1: <?php
  2: /*****************************************************************************************
  3:  * X2Engine Open Source Edition is a customer relationship management program developed by
  4:  * X2Engine, Inc. Copyright (C) 2011-2016 X2Engine Inc.
  5:  * 
  6:  * This program is free software; you can redistribute it and/or modify it under
  7:  * the terms of the GNU Affero General Public License version 3 as published by the
  8:  * Free Software Foundation with the addition of the following permission added
  9:  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 10:  * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
 11:  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 12:  * 
 13:  * This program is distributed in the hope that it will be useful, but WITHOUT
 14:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 15:  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 16:  * details.
 17:  * 
 18:  * You should have received a copy of the GNU Affero General Public License along with
 19:  * this program; if not, see http://www.gnu.org/licenses or write to the Free
 20:  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 21:  * 02110-1301 USA.
 22:  * 
 23:  * You can contact X2Engine, Inc. P.O. Box 66752, Scotts Valley,
 24:  * California 95067, USA. or at email address contact@x2engine.com.
 25:  * 
 26:  * The interactive user interfaces in modified source and object code versions
 27:  * of this program must display Appropriate Legal Notices, as required under
 28:  * Section 5 of the GNU Affero General Public License version 3.
 29:  * 
 30:  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 31:  * these Appropriate Legal Notices must retain the display of the "Powered by
 32:  * X2Engine" logo. If the display of the logo is not reasonably feasible for
 33:  * technical reasons, the Appropriate Legal Notices must display the words
 34:  * "Powered by X2Engine".
 35:  *****************************************************************************************/
 36: 
 37: /**
 38:  * Miscellaneous additions to CValidator including option to have errors reported in the form 
 39:  * of exceptions. Certain bad inputs will not occur during normal form submission and indicate
 40:  * either a programming error a malicious request. In either of these cases it makes sense to 
 41:  * throw an exception instead of adding errors to the model.
 42:  */
 43: 
 44: abstract class X2Validator extends CValidator {
 45: 
 46:     /**
 47:      * @var bool if true, instead of adding error messages to the model, exceptions will be thrown 
 48:      *  with error message
 49:      */
 50:     public $throwExceptions = false;
 51: 
 52:     /**
 53:      * @var CException type of exception that will get thrown if $throwExceptions is true
 54:      */
 55:     public $exceptionClass = 'CHttpException';
 56: 
 57:     /**
 58:      * @var bool if true attribute will validate if it's empty 
 59:      */
 60:     public $allowEmpty = false;
 61: 
 62:     protected $object;
 63: 
 64:     protected $attribute;
 65: 
 66:     /**
 67:      * A nicer-to-use version of CValidator's validateAttribute ()
 68:      */
 69:     abstract protected function validateValue (CModel $object, $value, $attribute);
 70: 
 71:     /**
 72:      * Allows use of validateValue in place of CValidator validateAttribute. Also sets $object
 73:      * and $attribute instance properties.
 74:      */
 75:     protected function validateAttribute ($object, $attribute) {
 76:         $value = $object->$attribute;
 77:         if ($this->allowEmpty && empty ($value)) return;
 78:         $this->object = $object;
 79:         $this->attribute = $attribute;
 80:         return $this->validateValue ($object, $value, $attribute);
 81:     } 
 82: 
 83:     /**
 84:      * Adds error to model or if $throwExceptions is true, throws an exception.
 85:      * @throws CException if validateAttribute () hasn't been called 
 86:      */
 87:     protected function error ($message) {
 88:         if (!isset ($this->object) || !isset ($this->attribute)) {
 89:             throw new CException (
 90:                 'Precondition violated: validateAttribute must be called before this method');
 91:         }
 92:         if ($this->throwExceptions) {
 93:             if ($this->exceptionClass === 'CHttpException') {
 94:                 throw new $this->exceptionClass (400, $message);
 95:             } else {
 96:                 throw new $this->exceptionClass ($message);
 97:             }
 98:         } else {
 99:             $this->addError ($this->object, $this->attribute, $message);
100:         }
101:     }
102: }
103: