class PersonalAccessToken extends BaseResource implements CreatableInterface

PersonalAccessToken class.

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

Properties

protected PersonalAccessToken $sys
protected Client|null $client from BaseResource
protected string $name
protected DateTimeImmutable|null $revokedAt
protected bool $isReadOnly
protected string|null $token

Methods

getId()

{@inheritdoc}

getType()

{@inheritdoc}

asLink()

{@inheritdoc}

mixed
asRequestBody()

Returns the resource in the form of request body.

setClient(Client $client)

Sets the current Client object instance.

__construct(string $name = '', bool $isReadOnly = false)

PersonalAccessToken constructor.

getSystemProperties()

{@inheritdoc}

jsonSerialize()

{@inheritdoc}

string[]
getHeadersForCreation()

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

string[]
asUriParameters()

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

revoke()

Revokes the personal access token.

string
getName()

No description

setName(string $name)

No description

DateTimeImmutable|null
getRevokedAt()

No description

setReadOnly(bool $isReadOnly)

No description

isReadOnly()

No description

string|null
getToken()

No description

Details

in BaseResource at line 37
getId()

{@inheritdoc}

in BaseResource at line 45
getType()

{@inheritdoc}

{@inheritdoc}

at line 89
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 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.

Parameters

Client $client

Return Value

BaseResource

at line 56
__construct(string $name = '', bool $isReadOnly = false)

PersonalAccessToken constructor.

Parameters

string $name
bool $isReadOnly

at line 65
getSystemProperties()

{@inheritdoc}

at line 73
jsonSerialize()

{@inheritdoc}

at line 103
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.

Return Value

string[]

at line 111
string[] 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

string[]

at line 123
revoke()

Revokes the personal access token.

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens/token-revoking

at line 135
string getName()

Return Value

string

at line 145
PersonalAccessToken setName(string $name)

Parameters

string $name

Return Value

PersonalAccessToken

at line 155
DateTimeImmutable|null getRevokedAt()

Return Value

DateTimeImmutable|null

at line 163
PersonalAccessToken setReadOnly(bool $isReadOnly)

Parameters

bool $isReadOnly

Return Value

PersonalAccessToken

at line 170
isReadOnly()

at line 178
string|null getToken()

Return Value

string|null