CreateUserParametersGroup extends UserParametersGroup
in package

This is the user model (create user resource) parameters group class.

Table of Contents

$billingAddress  : BillingAddressParametersGroup
$birthday  : string
$createAccount  : bool
$customTags  : array<string|int, mixed>
$email  : string
$gender  : string
$groupPId  : string
$image  : string
$nick  : string
$password  : string
$pId  : string
$shippingAddress  : ShippingAddressParametersGroup
$useShippingAddress  : bool
$validator  : ParametersValidator
addCustomTag() Adds a new CustomTag to the array of CustomTags for this parameters group.  : void
setBillingAddress() Sets the billing address parameter for this parameters group.  : void
setBirthday() Sets the birthday parameter for this parameters group.  : void
setCreateAccount() Sets if an account will be created.  : void
setCustomTags() Sets an array of CustomTags as a parameter for this parameters group.  : void
setEmail() Sets the email 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
setPassword() Sets the password parameter for this parameters group.  : void
setPId() Sets the public identifier parameter for this parameters group.  : void
setShippingAddress() Sets the shipping address 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}  : CreateParametersValidator

Properties

Methods

setBirthday()

Sets the birthday parameter for this parameters group.

public setBirthday(DateTime $birthday) : void
Parameters
$birthday : DateTime
Return values
void —

setCreateAccount()

Sets if an account will be created.

public setCreateAccount(bool $createAccount) : void
Parameters
$createAccount : bool
Return values
void —

setEmail()

Sets the email parameter for this parameters group.

public setEmail(string $email) : void
Parameters
$email : string
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 —

setPassword()

Sets the password parameter for this parameters group.

public setPassword(string $password) : void
Parameters
$password : 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> —

Search results