Copied!

Policy

Policy.php : 22
Extends ValueObject

This class represents a policy value.

Properties

public $function read-only

Policy.php 
public string $function

Name of the module function Or all functions with '*'

public $id read-only

Policy.php 
public mixed $id

internal id of the policy

public $limitations read-only

Policy.php 
public array<string|int, Limitation> $limitations

an array of \Ibexa\Contracts\Core\Repository\Values\User\Limitation

public $module read-only

Policy.php 
public string $module

Name of module, associated with the Policy

public $roleId read-only

Policy.php 
public mixed $roleId

the role id this policy belongs to

protected $function

Policy.php : 54

Name of the module function Or all functions with '*'.

 
protected string $function

Eg: read

protected $id

Policy.php : 29

ID of the policy.

 
protected int $id

protected $module

Policy.php : 45

Name of module, associated with the Policy.

 
protected string $module

Eg: content

protected $roleId

Policy.php : 36

the ID of the role this policy belongs to.

 
protected int $roleId

Methods

public__construct()

ValueObject.php : 30

Construct object optionally with a set of properties.

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

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

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

publicgetLimitations()

Policy.php : 59 
public abstract getLimitations() : array<string|int, Limitation>

Return values

array<string|int, Limitation>

protectedgetProperties()

ValueObject.php : 50

Function where list of properties are returned.

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

Used by attributes(), override to add dynamic properties

Parameters

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

Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>