Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Options_Option Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Options_Option:

List of all members.

Public Member Functions
	__construct ()
	getItemCount ()
	setItemCount ($itemCount)
	getProduct ()
	setProduct ($product)
	getFieldName ()
	getFieldId ()
	isReadonly ()
	getAddButtonId ()
	getDeleteButtonHtml ()
	getTypeSelectHtml ()
	getRequireSelectHtml ()
	getTemplatesHtml ()
	getOptionValues ()
	getCheckboxScopeHtml ($id, $name, $checked=true, $select_id='-1')
	getPriceValue ($value, $type)
Protected Member Functions
	_prepareLayout ()
Protected Attributes
	$_product
	$_productInstance
	$_name = 'product[options]'
	$_id = 'product_option'
	$_values
	$_itemCount = 1

---

Detailed Description

Definition at line 35 of file Option.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.

Definition at line 48 of file Option.php.

    {
        parent::__construct();
        $this->setTemplate('catalog/product/edit/options/option.phtml');
    }

---

Member Function Documentation

_prepareLayout

(

)

[protected]

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 109 of file Option.php.

    {
        $this->setChild('delete_button',
            $this->getLayout()->createBlock('adminhtml/widget_button')
                ->setData(array(
                    'label' => Mage::helper('catalog')->__('Delete Option'),
                    'class' => 'delete delete-product-option '
                ))
        );

        $path = 'global/catalog/product/options/custom/groups';

        foreach (Mage::getConfig()->getNode($path)->children() as $group) {
            $this->setChild($group->getName() . '_option_type',
                $this->getLayout()->createBlock(
                    (string) Mage::getConfig()->getNode($path . '/' . $group->getName() . '/render')
                )
            );
        }

        return parent::_prepareLayout();
    }

getAddButtonId

(

)

Definition at line 132 of file Option.php.

    {
        $buttonId = $this->getLayout()
                ->getBlock('admin.product.options')
                ->getChild('add_button')->getId();
        return $buttonId;
    }

getCheckboxScopeHtml	(	$	id,
		$	name,
		$	checked = true,
		$	select_id = '-1'
	)

Definition at line 259 of file Option.php.

    {
        $checkedHtml = '';
        if ($checked) {
            $checkedHtml = ' checked="checked"';
        }
        $selectNameHtml = '';
        $selectIdHtml = '';
        if ($select_id != '-1') {
            $selectNameHtml = '[values]['.$select_id.']';
            $selectIdHtml = 'select_'.$select_id.'_';
        }
        $checkbox = '<input type="checkbox" id="'.$this->getFieldId().'_'.$id.'_'.$selectIdHtml.$name.'_use_default" class="product-option-scope-checkbox" name="'.$this->getFieldName().'['.$id.']'.$selectNameHtml.'[scope]['.$name.']" value="1" '.$checkedHtml.'/>';
        $checkbox .= '<label class="normal" for="'.$this->getFieldId().'_'.$id.'_'.$selectIdHtml.$name.'_use_default">Use Default Value</label>';
        return $checkbox;
    }

getDeleteButtonHtml

(

)

Definition at line 140 of file Option.php.

    {
        return $this->getChildHtml('delete_button');
    }

getFieldId

(

)

Definition at line 94 of file Option.php.

    {
        return $this->_id;
    }

getFieldName

(

)

Definition at line 89 of file Option.php.

    {
        return $this->_name;
    }

getItemCount

(

)

Definition at line 54 of file Option.php.

    {
        return $this->_itemCount;
    }

getOptionValues

(

)

Definition at line 181 of file Option.php.

    {
        $optionsArr = array_reverse($this->getProduct()->getOptions(), true);
//        $optionsArr = $this->getProduct()->getOptions();

        if (!$this->_values) {
            $values = array();
            $scope = (int) Mage::app()->getStore()->getConfig(Mage_Core_Model_Store::XML_PATH_PRICE_SCOPE);
            foreach ($optionsArr as $option) {
                /* @var $option Mage_Catalog_Model_Product_Option */

                $this->setItemCount($option->getOptionId());

                $value = array();

                $value['id'] = $option->getOptionId();
                $value['item_count'] = $this->getItemCount();
                $value['option_id'] = $option->getOptionId();
                $value['title'] = $this->htmlEscape($option->getTitle());
                $value['type'] = $option->getType();
                $value['is_require'] = $option->getIsRequire();
                $value['sort_order'] = $option->getSortOrder();

                if ($this->getProduct()->getStoreId() != '0') {
                    $value['checkboxScopeTitle'] = $this->getCheckboxScopeHtml($option->getOptionId(), 'title', is_null($option->getStoreTitle()));
                    $value['scopeTitleDisabled'] = is_null($option->getStoreTitle())?'disabled':null;
                }

                if ($option->getGroupByType() == Mage_Catalog_Model_Product_Option::OPTION_GROUP_SELECT) {

//                    $valuesArr = array_reverse($option->getValues(), true);

                    $i = 0;
                    $itemCount = 0;
                    foreach ($option->getValues() as $_value) {
                        /* @var $_value Mage_Catalog_Model_Product_Option_Value */
                        $value['optionValues'][$i] = array(
                            'item_count' => max($itemCount, $_value->getOptionTypeId()),
                            'option_id' => $_value->getOptionId(),
                            'option_type_id' => $_value->getOptionTypeId(),
                            'title' => $this->htmlEscape($_value->getTitle()),
                            'price' => $this->getPriceValue($_value->getPrice(), $_value->getPriceType()),
                            'price_type' => $_value->getPriceType(),
                            'sku' => $this->htmlEscape($_value->getSku()),
                            'sort_order' => $_value->getSortOrder(),
                        );

                        if ($this->getProduct()->getStoreId() != '0') {
                            $value['optionValues'][$i]['checkboxScopeTitle'] = $this->getCheckboxScopeHtml($_value->getOptionId(), 'title', is_null($_value->getStoreTitle()), $_value->getOptionTypeId());
                            $value['optionValues'][$i]['scopeTitleDisabled'] = is_null($_value->getStoreTitle())?'disabled':null;
                            if ($scope == Mage_Core_Model_Store::PRICE_SCOPE_WEBSITE) {
                                $value['optionValues'][$i]['checkboxScopePrice'] = $this->getCheckboxScopeHtml($_value->getOptionId(), 'price', is_null($_value->getstorePrice()), $_value->getOptionTypeId());
                                $value['optionValues'][$i]['scopePriceDisabled'] = is_null($_value->getStorePrice())?'disabled':null;
                            }
                        }
                        $i++;
                    }
                } else {
                    $value['price'] = $this->getPriceValue($option->getPrice(), $option->getPriceType());
                    $value['price_type'] = $option->getPriceType();
                    $value['sku'] = $this->htmlEscape($option->getSku());
                    $value['max_characters'] = $option->getMaxCharacters();
                    $value['file_extension'] = $option->getFileExtension();
                    $value['image_size_x'] = $option->getImageSizeX();
                    $value['image_size_y'] = $option->getImageSizeY();
                    if ($this->getProduct()->getStoreId() != '0' && $scope == Mage_Core_Model_Store::PRICE_SCOPE_WEBSITE) {
                        $value['checkboxScopePrice'] = $this->getCheckboxScopeHtml($option->getOptionId(), 'price', is_null($option->getStorePrice()));
                        $value['scopePriceDisabled'] = is_null($option->getStorePrice())?'disabled':null;
                    }
                }
                $values[] = new Varien_Object($value);
            }
            $this->_values = $values;
        }

        return $this->_values;
    }

getPriceValue	(	$	value,
		$	type
	)

Definition at line 276 of file Option.php.

    {
        if ($type == 'percent') {
            return number_format($value, 2, null, '');
        } elseif ($type == 'fixed') {
            return number_format($value, 2, null, '');
        }
    }

getProduct

(

)

Get Product

Returns:

Mage_Catalog_Model_Product

Definition at line 70 of file Option.php.

    {
        if (!$this->_productInstance) {
            if ($product = Mage::registry('product')) {
                $this->_productInstance = $product;
            } else {
                $this->_productInstance = Mage::getSingleton('catalog/product');
            }
        }

        return $this->_productInstance;
    }

getRequireSelectHtml

(

)

Definition at line 158 of file Option.php.

    {
        $select = $this->getLayout()->createBlock('adminhtml/html_select')
            ->setData(array(
                'id' => $this->getFieldId().'_{{id}}_is_require',
                'class' => 'select'
            ))
            ->setName($this->getFieldName().'[{{id}}][is_require]')
            ->setOptions(Mage::getSingleton('adminhtml/system_config_source_yesno')->toOptionArray());

        return $select->getHtml();
    }

getTemplatesHtml

(

)

Definition at line 171 of file Option.php.

    {
        $templates = $this->getChildHtml('text_option_type') . "\n" .
            $this->getChildHtml('file_option_type') . "\n" .
            $this->getChildHtml('select_option_type') . "\n" .
            $this->getChildHtml('date_option_type');

        return $templates;
    }

getTypeSelectHtml

(

)

Definition at line 145 of file Option.php.

    {
        $select = $this->getLayout()->createBlock('adminhtml/html_select')
            ->setData(array(
                'id' => $this->getFieldId().'_{{id}}_type',
                'class' => 'select select-product-option-type required-option-select'
            ))
            ->setName($this->getFieldName().'[{{id}}][type]')
            ->setOptions(Mage::getSingleton('adminhtml/system_config_source_product_options_type')->toOptionArray());

        return $select->getHtml();
    }

isReadonly

(

)

Check block is readonly

Returns:

boolean

Definition at line 104 of file Option.php.

    {
         return $this->getProduct()->getOptionsReadonly();
    }

setItemCount

(

$

itemCount

)

Definition at line 59 of file Option.php.

    {
        $this->_itemCount = max($this->_itemCount, $itemCount);
        return $this;
    }

setProduct

(

$

product

)

Definition at line 83 of file Option.php.

    {
        $this->_productInstance = $product;
        return $this;
    }

---

Member Data Documentation

$_id = 'product_option' [protected]

Definition at line 42 of file Option.php.

$_itemCount = 1 [protected]

Definition at line 46 of file Option.php.

$_name = 'product[options]' [protected]

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 41 of file Option.php.

$_product [protected]

Definition at line 37 of file Option.php.

$_productInstance [protected]

Definition at line 39 of file Option.php.

$_values [protected]

Definition at line 44 of file Option.php.

---

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

• app/code/core/Mage/Adminhtml/Block/Catalog/Product/Edit/Tab/Options/Option.php