1. class
  2. Thelia
  3. Coupon
  4. Type
  5. FreeProduct

FreeProduct

class FreeProduct extends AbstractRemoveOnProducts

Allow to remove an amount from the checkout total

Constants

COUPON_DATASET_NAME

The dataset name for all coupon specific input fields, that do not appear in the CouPonCreationForm form.

In the input form, these fields have to be created like:

theliacouponspecific[myfield, theliacouponcreationextended[myotherfield]

use the makeCouponField() method to do that safely.
AMOUNT_FIELD_NAME

A standard 'amount' filed name, thant can be used in coupons which extends this class
CATEGORY_ID

PRODUCTS_LIST

OFFERED_PRODUCT_ID

OFFERED_CATEGORY_ID

ADD_TO_CART_IN_PROCESS

This constant is user to mark a free product as in the process of being added to the cart, but the CartItem ID is not yet been defined.

Properties

$category_id from  AbstractRemoveOnProducts
$product_list from  AbstractRemoveOnProducts

Methods

__construct( FacadeInterface $facade)

Constructor

from  CouponAbstract
$this
setOrganizer( ConditionOrganizerInterface $organizer)

Set Condition Organizer

from  CouponAbstract
set( FacadeInterface $facade, string $code, string $title, string $shortDescription, string $description, array $effects, bool $isCumulative, bool $isRemovingPostage, bool $isAvailableOnSpecialOffers, bool $isEnabled, int $maxUsage, DateTime $expirationDate, ObjectCollection $freeShippingForCountries, ObjectCollection $freeShippingForModules, bool $perCustomerUsageCount)

No description

from  AbstractRemoveOnProducts
$this
setPerCustomerUsageCount( true $perCustomerUsageCount)

No description

from  CouponAbstract
boolean
getPerCustomerUsageCount()

No description

from  CouponAbstract
string
getCode()

Return Coupon code (ex: XMAS)

from  CouponAbstract
string
getTitle()

Return Coupon title (ex: Coupon for XMAS)

from  CouponAbstract
string
getShortDescription()

Return Coupon short description

from  CouponAbstract
string
getDescription()

Return Coupon description

from  CouponAbstract
bool
isCumulative()

If Coupon is cumulative or prevent any accumulation If is cumulative you can sum Coupon effects If not cancel all other Coupon and take the last given

from  CouponAbstract
bool
isRemovingPostage()

If Coupon is removing Checkout Postage

from  CouponAbstract
ObjectCollection
getFreeShippingForCountries()

No description

from  CouponAbstract
ObjectCollection
getFreeShippingForModules()

No description

from  CouponAbstract
float
exec()

No description

ConditionCollection
getConditions()

Return condition to validate the Coupon or not

from  CouponAbstract
$this
setConditions( ConditionCollection $conditions)

Replace the existing Conditions by those given in parameter If one Condition is badly implemented, no Condition will be added

from  CouponAbstract
DateTime
getExpirationDate()

Return Coupon expiration date

from  CouponAbstract
boolean
isAvailableOnSpecialOffers()

Check if the Coupon can be used against a product already with a special offer price

from  CouponAbstract
boolean
isEnabled()

Check if Coupon has been disabled by admin

from  CouponAbstract
int
getMaxUsage()

Return how many time the Coupon can be used again Ex : -1 unlimited

from  CouponAbstract
bool
isExpired()

Check if the Coupon is already Expired

from  CouponAbstract
string
getServiceId()

Get Coupon Manager service Id

from  CouponAbstract
bool
isMatching()

We overload this method here to remove the free products when the coupons conditions are no longer met.

string
getInputName()

This is the field label than will be displayed in the form.

from  CouponAbstract
string
drawBackOfficeInputs()

No description

array
getEffects( array $data)

Create the effect array from the list of fields

from  CouponAbstract
clear()

No description

bool
isInUse()

No description

from  CouponAbstract
setFieldsValue( Array $effects)

No description

float
getCartItemDiscount( CartItem $cartItem)

No description

string
drawBaseBackOfficeInputs( string $templateName, array $otherFields)

No description

from  AbstractRemoveOnProducts
getBaseFieldList($otherFields)

No description

from  AbstractRemoveOnProducts
checkBaseCouponFieldValue($fieldName, $fieldValue)

No description

from  AbstractRemoveOnProducts
string
getName()

Get I18n name

string
getToolTip()

No description

Details

in CouponAbstract at line 120
__construct( FacadeInterface $facade)

Constructor

Parameters

FacadeInterface $facade Service facade

in CouponAbstract at line 134
$this setOrganizer( ConditionOrganizerInterface $organizer)

Set Condition Organizer

Parameters

ConditionOrganizerInterface $organizer Manage Condition groups (&& and ||)

Return Value

$this

in AbstractRemoveOnProducts at line 51
set( FacadeInterface $facade, string $code, string $title, string $shortDescription, string $description, array $effects, bool $isCumulative, bool $isRemovingPostage, bool $isAvailableOnSpecialOffers, bool $isEnabled, int $maxUsage, DateTime $expirationDate, ObjectCollection $freeShippingForCountries, ObjectCollection $freeShippingForModules, bool $perCustomerUsageCount)

Parameters

FacadeInterface $facade Provides necessary value from Thelia
string $code Coupon code (ex: XMAS)
string $title Coupon title (ex: Coupon for XMAS)
string $shortDescription Coupon short description
string $description Coupon description
array $effects Coupon effects params
bool $isCumulative If Coupon is cumulative
bool $isRemovingPostage If Coupon is removing postage
bool $isAvailableOnSpecialOffers If available on Product already on special offer price
bool $isEnabled False if Coupon is disabled by admin
int $maxUsage How many usage left
DateTime $expirationDate When the Code is expiring
ObjectCollection $freeShippingForCountries list of countries which shipping is free. All if empty
ObjectCollection $freeShippingForModules list of modules for which shipping is free. All if empty
bool $perCustomerUsageCount true if usage count is per customer only

in CouponAbstract at line 190
$this setPerCustomerUsageCount( true $perCustomerUsageCount)

Parameters

true $perCustomerUsageCount

Return Value

$this

in CouponAbstract at line 200
boolean getPerCustomerUsageCount()

Return Value

boolean

in CouponAbstract at line 210
string getCode()

Return Coupon code (ex: XMAS)

Return Value

string

in CouponAbstract at line 220
string getTitle()

Return Coupon title (ex: Coupon for XMAS)

Return Value

string

in CouponAbstract at line 230
string getShortDescription()

Return Coupon short description

Return Value

string

in CouponAbstract at line 240
string getDescription()

Return Coupon description

Return Value

string

in CouponAbstract at line 252
bool isCumulative()

If Coupon is cumulative or prevent any accumulation If is cumulative you can sum Coupon effects If not cancel all other Coupon and take the last given

Return Value

bool

in CouponAbstract at line 262
bool isRemovingPostage()

If Coupon is removing Checkout Postage

Return Value

bool

in CouponAbstract at line 270
ObjectCollection getFreeShippingForCountries()

Return Value

ObjectCollection list of country IDs for which shipping is free. All if empty

in CouponAbstract at line 278
ObjectCollection getFreeShippingForModules()

Return Value

ObjectCollection list of module IDs for which shipping is free. All if empty

at line 178
float exec()

Return Value

float Amount removed from the cart total

in CouponAbstract at line 296
ConditionCollection getConditions()

Return condition to validate the Coupon or not

Return Value

ConditionCollection A set of ConditionInterface

in CouponAbstract at line 310
$this setConditions( ConditionCollection $conditions)

Replace the existing Conditions by those given in parameter If one Condition is badly implemented, no Condition will be added

Parameters

ConditionCollection $conditions ConditionInterface to add

Return Value

$this

Exceptions

InvalidConditionException

in CouponAbstract at line 322
DateTime getExpirationDate()

Return Coupon expiration date

Return Value

DateTime

in CouponAbstract at line 333
boolean isAvailableOnSpecialOffers()

Check if the Coupon can be used against a product already with a special offer price

Return Value

boolean

in CouponAbstract at line 343
boolean isEnabled()

Check if Coupon has been disabled by admin

Return Value

boolean

in CouponAbstract at line 354
int getMaxUsage()

Return how many time the Coupon can be used again Ex : -1 unlimited

Return Value

int

in CouponAbstract at line 364
bool isExpired()

Check if the Coupon is already Expired

Return Value

bool

in CouponAbstract at line 381
string getServiceId()

Get Coupon Manager service Id

Return Value

string

at line 163
bool isMatching()

We overload this method here to remove the free products when the coupons conditions are no longer met.

Return Value

bool

in CouponAbstract at line 405
string getInputName()

This is the field label than will be displayed in the form.

This method should be overridden to be useful.

For backward compatibility only.

Return Value

string

at line 311
string drawBackOfficeInputs()

Return Value

string HTML string

in CouponAbstract at line 495
array getEffects( array $data)

Create the effect array from the list of fields

Parameters

array $data the input form data (e.g. $form->getData())

Return Value

array a filedName => fieldValue array

at line 325
clear()

in CouponAbstract at line 514
bool isInUse()

Return Value

bool true if the coupon is currently in use in the current order process, false otherwise

at line 49
setFieldsValue( Array $effects)

Parameters

Array $effects the Coupon effects params

at line 58
float getCartItemDiscount( CartItem $cartItem)

Parameters

CartItem $cartItem the cart item

Return Value

float the discount value

in AbstractRemoveOnProducts at line 125
string drawBaseBackOfficeInputs( string $templateName, array $otherFields)

Parameters

string $templateName the path to the template
array $otherFields the list of additional fields fields

Return Value

string the rendered template.

in AbstractRemoveOnProducts at line 143
getBaseFieldList($otherFields)

Parameters

$otherFields

in AbstractRemoveOnProducts at line 151
checkBaseCouponFieldValue($fieldName, $fieldValue)

Parameters

$fieldName
$fieldValue

at line 286
string getName()

Get I18n name

Return Value

string

at line 296
string getToolTip()

Return Value

string