Mage_Rule_Model_Condition_Abstract Class Reference

Inheritance diagram for Mage_Rule_Model_Condition_Abstract:

List of all members.

Public Member Functions
	__construct ()
	getForm ()
	asArray (array $arrAttributes=array())
	asXml ()
	loadArray ($arr)
	loadXml ($xml)
	loadAttributeOptions ()
	getAttributeOptions ()
	getAttributeSelectOptions ()
	getAttributeName ()
	loadOperatorOptions ()
	getInputType ()
	getOperatorSelectOptions ()
	getOperatorName ()
	loadValueOptions ()
	getValueSelectOptions ()
	getValueParsed ()
	getValue ()
	getValueName ()
	getNewChildSelectOptions ()
	getNewChildName ()
	asHtml ()
	asHtmlRecursive ()
	getTypeElement ()
	getTypeElementHtml ()
	getAttributeElement ()
	getAttributeElementHtml ()
	getOperatorElement ()
	getOperatorElementHtml ()
	getValueElementType ()
	getValueElementRenderer ()
	getValueElement ()
	getValueElementHtml ()
	getAddLinkHtml ()
	getRemoveLinkHtml ()
	getChooserContainerHtml ()
	asString ($format='')
	asStringRecursive ($level=0)
	validateAttribute ($validatedValue)
	validate (Varien_Object $object)

---

Detailed Description

Abstract class for quote rule condition

Definition at line 32 of file Abstract.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_CatalogRule_Model_Rule_Condition_Combine, Mage_Rule_Model_Condition_Combine, Mage_SalesRule_Model_Rule_Condition_Combine, Mage_SalesRule_Model_Rule_Condition_Product_Combine, Mage_SalesRule_Model_Rule_Condition_Product_Found, and Mage_SalesRule_Model_Rule_Condition_Product_Subselect.

Definition at line 36 of file Abstract.php.

    {
        parent::__construct();

        $this->loadAttributeOptions()->loadOperatorOptions()->loadValueOptions();

        if ($options = $this->getAttributeOptions()) {
            foreach ($options as $attr=>$dummy) { $this->setAttribute($attr); break; }
        }
        if ($options = $this->getOperatorOptions()) {
            foreach ($options as $operator=>$dummy) { $this->setOperator($operator); break; }
        }
    }

---

Member Function Documentation

asArray

(

array $

arrAttributes = array()

)

Reimplemented in Mage_Rule_Model_Condition_Combine.

Definition at line 55 of file Abstract.php.

    {
        $out = array(
            'type'=>$this->getType(),
            'attribute'=>$this->getAttribute(),
            'operator'=>$this->getOperator(),
            'value'=>$this->getValue(),
            'is_value_processed'=>$this->getIsValueParsed(),
        );
        return $out;
    }

asHtml

(

)

Reimplemented in Mage_Rule_Model_Condition_Combine, Mage_SalesRule_Model_Rule_Condition_Product_Found, and Mage_SalesRule_Model_Rule_Condition_Product_Subselect.

Definition at line 269 of file Abstract.php.

    {
        $html = $this->getTypeElementHtml()
           .$this->getAttributeElementHtml()
           .$this->getOperatorElementHtml()
           .$this->getValueElementHtml()
           .$this->getRemoveLinkHtml()
           .$this->getChooserContainerHtml();
        return $html;
    }

asHtmlRecursive

(

)

Reimplemented in Mage_Rule_Model_Condition_Combine.

Definition at line 280 of file Abstract.php.

    {
        $html = $this->asHtml();
        return $html;
    }

asString

(

$

format = ''

)

Reimplemented in Mage_Rule_Model_Condition_Combine.

Definition at line 412 of file Abstract.php.

    {
        $str = $this->getAttributeName().' '.$this->getOperatorName().' '.$this->getValueName();
        return $str;
    }

asStringRecursive

(

$

level = 0

)

Reimplemented in Mage_Rule_Model_Condition_Combine.

Definition at line 418 of file Abstract.php.

    {
        $str = str_pad('', $level*3, ' ', STR_PAD_LEFT).$this->asString();
        return $str;
    }

asXml

(

)

Definition at line 67 of file Abstract.php.

    {
        $xml = "<type>".$this->getType()."</type>"
            ."<attribute>".$this->getAttribute()."</attribute>"
            ."<operator>".$this->getOperator()."</operator>"
            ."<value>".$this->getValue()."</value>";
        return $xml;
    }

getAddLinkHtml

(

)

Definition at line 388 of file Abstract.php.

    {
        $src = Mage::getDesign()->getSkinUrl('images/rule_component_add.gif');
        $html = '<img src="'.$src.'" class="rule-param-add v-middle" alt="" title="'.Mage::helper('rule')->__('Add').'"/>';
        return $html;
    }

getAttributeElement

(

)

Reimplemented in Mage_CatalogRule_Model_Rule_Condition_Product, and Mage_SalesRule_Model_Rule_Condition_Address.

Definition at line 301 of file Abstract.php.

    {
        if (is_null($this->getAttribute())) {
            foreach ($this->getAttributeOption() as $k=>$v) {
                $this->setAttribute($k);
                break;
            }
        }
        return $this->getForm()->addField($this->getPrefix().'__'.$this->getId().'__attribute', 'select', array(
            'name'=>'rule['.$this->getPrefix().']['.$this->getId().'][attribute]',
            'values'=>$this->getAttributeSelectOptions(),
            'value'=>$this->getAttribute(),
            'value_name'=>$this->getAttributeName(),
        ))->setRenderer(Mage::getBlockSingleton('rule/editable'));
    }

getAttributeElementHtml

(

)

Definition at line 317 of file Abstract.php.

    {
        return $this->getAttributeElement()->getHtml();
    }

getAttributeName

(

)

Definition at line 119 of file Abstract.php.

    {
        return $this->getAttributeOption($this->getAttribute());
    }

getAttributeOptions

(

)

Definition at line 105 of file Abstract.php.

    {
        return array();
    }

getAttributeSelectOptions

(

)

Definition at line 110 of file Abstract.php.

    {
        $opt = array();
        foreach ($this->getAttributeOption() as $k=>$v) {
            $opt[] = array('value'=>$k, 'label'=>$v);
        }
        return $opt;
    }

getChooserContainerHtml

(

)

Definition at line 402 of file Abstract.php.

    {
        $url = $this->getValueElementChooserUrl();
        $html = '';
        if ($url) {
            $html = '<div class="rule-chooser" url="'.$url.'"></div>';
        }
        return $html;
    }

getForm

(

)

Definition at line 50 of file Abstract.php.

    {
        return $this->getRule()->getForm();
    }

getInputType

(

)

This value will define which operators will be available for this condition.

Possible values are: string, numeric, date, select, multiselect, grid

Returns:

string

Reimplemented in Mage_CatalogRule_Model_Rule_Condition_Product, and Mage_SalesRule_Model_Rule_Condition_Address.

Definition at line 156 of file Abstract.php.

    {
        return 'string';
    }

getNewChildName

(

)

Definition at line 264 of file Abstract.php.

    {
        return $this->getAddLinkHtml();
    }

getNewChildSelectOptions

(

)

Reimplemented in Mage_CatalogRule_Model_Rule_Condition_Combine, Mage_SalesRule_Model_Rule_Condition_Combine, and Mage_SalesRule_Model_Rule_Condition_Product_Combine.

Definition at line 257 of file Abstract.php.

    {
        return array(
            array('value'=>'', 'label'=>Mage::helper('rule')->__('Please choose a condition to add...')),
        );
    }

getOperatorElement

(

)

Definition at line 322 of file Abstract.php.

    {
        if (is_null($this->getOperator())) {
            foreach ($this->getOperatorOption() as $k=>$v) {
                $this->setOperator($k);
                break;
            }
        }
        return $this->getForm()->addField($this->getPrefix().'__'.$this->getId().'__operator', 'select', array(
            'name'=>'rule['.$this->getPrefix().']['.$this->getId().'][operator]',
            'values'=>$this->getOperatorSelectOptions(),
            'value'=>$this->getOperator(),
            'value_name'=>$this->getOperatorName(),
        ))->setRenderer(Mage::getBlockSingleton('rule/editable'));
    }

getOperatorElementHtml

(

)

Definition at line 338 of file Abstract.php.

    {
        return $this->getOperatorElement()->getHtml();
    }

getOperatorName

(

)

Definition at line 174 of file Abstract.php.

    {
        return $this->getOperatorOption($this->getOperator());
    }

getOperatorSelectOptions

(

)

Definition at line 161 of file Abstract.php.

    {
        $type = $this->getInputType();
        $opt = array();
        $operatorByType = $this->getOperatorByInputType();
        foreach ($this->getOperatorOption() as $k=>$v) {
            if (!$operatorByType || in_array($k, $operatorByType[$type])) {
                $opt[] = array('value'=>$k, 'label'=>$v);
            }
        }
        return $opt;
    }

getRemoveLinkHtml

(

)

Definition at line 395 of file Abstract.php.

    {
        $src = Mage::getDesign()->getSkinUrl('images/rule_component_remove.gif');
        $html = ' <span class="rule-param"><a href="javascript:void(0)" class="rule-param-remove" title="'.Mage::helper('rule')->__('Remove').'"><img src="'.$src.'"  alt="" class="v-middle" /></a></span>';
        return $html;
    }

getTypeElement

(

)

Definition at line 286 of file Abstract.php.

    {
        return $this->getForm()->addField($this->getPrefix().'__'.$this->getId().'__type', 'hidden', array(
            'name'=>'rule['.$this->getPrefix().']['.$this->getId().'][type]',
            'value'=>$this->getType(),
            'no_span'=>true,
            'class' => 'hidden',
        ));
    }

getTypeElementHtml

(

)

Definition at line 296 of file Abstract.php.

    {
        return $this->getTypeElement()->getHtml();
    }

getValue

(

)

Definition at line 211 of file Abstract.php.

    {
        if ($this->getInputType()=='date' && !$this->getIsValueParsed()) {
            // date format intentionally hard-coded
            $this->setValue(Mage::app()->getLocale()->date($this->getData('value'), Varien_Date::DATE_INTERNAL_FORMAT, null, false)
                ->toString(Varien_Date::DATE_INTERNAL_FORMAT));
            $this->setIsValueParsed(true);
        }
        return $this->getData('value');
    }

getValueElement

(

)

Reimplemented in Mage_CatalogRule_Model_Rule_Condition_Product.

Definition at line 362 of file Abstract.php.

    {
        $elementParams = array(
            'name'               => 'rule['.$this->getPrefix().']['.$this->getId().'][value]',
            'value'              => $this->getValue(),
            'values'             => $this->getValueSelectOptions(),
            'value_name'         => $this->getValueName(),
            'after_element_html' => $this->getValueAfterElementHtml(),
            'explicit_apply'     => $this->getExplicitApply(),
        );
        if ($this->getInputType()=='date') {
            // date format intentionally hard-coded
            $elementParams['input_format'] = Varien_Date::DATE_INTERNAL_FORMAT;
            $elementParams['format']       = Varien_Date::DATE_INTERNAL_FORMAT;
        }
        return $this->getForm()->addField($this->getPrefix().'__'.$this->getId().'__value',
            $this->getValueElementType(),
            $elementParams
        )->setRenderer($this->getValueElementRenderer());
    }

getValueElementHtml

(

)

Definition at line 383 of file Abstract.php.

    {
        return $this->getValueElement()->getHtml();
    }

getValueElementRenderer

(

)

Definition at line 354 of file Abstract.php.

    {
        if (strpos($this->getValueElementType(), '/')!==false) {
            return Mage::getBlockSingleton($this->getValueElementType());
        }
        return Mage::getBlockSingleton('rule/editable');
    }

getValueElementType

(

)

Value element type will define renderer for condition value element

See also:

Varien_Data_Form_Element

Returns:

string

Reimplemented in Mage_CatalogRule_Model_Rule_Condition_Product, Mage_Rule_Model_Condition_Combine, Mage_SalesRule_Model_Rule_Condition_Address, and Mage_SalesRule_Model_Rule_Condition_Product_Subselect.

Definition at line 349 of file Abstract.php.

    {
        return 'text';
    }

getValueName

(

)

Definition at line 222 of file Abstract.php.

    {
        $value = $this->getValue();
        if (is_null($value) || ''===$value) {
            return '...';
        }

        $options = $this->getValueSelectOptions();
        $valueArr = array();
        if (!empty($options)) {
            foreach ($options as $o) {
                if (is_array($value)) {
                    if (in_array($o['value'], $value)) {
                        $valueArr[] = $o['label'];
                    }
                } else {
                    if (is_array($o['value'])) {
                        foreach ($o['value'] as $v) {
                            if ($v['value']==$value) {
                                return $v['label'];
                            }
                        }
                    }
                    if ($o['value']==$value) {
                        return $o['label'];
                    }
                }
            }
        }
        if (!empty($valueArr)) {
            $value = implode(', ', $valueArr);
        }
        return $value;
    }

getValueParsed

(

)

Definition at line 198 of file Abstract.php.

    {
        $value = $this->getData('value');

        $op = $this->getOperator();
        if (($op==='()' || $op==='!()') && is_string($value)) {
            $value = preg_split('#\s*[,;]\s*#', $value, null, PREG_SPLIT_NO_EMPTY);
            $this->setValue($value);
        }

        return $value;
    }

getValueSelectOptions

(

)

Reimplemented in Mage_CatalogRule_Model_Rule_Condition_Product, and Mage_SalesRule_Model_Rule_Condition_Address.

Definition at line 189 of file Abstract.php.

    {
        $opt = array();
        foreach ($this->getValueOption() as $k=>$v) {
            $opt[] = array('value'=>$k, 'label'=>$v);
        }
        return $opt;
    }

loadArray

(

$

arr

)

Reimplemented in Mage_CatalogRule_Model_Rule_Condition_Product.

Definition at line 76 of file Abstract.php.

    {
        $this->setType($arr['type']);
        $this->setAttribute(isset($arr['attribute']) ? $arr['attribute'] : false);
        $this->setOperator(isset($arr['operator']) ? $arr['operator'] : false);
        $this->setValue(isset($arr['value']) ? $arr['value'] : false);
        $this->setIsValueParsed(isset($arr['is_value_parsed']) ? $arr['is_value_parsed'] : false);

//        $this->loadAttributeOptions();
//        $this->loadOperatorOptions();
//        $this->loadValueOptions();
        return $this;
    }

loadAttributeOptions

(

)

Reimplemented in Mage_CatalogRule_Model_Rule_Condition_Product, Mage_SalesRule_Model_Rule_Condition_Address, and Mage_SalesRule_Model_Rule_Condition_Product_Subselect.

Definition at line 100 of file Abstract.php.

    {
        return $this;
    }

loadOperatorOptions

(

)

Reimplemented in Mage_SalesRule_Model_Rule_Condition_Product_Subselect.

Definition at line 124 of file Abstract.php.

    {
        $this->setOperatorOption(array(
            '=='  => Mage::helper('rule')->__('is'),
            '!='  => Mage::helper('rule')->__('is not'),
            '>='  => Mage::helper('rule')->__('equals or greater than'),
            '<='  => Mage::helper('rule')->__('equals or less than'),
            '>'   => Mage::helper('rule')->__('greater than'),
            '<'   => Mage::helper('rule')->__('less than'),
            '{}'  => Mage::helper('rule')->__('contains'),
            '!{}' => Mage::helper('rule')->__('does not contain'),
            '()'  => Mage::helper('rule')->__('is one of'),
            '!()' => Mage::helper('rule')->__('is not one of'),
        ));
        $this->setOperatorByInputType(array(
            'string' => array('==', '!=', '>=', '>', '<=', '<', '{}', '!{}', '()', '!()'),
            'numeric' => array('==', '!=', '>=', '>', '<=', '<', '()', '!()'),
            'date' => array('==', '>=', '<='),
            'select' => array('==', '!='),
            'multiselect' => array('==', '!=', '{}', '!{}'),
            'grid' => array('()', '!()'),
        ));
        return $this;
    }

loadValueOptions

(

)

Reimplemented in Mage_Rule_Model_Condition_Combine, and Mage_SalesRule_Model_Rule_Condition_Product_Found.

Definition at line 179 of file Abstract.php.

    {
//        $this->setValueOption(array(
//            true  => Mage::helper('rule')->__('TRUE'),
//            false => Mage::helper('rule')->__('FALSE'),
//        ));
        $this->setValueOption(array());
        return $this;
    }

loadXml

(

$

xml

)

Reimplemented in Mage_Rule_Model_Condition_Combine.

Definition at line 90 of file Abstract.php.

    {
        if (is_string($xml)) {
            $xml = simplexml_load_string($xml);
        }
        $arr = (array)$xml;
        $this->loadArray($arr);
        return $this;
    }

validate

(

Varien_Object $

object

)

Reimplemented in Mage_CatalogRule_Model_Rule_Condition_Product, Mage_Rule_Model_Condition_Combine, Mage_SalesRule_Model_Rule_Condition_Address, Mage_SalesRule_Model_Rule_Condition_Product_Found, Mage_SalesRule_Model_Rule_Condition_Product_Subselect, and Mage_SalesRule_Model_Rule_Condition_Product.

Definition at line 521 of file Abstract.php.

    {
        return $this->validateAttribute($object->getData($this->getAttribute()));
    }

validateAttribute

(

$

validatedValue

)

Validate product attrbute value for condition

Parameters:

mixed

$validatedValue product attribute value

Returns:

bool

Condition attribute value

Comparison operator

Definition at line 430 of file Abstract.php.

    {
        if (is_object($validatedValue)) {
            return false;
        }

        /**
         * Condition attribute value
         */
        $value = $this->getValueParsed();

        /**
         * Comparison operator
         */
        $op = $this->getOperator();

        // if operator requires array and it is not, or on opposite, return false
        if ((($op=='()' || $op=='!()') && !is_array($value))
            || (!($op=='()' || $op=='!()' || $op=='!=' || $op=='==' || $op=='{}' || $op=='!{}') && is_array($value))) {
            return false;
        }

        $result = false;

        switch ($op) {
            case '==': case '!=':
                if (is_array($value)) {
                    if (is_array($validatedValue)) {
                        $result = array_diff($validatedValue, $value);
                        $result = empty($result) && (sizeof($validatedValue) == sizeof($value));
                    } else {
                        return false;
                    }
                } else {
                    if (is_array($validatedValue)) {
                        $result = in_array($value, $validatedValue);
                    } else {
                        $result = $validatedValue==$value;
                    }
                }
                break;

            case '<=': case '>':
                if (is_array($validatedValue)) {
                    $result = false;
                } else {
                    $result = $validatedValue<=$value;
                }
                break;

            case '>=': case '<':
                if (is_array($validatedValue)) {
                    $result = false;
                } else {
                    $result = $validatedValue>=$value;
                }
                break;

            case '{}': case '!{}':
                if (is_array($value)) {
                    if (is_array($validatedValue)) {
                        $result = array_diff($value, $validatedValue);
                        $result = empty($result);
                    } else {
                        return false;
                    }
                } else {
                    if (is_array($validatedValue)) {
                        $result = false;
                    } else {
                        $result = stripos((string)$validatedValue, (string)$value)!==false;
                    }
                }
                break;

            case '()': case '!()':
                if (is_array($validatedValue)) {
                    $result = count(array_intersect($validatedValue, (array)$value))>0;
                } else {
                    $result = in_array($validatedValue, (array)$value);
                }
                break;
        }

        if ('!='==$op || '>'==$op || '<'==$op || '!{}'==$op || '!()'==$op) {
            $result = !$result;
        }

        return $result;
    }

---

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

• app/code/core/Mage/Rule/Model/Condition/Abstract.php