ShippingMethodUpdateStruct

ShippingMethodUpdateStruct.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() ¶

ShippingMethodUpdateStruct.php : 43 Copy path

Construct object optionally with a set of properties.

public __construct([string|null $identifier = null ][, array<string, string> $names = [] ][, array<string, string> $descriptions = [] ][, array<string, mixed>|null $options = [] ][, array<int, RegionInterface> $regions = [] ][, bool|null $enabled = null ][, string|null $vatCategoryIdentifier = null ])

Parameters

Name	Type	Default value	Description
$identifier	string\|null	null	-
$names	array<string, string>	[]	-
$descriptions	array<string, string>	[]	-
$options	array<string, mixed>\|null	[]	-
$regions	array<int, RegionInterface>	[]	-
$enabled	bool\|null	null	-
$vatCategoryIdentifier	string\|null	null	-

getDescriptions() ¶

ShippingMethodUpdateStruct.php : 97 Copy path

public getDescriptions() : array<string, string>

Return values

array<string, string>

getEnabled() ¶

ShippingMethodUpdateStruct.php : 131 Copy path

public getEnabled() : bool|null

Return values

bool|null

getIdentifier() ¶

ShippingMethodUpdateStruct.php : 63 Copy path

public getIdentifier() : string|null

Return values

string|null

getNames() ¶

ShippingMethodUpdateStruct.php : 76 Copy path

public getNames() : array<string, string>

Return values

array<string, string>

getOptions() ¶

ShippingMethodUpdateStruct.php : 118 Copy path

public getOptions() : array<string, mixed>|null

Return values

array<string, mixed>|null

getRegions() ¶

ShippingMethodUpdateStruct.php : 144 Copy path

public getRegions() : array<int, RegionInterface>|null

Return values

array<int, RegionInterface>|null

getVatCategoryIdentifier() ¶

ShippingMethodUpdateStruct.php : 157 Copy path

public getVatCategoryIdentifier() : string|null

Return values

string|null

setDescription() ¶

ShippingMethodUpdateStruct.php : 110 Copy path

public setDescription(string $languageCode, string $description) : void

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-
$description	string	-	-

setDescriptions() ¶

ShippingMethodUpdateStruct.php : 105 Copy path

public setDescriptions(array<string, string> $descriptions) : void

Parameters

Name	Type	Default value	Description
$descriptions	array<string, string>	-	-

setEnabled() ¶

ShippingMethodUpdateStruct.php : 136 Copy path

public setEnabled(bool|null $enabled) : void

Parameters

Name	Type	Default value	Description
$enabled	bool\|null	-	-

setIdentifier() ¶

ShippingMethodUpdateStruct.php : 68 Copy path

public setIdentifier(string|null $identifier) : void

Parameters

Name	Type	Default value	Description
$identifier	string\|null	-	-

setName() ¶

ShippingMethodUpdateStruct.php : 89 Copy path

public setName(string $languageCode, string $name) : void

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-
$name	string	-	-

setNames() ¶

ShippingMethodUpdateStruct.php : 84 Copy path

public setNames(array<string, string> $names) : void

Parameters

Name	Type	Default value	Description
$names	array<string, string>	-	-

setOptions() ¶

ShippingMethodUpdateStruct.php : 126 Copy path

public setOptions(array<string, mixed>|null $options) : void

Parameters

Name	Type	Default value	Description
$options	array<string, mixed>\|null	-	-

setRegions() ¶

ShippingMethodUpdateStruct.php : 152 Copy path

public setRegions(array<int, RegionInterface> $regions) : void

Parameters

Name	Type	Default value	Description
$regions	array<int, RegionInterface>	-	-

setVatCategoryIdentifier() ¶

ShippingMethodUpdateStruct.php : 162 Copy path

public setVatCategoryIdentifier(string|null $vatCategoryIdentifier) : void

Parameters

Name	Type	Default value	Description
$vatCategoryIdentifier	string\|null	-	-

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>