Mage_Payment_Helper_Data Class Reference

Inheritance diagram for Mage_Payment_Helper_Data:

List of all members.

Public Member Functions
	getMethodInstance ($code)
	getStoreMethods ($store=null, $quote=null)
	getMethodFormBlock (Mage_Payment_Model_Method_Abstract $method)
	getInfoBlock (Mage_Payment_Model_Info $info)
Public Attributes
const	XML_PATH_PAYMENT_METHODS = 'payment'
Protected Member Functions
	_sortMethods ($a, $b)

---

Detailed Description

Payment module base helper

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 32 of file Data.php.

---

Member Function Documentation

_sortMethods	(	$	a,
		$	b
	)			[protected]

Definition at line 108 of file Data.php.

    {
       // var_dump($a);
        if (is_object($a)) {
            //var_dump($a->getData());
            //var_dump($a->sort_order);
            //die ();

            return (int)$a->sort_order < (int)$b->sort_order ? -1 : ((int)$a->sort_order > (int)$b->sort_order ? 1 : 0);
        }
        return 0;
    }

getInfoBlock

(

Mage_Payment_Model_Info $

info

)

Retrieve payment information block

Parameters:

Mage_Payment_Model_Info

$info

Returns:

Mage_Core_Block_Template

Definition at line 144 of file Data.php.

    {
        $blockType = $info->getMethodInstance()->getInfoBlockType();
        if ($this->getLayout()) {
            $block = $this->getLayout()->createBlock($blockType);
        }
        else {
            $className = Mage::getConfig()->getBlockClassName($blockType);
            $block = new $className;
        }
        $block->setInfo($info);
        return $block;
    }

getMethodFormBlock

(

Mage_Payment_Model_Method_Abstract $

method

)

Retreive payment method form html

Parameters:

Mage_Payment_Model_Abstract

$method

Returns:

Mage_Payment_Block_Form

Definition at line 127 of file Data.php.

    {
        $block = false;
        $blockType = $method->getFormBlockType();
        if ($this->getLayout()) {
            $block = $this->getLayout()->createBlock($blockType);
            $block->setMethod($method);
        }
        return $block;
    }

getMethodInstance

(

$

code

)

Retrieve method model object

Parameters:

string

$code

Returns:

Mage_Payment_Model_Method_Abstract

Definition at line 42 of file Data.php.

    {
        $key = self::XML_PATH_PAYMENT_METHODS.'/'.$code.'/model';
        $class = Mage::getStoreConfig($key);
        if (!$class) {
            Mage::throwException($this->__('Can not configuration for payment method with code: %s', $code));
        }
        return Mage::getModel($class);
    }

getStoreMethods	(	$	store = null,
		$	quote = null
	)

Retrieve available payment methods for store

array structure: $index => Varien_Simplexml_Element

Parameters:

mixed

$store

Returns:

array

Definition at line 61 of file Data.php.

    {
        $methods = Mage::getStoreConfig(self::XML_PATH_PAYMENT_METHODS, $store);
        $res = array();
        foreach ($methods as $code => $methodConfig) {
            $prefix = self::XML_PATH_PAYMENT_METHODS.'/'.$code.'/';

            if (!Mage::getStoreConfigFlag($prefix.'active', $store)) {
                continue;
            }
            if (!$model = Mage::getStoreConfig($prefix.'model', $store)) {
                continue;
            }

            $methodInstance = Mage::getModel($model);

            if ($methodInstance instanceof Mage_Payment_Model_Method_Cc && !Mage::getStoreConfig($prefix.'cctypes')) {
                /* if the payment method has credit card types configuration option
                   and no credit card type is enabled in configuration */
                continue;
            }

            if ( !$methodInstance->isAvailable($quote) ) {
                /* if the payment method can not be used at this time */
                continue;
            }

            $sortOrder = (int)Mage::getStoreConfig($prefix.'sort_order', $store);
            $methodInstance->setSortOrder($sortOrder);
            $methodInstance->setStore($store);
//            while (isset($res[$sortOrder])) {
//                $sortOrder++;
//            }
//            $res[$sortOrder] = $methodInstance;
            $res[] = $methodInstance;
        }
//        ksort($res);
        //die('!');

        //echo '<pre>';
        //var_dump( (array)$res);
        usort($res, array($this, '_sortMethods'));
        //var_dump((array)$res);
      //  echo '</pre>';
        return $res;
    }

---

Member Data Documentation

const XML_PATH_PAYMENT_METHODS = 'payment'

Definition at line 34 of file Data.php.

---

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

• app/code/core/Mage/Payment/Helper/Data.php