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.
string
Default class name for new event objects.
Cake\Event\EventManagerInterface|null
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
array<string, array>
Finder method mappings.
array<object>
Map of loaded objects.
array<string, array>
Method mappings.
Cake\ORM\Table
The table using this registry.
Constructor
Debug friendly object properties.
Provide public read access to the loaded objects
Provide isset access to _loaded
Sets an object.
Unsets an object.
Check for duplicate object loading.
Create the behavior instance.
Get the behavior methods and ensure there are no duplicates.
Resolve a behavior classname.
Throws an exception when a behavior is missing.
Invoke a method on a behavior.
Invoke a finder on a behavior.
Resolve a behavior classname.
Returns the number of loaded objects.
Wrapper for creating and dispatching events.
Get loaded object instance.
Returns the Cake\Event\EventManager manager instance for this object.
Returns an array iterator.
Check whether a given object is loaded.
Check if any loaded behavior implements the named finder.
Check if any loaded behavior implements a method.
Loads/constructs an object instance.
Get the list of loaded objects.
Normalizes an object array, creates an array that makes lazy loading easier
Clear loaded instances in the registry.
Set an object directly into the registry by name.
Returns the Cake\Event\EventManagerInterface instance for this object.
Attaches a table instance to this registry.
Remove an object from the registry.
__construct(Cake\ORM\Table|null $table = null)
Constructor
Cake\ORM\Table|null
$table optional The table this registry is attached to.
__debugInfo(): array<string, mixed>
Debug friendly object properties.
array<string, mixed>
__get(string $name): object|null
Provide public read access to the loaded objects
string
$name Name of property to read
object|null
__isset(string $name): bool
Provide isset access to _loaded
string
$name Name of object being checked.
bool
__set(string $name, object $object): void
Sets an object.
string
$name Name of a property to set.
object
$object Object to set.
void
__unset(string $name): void
Unsets an object.
string
$name Name of a property to unset.
void
_checkDuplicate(string $name, array<string, mixed> $config): void
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<string, mixed>
$config The config data for the new instance.
void
RuntimeException
_create(object|string $class, string $alias, array<string, mixed> $config): Cake\ORM\Behavior
Create the behavior instance.
Part of the template method for Cake\Core\ObjectRegistry::load() Enabled behaviors will be registered with the event manager.
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.
Cake\ORM\Behavior
_getMethods(Cake\ORM\Behavior $instance, string $class, string $alias): array
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.
array
LogicException
_resolveClassName(string $class): string|null
Resolve a behavior classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
string
$class Partial classname to resolve.
string|null
_throwMissingClassError(string $class, string|null $plugin): void
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.
void
Cake\ORM\Exception\MissingBehaviorException
call(string $method, array $args = []): mixed
Invoke a method on a behavior.
string
$method The method to invoke.
array
$args optional The arguments you want to invoke the method with.
mixed
BadMethodCallException
callFinder(string $type, array $args = []): Cake\ORM\Query
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\Query
BadMethodCallException
className(string $class): string|null
Resolve a behavior classname.
string
$class Partial classname to resolve.
string|null
count(): int
Returns the number of loaded objects.
int
dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterface
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\EventInterface
get(string $name): object
Get loaded object instance.
string
$name Name of object.
object
RuntimeException
getEventManager(): Cake\Event\EventManagerInterface
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\EventManagerInterface
getIterator(): Traversable
Returns an array iterator.
Traversable
has(string $name): bool
Check whether a given object is loaded.
string
$name The object name to check for.
bool
hasFinder(string $method): bool
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.
bool
hasMethod(string $method): bool
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.
bool
load(string $name, array<string, mixed> $config = []): mixed
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 {@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.
string
$name The name/class of the object to load.
array<string, mixed>
$config optional Additional settings to use when loading the object.
mixed
Exception
loaded(): array<string>
Get the list of loaded objects.
array<string>
normalizeArray(array $objects): array<string, array>
Normalizes an object array, creates an array that makes lazy loading easier
array
$objects Array of child objects to normalize.
array<string, array>
reset(): $this
Clear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
$this
set(string $name, object $object): $this
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
$name The name of the object to set in the registry.
object
$object instance to store in the registry
$this
setEventManager(Cake\Event\EventManagerInterface $eventManager): $this
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
$this
setTable(Cake\ORM\Table $table): void
Attaches a table instance to this registry.
Cake\ORM\Table
$table The table this registry is attached to.
void
unload(string $name): $this
Remove an object from the registry.
If this registry has an event manager, the object will be detached from any events as well.
string
$name The name of the object to remove from the registry.
$this
Default class name for new event objects.
string
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Cake\Event\EventManagerInterface|null
Finder method mappings.
array<string, array>
Map of loaded objects.
array<object>
Method mappings.
array<string, array>
The 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.4/class-Cake.ORM.BehaviorRegistry.html