UserProfile
extends EntityBase
in package
Cx\Core\User\Model\Entity\UserProfile
Table of Contents
Properties
- $designation : mixed
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $nestingCount : int
- Counts the nesting level of __call()
- $stringRepresentationBlank : bool
- Whether blank string representations are valid
- $stringRepresentationFields : array<string|int, mixed>
- List of fields that should be available in the string representation
- $stringRepresentationFormat : string
- Sprintf format for the string representation
- $userAttributeValues : ProfileTitle
- $validators : array<string|int, mixed>
- Initialize this array as follows: array( 'columName' => Zend_Validate )
- $virtual : bool
- Defines if an entity is virtual and therefore not persistable.
- $address : string
- $birthday : string
- $city : string
- $company : string
- $country : int
- $firstname : string
- $gender : string
- $interests : string
- $lastname : string
- $phoneFax : string
- $phoneMobile : string
- $phoneOffice : string
- $phonePrivate : string
- $picture : string
- $profession : string
- $signature : string
- $userId : int
- $users : User
- $userTitle : Collection
- $website : string
- $zip : string
Methods
- __call() : mixed
- Route methods like getName(), getType(), getDirectory(), etc.
- __construct() : mixed
- __get() : mixed
- This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
- __toString() : string
- Returns this entity's identifying value
- addUserAttributeValue() : UserProfile
- Add userAttributeValues
- addUserAttributeValues() : mixed
- Add userAttributeValues
- getAddress() : string
- Get address
- getBirthday() : string
- Get birthday
- getCity() : string
- Get city
- getCompany() : string
- Get company
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getCountry() : int
- Get country
- getDesignation() : string
- Get designation
- getFirstname() : string
- Get firstname
- getGender() : string
- Get gender
- getInterests() : string
- Get interests
- getKeyAsString() : string
- Returns this entity's key
- getLastname() : string
- Get lastname
- getPhoneFax() : string
- Get phoneFax
- getPhoneMobile() : string
- Get phoneMobile
- getPhoneOffice() : string
- Get phoneOffice
- getPhonePrivate() : string
- Get phonePrivate
- getPicture() : string
- Get picture
- getProfession() : string
- Get profession
- getSignature() : string
- Get signature
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- getUserAttributeValues() : Collection
- Get userAttributeValue
- getUserId() : int
- Get userId
- getUsers() : User
- Get users
- getUserTitle() : ProfileTitle
- Get userTitle
- getWebsite() : string
- Get website
- getZip() : string
- Get zip
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- removeUserAttributeValue() : mixed
- Remove userAttributeValues
- setAddress() : mixed
- Set address
- setBirthday() : mixed
- Set birthday
- setCity() : mixed
- Set city
- setCompany() : mixed
- Set company
- setCountry() : mixed
- Set country
- setDesignation() : mixed
- Set designation
- setFirstname() : mixed
- Set firstname
- setGender() : mixed
- Set gender
- setInterests() : mixed
- Set interests
- setLastname() : mixed
- Set lastname
- setPhoneFax() : mixed
- Set phoneFax
- setPhoneMobile() : mixed
- Set phoneMobile
- setPhoneOffice() : mixed
- Set phoneOffice
- setPhonePrivate() : mixed
- Set phonePrivate
- setPicture() : mixed
- Set picture
- setProfession() : mixed
- Set profession
- setSignature() : mixed
- Set signature
- setUserId() : mixed
- Set userId
- setUsers() : mixed
- Set users
- setUserTitle() : mixed
- Set userTitle
- setVirtual() : mixed
- Set the virtuality of the entity
- setWebsite() : mixed
- Set website
- setZip() : mixed
- Set zip
- validate() : mixed
- getFallbackLocaleCodes() : array<string|int, mixed>
- Returns a list of all locale codes ordered by fallback order
- getStringRepresentationBlank() : bool
- Whether blank string representations are valid
- getStringRepresentationFields() : array<string|int, mixed>
- Returns a list of fields available in the string representation
- getStringRepresentationFormat() : string
- Returns the sprintf() format for the string representation
Properties
$designation
protected
mixed
$designation
$localeCodes
List of locale codes ordered by translation fallback order per Cx instance
protected
static array<string|int, mixed>
$localeCodes
= array()
Array in the form: array(<instanceId> => array(<localeCode>, ...))
Tags
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$stringRepresentationBlank
Whether blank string representations are valid
protected
bool
$stringRepresentationBlank
= false
Whether blank string representations are valid
Tags
$stringRepresentationFields
List of fields that should be available in the string representation
protected
array<string|int, mixed>
$stringRepresentationFields
= array()
List of field names
Tags
$stringRepresentationFormat
Sprintf format for the string representation
protected
string
$stringRepresentationFormat
= ''
Sprintf format string
Tags
$userAttributeValues
protected
ProfileTitle
$userAttributeValues
$validators
Initialize this array as follows: array( 'columName' => Zend_Validate )
protected
array<string|int, mixed>
$validators
= array()
$virtual
Defines if an entity is virtual and therefore not persistable.
protected
bool
$virtual
= false
Defaults to FALSE - not virtual.
$address
private
string
$address
$birthday
private
string
$birthday
$city
private
string
$city
$company
private
string
$company
$country
private
int
$country
$firstname
private
string
$firstname
$gender
private
string
$gender
$interests
private
string
$interests
$lastname
private
string
$lastname
$phoneFax
private
string
$phoneFax
$phoneMobile
private
string
$phoneMobile
$phoneOffice
private
string
$phoneOffice
$phonePrivate
private
string
$phonePrivate
$picture
private
string
$picture
$profession
private
string
$profession
$signature
private
string
$signature
$userId
private
int
$userId
$users
private
User
$users
$userTitle
private
Collection
$userTitle
$website
private
string
$website
$zip
private
string
$zip
Methods
__call()
Route methods like getName(), getType(), getDirectory(), etc.
public
__call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
- $methodName : string
-
Name of method to call
- $arguments : array<string|int, mixed>
-
List of arguments for the method to call
Tags
Return values
mixed —Return value of the method to call
__construct()
public
__construct() : mixed
__get()
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
__toString()
Returns this entity's identifying value
public
__toString() : string
By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.
Return values
string —Identifying value for this entity
addUserAttributeValue()
Add userAttributeValues
public
addUserAttributeValue(UserAttributeValue $userAttributeValues) : UserProfile
Parameters
- $userAttributeValues : UserAttributeValue
Return values
UserProfileaddUserAttributeValues()
Add userAttributeValues
public
addUserAttributeValues(UserAttributeValue $userAttributeValue) : mixed
Parameters
- $userAttributeValue : UserAttributeValue
getAddress()
Get address
public
getAddress() : string
Return values
string —$address
getBirthday()
Get birthday
public
getBirthday() : string
Return values
string —$birthday
getCity()
Get city
public
getCity() : string
Return values
string —$city
getCompany()
Get company
public
getCompany() : string
Return values
string —$company
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetCountry()
Get country
public
getCountry() : int
Return values
int —$country
getDesignation()
Get designation
public
getDesignation() : string
Return values
string —$designation
getFirstname()
Get firstname
public
getFirstname() : string
Return values
string —$firstname
getGender()
Get gender
public
getGender() : string
Return values
string —$gender
getInterests()
Get interests
public
getInterests() : string
Return values
string —$interests
getKeyAsString()
Returns this entity's key
public
final getKeyAsString([string $separator = '/' ]) : string
If this entity has a composite key, the fields are separated by $separator.
Parameters
- $separator : string = '/'
-
(optional) Separator for composite key fields, default "/"
Return values
string —Entity key as string
getLastname()
Get lastname
public
getLastname() : string
Return values
string —$lastname
getPhoneFax()
Get phoneFax
public
getPhoneFax() : string
Return values
string —$phoneFax
getPhoneMobile()
Get phoneMobile
public
getPhoneMobile() : string
Return values
string —$phoneMobile
getPhoneOffice()
Get phoneOffice
public
getPhoneOffice() : string
Return values
string —$phoneOffice
getPhonePrivate()
Get phonePrivate
public
getPhonePrivate() : string
Return values
string —$phonePrivate
getPicture()
Get picture
public
getPicture() : string
Return values
string —$picture
getProfession()
Get profession
public
getProfession() : string
Return values
string —$profession
getSignature()
Get signature
public
getSignature() : string
Return values
string —$signature
getTranslatedFieldValue()
Returns the value of a translatable field using fallback mechanisms
public
getTranslatedFieldValue(string $fieldName) : mixed
If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):
- Current locale
- Default locale
- All other locales
Parameters
- $fieldName : string
-
Name of a translatable field
getUserAttributeValues()
Get userAttributeValue
public
getUserAttributeValues() : Collection
Return values
Collection —$userAttributeValues
getUserId()
Get userId
public
getUserId() : int
Return values
int —$userId
getUsers()
Get users
public
getUsers() : User
Return values
User —$users
getUserTitle()
Get userTitle
public
getUserTitle() : ProfileTitle
Return values
ProfileTitle —$userTitle
getWebsite()
Get website
public
getWebsite() : string
Return values
string —$website
getZip()
Get zip
public
getZip() : string
Return values
string —$zip
initializeValidators()
Set $this->validators
public
initializeValidators() : mixed
Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called
isVirtual()
Returns the virtuality of the entity
public
isVirtual() : bool
Return values
bool —TRUE if the entity is virtual, otherwise FALSE
removeUserAttributeValue()
Remove userAttributeValues
public
removeUserAttributeValue(UserAttributeValue $userAttributeValues) : mixed
Parameters
- $userAttributeValues : UserAttributeValue
setAddress()
Set address
public
setAddress(string $address) : mixed
Parameters
- $address : string
setBirthday()
Set birthday
public
setBirthday(string $birthday) : mixed
Parameters
- $birthday : string
setCity()
Set city
public
setCity(string $city) : mixed
Parameters
- $city : string
setCompany()
Set company
public
setCompany(string $company) : mixed
Parameters
- $company : string
setCountry()
Set country
public
setCountry(int $country) : mixed
Parameters
- $country : int
setDesignation()
Set designation
public
setDesignation(string $designation) : mixed
Parameters
- $designation : string
setFirstname()
Set firstname
public
setFirstname(string $firstname) : mixed
Parameters
- $firstname : string
setGender()
Set gender
public
setGender(string $gender) : mixed
Parameters
- $gender : string
setInterests()
Set interests
public
setInterests(string $interests) : mixed
Parameters
- $interests : string
setLastname()
Set lastname
public
setLastname(string $lastname) : mixed
Parameters
- $lastname : string
setPhoneFax()
Set phoneFax
public
setPhoneFax(string $phoneFax) : mixed
Parameters
- $phoneFax : string
setPhoneMobile()
Set phoneMobile
public
setPhoneMobile(string $phoneMobile) : mixed
Parameters
- $phoneMobile : string
setPhoneOffice()
Set phoneOffice
public
setPhoneOffice(string $phoneOffice) : mixed
Parameters
- $phoneOffice : string
setPhonePrivate()
Set phonePrivate
public
setPhonePrivate(string $phonePrivate) : mixed
Parameters
- $phonePrivate : string
setPicture()
Set picture
public
setPicture(string $picture) : mixed
Parameters
- $picture : string
setProfession()
Set profession
public
setProfession(string $profession) : mixed
Parameters
- $profession : string
setSignature()
Set signature
public
setSignature(string $signature) : mixed
Parameters
- $signature : string
setUserId()
Set userId
public
setUserId(int $userId) : mixed
Parameters
- $userId : int
setUsers()
Set users
public
setUsers(User $users) : mixed
Parameters
- $users : User
setUserTitle()
Set userTitle
public
setUserTitle(ProfileTitle $userTitle) : mixed
Parameters
- $userTitle : ProfileTitle
setVirtual()
Set the virtuality of the entity
public
setVirtual(bool $virtual) : mixed
Parameters
- $virtual : bool
-
TRUE to set the entity as virtual or otherwise to FALSE
setWebsite()
Set website
public
setWebsite(string $website) : mixed
Parameters
- $website : string
setZip()
Set zip
public
setZip(string $zip) : mixed
Parameters
- $zip : string
validate()
public
validate() : mixed
Tags
getFallbackLocaleCodes()
Returns a list of all locale codes ordered by fallback order
protected
getFallbackLocaleCodes() : array<string|int, mixed>
- First entry is the current locale
- Second entry is the default locale (if different from current, it's omitted otherwise)
- Then all other locales follow (in no particular order)
Tags
Return values
array<string|int, mixed> —List of locale codes
getStringRepresentationBlank()
Whether blank string representations are valid
protected
getStringRepresentationBlank() : bool
Return values
bool —Whether blank string representations are valid
getStringRepresentationFields()
Returns a list of fields available in the string representation
protected
getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of field names
getStringRepresentationFormat()
Returns the sprintf() format for the string representation
protected
getStringRepresentationFormat() : string
Return values
string —sprintf() format string