Role
class Role extends BaseResource implements CreatableInterface
Role class.
This class represents a resource with type "Role" in Contentful.
Traits
Properties
| SystemProperties | $sys | from UpdatableTrait | |
| Client | $client | from UpdatableTrait | |
| protected string | $name | ||
| protected string | $description | ||
| protected Policy[] | $policies | ||
| protected Permissions | $permissions |
Methods
Role constructor.
Returns an array to be used by "json_encode" to serialize objects of this class.
Returns an associate 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 39
protected
initialize(string $type, array $sys = [])
Initialize system properties.
in BaseResource at line 48
getSystemProperties()
{@inheritdoc}
in BaseResource at line 56
getId()
{@inheritdoc}
in BaseResource at line 64
getType()
{@inheritdoc}
in BaseResource at line 72
asLink()
{@inheritdoc}
in UpdatableTrait at line 33
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 98
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 29
delete()
Deletes the current resource.
in UpdatableTrait at line 38
update()
Deletes the current resource.
at line 57
__construct(string $name = '', string $description = '')
Role constructor.
at line 70
array
jsonSerialize()
Returns an array to be used by "json_encode" to serialize objects of this class.
at line 84
string[]
asUriParameters()
Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.
at line 95
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.