class User extends BaseResource

User class.

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

Properties

protected User $sys
protected Client|null $client from BaseResource
protected string $firstName
protected string $lastName
protected string $avatarUrl
protected string $email
protected bool $activated
protected int $signInCount
protected bool $confirmed

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.

getSystemProperties()

{@inheritdoc}

jsonSerialize()

{@inheritdoc}

string[]
asUriParameters()

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

getFirstName()

No description

getLastName()

No description

getAvatarUrl()

No description

getEmail()

No description

isActivated()

No description

getSignInCount()

No description

isConfirmed()

No description

Details

in BaseResource at line 37
getId()

{@inheritdoc}

in BaseResource at line 45
getType()

{@inheritdoc}

{@inheritdoc}

at line 100
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 75
getSystemProperties()

{@inheritdoc}

at line 83
jsonSerialize()

{@inheritdoc}

at line 108
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 113
getFirstName()

at line 118
getLastName()

at line 123
getAvatarUrl()

at line 128
getEmail()

at line 133
isActivated()

at line 138
getSignInCount()

at line 143
isConfirmed()