Mage_Adminhtml_Block_Store_Switcher Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Store_Switcher:

List of all members.

Public Member Functions
	__construct ()
	getWebsiteCollection ()
	getWebsites ()
	getGroupCollection ($website)
	getStoreGroups ($website)
	getStoreCollection ($group)
	getStores ($group)
	getSwitchUrl ()
	getStoreId ()
	setStoreIds ($storeIds)
	getStoreIds ()
	isShow ()
	hasDefaultOption ($hasDefaultOption=null)
Protected Member Functions
	_toHtml ()
Protected Attributes
	$_storeIds
	$_hasDefaultOption = true

---

Detailed Description

Definition at line 34 of file Switcher.php.

---

Constructor & Destructor Documentation

__construct

(

)

Constructor

By default is looking for first argument as array and assignes it as object attributes This behaviour may change in child classes

Reimplemented from Varien_Object.

Reimplemented in Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Websites, Mage_Adminhtml_Block_Sales_Order_Create_Store_Select, and Mage_GoogleBase_Block_Adminhtml_Store_Switcher.

Definition at line 46 of file Switcher.php.

    {
        parent::__construct();
        $this->setTemplate('store/switcher.phtml');
        $this->setUseConfirm(true);
        $this->setUseAjax(true);
        $this->setDefaultStoreName($this->__('All Store Views'));
    }

---

Member Function Documentation

_toHtml

(

)

[protected]

Render block HTML

Returns:

string

Reimplemented from Mage_Core_Block_Template.

Definition at line 180 of file Switcher.php.

    {
        if (!Mage::app()->isSingleStoreMode()) {
            return parent::_toHtml();
        }
        return '';
    }

getGroupCollection

(

$

website

)

Deprecated

Definition at line 91 of file Switcher.php.

    {
        if (!$website instanceof Mage_Core_Model_Website) {
            $website = Mage::getModel('core/website')->load($website);
        }
        return $website->getGroupCollection();
    }

getStoreCollection

(

$

group

)

Deprecated

Definition at line 116 of file Switcher.php.

    {
        if (!$group instanceof Mage_Core_Model_Store_Group) {
            $group = Mage::getModel('core/store_group')->load($group);
        }
        $stores = $group->getStoreCollection();
        $_storeIds = $this->getStoreIds();
        if (!empty($_storeIds)) {
            $stores->addIdFilter($_storeIds);
        }
        return $stores;
    }

getStoreGroups

(

$

website

)

Get store groups for specified website

Parameters:

Mage_Core_Model_Website

$website

Returns:

array

Definition at line 105 of file Switcher.php.

    {
        if (!$website instanceof Mage_Core_Model_Website) {
            $website = Mage::app()->getWebsite($website);
        }
        return $website->getGroups();
    }

getStoreId

(

)

Reimplemented in Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Websites.

Definition at line 159 of file Switcher.php.

    {
        return $this->getRequest()->getParam('store');
    }

getStoreIds

(

)

Definition at line 170 of file Switcher.php.

    {
        return $this->_storeIds;
    }

getStores

(

$

group

)

Get store views for specified store group

Parameters:

Mage_Core_Model_Store_Group

$group

Returns:

array

Definition at line 135 of file Switcher.php.

    {
        if (!$group instanceof Mage_Core_Model_Store_Group) {
            $group = Mage::app()->getGroup($group);
        }
        $stores = $group->getStores();
        if ($storeIds = $this->getStoreIds()) {
            foreach ($stores as $storeId => $store) {
                if (!in_array($storeId, $storeIds)) {
                    unset($stores[$storeId]);
                }
            }
        }
        return $stores;
    }

getSwitchUrl

(

)

Definition at line 151 of file Switcher.php.

    {
        if ($url = $this->getData('switch_url')) {
            return $url;
        }
        return $this->getUrl('*/*/*', array('_current' => true, 'store' => null));
    }

getWebsiteCollection

(

)

Deprecated

Definition at line 58 of file Switcher.php.

    {
        $collection = Mage::getModel('core/website')->getResourceCollection();

        $websiteIds = $this->getWebsiteIds();
        if (!is_null($websiteIds)) {
            $collection->addIdFilter($this->getWebsiteIds());
        }

        return $collection->load();
    }

getWebsites

(

)

Get websites

Returns:

array

Reimplemented in Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Websites.

Definition at line 75 of file Switcher.php.

    {
        $websites = Mage::app()->getWebsites();
        if ($websiteIds = $this->getWebsiteIds()) {
            foreach ($websites as $websiteId => $website) {
                if (!in_array($websiteId, $websiteIds)) {
                    unset($websites[$websiteId]);
                }
            }
        }
        return $websites;
    }

hasDefaultOption

(

$

hasDefaultOption = null

)

Set/Get whether the switcher should show default option

Parameters:

bool

$hasDefaultOption

Returns:

bool

Definition at line 194 of file Switcher.php.

    {
        if (null !== $hasDefaultOption) {
            $this->_hasDefaultOption = $hasDefaultOption;
        }
        return $this->_hasDefaultOption;
    }

isShow

(

)

Definition at line 175 of file Switcher.php.

    {
        return !Mage::app()->isSingleStoreMode();
    }

setStoreIds

(

$

storeIds

)

Definition at line 164 of file Switcher.php.

    {
        $this->_storeIds = $storeIds;
        return $this;
    }

---

Member Data Documentation

$_hasDefaultOption = true [protected]

Reimplemented in Mage_GoogleBase_Block_Adminhtml_Store_Switcher.

Definition at line 44 of file Switcher.php.

$_storeIds [protected]

Definition at line 39 of file Switcher.php.

---

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

• app/code/core/Mage/Adminhtml/Block/Store/Switcher.php