HumHub Documentation (unofficial)

PolymorphicRelation extends Behavior
in package

Application

PolymorphicRelations behavior provides simple support for polymorphic relations in ActiveRecords.

Properties

$classAttribute : string
$mustBeInstanceOf : array<string|int, mixed>
$owner : Component|null
$pkAttribute : string
$polymorphicRelation : ActiveRecord|object|null
$strict : bool
$_attachedEvents : array<string|int, mixed>
$cached : ActiveRecord|object|null

Methods

__call() : mixed: Calls the named method which is not a class method.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of an object property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets value of an object property.
__unset() : mixed: Sets an object property to null.
attach() : mixed: Attaches the behavior object to the component.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
detach() : mixed: Detaches the behavior object from the component.
events() : array<string|int, mixed>: Declares event handlers for the [[owner]]'s events.
getObjectModel() : string
getPolymorphicRelation() : ActiveRecordInterface|ActiveRecord|object|null: Returns the Underlying Object
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined.
init() : mixed: Initializes the object.
isPolymorphicRelationLoaded() : bool: Returns if the polymorphic relation is established
loadActiveRecord() : null|ActiveRecord|ActiveRecordInterface: Loads an active record based on classname and primary key.
resetPolymorphicRelation() : mixed: Resets the already loaded $_cached instance of the related object
setPolymorphicRelation() : mixed: Sets the related object
validateUnderlyingObjectType() : bool: Validates if given object is of an allowed type

$classAttribute


    public
        string
    $classAttribute
     = 'object_model'

the class name attribute

$mustBeInstanceOf


    public
        array<string|int, mixed>
    $mustBeInstanceOf
     = []

the related object needs to be an "instanceof" at least one of these given classnames

$owner


    public
        Component|null
    $owner

the owner of this behavior

$pkAttribute


    public
        string
    $pkAttribute
     = 'object_id'

the primary key attribute

$polymorphicRelation


    public
        ActiveRecord|object|null
    $polymorphicRelation

$strict


    public
        bool
    $strict
     = false

if set to true, an exception is thrown if object_model and object_id is set but does not exist

$_attachedEvents


    private
        array<string|int, mixed>
    $_attachedEvents
     = []

Attached events handlers

$cached


    private
        ActiveRecord|object|null
    $cached
     = null

the cached object

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.


    public
                    __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set (not null).

__set()

Sets value of an object property.


    public
                    __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets an object property to null.


    public
                    __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters

$name : string: the property name

attach()

Attaches the behavior object to the component.


    public
                    attach(Component $owner) : mixed

The default implementation will set the [[owner]] property and attach event handlers as declared in [[events]]. Make sure you call the parent implementation if you override this method.

Parameters

$owner : Component: the component that this behavior is to be attached to.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ]) : bool

A property is readable if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ]) : bool

A property is writable if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

detach()

Detaches the behavior object from the component.


    public
                    detach() : mixed

The default implementation will unset the [[owner]] property and detach event handlers declared in [[events]]. Make sure you call the parent implementation if you override this method.

events()

Declares event handlers for the [[owner]]'s events.


    public
                    events() : array<string|int, mixed>

Child classes may override this method to declare what PHP callbacks should be attached to the events of the [[owner]] component.

The callbacks will be attached to the [[owner]]'s events when the behavior is attached to the owner; and they will be detached from the events when the behavior is detached from the component.

The callbacks can be any of the following:

method in this behavior: 'handleClick', equivalent to [$this, 'handleClick']
object method: [$object, 'handleClick']
static method: ['Page', 'handleClick']
anonymous function: function ($event) { ... }

The following is an example:

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]

Return values

array<string|int, mixed> —

events (array keys) and the corresponding event handler methods (array values).

getObjectModel()


    public
            static        getObjectModel(ActiveRecordInterface $object) : string

Parameters

$object : ActiveRecordInterface

Return values

string

getPolymorphicRelation()

Returns the Underlying Object


    public
                    getPolymorphicRelation() : ActiveRecordInterface|ActiveRecord|object|null

Return values

ActiveRecordInterface|ActiveRecord|object|null

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters

$name : string: the method name

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.


    public
                    hasProperty(string $name[, bool $checkVars = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

isPolymorphicRelationLoaded()

Returns if the polymorphic relation is established


    public
                    isPolymorphicRelationLoaded() : bool

Return values

bool

loadActiveRecord()

Loads an active record based on classname and primary key.


    public
            static        loadActiveRecord(string|null $className, string|int $primaryKey) : null|ActiveRecord|ActiveRecordInterface

Parameters

$className : string|null
$primaryKey : string|int

Return values

null|ActiveRecord|ActiveRecordInterface

resetPolymorphicRelation()

Resets the already loaded $_cached instance of the related object


    public
                    resetPolymorphicRelation() : mixed

setPolymorphicRelation()

Sets the related object


    public
                    setPolymorphicRelation(object|null $object) : mixed

Parameters

$object : object|null

validateUnderlyingObjectType()

Validates if given object is of an allowed type


    private
                    validateUnderlyingObjectType(mixed $object) : bool

Parameters

$object : mixed

Return values

bool

PolymorphicRelation extends Behavior in package Application

Tags

Table of Contents

Properties

Methods

Properties

$classAttribute

$mustBeInstanceOf

$owner

$pkAttribute

$polymorphicRelation

$strict

$_attachedEvents

$cached

Methods

__call()

Parameters

Tags

Return values

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

attach()

Parameters

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

detach()

events()

Return values

getObjectModel()

Parameters

Return values

getPolymorphicRelation()

Tags

Return values

hasMethod()

Parameters

Return values

hasProperty()

Parameters

Tags

Return values

init()

isPolymorphicRelationLoaded()

Tags

Return values

loadActiveRecord()

Parameters

Return values

resetPolymorphicRelation()

setPolymorphicRelation()

PolymorphicRelation extends Behavior
in package

Application