Copied!

PolicyStruct

PolicyStruct.php : 13
Abstract
Extends ValueObject

The base class for all value objects and structs.

Supports read-only properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using @property-read <type> <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Methods

public__construct()

ValueObject.php : 31

Construct object optionally with a set of properties.

public __construct([array<string, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they aren't writable anymore after object has been created.

Parameters

Name Type Default value Description
$properties array<string, mixed> [] -

publicaddLimitation()

PolicyStruct.php : 27

Adds a limitation with the given identifier and list of values.

public abstract addLimitation(Limitation $limitation) : void

Parameters

Name Type Default value Description
$limitation Limitation - -

publicgetLimitations()

PolicyStruct.php : 20

Returns list of limitations added to policy.

public abstract getLimitations() : array<string|int, Limitation>

Return values

array<string|int, Limitation>

protectedgetProperties()

ValueObject.php : 54

Returns list of available properties' names.

protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

Override to add dynamic properties.

Parameters

Name Type Default value Description
$dynamicProperties array<int, string> []

Additional dynamic properties exposed on the object

Return values

array<int, string>

Tags
Serializerignore

()