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 [email protected].
 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: class StringUtil {
 38: 
 39:     /**
 40:      * Like preg_replace but with option to have exception thrown if error occurs
 41:      */
 42:     public static function pregReplace (
 43:         $pattern, $replacement, $subject, $limit = null, &$count = null, $throws=true) {
 44: 
 45:         // precondition check
 46:         assert (!($limit === null && $count !== null));
 47: 
 48:         if ($count !== null) {
 49:             $retVal = preg_replace ($pattern, $replacement, $subject, $limit, $count);
 50:         } elseif ($limit !== null) {
 51:             $retVal = preg_replace ($pattern, $replacement, $subject, $limit);
 52:         } else {
 53:             $retVal = preg_replace ($pattern, $replacement, $subject);
 54:         }
 55: 
 56:         if ($throws && $retVal === null) {
 57:             throw new StringUtilException(
 58:             Yii::t('app', 'preg_replace error: {error}',
 59:                     array(
 60:                 '{error}' => StringUtilException::getErrorMessage(preg_last_error())
 61:             )), StringUtilException::PREG_REPLACE_ERROR);
 62:         }
 63:         return $retVal;
 64:     }
 65: 
 66:     /**
 67:      * Like preg_replace_callback but with option to have exception thrown if error occurs
 68:      */
 69:     public static function pregReplaceCallback (
 70:         $pattern, $callback, $subject, $limit = null, &$count = null, $throws=true) {
 71: 
 72:         // precondition check
 73:         assert (!($limit === null && $count !== null));
 74: 
 75:         if ($count !== null) {
 76:             $retVal = preg_replace_callback ($pattern, $callback, $subject, $limit, $count);
 77:         } elseif ($limit !== null) {
 78:             $retVal = preg_replace_callback ($pattern, $callback, $subject, $limit);
 79:         } else {
 80:             $retVal = preg_replace_callback ($pattern, $callback, $subject);
 81:         }
 82:         if ($throws && $retVal === null) {
 83:             throw new StringUtilException(
 84:             Yii::t('app', 'preg_replace_callback error: {error}',
 85:                     array(
 86:                 '{error}' => StringUtilException::getErrorMessage(preg_last_error())
 87:             )), StringUtilException::PREG_REPLACE_CALLBACK_ERROR);
 88:         }
 89:         return $retVal;
 90:     }
 91: 
 92:     /**
 93:      * Like json_decode, but returns $subject if decoding fails 
 94:      */
 95:     public static function jsonDecode ($subject, $assoc=false, $depth=512) {
 96:         $decoded = json_decode ($subject, $assoc, $depth);
 97:         if ($decoded !== null) return $decoded;
 98:         return $subject;
 99:     }
100: 
101:     /**
102:      * @return bool true if string is json, false otherwise
103:      */
104:     public static function isJson ($string) {
105:         json_decode ($string);
106:         return (json_last_error() == JSON_ERROR_NONE);
107:     }
108: 
109: }
110: 
111: class StringUtilException extends Exception {
112:     const PREG_REPLACE_ERROR = 1;
113:     const PREG_REPLACE_CALLBACK_ERROR = 2;
114: 
115:     /**
116:      * Convert PCRE error constant into an error message 
117:      */
118:     public static function getErrorMessage ($pcreConstant) {
119:         $definedConstants = get_defined_constants (true);
120:         $pcreConstantsByErrorCodes = array_flip ($definedConstants['pcre']);
121:         return isset ($pcreConstantsByErrorCodes[$pcreConstant]) ?
122:             $pcreConstantsByErrorCodes[$pcreConstant] : '';
123:     }
124: }
125: 
126: ?>
127: