Copied!

ShippingMethodUpdateStruct

ShippingMethodUpdateStruct.php : 14
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()

ShippingMethodUpdateStruct.php : 44

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 -

publicgetDescriptions()

ShippingMethodUpdateStruct.php : 100 
public getDescriptions() : array<string, string>

Return values

array<string, string>

publicgetEnabled()

ShippingMethodUpdateStruct.php : 136 
public getEnabled() : bool|null

Return values

bool|null

publicgetIdentifier()

ShippingMethodUpdateStruct.php : 64 
public getIdentifier() : string|null

Return values

string|null

publicgetNames()

ShippingMethodUpdateStruct.php : 77 
public getNames() : array<string, string>

Return values

array<string, string>

publicgetOptions()

ShippingMethodUpdateStruct.php : 123 
public getOptions() : array<string, mixed>|null

Return values

array<string, mixed>|null

publicgetRegions()

ShippingMethodUpdateStruct.php : 149 
public getRegions() : array<int, RegionInterface>|null

Return values

array<int, RegionInterface>|null

publicgetVatCategoryIdentifier()

ShippingMethodUpdateStruct.php : 162 
public getVatCategoryIdentifier() : string|null

Return values

string|null

publicsetDescription()

ShippingMethodUpdateStruct.php : 113 
public setDescription(string $languageCode, string $description) : void

Parameters

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

publicsetDescriptions()

ShippingMethodUpdateStruct.php : 108 
public setDescriptions(array<string, string> $descriptions) : void

Parameters

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

publicsetEnabled()

ShippingMethodUpdateStruct.php : 141 
public setEnabled(bool|null $enabled) : void

Parameters

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

publicsetIdentifier()

ShippingMethodUpdateStruct.php : 69 
public setIdentifier(string|null $identifier) : void

Parameters

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

publicsetName()

ShippingMethodUpdateStruct.php : 90 
public setName(string $languageCode, string $name) : void

Parameters

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

publicsetNames()

ShippingMethodUpdateStruct.php : 85 
public setNames(array<string, string> $names) : void

Parameters

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

publicsetOptions()

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

Parameters

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

publicsetRegions()

ShippingMethodUpdateStruct.php : 157 
public setRegions(array<int, RegionInterface> $regions) : void

Parameters

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

publicsetVatCategoryIdentifier()

ShippingMethodUpdateStruct.php : 167 
public setVatCategoryIdentifier(string|null $vatCategoryIdentifier) : void

Parameters

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

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]