1. class
  2. Contentful
  3. \
  4. Management
  5. \
  6. Resource
  7. \
  8. User

User

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}

from BaseResource
getType()

{@inheritdoc}

from BaseResource
asLink()

{@inheritdoc}

from BaseResource
mixed
asRequestBody()

Returns the resource in the form of request body.

BaseResource
setClient(Client $client)

Sets the current Client object instance.

from BaseResource
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.

string
getFirstName()

No description

string
getLastName()

No description

string
getAvatarUrl()

No description

string
getEmail()

No description

bool
isActivated()

No description

int
getSignInCount()

No description

bool
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 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 75
getSystemProperties()

{@inheritdoc}

at line 83
jsonSerialize()

{@inheritdoc}

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 119
string getFirstName()

Return Value

string

at line 127
string getLastName()

Return Value

string

at line 135
string getAvatarUrl()

Return Value

string

at line 143
string getEmail()

Return Value

string

at line 151
bool isActivated()

Return Value

bool

at line 159
int getSignInCount()

Return Value

int

at line 167
bool isConfirmed()

Return Value

bool