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

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.

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

PersonalAccessToken constructor.

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.

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 37
string getId()

{@inheritdoc}

Return Value

string

in BaseResource at line 45
string getType()

{@inheritdoc}

Return Value

string

{@inheritdoc}

Return Value

Link

at line 92
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

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

PersonalAccessToken constructor.

Parameters

string $name
bool $isReadOnly

at line 68
PersonalAccessToken getSystemProperties()

{@inheritdoc}

Return Value

PersonalAccessToken

at line 76
array jsonSerialize()

{@inheritdoc}

Return Value

array

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

Return Value

string

at line 148
PersonalAccessToken setName(string $name)

Parameters

string $name

Return Value

PersonalAccessToken

at line 158
DateTimeImmutable|null getRevokedAt()

Return Value

DateTimeImmutable|null

at line 168
PersonalAccessToken setReadOnly(bool $isReadOnly)

Parameters

bool $isReadOnly

Return Value

PersonalAccessToken

at line 178
bool isReadOnly()

Return Value

bool

at line 186
string|null getToken()

Return Value

string|null