CustomerGroupUpdateStruct

CustomerGroupUpdateStruct.php : 13 Copy path

Extends ValueObject

The base class for all value objects and structs.

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

Methods¶

__construct() ¶

CustomerGroupUpdateStruct.php : 53 Copy path

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	-

addDescription() ¶

CustomerGroupUpdateStruct.php : 101 Copy path

public addDescription(int $languageId, string $description) : void

Parameters

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

addName() ¶

CustomerGroupUpdateStruct.php : 88 Copy path

public addName(int $languageId, string $name) : void

Parameters

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

getDescription() ¶

CustomerGroupUpdateStruct.php : 106 Copy path

public getDescription(int $languageId) : string

Parameters

Name	Type	Default value	Description
$languageId	int	-	-

Return values

string

getDescriptions() ¶

CustomerGroupUpdateStruct.php : 114 Copy path

public getDescriptions() : array<int, string>

Return values

array<int, string>

getGlobalPriceRate() ¶

CustomerGroupUpdateStruct.php : 122 Copy path

public getGlobalPriceRate() : numeric-string|null

Return values

numeric-string|null

getId() ¶

CustomerGroupUpdateStruct.php : 73 Copy path

public getId() : int

Return values

int

getIdentifier() ¶

CustomerGroupUpdateStruct.php : 78 Copy path

public getIdentifier() : string|null

Return values

string|null

getName() ¶

CustomerGroupUpdateStruct.php : 83 Copy path

public getName(int $languageId) : string

Parameters

Name	Type	Default value	Description
$languageId	int	-	-

Return values

string

getNames() ¶

CustomerGroupUpdateStruct.php : 96 Copy path

public getNames() : array<int, string>

Return values

array<int, string>

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

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

Used by attributes(), override to add dynamic properties

Parameters

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>