\User\EventUserHook

Main Hook Listener for User plugin.

Summary

Methods
Properties
Constants
implementedEvents()
renderBlock()
settingsValidate()
settingsDefaults()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

implementedEvents()

implementedEvents() : void

Returns a list of hooks this Hook Listener is implementing. When the class is registered in an event manager, each individual method will be associated with the respective event.

renderBlock()

renderBlock(\Cake\Event\Event $event, \Block\Model\Entity\Block $block, array $options) : string

Renders all blocks registered by User plugin.

User plugin has one built-in block that comes with every QuickAppsCMS installation: "User Sub-menu" which allow users to access their profile page among other things.

Parameters

\Cake\Event\Event $event

The event that was triggered

\Block\Model\Entity\Block $block

The block being rendered

array $options

Additional options as an array

Returns

string

settingsValidate()

settingsValidate(\Cake\Event\Event $event, array $data, \Cake\Validation\Validator $validator) : void

Validates plugin's settings.

Parameters

\Cake\Event\Event $event

The event that was triggered

array $data

Data to be validated

\Cake\Validation\Validator $validator

The validator object

settingsDefaults()

settingsDefaults(\Cake\Event\Event $event) : array

Provides defaults values for settings keys.

Parameters

\Cake\Event\Event $event

The event that was triggered

Returns

array