\Installer\Shell\TaskThemeActivationTask

Task for switching site's theme.

Summary

Methods
Properties
Constants
startup()
getOptionParser()
main()
trigger()
eventDispatcher()
triggered()
No public properties found
No constants found
_copyBlockPositions()
_attachListeners()
_detachListeners()
$_listeners
N/A
No private methods found
No private properties found
N/A

Properties

$_listeners

$_listeners : array

List of all loaded listeners using "_attachListeners()" method.

Type

array

Methods

startup()

startup() : void

Removes the welcome message.

getOptionParser()

getOptionParser() : \Cake\Console\ConsoleOptionParser

Gets the option parser instance and configures it.

Returns

\Cake\Console\ConsoleOptionParser

main()

main() : void

Switch site's theme.

trigger()

trigger(array|string $eventName) : \Cake\Event\Event

Triggers the given event name. This method provides a shortcut for:

$this->trigger('EventName', $arg1, $arg2, ..., $argn);

You can provide a subject to use by passing an array as first arguments where the first element is the event name and the second one is the subject, if no subject is given $this will be used by default:

$this->trigger(['GetTime', new MySubject()], $arg_0, $arg_1, ..., $arg_n);

You can also indicate an EventDispatcher instance to use by prefixing the event name with <InstanceName>::, for instance:

$this->trigger('Blog::EventName', $arg1, $arg2, ..., $argn);

This will use the EventDispacher instance named Blog and will trigger the event EventName within that instance.

Parameters

array|string $eventName

The event name to trigger

Returns

\Cake\Event\Event —

The event object that was fired

eventDispatcher()

eventDispatcher(string $name) : \QuickApps\Event\EventDispatcher

Gets an instance of the given Event Dispatcher name.

Usage:

$this->eventDispatcher('myDispatcher')
    ->trigger('MyEventName', $argument)
    ->result;

Parameters

string $name

Name of the dispatcher to get, defaults to 'default'

Returns

\QuickApps\Event\EventDispatcher

triggered()

triggered(string|null $eventName) : integer|array

Retrieves the number of times an event was triggered, or the complete list of events that were triggered.

Parameters

string|null $eventName

The name of the event, if null returns the entire list of event that were fired

Returns

integer|array

_copyBlockPositions()

_copyBlockPositions(string $dst, string $src) : void

If $src has any region in common with $dst this method will make $dst have these blocks in the same regions as $src.

Parameters

string $dst

Destination theme name

string $src

Source theme name

_attachListeners()

_attachListeners(string $plugin, string $path)

Loads and registers plugin's namespace and loads its event listeners classes.

This is used to allow plugins being installed to respond to events before they are integrated to the system. Events such as beforeInstall, afterInstall, etc.

Parameters

string $plugin

Name of the plugin for which attach listeners

string $path

Path to plugin's root directory (which contains "src")

Throws

\Cake\Error\FatalErrorException

On illegal usage of this method

_detachListeners()

_detachListeners() : void

Unloads all registered listeners that were attached using the "_attachListeners()" method.