Copied!

DiscountCreateStruct

DiscountCreateStruct.php : 19
Final
Extends ValueObject
Implements TranslationAwareDiscountStructInterface, DiscountStructInterface
Uses TranslationAwareDiscountStructTrait

The base class for all value objects and structs.

Supports read-only properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using @property-read <type> <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Methods

public__construct()

DiscountCreateStruct.php : 69

Construct object optionally with a set of properties.

 
public __construct([string|null $identifier = null ][, string|null $type = null ][, int|null $priority = null ][, bool|null $isEnabled = null ][, User|null $user = null ][, DiscountRuleInterface|null $rule = null ][, DateTimeInterface|null $startDate = null ][, array<string|int, DiscountConditionInterface> $conditions = [] ][, array<string|int, DiscountTranslationStruct> $translations = [] ][, DateTimeInterface|null $endDate = null ][, DateTimeInterface|null $createdAt = null ][, DateTimeInterface|null $updatedAt = null ][, MapInterface<string, mixed>|null $context = null ])

Parameters

Name Type Default value Description
$identifier string|null null -
$type string|null null -
$priority int|null null -
$isEnabled bool|null null -
$user User|null null -
$rule DiscountRuleInterface|null null -
$startDate DateTimeInterface|null null -
$conditions array<string|int, DiscountConditionInterface> [] -
$translations array<string|int, DiscountTranslationStruct> [] -
$endDate DateTimeInterface|null null -
$createdAt DateTimeInterface|null null -
$updatedAt DateTimeInterface|null null -
$context MapInterface<string, mixed>|null null -

publicaddCondition()

DiscountCreateStruct.php : 193 
public addCondition(DiscountConditionInterface $condition) : $this

Parameters

Name Type Default value Description
$condition DiscountConditionInterface - -

Return values

$this

publicgetConditions()

DiscountCreateStruct.php : 188 
public getConditions() : array<string|int, DiscountConditionInterface>

Return values

array<string|int, DiscountConditionInterface>

publicgetContext()

DiscountCreateStruct.php : 243

Returns the discount context.

 
public getContext() : MapInterface<string, mixed>|null

The context is a set of key-value pairs that can be used to store additional information about the discount.

Return values

MapInterface<string, mixed>|null

publicgetCreatedAt()

DiscountCreateStruct.php : 219 
public getCreatedAt() : DateTimeInterface|null

Return values

DateTimeInterface|null

publicgetEndDate()

DiscountCreateStruct.php : 207 
public getEndDate() : DateTimeInterface|null

Return values

DateTimeInterface|null

publicgetIdentifier()

DiscountCreateStruct.php : 101 
public getIdentifier() : string|null

Return values

string|null

publicgetPriority()

DiscountCreateStruct.php : 128 
public getPriority() : int|null

Return values

int|null

publicgetRule()

DiscountCreateStruct.php : 164 
public getRule() : DiscountRuleInterface|null

Return values

DiscountRuleInterface|null

publicgetStartDate()

DiscountCreateStruct.php : 176 
public getStartDate() : DateTimeInterface|null

Return values

DateTimeInterface|null

publicgetTranslations()

TranslationAwareDiscountStructTrait.php : 19 
public getTranslations() : array<string|int, DiscountTranslationStruct>

Return values

array<string|int, DiscountTranslationStruct>

publicgetType()

DiscountCreateStruct.php : 113 
public getType() : string|null

Return values

string|null

publicgetUpdatedAt()

DiscountCreateStruct.php : 231 
public getUpdatedAt() : DateTimeInterface|null

Return values

DateTimeInterface|null

publicgetUser()

DiscountCreateStruct.php : 152 
public getUser() : User|null

Return values

User|null

publicisEnabled()

DiscountCreateStruct.php : 140 
public isEnabled() : bool|null

Return values

bool|null

publicsetConditions()

DiscountCreateStruct.php : 200 
public setConditions(array<string|int, mixed> $conditions) : $this

Parameters

Name Type Default value Description
$conditions array<string|int, mixed> - -

Return values

$this

publicsetContext()

DiscountCreateStruct.php : 248

Sets the discount context.

 
public setContext(MapInterface|null $context) : self

The context is a set of key-value pairs that can be used to store additional information about the discount.

Parameters

Name Type Default value Description
$context MapInterface|null - -

Return values

self

publicsetCreatedAt()

DiscountCreateStruct.php : 224 
public setCreatedAt(DateTimeInterface|null $createdAt) : $this

Parameters

Name Type Default value Description
$createdAt DateTimeInterface|null - -

Return values

$this

publicsetEnabled()

DiscountCreateStruct.php : 145 
public setEnabled(bool $isEnabled) : $this

Parameters

Name Type Default value Description
$isEnabled bool - -

Return values

$this

publicsetEndDate()

DiscountCreateStruct.php : 212 
public setEndDate(DateTimeInterface|null $endDate) : $this

Parameters

Name Type Default value Description
$endDate DateTimeInterface|null - -

Return values

$this

publicsetIdentifier()

DiscountCreateStruct.php : 106 
public setIdentifier(string $identifier) : $this

Parameters

Name Type Default value Description
$identifier string - -

Return values

$this

publicsetPriority()

DiscountCreateStruct.php : 133 
public setPriority(int $priority) : $this

Parameters

Name Type Default value Description
$priority int - -

Return values

$this

publicsetRule()

DiscountCreateStruct.php : 169 
public setRule(DiscountRuleInterface $rule) : $this

Parameters

Name Type Default value Description
$rule DiscountRuleInterface - -

Return values

$this

publicsetStartDate()

DiscountCreateStruct.php : 181 
public setStartDate(DateTimeInterface $startDate) : $this

Parameters

Name Type Default value Description
$startDate DateTimeInterface - -

Return values

$this

publicsetTranslations()

TranslationAwareDiscountStructTrait.php : 29 
public setTranslations(array<string|int, DiscountTranslationStruct> $translations) : $this

Parameters

Name Type Default value Description
$translations array<string|int, DiscountTranslationStruct> - -

Return values

$this

publicsetType()

DiscountCreateStruct.php : 121 
public setType(string $type) : $this

Parameters

Name Type Default value Description
$type string - -

Return values

$this

publicsetUpdatedAt()

DiscountCreateStruct.php : 236 
public setUpdatedAt(DateTimeInterface|null $updatedAt) : $this

Parameters

Name Type Default value Description
$updatedAt DateTimeInterface|null - -

Return values

$this

publicsetUser()

DiscountCreateStruct.php : 157 
public setUser(User $user) : $this

Parameters

Name Type Default value Description
$user User - -

Return values

$this

protectedgetProperties()

ValueObject.php : 53

Returns list of available properties' names.

 
protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

Override to add dynamic properties.

Parameters

Name Type Default value Description
$dynamicProperties array<int, string> []

Additional dynamic properties exposed on the object

Return values

array<int, string>

Attributes
#[Ignore]