FrontendUser extends AbstractEntity

A Frontend User

Deprecated

since v11, will be removed in v12. Do not use or extend this model.

Table of Contents

Properties

$_languageUid  : int
$_localizedUid  : int
$_versionedUid  : int
$address  : string
$city  : string
$company  : string
$country  : string
$email  : string
$fax  : string
$firstName  : string
$image  : ObjectStorage<string|int, FileReference>
$lastlogin  : DateTime|null
$lastName  : string
$middleName  : string
$name  : string
$password  : string
$pid  : int
$telephone  : string
$title  : string
$uid  : int
$usergroup  : ObjectStorage<string|int, FrontendUserGroup>
$username  : string
$www  : string
$zip  : string

Methods

__clone()  : mixed
Clone method. Sets the _isClone property.
__construct()  : mixed
Constructs a new Front-End User
__toString()  : string
Returns the class name and the uid of the object as string
_getCleanProperties()  : array<string|int, mixed>
Returns a hash map of clean properties and $values.
_getCleanProperty()  : mixed
Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.
_getProperties()  : array<string|int, mixed>
Returns a hash map of property names and property values. Only for internal use.
_getProperty()  : mixed
Returns the property value of the given property name. Only for internal use.
_hasProperty()  : bool
Returns the property value of the given property name. Only for internal use.
_isClone()  : bool
Returns TRUE if the object has been cloned, FALSE otherwise.
_isDirty()  : bool
Returns TRUE if the properties were modified after reconstitution
_isNew()  : bool
Returns TRUE if the object is new (the uid was not set, yet). Only for internal use
_memorizeCleanState()  : mixed
Register an object's clean state, e.g. after it has been reconstituted from the database.
_memorizePropertyCleanState()  : mixed
Register a properties's clean state, e.g. after it has been reconstituted from the database.
_setClone()  : mixed
Setter whether this Domain Object is a clone of another one.
_setProperty()  : bool
Reconstitutes a property. Only for internal use.
addUsergroup()  : mixed
Adds a usergroup to the frontend user
getAddress()  : string
Returns the address value
getCity()  : string
Returns the city value
getCompany()  : string
Returns the company value
getCountry()  : string
Returns the country value
getEmail()  : string
Returns the email value
getFax()  : string
Returns the fax value
getFirstName()  : string
Returns the firstName value
getImage()  : ObjectStorage<string|int, FileReference>
Gets the image value
getLastlogin()  : DateTime
Returns the lastlogin value
getLastName()  : string
Returns the lastName value
getMiddleName()  : string
Returns the middleName value
getName()  : string
Returns the name value
getPassword()  : string
Returns the password value
getPid()  : int|null
Getter for the pid.
getTelephone()  : string
Returns the telephone value
getTitle()  : string
Returns the title value
getUid()  : int|null
Getter for uid.
getUsergroup()  : ObjectStorage<string|int, FrontendUserGroup>
Returns the usergroups. Keep in mind that the property is called "usergroup" although it can hold several usergroups.
getUsername()  : string
Returns the username value
getWww()  : string
Returns the www value
getZip()  : string
Returns the zip value
initializeObject()  : mixed
Called again with initialize object, as fetching an entity from the DB does not use the constructor
removeUsergroup()  : mixed
Removes a usergroup from the frontend user
setAddress()  : mixed
Sets the address value
setCity()  : mixed
Sets the city value
setCompany()  : mixed
Sets the company value
setCountry()  : mixed
Sets the country value
setEmail()  : mixed
Sets the email value
setFax()  : mixed
Sets the fax value
setFirstName()  : mixed
Sets the firstName value
setImage()  : mixed
Sets the image value
setLastlogin()  : mixed
Sets the lastlogin value
setLastName()  : mixed
Sets the lastName value
setMiddleName()  : mixed
Sets the middleName value
setName()  : mixed
Sets the name value
setPassword()  : mixed
Sets the password value
setPid()  : void
Setter for the pid.
setTelephone()  : mixed
Sets the telephone value
setTitle()  : mixed
Sets the title value
setUsergroup()  : mixed
Sets the usergroups. Keep in mind that the property is called "usergroup" although it can hold several usergroups.
setUsername()  : mixed
Sets the username value
setWww()  : mixed
Sets the www value
setZip()  : mixed
Sets the zip value
isPropertyDirty()  : bool
Checks the $value against the $cleanState.

Properties

$_languageUid

protected int $_languageUid

The uid of the language of the object. This is the uid of the language record in the table sys_language.

$_localizedUid

protected int $_localizedUid

The uid of the localized record. Holds the uid of the record in default language (the translationOrigin).

$_versionedUid

protected int $_versionedUid

The uid of the versioned record.

$firstName

protected string $firstName = ''

$lastlogin

protected DateTime|null $lastlogin

$middleName

protected string $middleName = ''

$pid

protected int $pid

The id of the page the record is "stored".

$telephone

protected string $telephone = ''

$uid

protected int $uid

The uid of the record. The uid is only unique in the context of the database table.

Methods

__clone()

Clone method. Sets the _isClone property.

public __clone() : mixed

__construct()

Constructs a new Front-End User

public __construct([string $username = '' ][, string $password = '' ]) : mixed
Parameters
$username : string = ''
$password : string = ''

__toString()

Returns the class name and the uid of the object as string

public __toString() : string
Return values
string

_getCleanProperties()

Returns a hash map of clean properties and $values.

public _getCleanProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

_getCleanProperty()

Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.

public _getCleanProperty(string $propertyName) : mixed
Parameters
$propertyName : string

The name of the property to be memorized.

Internal
Return values
mixed —

The clean property value or NULL

_getProperties()

Returns a hash map of property names and property values. Only for internal use.

public _getProperties() : array<string|int, mixed>
Internal
Return values
array<string|int, mixed> —

The properties

_getProperty()

Returns the property value of the given property name. Only for internal use.

public _getProperty(string $propertyName) : mixed
Parameters
$propertyName : string
Internal
Return values
mixed —

The propertyValue

_hasProperty()

Returns the property value of the given property name. Only for internal use.

public _hasProperty(string $propertyName) : bool
Parameters
$propertyName : string
Internal
Return values
bool —

TRUE bool true if the property exists, FALSE if it doesn't exist or NULL in case of an error.

_isClone()

Returns TRUE if the object has been cloned, FALSE otherwise.

public _isClone() : bool
Return values
bool —

TRUE if the object has been cloned

_isDirty()

Returns TRUE if the properties were modified after reconstitution

public _isDirty([string $propertyName = null ]) : bool
Parameters
$propertyName : string = null

An optional name of a property to be checked if its value is dirty

Tags
throws
TooDirtyException
Return values
bool

_isNew()

Returns TRUE if the object is new (the uid was not set, yet). Only for internal use

public _isNew() : bool
Internal
Return values
bool

_memorizeCleanState()

Register an object's clean state, e.g. after it has been reconstituted from the database.

public _memorizeCleanState([string $propertyName = null ]) : mixed
Parameters
$propertyName : string = null

The name of the property to be memorized. If omitted all persistable properties are memorized.

_memorizePropertyCleanState()

Register a properties's clean state, e.g. after it has been reconstituted from the database.

public _memorizePropertyCleanState(string $propertyName) : mixed
Parameters
$propertyName : string

The name of the property to be memorized. If omitted all persistable properties are memorized.

_setClone()

Setter whether this Domain Object is a clone of another one.

public _setClone(bool $clone) : mixed

NEVER SET THIS PROPERTY DIRECTLY. We currently need it to make the _isDirty check inside AbstractEntity work, but it is just a work- around right now.

Parameters
$clone : bool

_setProperty()

Reconstitutes a property. Only for internal use.

public _setProperty(string $propertyName, mixed $propertyValue) : bool
Parameters
$propertyName : string
$propertyValue : mixed
Internal
Return values
bool

getAddress()

Returns the address value

public getAddress() : string
Return values
string

getCity()

Returns the city value

public getCity() : string
Return values
string

getCompany()

Returns the company value

public getCompany() : string
Return values
string

getCountry()

Returns the country value

public getCountry() : string
Return values
string

getEmail()

Returns the email value

public getEmail() : string
Return values
string

getFax()

Returns the fax value

public getFax() : string
Return values
string

getFirstName()

Returns the firstName value

public getFirstName() : string
Return values
string

getLastlogin()

Returns the lastlogin value

public getLastlogin() : DateTime
Return values
DateTime

getLastName()

Returns the lastName value

public getLastName() : string
Return values
string

getMiddleName()

Returns the middleName value

public getMiddleName() : string
Return values
string

getName()

Returns the name value

public getName() : string
Return values
string

getPassword()

Returns the password value

public getPassword() : string
Return values
string

getPid()

Getter for the pid.

public getPid() : int|null
Return values
int|null —

The pid or NULL if none set yet.

getTelephone()

Returns the telephone value

public getTelephone() : string
Return values
string

getTitle()

Returns the title value

public getTitle() : string
Return values
string

getUid()

Getter for uid.

public getUid() : int|null
Return values
int|null —

The uid or NULL if none set yet.

getUsername()

Returns the username value

public getUsername() : string
Return values
string

getWww()

Returns the www value

public getWww() : string
Return values
string

getZip()

Returns the zip value

public getZip() : string
Return values
string

initializeObject()

Called again with initialize object, as fetching an entity from the DB does not use the constructor

public initializeObject() : mixed

setAddress()

Sets the address value

public setAddress(string $address) : mixed
Parameters
$address : string

setCity()

Sets the city value

public setCity(string $city) : mixed
Parameters
$city : string

setCompany()

Sets the company value

public setCompany(string $company) : mixed
Parameters
$company : string

setCountry()

Sets the country value

public setCountry(string $country) : mixed
Parameters
$country : string

setEmail()

Sets the email value

public setEmail(string $email) : mixed
Parameters
$email : string

setFax()

Sets the fax value

public setFax(string $fax) : mixed
Parameters
$fax : string

setFirstName()

Sets the firstName value

public setFirstName(string $firstName) : mixed
Parameters
$firstName : string

setLastlogin()

Sets the lastlogin value

public setLastlogin(DateTime $lastlogin) : mixed
Parameters
$lastlogin : DateTime

setLastName()

Sets the lastName value

public setLastName(string $lastName) : mixed
Parameters
$lastName : string

setMiddleName()

Sets the middleName value

public setMiddleName(string $middleName) : mixed
Parameters
$middleName : string

setName()

Sets the name value

public setName(string $name) : mixed
Parameters
$name : string

setPassword()

Sets the password value

public setPassword(string $password) : mixed
Parameters
$password : string

setPid()

Setter for the pid.

public setPid(int $pid) : void
Parameters
$pid : int

setTelephone()

Sets the telephone value

public setTelephone(string $telephone) : mixed
Parameters
$telephone : string

setTitle()

Sets the title value

public setTitle(string $title) : mixed
Parameters
$title : string

setUsername()

Sets the username value

public setUsername(string $username) : mixed
Parameters
$username : string

setWww()

Sets the www value

public setWww(string $www) : mixed
Parameters
$www : string

setZip()

Sets the zip value

public setZip(string $zip) : mixed
Parameters
$zip : string

isPropertyDirty()

Checks the $value against the $cleanState.

protected isPropertyDirty(mixed $previousValue, mixed $currentValue) : bool
Parameters
$previousValue : mixed
$currentValue : mixed
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results