1. class
  2. Contentful
  3. \
  4. Management
  5. \
  6. Resource
  7. \
  8. Role
  9. \
  10. Policy

Policy

class Policy implements JsonSerializable

Policy class.

Constants

EFFECTS

ACTIONS

Methods

__construct(string $effect, string|array $actions = [], ConstraintInterface $constraint = null)

Policy constructor.

string
getEffect()

No description

Policy
setEffect(string $effect)

No description

string|string[]
getActions()

No description

Policy
setActions(string|string[] $actions)

No description

Policy
addAction(string $action)

No description

ConstraintInterface|null
getConstraint()

No description

Policy
setConstraint(ConstraintInterface $constraint = null)

No description

array
jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Details

at line 63
__construct(string $effect, string|array $actions = [], ConstraintInterface $constraint = null)

Policy constructor.

Parameters

string $effect Either "allow" or "deny"
string|array $actions Either "all" or an array
ConstraintInterface $constraint

at line 73
string getEffect()

Return Value

string Either "allow" or "deny"

at line 83
Policy setEffect(string $effect)

Parameters

string $effect Either "allow" or "deny"

Return Value

Policy

at line 100
string|string[] getActions()

Return Value

string|string[] Either the string "all", or an array with available actions

at line 110
Policy setActions(string|string[] $actions)

Parameters

string|string[] $actions Either the string "all", or an array with available actions

Return Value

Policy

at line 133
Policy addAction(string $action)

Parameters

string $action

Return Value

Policy

at line 157
ConstraintInterface|null getConstraint()

Return Value

ConstraintInterface|null

at line 167
Policy setConstraint(ConstraintInterface $constraint = null)

Parameters

ConstraintInterface $constraint

Return Value

Policy

at line 179
array jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Return Value

array