\Applications\EntityContact

Holds the contact information including the optional photo of the applicant.

Provides some magic function for accessing properties as class members, mirroring these calls to the getter and setter methods.

Summary

Methods
Properties
Constants
setBirthDay()
getBirthDay()
setBirthMonth()
getBirthMonth()
setBirthYear()
getBirthYear()
setEmail()
getEmail()
isEmailVerified()
setEmailVerified()
setFirstName()
getGender()
setGender()
getFirstName()
setHouseNumber()
getHouseNumber()
setLastName()
getLastName()
getDisplayName()
setPhone()
getPhone()
setPostalCode()
getPostalCode()
setCity()
getCity()
setImage()
getImage()
setStreet()
getStreet()
__set()
__get()
__isset()
__construct()
inherit()
No public properties found
No constants found
No protected methods found
$birthDay
$birthMonth
$birthYear
$email
$emailVerified
$firstName
$gender
$houseNumber
$lastName
$phone
$postalCode
$city
$image
$street
N/A
No private methods found
No private properties found
N/A

Properties

$birthDay

$birthDay : string

Day of birth of the user

Type

string

$birthMonth

$birthMonth : string

Month of birth of the user

Type

string

$birthYear

$birthYear : string

Year of birth of the user

Type

string

$email

$email : string

primary email of the user.

Type

string

$emailVerified

$emailVerified : boolean

Flag, if primary email is verified

Type

boolean

$firstName

$firstName : string

Firstname of the user

Type

string

$gender

$gender : string

Gender of the user

Type

string

$houseNumber

$houseNumber : string

house number of the users address

Type

string

$lastName

$lastName : string

Lastname of the user

Type

string

$phone

$phone : string

phone number of the user

Type

string

$postalCode

$postalCode : string

postal code of the users address

Type

string

$city

$city : string

city of the users address

Type

string

$image

$image : \Core\Entity\FileInterface

profile image of an application.

As contact image is stored as an {@link Applications\Entity\Attachment} it must be redeclared here.

Type

\Core\Entity\FileInterface

$street

$street : string

street of the users address

Type

string

Methods

setBirthDay()

setBirthDay( $birthDay) : $this

Sets the Day of the date of birth.

Parameters

$birthDay

Returns

$this

getBirthDay()

getBirthDay() : string

Gets the Day of the date of birth

Returns

string

setBirthMonth()

setBirthMonth( $birthMonth) : $this

Sets the month of the date of birth.

Parameters

$birthMonth

Returns

$this

getBirthMonth()

getBirthMonth() : string

Gets the month of the date of birth

Returns

string

setBirthYear()

setBirthYear( $birthYear) : $this

Sets the year of the date of birth.

Parameters

$birthYear

Returns

$this

getBirthYear()

getBirthYear() : string

Gets the Year of the date of birth.

Returns

string

setEmail()

setEmail( $email) : $this

Sets the email.

Parameters

$email

Returns

$this

getEmail()

getEmail() : string

Gets the email

Returns

string

isEmailVerified()

isEmailVerified() : bool

Returns

bool

setEmailVerified()

setEmailVerified(bool $emailVerified) : $this

Parameters

bool $emailVerified

Returns

$this

setFirstName()

setFirstName( $firstName) : $this

Sets the first name

Parameters

$firstName

Returns

$this

getGender()

getGender() : string

Gets the gender

Returns

string

setGender()

setGender( $gender) : $this

Sets the gender

Parameters

$gender

Returns

$this

getFirstName()

getFirstName() : string

Gets the first name

Returns

string

setHouseNumber()

setHouseNumber( $houseNumber) : $this

Sets the users house number

Parameters

$houseNumber

Returns

$this

getHouseNumber()

getHouseNumber() : string

Gets the users house number

@@return string

Returns

string

setLastName()

setLastName( $name) : $this

Sets the last name

Parameters

$name

Returns

$this

getLastName()

getLastName() : string

Gets the last name

Returns

string

getDisplayName()

getDisplayName(bool $emailIfEmpty) : string

Gets the user display name

Parameters

bool $emailIfEmpty

Returns

string

setPhone()

setPhone( $phone) : $this

Sets the users phone number

Parameters

$phone

Returns

$this

getPhone()

getPhone() : string

Gets the users phone number

Returns

string

setPostalCode()

setPostalCode( $postalCode) : $this

Sets the users postal Code

Parameters

$postalCode

Returns

$this

getPostalCode()

getPostalCode() : string

Gets the users postal Code

Returns

string

setCity()

setCity( $city) : $this

Sets the users city

Parameters

$city

Returns

$this

getCity()

getCity() : string

Gets the users city

Returns

string

setImage()

setImage(\Auth\Entity\UserImage $image) : $this

Sets the profile Image of an user

Parameters

\Auth\Entity\UserImage $image

Returns

$this

getImage()

getImage() : \Auth\Entity\UserImage

Gets the profile Image of an user

Returns

\Auth\Entity\UserImage

setStreet()

setStreet( $street) : $this

Sets the users street

Parameters

$street

Returns

$this

getStreet()

getStreet() : string

Gets the users street

Returns

string

__set()

__set(string $property, mixed $value) : mixed

Sets a property through the setter method.

An exception is raised, when no setter method exists.

Parameters

string $property
mixed $value

Throws

\Core\Entity\Exception\OutOfBoundsException

Returns

mixed

__get()

__get(string $property) : mixed

Gets a property through the getter method.

An exception is raised, when no getter method exists.

Parameters

string $property

Throws

\Core\Entity\Exception\OutOfBoundsException

Returns

mixed

__isset()

__isset(string $property) : boolean

Checks if a property exists and has a non-empty value.

If the property is an array, the check will return, if this array has items or not.

Parameters

string $property

Returns

boolean

__construct()

__construct(\Auth\Entity\InfoInterface|null $userInfo)

Creates a Contact

Parameters

\Auth\Entity\InfoInterface|null $userInfo

inherit()

inherit(\Auth\Entity\InfoInterface $info) : $this

Inherit data from an {@link UserInfoInterface}.

Copies the user image to an application attachment.

Parameters

\Auth\Entity\InfoInterface $info

Returns

$this