Coupon Class Reference

Inheritance diagram for Coupon:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, array $couponParameters)
	getFormatsList ()
	getDefaultLength ()
	getDefaultFormat ()
	getDefaultPrefix ()
	getDefaultSuffix ()
	getDefaultDashInterval ()
	getCharset ($format)
	getCodeSeparator ()
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	COUPON_FORMAT_ALPHANUMERIC = 'alphanum'
const	COUPON_FORMAT_ALPHABETICAL = 'alpha'
const	COUPON_FORMAT_NUMERIC = 'num'
const	COUPON_TYPE_SPECIFIC_AUTOGENERATED = 1
const	XML_PATH_SALES_RULE_COUPON_LENGTH = 'promo/auto_generated_coupon_codes/length'
const	XML_PATH_SALES_RULE_COUPON_FORMAT = 'promo/auto_generated_coupon_codes/format'
const	XML_PATH_SALES_RULE_COUPON_PREFIX = 'promo/auto_generated_coupon_codes/prefix'
const	XML_PATH_SALES_RULE_COUPON_SUFFIX = 'promo/auto_generated_coupon_codes/suffix'
const	XML_PATH_SALES_RULE_COUPON_DASH_INTERVAL = 'promo/auto_generated_coupon_codes/dash'

Protected Attributes
	$_couponParameters
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Detailed Description

Helper for coupon codes creating and managing

@api

Since

100.0.2

Definition at line 15 of file Coupon.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		array	$couponParameters
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
array	$couponParameters

Definition at line 53 of file Coupon.php.

      {
        $this->_couponParameters = $couponParameters;
        parent::__construct($context);
    }

Member Function Documentation

getCharset()

getCharset

(

$format

)

Get Coupon's alphabet as array of chars

Parameters

string

$format

Returns

array|bool

Definition at line 146 of file Coupon.php.

    {
        return str_split($this->_couponParameters['charset'][$format]);
    }

getCodeSeparator()

getCodeSeparator

(

)

Retrieve Separator

Returns

string

Definition at line 156 of file Coupon.php.

    {
        return $this->_couponParameters['separator'];
    }

getDefaultDashInterval()

getDefaultDashInterval

(

)

Get dashes occurrences frequency in coupon code

Returns

int

Definition at line 132 of file Coupon.php.

    {
        return (int)$this->scopeConfig->getValue(
            self::XML_PATH_SALES_RULE_COUPON_DASH_INTERVAL,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getDefaultFormat()

getDefaultFormat

(

)

Get default coupon code format

Returns

int

Definition at line 93 of file Coupon.php.

    {
        return $this->scopeConfig->getValue(
            self::XML_PATH_SALES_RULE_COUPON_FORMAT,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getDefaultLength()

getDefaultLength

(

)

Get default coupon code length

Returns

int

Definition at line 80 of file Coupon.php.

    {
        return (int)$this->scopeConfig->getValue(
            self::XML_PATH_SALES_RULE_COUPON_LENGTH,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getDefaultPrefix()

getDefaultPrefix

(

)

Get default coupon code prefix

Returns

string

Definition at line 106 of file Coupon.php.

    {
        return $this->scopeConfig->getValue(
            self::XML_PATH_SALES_RULE_COUPON_PREFIX,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getDefaultSuffix()

getDefaultSuffix

(

)

Get default coupon code suffix

Returns

string

Definition at line 119 of file Coupon.php.

    {
        return $this->scopeConfig->getValue(
            self::XML_PATH_SALES_RULE_COUPON_SUFFIX,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getFormatsList()

getFormatsList

(

)

Get all possible coupon codes formats

Returns

array

Definition at line 66 of file Coupon.php.

    {
        return [
            self::COUPON_FORMAT_ALPHANUMERIC => __('Alphanumeric'),
            self::COUPON_FORMAT_ALPHABETICAL => __('Alphabetical'),
            self::COUPON_FORMAT_NUMERIC => __('Numeric')
        ];
    }

Field Documentation

$_couponParameters

$_couponParameters

protected

Definition at line 47 of file Coupon.php.

COUPON_FORMAT_ALPHABETICAL

const COUPON_FORMAT_ALPHABETICAL = 'alpha'

Definition at line 22 of file Coupon.php.

COUPON_FORMAT_ALPHANUMERIC

const COUPON_FORMAT_ALPHANUMERIC = 'alphanum'

Constants which defines all possible coupon codes formats

Definition at line 20 of file Coupon.php.

COUPON_FORMAT_NUMERIC

const COUPON_FORMAT_NUMERIC = 'num'

Definition at line 24 of file Coupon.php.

COUPON_TYPE_SPECIFIC_AUTOGENERATED

const COUPON_TYPE_SPECIFIC_AUTOGENERATED = 1

Defines type of Coupon

Definition at line 29 of file Coupon.php.

XML_PATH_SALES_RULE_COUPON_DASH_INTERVAL

const XML_PATH_SALES_RULE_COUPON_DASH_INTERVAL = 'promo/auto_generated_coupon_codes/dash'

Definition at line 42 of file Coupon.php.

XML_PATH_SALES_RULE_COUPON_FORMAT

const XML_PATH_SALES_RULE_COUPON_FORMAT = 'promo/auto_generated_coupon_codes/format'

Definition at line 36 of file Coupon.php.

XML_PATH_SALES_RULE_COUPON_LENGTH

const XML_PATH_SALES_RULE_COUPON_LENGTH = 'promo/auto_generated_coupon_codes/length'

XML paths to coupon codes generation options

Definition at line 34 of file Coupon.php.

XML_PATH_SALES_RULE_COUPON_PREFIX

const XML_PATH_SALES_RULE_COUPON_PREFIX = 'promo/auto_generated_coupon_codes/prefix'

Definition at line 38 of file Coupon.php.

XML_PATH_SALES_RULE_COUPON_SUFFIX

const XML_PATH_SALES_RULE_COUPON_SUFFIX = 'promo/auto_generated_coupon_codes/suffix'

Definition at line 40 of file Coupon.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-sales-rule/Helper/Coupon.php