hphp/idl/ctype.idl.php

   1 <?php
   2 /**
   3  * Automatically generated by running "php schema.php ctype".
   4  *
   5  * You may modify the file, but re-running schema.php against this file will
   6  * standardize the format without losing your schema changes. It does lose
   7  * any changes that are not part of schema. Use "note" field to comment on
   8  * schema itself, and "note" fields are not used in any code generation but
   9  * only staying within this file.
  10  */
  11 ///////////////////////////////////////////////////////////////////////////////
  12 // Preamble: C++ code inserted at beginning of ext_{name}.h
  13
  14 DefinePreamble(<<<CPP
  15
  16 CPP
  17 );
  18
  19 ///////////////////////////////////////////////////////////////////////////////
  20 // Constants
  21 //
  22 // array (
  23 //   'name' => name of the constant
  24 //   'type' => type of the constant
  25 //   'note' => additional note about this constant's schema
  26 // )
  27
  28
  29 ///////////////////////////////////////////////////////////////////////////////
  30 // Functions
  31 //
  32 // array (
  33 //   'name'   => name of the function
  34 //   'desc'   => description of the function's purpose
  35 //   'flags'  => attributes of the function, see base.php for possible values
  36 //   'opt'    => optimization callback function's name for compiler
  37 //   'note'   => additional note about this function's schema
  38 //   'return' =>
  39 //      array (
  40 //        'type'  => return type, use Reference for ref return
  41 //        'desc'  => description of the return value
  42 //      )
  43 //   'args'   => arguments
  44 //      array (
  45 //        'name'  => name of the argument
  46 //        'type'  => type of the argument, use Reference for output parameter
  47 //        'value' => default value of the argument
  48 //        'desc'  => description of the argument
  49 //      )
  50 // )
  51
  52 DefineFunction(
  53   array(
  54     'name'   => "ctype_alnum",
  55     'desc'   => "Checks if all of the characters in the provided string, text, are alphanumeric. In the standard C locale letters are just [A-Za-z].",
  56     'flags'  =>  HasDocComment,
  57     'return' => array(
  58       'type'   => Boolean,
  59       'desc'   => "Returns TRUE if every character in text is either a letter or a digit, FALSE otherwise.",
  60     ),
  61     'args'   => array(
  62       array(
  63         'name'   => "text",
  64         'type'   => Variant,
  65         'desc'   => "The tested string.",
  66       ),
  67     ),
  68     'taint_observer' => false,
  69   ));
  70
  71 DefineFunction(
  72   array(
  73     'name'   => "ctype_alpha",
  74     'desc'   => "Checks if all of the characters in the provided string, text, are alphabetic. In the standard C locale letters are just [A-Za-z] and ctype_alpha() is equivalent to (ctype_upper(\$text) || ctype_lower(\$text)) if \$text is just a single character, but other languages have letters that are considered neither upper nor lower case.",
  75     'flags'  =>  HasDocComment,
  76     'return' => array(
  77       'type'   => Boolean,
  78       'desc'   => "Returns TRUE if every character in text is a letter from the current locale, FALSE otherwise.",
  79     ),
  80     'args'   => array(
  81       array(
  82         'name'   => "text",
  83         'type'   => Variant,
  84         'desc'   => "The tested string.",
  85       ),
  86     ),
  87     'taint_observer' => false,
  88   ));
  89
  90 DefineFunction(
  91   array(
  92     'name'   => "ctype_cntrl",
  93     'desc'   => "Checks if all of the characters in the provided string, text, are control characters. Control characters are e.g. line feed, tab, escape.",
  94     'flags'  =>  HasDocComment,
  95     'return' => array(
  96       'type'   => Boolean,
  97       'desc'   => "Returns TRUE if every character in text is a control character from the current locale, FALSE otherwise.",
  98     ),
  99     'args'   => array(
 100       array(
 101         'name'   => "text",
 102         'type'   => Variant,
 103         'desc'   => "The tested string.",
 104       ),
 105     ),
 106     'taint_observer' => false,
 107   ));
 108
 109 DefineFunction(
 110   array(
 111     'name'   => "ctype_digit",
 112     'desc'   => "Checks if all of the characters in the provided string, text, are numerical.",
 113     'flags'  =>  HasDocComment,
 114     'return' => array(
 115       'type'   => Boolean,
 116       'desc'   => "Returns TRUE if every character in the string text is a decimal digit, FALSE otherwise.",
 117     ),
 118     'args'   => array(
 119       array(
 120         'name'   => "text",
 121         'type'   => Variant,
 122         'desc'   => "The tested string.",
 123       ),
 124     ),
 125     'taint_observer' => false,
 126   ));
 127
 128 DefineFunction(
 129   array(
 130     'name'   => "ctype_graph",
 131     'desc'   => "Checks if all of the characters in the provided string, text, creates visible output.",
 132     'flags'  =>  HasDocComment,
 133     'return' => array(
 134       'type'   => Boolean,
 135       'desc'   => "Returns TRUE if every character in text is printable and actually creates visible output (no white space), FALSE otherwise.",
 136     ),
 137     'args'   => array(
 138       array(
 139         'name'   => "text",
 140         'type'   => Variant,
 141         'desc'   => "The tested string.",
 142       ),
 143     ),
 144     'taint_observer' => false,
 145   ));
 146
 147 DefineFunction(
 148   array(
 149     'name'   => "ctype_lower",
 150     'desc'   => "Checks if all of the characters in the provided string, text, are lowercase letters.",
 151     'flags'  =>  HasDocComment,
 152     'return' => array(
 153       'type'   => Boolean,
 154       'desc'   => "Returns TRUE if every character in text is a lowercase letter in the current locale.",
 155     ),
 156     'args'   => array(
 157       array(
 158         'name'   => "text",
 159         'type'   => Variant,
 160         'desc'   => "The tested string.",
 161       ),
 162     ),
 163     'taint_observer' => false,
 164   ));
 165
 166 DefineFunction(
 167   array(
 168     'name'   => "ctype_print",
 169     'desc'   => "Checks if all of the characters in the provided string, text, are printable.",
 170     'flags'  =>  HasDocComment,
 171     'return' => array(
 172       'type'   => Boolean,
 173       'desc'   => "Returns TRUE if every character in text will actually create output (including blanks). Returns FALSE if text contains control characters or characters that do not have any output or control function at all.",
 174     ),
 175     'args'   => array(
 176       array(
 177         'name'   => "text",
 178         'type'   => Variant,
 179         'desc'   => "The tested string.",
 180       ),
 181     ),
 182     'taint_observer' => false,
 183   ));
 184
 185 DefineFunction(
 186   array(
 187     'name'   => "ctype_punct",
 188     'desc'   => "Checks if all of the characters in the provided string, text, are punctuation character.",
 189     'flags'  =>  HasDocComment,
 190     'return' => array(
 191       'type'   => Boolean,
 192       'desc'   => "Returns TRUE if every character in text is printable, but neither letter, digit or blank, FALSE otherwise.",
 193     ),
 194     'args'   => array(
 195       array(
 196         'name'   => "text",
 197         'type'   => Variant,
 198         'desc'   => "The tested string.",
 199       ),
 200     ),
 201     'taint_observer' => false,
 202   ));
 203
 204 DefineFunction(
 205   array(
 206     'name'   => "ctype_space",
 207     'desc'   => "Checks if all of the characters in the provided string, text, creates whitespace.",
 208     'flags'  =>  HasDocComment,
 209     'return' => array(
 210       'type'   => Boolean,
 211       'desc'   => "Returns TRUE if every character in text creates some sort of white space, FALSE otherwise. Besides the blank character this also includes tab, vertical tab, line feed, carriage return and form feed characters.",
 212     ),
 213     'args'   => array(
 214       array(
 215         'name'   => "text",
 216         'type'   => Variant,
 217         'desc'   => "The tested string.",
 218       ),
 219     ),
 220     'taint_observer' => false,
 221   ));
 222
 223 DefineFunction(
 224   array(
 225     'name'   => "ctype_upper",
 226     'desc'   => "Checks if all of the characters in the provided string, text, are uppercase characters.",
 227     'flags'  =>  HasDocComment,
 228     'return' => array(
 229       'type'   => Boolean,
 230       'desc'   => "Returns TRUE if every character in text is an uppercase letter in the current locale.",
 231     ),
 232     'args'   => array(
 233       array(
 234         'name'   => "text",
 235         'type'   => Variant,
 236         'desc'   => "The tested string.",
 237       ),
 238     ),
 239     'taint_observer' => false,
 240   ));
 241
 242 DefineFunction(
 243   array(
 244     'name'   => "ctype_xdigit",
 245     'desc'   => "Checks if all of the characters in the provided string, text, are hexadecimal 'digits'.",
 246     'flags'  =>  HasDocComment,
 247     'return' => array(
 248       'type'   => Boolean,
 249       'desc'   => "Returns TRUE if every character in text is a hexadecimal 'digit', that is a decimal digit or a character from [A-Fa-f] , FALSE otherwise.",
 250     ),
 251     'args'   => array(
 252       array(
 253         'name'   => "text",
 254         'type'   => Variant,
 255         'desc'   => "The tested string.",
 256       ),
 257     ),
 258     'taint_observer' => false,
 259   ));
 260
 261
 262 ///////////////////////////////////////////////////////////////////////////////
 263 // Classes
 264 //
 265 // BeginClass
 266 // array (
 267 //   'name'   => name of the class
 268 //   'desc'   => description of the class's purpose
 269 //   'flags'  => attributes of the class, see base.php for possible values
 270 //   'note'   => additional note about this class's schema
 271 //   'parent' => parent class name, if any
 272 //   'ifaces' => array of interfaces tihs class implements
 273 //   'bases'  => extra internal and special base classes this class requires
 274 //   'footer' => extra C++ inserted at end of class declaration
 275 // )
 276 //
 277 // DefineConstant(..)
 278 // DefineConstant(..)
 279 // ...
 280 // DefineFunction(..)
 281 // DefineFunction(..)
 282 // ...
 283 // DefineProperty
 284 // DefineProperty
 285 //
 286 // array (
 287 //   'name'  => name of the property
 288 //   'type'  => type of the property
 289 //   'flags' => attributes of the property
 290 //   'desc'  => description of the property
 291 //   'note'  => additional note about this property's schema
 292 // )
 293 //
 294 // EndClass()
 295