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.
stringDefault class name for new event objects.
\Cake\Event\EventManagerInterfaceInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
arrayFinder method mappings.
object[]Map of loaded objects.
arrayMethod mappings.
\Cake\ORM\TableThe table using this registry.
__construct(?\Cake\ORM\Table $table)
Constructor
\Cake\ORM\Table|null $table optional The table this registry is attached to.
__debugInfo()
Debug friendly object properties.
array__get(string $name)
Provide public read access to the loaded objects
string $name Name of property to read
object|null__isset(string $name)
Provide isset access to _loaded
string $name Name of object being checked.
bool__set(string $name, mixed $object)
Sets an object.
string $name Name of a property to set.
object $object Object to set.
__unset(string $name)
Unsets an object.
string $name Name of a property to unset.
_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.
string $name The name of the alias in the registry.
array $config The config data for the new instance.
RuntimeException_create(mixed $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.
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.
\Cake\ORM\BehaviorThe constructed behavior class.
_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 The behavior to get methods from.
string $class The classname that is missing.
string $alias The alias of the object.
arrayA list of implemented finders and methods.
LogicException_resolveClassName(string $class)
Resolve a behavior classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
string $class Partial classname to resolve.
string|nullEither the correct class name or null.
_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()
string $class The classname that is missing.
string|null $plugin The plugin the behavior is missing in.
Cake\ORM\Exception\MissingBehaviorExceptioncall(string $method, array $args)
Invoke a method on a behavior.
string $method The method to invoke.
array $args optional The arguments you want to invoke the method with.
mixedThe return value depends on the underlying behavior method.
BadMethodCallExceptioncallFinder(string $type, array $args)
Invoke a finder on a behavior.
string $type The finder type to invoke.
array $args optional The arguments you want to invoke the method with.
\Cake\ORM\QueryThe return value depends on the underlying behavior method.
BadMethodCallExceptionclassName(string $class)
Resolve a behavior classname.
string $class Partial classname to resolve.
string|nullEither the correct classname or null.
count()
Returns the number of loaded objects.
intdispatchEvent(string $name, ?array $data, ?object $subject)
Wrapper for creating and dispatching events.
Returns a dispatched event.
string $name Name of the event.
array|null $data optional Any value you wish to be transported with this event to it can be read by listeners.
object|null $subject optional The object that this event applies to ($this by default).
\Cake\Event\EventInterfaceget(string $name)
Get loaded object instance.
string $name Name of object.
objectObject instance.
RuntimeExceptiongetEventManager()
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\EventManagerInterfacegetIterator()
Returns an array iterator.
\Traversablehas(string $name)
Check whether or not a given object is loaded.
string $name The object name to check for.
boolTrue is object is loaded else false.
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.
string $method The method to check for.
boolhasMethod(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.
string $method The method to check for.
boolload(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.
string $objectName The name/class of the object to load.
array $config optional Additional settings to use when loading the object.
mixedExceptionloaded()
Get the list of loaded objects.
string[]List of object names.
normalizeArray(array $objects)
Normalizes an object array, creates an array that makes lazy loading easier
array $objects Array of child objects to normalize.
array[]Array of normalized objects.
reset()
Clear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
$thisset(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
string $objectName The name of the object to set in the registry.
object $object instance to store in the registry
$thissetEventManager(\Cake\Event\EventManagerInterface $eventManager)
Returns the Cake\Event\EventManagerInterface 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\EventManagerInterface $eventManager the eventManager to set
$thissetTable(\Cake\ORM\Table $table)
Attaches a table instance to this registry.
\Cake\ORM\Table $table The table this registry is attached to.
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.
string $objectName The name of the object to remove from the registry.
$thisDefault class name for new event objects.
stringInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
\Cake\Event\EventManagerInterfaceFinder method mappings.
arrayMap of loaded objects.
object[]Method mappings.
arrayThe table using this registry.
\Cake\ORM\Table
© 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/4.1/class-Cake.ORM.BehaviorRegistry.html