Mage_Api_Model_Config Class Reference

Inheritance diagram for Mage_Api_Model_Config:

List of all members.

Public Member Functions
	__construct ($sourceData=null)
	getAdapters ()
	getActiveAdapters ()
	getHandlers ()
	getResources ()
	getResourcesAlias ()
	loadAclResources (Mage_Api_Model_Acl $acl, $resource=null, $parentName=null)
	getAclAssert ($name='')
	getAclPrivilegeSet ($name='')
	getFaults ($resourceName=null)
	getCache ()
Public Attributes
const	CACHE_TAG = 'config_api'
Protected Member Functions
	_construct ()
	_loadCache ($id)
	_saveCache ($data, $id, $tags=array(), $lifetime=false)
	_removeCache ($id)

---

Detailed Description

Definition at line 34 of file Config.php.

---

Constructor & Destructor Documentation

__construct

(

$

sourceData = null

)

Constructor

See also:

Varien_Simplexml_Config

Reimplemented from Varien_Simplexml_Config.

Definition at line 43 of file Config.php.

    {
        $this->setCacheId('config_api');
        $this->setCacheTags(array(self::CACHE_TAG));

        parent::__construct($sourceData);
        $this->_construct();
    }

---

Member Function Documentation

_construct

(

)

[protected]

Init configuration for webservices api

Returns:

Mage_Api_Model_Config

Definition at line 57 of file Config.php.

    {
        if (Mage::app()->useCache('config_api')) {
            if ($this->loadCache()) {
                return $this;
            }
        }

        $config = Mage::getConfig()->loadModulesConfiguration('api.xml');
        $this->setXml($config->getNode('api'));

        if (Mage::app()->useCache('config_api')) {
            $this->saveCache();
        }
        return $this;
    }

_loadCache

(

$

id

)

[protected]

Enter description here...

Parameters:

string

$id

Returns:

boolean

Reimplemented from Varien_Simplexml_Config.

Definition at line 259 of file Config.php.

    {
        return Mage::app()->loadCache($id);
    }

_removeCache

(

$

id

)

[protected]

Enter description here...

Todo:

check this, as there are no caches that implement remove() method

Parameters:

string

$id

Returns:

unknown

Reimplemented from Varien_Simplexml_Config.

Definition at line 269 of file Config.php.

    {
        return Mage::app()->removeCache($id);
    }

_saveCache	(	$	data,
		$	id,
		$	tags = array(),
		$	lifetime = false
	)			[protected]

Enter description here...

Parameters:

	string	$data
	string	$id
	array	$tags
	int|boolean	$lifetime

Returns:

boolean

Reimplemented from Varien_Simplexml_Config.

Definition at line 264 of file Config.php.

    {
        return Mage::app()->saveCache($data, $id, $tags, $lifetime);
    }

getAclAssert

(

$

name = ''

)

Get acl assert config

Parameters:

string

$name

Returns:

Mage_Core_Model_Config_Element|boolean

Definition at line 188 of file Config.php.

    {
        $asserts = $this->getNode('acl/asserts');
        if (''===$name) {
            return $asserts;
        }

        if (isset($asserts->$name)) {
            return $asserts->$name;
        }

        return false;
    }

getAclPrivilegeSet

(

$

name = ''

)

Retrieve privilege set by name

Parameters:

string

$name

Returns:

Mage_Core_Model_Config_Element|boolean

Definition at line 208 of file Config.php.

    {
        $sets = $this->getNode('acl/privilegeSets');
        if (''===$name) {
            return $sets;
        }

        if (isset($sets->$name)) {
            return $sets->$name;
        }

        return false;
    }

getActiveAdapters

(

)

Retrieve active adapters

Returns:

array

Definition at line 97 of file Config.php.

    {
        $adapters = array();
        foreach ($this->getAdapters() as $adapterName => $adapter) {
            if (!isset($adapter->active) || $adapter->active == '0') {
                continue;
            }

            if (isset($adapter->required) && isset($adapter->required->extensions)) {
                foreach ($adapter->required->extensions->children() as $extension=>$data) {
                    if (!extension_loaded($extension)) {
                        continue;
                    }
                }
            }

            $adapters[$adapterName] = $adapter;
        }

        return $adapters;
    }

getAdapters

(

)

Retrieve all adapters

Returns:

array

Definition at line 79 of file Config.php.

    {
        $adapters = array();
        foreach ($this->getNode('adapters')->children() as $adapterName => $adapter) {
            /* @var $adapter Varien_SimpleXml_Element */
            if (isset($adapter->use)) {
                $adapter = $this->getNode('adapters/' . (string) $adapter->use);
            }
            $adapters[$adapterName] = $adapter;
        }
        return $adapters;
    }

getCache

(

)

Retrieve cache object

Returns:

Zend_Cache_Frontend_File

Reimplemented from Varien_Simplexml_Config.

Definition at line 254 of file Config.php.

    {
        return Mage::app()->getCache();
    }

getFaults

(

$

resourceName = null

)

Definition at line 222 of file Config.php.

    {
        if (is_null($resourceName)
            || !isset($this->getResources()->$resourceName)
            || !isset($this->getResources()->$resourceName->faults)) {
            $faultsNode = $this->getNode('faults');
        } else {
            $faultsNode = $this->getResources()->$resourceName->faults;
        }
        /* @var $faultsNode Varien_Simplexml_Element */

        $translateModule = 'api';
        if (isset($faultsNode['module'])) {
           $translateModule = (string) $faultsNode['module'];
        }

        $faults = array();
        foreach ($faultsNode->children() as $faultName => $fault) {
            $faults[$faultName] = array(
                'code'    => (string) $fault->code,
                'message' => Mage::helper($translateModule)->__((string)$fault->message)
            );
        }

        return $faults;
    }

getHandlers

(

)

Retrieve handlers

Returns:

Varien_Simplexml_Element

Definition at line 124 of file Config.php.

    {
        return $this->getNode('handlers')->children();
    }

getResources

(

)

Retrieve resources

Returns:

Varien_Simplexml_Element

Definition at line 134 of file Config.php.

    {
        return $this->getNode('resources')->children();
    }

getResourcesAlias

(

)

Retrieve resources alias

Returns:

Varien_Simplexml_Element

Definition at line 144 of file Config.php.

    {
        return $this->getNode('resources_alias')->children();
    }

loadAclResources	(	Mage_Api_Model_Acl $	acl,
		$	resource = null,
		$	parentName = null
	)

Load Acl resources from config

Parameters:

	Mage_Api_Model_Acl	$acl
	Mage_Core_Model_Config_Element	$resource
	string	$parentName

Returns:

Mage_Api_Model_Config

Definition at line 158 of file Config.php.

    {
        $resourceName = null;
        if (is_null($resource)) {
            $resource = $this->getNode('acl/resources');
        } else {
            $resourceName = (is_null($parentName) ? '' : $parentName.'/').$resource->getName();
            $acl->add(Mage::getModel('api/acl_resource', $resourceName), $parentName);
        }

        $children = $resource->children();

        if (empty($children)) {
            return $this;
        }

        foreach ($children as $res) {
            if ($res->getName() != 'title' && $res->getName() != 'sort_order') {
                $this->loadAclResources($acl, $res, $resourceName);
            }
        }
        return $this;
    }

---

Member Data Documentation

const CACHE_TAG = 'config_api'

Definition at line 36 of file Config.php.

---

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

• app/code/core/Mage/Api/Model/Config.php