Role
class Role extends BaseResource implements CreatableInterface
Role class.
This class represents a resource with type "Role" in Contentful.
Traits
Properties
| protected Role | $sys | ||
| Client | $client | from UpdatableTrait | |
| protected string | $name | ||
| protected string | $description | ||
| protected Policy[] | $policies | ||
| protected Permissions | $permissions |
Methods
{@inheritdoc}
Role constructor.
{@inheritdoc}
Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.
Returns an array of headers that the current resource needs to sent for being created.
No description
No description
No description
No description
No description
No description
Details
in BaseResource at line 37
getId()
{@inheritdoc}
in BaseResource at line 45
getType()
{@inheritdoc}
in BaseResource at line 53
asLink()
{@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.
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.
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.
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.
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.