class User extends BaseResource

User class.

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

Properties

protected SystemProperties $sys from BaseResource
protected BaseProxy $proxy from BaseResource
protected string $firstName
protected string $lastName
protected string $avatarUrl
protected string $email
protected bool $activated
protected int $signInCount
protected bool $confirmed

Methods

__construct()

User constructor.

getSystemProperties()

Returns the resource's system properties, defined in the object "sys" in Contentful's responses.

string|null
getId()

Shortcut for accessing the resource ID through its system properties.

Link
asLink()

Creates a Link representation of the current resource.

setProxy(BaseProxy $proxy)

Sets the current BaseProxy object instance.

asRequestBody()

{@inheritdoc}

__call(string $name, array $arguments)

Shortcut for forwarding methods to the current proxy, using the current object as argument.

array
jsonSerialize()

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

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

at line 59
final __construct()

User constructor.

in BaseResource at line 47
SystemProperties getSystemProperties()

Returns the resource's system properties, defined in the object "sys" in Contentful's responses.

Return Value

SystemProperties

in BaseResource at line 57
string|null getId()

Shortcut for accessing the resource ID through its system properties.

Return Value

string|null

Creates a Link representation of the current resource.

Return Value

Link

in BaseResource at line 79
BaseResource setProxy(BaseProxy $proxy)

Sets the current BaseProxy object instance.

This is done automatically when performing API calls, so it shouldn't be used manually.

Parameters

BaseProxy $proxy

Return Value

BaseResource

at line 89
asRequestBody()

{@inheritdoc}

in BaseResource at line 111
__call(string $name, array $arguments)

Shortcut for forwarding methods to the current proxy, using the current object as argument.

// Instead of
$client->asset->publish($asset);
// You can use
$asset->publish();

Parameters

string $name
array $arguments

at line 72
array jsonSerialize()

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

Return Value

array

at line 100
string getFirstName()

Return Value

string

at line 108
string getLastName()

Return Value

string

at line 116
string getAvatarUrl()

Return Value

string

at line 124
string getEmail()

Return Value

string

at line 132
bool isActivated()

Return Value

bool

at line 140
int getSignInCount()

Return Value

int

at line 148
bool isConfirmed()

Return Value

bool