[RunnableSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [RunnableSettings] of settings/site.ini.
File
settings/site.ini; override it in settings/override/site.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| Implementation[] | (empty array) | Commands (bin/), cronjob parts (cronjobs/) and module views are classes that extend Exponential\Runnable\Command, CronjobPart or ModuleView. Guide: doc/eng-us/bc/6.0/cli_cronjob_view_abstractions.md Re-implementation: the class to create instead of a runnable class. It must extend the class it replaces; an entry naming anything else is ignored. Implementation[<runnable class>]=<subclass> eg: Implementation[Exponential\View\Kernel\Content\History]=myHistoryView Implementation[Exponential\Command\Kernel\Trashpurge]=myTrashpurgeCommand |
| Listeners[] | (empty array) | Listeners of the runnables' events, in the form of [Event] Listeners[]: Listeners[]=<event>@<callback> The events, <kind> being command, cronjob or view: runnable/<kind>/before notified with ( $runnable, $class, $scope ) before run() runnable/<kind>/after filters the result: ( $result, $runnable, $class, $scope ), returns the result to use eg: Listeners[]=runnable/view/after@myViewTimer::after These are attached for the runnables in every context, the command line too ([Event] Listeners[] is attached to web requests only). A command is created before its script has read the siteaccess and extension settings, so Implementation[] and Listeners[] for a command are read from settings/site.ini and settings/override/site.ini.append.php only. runcronjobs.php asks one more filter before the scripts of a part run, after the siteaccess and extension settings are loaded (its listener may come from either): cronjob/part/run ( true, $part, $siteaccess, $scripts, $single ); return true to run the part, anything else leaves it out. $part is '' for [CronjobSettings] and for --script; $single is true for --script, whose one file name is in $scripts Listeners[]=cronjob/part/run@myCronjobStop::partRun Guide: doc/eng-us/features/6.0/cronjob-part-filter.md |
See also
Generated example: site.ini [RunnableSettings]
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/site.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment