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

getId()

{@inheritdoc}

getType()

{@inheritdoc}

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.

jsonSerialize()

{@inheritdoc}

string[]
asUriParameters()

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

string[]
getHeadersForCreation()

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

getName()

No description

setName(string $name)

No description

getDescription()

No description

setDescription(string $description)

No description

getPermissions()

No description

Policy[]
getPolicies()

No description

setPolicies(array $policies)

No description

addPolicy(Policy $policy)

No description

Details

in BaseResource at line 37
getId()

{@inheritdoc}

in BaseResource at line 45
getType()

{@inheritdoc}

{@inheritdoc}

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 77
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 71
getSystemProperties()

{@inheritdoc}

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

Role constructor.

Parameters

string $name
string $description

at line 79
jsonSerialize()

{@inheritdoc}

at line 93
string[] 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

string[]

at line 104
string[] 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

string[]

at line 109
getName()

at line 117
Role setName(string $name)

Parameters

string $name

Return Value

Role

at line 124
getDescription()

at line 134
Role setDescription(string $description)

Parameters

string $description

Return Value

Role

at line 144
Permissions getPermissions()

Return Value

Permissions

at line 152
Policy[] getPolicies()

Return Value

Policy[]

at line 162
Role setPolicies(array $policies)

Parameters

array $policies

Return Value

Role

at line 172
Role addPolicy(Policy $policy)

Parameters

Policy $policy

Return Value

Role