MishkaCmsBuilder. Plugins. ProvisionSnippet
(Mishka CMS Builder v0.0.1-alpha.2)
Copy Markdown
View Source
Saves the snippet an extension ships into the editor's Studio list when a site is set up, on
runtime:provision:snippets (MishkaCmsCore.Runtime.ExtensionProvision, which describes the
payload as MishkaCmsCore.Runtime.ExtensionProvision.snippet_payload/0).
NOTHING IS EVER UPDATED, as in the rest of a provision: a site that already holds the snippet keeps its row, edited or not, and the name is not reported.
A REFUSED WRITE COMES BACK AS error, never as a raise. A plugin that raises is skipped and the
event answers the payload it was given, so a raise here would read as "nothing to install" and the
admin would never hear that their snippet was refused. The run raises with the reason instead.
It writes for whoever runs the provision, as the pages beside it are written: nobody (the seeds, the install wizard) writes as the system, a master through the master action with the site named, and a site admin through their own site's action under its tenant.
Summary
Functions
Returns a specification to start this module under a supervisor.
Callback implementation for MishkaInstaller.Event.Hook.enable/0.
Callback implementation for MishkaInstaller.Event.Hook.get/0.
Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.
Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.
Callback implementation for MishkaInstaller.Event.Hook.register/0.
Callback implementation for MishkaInstaller.Event.Hook.restart/0.
Callback implementation for MishkaInstaller.Event.Hook.start/0.
Callback implementation for MishkaInstaller.Event.Hook.stop/0.
Callback implementation for MishkaInstaller.Event.Hook.unregister/0.
Types
Functions
Returns a specification to start this module under a supervisor.
See Supervisor.
@spec config() :: keyword()
@spec enable() :: okey_return() | error_return()
Callback implementation for MishkaInstaller.Event.Hook.enable/0.
@spec get() :: keyword()
Callback implementation for MishkaInstaller.Event.Hook.get/0.
Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.
Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.
@spec register() :: okey_return() | error_return()
Callback implementation for MishkaInstaller.Event.Hook.register/0.
@spec restart() :: okey_return() | error_return()
Callback implementation for MishkaInstaller.Event.Hook.restart/0.
@spec start() :: okey_return() | error_return()
Callback implementation for MishkaInstaller.Event.Hook.start/0.
@spec stop() :: okey_return() | error_return()
Callback implementation for MishkaInstaller.Event.Hook.stop/0.
@spec unregister() :: okey_return() | error_return()
Callback implementation for MishkaInstaller.Event.Hook.unregister/0.