Copied!

ShippingMethodCreateStruct

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

ShippingMethodCreateStruct.php : 40

Construct object optionally with a set of properties.

 
public __construct(string $identifier)

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name Type Default value Description
$identifier string - -

publicgetDescriptions()

ShippingMethodCreateStruct.php : 89 
public getDescriptions() : array<string, string>

Return values

array<string, string>

publicgetIdentifier()

ShippingMethodCreateStruct.php : 53 
public getIdentifier() : string

Return values

string

publicgetNames()

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

Return values

array<string, string>

publicgetOptions()

ShippingMethodCreateStruct.php : 102 
public getOptions() : array<string, mixed>

Return values

array<string, mixed>

publicgetRegions()

ShippingMethodCreateStruct.php : 128 
public getRegions() : array<int, RegionInterface>

Return values

array<int, RegionInterface>

publicgetType()

ShippingMethodCreateStruct.php : 63 
public getType() : ShippingMethodTypeInterface

Return values

ShippingMethodTypeInterface

publicgetVatCategoryIdentifier()

ShippingMethodCreateStruct.php : 141 
public getVatCategoryIdentifier() : string|null

Return values

string|null

publicisEnabled()

ShippingMethodCreateStruct.php : 115 
public isEnabled() : bool

Return values

bool

publicsetDescription()

ShippingMethodCreateStruct.php : 94 
public setDescription(string $languageCode, string $description) : void

Parameters

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

publicsetEnabled()

ShippingMethodCreateStruct.php : 120 
public setEnabled(bool $enabled) : void

Parameters

Name Type Default value Description
$enabled bool - -

publicsetIdentifier()

ShippingMethodCreateStruct.php : 58 
public setIdentifier(string $identifier) : void

Parameters

Name Type Default value Description
$identifier string - -

publicsetName()

ShippingMethodCreateStruct.php : 81 
public setName(string $languageCode, string $name) : void

Parameters

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

publicsetOptions()

ShippingMethodCreateStruct.php : 110 
public setOptions(array<string, mixed> $options) : void

Parameters

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

publicsetRegions()

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

Parameters

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

publicsetType()

ShippingMethodCreateStruct.php : 68 
public setType(ShippingMethodTypeInterface $type) : void

Parameters

Name Type Default value Description
$type ShippingMethodTypeInterface - -

publicsetVatCategoryIdentifier()

ShippingMethodCreateStruct.php : 146 
public setVatCategoryIdentifier(string|null $vatCategoryIdentifier) : void

Parameters

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

protectedgetProperties()

ValueObject.php : 50

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>