BehaviorRegistry is used as a registry for loaded behaviors and handles loading and constructing behavior objects.
This class also provides method for checking and dispatching behavior methods.
__construct( Cake\ORM\Table|null $table null )
Constructor
Cake\ORM\Table
|null $table
optional null _create( string $class , string $alias , array $config )
Create the behavior instance.
Part of the template method for Cake\Core\ObjectRegistry::load() Enabled behaviors will be registered with the event manager.
$class
$alias
$config
Cake\ORM\Behavior
_getMethods( Cake\ORM\Behavior $instance , string $class , string $alias )
Get the behavior methods and ensure there are no duplicates.
Use the implementedEvents() method to exclude callback methods. Methods starting with _
will be ignored, as will methods declared on Cake\ORM\Behavior
Cake\ORM\Behavior
$instance
$class
$alias
array
LogicException
_resolveClassName( string $class )
Resolve a behavior classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
$class
string|false
_throwMissingClassError( string $class , string $plugin )
Throws an exception when a behavior is missing.
Part of the template method for Cake\Core\ObjectRegistry::load()
$class
$plugin
Cake\ORM\Exception\MissingBehaviorException
call( string $method , array $args [] )
Invoke a method on a behavior.
$method
$args
optional [] mixed
BadMethodCallException
callFinder( string $type , array $args [] )
Invoke a finder on a behavior.
$type
$args
optional [] mixed
BadMethodCallException
hasFinder( string $method )
Check if any loaded behavior implements the named finder.
Will return true if any behavior provides a public method with the chosen name.
$method
boolean
hasMethod( string $method )
Check if any loaded behavior implements a method.
Will return true if any behavior provides a public non-finder method with the chosen name.
$method
boolean
setTable( Cake\ORM\Table $table )
Attaches a table instance to this registry.
Cake\ORM\Table
$table
__get( string $name )
Provide public read access to the loaded objects
$name
mixed
__isset( string $name )
Provide isset access to _loaded
$name
boolean
_checkDuplicate( string $name , array $config )
Check for duplicate object loading.
If a duplicate is being loaded and has different configuration, that is bad and an exception will be raised.
An exception is raised, as replacing the object will not update any references other objects may have. Additionally, simply updating the runtime configuration is not a good option as we may be missing important constructor logic dependent on the configuration.
$name
$config
RuntimeException
get( string $name )
Get loaded object instance.
$name
object|null
has( string $name )
Check whether or not a given object is loaded.
$name
boolean
load( string $objectName , array $config [] )
Loads/constructs an object instance.
Will return the instance in the registry if it already exists. If a subclass provides event support, you can use $config['enabled'] = false
to exclude constructed objects from being registered for events.
Using Cake\Controller\Controller::$components as an example. You can alias an object by setting the 'className' key, i.e.,
public $components = [ 'Email' => [ 'className' => '\App\Controller\Component\AliasedEmailComponent' ]; ];
All calls to the Email
component would use AliasedEmail
instead.
$objectName
$config
optional [] mixed
normalizeArray( array $objects )
Normalizes an object array, creates an array that makes lazy loading easier
$objects
array
reset( )
Clear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
set( string $objectName , object $object )
Set an object directly into the registry by name.
If this collection implements events, the passed object will be attached into the event manager
$objectName
$object
unload( string $objectName )
Remove an object from the registry.
If this registry has an event manager, the object will be detached from any events as well.
$objectName
dispatchEvent( string $name , array|null $data null , object|null $subject null )
Wrapper for creating and dispatching events.
Returns a dispatched event.
$name
$data
optional null $subject
optional null Cake\Event\Event
Cake\Event\EventDispatcherInterface::dispatchEvent()
eventManager( Cake\Event\EventManager $eventManager null )
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Cake\Event\EventManager
$eventManager
optional null Cake\Event\EventManager
Cake\Event\EventDispatcherInterface::eventManager()
protected Cake\Event\EventManager
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
null
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.ORM.BehaviorRegistry.html