With RAD: a settings-only extension #

Tutorial 7. The Settings extension wizard (/setup/settingsextension) writes extensions that are mostly settings: image aliases, event listeners, view cache rules, information collection, trigger operations, siteaccess settings, extension roots, icon themes and more. The output below was produced by the wizard's generator (expSettingsExtensionWizard::files()) with two event listeners chosen; every PHP file passed php -l.

The topics #

Each topic writes one settings file (the wizard names it):

Plus the listener class, API examples, README, metadata, Composer file, .gitignore and license.

Event listeners #

With the events content/state/assign and response/output and the class mysiteSettingsListeners, the wizard wrote:

.gitignore
LICENSE
README.md
classes/mysitesettingslisteners.php
composer.json
doc/examples.php
extension.xml
ezinfo.php
settings/site.ini.append.php

[Event]
Listeners[]=content/state/assign@mysiteSettingsListeners::contentStateAssign
Listeners[]=response/output@mysiteSettingsListeners::responseOutput

The listener class knows which kind each event is and is safe until you write it:

/**
 * response/output
 *
 * The whole page, about to be sent. Whatever is returned is what the
 * browser gets.
 *
 * A filter event. Whatever this returns is what the rest of the
 * system uses, so returning nothing destroys the value. The first
 * argument is the value; anything after it is context.
 */
public static function responseOutput( $value = null )
{
    // Not written yet. Handing the value back unchanged leaves the
    // system working exactly as it did before this listener existed.
    return $value;
}

The notify listener (contentStateAssign()) returns nothing, with the note "What this returns is ignored, and nothing waits for it either - anything slow here is felt by whoever caused it." Fill them in as in Events, listeners and filters. Note that content/state/assign is notified with ( $objectID, $selectedStateIDList ); give your method both parameters.

Moving existing settings instead #

When the settings already exist in settings/siteaccess/<sa>/ or settings/override/, the settings command builds the extension from them, keeping every value in effect:

./console exp:ini move-all siteaccess:mysite extension:mysite_settings:siteaccess:mysite --create-extension --dry-run

See Settings that live in an extension.

Switch it on #

./console exp:ini add 'site.ini/ExtensionSettings/ActiveExtensions[]' mysite_settings global
php bin/php/ezpgenerateautoloads.php -e
php bin/php/ezcache.php --clear-tag=ini

Related pages #

• Previous: With RAD: a design extension
• Next: With RAD: handlers and kernel overrides
• Settings in an extension
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.