GeneralPropertiesInterface

GeneralPropertiesInterface.php : 18 Copy path

Interface

Extends DiscountDataAwareInterface, CustomDataAwareInterface

Constants¶

IDENTIFIER ¶

GeneralPropertiesInterface.php : 20 Copy path

public mixed IDENTIFIER = 'general_properties'

LABEL_KEY ¶

GeneralPropertiesInterface.php : 21 Copy path

public mixed LABEL_KEY = 'discount.step.general_properties.label'

Methods¶

addData() ¶

CustomDataAwareInterface.php : 34 Copy path

public addData(object $data) : $this

Parameters

Name	Type	Default value	Description
$data	object	-	-

Return values

$this

addRegion() ¶

GeneralPropertiesInterface.php : 103 Copy path

public addRegion(RegionInterface $region) : $this

Parameters

Name	Type	Default value	Description
$region	RegionInterface	-	-

Return values

$this

getCurrency() ¶

GeneralPropertiesInterface.php : 110 Copy path

public getCurrency() : CurrencyInterface|null

Return values

CurrencyInterface|null

getData() ¶

CustomDataAwareInterface.php : 22 Copy path

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>

getDescription() ¶

GeneralPropertiesInterface.php : 48 Copy path

public getDescription() : string|null

Return values

string|null

Attributes

#[Length]: $max: 10000

getDiscountData() ¶

DiscountDataAwareInterface.php : 13 Copy path

public getDiscountData() : DiscountDataInterface

Return values

DiscountDataInterface

getEndTime() ¶

GeneralPropertiesInterface.php : 80 Copy path

public getEndTime() : DateTimeImmutable|null

Return values

DateTimeImmutable|null

#[GreaterThan]: $propertyPath: 'startTime'

getIdentifier() ¶

GeneralPropertiesInterface.php : 41 Copy path

public getIdentifier() : string

Return values

string

getLabel() ¶

GeneralPropertiesInterface.php : 117 Copy path

public getLabel() : string|null

Return values

string|null

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

getLabelDescription() ¶

GeneralPropertiesInterface.php : 125 Copy path

public getLabelDescription() : string|null

Return values

string|null

Attributes

#[Length]: $max: 10000

getLanguage() ¶

GeneralPropertiesInterface.php : 28 Copy path

public getLanguage() : Language

Return values

Language

getName() ¶

GeneralPropertiesInterface.php : 30 Copy path

public getName() : string

Return values

string

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

getPriority() ¶

GeneralPropertiesInterface.php : 56 Copy path

public getPriority() : int

Return values

int

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

getRegions() ¶

GeneralPropertiesInterface.php : 98 Copy path

public getRegions() : array<string|int, RegionInterface>

Return values

array<string|int, RegionInterface>

getStartTime() ¶

GeneralPropertiesInterface.php : 71 Copy path

public getStartTime() : DateTimeImmutable|null

Return values

DateTimeImmutable|null

#[LessThan]: $propertyPath: 'endTime'

#[NotBlank]

isEnabled() ¶

GeneralPropertiesInterface.php : 88 Copy path

public isEnabled() : bool

Return values

bool

isPermanent() ¶

GeneralPropertiesInterface.php : 64 Copy path

public isPermanent() : bool

Return values

bool

removeData() ¶

CustomDataAwareInterface.php : 39 Copy path

public removeData(object $data) : $this

Parameters

Name	Type	Default value	Description
$data	object	-	-

Return values

$this

removeRegion() ¶

GeneralPropertiesInterface.php : 108 Copy path

public removeRegion(RegionInterface $region) : $this

Parameters

Name	Type	Default value	Description
$region	RegionInterface	-	-

Return values

$this

setCurrency() ¶

GeneralPropertiesInterface.php : 115 Copy path

public setCurrency(CurrencyInterface|null $currency) : $this

Parameters

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

Return values

$this

setData() ¶

CustomDataAwareInterface.php : 29 Copy path

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

Parameters

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

Return values

$this

setDescription() ¶

GeneralPropertiesInterface.php : 54 Copy path

public setDescription(string|null $description) : $this

Parameters

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

Return values

$this

setDiscountData() ¶

DiscountDataAwareInterface.php : 15 Copy path

public setDiscountData(DiscountDataInterface $discountData) : void

Parameters

Name	Type	Default value	Description
$discountData	DiscountDataInterface	-	-

setEnabled() ¶

GeneralPropertiesInterface.php : 93 Copy path

public setEnabled(bool $enabled) : $this

Parameters

Name	Type	Default value	Description
$enabled	bool	-	-

Return values

$this

setEndTime() ¶

GeneralPropertiesInterface.php : 86 Copy path

public setEndTime(DateTimeInterface|null $endTime) : $this

Parameters

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

Return values

$this

setIdentifier() ¶

GeneralPropertiesInterface.php : 46 Copy path

public setIdentifier(string|null $identifier) : $this

Parameters

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

Return values

$this

setLabel() ¶

GeneralPropertiesInterface.php : 123 Copy path

public setLabel(string|null $label) : $this

Parameters

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

Return values

$this

setLabelDescription() ¶

GeneralPropertiesInterface.php : 131 Copy path

public setLabelDescription(string|null $labelDescription) : $this

Parameters

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

Return values

$this

setLanguage() ¶

GeneralPropertiesInterface.php : 26 Copy path

public setLanguage(Language $language) : $this

Parameters

Name	Type	Default value	Description
$language	Language	-	-

Return values

$this

setName() ¶

GeneralPropertiesInterface.php : 39 Copy path

public setName(string|null $name) : $this

Parameters

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

Return values

$this

setPermanent() ¶

GeneralPropertiesInterface.php : 69 Copy path

public setPermanent(bool $permanent) : $this

Parameters

Name	Type	Default value	Description
$permanent	bool	-	-

Return values

$this

setPriority() ¶

GeneralPropertiesInterface.php : 62 Copy path

public setPriority(int $priority) : $this

Parameters

Name	Type	Default value	Description
$priority	int	-	-

Return values

$this

setStartTime() ¶

GeneralPropertiesInterface.php : 78 Copy path

public setStartTime(DateTimeInterface|null $startTime) : $this

Parameters

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

Return values

$this