W3cubDocs

/CakePHP 3.8

Class BehaviorRegistry

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.

Cake\Core\ObjectRegistry implements Countable, IteratorAggregate
Extended by Cake\ORM\BehaviorRegistry implements Cake\Event\EventDispatcherInterface uses Cake\Event\EventDispatcherTrait
Namespace: Cake\ORM
Location: ORM/BehaviorRegistry.php

Properties summary

Inherited Properties

Method Summary

Method Detail

__construct()source public

__construct( Cake\ORM\Table|null $table = null )

Constructor

Parameters

Cake\ORM\Table|null $table optional null
The table this registry is attached to.

_create()source protected

_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.

Parameters

string $class
The classname that is missing.
string $alias
The alias of the object.
array $config
An array of config to use for the behavior.

Returns

Cake\ORM\Behavior
The constructed behavior class.

_getMethods()source protected

_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

Parameters

Cake\ORM\Behavior $instance
The behavior to get methods from.
string $class
The classname that is missing.
string $alias
The alias of the object.

Returns

array
A list of implemented finders and methods.

Throws

LogicException
when duplicate methods are connected.

_resolveClassName()source protected

_resolveClassName( string $class )

Resolve a behavior classname.

Part of the template method for Cake\Core\ObjectRegistry::load()

Parameters

string $class
Partial classname to resolve.

Returns

string|false
Either the correct classname or false.

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

Throws an exception when a behavior is missing.

Part of the template method for Cake\Core\ObjectRegistry::load() and Cake\Core\ObjectRegistry::unload()

Parameters

string $class
The classname that is missing.
string $plugin
The plugin the behavior is missing in.

Throws

Cake\ORM\Exception\MissingBehaviorException

call()source public

call( string $method , array $args = [] )

Invoke a method on a behavior.

Parameters

string $method
The method to invoke.
array $args optional []
The arguments you want to invoke the method with.

Returns

mixed
The return value depends on the underlying behavior method.

Throws

BadMethodCallException
When the method is unknown.

callFinder()source public

callFinder( string $type , array $args = [] )

Invoke a finder on a behavior.

Parameters

string $type
The finder type to invoke.
array $args optional []
The arguments you want to invoke the method with.

Returns

mixed
The return value depends on the underlying behavior method.

Throws

BadMethodCallException
When the method is unknown.

className()source public static

className( string $class )

Resolve a behavior classname.

Parameters

string $class
Partial classname to resolve.

Returns

string|null
Either the correct classname or null.

Since

3.5.7

hasFinder()source public

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.

Parameters

string $method
The method to check for.

Returns

boolean

hasMethod()source public

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.

Parameters

string $method
The method to check for.

Returns

boolean

setTable()source public

setTable( Cake\ORM\Table $table )

Attaches a table instance to this registry.

Parameters

Cake\ORM\Table $table
The table this registry is attached to.

Methods inherited from Cake\Core\ObjectRegistry

__debugInfo()source public

__debugInfo( )

Debug friendly object properties.

Returns

array

__get()source public

__get( string $name )

Provide public read access to the loaded objects

Parameters

string $name
Name of property to read

Returns

mixed

__isset()source public

__isset( string $name )

Provide isset access to _loaded

Parameters

string $name
Name of object being checked.

Returns

boolean

__set()source public

__set( string $name , mixed $object )

Sets an object.

Parameters

string $name
Name of a property to set.
mixed $object
Object to set.

__unset()source public

__unset( string $name )

Unsets an object.

Parameters

string $name
Name of a property to unset.

_checkDuplicate()source protected

_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.

Parameters

string $name
The name of the alias in the registry.
array $config
The config data for the new instance.

Throws

RuntimeException
When a duplicate is found.

count()source public

count( )

Returns the number of loaded objects.

Returns

integer

Implementation of

Countable::count()

get()source public

get( string $name )

Get loaded object instance.

Parameters

string $name
Name of object.

Returns

object|null
Object instance if loaded else null.

getIterator()source public

getIterator( )

Returns an array iterator.

Returns

ArrayIterator

Implementation of

IteratorAggregate::getIterator()

has()source public

has( string $name )

Check whether or not a given object is loaded.

Parameters

string $name
The object name to check for.

Returns

boolean
True is object is loaded else false.

load()source public

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.

Parameters

string $objectName
The name/class of the object to load.
array $config optional []
Additional settings to use when loading the object.

Returns

mixed

Throws

Exception
If the class cannot be found.

loaded()source public

loaded( )

Get the list of loaded objects.

Returns

string[]
List of object names.

normalizeArray()source public

normalizeArray( array $objects )

Normalizes an object array, creates an array that makes lazy loading easier

Parameters

array $objects
Array of child objects to normalize.

Returns

array
Array of normalized objects.

reset()source public

reset( )

Clear loaded instances in the registry.

If the registry subclass has an event manager, the objects will be detached from events as well.

Returns


$this

set()source public

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

Parameters

string $objectName
The name of the object to set in the registry.
object $object
instance to store in the registry

Returns


$this

unload()source public

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.

Parameters

string $objectName
The name of the object to remove from the registry.

Returns


$this

Methods used from Cake\Event\EventDispatcherTrait

dispatchEvent()source public

dispatchEvent( string $name , array|null $data = null , object|null $subject = null )

Wrapper for creating and dispatching events.

Returns a dispatched event.

Parameters

string $name
Name of the event.
array|null $data optional null

Any value you wish to be transported with this event to it can be read by listeners.

object|null $subject optional null

The object that this event applies to ($this by default).

Returns

Cake\Event\Event

eventManager()source public deprecated

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.

Deprecated

3.5.0 Use getEventManager()/setEventManager() instead.

Parameters

Cake\Event\EventManager $eventManager optional null
the eventManager to set

Returns

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

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.

Returns

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

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.

Parameters

Cake\Event\EventManager $eventManager
the eventManager to set

Returns


$this

Magic methods inherited from Cake\Event\EventDispatcherInterface

getEventManager()

Properties detail

$_finderMapsource

protected array

Finder method mappings.

[]

$_methodMapsource

protected array

Method mappings.

[]

$_tablesource

protected Cake\ORM\Table

The table using this registry.

© 2005–present 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.
https://api.cakephp.org/3.8/class-Cake.ORM.BehaviorRegistry.html