Copied!

CustomerGroupUpdateStruct

CustomerGroupUpdateStruct.php : 13
Final
Extends ValueObject

The base class for all value objects and structs.

Supports read-only properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using @property-read <type> <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Methods

public__construct()

CustomerGroupUpdateStruct.php : 53

Construct object optionally with a set of properties.

 
public __construct(int $id[, string|null $identifier = null ][, array<int, string> $names = [] ][, array<int, string> $descriptions = [] ][, numeric-string|null $globalPriceRate = null ])

Parameters

Name Type Default value Description
$id int - -
$identifier string|null null -
$names array<int, string> [] -
$descriptions array<int, string> [] -
$globalPriceRate numeric-string|null null -

publicaddDescription()

CustomerGroupUpdateStruct.php : 101 
public addDescription(int $languageId, string $description) : void

Parameters

Name Type Default value Description
$languageId int - -
$description string - -

publicaddName()

CustomerGroupUpdateStruct.php : 88 
public addName(int $languageId, string $name) : void

Parameters

Name Type Default value Description
$languageId int - -
$name string - -

publicgetDescription()

CustomerGroupUpdateStruct.php : 106 
public getDescription(int $languageId) : string

Parameters

Name Type Default value Description
$languageId int - -

Return values

string

publicgetDescriptions()

CustomerGroupUpdateStruct.php : 114 
public getDescriptions() : array<int, string>

Return values

array<int, string>

publicgetGlobalPriceRate()

CustomerGroupUpdateStruct.php : 122 
public getGlobalPriceRate() : numeric-string|null

Return values

numeric-string|null

publicgetId()

CustomerGroupUpdateStruct.php : 73 
public getId() : int

Return values

int

publicgetIdentifier()

CustomerGroupUpdateStruct.php : 78 
public getIdentifier() : string|null

Return values

string|null

publicgetName()

CustomerGroupUpdateStruct.php : 83 
public getName(int $languageId) : string

Parameters

Name Type Default value Description
$languageId int - -

Return values

string

publicgetNames()

CustomerGroupUpdateStruct.php : 96 
public getNames() : array<int, string>

Return values

array<int, string>

protectedgetProperties()

ValueObject.php : 53

Returns list of available properties' names.

 
protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

Override to add dynamic properties.

Parameters

Name Type Default value Description
$dynamicProperties array<int, string> []

Additional dynamic properties exposed on the object

Return values

array<int, string>

Attributes
#[Ignore]