TargetAwareType

TargetAwareType.php : 22 Copy path

Extends Type

Represents Limitation type.

Indicates that Limitation Type implementation properly supports $targets passed as instances of Target.

Tags

Constants¶

ACCESS_ABSTAIN ¶

Type.php : 34 Copy path

public mixed ACCESS_ABSTAIN = null

ACCESS_DENIED ¶

Type.php : 35 Copy path

public mixed ACCESS_DENIED = false

ACCESS_GRANTED ¶

Type.php : 33 Copy path

Constants for return value of {@see evaluate()}.

public mixed ACCESS_GRANTED = true

Currently ACCESS_ABSTAIN must mean that evaluate does not support the provided $object or $targets, this is currently only supported by role limitations as policy limitations should not allow this.

Note: In future version constant values might change to 1, 0 and -1 as used in Symfony.

VALUE_SCHEMA_LOCATION_ID ¶

Type.php : 43 Copy path

Constants for valueSchema() return values.

public mixed VALUE_SCHEMA_LOCATION_ID = 1

Used in cases where a certain value is accepted but the options are to many to return as a hash of options. GUI should typically present option to browse content tree to select limitation value(s).

VALUE_SCHEMA_LOCATION_PATH ¶

Type.php : 44 Copy path

public mixed VALUE_SCHEMA_LOCATION_PATH = 2

Methods¶

acceptValue() ¶

Type.php : 55 Copy path

Accepts a Limitation value and checks for structural validity.

public acceptValue(Limitation $limitationValue) : mixed

Makes sure LimitationValue object and ->limitationValues is of correct type.

Parameters

Name	Type	Default value	Description
$limitationValue	Limitation	-	-

Tags

buildValue() ¶

Type.php : 78 Copy path

Create the Limitation Value.

public buildValue(array<string|int, mixed> $limitationValues) : Limitation

The is the method to create values as Limitation type needs value knowledge anyway in acceptValue, the reverse relation is provided by means of identifier lookup (Value has identifier, and so does RoleService).

Parameters

Name	Type	Default value	Description
$limitationValues	array<string\|int, mixed>	-	-

Return values

Limitation

evaluate() ¶

TargetAwareType.php : 38 Copy path

Evaluate ("Vote") against a main value object and targets for the context.

public evaluate(Limitation $value, UserReference $currentUser, ValueObject $object[, array<string|int, Target>|null $targets = null ]) : bool|null

Parameters

Name	Type	Default value	Description
$value	Limitation	-	-
$currentUser	UserReference	-	-
$object	ValueObject	-	-
$targets	array<string\|int, Target>\|null	null	An array of location, parent or "assignment" objects, if null: none where provided by caller

Return values

bool|null

Returns one of ACCESS_* constants

Tags

getCriterion() ¶

Type.php : 110 Copy path

Returns Criterion for use in find() query.

public getCriterion(Limitation $value, UserReference $currentUser) : CriterionInterface|LogicalOperator

Parameters

Name	Type	Default value	Description
$value	Limitation	-	-
$currentUser	UserReference	-	-

Return values

CriterionInterface|LogicalOperator

Tags

validate() ¶

Type.php : 66 Copy path

Makes sure LimitationValue->limitationValues is valid according to valueSchema().

public validate(Limitation $limitationValue) : array<string|int, ValidationError>

Make sure Type::acceptValue() is checked first.

Parameters

Name	Type	Default value	Description
$limitationValue	Limitation	-	-

Return values

array<string|int, ValidationError>

valueSchema() ¶

Type.php : 119 Copy path

Returns info on valid $limitationValues.

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

Return values

array<string|int, mixed>|int

In case of array, a hash with key as valid limitations value and value as human readable name of that option, in case of int on of VALUE_SCHEMA_* constants. Note: The hash might be an instance of Traversable, and not a native php array.