\Menu\Model\TableMenusTable

Represents "menus" database table.

Summary

Methods
Properties
Constants
initialize()
validationDefault()
beforeSave()
afterSave()
beforeDelete()
afterDelete()
trigger()
eventDispatcher()
triggered()
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

initialize()

initialize(array $config) : void

Initialize a table instance. Called after the constructor.

Parameters

array $config

Configuration options passed to the constructor

validationDefault()

validationDefault(\Cake\Validation\Validator $validator) : \Cake\Validation\Validator

Default validation rules set.

Parameters

\Cake\Validation\Validator $validator

The validator object

Returns

\Cake\Validation\Validator

beforeSave()

beforeSave(\Cake\Event\Event $event, \Menu\Model\Entity\Menu $menu, \ArrayObject $options) : boolean

Triggers the "Menu.<handler>.beforeSave" hook, so plugins may do any logic their require.

Parameters

\Cake\Event\Event $event

The event that was triggered

\Menu\Model\Entity\Menu $menu

The menu entity being saved

\ArrayObject $options

Options given as an array

Returns

boolean —

False if save operation should not continue, true otherwise

afterSave()

afterSave(\Cake\Event\Event $event, \Menu\Model\Entity\Menu $menu, \ArrayObject $options) : void

Triggers the "Menu.<handler>.afterSave" hook, so plugins may do any logic their require.

It will also create menu's associated block if not exists.

Parameters

\Cake\Event\Event $event

The event that was triggered

\Menu\Model\Entity\Menu $menu

The menu entity that was saved

\ArrayObject $options

Options given as an array

beforeDelete()

beforeDelete(\Cake\Event\Event $event, \Menu\Model\Entity\Menu $menu, \ArrayObject $options) : boolean

Triggers the "Menu.<handler>.beforeDelete" hook, so plugins may do any logic their require.

Parameters

\Cake\Event\Event $event

The event that was triggered

\Menu\Model\Entity\Menu $menu

The menu entity being deleted

\ArrayObject $options

Options given as an array

Returns

boolean —

False if delete operation should not continue, true otherwise

afterDelete()

afterDelete(\Cake\Event\Event $event, \Menu\Model\Entity\Menu $menu, \ArrayObject $options) : void

Triggers the "Menu.<handler>.afterDelete" hook, so plugins may do any logic their require.

Parameters

\Cake\Event\Event $event

The event that was triggered

\Menu\Model\Entity\Menu $menu

The menu entity that was deleted

\ArrayObject $options

Options given as an array

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