Interface DiscountInterface

Discount interface

Direct known implementers

Blesta\Core\Pricing\Modifier\Type\Discount\AbstractCoupon

Indirect known implementers

Blesta\Core\Pricing\Modifier\Type\Discount\Coupon

Namespace: Blesta\Core\Pricing\Modifier\Type\Discount
Package: blesta\core\Pricing\Modifier\Type\Discount
Copyright: Copyright (c) 2019, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at core/Pricing/Modifier/Type/Discount/DiscountInterface.php

Methods summary
`public boolean`	# `active( )` Determines whether the coupon is active Determines whether the coupon is active Returns boolean True if the coupon is active, or false otherwise
`public boolean`	# `applies( array $packageIds, boolean $options = false, boolean $recurs = false )` Determines whether the coupon applies to the given packages, their options, whether added new or recurring Determines whether the coupon applies to the given packages, their options, whether added new or recurring Parameters `$packageIds` One of the following: An array of package IDs that the coupon must apply to An array of package IDs mapped to periods and terms [packageID => [period => [term, term]]] that the coupon must apply to `$options` Whether or not the coupon must apply to package options (optional, default false) `$recurs` Whether or not the coupon is being used to recur or not (optional, default false) Returns boolean True if the coupon applies, or false otherwise
`public array`	# `amount( string $currency )` Retrieves the amount from the discount that applies for the given currency Retrieves the amount from the discount that applies for the given currency Parameters `$currency` The ISO 4217 currency code Returns array An array of key/value pairs representing the discount amount for the given currency
`public array`	# `packages( )` Retrieves the package IDs of all packages that the coupon supports Retrieves the package IDs of all packages that the coupon supports Returns array An array of package IDs

Packages

Classes

Interfaces

Interface DiscountInterface

Direct known implementers

Indirect known implementers

Returns

Parameters

Returns

Parameters

Returns

Returns