Mage_CatalogSearch_Block_Advanced_Form Class Reference

Inheritance diagram for Mage_CatalogSearch_Block_Advanced_Form:

List of all members.

Public Member Functions
	_prepareLayout ()
	getSearchableAttributes ()
	getAttributeLabel ($attribute)
	getAttributeValidationClass ($attribute)
	getAttributeValue ($attribute, $part=null)
	getAvailableCurrencies ()
	getCurrencyCount ()
	getCurrency ($attribute)
	getAttributeInputType ($attribute)
	getAttributeSelectElement ($attribute)
	getAttributeYesNoElement ($attribute)
	getModel ()
	getSearchPostUrl ()
	getDateInput ($attribute, $part= 'from')
Protected Member Functions
	_getSelectBlock ()
	_getDateBlock ()

---

Detailed Description

Definition at line 34 of file Form.php.

---

Member Function Documentation

_getDateBlock

(

)

[protected]

Definition at line 234 of file Form.php.

    {
        $block = $this->getData('_date_block');
        if (is_null($block)) {
            $block = $this->getLayout()->createBlock('core/html_date');
            $this->setData('_date_block', $block);
        }
        return $block;
    }

_getSelectBlock

(

)

[protected]

Definition at line 224 of file Form.php.

    {
        $block = $this->getData('_select_block');
        if (is_null($block)) {
            $block = $this->getLayout()->createBlock('core/html_select');
            $this->setData('_select_block', $block);
        }
        return $block;
    }

_prepareLayout

(

)

Preparing global layout

You can redefine this method in child classes for changin layout

Returns:

Mage_Core_Block_Abstract

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 36 of file Form.php.

    {
        if ($headBlock = $this->getLayout()->getBlock('head')) {
            $headBlock->setTitle(Mage::helper('catalogsearch')->__('Catalog Advanced Search'));
        }

        // add Home breadcrumb
        if ($breadcrumbs = $this->getLayout()->getBlock('breadcrumbs')) {
            $breadcrumbs->addCrumb('home', array(
                'label'=>Mage::helper('catalogsearch')->__('Home'),
                'title'=>Mage::helper('catalogsearch')->__('Go to Home Page'),
                'link'=>Mage::getBaseUrl()
            ))->addCrumb('search', array(
                'label'=>Mage::helper('catalogsearch')->__('Catalog Advanced Search')
            ));
        }
        return parent::_prepareLayout();
    }

getAttributeInputType

(

$

attribute

)

Retrieve attribute input type

Parameters:

$attribute

Returns:

string

Definition at line 149 of file Form.php.

    {
        $dataType   = $attribute->getBackend()->getType();
        $imputType  = $attribute->getFrontend()->getInputType();
        if ($imputType == 'select' || $imputType == 'multiselect') {
            return 'select';
        }

        if ($imputType == 'boolean') {
            return 'yesno';
        }

        if ($imputType == 'price') {
            return 'price';
        }

        if ($dataType == 'int' || $dataType == 'decimal') {
            return 'number';
        }

        if ($dataType == 'datetime') {
            return 'date';
        }

        return 'string';
    }

getAttributeLabel

(

$

attribute

)

Retrieve attribute label

Parameters:

$attribute

Returns:

string

Definition at line 72 of file Form.php.

    {
        return Mage::helper('catalog')->__($attribute->getFrontend()->getLabel());
    }

getAttributeSelectElement

(

$

attribute

)

Definition at line 176 of file Form.php.

    {
        $extra = '';
        $options = $attribute->getSource()->getAllOptions(false);

        $name = $attribute->getAttributeCode();

        // 2 - avoid yes/no selects to be multiselects
        if (is_array($options) && count($options)>2) {
            $extra = 'multiple="multiple" size="4"';
            $name.= '[]';
        }
        else {
            array_unshift($options, array('value'=>'', 'label'=>Mage::helper('catalogsearch')->__('All')));
        }



        return $this->_getSelectBlock()
            ->setName($name)
            ->setId($attribute->getAttributeCode())
            ->setTitle($this->getAttributeLabel($attribute))
            ->setExtraParams($extra)
            ->setValue($this->getAttributeValue($attribute))
            ->setOptions($options)
            ->setClass('multiselect')
            ->getHtml();
    }

getAttributeValidationClass

(

$

attribute

)

Retrieve attribute input validation class

Parameters:

$attribute

Returns:

string

Definition at line 83 of file Form.php.

    {
        return $attribute->getFrontendClass();
    }

getAttributeValue	(	$	attribute,
		$	part = null
	)

Definition at line 88 of file Form.php.

    {
        $value = $this->getRequest()->getQuery($attribute->getAttributeCode());
        if ($part && $value) {
            if (isset($value[$part])) {
                $value = $value[$part];
            }
            else {
                $value = '';
            }
        }

        if (!is_array($value)) {
            $value = htmlspecialchars($value);
        }
        return $value;
    }

getAttributeYesNoElement

(

$

attribute

)

Definition at line 205 of file Form.php.

    {
        $options = array(
            array('value' => '',  'label' => Mage::helper('catalogsearch')->__('All')),
            array('value' => '1', 'label' => Mage::helper('catalogsearch')->__('Yes')),
            array('value' => '0', 'label' => Mage::helper('catalogsearch')->__('No'))
        );

        $name = $attribute->getAttributeCode();
        return $this->_getSelectBlock()
            ->setName($name)
            ->setId($attribute->getAttributeCode())
            ->setTitle($this->getAttributeLabel($attribute))
            ->setExtraParams("")
            ->setValue($this->getAttributeValue($attribute))
            ->setOptions($options)
            ->getHtml();
    }

getAvailableCurrencies

(

)

Definition at line 106 of file Form.php.

    {
        $currencies = $this->getData('_currencies');
        if (is_null($currencies)) {
            $currencies = array();
            $codes = Mage::app()->getStore()->getAvailableCurrencyCodes(true);
            if (is_array($codes) && count($codes)) {
                $rates = Mage::getModel('directory/currency')->getCurrencyRates(
                    Mage::app()->getStore()->getBaseCurrency(),
                    $codes
                );

                foreach ($codes as $code) {
                    if (isset($rates[$code])) {
                        $currencies[$code] = $code;
                    }
                }
            }

            $this->setData('currencies', $currencies);
        }
        return $currencies;
    }

getCurrency

(

$

attribute

)

Definition at line 135 of file Form.php.

    {
        return Mage::app()->getStore()->getCurrentCurrencyCode();

        $baseCurrency = Mage::app()->getStore()->getBaseCurrency()->getCurrencyCode();
        return $this->getAttributeValue($attribute, 'currency') ? $this->getAttributeValue($attribute, 'currency') : $baseCurrency;
    }

getCurrencyCount

(

)

Definition at line 130 of file Form.php.

    {
        return count($this->getAvailableCurrencies());
    }

getDateInput	(	$	attribute,
		$	part = 'from'
	)

Definition at line 258 of file Form.php.

    {
        $name = $attribute->getAttributeCode() . '[' . $part . ']';
        $value = $this->getAttributeValue($attribute, $part);

        return $this->_getDateBlock()
            ->setName($name)
            ->setId($attribute->getAttributeCode() . '_' . $part)
            ->setTitle($this->getAttributeLabel($attribute))
            ->setValue($value)
            ->setImage($this->getSkinUrl('images/calendar.gif'))
            ->setFormat('%m/%d/%y')
            ->setClass('input-text')
            ->getHtml();
    }

getModel

(

)

Retrieve advanced search model object

Returns:

Mage_CatalogSearch_Model_Advanced

Definition at line 248 of file Form.php.

    {
        return Mage::getSingleton('catalogsearch/advanced');
    }

getSearchableAttributes

(

)

Retrieve collection of product searchable attributes

Returns:

Varien_Data_Collection_Db

Definition at line 60 of file Form.php.

    {
        $attributes = $this->getModel()->getAttributes();
        return $attributes;
    }

getSearchPostUrl

(

)

Definition at line 253 of file Form.php.

    {
        return $this->getUrl('*/*/result');
    }

---

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

• app/code/core/Mage/CatalogSearch/Block/Advanced/Form.php