Copied!

CatalogUpdateStruct

CatalogUpdateStruct.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()

CatalogUpdateStruct.php : 56

Construct object optionally with a set of properties.

 
public __construct(int $id[, string|null $transition = null ][, string|null $identifier = null ][, CriterionInterface|null $criterion = null ][, array<string, string> $names = [] ][, array<string, string> $descriptions = [] ])

Parameters

Name Type Default value Description
$id int - -
$transition string|null null -
$identifier string|null null -
$criterion CriterionInterface|null null -
$names array<string, string> [] -
$descriptions array<string, string> [] -

publicaddDescription()

CatalogUpdateStruct.php : 106 
public addDescription(string $languageCode, string $description) : void

Parameters

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

publicaddName()

CatalogUpdateStruct.php : 93 
public addName(string $languageCode, string $name) : void

Parameters

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

publicgetCriterion()

CatalogUpdateStruct.php : 150 
public getCriterion() : CriterionInterface|null

Return values

CriterionInterface|null

publicgetDescription()

CatalogUpdateStruct.php : 111 
public getDescription(string $languageCode) : string

Parameters

Name Type Default value Description
$languageCode string - -

Return values

string

publicgetDescriptions()

CatalogUpdateStruct.php : 119 
public getDescriptions() : array<string, string>

Return values

array<string, string>

publicgetId()

CatalogUpdateStruct.php : 78 
public getId() : int

Return values

int

publicgetIdentifier()

CatalogUpdateStruct.php : 83 
public getIdentifier() : string|null

Return values

string|null

publicgetName()

CatalogUpdateStruct.php : 88 
public getName(string $languageCode) : string

Parameters

Name Type Default value Description
$languageCode string - -

Return values

string

publicgetNames()

CatalogUpdateStruct.php : 101 
public getNames() : array<string, string>

Return values

array<string, string>

publicgetStatus()

CatalogUpdateStruct.php : 145 
public getStatus() : string

Return values

string

publicgetTransition()

CatalogUpdateStruct.php : 127 
public getTransition() : string|null

Return values

string|null

publicsetCriterion()

CatalogUpdateStruct.php : 155 
public setCriterion(CriterionInterface|null $criterion) : void

Parameters

Name Type Default value Description
$criterion CriterionInterface|null - -

publicsetStatus()

CatalogUpdateStruct.php : 140 
public setStatus(string $status) : void

Parameters

Name Type Default value Description
$status string - -

publicsetTransition()

CatalogUpdateStruct.php : 135 
public setTransition(string|null $transition) : void

Parameters

Name Type Default value Description
$transition 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

()