SpaceMembership
class SpaceMembership extends BaseResource implements CreatableInterface
SpaceMembership class.
This class represents a resource with type "SpaceMembership" in Contentful.
Traits
Properties
| protected SpaceMembership | $sys | ||
| Client | $client | from UpdatableTrait | |
| protected bool | $admin | ||
| protected string|null | |||
| protected Link[] | $roles | ||
| protected Link|null | $user |
Methods
{@inheritdoc}
{@inheritdoc}
Returns an array of headers that the current resource needs to sent for being created.
Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.
No description
No description
No description
No description
No description
No description
Shortcut for adding a link to a role.
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 60
getSystemProperties()
{@inheritdoc}
at line 68
jsonSerialize()
{@inheritdoc}
at line 86
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.
at line 94
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 102
isAdmin()
at line 110
SpaceMembership
setAdmin(bool $admin)
at line 120
string|null
getEmail()
at line 128
SpaceMembership
setEmail(string $email)
at line 138
Link[]
getRoles()
at line 146
SpaceMembership
addRole(Link $role)
at line 158
SpaceMembership
addRoleLink(string $roleId)
Shortcut for adding a link to a role.