libraries/StringByte.int.php

   1 <?php
   2 /**
   3  * Defines a set of specialized string functions.
   4  *
   5  * @package PhpMyAdmin-String
   6  */
   7 interface PMA_StringByte
   8 {
   9     /**
  10      * Returns length of string depending on current charset.
  11      *
  12      * @param string $string string to count
  13      *
  14      * @return int|false string length
  15      */
  16
  17     public function strlen($string);
  18
  19     /**
  20      * Returns substring from string, works depending on current charset.
  21      *
  22      * @param string $string string to count
  23      * @param int    $start  start of substring
  24      * @param int    $length length of substring
  25      *
  26      * @return string|false the sub string
  27      */
  28     public function substr($string, $start, $length = 2147483647);
  29
  30     /**
  31      * Returns number of substring from string, works depending on current charset.
  32      *
  33      * @param string $string string to check
  34      * @param int    $needle string to count
  35      *
  36      * @return int number of substring from the string
  37      */
  38     public function substrCount($string, $needle);
  39
  40     /**
  41      * Returns position of $needle in $haystack or false if not found
  42      *
  43      * @param string $haystack the string being checked
  44      * @param string $needle   the string to find in haystack
  45      * @param int    $offset   the search offset
  46      *
  47      * @return int|false position of $needle in $haystack or false
  48      */
  49     public function strpos($haystack, $needle, $offset = 0);
  50
  51     /**
  52      * Returns position of $needle in $haystack - case insensitive - or false if
  53      * not found
  54      *
  55      * @param string $haystack the string being checked
  56      * @param string $needle   the string to find in haystack
  57      * @param int    $offset   the search offset
  58      *
  59      * @return int|false position of $needle in $haystack or false
  60      */
  61     public function stripos($haystack, $needle, $offset = 0);
  62
  63     /**
  64      * Returns position of last $needle in $haystack or false if not found
  65      *
  66      * @param string $haystack the string being checked
  67      * @param string $needle   the string to find in haystack
  68      * @param int    $offset   the search offset
  69      *
  70      * @return int|false position of last $needle in $haystack or false
  71      */
  72     public function strrpos($haystack, $needle, $offset = 0);
  73
  74     /**
  75      * Returns position of last $needle in $haystack - case insensitive - or false
  76      * if not found
  77      *
  78      * @param string $haystack the string being checked
  79      * @param string $needle   the string to find in haystack
  80      * @param int    $offset   the search offset
  81      *
  82      * @return int|false position of last $needle in $haystack or false
  83      */
  84     public function strripos($haystack, $needle, $offset = 0);
  85
  86     /**
  87      * Returns part of $haystack string starting from and including the first
  88      * occurrence of $needle to the end of $haystack or false if not found
  89      *
  90      * @param string $haystack      the string being checked
  91      * @param string $needle        the string to find in haystack
  92      * @param bool   $before_needle the part before the needle
  93      *
  94      * @return string|false part of $haystack or false
  95      */
  96     public function strstr($haystack, $needle, $before_needle = false);
  97
  98     /**
  99      * Returns part of $haystack string starting from and including the first
 100      * occurrence of $needle to the end of $haystack - case insensitive - or false
 101      * if not found
 102      *
 103      * @param string $haystack      the string being checked
 104      * @param string $needle        the string to find in haystack
 105      * @param bool   $before_needle the part before the needle
 106      *
 107      * @return string|false part of $haystack or false
 108      *
 109      * @deprecated
 110      * @see DON'T USE UNTIL HHVM IMPLEMENTS THIRD PARAMETER!
 111      */
 112     public function stristr($haystack, $needle, $before_needle = false);
 113
 114     /**
 115      * Returns the portion of haystack which starts at the last occurrence or false
 116      * if not found
 117      *
 118      * @param string $haystack the string being checked
 119      * @param string $needle   the string to find in haystack
 120      *
 121      * @return string|false portion of haystack which starts at the last occurrence
 122      *                      or false
 123      */
 124     public function strrchr($haystack, $needle);
 125
 126     /**
 127      * Make a string lowercase
 128      *
 129      * @param string $string the string being lowercased
 130      *
 131      * @return string the lower case string
 132      */
 133     public function strtolower($string);
 134
 135     /**
 136      * Make a string uppercase
 137      *
 138      * @param string $string the string being uppercased
 139      *
 140      * @return string the lower case string
 141      */
 142     public function strtoupper($string);
 143
 144     /**
 145      * Returns position of $needle in $haystack from a regular expression match
 146      *
 147      * @param string $pattern Pattern to search for
 148      * @param string $subject Input string
 149      * @param int    $offset  Start from search
 150      *
 151      * @return int|false position of $needle in $haystack or false
 152      */
 153     public function pregStrpos($pattern, $subject, $offset = 0);
 154
 155     /**
 156      * Get the ordinal value of a string
 157      *
 158      * @param string $string the string for which ord is required
 159      *
 160      * @return string the ord value
 161      */
 162     public function ord($string);
 163
 164     /**
 165      * Get the character of an ASCII
 166      *
 167      * @param int $ascii the ASCII code for which character is required
 168      *
 169      * @return string the character
 170      */
 171     public function chr($ascii);
 172 }
 173 ?>