libraries/StringType.int.php

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