CatalogCreateStruct

CatalogCreateStruct.php : 16 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() ¶

CatalogCreateStruct.php : 56 Copy path

Construct object optionally with a set of properties.

public __construct(string $identifier, CriterionInterface $criterion, array<string, string> $names, array<string, string> $descriptions[, string $status = Status::DRAFT_PLACE ][, int|null $creatorId = null ])

Parameters

Name	Type	Default value	Description
$identifier	string	-	-
$criterion	CriterionInterface	-	-
$names	array<string, string>	-	-
$descriptions	array<string, string>	-	-
$status	string	Status::DRAFT_PLACE	-
$creatorId	int\|null	null	-

addDescription() ¶

CatalogCreateStruct.php : 100 Copy path

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

Parameters

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

addName() ¶

CatalogCreateStruct.php : 87 Copy path

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

Parameters

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

getCreatorId() ¶

CatalogCreateStruct.php : 118 Copy path

public getCreatorId() : int|null

Return values

int|null

getCriterion() ¶

CatalogCreateStruct.php : 133 Copy path

public getCriterion() : CriterionInterface

Return values

CriterionInterface

getDescription() ¶

CatalogCreateStruct.php : 105 Copy path

public getDescription(string $languageCode) : string

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-

Return values

string

getDescriptions() ¶

CatalogCreateStruct.php : 113 Copy path

public getDescriptions() : array<string, string>

Return values

array<string, string>

getIdentifier() ¶

CatalogCreateStruct.php : 77 Copy path

public getIdentifier() : string

Return values

string

getName() ¶

CatalogCreateStruct.php : 82 Copy path

public getName(string $languageCode) : string

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-

Return values

string

getNames() ¶

CatalogCreateStruct.php : 95 Copy path

public getNames() : array<string, string>

Return values

array<string, string>

getStatus() ¶

CatalogCreateStruct.php : 128 Copy path

public getStatus() : string

Return values

string

setCreatorId() ¶

CatalogCreateStruct.php : 123 Copy path

public setCreatorId(int $creatorId) : void

Parameters

Name	Type	Default value	Description
$creatorId	int	-	-

setCriterion() ¶

CatalogCreateStruct.php : 138 Copy path

public setCriterion(CriterionInterface $criterion) : void

Parameters

Name	Type	Default value	Description
$criterion	CriterionInterface	-	-

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>