Editor\Classes\ExtensionBase

ExtensionBase is a base class for Editor extensions

Protected properties

protected array $emitterSingleEventCollection

Collection of registered events to be fired once only.

protected array $emitterEventCollection

Collection of registered events.

protected array $emitterEventSorted

Sorted collection of events.

Public methods

public self bindEvent($event, $callback, $priority=0)

Create a new event binding.

Parameters

• $event
• $callback
• $priority

public self bindEventOnce($event, $callback)

Create a new event binding that fires once only

Parameters

• $event
• $callback

public array fireEvent(string $event, array $params=array(), boolean $halt=false)

Fire an event and call the listeners.

Parameters

• string $event - Event name
• array $params - Event parameters
• boolean $halt - Halt after first non-null result

public mixed fireSystemEvent(string $event, array $params=array(), boolean $halt=true)

Fires a combination of local and global events. The first segment is removed from the event name locally and the local object is passed as the first argument to the event globally. Halting is also enabled by default.

For example:

$this->fireSystemEvent('backend.list.myEvent', ['my value']);

Is equivalent to:

$this->fireEvent('list.myEvent', ['myvalue'], true);

Event::fire('backend.list.myEvent', [$this, 'myvalue'], true);

Parameters

• string $event - Event name
• array $params - Event parameters
• boolean $halt - Halt after first non-null result

public string fireViewEvent(string $event, array $params=array())

Special event function used for extending within view files, allowing HTML to be injected multiple times.

For example:

<?= $this->fireViewEvent('backend.auth.extendSigninView') ?>

Parameters

• string $event - Event name
• array $params - Event parameters

public array getClientSideLangStrings()

getClientSideLangStrings returns a list of language strings required for the client-side extension controller.

public void getCustomData()

getCustomData returns custom state data required for the extension client-side controller.

public string getNamespace()

getNamespace returns unique extension namespace, for example 'cms'. Plugins extending Editor must also define a client-side state controller class in $.oc.editor.extension[namespace]. State controller classes must extend $.oc.editor.stateController.

public void getNamespaceNormalized()

public array getNewDocumentsData()

getNewDocumentsData returns a list of new document descriptions, allowing creating documents on the client side.

public array getSettingsForms()

getSettingsForms returns a list of settings form configurations for document types supported by the extension.

public array listInspectorConfigurations()

listInspectorConfigurations returns a list of Inspector configurations that must be available on the client side.

public array listJsFiles()

listJsFiles returns a list of JavaScript files required for the extension.

public void listNavigatorSections($sectionList, $documentType=NULL)

listNavigatorSections initializes extension's sidebar Navigator sections. The sections must be added to the supplied section list.

Parameters

• $sectionList
• $documentType

public array listVueComponents()

listVueComponents returns a list of Vue components required for the extension.

public void runCommand($command)

runCommand handles client-side requests

Parameters

• $command

public self unbindEvent(string $event=NULL)

Destroys an event binding.

Parameters

• string $event - Event to destroy

Protected methods

protected array emitterEventSortEvents(string $eventName)

Sort the listeners for a given event by priority.

Parameters

• string $eventName

protected void loadAndLocalizeJsonFile($path)

loadAndLocalizeJsonFile

Parameters

• $path

protected void loadSettingsFile($rootPath, $documentDirectoryName)

loadSettingsFile

Parameters

• $rootPath
• $documentDirectoryName