phpmyadmin/libraries/StringByte.int.php

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