class Role extends BaseResource implements CreatableInterface

Role class.

This class represents a resource with type "Role" in Contentful.

Traits

DeletableTrait.
UpdatableTrait.

Properties

protected Role $sys
Client $client from UpdatableTrait
protected string $name
protected string $description
protected Policy[] $policies
protected Permissions $permissions

Methods

string
getId()

{@inheritdoc}

string
getType()

{@inheritdoc}

Link
asLink()

{@inheritdoc}

mixed
asRequestBody()

Returns the resource in the form of request body.

setClient(Client $client)

Sets the current Client object instance.

delete()

Deletes the current resource.

update()

Updates the current resource.

getSystemProperties()

{@inheritdoc}

__construct(string $name = '', string $description = '')

Role constructor.

array
jsonSerialize()

{@inheritdoc}

array
asUriParameters()

Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

array
getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

string
getName()

No description

setName(string $name)

No description

string
getDescription()

No description

setDescription(string $description)

No description

getPermissions()

No description

array
getPolicies()

No description

setPolicies(array $policies)

No description

addPolicy(Policy $policy)

No description

Details

in BaseResource at line 37
string getId()

{@inheritdoc}

Return Value

string

in BaseResource at line 45
string getType()

{@inheritdoc}

Return Value

string

{@inheritdoc}

Return Value

Link

in UpdatableTrait at line 35
abstract mixed asRequestBody()

Returns the resource in the form of request body.

This can differ from regular serialization, as some fields may not be present in the request payload.

Return Value

mixed

in BaseResource at line 79
BaseResource setClient(Client $client)

Sets the current Client object instance.

This is done automatically when performing API calls, so it shouldn't be used manually.

Parameters

Client $client

Return Value

BaseResource

in DeletableTrait at line 28
delete()

Deletes the current resource.

in UpdatableTrait at line 40
update()

Updates the current resource.

at line 74
Role getSystemProperties()

{@inheritdoc}

Return Value

Role

at line 64
__construct(string $name = '', string $description = '')

Role constructor.

Parameters

string $name
string $description

at line 82
array jsonSerialize()

{@inheritdoc}

Return Value

array

at line 96
array asUriParameters()

Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

Return Value

array

at line 107
array getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

This method is supposed to be overridden if necessary.

Return Value

array

at line 115
string getName()

Return Value

string

at line 125
Role setName(string $name)

Parameters

string $name

Return Value

Role

at line 135
string getDescription()

Return Value

string

at line 145
Role setDescription(string $description)

Parameters

string $description

Return Value

Role

at line 155
Permissions getPermissions()

Return Value

Permissions

at line 163
array getPolicies()

Return Value

array

at line 173
Role setPolicies(array $policies)

Parameters

array $policies

Return Value

Role

at line 185
Role addPolicy(Policy $policy)

Parameters

Policy $policy

Return Value

Role