Copied!

GeneralPropertiesInterface

GeneralPropertiesInterface.php : 19
Interface
Extends DiscountDataAwareInterface, CustomDataAwareInterface

Constants

publicIDENTIFIER

GeneralPropertiesInterface.php : 21 
public mixed IDENTIFIER = 'general_properties'

publicLABEL_KEY

GeneralPropertiesInterface.php : 22 
public mixed LABEL_KEY = 'discount.step.general_properties.label'

Methods

publicaddData()

CustomDataAwareInterface.php : 34 
public addData(object $data) : $this

Parameters

Name Type Default value Description
$data object - -

Return values

$this

publicaddRegion()

GeneralPropertiesInterface.php : 109 
public addRegion(RegionInterface $region) : $this

Parameters

Name Type Default value Description
$region RegionInterface - -

Return values

$this

publicgetCurrency()

GeneralPropertiesInterface.php : 116 
public getCurrency() : CurrencyInterface|null

Return values

CurrencyInterface|null

publicgetData()

CustomDataAwareInterface.php : 22

TODO: Create a dedicated "Valid"-like constraint that will use different validation groups in itself.

 
public getData() : array<string|int, object>

TODO: See https://github.com/symfony/symfony/issues/40741.

Return values

array<string|int, object>

publicgetDescription()

GeneralPropertiesInterface.php : 54 
public getDescription() : string|null

Return values

string|null

Attributes
#[Length]
$max: 10000

publicgetDiscountData()

DiscountDataAwareInterface.php : 13 
public getDiscountData() : DiscountDataInterface

Return values

DiscountDataInterface

publicgetEndTime()

GeneralPropertiesInterface.php : 86 
public getEndTime() : DateTimeImmutable|null

Return values

DateTimeImmutable|null

Attributes
#[GreaterThan]
$propertyPath: 'startTime'

publicgetIdentifier()

GeneralPropertiesInterface.php : 42 
public getIdentifier() : string

Return values

string

Attributes
#[Sequentially]
[new Assert\NotBlank(), new Assert\Length(min: 1, max: 190), new Identifier()]

publicgetLabel()

GeneralPropertiesInterface.php : 123 
public getLabel() : string|null

Return values

string|null

Attributes
#[Length]
$min: 1
$max: 190

publicgetLabelDescription()

GeneralPropertiesInterface.php : 131 
public getLabelDescription() : string|null

Return values

string|null

Attributes
#[Length]
$max: 10000

publicgetLanguage()

GeneralPropertiesInterface.php : 29 
public getLanguage() : Language

Return values

Language

publicgetName()

GeneralPropertiesInterface.php : 31 
public getName() : string

Return values

string

Attributes
#[Sequentially]
[new Assert\NotBlank(), new Assert\Length(min: 1, max: 190)]

publicgetPriority()

GeneralPropertiesInterface.php : 62 
public getPriority() : int

Return values

int

Attributes
#[Range]
$min: 1
$max: 10

publicgetRegions()

GeneralPropertiesInterface.php : 104 
public getRegions() : array<string|int, RegionInterface>

Return values

array<string|int, RegionInterface>

publicgetStartTime()

GeneralPropertiesInterface.php : 77 
public getStartTime() : DateTimeImmutable|null

Return values

DateTimeImmutable|null

Attributes
#[LessThan]
$propertyPath: 'endTime'
#[NotBlank]

publicisEnabled()

GeneralPropertiesInterface.php : 94 
public isEnabled() : bool

Return values

bool

publicisPermanent()

GeneralPropertiesInterface.php : 70 
public isPermanent() : bool

Return values

bool

publicremoveData()

CustomDataAwareInterface.php : 39 
public removeData(object $data) : $this

Parameters

Name Type Default value Description
$data object - -

Return values

$this

publicremoveRegion()

GeneralPropertiesInterface.php : 114 
public removeRegion(RegionInterface $region) : $this

Parameters

Name Type Default value Description
$region RegionInterface - -

Return values

$this

publicsetCurrency()

GeneralPropertiesInterface.php : 121 
public setCurrency(CurrencyInterface|null $currency) : $this

Parameters

Name Type Default value Description
$currency CurrencyInterface|null - -

Return values

$this

publicsetData()

CustomDataAwareInterface.php : 29 
public setData(array<string|int, object> $data) : $this

Parameters

Name Type Default value Description
$data array<string|int, object> - -

Return values

$this

publicsetDescription()

GeneralPropertiesInterface.php : 60 
public setDescription(string|null $description) : $this

Parameters

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

Return values

$this

publicsetDiscountData()

DiscountDataAwareInterface.php : 15 
public setDiscountData(DiscountDataInterface $discountData) : void

Parameters

Name Type Default value Description
$discountData DiscountDataInterface - -

publicsetEnabled()

GeneralPropertiesInterface.php : 99 
public setEnabled(bool $enabled) : $this

Parameters

Name Type Default value Description
$enabled bool - -

Return values

$this

publicsetEndTime()

GeneralPropertiesInterface.php : 92 
public setEndTime(DateTimeInterface|null $endTime) : $this

Parameters

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

Return values

$this

publicsetIdentifier()

GeneralPropertiesInterface.php : 52 
public setIdentifier(string|null $identifier) : $this

Parameters

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

Return values

$this

publicsetLabel()

GeneralPropertiesInterface.php : 129 
public setLabel(string|null $label) : $this

Parameters

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

Return values

$this

publicsetLabelDescription()

GeneralPropertiesInterface.php : 137 
public setLabelDescription(string|null $labelDescription) : $this

Parameters

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

Return values

$this

publicsetLanguage()

GeneralPropertiesInterface.php : 27 
public setLanguage(Language $language) : $this

Parameters

Name Type Default value Description
$language Language - -

Return values

$this

publicsetName()

GeneralPropertiesInterface.php : 40 
public setName(string|null $name) : $this

Parameters

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

Return values

$this

publicsetPermanent()

GeneralPropertiesInterface.php : 75 
public setPermanent(bool $permanent) : $this

Parameters

Name Type Default value Description
$permanent bool - -

Return values

$this

publicsetPriority()

GeneralPropertiesInterface.php : 68 
public setPriority(int $priority) : $this

Parameters

Name Type Default value Description
$priority int - -

Return values

$this

publicsetStartTime()

GeneralPropertiesInterface.php : 84 
public setStartTime(DateTimeInterface|null $startTime) : $this

Parameters

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

Return values

$this