class Role extends BaseResource implements Creatable, Updatable, Deletable

Role class.

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

Properties

protected SystemProperties $sys from BaseResource
protected BaseProxy $proxy from BaseResource
protected string $name
protected string $description
protected Policy[] $policies
protected Permissions $permissions

Methods

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

Role constructor.

getSystemProperties()

Returns the resource's system properties, defined in the object "sys" in Contentful's responses.

string|null
getId()

Shortcut for accessing the resource ID through its system properties.

Link
asLink()

Creates a Link representation of the current resource.

setProxy(BaseProxy $proxy)

Sets the current BaseProxy object instance.

asRequestBody()

{@inheritdoc}

__call(string $name, array $arguments)

Shortcut for forwarding methods to the current proxy, using the current object as argument.

array
jsonSerialize()

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

string
getName()

No description

setName(string $name)

No description

string
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

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

Role constructor.

Parameters

string $name
string $description

in BaseResource at line 47
SystemProperties getSystemProperties()

Returns the resource's system properties, defined in the object "sys" in Contentful's responses.

Return Value

SystemProperties

in BaseResource at line 57
string|null getId()

Shortcut for accessing the resource ID through its system properties.

Return Value

string|null

Creates a Link representation of the current resource.

Return Value

Link

in BaseResource at line 79
BaseResource setProxy(BaseProxy $proxy)

Sets the current BaseProxy object instance.

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

Parameters

BaseProxy $proxy

Return Value

BaseResource

in BaseResource at line 89
asRequestBody()

{@inheritdoc}

in BaseResource at line 111
__call(string $name, array $arguments)

Shortcut for forwarding methods to the current proxy, using the current object as argument.

// Instead of
$client->asset->publish($asset);
// You can use
$asset->publish();

Parameters

string $name
array $arguments

at line 66
array jsonSerialize()

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

Return Value

array

at line 80
string getName()

Return Value

string

at line 90
Role setName(string $name)

Parameters

string $name

Return Value

Role

at line 100
string getDescription()

Return Value

string

at line 110
Role setDescription(string $description)

Parameters

string $description

Return Value

Role

at line 120
Permissions getPermissions()

Return Value

Permissions

at line 128
Policy[] getPolicies()

Return Value

Policy[]

at line 138
Role setPolicies(array $policies)

Parameters

array $policies

Return Value

Role

at line 150
Role addPolicy(Policy $policy)

Parameters

Policy $policy

Return Value

Role