class PersonalAccessToken extends BaseResource implements CreatableInterface

PersonalAccessToken class.

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

Properties

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

Methods

initialize(string $type, array $sys = [])

Initialize system properties.

getSystemProperties()

{@inheritdoc}

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.

array
jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

string[]
getHeadersForCreation()

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

string[]
asUriParameters()

Returns an associate 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

bool
isReadOnly()

No description

string|null
getToken()

No description

Details

in BaseResource at line 39
protected initialize(string $type, array $sys = [])

Initialize system properties.

Parameters

string $type The system type
array $sys

in BaseResource at line 48
getSystemProperties()

{@inheritdoc}

in BaseResource at line 56
getId()

{@inheritdoc}

in BaseResource at line 64
getType()

{@inheritdoc}

{@inheritdoc}

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

Parameters

Client $client

Return Value

BaseResource

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

PersonalAccessToken constructor.

Parameters

string $name
bool $isReadOnly

at line 64
array jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Return Value

array

at line 94
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 102
string[] asUriParameters()

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

Return Value

string[]

at line 114
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 122
string getName()

Return Value

string

at line 132
PersonalAccessToken setName(string $name)

Parameters

string $name

Return Value

PersonalAccessToken

at line 142
DateTimeImmutable|null getRevokedAt()

Return Value

DateTimeImmutable|null

at line 150
setReadOnly(bool $isReadOnly)

Parameters

bool $isReadOnly

at line 160
bool isReadOnly()

Return Value

bool

at line 168
string|null getToken()

Return Value

string|null