Copied!

ShippingMethodUpdateStruct

ShippingMethodUpdateStruct.php : 13
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

public__construct()

ShippingMethodUpdateStruct.php : 43

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 : 97 
public getDescriptions() : array<string, string>

Return values

array<string, string>

publicgetEnabled()

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

Return values

bool|null

publicgetIdentifier()

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

Return values

string|null

publicgetNames()

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

Return values

array<string, string>

publicgetOptions()

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

Return values

array<string, mixed>|null

publicgetRegions()

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

Return values

array<int, RegionInterface>|null

publicgetVatCategoryIdentifier()

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

Return values

string|null

publicsetDescription()

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

Parameters

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

publicsetDescriptions()

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

Parameters

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

publicsetEnabled()

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

Parameters

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

publicsetIdentifier()

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

Parameters

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

publicsetName()

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

Parameters

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

publicsetNames()

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

Parameters

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

publicsetOptions()

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

Parameters

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

publicsetRegions()

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

Parameters

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

publicsetVatCategoryIdentifier()

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

Parameters

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

protectedgetProperties()

ValueObject.php : 53

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>

Tags
Serializerignore

()