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.
Property Summary
-
$_eventClass protected
stringDefault class name for new event objects.
-
$_eventManager protected
Cake\Event\EventManagerInterface|nullInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
-
$_finderMap protected
array<string, array>Finder method mappings.
-
$_loaded protected
array<object>Map of loaded objects.
-
$_methodMap protected
array<string, array>Method mappings.
-
$_table protected
Cake\ORM\TableThe table using this registry.
Method Summary
-
__construct() public
Constructor
-
__debugInfo() public
Debug friendly object properties.
-
__get() public
Provide public read access to the loaded objects
-
__isset() public
Provide isset access to _loaded
-
__set() public
Sets an object.
-
__unset() public
Unsets an object.
-
_checkDuplicate() protected
Check for duplicate object loading.
-
_create() protected
Create the behavior instance.
-
_getMethods() protected
Get the behavior methods and ensure there are no duplicates.
-
_resolveClassName() protected
Resolve a behavior classname.
-
_throwMissingClassError() protected
Throws an exception when a behavior is missing.
-
call() public
Invoke a method on a behavior.
-
callFinder() public
Invoke a finder on a behavior.
-
className() public static
Resolve a behavior classname.
-
count() public
Returns the number of loaded objects.
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
get() public
Get loaded object instance.
-
getEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
getIterator() public
Returns an array iterator.
-
has() public
Check whether a given object is loaded.
-
hasFinder() public
Check if any loaded behavior implements the named finder.
-
hasMethod() public
Check if any loaded behavior implements a method.
-
load() public
Loads/constructs an object instance.
-
loaded() public
Get the list of loaded objects.
-
normalizeArray() public
Normalizes an object array, creates an array that makes lazy loading easier
-
reset() public
Clear loaded instances in the registry.
-
set() public
Set an object directly into the registry by name.
-
setEventManager() public
Returns the Cake\Event\EventManagerInterface instance for this object.
-
setTable() public
Attaches a table instance to this registry.
-
unload() public
Remove an object from the registry.
Method Detail
__construct() ¶ public
__construct(Cake\ORM\Table|null $table = null)Constructor
Parameters
-
Cake\ORM\Table|null$table optional The table this registry is attached to.
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>Debug friendly object properties.
Returns
array<string, mixed>__get() ¶ public
__get(string $name): object|nullProvide public read access to the loaded objects
Parameters
-
string$name Name of property to read
Returns
object|null__isset() ¶ public
__isset(string $name): boolProvide isset access to _loaded
Parameters
-
string$name Name of object being checked.
Returns
bool__set() ¶ public
__set(string $name, object $object): voidSets an object.
Parameters
-
string$name Name of a property to set.
-
object$object Object to set.
Returns
void__unset() ¶ public
__unset(string $name): voidUnsets an object.
Parameters
-
string$name Name of a property to unset.
Returns
void_checkDuplicate() ¶ protected
_checkDuplicate(string $name, array<string, mixed> $config): voidCheck 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<string, mixed>$config The config data for the new instance.
Returns
voidThrows
RuntimeExceptionWhen a duplicate is found.
_create() ¶ protected
_create(object|string $class, string $alias, array<string, mixed> $config): Cake\ORM\BehaviorCreate the behavior instance.
Part of the template method for Cake\Core\ObjectRegistry::load() Enabled behaviors will be registered with the event manager.
Parameters
-
object|string$class The classname that is missing.
-
string$alias The alias of the object.
-
array<string, mixed>$config An array of config to use for the behavior.
Returns
Cake\ORM\Behavior_getMethods() ¶ protected
_getMethods(Cake\ORM\Behavior $instance, string $class, string $alias): arrayGet 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
arrayThrows
LogicExceptionwhen duplicate methods are connected.
_resolveClassName() ¶ protected
_resolveClassName(string $class): string|nullResolve a behavior classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
-
string$class Partial classname to resolve.
Returns
string|null_throwMissingClassError() ¶ protected
_throwMissingClassError(string $class, string|null $plugin): voidThrows 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|null$plugin The plugin the behavior is missing in.
Returns
voidThrows
Cake\ORM\Exception\MissingBehaviorExceptioncall() ¶ public
call(string $method, array $args = []): mixedInvoke 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
mixedThrows
BadMethodCallExceptionWhen the method is unknown.
callFinder() ¶ public
callFinder(string $type, array $args = []): Cake\ORM\QueryInvoke 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
Cake\ORM\QueryThrows
BadMethodCallExceptionWhen the method is unknown.
className() ¶ public static
className(string $class): string|nullResolve a behavior classname.
Parameters
-
string$class Partial classname to resolve.
Returns
string|nulldispatchEvent() ¶ public
dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterfaceWrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
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).
Returns
Cake\Event\EventInterfaceget() ¶ public
get(string $name): objectGet loaded object instance.
Parameters
-
string$name Name of object.
Returns
objectThrows
RuntimeExceptionIf not loaded or found.
getEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterfaceReturns 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\EventManagerInterfacehas() ¶ public
has(string $name): boolCheck whether a given object is loaded.
Parameters
-
string$name The object name to check for.
Returns
boolhasFinder() ¶ public
hasFinder(string $method): boolCheck 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
boolhasMethod() ¶ public
hasMethod(string $method): boolCheck 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
boolload() ¶ public
load(string $name, array<string, mixed> $config = []): mixedLoads/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 {@link \Cake\Controller\Component::$components} as an example. You can alias an object by setting the 'className' key, i.e.,
protected $components = [
'Email' => [
'className' => 'App\Controller\Component\AliasedEmailComponent'
];
];All calls to the Email component would use AliasedEmail instead.
Parameters
-
string$name The name/class of the object to load.
-
array<string, mixed>$config optional Additional settings to use when loading the object.
Returns
mixedThrows
ExceptionIf the class cannot be found.
normalizeArray() ¶ public
normalizeArray(array $objects): array<string, array>Normalizes an object array, creates an array that makes lazy loading easier
Parameters
-
array$objects Array of child objects to normalize.
Returns
array<string, array>reset() ¶ public
reset(): $thisClear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
Returns
$thisset() ¶ public
set(string $name, object $object): $thisSet 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$name The name of the object to set in the registry.
-
object$object instance to store in the registry
Returns
$thissetEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $thisReturns 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.
Parameters
-
Cake\Event\EventManagerInterface$eventManager the eventManager to set
Returns
$thissetTable() ¶ public
setTable(Cake\ORM\Table $table): voidAttaches a table instance to this registry.
Parameters
-
Cake\ORM\Table$table The table this registry is attached to.
Returns
voidunload() ¶ public
unload(string $name): $thisRemove an object from the registry.
If this registry has an event manager, the object will be detached from any events as well.
Parameters
-
string$name The name of the object to remove from the registry.
Returns
$thisProperty Detail
$_eventManager ¶ protected
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Type
Cake\Event\EventManagerInterface|null