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 SystemProperties $sys from BaseResource
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

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

Initialize system properties.

from BaseResource
getSystemProperties()

{@inheritdoc}

from BaseResource
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
array
jsonSerialize()

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

string[]
asUriParameters()

Returns an associate 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 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 86
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 69
array jsonSerialize()

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

Return Value

array

at line 97
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 105
string getFirstName()

Return Value

string

at line 113
string getLastName()

Return Value

string

at line 121
string getAvatarUrl()

Return Value

string

at line 129
string getEmail()

Return Value

string

at line 137
bool isActivated()

Return Value

bool

at line 145
int getSignInCount()

Return Value

int

at line 153
bool isConfirmed()

Return Value

bool