fluxcms /install/phing/classes/phing/util/StringHelper.php

Language PHP Lines 209
MD5 Hash 4082bb63caaa27c622fc82149312a221
Repository https://github.com/chregu/fluxcms.git View Raw File View Project SPDX
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?php

/**
 * String helper utility class.
 *
 * This class includes some Java-like functions for parsing strings,
 * as well as some functions for getting qualifiers / unqualifying phing-style
 * classpaths.  (e.g. "phing.util.StringHelper").
 *
 * @author Hans Lellelid <hans@xmpl.org>
 * @package phing.system.util
 */
class StringHelper {

    private static $TRUE_VALUES = array("on", "true", "t", "yes");
    private static $FALSE_VALUES = array("off", "false", "f", "no");
    
    /**
     * Replaces identifier tokens with corresponding text values in passed string.
     *
     * @params array $strings Array of strings to multiply. (If string is passed, will convert to array)
     * @params array $tokens The tokens to search for.
     * @params array $replacements The values with which to replace found tokens.
     * @return string
     */
    public function multiply($strings, $tokens, $replacements) {
        $strings = (array) $strings;
        $results = array();
        foreach ($strings as $string) {
            $results[] = str_replace($tokens, $replacements, $string);
        }        
        return $results;
    }

    /**
     * Remove qualification to name.
     * E.g. eg.Cat -> Cat
     * @param string $qualifiedName
     * @param string $separator Character used to separate.
     */
    public function unqualify($qualifiedName, $separator = '.') {
        // if false, then will be 0
        $pos = strrpos($qualifiedName, $separator);
        if ($pos === false) { 
            return $qualifiedName;  // there is no '.' in the qualifed name
        } else {
            return substr($qualifiedName, $pos + 1); // start just after '.'
        }
    }

    /** 
     * Converts a string to an indexed array of chars
     * There's really no reason for this to be used in PHP, since strings
     * are all accessible using the $string{0} notation.
     * @param string $string
     * @return array
     * @deprecated
     */
    function toCharArray($str) {
        $ret=array();
        $len=strlen($str);
        for ($i=0; $i < $len; $i++) {
            $ret[] = $str{$i};
        }
        return $ret;
    }
    
    /**
     * Get the qualifier part of a qualified name.
     * E.g. eg.Cat -> eg
     * @return string
     */    
    public function qualifier($qualifiedName, $seperator = '.') {
        $pos = strrchr($qualifiedName, $seperator);
        if ($pos === false) {
            return '';
        } else {
            return substr($qualifiedName, 0, $pos);
        }
    }
    
    /**
     * @param array $columns String[]
     * @param string $prefix
     * @return array String[]
     */ 
    public function prefix( $columns, $prefix) {
        if ($prefix == null) return $columns;
        $qualified = array();
        foreach($columns as $key => $column) {
            $qualified[$key] = $prefix . $column;
        }        
        return $qualified;
    }
    
    /**
     *
     * @return string
     */ 
    public function root($qualifiedName, $separator = '.') {
        $loc = strpos($qualifiedName, $separator);
        return ($loc === false) ? $qualifiedName : substr($qualifiedName, 0, $loc);
    }
    
    /**
     * @return int
     */
    public function hashCode($string) {
        return crc32($string);
    }
    
    /**
     * @return boolean
     */ 
    public function booleanValue($s) {
        if (is_bool($s)) {
            return $s; // it's already boolean (not a string)
        }
        // otherwise assume it's something like "true" or "t"
        $trimmed = strtolower(trim($s));
        return (boolean) in_array($trimmed, self::$TRUE_VALUES);
    }

    /** tests if a string is a representative of a boolean */
    public function isBoolean($s) {

        if (is_bool($s)) {
            return true; // it already is boolean
        }
        
        if ($s === "" || $s === null || !is_string($s)) {
            return false; // not a valid string for testing
        }

        $test = trim(strtolower($s));
        return (boolean) in_array($test, array_merge(self::$FALSE_VALUES, self::$TRUE_VALUES));
    }
        
    /**
     * Creates a key based on any number of passed params.
     * @return string
     */
    public function key() {
        $args = func_get_args();
        return serialize($args);
    }    
    
    /** tests if a string starts with a given string */
    function startsWith($check, $string) {
        if ($check === "" || $check === $string) {
            return true;
        } else {
            return (strpos($string, $check) === 0) ? true : false;
        }
    }
    
    /** tests if a string ends with a given string */
    function endsWith($check, $string) {
        if ($check === "" || $check === $string) {
            return true;
        } else {
            return (strpos(strrev($string), strrev($check)) === 0) ? true : false;
        }
    }            

    /**
     * a natural way of getting a subtring, php's circular string buffer and strange
     * return values suck if you want to program strict as of C or friends 
     */
    function substring($string, $startpos, $endpos = -1) {
        $len    = strlen($string);
        $endpos = (int) (($endpos === -1) ? $len-1 : $endpos);
        if ($startpos > $len-1 || $startpos < 0) {
            trigger_error("substring(), Startindex out of bounds must be 0<n<$len", E_USER_ERROR);
        }
        if ($endpos > $len-1 || $endpos < $startpos) {
            trigger_error("substring(), Endindex out of bounds must be $startpos<n<".($len-1), E_USER_ERROR);
        }
        if ($startpos === $endpos) {
            return (string) $string{$startpos};
        } else {
            $len = $endpos-$startpos;
        }
        return substr($string, $startpos, $len+1);
    }

    /**
     * Does the value correspond to a slot variable?
     * @param string $value    
     */
    function isSlotVar($value) {
        $value = trim($value);
        if ($value === "") return false;
        return preg_match('/^%\{([\w\.\-]+)\}$/', $value);
    }
    
    /**
     * Extracts the variable name for a slot var in the format %{task.current_file}
     * @param string $var The var from build file.
     * @return string Extracted name part.
     */
    function slotVar($var) {
        return trim($var, '%{} ');
    }
    
}


?>
Back to Top