UpdateUserParametersGroup
extends UserParametersGroup
in package
This is the user model (update user resource) parameters group class.
Table of Contents
| $birthday | : string | |
|---|---|---|
| $customTags | : array<string|int, mixed> | |
| $gender | : string | |
| $groupPId | : string | |
| $image | : string | |
| $nick | : string | |
| $pId | : string | |
| $useShippingAddress | : bool | |
| $validator | : ParametersValidator | |
| addCustomTag() | Adds a new CustomTag to the array of CustomTags for this parameters group. | : void |
| setBirthday() | Sets the birthday parameter for this parameters group. | : void |
| setCustomTags() | Sets an array of CustomTags as a parameter for this parameters group. | : void |
| setGender() | Sets the gender parameter for this parameters group. | : void |
| setGroupPId() | Sets the public group identifier parameter for this parameters group. | : void |
| setImage() | Sets the image parameter for this parameters group. | : void |
| setNick() | Sets the nick parameter for this parameters group. | : void |
| setPId() | Sets the public identifier parameter for this parameters group. | : void |
| setUseShippingAddress() | Sets if the user will use the shipping address for delivery. | : void |
| toArray() | Returns the object data on array format. | : array<string|int, mixed> |
| filter() | : array<string|int, mixed> | |
| getInstantiatedValidator() | : ParametersValidator | |
| getValidator() | {@inheritdoc} | : UpdateParametersValidator |
Properties
$birthday
protected
string
$birthday
$customTags
protected
array<string|int, mixed>
$customTags
$gender
protected
string
$gender
$groupPId
protected
string
$groupPId
$image
protected
string
$image
$nick
protected
string
$nick
$pId
protected
string
$pId
$useShippingAddress
protected
bool
$useShippingAddress
$validator
protected
ParametersValidator
$validator
Methods
addCustomTag()
Adds a new CustomTag to the array of CustomTags for this parameters group.
public
addCustomTag(UserCustomTagParametersGroup $customTag) : void
Parameters
- $customTag : UserCustomTagParametersGroup
Return values
void —setBirthday()
Sets the birthday parameter for this parameters group.
public
setBirthday(DateTime $birthday) : void
Parameters
- $birthday : DateTime
Return values
void —setCustomTags()
Sets an array of CustomTags as a parameter for this parameters group.
public
setCustomTags(array<string|int, UserCustomTagParametersGroup> $customTags) : void
Parameters
- $customTags : array<string|int, UserCustomTagParametersGroup>
Return values
void —setGender()
Sets the gender parameter for this parameters group.
public
setGender(string $gender) : void
Parameters
- $gender : string
Return values
void —setGroupPId()
Sets the public group identifier parameter for this parameters group.
public
setGroupPId(string $groupPId) : void
Parameters
- $groupPId : string
Return values
void —setImage()
Sets the image parameter for this parameters group.
public
setImage(string $image) : void
Parameters
- $image : string
Return values
void —setNick()
Sets the nick parameter for this parameters group.
public
setNick(string $nick) : void
Parameters
- $nick : string
Return values
void —setPId()
Sets the public identifier parameter for this parameters group.
public
setPId(string $pId) : void
Parameters
- $pId : string
Return values
void —setUseShippingAddress()
Sets if the user will use the shipping address for delivery.
public
setUseShippingAddress(bool $useShippingAddress) : void
Parameters
- $useShippingAddress : bool
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()
{@inheritdoc}
protected
getValidator() : UpdateParametersValidator