Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_SalesRule_Exception
  • Mage_SalesRule_Helper_Coupon
  • Mage_SalesRule_Helper_Data
  • Mage_SalesRule_Model_Coupon
  • Mage_SalesRule_Model_Coupon_Codegenerator
  • Mage_SalesRule_Model_Coupon_Massgenerator
  • Mage_SalesRule_Model_Mysql4_Coupon
  • Mage_SalesRule_Model_Mysql4_Coupon_Collection
  • Mage_SalesRule_Model_Mysql4_Coupon_Usage
  • Mage_SalesRule_Model_Mysql4_Report_Collection
  • Mage_SalesRule_Model_Mysql4_Report_Rule
  • Mage_SalesRule_Model_Mysql4_Report_Updatedat_Collection
  • Mage_SalesRule_Model_Mysql4_Rule
  • Mage_SalesRule_Model_Mysql4_Rule_Collection
  • Mage_SalesRule_Model_Mysql4_Rule_Customer
  • Mage_SalesRule_Model_Mysql4_Rule_Customer_Collection
  • Mage_SalesRule_Model_Mysql4_Rule_Product
  • Mage_SalesRule_Model_Mysql4_Rule_Product_Collection
  • Mage_SalesRule_Model_Observer
  • Mage_SalesRule_Model_Quote_Discount
  • Mage_SalesRule_Model_Quote_Freeshipping
  • Mage_SalesRule_Model_Quote_Nominal_Discount
  • Mage_SalesRule_Model_Resource_Coupon
  • Mage_SalesRule_Model_Resource_Coupon_Collection
  • Mage_SalesRule_Model_Resource_Coupon_Usage
  • Mage_SalesRule_Model_Resource_Report_Collection
  • Mage_SalesRule_Model_Resource_Report_Rule
  • Mage_SalesRule_Model_Resource_Report_Rule_Createdat
  • Mage_SalesRule_Model_Resource_Report_Rule_Updatedat
  • Mage_SalesRule_Model_Resource_Report_Updatedat_Collection
  • Mage_SalesRule_Model_Resource_Rule
  • Mage_SalesRule_Model_Resource_Rule_Collection
  • Mage_SalesRule_Model_Resource_Rule_Customer
  • Mage_SalesRule_Model_Resource_Rule_Customer_Collection
  • Mage_SalesRule_Model_Resource_Rule_Product
  • Mage_SalesRule_Model_Resource_Rule_Product_Collection
  • Mage_SalesRule_Model_Rule
  • Mage_SalesRule_Model_Rule_Action_Collection
  • Mage_SalesRule_Model_Rule_Action_Product
  • Mage_SalesRule_Model_Rule_Condition_Address
  • Mage_SalesRule_Model_Rule_Condition_Combine
  • Mage_SalesRule_Model_Rule_Condition_Product
  • Mage_SalesRule_Model_Rule_Condition_Product_Combine
  • Mage_SalesRule_Model_Rule_Condition_Product_Found
  • Mage_SalesRule_Model_Rule_Condition_Product_Subselect
  • Mage_SalesRule_Model_Rule_Customer
  • Mage_SalesRule_Model_Rule_Product
  • Mage_SalesRule_Model_System_Config_Source_Coupon_Format
  • Mage_SalesRule_Model_Validator

Interfaces

  • Mage_SalesRule_Model_Coupon_CodegeneratorInterface
  • Overview
  • Package
  • Class
  • Tree

Class Mage_SalesRule_Helper_Coupon

Helper for coupon codes creating and managing

Mage_Core_Helper_Abstract
Extended by Mage_SalesRule_Helper_Coupon
Package: Mage\SalesRule
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/SalesRule/Helper/Coupon.php
Methods summary
public array
# getFormatsList( )

Get all possible coupon codes formats

Get all possible coupon codes formats

Returns

array
public integer
# getDefaultLength( )

Get default coupon code length

Get default coupon code length

Returns

integer
public integer
# getDefaultFormat( )

Get default coupon code format

Get default coupon code format

Returns

integer
public string
# getDefaultPrefix( )

Get default coupon code prefix

Get default coupon code prefix

Returns

string
public string
# getDefaultSuffix( )

Get default coupon code suffix

Get default coupon code suffix

Returns

string
public integer
# getDefaultDashInterval( )

Get dashes occurrences frequency in coupon code

Get dashes occurrences frequency in coupon code

Returns

integer
public array|boolean
# getCharset( string $format )

Get Coupon's alphabet as array of chars

Get Coupon's alphabet as array of chars

Parameters

$format
string
$format

Returns

array|boolean
public string
# getCodeSeparator( )

Retrieve Separator from config

Retrieve Separator from config

Returns

string
Methods inherited from Mage_Core_Helper_Abstract
__(), _cleanCache(), _getModuleName(), _getRequest(), _getUrl(), _loadCache(), _removeCache(), _saveCache(), escapeHtml(), escapeUrl(), getLayout(), isModuleEnabled(), isModuleOutputEnabled(), jsQuoteEscape(), quoteEscape(), removeTags(), setLayout(), stripTags(), translateArray(), urlDecode(), urlEncode()
Constants summary
string COUPON_FORMAT_ALPHANUMERIC 'alphanum'
#

Constants which defines all possible coupon codes formats

Constants which defines all possible coupon codes formats

string COUPON_FORMAT_ALPHABETICAL 'alpha'
#
string COUPON_FORMAT_NUMERIC 'num'
#
integer COUPON_TYPE_SPECIFIC_AUTOGENERATED 1
#

Defines type of Coupon

Defines type of Coupon

string XML_PATH_SALES_RULE_COUPON_LENGTH 'promo/auto_generated_coupon_codes/length'
#

XML paths to coupon codes generation options

XML paths to coupon codes generation options

string XML_PATH_SALES_RULE_COUPON_FORMAT 'promo/auto_generated_coupon_codes/format'
#
string XML_PATH_SALES_RULE_COUPON_PREFIX 'promo/auto_generated_coupon_codes/prefix'
#
string XML_PATH_SALES_RULE_COUPON_SUFFIX 'promo/auto_generated_coupon_codes/suffix'
#
string XML_PATH_SALES_RULE_COUPON_DASH_INTERVAL 'promo/auto_generated_coupon_codes/dash'
#
string XML_CHARSET_NODE 'global/salesrule/coupon/charset/%s'
#

Config path for character set and separator

Config path for character set and separator

string XML_CHARSET_SEPARATOR 'global/salesrule/coupon/separator'
#
Properties inherited from Mage_Core_Helper_Abstract
$_layout, $_moduleName, $_request
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0