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_Api2_Adminhtml_Api2_AttributeController
  • Mage_Api2_Adminhtml_Api2_RoleController
  • Mage_Api2_Block_Adminhtml_Attribute
  • Mage_Api2_Block_Adminhtml_Attribute_Buttons
  • Mage_Api2_Block_Adminhtml_Attribute_Edit
  • Mage_Api2_Block_Adminhtml_Attribute_Edit_Form
  • Mage_Api2_Block_Adminhtml_Attribute_Grid
  • Mage_Api2_Block_Adminhtml_Attribute_Tab_Resource
  • Mage_Api2_Block_Adminhtml_Attribute_Tabs
  • Mage_Api2_Block_Adminhtml_Permissions_User_Edit_Tab_Roles
  • Mage_Api2_Block_Adminhtml_Roles
  • Mage_Api2_Block_Adminhtml_Roles_Buttons
  • Mage_Api2_Block_Adminhtml_Roles_Grid
  • Mage_Api2_Block_Adminhtml_Roles_Tab_Info
  • Mage_Api2_Block_Adminhtml_Roles_Tab_Resources
  • Mage_Api2_Block_Adminhtml_Roles_Tab_Users
  • Mage_Api2_Block_Adminhtml_Roles_Tabs
  • Mage_Api2_Helper_Data
  • Mage_Api2_Model_Acl
  • Mage_Api2_Model_Acl_Filter
  • Mage_Api2_Model_Acl_Filter_Attribute
  • Mage_Api2_Model_Acl_Filter_Attribute_Operation
  • Mage_Api2_Model_Acl_Filter_Attribute_ResourcePermission
  • Mage_Api2_Model_Acl_Global
  • Mage_Api2_Model_Acl_Global_Role
  • Mage_Api2_Model_Acl_Global_Rule
  • Mage_Api2_Model_Acl_Global_Rule_Permission
  • Mage_Api2_Model_Acl_Global_Rule_Privilege
  • Mage_Api2_Model_Acl_Global_Rule_ResourcePermission
  • Mage_Api2_Model_Acl_Global_Rule_Tree
  • Mage_Api2_Model_Auth
  • Mage_Api2_Model_Auth_Adapter
  • Mage_Api2_Model_Auth_Adapter_Abstract
  • Mage_Api2_Model_Auth_Adapter_Oauth
  • Mage_Api2_Model_Auth_User
  • Mage_Api2_Model_Auth_User_Abstract
  • Mage_Api2_Model_Auth_User_Admin
  • Mage_Api2_Model_Auth_User_Customer
  • Mage_Api2_Model_Auth_User_Guest
  • Mage_Api2_Model_Config
  • Mage_Api2_Model_Dispatcher
  • Mage_Api2_Model_Multicall
  • Mage_Api2_Model_Observer
  • Mage_Api2_Model_Renderer
  • Mage_Api2_Model_Renderer_Json
  • Mage_Api2_Model_Renderer_Query
  • Mage_Api2_Model_Renderer_Xml
  • Mage_Api2_Model_Renderer_Xml_Writer
  • Mage_Api2_Model_Request
  • Mage_Api2_Model_Request_Internal
  • Mage_Api2_Model_Request_Interpreter
  • Mage_Api2_Model_Request_Interpreter_Json
  • Mage_Api2_Model_Request_Interpreter_Query
  • Mage_Api2_Model_Request_Interpreter_Xml
  • Mage_Api2_Model_Resource
  • Mage_Api2_Model_Resource_Acl_Filter_Attribute
  • Mage_Api2_Model_Resource_Acl_Filter_Attribute_Collection
  • Mage_Api2_Model_Resource_Acl_Global_Role
  • Mage_Api2_Model_Resource_Acl_Global_Role_Collection
  • Mage_Api2_Model_Resource_Acl_Global_Rule
  • Mage_Api2_Model_Resource_Acl_Global_Rule_Collection
  • Mage_Api2_Model_Resource_Setup
  • Mage_Api2_Model_Resource_Validator
  • Mage_Api2_Model_Resource_Validator_Eav
  • Mage_Api2_Model_Resource_Validator_Fields
  • Mage_Api2_Model_Response
  • Mage_Api2_Model_Route_Abstract
  • Mage_Api2_Model_Route_ApiType
  • Mage_Api2_Model_Route_Rest
  • Mage_Api2_Model_Router
  • Mage_Api2_Model_Server

Interfaces

  • Mage_Api2_Model_Acl_PermissionInterface
  • Mage_Api2_Model_Renderer_Interface
  • Mage_Api2_Model_Request_Interpreter_Interface
  • Mage_Api2_Model_Route_Interface

Exceptions

  • Mage_Api2_Exception
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Api2_Model_Acl_Global_Rule_Tree

API2 acl global rule tree

Mage_Core_Helper_Abstract
Extended by Mage_Api2_Model_Acl_Global_Rule_Tree
Package: Mage\Api2
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/Api2/Model/Acl/Global/Rule/Tree.php
Methods summary
public
# __construct( array $options )

Constructor

Constructor

In the constructor should be set tree type: attributes or privileges. Attributes for tree with resources, operations and attributes. Privileges for tree with resources and privileges.

Parameters

$options
array
$options
protected Mage_Api2_Model_Acl_Global_Rule_Tree
# _init( )

Initialize block

Initialize block

Returns

Mage_Api2_Model_Acl_Global_Rule_Tree

Throws

Exception
public array
# getPostResources( )

Convert to array serialized post data from tree grid

Convert to array serialized post data from tree grid

Returns

array
public boolean
# getEverythingAllowed( )

Check if everything is allowed

Check if everything is allowed

Returns

boolean
public array
# getTreeResources( )

Get tree resources

Get tree resources

Returns

array
protected array
# _getTreeNode( Varien_Simplexml_Element|array $node, integer $level = 0 )

Get tree node

Get tree node

Parameters

$node
Varien_Simplexml_Element|array
$node
$level
integer
$level

Returns

array
protected boolean
# _addPrivileges( array & $item, Varien_Simplexml_Element $node, string $name )

Add privileges

Add privileges

Parameters

$item
array
$item Tree node
$node
Varien_Simplexml_Element
$node XML node
$name
string
$name Resource name

Returns

boolean
protected boolean
# _addOperations( array & $item, Varien_Simplexml_Element $node, string $name )

Add operation

Add operation

Parameters

$item
array
$item Tree node
$node
Varien_Simplexml_Element
$node XML node
$name
string
$name Resource name

Returns

boolean
protected boolean
# _addAttribute( array & $item, Varien_Simplexml_Element $node, string $name, string $privilege )

Add privileges

Add privileges

Parameters

$item
array
$item Tree node
$node
Varien_Simplexml_Element
$node XML node
$name
string
$name Node name
$privilege
string
$privilege Privilege name

Returns

boolean
protected integer
# _sortTree( array $a, array $b )

Compare two nodes of the Resource Tree

Compare two nodes of the Resource Tree

Parameters

$a
array
$a
$b
array
$b

Returns

integer
public Mage_Api2_Model_Acl_Global_Rule_Tree
# setRole( Mage_Api2_Model_Acl_Global_Role $role )

Set role

Set role

Parameters

$role
Mage_Api2_Model_Acl_Global_Role
$role

Returns

Mage_Api2_Model_Acl_Global_Rule_Tree
public Mage_Api2_Model_Acl_Global_Role
# getRole( )

Get role

Get role

Returns

Mage_Api2_Model_Acl_Global_Role
public Mage_Api2_Model_Acl_Global_Rule_Tree
# setResourcesPermissions( array $resourcesPermissions )

Set resources permissions

Set resources permissions

Parameters

$resourcesPermissions
array
$resourcesPermissions

Returns

Mage_Api2_Model_Acl_Global_Rule_Tree
public array
# getResourcesPermissions( )

Get resources permissions

Get resources permissions

Returns

array
public Mage_Api2_Model_Acl_Global_Rule_Tree
# setHasEntityOnlyAttributes( boolean $hasEntityOnlyAttributes )

Set has entity only attributes flag

Set has entity only attributes flag

Parameters

$hasEntityOnlyAttributes
boolean
$hasEntityOnlyAttributes

Returns

Mage_Api2_Model_Acl_Global_Rule_Tree
public boolean
# getHasEntityOnlyAttributes( )

Get has entity only attributes flag

Get has entity only attributes flag

Returns

boolean
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 TYPE_ATTRIBUTE 'attribute'
#

Tree types

Tree types

string TYPE_PRIVILEGE 'privilege'
#
string NAME_CHILDREN 'children'
#

Names

Names

string NAME_PRIVILEGE 'privilege'
#
string NAME_OPERATION 'operation'
#
string NAME_ATTRIBUTE 'attribute'
#
string NAME_RESOURCE 'resource'
#
string NAME_RESOURCE_GROUPS 'resource_groups'
#
string NAME_GROUP 'group'
#
string ID_SEPARATOR '-'
#

Separator for tree ID

Separator for tree ID

Properties summary
protected Mage_Api2_Model_Acl_Global_Role $_role
#

Role

Role

protected array $_resourcesPermissions
#

Resources permissions

Resources permissions

protected Varien_Simplexml_Element $_resourcesConfig
#

Resources from config model

Resources from config model

protected array $_existPrivileges
#

Exist privileges

Exist privileges

protected array $_existOperations
#

Exist operations

Exist operations

protected string $_type
#

Tree type

Tree type

protected boolean $_initialized false
#

Initialized

Initialized

protected boolean $_hasEntityOnlyAttributes false
#

Flag if resource has entity only attributes

Flag if resource has entity only attributes

Properties inherited from Mage_Core_Helper_Abstract
$_layout, $_moduleName, $_request
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0