AddressParametersGroup
extends BaseUserDataParametersGroup
in package
This is the user model (base for addresses resources) parameters group class.
Table of Contents
$address | : string | |
---|---|---|
$addressAdditionalInformation | : string | |
$alias | : string | |
$city | : string | |
$company | : string | |
$defaultAddress | : bool | |
$fax | : string | |
$firstName | : string | |
$lastName | : string | |
$location | : LocationParametersGroup | |
$mobile | : string | |
$nif | : string | |
$number | : string | |
$phone | : string | |
$postalCode | : string | |
$state | : string | |
$validator | : ParametersValidator | |
$vat | : string | |
setAddress() | Sets the address parameter for this parameters group. | : void |
setAddressAdditionalInformation() | Sets the address additional information parameter for this parameters group. | : void |
setAlias() | Sets the alias parameter for this parameters group. | : void |
setCity() | Sets the city parameter for this parameters group. | : void |
setCompany() | Sets the company parameter for this parameters group. | : void |
setDefaultAddress() | Sets if the addresses will be filtered using this parameters group in function of if they are the default address. | : void |
setFax() | Sets the fax parameter for this parameters group. | : void |
setFirstName() | Sets the first name parameter for this parameters group. | : void |
setLastName() | Sets the last name parameter for this parameters group. | : void |
setLocation() | Sets the location parameter for this parameters group. | : void |
setMobile() | Sets the mobile parameter for this parameters group. | : void |
setNif() | Sets the nif parameter for this parameters group. | : void |
setNumber() | Sets the number parameter for this parameters group. | : void |
setPhone() | Sets the phone parameter for this parameters group. | : void |
setPostalCode() | Sets the postal code parameter for this parameters group. | : void |
setState() | Sets the state parameter for this parameters group. | : void |
setVat() | Sets the vat parameter for this parameters group. | : void |
toArray() | Returns the object data on array format. | : array<string|int, mixed> |
filter() | : array<string|int, mixed> | |
getInstantiatedValidator() | : ParametersValidator | |
getValidator() | : ParametersValidator |
Properties
$address
protected
string
$address
$addressAdditionalInformation
protected
string
$addressAdditionalInformation
$alias
protected
string
$alias
$city
protected
string
$city
$company
protected
string
$company
$defaultAddress
protected
bool
$defaultAddress
$fax
protected
string
$fax
$firstName
protected
string
$firstName
$lastName
protected
string
$lastName
$location
protected
LocationParametersGroup
$location
$mobile
protected
string
$mobile
$nif
protected
string
$nif
$number
protected
string
$number
$phone
protected
string
$phone
$postalCode
protected
string
$postalCode
$state
protected
string
$state
$validator
protected
ParametersValidator
$validator
$vat
protected
string
$vat
Methods
setAddress()
Sets the address parameter for this parameters group.
public
setAddress(string $address) : void
Parameters
- $address : string
Return values
void —setAddressAdditionalInformation()
Sets the address additional information parameter for this parameters group.
public
setAddressAdditionalInformation(string $addressAdditionalInformation) : void
Parameters
- $addressAdditionalInformation : string
Return values
void —setAlias()
Sets the alias parameter for this parameters group.
public
setAlias(string $alias) : void
Parameters
- $alias : string
Return values
void —setCity()
Sets the city parameter for this parameters group.
public
setCity(string $city) : void
Parameters
- $city : string
Return values
void —setCompany()
Sets the company parameter for this parameters group.
public
setCompany(string $company) : void
Parameters
- $company : string
Return values
void —setDefaultAddress()
Sets if the addresses will be filtered using this parameters group in function of if they are the default address.
public
setDefaultAddress(bool $defaultAddress) : void
Parameters
- $defaultAddress : bool
Return values
void —setFax()
Sets the fax parameter for this parameters group.
public
setFax(string $fax) : void
Parameters
- $fax : string
Return values
void —setFirstName()
Sets the first name parameter for this parameters group.
public
setFirstName(string $firstName) : void
Parameters
- $firstName : string
Return values
void —setLastName()
Sets the last name parameter for this parameters group.
public
setLastName(string $lastName) : void
Parameters
- $lastName : string
Return values
void —setLocation()
Sets the location parameter for this parameters group.
public
setLocation(LocationParametersGroup $location) : void
Parameters
- $location : LocationParametersGroup
Return values
void —setMobile()
Sets the mobile parameter for this parameters group.
public
setMobile(string $mobile) : void
Parameters
- $mobile : string
Return values
void —setNif()
Sets the nif parameter for this parameters group.
public
setNif(string $nif) : void
Parameters
- $nif : string
Return values
void —setNumber()
Sets the number parameter for this parameters group.
public
setNumber(string $number) : void
Parameters
- $number : string
Return values
void —setPhone()
Sets the phone parameter for this parameters group.
public
setPhone(string $phone) : void
Parameters
- $phone : string
Return values
void —setPostalCode()
Sets the postal code parameter for this parameters group.
public
setPostalCode(string $postalCode) : void
Parameters
- $postalCode : string
Return values
void —setState()
Sets the state parameter for this parameters group.
public
setState(string $state) : void
Parameters
- $state : string
Return values
void —setVat()
Sets the vat parameter for this parameters group.
public
setVat(string $vat) : void
Parameters
- $vat : string
Return values
void —toArray()
Returns the object data on array format.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —filter()
protected
filter(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstantiatedValidator()
protected
getInstantiatedValidator() : ParametersValidator
Return values
ParametersValidator —getValidator()
protected
abstract getValidator() : ParametersValidator