libraries/StringType.int.php

   1 <?php
   2 /**
   3  * Defines a set of specialized string functions.
   4  *
   5  * @package PhpMyAdmin-String
   6  */
   7 interface PMA_StringType
   8 {
   9     /**
  10      * Checks if a character is an alphanumeric one
  11      *
  12      * @param string $c character to check for
  13      *
  14      * @return boolean whether the character is an alphanumeric one or not
  15      */
  16     public function isAlnum($c);
  17
  18     /**
  19      * Checks if a character is an alphabetic one
  20      *
  21      * @param string $c character to check for
  22      *
  23      * @return boolean whether the character is an alphabetic one or not
  24      */
  25     public function isAlpha($c);
  26
  27     /**
  28      * Checks if a character is a digit
  29      *
  30      * @param string $c character to check for
  31      *
  32      * @return boolean whether the character is a digit or not
  33      */
  34     public function isDigit($c);
  35
  36     /**
  37      * Checks if a character is an upper alphabetic one
  38      *
  39      * @param string $c character to check for
  40      *
  41      * @return boolean whether the character is an upper alphabetic one or not
  42      */
  43     public function isUpper($c);
  44
  45
  46     /**
  47      * Checks if a character is a lower alphabetic one
  48      *
  49      * @param string $c character to check for
  50      *
  51      * @return boolean whether the character is a lower alphabetic one or not
  52      */
  53     public function isLower($c);
  54
  55     /**
  56      * Checks if a character is a space one
  57      *
  58      * @param string $c character to check for
  59      *
  60      * @return boolean whether the character is a space one or not
  61      */
  62     public function isSpace($c);
  63
  64     /**
  65      * Checks if a character is an hexadecimal digit
  66      *
  67      * @param string $c character to check for
  68      *
  69      * @return boolean whether the character is an hexadecimal digit or not
  70      */
  71     public function isHexDigit($c);
  72
  73     /**
  74      * Checks if a number is in a range
  75      *
  76      * @param integer $num   number to check for
  77      * @param integer $lower lower bound
  78      * @param integer $upper upper bound
  79      *
  80      * @return boolean  whether the number is in the range or not
  81      */
  82     public function numberInRangeInclusive($num, $lower, $upper);
  83 }
  84 ?>