Copied!

CatalogCreateStruct

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

CatalogCreateStruct.php : 56

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 -

publicaddDescription()

CatalogCreateStruct.php : 100 
public addDescription(string $languageCode, string $description) : void

Parameters

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

publicaddName()

CatalogCreateStruct.php : 87 
public addName(string $languageCode, string $name) : void

Parameters

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

publicgetCreatorId()

CatalogCreateStruct.php : 118 
public getCreatorId() : int|null

Return values

int|null

publicgetCriterion()

CatalogCreateStruct.php : 133 
public getCriterion() : CriterionInterface

Return values

CriterionInterface

publicgetDescription()

CatalogCreateStruct.php : 105 
public getDescription(string $languageCode) : string

Parameters

Name Type Default value Description
$languageCode string - -

Return values

string

publicgetDescriptions()

CatalogCreateStruct.php : 113 
public getDescriptions() : array<string, string>

Return values

array<string, string>

publicgetIdentifier()

CatalogCreateStruct.php : 77 
public getIdentifier() : string

Return values

string

publicgetName()

CatalogCreateStruct.php : 82 
public getName(string $languageCode) : string

Parameters

Name Type Default value Description
$languageCode string - -

Return values

string

publicgetNames()

CatalogCreateStruct.php : 95 
public getNames() : array<string, string>

Return values

array<string, string>

publicgetStatus()

CatalogCreateStruct.php : 128 
public getStatus() : string

Return values

string

publicsetCreatorId()

CatalogCreateStruct.php : 123 
public setCreatorId(int $creatorId) : void

Parameters

Name Type Default value Description
$creatorId int - -

publicsetCriterion()

CatalogCreateStruct.php : 138 
public setCriterion(CriterionInterface $criterion) : void

Parameters

Name Type Default value Description
$criterion CriterionInterface - -

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

()