class SpaceMembership extends BaseResource implements CreatableInterface

SpaceMembership class.

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

Traits

DeletableTrait.
UpdatableTrait.

Properties

protected SpaceMembership $sys
Client $client from UpdatableTrait
protected bool $admin
protected string|null $email
protected Link[] $roles
protected Link|null $user

Methods

string
getId()

{@inheritdoc}

string
getType()

{@inheritdoc}

Link
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.

array
jsonSerialize()

{@inheritdoc}

array
getHeadersForCreation()

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

array
asUriParameters()

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

bool
isAdmin()

No description

setAdmin(bool $admin)

No description

string|null
getEmail()

No description

setEmail(string $email)

No description

array
getRoles()

No description

addRole(Link $role)

No description

addRoleLink(string $roleId)

Shortcut for adding a link to a role.

setRoles(array $roles = [])

No description

Link|null
getUser()

No description

Details

in BaseResource at line 37
string getId()

{@inheritdoc}

Return Value

string

in BaseResource at line 45
string getType()

{@inheritdoc}

Return Value

string

{@inheritdoc}

Return Value

Link

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 79
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 60
SpaceMembership getSystemProperties()

{@inheritdoc}

Return Value

SpaceMembership

at line 68
array jsonSerialize()

{@inheritdoc}

Return Value

array

at line 86
array 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

array

at line 94
array 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

array

at line 105
bool isAdmin()

Return Value

bool

at line 115
SpaceMembership setAdmin(bool $admin)

Parameters

bool $admin

Return Value

SpaceMembership

at line 125
string|null getEmail()

Return Value

string|null

at line 135
SpaceMembership setEmail(string $email)

Parameters

string $email

Return Value

SpaceMembership

at line 145
array getRoles()

Return Value

array

at line 155
SpaceMembership addRole(Link $role)

Parameters

Link $role

Return Value

SpaceMembership

Shortcut for adding a link to a role.

Parameters

string $roleId

Return Value

SpaceMembership

at line 179
SpaceMembership setRoles(array $roles = [])

Parameters

array $roles

Return Value

SpaceMembership

at line 189
Link|null getUser()

Return Value

Link|null