1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_XmlConnect
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: /**
 28:  * Xmlconnect form validator rule element abstract
 29:  *
 30:  * @category    Mage
 31:  * @package     Mage_XmlConnect
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_XmlConnect_Model_Simplexml_Form_Element_Validator_Abstract
 35:     extends Mage_XmlConnect_Model_Simplexml_Form_Element_Abstract
 36: {
 37:     /**
 38:      * Array of the messages for default validator types
 39:      *
 40:      * @var array
 41:      */
 42:     protected $_validatorTypeMessages = array();
 43: 
 44:     /**
 45:      * Main element node
 46:      *
 47:      * @var string
 48:      */
 49:     protected $_mainNode = 'validator';
 50: 
 51:     /**
 52:      * Init validator rule element abstract
 53:      *
 54:      * @param array $attributes
 55:      */
 56:     public function __construct($attributes = array())
 57:     {
 58:         parent::__construct($attributes);
 59:         $this->_renderer = Mage_XmlConnect_Model_Simplexml_Form::getValidatorRuleRenderer();
 60:         $this->_setDefaultValidatorTypeMessages();
 61:         if (isset($attributes['type'])) {
 62:             $this->setType($attributes['type']);
 63:         }
 64:     }
 65: 
 66:     /**
 67:      * Set default validator messages
 68:      *
 69:      * @see Mage_Core_Helper_Js->_getTranslateData() and validation.js
 70:      * @return Mage_XmlConnect_Model_Simplexml_Form_Element_Validator_Abstract
 71:      */
 72:     protected function _setDefaultValidatorTypeMessages()
 73:     {
 74:         $this->_validatorTypeMessages = array(
 75:             'min_length' => Mage::helper('xmlconnect')->__('Text length does not satisfy specified min text range.'),
 76:             'max_length' => Mage::helper('xmlconnect')->__('Text length does not satisfy specified max text range.'),
 77:             'alphanumeric' => Mage::helper('xmlconnect')->__('Please use only letters (a-z or A-Z) or numbers (0-9) only in this field. No spaces or other characters are allowed.'),
 78:             'email' => Mage::helper('xmlconnect')->__('Please enter a valid email address. For example johndoe@domain.com.'),
 79:             'required' => Mage::helper('xmlconnect')->__('This is a required field.'),
 80:             'required_select' => Mage::helper('xmlconnect')->__('Please select an option.'),
 81:             'numeric' => Mage::helper('xmlconnect')->__('Please use numbers only in this field. Please avoid spaces or other characters such as dots or commas.'),
 82:             'alpha' => Mage::helper('xmlconnect')->__('Please use letters only (a-z or A-Z) in this field.'),
 83:             'url' => Mage::helper('xmlconnect')->__('Please enter a valid URL. Protocol is required (http://, https:// or ftp://)'),
 84:             'date' => Mage::helper('xmlconnect')->__('Please enter a valid date.'),
 85:             'max_file_size' => Mage::helper('xmlconnect')->__('\'%s\' exceeds the allowed file size: %d (bytes)', $this->getFieldLabel(), $this->getValue()),
 86:             'file_extensions' => Mage::helper('xmlconnect')->__('\'%s\' is not a valid file extension. Allowed extensions: %s', $this->getFieldLabel(), $this->getValue()),
 87:             'max_image_width' => Mage::helper('xmlconnect')->__('\'%s\' width exceeds allowed value of %d px', $this->getFieldLabel(), $this->getValue()),
 88:             'max_image_height' => Mage::helper('xmlconnect')->__('\'%s\' height exceeds allowed value of %d px', $this->getFieldLabel(), $this->getValue())
 89:         );
 90:         return $this;
 91:     }
 92: 
 93:     /**
 94:      * Add required attributes to validator rule
 95:      *
 96:      * @todo re-factor required attributes logic to make it easy to replace them
 97:      * @throws Mage_Core_Exception
 98:      * @param Mage_XmlConnect_Model_Simplexml_Element $xmlObj
 99:      * @return Mage_XmlConnect_Model_Simplexml_Form_Abstract
100:      */
101:     protected  function _addRequiredAttributes(Mage_XmlConnect_Model_Simplexml_Element $xmlObj)
102:     {
103:         $this->_addId($xmlObj);
104: 
105:         foreach ($this->getRequiredXmlAttributes() as $attribute => $defValue) {
106:             $data = $this->getData($this->_underscore($attribute));
107: 
108:             if ($data) {
109:                 $xmlObj->addAttribute($attribute, $xmlObj->xmlAttribute($data));
110:             } elseif(null !== $defValue){
111:                 $xmlObj->addAttribute($attribute, $xmlObj->xmlAttribute($defValue));
112:             } else {
113:                 Mage::throwException(Mage::helper('xmlconnect')->__('%s attribute is required.', $attribute));
114:             }
115:         }
116:         $this->_addMessage($xmlObj);
117:         return $this;
118:     }
119: 
120:     /**
121:      * Add validator message for validator rule
122:      *
123:      * @throws Mage_Core_Exception
124:      * @param Mage_XmlConnect_Model_Simplexml_Element $xmlObj
125:      * @return Mage_XmlConnect_Model_Simplexml_Form_Abstract
126:      */
127:     protected function _addMessage(Mage_XmlConnect_Model_Simplexml_Element $xmlObj)
128:     {
129:         if ($this->getMessage()) {
130:             $message = $this->getMessage();
131:         } elseif (array_key_exists($this->getType(), $this->getValidatorTypeMessages())) {
132:             $message = $this->_validatorTypeMessages[$this->getType()];
133:         } else {
134:             Mage::throwException(
135:                 Mage::helper('xmlconnect')->__('"message" attribute is required for "%s" validator rule.', $this->getType())
136:             );
137:         }
138:         $xmlObj->addAttribute('message', $xmlObj->xmlAttribute($message));
139:         return $this;
140:     }
141: 
142:     /**
143:      * Default validator rule attribute array
144:      *
145:      * @return array
146:      */
147:     public function getXmlAttributes()
148:     {
149:         return array('relation');
150:     }
151: 
152:     /**
153:      * Required validator rule attribute array
154:      *
155:      * @return array
156:      */
157:     public function getRequiredXmlAttributes()
158:     {
159:         return array('type' => null);
160:     }
161: 
162:     /**
163:      * Get validator type messages
164:      *
165:      * @return array
166:      */
167:     public function getValidatorTypeMessages()
168:     {
169:         return $this->_validatorTypeMessages;
170:     }
171: 
172:     /**
173:      * Set validator type messages
174:      *
175:      * @param array $validatorTypeMessages
176:      * @return Mage_XmlConnect_Model_Simplexml_Form_Element_Validator_Abstract
177:      */
178:     public function addValidatorTypeMessages(array $validatorTypeMessages)
179:     {
180:         $this->_validatorTypeMessages = array_merge($this->_validatorTypeMessages, $validatorTypeMessages);
181:         return $this;
182:     }
183: }
184: