1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. User
  7. \
  8. UserInfo

UserInfo

class UserInfo extends ConcreteObject implements ObjectInterface, ObjectInterface, ExportableInterface (View source)

Traits

ObjectTrait

Properties

$error from  ConcreteObject
protected AvatarServiceInterface $avatarService
protected Application $application
protected UserCategory $attributeCategory
protected EntityManagerInterface $entityManager
protected Connection $connection
protected User $entity
protected EventDispatcher|null $director

Methods

loadError($error)

No description

from  ConcreteObject
isError()

No description

from  ConcreteObject
getError()

No description

from  ConcreteObject
setPropertiesFromArray($arr)

No description

from  ConcreteObject
static 
camelcase($file)

No description

from  ConcreteObject
static 
uncamelcase($string)

No description

from  ConcreteObject
CategoryInterface
getObjectAttributeCategory()

No description

AttributeValueInterface|null
getAttributeValueObject(AttributeKeyInterface|string $ak, bool $createIfNotExists = false)

No description

getAttribute($ak, $mode = false)

No description

from  ObjectTrait
Value
getAttributeValue($ak)

No description

from  ObjectTrait
clearAttribute($ak, bool $doReindexImmediately = true)

No description

from  ObjectTrait
Value
setAttribute($ak, mixed $value, bool $doReindexImmediately = true)

Sets the attribute of a user info object to the specified value, and saves it in the database.

from  ObjectTrait
__construct(EntityManagerInterface $entityManager, UserCategory $attributeCategory, Application $application, AvatarServiceInterface $avatarService)

No description

string
__toString()

No description

getPermissionObjectIdentifier()

No description

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

setEntityObject(User $entity)

No description

User
getEntityObject()

No description

ItemInterface
getExporter()

No description

Group[]
getUserBadges()

No description

bool
triggerDelete(User $requester)

No description

bool
delete()

Deletes a user.

bool
canReadPrivateMessage(PrivateMessage $msg)

No description

updateUserAvatar(ImageInterface $image)

No description

markAsPasswordReset()

Marks the current user as having had a password reset from the system.

ErrorList|false|null
sendPrivateMessage(UserInfo $recipient, string $subject, string $text, PrivateMessage $inReplyTo = null)

Sent a private message.

User
getUserObject()

Gets the User object of the current UserInfo object ($this).

bool|null
update(array $data)

No description

bool
passwordMatches($uPassword)

Checks the uPassword record for the current user and returns true if the hashed version of the passed password matches.

updateGroups(int[] $groupArray)

No description

string
setupValidation()

No description

true
markValidated()

No description

bool
changePassword(string $newPassword)

No description

bool
triggerActivate(string|null $action = null, int|null $requesterUID = null)

No description

activate()

No description

bool
triggerDeactivate(int|null $requesterUID = null)

No description

deactivate()

No description

string|null
resetUserPassword(int $length = 256)

No description

AvatarInterface
getUserAvatar()

No description

URLInterface|null
getUserPublicProfileUrl()

No description

bool
hasAvatar()

No description

getLastLogin()

No description

string|null
getLastIPAddress()

No description

getPreviousLogin()

No description

isActive()

No description

isValidated()

No description

isFullRecord()

No description

getNumLogins()

No description

getUserID()

No description

getUserName()

No description

getUserDisplayName()

No description

getUserPassword()

No description

getUserEmail()

No description

getUserTimezone()

No description

getUserDefaultLanguage()

No description

getUserDateAdded()

No description

getLastOnline()

No description

saveUserAttributesForm(UserAttributeKey[] $attributes)

No description

saveUserAttributesDefault(array $attributes)

No description

mixed|null
__call($nm, $a)

Magic method for user attributes. This is db expensive but pretty damn cool so if the attrib handle is "my_attribute", then get the attribute with $ui->getUserMyAttribute(), or "uFirstName" become $ui->getUserUfirstname();.

EventDispatcher
getDirector()

No description

static 
add($data) deprecated

No description

static 
addSuperUser($uPasswordEncrypted, $uEmail) deprecated

No description

static 
register($data) deprecated

No description

static 
getByID($uID) deprecated

No description

static 
getByUserName($uName) deprecated

No description

static 
getByEmail($uEmail) deprecated

No description

static 
getByValidationHash($uHash, $unredeemedHashesOnly = true) deprecated

No description

Details

in ConcreteObject at line 10
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 15
isError()

No description

in ConcreteObject at line 25
getError()

No description

in ConcreteObject at line 30
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 37
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 42
static uncamelcase($string)

No description

Parameters

$string

at line 982
CategoryInterface getObjectAttributeCategory()

No description

Return Value

CategoryInterface

See also

ObjectInterface::getObjectAttributeCategory

at line 993
AttributeValueInterface|null getAttributeValueObject(AttributeKeyInterface|string $ak, bool $createIfNotExists = false)

No description

Parameters

AttributeKeyInterface|string $ak

An attribute key instance (or its handle)
bool $createIfNotExists

Shall the generic attribute value be created if it does not already exist?

Return Value

AttributeValueInterface|null

in ObjectTrait at line 24
getAttribute($ak, $mode = false)

No description

Parameters

$ak
$mode

in ObjectTrait at line 36
Value getAttributeValue($ak)

No description

Parameters

$ak

Return Value

Value

in ObjectTrait at line 48
clearAttribute($ak, bool $doReindexImmediately = true)

No description

Parameters

$ak
bool $doReindexImmediately

in ObjectTrait at line 72
Value setAttribute($ak, mixed $value, bool $doReindexImmediately = true)

Sets the attribute of a user info object to the specified value, and saves it in the database.

Parameters

$ak
mixed $value
bool $doReindexImmediately

Return Value

Value

at line 97
__construct(EntityManagerInterface $entityManager, UserCategory $attributeCategory, Application $application, AvatarServiceInterface $avatarService)

No description

Parameters

EntityManagerInterface $entityManager
UserCategory $attributeCategory
Application $application
AvatarServiceInterface $avatarService

at line 109
string __toString()

No description

Return Value

string

at line 119
getPermissionObjectIdentifier()

No description

See also

ObjectInterface::getPermissionObjectIdentifier

at line 129
getPermissionResponseClassName()

No description

See also

ObjectInterface::getPermissionResponseClassName

at line 139
getPermissionAssignmentClassName()

No description

See also

ObjectInterface::getPermissionAssignmentClassName

at line 149
getPermissionObjectKeyCategoryHandle()

No description

See also

ObjectInterface::getPermissionObjectKeyCategoryHandle

at line 157
setEntityObject(User $entity)

No description

Parameters

User $entity

at line 165
User getEntityObject()

No description

Return Value

User

at line 170
ItemInterface getExporter()

No description

Return Value

ItemInterface

at line 178
Group[] getUserBadges()

No description

Return Value

Group[]

at line 195
bool triggerDelete(User $requester)

No description

Parameters

User $requester

Return Value

bool

at line 211
bool delete()

Deletes a user.

Return Value

bool

at line 303
bool canReadPrivateMessage(PrivateMessage $msg)

No description

Parameters

PrivateMessage $msg

Return Value

bool

at line 311
updateUserAvatar(ImageInterface $image)

No description

Parameters

ImageInterface $image

at line 342
markAsPasswordReset()

Marks the current user as having had a password reset from the system.

at line 360
ErrorList|false|null sendPrivateMessage(UserInfo $recipient, string $subject, string $text, PrivateMessage $inReplyTo = null)

Sent a private message.

Parameters

UserInfo $recipient
string $subject
string $text
PrivateMessage $inReplyTo

Return Value

ErrorList|false|null

Returns:

  • an error if the send limit has been reached
  • false if the message is detected as spam
  • null if no errors occurred

at line 456
User getUserObject()

Gets the User object of the current UserInfo object ($this).

Return Value

User

at line 469
bool|null update(array $data)

No description

Parameters

array $data

Return Value

bool|null

returns false if the record has not been saved, null if the password confirmation failed, true otherwise

at line 563
bool passwordMatches($uPassword)

Checks the uPassword record for the current user and returns true if the hashed version of the passed password matches.

Parameters

$uPassword

Return Value

bool

at line 572
updateGroups(int[] $groupArray)

No description

Parameters

int[] $groupArray

at line 627
string setupValidation()

No description

Return Value

string

at line 645
true markValidated()

No description

Return Value

true

at line 663
bool changePassword(string $newPassword)

No description

Parameters

string $newPassword

Return Value

bool

at line 678
bool triggerActivate(string|null $action = null, int|null $requesterUID = null)

No description

Parameters

string|null $action
int|null $requesterUID

Use null for the current user

Return Value

bool

at line 706
activate()

No description

at line 721
bool triggerDeactivate(int|null $requesterUID = null)

No description

Parameters

int|null $requesterUID

Use null for the current user

Return Value

bool

at line 744
deactivate()

No description

at line 759
string|null resetUserPassword(int $length = 256)

No description

Parameters

int $length

Return Value

string|null

at line 777
AvatarInterface getUserAvatar()

No description

Return Value

AvatarInterface

at line 785
URLInterface|null getUserPublicProfileUrl()

No description

Return Value

URLInterface|null

at line 805
bool hasAvatar()

No description

Return Value

bool

at line 813
getLastLogin()

No description

See also

User::getUserLastLogin

at line 821
string|null getLastIPAddress()

No description

Return Value

string|null

at line 831
getPreviousLogin()

No description

See also

User::getUserPreviousLogin

at line 839
isActive()

No description

See also

User::isUserActive

at line 847
isValidated()

No description

See also

User::isUserValidated

at line 855
isFullRecord()

No description

See also

User::isUserFullRecord

at line 863
getNumLogins()

No description

See also

User::getUserTotalLogins

at line 871
getUserID()

No description

See also

User::getUserID

at line 879
getUserName()

No description

See also

User::getUserName

at line 887
getUserDisplayName()

No description

See also

User::getUserName

at line 895
getUserPassword()

No description

See also

User::getUserPassword

at line 903
getUserEmail()

No description

See also

User::getUserEmail

at line 911
getUserTimezone()

No description

See also

User::getUserTimezone

at line 919
getUserDefaultLanguage()

No description

See also

User::getUserDefaultLanguage

at line 927
getUserDateAdded()

No description

See also

User::getUserDateAdded

at line 935
getLastOnline()

No description

See also

User::getUserLastOnline

at line 943
saveUserAttributesForm(UserAttributeKey[] $attributes)

No description

Parameters

UserAttributeKey[] $attributes

at line 959
saveUserAttributesDefault(array $attributes)

No description

Parameters

array $attributes

at line 1019
mixed|null __call($nm, $a)

Magic method for user attributes. This is db expensive but pretty damn cool so if the attrib handle is "my_attribute", then get the attribute with $ui->getUserMyAttribute(), or "uFirstName" become $ui->getUserUfirstname();.

Parameters

$nm
$a

Return Value

mixed|null

at line 1033
protected EventDispatcher getDirector()

No description

Return Value

EventDispatcher

at line 1045
static add($data) deprecated

deprecated Use \Core::make('user/registration')->create()

No description

Parameters

$data

at line 1053
static addSuperUser($uPasswordEncrypted, $uEmail) deprecated

deprecated Use \Core::make('user/registration')->createSuperUser()

No description

Parameters

$uPasswordEncrypted
$uEmail

at line 1061
static register($data) deprecated

deprecated Use \Core::make('user/registration')->createFromPublicRegistration()

No description

Parameters

$data

at line 1069
static getByID($uID) deprecated

deprecated use \Core::make('Concrete\Core\User\UserInfoRepository')->getByID()

No description

Parameters

$uID

at line 1077
static getByUserName($uName) deprecated

deprecated use \Core::make('Concrete\Core\User\UserInfoRepository')->getByName()

No description

Parameters

$uName

at line 1085
static getByEmail($uEmail) deprecated

deprecated use \Core::make('Concrete\Core\User\UserInfoRepository')->getByEmail()

No description

Parameters

$uEmail

at line 1093
static getByValidationHash($uHash, $unredeemedHashesOnly = true) deprecated

deprecated use \Core::make('Concrete\Core\User\UserInfoRepository')->getByValidationHash()

No description

Parameters

$uHash
$unredeemedHashesOnly