Copied!

DiscountUpdateStruct

DiscountUpdateStruct.php : 19
Final
Extends ValueObject

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

DiscountUpdateStruct.php : 71

Construct object optionally with a set of properties.

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

publicaddCondition()

DiscountUpdateStruct.php : 192
public addCondition(DiscountConditionInterface $condition) : $this

Parameters

Name Type Default value Description
$condition DiscountConditionInterface - -

Return values

$this

publicgetConditions()

DiscountUpdateStruct.php : 187
public getConditions() : array<string|int, DiscountConditionInterface>

Return values

array<string|int, DiscountConditionInterface>

publicgetContext()

DiscountUpdateStruct.php : 246

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

DiscountUpdateStruct.php : 222
public getCreatedAt() : DateTimeInterface|null

Return values

DateTimeInterface|null

publicgetEndDate()

DiscountUpdateStruct.php : 210
public getEndDate() : DateTimeInterface|null

Return values

DateTimeInterface|null

publicgetIdentifier()

DiscountUpdateStruct.php : 103
public getIdentifier() : string|null

Return values

string|null

publicgetLastContributor()

DiscountUpdateStruct.php : 151
public getLastContributor() : User|null

Return values

User|null

publicgetPriority()

DiscountUpdateStruct.php : 115
public getPriority() : int|null

Return values

int|null

publicgetRule()

DiscountUpdateStruct.php : 163
public getRule() : DiscountRuleInterface|null

Return values

DiscountRuleInterface|null

publicgetStartDate()

DiscountUpdateStruct.php : 175
public getStartDate() : DateTimeInterface|null

Return values

DateTimeInterface|null

publicgetTranslations()

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

Return values

array<string|int, DiscountTranslationStruct>

publicgetUpdatedAt()

DiscountUpdateStruct.php : 234
public getUpdatedAt() : DateTimeInterface|null

Return values

DateTimeInterface|null

publicgetUser()

DiscountUpdateStruct.php : 139
public getUser() : User|null

Return values

User|null

publicisEnabled()

DiscountUpdateStruct.php : 127
public isEnabled() : bool|null

Return values

bool|null

publicsetConditions()

DiscountUpdateStruct.php : 203
public setConditions(array<string|int, mixed>|null $conditions) : $this

Parameters

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

Return values

$this

publicsetContext()

DiscountUpdateStruct.php : 251

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

DiscountUpdateStruct.php : 227
public setCreatedAt(DateTimeInterface|null $createdAt) : $this

Parameters

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

Return values

$this

publicsetEnabled()

DiscountUpdateStruct.php : 132
public setEnabled(bool|null $isEnabled) : $this

Parameters

Name Type Default value Description
$isEnabled bool|null - -

Return values

$this

publicsetEndDate()

DiscountUpdateStruct.php : 215
public setEndDate(DateTimeInterface|null $endDate) : $this

Parameters

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

Return values

$this

publicsetIdentifier()

DiscountUpdateStruct.php : 108
public setIdentifier(string|null $identifier) : $this

Parameters

Name Type Default value Description
$identifier string|null - -

Return values

$this

publicsetLastContributor()

DiscountUpdateStruct.php : 156
public setLastContributor(User|null $lastContributor) : self

Parameters

Name Type Default value Description
$lastContributor User|null - -

Return values

self

publicsetPriority()

DiscountUpdateStruct.php : 120
public setPriority(int|null $priority) : $this

Parameters

Name Type Default value Description
$priority int|null - -

Return values

$this

publicsetRule()

DiscountUpdateStruct.php : 168
public setRule(DiscountRuleInterface|null $rule) : $this

Parameters

Name Type Default value Description
$rule DiscountRuleInterface|null - -

Return values

$this

publicsetStartDate()

DiscountUpdateStruct.php : 180
public setStartDate(DateTimeInterface|null $startDate) : $this

Parameters

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

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

publicsetUpdatedAt()

DiscountUpdateStruct.php : 239
public setUpdatedAt(DateTimeInterface|null $updatedAt) : $this

Parameters

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

Return values

$this

publicsetUser()

DiscountUpdateStruct.php : 144
public setUser(User|null $user) : $this

Parameters

Name Type Default value Description
$user User|null - -

Return values

$this

protectedgetProperties()

ValueObject.php : 54

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>

Tags
Serializerignore

()