CatalogUpdateStruct

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

CatalogUpdateStruct.php : 56 Copy path

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>	[]	-

addDescription() ¶

CatalogUpdateStruct.php : 106 Copy path

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

Parameters

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

addName() ¶

CatalogUpdateStruct.php : 93 Copy path

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

Parameters

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

getCriterion() ¶

CatalogUpdateStruct.php : 150 Copy path

public getCriterion() : CriterionInterface|null

Return values

CriterionInterface|null

getDescription() ¶

CatalogUpdateStruct.php : 111 Copy path

public getDescription(string $languageCode) : string

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-

Return values

string

getDescriptions() ¶

CatalogUpdateStruct.php : 119 Copy path

public getDescriptions() : array<string, string>

Return values

array<string, string>

getId() ¶

CatalogUpdateStruct.php : 78 Copy path

public getId() : int

Return values

int

getIdentifier() ¶

CatalogUpdateStruct.php : 83 Copy path

public getIdentifier() : string|null

Return values

string|null

getName() ¶

CatalogUpdateStruct.php : 88 Copy path

public getName(string $languageCode) : string

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-

Return values

string

getNames() ¶

CatalogUpdateStruct.php : 101 Copy path

public getNames() : array<string, string>

Return values

array<string, string>

getStatus() ¶

CatalogUpdateStruct.php : 145 Copy path

public getStatus() : string

Return values

string

getTransition() ¶

CatalogUpdateStruct.php : 127 Copy path

public getTransition() : string|null

Return values

string|null

setCriterion() ¶

CatalogUpdateStruct.php : 155 Copy path

public setCriterion(CriterionInterface|null $criterion) : void

Parameters

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

setStatus() ¶

CatalogUpdateStruct.php : 140 Copy path

public setStatus(string $status) : void

Parameters

Name	Type	Default value	Description
$status	string	-	-

setTransition() ¶

CatalogUpdateStruct.php : 135 Copy path

public setTransition(string|null $transition) : void

Parameters

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