PageRenderTime 75ms CodeModel.GetById 10ms RepoModel.GetById 0ms app.codeStats 1ms

/plugins/com.aptana.editor.php.epl/Resources/language/php5/standard.php

https://github.com/haegyung/aptana-php
PHP | 9594 lines | 724 code | 498 blank | 8372 comment | 0 complexity | df22207fbe33cd3fa58d045760fe0378 MD5 | raw file
  1. <?php
  2. // Start of standard v.5.2.10
  3. class __PHP_Incomplete_Class {
  4. }
  5. class php_user_filter {
  6. public $filtername;
  7. public $params;
  8. /**
  9. * @param in
  10. * @param out
  11. * @param consumed
  12. * @param closing
  13. */
  14. public function filter ($in, $out, &$consumed, $closing) {}
  15. public function onCreate () {}
  16. public function onClose () {}
  17. }
  18. class Directory {
  19. public function close () {}
  20. public function rewind () {}
  21. public function read () {}
  22. }
  23. /**
  24. * Returns the value of a constant
  25. * @link http://www.php.net/manual/en/function.constant.php
  26. * @param name string <p>
  27. * The constant name.
  28. * </p>
  29. * @return mixed the value of the constant, or &null; if the constant is not
  30. * defined.
  31. */
  32. function constant ($name) {}
  33. /**
  34. * Convert binary data into hexadecimal representation
  35. * @link http://www.php.net/manual/en/function.bin2hex.php
  36. * @param str string <p>
  37. * A character.
  38. * </p>
  39. * @return string the hexadecimal representation of the given string.
  40. */
  41. function bin2hex ($str) {}
  42. /**
  43. * Delay execution
  44. * @link http://www.php.net/manual/en/function.sleep.php
  45. * @param seconds int <p>
  46. * Halt time in seconds.
  47. * </p>
  48. * @return int zero on success, or false on errors. If the call was interrupted
  49. * by a signal, sleep returns the number of seconds left
  50. * to sleep.
  51. */
  52. function sleep ($seconds) {}
  53. /**
  54. * Delay execution in microseconds
  55. * @link http://www.php.net/manual/en/function.usleep.php
  56. * @param micro_seconds int <p>
  57. * Halt time in micro seconds. A micro second is one millionth of a
  58. * second.
  59. * </p>
  60. * @return void
  61. */
  62. function usleep ($micro_seconds) {}
  63. /**
  64. * Flush the output buffer
  65. * @link http://www.php.net/manual/en/function.flush.php
  66. * @return void
  67. */
  68. function flush () {}
  69. /**
  70. * Wraps a string to a given number of characters
  71. * @link http://www.php.net/manual/en/function.wordwrap.php
  72. * @param str string <p>
  73. * The input string.
  74. * </p>
  75. * @param width int[optional] <p>
  76. * The column width.
  77. * </p>
  78. * @param break string[optional] <p>
  79. * The line is broken using the optional
  80. * break parameter.
  81. * </p>
  82. * @param cut bool[optional] <p>
  83. * If the cut is set to true, the string is
  84. * always wrapped at or before the specified width. So if you have
  85. * a word that is larger than the given width, it is broken apart.
  86. * (See second example).
  87. * </p>
  88. * @return string the given string wrapped at the specified column.
  89. */
  90. function wordwrap ($str, $width = null, $break = null, $cut = null) {}
  91. /**
  92. * Convert special characters to HTML entities
  93. * @link http://www.php.net/manual/en/function.htmlspecialchars.php
  94. * @param string string <p>
  95. * The string being converted.
  96. * </p>
  97. * @param quote_style int[optional] <p>
  98. * The optional second argument, quote_style, tells
  99. * the function what to do with single and double quote characters.
  100. * The default mode, ENT_COMPAT, is the backwards compatible mode
  101. * which only translates the double-quote character and leaves the
  102. * single-quote untranslated. If ENT_QUOTES is set, both single and
  103. * double quotes are translated and if ENT_NOQUOTES is set neither
  104. * single nor double quotes are translated.
  105. * </p>
  106. * @param charset string[optional] <p>
  107. * Defines character set used in conversion.
  108. * The default character set is ISO-8859-1.
  109. * </p>
  110. * <p>
  111. * For the purposes of this function, the charsets
  112. * ISO-8859-1, ISO-8859-15,
  113. * UTF-8, cp866,
  114. * cp1251, cp1252, and
  115. * KOI8-R are effectively equivalent, as the
  116. * characters affected by htmlspecialchars
  117. * occupy the same positions in all of these charsets.
  118. * </p>
  119. * &reference.strings.charsets;
  120. * @param double_encode bool[optional] <p>
  121. * When double_encode is turned off PHP will not
  122. * encode existing html entities, the default is to convert everything.
  123. * </p>
  124. * @return string The converted string.
  125. */
  126. function htmlspecialchars ($string, $quote_style = null, $charset = null, $double_encode = null) {}
  127. /**
  128. * Convert all applicable characters to HTML entities
  129. * @link http://www.php.net/manual/en/function.htmlentities.php
  130. * @param string string <p>
  131. * The input string.
  132. * </p>
  133. * @param quote_style int[optional] <p>
  134. * Like htmlspecialchars, the optional second
  135. * quote_style parameter lets you define what will
  136. * be done with 'single' and "double" quotes. It takes on one of three
  137. * constants with the default being ENT_COMPAT:
  138. * <table>
  139. * Available quote_style constants
  140. * <tr valign="top">
  141. * <td>Constant Name</td>
  142. * <td>Description</td>
  143. * </tr>
  144. * <tr valign="top">
  145. * <td>ENT_COMPAT</td>
  146. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  147. * </tr>
  148. * <tr valign="top">
  149. * <td>ENT_QUOTES</td>
  150. * <td>Will convert both double and single quotes.</td>
  151. * </tr>
  152. * <tr valign="top">
  153. * <td>ENT_NOQUOTES</td>
  154. * <td>Will leave both double and single quotes unconverted.</td>
  155. * </tr>
  156. * </table>
  157. * </p>
  158. * @param charset string[optional] <p>
  159. * Like htmlspecialchars, it takes an optional
  160. * third argument charset which defines character
  161. * set used in conversion.
  162. * Presently, the ISO-8859-1 character set is used as the default.
  163. * </p>
  164. * &reference.strings.charsets;
  165. * @param double_encode bool[optional] <p>
  166. * When double_encode is turned off PHP will not
  167. * encode existing html entities. The default is to convert everything.
  168. * </p>
  169. * @return string the encoded string.
  170. */
  171. function htmlentities ($string, $quote_style = null, $charset = null, $double_encode = null) {}
  172. /**
  173. * Convert all HTML entities to their applicable characters
  174. * @link http://www.php.net/manual/en/function.html-entity-decode.php
  175. * @param string string <p>
  176. * The input string.
  177. * </p>
  178. * @param quote_style int[optional] <p>
  179. * The optional second quote_style parameter lets
  180. * you define what will be done with 'single' and "double" quotes. It takes
  181. * on one of three constants with the default being
  182. * ENT_COMPAT:
  183. * <table>
  184. * Available quote_style constants
  185. * <tr valign="top">
  186. * <td>Constant Name</td>
  187. * <td>Description</td>
  188. * </tr>
  189. * <tr valign="top">
  190. * <td>ENT_COMPAT</td>
  191. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  192. * </tr>
  193. * <tr valign="top">
  194. * <td>ENT_QUOTES</td>
  195. * <td>Will convert both double and single quotes.</td>
  196. * </tr>
  197. * <tr valign="top">
  198. * <td>ENT_NOQUOTES</td>
  199. * <td>Will leave both double and single quotes unconverted.</td>
  200. * </tr>
  201. * </table>
  202. * </p>
  203. * @param charset string[optional] <p>
  204. * The ISO-8859-1 character set is used as default for the optional third
  205. * charset. This defines the character set used in
  206. * conversion.
  207. * </p>
  208. * &reference.strings.charsets;
  209. * @return string the decoded string.
  210. */
  211. function html_entity_decode ($string, $quote_style = null, $charset = null) {}
  212. /**
  213. * Convert special HTML entities back to characters
  214. * @link http://www.php.net/manual/en/function.htmlspecialchars-decode.php
  215. * @param string string <p>
  216. * The string to decode
  217. * </p>
  218. * @param quote_style int[optional] <p>
  219. * The quote style. One of the following constants:
  220. * <table>
  221. * quote_style constants
  222. * <tr valign="top">
  223. * <td>Constant Name</td>
  224. * <td>Description</td>
  225. * </tr>
  226. * <tr valign="top">
  227. * <td>ENT_COMPAT</td>
  228. * <td>Will convert double-quotes and leave single-quotes alone
  229. * (default)</td>
  230. * </tr>
  231. * <tr valign="top">
  232. * <td>ENT_QUOTES</td>
  233. * <td>Will convert both double and single quotes</td>
  234. * </tr>
  235. * <tr valign="top">
  236. * <td>ENT_NOQUOTES</td>
  237. * <td>Will leave both double and single quotes unconverted</td>
  238. * </tr>
  239. * </table>
  240. * </p>
  241. * @return string the decoded string.
  242. */
  243. function htmlspecialchars_decode ($string, $quote_style = null) {}
  244. /**
  245. * Returns the translation table used by <function>htmlspecialchars</function> and <function>htmlentities</function>
  246. * @link http://www.php.net/manual/en/function.get-html-translation-table.php
  247. * @param table int[optional] <p>
  248. * There are two new constants (HTML_ENTITIES,
  249. * HTML_SPECIALCHARS) that allow you to specify the
  250. * table you want.
  251. * </p>
  252. * @param quote_style int[optional] <p>
  253. * Like the htmlspecialchars and
  254. * htmlentities functions you can optionally specify
  255. * the quote_style you are working with.
  256. * See the description
  257. * of these modes in htmlspecialchars.
  258. * </p>
  259. * @return array the translation table as an array.
  260. */
  261. function get_html_translation_table ($table = null, $quote_style = null) {}
  262. /**
  263. * Calculate the sha1 hash of a string
  264. * @link http://www.php.net/manual/en/function.sha1.php
  265. * @param str string <p>
  266. * The input string.
  267. * </p>
  268. * @param raw_output bool[optional] <p>
  269. * If the optional raw_output is set to true,
  270. * then the sha1 digest is instead returned in raw binary format with a
  271. * length of 20, otherwise the returned value is a 40-character
  272. * hexadecimal number.
  273. * </p>
  274. * @return string the sha1 hash as a string.
  275. */
  276. function sha1 ($str, $raw_output = null) {}
  277. /**
  278. * Calculate the sha1 hash of a file
  279. * @link http://www.php.net/manual/en/function.sha1-file.php
  280. * @param filename string <p>
  281. * The filename of the file to hash.
  282. * </p>
  283. * @param raw_output bool[optional] <p>
  284. * When true, returns the digest in raw binary format with a length of
  285. * 20.
  286. * </p>
  287. * @return string a string on success, false otherwise.
  288. */
  289. function sha1_file ($filename, $raw_output = null) {}
  290. /**
  291. * Calculate the md5 hash of a string
  292. * @link http://www.php.net/manual/en/function.md5.php
  293. * @param str string <p>
  294. * The string.
  295. * </p>
  296. * @param raw_output bool[optional] <p>
  297. * If the optional raw_output is set to true,
  298. * then the md5 digest is instead returned in raw binary format with a
  299. * length of 16.
  300. * </p>
  301. * @return string the hash as a 32-character hexadecimal number.
  302. */
  303. function md5 ($str, $raw_output = null) {}
  304. /**
  305. * Calculates the md5 hash of a given file
  306. * @link http://www.php.net/manual/en/function.md5-file.php
  307. * @param filename string <p>
  308. * The filename
  309. * </p>
  310. * @param raw_output bool[optional] <p>
  311. * When true, returns the digest in raw binary format with a length of
  312. * 16.
  313. * </p>
  314. * @return string a string on success, false otherwise.
  315. */
  316. function md5_file ($filename, $raw_output = null) {}
  317. /**
  318. * Calculates the crc32 polynomial of a string
  319. * @link http://www.php.net/manual/en/function.crc32.php
  320. * @param str string <p>
  321. * The data.
  322. * </p>
  323. * @return int the crc32 checksum of str as an integer.
  324. */
  325. function crc32 ($str) {}
  326. /**
  327. * Parse a binary IPTC block into single tags.
  328. * @link http://www.php.net/manual/en/function.iptcparse.php
  329. * @param iptcblock string <p>
  330. * A binary IPTC block.
  331. * </p>
  332. * @return array an array using the tagmarker as an index and the value as the
  333. * value. It returns false on error or if no IPTC data was found.
  334. */
  335. function iptcparse ($iptcblock) {}
  336. /**
  337. * Embeds binary IPTC data into a JPEG image
  338. * @link http://www.php.net/manual/en/function.iptcembed.php
  339. * @param iptcdata string <p>
  340. * The data to be written.
  341. * </p>
  342. * @param jpeg_file_name string <p>
  343. * Path to the JPEG image.
  344. * </p>
  345. * @param spool int[optional] <p>
  346. * Spool flag. If the spool flag is over 2 then the JPEG will be
  347. * returned as a string.
  348. * </p>
  349. * @return mixed If success and spool flag is lower than 2 then the JPEG will not be
  350. * returned as a string, false on errors.
  351. */
  352. function iptcembed ($iptcdata, $jpeg_file_name, $spool = null) {}
  353. /**
  354. * Get the size of an image
  355. * @link http://www.php.net/manual/en/function.getimagesize.php
  356. * @param filename string <p>
  357. * This parameter specifies the file you wish to retrieve information
  358. * about. It can reference a local file or (configuration permitting) a
  359. * remote file using one of the supported streams.
  360. * </p>
  361. * @param imageinfo array[optional] <p>
  362. * This optional parameter allows you to extract some extended
  363. * information from the image file. Currently, this will return the
  364. * different JPG APP markers as an associative array.
  365. * Some programs use these APP markers to embed text information in
  366. * images. A very common one is to embed
  367. * IPTC information in the APP13 marker.
  368. * You can use the iptcparse function to parse the
  369. * binary APP13 marker into something readable.
  370. * </p>
  371. * @return array an array with 7 elements.
  372. * </p>
  373. * <p>
  374. * Index 0 and 1 contains respectively the width and the height of the image.
  375. * </p>
  376. * <p>
  377. * Some formats may contain no image or may contain multiple images. In these
  378. * cases, getimagesize might not be able to properly
  379. * determine the image size. getimagesize will return
  380. * zero for width and height in these cases.
  381. * </p>
  382. * <p>
  383. * Index 2 is one of the IMAGETYPE_XXX constants indicating
  384. * the type of the image.
  385. * </p>
  386. * <p>
  387. * Index 3 is a text string with the correct
  388. * height="yyy" width="xxx" string that can be used
  389. * directly in an IMG tag.
  390. * </p>
  391. * <p>
  392. * mime is the correspondant MIME type of the image.
  393. * This information can be used to deliver images with correct the HTTP
  394. * Content-type header:
  395. * getimagesize and MIME types
  396. * ]]>
  397. * </p>
  398. * <p>
  399. * channels will be 3 for RGB pictures and 4 for CMYK
  400. * pictures.
  401. * </p>
  402. * <p>
  403. * bits is the number of bits for each color.
  404. * </p>
  405. * <p>
  406. * For some image types, the presence of channels and
  407. * bits values can be a bit
  408. * confusing. As an example, GIF always uses 3 channels
  409. * per pixel, but the number of bits per pixel cannot be calculated for an
  410. * animated GIF with a global color table.
  411. * </p>
  412. * <p>
  413. * On failure, false is returned.
  414. */
  415. function getimagesize ($filename, array &$imageinfo = null) {}
  416. /**
  417. * Get Mime-Type for image-type returned by getimagesize,
  418. exif_read_data, exif_thumbnail, exif_imagetype
  419. * @link http://www.php.net/manual/en/function.image-type-to-mime-type.php
  420. * @param imagetype int <p>
  421. * One of the IMAGETYPE_XXX constants.
  422. * </p>
  423. * @return string The returned values are as follows
  424. * <table>
  425. * Returned values Constants
  426. * <tr valign="top">
  427. * <td>imagetype</td>
  428. * <td>Returned value</td>
  429. * </tr>
  430. * <tr valign="top">
  431. * <td>IMAGETYPE_GIF</td>
  432. * <td>image/gif</td>
  433. * </tr>
  434. * <tr valign="top">
  435. * <td>IMAGETYPE_JPEG</td>
  436. * <td>image/jpeg</td>
  437. * </tr>
  438. * <tr valign="top">
  439. * <td>IMAGETYPE_PNG</td>
  440. * <td>image/png</td>
  441. * </tr>
  442. * <tr valign="top">
  443. * <td>IMAGETYPE_SWF</td>
  444. * <td>application/x-shockwave-flash</td>
  445. * </tr>
  446. * <tr valign="top">
  447. * <td>IMAGETYPE_PSD</td>
  448. * <td>image/psd</td>
  449. * </tr>
  450. * <tr valign="top">
  451. * <td>IMAGETYPE_BMP</td>
  452. * <td>image/bmp</td>
  453. * </tr>
  454. * <tr valign="top">
  455. * <td>IMAGETYPE_TIFF_II (intel byte order)</td>
  456. * <td>image/tiff</td>
  457. * </tr>
  458. * <tr valign="top">
  459. * <td>
  460. * IMAGETYPE_TIFF_MM (motorola byte order)
  461. * </td>
  462. * <td>image/tiff</td>
  463. * </tr>
  464. * <tr valign="top">
  465. * <td>IMAGETYPE_JPC</td>
  466. * <td>application/octet-stream</td>
  467. * </tr>
  468. * <tr valign="top">
  469. * <td>IMAGETYPE_JP2</td>
  470. * <td>image/jp2</td>
  471. * </tr>
  472. * <tr valign="top">
  473. * <td>IMAGETYPE_JPX</td>
  474. * <td>application/octet-stream</td>
  475. * </tr>
  476. * <tr valign="top">
  477. * <td>IMAGETYPE_JB2</td>
  478. * <td>application/octet-stream</td>
  479. * </tr>
  480. * <tr valign="top">
  481. * <td>IMAGETYPE_SWC</td>
  482. * <td>application/x-shockwave-flash</td>
  483. * </tr>
  484. * <tr valign="top">
  485. * <td>IMAGETYPE_IFF</td>
  486. * <td>image/iff</td>
  487. * </tr>
  488. * <tr valign="top">
  489. * <td>IMAGETYPE_WBMP</td>
  490. * <td>image/vnd.wap.wbmp</td>
  491. * </tr>
  492. * <tr valign="top">
  493. * <td>IMAGETYPE_XBM</td>
  494. * <td>image/xbm</td>
  495. * </tr>
  496. * <tr valign="top">
  497. * <td>IMAGETYPE_ICO</td>
  498. * <td>image/vnd.microsoft.icon</td>
  499. * </tr>
  500. * </table>
  501. */
  502. function image_type_to_mime_type ($imagetype) {}
  503. /**
  504. * Get file extension for image type
  505. * @link http://www.php.net/manual/en/function.image-type-to-extension.php
  506. * @param imagetype int <p>
  507. * One of the IMAGETYPE_XXX constant.
  508. * </p>
  509. * @param include_dot bool[optional] <p>
  510. * Whether to prepend a dot to the extension or not. Default to true.
  511. * </p>
  512. * @return string A string with the extension corresponding to the given image type.
  513. */
  514. function image_type_to_extension ($imagetype, $include_dot = null) {}
  515. /**
  516. * Outputs lots of PHP information
  517. * @link http://www.php.net/manual/en/function.phpinfo.php
  518. * @param what int[optional] <p>
  519. * The output may be customized by passing one or more of the
  520. * following constants bitwise values summed
  521. * together in the optional what parameter.
  522. * One can also combine the respective constants or bitwise values
  523. * together with the or operator.
  524. * </p>
  525. * <p>
  526. * <table>
  527. * phpinfo options
  528. * <tr valign="top">
  529. * <td>Name (constant)</td>
  530. * <td>Value</td>
  531. * <td>Description</td>
  532. * </tr>
  533. * <tr valign="top">
  534. * <td>INFO_GENERAL</td>
  535. * <td>1</td>
  536. * <td>
  537. * The configuration line, &php.ini; location, build date, Web
  538. * Server, System and more.
  539. * </td>
  540. * </tr>
  541. * <tr valign="top">
  542. * <td>INFO_CREDITS</td>
  543. * <td>2</td>
  544. * <td>
  545. * PHP Credits. See also phpcredits.
  546. * </td>
  547. * </tr>
  548. * <tr valign="top">
  549. * <td>INFO_CONFIGURATION</td>
  550. * <td>4</td>
  551. * <td>
  552. * Current Local and Master values for PHP directives. See
  553. * also ini_get.
  554. * </td>
  555. * </tr>
  556. * <tr valign="top">
  557. * <td>INFO_MODULES</td>
  558. * <td>8</td>
  559. * <td>
  560. * Loaded modules and their respective settings. See also
  561. * get_loaded_extensions.
  562. * </td>
  563. * </tr>
  564. * <tr valign="top">
  565. * <td>INFO_ENVIRONMENT</td>
  566. * <td>16</td>
  567. * <td>
  568. * Environment Variable information that's also available in
  569. * $_ENV.
  570. * </td>
  571. * </tr>
  572. * <tr valign="top">
  573. * <td>INFO_VARIABLES</td>
  574. * <td>32</td>
  575. * <td>
  576. * Shows all
  577. * predefined variables from EGPCS (Environment, GET,
  578. * POST, Cookie, Server).
  579. * </td>
  580. * </tr>
  581. * <tr valign="top">
  582. * <td>INFO_LICENSE</td>
  583. * <td>64</td>
  584. * <td>
  585. * PHP License information. See also the license FAQ.
  586. * </td>
  587. * </tr>
  588. * <tr valign="top">
  589. * <td>INFO_ALL</td>
  590. * <td>-1</td>
  591. * <td>
  592. * Shows all of the above.
  593. * </td>
  594. * </tr>
  595. * </table>
  596. * </p>
  597. * @return bool Returns true on success or false on failure.
  598. */
  599. function phpinfo ($what = null) {}
  600. /**
  601. * Gets the current PHP version
  602. * @link http://www.php.net/manual/en/function.phpversion.php
  603. * @param extension string[optional] <p>
  604. * An optional extension name.
  605. * </p>
  606. * @return string If the optional extension parameter is
  607. * specified, phpversion returns the version of that
  608. * extension, or false if there is no version information associated or
  609. * the extension isn't enabled.
  610. */
  611. function phpversion ($extension = null) {}
  612. /**
  613. * Prints out the credits for PHP
  614. * @link http://www.php.net/manual/en/function.phpcredits.php
  615. * @param flag int[optional] <p>
  616. * To generate a custom credits page, you may want to use the
  617. * flag parameter.
  618. * </p>
  619. * <p>
  620. * <table>
  621. * Pre-defined phpcredits flags
  622. * <tr valign="top">
  623. * <td>name</td>
  624. * <td>description</td>
  625. * </tr>
  626. * <tr valign="top">
  627. * <td>CREDITS_ALL</td>
  628. * <td>
  629. * All the credits, equivalent to using: CREDITS_DOCS +
  630. * CREDITS_GENERAL + CREDITS_GROUP +
  631. * CREDITS_MODULES + CREDITS_FULLPAGE.
  632. * It generates a complete stand-alone HTML page with the appropriate tags.
  633. * </td>
  634. * </tr>
  635. * <tr valign="top">
  636. * <td>CREDITS_DOCS</td>
  637. * <td>The credits for the documentation team</td>
  638. * </tr>
  639. * <tr valign="top">
  640. * <td>CREDITS_FULLPAGE</td>
  641. * <td>
  642. * Usually used in combination with the other flags. Indicates
  643. * that a complete stand-alone HTML page needs to be
  644. * printed including the information indicated by the other
  645. * flags.
  646. * </td>
  647. * </tr>
  648. * <tr valign="top">
  649. * <td>CREDITS_GENERAL</td>
  650. * <td>
  651. * General credits: Language design and concept, PHP 4.0
  652. * authors and SAPI module.
  653. * </td>
  654. * </tr>
  655. * <tr valign="top">
  656. * <td>CREDITS_GROUP</td>
  657. * <td>A list of the core developers</td>
  658. * </tr>
  659. * <tr valign="top">
  660. * <td>CREDITS_MODULES</td>
  661. * <td>
  662. * A list of the extension modules for PHP, and their authors
  663. * </td>
  664. * </tr>
  665. * <tr valign="top">
  666. * <td>CREDITS_SAPI</td>
  667. * <td>
  668. * A list of the server API modules for PHP, and their authors
  669. * </td>
  670. * </tr>
  671. * </table>
  672. * </p>
  673. * @return bool Returns true on success or false on failure.
  674. */
  675. function phpcredits ($flag = null) {}
  676. /**
  677. * Gets the logo guid
  678. * @link http://www.php.net/manual/en/function.php-logo-guid.php
  679. * @return string PHPE9568F34-D428-11d2-A769-00AA001ACF42.
  680. */
  681. function php_logo_guid () {}
  682. function php_real_logo_guid () {}
  683. function php_egg_logo_guid () {}
  684. /**
  685. * Gets the Zend guid
  686. * @link http://www.php.net/manual/en/function.zend-logo-guid.php
  687. * @return string PHPE9568F35-D428-11d2-A769-00AA001ACF42.
  688. */
  689. function zend_logo_guid () {}
  690. /**
  691. * Returns the type of interface between web server and PHP
  692. * @link http://www.php.net/manual/en/function.php-sapi-name.php
  693. * @return string the interface type, as a lowercase string.
  694. * </p>
  695. * <p>
  696. * Although not exhaustive, the possible return values include
  697. * aolserver, apache,
  698. * apache2filter, apache2handler,
  699. * caudium, cgi (until PHP 5.3),
  700. * cgi-fcgi, cli,
  701. * continuity, embed,
  702. * isapi, litespeed,
  703. * milter, nsapi,
  704. * phttpd, pi3web, roxen,
  705. * thttpd, tux, and webjames.
  706. */
  707. function php_sapi_name () {}
  708. /**
  709. * Returns information about the operating system PHP is running on
  710. * @link http://www.php.net/manual/en/function.php-uname.php
  711. * @param mode string[optional] <p>
  712. * mode is a single character that defines what
  713. * information is returned:
  714. * 'a': This is the default. Contains all modes in
  715. * the sequence "s n r v m".
  716. * @return string the description, as a string.
  717. */
  718. function php_uname ($mode = null) {}
  719. /**
  720. * Return a list of .ini files parsed from the additional ini dir
  721. * @link http://www.php.net/manual/en/function.php-ini-scanned-files.php
  722. * @return string a comma-separated string of .ini files on success. Each comma is
  723. * followed by a newline. If the directive --with-config-file-scan-dir wasn't set,
  724. * false is returned. If it was set and the directory was empty, an
  725. * empty string is returned. If a file is unrecognizable, the file will
  726. * still make it into the returned string but a PHP error will also result.
  727. * This PHP error will be seen both at compile time and while using
  728. * php_ini_scanned_files.
  729. */
  730. function php_ini_scanned_files () {}
  731. /**
  732. * Retrieve a path to the loaded php.ini file
  733. * @link http://www.php.net/manual/en/function.php-ini-loaded-file.php
  734. * @return string The loaded &php.ini; path, or false if one is not loaded.
  735. */
  736. function php_ini_loaded_file () {}
  737. /**
  738. * String comparisons using a "natural order" algorithm
  739. * @link http://www.php.net/manual/en/function.strnatcmp.php
  740. * @param str1 string <p>
  741. * The first string.
  742. * </p>
  743. * @param str2 string <p>
  744. * The second string.
  745. * </p>
  746. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  747. * str1 is less than str2; &gt;
  748. * 0 if str1 is greater than
  749. * str2, and 0 if they are equal.
  750. */
  751. function strnatcmp ($str1, $str2) {}
  752. /**
  753. * Case insensitive string comparisons using a "natural order" algorithm
  754. * @link http://www.php.net/manual/en/function.strnatcasecmp.php
  755. * @param str1 string <p>
  756. * The first string.
  757. * </p>
  758. * @param str2 string <p>
  759. * The second string.
  760. * </p>
  761. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  762. * str1 is less than str2 &gt;
  763. * 0 if str1 is greater than
  764. * str2, and 0 if they are equal.
  765. */
  766. function strnatcasecmp ($str1, $str2) {}
  767. /**
  768. * Count the number of substring occurrences
  769. * @link http://www.php.net/manual/en/function.substr-count.php
  770. * @param haystack string <p>
  771. * The string to search in
  772. * </p>
  773. * @param needle string <p>
  774. * The substring to search for
  775. * </p>
  776. * @param offset int[optional] <p>
  777. * The offset where to start counting
  778. * </p>
  779. * @param length int[optional] <p>
  780. * The maximum length after the specified offset to search for the
  781. * substring. It outputs a warning if the offset plus the length is
  782. * greater than the haystack length.
  783. * </p>
  784. * @return int This functions returns an integer.
  785. */
  786. function substr_count ($haystack, $needle, $offset = null, $length = null) {}
  787. /**
  788. * Finds the length of the first segment of a string consisting
  789. entirely of characters contained within a given mask.
  790. * @link http://www.php.net/manual/en/function.strspn.php
  791. * @param subject string <p>
  792. * The string to examine.
  793. * </p>
  794. * @param mask string <p>
  795. * The list of allowable characters to include in counted segments.
  796. * </p>
  797. * @param start int[optional] <p>
  798. * The position in subject to
  799. * start searching.
  800. * </p>
  801. * <p>
  802. * If start is given and is non-negative,
  803. * then strspn will begin
  804. * examining subject at
  805. * the start'th position. For instance, in
  806. * the string 'abcdef', the character at
  807. * position 0 is 'a', the
  808. * character at position 2 is
  809. * 'c', and so forth.
  810. * </p>
  811. * <p>
  812. * If start is given and is negative,
  813. * then strspn will begin
  814. * examining subject at
  815. * the start'th position from the end
  816. * of subject.
  817. * </p>
  818. * @param length int[optional] <p>
  819. * The length of the segment from subject
  820. * to examine.
  821. * </p>
  822. * <p>
  823. * If length is given and is non-negative,
  824. * then subject will be examined
  825. * for length characters after the starting
  826. * position.
  827. * </p>
  828. * <p>
  829. * If lengthis given and is negative,
  830. * then subject will be examined from the
  831. * starting position up to length
  832. * characters from the end of subject.
  833. * </p>
  834. * @return int the length of the initial segment of str1
  835. * which consists entirely of characters in str2.
  836. */
  837. function strspn ($subject, $mask, $start = null, $length = null) {}
  838. /**
  839. * Find length of initial segment not matching mask
  840. * @link http://www.php.net/manual/en/function.strcspn.php
  841. * @param str1 string <p>
  842. * The first string.
  843. * </p>
  844. * @param str2 string <p>
  845. * The second string.
  846. * </p>
  847. * @param start int[optional] <p>
  848. * The start position of the string to examine.
  849. * </p>
  850. * @param length int[optional] <p>
  851. * The length of the string to examine.
  852. * </p>
  853. * @return int the length of the segment as an integer.
  854. */
  855. function strcspn ($str1, $str2, $start = null, $length = null) {}
  856. /**
  857. * Tokenize string
  858. * @link http://www.php.net/manual/en/function.strtok.php
  859. * @param str string <p>
  860. * The string being split up into smaller strings (tokens).
  861. * </p>
  862. * @param token string <p>
  863. * The delimiter used when splitting up str.
  864. * </p>
  865. * @return string A string token.
  866. */
  867. function strtok ($str, $token) {}
  868. /**
  869. * Make a string uppercase
  870. * @link http://www.php.net/manual/en/function.strtoupper.php
  871. * @param string string <p>
  872. * The input string.
  873. * </p>
  874. * @return string the uppercased string.
  875. */
  876. function strtoupper ($string) {}
  877. /**
  878. * Make a string lowercase
  879. * @link http://www.php.net/manual/en/function.strtolower.php
  880. * @param str string <p>
  881. * The input string.
  882. * </p>
  883. * @return string the lowercased string.
  884. */
  885. function strtolower ($str) {}
  886. /**
  887. * Find position of first occurrence of a string
  888. * @link http://www.php.net/manual/en/function.strpos.php
  889. * @param haystack string <p>
  890. * The string to search in
  891. * </p>
  892. * @param needle mixed <p>
  893. * If needle is not a string, it is converted
  894. * to an integer and applied as the ordinal value of a character.
  895. * </p>
  896. * @param offset int[optional] <p>
  897. * The optional offset parameter allows you
  898. * to specify which character in haystack to
  899. * start searching. The position returned is still relative to the
  900. * beginning of haystack.
  901. * </p>
  902. * @return int the position as an integer. If needle is
  903. * not found, strpos will return boolean
  904. * false.
  905. */
  906. function strpos ($haystack, $needle, $offset = null) {}
  907. /**
  908. * Find position of first occurrence of a case-insensitive string
  909. * @link http://www.php.net/manual/en/function.stripos.php
  910. * @param haystack string <p>
  911. * The string to search in
  912. * </p>
  913. * @param needle string <p>
  914. * Note that the needle may be a string of one or
  915. * more characters.
  916. * </p>
  917. * <p>
  918. * If needle is not a string, it is converted to
  919. * an integer and applied as the ordinal value of a character.
  920. * </p>
  921. * @param offset int[optional] <p>
  922. * The optional offset parameter allows you
  923. * to specify which character in haystack to
  924. * start searching. The position returned is still relative to the
  925. * beginning of haystack.
  926. * </p>
  927. * @return int If needle is not found,
  928. * stripos will return boolean false.
  929. */
  930. function stripos ($haystack, $needle, $offset = null) {}
  931. /**
  932. * Find position of last occurrence of a char in a string
  933. * @link http://www.php.net/manual/en/function.strrpos.php
  934. * @param haystack string <p>
  935. * The string to search in.
  936. * </p>
  937. * @param needle string <p>
  938. * If needle is not a string, it is converted
  939. * to an integer and applied as the ordinal value of a character.
  940. * </p>
  941. * @param offset int[optional] <p>
  942. * May be specified to begin searching an arbitrary number of characters into
  943. * the string. Negative values will stop searching at an arbitrary point
  944. * prior to the end of the string.
  945. * </p>
  946. * @return int the position where the needle exists. Returns false if the needle
  947. * was not found.
  948. */
  949. function strrpos ($haystack, $needle, $offset = null) {}
  950. /**
  951. * Find position of last occurrence of a case-insensitive string in a string
  952. * @link http://www.php.net/manual/en/function.strripos.php
  953. * @param haystack string <p>
  954. * The string to search in
  955. * </p>
  956. * @param needle string <p>
  957. * Note that the needle may be a string of one or
  958. * more characters.
  959. * </p>
  960. * @param offset int[optional] <p>
  961. * The offset parameter may be specified to begin
  962. * searching an arbitrary number of characters into the string.
  963. * </p>
  964. * <p>
  965. * Negative offset values will start the search at
  966. * offset characters from the
  967. * start of the string.
  968. * </p>
  969. * @return int the numerical position of the last occurrence of
  970. * needle. Also note that string positions start at 0,
  971. * and not 1.
  972. * </p>
  973. * <p>
  974. * If needle is not found, false is returned.
  975. */
  976. function strripos ($haystack, $needle, $offset = null) {}
  977. /**
  978. * Reverse a string
  979. * @link http://www.php.net/manual/en/function.strrev.php
  980. * @param string string <p>
  981. * The string to be reversed.
  982. * </p>
  983. * @return string the reversed string.
  984. */
  985. function strrev ($string) {}
  986. /**
  987. * Convert logical Hebrew text to visual text
  988. * @link http://www.php.net/manual/en/function.hebrev.php
  989. * @param hebrew_text string <p>
  990. * A Hebrew input string.
  991. * </p>
  992. * @param max_chars_per_line int[optional] <p>
  993. * This optional parameter indicates maximum number of characters per
  994. * line that will be returned.
  995. * </p>
  996. * @return string the visual string.
  997. */
  998. function hebrev ($hebrew_text, $max_chars_per_line = null) {}
  999. /**
  1000. * Convert logical Hebrew text to visual text with newline conversion
  1001. * @link http://www.php.net/manual/en/function.hebrevc.php
  1002. * @param hebrew_text string <p>
  1003. * A Hebrew input string.
  1004. * </p>
  1005. * @param max_chars_per_line int[optional] <p>
  1006. * This optional parameter indicates maximum number of characters per
  1007. * line that will be returned.
  1008. * </p>
  1009. * @return string the visual string.
  1010. */
  1011. function hebrevc ($hebrew_text, $max_chars_per_line = null) {}
  1012. /**
  1013. * Inserts HTML line breaks before all newlines in a string
  1014. * @link http://www.php.net/manual/en/function.nl2br.php
  1015. * @param string string <p>
  1016. * The input string.
  1017. * </p>
  1018. * @param is_xhtml bool[optional] <p>
  1019. * Whenever to use XHTML compatible line breaks or not.
  1020. * </p>
  1021. * @return string the altered string.
  1022. */
  1023. function nl2br ($string, $is_xhtml = null) {}
  1024. /**
  1025. * Returns filename component of path
  1026. * @link http://www.php.net/manual/en/function.basename.php
  1027. * @param path string <p>
  1028. * A path.
  1029. * </p>
  1030. * <p>
  1031. * On Windows, both slash (/) and backslash
  1032. * (\) are used as directory separator character. In
  1033. * other environments, it is the forward slash (/).
  1034. * </p>
  1035. * @param suffix string[optional] <p>
  1036. * If the filename ends in suffix this will also
  1037. * be cut off.
  1038. * </p>
  1039. * @return string the base name of the given path.
  1040. */
  1041. function basename ($path, $suffix = null) {}
  1042. /**
  1043. * Returns directory name component of path
  1044. * @link http://www.php.net/manual/en/function.dirname.php
  1045. * @param path string <p>
  1046. * A path.
  1047. * </p>
  1048. * <p>
  1049. * On Windows, both slash (/) and backslash
  1050. * (\) are used as directory separator character. In
  1051. * other environments, it is the forward slash (/).
  1052. * </p>
  1053. * @return string the name of the directory. If there are no slashes in
  1054. * path, a dot ('.') is returned,
  1055. * indicating the current directory. Otherwise, the returned string is
  1056. * path with any trailing
  1057. * /component removed.
  1058. */
  1059. function dirname ($path) {}
  1060. /**
  1061. * Returns information about a file path
  1062. * @link http://www.php.net/manual/en/function.pathinfo.php
  1063. * @param path string <p>
  1064. * The path being checked.
  1065. * </p>
  1066. * @param options int[optional] <p>
  1067. * You can specify which elements are returned with optional parameter
  1068. * options. It composes from
  1069. * PATHINFO_DIRNAME,
  1070. * PATHINFO_BASENAME,
  1071. * PATHINFO_EXTENSION and
  1072. * PATHINFO_FILENAME. It
  1073. * defaults to return all elements.
  1074. * </p>
  1075. * @return mixed The following associative array elements are returned:
  1076. * dirname, basename,
  1077. * extension (if any), and filename.
  1078. * </p>
  1079. * <p>
  1080. * If options is used, this function will return a
  1081. * string if not all elements are requested.
  1082. */
  1083. function pathinfo ($path, $options = null) {}
  1084. /**
  1085. * Un-quotes a quoted string
  1086. * @link http://www.php.net/manual/en/function.stripslashes.php
  1087. * @param str string <p>
  1088. * The input string.
  1089. * </p>
  1090. * @return string a string with backslashes stripped off.
  1091. * (\' becomes ' and so on.)
  1092. * Double backslashes (\\) are made into a single
  1093. * backslash (\).
  1094. */
  1095. function stripslashes ($str) {}
  1096. /**
  1097. * Un-quote string quoted with <function>addcslashes</function>
  1098. * @link http://www.php.net/manual/en/function.stripcslashes.php
  1099. * @param str string <p>
  1100. * The string to be unescaped.
  1101. * </p>
  1102. * @return string the unescaped string.
  1103. */
  1104. function stripcslashes ($str) {}
  1105. /**
  1106. * Find first occurrence of a string
  1107. * @link http://www.php.net/manual/en/function.strstr.php
  1108. * @param haystack string <p>
  1109. * The input string.
  1110. * </p>
  1111. * @param needle mixed <p>
  1112. * If needle is not a string, it is converted to
  1113. * an integer and applied as the ordinal value of a character.
  1114. * </p>
  1115. * @param before_needle bool[optional] <p>
  1116. * If true, strstr returns
  1117. * the part of the haystack before the first
  1118. * occurrence of the needle.
  1119. * </p>
  1120. * @return string the portion of string, or false if needle
  1121. * is not found.
  1122. */
  1123. function strstr ($haystack, $needle, $before_needle = null) {}
  1124. /**
  1125. * Case-insensitive <function>strstr</function>
  1126. * @link http://www.php.net/manual/en/function.stristr.php
  1127. * @param haystack string <p>
  1128. * The string to search in
  1129. * </p>
  1130. * @param needle mixed <p>
  1131. * If needle is not a string, it is converted to
  1132. * an integer and applied as the ordinal value of a character.
  1133. * </p>
  1134. * @param before_needle bool[optional] <p>
  1135. * If true, stristr
  1136. * returns the part of the haystack before the
  1137. * first occurrence of the needle.
  1138. * </p>
  1139. * @return string the matched substring. If needle is not
  1140. * found, returns false.
  1141. */
  1142. function stristr ($haystack, $needle, $before_needle = null) {}
  1143. /**
  1144. * Find the last occurrence of a character in a string
  1145. * @link http://www.php.net/manual/en/function.strrchr.php
  1146. * @param haystack string <p>
  1147. * The string to search in
  1148. * </p>
  1149. * @param needle mixed <p>
  1150. * If needle contains more than one character,
  1151. * only the first is used. This behavior is different from that of
  1152. * strstr.
  1153. * </p>
  1154. * <p>
  1155. * If needle is not a string, it is converted to
  1156. * an integer and applied as the ordinal value of a character.
  1157. * </p>
  1158. * @return string This function returns the portion of string, or false if
  1159. * needle is not found.
  1160. */
  1161. function strrchr ($haystack, $needle) {}
  1162. /**
  1163. * Randomly shuffles a string
  1164. * @link http://www.php.net/manual/en/function.str-shuffle.php
  1165. * @param str string <p>
  1166. * The input string.
  1167. * </p>
  1168. * @return string the shuffled string.
  1169. */
  1170. function str_shuffle ($str) {}
  1171. /**
  1172. * Return information about words used in a string
  1173. * @link http://www.php.net/manual/en/function.str-word-count.php
  1174. * @param string string <p>
  1175. * The string
  1176. * </p>
  1177. * @param format int[optional] <p>
  1178. * Specify the return value of this function. The current supported values
  1179. * are:
  1180. * 0 - returns the number of words found
  1181. * @param charlist string[optional] <p>
  1182. * A list of additional characters which will be considered as 'word'
  1183. * </p>
  1184. * @return mixed an array or an integer, depending on the
  1185. * format chosen.
  1186. */
  1187. function str_word_count ($string, $format = null, $charlist = null) {}
  1188. /**
  1189. * Convert a string to an array
  1190. * @link http://www.php.net/manual/en/function.str-split.php
  1191. * @param string string <p>
  1192. * The input string.
  1193. * </p>
  1194. * @param split_length int[optional] <p>
  1195. * Maximum length of the chunk.
  1196. * </p>
  1197. * @return array If the optional split_length parameter is
  1198. * specified, the returned array will be broken down into chunks with each
  1199. * being split_length in length, otherwise each chunk
  1200. * will be one character in length.
  1201. * </p>
  1202. * <p>
  1203. * false is returned if split_length is less than 1.
  1204. * If the split_length length exceeds the length of
  1205. * string, the entire string is returned as the first
  1206. * (and only) array element.
  1207. */
  1208. function str_split ($string, $split_length = null) {}
  1209. /**
  1210. * Search a string for any of a set of characters
  1211. * @link http://www.php.net/manual/en/function.strpbrk.php
  1212. * @param haystack string <p>
  1213. * The string where char_list is looked for.
  1214. * </p>
  1215. * @param char_list string <p>
  1216. * This parameter is case sensitive.
  1217. * </p>
  1218. * @return string a string starting from the character found, or false if it is
  1219. * not found.
  1220. */
  1221. function strpbrk ($haystack, $char_list) {}
  1222. /**
  1223. * Binary safe comparison of 2 strings from an offset, up to length characters
  1224. * @link http://www.php.net/manual/en/function.substr-compare.php
  1225. * @param main_str string <p>
  1226. * The main string being compared.
  1227. * </p>
  1228. * @param str string <p>
  1229. * The secondary string being compared.
  1230. * </p>
  1231. * @param offset int <p>
  1232. * The start position for the comparison. If negative, it starts counting
  1233. * from the end of the string.
  1234. * </p>
  1235. * @param length int[optional] <p>
  1236. * The length of the comparison. The default value is the largest of the
  1237. * length of the str compared to the length of
  1238. * main_str less the
  1239. * offset.
  1240. * </p>
  1241. * @param case_insensitivity bool[optional] <p>
  1242. * If case_insensitivity is true, comparison is
  1243. * case insensitive.
  1244. * </p>
  1245. * @return int &lt; 0 if main_str from position
  1246. * offset is less than str, &gt;
  1247. * 0 if it is greater than str, and 0 if they are equal.
  1248. * If offset is equal to or greater than the length of
  1249. * main_str or length is set and
  1250. * is less than 1, substr_compare prints a warning and returns
  1251. * false.
  1252. */
  1253. function substr_compare ($main_str, $str, $offset, $length = null, $case_insensitivity = null) {}
  1254. /**
  1255. * Locale based string comparison
  1256. * @link http://www.php.net/manual/en/function.strcoll.php
  1257. * @param str1 string <p>
  1258. * The first string.
  1259. * </p>
  1260. * @param str2 string <p>
  1261. * The second string.
  1262. * </p>
  1263. * @return int &lt; 0 if str1 is less than
  1264. * str2; &gt; 0 if
  1265. * str1 is greater than
  1266. * str2, and 0 if they are equal.
  1267. */
  1268. function strcoll ($str1, $str2) {}
  1269. /**
  1270. * Return part of a string
  1271. * @link http://www.php.net/manual/en/function.substr.php
  1272. * @param string string <p>
  1273. * The input string.
  1274. * </p>
  1275. * @param start int <p>
  1276. * If start is non-negative, the returned string
  1277. * will start at the start'th position in
  1278. * string, counting from zero. For instance,
  1279. * in the string 'abcdef', the character at
  1280. * position 0 is 'a', the
  1281. * character at position 2 is
  1282. * 'c', and so forth.
  1283. * </p>
  1284. * <p>
  1285. * If start is negative, the returned string
  1286. * will start at the start'th character
  1287. * from the end of string.
  1288. * </p>
  1289. * <p>
  1290. * If string is less than or equal to
  1291. * start characters long, false will be returned.
  1292. * </p>
  1293. * <p>
  1294. * Using a negative start
  1295. * ]]>
  1296. * </p>
  1297. * @param length int[optional] <p>
  1298. * If length is given and is positive, the string
  1299. * returned will contain at most length characters
  1300. * beginning from start (depending on the length of
  1301. * string).
  1302. * </p>
  1303. * <p>
  1304. * If length is given and is negative, then that many
  1305. * characters will be omitted from the end of string
  1306. * (after the start position has been calculated when a
  1307. * start is negative). If
  1308. * start denotes a position beyond this truncation,
  1309. * an empty string will be returned.
  1310. * </p>
  1311. * <p>
  1312. * If length is given and is 0,
  1313. * false or &null; an empty string will be returned.
  1314. * </p>
  1315. * Using a negative length
  1316. * ]]>
  1317. * @return string the extracted part of string&return.falseforfailure;.
  1318. */
  1319. function substr ($string, $start, $length = null) {}
  1320. /**
  1321. * Replace text within a portion of a string
  1322. * @link http://www.php.net/manual/en/function.substr-replace.php
  1323. * @param string mixed <p>
  1324. * The input string.
  1325. * </p>
  1326. * @param replacement string <p>
  1327. * The replacement string.
  1328. * </p>
  1329. * @param start int <p>
  1330. * If start is positive, the replacing will
  1331. * begin at the start'th offset into
  1332. * string.
  1333. * </p>
  1334. * <p>
  1335. * If start is negative, the replacing will
  1336. * begin at the start'th character from the
  1337. * end of string.
  1338. * </p>
  1339. * @param length int[optional] <p>
  1340. * If given and is positive, it represents the length of the portion of
  1341. * string which is to be replaced. If it is
  1342. * negative, it represents the number of characters from the end of
  1343. * string at which to stop replacing. If it
  1344. * is not given, then it will default to strlen(
  1345. * string ); i.e. end the replacing at the
  1346. * end of string. Of course, if
  1347. * length is zero then this function will have the
  1348. * effect of inserting replacement into
  1349. * string at the given
  1350. * start offset.
  1351. * </p>
  1352. * @return mixed The result string is returned. If string is an
  1353. * array then array is returned.
  1354. */
  1355. function substr_replace ($string, $replacement, $start, $length = null) {}
  1356. /**
  1357. * Quote meta characters
  1358. * @link http://www.php.net/manual/en/function.quotemeta.php
  1359. * @param str string <p>
  1360. * The input string.
  1361. * </p>
  1362. * @return string the string with meta characters quoted.
  1363. */
  1364. function quotemeta ($str) {}
  1365. /**
  1366. * Make a string's first character uppercase
  1367. * @link http://www.php.net/manual/en/function.ucfirst.php
  1368. * @param str string <p>
  1369. * The input string.
  1370. * </p>
  1371. * @return string the resulting string.
  1372. */
  1373. function ucfirst ($str) {}
  1374. /**
  1375. * Uppercase the first character of each word in a string
  1376. * @link http://www.php.net/manual/en/function.ucwords.php
  1377. * @param str string <p>
  1378. * The input string.
  1379. * </p>
  1380. * @return string the modified string.
  1381. */
  1382. function ucwords ($str) {}
  1383. /**
  1384. * Translate certain characters
  1385. * @link http://www.php.net/manual/en/function.strtr.php
  1386. * @param str string <p>
  1387. * The string being translated.
  1388. * </p>
  1389. * @param from string <p>
  1390. * The string being translated to to.
  1391. * </p>
  1392. * @param to string <p>
  1393. * The string replacing from.
  1394. * </p>
  1395. * @return string This function returns a copy of str,
  1396. * translating all occurrences of each character in
  1397. * from to the corresponding character in
  1398. * to.
  1399. */
  1400. function strtr ($str, $from, $to) {}
  1401. /**
  1402. * Quote string with slashes
  1403. * @link http://www.php.net/manual/en/function.addslashes.php
  1404. * @param str string <p>
  1405. * The string to be escaped.
  1406. * </p>
  1407. * @return string the escaped string.
  1408. */
  1409. function addslashes ($str) {}
  1410. /**
  1411. * Quote string with slashes in a C style
  1412. * @link http://www.php.net/manual/en/function.addcslashes.php
  1413. * @param str string <p>
  1414. * The string to be escaped.
  1415. * </p>
  1416. * @param charlist string <p>
  1417. * A list of characters to be escaped. If
  1418. * charlist contains characters
  1419. * \n, \r etc., they are
  1420. * converted in C-like style, while other non-alphanumeric characters
  1421. * with ASCII codes lower than 32 and higher than 126 converted to
  1422. * octal representation.
  1423. * </p>
  1424. * <p>
  1425. * When you define a sequence of characters in the charlist argument
  1426. * make sure that you know what characters come between the
  1427. * characters that you set as the start and end of the range.
  1428. * ]]>
  1429. * Also, if the first character in a range has a higher ASCII value
  1430. * than the second character in the range, no range will be
  1431. * constructed. Only the start, end and period characters will be
  1432. * escaped. Use the ord function to find the
  1433. * ASCII value for a character.
  1434. * ]]>
  1435. * </p>
  1436. * <p>
  1437. * Be careful if you choose to escape characters 0, a, b, f, n, r,
  1438. * t and v. They will be converted to \0, \a, \b, \f, \n, \r, \t
  1439. * and \v.
  1440. * In PHP \0 (NULL), \r (carriage return), \n (newline), \f (form feed),
  1441. * \v (vertical tab) and \t (tab) are predefined escape sequences,
  1442. * while in C all of these are predefined escape sequences.
  1443. * </p>
  1444. * @return string the escaped string.
  1445. */
  1446. function addcslashes ($str, $charlist) {}
  1447. /**
  1448. * Strip whitespace (or other characters) from the end of a string
  1449. * @link http://www.php.net/manual/en/function.rtrim.php
  1450. * @param str string <p>
  1451. * The input string.
  1452. * </p>
  1453. * @param charlist string[optional] <p>
  1454. * You can also specify the characters you want to strip, by means
  1455. * of the charlist parameter.
  1456. * Simply list all characters that you want to be stripped. With
  1457. * .. you can specify a range of characters.
  1458. * </p>
  1459. * @return string the modified string.
  1460. */
  1461. function rtrim ($str, $charlist = null) {}
  1462. /**
  1463. * Replace all occurrences of the search string with the replacement string
  1464. * @link http://www.php.net/manual/en/function.str-replace.php
  1465. * @param search mixed <p>
  1466. * The value being searched for, otherwise known as the needle.
  1467. * An array may be used to designate multiple needles.
  1468. * </p>
  1469. * @param replace mixed <p>
  1470. * The replacement value that replaces found search
  1471. * values. An array may be used to designate multiple replacements.
  1472. * </p>
  1473. * @param subject mixed <p>
  1474. * The string or array being searched and replaced on,
  1475. * otherwise known as the haystack.
  1476. * </p>
  1477. * <p>
  1478. * If subject is an array, then the search and
  1479. * replace is performed with every entry of
  1480. * subject, and the return value is an array as
  1481. * well.
  1482. * </p>
  1483. * @param count int[optional] If passed, this will hold the number of matched and replaced needles.
  1484. * @return mixed This function returns a string or an array with the replaced values.
  1485. */
  1486. function str_replace ($search, $replace, $subject, &$count = null) {}
  1487. /**
  1488. * Case-insensitive version of <function>str_replace</function>.
  1489. * @link http://www.php.net/manual/en/function.str-ireplace.php
  1490. * @param search mixed <p>
  1491. * Every replacement with search array is
  1492. * performed on the result of previous replacement.
  1493. * </p>
  1494. * @param replace mixed <p>
  1495. * </p>
  1496. * @param subject mixed <p>
  1497. * If subject is an array, then the search and
  1498. * replace is performed with every entry of
  1499. * subject, and the return value is an array as
  1500. * well.
  1501. * </p>
  1502. * @param count int[optional] <p>
  1503. * The number of matched and replaced needles will
  1504. * be returned in count which is passed by
  1505. * reference.
  1506. * </p>
  1507. * @return mixed a string or an array of replacements.
  1508. */
  1509. function str_ireplace ($search, $replace, $subject, &$count = null) {}
  1510. /**
  1511. * Repeat a string
  1512. * @link http://www.php.net/manual/en/function.str-repeat.php
  1513. * @param input string <p>
  1514. * The string to be repeated.
  1515. * </p>
  1516. * @param multiplier int <p>
  1517. * Number of time the input string should be
  1518. * repeated.
  1519. * </p>
  1520. * <p>
  1521. * multiplier has to be greater than or equal to 0.
  1522. * If the multiplier is set to 0, the function
  1523. * will return an empty string.
  1524. * </p>
  1525. * @return string the repeated string.
  1526. */
  1527. function str_repeat ($input, $multiplier) {}
  1528. /**
  1529. * Return information about characters used in a string
  1530. * @link http://www.php.net/manual/en/function.count-chars.php
  1531. * @param string string <p>
  1532. * The examined string.
  1533. * </p>
  1534. * @param mode int[optional] <p>
  1535. * See return values.
  1536. * </p>
  1537. * @return mixed Depending on mode
  1538. * count_chars returns one of the following:
  1539. * 0 - an array with the byte-value as key and the frequency of
  1540. * every byte as value.
  1541. * 1 - same as 0 but only byte-values with a frequency greater
  1542. * than zero are listed.
  1543. * 2 - same as 0 but only byte-values with a frequency equal to
  1544. * zero are listed.
  1545. * 3 - a string containing all unique characters is returned.
  1546. * 4 - a string containing all not used characters is returned.
  1547. */
  1548. function count_chars ($string, $mode = null) {}
  1549. /**
  1550. * Split a string into smaller chunks
  1551. * @link http://www.php.net/manual/en/function.chunk-split.php
  1552. * @param body string <p>
  1553. * The string to be chunked.
  1554. * </p>
  1555. * @param chunklen int[optional] <p>
  1556. * The chunk length.
  1557. * </p>
  1558. * @param end string[optional] <p>
  1559. * The line ending sequence.
  1560. * </p>
  1561. * @return string the chunked string.
  1562. */
  1563. function chunk_split ($body, $chunklen = null, $end = null) {}
  1564. /**
  1565. * Strip whitespace (or other characters) from the beginning and end of a string
  1566. * @link http://www.php.net/manual/en/function.trim.php
  1567. * @param str string <p>
  1568. * The string that will be trimmed.
  1569. * </p>
  1570. * @param charlist string[optional] <p>
  1571. * Optionally, the stripped characters can also be specified using
  1572. * the charlist parameter.
  1573. * Simply list all characters that you want to be stripped. With
  1574. * .. you can specify a range of characters.
  1575. * </p>
  1576. * @return string The trimmed string.
  1577. */
  1578. function trim ($str, $charlist = null) {}
  1579. /**
  1580. * Strip whitespace (or other characters) from the beginning of a string
  1581. * @link http://www.php.net/manual/en/function.ltrim.php
  1582. * @param str string <p>
  1583. * The input string.
  1584. * </p>
  1585. * @param charlist string[optional] <p>
  1586. * You can also specify the characters you want to strip, by means of the
  1587. * charlist parameter.
  1588. * Simply list all characters that you want to be stripped. With
  1589. * .. you can specify a range of characters.
  1590. * </p>
  1591. * @return string This function returns a string with whitespace stripped from the
  1592. * beginning of str.
  1593. * Without the second parameter,
  1594. * ltrim will strip these characters:
  1595. * " " (ASCII 32
  1596. * (0x20)), an ordinary space.
  1597. * "\t" (ASCII 9
  1598. * (0x09)), a tab.
  1599. * "\n" (ASCII 10
  1600. * (0x0A)), a new line (line feed).
  1601. * "\r" (ASCII 13
  1602. * (0x0D)), a carriage return.
  1603. * "\0" (ASCII 0
  1604. * (0x00)), the NUL-byte.
  1605. * "\x0B" (ASCII 11
  1606. * (0x0B)), a vertical tab.
  1607. */
  1608. function ltrim ($str, $charlist = null) {}
  1609. /**
  1610. * Strip HTML and PHP tags from a string
  1611. * @link http://www.php.net/manual/en/function.strip-tags.php
  1612. * @param str string <p>
  1613. * The input string.
  1614. * </p>
  1615. * @param allowable_tags string[optional] <p>
  1616. * You can use the optional second parameter to specify tags which should
  1617. * not be stripped.
  1618. * </p>
  1619. * <p>
  1620. * HTML comments and PHP tags are also stripped. This is hardcoded and
  1621. * can not be changed with allowable_tags.
  1622. * </p>
  1623. * @return string the stripped string.
  1624. */
  1625. function strip_tags ($str, $allowable_tags = null) {}
  1626. /**
  1627. * Calculate the similarity between two strings
  1628. * @link http://www.php.net/manual/en/function.similar-text.php
  1629. * @param first string <p>
  1630. * The first string.
  1631. * </p>
  1632. * @param second string <p>
  1633. * The second string.
  1634. * </p>
  1635. * @param percent float[optional] <p>
  1636. * By passing a reference as third argument,
  1637. * similar_text will calculate the similarity in
  1638. * percent for you.
  1639. * </p>
  1640. * @return int the number of matching chars in both strings.
  1641. */
  1642. function similar_text ($first, $second, &$percent = null) {}
  1643. /**
  1644. * Split a string by string
  1645. * @link http://www.php.net/manual/en/function.explode.php
  1646. * @param delimiter string <p>
  1647. * The boundary string.
  1648. * </p>
  1649. * @param string string <p>
  1650. * The input string.
  1651. * </p>
  1652. * @param limit int[optional] <p>
  1653. * If limit is set and positive, the returned array will contain
  1654. * a maximum of limit elements with the last
  1655. * element containing the rest of string.
  1656. * </p>
  1657. * <p>
  1658. * If the limit parameter is negative, all components
  1659. * except the last -limit are returned.
  1660. * </p>
  1661. * <p>
  1662. * If the limit parameter is zero, then this is treated as 1.
  1663. * </p>
  1664. * @return array If delimiter is an empty string (""),
  1665. * explode will return false.
  1666. * If delimiter contains a value that is not
  1667. * contained in string and a negative
  1668. * limit is used, then an empty array will be
  1669. * returned. For any other limit, an array containing
  1670. * string will be returned.
  1671. */
  1672. function explode ($delimiter, $string, $limit = null) {}
  1673. /**
  1674. * Join array elements with a string
  1675. * @link http://www.php.net/manual/en/function.implode.php
  1676. * @param glue string <p>
  1677. * Defaults to an empty string. This is not the preferred usage of
  1678. * implode as glue would be
  1679. * the second parameter and thus, the bad prototype would be used.
  1680. * </p>
  1681. * @param pieces array <p>
  1682. * The array of strings to implode.
  1683. * </p>
  1684. * @return string a string containing a string representation of all the array
  1685. * elements in the same order, with the glue string between each element.
  1686. */
  1687. function implode ($glue, array $pieces) {}
  1688. /**
  1689. * Set locale information
  1690. * @link http://www.php.net/manual/en/function.setlocale.php
  1691. * @param category int <p>
  1692. * category is a named constant specifying the
  1693. * category of the functions affected by the locale setting:
  1694. * LC_ALL for all of the below
  1695. * @param locale string <p>
  1696. * If locale is &null; or the empty string
  1697. * "", the locale names will be set from the
  1698. * values of environment variables with the same names as the above
  1699. * categories, or from "LANG".
  1700. * </p>
  1701. * <p>
  1702. * If locale is "0",
  1703. * the locale setting is not affected, only the current setting is returned.
  1704. * </p>
  1705. * <p>
  1706. * If locale is an array or followed by additional
  1707. * parameters then each array element or parameter is tried to be set as
  1708. * new locale until success. This is useful if a locale is known under
  1709. * different names on different systems or for providing a fallback
  1710. * for a possibly not available locale.
  1711. * </p>
  1712. * @param _ string[optional]
  1713. * @return string the new current locale, or false if the locale functionality is
  1714. * not implemented on your platform, the specified locale does not exist or
  1715. * the category name is invalid.
  1716. * </p>
  1717. * <p>
  1718. * An invalid category name also causes a warning message. Category/locale
  1719. * names can be found in RFC 1766
  1720. * and ISO 639.
  1721. * Different systems have different naming schemes for locales.
  1722. * </p>
  1723. * <p>
  1724. * The return value of setlocale depends
  1725. * on the system that PHP is running. It returns exactly
  1726. * what the system setlocale function returns.
  1727. */
  1728. function setlocale ($category, $locale, $_ = null) {}
  1729. /**
  1730. * Get numeric formatting information
  1731. * @link http://www.php.net/manual/en/function.localeconv.php
  1732. * @return array localeconv returns data based upon the current locale
  1733. * as set by setlocale. The associative array that is
  1734. * returned contains the following fields:
  1735. * <tr valign="top">
  1736. * <td>Array element</td>
  1737. * <td>Description</td>
  1738. * </tr>
  1739. * <tr valign="top">
  1740. * <td>decimal_point</td>
  1741. * <td>Decimal point character</td>
  1742. * </tr>
  1743. * <tr valign="top">
  1744. * <td>thousands_sep</td>
  1745. * <td>Thousands separator</td>
  1746. * </tr>
  1747. * <tr valign="top">
  1748. * <td>grouping</td>
  1749. * <td>Array containing numeric groupings</td>
  1750. * </tr>
  1751. * <tr valign="top">
  1752. * <td>int_curr_symbol</td>
  1753. * <td>International currency symbol (i.e. USD)</td>
  1754. * </tr>
  1755. * <tr valign="top">
  1756. * <td>currency_symbol</td>
  1757. * <td>Local currency symbol (i.e. $)</td>
  1758. * </tr>
  1759. * <tr valign="top">
  1760. * <td>mon_decimal_point</td>
  1761. * <td>Monetary decimal point character</td>
  1762. * </tr>
  1763. * <tr valign="top">
  1764. * <td>mon_thousands_sep</td>
  1765. * <td>Monetary thousands separator</td>
  1766. * </tr>
  1767. * <tr valign="top">
  1768. * <td>mon_grouping</td>
  1769. * <td>Array containing monetary groupings</td>
  1770. * </tr>
  1771. * <tr valign="top">
  1772. * <td>positive_sign</td>
  1773. * <td>Sign for positive values</td>
  1774. * </tr>
  1775. * <tr valign="top">
  1776. * <td>negative_sign</td>
  1777. * <td>Sign for negative values</td>
  1778. * </tr>
  1779. * <tr valign="top">
  1780. * <td>int_frac_digits</td>
  1781. * <td>International fractional digits</td>
  1782. * </tr>
  1783. * <tr valign="top">
  1784. * <td>frac_digits</td>
  1785. * <td>Local fractional digits</td>
  1786. * </tr>
  1787. * <tr valign="top">
  1788. * <td>p_cs_precedes</td>
  1789. * <td>
  1790. * true if currency_symbol precedes a positive value, false
  1791. * if it succeeds one
  1792. * </td>
  1793. * </tr>
  1794. * <tr valign="top">
  1795. * <td>p_sep_by_space</td>
  1796. * <td>
  1797. * true if a space separates currency_symbol from a positive
  1798. * value, false otherwise
  1799. * </td>
  1800. * </tr>
  1801. * <tr valign="top">
  1802. * <td>n_cs_precedes</td>
  1803. * <td>
  1804. * true if currency_symbol precedes a negative value, false
  1805. * if it succeeds one
  1806. * </td>
  1807. * </tr>
  1808. * <tr valign="top">
  1809. * <td>n_sep_by_space</td>
  1810. * <td>
  1811. * true if a space separates currency_symbol from a negative
  1812. * value, false otherwise
  1813. * </td>
  1814. * </tr>
  1815. * <td>p_sign_posn</td>
  1816. * <td>
  1817. * 0 - Parentheses surround the quantity and currency_symbol
  1818. * 1 - The sign string precedes the quantity and currency_symbol
  1819. * 2 - The sign string succeeds the quantity and currency_symbol
  1820. * 3 - The sign string immediately precedes the currency_symbol
  1821. * 4 - The sign string immediately succeeds the currency_symbol
  1822. * </td>
  1823. * </tr>
  1824. * <td>n_sign_posn</td>
  1825. * <td>
  1826. * 0 - Parentheses surround the quantity and currency_symbol
  1827. * 1 - The sign string precedes the quantity and currency_symbol
  1828. * 2 - The sign string succeeds the quantity and currency_symbol
  1829. * 3 - The sign string immediately precedes the currency_symbol
  1830. * 4 - The sign string immediately succeeds the currency_symbol
  1831. * </td>
  1832. * </tr>
  1833. * </p>
  1834. * <p>
  1835. * The p_sign_posn, and n_sign_posn contain a string
  1836. * of formatting options. Each number representing one of the above listed conditions.
  1837. * </p>
  1838. * <p>
  1839. * The grouping fields contain arrays that define the way numbers should be
  1840. * grouped. For example, the monetary grouping field for the nl_NL locale (in
  1841. * UTF-8 mode with the euro sign), would contain a 2 item array with the
  1842. * values 3 and 3. The higher the index in the array, the farther left the
  1843. * grouping is. If an array element is equal to CHAR_MAX,
  1844. * no further grouping is done. If an array element is equal to 0, the previous
  1845. * element should be used.
  1846. */
  1847. function localeconv () {}
  1848. /**
  1849. * Calculate the soundex key of a string
  1850. * @link http://www.php.net/manual/en/function.soundex.php
  1851. * @param str string <p>
  1852. * The input string.
  1853. * </p>
  1854. * @return string the soundex key as a string.
  1855. */
  1856. function soundex ($str) {}
  1857. /**
  1858. * Calculate Levenshtein distance between two strings
  1859. * @link http://www.php.net/manual/en/function.levenshtein.php
  1860. * @param str1 string <p>
  1861. * One of the strings being evaluated for Levenshtein distance.
  1862. * </p>
  1863. * @param str2 string <p>
  1864. * One of the strings being evaluated for Levenshtein distance.
  1865. * </p>
  1866. * @return int This function returns the Levenshtein-Distance between the
  1867. * two argument strings or -1, if one of the argument strings
  1868. * is longer than the limit of 255 characters.
  1869. */
  1870. function levenshtein ($str1, $str2) {}
  1871. /**
  1872. * Return a specific character
  1873. * @link http://www.php.net/manual/en/function.chr.php
  1874. * @param ascii int <p>
  1875. * The ascii code.
  1876. * </p>
  1877. * @return string the specified character.
  1878. */
  1879. function chr ($ascii) {}
  1880. /**
  1881. * Return ASCII value of character
  1882. * @link http://www.php.net/manual/en/function.ord.php
  1883. * @param string string <p>
  1884. * A character.
  1885. * </p>
  1886. * @return int the ASCII value as an integer.
  1887. */
  1888. function ord ($string) {}
  1889. /**
  1890. * Parses the string into variables
  1891. * @link http://www.php.net/manual/en/function.parse-str.php
  1892. * @param str string <p>
  1893. * The input string.
  1894. * </p>
  1895. * @param arr array[optional] <p>
  1896. * If the second parameter arr is present,
  1897. * variables are stored in this variable as array elements instead.
  1898. * </p>
  1899. * @return void
  1900. */
  1901. function parse_str ($str, array &$arr = null) {}
  1902. /**
  1903. * Pad a string to a certain length with another string
  1904. * @link http://www.php.net/manual/en/function.str-pad.php
  1905. * @param input string <p>
  1906. * The input string.
  1907. * </p>
  1908. * @param pad_length int <p>
  1909. * If the value of pad_length is negative,
  1910. * less than, or equal to the length of the input string, no padding
  1911. * takes place.
  1912. * </p>
  1913. * @param pad_string string[optional] <p>
  1914. * The pad_string may be truncated if the
  1915. * required number of padding characters can't be evenly divided by the
  1916. * pad_string's length.
  1917. * </p>
  1918. * @param pad_type int[optional] <p>
  1919. * Optional argument pad_type can be
  1920. * STR_PAD_RIGHT, STR_PAD_LEFT,
  1921. * or STR_PAD_BOTH. If
  1922. * pad_type is not specified it is assumed to be
  1923. * STR_PAD_RIGHT.
  1924. * </p>
  1925. * @return string the padded string.
  1926. */
  1927. function str_pad ($input, $pad_length, $pad_string = null, $pad_type = null) {}
  1928. /**
  1929. * &Alias; <function>rtrim</function>
  1930. * @link http://www.php.net/manual/en/function.chop.php
  1931. * @param str
  1932. * @param character_mask[optional]
  1933. */
  1934. function chop ($str, $character_mask) {}
  1935. /**
  1936. * &Alias; <function>strstr</function>
  1937. * @link http://www.php.net/manual/en/function.strchr.php
  1938. * @param haystack
  1939. * @param needle
  1940. */
  1941. function strchr ($haystack, $needle) {}
  1942. /**
  1943. * Return a formatted string
  1944. * @link http://www.php.net/manual/en/function.sprintf.php
  1945. * @param format string <p>
  1946. * The format string is composed of zero or more directives:
  1947. * ordinary characters (excluding %) that are
  1948. * copied directly to the result, and conversion
  1949. * specifications, each of which results in fetching its
  1950. * own parameter. This applies to both sprintf
  1951. * and printf.
  1952. * </p>
  1953. * <p>
  1954. * Each conversion specification consists of a percent sign
  1955. * (%), followed by one or more of these
  1956. * elements, in order:
  1957. * An optional sign specifier that forces a sign
  1958. * (- or +) to be used on a number. By default, only the - sign is used
  1959. * on a number if it's negative. This specifier forces positive numbers
  1960. * to have the + sign attached as well, and was added in PHP 4.3.0.
  1961. * @param args mixed[optional] <p>
  1962. * </p>
  1963. * @param _ mixed[optional]
  1964. * @return string a string produced according to the formatting string
  1965. * format.
  1966. */
  1967. function sprintf ($format, $args = null, $_ = null) {}
  1968. /**
  1969. * Output a formatted string
  1970. * @link http://www.php.net/manual/en/function.printf.php
  1971. * @param format string <p>
  1972. * See sprintf for a description of
  1973. * format.
  1974. * </p>
  1975. * @param args mixed[optional] <p>
  1976. * </p>
  1977. * @param _ mixed[optional]
  1978. * @return int the length of the outputted string.
  1979. */
  1980. function printf ($format, $args = null, $_ = null) {}
  1981. /**
  1982. * Output a formatted string
  1983. * @link http://www.php.net/manual/en/function.vprintf.php
  1984. * @param format string <p>
  1985. * See sprintf for a description of
  1986. * format.
  1987. * </p>
  1988. * @param args array <p>
  1989. * </p>
  1990. * @return int the length of the outputted string.
  1991. */
  1992. function vprintf ($format, array $args) {}
  1993. /**
  1994. * Return a formatted string
  1995. * @link http://www.php.net/manual/en/function.vsprintf.php
  1996. * @param format string <p>
  1997. * See sprintf for a description of
  1998. * format.
  1999. * </p>
  2000. * @param args array <p>
  2001. * </p>
  2002. * @return string Return array values as a formatted string according to
  2003. * format (which is described in the documentation
  2004. * for sprintf).
  2005. */
  2006. function vsprintf ($format, array $args) {}
  2007. /**
  2008. * Write a formatted string to a stream
  2009. * @link http://www.php.net/manual/en/function.fprintf.php
  2010. * @param handle resource &fs.file.pointer;
  2011. * @param format string <p>
  2012. * See sprintf for a description of
  2013. * format.
  2014. * </p>
  2015. * @param args mixed[optional] <p>
  2016. * </p>
  2017. * @param _ mixed[optional]
  2018. * @return int the length of the string written.
  2019. */
  2020. function fprintf ($handle, $format, $args = null, $_ = null) {}
  2021. /**
  2022. * Write a formatted string to a stream
  2023. * @link http://www.php.net/manual/en/function.vfprintf.php
  2024. * @param handle resource <p>
  2025. * </p>
  2026. * @param format string <p>
  2027. * See sprintf for a description of
  2028. * format.
  2029. * </p>
  2030. * @param args array <p>
  2031. * </p>
  2032. * @return int the length of the outputted string.
  2033. */
  2034. function vfprintf ($handle, $format, array $args) {}
  2035. /**
  2036. * Parses input from a string according to a format
  2037. * @link http://www.php.net/manual/en/function.sscanf.php
  2038. * @param str string <p>
  2039. * The input string being parsed.
  2040. * </p>
  2041. * @param format string <p>
  2042. * The interpreted format for str, which is
  2043. * described in the documentation for sprintf with
  2044. * following differences:
  2045. * Function is not locale-aware.
  2046. * F, g, G and
  2047. * b are not supported.
  2048. * D stands for decimal number.
  2049. * i stands for integer with base detection.
  2050. * n stands for number of characters processed so far.
  2051. * </p>
  2052. * @param _ mixed[optional]
  2053. * @return mixed If only
  2054. * two parameters were passed to this function, the values parsed
  2055. * will be returned as an array. Otherwise, if optional parameters are passed,
  2056. * the function will return the number of assigned values. The optional
  2057. * parameters must be passed by reference.
  2058. */
  2059. function sscanf ($str, $format, &$_ = null) {}
  2060. /**
  2061. * Parses input from a file according to a format
  2062. * @link http://www.php.net/manual/en/function.fscanf.php
  2063. * @param handle resource &fs.file.pointer;
  2064. * @param format string <p>
  2065. * The specified format as described in the
  2066. * sprintf documentation.
  2067. * </p>
  2068. * @param _ mixed[optional]
  2069. * @return mixed If only two parameters were passed to this function, the values parsed will be
  2070. * returned as an array. Otherwise, if optional parameters are passed, the
  2071. * function will return the number of assigned values. The optional
  2072. * parameters must be passed by reference.
  2073. */
  2074. function fscanf ($handle, $format, &$_ = null) {}
  2075. /**
  2076. * Parse a URL and return its components
  2077. * @link http://www.php.net/manual/en/function.parse-url.php
  2078. * @param url string <p>
  2079. * The URL to parse. Invalid characters are replaced by
  2080. * _.
  2081. * </p>
  2082. * @param component int[optional] <p>
  2083. * Specify one of PHP_URL_SCHEME,
  2084. * PHP_URL_HOST, PHP_URL_PORT,
  2085. * PHP_URL_USER, PHP_URL_PASS,
  2086. * PHP_URL_PATH, PHP_URL_QUERY
  2087. * or PHP_URL_FRAGMENT to retrieve just a specific
  2088. * URL component as a string.
  2089. * </p>
  2090. * @return mixed On seriously malformed URLs, parse_url may return
  2091. * false and emit a E_WARNING. Otherwise an associative
  2092. * array is returned, whose components may be (at least one):
  2093. * scheme - e.g. http
  2094. * host
  2095. * port
  2096. * user
  2097. * pass
  2098. * path
  2099. * query - after the question mark ?
  2100. * fragment - after the hashmark #
  2101. * </p>
  2102. * <p>
  2103. * If the component parameter is specified a
  2104. * string is returned instead of an array.
  2105. */
  2106. function parse_url ($url, $component = null) {}
  2107. /**
  2108. * URL-encodes string
  2109. * @link http://www.php.net/manual/en/function.urlencode.php
  2110. * @param str string <p>
  2111. * The string to be encoded.
  2112. * </p>
  2113. * @return string a string in which all non-alphanumeric characters except
  2114. * -_. have been replaced with a percent
  2115. * (%) sign followed by two hex digits and spaces encoded
  2116. * as plus (+) signs. It is encoded the same way that the
  2117. * posted data from a WWW form is encoded, that is the same way as in
  2118. * application/x-www-form-urlencoded media type. This
  2119. * differs from the RFC 1738 encoding (see
  2120. * rawurlencode) in that for historical reasons, spaces
  2121. * are encoded as plus (+) signs.
  2122. */
  2123. function urlencode ($str) {}
  2124. /**
  2125. * Decodes URL-encoded string
  2126. * @link http://www.php.net/manual/en/function.urldecode.php
  2127. * @param str string <p>
  2128. * The string to be decoded.
  2129. * </p>
  2130. * @return string the decoded string.
  2131. */
  2132. function urldecode ($str) {}
  2133. /**
  2134. * URL-encode according to RFC 1738
  2135. * @link http://www.php.net/manual/en/function.rawurlencode.php
  2136. * @param str string <p>
  2137. * The URL to be encoded.
  2138. * </p>
  2139. * @return string a string in which all non-alphanumeric characters except
  2140. * -_. have been replaced with a percent
  2141. * (%) sign followed by two hex digits. This is the
  2142. * encoding described in RFC 1738 for
  2143. * protecting literal characters from being interpreted as special URL
  2144. * delimiters, and for protecting URLs from being mangled by transmission
  2145. * media with character conversions (like some email systems).
  2146. */
  2147. function rawurlencode ($str) {}
  2148. /**
  2149. * Decode URL-encoded strings
  2150. * @link http://www.php.net/manual/en/function.rawurldecode.php
  2151. * @param str string <p>
  2152. * The URL to be decoded.
  2153. * </p>
  2154. * @return string the decoded URL, as a string.
  2155. */
  2156. function rawurldecode ($str) {}
  2157. /**
  2158. * Generate URL-encoded query string
  2159. * @link http://www.php.net/manual/en/function.http-build-query.php
  2160. * @param formdata array <p>
  2161. * May be an array or object containing properties.
  2162. * </p>
  2163. * <p>
  2164. * The array form may be a simple one-dimensional structure, or an array
  2165. * of arrays (who in turn may contain other arrays).
  2166. * </p>
  2167. * @param numeric_prefix string[optional] <p>
  2168. * If numeric indices are used in the base array and this parameter is
  2169. * provided, it will be prepended to the numeric index for elements in
  2170. * the base array only.
  2171. * </p>
  2172. * <p>
  2173. * This is meant to allow for legal variable names when the data is
  2174. * decoded by PHP or another CGI application later on.
  2175. * </p>
  2176. * @param arg_separator string[optional] <p>
  2177. * arg_separator.output
  2178. * is used to separate arguments, unless this parameter is specified,
  2179. * and is then used.
  2180. * </p>
  2181. * @return string a URL-encoded string.
  2182. */
  2183. function http_build_query (array $formdata, $numeric_prefix = null, $arg_separator = null) {}
  2184. /**
  2185. * Deletes a file
  2186. * @link http://www.php.net/manual/en/function.unlink.php
  2187. * @param filename string <p>
  2188. * Path to the file.
  2189. * </p>
  2190. * @param context resource[optional] &note.context-support;
  2191. * @return bool Returns true on success or false on failure.
  2192. */
  2193. function unlink ($filename, $context = null) {}
  2194. /**
  2195. * Execute an external program
  2196. * @link http://www.php.net/manual/en/function.exec.php
  2197. * @param command string <p>
  2198. * The command that will be executed.
  2199. * </p>
  2200. * @param output array[optional] <p>
  2201. * If the output argument is present, then the
  2202. * specified array will be filled with every line of output from the
  2203. * command. Trailing whitespace, such as \n, is not
  2204. * included in this array. Note that if the array already contains some
  2205. * elements, exec will append to the end of the array.
  2206. * If you do not want the function to append elements, call
  2207. * unset on the array before passing it to
  2208. * exec.
  2209. * </p>
  2210. * @param return_var int[optional] <p>
  2211. * If the return_var argument is present
  2212. * along with the output argument, then the
  2213. * return status of the executed command will be written to this
  2214. * variable.
  2215. * </p>
  2216. * @return string The last line from the result of the command. If you need to execute a
  2217. * command and have all the data from the command passed directly back without
  2218. * any interference, use the passthru function.
  2219. * </p>
  2220. * <p>
  2221. * To get the output of the executed command, be sure to set and use the
  2222. * output parameter.
  2223. */
  2224. function exec ($command, array &$output = null, &$return_var = null) {}
  2225. /**
  2226. * Execute an external program and display the output
  2227. * @link http://www.php.net/manual/en/function.system.php
  2228. * @param command string <p>
  2229. * The command that will be executed.
  2230. * </p>
  2231. * @param return_var int[optional] <p>
  2232. * If the return_var argument is present, then the
  2233. * return status of the executed command will be written to this
  2234. * variable.
  2235. * </p>
  2236. * @return string the last line of the command output on success, and false
  2237. * on failure.
  2238. */
  2239. function system ($command, &$return_var = null) {}
  2240. /**
  2241. * Escape shell metacharacters
  2242. * @link http://www.php.net/manual/en/function.escapeshellcmd.php
  2243. * @param command string <p>
  2244. * The command that will be escaped.
  2245. * </p>
  2246. * @return string The escaped string.
  2247. */
  2248. function escapeshellcmd ($command) {}
  2249. /**
  2250. * Escape a string to be used as a shell argument
  2251. * @link http://www.php.net/manual/en/function.escapeshellarg.php
  2252. * @param arg string <p>
  2253. * The argument that will be escaped.
  2254. * </p>
  2255. * @return string The escaped string.
  2256. */
  2257. function escapeshellarg ($arg) {}
  2258. /**
  2259. * Execute an external program and display raw output
  2260. * @link http://www.php.net/manual/en/function.passthru.php
  2261. * @param command string <p>
  2262. * The command that will be executed.
  2263. * </p>
  2264. * @param return_var int[optional] <p>
  2265. * If the return_var argument is present, the
  2266. * return status of the Unix command will be placed here.
  2267. * </p>
  2268. * @return void
  2269. */
  2270. function passthru ($command, &$return_var = null) {}
  2271. /**
  2272. * Execute command via shell and return the complete output as a string
  2273. * @link http://www.php.net/manual/en/function.shell-exec.php
  2274. * @param cmd string <p>
  2275. * The command that will be executed.
  2276. * </p>
  2277. * @return string The output from the executed command.
  2278. */
  2279. function shell_exec ($cmd) {}
  2280. /**
  2281. * Execute a command and open file pointers for input/output
  2282. * @link http://www.php.net/manual/en/function.proc-open.php
  2283. * @param cmd string <p>
  2284. * The command to execute
  2285. * </p>
  2286. * @param descriptorspec array <p>
  2287. * An indexed array where the key represents the descriptor number and the
  2288. * value represents how PHP will pass that descriptor to the child
  2289. * process. 0 is stdin, 1 is stdout, while 2 is stderr.
  2290. * </p>
  2291. * <p>
  2292. * Each element can be:
  2293. * An array describing the pipe to pass to the process. The first
  2294. * element is the descriptor type and the second element is an option for
  2295. * the given type. Valid types are pipe (the second
  2296. * element is either r to pass the read end of the pipe
  2297. * to the process, or w to pass the write end) and
  2298. * file (the second element is a filename).
  2299. * A stream resource representing a real file descriptor (e.g. opened file,
  2300. * a socket, STDIN).
  2301. * </p>
  2302. * <p>
  2303. * The file descriptor numbers are not limited to 0, 1 and 2 - you may
  2304. * specify any valid file descriptor number and it will be passed to the
  2305. * child process. This allows your script to interoperate with other
  2306. * scripts that run as "co-processes". In particular, this is useful for
  2307. * passing passphrases to programs like PGP, GPG and openssl in a more
  2308. * secure manner. It is also useful for reading status information
  2309. * provided by those programs on auxiliary file descriptors.
  2310. * </p>
  2311. * @param pipes array <p>
  2312. * Will be set to an indexed array of file pointers that correspond to
  2313. * PHP's end of any pipes that are created.
  2314. * </p>
  2315. * @param cwd string[optional] <p>
  2316. * The initial working dir for the command. This must be an
  2317. * absolute directory path, or &null;
  2318. * if you want to use the default value (the working dir of the current
  2319. * PHP process)
  2320. * </p>
  2321. * @param env array[optional] <p>
  2322. * An array with the environment variables for the command that will be
  2323. * run, or &null; to use the same environment as the current PHP process
  2324. * </p>
  2325. * @param other_options array[optional] <p>
  2326. * Allows you to specify additional options. Currently supported options
  2327. * include:
  2328. * suppress_errors (windows only): suppresses errors
  2329. * generated by this function when it's set to true
  2330. * bypass_shell (windows only): bypass
  2331. * cmd.exe shell when set to true
  2332. * context: stream context used when opening files
  2333. * (created with stream_context_create)
  2334. * binary_pipes: open pipes in binary mode, instead
  2335. * of using the usual stream_encoding
  2336. * </p>
  2337. * @return resource a resource representing the process, which should be freed using
  2338. * proc_close when you are finished with it. On failure
  2339. * returns false.
  2340. */
  2341. function proc_open ($cmd, array $descriptorspec, array &$pipes, $cwd = null, array $env = null, array $other_options = null) {}
  2342. /**
  2343. * Close a process opened by <function>proc_open</function> and return the exit code of that process
  2344. * @link http://www.php.net/manual/en/function.proc-close.php
  2345. * @param process resource <p>
  2346. * The proc_open resource that will
  2347. * be closed.
  2348. * </p>
  2349. * @return int the termination status of the process that was run.
  2350. */
  2351. function proc_close ($process) {}
  2352. /**
  2353. * Kills a process opened by proc_open
  2354. * @link http://www.php.net/manual/en/function.proc-terminate.php
  2355. * @param process resource <p>
  2356. * The proc_open resource that will
  2357. * be closed.
  2358. * </p>
  2359. * @param signal int[optional] <p>
  2360. * This optional parameter is only useful on POSIX
  2361. * operating systems; you may specify a signal to send to the process
  2362. * using the kill(2) system call. The default is
  2363. * SIGTERM.
  2364. * </p>
  2365. * @return bool the termination status of the process that was run.
  2366. */
  2367. function proc_terminate ($process, $signal = null) {}
  2368. /**
  2369. * Get information about a process opened by <function>proc_open</function>
  2370. * @link http://www.php.net/manual/en/function.proc-get-status.php
  2371. * @param process resource <p>
  2372. * The proc_open resource that will
  2373. * be evaluated.
  2374. * </p>
  2375. * @return array An array of collected information on success, and false
  2376. * on failure. The returned array contains the following elements:
  2377. * </p>
  2378. * <p>
  2379. * <tr valign="top"><td>element</td><td>type</td><td>description</td></tr>
  2380. * <tr valign="top">
  2381. * <td>command</td>
  2382. * <td>string</td>
  2383. * <td>
  2384. * The command string that was passed to proc_open.
  2385. * </td>
  2386. * </tr>
  2387. * <tr valign="top">
  2388. * <td>pid</td>
  2389. * <td>int</td>
  2390. * <td>process id</td>
  2391. * </tr>
  2392. * <tr valign="top">
  2393. * <td>running</td>
  2394. * <td>bool</td>
  2395. * <td>
  2396. * true if the process is still running, false if it has
  2397. * terminated.
  2398. * </td>
  2399. * </tr>
  2400. * <tr valign="top">
  2401. * <td>signaled</td>
  2402. * <td>bool</td>
  2403. * <td>
  2404. * true if the child process has been terminated by
  2405. * an uncaught signal. Always set to false on Windows.
  2406. * </td>
  2407. * </tr>
  2408. * <tr valign="top">
  2409. * <td>stopped</td>
  2410. * <td>bool</td>
  2411. * <td>
  2412. * true if the child process has been stopped by a
  2413. * signal. Always set to false on Windows.
  2414. * </td>
  2415. * </tr>
  2416. * <tr valign="top">
  2417. * <td>exitcode</td>
  2418. * <td>int</td>
  2419. * <td>
  2420. * The exit code returned by the process (which is only
  2421. * meaningful if running is false).
  2422. * Only first call of this function return real value, next calls return
  2423. * -1.
  2424. * </td>
  2425. * </tr>
  2426. * <tr valign="top">
  2427. * <td>termsig</td>
  2428. * <td>int</td>
  2429. * <td>
  2430. * The number of the signal that caused the child process to terminate
  2431. * its execution (only meaningful if signaled is true).
  2432. * </td>
  2433. * </tr>
  2434. * <tr valign="top">
  2435. * <td>stopsig</td>
  2436. * <td>int</td>
  2437. * <td>
  2438. * The number of the signal that caused the child process to stop its
  2439. * execution (only meaningful if stopped is true).
  2440. * </td>
  2441. * </tr>
  2442. */
  2443. function proc_get_status ($process) {}
  2444. /**
  2445. * Generate a random integer
  2446. * @link http://www.php.net/manual/en/function.rand.php
  2447. * @param min[optional]
  2448. * @param max[optional]
  2449. * @return int A pseudo random value between min
  2450. * (or 0) and max (or getrandmax, inclusive).
  2451. */
  2452. function rand ($min, $max) {}
  2453. /**
  2454. * Seed the random number generator
  2455. * @link http://www.php.net/manual/en/function.srand.php
  2456. * @param seed int[optional] <p>
  2457. * Optional seed value
  2458. * </p>
  2459. * @return void
  2460. */
  2461. function srand ($seed = null) {}
  2462. /**
  2463. * Show largest possible random value
  2464. * @link http://www.php.net/manual/en/function.getrandmax.php
  2465. * @return int The largest possible random value returned by rand
  2466. */
  2467. function getrandmax () {}
  2468. /**
  2469. * Generate a better random value
  2470. * @link http://www.php.net/manual/en/function.mt-rand.php
  2471. * @param min[optional]
  2472. * @param max[optional]
  2473. * @return int A random integer value between min (or 0)
  2474. * and max (or mt_getrandmax, inclusive)
  2475. */
  2476. function mt_rand ($min, $max) {}
  2477. /**
  2478. * Seed the better random number generator
  2479. * @link http://www.php.net/manual/en/function.mt-srand.php
  2480. * @param seed int[optional] <p>
  2481. * An optional seed value
  2482. * </p>
  2483. * @return void
  2484. */
  2485. function mt_srand ($seed = null) {}
  2486. /**
  2487. * Show largest possible random value
  2488. * @link http://www.php.net/manual/en/function.mt-getrandmax.php
  2489. * @return int the maximum random value returned by mt_rand
  2490. */
  2491. function mt_getrandmax () {}
  2492. /**
  2493. * Get port number associated with an Internet service and protocol
  2494. * @link http://www.php.net/manual/en/function.getservbyname.php
  2495. * @param service string <p>
  2496. * The Internet service name, as a string.
  2497. * </p>
  2498. * @param protocol string <p>
  2499. * protocol is either "tcp"
  2500. * or "udp" (in lowercase).
  2501. * </p>
  2502. * @return int the port number, or false if service or
  2503. * protocol is not found.
  2504. */
  2505. function getservbyname ($service, $protocol) {}
  2506. /**
  2507. * Get Internet service which corresponds to port and protocol
  2508. * @link http://www.php.net/manual/en/function.getservbyport.php
  2509. * @param port int <p>
  2510. * The port number.
  2511. * </p>
  2512. * @param protocol string <p>
  2513. * protocol is either "tcp"
  2514. * or "udp" (in lowercase).
  2515. * </p>
  2516. * @return string the Internet service name as a string.
  2517. */
  2518. function getservbyport ($port, $protocol) {}
  2519. /**
  2520. * Get protocol number associated with protocol name
  2521. * @link http://www.php.net/manual/en/function.getprotobyname.php
  2522. * @param name string <p>
  2523. * The protocol name.
  2524. * </p>
  2525. * @return int the protocol number or -1 if the protocol is not found.
  2526. */
  2527. function getprotobyname ($name) {}
  2528. /**
  2529. * Get protocol name associated with protocol number
  2530. * @link http://www.php.net/manual/en/function.getprotobynumber.php
  2531. * @param number int <p>
  2532. * The protocol number.
  2533. * </p>
  2534. * @return string the protocol name as a string.
  2535. */
  2536. function getprotobynumber ($number) {}
  2537. /**
  2538. * Gets PHP script owner's UID
  2539. * @link http://www.php.net/manual/en/function.getmyuid.php
  2540. * @return int the user ID of the current script, or false on error.
  2541. */
  2542. function getmyuid () {}
  2543. /**
  2544. * Get PHP script owner's GID
  2545. * @link http://www.php.net/manual/en/function.getmygid.php
  2546. * @return int the group ID of the current script, or false on error.
  2547. */
  2548. function getmygid () {}
  2549. /**
  2550. * Gets PHP's process ID
  2551. * @link http://www.php.net/manual/en/function.getmypid.php
  2552. * @return int the current PHP process ID, or false on error.
  2553. */
  2554. function getmypid () {}
  2555. /**
  2556. * Gets the inode of the current script
  2557. * @link http://www.php.net/manual/en/function.getmyinode.php
  2558. * @return int the current script's inode as an integer, or false on error.
  2559. */
  2560. function getmyinode () {}
  2561. /**
  2562. * Gets time of last page modification
  2563. * @link http://www.php.net/manual/en/function.getlastmod.php
  2564. * @return int the time of the last modification of the current
  2565. * page. The value returned is a Unix timestamp, suitable for
  2566. * feeding to date. Returns false on error.
  2567. */
  2568. function getlastmod () {}
  2569. /**
  2570. * Decodes data encoded with MIME base64
  2571. * @link http://www.php.net/manual/en/function.base64-decode.php
  2572. * @param data string <p>
  2573. * The encoded data.
  2574. * </p>
  2575. * @param strict bool[optional] <p>
  2576. * Returns false if input contains character from outside the base64
  2577. * alphabet.
  2578. * </p>
  2579. * @return string the original data&return.falseforfailure;. The returned data may be
  2580. * binary.
  2581. */
  2582. function base64_decode ($data, $strict = null) {}
  2583. /**
  2584. * Encodes data with MIME base64
  2585. * @link http://www.php.net/manual/en/function.base64-encode.php
  2586. * @param data string <p>
  2587. * The data to encode.
  2588. * </p>
  2589. * @return string The encoded data, as a string.
  2590. */
  2591. function base64_encode ($data) {}
  2592. /**
  2593. * Uuencode a string
  2594. * @link http://www.php.net/manual/en/function.convert-uuencode.php
  2595. * @param data string <p>
  2596. * The data to be encoded.
  2597. * </p>
  2598. * @return string the uuencoded data.
  2599. */
  2600. function convert_uuencode ($data) {}
  2601. /**
  2602. * Decode a uuencoded string
  2603. * @link http://www.php.net/manual/en/function.convert-uudecode.php
  2604. * @param data string <p>
  2605. * The uuencoded data.
  2606. * </p>
  2607. * @return string the decoded data as a string.
  2608. */
  2609. function convert_uudecode ($data) {}
  2610. /**
  2611. * Absolute value
  2612. * @link http://www.php.net/manual/en/function.abs.php
  2613. * @param number mixed <p>
  2614. * The numeric value to process
  2615. * </p>
  2616. * @return number The absolute value of number. If the
  2617. * argument number is
  2618. * of type float, the return type is also float,
  2619. * otherwise it is integer (as float usually has a
  2620. * bigger value range than integer).
  2621. */
  2622. function abs ($number) {}
  2623. /**
  2624. * Round fractions up
  2625. * @link http://www.php.net/manual/en/function.ceil.php
  2626. * @param value float <p>
  2627. * The value to round
  2628. * </p>
  2629. * @return float value rounded up to the next highest
  2630. * integer.
  2631. * The return value of ceil is still of type
  2632. * float as the value range of float is
  2633. * usually bigger than that of integer.
  2634. */
  2635. function ceil ($value) {}
  2636. /**
  2637. * Round fractions down
  2638. * @link http://www.php.net/manual/en/function.floor.php
  2639. * @param value float <p>
  2640. * The numeric value to round
  2641. * </p>
  2642. * @return float value rounded to the next lowest integer.
  2643. * The return value of floor is still of type
  2644. * float because the value range of float is
  2645. * usually bigger than that of integer.
  2646. */
  2647. function floor ($value) {}
  2648. /**
  2649. * Rounds a float
  2650. * @link http://www.php.net/manual/en/function.round.php
  2651. * @param val float <p>
  2652. * The value to round
  2653. * </p>
  2654. * @param precision int[optional] <p>
  2655. * The optional number of decimal digits to round to.
  2656. * </p>
  2657. * @param mode int[optional] <p>
  2658. * One of PHP_ROUND_HALF_UP,
  2659. * PHP_ROUND_HALF_DOWN,
  2660. * PHP_ROUND_HALF_EVEN, or
  2661. * PHP_ROUND_HALF_ODD.
  2662. * </p>
  2663. * @return float The rounded value
  2664. */
  2665. function round ($val, $precision = null, $mode = null) {}
  2666. /**
  2667. * Sine
  2668. * @link http://www.php.net/manual/en/function.sin.php
  2669. * @param arg float <p>
  2670. * A value in radians
  2671. * </p>
  2672. * @return float The sine of arg
  2673. */
  2674. function sin ($arg) {}
  2675. /**
  2676. * Cosine
  2677. * @link http://www.php.net/manual/en/function.cos.php
  2678. * @param arg float <p>
  2679. * An angle in radians
  2680. * </p>
  2681. * @return float The cosine of arg
  2682. */
  2683. function cos ($arg) {}
  2684. /**
  2685. * Tangent
  2686. * @link http://www.php.net/manual/en/function.tan.php
  2687. * @param arg float <p>
  2688. * The argument to process in radians
  2689. * </p>
  2690. * @return float The tangent of arg
  2691. */
  2692. function tan ($arg) {}
  2693. /**
  2694. * Arc sine
  2695. * @link http://www.php.net/manual/en/function.asin.php
  2696. * @param arg float <p>
  2697. * The argument to process
  2698. * </p>
  2699. * @return float The arc sine of arg in radians
  2700. */
  2701. function asin ($arg) {}
  2702. /**
  2703. * Arc cosine
  2704. * @link http://www.php.net/manual/en/function.acos.php
  2705. * @param arg float <p>
  2706. * The argument to process
  2707. * </p>
  2708. * @return float The arc cosine of arg in radians.
  2709. */
  2710. function acos ($arg) {}
  2711. /**
  2712. * Arc tangent
  2713. * @link http://www.php.net/manual/en/function.atan.php
  2714. * @param arg float <p>
  2715. * The argument to process
  2716. * </p>
  2717. * @return float The arc tangent of arg in radians.
  2718. */
  2719. function atan ($arg) {}
  2720. /**
  2721. * Arc tangent of two variables
  2722. * @link http://www.php.net/manual/en/function.atan2.php
  2723. * @param y float <p>
  2724. * Dividend parameter
  2725. * </p>
  2726. * @param x float <p>
  2727. * Divisor parameter
  2728. * </p>
  2729. * @return float The arc tangent of y/x
  2730. * in radians.
  2731. */
  2732. function atan2 ($y, $x) {}
  2733. /**
  2734. * Hyperbolic sine
  2735. * @link http://www.php.net/manual/en/function.sinh.php
  2736. * @param arg float <p>
  2737. * The argument to process
  2738. * </p>
  2739. * @return float The hyperbolic sine of arg
  2740. */
  2741. function sinh ($arg) {}
  2742. /**
  2743. * Hyperbolic cosine
  2744. * @link http://www.php.net/manual/en/function.cosh.php
  2745. * @param arg float <p>
  2746. * The argument to process
  2747. * </p>
  2748. * @return float The hyperbolic cosine of arg
  2749. */
  2750. function cosh ($arg) {}
  2751. /**
  2752. * Hyperbolic tangent
  2753. * @link http://www.php.net/manual/en/function.tanh.php
  2754. * @param arg float <p>
  2755. * The argument to process
  2756. * </p>
  2757. * @return float The hyperbolic tangent of arg
  2758. */
  2759. function tanh ($arg) {}
  2760. /**
  2761. * Get value of pi
  2762. * @link http://www.php.net/manual/en/function.pi.php
  2763. * @return float The value of pi as float.
  2764. */
  2765. function pi () {}
  2766. /**
  2767. * Finds whether a value is a legal finite number
  2768. * @link http://www.php.net/manual/en/function.is-finite.php
  2769. * @param val float <p>
  2770. * The value to check
  2771. * </p>
  2772. * @return bool true if val is a legal finite
  2773. * number within the allowed range for a PHP float on this platform,
  2774. * else false.
  2775. */
  2776. function is_finite ($val) {}
  2777. /**
  2778. * Finds whether a value is not a number
  2779. * @link http://www.php.net/manual/en/function.is-nan.php
  2780. * @param val float <p>
  2781. * The value to check
  2782. * </p>
  2783. * @return bool true if val is 'not a number',
  2784. * else false.
  2785. */
  2786. function is_nan ($val) {}
  2787. /**
  2788. * Finds whether a value is infinite
  2789. * @link http://www.php.net/manual/en/function.is-infinite.php
  2790. * @param val float <p>
  2791. * The value to check
  2792. * </p>
  2793. * @return bool true if val is infinite, else false.
  2794. */
  2795. function is_infinite ($val) {}
  2796. /**
  2797. * Exponential expression
  2798. * @link http://www.php.net/manual/en/function.pow.php
  2799. * @param base number <p>
  2800. * The base to use
  2801. * </p>
  2802. * @param exp number <p>
  2803. * The exponent
  2804. * </p>
  2805. * @return number base raised to the power of exp.
  2806. * If the result can be represented as integer it will be returned as type
  2807. * integer, else it will be returned as type float.
  2808. * If the power cannot be computed false will be returned instead.
  2809. */
  2810. function pow ($base, $exp) {}
  2811. /**
  2812. * Calculates the exponent of <constant>e</constant>
  2813. * @link http://www.php.net/manual/en/function.exp.php
  2814. * @param arg float <p>
  2815. * The argument to process
  2816. * </p>
  2817. * @return float 'e' raised to the power of arg
  2818. */
  2819. function exp ($arg) {}
  2820. /**
  2821. * Natural logarithm
  2822. * @link http://www.php.net/manual/en/function.log.php
  2823. * @param arg float <p>
  2824. * The value to calculate the logarithm for
  2825. * </p>
  2826. * @param base float[optional] <p>
  2827. * The optional logarithmic base to use
  2828. * (defaults to 'e' and so to the natural logarithm).
  2829. * </p>
  2830. * @return float The logarithm of arg to
  2831. * base, if given, or the
  2832. * natural logarithm.
  2833. */
  2834. function log ($arg, $base = null) {}
  2835. /**
  2836. * Base-10 logarithm
  2837. * @link http://www.php.net/manual/en/function.log10.php
  2838. * @param arg float <p>
  2839. * The argument to process
  2840. * </p>
  2841. * @return float The base-10 logarithm of arg
  2842. */
  2843. function log10 ($arg) {}
  2844. /**
  2845. * Square root
  2846. * @link http://www.php.net/manual/en/function.sqrt.php
  2847. * @param arg float <p>
  2848. * The argument to process
  2849. * </p>
  2850. * @return float The square root of arg
  2851. * or the special value NAN for negative numbers.
  2852. */
  2853. function sqrt ($arg) {}
  2854. /**
  2855. * Calculate the length of the hypotenuse of a right-angle triangle
  2856. * @link http://www.php.net/manual/en/function.hypot.php
  2857. * @param x float <p>
  2858. * Length of first side
  2859. * </p>
  2860. * @param y float <p>
  2861. * Length of second side
  2862. * </p>
  2863. * @return float Calculated length of the hypotenuse
  2864. */
  2865. function hypot ($x, $y) {}
  2866. /**
  2867. * Converts the number in degrees to the radian equivalent
  2868. * @link http://www.php.net/manual/en/function.deg2rad.php
  2869. * @param number float <p>
  2870. * Angular value in degrees
  2871. * </p>
  2872. * @return float The radian equivalent of number
  2873. */
  2874. function deg2rad ($number) {}
  2875. /**
  2876. * Converts the radian number to the equivalent number in degrees
  2877. * @link http://www.php.net/manual/en/function.rad2deg.php
  2878. * @param number float <p>
  2879. * A radian value
  2880. * </p>
  2881. * @return float The equivalent of number in degrees
  2882. */
  2883. function rad2deg ($number) {}
  2884. /**
  2885. * Binary to decimal
  2886. * @link http://www.php.net/manual/en/function.bindec.php
  2887. * @param binary_string string <p>
  2888. * The binary string to convert
  2889. * </p>
  2890. * @return number The decimal value of binary_string
  2891. */
  2892. function bindec ($binary_string) {}
  2893. /**
  2894. * Hexadecimal to decimal
  2895. * @link http://www.php.net/manual/en/function.hexdec.php
  2896. * @param hex_string string <p>
  2897. * The hexadecimal string to convert
  2898. * </p>
  2899. * @return number The decimal representation of hex_string
  2900. */
  2901. function hexdec ($hex_string) {}
  2902. /**
  2903. * Octal to decimal
  2904. * @link http://www.php.net/manual/en/function.octdec.php
  2905. * @param octal_string string <p>
  2906. * The octal string to convert
  2907. * </p>
  2908. * @return number The decimal representation of octal_string
  2909. */
  2910. function octdec ($octal_string) {}
  2911. /**
  2912. * Decimal to binary
  2913. * @link http://www.php.net/manual/en/function.decbin.php
  2914. * @param number int <p>
  2915. * Decimal value to convert
  2916. * </p>
  2917. * <table>
  2918. * Range of inputs on 32-bit machines
  2919. * <tr valign="top">
  2920. * <td>positive number</td>
  2921. * <td>negative number</td>
  2922. * <td>return value</td>
  2923. * </tr>
  2924. * <tr valign="top">
  2925. * <td>0</td>
  2926. * <td></td>
  2927. * <td>0</td>
  2928. * </tr>
  2929. * <tr valign="top">
  2930. * <td>1</td>
  2931. * <td></td>
  2932. * <td>1</td>
  2933. * </tr>
  2934. * <tr valign="top">
  2935. * <td>2</td>
  2936. * <td></td>
  2937. * <td>10</td>
  2938. * </tr>
  2939. * <tr valign="top">
  2940. * ... normal progression ...</td>
  2941. * </tr>
  2942. * <tr valign="top">
  2943. * <td>2147483646</td>
  2944. * <td></td>
  2945. * <td>1111111111111111111111111111110</td>
  2946. * </tr>
  2947. * <tr valign="top">
  2948. * <td>2147483647 (largest signed integer)</td>
  2949. * <td></td>
  2950. * <td>1111111111111111111111111111111 (31 1's)</td>
  2951. * </tr>
  2952. * <tr valign="top">
  2953. * <td>2147483648</td>
  2954. * <td>-2147483648</td>
  2955. * <td>10000000000000000000000000000000</td>
  2956. * </tr>
  2957. * <tr valign="top">
  2958. * ... normal progression ...</td>
  2959. * </tr>
  2960. * <tr valign="top">
  2961. * <td>4294967294</td>
  2962. * <td>-2</td>
  2963. * <td>11111111111111111111111111111110</td>
  2964. * </tr>
  2965. * <tr valign="top">
  2966. * <td>4294967295 (largest unsigned integer)</td>
  2967. * <td>-1</td>
  2968. * <td>11111111111111111111111111111111 (32 1's)</td>
  2969. * </tr>
  2970. * </table>
  2971. * <table>
  2972. * Range of inputs on 64-bit machines
  2973. * <tr valign="top">
  2974. * <td>positive number</td>
  2975. * <td>negative number</td>
  2976. * <td>return value</td>
  2977. * </tr>
  2978. * <tr valign="top">
  2979. * <td>0</td>
  2980. * <td></td>
  2981. * <td>0</td>
  2982. * </tr>
  2983. * <tr valign="top">
  2984. * <td>1</td>
  2985. * <td></td>
  2986. * <td>1</td>
  2987. * </tr>
  2988. * <tr valign="top">
  2989. * <td>2</td>
  2990. * <td></td>
  2991. * <td>10</td>
  2992. * </tr>
  2993. * <tr valign="top">
  2994. * ... normal progression ...</td>
  2995. * </tr>
  2996. * <tr valign="top">
  2997. * <td>9223372036854775806</td>
  2998. * <td></td>
  2999. * <td>111111111111111111111111111111111111111111111111111111111111110</td>
  3000. * </tr>
  3001. * <tr valign="top">
  3002. * <td>9223372036854775807 (largest signed integer)</td>
  3003. * <td></td>
  3004. * <td>111111111111111111111111111111111111111111111111111111111111111 (31 1's)</td>
  3005. * </tr>
  3006. * <tr valign="top">
  3007. * <td></td>
  3008. * <td>-9223372036854775808</td>
  3009. * <td>1000000000000000000000000000000000000000000000000000000000000000</td>
  3010. * </tr>
  3011. * <tr valign="top">
  3012. * ... normal progression ...</td>
  3013. * </tr>
  3014. * <tr valign="top">
  3015. * <td></td>
  3016. * <td>-2</td>
  3017. * <td>1111111111111111111111111111111111111111111111111111111111111110</td>
  3018. * </tr>
  3019. * <tr valign="top">
  3020. * <td></td>
  3021. * <td>-1</td>
  3022. * <td>1111111111111111111111111111111111111111111111111111111111111111 (64 1's)</td>
  3023. * </tr>
  3024. * </table>
  3025. * @return string Binary string representation of number
  3026. */
  3027. function decbin ($number) {}
  3028. /**
  3029. * Decimal to octal
  3030. * @link http://www.php.net/manual/en/function.decoct.php
  3031. * @param number int <p>
  3032. * Decimal value to convert
  3033. * </p>
  3034. * @return string Octal string representation of number
  3035. */
  3036. function decoct ($number) {}
  3037. /**
  3038. * Decimal to hexadecimal
  3039. * @link http://www.php.net/manual/en/function.dechex.php
  3040. * @param number int <p>
  3041. * Decimal value to convert
  3042. * </p>
  3043. * @return string Hexadecimal string representation of number
  3044. */
  3045. function dechex ($number) {}
  3046. /**
  3047. * Convert a number between arbitrary bases
  3048. * @link http://www.php.net/manual/en/function.base-convert.php
  3049. * @param number string <p>
  3050. * The number to convert
  3051. * </p>
  3052. * @param frombase int <p>
  3053. * The base number is in
  3054. * </p>
  3055. * @param tobase int <p>
  3056. * The base to convert number to
  3057. * </p>
  3058. * @return string number converted to base tobase
  3059. */
  3060. function base_convert ($number, $frombase, $tobase) {}
  3061. /**
  3062. * Format a number with grouped thousands
  3063. * @link http://www.php.net/manual/en/function.number-format.php
  3064. * @param number float <p>
  3065. * The number being formatted.
  3066. * </p>
  3067. * @param decimals int[optional] <p>
  3068. * Sets the number of decimal points.
  3069. * </p>
  3070. * @return string A formatted version of number.
  3071. */
  3072. function number_format ($number, $decimals = null) {}
  3073. /**
  3074. * Returns the floating point remainder (modulo) of the division
  3075. of the arguments
  3076. * @link http://www.php.net/manual/en/function.fmod.php
  3077. * @param x float <p>
  3078. * The dividend
  3079. * </p>
  3080. * @param y float <p>
  3081. * The divisor
  3082. * </p>
  3083. * @return float The floating point remainder of
  3084. * x/y
  3085. */
  3086. function fmod ($x, $y) {}
  3087. /**
  3088. * Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address
  3089. * @link http://www.php.net/manual/en/function.ip2long.php
  3090. * @param ip_address string <p>
  3091. * A standard format address.
  3092. * </p>
  3093. * @return int the IPv4 address or false if ip_address
  3094. * is invalid.
  3095. */
  3096. function ip2long ($ip_address) {}
  3097. /**
  3098. * Converts an (IPv4) Internet network address into a string in Internet standard dotted format
  3099. * @link http://www.php.net/manual/en/function.long2ip.php
  3100. * @param proper_address string <p>
  3101. * A proper address representation.
  3102. * </p>
  3103. * @return string the Internet IP address as a string.
  3104. */
  3105. function long2ip ($proper_address) {}
  3106. /**
  3107. * Gets the value of an environment variable
  3108. * @link http://www.php.net/manual/en/function.getenv.php
  3109. * @param varname string <p>
  3110. * The variable name.
  3111. * </p>
  3112. * @return string the value of the environment variable
  3113. * varname, or false on an error.
  3114. */
  3115. function getenv ($varname) {}
  3116. /**
  3117. * Sets the value of an environment variable
  3118. * @link http://www.php.net/manual/en/function.putenv.php
  3119. * @param setting string <p>
  3120. * The setting, like "FOO=BAR"
  3121. * </p>
  3122. * @return bool Returns true on success or false on failure.
  3123. */
  3124. function putenv ($setting) {}
  3125. /**
  3126. * Return current Unix timestamp with microseconds
  3127. * @link http://www.php.net/manual/en/function.microtime.php
  3128. * @param get_as_float bool[optional] <p>
  3129. * When called without the optional argument, this function returns the string
  3130. * "msec sec" where sec is the current time measured in the number of
  3131. * seconds since the Unix Epoch (0:00:00 January 1, 1970 GMT), and
  3132. * msec is the microseconds part.
  3133. * Both portions of the string are returned in units of seconds.
  3134. * </p>
  3135. * <p>
  3136. * If the optional get_as_float is set to
  3137. * true then a float (in seconds) is returned.
  3138. * </p>
  3139. * @return mixed
  3140. */
  3141. function microtime ($get_as_float = null) {}
  3142. /**
  3143. * Get current time
  3144. * @link http://www.php.net/manual/en/function.gettimeofday.php
  3145. * @param return_float bool[optional] <p>
  3146. * When set to true, a float instead of an array is returned.
  3147. * </p>
  3148. * @return mixed By default an array is returned. If return_float
  3149. * is set, then a float is returned.
  3150. * </p>
  3151. * <p>
  3152. * Array keys:
  3153. * "sec" - seconds since the Unix Epoch
  3154. * "usec" - microseconds
  3155. * "minuteswest" - minutes west of Greenwich
  3156. * "dsttime" - type of dst correction
  3157. */
  3158. function gettimeofday ($return_float = null) {}
  3159. /**
  3160. * Generate a unique ID
  3161. * @link http://www.php.net/manual/en/function.uniqid.php
  3162. * @param prefix string[optional] <p>
  3163. * Can be useful, for instance, if you generate identifiers
  3164. * simultaneously on several hosts that might happen to generate the
  3165. * identifier at the same microsecond.
  3166. * </p>
  3167. * <p>
  3168. * With an empty prefix, the returned string will
  3169. * be 13 characters long. If more_entropy is
  3170. * true, it will be 23 characters.
  3171. * </p>
  3172. * @param more_entropy bool[optional] <p>
  3173. * If set to true, uniqid will add additional
  3174. * entropy (using the combined linear congruential generator) at the end
  3175. * of the return value, which should make the results more unique.
  3176. * </p>
  3177. * @return string the unique identifier, as a string.
  3178. */
  3179. function uniqid ($prefix = null, $more_entropy = null) {}
  3180. /**
  3181. * Convert a quoted-printable string to an 8 bit string
  3182. * @link http://www.php.net/manual/en/function.quoted-printable-decode.php
  3183. * @param str string <p>
  3184. * The input string.
  3185. * </p>
  3186. * @return string the 8-bit binary string.
  3187. */
  3188. function quoted_printable_decode ($str) {}
  3189. /**
  3190. * Convert from one Cyrillic character set to another
  3191. * @link http://www.php.net/manual/en/function.convert-cyr-string.php
  3192. * @param str string <p>
  3193. * The string to be converted.
  3194. * </p>
  3195. * @param from string <p>
  3196. * The source Cyrillic character set, as a single character.
  3197. * </p>
  3198. * @param to string <p>
  3199. * The target Cyrillic character set, as a single character.
  3200. * </p>
  3201. * @return string the converted string.
  3202. */
  3203. function convert_cyr_string ($str, $from, $to) {}
  3204. /**
  3205. * Gets the name of the owner of the current PHP script
  3206. * @link http://www.php.net/manual/en/function.get-current-user.php
  3207. * @return string the username as a string.
  3208. */
  3209. function get_current_user () {}
  3210. /**
  3211. * Limits the maximum execution time
  3212. * @link http://www.php.net/manual/en/function.set-time-limit.php
  3213. * @param seconds int <p>
  3214. * The maximum execution time, in seconds. If set to zero, no time limit
  3215. * is imposed.
  3216. * </p>
  3217. * @return void
  3218. */
  3219. function set_time_limit ($seconds) {}
  3220. /**
  3221. * Gets the value of a PHP configuration option
  3222. * @link http://www.php.net/manual/en/function.get-cfg-var.php
  3223. * @param option string <p>
  3224. * The configuration option name.
  3225. * </p>
  3226. * @return string the current value of the PHP configuration variable specified by
  3227. * option, or false if an error occurs.
  3228. */
  3229. function get_cfg_var ($option) {}
  3230. /**
  3231. * &Alias; <function>set_magic_quotes_runtime</function>
  3232. * @link http://www.php.net/manual/en/function.magic-quotes-runtime.php
  3233. */
  3234. function magic_quotes_runtime () {}
  3235. /**
  3236. * Sets the current active configuration setting of magic_quotes_runtime
  3237. * @link http://www.php.net/manual/en/function.set-magic-quotes-runtime.php
  3238. * @param new_setting bool <p>
  3239. * false for off, true for on.
  3240. * </p>
  3241. * @return bool Returns true on success or false on failure.
  3242. */
  3243. function set_magic_quotes_runtime ($new_setting) {}
  3244. /**
  3245. * Gets the current configuration setting of magic_quotes_gpc
  3246. * @link http://www.php.net/manual/en/function.get-magic-quotes-gpc.php
  3247. * @return int 0 if magic_quotes_gpc is off, 1 otherwise.
  3248. */
  3249. function get_magic_quotes_gpc () {}
  3250. /**
  3251. * Gets the current active configuration setting of magic_quotes_runtime
  3252. * @link http://www.php.net/manual/en/function.get-magic-quotes-runtime.php
  3253. * @return int 0 if magic_quotes_runtime is off, 1 otherwise.
  3254. */
  3255. function get_magic_quotes_runtime () {}
  3256. /**
  3257. * Import GET/POST/Cookie variables into the global scope
  3258. * @link http://www.php.net/manual/en/function.import-request-variables.php
  3259. * @param types string <p>
  3260. * Using the types parameter, you can specify
  3261. * which request variables to import. You can use 'G', 'P' and 'C'
  3262. * characters respectively for GET, POST and Cookie. These characters are
  3263. * not case sensitive, so you can also use any combination of 'g', 'p'
  3264. * and 'c'. POST includes the POST uploaded file information.
  3265. * </p>
  3266. * <p>
  3267. * Note that the order of the letters matters, as when using
  3268. * "GP", the
  3269. * POST variables will overwrite GET variables with the same name. Any
  3270. * other letters than GPC are discarded.
  3271. * </p>
  3272. * @param prefix string[optional] <p>
  3273. * Variable name prefix, prepended before all variable's name imported
  3274. * into the global scope. So if you have a GET value named
  3275. * "userid", and provide a prefix
  3276. * "pref_", then you'll get a global variable named
  3277. * $pref_userid.
  3278. * </p>
  3279. * <p>
  3280. * Although the prefix parameter is optional, you
  3281. * will get an E_NOTICE level
  3282. * error if you specify no prefix, or specify an empty string as a
  3283. * prefix. This is a possible security hazard. Notice level errors are
  3284. * not displayed using the default error reporting level.
  3285. * </p>
  3286. * @return bool Returns true on success or false on failure.
  3287. */
  3288. function import_request_variables ($types, $prefix = null) {}
  3289. /**
  3290. * Send an error message somewhere
  3291. * @link http://www.php.net/manual/en/function.error-log.php
  3292. * @param message string <p>
  3293. * The error message that should be logged.
  3294. * </p>
  3295. * @param message_type int[optional] <p>
  3296. * Says where the error should go. The possible message types are as
  3297. * follows:
  3298. * </p>
  3299. * <p>
  3300. * <table>
  3301. * error_log log types
  3302. * <tr valign="top">
  3303. * <td>0</td>
  3304. * <td>
  3305. * message is sent to PHP's system logger, using
  3306. * the Operating System's system logging mechanism or a file, depending
  3307. * on what the error_log
  3308. * configuration directive is set to. This is the default option.
  3309. * </td>
  3310. * </tr>
  3311. * <tr valign="top">
  3312. * <td>1</td>
  3313. * <td>
  3314. * message is sent by email to the address in
  3315. * the destination parameter. This is the only
  3316. * message type where the fourth parameter,
  3317. * extra_headers is used.
  3318. * </td>
  3319. * </tr>
  3320. * <tr valign="top">
  3321. * <td>2</td>
  3322. * <td>
  3323. * No longer an option.
  3324. * </td>
  3325. * </tr>
  3326. * <tr valign="top">
  3327. * <td>3</td>
  3328. * <td>
  3329. * message is appended to the file
  3330. * destination. A newline is not automatically
  3331. * added to the end of the message string.
  3332. * </td>
  3333. * </tr>
  3334. * <tr valign="top">
  3335. * <td>4</td>
  3336. * <td>
  3337. * message is sent directly to the SAPI logging
  3338. * handler.
  3339. * </td>
  3340. * </tr>
  3341. * </table>
  3342. * </p>
  3343. * @param destination string[optional] <p>
  3344. * The destination. Its meaning depends on the
  3345. * message_type parameter as described above.
  3346. * </p>
  3347. * @param extra_headers string[optional] <p>
  3348. * The extra headers. It's used when the message_type
  3349. * parameter is set to 1.
  3350. * This message type uses the same internal function as
  3351. * mail does.
  3352. * </p>
  3353. * @return bool Returns true on success or false on failure.
  3354. */
  3355. function error_log ($message, $message_type = null, $destination = null, $extra_headers = null) {}
  3356. /**
  3357. * Get the last occurred error
  3358. * @link http://www.php.net/manual/en/function.error-get-last.php
  3359. * @return array an associative array describing the last error with keys "type",
  3360. * "message", "file" and "line". Returns &null; if there hasn't been an error
  3361. * yet.
  3362. */
  3363. function error_get_last () {}
  3364. /**
  3365. * Call a user function given by the first parameter
  3366. * @link http://www.php.net/manual/en/function.call-user-func.php
  3367. * @param function callback <p>
  3368. * The function to be called. Class methods may also be invoked
  3369. * statically using this function by passing
  3370. * array($classname, $methodname) to this parameter.
  3371. * Additionally class methods of an object instance may be called by passing
  3372. * array($objectinstance, $methodname) to this parameter.
  3373. * </p>
  3374. * @param parameter mixed[optional] <p>
  3375. * Zero or more parameters to be passed to the function.
  3376. * </p>
  3377. * <p>
  3378. * Note that the parameters for call_user_func are
  3379. * not passed by reference.
  3380. * call_user_func example and references
  3381. * ]]>
  3382. * &example.outputs;
  3383. * </p>
  3384. * @param _ mixed[optional]
  3385. * @return mixed the function result, or false on error.
  3386. */
  3387. function call_user_func ($function, $parameter = null, $_ = null) {}
  3388. /**
  3389. * Call a user function given with an array of parameters
  3390. * @link http://www.php.net/manual/en/function.call-user-func-array.php
  3391. * @param function callback <p>
  3392. * The function to be called.
  3393. * </p>
  3394. * @param param_arr array <p>
  3395. * The parameters to be passed to the function, as an indexed array.
  3396. * </p>
  3397. * @return mixed the function result, or false on error.
  3398. */
  3399. function call_user_func_array ($function, array $param_arr) {}
  3400. /**
  3401. * Call a user method on an specific object [deprecated]
  3402. * @link http://www.php.net/manual/en/function.call-user-method.php
  3403. * @param method_name string
  3404. * @param obj object
  3405. * @param parameter mixed[optional]
  3406. * @param _ mixed[optional]
  3407. * @return mixed
  3408. */
  3409. function call_user_method ($method_name, &$obj, $parameter = null, $_ = null) {}
  3410. /**
  3411. * Call a user method given with an array of parameters [deprecated]
  3412. * @link http://www.php.net/manual/en/function.call-user-method-array.php
  3413. * @param method_name string
  3414. * @param obj object
  3415. * @param params array
  3416. * @return mixed
  3417. */
  3418. function call_user_method_array ($method_name, &$obj, array $params) {}
  3419. /**
  3420. * Generates a storable representation of a value
  3421. * @link http://www.php.net/manual/en/function.serialize.php
  3422. * @param value mixed <p>
  3423. * The value to be serialized. serialize
  3424. * handles all types, except the resource-type.
  3425. * You can even serialize arrays that contain
  3426. * references to itself. Circular references inside the array/object you
  3427. * are serializing will also be stored. Any other
  3428. * reference will be lost.
  3429. * </p>
  3430. * <p>
  3431. * When serializing objects, PHP will attempt to call the member function
  3432. * __sleep prior to serialization.
  3433. * This is to allow the object to do any last minute clean-up, etc. prior
  3434. * to being serialized. Likewise, when the object is restored using
  3435. * unserialize the __wakeup member function is called.
  3436. * </p>
  3437. * <p>
  3438. * Object's private members have the class name prepended to the member
  3439. * name; protected members have a '*' prepended to the member name.
  3440. * These prepended values have null bytes on either side.
  3441. * </p>
  3442. * @return string a string containing a byte-stream representation of
  3443. * value that can be stored anywhere.
  3444. */
  3445. function serialize ($value) {}
  3446. /**
  3447. * Creates a PHP value from a stored representation
  3448. * @link http://www.php.net/manual/en/function.unserialize.php
  3449. * @param str string <p>
  3450. * The serialized string.
  3451. * </p>
  3452. * <p>
  3453. * If the variable being unserialized is an object, after successfully
  3454. * reconstructing the object PHP will automatically attempt to call the
  3455. * __wakeup member function (if it exists).
  3456. * </p>
  3457. * <p>
  3458. * unserialize_callback_func directive
  3459. * <p>
  3460. * It's possible to set a callback-function which will be called,
  3461. * if an undefined class should be instantiated during unserializing.
  3462. * (to prevent getting an incomplete object "__PHP_Incomplete_Class".)
  3463. * Use your &php.ini;, ini_set or &htaccess;
  3464. * to define 'unserialize_callback_func'. Everytime an undefined class
  3465. * should be instantiated, it'll be called. To disable this feature just
  3466. * empty this setting.
  3467. * </p>
  3468. * </p>
  3469. * @return mixed The converted value is returned, and can be a boolean,
  3470. * integer, float, string,
  3471. * array or object.
  3472. * </p>
  3473. * <p>
  3474. * In case the passed string is not unserializeable, false is returned and
  3475. * E_NOTICE is issued.
  3476. */
  3477. function unserialize ($str) {}
  3478. /**
  3479. * Dumps information about a variable
  3480. * @link http://www.php.net/manual/en/function.var-dump.php
  3481. * @param expression mixed <p>
  3482. * The variable you want to export.
  3483. * </p>
  3484. * @param expression mixed[optional]
  3485. * @return void
  3486. */
  3487. function var_dump ($expression, $expression = null) {}
  3488. /**
  3489. * Outputs or returns a parsable string representation of a variable
  3490. * @link http://www.php.net/manual/en/function.var-export.php
  3491. * @param expression mixed <p>
  3492. * The variable you want to export.
  3493. * </p>
  3494. * @param return bool[optional] <p>
  3495. * If used and set to true, var_export will return
  3496. * the variable representation instead of outputing it.
  3497. * </p>
  3498. * &note.uses-ob;
  3499. * @return mixed the variable representation when the return
  3500. * parameter is used and evaluates to true. Otherwise, this function will
  3501. * return &null;.
  3502. */
  3503. function var_export ($expression, $return = null) {}
  3504. /**
  3505. * Dumps a string representation of an internal zend value to output
  3506. * @link http://www.php.net/manual/en/function.debug-zval-dump.php
  3507. * @param variable mixed <p>
  3508. * The variable being evaluated.
  3509. * </p>
  3510. * @return void
  3511. */
  3512. function debug_zval_dump ($variable) {}
  3513. /**
  3514. * Prints human-readable information about a variable
  3515. * @link http://www.php.net/manual/en/function.print-r.php
  3516. * @param expression mixed <p>
  3517. * The expression to be printed.
  3518. * </p>
  3519. * @param return bool[optional] <p>
  3520. * If you would like to capture the output of print_r,
  3521. * use the return parameter. When this parameter is set
  3522. * to true, print_r will return the information rather than print it.
  3523. * </p>
  3524. * @return mixed If given a string, integer or float,
  3525. * the value itself will be printed. If given an array, values
  3526. * will be presented in a format that shows keys and elements. Similar
  3527. * notation is used for objects.
  3528. * </p>
  3529. * <p>
  3530. * When the return parameter is true, this function
  3531. * will return a string. Otherwise, the return value is true.
  3532. */
  3533. function print_r ($expression, $return = null) {}
  3534. /**
  3535. * Returns the amount of memory allocated to PHP
  3536. * @link http://www.php.net/manual/en/function.memory-get-usage.php
  3537. * @param real_usage bool[optional] <p>
  3538. * Set this to true to get the real size of memory allocated from
  3539. * system. If not set or false only the memory used by
  3540. * emalloc() is reported.
  3541. * </p>
  3542. * @return int the memory amount in bytes.
  3543. */
  3544. function memory_get_usage ($real_usage = null) {}
  3545. /**
  3546. * Returns the peak of memory allocated by PHP
  3547. * @link http://www.php.net/manual/en/function.memory-get-peak-usage.php
  3548. * @param real_usage bool[optional] <p>
  3549. * Set this to true to get the real size of memory allocated from
  3550. * system. If not set or false only the memory used by
  3551. * emalloc() is reported.
  3552. * </p>
  3553. * @return int the memory peak in bytes.
  3554. */
  3555. function memory_get_peak_usage ($real_usage = null) {}
  3556. /**
  3557. * Register a function for execution on shutdown
  3558. * @link http://www.php.net/manual/en/function.register-shutdown-function.php
  3559. * @param function callback <p>
  3560. * The shutdown function to register.
  3561. * </p>
  3562. * <p>
  3563. * The shutdown functions are called as the part of the request so that
  3564. * it's possible to send the output from them. There is currently no way
  3565. * to process the data with output buffering functions in the shutdown
  3566. * function.
  3567. * </p>
  3568. * <p>
  3569. * Shutdown functions are called after closing all opened output buffers
  3570. * thus, for example, its output will not be compressed if zlib.output_compression is
  3571. * enabled.
  3572. * </p>
  3573. * @param parameter mixed[optional] <p>
  3574. * It is possible to pass parameters to the shutdown function by passing
  3575. * additional parameters.
  3576. * </p>
  3577. * @param _ mixed[optional]
  3578. * @return void
  3579. */
  3580. function register_shutdown_function ($function, $parameter = null, $_ = null) {}
  3581. /**
  3582. * Register a function for execution on each tick
  3583. * @link http://www.php.net/manual/en/function.register-tick-function.php
  3584. * @param function callback <p>
  3585. * The function name as a string, or an array consisting of an object and
  3586. * a method.
  3587. * </p>
  3588. * @param arg mixed[optional] <p>
  3589. * </p>
  3590. * @param _ mixed[optional]
  3591. * @return bool Returns true on success or false on failure.
  3592. */
  3593. function register_tick_function ($function, $arg = null, $_ = null) {}
  3594. /**
  3595. * De-register a function for execution on each tick
  3596. * @link http://www.php.net/manual/en/function.unregister-tick-function.php
  3597. * @param function_name string <p>
  3598. * The function name, as a string.
  3599. * </p>
  3600. * @return void
  3601. */
  3602. function unregister_tick_function ($function_name) {}
  3603. /**
  3604. * Syntax highlighting of a file
  3605. * @link http://www.php.net/manual/en/function.highlight-file.php
  3606. * @param filename string <p>
  3607. * Path to the PHP file to be highlighted.
  3608. * </p>
  3609. * @param return bool[optional] <p>
  3610. * Set this parameter to true to make this function return the
  3611. * highlighted code.
  3612. * </p>
  3613. * @return mixed If return is set to true, returns the highlighted
  3614. * code as a string instead of printing it out. Otherwise, it will return
  3615. * true on success, false on failure.
  3616. */
  3617. function highlight_file ($filename, $return = null) {}
  3618. /**
  3619. * &Alias; <function>highlight_file</function>
  3620. * @link http://www.php.net/manual/en/function.show-source.php
  3621. * @param file_name
  3622. * @param return[optional]
  3623. */
  3624. function show_source ($file_name, $return) {}
  3625. /**
  3626. * Syntax highlighting of a string
  3627. * @link http://www.php.net/manual/en/function.highlight-string.php
  3628. * @param str string <p>
  3629. * The PHP code to be highlighted. This should include the opening tag.
  3630. * </p>
  3631. * @param return bool[optional] <p>
  3632. * Set this parameter to true to make this function return the
  3633. * highlighted code.
  3634. * </p>
  3635. * @return mixed If return is set to true, returns the highlighted
  3636. * code as a string instead of printing it out. Otherwise, it will return
  3637. * true on success, false on failure.
  3638. */
  3639. function highlight_string ($str, $return = null) {}
  3640. /**
  3641. * Return source with stripped comments and whitespace
  3642. * @link http://www.php.net/manual/en/function.php-strip-whitespace.php
  3643. * @param filename string <p>
  3644. * Path to the PHP file.
  3645. * </p>
  3646. * @return string The stripped source code will be returned on success, or an empty string
  3647. * on failure.
  3648. * </p>
  3649. * <p>
  3650. * This function works as described as of PHP 5.0.1. Before this it would
  3651. * only return an empty string. For more information on this bug and its
  3652. * prior behavior, see bug report
  3653. * #29606.
  3654. */
  3655. function php_strip_whitespace ($filename) {}
  3656. /**
  3657. * Gets the value of a configuration option
  3658. * @link http://www.php.net/manual/en/function.ini-get.php
  3659. * @param varname string <p>
  3660. * The configuration option name.
  3661. * </p>
  3662. * @return string the value of the configuration option as a string on success, or
  3663. * an empty string on failure or for null values.
  3664. */
  3665. function ini_get ($varname) {}
  3666. /**
  3667. * Gets all configuration options
  3668. * @link http://www.php.net/manual/en/function.ini-get-all.php
  3669. * @param extension string[optional] <p>
  3670. * An optional extension name. If set, the function return only options
  3671. * specific for that extension.
  3672. * </p>
  3673. * @param details bool[optional] <p>
  3674. * Retrieve details settings or only the current value for each setting.
  3675. * Default is true (retrieve details).
  3676. * </p>
  3677. * @return array an associative array with directive name as the array key.
  3678. * </p>
  3679. * <p>
  3680. * When details is true (default) the array will
  3681. * contain global_value (set in
  3682. * &php.ini;), local_value (perhaps set with
  3683. * ini_set or &htaccess;), and
  3684. * access (the access level).
  3685. * </p>
  3686. * <p>
  3687. * When details is false the value will be the
  3688. * current value of the option.
  3689. * </p>
  3690. * <p>
  3691. * See the manual section
  3692. * for information on what access levels mean.
  3693. * </p>
  3694. * <p>
  3695. * It's possible for a directive to have multiple access levels, which is
  3696. * why access shows the appropriate bitmask values.
  3697. */
  3698. function ini_get_all ($extension = null, $details = null) {}
  3699. /**
  3700. * Sets the value of a configuration option
  3701. * @link http://www.php.net/manual/en/function.ini-set.php
  3702. * @param varname string <p>
  3703. * </p>
  3704. * <p>
  3705. * Not all the available options can be changed using
  3706. * ini_set. There is a list of all available options
  3707. * in the appendix.
  3708. * </p>
  3709. * @param newvalue string <p>
  3710. * The new value for the option.
  3711. * </p>
  3712. * @return string the old value on success, false on failure.
  3713. */
  3714. function ini_set ($varname, $newvalue) {}
  3715. /**
  3716. * &Alias; <function>ini_set</function>
  3717. * @link http://www.php.net/manual/en/function.ini-alter.php
  3718. * @param varname
  3719. * @param newvalue
  3720. */
  3721. function ini_alter ($varname, $newvalue) {}
  3722. /**
  3723. * Restores the value of a configuration option
  3724. * @link http://www.php.net/manual/en/function.ini-restore.php
  3725. * @param varname string <p>
  3726. * The configuration option name.
  3727. * </p>
  3728. * @return void
  3729. */
  3730. function ini_restore ($varname) {}
  3731. /**
  3732. * Gets the current include_path configuration option
  3733. * @link http://www.php.net/manual/en/function.get-include-path.php
  3734. * @return string the path, as a string.
  3735. */
  3736. function get_include_path () {}
  3737. /**
  3738. * Sets the include_path configuration option
  3739. * @link http://www.php.net/manual/en/function.set-include-path.php
  3740. * @param new_include_path string <p>
  3741. * The new value for the include_path
  3742. * </p>
  3743. * @return string the old include_path on
  3744. * success&return.falseforfailure;.
  3745. */
  3746. function set_include_path ($new_include_path) {}
  3747. /**
  3748. * Restores the value of the include_path configuration option
  3749. * @link http://www.php.net/manual/en/function.restore-include-path.php
  3750. * @return void
  3751. */
  3752. function restore_include_path () {}
  3753. /**
  3754. * Send a cookie
  3755. * @link http://www.php.net/manual/en/function.setcookie.php
  3756. * @param name string <p>
  3757. * The name of the cookie.
  3758. * </p>
  3759. * @param value string[optional] <p>
  3760. * The value of the cookie. This value is stored on the clients
  3761. * computer; do not store sensitive information.
  3762. * Assuming the name is 'cookiename', this
  3763. * value is retrieved through $_COOKIE['cookiename']
  3764. * </p>
  3765. * @param expire int[optional] <p>
  3766. * The time the cookie expires. This is a Unix timestamp so is
  3767. * in number of seconds since the epoch. In other words, you'll
  3768. * most likely set this with the time function
  3769. * plus the number of seconds before you want it to expire. Or
  3770. * you might use mktime.
  3771. * time()+60*60*24*30 will set the cookie to
  3772. * expire in 30 days. If set to 0, or omitted, the cookie will expire at
  3773. * the end of the session (when the browser closes).
  3774. * </p>
  3775. * <p>
  3776. * <p>
  3777. * You may notice the expire parameter takes on a
  3778. * Unix timestamp, as opposed to the date format Wdy, DD-Mon-YYYY
  3779. * HH:MM:SS GMT, this is because PHP does this conversion
  3780. * internally.
  3781. * </p>
  3782. * <p>
  3783. * expire is compared to the client's time which can
  3784. * differ from server's time.
  3785. * </p>
  3786. * </p>
  3787. * @param path string[optional] <p>
  3788. * The path on the server in which the cookie will be available on.
  3789. * If set to '/', the cookie will be available
  3790. * within the entire domain. If set to
  3791. * '/foo/', the cookie will only be available
  3792. * within the /foo/ directory and all
  3793. * sub-directories such as /foo/bar/ of
  3794. * domain. The default value is the
  3795. * current directory that the cookie is being set in.
  3796. * </p>
  3797. * @param domain string[optional] <p>
  3798. * The domain that the cookie is available.
  3799. * To make the cookie available on all subdomains of example.com
  3800. * then you'd set it to '.example.com'. The
  3801. * . is not required but makes it compatible
  3802. * with more browsers. Setting it to www.example.com
  3803. * will make the cookie only available in the www
  3804. * subdomain. Refer to tail matching in the
  3805. * spec for details.
  3806. * </p>
  3807. * @param secure bool[optional] <p>
  3808. * Indicates that the cookie should only be transmitted over a
  3809. * secure HTTPS connection from the client. When set to true, the
  3810. * cookie will only be set if a secure connection exists.
  3811. * On the server-side, it's on the programmer to send this
  3812. * kind of cookie only on secure connection (e.g. with respect to
  3813. * $_SERVER["HTTPS"]).
  3814. * </p>
  3815. * @param httponly bool[optional] <p>
  3816. * When true the cookie will be made accessible only through the HTTP
  3817. * protocol. This means that the cookie won't be accessible by
  3818. * scripting languages, such as JavaScript. This setting can effectively
  3819. * help to reduce identity theft through XSS attacks (although it is
  3820. * not supported by all browsers). Added in PHP 5.2.0.
  3821. * true or false
  3822. * </p>
  3823. * @return bool If output exists prior to calling this function,
  3824. * setcookie will fail and return false. If
  3825. * setcookie successfully runs, it will return true.
  3826. * This does not indicate whether the user accepted the cookie.
  3827. */
  3828. function setcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  3829. /**
  3830. * Send a cookie without urlencoding the cookie value
  3831. * @link http://www.php.net/manual/en/function.setrawcookie.php
  3832. * @param name string
  3833. * @param value string[optional]
  3834. * @param expire int[optional]
  3835. * @param path string[optional]
  3836. * @param domain string[optional]
  3837. * @param secure bool[optional]
  3838. * @param httponly bool[optional]
  3839. * @return bool Returns true on success or false on failure.
  3840. */
  3841. function setrawcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  3842. /**
  3843. * Send a raw HTTP header
  3844. * @link http://www.php.net/manual/en/function.header.php
  3845. * @param string string <p>
  3846. * The header string.
  3847. * </p>
  3848. * <p>
  3849. * There are two special-case header calls. The first is a header
  3850. * that starts with the string "HTTP/" (case is not
  3851. * significant), which will be used to figure out the HTTP status
  3852. * code to send. For example, if you have configured Apache to
  3853. * use a PHP script to handle requests for missing files (using
  3854. * the ErrorDocument directive), you may want to
  3855. * make sure that your script generates the proper status code.
  3856. * </p>
  3857. * <p>
  3858. * ]]>
  3859. * </p>
  3860. * <p>
  3861. * The second special case is the "Location:" header. Not only does
  3862. * it send this header back to the browser, but it also returns a
  3863. * REDIRECT (302) status code to the browser
  3864. * unless the 201 or
  3865. * a 3xx status code has already been set.
  3866. * </p>
  3867. * <p>
  3868. * ]]>
  3869. * </p>
  3870. * @param replace bool[optional] <p>
  3871. * The optional replace parameter indicates
  3872. * whether the header should replace a previous similar header, or
  3873. * add a second header of the same type. By default it will replace,
  3874. * but if you pass in false as the second argument you can force
  3875. * multiple headers of the same type. For example:
  3876. * </p>
  3877. * <p>
  3878. * ]]>
  3879. * </p>
  3880. * @param http_response_code int[optional] <p>
  3881. * Forces the HTTP response code to the specified value.
  3882. * </p>
  3883. * @return void
  3884. */
  3885. function header ($string, $replace = null, $http_response_code = null) {}
  3886. /**
  3887. * Checks if or where headers have been sent
  3888. * @link http://www.php.net/manual/en/function.headers-sent.php
  3889. * @param file string[optional] <p>
  3890. * If the optional file and
  3891. * line parameters are set,
  3892. * headers_sent will put the PHP source file name
  3893. * and line number where output started in the file
  3894. * and line variables.
  3895. * </p>
  3896. * @param line int[optional] <p>
  3897. * The line number where the output started.
  3898. * </p>
  3899. * @return bool headers_sent will return false if no HTTP headers
  3900. * have already been sent or true otherwise.
  3901. */
  3902. function headers_sent (&$file = null, &$line = null) {}
  3903. /**
  3904. * Returns a list of response headers sent (or ready to send)
  3905. * @link http://www.php.net/manual/en/function.headers-list.php
  3906. * @return array a numerically indexed array of headers.
  3907. */
  3908. function headers_list () {}
  3909. /**
  3910. * Check whether client disconnected
  3911. * @link http://www.php.net/manual/en/function.connection-aborted.php
  3912. * @return int 1 if client disconnected, 0 otherwise.
  3913. */
  3914. function connection_aborted () {}
  3915. /**
  3916. * Returns connection status bitfield
  3917. * @link http://www.php.net/manual/en/function.connection-status.php
  3918. * @return int the connection status bitfield, which can be used against the
  3919. * CONNECTION_XXX constants to determine the connection
  3920. * status.
  3921. */
  3922. function connection_status () {}
  3923. /**
  3924. * Set whether a client disconnect should abort script execution
  3925. * @link http://www.php.net/manual/en/function.ignore-user-abort.php
  3926. * @param value string[optional] <p>
  3927. * If set, this function will set the ignore_user_abort ini setting
  3928. * to the given value. If not, this function will
  3929. * only return the previous setting without changing it.
  3930. * </p>
  3931. * @return int the previous setting, as an integer.
  3932. */
  3933. function ignore_user_abort ($value = null) {}
  3934. /**
  3935. * Parse a configuration file
  3936. * @link http://www.php.net/manual/en/function.parse-ini-file.php
  3937. * @param filename string <p>
  3938. * The filename of the ini file being parsed.
  3939. * </p>
  3940. * @param process_sections bool[optional] <p>
  3941. * By setting the process_sections
  3942. * parameter to true, you get a multidimensional array, with
  3943. * the section names and settings included. The default
  3944. * for process_sections is false
  3945. * </p>
  3946. * @param scanner_mode int[optional] <p>
  3947. * Can either be INI_SCANNER_NORMAL (default) or
  3948. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  3949. * is supplied, then option values will not be parsed.
  3950. * </p>
  3951. * @return array The settings are returned as an associative array on success,
  3952. * and false on failure.
  3953. */
  3954. function parse_ini_file ($filename, $process_sections = null, $scanner_mode = null) {}
  3955. /**
  3956. * Tells whether the file was uploaded via HTTP POST
  3957. * @link http://www.php.net/manual/en/function.is-uploaded-file.php
  3958. * @param filename string <p>
  3959. * The filename being checked.
  3960. * </p>
  3961. * @return bool Returns true on success or false on failure.
  3962. */
  3963. function is_uploaded_file ($filename) {}
  3964. /**
  3965. * Moves an uploaded file to a new location
  3966. * @link http://www.php.net/manual/en/function.move-uploaded-file.php
  3967. * @param filename string <p>
  3968. * The filename of the uploaded file.
  3969. * </p>
  3970. * @param destination string <p>
  3971. * The destination of the moved file.
  3972. * </p>
  3973. * @return bool If filename is not a valid upload file,
  3974. * then no action will occur, and
  3975. * move_uploaded_file will return
  3976. * false.
  3977. * </p>
  3978. * <p>
  3979. * If filename is a valid upload file, but
  3980. * cannot be moved for some reason, no action will occur, and
  3981. * move_uploaded_file will return
  3982. * false. Additionally, a warning will be issued.
  3983. */
  3984. function move_uploaded_file ($filename, $destination) {}
  3985. /**
  3986. * Get the Internet host name corresponding to a given IP address
  3987. * @link http://www.php.net/manual/en/function.gethostbyaddr.php
  3988. * @param ip_address string <p>
  3989. * The host IP address.
  3990. * </p>
  3991. * @return string the host name or the unmodified ip_address
  3992. * on failure.
  3993. */
  3994. function gethostbyaddr ($ip_address) {}
  3995. /**
  3996. * Get the IPv4 address corresponding to a given Internet host name
  3997. * @link http://www.php.net/manual/en/function.gethostbyname.php
  3998. * @param hostname string <p>
  3999. * The host name.
  4000. * </p>
  4001. * @return string the IPv4 address or a string containing the unmodified
  4002. * hostname on failure.
  4003. */
  4004. function gethostbyname ($hostname) {}
  4005. /**
  4006. * Get a list of IPv4 addresses corresponding to a given Internet host
  4007. name
  4008. * @link http://www.php.net/manual/en/function.gethostbynamel.php
  4009. * @param hostname string <p>
  4010. * The host name.
  4011. * </p>
  4012. * @return array an array of IPv4 addresses or false if
  4013. * hostname could not be resolved.
  4014. */
  4015. function gethostbynamel ($hostname) {}
  4016. /**
  4017. * Get the integer value of a variable
  4018. * @link http://www.php.net/manual/en/function.intval.php
  4019. * @param var mixed <p>
  4020. * The scalar value being converted to an integer
  4021. * </p>
  4022. * @param base int[optional] <p>
  4023. * The base for the conversion
  4024. * </p>
  4025. * @return int The integer value of var on success, or 0 on
  4026. * failure. Empty arrays and objects return 0, non-empty arrays and
  4027. * objects return 1.
  4028. * </p>
  4029. * <p>
  4030. * The maximum value depends on the system. 32 bit systems have a
  4031. * maximum signed integer range of -2147483648 to 2147483647. So for example
  4032. * on such a system, intval('1000000000000') will return
  4033. * 2147483647. The maximum signed integer value for 64 bit systems is
  4034. * 9223372036854775807.
  4035. * </p>
  4036. * <p>
  4037. * Strings will most likely return 0 although this depends on the
  4038. * leftmost characters of the string. The common rules of
  4039. * integer casting
  4040. * apply.
  4041. */
  4042. function intval ($var, $base = null) {}
  4043. /**
  4044. * Get float value of a variable
  4045. * @link http://www.php.net/manual/en/function.floatval.php
  4046. * @param var mixed <p>
  4047. * May be any scalar type. floatval should not be used
  4048. * on objects, as doing so will emit an E_NOTICE level
  4049. * error and return 1.
  4050. * </p>
  4051. * @return float The float value of the given variable. Empty arrays return 0, non-empty
  4052. * arrays return 1.
  4053. */
  4054. function floatval ($var) {}
  4055. /**
  4056. * &Alias; <function>floatval</function>
  4057. * @link http://www.php.net/manual/en/function.doubleval.php
  4058. * @param var
  4059. */
  4060. function doubleval ($var) {}
  4061. /**
  4062. * Get string value of a variable
  4063. * @link http://www.php.net/manual/en/function.strval.php
  4064. * @param var mixed <p>
  4065. * The variable that is being converted to a string.
  4066. * </p>
  4067. * <p>
  4068. * var may be any scalar type. You cannot use
  4069. * strval on arrays or objects.
  4070. * </p>
  4071. * @return string The string value of var.
  4072. */
  4073. function strval ($var) {}
  4074. /**
  4075. * Get the type of a variable
  4076. * @link http://www.php.net/manual/en/function.gettype.php
  4077. * @param var mixed <p>
  4078. * The variable being type checked.
  4079. * </p>
  4080. * @return string Possibles values for the returned string are:
  4081. * "boolean"
  4082. * "integer"
  4083. * "double" (for historical reasons "double" is
  4084. * returned in case of a float, and not simply
  4085. * "float")
  4086. * "string"
  4087. * "array"
  4088. * "object"
  4089. * "resource"
  4090. * "NULL"
  4091. * "unknown type"
  4092. */
  4093. function gettype ($var) {}
  4094. /**
  4095. * Set the type of a variable
  4096. * @link http://www.php.net/manual/en/function.settype.php
  4097. * @param var mixed <p>
  4098. * The variable being converted.
  4099. * </p>
  4100. * @param type string <p>
  4101. * Possibles values of type are:
  4102. * "boolean" (or, since PHP 4.2.0, "bool")
  4103. * @return bool Returns true on success or false on failure.
  4104. */
  4105. function settype (&$var, $type) {}
  4106. /**
  4107. * Finds whether a variable is &null;
  4108. * @link http://www.php.net/manual/en/function.is-null.php
  4109. * @param var mixed <p>
  4110. * The variable being evaluated.
  4111. * </p>
  4112. * @return bool true if var is null, false
  4113. * otherwise.
  4114. */
  4115. function is_null ($var) {}
  4116. /**
  4117. * Finds whether a variable is a resource
  4118. * @link http://www.php.net/manual/en/function.is-resource.php
  4119. * @param var mixed <p>
  4120. * The variable being evaluated.
  4121. * </p>
  4122. * @return bool true if var is a resource,
  4123. * false otherwise.
  4124. */
  4125. function is_resource ($var) {}
  4126. /**
  4127. * Finds out whether a variable is a boolean
  4128. * @link http://www.php.net/manual/en/function.is-bool.php
  4129. * @param var mixed <p>
  4130. * The variable being evaluated.
  4131. * </p>
  4132. * @return bool true if var is a boolean,
  4133. * false otherwise.
  4134. */
  4135. function is_bool ($var) {}
  4136. /**
  4137. * &Alias; <function>is_int</function>
  4138. * @link http://www.php.net/manual/en/function.is-long.php
  4139. * @param var
  4140. */
  4141. function is_long ($var) {}
  4142. /**
  4143. * Finds whether the type of a variable is float
  4144. * @link http://www.php.net/manual/en/function.is-float.php
  4145. * @param var mixed <p>
  4146. * The variable being evaluated.
  4147. * </p>
  4148. * @return bool true if var is a float,
  4149. * false otherwise.
  4150. */
  4151. function is_float ($var) {}
  4152. /**
  4153. * Find whether the type of a variable is integer
  4154. * @link http://www.php.net/manual/en/function.is-int.php
  4155. * @param var mixed <p>
  4156. * The variable being evaluated.
  4157. * </p>
  4158. * @return bool true if var is an integer,
  4159. * false otherwise.
  4160. */
  4161. function is_int ($var) {}
  4162. /**
  4163. * &Alias; <function>is_int</function>
  4164. * @link http://www.php.net/manual/en/function.is-integer.php
  4165. * @param var
  4166. */
  4167. function is_integer ($var) {}
  4168. /**
  4169. * &Alias; <function>is_float</function>
  4170. * @link http://www.php.net/manual/en/function.is-double.php
  4171. * @param var
  4172. */
  4173. function is_double ($var) {}
  4174. /**
  4175. * &Alias; <function>is_float</function>
  4176. * @link http://www.php.net/manual/en/function.is-real.php
  4177. * @param var
  4178. */
  4179. function is_real ($var) {}
  4180. /**
  4181. * Finds whether a variable is a number or a numeric string
  4182. * @link http://www.php.net/manual/en/function.is-numeric.php
  4183. * @param var mixed <p>
  4184. * The variable being evaluated.
  4185. * </p>
  4186. * @return bool true if var is a number or a numeric
  4187. * string, false otherwise.
  4188. */
  4189. function is_numeric ($var) {}
  4190. /**
  4191. * Find whether the type of a variable is string
  4192. * @link http://www.php.net/manual/en/function.is-string.php
  4193. * @param var mixed <p>
  4194. * The variable being evaluated.
  4195. * </p>
  4196. * @return bool true if var is of type string,
  4197. * false otherwise.
  4198. */
  4199. function is_string ($var) {}
  4200. /**
  4201. * Finds whether a variable is an array
  4202. * @link http://www.php.net/manual/en/function.is-array.php
  4203. * @param var mixed <p>
  4204. * The variable being evaluated.
  4205. * </p>
  4206. * @return bool true if var is an array,
  4207. * false otherwise.
  4208. */
  4209. function is_array ($var) {}
  4210. /**
  4211. * Finds whether a variable is an object
  4212. * @link http://www.php.net/manual/en/function.is-object.php
  4213. * @param var mixed <p>
  4214. * The variable being evaluated.
  4215. * </p>
  4216. * @return bool true if var is an object,
  4217. * false otherwise.
  4218. */
  4219. function is_object ($var) {}
  4220. /**
  4221. * Finds whether a variable is a scalar
  4222. * @link http://www.php.net/manual/en/function.is-scalar.php
  4223. * @param var mixed <p>
  4224. * The variable being evaluated.
  4225. * </p>
  4226. * @return bool true if var is a scalar false
  4227. * otherwise.
  4228. */
  4229. function is_scalar ($var) {}
  4230. /**
  4231. * Verify that the contents of a variable can be called as a function
  4232. * @link http://www.php.net/manual/en/function.is-callable.php
  4233. * @param name callback <p>
  4234. * Can be either the name of a function stored in a string variable, or
  4235. * an object and the name of a method within the object, like this:
  4236. * array($SomeObject, 'MethodName')
  4237. * </p>
  4238. * @param syntax_only bool[optional] <p>
  4239. * If set to true the function only verifies that
  4240. * name might be a function or method. It will only
  4241. * reject simple variables that are not strings, or an array that does
  4242. * not have a valid structure to be used as a callback. The valid ones
  4243. * are supposed to have only 2 entries, the first of which is an object
  4244. * or a string, and the second a string.
  4245. * </p>
  4246. * @param callable_name string[optional] <p>
  4247. * Receives the "callable name". In the example below it is
  4248. * "someClass::someMethod". Note, however, that despite the implication
  4249. * that someClass::SomeMethod() is a callable static method, this is not
  4250. * the case.
  4251. * </p>
  4252. * @return bool true if name is callable, false
  4253. * otherwise.
  4254. */
  4255. function is_callable ($name, $syntax_only = null, &$callable_name = null) {}
  4256. /**
  4257. * Regular expression match
  4258. * @link http://www.php.net/manual/en/function.ereg.php
  4259. * @param pattern string <p>
  4260. * Case sensitive regular expression.
  4261. * </p>
  4262. * @param string string <p>
  4263. * The input string.
  4264. * </p>
  4265. * @param regs array[optional] <p>
  4266. * If matches are found for parenthesized substrings of
  4267. * pattern and the function is called with the
  4268. * third argument regs, the matches will be stored
  4269. * in the elements of the array regs.
  4270. * </p>
  4271. * <p>
  4272. * $regs[1] will contain the substring which starts at
  4273. * the first left parenthesis; $regs[2] will contain
  4274. * the substring starting at the second, and so on.
  4275. * $regs[0] will contain a copy of the complete string
  4276. * matched.
  4277. * </p>
  4278. * @return int the length of the matched string if a match for
  4279. * pattern was found in string,
  4280. * or false if no matches were found or an error occurred.
  4281. * </p>
  4282. * <p>
  4283. * If the optional parameter regs was not passed or
  4284. * the length of the matched string is 0, this function returns 1.
  4285. */
  4286. function ereg ($pattern, $string, array &$regs = null) {}
  4287. /**
  4288. * Replace regular expression
  4289. * @link http://www.php.net/manual/en/function.ereg-replace.php
  4290. * @param pattern string <p>
  4291. * A POSIX extended regular expression.
  4292. * </p>
  4293. * @param replacement string <p>
  4294. * If pattern contains parenthesized substrings,
  4295. * replacement may contain substrings of the form
  4296. * \\digit, which will be
  4297. * replaced by the text matching the digit'th parenthesized substring;
  4298. * \\0 will produce the entire contents of string.
  4299. * Up to nine substrings may be used. Parentheses may be nested, in which
  4300. * case they are counted by the opening parenthesis.
  4301. * </p>
  4302. * @param string string <p>
  4303. * The input string.
  4304. * </p>
  4305. * @return string The modified string is returned. If no matches are found in
  4306. * string, then it will be returned unchanged.
  4307. */
  4308. function ereg_replace ($pattern, $replacement, $string) {}
  4309. /**
  4310. * Case insensitive regular expression match
  4311. * @link http://www.php.net/manual/en/function.eregi.php
  4312. * @param pattern string <p>
  4313. * Case insensitive regular expression.
  4314. * </p>
  4315. * @param string string <p>
  4316. * The input string.
  4317. * </p>
  4318. * @param regs array[optional] <p>
  4319. * If matches are found for parenthesized substrings of
  4320. * pattern and the function is called with the
  4321. * third argument regs, the matches will be stored
  4322. * in the elements of the array regs.
  4323. * </p>
  4324. * <p>
  4325. * $regs[1] will contain the substring which starts at the first left
  4326. * parenthesis; $regs[2] will contain the substring starting at the
  4327. * second, and so on. $regs[0] will contain a copy of the complete string
  4328. * matched.
  4329. * </p>
  4330. * @return int the length of the matched string if a match for
  4331. * pattern was found in string,
  4332. * or false if no matches were found or an error occurred.
  4333. * </p>
  4334. * <p>
  4335. * If the optional parameter regs was not passed or
  4336. * the length of the matched string is 0, this function returns 1.
  4337. */
  4338. function eregi ($pattern, $string, array &$regs = null) {}
  4339. /**
  4340. * Replace regular expression case insensitive
  4341. * @link http://www.php.net/manual/en/function.eregi-replace.php
  4342. * @param pattern string <p>
  4343. * A POSIX extended regular expression.
  4344. * </p>
  4345. * @param replacement string <p>
  4346. * If pattern contains parenthesized substrings,
  4347. * replacement may contain substrings of the form
  4348. * \\digit, which will be
  4349. * replaced by the text matching the digit'th parenthesized substring;
  4350. * \\0 will produce the entire contents of string.
  4351. * Up to nine substrings may be used. Parentheses may be nested, in which
  4352. * case they are counted by the opening parenthesis.
  4353. * </p>
  4354. * @param string string <p>
  4355. * The input string.
  4356. * </p>
  4357. * @return string The modified string is returned. If no matches are found in
  4358. * string, then it will be returned unchanged.
  4359. */
  4360. function eregi_replace ($pattern, $replacement, $string) {}
  4361. /**
  4362. * Split string into array by regular expression
  4363. * @link http://www.php.net/manual/en/function.split.php
  4364. * @param pattern string <p>
  4365. * Case sensitive regular expression.
  4366. * </p>
  4367. * <p>
  4368. * If you want to split on any of the characters which are considered
  4369. * special by regular expressions, you'll need to escape them first. If
  4370. * you think split (or any other regex function, for
  4371. * that matter) is doing something weird, please read the file
  4372. * regex.7, included in the
  4373. * regex/ subdirectory of the PHP distribution. It's
  4374. * in manpage format, so you'll want to do something along the lines of
  4375. * man /usr/local/src/regex/regex.7 in order to read it.
  4376. * </p>
  4377. * @param string string <p>
  4378. * The input string.
  4379. * </p>
  4380. * @param limit int[optional] <p>
  4381. * If limit is set, the returned array will
  4382. * contain a maximum of limit elements with the
  4383. * last element containing the whole rest of
  4384. * string.
  4385. * </p>
  4386. * @return array an array of strings, each of which is a substring of
  4387. * string formed by splitting it on boundaries formed
  4388. * by the case-sensitive regular expression pattern.
  4389. * </p>
  4390. * <p>
  4391. * If there are n occurrences of
  4392. * pattern, the returned array will contain
  4393. * n+1 items. For example, if
  4394. * there is no occurrence of pattern, an array with
  4395. * only one element will be returned. Of course, this is also true if
  4396. * string is empty. If an error occurs,
  4397. * split returns false.
  4398. */
  4399. function split ($pattern, $string, $limit = null) {}
  4400. /**
  4401. * Split string into array by regular expression case insensitive
  4402. * @link http://www.php.net/manual/en/function.spliti.php
  4403. * @param pattern string <p>
  4404. * Case insensitive regular expression.
  4405. * </p>
  4406. * <p>
  4407. * If you want to split on any of the characters which are considered
  4408. * special by regular expressions, you'll need to escape them first. If
  4409. * you think spliti (or any other regex function, for
  4410. * that matter) is doing something weird, please read the file
  4411. * regex.7, included in the
  4412. * regex/ subdirectory of the PHP distribution. It's
  4413. * in manpage format, so you'll want to do something along the lines of
  4414. * man /usr/local/src/regex/regex.7 in order to read it.
  4415. * </p>
  4416. * @param string string <p>
  4417. * The input string.
  4418. * </p>
  4419. * @param limit int[optional] <p>
  4420. * If limit is set, the returned array will
  4421. * contain a maximum of limit elements with the
  4422. * last element containing the whole rest of
  4423. * string.
  4424. * </p>
  4425. * @return array an array of strings, each of which is a substring of
  4426. * string formed by splitting it on boundaries formed
  4427. * by the case insensitive regular expression pattern.
  4428. * </p>
  4429. * <p>
  4430. * If there are n occurrences of
  4431. * pattern, the returned array will contain
  4432. * n+1 items. For example, if
  4433. * there is no occurrence of pattern, an array with
  4434. * only one element will be returned. Of course, this is also true if
  4435. * string is empty. If an error occurs,
  4436. * spliti returns false.
  4437. */
  4438. function spliti ($pattern, $string, $limit = null) {}
  4439. /**
  4440. * &Alias; <function>implode</function>
  4441. * @link http://www.php.net/manual/en/function.join.php
  4442. * @param glue
  4443. * @param pieces
  4444. */
  4445. function join ($glue, $pieces) {}
  4446. /**
  4447. * Make regular expression for case insensitive match
  4448. * @link http://www.php.net/manual/en/function.sql-regcase.php
  4449. * @param string string <p>
  4450. * The input string.
  4451. * </p>
  4452. * @return string a valid regular expression which will match
  4453. * string, ignoring case. This expression is
  4454. * string with each alphabetic character converted to
  4455. * a bracket expression; this bracket expression contains that character's
  4456. * uppercase and lowercase form. Other characters remain unchanged.
  4457. */
  4458. function sql_regcase ($string) {}
  4459. /**
  4460. * Loads a PHP extension at runtime
  4461. * @link http://www.php.net/manual/en/function.dl.php
  4462. * @param library string <p>
  4463. * This parameter is only the filename of the
  4464. * extension to load which also depends on your platform. For example,
  4465. * the sockets extension (if compiled
  4466. * as a shared module, not the default!) would be called
  4467. * sockets.so on Unix platforms whereas it is called
  4468. * php_sockets.dll on the Windows platform.
  4469. * </p>
  4470. * <p>
  4471. * The directory where the extension is loaded from depends on your
  4472. * platform:
  4473. * </p>
  4474. * <p>
  4475. * Windows - If not explicitly set in the &php.ini;, the extension is
  4476. * loaded from C:\php4\extensions\ (PHP4) or
  4477. * C:\php5\ (PHP5) by default.
  4478. * </p>
  4479. * <p>
  4480. * Unix - If not explicitly set in the &php.ini;, the default extension
  4481. * directory depends on
  4482. * whether PHP has been built with --enable-debug
  4483. * or not
  4484. * @return int Returns true on success or false on failure. If the functionality of loading modules is not available
  4485. * or has been disabled (either by setting
  4486. * enable_dl off or by enabling &safemode;
  4487. * in &php.ini;) an E_ERROR is emitted
  4488. * and execution is stopped. If dl fails because the
  4489. * specified library couldn't be loaded, in addition to false an
  4490. * E_WARNING message is emitted.
  4491. */
  4492. function dl ($library) {}
  4493. /**
  4494. * Closes process file pointer
  4495. * @link http://www.php.net/manual/en/function.pclose.php
  4496. * @param handle resource <p>
  4497. * The file pointer must be valid, and must have been returned by a
  4498. * successful call to popen.
  4499. * </p>
  4500. * @return int the termination status of the process that was run.
  4501. */
  4502. function pclose ($handle) {}
  4503. /**
  4504. * Opens process file pointer
  4505. * @link http://www.php.net/manual/en/function.popen.php
  4506. * @param command string <p>
  4507. * The command
  4508. * </p>
  4509. * @param mode string <p>
  4510. * The mode
  4511. * </p>
  4512. * @return resource a file pointer identical to that returned by
  4513. * fopen, except that it is unidirectional (may
  4514. * only be used for reading or writing) and must be closed with
  4515. * pclose. This pointer may be used with
  4516. * fgets, fgetss, and
  4517. * fwrite.
  4518. * </p>
  4519. * <p>
  4520. * If an error occurs, returns false.
  4521. */
  4522. function popen ($command, $mode) {}
  4523. /**
  4524. * Outputs a file
  4525. * @link http://www.php.net/manual/en/function.readfile.php
  4526. * @param filename string <p>
  4527. * The filename being read.
  4528. * </p>
  4529. * @param use_include_path bool[optional] <p>
  4530. * You can use the optional second parameter and set it to true, if
  4531. * you want to search for the file in the include_path, too.
  4532. * </p>
  4533. * @param context resource[optional] <p>
  4534. * A context stream resource.
  4535. * </p>
  4536. * @return int the number of bytes read from the file. If an error
  4537. * occurs, false is returned and unless the function was called as
  4538. * @readfile, an error message is printed.
  4539. */
  4540. function readfile ($filename, $use_include_path = null, $context = null) {}
  4541. /**
  4542. * Rewind the position of a file pointer
  4543. * @link http://www.php.net/manual/en/function.rewind.php
  4544. * @param handle resource <p>
  4545. * The file pointer must be valid, and must point to a file
  4546. * successfully opened by fopen.
  4547. * </p>
  4548. * @return bool Returns true on success or false on failure.
  4549. */
  4550. function rewind ($handle) {}
  4551. /**
  4552. * Removes directory
  4553. * @link http://www.php.net/manual/en/function.rmdir.php
  4554. * @param dirname string <p>
  4555. * Path to the directory.
  4556. * </p>
  4557. * @param context resource[optional] &note.context-support;
  4558. * @return bool Returns true on success or false on failure.
  4559. */
  4560. function rmdir ($dirname, $context = null) {}
  4561. /**
  4562. * Changes the current umask
  4563. * @link http://www.php.net/manual/en/function.umask.php
  4564. * @param mask int[optional] <p>
  4565. * The new umask.
  4566. * </p>
  4567. * @return int umask without arguments simply returns the
  4568. * current umask otherwise the old umask is returned.
  4569. */
  4570. function umask ($mask = null) {}
  4571. /**
  4572. * Closes an open file pointer
  4573. * @link http://www.php.net/manual/en/function.fclose.php
  4574. * @param handle resource <p>
  4575. * The file pointer must be valid, and must point to a file successfully
  4576. * opened by fopen or fsockopen.
  4577. * </p>
  4578. * @return bool Returns true on success or false on failure.
  4579. */
  4580. function fclose ($handle) {}
  4581. /**
  4582. * Tests for end-of-file on a file pointer
  4583. * @link http://www.php.net/manual/en/function.feof.php
  4584. * @param handle resource &fs.validfp.all;
  4585. * @return bool true if the file pointer is at EOF or an error occurs
  4586. * (including socket timeout); otherwise returns false.
  4587. */
  4588. function feof ($handle) {}
  4589. /**
  4590. * Gets character from file pointer
  4591. * @link http://www.php.net/manual/en/function.fgetc.php
  4592. * @param handle resource &fs.validfp.all;
  4593. * @return string a string containing a single character read from the file pointed
  4594. * to by handle. Returns false on EOF.
  4595. */
  4596. function fgetc ($handle) {}
  4597. /**
  4598. * Gets line from file pointer
  4599. * @link http://www.php.net/manual/en/function.fgets.php
  4600. * @param handle resource &fs.validfp.all;
  4601. * @param length int[optional] <p>
  4602. * Reading ends when length - 1 bytes have been
  4603. * read, on a newline (which is included in the return value), or on EOF
  4604. * (whichever comes first). If no length is specified, it will keep
  4605. * reading from the stream until it reaches the end of the line.
  4606. * </p>
  4607. * <p>
  4608. * Until PHP 4.3.0, omitting it would assume 1024 as the line length.
  4609. * If the majority of the lines in the file are all larger than 8KB,
  4610. * it is more resource efficient for your script to specify the maximum
  4611. * line length.
  4612. * </p>
  4613. * @return string a string of up to length - 1 bytes read from
  4614. * the file pointed to by handle.
  4615. * </p>
  4616. * <p>
  4617. * If an error occurs, returns false.
  4618. */
  4619. function fgets ($handle, $length = null) {}
  4620. /**
  4621. * Gets line from file pointer and strip HTML tags
  4622. * @link http://www.php.net/manual/en/function.fgetss.php
  4623. * @param handle resource &fs.validfp.all;
  4624. * @param length int[optional] <p>
  4625. * Length of the data to be retrieved.
  4626. * </p>
  4627. * @param allowable_tags string[optional] <p>
  4628. * You can use the optional third parameter to specify tags which should
  4629. * not be stripped.
  4630. * </p>
  4631. * @return string a string of up to length - 1 bytes read from
  4632. * the file pointed to by handle, with all HTML and PHP
  4633. * code stripped.
  4634. * </p>
  4635. * <p>
  4636. * If an error occurs, returns false.
  4637. */
  4638. function fgetss ($handle, $length = null, $allowable_tags = null) {}
  4639. /**
  4640. * Binary-safe file read
  4641. * @link http://www.php.net/manual/en/function.fread.php
  4642. * @param handle resource &fs.file.pointer;
  4643. * @param length int <p>
  4644. * Up to length number of bytes read.
  4645. * </p>
  4646. * @return string the read string &return.falseforfailure;.
  4647. */
  4648. function fread ($handle, $length) {}
  4649. /**
  4650. * Opens file or URL
  4651. * @link http://www.php.net/manual/en/function.fopen.php
  4652. * @param filename string <p>
  4653. * If filename is of the form "scheme://...", it
  4654. * is assumed to be a URL and PHP will search for a protocol handler
  4655. * (also known as a wrapper) for that scheme. If no wrappers for that
  4656. * protocol are registered, PHP will emit a notice to help you track
  4657. * potential problems in your script and then continue as though
  4658. * filename specifies a regular file.
  4659. * </p>
  4660. * <p>
  4661. * If PHP has decided that filename specifies
  4662. * a local file, then it will try to open a stream on that file.
  4663. * The file must be accessible to PHP, so you need to ensure that
  4664. * the file access permissions allow this access.
  4665. * If you have enabled &safemode;,
  4666. * or open_basedir further
  4667. * restrictions may apply.
  4668. * </p>
  4669. * <p>
  4670. * If PHP has decided that filename specifies
  4671. * a registered protocol, and that protocol is registered as a
  4672. * network URL, PHP will check to make sure that
  4673. * allow_url_fopen is
  4674. * enabled. If it is switched off, PHP will emit a warning and
  4675. * the fopen call will fail.
  4676. * </p>
  4677. * <p>
  4678. * The list of supported protocols can be found in . Some protocols (also referred to as
  4679. * wrappers) support context
  4680. * and/or &php.ini; options. Refer to the specific page for the
  4681. * protocol in use for a list of options which can be set. (e.g.
  4682. * &php.ini; value user_agent used by the
  4683. * http wrapper).
  4684. * </p>
  4685. * <p>
  4686. * On the Windows platform, be careful to escape any backslashes
  4687. * used in the path to the file, or use forward slashes.
  4688. * ]]>
  4689. * </p>
  4690. * @param mode string <p>
  4691. * The mode parameter specifies the type of access
  4692. * you require to the stream. It may be any of the following:
  4693. * <table>
  4694. * A list of possible modes for fopen
  4695. * using mode
  4696. * <tr valign="top">
  4697. * <td>mode</td>
  4698. * <td>Description</td>
  4699. * </tr>
  4700. * <tr valign="top">
  4701. * <td>'r'</td>
  4702. * <td>
  4703. * Open for reading only; place the file pointer at the
  4704. * beginning of the file.
  4705. * </td>
  4706. * </tr>
  4707. * <tr valign="top">
  4708. * <td>'r+'</td>
  4709. * <td>
  4710. * Open for reading and writing; place the file pointer at
  4711. * the beginning of the file.
  4712. * </td>
  4713. * </tr>
  4714. * <tr valign="top">
  4715. * <td>'w'</td>
  4716. * <td>
  4717. * Open for writing only; place the file pointer at the
  4718. * beginning of the file and truncate the file to zero length.
  4719. * If the file does not exist, attempt to create it.
  4720. * </td>
  4721. * </tr>
  4722. * <tr valign="top">
  4723. * <td>'w+'</td>
  4724. * <td>
  4725. * Open for reading and writing; place the file pointer at
  4726. * the beginning of the file and truncate the file to zero
  4727. * length. If the file does not exist, attempt to create it.
  4728. * </td>
  4729. * </tr>
  4730. * <tr valign="top">
  4731. * <td>'a'</td>
  4732. * <td>
  4733. * Open for writing only; place the file pointer at the end of
  4734. * the file. If the file does not exist, attempt to create it.
  4735. * </td>
  4736. * </tr>
  4737. * <tr valign="top">
  4738. * <td>'a+'</td>
  4739. * <td>
  4740. * Open for reading and writing; place the file pointer at
  4741. * the end of the file. If the file does not exist, attempt to
  4742. * create it.
  4743. * </td>
  4744. * </tr>
  4745. * <tr valign="top">
  4746. * <td>'x'</td>
  4747. * <td>
  4748. * Create and open for writing only; place the file pointer at the
  4749. * beginning of the file. If the file already exists, the
  4750. * fopen call will fail by returning false and
  4751. * generating an error of level E_WARNING. If
  4752. * the file does not exist, attempt to create it. This is equivalent
  4753. * to specifying O_EXCL|O_CREAT flags for the
  4754. * underlying open(2) system call.
  4755. * </td>
  4756. * </tr>
  4757. * <tr valign="top">
  4758. * <td>'x+'</td>
  4759. * <td>
  4760. * Create and open for reading and writing; place the file pointer at
  4761. * the beginning of the file. If the file already exists, the
  4762. * fopen call will fail by returning false and
  4763. * generating an error of level E_WARNING. If
  4764. * the file does not exist, attempt to create it. This is equivalent
  4765. * to specifying O_EXCL|O_CREAT flags for the
  4766. * underlying open(2) system call.
  4767. * </td>
  4768. * </tr>
  4769. * </table>
  4770. * </p>
  4771. * <p>
  4772. * Different operating system families have different line-ending
  4773. * conventions. When you write a text file and want to insert a line
  4774. * break, you need to use the correct line-ending character(s) for your
  4775. * operating system. Unix based systems use \n as the
  4776. * line ending character, Windows based systems use \r\n
  4777. * as the line ending characters and Macintosh based systems use
  4778. * \r as the line ending character.
  4779. * </p>
  4780. * <p>
  4781. * If you use the wrong line ending characters when writing your files, you
  4782. * might find that other applications that open those files will "look
  4783. * funny".
  4784. * </p>
  4785. * <p>
  4786. * Windows offers a text-mode translation flag ('t')
  4787. * which will transparently translate \n to
  4788. * \r\n when working with the file. In contrast, you
  4789. * can also use 'b' to force binary mode, which will not
  4790. * translate your data. To use these flags, specify either
  4791. * 'b' or 't' as the last character
  4792. * of the mode parameter.
  4793. * </p>
  4794. * <p>
  4795. * The default translation mode depends on the SAPI and version of PHP that
  4796. * you are using, so you are encouraged to always specify the appropriate
  4797. * flag for portability reasons. You should use the 't'
  4798. * mode if you are working with plain-text files and you use
  4799. * \n to delimit your line endings in your script, but
  4800. * expect your files to be readable with applications such as notepad. You
  4801. * should use the 'b' in all other cases.
  4802. * </p>
  4803. * <p>
  4804. * If you do not specify the 'b' flag when working with binary files, you
  4805. * may experience strange problems with your data, including broken image
  4806. * files and strange problems with \r\n characters.
  4807. * </p>
  4808. * <p>
  4809. * For portability, it is strongly recommended that you always
  4810. * use the 'b' flag when opening files with fopen.
  4811. * </p>
  4812. * <p>
  4813. * Again, for portability, it is also strongly recommended that
  4814. * you re-write code that uses or relies upon the 't'
  4815. * mode so that it uses the correct line endings and
  4816. * 'b' mode instead.
  4817. * </p>
  4818. * @param use_include_path bool[optional] <p>
  4819. * The optional third use_include_path parameter
  4820. * can be set to '1' or true if you want to search for the file in the
  4821. * include_path, too.
  4822. * </p>
  4823. * @param context resource[optional] &note.context-support;
  4824. * @return resource a file pointer resource on success, or false on error.
  4825. */
  4826. function fopen ($filename, $mode, $use_include_path = null, $context = null) {}
  4827. /**
  4828. * Output all remaining data on a file pointer
  4829. * @link http://www.php.net/manual/en/function.fpassthru.php
  4830. * @param handle resource &fs.validfp.all;
  4831. * @return int If an error occurs, fpassthru returns
  4832. * false. Otherwise, fpassthru returns
  4833. * the number of characters read from handle
  4834. * and passed through to the output.
  4835. */
  4836. function fpassthru ($handle) {}
  4837. /**
  4838. * Truncates a file to a given length
  4839. * @link http://www.php.net/manual/en/function.ftruncate.php
  4840. * @param handle resource <p>
  4841. * The file pointer.
  4842. * </p>
  4843. * <p>
  4844. * The handle must be open for writing.
  4845. * </p>
  4846. * @param size int <p>
  4847. * The size to truncate to.
  4848. * </p>
  4849. * <p>
  4850. * If size is larger than the file it is extended
  4851. * with null bytes.
  4852. * </p>
  4853. * <p>
  4854. * If size is smaller than the extra data
  4855. * will be lost.
  4856. * </p>
  4857. * @return bool Returns true on success or false on failure.
  4858. */
  4859. function ftruncate ($handle, $size) {}
  4860. /**
  4861. * Gets information about a file using an open file pointer
  4862. * @link http://www.php.net/manual/en/function.fstat.php
  4863. * @param handle resource &fs.file.pointer;
  4864. * @return array an array with the statistics of the file; the format of the array
  4865. * is described in detail on the stat manual page.
  4866. */
  4867. function fstat ($handle) {}
  4868. /**
  4869. * Seeks on a file pointer
  4870. * @link http://www.php.net/manual/en/function.fseek.php
  4871. * @param handle resource &fs.file.pointer;
  4872. * @param offset int <p>
  4873. * The offset.
  4874. * </p>
  4875. * <p>
  4876. * To move to a position before the end-of-file, you need to pass
  4877. * a negative value in offset and
  4878. * set whence
  4879. * to SEEK_END.
  4880. * </p>
  4881. * @param whence int[optional] <p>
  4882. * whence values are:
  4883. * SEEK_SET - Set position equal to offset bytes.
  4884. * SEEK_CUR - Set position to current location plus offset.
  4885. * SEEK_END - Set position to end-of-file plus offset.
  4886. * </p>
  4887. * <p>
  4888. * If whence is not specified, it is assumed to be
  4889. * SEEK_SET.
  4890. * </p>
  4891. * @return int Upon success, returns 0; otherwise, returns -1. Note that seeking
  4892. * past EOF is not considered an error.
  4893. */
  4894. function fseek ($handle, $offset, $whence = null) {}
  4895. /**
  4896. * Returns the current position of the file read/write pointer
  4897. * @link http://www.php.net/manual/en/function.ftell.php
  4898. * @param handle resource <p>
  4899. * The file pointer must be valid, and must point to a file successfully
  4900. * opened by fopen or popen.
  4901. * ftell gives undefined results for append-only streams
  4902. * (opened with "a" flag).
  4903. * </p>
  4904. * @return int the position of the file pointer referenced by
  4905. * handle as an integer; i.e., its offset into the file stream.
  4906. * </p>
  4907. * <p>
  4908. * If an error occurs, returns false.
  4909. */
  4910. function ftell ($handle) {}
  4911. /**
  4912. * Flushes the output to a file
  4913. * @link http://www.php.net/manual/en/function.fflush.php
  4914. * @param handle resource &fs.validfp.all;
  4915. * @return bool Returns true on success or false on failure.
  4916. */
  4917. function fflush ($handle) {}
  4918. /**
  4919. * Binary-safe file write
  4920. * @link http://www.php.net/manual/en/function.fwrite.php
  4921. * @param handle resource &fs.file.pointer;
  4922. * @param string string <p>
  4923. * The string that is to be written.
  4924. * </p>
  4925. * @param length int[optional] <p>
  4926. * If the length argument is given, writing will
  4927. * stop after length bytes have been written or
  4928. * the end of string is reached, whichever comes
  4929. * first.
  4930. * </p>
  4931. * <p>
  4932. * Note that if the length argument is given,
  4933. * then the magic_quotes_runtime
  4934. * configuration option will be ignored and no slashes will be
  4935. * stripped from string.
  4936. * </p>
  4937. * @return int
  4938. */
  4939. function fwrite ($handle, $string, $length = null) {}
  4940. /**
  4941. * &Alias; <function>fwrite</function>
  4942. * @link http://www.php.net/manual/en/function.fputs.php
  4943. * @param fp
  4944. * @param str
  4945. * @param length[optional]
  4946. */
  4947. function fputs ($fp, $str, $length) {}
  4948. /**
  4949. * Makes directory
  4950. * @link http://www.php.net/manual/en/function.mkdir.php
  4951. * @param pathname string <p>
  4952. * The directory path.
  4953. * </p>
  4954. * @param mode int[optional] <p>
  4955. * The mode is 0777 by default, which means the widest possible
  4956. * access. For more information on modes, read the details
  4957. * on the chmod page.
  4958. * </p>
  4959. * <p>
  4960. * mode is ignored on Windows.
  4961. * </p>
  4962. * <p>
  4963. * Note that you probably want to specify the mode as an octal number,
  4964. * which means it should have a leading zero. The mode is also modified
  4965. * by the current umask, which you can change using
  4966. * umask.
  4967. * </p>
  4968. * @param recursive bool[optional] <p>
  4969. * Default to false.
  4970. * </p>
  4971. * @param context resource[optional] &note.context-support;
  4972. * @return bool Returns true on success or false on failure.
  4973. */
  4974. function mkdir ($pathname, $mode = null, $recursive = null, $context = null) {}
  4975. /**
  4976. * Renames a file or directory
  4977. * @link http://www.php.net/manual/en/function.rename.php
  4978. * @param oldname string <p>
  4979. * </p>
  4980. * <p>
  4981. * The old name. The wrapper used in oldname
  4982. * must match the wrapper used in
  4983. * newname.
  4984. * </p>
  4985. * @param newname string <p>
  4986. * The new name.
  4987. * </p>
  4988. * @param context resource[optional] &note.context-support;
  4989. * @return bool Returns true on success or false on failure.
  4990. */
  4991. function rename ($oldname, $newname, $context = null) {}
  4992. /**
  4993. * Copies file
  4994. * @link http://www.php.net/manual/en/function.copy.php
  4995. * @param source string <p>
  4996. * Path to the source file.
  4997. * </p>
  4998. * @param dest string <p>
  4999. * The destination path. If dest is a URL, the
  5000. * copy operation may fail if the wrapper does not support overwriting of
  5001. * existing files.
  5002. * </p>
  5003. * <p>
  5004. * If the destination file already exists, it will be overwritten.
  5005. * </p>
  5006. * @param context resource[optional] <p>
  5007. * A valid context resource created with
  5008. * stream_context_create.
  5009. * </p>
  5010. * @return bool Returns true on success or false on failure.
  5011. */
  5012. function copy ($source, $dest, $context = null) {}
  5013. /**
  5014. * Create file with unique file name
  5015. * @link http://www.php.net/manual/en/function.tempnam.php
  5016. * @param dir string <p>
  5017. * The directory where the temporary filename will be created.
  5018. * </p>
  5019. * @param prefix string <p>
  5020. * The prefix of the generated temporary filename.
  5021. * </p>
  5022. * Windows uses only the first three characters of prefix.
  5023. * @return string the new temporary filename, or false on
  5024. * failure.
  5025. */
  5026. function tempnam ($dir, $prefix) {}
  5027. /**
  5028. * Creates a temporary file
  5029. * @link http://www.php.net/manual/en/function.tmpfile.php
  5030. * @return resource a file handle, similar to the one returned by
  5031. * fopen, for the new file&return.falseforfailure;.
  5032. */
  5033. function tmpfile () {}
  5034. /**
  5035. * Reads entire file into an array
  5036. * @link http://www.php.net/manual/en/function.file.php
  5037. * @param filename string <p>
  5038. * Path to the file.
  5039. * </p>
  5040. * &tip.fopen-wrapper;
  5041. * @param flags int[optional] <p>
  5042. * The optional parameter flags can be one, or
  5043. * more, of the following constants:
  5044. * FILE_USE_INCLUDE_PATH
  5045. * Search for the file in the include_path.
  5046. * @param context resource[optional] <p>
  5047. * A context resource created with the
  5048. * stream_context_create function.
  5049. * </p>
  5050. * <p>
  5051. * &note.context-support;
  5052. * </p>
  5053. * @return array the file in an array. Each element of the array corresponds to a
  5054. * line in the file, with the newline still attached. Upon failure,
  5055. * file returns false.
  5056. * </p>
  5057. * <p>
  5058. * Each line in the resulting array will include the line ending, unless
  5059. * FILE_IGNORE_NEW_LINES is used, so you still need to
  5060. * use rtrim if you do not want the line ending
  5061. * present.
  5062. */
  5063. function file ($filename, $flags = null, $context = null) {}
  5064. /**
  5065. * Reads entire file into a string
  5066. * @link http://www.php.net/manual/en/function.file-get-contents.php
  5067. * @param filename string <p>
  5068. * Name of the file to read.
  5069. * </p>
  5070. * @param flags int[optional] <p>
  5071. * Prior to PHP 6, this parameter is called
  5072. * use_include_path and is a bool.
  5073. * As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
  5074. * to trigger include path
  5075. * search.
  5076. * </p>
  5077. * <p>
  5078. * The value of flags can be any combination of
  5079. * the following flags (with some restrictions), joined with the
  5080. * binary OR (|)
  5081. * operator.
  5082. * </p>
  5083. * <p>
  5084. * <table>
  5085. * Available flags
  5086. * <tr valign="top">
  5087. * <td>Flag</td>
  5088. * <td>Description</td>
  5089. * </tr>
  5090. * <tr valign="top">
  5091. * <td>
  5092. * FILE_USE_INCLUDE_PATH
  5093. * </td>
  5094. * <td>
  5095. * Search for filename in the include directory.
  5096. * See include_path for more
  5097. * information.
  5098. * </td>
  5099. * </tr>
  5100. * <tr valign="top">
  5101. * <td>
  5102. * FILE_TEXT
  5103. * </td>
  5104. * <td>
  5105. * As of PHP 6, the default encoding of the read
  5106. * data is UTF-8. You can specify a different encoding by creating a
  5107. * custom context or by changing the default using
  5108. * stream_default_encoding. This flag cannot be
  5109. * used with FILE_BINARY.
  5110. * </td>
  5111. * </tr>
  5112. * <tr valign="top">
  5113. * <td>
  5114. * FILE_BINARY
  5115. * </td>
  5116. * <td>
  5117. * With this flag, the file is read in binary mode. This is the default
  5118. * setting and cannot be used with FILE_TEXT.
  5119. * </td>
  5120. * </tr>
  5121. * </table>
  5122. * </p>
  5123. * @param context resource[optional] <p>
  5124. * A valid context resource created with
  5125. * stream_context_create. If you don't need to use a
  5126. * custom context, you can skip this parameter by &null;.
  5127. * </p>
  5128. * @param offset int[optional] <p>
  5129. * The offset where the reading starts.
  5130. * </p>
  5131. * @param maxlen int[optional] <p>
  5132. * Maximum length of data read. The default is to read until end
  5133. * of file is reached.
  5134. * </p>
  5135. * @return string The function returns the read data&return.falseforfailure;.
  5136. */
  5137. function file_get_contents ($filename, $flags = null, $context = null, $offset = null, $maxlen = null) {}
  5138. /**
  5139. * Write a string to a file
  5140. * @link http://www.php.net/manual/en/function.file-put-contents.php
  5141. * @param filename string <p>
  5142. * Path to the file where to write the data.
  5143. * </p>
  5144. * @param data mixed <p>
  5145. * The data to write. Can be either a string, an
  5146. * array or a stream resource.
  5147. * </p>
  5148. * <p>
  5149. * If data is a stream resource, the
  5150. * remaining buffer of that stream will be copied to the specified file.
  5151. * This is similar with using stream_copy_to_stream.
  5152. * </p>
  5153. * <p>
  5154. * You can also specify the data parameter as a single
  5155. * dimension array. This is equivalent to
  5156. * file_put_contents($filename, implode('', $array)).
  5157. * </p>
  5158. * @param flags int[optional] <p>
  5159. * The value of flags can be any combination of
  5160. * the following flags (with some restrictions), joined with the binary OR
  5161. * (|) operator.
  5162. * </p>
  5163. * <p>
  5164. * <table>
  5165. * Available flags
  5166. * <tr valign="top">
  5167. * <td>Flag</td>
  5168. * <td>Description</td>
  5169. * </tr>
  5170. * <tr valign="top">
  5171. * <td>
  5172. * FILE_USE_INCLUDE_PATH
  5173. * </td>
  5174. * <td>
  5175. * Search for filename in the include directory.
  5176. * See include_path for more
  5177. * information.
  5178. * </td>
  5179. * </tr>
  5180. * <tr valign="top">
  5181. * <td>
  5182. * FILE_APPEND
  5183. * </td>
  5184. * <td>
  5185. * If file filename already exists, append
  5186. * the data to the file instead of overwriting it. Mutually
  5187. * exclusive with LOCK_EX since appends are atomic and thus there
  5188. * is no reason to lock.
  5189. * </td>
  5190. * </tr>
  5191. * <tr valign="top">
  5192. * <td>
  5193. * LOCK_EX
  5194. * </td>
  5195. * <td>
  5196. * Acquire an exclusive lock on the file while proceeding to the
  5197. * writing. Mutually exclusive with FILE_APPEND.
  5198. * </td>
  5199. * </tr>
  5200. * <tr valign="top">
  5201. * <td>
  5202. * FILE_TEXT
  5203. * </td>
  5204. * <td>
  5205. * data is written in text mode. If unicode
  5206. * semantics are enabled, the default encoding is UTF-8.
  5207. * You can specify a different encoding by creating a custom context
  5208. * or by using the stream_default_encoding to
  5209. * change the default. This flag cannot be used with
  5210. * FILE_BINARY. This flag is only available since
  5211. * PHP 6.
  5212. * </td>
  5213. * </tr>
  5214. * <tr valign="top">
  5215. * <td>
  5216. * FILE_BINARY
  5217. * </td>
  5218. * <td>
  5219. * data will be written in binary mode. This
  5220. * is the default setting and cannot be used with
  5221. * FILE_TEXT. This flag is only available since
  5222. * PHP 6.
  5223. * </td>
  5224. * </tr>
  5225. * </table>
  5226. * </p>
  5227. * @param context resource[optional] <p>
  5228. * A valid context resource created with
  5229. * stream_context_create.
  5230. * </p>
  5231. * @return int The function returns the number of bytes that were written to the file, or
  5232. * false on failure.
  5233. */
  5234. function file_put_contents ($filename, $data, $flags = null, $context = null) {}
  5235. /**
  5236. * Runs the equivalent of the select() system call on the given
  5237. arrays of streams with a timeout specified by tv_sec and tv_usec
  5238. * @link http://www.php.net/manual/en/function.stream-select.php
  5239. * @param read array <p>
  5240. * The streams listed in the read array will be watched to
  5241. * see if characters become available for reading (more precisely, to see if
  5242. * a read will not block - in particular, a stream resource is also ready on
  5243. * end-of-file, in which case an fread will return
  5244. * a zero length string).
  5245. * </p>
  5246. * @param write array <p>
  5247. * The streams listed in the write array will be
  5248. * watched to see if a write will not block.
  5249. * </p>
  5250. * @param except array <p>
  5251. * The streams listed in the except array will be
  5252. * watched for high priority exceptional ("out-of-band") data arriving.
  5253. * </p>
  5254. * <p>
  5255. * When stream_select returns, the arrays
  5256. * read, write and
  5257. * except are modified to indicate which stream
  5258. * resource(s) actually changed status.
  5259. * </p>
  5260. * You do not need to pass every array to
  5261. * stream_select. You can leave it out and use an
  5262. * empty array or &null; instead. Also do not forget that those arrays are
  5263. * passed by reference and will be modified after
  5264. * stream_select returns.
  5265. * @param tv_sec int <p>
  5266. * The tv_sec and tv_usec
  5267. * together form the timeout parameter,
  5268. * tv_sec specifies the number of seconds while
  5269. * tv_usec the number of microseconds.
  5270. * The timeout is an upper bound on the amount of time
  5271. * that stream_select will wait before it returns.
  5272. * If tv_sec and tv_usec are
  5273. * both set to 0, stream_select will
  5274. * not wait for data - instead it will return immediately, indicating the
  5275. * current status of the streams.
  5276. * </p>
  5277. * <p>
  5278. * If tv_sec is &null; stream_select
  5279. * can block indefinitely, returning only when an event on one of the
  5280. * watched streams occurs (or if a signal interrupts the system call).
  5281. * </p>
  5282. * <p>
  5283. * Using a timeout value of 0 allows you to
  5284. * instantaneously poll the status of the streams, however, it is NOT a
  5285. * good idea to use a 0 timeout value in a loop as it
  5286. * will cause your script to consume too much CPU time.
  5287. * </p>
  5288. * <p>
  5289. * It is much better to specify a timeout value of a few seconds, although
  5290. * if you need to be checking and running other code concurrently, using a
  5291. * timeout value of at least 200000 microseconds will
  5292. * help reduce the CPU usage of your script.
  5293. * </p>
  5294. * <p>
  5295. * Remember that the timeout value is the maximum time that will elapse;
  5296. * stream_select will return as soon as the
  5297. * requested streams are ready for use.
  5298. * </p>
  5299. * @param tv_usec int[optional] <p>
  5300. * See tv_sec description.
  5301. * </p>
  5302. * @return int On success stream_select returns the number of
  5303. * stream resources contained in the modified arrays, which may be zero if
  5304. * the timeout expires before anything interesting happens. On error false
  5305. * is returned and a warning raised (this can happen if the system call is
  5306. * interrupted by an incoming signal).
  5307. */
  5308. function stream_select (array &$read, array &$write, array &$except, $tv_sec, $tv_usec = null) {}
  5309. /**
  5310. * Create a streams context
  5311. * @link http://www.php.net/manual/en/function.stream-context-create.php
  5312. * @param options array[optional] <p>
  5313. * Must be an associative array of associative arrays in the format
  5314. * $arr['wrapper']['option'] = $value.
  5315. * </p>
  5316. * <p>
  5317. * Default to an empty array.
  5318. * </p>
  5319. * @param params array[optional] <p>
  5320. * Must be an associative array in the format
  5321. * $arr['parameter'] = $value.
  5322. * Refer to context parameters for
  5323. * a listing of standard stream parameters.
  5324. * </p>
  5325. * @return resource A stream context resource.
  5326. */
  5327. function stream_context_create (array $options = null, array $params = null) {}
  5328. /**
  5329. * Set parameters for a stream/wrapper/context
  5330. * @link http://www.php.net/manual/en/function.stream-context-set-params.php
  5331. * @param stream_or_context resource <p>
  5332. * The stream or context to apply the parameters too.
  5333. * </p>
  5334. * @param params array <p>
  5335. * An array of parameters to set.
  5336. * </p>
  5337. * <p>
  5338. * params should be an associative array of the structure:
  5339. * $params['paramname'] = "paramvalue";.
  5340. * </p>
  5341. * @return bool Returns true on success or false on failure.
  5342. */
  5343. function stream_context_set_params ($stream_or_context, array $params) {}
  5344. /**
  5345. * Sets an option for a stream/wrapper/context
  5346. * @link http://www.php.net/manual/en/function.stream-context-set-option.php
  5347. * @param stream_or_context resource <p>
  5348. * The stream or context resource to apply the options too.
  5349. * </p>
  5350. * @param wrapper string
  5351. * @param option string
  5352. * @param value mixed
  5353. * @return bool Returns true on success or false on failure.
  5354. */
  5355. function stream_context_set_option ($stream_or_context, $wrapper, $option, $value) {}
  5356. /**
  5357. * Retrieve options for a stream/wrapper/context
  5358. * @link http://www.php.net/manual/en/function.stream-context-get-options.php
  5359. * @param stream_or_context resource <p>
  5360. * The stream or context to get options from
  5361. * </p>
  5362. * @return array an associative array with the options.
  5363. */
  5364. function stream_context_get_options ($stream_or_context) {}
  5365. /**
  5366. * Retreive the default streams context
  5367. * @link http://www.php.net/manual/en/function.stream-context-get-default.php
  5368. * @param options array[optional] options must be an associative
  5369. * array of associative arrays in the format
  5370. * $arr['wrapper']['option'] = $value.
  5371. * <p>
  5372. * As of PHP 5.3.0, the stream_context_set_default function
  5373. * can be used to set the default context.
  5374. * </p>
  5375. * @return resource A stream context resource.
  5376. */
  5377. function stream_context_get_default (array $options = null) {}
  5378. /**
  5379. * Attach a filter to a stream
  5380. * @link http://www.php.net/manual/en/function.stream-filter-prepend.php
  5381. * @param stream resource <p>
  5382. * The target stream.
  5383. * </p>
  5384. * @param filtername string <p>
  5385. * The filter name.
  5386. * </p>
  5387. * @param read_write int[optional] <p>
  5388. * By default, stream_filter_prepend will
  5389. * attach the filter to the read filter chain
  5390. * if the file was opened for reading (i.e. File Mode:
  5391. * r, and/or +). The filter
  5392. * will also be attached to the write filter chain
  5393. * if the file was opened for writing (i.e. File Mode:
  5394. * w, a, and/or +).
  5395. * STREAM_FILTER_READ,
  5396. * STREAM_FILTER_WRITE, and/or
  5397. * STREAM_FILTER_ALL can also be passed to the
  5398. * read_write parameter to override this behavior.
  5399. * See stream_filter_append for an example of
  5400. * using this parameter.
  5401. * </p>
  5402. * @param params mixed[optional] <p>
  5403. * This filter will be added with the specified params
  5404. * to the beginning of the list and will therefore be
  5405. * called first during stream operations. To add a filter to the end of the
  5406. * list, use stream_filter_append.
  5407. * </p>
  5408. * @return resource a resource which can be used to refer to this filter
  5409. * instance during a call to stream_filter_remove.
  5410. */
  5411. function stream_filter_prepend ($stream, $filtername, $read_write = null, $params = null) {}
  5412. /**
  5413. * Attach a filter to a stream
  5414. * @link http://www.php.net/manual/en/function.stream-filter-append.php
  5415. * @param stream resource <p>
  5416. * The target stream.
  5417. * </p>
  5418. * @param filtername string <p>
  5419. * The filter name.
  5420. * </p>
  5421. * @param read_write int[optional] <p>
  5422. * By default, stream_filter_append will
  5423. * attach the filter to the read filter chain
  5424. * if the file was opened for reading (i.e. File Mode:
  5425. * r, and/or +). The filter
  5426. * will also be attached to the write filter chain
  5427. * if the file was opened for writing (i.e. File Mode:
  5428. * w, a, and/or +).
  5429. * STREAM_FILTER_READ,
  5430. * STREAM_FILTER_WRITE, and/or
  5431. * STREAM_FILTER_ALL can also be passed to the
  5432. * read_write parameter to override this behavior.
  5433. * </p>
  5434. * @param params mixed[optional] <p>
  5435. * This filter will be added with the specified
  5436. * params to the end of
  5437. * the list and will therefore be called last during stream operations.
  5438. * To add a filter to the beginning of the list, use
  5439. * stream_filter_prepend.
  5440. * </p>
  5441. * @return resource a resource which can be used to refer to this filter
  5442. * instance during a call to stream_filter_remove.
  5443. */
  5444. function stream_filter_append ($stream, $filtername, $read_write = null, $params = null) {}
  5445. /**
  5446. * Remove a filter from a stream
  5447. * @link http://www.php.net/manual/en/function.stream-filter-remove.php
  5448. * @param stream_filter resource <p>
  5449. * The stream filter to be removed.
  5450. * </p>
  5451. * @return bool Returns true on success or false on failure.
  5452. */
  5453. function stream_filter_remove ($stream_filter) {}
  5454. /**
  5455. * Open Internet or Unix domain socket connection
  5456. * @link http://www.php.net/manual/en/function.stream-socket-client.php
  5457. * @param remote_socket string <p>
  5458. * Address to the socket to connect to.
  5459. * </p>
  5460. * @param errno int[optional] <p>
  5461. * Will be set to the system level error number if connection fails.
  5462. * </p>
  5463. * @param errstr string[optional] <p>
  5464. * Will be set to the system level error message if the connection fails.
  5465. * </p>
  5466. * @param timeout float[optional] <p>
  5467. * Number of seconds until the connect() system call
  5468. * should timeout.
  5469. * This parameter only applies when not making asynchronous
  5470. * connection attempts.
  5471. * <p>
  5472. * To set a timeout for reading/writing data over the socket, use the
  5473. * stream_set_timeout, as the
  5474. * timeout only applies while making connecting
  5475. * the socket.
  5476. * </p>
  5477. * </p>
  5478. * @param flags int[optional] <p>
  5479. * Bitmask field which may be set to any combination of connection flags.
  5480. * Currently the select of connection flags is limited to
  5481. * STREAM_CLIENT_CONNECT (default),
  5482. * STREAM_CLIENT_ASYNC_CONNECT and
  5483. * STREAM_CLIENT_PERSISTENT.
  5484. * </p>
  5485. * @param context resource[optional] <p>
  5486. * A valid context resource created with stream_context_create.
  5487. * </p>
  5488. * @return resource On success a stream resource is returned which may
  5489. * be used together with the other file functions (such as
  5490. * fgets, fgetss,
  5491. * fwrite, fclose, and
  5492. * feof), false on failure.
  5493. */
  5494. function stream_socket_client ($remote_socket, &$errno = null, &$errstr = null, $timeout = null, $flags = null, $context = null) {}
  5495. /**
  5496. * Create an Internet or Unix domain server socket
  5497. * @link http://www.php.net/manual/en/function.stream-socket-server.php
  5498. * @param local_socket string <p>
  5499. * The type of socket created is determined by the transport specified
  5500. * using standard URL formatting: transport://target.
  5501. * </p>
  5502. * <p>
  5503. * For Internet Domain sockets (AF_INET) such as TCP and UDP, the
  5504. * target portion of the
  5505. * remote_socket parameter should consist of a
  5506. * hostname or IP address followed by a colon and a port number. For
  5507. * Unix domain sockets, the target portion should
  5508. * point to the socket file on the filesystem.
  5509. * </p>
  5510. * <p>
  5511. * Depending on the environment, Unix domain sockets may not be available.
  5512. * A list of available transports can be retrieved using
  5513. * stream_get_transports. See
  5514. * for a list of bulitin transports.
  5515. * </p>
  5516. * @param errno int[optional] <p>
  5517. * If the optional errno and errstr
  5518. * arguments are present they will be set to indicate the actual system
  5519. * level error that occurred in the system-level socket(),
  5520. * bind(), and listen() calls. If
  5521. * the value returned in errno is
  5522. * 0 and the function returned false, it is an
  5523. * indication that the error occurred before the bind()
  5524. * call. This is most likely due to a problem initializing the socket.
  5525. * Note that the errno and
  5526. * errstr arguments will always be passed by reference.
  5527. * </p>
  5528. * @param errstr string[optional] <p>
  5529. * See errno description.
  5530. * </p>
  5531. * @param flags int[optional] <p>
  5532. * A bitmask field which may be set to any combination of socket creation
  5533. * flags.
  5534. * </p>
  5535. * <p>
  5536. * For UDP sockets, you must use STREAM_SERVER_BIND as
  5537. * the flags parameter.
  5538. * </p>
  5539. * @param context resource[optional] <p>
  5540. * </p>
  5541. * @return resource the created stream, or false on error.
  5542. */
  5543. function stream_socket_server ($local_socket, &$errno = null, &$errstr = null, $flags = null, $context = null) {}
  5544. /**
  5545. * Accept a connection on a socket created by <function>stream_socket_server</function>
  5546. * @link http://www.php.net/manual/en/function.stream-socket-accept.php
  5547. * @param server_socket resource
  5548. * @param timeout float[optional] <p>
  5549. * Override the default socket accept timeout. Time should be given in
  5550. * seconds.
  5551. * </p>
  5552. * @param peername string[optional] <p>
  5553. * Will be set to the name (address) of the client which connected, if
  5554. * included and available from the selected transport.
  5555. * </p>
  5556. * <p>
  5557. * Can also be determined later using
  5558. * stream_socket_get_name.
  5559. * </p>
  5560. * @return resource Returns true on success or false on failure.
  5561. */
  5562. function stream_socket_accept ($server_socket, $timeout = null, &$peername = null) {}
  5563. /**
  5564. * Retrieve the name of the local or remote sockets
  5565. * @link http://www.php.net/manual/en/function.stream-socket-get-name.php
  5566. * @param handle resource <p>
  5567. * The socket to get the name of.
  5568. * </p>
  5569. * @param want_peer bool <p>
  5570. * If set to true the remote socket name will be returned, if set
  5571. * to false the local socket name will be returned.
  5572. * </p>
  5573. * @return string The name of the socket.
  5574. */
  5575. function stream_socket_get_name ($handle, $want_peer) {}
  5576. /**
  5577. * Receives data from a socket, connected or not
  5578. * @link http://www.php.net/manual/en/function.stream-socket-recvfrom.php
  5579. * @param socket resource <p>
  5580. * The remote socket.
  5581. * </p>
  5582. * @param length int <p>
  5583. * The number of bytes to receive from the socket.
  5584. * </p>
  5585. * @param flags int[optional] <p>
  5586. * The value of flags can be any combination
  5587. * of the following:
  5588. * <table>
  5589. * Possible values for flags
  5590. * <tr valign="top">
  5591. * <td>STREAM_OOB</td>
  5592. * <td>
  5593. * Process OOB (out-of-band) data.
  5594. * </td>
  5595. * </tr>
  5596. * <tr valign="top">
  5597. * <td>STREAM_PEEK</td>
  5598. * <td>
  5599. * Retrieve data from the socket, but do not consume the buffer.
  5600. * Subsequent calls to fread or
  5601. * stream_socket_recvfrom will see
  5602. * the same data.
  5603. * </td>
  5604. * </tr>
  5605. * </table>
  5606. * </p>
  5607. * @param address string[optional] <p>
  5608. * If address is provided it will be populated with
  5609. * the address of the remote socket.
  5610. * </p>
  5611. * @return string the read data, as a string
  5612. */
  5613. function stream_socket_recvfrom ($socket, $length, $flags = null, &$address = null) {}
  5614. /**
  5615. * Sends a message to a socket, whether it is connected or not
  5616. * @link http://www.php.net/manual/en/function.stream-socket-sendto.php
  5617. * @param socket resource <p>
  5618. * The socket to send data to.
  5619. * </p>
  5620. * @param data string <p>
  5621. * The data to be sent.
  5622. * </p>
  5623. * @param flags int[optional] <p>
  5624. * The value of flags can be any combination
  5625. * of the following:
  5626. * <table>
  5627. * possible values for flags
  5628. * <tr valign="top">
  5629. * <td>STREAM_OOB</td>
  5630. * <td>
  5631. * Process OOB (out-of-band) data.
  5632. * </td>
  5633. * </tr>
  5634. * </table>
  5635. * </p>
  5636. * @param address string[optional] <p>
  5637. * The address specified when the socket stream was created will be used
  5638. * unless an alternate address is specified in address.
  5639. * </p>
  5640. * <p>
  5641. * If specified, it must be in dotted quad (or [ipv6]) format.
  5642. * </p>
  5643. * @return int a result code, as an integer.
  5644. */
  5645. function stream_socket_sendto ($socket, $data, $flags = null, $address = null) {}
  5646. /**
  5647. * Turns encryption on/off on an already connected socket
  5648. * @link http://www.php.net/manual/en/function.stream-socket-enable-crypto.php
  5649. * @param stream resource <p>
  5650. * The stream resource.
  5651. * </p>
  5652. * @param enable bool <p>
  5653. * Enable/disable cryptography on the stream.
  5654. * </p>
  5655. * @param crypto_type int[optional] <p>
  5656. * Setup encryption on the stream.
  5657. * Valid methods are
  5658. * STREAM_CRYPTO_METHOD_SSLv2_CLIENT
  5659. * @param session_stream resource[optional] <p>
  5660. * Seed the stream with settings from session_stream.
  5661. * </p>
  5662. * @return mixed true on success, false if negotiation has failed or
  5663. * 0 if there isn't enough data and you should try again
  5664. * (only for non-blocking sockets).
  5665. */
  5666. function stream_socket_enable_crypto ($stream, $enable, $crypto_type = null, $session_stream = null) {}
  5667. /**
  5668. * Shutdown a full-duplex connection
  5669. * @link http://www.php.net/manual/en/function.stream-socket-shutdown.php
  5670. * @param stream resource <p>
  5671. * An open stream (opened with stream_socket_client,
  5672. * for example)
  5673. * </p>
  5674. * @param how int <p>
  5675. * One of the following constants: STREAM_SHUT_RD
  5676. * (disable further receptions), STREAM_SHUT_WR
  5677. * (disable further transmissions) or
  5678. * STREAM_SHUT_RDWR (disable further receptions and
  5679. * transmissions).
  5680. * </p>
  5681. * @return bool Returns true on success or false on failure.
  5682. */
  5683. function stream_socket_shutdown ($stream, $how) {}
  5684. /**
  5685. * Copies data from one stream to another
  5686. * @link http://www.php.net/manual/en/function.stream-copy-to-stream.php
  5687. * @param source resource <p>
  5688. * The source stream
  5689. * </p>
  5690. * @param dest resource <p>
  5691. * The destination stream
  5692. * </p>
  5693. * @param maxlength int[optional] <p>
  5694. * Maximum bytes to copy
  5695. * </p>
  5696. * @param offset int[optional] <p>
  5697. * The offset where to start to copy data
  5698. * </p>
  5699. * @return int the total count of bytes copied.
  5700. */
  5701. function stream_copy_to_stream ($source, $dest, $maxlength = null, $offset = null) {}
  5702. /**
  5703. * Reads remainder of a stream into a string
  5704. * @link http://www.php.net/manual/en/function.stream-get-contents.php
  5705. * @param handle resource <p>
  5706. * A stream resource (e.g. returned from fopen)
  5707. * </p>
  5708. * @param maxlength int[optional] <p>
  5709. * The maximum bytes to read. Defaults to -1 (read all the remaining
  5710. * buffer).
  5711. * </p>
  5712. * @param offset int[optional] <p>
  5713. * Seek to the specified offset before reading.
  5714. * </p>
  5715. * @return string a string&return.falseforfailure;.
  5716. */
  5717. function stream_get_contents ($handle, $maxlength = null, $offset = null) {}
  5718. /**
  5719. * Gets line from file pointer and parse for CSV fields
  5720. * @link http://www.php.net/manual/en/function.fgetcsv.php
  5721. * @param handle resource <p>
  5722. * A valid file pointer to a file successfully opened by
  5723. * fopen, popen, or
  5724. * fsockopen.
  5725. * </p>
  5726. * @param length int[optional] <p>
  5727. * Must be greater than the longest line (in characters) to be found in
  5728. * the CSV file (allowing for trailing line-end characters). It became
  5729. * optional in PHP 5. Omitting this parameter (or setting it to 0 in PHP
  5730. * 5.0.4 and later) the maximum line length is not limited, which is
  5731. * slightly slower.
  5732. * </p>
  5733. * @param delimiter string[optional] <p>
  5734. * Set the field delimiter (one character only).
  5735. * </p>
  5736. * @param enclosure string[optional] <p>
  5737. * Set the field enclosure character (one character only).
  5738. * </p>
  5739. * @param escape string[optional] <p>
  5740. * Set the escape character (one character only). Defaults as a backslash.
  5741. * </p>
  5742. * @return array an indexed array containing the fields read.
  5743. * </p>
  5744. * <p>
  5745. * A blank line in a CSV file will be returned as an array
  5746. * comprising a single null field, and will not be treated
  5747. * as an error.
  5748. * </p>
  5749. * &note.line-endings;
  5750. * <p>
  5751. * fgetcsv returns &null; if an invalid
  5752. * handle is supplied or false on other errors,
  5753. * including end of file.
  5754. */
  5755. function fgetcsv ($handle, $length = null, $delimiter = null, $enclosure = null, $escape = null) {}
  5756. /**
  5757. * Format line as CSV and write to file pointer
  5758. * @link http://www.php.net/manual/en/function.fputcsv.php
  5759. * @param handle resource &fs.validfp.all;
  5760. * @param fields array <p>
  5761. * An array of values.
  5762. * </p>
  5763. * @param delimiter string[optional] <p>
  5764. * The optional delimiter parameter sets the field
  5765. * delimiter (one character only).
  5766. * </p>
  5767. * @param enclosure string[optional] <p>
  5768. * The optional enclosure parameter sets the field
  5769. * enclosure (one character only).
  5770. * </p>
  5771. * @return int the length of the written string&return.falseforfailure;.
  5772. */
  5773. function fputcsv ($handle, array $fields, $delimiter = null, $enclosure = null) {}
  5774. /**
  5775. * Portable advisory file locking
  5776. * @link http://www.php.net/manual/en/function.flock.php
  5777. * @param handle resource <p>
  5778. * An open file pointer.
  5779. * </p>
  5780. * @param operation int <p>
  5781. * operation is one of the following:
  5782. * LOCK_SH to acquire a shared lock (reader).
  5783. * @param wouldblock int[optional] <p>
  5784. * The optional third argument is set to true if the lock would block
  5785. * (EWOULDBLOCK errno condition). (not supported on Windows)
  5786. * </p>
  5787. * @return bool Returns true on success or false on failure.
  5788. */
  5789. function flock ($handle, $operation, &$wouldblock = null) {}
  5790. /**
  5791. * Extracts all meta tag content attributes from a file and returns an array
  5792. * @link http://www.php.net/manual/en/function.get-meta-tags.php
  5793. * @param filename string <p>
  5794. * The path to the HTML file, as a string. This can be a local file or an
  5795. * URL.
  5796. * </p>
  5797. * <p>
  5798. * What get_meta_tags parses
  5799. * ]]>
  5800. * (pay attention to line endings - PHP uses a native function to
  5801. * parse the input, so a Mac file won't work on Unix).
  5802. * </p>
  5803. * @param use_include_path bool[optional] <p>
  5804. * Setting use_include_path to true will result
  5805. * in PHP trying to open the file along the standard include path as per
  5806. * the include_path directive.
  5807. * This is used for local files, not URLs.
  5808. * </p>
  5809. * @return array an array with all the parsed meta tags.
  5810. * </p>
  5811. * <p>
  5812. * The value of the name property becomes the key, the value of the content
  5813. * property becomes the value of the returned array, so you can easily use
  5814. * standard array functions to traverse it or access single values.
  5815. * Special characters in the value of the name property are substituted with
  5816. * '_', the rest is converted to lower case. If two meta tags have the same
  5817. * name, only the last one is returned.
  5818. */
  5819. function get_meta_tags ($filename, $use_include_path = null) {}
  5820. /**
  5821. * Sets file buffering on the given stream
  5822. * @link http://www.php.net/manual/en/function.stream-set-write-buffer.php
  5823. * @param stream resource <p>
  5824. * The file pointer.
  5825. * </p>
  5826. * @param buffer int <p>
  5827. * The number of bytes to buffer. If buffer
  5828. * is 0 then write operations are unbuffered. This ensures that all writes
  5829. * with fwrite are completed before other processes are
  5830. * allowed to write to that output stream.
  5831. * </p>
  5832. * @return int 0 on success, or EOF if the request cannot be honored.
  5833. */
  5834. function stream_set_write_buffer ($stream, $buffer) {}
  5835. /**
  5836. * &Alias; <function>stream_set_write_buffer</function>
  5837. * @link http://www.php.net/manual/en/function.set-file-buffer.php
  5838. * @param fp
  5839. * @param buffer
  5840. */
  5841. function set_file_buffer ($fp, $buffer) {}
  5842. /**
  5843. * &Alias; <function>stream_set_blocking</function>
  5844. * @link http://www.php.net/manual/en/function.set-socket-blocking.php
  5845. * @param socket
  5846. * @param mode
  5847. */
  5848. function set_socket_blocking ($socket, $mode) {}
  5849. /**
  5850. * Set blocking/non-blocking mode on a stream
  5851. * @link http://www.php.net/manual/en/function.stream-set-blocking.php
  5852. * @param stream resource <p>
  5853. * The stream.
  5854. * </p>
  5855. * @param mode int <p>
  5856. * If mode is 0, the given stream
  5857. * will be switched to non-blocking mode, and if 1, it
  5858. * will be switched to blocking mode. This affects calls like
  5859. * fgets and fread
  5860. * that read from the stream. In non-blocking mode an
  5861. * fgets call will always return right away
  5862. * while in blocking mode it will wait for data to become available
  5863. * on the stream.
  5864. * </p>
  5865. * @return bool Returns true on success or false on failure.
  5866. */
  5867. function stream_set_blocking ($stream, $mode) {}
  5868. /**
  5869. * &Alias; <function>stream_set_blocking</function>
  5870. * @link http://www.php.net/manual/en/function.socket-set-blocking.php
  5871. * @param socket
  5872. * @param mode
  5873. */
  5874. function socket_set_blocking ($socket, $mode) {}
  5875. /**
  5876. * Retrieves header/meta data from streams/file pointers
  5877. * @link http://www.php.net/manual/en/function.stream-get-meta-data.php
  5878. * @param stream resource <p>
  5879. * The stream can be any stream created by fopen,
  5880. * fsockopen and pfsockopen.
  5881. * </p>
  5882. * @return array The result array contains the following items:
  5883. * </p>
  5884. * <p>
  5885. * timed_out (bool) - true if the stream
  5886. * timed out while waiting for data on the last call to
  5887. * fread or fgets.
  5888. * </p>
  5889. * <p>
  5890. * blocked (bool) - true if the stream is
  5891. * in blocking IO mode. See stream_set_blocking.
  5892. * </p>
  5893. * <p>
  5894. * eof (bool) - true if the stream has reached
  5895. * end-of-file. Note that for socket streams this member can be true
  5896. * even when unread_bytes is non-zero. To
  5897. * determine if there is more data to be read, use
  5898. * feof instead of reading this item.
  5899. * </p>
  5900. * <p>
  5901. * unread_bytes (int) - the number of bytes
  5902. * currently contained in the PHP's own internal buffer.
  5903. * </p>
  5904. * You shouldn't use this value in a script.
  5905. * <p>
  5906. * stream_type (string) - a label describing
  5907. * the underlying implementation of the stream.
  5908. * </p>
  5909. * <p>
  5910. * wrapper_type (string) - a label describing
  5911. * the protocol wrapper implementation layered over the stream.
  5912. * See for more information about wrappers.
  5913. * </p>
  5914. * <p>
  5915. * wrapper_data (mixed) - wrapper specific
  5916. * data attached to this stream. See for
  5917. * more information about wrappers and their wrapper data.
  5918. * </p>
  5919. * <p>
  5920. * filters (array) - and array containing
  5921. * the names of any filters that have been stacked onto this stream.
  5922. * Documentation on filters can be found in the
  5923. * Filters appendix.
  5924. * </p>
  5925. * <p>
  5926. * mode (string) - the type of access required for
  5927. * this stream (see Table 1 of the fopen() reference)
  5928. * </p>
  5929. * <p>
  5930. * seekable (bool) - whether the current stream can
  5931. * be seeked.
  5932. * </p>
  5933. * <p>
  5934. * uri (string) - the URI/filename associated with this
  5935. * stream.
  5936. */
  5937. function stream_get_meta_data ($stream) {}
  5938. /**
  5939. * Gets line from stream resource up to a given delimiter
  5940. * @link http://www.php.net/manual/en/function.stream-get-line.php
  5941. * @param handle resource <p>
  5942. * A valid file handle.
  5943. * </p>
  5944. * @param length int <p>
  5945. * The number of bytes to read from the handle.
  5946. * </p>
  5947. * @param ending string[optional] <p>
  5948. * An optional string delimiter.
  5949. * </p>
  5950. * @return string a string of up to length bytes read from the file
  5951. * pointed to by handle.
  5952. * </p>
  5953. * <p>
  5954. * If an error occurs, returns false.
  5955. */
  5956. function stream_get_line ($handle, $length, $ending = null) {}
  5957. /**
  5958. * Register a URL wrapper implemented as a PHP class
  5959. * @link http://www.php.net/manual/en/function.stream-wrapper-register.php
  5960. * @param protocol string <p>
  5961. * The wrapper name to be registered.
  5962. * </p>
  5963. * @param classname string <p>
  5964. * The classname which implements the protocol.
  5965. * </p>
  5966. * @param flags int[optional] <p>
  5967. * Should be set to STREAM_IS_URL if
  5968. * protocol is a URL protocol. Default is 0, local
  5969. * stream.
  5970. * </p>
  5971. * @return bool Returns true on success or false on failure.
  5972. * </p>
  5973. * <p>
  5974. * stream_wrapper_register will return false if the
  5975. * protocol already has a handler.
  5976. */
  5977. function stream_wrapper_register ($protocol, $classname, $flags = null) {}
  5978. /**
  5979. * &Alias; <function>stream_wrapper_register</function>
  5980. * @link http://www.php.net/manual/en/function.stream-register-wrapper.php
  5981. * @param protocol
  5982. * @param classname
  5983. * @param flags[optional]
  5984. */
  5985. function stream_register_wrapper ($protocol, $classname, $flags) {}
  5986. /**
  5987. * Unregister a URL wrapper
  5988. * @link http://www.php.net/manual/en/function.stream-wrapper-unregister.php
  5989. * @param protocol string <p>
  5990. * </p>
  5991. * @return bool Returns true on success or false on failure.
  5992. */
  5993. function stream_wrapper_unregister ($protocol) {}
  5994. /**
  5995. * Restores a previously unregistered built-in wrapper
  5996. * @link http://www.php.net/manual/en/function.stream-wrapper-restore.php
  5997. * @param protocol string <p>
  5998. * </p>
  5999. * @return bool Returns true on success or false on failure.
  6000. */
  6001. function stream_wrapper_restore ($protocol) {}
  6002. /**
  6003. * Retrieve list of registered streams
  6004. * @link http://www.php.net/manual/en/function.stream-get-wrappers.php
  6005. * @return array an indexed array containing the name of all stream wrappers
  6006. * available on the running system.
  6007. */
  6008. function stream_get_wrappers () {}
  6009. /**
  6010. * Retrieve list of registered socket transports
  6011. * @link http://www.php.net/manual/en/function.stream-get-transports.php
  6012. * @return array an indexed array of socket transports names.
  6013. */
  6014. function stream_get_transports () {}
  6015. /**
  6016. * Checks if a stream is a local stream
  6017. * @link http://www.php.net/manual/en/function.stream-is-local.php
  6018. * @param stream_or_url mixed <p>
  6019. * The stream resource or URL to check.
  6020. * </p>
  6021. * @return bool Returns true on success or false on failure.
  6022. */
  6023. function stream_is_local ($stream_or_url) {}
  6024. /**
  6025. * Fetches all the headers sent by the server in response to a HTTP request
  6026. * @link http://www.php.net/manual/en/function.get-headers.php
  6027. * @param url string <p>
  6028. * The target URL.
  6029. * </p>
  6030. * @param format int[optional] <p>
  6031. * If the optional format parameter is set to non-zero,
  6032. * get_headers parses the response and sets the
  6033. * array's keys.
  6034. * </p>
  6035. * @return array an indexed or associative array with the headers, or false on
  6036. * failure.
  6037. */
  6038. function get_headers ($url, $format = null) {}
  6039. /**
  6040. * Set timeout period on a stream
  6041. * @link http://www.php.net/manual/en/function.stream-set-timeout.php
  6042. * @param stream resource <p>
  6043. * The target stream.
  6044. * </p>
  6045. * @param seconds int <p>
  6046. * The seconds part of the timeout to be set.
  6047. * </p>
  6048. * @param microseconds int[optional] <p>
  6049. * The microseconds part of the timeout to be set.
  6050. * </p>
  6051. * @return bool Returns true on success or false on failure.
  6052. */
  6053. function stream_set_timeout ($stream, $seconds, $microseconds = null) {}
  6054. /**
  6055. * &Alias; <function>stream_set_timeout</function>
  6056. * @link http://www.php.net/manual/en/function.socket-set-timeout.php
  6057. * @param stream
  6058. * @param seconds
  6059. * @param microseconds
  6060. */
  6061. function socket_set_timeout ($stream, $seconds, $microseconds) {}
  6062. /**
  6063. * &Alias; <function>stream_get_meta_data</function>
  6064. * @link http://www.php.net/manual/en/function.socket-get-status.php
  6065. * @param fp
  6066. */
  6067. function socket_get_status ($fp) {}
  6068. /**
  6069. * Returns canonicalized absolute pathname
  6070. * @link http://www.php.net/manual/en/function.realpath.php
  6071. * @param path string <p>
  6072. * The path being checked.
  6073. * </p>
  6074. * @return string the canonicalized absolute pathname on success. The resulting path
  6075. * will have no symbolic link, '/./' or '/../' components.
  6076. * </p>
  6077. * <p>
  6078. * realpath returns false on failure, e.g. if
  6079. * the file does not exist.
  6080. * </p>
  6081. * <p>
  6082. * The running script must have executable permissions on all directories in
  6083. * the hierarchy, otherwise realpath will return
  6084. * false.
  6085. */
  6086. function realpath ($path) {}
  6087. /**
  6088. * Open Internet or Unix domain socket connection
  6089. * @link http://www.php.net/manual/en/function.fsockopen.php
  6090. * @param hostname string <p>
  6091. * If you have compiled in OpenSSL support, you may prefix the
  6092. * hostname with either ssl://
  6093. * or tls:// to use an SSL or TLS client connection
  6094. * over TCP/IP to connect to the remote host.
  6095. * </p>
  6096. * @param port int[optional] <p>
  6097. * The port number.
  6098. * </p>
  6099. * @param errno int[optional] <p>
  6100. * If provided, holds the system level error number that occurred in the
  6101. * system-level connect() call.
  6102. * </p>
  6103. * <p>
  6104. * If the value returned in errno is
  6105. * 0 and the function returned false, it is an
  6106. * indication that the error occurred before the
  6107. * connect() call. This is most likely due to a
  6108. * problem initializing the socket.
  6109. * </p>
  6110. * @param errstr string[optional] <p>
  6111. * The error message as a string.
  6112. * </p>
  6113. * @param timeout float[optional] <p>
  6114. * The connection timeout, in seconds.
  6115. * </p>
  6116. * <p>
  6117. * If you need to set a timeout for reading/writing data over the
  6118. * socket, use stream_set_timeout, as the
  6119. * timeout parameter to
  6120. * fsockopen only applies while connecting the
  6121. * socket.
  6122. * </p>
  6123. * @return resource fsockopen returns a file pointer which may be used
  6124. * together with the other file functions (such as
  6125. * fgets, fgetss,
  6126. * fwrite, fclose, and
  6127. * feof). If the call fails, it will return false
  6128. */
  6129. function fsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  6130. /**
  6131. * Open persistent Internet or Unix domain socket connection
  6132. * @link http://www.php.net/manual/en/function.pfsockopen.php
  6133. * @param hostname string
  6134. * @param port int[optional]
  6135. * @param errno int[optional]
  6136. * @param errstr string[optional]
  6137. * @param timeout float[optional]
  6138. * @return resource
  6139. */
  6140. function pfsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  6141. /**
  6142. * Pack data into binary string
  6143. * @link http://www.php.net/manual/en/function.pack.php
  6144. * @param format string <p>
  6145. * The format string consists of format codes
  6146. * followed by an optional repeater argument. The repeater argument can
  6147. * be either an integer value or * for repeating to
  6148. * the end of the input data. For a, A, h, H the repeat count specifies
  6149. * how many characters of one data argument are taken, for @ it is the
  6150. * absolute position where to put the next data, for everything else the
  6151. * repeat count specifies how many data arguments are consumed and packed
  6152. * into the resulting binary string.
  6153. * </p>
  6154. * <p>
  6155. * Currently implemented formats are:
  6156. * <table>
  6157. * pack format characters
  6158. * <tr valign="top">
  6159. * <td>Code</td>
  6160. * <td>Description</td>
  6161. * </tr>
  6162. * <tr valign="top">
  6163. * <td>a</td>
  6164. * <td>NUL-padded string</td>
  6165. * </tr>
  6166. * <tr valign="top">
  6167. * <td>A</td>
  6168. * <td>SPACE-padded string</td></tr>
  6169. * <tr valign="top">
  6170. * <td>h</td>
  6171. * <td>Hex string, low nibble first</td></tr>
  6172. * <tr valign="top">
  6173. * <td>H</td>
  6174. * <td>Hex string, high nibble first</td></tr>
  6175. * <tr valign="top"><td>c</td><td>signed char</td></tr>
  6176. * <tr valign="top">
  6177. * <td>C</td>
  6178. * <td>unsigned char</td></tr>
  6179. * <tr valign="top">
  6180. * <td>s</td>
  6181. * <td>signed short (always 16 bit, machine byte order)</td>
  6182. * </tr>
  6183. * <tr valign="top">
  6184. * <td>S</td>
  6185. * <td>unsigned short (always 16 bit, machine byte order)</td>
  6186. * </tr>
  6187. * <tr valign="top">
  6188. * <td>n</td>
  6189. * <td>unsigned short (always 16 bit, big endian byte order)</td>
  6190. * </tr>
  6191. * <tr valign="top">
  6192. * <td>v</td>
  6193. * <td>unsigned short (always 16 bit, little endian byte order)</td>
  6194. * </tr>
  6195. * <tr valign="top">
  6196. * <td>i</td>
  6197. * <td>signed integer (machine dependent size and byte order)</td>
  6198. * </tr>
  6199. * <tr valign="top">
  6200. * <td>I</td>
  6201. * <td>unsigned integer (machine dependent size and byte order)</td>
  6202. * </tr>
  6203. * <tr valign="top">
  6204. * <td>l</td>
  6205. * <td>signed long (always 32 bit, machine byte order)</td>
  6206. * </tr>
  6207. * <tr valign="top">
  6208. * <td>L</td>
  6209. * <td>unsigned long (always 32 bit, machine byte order)</td>
  6210. * </tr>
  6211. * <tr valign="top">
  6212. * <td>N</td>
  6213. * <td>unsigned long (always 32 bit, big endian byte order)</td>
  6214. * </tr>
  6215. * <tr valign="top">
  6216. * <td>V</td>
  6217. * <td>unsigned long (always 32 bit, little endian byte order)</td>
  6218. * </tr>
  6219. * <tr valign="top">
  6220. * <td>f</td>
  6221. * <td>float (machine dependent size and representation)</td>
  6222. * </tr>
  6223. * <tr valign="top">
  6224. * <td>d</td>
  6225. * <td>double (machine dependent size and representation)</td>
  6226. * </tr>
  6227. * <tr valign="top">
  6228. * <td>x</td>
  6229. * <td>NUL byte</td>
  6230. * </tr>
  6231. * <tr valign="top">
  6232. * <td>X</td>
  6233. * <td>Back up one byte</td>
  6234. * </tr>
  6235. * <tr valign="top">
  6236. * <td>@</td>
  6237. * <td>NUL-fill to absolute position</td>
  6238. * </tr>
  6239. * </table>
  6240. * </p>
  6241. * @param args mixed[optional] <p>
  6242. * </p>
  6243. * @param _ mixed[optional]
  6244. * @return string a binary string containing data.
  6245. */
  6246. function pack ($format, $args = null, $_ = null) {}
  6247. /**
  6248. * Unpack data from binary string
  6249. * @link http://www.php.net/manual/en/function.unpack.php
  6250. * @param format string <p>
  6251. * See pack for an explanation of the format codes.
  6252. * </p>
  6253. * @param data string <p>
  6254. * The packed data.
  6255. * </p>
  6256. * @return array an associative array containing unpacked elements of binary
  6257. * string.
  6258. */
  6259. function unpack ($format, $data) {}
  6260. /**
  6261. * Tells what the user's browser is capable of
  6262. * @link http://www.php.net/manual/en/function.get-browser.php
  6263. * @param user_agent string[optional] <p>
  6264. * The User Agent to be analyzed. By default, the value of HTTP
  6265. * User-Agent header is used; however, you can alter this (i.e., look up
  6266. * another browser's info) by passing this parameter.
  6267. * </p>
  6268. * <p>
  6269. * You can bypass this parameter with a &null; value.
  6270. * </p>
  6271. * @param return_array bool[optional] <p>
  6272. * If set to true, this function will return an array
  6273. * instead of an object.
  6274. * </p>
  6275. * @return mixed The information is returned in an object or an array which will contain
  6276. * various data elements representing, for instance, the browser's major and
  6277. * minor version numbers and ID string; true/false values for features
  6278. * such as frames, JavaScript, and cookies; and so forth.
  6279. * </p>
  6280. * <p>
  6281. * The cookies value simply means that the browser
  6282. * itself is capable of accepting cookies and does not mean the user has
  6283. * enabled the browser to accept cookies or not. The only way to test if
  6284. * cookies are accepted is to set one with setcookie,
  6285. * reload, and check for the value.
  6286. */
  6287. function get_browser ($user_agent = null, $return_array = null) {}
  6288. /**
  6289. * One-way string hashing
  6290. * @link http://www.php.net/manual/en/function.crypt.php
  6291. * @param str string <p>
  6292. * The string to be hashed.
  6293. * </p>
  6294. * @param salt string[optional] <p>
  6295. * An optional salt string to base the hashing on. If not provided,
  6296. * one will be randomly generated by PHP each time you call this function.
  6297. * </p>
  6298. * <p>
  6299. * If you are using the supplied salt, you should be aware that the salt
  6300. * is generated once. If you are calling this function repeatedly, this
  6301. * may impact both appearance and security.
  6302. * </p>
  6303. * @return string the hashed string.
  6304. */
  6305. function crypt ($str, $salt = null) {}
  6306. /**
  6307. * Open directory handle
  6308. * @link http://www.php.net/manual/en/function.opendir.php
  6309. * @param path string <p>
  6310. * The directory path that is to be opened
  6311. * </p>
  6312. * @param context resource[optional] <p>
  6313. * For a description of the context parameter,
  6314. * refer to the streams section of
  6315. * the manual.
  6316. * </p>
  6317. * @return resource a directory handle resource on success, or
  6318. * false on failure.
  6319. * </p>
  6320. * <p>
  6321. * If path is not a valid directory or the
  6322. * directory can not be opened due to permission restrictions or
  6323. * filesystem errors, opendir returns false and
  6324. * generates a PHP error of level
  6325. * E_WARNING. You can suppress the error output of
  6326. * opendir by prepending
  6327. * '@' to the
  6328. * front of the function name.
  6329. */
  6330. function opendir ($path, $context = null) {}
  6331. /**
  6332. * Close directory handle
  6333. * @link http://www.php.net/manual/en/function.closedir.php
  6334. * @param dir_handle resource[optional] <p>
  6335. * The directory handle resource previously opened
  6336. * with opendir. If the directory handle is
  6337. * not specified, the last link opened by opendir
  6338. * is assumed.
  6339. * </p>
  6340. * @return void
  6341. */
  6342. function closedir ($dir_handle = null) {}
  6343. /**
  6344. * Change directory
  6345. * @link http://www.php.net/manual/en/function.chdir.php
  6346. * @param directory string <p>
  6347. * The new current directory
  6348. * </p>
  6349. * @return bool Returns true on success or false on failure.
  6350. */
  6351. function chdir ($directory) {}
  6352. /**
  6353. * Gets the current working directory
  6354. * @link http://www.php.net/manual/en/function.getcwd.php
  6355. * @return string the current working directory on success, or false on
  6356. * failure.
  6357. * </p>
  6358. * <p>
  6359. * On some Unix variants, getcwd will return
  6360. * false if any one of the parent directories does not have the
  6361. * readable or search mode set, even if the current directory
  6362. * does. See chmod for more information on
  6363. * modes and permissions.
  6364. */
  6365. function getcwd () {}
  6366. /**
  6367. * Rewind directory handle
  6368. * @link http://www.php.net/manual/en/function.rewinddir.php
  6369. * @param dir_handle resource[optional] <p>
  6370. * The directory handle resource previously opened
  6371. * with opendir. If the directory handle is
  6372. * not specified, the last link opened by opendir
  6373. * is assumed.
  6374. * </p>
  6375. * @return void
  6376. */
  6377. function rewinddir ($dir_handle = null) {}
  6378. /**
  6379. * Read entry from directory handle
  6380. * @link http://www.php.net/manual/en/function.readdir.php
  6381. * @param dir_handle resource[optional] <p>
  6382. * The directory handle resource previously opened
  6383. * with opendir. If the directory handle is
  6384. * not specified, the last link opened by opendir
  6385. * is assumed.
  6386. * </p>
  6387. * @return string the filename on success&return.falseforfailure;.
  6388. */
  6389. function readdir ($dir_handle = null) {}
  6390. /**
  6391. * Return an instance of the Directory class
  6392. * @link http://www.php.net/manual/en/class.dir.php
  6393. * @param directory
  6394. * @param context[optional]
  6395. * @return string
  6396. */
  6397. function dir ($directory, $context) {}
  6398. /**
  6399. * List files and directories inside the specified path
  6400. * @link http://www.php.net/manual/en/function.scandir.php
  6401. * @param directory string <p>
  6402. * The directory that will be scanned.
  6403. * </p>
  6404. * @param sorting_order int[optional] <p>
  6405. * By default, the sorted order is alphabetical in ascending order. If
  6406. * the optional sorting_order is set to non-zero,
  6407. * then the sort order is alphabetical in descending order.
  6408. * </p>
  6409. * @param context resource[optional] <p>
  6410. * For a description of the context parameter,
  6411. * refer to the streams section of
  6412. * the manual.
  6413. * </p>
  6414. * @return array an array of filenames on success, or false on
  6415. * failure. If directory is not a directory, then
  6416. * boolean false is returned, and an error of level
  6417. * E_WARNING is generated.
  6418. */
  6419. function scandir ($directory, $sorting_order = null, $context = null) {}
  6420. /**
  6421. * Find pathnames matching a pattern
  6422. * @link http://www.php.net/manual/en/function.glob.php
  6423. * @param pattern string <p>
  6424. * The pattern. No tilde expansion or parameter substitution is done.
  6425. * </p>
  6426. * @param flags int[optional] <p>
  6427. * Valid flags:
  6428. * GLOB_MARK - Adds a slash to each directory returned
  6429. * @return array an array containing the matched files/directories, an empty array
  6430. * if no file matched or false on error.
  6431. * </p>
  6432. * <p>
  6433. * On some systems it is impossible to distinguish between empty match and an
  6434. * error.
  6435. */
  6436. function glob ($pattern, $flags = null) {}
  6437. /**
  6438. * Gets last access time of file
  6439. * @link http://www.php.net/manual/en/function.fileatime.php
  6440. * @param filename string <p>
  6441. * Path to the file.
  6442. * </p>
  6443. * @return int the time the file was last accessed, &return.falseforfailure;.
  6444. * The time is returned as a Unix timestamp.
  6445. */
  6446. function fileatime ($filename) {}
  6447. /**
  6448. * Gets inode change time of file
  6449. * @link http://www.php.net/manual/en/function.filectime.php
  6450. * @param filename string <p>
  6451. * Path to the file.
  6452. * </p>
  6453. * @return int the time the file was last changed, &return.falseforfailure;.
  6454. * The time is returned as a Unix timestamp.
  6455. */
  6456. function filectime ($filename) {}
  6457. /**
  6458. * Gets file group
  6459. * @link http://www.php.net/manual/en/function.filegroup.php
  6460. * @param filename string <p>
  6461. * Path to the file.
  6462. * </p>
  6463. * @return int the group ID of the file, or false in case
  6464. * of an error. The group ID is returned in numerical format, use
  6465. * posix_getgrgid to resolve it to a group name.
  6466. * Upon failure, false is returned.
  6467. */
  6468. function filegroup ($filename) {}
  6469. /**
  6470. * Gets file inode
  6471. * @link http://www.php.net/manual/en/function.fileinode.php
  6472. * @param filename string <p>
  6473. * Path to the file.
  6474. * </p>
  6475. * @return int the inode number of the file, &return.falseforfailure;.
  6476. */
  6477. function fileinode ($filename) {}
  6478. /**
  6479. * Gets file modification time
  6480. * @link http://www.php.net/manual/en/function.filemtime.php
  6481. * @param filename string <p>
  6482. * Path to the file.
  6483. * </p>
  6484. * @return int the time the file was last modified, &return.falseforfailure;.
  6485. * The time is returned as a Unix timestamp, which is
  6486. * suitable for the date function.
  6487. */
  6488. function filemtime ($filename) {}
  6489. /**
  6490. * Gets file owner
  6491. * @link http://www.php.net/manual/en/function.fileowner.php
  6492. * @param filename string <p>
  6493. * Path to the file.
  6494. * </p>
  6495. * @return int the user ID of the owner of the file, &return.falseforfailure;.
  6496. * The user ID is returned in numerical format, use
  6497. * posix_getpwuid to resolve it to a username.
  6498. */
  6499. function fileowner ($filename) {}
  6500. /**
  6501. * Gets file permissions
  6502. * @link http://www.php.net/manual/en/function.fileperms.php
  6503. * @param filename string <p>
  6504. * Path to the file.
  6505. * </p>
  6506. * @return int the permissions on the file, &return.falseforfailure;.
  6507. */
  6508. function fileperms ($filename) {}
  6509. /**
  6510. * Gets file size
  6511. * @link http://www.php.net/manual/en/function.filesize.php
  6512. * @param filename string <p>
  6513. * Path to the file.
  6514. * </p>
  6515. * @return int the size of the file in bytes, or false (and generates an error
  6516. * of level E_WARNING) in case of an error.
  6517. */
  6518. function filesize ($filename) {}
  6519. /**
  6520. * Gets file type
  6521. * @link http://www.php.net/manual/en/function.filetype.php
  6522. * @param filename string <p>
  6523. * Path to the file.
  6524. * </p>
  6525. * @return string the type of the file. Possible values are fifo, char,
  6526. * dir, block, link, file, socket and unknown.
  6527. * </p>
  6528. * <p>
  6529. * Returns false if an error occurs. filetype will also
  6530. * produce an E_NOTICE message if the stat call fails
  6531. * or if the file type is unknown.
  6532. */
  6533. function filetype ($filename) {}
  6534. /**
  6535. * Checks whether a file or directory exists
  6536. * @link http://www.php.net/manual/en/function.file-exists.php
  6537. * @param filename string <p>
  6538. * Path to the file or directory.
  6539. * </p>
  6540. * <p>
  6541. * On windows, use //computername/share/filename or
  6542. * \\computername\share\filename to check files on
  6543. * network shares.
  6544. * </p>
  6545. * @return bool true if the file or directory specified by
  6546. * filename exists; false otherwise.
  6547. * </p>
  6548. * <p>
  6549. * This function will return false for symlinks pointing to non-existing
  6550. * files.
  6551. * </p>
  6552. * <p>
  6553. * This function returns false for files inaccessible due to safe mode restrictions. However these
  6554. * files still can be included if
  6555. * they are located in safe_mode_include_dir.
  6556. * </p>
  6557. * <p>
  6558. * The check is done using the real UID/GID instead of the effective one.
  6559. */
  6560. function file_exists ($filename) {}
  6561. /**
  6562. * Tells whether the filename is writable
  6563. * @link http://www.php.net/manual/en/function.is-writable.php
  6564. * @param filename string <p>
  6565. * The filename being checked.
  6566. * </p>
  6567. * @return bool true if the filename exists and is
  6568. * writable.
  6569. */
  6570. function is_writable ($filename) {}
  6571. /**
  6572. * &Alias; <function>is_writable</function>
  6573. * @link http://www.php.net/manual/en/function.is-writeable.php
  6574. * @param filename
  6575. */
  6576. function is_writeable ($filename) {}
  6577. /**
  6578. * Tells whether a file exists and is readable
  6579. * @link http://www.php.net/manual/en/function.is-readable.php
  6580. * @param filename string <p>
  6581. * Path to the file.
  6582. * </p>
  6583. * @return bool true if the file or directory specified by
  6584. * filename exists and is readable, false otherwise.
  6585. */
  6586. function is_readable ($filename) {}
  6587. /**
  6588. * Tells whether the filename is executable
  6589. * @link http://www.php.net/manual/en/function.is-executable.php
  6590. * @param filename string <p>
  6591. * Path to the file.
  6592. * </p>
  6593. * @return bool true if the filename exists and is executable, or false on
  6594. * error.
  6595. */
  6596. function is_executable ($filename) {}
  6597. /**
  6598. * Tells whether the filename is a regular file
  6599. * @link http://www.php.net/manual/en/function.is-file.php
  6600. * @param filename string <p>
  6601. * Path to the file.
  6602. * </p>
  6603. * @return bool true if the filename exists and is a regular file, false
  6604. * otherwise.
  6605. */
  6606. function is_file ($filename) {}
  6607. /**
  6608. * Tells whether the filename is a directory
  6609. * @link http://www.php.net/manual/en/function.is-dir.php
  6610. * @param filename string <p>
  6611. * Path to the file. If filename is a relative
  6612. * filename, it will be checked relative to the current working
  6613. * directory. If filename is a symbolic or hard link
  6614. * then the link will be resolved and checked. If you have enabled &safemode;,
  6615. * or open_basedir further
  6616. * restrictions may apply.
  6617. * </p>
  6618. * @return bool true if the filename exists and is a directory, false
  6619. * otherwise.
  6620. */
  6621. function is_dir ($filename) {}
  6622. /**
  6623. * Tells whether the filename is a symbolic link
  6624. * @link http://www.php.net/manual/en/function.is-link.php
  6625. * @param filename string <p>
  6626. * Path to the file.
  6627. * </p>
  6628. * @return bool true if the filename exists and is a symbolic link, false
  6629. * otherwise.
  6630. */
  6631. function is_link ($filename) {}
  6632. /**
  6633. * Gives information about a file
  6634. * @link http://www.php.net/manual/en/function.stat.php
  6635. * @param filename string <p>
  6636. * Path to the file.
  6637. * </p>
  6638. * @return array <table>
  6639. * stat and fstat result
  6640. * format
  6641. * <tr valign="top">
  6642. * <td>Numeric</td>
  6643. * <td>Associative (since PHP 4.0.6)</td>
  6644. * <td>Description</td>
  6645. * </tr>
  6646. * <tr valign="top">
  6647. * <td>0</td>
  6648. * <td>dev</td>
  6649. * <td>device number</td>
  6650. * </tr>
  6651. * <tr valign="top">
  6652. * <td>1</td>
  6653. * <td>ino</td>
  6654. * <td>inode number *</td>
  6655. * </tr>
  6656. * <tr valign="top">
  6657. * <td>2</td>
  6658. * <td>mode</td>
  6659. * <td>inode protection mode</td>
  6660. * </tr>
  6661. * <tr valign="top">
  6662. * <td>3</td>
  6663. * <td>nlink</td>
  6664. * <td>number of links</td>
  6665. * </tr>
  6666. * <tr valign="top">
  6667. * <td>4</td>
  6668. * <td>uid</td>
  6669. * <td>userid of owner *</td>
  6670. * </tr>
  6671. * <tr valign="top">
  6672. * <td>5</td>
  6673. * <td>gid</td>
  6674. * <td>groupid of owner *</td>
  6675. * </tr>
  6676. * <tr valign="top">
  6677. * <td>6</td>
  6678. * <td>rdev</td>
  6679. * <td>device type, if inode device</td>
  6680. * </tr>
  6681. * <tr valign="top">
  6682. * <td>7</td>
  6683. * <td>size</td>
  6684. * <td>size in bytes</td>
  6685. * </tr>
  6686. * <tr valign="top">
  6687. * <td>8</td>
  6688. * <td>atime</td>
  6689. * <td>time of last access (Unix timestamp)</td>
  6690. * </tr>
  6691. * <tr valign="top">
  6692. * <td>9</td>
  6693. * <td>mtime</td>
  6694. * <td>time of last modification (Unix timestamp)</td>
  6695. * </tr>
  6696. * <tr valign="top">
  6697. * <td>10</td>
  6698. * <td>ctime</td>
  6699. * <td>time of last inode change (Unix timestamp)</td>
  6700. * </tr>
  6701. * <tr valign="top">
  6702. * <td>11</td>
  6703. * <td>blksize</td>
  6704. * <td>blocksize of filesystem IO **</td>
  6705. * </tr>
  6706. * <tr valign="top">
  6707. * <td>12</td>
  6708. * <td>blocks</td>
  6709. * <td>number of 512-byte blocks allocated **</td>
  6710. * </tr>
  6711. * </table>
  6712. * * On Windows this will always be 0.
  6713. * </p>
  6714. * <p>
  6715. * ** Only valid on systems supporting the st_blksize type - other
  6716. * systems (e.g. Windows) return -1.
  6717. * </p>
  6718. * <p>
  6719. * In case of error, stat returns false.
  6720. */
  6721. function stat ($filename) {}
  6722. /**
  6723. * Gives information about a file or symbolic link
  6724. * @link http://www.php.net/manual/en/function.lstat.php
  6725. * @param filename string <p>
  6726. * Path to a file or a symbolic link.
  6727. * </p>
  6728. * @return array See the manual page for stat for information on
  6729. * the structure of the array that lstat returns.
  6730. * This function is identical to the stat function
  6731. * except that if the filename parameter is a symbolic
  6732. * link, the status of the symbolic link is returned, not the status of the
  6733. * file pointed to by the symbolic link.
  6734. */
  6735. function lstat ($filename) {}
  6736. /**
  6737. * Changes file owner
  6738. * @link http://www.php.net/manual/en/function.chown.php
  6739. * @param filename string <p>
  6740. * Path to the file.
  6741. * </p>
  6742. * @param user mixed <p>
  6743. * A user name or number.
  6744. * </p>
  6745. * @return bool Returns true on success or false on failure.
  6746. */
  6747. function chown ($filename, $user) {}
  6748. /**
  6749. * Changes file group
  6750. * @link http://www.php.net/manual/en/function.chgrp.php
  6751. * @param filename string <p>
  6752. * Path to the file.
  6753. * </p>
  6754. * @param group mixed <p>
  6755. * A group name or number.
  6756. * </p>
  6757. * @return bool Returns true on success or false on failure.
  6758. */
  6759. function chgrp ($filename, $group) {}
  6760. /**
  6761. * Changes file mode
  6762. * @link http://www.php.net/manual/en/function.chmod.php
  6763. * @param filename string <p>
  6764. * Path to the file.
  6765. * </p>
  6766. * @param mode int <p>
  6767. * Note that mode is not automatically
  6768. * assumed to be an octal value, so strings (such as "g+w") will
  6769. * not work properly. To ensure the expected operation,
  6770. * you need to prefix mode with a zero (0):
  6771. * </p>
  6772. * <p>
  6773. * ]]>
  6774. * </p>
  6775. * <p>
  6776. * The mode parameter consists of three octal
  6777. * number components specifying access restrictions for the owner,
  6778. * the user group in which the owner is in, and to everybody else in
  6779. * this order. One component can be computed by adding up the needed
  6780. * permissions for that target user base. Number 1 means that you
  6781. * grant execute rights, number 2 means that you make the file
  6782. * writeable, number 4 means that you make the file readable. Add
  6783. * up these numbers to specify needed rights. You can also read more
  6784. * about modes on Unix systems with 'man 1 chmod'
  6785. * and 'man 2 chmod'.
  6786. * </p>
  6787. * <p>
  6788. * @return bool Returns true on success or false on failure.
  6789. */
  6790. function chmod ($filename, $mode) {}
  6791. /**
  6792. * Sets access and modification time of file
  6793. * @link http://www.php.net/manual/en/function.touch.php
  6794. * @param filename string <p>
  6795. * The name of the file being touched.
  6796. * </p>
  6797. * @param time int[optional] <p>
  6798. * The touch time. If time is not supplied,
  6799. * the current system time is used.
  6800. * </p>
  6801. * @param atime int[optional] <p>
  6802. * If present, the access time of the given filename is set to
  6803. * the value of atime. Otherwise, it is set to
  6804. * time.
  6805. * </p>
  6806. * @return bool Returns true on success or false on failure.
  6807. */
  6808. function touch ($filename, $time = null, $atime = null) {}
  6809. /**
  6810. * Clears file status cache
  6811. * @link http://www.php.net/manual/en/function.clearstatcache.php
  6812. * @param clear_realpath_cache bool[optional] <p>
  6813. * Whenever to clear realpath cache or not.
  6814. * </p>
  6815. * @param filename string[optional] <p>
  6816. * Clear realpath cache on a specific filename, only used if
  6817. * clear_realpath_cache is true.
  6818. * </p>
  6819. * @return void
  6820. */
  6821. function clearstatcache ($clear_realpath_cache = null, $filename = null) {}
  6822. /**
  6823. * Returns the total size of a directory
  6824. * @link http://www.php.net/manual/en/function.disk-total-space.php
  6825. * @param directory string <p>
  6826. * A directory of the filesystem or disk partition.
  6827. * </p>
  6828. * @return float the total number of bytes as a float
  6829. * &return.falseforfailure;.
  6830. */
  6831. function disk_total_space ($directory) {}
  6832. /**
  6833. * Returns available space in directory
  6834. * @link http://www.php.net/manual/en/function.disk-free-space.php
  6835. * @param directory string <p>
  6836. * A directory of the filesystem or disk partition.
  6837. * </p>
  6838. * <p>
  6839. * Given a file name instead of a directory, the behaviour of the
  6840. * function is unspecified and may differ between operating systems and
  6841. * PHP versions.
  6842. * </p>
  6843. * @return float the number of available bytes as a float
  6844. * &return.falseforfailure;.
  6845. */
  6846. function disk_free_space ($directory) {}
  6847. /**
  6848. * &Alias; <function>disk_free_space</function>
  6849. * @link http://www.php.net/manual/en/function.diskfreespace.php
  6850. * @param path
  6851. */
  6852. function diskfreespace ($path) {}
  6853. /**
  6854. * Send mail
  6855. * @link http://www.php.net/manual/en/function.mail.php
  6856. * @param to string <p>
  6857. * Receiver, or receivers of the mail.
  6858. * </p>
  6859. * <p>
  6860. * The formatting of this string must comply with
  6861. * RFC 2822. Some examples are:
  6862. * user@example.com
  6863. * user@example.com, anotheruser@example.com
  6864. * User &lt;user@example.com&gt;
  6865. * User &lt;user@example.com&gt;, Another User &lt;anotheruser@example.com&gt;
  6866. * </p>
  6867. * @param subject string <p>
  6868. * Subject of the email to be sent.
  6869. * </p>
  6870. * <p>
  6871. * Subject must satisfy RFC 2047.
  6872. * </p>
  6873. * @param message string <p>
  6874. * Message to be sent.
  6875. * </p>
  6876. * <p>
  6877. * Each line should be separated with a LF (\n). Lines should not be larger
  6878. * than 70 characters.
  6879. * </p>
  6880. * <p>
  6881. * (Windows only) When PHP is talking to a SMTP server directly, if a full
  6882. * stop is found on the start of a line, it is removed. To counter-act this,
  6883. * replace these occurrences with a double dot.
  6884. * ]]>
  6885. * </p>
  6886. * @param additional_headers string[optional] <p>
  6887. * String to be inserted at the end of the email header.
  6888. * </p>
  6889. * <p>
  6890. * This is typically used to add extra headers (From, Cc, and Bcc).
  6891. * Multiple extra headers should be separated with a CRLF (\r\n).
  6892. * </p>
  6893. * <p>
  6894. * When sending mail, the mail must contain
  6895. * a From header. This can be set with the
  6896. * additional_headers parameter, or a default
  6897. * can be set in &php.ini;.
  6898. * </p>
  6899. * <p>
  6900. * Failing to do this will result in an error
  6901. * message similar to Warning: mail(): "sendmail_from" not
  6902. * set in php.ini or custom "From:" header missing.
  6903. * The From header sets also
  6904. * Return-Path under Windows.
  6905. * </p>
  6906. * <p>
  6907. * If messages are not received, try using a LF (\n) only.
  6908. * Some poor quality Unix mail transfer agents replace LF by CRLF
  6909. * automatically (which leads to doubling CR if CRLF is used).
  6910. * This should be a last resort, as it does not comply with
  6911. * RFC 2822.
  6912. * </p>
  6913. * @param additional_parameters string[optional] <p>
  6914. * The additional_parameters parameter
  6915. * can be used to pass additional flags as command line options to the
  6916. * program configured to be used when sending mail, as defined by the
  6917. * sendmail_path configuration setting. For example,
  6918. * this can be used to set the envelope sender address when using
  6919. * sendmail with the -f sendmail option.
  6920. * </p>
  6921. * <p>
  6922. * The user that the webserver runs as should be added as a trusted user to the
  6923. * sendmail configuration to prevent a 'X-Warning' header from being added
  6924. * to the message when the envelope sender (-f) is set using this method.
  6925. * For sendmail users, this file is /etc/mail/trusted-users.
  6926. * </p>
  6927. * @return bool true if the mail was successfully accepted for delivery, false otherwise.
  6928. * </p>
  6929. * <p>
  6930. * It is important to note that just because the mail was accepted for delivery,
  6931. * it does NOT mean the mail will actually reach the intended destination.
  6932. */
  6933. function mail ($to, $subject, $message, $additional_headers = null, $additional_parameters = null) {}
  6934. /**
  6935. * Calculate the hash value needed by EZMLM
  6936. * @link http://www.php.net/manual/en/function.ezmlm-hash.php
  6937. * @param addr string <p>
  6938. * The email address that's being hashed.
  6939. * </p>
  6940. * @return int The hash value of addr.
  6941. */
  6942. function ezmlm_hash ($addr) {}
  6943. /**
  6944. * Open connection to system logger
  6945. * @link http://www.php.net/manual/en/function.openlog.php
  6946. * @param ident string <p>
  6947. * The string ident is added to each message.
  6948. * </p>
  6949. * @param option int <p>
  6950. * The option argument is used to indicate
  6951. * what logging options will be used when generating a log message.
  6952. * <table>
  6953. * openlog Options
  6954. * <tr valign="top">
  6955. * <td>Constant</td>
  6956. * <td>Description</td>
  6957. * </tr>
  6958. * <tr valign="top">
  6959. * <td>LOG_CONS</td>
  6960. * <td>
  6961. * if there is an error while sending data to the system logger,
  6962. * write directly to the system console
  6963. * </td>
  6964. * </tr>
  6965. * <tr valign="top">
  6966. * <td>LOG_NDELAY</td>
  6967. * <td>
  6968. * open the connection to the logger immediately
  6969. * </td>
  6970. * </tr>
  6971. * <tr valign="top">
  6972. * <td>LOG_ODELAY</td>
  6973. * <td>
  6974. * (default) delay opening the connection until the first
  6975. * message is logged
  6976. * </td>
  6977. * </tr>
  6978. * <tr valign="top">
  6979. * <td>LOG_PERROR</td>
  6980. * <td>print log message also to standard error</td>
  6981. * </tr>
  6982. * <tr valign="top">
  6983. * <td>LOG_PID</td>
  6984. * <td>include PID with each message</td>
  6985. * </tr>
  6986. * </table>
  6987. * You can use one or more of this options. When using multiple options
  6988. * you need to OR them, i.e. to open the connection
  6989. * immediately, write to the console and include the PID in each message,
  6990. * you will use: LOG_CONS | LOG_NDELAY | LOG_PID
  6991. * </p>
  6992. * @param facility int <p>
  6993. * The facility argument is used to specify what
  6994. * type of program is logging the message. This allows you to specify
  6995. * (in your machine's syslog configuration) how messages coming from
  6996. * different facilities will be handled.
  6997. * <table>
  6998. * openlog Facilities
  6999. * <tr valign="top">
  7000. * <td>Constant</td>
  7001. * <td>Description</td>
  7002. * </tr>
  7003. * <tr valign="top">
  7004. * <td>LOG_AUTH</td>
  7005. * <td>
  7006. * security/authorization messages (use
  7007. * LOG_AUTHPRIV instead
  7008. * in systems where that constant is defined)
  7009. * </td>
  7010. * </tr>
  7011. * <tr valign="top">
  7012. * <td>LOG_AUTHPRIV</td>
  7013. * <td>security/authorization messages (private)</td>
  7014. * </tr>
  7015. * <tr valign="top">
  7016. * <td>LOG_CRON</td>
  7017. * <td>clock daemon (cron and at)</td>
  7018. * </tr>
  7019. * <tr valign="top">
  7020. * <td>LOG_DAEMON</td>
  7021. * <td>other system daemons</td>
  7022. * </tr>
  7023. * <tr valign="top">
  7024. * <td>LOG_KERN</td>
  7025. * <td>kernel messages</td>
  7026. * </tr>
  7027. * <tr valign="top">
  7028. * <td>LOG_LOCAL0 ... LOG_LOCAL7</td>
  7029. * <td>reserved for local use, these are not available in Windows</td>
  7030. * </tr>
  7031. * <tr valign="top">
  7032. * <td>LOG_LPR</td>
  7033. * <td>line printer subsystem</td>
  7034. * </tr>
  7035. * <tr valign="top">
  7036. * <td>LOG_MAIL</td>
  7037. * <td>mail subsystem</td>
  7038. * </tr>
  7039. * <tr valign="top">
  7040. * <td>LOG_NEWS</td>
  7041. * <td>USENET news subsystem</td>
  7042. * </tr>
  7043. * <tr valign="top">
  7044. * <td>LOG_SYSLOG</td>
  7045. * <td>messages generated internally by syslogd</td>
  7046. * </tr>
  7047. * <tr valign="top">
  7048. * <td>LOG_USER</td>
  7049. * <td>generic user-level messages</td>
  7050. * </tr>
  7051. * <tr valign="top">
  7052. * <td>LOG_UUCP</td>
  7053. * <td>UUCP subsystem</td>
  7054. * </tr>
  7055. * </table>
  7056. * </p>
  7057. * <p>
  7058. * LOG_USER is the only valid log type under Windows
  7059. * operating systems
  7060. * </p>
  7061. * @return bool Returns true on success or false on failure.
  7062. */
  7063. function openlog ($ident, $option, $facility) {}
  7064. /**
  7065. * Generate a system log message
  7066. * @link http://www.php.net/manual/en/function.syslog.php
  7067. * @param priority int <p>
  7068. * priority is a combination of the facility and
  7069. * the level. Possible values are:
  7070. * <table>
  7071. * syslog Priorities (in descending order)
  7072. * <tr valign="top">
  7073. * <td>Constant</td>
  7074. * <td>Description</td>
  7075. * </tr>
  7076. * <tr valign="top">
  7077. * <td>LOG_EMERG</td>
  7078. * <td>system is unusable</td>
  7079. * </tr>
  7080. * <tr valign="top">
  7081. * <td>LOG_ALERT</td>
  7082. * <td>action must be taken immediately</td>
  7083. * </tr>
  7084. * <tr valign="top">
  7085. * <td>LOG_CRIT</td>
  7086. * <td>critical conditions</td>
  7087. * </tr>
  7088. * <tr valign="top">
  7089. * <td>LOG_ERR</td>
  7090. * <td>error conditions</td>
  7091. * </tr>
  7092. * <tr valign="top">
  7093. * <td>LOG_WARNING</td>
  7094. * <td>warning conditions</td>
  7095. * </tr>
  7096. * <tr valign="top">
  7097. * <td>LOG_NOTICE</td>
  7098. * <td>normal, but significant, condition</td>
  7099. * </tr>
  7100. * <tr valign="top">
  7101. * <td>LOG_INFO</td>
  7102. * <td>informational message</td>
  7103. * </tr>
  7104. * <tr valign="top">
  7105. * <td>LOG_DEBUG</td>
  7106. * <td>debug-level message</td>
  7107. * </tr>
  7108. * </table>
  7109. * </p>
  7110. * @param message string <p>
  7111. * The message to send, except that the two characters
  7112. * %m will be replaced by the error message string
  7113. * (strerror) corresponding to the present value of
  7114. * errno.
  7115. * </p>
  7116. * @return bool Returns true on success or false on failure.
  7117. */
  7118. function syslog ($priority, $message) {}
  7119. /**
  7120. * Close connection to system logger
  7121. * @link http://www.php.net/manual/en/function.closelog.php
  7122. * @return bool Returns true on success or false on failure.
  7123. */
  7124. function closelog () {}
  7125. /**
  7126. * Initializes all syslog related variables
  7127. * @link http://www.php.net/manual/en/function.define-syslog-variables.php
  7128. * @return void
  7129. */
  7130. function define_syslog_variables () {}
  7131. /**
  7132. * Combined linear congruential generator
  7133. * @link http://www.php.net/manual/en/function.lcg-value.php
  7134. * @return float A pseudo random float value in the range of (0, 1)
  7135. */
  7136. function lcg_value () {}
  7137. /**
  7138. * Calculate the metaphone key of a string
  7139. * @link http://www.php.net/manual/en/function.metaphone.php
  7140. * @param str string <p>
  7141. * The input string.
  7142. * </p>
  7143. * @param phones int[optional] <p>
  7144. * </p>
  7145. * @return string the metaphone key as a string.
  7146. */
  7147. function metaphone ($str, $phones = null) {}
  7148. /**
  7149. * Turn on output buffering
  7150. * @link http://www.php.net/manual/en/function.ob-start.php
  7151. * @param output_callback callback[optional] <p>
  7152. * An optional output_callback function may be
  7153. * specified. This function takes a string as a parameter and should
  7154. * return a string. The function will be called when
  7155. * the output buffer is flushed (sent) or cleaned (with
  7156. * ob_flush, ob_clean or similar
  7157. * function) or when the output buffer
  7158. * is flushed to the browser at the end of the request. When
  7159. * output_callback is called, it will receive the
  7160. * contents of the output buffer as its parameter and is expected to
  7161. * return a new output buffer as a result, which will be sent to the
  7162. * browser. If the output_callback is not a
  7163. * callable function, this function will return false.
  7164. * </p>
  7165. * <p>
  7166. * If the callback function has two parameters, the second parameter is
  7167. * filled with a bit-field consisting of
  7168. * PHP_OUTPUT_HANDLER_START,
  7169. * PHP_OUTPUT_HANDLER_CONT and
  7170. * PHP_OUTPUT_HANDLER_END.
  7171. * </p>
  7172. * <p>
  7173. * If output_callback returns false original
  7174. * input is sent to the browser.
  7175. * </p>
  7176. * <p>
  7177. * The output_callback parameter may be bypassed
  7178. * by passing a &null; value.
  7179. * </p>
  7180. * <p>
  7181. * ob_end_clean, ob_end_flush,
  7182. * ob_clean, ob_flush and
  7183. * ob_start may not be called from a callback
  7184. * function. If you call them from callback function, the behavior is
  7185. * undefined. If you would like to delete the contents of a buffer,
  7186. * return "" (a null string) from callback function.
  7187. * You can't even call functions using the output buffering functions like
  7188. * print_r($expression, true) or
  7189. * highlight_file($filename, true) from a callback
  7190. * function.
  7191. * </p>
  7192. * <p>
  7193. * In PHP 4.0.4, ob_gzhandler was introduced to
  7194. * facilitate sending gz-encoded data to web browsers that support
  7195. * compressed web pages. ob_gzhandler determines
  7196. * what type of content encoding the browser will accept and will return
  7197. * its output accordingly.
  7198. * </p>
  7199. * @param chunk_size int[optional] <p>
  7200. * If the optional parameter chunk_size is passed, the
  7201. * buffer will be flushed after any output call which causes the buffer's
  7202. * length to equal or exceed chunk_size.
  7203. * Default value 0 means that the function is called only in the end,
  7204. * other special value 1 sets chunk_size to 4096.
  7205. * </p>
  7206. * @param erase bool[optional] <p>
  7207. * If the optional parameter erase is set to false,
  7208. * the buffer will not be deleted until the script finishes.
  7209. * This causes that flushing and cleaning functions would issue a notice
  7210. * and return false if called.
  7211. * </p>
  7212. * @return bool Returns true on success or false on failure.
  7213. */
  7214. function ob_start ($output_callback = null, $chunk_size = null, $erase = null) {}
  7215. /**
  7216. * Flush (send) the output buffer
  7217. * @link http://www.php.net/manual/en/function.ob-flush.php
  7218. * @return void
  7219. */
  7220. function ob_flush () {}
  7221. /**
  7222. * Clean (erase) the output buffer
  7223. * @link http://www.php.net/manual/en/function.ob-clean.php
  7224. * @return void
  7225. */
  7226. function ob_clean () {}
  7227. /**
  7228. * Flush (send) the output buffer and turn off output buffering
  7229. * @link http://www.php.net/manual/en/function.ob-end-flush.php
  7230. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  7231. * function without an active buffer or that for some reason a buffer could
  7232. * not be deleted (possible for special buffer).
  7233. */
  7234. function ob_end_flush () {}
  7235. /**
  7236. * Clean (erase) the output buffer and turn off output buffering
  7237. * @link http://www.php.net/manual/en/function.ob-end-clean.php
  7238. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  7239. * function without an active buffer or that for some reason a buffer could
  7240. * not be deleted (possible for special buffer).
  7241. */
  7242. function ob_end_clean () {}
  7243. /**
  7244. * Flush the output buffer, return it as a string and turn off output buffering
  7245. * @link http://www.php.net/manual/en/function.ob-get-flush.php
  7246. * @return string the output buffer or false if no buffering is active.
  7247. */
  7248. function ob_get_flush () {}
  7249. /**
  7250. * Get current buffer contents and delete current output buffer
  7251. * @link http://www.php.net/manual/en/function.ob-get-clean.php
  7252. * @return string the contents of the output buffer and end output buffering.
  7253. * If output buffering isn't active then false is returned.
  7254. */
  7255. function ob_get_clean () {}
  7256. /**
  7257. * Return the length of the output buffer
  7258. * @link http://www.php.net/manual/en/function.ob-get-length.php
  7259. * @return int the length of the output buffer contents or false if no
  7260. * buffering is active.
  7261. */
  7262. function ob_get_length () {}
  7263. /**
  7264. * Return the nesting level of the output buffering mechanism
  7265. * @link http://www.php.net/manual/en/function.ob-get-level.php
  7266. * @return int the level of nested output buffering handlers or zero if output
  7267. * buffering is not active.
  7268. */
  7269. function ob_get_level () {}
  7270. /**
  7271. * Get status of output buffers
  7272. * @link http://www.php.net/manual/en/function.ob-get-status.php
  7273. * @param full_status bool[optional] <p>
  7274. * true to return all active output buffer levels. If false or not
  7275. * set, only the top level output buffer is returned.
  7276. * </p>
  7277. * @return array If called without the full_status parameter
  7278. * or with full_status = false a simple array
  7279. * with the following elements is returned:
  7280. * 2
  7281. * [type] => 0
  7282. * [status] => 0
  7283. * [name] => URL-Rewriter
  7284. * [del] => 1
  7285. * )
  7286. * ]]>
  7287. * Simple ob_get_status results
  7288. * KeyValue
  7289. * levelOutput nesting level
  7290. * typePHP_OUTPUT_HANDLER_INTERNAL (0) or PHP_OUTPUT_HANDLER_USER (1)
  7291. * statusOne of PHP_OUTPUT_HANDLER_START (0), PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2)
  7292. * nameName of active output handler or ' default output handler' if none is set
  7293. * delErase-flag as set by ob_start
  7294. * </p>
  7295. * <p>
  7296. * If called with full_status = true an array
  7297. * with one element for each active output buffer level is returned.
  7298. * The output level is used as key of the top level array and each array
  7299. * element itself is another array holding status information
  7300. * on one active output level.
  7301. * Array
  7302. * (
  7303. * [chunk_size] => 0
  7304. * [size] => 40960
  7305. * [block_size] => 10240
  7306. * [type] => 1
  7307. * [status] => 0
  7308. * [name] => default output handler
  7309. * [del] => 1
  7310. * )
  7311. * [1] => Array
  7312. * (
  7313. * [chunk_size] => 0
  7314. * [size] => 40960
  7315. * [block_size] => 10240
  7316. * [type] => 0
  7317. * [buffer_size] => 0
  7318. * [status] => 0
  7319. * [name] => URL-Rewriter
  7320. * [del] => 1
  7321. * )
  7322. * )
  7323. * ]]>
  7324. * </p>
  7325. * <p>
  7326. * The full output contains these additional elements:
  7327. * Full ob_get_status results
  7328. * KeyValue
  7329. * chunk_sizeChunk size as set by ob_start
  7330. * size...
  7331. * blocksize...
  7332. */
  7333. function ob_get_status ($full_status = null) {}
  7334. /**
  7335. * Return the contents of the output buffer
  7336. * @link http://www.php.net/manual/en/function.ob-get-contents.php
  7337. * @return string This will return the contents of the output buffer or false, if output
  7338. * buffering isn't active.
  7339. */
  7340. function ob_get_contents () {}
  7341. /**
  7342. * Turn implicit flush on/off
  7343. * @link http://www.php.net/manual/en/function.ob-implicit-flush.php
  7344. * @param flag int[optional] <p>
  7345. * true to turn implicit flushing on, false otherwise.
  7346. * </p>
  7347. * @return void
  7348. */
  7349. function ob_implicit_flush ($flag = null) {}
  7350. /**
  7351. * List all output handlers in use
  7352. * @link http://www.php.net/manual/en/function.ob-list-handlers.php
  7353. * @return array This will return an array with the output handlers in use (if any). If
  7354. * output_buffering is enabled or
  7355. * an anonymous function was used with ob_start,
  7356. * ob_list_handlers will return "default output
  7357. * handler".
  7358. */
  7359. function ob_list_handlers () {}
  7360. /**
  7361. * Sort an array by key
  7362. * @link http://www.php.net/manual/en/function.ksort.php
  7363. * @param array array <p>
  7364. * The input array.
  7365. * </p>
  7366. * @param sort_flags int[optional] <p>
  7367. * You may modify the behavior of the sort using the optional
  7368. * parameter sort_flags, for details
  7369. * see sort.
  7370. * </p>
  7371. * @return bool Returns true on success or false on failure.
  7372. */
  7373. function ksort (array &$array, $sort_flags = null) {}
  7374. /**
  7375. * Sort an array by key in reverse order
  7376. * @link http://www.php.net/manual/en/function.krsort.php
  7377. * @param array array <p>
  7378. * The input array.
  7379. * </p>
  7380. * @param sort_flags int[optional] <p>
  7381. * You may modify the behavior of the sort using the optional parameter
  7382. * sort_flags, for details see
  7383. * sort.
  7384. * </p>
  7385. * @return bool Returns true on success or false on failure.
  7386. */
  7387. function krsort (array &$array, $sort_flags = null) {}
  7388. /**
  7389. * Sort an array using a "natural order" algorithm
  7390. * @link http://www.php.net/manual/en/function.natsort.php
  7391. * @param array array <p>
  7392. * The input array.
  7393. * </p>
  7394. * @return bool Returns true on success or false on failure.
  7395. */
  7396. function natsort (array &$array) {}
  7397. /**
  7398. * Sort an array using a case insensitive "natural order" algorithm
  7399. * @link http://www.php.net/manual/en/function.natcasesort.php
  7400. * @param array array <p>
  7401. * The input array.
  7402. * </p>
  7403. * @return bool Returns true on success or false on failure.
  7404. */
  7405. function natcasesort (array &$array) {}
  7406. /**
  7407. * Sort an array and maintain index association
  7408. * @link http://www.php.net/manual/en/function.asort.php
  7409. * @param array array <p>
  7410. * The input array.
  7411. * </p>
  7412. * @param sort_flags int[optional] <p>
  7413. * You may modify the behavior of the sort using the optional
  7414. * parameter sort_flags, for details
  7415. * see sort.
  7416. * </p>
  7417. * @return bool Returns true on success or false on failure.
  7418. */
  7419. function asort (array &$array, $sort_flags = null) {}
  7420. /**
  7421. * Sort an array in reverse order and maintain index association
  7422. * @link http://www.php.net/manual/en/function.arsort.php
  7423. * @param array array <p>
  7424. * The input array.
  7425. * </p>
  7426. * @param sort_flags int[optional] <p>
  7427. * You may modify the behavior of the sort using the optional parameter
  7428. * sort_flags, for details see
  7429. * sort.
  7430. * </p>
  7431. * @return bool Returns true on success or false on failure.
  7432. */
  7433. function arsort (array &$array, $sort_flags = null) {}
  7434. /**
  7435. * Sort an array
  7436. * @link http://www.php.net/manual/en/function.sort.php
  7437. * @param array array <p>
  7438. * The input array.
  7439. * </p>
  7440. * @param sort_flags int[optional] <p>
  7441. * The optional second parameter sort_flags
  7442. * may be used to modify the sorting behavior using these values:
  7443. * </p>
  7444. * <p>
  7445. * Sorting type flags:
  7446. * SORT_REGULAR - compare items normally
  7447. * (don't change types)
  7448. * @return bool Returns true on success or false on failure.
  7449. */
  7450. function sort (array &$array, $sort_flags = null) {}
  7451. /**
  7452. * Sort an array in reverse order
  7453. * @link http://www.php.net/manual/en/function.rsort.php
  7454. * @param array array <p>
  7455. * The input array.
  7456. * </p>
  7457. * @param sort_flags int[optional] <p>
  7458. * You may modify the behavior of the sort using the optional
  7459. * parameter sort_flags, for details see
  7460. * sort.
  7461. * </p>
  7462. * @return bool Returns true on success or false on failure.
  7463. */
  7464. function rsort (array &$array, $sort_flags = null) {}
  7465. /**
  7466. * Sort an array by values using a user-defined comparison function
  7467. * @link http://www.php.net/manual/en/function.usort.php
  7468. * @param array array <p>
  7469. * The input array.
  7470. * </p>
  7471. * @param cmp_function callback <p>
  7472. * The comparison function must return an integer less than, equal to, or
  7473. * greater than zero if the first argument is considered to be
  7474. * respectively less than, equal to, or greater than the second.
  7475. * </p>
  7476. * @return bool Returns true on success or false on failure.
  7477. */
  7478. function usort (array &$array, $cmp_function) {}
  7479. /**
  7480. * Sort an array with a user-defined comparison function and maintain index association
  7481. * @link http://www.php.net/manual/en/function.uasort.php
  7482. * @param array array <p>
  7483. * The input array.
  7484. * </p>
  7485. * @param cmp_function callback <p>
  7486. * See usort and uksort for
  7487. * examples of user-defined comparison functions.
  7488. * </p>
  7489. * @return bool Returns true on success or false on failure.
  7490. */
  7491. function uasort (array &$array, $cmp_function) {}
  7492. /**
  7493. * Sort an array by keys using a user-defined comparison function
  7494. * @link http://www.php.net/manual/en/function.uksort.php
  7495. * @param array array <p>
  7496. * The input array.
  7497. * </p>
  7498. * @param cmp_function callback <p>
  7499. * The callback comparison function.
  7500. * </p>
  7501. * <p>
  7502. * Function cmp_function should accept two
  7503. * parameters which will be filled by pairs of array keys.
  7504. * The comparison function must return an integer less than, equal
  7505. * to, or greater than zero if the first argument is considered to
  7506. * be respectively less than, equal to, or greater than the
  7507. * second.
  7508. * </p>
  7509. * @return bool Returns true on success or false on failure.
  7510. */
  7511. function uksort (array &$array, $cmp_function) {}
  7512. /**
  7513. * Shuffle an array
  7514. * @link http://www.php.net/manual/en/function.shuffle.php
  7515. * @param array array <p>
  7516. * The array.
  7517. * </p>
  7518. * @return bool Returns true on success or false on failure.
  7519. */
  7520. function shuffle (array &$array) {}
  7521. /**
  7522. * Apply a user function to every member of an array
  7523. * @link http://www.php.net/manual/en/function.array-walk.php
  7524. * @param array array <p>
  7525. * The input array.
  7526. * </p>
  7527. * @param funcname callback <p>
  7528. * Typically, funcname takes on two parameters.
  7529. * The array parameter's value being the first, and
  7530. * the key/index second.
  7531. * </p>
  7532. * <p>
  7533. * If funcname needs to be working with the
  7534. * actual values of the array, specify the first parameter of
  7535. * funcname as a
  7536. * reference. Then,
  7537. * any changes made to those elements will be made in the
  7538. * original array itself.
  7539. * </p>
  7540. * <p>
  7541. * Users may not change the array itself from the
  7542. * callback function. e.g. Add/delete elements, unset elements, etc. If
  7543. * the array that array_walk is applied to is
  7544. * changed, the behavior of this function is undefined, and unpredictable.
  7545. * </p>
  7546. * @param userdata mixed[optional] <p>
  7547. * If the optional userdata parameter is supplied,
  7548. * it will be passed as the third parameter to the callback
  7549. * funcname.
  7550. * </p>
  7551. * @return bool Returns true on success or false on failure.
  7552. */
  7553. function array_walk (array &$array, $funcname, $userdata = null) {}
  7554. /**
  7555. * Apply a user function recursively to every member of an array
  7556. * @link http://www.php.net/manual/en/function.array-walk-recursive.php
  7557. * @param input array <p>
  7558. * The input array.
  7559. * </p>
  7560. * @param funcname callback <p>
  7561. * Typically, funcname takes on two parameters.
  7562. * The input parameter's value being the first, and
  7563. * the key/index second.
  7564. * </p>
  7565. * <p>
  7566. * If funcname needs to be working with the
  7567. * actual values of the array, specify the first parameter of
  7568. * funcname as a
  7569. * reference. Then,
  7570. * any changes made to those elements will be made in the
  7571. * original array itself.
  7572. * </p>
  7573. * @param userdata mixed[optional] <p>
  7574. * If the optional userdata parameter is supplied,
  7575. * it will be passed as the third parameter to the callback
  7576. * funcname.
  7577. * </p>
  7578. * @return bool Returns true on success or false on failure.
  7579. */
  7580. function array_walk_recursive (array &$input, $funcname, $userdata = null) {}
  7581. /**
  7582. * Count all elements in an array, or properties in an object
  7583. * @link http://www.php.net/manual/en/function.count.php
  7584. * @param var mixed <p>
  7585. * The array.
  7586. * </p>
  7587. * @param mode int[optional] <p>
  7588. * If the optional mode parameter is set to
  7589. * COUNT_RECURSIVE (or 1), count
  7590. * will recursively count the array. This is particularly useful for
  7591. * counting all the elements of a multidimensional array.
  7592. * count does not detect infinite recursion.
  7593. * </p>
  7594. * @return int the number of elements in var, which is
  7595. * typically an array, since anything else will have one
  7596. * element.
  7597. * </p>
  7598. * <p>
  7599. * If var is not an array or an object with
  7600. * implemented Countable interface,
  7601. * 1 will be returned.
  7602. * There is one exception, if var is &null;,
  7603. * 0 will be returned.
  7604. * </p>
  7605. * <p>
  7606. * count may return 0 for a variable that isn't set,
  7607. * but it may also return 0 for a variable that has been initialized with an
  7608. * empty array. Use isset to test if a variable is set.
  7609. */
  7610. function count ($var, $mode = null) {}
  7611. /**
  7612. * Set the internal pointer of an array to its last element
  7613. * @link http://www.php.net/manual/en/function.end.php
  7614. * @param array array <p>
  7615. * The array. This array is passed by reference because it is modified by
  7616. * the function. This means you must pass it a real variable and not
  7617. * a function returning an array because only actual variables may be
  7618. * passed by reference.
  7619. * </p>
  7620. * @return mixed the value of the last element or false for empty array.
  7621. */
  7622. function end (array &$array) {}
  7623. /**
  7624. * Rewind the internal array pointer
  7625. * @link http://www.php.net/manual/en/function.prev.php
  7626. * @param array array <p>
  7627. * The input array.
  7628. * </p>
  7629. * @return mixed the array value in the previous place that's pointed to by
  7630. * the internal array pointer, or false if there are no more
  7631. * elements.
  7632. */
  7633. function prev (array &$array) {}
  7634. /**
  7635. * Advance the internal array pointer of an array
  7636. * @link http://www.php.net/manual/en/function.next.php
  7637. * @param array array <p>
  7638. * The array being affected.
  7639. * </p>
  7640. * @return mixed the array value in the next place that's pointed to by the
  7641. * internal array pointer, or false if there are no more elements.
  7642. */
  7643. function next (array &$array) {}
  7644. /**
  7645. * Set the internal pointer of an array to its first element
  7646. * @link http://www.php.net/manual/en/function.reset.php
  7647. * @param array array <p>
  7648. * The input array.
  7649. * </p>
  7650. * @return mixed the value of the first array element, or false if the array is
  7651. * empty.
  7652. */
  7653. function reset (array &$array) {}
  7654. /**
  7655. * Return the current element in an array
  7656. * @link http://www.php.net/manual/en/function.current.php
  7657. * @param array array <p>
  7658. * The array.
  7659. * </p>
  7660. * @return mixed The current function simply returns the
  7661. * value of the array element that's currently being pointed to by the
  7662. * internal pointer. It does not move the pointer in any way. If the
  7663. * internal pointer points beyond the end of the elements list or the array is
  7664. * empty, current returns false.
  7665. */
  7666. function current (array &$array) {}
  7667. /**
  7668. * Fetch a key from an array
  7669. * @link http://www.php.net/manual/en/function.key.php
  7670. * @param array array <p>
  7671. * The array.
  7672. * </p>
  7673. * @return mixed The key function simply returns the
  7674. * key of the array element that's currently being pointed to by the
  7675. * internal pointer. It does not move the pointer in any way. If the
  7676. * internal pointer points beyond the end of the elements list or the array is
  7677. * empty, key returns &null;.
  7678. */
  7679. function key (array &$array) {}
  7680. /**
  7681. * Find lowest value
  7682. * @link http://www.php.net/manual/en/function.min.php
  7683. * @param values array <p>
  7684. * An array containing the values.
  7685. * </p>
  7686. * @return mixed min returns the numerically lowest of the
  7687. * parameter values.
  7688. */
  7689. function min (array $values) {}
  7690. /**
  7691. * Find highest value
  7692. * @link http://www.php.net/manual/en/function.max.php
  7693. * @param values array <p>
  7694. * An array containing the values.
  7695. * </p>
  7696. * @return mixed max returns the numerically highest of the
  7697. * parameter values. If multiple values can be considered of the same size,
  7698. * the one that is listed first will be returned.
  7699. * </p>
  7700. * <p>
  7701. * When max is given multiple arrays, the
  7702. * longest array is returned. If all the arrays have the same length,
  7703. * max will use lexicographic ordering to find the return
  7704. * value.
  7705. * </p>
  7706. * <p>
  7707. * When given a string it will be cast as an integer
  7708. * when comparing.
  7709. */
  7710. function max (array $values) {}
  7711. /**
  7712. * Checks if a value exists in an array
  7713. * @link http://www.php.net/manual/en/function.in-array.php
  7714. * @param needle mixed <p>
  7715. * The searched value.
  7716. * </p>
  7717. * <p>
  7718. * If needle is a string, the comparison is done
  7719. * in a case-sensitive manner.
  7720. * </p>
  7721. * @param haystack array <p>
  7722. * The array.
  7723. * </p>
  7724. * @param strict bool[optional] <p>
  7725. * If the third parameter strict is set to true
  7726. * then the in_array function will also check the
  7727. * types of the
  7728. * needle in the haystack.
  7729. * </p>
  7730. * @return bool true if needle is found in the array,
  7731. * false otherwise.
  7732. */
  7733. function in_array ($needle, array $haystack, $strict = null) {}
  7734. /**
  7735. * Searches the array for a given value and returns the corresponding key if successful
  7736. * @link http://www.php.net/manual/en/function.array-search.php
  7737. * @param needle mixed <p>
  7738. * The searched value.
  7739. * </p>
  7740. * <p>
  7741. * If needle is a string, the comparison is done
  7742. * in a case-sensitive manner.
  7743. * </p>
  7744. * @param haystack array <p>
  7745. * The array.
  7746. * </p>
  7747. * @param strict bool[optional] <p>
  7748. * If the third parameter strict is set to true
  7749. * then the array_search function will also check the
  7750. * types of the
  7751. * needle in the haystack.
  7752. * </p>
  7753. * @return mixed the key for needle if it is found in the
  7754. * array, false otherwise.
  7755. * </p>
  7756. * <p>
  7757. * If needle is found in haystack
  7758. * more than once, the first matching key is returned. To return the keys for
  7759. * all matching values, use array_keys with the optional
  7760. * search_value parameter instead.
  7761. */
  7762. function array_search ($needle, array $haystack, $strict = null) {}
  7763. /**
  7764. * Import variables into the current symbol table from an array
  7765. * @link http://www.php.net/manual/en/function.extract.php
  7766. * @param var_array array <p>
  7767. * Note that prefix is only required if
  7768. * extract_type is EXTR_PREFIX_SAME,
  7769. * EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID
  7770. * or EXTR_PREFIX_IF_EXISTS. If
  7771. * the prefixed result is not a valid variable name, it is not
  7772. * imported into the symbol table. Prefixes are automatically separated from
  7773. * the array key by an underscore character.
  7774. * </p>
  7775. * @param extract_type int[optional] <p>
  7776. * The way invalid/numeric keys and collisions are treated is determined
  7777. * by the extract_type. It can be one of the
  7778. * following values:
  7779. * EXTR_OVERWRITE
  7780. * If there is a collision, overwrite the existing variable.
  7781. * @param prefix string[optional] Only overwrite the variable if it already exists in the
  7782. * current symbol table, otherwise do nothing. This is useful
  7783. * for defining a list of valid variables and then extracting
  7784. * only those variables you have defined out of
  7785. * $_REQUEST, for example.
  7786. * @return int the number of variables successfully imported into the symbol
  7787. * table.
  7788. */
  7789. function extract (array $var_array, $extract_type = null, $prefix = null) {}
  7790. /**
  7791. * Create array containing variables and their values
  7792. * @link http://www.php.net/manual/en/function.compact.php
  7793. * @param varname mixed <p>
  7794. * compact takes a variable number of parameters.
  7795. * Each parameter can be either a string containing the name of the
  7796. * variable, or an array of variable names. The array can contain other
  7797. * arrays of variable names inside it; compact
  7798. * handles it recursively.
  7799. * </p>
  7800. * @param _ mixed[optional]
  7801. * @return array the output array with all the variables added to it.
  7802. */
  7803. function compact ($varname, $_ = null) {}
  7804. /**
  7805. * Fill an array with values
  7806. * @link http://www.php.net/manual/en/function.array-fill.php
  7807. * @param start_index int <p>
  7808. * The first index of the returned array.
  7809. * Supports non-negative indexes only.
  7810. * </p>
  7811. * @param num int <p>
  7812. * Number of elements to insert
  7813. * </p>
  7814. * @param value mixed <p>
  7815. * Value to use for filling
  7816. * </p>
  7817. * @return array the filled array
  7818. */
  7819. function array_fill ($start_index, $num, $value) {}
  7820. /**
  7821. * Fill an array with values, specifying keys
  7822. * @link http://www.php.net/manual/en/function.array-fill-keys.php
  7823. * @param keys array <p>
  7824. * Array of values that will be used as keys. Illegal values
  7825. * for key will be converted to string.
  7826. * </p>
  7827. * @param value mixed <p>
  7828. * Value to use for filling
  7829. * </p>
  7830. * @return array the filled array
  7831. */
  7832. function array_fill_keys (array $keys, $value) {}
  7833. /**
  7834. * Create an array containing a range of elements
  7835. * @link http://www.php.net/manual/en/function.range.php
  7836. * @param low mixed <p>
  7837. * Low value.
  7838. * </p>
  7839. * @param high mixed <p>
  7840. * High value.
  7841. * </p>
  7842. * @param step number[optional] <p>
  7843. * If a step value is given, it will be used as the
  7844. * increment between elements in the sequence. step
  7845. * should be given as a positive number. If not specified,
  7846. * step will default to 1.
  7847. * </p>
  7848. * @return array an array of elements from low to
  7849. * high, inclusive. If low > high, the sequence will
  7850. * be from high to low.
  7851. */
  7852. function range ($low, $high, $step = null) {}
  7853. /**
  7854. * Sort multiple or multi-dimensional arrays
  7855. * @link http://www.php.net/manual/en/function.array-multisort.php
  7856. * @param arr array <p>
  7857. * An array being sorted.
  7858. * </p>
  7859. * @param arg mixed[optional] <p>
  7860. * Optionally another array, or sort options for the
  7861. * previous array argument:
  7862. * SORT_ASC,
  7863. * SORT_DESC,
  7864. * SORT_REGULAR,
  7865. * SORT_NUMERIC,
  7866. * SORT_STRING.
  7867. * </p>
  7868. * @param arg mixed[optional]
  7869. * @param _ mixed[optional]
  7870. * @return bool Returns true on success or false on failure.
  7871. */
  7872. function array_multisort (array &$arr, $arg = null, $arg = null, $_ = null) {}
  7873. /**
  7874. * Push one or more elements onto the end of array
  7875. * @link http://www.php.net/manual/en/function.array-push.php
  7876. * @param array array <p>
  7877. * The input array.
  7878. * </p>
  7879. * @param var mixed <p>
  7880. * The pushed value.
  7881. * </p>
  7882. * @param _ mixed[optional]
  7883. * @return int the new number of elements in the array.
  7884. */
  7885. function array_push (array &$array, $var, $_ = null) {}
  7886. /**
  7887. * Pop the element off the end of array
  7888. * @link http://www.php.net/manual/en/function.array-pop.php
  7889. * @param array array <p>
  7890. * The array to get the value from.
  7891. * </p>
  7892. * @return mixed the last value of array.
  7893. * If array is empty (or is not an array),
  7894. * &null; will be returned.
  7895. */
  7896. function array_pop (array &$array) {}
  7897. /**
  7898. * Shift an element off the beginning of array
  7899. * @link http://www.php.net/manual/en/function.array-shift.php
  7900. * @param array array <p>
  7901. * The input array.
  7902. * </p>
  7903. * @return mixed the shifted value, or &null; if array is
  7904. * empty or is not an array.
  7905. */
  7906. function array_shift (array &$array) {}
  7907. /**
  7908. * Prepend one or more elements to the beginning of an array
  7909. * @link http://www.php.net/manual/en/function.array-unshift.php
  7910. * @param array array <p>
  7911. * The input array.
  7912. * </p>
  7913. * @param var mixed <p>
  7914. * The prepended variable.
  7915. * </p>
  7916. * @param _ mixed[optional]
  7917. * @return int the new number of elements in the array.
  7918. */
  7919. function array_unshift (array &$array, $var, $_ = null) {}
  7920. /**
  7921. * Remove a portion of the array and replace it with something else
  7922. * @link http://www.php.net/manual/en/function.array-splice.php
  7923. * @param input array <p>
  7924. * The input array.
  7925. * </p>
  7926. * @param offset int <p>
  7927. * If offset is positive then the start of removed
  7928. * portion is at that offset from the beginning of the
  7929. * input array. If offset
  7930. * is negative then it starts that far from the end of the
  7931. * input array.
  7932. * </p>
  7933. * @param length int[optional] <p>
  7934. * If length is omitted, removes everything
  7935. * from offset to the end of the array. If
  7936. * length is specified and is positive, then
  7937. * that many elements will be removed. If
  7938. * length is specified and is negative then
  7939. * the end of the removed portion will be that many elements from
  7940. * the end of the array. Tip: to remove everything from
  7941. * offset to the end of the array when
  7942. * replacement is also specified, use
  7943. * count($input) for
  7944. * length.
  7945. * </p>
  7946. * @param replacement mixed[optional] <p>
  7947. * If replacement array is specified, then the
  7948. * removed elements are replaced with elements from this array.
  7949. * </p>
  7950. * <p>
  7951. * If offset and length
  7952. * are such that nothing is removed, then the elements from the
  7953. * replacement array are inserted in the place
  7954. * specified by the offset. Note that keys in
  7955. * replacement array are not preserved.
  7956. * </p>
  7957. * <p>
  7958. * If replacement is just one element it is
  7959. * not necessary to put array()
  7960. * around it, unless the element is an array itself.
  7961. * </p>
  7962. * @return array the array consisting of the extracted elements.
  7963. */
  7964. function array_splice (array &$input, $offset, $length = null, $replacement = null) {}
  7965. /**
  7966. * Extract a slice of the array
  7967. * @link http://www.php.net/manual/en/function.array-slice.php
  7968. * @param array array <p>
  7969. * The input array.
  7970. * </p>
  7971. * @param offset int <p>
  7972. * If offset is non-negative, the sequence will
  7973. * start at that offset in the array. If
  7974. * offset is negative, the sequence will
  7975. * start that far from the end of the array.
  7976. * </p>
  7977. * @param length int[optional] <p>
  7978. * If length is given and is positive, then
  7979. * the sequence will have that many elements in it. If
  7980. * length is given and is negative then the
  7981. * sequence will stop that many elements from the end of the
  7982. * array. If it is omitted, then the sequence will have everything
  7983. * from offset up until the end of the
  7984. * array.
  7985. * </p>
  7986. * @param preserve_keys bool[optional] <p>
  7987. * Note that array_slice will reorder and reset the
  7988. * array indices by default. You can change this behaviour by setting
  7989. * preserve_keys to true.
  7990. * </p>
  7991. * @return array the slice.
  7992. */
  7993. function array_slice (array $array, $offset, $length = null, $preserve_keys = null) {}
  7994. /**
  7995. * Merge one or more arrays
  7996. * @link http://www.php.net/manual/en/function.array-merge.php
  7997. * @param array1 array <p>
  7998. * Initial array to merge.
  7999. * </p>
  8000. * @param array2 array[optional]
  8001. * @param _ array[optional]
  8002. * @return array the resulting array.
  8003. */
  8004. function array_merge (array $array1, array $array2 = null, array $_ = null) {}
  8005. /**
  8006. * Merge two or more arrays recursively
  8007. * @link http://www.php.net/manual/en/function.array-merge-recursive.php
  8008. * @param array1 array <p>
  8009. * Initial array to merge.
  8010. * </p>
  8011. * @param _ array[optional]
  8012. * @return array An array of values resulted from merging the arguments together.
  8013. */
  8014. function array_merge_recursive (array $array1, array $_ = null) {}
  8015. /**
  8016. * Return all the keys of an array
  8017. * @link http://www.php.net/manual/en/function.array-keys.php
  8018. * @param input array <p>
  8019. * An array containing keys to return.
  8020. * </p>
  8021. * @param search_value mixed[optional] <p>
  8022. * If specified, then only keys containing these values are returned.
  8023. * </p>
  8024. * @param strict bool[optional] <p>
  8025. * Determines if strict comparison (===) should be used during the search.
  8026. * </p>
  8027. * @return array an array of all the keys in input.
  8028. */
  8029. function array_keys (array $input, $search_value = null, $strict = null) {}
  8030. /**
  8031. * Return all the values of an array
  8032. * @link http://www.php.net/manual/en/function.array-values.php
  8033. * @param input array <p>
  8034. * The array.
  8035. * </p>
  8036. * @return array an indexed array of values.
  8037. */
  8038. function array_values (array $input) {}
  8039. /**
  8040. * Counts all the values of an array
  8041. * @link http://www.php.net/manual/en/function.array-count-values.php
  8042. * @param input array <p>
  8043. * The array of values to count
  8044. * </p>
  8045. * @return array an associative array of values from input as
  8046. * keys and their count as value.
  8047. */
  8048. function array_count_values (array $input) {}
  8049. /**
  8050. * Return an array with elements in reverse order
  8051. * @link http://www.php.net/manual/en/function.array-reverse.php
  8052. * @param array array <p>
  8053. * The input array.
  8054. * </p>
  8055. * @param preserve_keys bool[optional] <p>
  8056. * If set to true keys are preserved.
  8057. * </p>
  8058. * @return array the reversed array.
  8059. */
  8060. function array_reverse (array $array, $preserve_keys = null) {}
  8061. /**
  8062. * Iteratively reduce the array to a single value using a callback function
  8063. * @link http://www.php.net/manual/en/function.array-reduce.php
  8064. * @param input array <p>
  8065. * The input array.
  8066. * </p>
  8067. * @param function callback <p>
  8068. * The callback function.
  8069. * </p>
  8070. * @param initial mixed[optional] <p>
  8071. * If the optional initial is available, it will
  8072. * be used at the beginning of the process, or as a final result in case
  8073. * the array is empty.
  8074. * </p>
  8075. * @return mixed the resulting value.
  8076. * </p>
  8077. * <p>
  8078. * If the array is empty and initial is not passed,
  8079. * array_reduce returns &null;.
  8080. */
  8081. function array_reduce (array $input, $function, $initial = null) {}
  8082. /**
  8083. * Pad array to the specified length with a value
  8084. * @link http://www.php.net/manual/en/function.array-pad.php
  8085. * @param input array <p>
  8086. * Initial array of values to pad.
  8087. * </p>
  8088. * @param pad_size int <p>
  8089. * New size of the array.
  8090. * </p>
  8091. * @param pad_value mixed <p>
  8092. * Value to pad if input is less than
  8093. * pad_size.
  8094. * </p>
  8095. * @return array a copy of the input padded to size specified
  8096. * by pad_size with value
  8097. * pad_value. If pad_size is
  8098. * positive then the array is padded on the right, if it's negative then
  8099. * on the left. If the absolute value of pad_size is less than or equal to
  8100. * the length of the input then no padding takes place.
  8101. */
  8102. function array_pad (array $input, $pad_size, $pad_value) {}
  8103. /**
  8104. * Exchanges all keys with their associated values in an array
  8105. * @link http://www.php.net/manual/en/function.array-flip.php
  8106. * @param trans array <p>
  8107. * An array of key/value pairs to be flipped.
  8108. * </p>
  8109. * @return array the flipped array on success and &null; on failure.
  8110. */
  8111. function array_flip (array $trans) {}
  8112. /**
  8113. * Changes all keys in an array
  8114. * @link http://www.php.net/manual/en/function.array-change-key-case.php
  8115. * @param input array <p>
  8116. * The array to work on
  8117. * </p>
  8118. * @param case int[optional] <p>
  8119. * Either CASE_UPPER or
  8120. * CASE_LOWER (default)
  8121. * </p>
  8122. * @return array an array with its keys lower or uppercased, or false if
  8123. * input is not an array.
  8124. */
  8125. function array_change_key_case (array $input, $case = null) {}
  8126. /**
  8127. * Pick one or more random entries out of an array
  8128. * @link http://www.php.net/manual/en/function.array-rand.php
  8129. * @param input array <p>
  8130. * The input array.
  8131. * </p>
  8132. * @param num_req int[optional] <p>
  8133. * Specifies how many entries you want to pick.
  8134. * </p>
  8135. * @return mixed If you are picking only one entry, array_rand
  8136. * returns the key for a random entry. Otherwise, it returns an array
  8137. * of keys for the random entries. This is done so that you can pick
  8138. * random keys as well as values out of the array.
  8139. */
  8140. function array_rand (array $input, $num_req = null) {}
  8141. /**
  8142. * Removes duplicate values from an array
  8143. * @link http://www.php.net/manual/en/function.array-unique.php
  8144. * @param array array <p>
  8145. * The input array.
  8146. * </p>
  8147. * @param sort_flags int[optional] <p>
  8148. * The optional second parameter sort_flags
  8149. * may be used to modify the sorting behavior using these values:
  8150. * </p>
  8151. * <p>
  8152. * Sorting type flags:
  8153. * SORT_REGULAR - compare items normally
  8154. * (don't change types)
  8155. * @return array the filtered array.
  8156. */
  8157. function array_unique (array $array, $sort_flags = null) {}
  8158. /**
  8159. * Computes the intersection of arrays
  8160. * @link http://www.php.net/manual/en/function.array-intersect.php
  8161. * @param array1 array <p>
  8162. * The array with master values to check.
  8163. * </p>
  8164. * @param array2 array <p>
  8165. * An array to compare values against.
  8166. * </p>
  8167. * @param _ array[optional]
  8168. * @return array an array containing all of the values in
  8169. * array1 whose values exist in all of the parameters.
  8170. */
  8171. function array_intersect (array $array1, array $array2, array $_ = null) {}
  8172. /**
  8173. * Computes the intersection of arrays using keys for comparison
  8174. * @link http://www.php.net/manual/en/function.array-intersect-key.php
  8175. * @param array1 array <p>
  8176. * The array with master keys to check.
  8177. * </p>
  8178. * @param array2 array <p>
  8179. * An array to compare keys against.
  8180. * </p>
  8181. * @param _ array[optional]
  8182. * @return array an associative array containing all the entries of
  8183. * array1 which have keys that are present in all
  8184. * arguments.
  8185. */
  8186. function array_intersect_key (array $array1, array $array2, array $_ = null) {}
  8187. /**
  8188. * Computes the intersection of arrays using a callback function on the keys for comparison
  8189. * @link http://www.php.net/manual/en/function.array-intersect-ukey.php
  8190. * @param array1 array <p>
  8191. * Initial array for comparison of the arrays.
  8192. * </p>
  8193. * @param array2 array <p>
  8194. * First array to compare keys against.
  8195. * </p>
  8196. * @param _ array[optional]
  8197. * @param key_compare_func callback <p>
  8198. * User supplied callback function to do the comparison.
  8199. * </p>
  8200. * @return array the values of array1 whose keys exist
  8201. * in all the arguments.
  8202. */
  8203. function array_intersect_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8204. /**
  8205. * Computes the intersection of arrays, compares data by a callback function
  8206. * @link http://www.php.net/manual/en/function.array-uintersect.php
  8207. * @param array1 array <p>
  8208. * The first array.
  8209. * </p>
  8210. * @param array2 array <p>
  8211. * The second array.
  8212. * </p>
  8213. * @param _ array[optional]
  8214. * @param data_compare_func callback <p>
  8215. * The callback comparison function.
  8216. * </p>
  8217. * <p>
  8218. * The user supplied callback function is used for comparison.
  8219. * It must return an integer less than, equal to, or greater than zero if
  8220. * the first argument is considered to be respectively less than, equal
  8221. * to, or greater than the second.
  8222. * </p>
  8223. * @return array an array containing all the values of array1
  8224. * that are present in all the arguments.
  8225. */
  8226. function array_uintersect (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8227. /**
  8228. * Computes the intersection of arrays with additional index check
  8229. * @link http://www.php.net/manual/en/function.array-intersect-assoc.php
  8230. * @param array1 array <p>
  8231. * The array with master values to check.
  8232. * </p>
  8233. * @param array2 array <p>
  8234. * An array to compare values against.
  8235. * </p>
  8236. * @param _ array[optional]
  8237. * @return array an associative array containing all the values in
  8238. * array1 that are present in all of the arguments.
  8239. */
  8240. function array_intersect_assoc (array $array1, array $array2, array $_ = null) {}
  8241. /**
  8242. * Computes the intersection of arrays with additional index check, compares data by a callback function
  8243. * @link http://www.php.net/manual/en/function.array-uintersect-assoc.php
  8244. * @param array1 array <p>
  8245. * The first array.
  8246. * </p>
  8247. * @param array2 array <p>
  8248. * The second array.
  8249. * </p>
  8250. * @param _ array[optional]
  8251. * @param data_compare_func callback <p>
  8252. * For comparison is used the user supplied callback function.
  8253. * It must return an integer less than, equal
  8254. * to, or greater than zero if the first argument is considered to
  8255. * be respectively less than, equal to, or greater than the
  8256. * second.
  8257. * </p>
  8258. * @return array an array containing all the values of
  8259. * array1 that are present in all the arguments.
  8260. */
  8261. function array_uintersect_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8262. /**
  8263. * Computes the intersection of arrays with additional index check, compares indexes by a callback function
  8264. * @link http://www.php.net/manual/en/function.array-intersect-uassoc.php
  8265. * @param array1 array <p>
  8266. * Initial array for comparison of the arrays.
  8267. * </p>
  8268. * @param array2 array <p>
  8269. * First array to compare keys against.
  8270. * </p>
  8271. * @param _ array[optional]
  8272. * @param key_compare_func callback <p>
  8273. * User supplied callback function to do the comparison.
  8274. * </p>
  8275. * @return array the values of array1 whose values exist
  8276. * in all of the arguments.
  8277. */
  8278. function array_intersect_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8279. /**
  8280. * Computes the intersection of arrays with additional index check, compares data and indexes by a callback functions
  8281. * @link http://www.php.net/manual/en/function.array-uintersect-uassoc.php
  8282. * @param array1 array <p>
  8283. * The first array.
  8284. * </p>
  8285. * @param array2 array <p>
  8286. * The second array.
  8287. * </p>
  8288. * @param _ array[optional]
  8289. * @param data_compare_func callback <p>
  8290. * For comparison is used the user supplied callback function.
  8291. * It must return an integer less than, equal
  8292. * to, or greater than zero if the first argument is considered to
  8293. * be respectively less than, equal to, or greater than the
  8294. * second.
  8295. * </p>
  8296. * @param key_compare_func callback <p>
  8297. * Key comparison callback function.
  8298. * </p>
  8299. * @return array an array containing all the values of
  8300. * array1 that are present in all the arguments.
  8301. */
  8302. function array_uintersect_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  8303. /**
  8304. * Computes the difference of arrays
  8305. * @link http://www.php.net/manual/en/function.array-diff.php
  8306. * @param array1 array <p>
  8307. * The array to compare from
  8308. * </p>
  8309. * @param array2 array <p>
  8310. * An array to compare against
  8311. * </p>
  8312. * @param _ array[optional]
  8313. * @return array an array containing all the entries from
  8314. * array1 that are not present in any of the other arrays.
  8315. */
  8316. function array_diff (array $array1, array $array2, array $_ = null) {}
  8317. /**
  8318. * Computes the difference of arrays using keys for comparison
  8319. * @link http://www.php.net/manual/en/function.array-diff-key.php
  8320. * @param array1 array <p>
  8321. * The array to compare from
  8322. * </p>
  8323. * @param array2 array <p>
  8324. * An array to compare against
  8325. * </p>
  8326. * @param _ array[optional]
  8327. * @return array an array containing all the entries from
  8328. * array1 whose keys are not present in any of the
  8329. * other arrays.
  8330. */
  8331. function array_diff_key (array $array1, array $array2, array $_ = null) {}
  8332. /**
  8333. * Computes the difference of arrays using a callback function on the keys for comparison
  8334. * @link http://www.php.net/manual/en/function.array-diff-ukey.php
  8335. * @param array1 array <p>
  8336. * The array to compare from
  8337. * </p>
  8338. * @param array2 array <p>
  8339. * An array to compare against
  8340. * </p>
  8341. * @param _ array[optional]
  8342. * @param key_compare_func callback <p>
  8343. * callback function to use.
  8344. * The callback function must return an integer less than, equal
  8345. * to, or greater than zero if the first argument is considered to
  8346. * be respectively less than, equal to, or greater than the second.
  8347. * </p>
  8348. * @return array an array containing all the entries from
  8349. * array1 that are not present in any of the other arrays.
  8350. */
  8351. function array_diff_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8352. /**
  8353. * Computes the difference of arrays by using a callback function for data comparison
  8354. * @link http://www.php.net/manual/en/function.array-udiff.php
  8355. * @param array1 array <p>
  8356. * The first array.
  8357. * </p>
  8358. * @param array2 array <p>
  8359. * The second array.
  8360. * </p>
  8361. * @param _ array[optional]
  8362. * @param data_compare_func callback <p>
  8363. * The callback comparison function.
  8364. * </p>
  8365. * <p>
  8366. * The user supplied callback function is used for comparison.
  8367. * It must return an integer less than, equal to, or greater than zero if
  8368. * the first argument is considered to be respectively less than, equal
  8369. * to, or greater than the second.
  8370. * </p>
  8371. * @return array an array containing all the values of array1
  8372. * that are not present in any of the other arguments.
  8373. */
  8374. function array_udiff (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8375. /**
  8376. * Computes the difference of arrays with additional index check
  8377. * @link http://www.php.net/manual/en/function.array-diff-assoc.php
  8378. * @param array1 array <p>
  8379. * The array to compare from
  8380. * </p>
  8381. * @param array2 array <p>
  8382. * An array to compare against
  8383. * </p>
  8384. * @param _ array[optional]
  8385. * @return array an array containing all the values from
  8386. * array1 that are not present in any of the other arrays.
  8387. */
  8388. function array_diff_assoc (array $array1, array $array2, array $_ = null) {}
  8389. /**
  8390. * Computes the difference of arrays with additional index check, compares data by a callback function
  8391. * @link http://www.php.net/manual/en/function.array-udiff-assoc.php
  8392. * @param array1 array <p>
  8393. * The first array.
  8394. * </p>
  8395. * @param array2 array <p>
  8396. * The second array.
  8397. * </p>
  8398. * @param _ array[optional]
  8399. * @param data_compare_func callback <p>
  8400. * The callback comparison function.
  8401. * </p>
  8402. * <p>
  8403. * The user supplied callback function is used for comparison.
  8404. * It must return an integer less than, equal to, or greater than zero if
  8405. * the first argument is considered to be respectively less than, equal
  8406. * to, or greater than the second.
  8407. * </p>
  8408. * @return array array_udiff_assoc returns an array
  8409. * containing all the values from array1
  8410. * that are not present in any of the other arguments.
  8411. * Note that the keys are used in the comparison unlike
  8412. * array_diff and array_udiff.
  8413. * The comparison of arrays' data is performed by using an user-supplied
  8414. * callback. In this aspect the behaviour is opposite to the behaviour of
  8415. * array_diff_assoc which uses internal function for
  8416. * comparison.
  8417. */
  8418. function array_udiff_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8419. /**
  8420. * Computes the difference of arrays with additional index check which is performed by a user supplied callback function
  8421. * @link http://www.php.net/manual/en/function.array-diff-uassoc.php
  8422. * @param array1 array <p>
  8423. * The array to compare from
  8424. * </p>
  8425. * @param array2 array <p>
  8426. * An array to compare against
  8427. * </p>
  8428. * @param _ array[optional]
  8429. * @param key_compare_func callback <p>
  8430. * callback function to use.
  8431. * The callback function must return an integer less than, equal
  8432. * to, or greater than zero if the first argument is considered to
  8433. * be respectively less than, equal to, or greater than the second.
  8434. * </p>
  8435. * @return array an array containing all the entries from
  8436. * array1 that are not present in any of the other arrays.
  8437. */
  8438. function array_diff_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8439. /**
  8440. * Computes the difference of arrays with additional index check, compares data and indexes by a callback function
  8441. * @link http://www.php.net/manual/en/function.array-udiff-uassoc.php
  8442. * @param array1 array <p>
  8443. * The first array.
  8444. * </p>
  8445. * @param array2 array <p>
  8446. * The second array.
  8447. * </p>
  8448. * @param _ array[optional]
  8449. * @param data_compare_func callback <p>
  8450. * The callback comparison function.
  8451. * </p>
  8452. * <p>
  8453. * The user supplied callback function is used for comparison.
  8454. * It must return an integer less than, equal to, or greater than zero if
  8455. * the first argument is considered to be respectively less than, equal
  8456. * to, or greater than the second.
  8457. * </p>
  8458. * <p>
  8459. * The comparison of arrays' data is performed by using an user-supplied
  8460. * callback : data_compare_func. In this aspect
  8461. * the behaviour is opposite to the behaviour of
  8462. * array_diff_assoc which uses internal function for
  8463. * comparison.
  8464. * </p>
  8465. * @param key_compare_func callback <p>
  8466. * The comparison of keys (indices) is done also by the callback function
  8467. * key_compare_func. This behaviour is unlike what
  8468. * array_udiff_assoc does, since the latter compares
  8469. * the indices by using an internal function.
  8470. * </p>
  8471. * @return array an array containing all the values from
  8472. * array1 that are not present in any of the other
  8473. * arguments.
  8474. */
  8475. function array_udiff_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  8476. /**
  8477. * Calculate the sum of values in an array
  8478. * @link http://www.php.net/manual/en/function.array-sum.php
  8479. * @param array array <p>
  8480. * The input array.
  8481. * </p>
  8482. * @return number the sum of values as an integer or float.
  8483. */
  8484. function array_sum (array $array) {}
  8485. /**
  8486. * Calculate the product of values in an array
  8487. * @link http://www.php.net/manual/en/function.array-product.php
  8488. * @param array array <p>
  8489. * The array.
  8490. * </p>
  8491. * @return number the product as an integer or float.
  8492. */
  8493. function array_product (array $array) {}
  8494. /**
  8495. * Filters elements of an array using a callback function
  8496. * @link http://www.php.net/manual/en/function.array-filter.php
  8497. * @param input array <p>
  8498. * The array to iterate over
  8499. * </p>
  8500. * @param callback callback[optional] <p>
  8501. * The callback function to use
  8502. * </p>
  8503. * <p>
  8504. * If no callback is supplied, all entries of
  8505. * input equal to false (see
  8506. * converting to
  8507. * boolean) will be removed.
  8508. * </p>
  8509. * @return array the filtered array.
  8510. */
  8511. function array_filter (array $input, $callback = null) {}
  8512. /**
  8513. * Applies the callback to the elements of the given arrays
  8514. * @link http://www.php.net/manual/en/function.array-map.php
  8515. * @param callback callback <p>
  8516. * Callback function to run for each element in each array.
  8517. * </p>
  8518. * @param arr1 array <p>
  8519. * An array to run through the callback function.
  8520. * </p>
  8521. * @param _ array[optional]
  8522. * @return array an array containing all the elements of arr1
  8523. * after applying the callback function to each one.
  8524. */
  8525. function array_map ($callback, array $arr1, array $_ = null) {}
  8526. /**
  8527. * Split an array into chunks
  8528. * @link http://www.php.net/manual/en/function.array-chunk.php
  8529. * @param input array <p>
  8530. * The array to work on
  8531. * </p>
  8532. * @param size int <p>
  8533. * The size of each chunk
  8534. * </p>
  8535. * @param preserve_keys bool[optional] <p>
  8536. * When set to true keys will be preserved.
  8537. * Default is false which will reindex the chunk numerically
  8538. * </p>
  8539. * @return array a multidimensional numerically indexed array, starting with zero,
  8540. * with each dimension containing size elements.
  8541. */
  8542. function array_chunk (array $input, $size, $preserve_keys = null) {}
  8543. /**
  8544. * Creates an array by using one array for keys and another for its values
  8545. * @link http://www.php.net/manual/en/function.array-combine.php
  8546. * @param keys array <p>
  8547. * Array of keys to be used. Illegal values for key will be
  8548. * converted to string.
  8549. * </p>
  8550. * @param values array <p>
  8551. * Array of values to be used
  8552. * </p>
  8553. * @return array the combined array, false if the number of elements
  8554. * for each array isn't equal or if the arrays are empty.
  8555. */
  8556. function array_combine (array $keys, array $values) {}
  8557. /**
  8558. * Checks if the given key or index exists in the array
  8559. * @link http://www.php.net/manual/en/function.array-key-exists.php
  8560. * @param key mixed <p>
  8561. * Value to check.
  8562. * </p>
  8563. * @param search array <p>
  8564. * An array with keys to check.
  8565. * </p>
  8566. * @return bool Returns true on success or false on failure.
  8567. */
  8568. function array_key_exists ($key, array $search) {}
  8569. /**
  8570. * &Alias; <function>current</function>
  8571. * @link http://www.php.net/manual/en/function.pos.php
  8572. * @param arg
  8573. */
  8574. function pos (&$arg) {}
  8575. /**
  8576. * &Alias; <function>count</function>
  8577. * @link http://www.php.net/manual/en/function.sizeof.php
  8578. * @param var
  8579. * @param mode[optional]
  8580. */
  8581. function sizeof ($var, $mode) {}
  8582. /**
  8583. * @param key
  8584. * @param search
  8585. */
  8586. function key_exists ($key, $search) {}
  8587. /**
  8588. * Checks if assertion is &false;
  8589. * @link http://www.php.net/manual/en/function.assert.php
  8590. * @param assertion mixed <p>
  8591. * The assertion.
  8592. * </p>
  8593. * @return bool false if the assertion is false, true otherwise.
  8594. */
  8595. function assert ($assertion) {}
  8596. /**
  8597. * Set/get the various assert flags
  8598. * @link http://www.php.net/manual/en/function.assert-options.php
  8599. * @param what int <p>
  8600. * <table>
  8601. * Assert Options
  8602. * <tr valign="top">
  8603. * <td>Option</td>
  8604. * <td>INI Setting</td>
  8605. * <td>Default value</td>
  8606. * <td>Description</td>
  8607. * </tr>
  8608. * <tr valign="top">
  8609. * <td>ASSERT_ACTIVE</td>
  8610. * <td>assert.active</td>
  8611. * <td>1</td>
  8612. * <td>enable assert evaluation</td>
  8613. * </tr>
  8614. * <tr valign="top">
  8615. * <td>ASSERT_WARNING</td>
  8616. * <td>assert.warning</td>
  8617. * <td>1</td>
  8618. * <td>issue a PHP warning for each failed assertion</td>
  8619. * </tr>
  8620. * <tr valign="top">
  8621. * <td>ASSERT_BAIL</td>
  8622. * <td>assert.bail</td>
  8623. * <td>0</td>
  8624. * <td>terminate execution on failed assertions</td>
  8625. * </tr>
  8626. * <tr valign="top">
  8627. * <td>ASSERT_QUIET_EVAL</td>
  8628. * <td>assert.quiet_eval</td>
  8629. * <td>0</td>
  8630. * <td>
  8631. * disable error_reporting during assertion expression
  8632. * evaluation
  8633. * </td>
  8634. * </tr>
  8635. * <tr valign="top">
  8636. * <td>ASSERT_CALLBACK</td>
  8637. * <td>assert.callback</td>
  8638. * <td)<&null;)</td>
  8639. * <td>Callback to call on failed assertions</td>
  8640. * </tr>
  8641. * </table>
  8642. * </p>
  8643. * @param value mixed[optional] <p>
  8644. * An optional new value for the option.
  8645. * </p>
  8646. * @return mixed the original setting of any option or false on errors.
  8647. */
  8648. function assert_options ($what, $value = null) {}
  8649. /**
  8650. * Compares two "PHP-standardized" version number strings
  8651. * @link http://www.php.net/manual/en/function.version-compare.php
  8652. * @param version1 string <p>
  8653. * First version number.
  8654. * </p>
  8655. * @param version2 string <p>
  8656. * Second version number.
  8657. * </p>
  8658. * @param operator string[optional] <p>
  8659. * If you specify the third optional operator
  8660. * argument, you can test for a particular relationship. The
  8661. * possible operators are: &lt;,
  8662. * lt, &lt;=,
  8663. * le, &gt;,
  8664. * gt, &gt;=,
  8665. * ge, ==,
  8666. * =, eq,
  8667. * !=, &lt;&gt;,
  8668. * ne respectively.
  8669. * </p>
  8670. * <p>
  8671. * This parameter is case-sensitive, so values should be lowercase.
  8672. * </p>
  8673. * @return mixed By default, version_compare returns
  8674. * -1 if the first version is lower than the second,
  8675. * 0 if they are equal, and
  8676. * 1 if the second is lower.
  8677. * </p>
  8678. * <p>
  8679. * When using the optional operator argument, the
  8680. * function will return true if the relationship is the one specified
  8681. * by the operator, false otherwise.
  8682. */
  8683. function version_compare ($version1, $version2, $operator = null) {}
  8684. /**
  8685. * Perform the rot13 transform on a string
  8686. * @link http://www.php.net/manual/en/function.str-rot13.php
  8687. * @param str string <p>
  8688. * The input string.
  8689. * </p>
  8690. * @return string the ROT13 version of the given string.
  8691. */
  8692. function str_rot13 ($str) {}
  8693. /**
  8694. * Retrieve list of registered filters
  8695. * @link http://www.php.net/manual/en/function.stream-get-filters.php
  8696. * @return array an indexed array containing the name of all stream filters
  8697. * available.
  8698. */
  8699. function stream_get_filters () {}
  8700. /**
  8701. * Register a user defined stream filter
  8702. * @link http://www.php.net/manual/en/function.stream-filter-register.php
  8703. * @param filtername string <p>
  8704. * The filter name to be registered.
  8705. * </p>
  8706. * @param classname string <p>
  8707. * To implement a filter, you need to define a class as an extension of
  8708. * php_user_filter with a number of member functions
  8709. * as defined below. When performing read/write operations on the stream
  8710. * to which your filter is attached, PHP will pass the data through your
  8711. * filter (and any other filters attached to that stream) so that the
  8712. * data may be modified as desired. You must implement the methods
  8713. * exactly as described below - doing otherwise will lead to undefined
  8714. * behaviour.
  8715. * </p>
  8716. * intfilter
  8717. * resourcein
  8718. * resourceout
  8719. * intconsumed
  8720. * boolclosing
  8721. * <p>
  8722. * This method is called whenever data is read from or written to
  8723. * the attached stream (such as with fread or fwrite).
  8724. * in is a resource pointing to a bucket brigade
  8725. * which contains one or more bucket objects containing data to be filtered.
  8726. * out is a resource pointing to a second bucket brigade
  8727. * into which your modified buckets should be placed.
  8728. * consumed, which must always
  8729. * be declared by reference, should be incremented by the length of the data
  8730. * which your filter reads in and alters. In most cases this means you will
  8731. * increment consumed by $bucket->datalen
  8732. * for each $bucket. If the stream is in the process of closing
  8733. * (and therefore this is the last pass through the filterchain),
  8734. * the closing parameter will be set to true.
  8735. * The filter method must return one of
  8736. * three values upon completion.
  8737. * <tr valign="top">
  8738. * <td>Return Value</td>
  8739. * <td>Meaning</td>
  8740. * </tr>
  8741. * <tr valign="top">
  8742. * <td>PSFS_PASS_ON</td>
  8743. * <td>
  8744. * Filter processed successfully with data available in the
  8745. * out bucket brigade.
  8746. * </td>
  8747. * </tr>
  8748. * <tr valign="top">
  8749. * <td>PSFS_FEED_ME</td>
  8750. * <td>
  8751. * Filter processed successfully, however no data was available to
  8752. * return. More data is required from the stream or prior filter.
  8753. * </td>
  8754. * </tr>
  8755. * <tr valign="top">
  8756. * <td>PSFS_ERR_FATAL (default)</td>
  8757. * <td>
  8758. * The filter experienced an unrecoverable error and cannot continue.
  8759. * </td>
  8760. * </tr>
  8761. * </p>
  8762. * boolonCreate
  8763. * This method is called during instantiation of the filter class
  8764. * object. If your filter allocates or initializes any other resources
  8765. * (such as a buffer), this is the place to do it. Your implementation of
  8766. * this method should return false on failure, or true on success.
  8767. * When your filter is first instantiated, and
  8768. * yourfilter-&gt;onCreate() is called, a number of properties
  8769. * will be available as shown in the table below.
  8770. * <p>
  8771. * <tr valign="top">
  8772. * <td>Property</td>
  8773. * <td>Contents</td>
  8774. * </tr>
  8775. * <tr valign="top">
  8776. * <td>FilterClass-&gt;filtername</td>
  8777. * <td>
  8778. * A string containing the name the filter was instantiated with.
  8779. * Filters may be registered under multiple names or under wildcards.
  8780. * Use this property to determine which name was used.
  8781. * </td>
  8782. * </tr>
  8783. * <tr valign="top">
  8784. * <td>FilterClass-&gt;params</td>
  8785. * <td>
  8786. * The contents of the params parameter passed
  8787. * to stream_filter_append
  8788. * or stream_filter_prepend.
  8789. * </td>
  8790. * </tr>
  8791. * <tr valign="top">
  8792. * <td>FilterClass-&gt;stream</td>
  8793. * <td>
  8794. * The stream resource being filtered. Maybe available only during
  8795. * filter calls when the
  8796. * closing parameter is set to false.
  8797. * </td>
  8798. * </tr>
  8799. * </p>
  8800. * voidonClose
  8801. * <p>
  8802. * This method is called upon filter shutdown (typically, this is also
  8803. * during stream shutdown), and is executed after
  8804. * the flush method is called. If any resources
  8805. * were allocated or initialized during onCreate()
  8806. * this would be the time to destroy or dispose of them.
  8807. * </p>
  8808. * @return bool Returns true on success or false on failure.
  8809. * </p>
  8810. * <p>
  8811. * stream_filter_register will return false if the
  8812. * filtername is already defined.
  8813. */
  8814. function stream_filter_register ($filtername, $classname) {}
  8815. /**
  8816. * Return a bucket object from the brigade for operating on
  8817. * @link http://www.php.net/manual/en/function.stream-bucket-make-writeable.php
  8818. * @param brigade resource
  8819. * @return object
  8820. */
  8821. function stream_bucket_make_writeable ($brigade) {}
  8822. /**
  8823. * Prepend bucket to brigade
  8824. * @link http://www.php.net/manual/en/function.stream-bucket-prepend.php
  8825. * @param brigade resource
  8826. * @param bucket resource
  8827. * @return void
  8828. */
  8829. function stream_bucket_prepend ($brigade, $bucket) {}
  8830. /**
  8831. * Append bucket to brigade
  8832. * @link http://www.php.net/manual/en/function.stream-bucket-append.php
  8833. * @param brigade resource
  8834. * @param bucket resource
  8835. * @return void
  8836. */
  8837. function stream_bucket_append ($brigade, $bucket) {}
  8838. /**
  8839. * Create a new bucket for use on the current stream
  8840. * @link http://www.php.net/manual/en/function.stream-bucket-new.php
  8841. * @param stream resource
  8842. * @param buffer string
  8843. * @return object
  8844. */
  8845. function stream_bucket_new ($stream, $buffer) {}
  8846. /**
  8847. * Add URL rewriter values
  8848. * @link http://www.php.net/manual/en/function.output-add-rewrite-var.php
  8849. * @param name string <p>
  8850. * The variable name.
  8851. * </p>
  8852. * @param value string <p>
  8853. * The variable value.
  8854. * </p>
  8855. * @return bool Returns true on success or false on failure.
  8856. */
  8857. function output_add_rewrite_var ($name, $value) {}
  8858. /**
  8859. * Reset URL rewriter values
  8860. * @link http://www.php.net/manual/en/function.output-reset-rewrite-vars.php
  8861. * @return bool Returns true on success or false on failure.
  8862. */
  8863. function output_reset_rewrite_vars () {}
  8864. /**
  8865. * Returns directory path used for temporary files
  8866. * @link http://www.php.net/manual/en/function.sys-get-temp-dir.php
  8867. * @return string the path of the temporary directory.
  8868. */
  8869. function sys_get_temp_dir () {}
  8870. define ('CONNECTION_ABORTED', 1);
  8871. define ('CONNECTION_NORMAL', 0);
  8872. define ('CONNECTION_TIMEOUT', 2);
  8873. define ('INI_USER', 1);
  8874. define ('INI_PERDIR', 2);
  8875. define ('INI_SYSTEM', 4);
  8876. define ('INI_ALL', 7);
  8877. define ('PHP_URL_SCHEME', 0);
  8878. define ('PHP_URL_HOST', 1);
  8879. define ('PHP_URL_PORT', 2);
  8880. define ('PHP_URL_USER', 3);
  8881. define ('PHP_URL_PASS', 4);
  8882. define ('PHP_URL_PATH', 5);
  8883. define ('PHP_URL_QUERY', 6);
  8884. define ('PHP_URL_FRAGMENT', 7);
  8885. define ('M_E', 2.718281828459);
  8886. define ('M_LOG2E', 1.442695040889);
  8887. define ('M_LOG10E', 0.43429448190325);
  8888. define ('M_LN2', 0.69314718055995);
  8889. define ('M_LN10', 2.302585092994);
  8890. define ('M_PI', 3.1415926535898);
  8891. define ('M_PI_2', 1.5707963267949);
  8892. define ('M_PI_4', 0.78539816339745);
  8893. define ('M_1_PI', 0.31830988618379);
  8894. define ('M_2_PI', 0.63661977236758);
  8895. define ('M_SQRTPI', 1.7724538509055);
  8896. define ('M_2_SQRTPI', 1.1283791670955);
  8897. define ('M_LNPI', 1.1447298858494);
  8898. define ('M_EULER', 0.57721566490153);
  8899. define ('M_SQRT2', 1.4142135623731);
  8900. define ('M_SQRT1_2', 0.70710678118655);
  8901. define ('M_SQRT3', 1.7320508075689);
  8902. define ('INF', INF);
  8903. define ('NAN', NAN);
  8904. define ('INFO_GENERAL', 1);
  8905. define ('INFO_CREDITS', 2);
  8906. define ('INFO_CONFIGURATION', 4);
  8907. define ('INFO_MODULES', 8);
  8908. define ('INFO_ENVIRONMENT', 16);
  8909. define ('INFO_VARIABLES', 32);
  8910. define ('INFO_LICENSE', 64);
  8911. define ('INFO_ALL', -1);
  8912. define ('CREDITS_GROUP', 1);
  8913. define ('CREDITS_GENERAL', 2);
  8914. define ('CREDITS_SAPI', 4);
  8915. define ('CREDITS_MODULES', 8);
  8916. define ('CREDITS_DOCS', 16);
  8917. define ('CREDITS_FULLPAGE', 32);
  8918. define ('CREDITS_QA', 64);
  8919. define ('CREDITS_ALL', -1);
  8920. define ('HTML_SPECIALCHARS', 0);
  8921. define ('HTML_ENTITIES', 1);
  8922. define ('ENT_COMPAT', 2);
  8923. define ('ENT_QUOTES', 3);
  8924. define ('ENT_NOQUOTES', 0);
  8925. define ('STR_PAD_LEFT', 0);
  8926. define ('STR_PAD_RIGHT', 1);
  8927. define ('STR_PAD_BOTH', 2);
  8928. define ('PATHINFO_DIRNAME', 1);
  8929. define ('PATHINFO_BASENAME', 2);
  8930. define ('PATHINFO_EXTENSION', 4);
  8931. define ('PATHINFO_FILENAME', 8);
  8932. define ('CHAR_MAX', 127);
  8933. define ('LC_CTYPE', 2);
  8934. define ('LC_NUMERIC', 4);
  8935. define ('LC_TIME', 5);
  8936. define ('LC_COLLATE', 1);
  8937. define ('LC_MONETARY', 3);
  8938. define ('LC_ALL', 0);
  8939. define ('SEEK_SET', 0);
  8940. define ('SEEK_CUR', 1);
  8941. define ('SEEK_END', 2);
  8942. define ('LOCK_SH', 1);
  8943. define ('LOCK_EX', 2);
  8944. define ('LOCK_UN', 3);
  8945. define ('LOCK_NB', 4);
  8946. define ('STREAM_NOTIFY_CONNECT', 2);
  8947. define ('STREAM_NOTIFY_AUTH_REQUIRED', 3);
  8948. define ('STREAM_NOTIFY_AUTH_RESULT', 10);
  8949. define ('STREAM_NOTIFY_MIME_TYPE_IS', 4);
  8950. define ('STREAM_NOTIFY_FILE_SIZE_IS', 5);
  8951. define ('STREAM_NOTIFY_REDIRECTED', 6);
  8952. define ('STREAM_NOTIFY_PROGRESS', 7);
  8953. define ('STREAM_NOTIFY_FAILURE', 9);
  8954. define ('STREAM_NOTIFY_COMPLETED', 8);
  8955. define ('STREAM_NOTIFY_RESOLVE', 1);
  8956. define ('STREAM_NOTIFY_SEVERITY_INFO', 0);
  8957. define ('STREAM_NOTIFY_SEVERITY_WARN', 1);
  8958. define ('STREAM_NOTIFY_SEVERITY_ERR', 2);
  8959. define ('STREAM_FILTER_READ', 1);
  8960. define ('STREAM_FILTER_WRITE', 2);
  8961. define ('STREAM_FILTER_ALL', 3);
  8962. define ('STREAM_CLIENT_PERSISTENT', 1);
  8963. define ('STREAM_CLIENT_ASYNC_CONNECT', 2);
  8964. define ('STREAM_CLIENT_CONNECT', 4);
  8965. define ('STREAM_CRYPTO_METHOD_SSLv2_CLIENT', 0);
  8966. define ('STREAM_CRYPTO_METHOD_SSLv3_CLIENT', 1);
  8967. define ('STREAM_CRYPTO_METHOD_SSLv23_CLIENT', 2);
  8968. define ('STREAM_CRYPTO_METHOD_TLS_CLIENT', 3);
  8969. define ('STREAM_CRYPTO_METHOD_SSLv2_SERVER', 4);
  8970. define ('STREAM_CRYPTO_METHOD_SSLv3_SERVER', 5);
  8971. define ('STREAM_CRYPTO_METHOD_SSLv23_SERVER', 6);
  8972. define ('STREAM_CRYPTO_METHOD_TLS_SERVER', 7);
  8973. define ('STREAM_SHUT_RD', 0);
  8974. define ('STREAM_SHUT_WR', 1);
  8975. define ('STREAM_SHUT_RDWR', 2);
  8976. define ('STREAM_PF_INET', 2);
  8977. define ('STREAM_PF_INET6', 23);
  8978. define ('STREAM_PF_UNIX', 1);
  8979. define ('STREAM_IPPROTO_IP', 0);
  8980. define ('STREAM_IPPROTO_TCP', 6);
  8981. define ('STREAM_IPPROTO_UDP', 17);
  8982. define ('STREAM_IPPROTO_ICMP', 1);
  8983. define ('STREAM_IPPROTO_RAW', 255);
  8984. define ('STREAM_SOCK_STREAM', 1);
  8985. define ('STREAM_SOCK_DGRAM', 2);
  8986. define ('STREAM_SOCK_RAW', 3);
  8987. define ('STREAM_SOCK_SEQPACKET', 5);
  8988. define ('STREAM_SOCK_RDM', 4);
  8989. define ('STREAM_PEEK', 2);
  8990. define ('STREAM_OOB', 1);
  8991. define ('STREAM_SERVER_BIND', 4);
  8992. define ('STREAM_SERVER_LISTEN', 8);
  8993. define ('FILE_USE_INCLUDE_PATH', 1);
  8994. define ('FILE_IGNORE_NEW_LINES', 2);
  8995. define ('FILE_SKIP_EMPTY_LINES', 4);
  8996. define ('FILE_APPEND', 8);
  8997. define ('FILE_NO_DEFAULT_CONTEXT', 16);
  8998. define ('FILE_TEXT', 0);
  8999. define ('FILE_BINARY', 0);
  9000. define ('PSFS_PASS_ON', 2);
  9001. define ('PSFS_FEED_ME', 1);
  9002. define ('PSFS_ERR_FATAL', 0);
  9003. define ('PSFS_FLAG_NORMAL', 0);
  9004. define ('PSFS_FLAG_FLUSH_INC', 1);
  9005. define ('PSFS_FLAG_FLUSH_CLOSE', 2);
  9006. define ('CRYPT_SALT_LENGTH', 12);
  9007. define ('CRYPT_STD_DES', 1);
  9008. define ('CRYPT_EXT_DES', 0);
  9009. define ('CRYPT_MD5', 1);
  9010. define ('CRYPT_BLOWFISH', 0);
  9011. define ('DIRECTORY_SEPARATOR', "/");
  9012. define ('PATH_SEPARATOR', ";");
  9013. define ('GLOB_BRACE', 128);
  9014. define ('GLOB_MARK', 8);
  9015. define ('GLOB_NOSORT', 32);
  9016. define ('GLOB_NOCHECK', 16);
  9017. define ('GLOB_NOESCAPE', 4096);
  9018. define ('GLOB_ERR', 4);
  9019. define ('GLOB_ONLYDIR', 1073741824);
  9020. define ('GLOB_AVAILABLE_FLAGS', 1073746108);
  9021. define ('LOG_EMERG', 1);
  9022. define ('LOG_ALERT', 1);
  9023. define ('LOG_CRIT', 1);
  9024. define ('LOG_ERR', 4);
  9025. define ('LOG_WARNING', 5);
  9026. define ('LOG_NOTICE', 6);
  9027. define ('LOG_INFO', 6);
  9028. define ('LOG_DEBUG', 6);
  9029. define ('LOG_KERN', 0);
  9030. define ('LOG_USER', 8);
  9031. define ('LOG_MAIL', 16);
  9032. define ('LOG_DAEMON', 24);
  9033. define ('LOG_AUTH', 32);
  9034. define ('LOG_SYSLOG', 40);
  9035. define ('LOG_LPR', 48);
  9036. define ('LOG_NEWS', 56);
  9037. define ('LOG_UUCP', 64);
  9038. define ('LOG_CRON', 72);
  9039. define ('LOG_AUTHPRIV', 80);
  9040. define ('LOG_PID', 1);
  9041. define ('LOG_CONS', 2);
  9042. define ('LOG_ODELAY', 4);
  9043. define ('LOG_NDELAY', 8);
  9044. define ('LOG_NOWAIT', 16);
  9045. define ('LOG_PERROR', 32);
  9046. define ('EXTR_OVERWRITE', 0);
  9047. define ('EXTR_SKIP', 1);
  9048. define ('EXTR_PREFIX_SAME', 2);
  9049. define ('EXTR_PREFIX_ALL', 3);
  9050. define ('EXTR_PREFIX_INVALID', 4);
  9051. define ('EXTR_PREFIX_IF_EXISTS', 5);
  9052. define ('EXTR_IF_EXISTS', 6);
  9053. define ('EXTR_REFS', 256);
  9054. define ('SORT_ASC', 4);
  9055. define ('SORT_DESC', 3);
  9056. define ('SORT_REGULAR', 0);
  9057. define ('SORT_NUMERIC', 1);
  9058. define ('SORT_STRING', 2);
  9059. define ('SORT_LOCALE_STRING', 5);
  9060. define ('CASE_LOWER', 0);
  9061. define ('CASE_UPPER', 1);
  9062. define ('COUNT_NORMAL', 0);
  9063. define ('COUNT_RECURSIVE', 1);
  9064. define ('ASSERT_ACTIVE', 1);
  9065. define ('ASSERT_CALLBACK', 2);
  9066. define ('ASSERT_BAIL', 3);
  9067. define ('ASSERT_WARNING', 4);
  9068. define ('ASSERT_QUIET_EVAL', 5);
  9069. define ('STREAM_USE_PATH', 1);
  9070. define ('STREAM_IGNORE_URL', 2);
  9071. define ('STREAM_ENFORCE_SAFE_MODE', 4);
  9072. define ('STREAM_REPORT_ERRORS', 8);
  9073. define ('STREAM_MUST_SEEK', 16);
  9074. define ('STREAM_URL_STAT_LINK', 1);
  9075. define ('STREAM_URL_STAT_QUIET', 2);
  9076. define ('STREAM_MKDIR_RECURSIVE', 1);
  9077. define ('STREAM_IS_URL', 1);
  9078. define ('IMAGETYPE_GIF', 1);
  9079. define ('IMAGETYPE_JPEG', 2);
  9080. define ('IMAGETYPE_PNG', 3);
  9081. define ('IMAGETYPE_SWF', 4);
  9082. define ('IMAGETYPE_PSD', 5);
  9083. define ('IMAGETYPE_BMP', 6);
  9084. define ('IMAGETYPE_TIFF_II', 7);
  9085. define ('IMAGETYPE_TIFF_MM', 8);
  9086. define ('IMAGETYPE_JPC', 9);
  9087. define ('IMAGETYPE_JP2', 10);
  9088. define ('IMAGETYPE_JPX', 11);
  9089. define ('IMAGETYPE_JB2', 12);
  9090. define ('IMAGETYPE_SWC', 13);
  9091. define ('IMAGETYPE_IFF', 14);
  9092. define ('IMAGETYPE_WBMP', 15);
  9093. define ('IMAGETYPE_JPEG2000', 9);
  9094. define ('IMAGETYPE_XBM', 16);
  9095. // End of standard v.5.2.10
  9096. ?>