phpmyadmin/libraries/stringNative.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /** String Functions for phpMyAdmin
   4  * If mb_* functions don't exist, we create the ones we need and they'll use the
   5  * standard string functions.
   6  * All mb_* functions created by pMA should behave as mb_* functions.
   7  *
   8  * @package PhpMyAdmin
   9  */
  10 if (!defined('PHPMYADMIN')) {
  11     exit;
  12 }
  13
  14 //Define mb_* functions if they don't exist.
  15 if (!@function_exists('mb_strlen')) {
  16     /**
  17      * Returns length of string depending on current charset.
  18      *
  19      * @param string $string string to count
  20      *
  21      * @return int string length
  22      */
  23     function mb_strlen($string)
  24     {
  25         return strlen($string);
  26     }
  27
  28     /**
  29      * Returns substring from string, works depending on current charset.
  30      *
  31      * @param string $string string to count
  32      * @param int    $start  start of substring
  33      * @param int    $length length of substring
  34      *
  35      * @return string the sub string
  36      */
  37     function mb_substr($string, $start, $length = 2147483647)
  38     {
  39         if (null === $string || strlen($string) <= $start) {
  40             return '';
  41         }
  42         if (null === $length) {
  43             $length = 2147483647;
  44         }
  45         return substr($string, $start, $length);
  46     }
  47
  48     /**
  49      * Returns number of substring from string.
  50      *
  51      * @param string $string string to check
  52      * @param int    $needle string to count
  53      *
  54      * @return int number of substring from the string
  55      */
  56     function mb_substrCount($string, $needle)
  57     {
  58         return substr_count($string, $needle);
  59     }
  60
  61     /**
  62      * Returns position of $needle in $haystack or false if not found
  63      *
  64      * @param string $haystack the string being checked
  65      * @param string $needle   the string to find in haystack
  66      * @param int    $offset   the search offset
  67      *
  68      * @return integer position of $needle in $haystack or false
  69      */
  70     function mb_strpos($haystack, $needle, $offset = 0)
  71     {
  72         return strpos($haystack, $needle, $offset);
  73     }
  74
  75     /**
  76      * Returns position of $needle in $haystack - case insensitive - or false if
  77      * not found
  78      *
  79      * @param string $haystack the string being checked
  80      * @param string $needle   the string to find in haystack
  81      * @param int    $offset   the search offset
  82      *
  83      * @return integer position of $needle in $haystack or false
  84      */
  85     function mb_stripos($haystack, $needle, $offset = 0)
  86     {
  87         if (('' === $haystack || false === $haystack) && $offset >= strlen($haystack)
  88         ) {
  89             return false;
  90         }
  91         return stripos($haystack, $needle, $offset);
  92     }
  93
  94     /**
  95      * Returns position of last $needle in $haystack or false if not found
  96      *
  97      * @param string $haystack the string being checked
  98      * @param string $needle   the string to find in haystack
  99      * @param int    $offset   the search offset
 100      *
 101      * @return integer position of last $needle in $haystack or false
 102      */
 103     function mb_strrpos($haystack, $needle, $offset = 0)
 104     {
 105         return strrpos($haystack, $needle, $offset);
 106     }
 107
 108     /**
 109      * Returns position of last $needle in $haystack - case insensitive - or false
 110      * if not found
 111      *
 112      * @param string $haystack the string being checked
 113      * @param string $needle   the string to find in haystack
 114      * @param int    $offset   the search offset
 115      *
 116      * @return integer position of last $needle in $haystack or false
 117      */
 118     function mb_strripos($haystack, $needle, $offset = 0)
 119     {
 120         if (('' === $haystack || false === $haystack) && $offset >= strlen($haystack)
 121         ) {
 122             return false;
 123         }
 124         return strripos($haystack, $needle, $offset);
 125     }
 126
 127     /**
 128      * Returns part of $haystack string starting from and including the first
 129      * occurrence of $needle to the end of $haystack or false if not found
 130      *
 131      * @param string $haystack      the string being checked
 132      * @param string $needle        the string to find in haystack
 133      * @param bool   $before_needle the part before the needle
 134      *
 135      * @return string part of $haystack or false
 136      */
 137     function mb_strstr($haystack, $needle, $before_needle = false)
 138     {
 139         return strstr($haystack, $needle, $before_needle);
 140     }
 141
 142     /**
 143      * Returns part of $haystack string starting from and including the first
 144      * occurrence of $needle to the end of $haystack - case insensitive - or false
 145      * if not found
 146      *
 147      * @param string $haystack      the string being checked
 148      * @param string $needle        the string to find in haystack
 149      * @param bool   $before_needle the part before the needle
 150      *
 151      * @return string part of $haystack or false
 152      */
 153     function mb_stristr($haystack, $needle, $before_needle = false)
 154     {
 155         return stristr($haystack, $needle, $before_needle);
 156     }
 157
 158     /**
 159      * Returns the portion of haystack which starts at the last occurrence or false
 160      * if not found
 161      *
 162      * @param string $haystack the string being checked
 163      * @param string $needle   the string to find in haystack
 164      *
 165      * @return string portion of haystack which starts at the last occurrence or
 166      *                         false
 167      */
 168     function mb_strrchr($haystack, $needle)
 169     {
 170         return strrchr($haystack, $needle);
 171     }
 172
 173     /**
 174      * Make a string lowercase
 175      *
 176      * @param string $string the string being lowercased
 177      *
 178      * @return string the lower case string
 179      */
 180     function mb_strtolower($string)
 181     {
 182         return strtolower($string);
 183     }
 184
 185     /**
 186      * Make a string uppercase
 187      *
 188      * @param string $string the string being uppercased
 189      *
 190      * @return string the upper case string
 191      */
 192     function mb_strtoupper($string)
 193     {
 194         return strtoupper($string);
 195     }
 196 }
 197
 198 //New functions.
 199 if (!@function_exists('mb_ord')) {
 200     /**
 201      * Perform a regular expression match
 202      *
 203      * @param string $pattern Pattern to search for
 204      * @param string $subject Input string
 205      * @param int    $offset  Start from search
 206      *
 207      * @return int 1 if matched, 0 if doesn't, false on failure
 208      */
 209     function mb_preg_strpos($pattern, $subject, $offset = 0)
 210     {
 211         $matches = array();
 212         $bFind = preg_match(
 213             $pattern, $subject, $matches, PREG_OFFSET_CAPTURE, $offset
 214         );
 215         if (1 !== $bFind) {
 216             return false;
 217         }
 218
 219         return $matches[1][1];
 220     }
 221
 222     /**
 223      * Get the ordinal value of a string
 224      *
 225      * @param string $string the string for which ord is required
 226      *
 227      * @return int the ord value
 228      */
 229     function mb_ord($string)
 230     {
 231         return ord($string);
 232     }
 233
 234     /**
 235      * Get the character of an ASCII
 236      *
 237      * @param int $ascii the ASCII code for which character is required
 238      *
 239      * @return string the character
 240      */
 241     function mb_chr($ascii)
 242     {
 243         return chr($ascii);
 244     }
 245 }