CoolCMS API

User extends User
in package

Tags
extends
Attributes
#[Entity]
#[Table]
$name: 'cms_system_users'
#[TableAlias]
'user'

Table of Contents

Properties

$aboutMe  : string|null
$activated  : bool
$activationExpires  : DateTime|null
$activationKey  : string
$affiliateDisabled  : bool
$assetPath  : string|null
$banned  : bool
$city  : string|null
$companyName  : string|null
$country  : string|null
$countryCode  : string|null
$credits  : int
$deletedAt  : DateTime|null
$deletionClaimedAt  : DateTime|null
$deletionNonce  : string|null
$deletionRequestedAt  : DateTime|null
$deletionTokenExpires  : DateTime|null
$deletionTokenHash  : string|null
$discount  : int
$discountLevelId  : int|null
$email  : string|null
$externalId  : string|null
$firstname  : string
$id  : int|null
$ip  : string|null
$isCompany  : bool
$languageId  : int|null
$lastname  : string
$memberUntil  : DateTime|null
$parentUserId  : int|null
$password  : string
$passwordResetExpires  : DateTime|null
$passwordResetHash  : string|null
$paymentRegionId  : int|null
$phone  : string|null
$points  : int
$ratingThreadId  : int|null
$referralCode  : string|null
$referrerCode  : string|null
$referrerUserId  : int|null
$regId  : string|null
$regionId  : int|null
$registrationDatetime  : DateTime|null
$salt  : string
$state  : string|null
$street  : string|null
$type  : string
$url  : string|null
$username  : string
$userRoles  : Collection
$userTypeId  : int|null
$vatId  : string|null
$zip  : string|null
$assetFile  : FtpAsset|null
Transient cache of the derived `FtpAsset` (not a database column).

Methods

__construct()  : mixed
addUserRole()  : $this
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getAboutMe()  : string|null
getActivated()  : bool
getActivationExpires()  : DateTime|null
getActivationKey()  : string
getAffiliateDisabled()  : bool
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getAssetFile()  : FtpAsset|null
Returns the `FtpAsset` derived from the path (lazy, works after Doctrine hydration too).
getAssetPath()  : string|null
getBanned()  : bool
getCity()  : string|null
getCompanyName()  : string|null
getCountry()  : string|null
getCountryCode()  : string|null
getCredits()  : int
getDeletedAt()  : DateTime|null
getDeletionClaimedAt()  : DateTime|null
getDeletionNonce()  : string|null
getDeletionRequestedAt()  : DateTime|null
getDeletionTokenExpires()  : DateTime|null
getDeletionTokenHash()  : string|null
getDiscount()  : int
getDiscountLevelId()  : int|null
getEmail()  : string|null
getExternalId()  : string|null
getFirstname()  : string
getId()  : int|null
getIp()  : string|null
getLanguageId()  : int|null
getLastname()  : string
getMemberUntil()  : DateTime|null
getParentUserId()  : int|null
getPassword()  : string
getPasswordResetExpires()  : DateTime|null
getPasswordResetHash()  : string|null
getPaymentRegionId()  : int|null
getPhone()  : string|null
getPoints()  : int
getRatingThreadId()  : int|null
getReferralCode()  : string|null
getReferrerCode()  : string|null
getReferrerUserId()  : int|null
getRegId()  : string|null
getRegionId()  : int|null
getRegistrationDatetime()  : DateTime|null
getSalt()  : string
getState()  : string|null
getStreet()  : string|null
getType()  : string
getUrl()  : string|null
getUsername()  : string
getUserRoles()  : Collection<int, TRole>
Roles of the user: a single collection `$userRoles` (mapped by the ORM in the Api layer, `#[Transient]` protects it from being overwritten on an admin save). Keep it single: a second unmapped collection made the getter return empty roles (JWT `role` claim and bridge payload without roles), hence `UserRelationManager` syncs the relations set-based over DBAL.
getUserTypeId()  : int|null
getVatId()  : string|null
getZip()  : string|null
isActivated()  : bool
isAffiliateDisabled()  : bool
isBanned()  : bool
isCompany()  : bool
isDeleted()  : bool
Anonymized (deleted) account — it can never sign in or be saved again.
isDeletionPending()  : bool
Deletion requested and still waiting for the grace period to pass.
isPersisted()  : bool
removeUserRole()  : $this
setAboutMe()  : $this
setActivated()  : $this
setActivationExpires()  : TRole>
setActivationKey()  : $this
setAffiliateDisabled()  : TRole>
setAssetPath()  : $this
setBanned()  : $this
setCity()  : $this
setCompanyName()  : $this
setCountry()  : $this
setCountryCode()  : TRole>
setCredits()  : $this
setDeletedAt()  : TRole>
setDeletionClaimedAt()  : TRole>
setDeletionNonce()  : TRole>
setDeletionRequestedAt()  : TRole>
setDeletionTokenExpires()  : TRole>
setDeletionTokenHash()  : TRole>
setDiscount()  : $this
setDiscountLevelId()  : $this
setEmail()  : $this
setExternalId()  : $this
setFirstname()  : $this
setId()  : $this
setIp()  : $this
setIsCompany()  : $this
setLanguageId()  : $this
setLastname()  : $this
setMemberUntil()  : $this
setParentUserId()  : $this
setPassword()  : $this
setPasswordResetExpires()  : TRole>
setPasswordResetHash()  : TRole>
setPaymentRegionId()  : $this
setPhone()  : $this
setPoints()  : $this
setRatingThreadId()  : $this
setReferralCode()  : TRole>
setReferrerCode()  : TRole>
setReferrerUserId()  : TRole>
setRegId()  : $this
setRegionId()  : $this
setRegistrationDatetime()  : $this
setSalt()  : $this
setState()  : $this
setStreet()  : $this
setType()  : $this
setUrl()  : $this
setUsername()  : $this
setUserRoles()  : $this
setUserTypeId()  : $this
setVatId()  : $this
setZip()  : $this
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$aboutMe

protected string|null $aboutMe = null
Attributes
#[Column]
$type: "text"
$nullable: true
#[PersonalData]
PersonalDataKind::Hidden

$activated

protected bool $activated = false
Attributes
#[Column]
$type: "boolean"
$options: ["default" => false]
#[ExternalReadonly]

$activationExpires

protected DateTime|null $activationExpires = null
Attributes
#[Column]
$name: 'activation_expires'
$type: 'datetime'
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$activationKey

protected string $activationKey = ''
Attributes
#[Column]
$name: "activation_key"
$type: "string"
$length: 64
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$affiliateDisabled

protected bool $affiliateDisabled = false
Attributes
#[Column]
$name: 'affiliate_disabled'
$type: 'boolean'
$options: ['default' => 0]
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::Owner
$insert: Audience::Privileged
$update: Audience::Privileged

$assetPath

protected string|null $assetPath = null
Attributes
#[Column]
$name: "asset_path"
$type: "string"
$length: 255
$nullable: true
#[FieldAccess]
$read: Audience::All
$insert: Audience::Privileged
$update: Audience::Privileged

$banned

protected bool $banned = false
Attributes
#[Column]
$type: "boolean"
$options: ["default" => false]
#[ExternalReadonly]

$city

protected string|null $city = null
Attributes
#[Column]
$type: "string"
$length: 80
$nullable: true

$companyName

protected string|null $companyName = null
Attributes
#[Column]
$type: "string"
$length: 255
$nullable: true
#[PersonalData]
PersonalDataKind::Hidden

$country

protected string|null $country = null
Attributes
#[Column]
$type: "string"
$length: 80
$nullable: true

$countryCode

protected string|null $countryCode = null
Attributes
#[Column]
$name: "country_code"
$type: "string"
$length: 2
$nullable: true
$options: ["fixed" => true]

$credits

protected int $credits = 0
Attributes
#[Column]
$type: "integer"
$options: ["default" => 0]
#[FieldAccess]
$read: Audience::All
$insert: Audience::Privileged
$update: Audience::Privileged
#[PersonalData]
PersonalDataKind::Hidden

$deletedAt

protected DateTime|null $deletedAt = null
Attributes
#[Column]
$name: 'deleted_at'
$type: 'datetime'
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::Privileged
$insert: Audience::None
$update: Audience::None

$deletionClaimedAt

protected DateTime|null $deletionClaimedAt = null
Attributes
#[Column]
$name: 'deletion_claimed_at'
$type: 'datetime'
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$deletionNonce

protected string|null $deletionNonce = null
Attributes
#[Column]
$name: 'deletion_nonce'
$type: 'string'
$length: 32
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$deletionRequestedAt

protected DateTime|null $deletionRequestedAt = null
Attributes
#[Column]
$name: 'deletion_requested_at'
$type: 'datetime'
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::Privileged
$insert: Audience::None
$update: Audience::None

$deletionTokenExpires

protected DateTime|null $deletionTokenExpires = null
Attributes
#[Column]
$name: 'deletion_token_expires'
$type: 'datetime'
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$deletionTokenHash

protected string|null $deletionTokenHash = null
Attributes
#[Column]
$name: 'deletion_token_hash'
$type: 'string'
$length: 64
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$discount

protected int $discount = 0
Attributes
#[Column]
$type: "integer"
$options: ["default" => 0]
#[FieldAccess]
$read: Audience::All
$insert: Audience::Privileged
$update: Audience::Privileged
#[PersonalData]
PersonalDataKind::Hidden

$discountLevelId

protected int|null $discountLevelId = null
Attributes
#[Column]
$type: "integer"
$nullable: true
$name: "cms_system_user_discount_levels_discount_level_id"
#[FieldAccess]
$read: Audience::All
$insert: Audience::Privileged
$update: Audience::Privileged
#[PersonalData]
PersonalDataKind::Hidden

$email

protected string|null $email = null
Attributes
#[Column]
$type: "string"
$length: 255
$nullable: true
$unique: true
#[FieldAccess]
$read: Audience::All
$insert: Audience::All
$update: Audience::Privileged
#[PersonalData]
PersonalDataKind::Email

$externalId

protected string|null $externalId = null
Attributes
#[Column]
$type: "string"
$length: 45
$nullable: true
#[FieldAccess]
$read: Audience::All
$insert: Audience::Privileged
$update: Audience::Privileged

$firstname

protected string $firstname = ''
Attributes
#[Column]
$type: "string"
$length: 80

$id

protected int|null $id = null
Attributes
#[Column]
$type: "integer"
$name: "user_id"
#[GeneratedValue]
#[Id]

$isCompany

protected bool $isCompany = true
Attributes
#[Column]
$type: "boolean"
$options: ["default" => true]

$languageId

protected int|null $languageId = null
Attributes
#[Column]
$type: "integer"
$nullable: true
$name: "cms_system_languages_language_id"

$lastname

protected string $lastname = ''
Attributes
#[Column]
$type: "string"
$length: 100

$memberUntil

protected DateTime|null $memberUntil = null
Attributes
#[Column]
$type: "datetime"
$name: "member_until"
$nullable: true
#[FieldAccess]
$read: Audience::All
$insert: Audience::Privileged
$update: Audience::Privileged

$parentUserId

protected int|null $parentUserId = null
Attributes
#[Column]
$type: "integer"
$nullable: true
$name: "cms_system_users_user_id"
#[ExternalReadonly]

$password

protected string $password = ''
Attributes
#[Column]
$type: "string"
$length: 40
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$passwordResetExpires

protected DateTime|null $passwordResetExpires = null
Attributes
#[Column]
$name: 'password_reset_expires'
$type: 'datetime'
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$passwordResetHash

protected string|null $passwordResetHash = null
Attributes
#[Column]
$name: 'password_reset_hash'
$type: 'string'
$length: 64
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$paymentRegionId

protected int|null $paymentRegionId = null
Attributes
#[Column]
$type: "integer"
$nullable: true
$name: "cms_system_payment_regions_payment_region_id"

$phone

protected string|null $phone = null
Attributes
#[Column]
$type: "string"
$length: 255
$nullable: true
#[PersonalData]
PersonalDataKind::Hidden

$points

protected int $points = 0
Attributes
#[Column]
$type: "integer"
$options: ["default" => 0]
#[FieldAccess]
$read: Audience::All
$insert: Audience::Privileged
$update: Audience::Privileged
#[PersonalData]
PersonalDataKind::Hidden

$ratingThreadId

protected int|null $ratingThreadId = null
Attributes
#[Column]
$name: 'cms_mod_base_rating_threads_rating_thread_id'
$type: 'integer'
$nullable: true
$options: ['unsigned' => true]
#[FieldAccess]
$read: Audience::All
$insert: Audience::Privileged
$update: Audience::Privileged

$referralCode

protected string|null $referralCode = null
Attributes
#[Column]
$name: 'referral_code'
$type: 'string'
$length: 16
$nullable: true
$unique: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::Owner
$insert: Audience::None
$update: Audience::None

$referrerCode

protected string|null $referrerCode = null
Attributes
#[Column]
$name: 'referrer_code'
$type: 'string'
$length: 16
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::Privileged
$insert: Audience::None
$update: Audience::None

$referrerUserId

protected int|null $referrerUserId = null
Attributes
#[Column]
$name: 'referrer_user_id'
$type: 'integer'
$nullable: true
$options: ['unsigned' => true]
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::Privileged
$insert: Audience::None
$update: Audience::None

$regId

protected string|null $regId = null
Attributes
#[Column]
$type: "string"
$length: 255
$nullable: true
#[PersonalData]
PersonalDataKind::Hidden

$regionId

protected int|null $regionId = null
Attributes
#[Column]
$type: "integer"
$nullable: true
$name: "cms_system_regions_region_id"

$registrationDatetime

protected DateTime|null $registrationDatetime = null
Attributes
#[Column]
$type: "datetime"
#[ExternalReadonly]

$salt

protected string $salt = ''
Attributes
#[Column]
$type: "string"
$length: 25
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::None
$insert: Audience::None
$update: Audience::None

$state

protected string|null $state = null
Attributes
#[Column]
$type: "string"
$length: 80
$nullable: true

$street

protected string|null $street = null
Attributes
#[Column]
$type: "string"
$length: 80
$nullable: true
#[PersonalData]
PersonalDataKind::Hidden

$type

protected string $type = 'web'
Attributes
#[Column]
$type: "string"
$length: 45
$options: ["default" => "web"]
#[FieldAccess]
$read: Audience::All
$insert: Audience::Privileged
$update: Audience::Privileged

$url

protected string|null $url = null
Attributes
#[Column]
$type: "text"
$nullable: true

$username

protected string $username = ''
Attributes
#[Column]
$type: "string"
$length: 45
$unique: true
#[FieldAccess]
$read: Audience::All
$insert: Audience::All
$update: Audience::Privileged

$userRoles

protected Collection $userRoles
Attributes
#[FieldAccess]
$read: \App\Core\Attributes\Hydration\Audience::All
$insert: \App\Core\Attributes\Hydration\Audience::Privileged
$update: \App\Core\Attributes\Hydration\Audience::Privileged
#[InverseJoinColumn]
$name: "cms_system_user_roles_user_role_id"
$referencedColumnName: "user_role_id"
#[JoinColumn]
$name: "cms_system_users_user_id"
$referencedColumnName: "user_id"
#[JoinTable]
$name: "cms_system_user_role_relations"
#[ManyToMany]
$targetEntity: \App\UI\Api\System\Models\Entities\UserRole::class
$inversedBy: "users"

$userTypeId

protected int|null $userTypeId = null
Attributes
#[Column]
$type: "integer"
$nullable: true
$name: "cms_system_user_types_user_type_id"

$vatId

protected string|null $vatId = null
Attributes
#[Column]
$type: "string"
$length: 255
$nullable: true
#[PersonalData]
PersonalDataKind::Hidden

$zip

protected string|null $zip = null
Attributes
#[Column]
$type: "string"
$length: 15
$nullable: true
#[PersonalData]
PersonalDataKind::Hidden

Methods

__construct()

public __construct([int|null $id = null ][, string $username = '' ][, string|null $email = null ][, string $password = '' ][, string $salt = '' ][, string $firstname = '' ][, string $lastname = '' ][, string|null $phone = null ][, string|null $street = null ][, string|null $zip = null ][, string|null $city = null ][, string|null $state = null ][, string|null $country = null ][, string|null $countryCode = null ][, bool $isCompany = true ][, string|null $regId = null ][, string|null $vatId = null ][, string|null $companyName = null ][, int|null $languageId = null ][, string $activationKey = '' ][, bool $activated = false ][, bool $banned = false ][, DateTime|null $registrationDatetime = null ][, int $points = 0 ][, int $credits = 0 ][, int|null $discountLevelId = null ][, int $discount = 0 ][, string|null $assetPath = null ][, int|null $regionId = null ][, int|null $paymentRegionId = null ][, int|null $userTypeId = null ][, int|null $parentUserId = null ][, string $type = 'web' ][, string|null $externalId = null ][, string|null $url = null ][, string|null $aboutMe = null ][, string|null $ip = null ][, DateTime|null $memberUntil = null ][, int|null $ratingThreadId = null ][, string|null $passwordResetHash = null ][, DateTime|null $passwordResetExpires = null ][, DateTime|null $activationExpires = null ][, DateTime|null $deletionRequestedAt = null ][, string|null $deletionTokenHash = null ][, DateTime|null $deletionTokenExpires = null ][, DateTime|null $deletedAt = null ][, string|null $deletionNonce = null ][, DateTime|null $deletionClaimedAt = null ][, string|null $referralCode = null ][, int|null $referrerUserId = null ][, string|null $referrerCode = null ][, bool $affiliateDisabled = false ][, Collection $userRoles = new ArrayCollection() ]) : mixed
Parameters
$id : int|null = null
$username : string = ''
$email : string|null = null
$password : string = ''
$salt : string = ''
$firstname : string = ''
$lastname : string = ''
$phone : string|null = null
$street : string|null = null
$zip : string|null = null
$city : string|null = null
$state : string|null = null
$country : string|null = null
$countryCode : string|null = null
$isCompany : bool = true
$regId : string|null = null
$vatId : string|null = null
$companyName : string|null = null
$languageId : int|null = null
$activationKey : string = ''
$activated : bool = false
$banned : bool = false
$registrationDatetime : DateTime|null = null
$points : int = 0
$credits : int = 0
$discountLevelId : int|null = null
$discount : int = 0
$assetPath : string|null = null
$regionId : int|null = null
$paymentRegionId : int|null = null
$userTypeId : int|null = null
$parentUserId : int|null = null
$type : string = 'web'
$externalId : string|null = null
$url : string|null = null
$aboutMe : string|null = null
$ip : string|null = null
$memberUntil : DateTime|null = null
$ratingThreadId : int|null = null
$passwordResetHash : string|null = null
$passwordResetExpires : DateTime|null = null
$activationExpires : DateTime|null = null
$deletionRequestedAt : DateTime|null = null
$deletionTokenHash : string|null = null
$deletionTokenExpires : DateTime|null = null
$deletedAt : DateTime|null = null
$deletionNonce : string|null = null
$deletionClaimedAt : DateTime|null = null
$referralCode : string|null = null
$referrerUserId : int|null = null
$referrerCode : string|null = null
$affiliateDisabled : bool = false
$userRoles : Collection = new ArrayCollection()

addUserRole()

public addUserRole(TRole $userRole) : $this
Parameters
$userRole : TRole
Return values
$this

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getAboutMe()

public getAboutMe() : string|null
Return values
string|null

getActivated()

public getActivated() : bool
Return values
bool

getActivationExpires()

public getActivationExpires() : DateTime|null
Return values
DateTime|null

getActivationKey()

public getActivationKey() : string
Return values
string

getAffiliateDisabled()

public getAffiliateDisabled() : bool
Return values
bool

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getAssetFile()

Returns the `FtpAsset` derived from the path (lazy, works after Doctrine hydration too).

public getAssetFile() : FtpAsset|null
Return values
FtpAsset|null

getAssetPath()

public getAssetPath() : string|null
Return values
string|null

getBanned()

public getBanned() : bool
Return values
bool

getCity()

public getCity() : string|null
Return values
string|null

getCompanyName()

public getCompanyName() : string|null
Return values
string|null

getCountry()

public getCountry() : string|null
Return values
string|null

getCountryCode()

public getCountryCode() : string|null
Return values
string|null

getCredits()

public getCredits() : int
Return values
int

getDeletedAt()

public getDeletedAt() : DateTime|null
Return values
DateTime|null

getDeletionClaimedAt()

public getDeletionClaimedAt() : DateTime|null
Return values
DateTime|null

getDeletionNonce()

public getDeletionNonce() : string|null
Return values
string|null

getDeletionRequestedAt()

public getDeletionRequestedAt() : DateTime|null
Return values
DateTime|null

getDeletionTokenExpires()

public getDeletionTokenExpires() : DateTime|null
Return values
DateTime|null

getDeletionTokenHash()

public getDeletionTokenHash() : string|null
Return values
string|null

getDiscount()

public getDiscount() : int
Return values
int

getDiscountLevelId()

public getDiscountLevelId() : int|null
Return values
int|null

getEmail()

public getEmail() : string|null
Return values
string|null

getExternalId()

public getExternalId() : string|null
Return values
string|null

getFirstname()

public getFirstname() : string
Return values
string

getIp()

public getIp() : string|null
Return values
string|null

getLanguageId()

public getLanguageId() : int|null
Return values
int|null

getLastname()

public getLastname() : string
Return values
string

getMemberUntil()

public getMemberUntil() : DateTime|null
Return values
DateTime|null

getParentUserId()

public getParentUserId() : int|null
Return values
int|null

getPassword()

public getPassword() : string
Return values
string

getPasswordResetExpires()

public getPasswordResetExpires() : DateTime|null
Return values
DateTime|null

getPasswordResetHash()

public getPasswordResetHash() : string|null
Return values
string|null

getPaymentRegionId()

public getPaymentRegionId() : int|null
Return values
int|null

getPhone()

public getPhone() : string|null
Return values
string|null

getPoints()

public getPoints() : int
Return values
int

getRatingThreadId()

public getRatingThreadId() : int|null
Return values
int|null

getReferralCode()

public getReferralCode() : string|null
Return values
string|null

getReferrerCode()

public getReferrerCode() : string|null
Return values
string|null

getReferrerUserId()

public getReferrerUserId() : int|null
Return values
int|null

getRegId()

public getRegId() : string|null
Return values
string|null

getRegionId()

public getRegionId() : int|null
Return values
int|null

getRegistrationDatetime()

public getRegistrationDatetime() : DateTime|null
Return values
DateTime|null

getSalt()

public getSalt() : string
Return values
string

getState()

public getState() : string|null
Return values
string|null

getStreet()

public getStreet() : string|null
Return values
string|null

getType()

public getType() : string
Return values
string

getUrl()

public getUrl() : string|null
Return values
string|null

getUsername()

public getUsername() : string
Return values
string

getUserRoles()

Roles of the user: a single collection `$userRoles` (mapped by the ORM in the Api layer, `#[Transient]` protects it from being overwritten on an admin save). Keep it single: a second unmapped collection made the getter return empty roles (JWT `role` claim and bridge payload without roles), hence `UserRelationManager` syncs the relations set-based over DBAL.

public getUserRoles() : Collection<int, TRole>
Return values
Collection<int, TRole>

getUserTypeId()

public getUserTypeId() : int|null
Return values
int|null

getVatId()

public getVatId() : string|null
Return values
string|null

getZip()

public getZip() : string|null
Return values
string|null

isActivated()

public isActivated() : bool
Return values
bool

isAffiliateDisabled()

public isAffiliateDisabled() : bool
Return values
bool

isBanned()

public isBanned() : bool
Return values
bool

isCompany()

public isCompany() : bool
Return values
bool

isDeleted()

Anonymized (deleted) account — it can never sign in or be saved again.

public isDeleted() : bool
Return values
bool

isDeletionPending()

Deletion requested and still waiting for the grace period to pass.

public isDeletionPending() : bool
Return values
bool

removeUserRole()

public removeUserRole(TRole $userRole) : $this
Parameters
$userRole : TRole
Return values
$this

setAboutMe()

public setAboutMe(string|null $aboutMe) : $this
Parameters
$aboutMe : string|null
Return values
$this

setActivated()

public setActivated(bool $activated) : $this
Parameters
$activated : bool
Return values
$this

setActivationExpires()

public setActivationExpires(DateTime|null $activationExpires) : TRole>
Parameters
$activationExpires : DateTime|null
Return values
TRole>

setActivationKey()

public setActivationKey(string $activationKey) : $this
Parameters
$activationKey : string
Return values
$this

setAffiliateDisabled()

public setAffiliateDisabled(bool $affiliateDisabled) : TRole>
Parameters
$affiliateDisabled : bool
Return values
TRole>

setAssetPath()

public setAssetPath(string|null $assetPath) : $this
Parameters
$assetPath : string|null
Return values
$this

setBanned()

public setBanned(bool $banned) : $this
Parameters
$banned : bool
Return values
$this

setCity()

public setCity(string|null $city) : $this
Parameters
$city : string|null
Return values
$this

setCompanyName()

public setCompanyName(string|null $companyName) : $this
Parameters
$companyName : string|null
Return values
$this

setCountry()

public setCountry(string|null $country) : $this
Parameters
$country : string|null
Return values
$this

setCountryCode()

public setCountryCode(string|null $countryCode) : TRole>
Parameters
$countryCode : string|null
Return values
TRole>

setCredits()

public setCredits(int $credits) : $this
Parameters
$credits : int
Return values
$this

setDeletedAt()

public setDeletedAt(DateTime|null $deletedAt) : TRole>
Parameters
$deletedAt : DateTime|null
Return values
TRole>

setDeletionClaimedAt()

public setDeletionClaimedAt(DateTime|null $deletionClaimedAt) : TRole>
Parameters
$deletionClaimedAt : DateTime|null
Return values
TRole>

setDeletionNonce()

public setDeletionNonce(string|null $deletionNonce) : TRole>
Parameters
$deletionNonce : string|null
Return values
TRole>

setDeletionRequestedAt()

public setDeletionRequestedAt(DateTime|null $deletionRequestedAt) : TRole>
Parameters
$deletionRequestedAt : DateTime|null
Return values
TRole>

setDeletionTokenExpires()

public setDeletionTokenExpires(DateTime|null $deletionTokenExpires) : TRole>
Parameters
$deletionTokenExpires : DateTime|null
Return values
TRole>

setDeletionTokenHash()

public setDeletionTokenHash(string|null $deletionTokenHash) : TRole>
Parameters
$deletionTokenHash : string|null
Return values
TRole>

setDiscount()

public setDiscount(int $discount) : $this
Parameters
$discount : int
Return values
$this

setDiscountLevelId()

public setDiscountLevelId(int|null $discountLevelId) : $this
Parameters
$discountLevelId : int|null
Return values
$this

setEmail()

public setEmail(string|null $email) : $this
Parameters
$email : string|null
Return values
$this

setExternalId()

public setExternalId(string|null $externalId) : $this
Parameters
$externalId : string|null
Return values
$this

setFirstname()

public setFirstname(string $firstname) : $this
Parameters
$firstname : string
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setIp()

public setIp(string|null $ip) : $this
Parameters
$ip : string|null
Return values
$this

setIsCompany()

public setIsCompany(bool $isCompany) : $this
Parameters
$isCompany : bool
Return values
$this

setLanguageId()

public setLanguageId(int|null $languageId) : $this
Parameters
$languageId : int|null
Return values
$this

setLastname()

public setLastname(string $lastname) : $this
Parameters
$lastname : string
Return values
$this

setMemberUntil()

public setMemberUntil(DateTime|null $memberUntil) : $this
Parameters
$memberUntil : DateTime|null
Return values
$this

setParentUserId()

public setParentUserId(int|null $parentUserId) : $this
Parameters
$parentUserId : int|null
Return values
$this

setPassword()

public setPassword(string $password) : $this
Parameters
$password : string
Return values
$this

setPasswordResetExpires()

public setPasswordResetExpires(DateTime|null $passwordResetExpires) : TRole>
Parameters
$passwordResetExpires : DateTime|null
Return values
TRole>

setPasswordResetHash()

public setPasswordResetHash(string|null $passwordResetHash) : TRole>
Parameters
$passwordResetHash : string|null
Return values
TRole>

setPaymentRegionId()

public setPaymentRegionId(int|null $paymentRegionId) : $this
Parameters
$paymentRegionId : int|null
Return values
$this

setPhone()

public setPhone(string|null $phone) : $this
Parameters
$phone : string|null
Return values
$this

setPoints()

public setPoints(int $points) : $this
Parameters
$points : int
Return values
$this

setRatingThreadId()

public setRatingThreadId(int|null $ratingThreadId) : $this
Parameters
$ratingThreadId : int|null
Return values
$this

setReferralCode()

public setReferralCode(string|null $referralCode) : TRole>
Parameters
$referralCode : string|null
Return values
TRole>

setReferrerCode()

public setReferrerCode(string|null $referrerCode) : TRole>
Parameters
$referrerCode : string|null
Return values
TRole>

setReferrerUserId()

public setReferrerUserId(int|null $referrerUserId) : TRole>
Parameters
$referrerUserId : int|null
Return values
TRole>

setRegId()

public setRegId(string|null $regId) : $this
Parameters
$regId : string|null
Return values
$this

setRegionId()

public setRegionId(int|null $regionId) : $this
Parameters
$regionId : int|null
Return values
$this

setRegistrationDatetime()

public setRegistrationDatetime(DateTime|null $registrationDatetime) : $this
Parameters
$registrationDatetime : DateTime|null
Return values
$this

setSalt()

public setSalt(string $salt) : $this
Parameters
$salt : string
Return values
$this

setState()

public setState(string|null $state) : $this
Parameters
$state : string|null
Return values
$this

setStreet()

public setStreet(string|null $street) : $this
Parameters
$street : string|null
Return values
$this

setType()

public setType(string $type) : $this
Parameters
$type : string
Return values
$this

setUrl()

public setUrl(string|null $url) : $this
Parameters
$url : string|null
Return values
$this

setUsername()

public setUsername(string $username) : $this
Parameters
$username : string
Return values
$this

setUserRoles()

public setUserRoles(Collection<int, TRole>|array<int, TRole> $userRoles) : $this
Parameters
$userRoles : Collection<int, TRole>|array<int, TRole>
Return values
$this

setUserTypeId()

public setUserTypeId(int|null $userTypeId) : $this
Parameters
$userTypeId : int|null
Return values
$this

setVatId()

public setVatId(string|null $vatId) : $this
Parameters
$vatId : string|null
Return values
$this

setZip()

public setZip(string|null $zip) : $this
Parameters
$zip : string|null
Return values
$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results