PageRenderTime 93ms CodeModel.GetById 28ms RepoModel.GetById 0ms app.codeStats 1ms

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

https://github.com/haegyung/aptana-php
PHP | 10072 lines | 787 code | 524 blank | 8761 comment | 0 complexity | 8bfd47fc298d11e5d2910feb4918bddc MD5 | raw file
  1. <?php
  2. // Start of standard v.5.3.0
  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. Warning: Internal error: Cannot find extension function readlink in global function table in D:\Development\runtime-Studio 7.1 generate\generate\generate1.php on line 386
  24. Warning: Internal error: Cannot find extension function symlink in global function table in D:\Development\runtime-Studio 7.1 generate\generate\generate1.php on line 386
  25. /**
  26. * Returns the value of a constant
  27. * @link http://www.php.net/manual/en/function.constant.php
  28. * @param name string <p>
  29. * The constant name.
  30. * </p>
  31. * @return mixed the value of the constant, or &null; if the constant is not
  32. * defined.
  33. */
  34. function constant ($name) {}
  35. /**
  36. * Convert binary data into hexadecimal representation
  37. * @link http://www.php.net/manual/en/function.bin2hex.php
  38. * @param str string <p>
  39. * A character.
  40. * </p>
  41. * @return string the hexadecimal representation of the given string.
  42. */
  43. function bin2hex ($str) {}
  44. /**
  45. * Delay execution
  46. * @link http://www.php.net/manual/en/function.sleep.php
  47. * @param seconds int <p>
  48. * Halt time in seconds.
  49. * </p>
  50. * @return int zero on success, or false on errors. If the call was interrupted
  51. * by a signal, sleep returns the number of seconds left
  52. * to sleep.
  53. */
  54. function sleep ($seconds) {}
  55. /**
  56. * Delay execution in microseconds
  57. * @link http://www.php.net/manual/en/function.usleep.php
  58. * @param micro_seconds int <p>
  59. * Halt time in micro seconds. A micro second is one millionth of a
  60. * second.
  61. * </p>
  62. * @return void
  63. */
  64. function usleep ($micro_seconds) {}
  65. /**
  66. * Delay for a number of seconds and nanoseconds
  67. * @link http://www.php.net/manual/en/function.time-nanosleep.php
  68. * @param seconds int <p>
  69. * Must be a positive integer.
  70. * </p>
  71. * @param nanoseconds int <p>
  72. * Must be a positive integer less than 1 billion.
  73. * </p>
  74. * @return mixed Returns true on success or false on failure.
  75. * </p>
  76. * <p>
  77. * If the delay was interrupted by a signal, an associative array will be
  78. * returned with the components:
  79. * seconds - number of seconds remaining in
  80. * the delay
  81. * nanoseconds - number of nanoseconds
  82. * remaining in the delay
  83. */
  84. function time_nanosleep ($seconds, $nanoseconds) {}
  85. /**
  86. * Make the script sleep until the specified time
  87. * @link http://www.php.net/manual/en/function.time-sleep-until.php
  88. * @param timestamp float <p>
  89. * The timestamp when the script should wake.
  90. * </p>
  91. * @return bool Returns true on success or false on failure.
  92. */
  93. function time_sleep_until ($timestamp) {}
  94. /**
  95. * Flush the output buffer
  96. * @link http://www.php.net/manual/en/function.flush.php
  97. * @return void
  98. */
  99. function flush () {}
  100. /**
  101. * Wraps a string to a given number of characters
  102. * @link http://www.php.net/manual/en/function.wordwrap.php
  103. * @param str string <p>
  104. * The input string.
  105. * </p>
  106. * @param width int[optional] <p>
  107. * The column width.
  108. * </p>
  109. * @param break string[optional] <p>
  110. * The line is broken using the optional
  111. * break parameter.
  112. * </p>
  113. * @param cut bool[optional] <p>
  114. * If the cut is set to true, the string is
  115. * always wrapped at or before the specified width. So if you have
  116. * a word that is larger than the given width, it is broken apart.
  117. * (See second example).
  118. * </p>
  119. * @return string the given string wrapped at the specified column.
  120. */
  121. function wordwrap ($str, $width = null, $break = null, $cut = null) {}
  122. /**
  123. * Convert special characters to HTML entities
  124. * @link http://www.php.net/manual/en/function.htmlspecialchars.php
  125. * @param string string <p>
  126. * The string being converted.
  127. * </p>
  128. * @param quote_style int[optional] <p>
  129. * The optional second argument, quote_style, tells
  130. * the function what to do with single and double quote characters.
  131. * The default mode, ENT_COMPAT, is the backwards compatible mode
  132. * which only translates the double-quote character and leaves the
  133. * single-quote untranslated. If ENT_QUOTES is set, both single and
  134. * double quotes are translated and if ENT_NOQUOTES is set neither
  135. * single nor double quotes are translated.
  136. * </p>
  137. * @param charset string[optional] <p>
  138. * Defines character set used in conversion.
  139. * The default character set is ISO-8859-1.
  140. * </p>
  141. * <p>
  142. * For the purposes of this function, the charsets
  143. * ISO-8859-1, ISO-8859-15,
  144. * UTF-8, cp866,
  145. * cp1251, cp1252, and
  146. * KOI8-R are effectively equivalent, as the
  147. * characters affected by htmlspecialchars
  148. * occupy the same positions in all of these charsets.
  149. * </p>
  150. * &reference.strings.charsets;
  151. * @param double_encode bool[optional] <p>
  152. * When double_encode is turned off PHP will not
  153. * encode existing html entities, the default is to convert everything.
  154. * </p>
  155. * @return string The converted string.
  156. */
  157. function htmlspecialchars ($string, $quote_style = null, $charset = null, $double_encode = null) {}
  158. /**
  159. * Convert all applicable characters to HTML entities
  160. * @link http://www.php.net/manual/en/function.htmlentities.php
  161. * @param string string <p>
  162. * The input string.
  163. * </p>
  164. * @param quote_style int[optional] <p>
  165. * Like htmlspecialchars, the optional second
  166. * quote_style parameter lets you define what will
  167. * be done with 'single' and "double" quotes. It takes on one of three
  168. * constants with the default being ENT_COMPAT:
  169. * <table>
  170. * Available quote_style constants
  171. * <tr valign="top">
  172. * <td>Constant Name</td>
  173. * <td>Description</td>
  174. * </tr>
  175. * <tr valign="top">
  176. * <td>ENT_COMPAT</td>
  177. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  178. * </tr>
  179. * <tr valign="top">
  180. * <td>ENT_QUOTES</td>
  181. * <td>Will convert both double and single quotes.</td>
  182. * </tr>
  183. * <tr valign="top">
  184. * <td>ENT_NOQUOTES</td>
  185. * <td>Will leave both double and single quotes unconverted.</td>
  186. * </tr>
  187. * </table>
  188. * </p>
  189. * @param charset string[optional] <p>
  190. * Like htmlspecialchars, it takes an optional
  191. * third argument charset which defines character
  192. * set used in conversion.
  193. * Presently, the ISO-8859-1 character set is used as the default.
  194. * </p>
  195. * &reference.strings.charsets;
  196. * @param double_encode bool[optional] <p>
  197. * When double_encode is turned off PHP will not
  198. * encode existing html entities. The default is to convert everything.
  199. * </p>
  200. * @return string the encoded string.
  201. */
  202. function htmlentities ($string, $quote_style = null, $charset = null, $double_encode = null) {}
  203. /**
  204. * Convert all HTML entities to their applicable characters
  205. * @link http://www.php.net/manual/en/function.html-entity-decode.php
  206. * @param string string <p>
  207. * The input string.
  208. * </p>
  209. * @param quote_style int[optional] <p>
  210. * The optional second quote_style parameter lets
  211. * you define what will be done with 'single' and "double" quotes. It takes
  212. * on one of three constants with the default being
  213. * ENT_COMPAT:
  214. * <table>
  215. * Available quote_style constants
  216. * <tr valign="top">
  217. * <td>Constant Name</td>
  218. * <td>Description</td>
  219. * </tr>
  220. * <tr valign="top">
  221. * <td>ENT_COMPAT</td>
  222. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  223. * </tr>
  224. * <tr valign="top">
  225. * <td>ENT_QUOTES</td>
  226. * <td>Will convert both double and single quotes.</td>
  227. * </tr>
  228. * <tr valign="top">
  229. * <td>ENT_NOQUOTES</td>
  230. * <td>Will leave both double and single quotes unconverted.</td>
  231. * </tr>
  232. * </table>
  233. * </p>
  234. * @param charset string[optional] <p>
  235. * The ISO-8859-1 character set is used as default for the optional third
  236. * charset. This defines the character set used in
  237. * conversion.
  238. * </p>
  239. * &reference.strings.charsets;
  240. * @return string the decoded string.
  241. */
  242. function html_entity_decode ($string, $quote_style = null, $charset = null) {}
  243. /**
  244. * Convert special HTML entities back to characters
  245. * @link http://www.php.net/manual/en/function.htmlspecialchars-decode.php
  246. * @param string string <p>
  247. * The string to decode
  248. * </p>
  249. * @param quote_style int[optional] <p>
  250. * The quote style. One of the following constants:
  251. * <table>
  252. * quote_style constants
  253. * <tr valign="top">
  254. * <td>Constant Name</td>
  255. * <td>Description</td>
  256. * </tr>
  257. * <tr valign="top">
  258. * <td>ENT_COMPAT</td>
  259. * <td>Will convert double-quotes and leave single-quotes alone
  260. * (default)</td>
  261. * </tr>
  262. * <tr valign="top">
  263. * <td>ENT_QUOTES</td>
  264. * <td>Will convert both double and single quotes</td>
  265. * </tr>
  266. * <tr valign="top">
  267. * <td>ENT_NOQUOTES</td>
  268. * <td>Will leave both double and single quotes unconverted</td>
  269. * </tr>
  270. * </table>
  271. * </p>
  272. * @return string the decoded string.
  273. */
  274. function htmlspecialchars_decode ($string, $quote_style = null) {}
  275. /**
  276. * Returns the translation table used by <function>htmlspecialchars</function> and <function>htmlentities</function>
  277. * @link http://www.php.net/manual/en/function.get-html-translation-table.php
  278. * @param table int[optional] <p>
  279. * There are two new constants (HTML_ENTITIES,
  280. * HTML_SPECIALCHARS) that allow you to specify the
  281. * table you want.
  282. * </p>
  283. * @param quote_style int[optional] <p>
  284. * Like the htmlspecialchars and
  285. * htmlentities functions you can optionally specify
  286. * the quote_style you are working with.
  287. * See the description
  288. * of these modes in htmlspecialchars.
  289. * </p>
  290. * @return array the translation table as an array.
  291. */
  292. function get_html_translation_table ($table = null, $quote_style = null) {}
  293. /**
  294. * Calculate the sha1 hash of a string
  295. * @link http://www.php.net/manual/en/function.sha1.php
  296. * @param str string <p>
  297. * The input string.
  298. * </p>
  299. * @param raw_output bool[optional] <p>
  300. * If the optional raw_output is set to true,
  301. * then the sha1 digest is instead returned in raw binary format with a
  302. * length of 20, otherwise the returned value is a 40-character
  303. * hexadecimal number.
  304. * </p>
  305. * @return string the sha1 hash as a string.
  306. */
  307. function sha1 ($str, $raw_output = null) {}
  308. /**
  309. * Calculate the sha1 hash of a file
  310. * @link http://www.php.net/manual/en/function.sha1-file.php
  311. * @param filename string <p>
  312. * The filename of the file to hash.
  313. * </p>
  314. * @param raw_output bool[optional] <p>
  315. * When true, returns the digest in raw binary format with a length of
  316. * 20.
  317. * </p>
  318. * @return string a string on success, false otherwise.
  319. */
  320. function sha1_file ($filename, $raw_output = null) {}
  321. /**
  322. * Calculate the md5 hash of a string
  323. * @link http://www.php.net/manual/en/function.md5.php
  324. * @param str string <p>
  325. * The string.
  326. * </p>
  327. * @param raw_output bool[optional] <p>
  328. * If the optional raw_output is set to true,
  329. * then the md5 digest is instead returned in raw binary format with a
  330. * length of 16.
  331. * </p>
  332. * @return string the hash as a 32-character hexadecimal number.
  333. */
  334. function md5 ($str, $raw_output = null) {}
  335. /**
  336. * Calculates the md5 hash of a given file
  337. * @link http://www.php.net/manual/en/function.md5-file.php
  338. * @param filename string <p>
  339. * The filename
  340. * </p>
  341. * @param raw_output bool[optional] <p>
  342. * When true, returns the digest in raw binary format with a length of
  343. * 16.
  344. * </p>
  345. * @return string a string on success, false otherwise.
  346. */
  347. function md5_file ($filename, $raw_output = null) {}
  348. /**
  349. * Calculates the crc32 polynomial of a string
  350. * @link http://www.php.net/manual/en/function.crc32.php
  351. * @param str string <p>
  352. * The data.
  353. * </p>
  354. * @return int the crc32 checksum of str as an integer.
  355. */
  356. function crc32 ($str) {}
  357. /**
  358. * Parse a binary IPTC block into single tags.
  359. * @link http://www.php.net/manual/en/function.iptcparse.php
  360. * @param iptcblock string <p>
  361. * A binary IPTC block.
  362. * </p>
  363. * @return array an array using the tagmarker as an index and the value as the
  364. * value. It returns false on error or if no IPTC data was found.
  365. */
  366. function iptcparse ($iptcblock) {}
  367. /**
  368. * Embeds binary IPTC data into a JPEG image
  369. * @link http://www.php.net/manual/en/function.iptcembed.php
  370. * @param iptcdata string <p>
  371. * The data to be written.
  372. * </p>
  373. * @param jpeg_file_name string <p>
  374. * Path to the JPEG image.
  375. * </p>
  376. * @param spool int[optional] <p>
  377. * Spool flag. If the spool flag is over 2 then the JPEG will be
  378. * returned as a string.
  379. * </p>
  380. * @return mixed If success and spool flag is lower than 2 then the JPEG will not be
  381. * returned as a string, false on errors.
  382. */
  383. function iptcembed ($iptcdata, $jpeg_file_name, $spool = null) {}
  384. /**
  385. * Get the size of an image
  386. * @link http://www.php.net/manual/en/function.getimagesize.php
  387. * @param filename string <p>
  388. * This parameter specifies the file you wish to retrieve information
  389. * about. It can reference a local file or (configuration permitting) a
  390. * remote file using one of the supported streams.
  391. * </p>
  392. * @param imageinfo array[optional] <p>
  393. * This optional parameter allows you to extract some extended
  394. * information from the image file. Currently, this will return the
  395. * different JPG APP markers as an associative array.
  396. * Some programs use these APP markers to embed text information in
  397. * images. A very common one is to embed
  398. * IPTC information in the APP13 marker.
  399. * You can use the iptcparse function to parse the
  400. * binary APP13 marker into something readable.
  401. * </p>
  402. * @return array an array with 7 elements.
  403. * </p>
  404. * <p>
  405. * Index 0 and 1 contains respectively the width and the height of the image.
  406. * </p>
  407. * <p>
  408. * Some formats may contain no image or may contain multiple images. In these
  409. * cases, getimagesize might not be able to properly
  410. * determine the image size. getimagesize will return
  411. * zero for width and height in these cases.
  412. * </p>
  413. * <p>
  414. * Index 2 is one of the IMAGETYPE_XXX constants indicating
  415. * the type of the image.
  416. * </p>
  417. * <p>
  418. * Index 3 is a text string with the correct
  419. * height="yyy" width="xxx" string that can be used
  420. * directly in an IMG tag.
  421. * </p>
  422. * <p>
  423. * mime is the correspondant MIME type of the image.
  424. * This information can be used to deliver images with correct the HTTP
  425. * Content-type header:
  426. * getimagesize and MIME types
  427. * ]]>
  428. * </p>
  429. * <p>
  430. * channels will be 3 for RGB pictures and 4 for CMYK
  431. * pictures.
  432. * </p>
  433. * <p>
  434. * bits is the number of bits for each color.
  435. * </p>
  436. * <p>
  437. * For some image types, the presence of channels and
  438. * bits values can be a bit
  439. * confusing. As an example, GIF always uses 3 channels
  440. * per pixel, but the number of bits per pixel cannot be calculated for an
  441. * animated GIF with a global color table.
  442. * </p>
  443. * <p>
  444. * On failure, false is returned.
  445. */
  446. function getimagesize ($filename, array &$imageinfo = null) {}
  447. /**
  448. * Get Mime-Type for image-type returned by getimagesize,
  449. exif_read_data, exif_thumbnail, exif_imagetype
  450. * @link http://www.php.net/manual/en/function.image-type-to-mime-type.php
  451. * @param imagetype int <p>
  452. * One of the IMAGETYPE_XXX constants.
  453. * </p>
  454. * @return string The returned values are as follows
  455. * <table>
  456. * Returned values Constants
  457. * <tr valign="top">
  458. * <td>imagetype</td>
  459. * <td>Returned value</td>
  460. * </tr>
  461. * <tr valign="top">
  462. * <td>IMAGETYPE_GIF</td>
  463. * <td>image/gif</td>
  464. * </tr>
  465. * <tr valign="top">
  466. * <td>IMAGETYPE_JPEG</td>
  467. * <td>image/jpeg</td>
  468. * </tr>
  469. * <tr valign="top">
  470. * <td>IMAGETYPE_PNG</td>
  471. * <td>image/png</td>
  472. * </tr>
  473. * <tr valign="top">
  474. * <td>IMAGETYPE_SWF</td>
  475. * <td>application/x-shockwave-flash</td>
  476. * </tr>
  477. * <tr valign="top">
  478. * <td>IMAGETYPE_PSD</td>
  479. * <td>image/psd</td>
  480. * </tr>
  481. * <tr valign="top">
  482. * <td>IMAGETYPE_BMP</td>
  483. * <td>image/bmp</td>
  484. * </tr>
  485. * <tr valign="top">
  486. * <td>IMAGETYPE_TIFF_II (intel byte order)</td>
  487. * <td>image/tiff</td>
  488. * </tr>
  489. * <tr valign="top">
  490. * <td>
  491. * IMAGETYPE_TIFF_MM (motorola byte order)
  492. * </td>
  493. * <td>image/tiff</td>
  494. * </tr>
  495. * <tr valign="top">
  496. * <td>IMAGETYPE_JPC</td>
  497. * <td>application/octet-stream</td>
  498. * </tr>
  499. * <tr valign="top">
  500. * <td>IMAGETYPE_JP2</td>
  501. * <td>image/jp2</td>
  502. * </tr>
  503. * <tr valign="top">
  504. * <td>IMAGETYPE_JPX</td>
  505. * <td>application/octet-stream</td>
  506. * </tr>
  507. * <tr valign="top">
  508. * <td>IMAGETYPE_JB2</td>
  509. * <td>application/octet-stream</td>
  510. * </tr>
  511. * <tr valign="top">
  512. * <td>IMAGETYPE_SWC</td>
  513. * <td>application/x-shockwave-flash</td>
  514. * </tr>
  515. * <tr valign="top">
  516. * <td>IMAGETYPE_IFF</td>
  517. * <td>image/iff</td>
  518. * </tr>
  519. * <tr valign="top">
  520. * <td>IMAGETYPE_WBMP</td>
  521. * <td>image/vnd.wap.wbmp</td>
  522. * </tr>
  523. * <tr valign="top">
  524. * <td>IMAGETYPE_XBM</td>
  525. * <td>image/xbm</td>
  526. * </tr>
  527. * <tr valign="top">
  528. * <td>IMAGETYPE_ICO</td>
  529. * <td>image/vnd.microsoft.icon</td>
  530. * </tr>
  531. * </table>
  532. */
  533. function image_type_to_mime_type ($imagetype) {}
  534. /**
  535. * Get file extension for image type
  536. * @link http://www.php.net/manual/en/function.image-type-to-extension.php
  537. * @param imagetype int <p>
  538. * One of the IMAGETYPE_XXX constant.
  539. * </p>
  540. * @param include_dot bool[optional] <p>
  541. * Whether to prepend a dot to the extension or not. Default to true.
  542. * </p>
  543. * @return string A string with the extension corresponding to the given image type.
  544. */
  545. function image_type_to_extension ($imagetype, $include_dot = null) {}
  546. /**
  547. * Outputs lots of PHP information
  548. * @link http://www.php.net/manual/en/function.phpinfo.php
  549. * @param what int[optional] <p>
  550. * The output may be customized by passing one or more of the
  551. * following constants bitwise values summed
  552. * together in the optional what parameter.
  553. * One can also combine the respective constants or bitwise values
  554. * together with the or operator.
  555. * </p>
  556. * <p>
  557. * <table>
  558. * phpinfo options
  559. * <tr valign="top">
  560. * <td>Name (constant)</td>
  561. * <td>Value</td>
  562. * <td>Description</td>
  563. * </tr>
  564. * <tr valign="top">
  565. * <td>INFO_GENERAL</td>
  566. * <td>1</td>
  567. * <td>
  568. * The configuration line, &php.ini; location, build date, Web
  569. * Server, System and more.
  570. * </td>
  571. * </tr>
  572. * <tr valign="top">
  573. * <td>INFO_CREDITS</td>
  574. * <td>2</td>
  575. * <td>
  576. * PHP Credits. See also phpcredits.
  577. * </td>
  578. * </tr>
  579. * <tr valign="top">
  580. * <td>INFO_CONFIGURATION</td>
  581. * <td>4</td>
  582. * <td>
  583. * Current Local and Master values for PHP directives. See
  584. * also ini_get.
  585. * </td>
  586. * </tr>
  587. * <tr valign="top">
  588. * <td>INFO_MODULES</td>
  589. * <td>8</td>
  590. * <td>
  591. * Loaded modules and their respective settings. See also
  592. * get_loaded_extensions.
  593. * </td>
  594. * </tr>
  595. * <tr valign="top">
  596. * <td>INFO_ENVIRONMENT</td>
  597. * <td>16</td>
  598. * <td>
  599. * Environment Variable information that's also available in
  600. * $_ENV.
  601. * </td>
  602. * </tr>
  603. * <tr valign="top">
  604. * <td>INFO_VARIABLES</td>
  605. * <td>32</td>
  606. * <td>
  607. * Shows all
  608. * predefined variables from EGPCS (Environment, GET,
  609. * POST, Cookie, Server).
  610. * </td>
  611. * </tr>
  612. * <tr valign="top">
  613. * <td>INFO_LICENSE</td>
  614. * <td>64</td>
  615. * <td>
  616. * PHP License information. See also the license FAQ.
  617. * </td>
  618. * </tr>
  619. * <tr valign="top">
  620. * <td>INFO_ALL</td>
  621. * <td>-1</td>
  622. * <td>
  623. * Shows all of the above.
  624. * </td>
  625. * </tr>
  626. * </table>
  627. * </p>
  628. * @return bool Returns true on success or false on failure.
  629. */
  630. function phpinfo ($what = null) {}
  631. /**
  632. * Gets the current PHP version
  633. * @link http://www.php.net/manual/en/function.phpversion.php
  634. * @param extension string[optional] <p>
  635. * An optional extension name.
  636. * </p>
  637. * @return string If the optional extension parameter is
  638. * specified, phpversion returns the version of that
  639. * extension, or false if there is no version information associated or
  640. * the extension isn't enabled.
  641. */
  642. function phpversion ($extension = null) {}
  643. /**
  644. * Prints out the credits for PHP
  645. * @link http://www.php.net/manual/en/function.phpcredits.php
  646. * @param flag int[optional] <p>
  647. * To generate a custom credits page, you may want to use the
  648. * flag parameter.
  649. * </p>
  650. * <p>
  651. * <table>
  652. * Pre-defined phpcredits flags
  653. * <tr valign="top">
  654. * <td>name</td>
  655. * <td>description</td>
  656. * </tr>
  657. * <tr valign="top">
  658. * <td>CREDITS_ALL</td>
  659. * <td>
  660. * All the credits, equivalent to using: CREDITS_DOCS +
  661. * CREDITS_GENERAL + CREDITS_GROUP +
  662. * CREDITS_MODULES + CREDITS_FULLPAGE.
  663. * It generates a complete stand-alone HTML page with the appropriate tags.
  664. * </td>
  665. * </tr>
  666. * <tr valign="top">
  667. * <td>CREDITS_DOCS</td>
  668. * <td>The credits for the documentation team</td>
  669. * </tr>
  670. * <tr valign="top">
  671. * <td>CREDITS_FULLPAGE</td>
  672. * <td>
  673. * Usually used in combination with the other flags. Indicates
  674. * that a complete stand-alone HTML page needs to be
  675. * printed including the information indicated by the other
  676. * flags.
  677. * </td>
  678. * </tr>
  679. * <tr valign="top">
  680. * <td>CREDITS_GENERAL</td>
  681. * <td>
  682. * General credits: Language design and concept, PHP 4.0
  683. * authors and SAPI module.
  684. * </td>
  685. * </tr>
  686. * <tr valign="top">
  687. * <td>CREDITS_GROUP</td>
  688. * <td>A list of the core developers</td>
  689. * </tr>
  690. * <tr valign="top">
  691. * <td>CREDITS_MODULES</td>
  692. * <td>
  693. * A list of the extension modules for PHP, and their authors
  694. * </td>
  695. * </tr>
  696. * <tr valign="top">
  697. * <td>CREDITS_SAPI</td>
  698. * <td>
  699. * A list of the server API modules for PHP, and their authors
  700. * </td>
  701. * </tr>
  702. * </table>
  703. * </p>
  704. * @return bool Returns true on success or false on failure.
  705. */
  706. function phpcredits ($flag = null) {}
  707. /**
  708. * Gets the logo guid
  709. * @link http://www.php.net/manual/en/function.php-logo-guid.php
  710. * @return string PHPE9568F34-D428-11d2-A769-00AA001ACF42.
  711. */
  712. function php_logo_guid () {}
  713. function php_real_logo_guid () {}
  714. function php_egg_logo_guid () {}
  715. /**
  716. * Gets the Zend guid
  717. * @link http://www.php.net/manual/en/function.zend-logo-guid.php
  718. * @return string PHPE9568F35-D428-11d2-A769-00AA001ACF42.
  719. */
  720. function zend_logo_guid () {}
  721. /**
  722. * Returns the type of interface between web server and PHP
  723. * @link http://www.php.net/manual/en/function.php-sapi-name.php
  724. * @return string the interface type, as a lowercase string.
  725. * </p>
  726. * <p>
  727. * Although not exhaustive, the possible return values include
  728. * aolserver, apache,
  729. * apache2filter, apache2handler,
  730. * caudium, cgi (until PHP 5.3),
  731. * cgi-fcgi, cli,
  732. * continuity, embed,
  733. * isapi, litespeed,
  734. * milter, nsapi,
  735. * phttpd, pi3web, roxen,
  736. * thttpd, tux, and webjames.
  737. */
  738. function php_sapi_name () {}
  739. /**
  740. * Returns information about the operating system PHP is running on
  741. * @link http://www.php.net/manual/en/function.php-uname.php
  742. * @param mode string[optional] <p>
  743. * mode is a single character that defines what
  744. * information is returned:
  745. * 'a': This is the default. Contains all modes in
  746. * the sequence "s n r v m".
  747. * @return string the description, as a string.
  748. */
  749. function php_uname ($mode = null) {}
  750. /**
  751. * Return a list of .ini files parsed from the additional ini dir
  752. * @link http://www.php.net/manual/en/function.php-ini-scanned-files.php
  753. * @return string a comma-separated string of .ini files on success. Each comma is
  754. * followed by a newline. If the directive --with-config-file-scan-dir wasn't set,
  755. * false is returned. If it was set and the directory was empty, an
  756. * empty string is returned. If a file is unrecognizable, the file will
  757. * still make it into the returned string but a PHP error will also result.
  758. * This PHP error will be seen both at compile time and while using
  759. * php_ini_scanned_files.
  760. */
  761. function php_ini_scanned_files () {}
  762. /**
  763. * Retrieve a path to the loaded php.ini file
  764. * @link http://www.php.net/manual/en/function.php-ini-loaded-file.php
  765. * @return string The loaded &php.ini; path, or false if one is not loaded.
  766. */
  767. function php_ini_loaded_file () {}
  768. /**
  769. * String comparisons using a "natural order" algorithm
  770. * @link http://www.php.net/manual/en/function.strnatcmp.php
  771. * @param str1 string <p>
  772. * The first string.
  773. * </p>
  774. * @param str2 string <p>
  775. * The second string.
  776. * </p>
  777. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  778. * str1 is less than str2; &gt;
  779. * 0 if str1 is greater than
  780. * str2, and 0 if they are equal.
  781. */
  782. function strnatcmp ($str1, $str2) {}
  783. /**
  784. * Case insensitive string comparisons using a "natural order" algorithm
  785. * @link http://www.php.net/manual/en/function.strnatcasecmp.php
  786. * @param str1 string <p>
  787. * The first string.
  788. * </p>
  789. * @param str2 string <p>
  790. * The second string.
  791. * </p>
  792. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  793. * str1 is less than str2 &gt;
  794. * 0 if str1 is greater than
  795. * str2, and 0 if they are equal.
  796. */
  797. function strnatcasecmp ($str1, $str2) {}
  798. /**
  799. * Count the number of substring occurrences
  800. * @link http://www.php.net/manual/en/function.substr-count.php
  801. * @param haystack string <p>
  802. * The string to search in
  803. * </p>
  804. * @param needle string <p>
  805. * The substring to search for
  806. * </p>
  807. * @param offset int[optional] <p>
  808. * The offset where to start counting
  809. * </p>
  810. * @param length int[optional] <p>
  811. * The maximum length after the specified offset to search for the
  812. * substring. It outputs a warning if the offset plus the length is
  813. * greater than the haystack length.
  814. * </p>
  815. * @return int This functions returns an integer.
  816. */
  817. function substr_count ($haystack, $needle, $offset = null, $length = null) {}
  818. /**
  819. * Finds the length of the first segment of a string consisting
  820. entirely of characters contained within a given mask.
  821. * @link http://www.php.net/manual/en/function.strspn.php
  822. * @param subject string <p>
  823. * The string to examine.
  824. * </p>
  825. * @param mask string <p>
  826. * The list of allowable characters to include in counted segments.
  827. * </p>
  828. * @param start int[optional] <p>
  829. * The position in subject to
  830. * start searching.
  831. * </p>
  832. * <p>
  833. * If start is given and is non-negative,
  834. * then strspn will begin
  835. * examining subject at
  836. * the start'th position. For instance, in
  837. * the string 'abcdef', the character at
  838. * position 0 is 'a', the
  839. * character at position 2 is
  840. * 'c', and so forth.
  841. * </p>
  842. * <p>
  843. * If start is given and is negative,
  844. * then strspn will begin
  845. * examining subject at
  846. * the start'th position from the end
  847. * of subject.
  848. * </p>
  849. * @param length int[optional] <p>
  850. * The length of the segment from subject
  851. * to examine.
  852. * </p>
  853. * <p>
  854. * If length is given and is non-negative,
  855. * then subject will be examined
  856. * for length characters after the starting
  857. * position.
  858. * </p>
  859. * <p>
  860. * If lengthis given and is negative,
  861. * then subject will be examined from the
  862. * starting position up to length
  863. * characters from the end of subject.
  864. * </p>
  865. * @return int the length of the initial segment of str1
  866. * which consists entirely of characters in str2.
  867. */
  868. function strspn ($subject, $mask, $start = null, $length = null) {}
  869. /**
  870. * Find length of initial segment not matching mask
  871. * @link http://www.php.net/manual/en/function.strcspn.php
  872. * @param str1 string <p>
  873. * The first string.
  874. * </p>
  875. * @param str2 string <p>
  876. * The second string.
  877. * </p>
  878. * @param start int[optional] <p>
  879. * The start position of the string to examine.
  880. * </p>
  881. * @param length int[optional] <p>
  882. * The length of the string to examine.
  883. * </p>
  884. * @return int the length of the segment as an integer.
  885. */
  886. function strcspn ($str1, $str2, $start = null, $length = null) {}
  887. /**
  888. * Tokenize string
  889. * @link http://www.php.net/manual/en/function.strtok.php
  890. * @param str string <p>
  891. * The string being split up into smaller strings (tokens).
  892. * </p>
  893. * @param token string <p>
  894. * The delimiter used when splitting up str.
  895. * </p>
  896. * @return string A string token.
  897. */
  898. function strtok ($str, $token) {}
  899. /**
  900. * Make a string uppercase
  901. * @link http://www.php.net/manual/en/function.strtoupper.php
  902. * @param string string <p>
  903. * The input string.
  904. * </p>
  905. * @return string the uppercased string.
  906. */
  907. function strtoupper ($string) {}
  908. /**
  909. * Make a string lowercase
  910. * @link http://www.php.net/manual/en/function.strtolower.php
  911. * @param str string <p>
  912. * The input string.
  913. * </p>
  914. * @return string the lowercased string.
  915. */
  916. function strtolower ($str) {}
  917. /**
  918. * Find position of first occurrence of a string
  919. * @link http://www.php.net/manual/en/function.strpos.php
  920. * @param haystack string <p>
  921. * The string to search in
  922. * </p>
  923. * @param needle mixed <p>
  924. * If needle is not a string, it is converted
  925. * to an integer and applied as the ordinal value of a character.
  926. * </p>
  927. * @param offset int[optional] <p>
  928. * The optional offset parameter allows you
  929. * to specify which character in haystack to
  930. * start searching. The position returned is still relative to the
  931. * beginning of haystack.
  932. * </p>
  933. * @return int the position as an integer. If needle is
  934. * not found, strpos will return boolean
  935. * false.
  936. */
  937. function strpos ($haystack, $needle, $offset = null) {}
  938. /**
  939. * Find position of first occurrence of a case-insensitive string
  940. * @link http://www.php.net/manual/en/function.stripos.php
  941. * @param haystack string <p>
  942. * The string to search in
  943. * </p>
  944. * @param needle string <p>
  945. * Note that the needle may be a string of one or
  946. * more characters.
  947. * </p>
  948. * <p>
  949. * If needle is not a string, it is converted to
  950. * an integer and applied as the ordinal value of a character.
  951. * </p>
  952. * @param offset int[optional] <p>
  953. * The optional offset parameter allows you
  954. * to specify which character in haystack to
  955. * start searching. The position returned is still relative to the
  956. * beginning of haystack.
  957. * </p>
  958. * @return int If needle is not found,
  959. * stripos will return boolean false.
  960. */
  961. function stripos ($haystack, $needle, $offset = null) {}
  962. /**
  963. * Find position of last occurrence of a char in a string
  964. * @link http://www.php.net/manual/en/function.strrpos.php
  965. * @param haystack string <p>
  966. * The string to search in.
  967. * </p>
  968. * @param needle string <p>
  969. * If needle is not a string, it is converted
  970. * to an integer and applied as the ordinal value of a character.
  971. * </p>
  972. * @param offset int[optional] <p>
  973. * May be specified to begin searching an arbitrary number of characters into
  974. * the string. Negative values will stop searching at an arbitrary point
  975. * prior to the end of the string.
  976. * </p>
  977. * @return int the position where the needle exists. Returns false if the needle
  978. * was not found.
  979. */
  980. function strrpos ($haystack, $needle, $offset = null) {}
  981. /**
  982. * Find position of last occurrence of a case-insensitive string in a string
  983. * @link http://www.php.net/manual/en/function.strripos.php
  984. * @param haystack string <p>
  985. * The string to search in
  986. * </p>
  987. * @param needle string <p>
  988. * Note that the needle may be a string of one or
  989. * more characters.
  990. * </p>
  991. * @param offset int[optional] <p>
  992. * The offset parameter may be specified to begin
  993. * searching an arbitrary number of characters into the string.
  994. * </p>
  995. * <p>
  996. * Negative offset values will start the search at
  997. * offset characters from the
  998. * start of the string.
  999. * </p>
  1000. * @return int the numerical position of the last occurrence of
  1001. * needle. Also note that string positions start at 0,
  1002. * and not 1.
  1003. * </p>
  1004. * <p>
  1005. * If needle is not found, false is returned.
  1006. */
  1007. function strripos ($haystack, $needle, $offset = null) {}
  1008. /**
  1009. * Reverse a string
  1010. * @link http://www.php.net/manual/en/function.strrev.php
  1011. * @param string string <p>
  1012. * The string to be reversed.
  1013. * </p>
  1014. * @return string the reversed string.
  1015. */
  1016. function strrev ($string) {}
  1017. /**
  1018. * Convert logical Hebrew text to visual text
  1019. * @link http://www.php.net/manual/en/function.hebrev.php
  1020. * @param hebrew_text string <p>
  1021. * A Hebrew input string.
  1022. * </p>
  1023. * @param max_chars_per_line int[optional] <p>
  1024. * This optional parameter indicates maximum number of characters per
  1025. * line that will be returned.
  1026. * </p>
  1027. * @return string the visual string.
  1028. */
  1029. function hebrev ($hebrew_text, $max_chars_per_line = null) {}
  1030. /**
  1031. * Convert logical Hebrew text to visual text with newline conversion
  1032. * @link http://www.php.net/manual/en/function.hebrevc.php
  1033. * @param hebrew_text string <p>
  1034. * A Hebrew input string.
  1035. * </p>
  1036. * @param max_chars_per_line int[optional] <p>
  1037. * This optional parameter indicates maximum number of characters per
  1038. * line that will be returned.
  1039. * </p>
  1040. * @return string the visual string.
  1041. */
  1042. function hebrevc ($hebrew_text, $max_chars_per_line = null) {}
  1043. /**
  1044. * Inserts HTML line breaks before all newlines in a string
  1045. * @link http://www.php.net/manual/en/function.nl2br.php
  1046. * @param string string <p>
  1047. * The input string.
  1048. * </p>
  1049. * @param is_xhtml bool[optional] <p>
  1050. * Whenever to use XHTML compatible line breaks or not.
  1051. * </p>
  1052. * @return string the altered string.
  1053. */
  1054. function nl2br ($string, $is_xhtml = null) {}
  1055. /**
  1056. * Returns filename component of path
  1057. * @link http://www.php.net/manual/en/function.basename.php
  1058. * @param path string <p>
  1059. * A path.
  1060. * </p>
  1061. * <p>
  1062. * On Windows, both slash (/) and backslash
  1063. * (\) are used as directory separator character. In
  1064. * other environments, it is the forward slash (/).
  1065. * </p>
  1066. * @param suffix string[optional] <p>
  1067. * If the filename ends in suffix this will also
  1068. * be cut off.
  1069. * </p>
  1070. * @return string the base name of the given path.
  1071. */
  1072. function basename ($path, $suffix = null) {}
  1073. /**
  1074. * Returns directory name component of path
  1075. * @link http://www.php.net/manual/en/function.dirname.php
  1076. * @param path string <p>
  1077. * A path.
  1078. * </p>
  1079. * <p>
  1080. * On Windows, both slash (/) and backslash
  1081. * (\) are used as directory separator character. In
  1082. * other environments, it is the forward slash (/).
  1083. * </p>
  1084. * @return string the name of the directory. If there are no slashes in
  1085. * path, a dot ('.') is returned,
  1086. * indicating the current directory. Otherwise, the returned string is
  1087. * path with any trailing
  1088. * /component removed.
  1089. */
  1090. function dirname ($path) {}
  1091. /**
  1092. * Returns information about a file path
  1093. * @link http://www.php.net/manual/en/function.pathinfo.php
  1094. * @param path string <p>
  1095. * The path being checked.
  1096. * </p>
  1097. * @param options int[optional] <p>
  1098. * You can specify which elements are returned with optional parameter
  1099. * options. It composes from
  1100. * PATHINFO_DIRNAME,
  1101. * PATHINFO_BASENAME,
  1102. * PATHINFO_EXTENSION and
  1103. * PATHINFO_FILENAME. It
  1104. * defaults to return all elements.
  1105. * </p>
  1106. * @return mixed The following associative array elements are returned:
  1107. * dirname, basename,
  1108. * extension (if any), and filename.
  1109. * </p>
  1110. * <p>
  1111. * If options is used, this function will return a
  1112. * string if not all elements are requested.
  1113. */
  1114. function pathinfo ($path, $options = null) {}
  1115. /**
  1116. * Un-quotes a quoted string
  1117. * @link http://www.php.net/manual/en/function.stripslashes.php
  1118. * @param str string <p>
  1119. * The input string.
  1120. * </p>
  1121. * @return string a string with backslashes stripped off.
  1122. * (\' becomes ' and so on.)
  1123. * Double backslashes (\\) are made into a single
  1124. * backslash (\).
  1125. */
  1126. function stripslashes ($str) {}
  1127. /**
  1128. * Un-quote string quoted with <function>addcslashes</function>
  1129. * @link http://www.php.net/manual/en/function.stripcslashes.php
  1130. * @param str string <p>
  1131. * The string to be unescaped.
  1132. * </p>
  1133. * @return string the unescaped string.
  1134. */
  1135. function stripcslashes ($str) {}
  1136. /**
  1137. * Find first occurrence of a string
  1138. * @link http://www.php.net/manual/en/function.strstr.php
  1139. * @param haystack string <p>
  1140. * The input string.
  1141. * </p>
  1142. * @param needle mixed <p>
  1143. * If needle is not a string, it is converted to
  1144. * an integer and applied as the ordinal value of a character.
  1145. * </p>
  1146. * @param before_needle bool[optional] <p>
  1147. * If true, strstr returns
  1148. * the part of the haystack before the first
  1149. * occurrence of the needle.
  1150. * </p>
  1151. * @return string the portion of string, or false if needle
  1152. * is not found.
  1153. */
  1154. function strstr ($haystack, $needle, $before_needle = null) {}
  1155. /**
  1156. * Case-insensitive <function>strstr</function>
  1157. * @link http://www.php.net/manual/en/function.stristr.php
  1158. * @param haystack string <p>
  1159. * The string to search in
  1160. * </p>
  1161. * @param needle mixed <p>
  1162. * If needle is not a string, it is converted to
  1163. * an integer and applied as the ordinal value of a character.
  1164. * </p>
  1165. * @param before_needle bool[optional] <p>
  1166. * If true, stristr
  1167. * returns the part of the haystack before the
  1168. * first occurrence of the needle.
  1169. * </p>
  1170. * @return string the matched substring. If needle is not
  1171. * found, returns false.
  1172. */
  1173. function stristr ($haystack, $needle, $before_needle = null) {}
  1174. /**
  1175. * Find the last occurrence of a character in a string
  1176. * @link http://www.php.net/manual/en/function.strrchr.php
  1177. * @param haystack string <p>
  1178. * The string to search in
  1179. * </p>
  1180. * @param needle mixed <p>
  1181. * If needle contains more than one character,
  1182. * only the first is used. This behavior is different from that of
  1183. * strstr.
  1184. * </p>
  1185. * <p>
  1186. * If needle is not a string, it is converted to
  1187. * an integer and applied as the ordinal value of a character.
  1188. * </p>
  1189. * @return string This function returns the portion of string, or false if
  1190. * needle is not found.
  1191. */
  1192. function strrchr ($haystack, $needle) {}
  1193. /**
  1194. * Randomly shuffles a string
  1195. * @link http://www.php.net/manual/en/function.str-shuffle.php
  1196. * @param str string <p>
  1197. * The input string.
  1198. * </p>
  1199. * @return string the shuffled string.
  1200. */
  1201. function str_shuffle ($str) {}
  1202. /**
  1203. * Return information about words used in a string
  1204. * @link http://www.php.net/manual/en/function.str-word-count.php
  1205. * @param string string <p>
  1206. * The string
  1207. * </p>
  1208. * @param format int[optional] <p>
  1209. * Specify the return value of this function. The current supported values
  1210. * are:
  1211. * 0 - returns the number of words found
  1212. * @param charlist string[optional] <p>
  1213. * A list of additional characters which will be considered as 'word'
  1214. * </p>
  1215. * @return mixed an array or an integer, depending on the
  1216. * format chosen.
  1217. */
  1218. function str_word_count ($string, $format = null, $charlist = null) {}
  1219. /**
  1220. * Convert a string to an array
  1221. * @link http://www.php.net/manual/en/function.str-split.php
  1222. * @param string string <p>
  1223. * The input string.
  1224. * </p>
  1225. * @param split_length int[optional] <p>
  1226. * Maximum length of the chunk.
  1227. * </p>
  1228. * @return array If the optional split_length parameter is
  1229. * specified, the returned array will be broken down into chunks with each
  1230. * being split_length in length, otherwise each chunk
  1231. * will be one character in length.
  1232. * </p>
  1233. * <p>
  1234. * false is returned if split_length is less than 1.
  1235. * If the split_length length exceeds the length of
  1236. * string, the entire string is returned as the first
  1237. * (and only) array element.
  1238. */
  1239. function str_split ($string, $split_length = null) {}
  1240. /**
  1241. * Search a string for any of a set of characters
  1242. * @link http://www.php.net/manual/en/function.strpbrk.php
  1243. * @param haystack string <p>
  1244. * The string where char_list is looked for.
  1245. * </p>
  1246. * @param char_list string <p>
  1247. * This parameter is case sensitive.
  1248. * </p>
  1249. * @return string a string starting from the character found, or false if it is
  1250. * not found.
  1251. */
  1252. function strpbrk ($haystack, $char_list) {}
  1253. /**
  1254. * Binary safe comparison of 2 strings from an offset, up to length characters
  1255. * @link http://www.php.net/manual/en/function.substr-compare.php
  1256. * @param main_str string <p>
  1257. * The main string being compared.
  1258. * </p>
  1259. * @param str string <p>
  1260. * The secondary string being compared.
  1261. * </p>
  1262. * @param offset int <p>
  1263. * The start position for the comparison. If negative, it starts counting
  1264. * from the end of the string.
  1265. * </p>
  1266. * @param length int[optional] <p>
  1267. * The length of the comparison. The default value is the largest of the
  1268. * length of the str compared to the length of
  1269. * main_str less the
  1270. * offset.
  1271. * </p>
  1272. * @param case_insensitivity bool[optional] <p>
  1273. * If case_insensitivity is true, comparison is
  1274. * case insensitive.
  1275. * </p>
  1276. * @return int &lt; 0 if main_str from position
  1277. * offset is less than str, &gt;
  1278. * 0 if it is greater than str, and 0 if they are equal.
  1279. * If offset is equal to or greater than the length of
  1280. * main_str or length is set and
  1281. * is less than 1, substr_compare prints a warning and returns
  1282. * false.
  1283. */
  1284. function substr_compare ($main_str, $str, $offset, $length = null, $case_insensitivity = null) {}
  1285. /**
  1286. * Locale based string comparison
  1287. * @link http://www.php.net/manual/en/function.strcoll.php
  1288. * @param str1 string <p>
  1289. * The first string.
  1290. * </p>
  1291. * @param str2 string <p>
  1292. * The second string.
  1293. * </p>
  1294. * @return int &lt; 0 if str1 is less than
  1295. * str2; &gt; 0 if
  1296. * str1 is greater than
  1297. * str2, and 0 if they are equal.
  1298. */
  1299. function strcoll ($str1, $str2) {}
  1300. /**
  1301. * Return part of a string
  1302. * @link http://www.php.net/manual/en/function.substr.php
  1303. * @param string string <p>
  1304. * The input string.
  1305. * </p>
  1306. * @param start int <p>
  1307. * If start is non-negative, the returned string
  1308. * will start at the start'th position in
  1309. * string, counting from zero. For instance,
  1310. * in the string 'abcdef', the character at
  1311. * position 0 is 'a', the
  1312. * character at position 2 is
  1313. * 'c', and so forth.
  1314. * </p>
  1315. * <p>
  1316. * If start is negative, the returned string
  1317. * will start at the start'th character
  1318. * from the end of string.
  1319. * </p>
  1320. * <p>
  1321. * If string is less than or equal to
  1322. * start characters long, false will be returned.
  1323. * </p>
  1324. * <p>
  1325. * Using a negative start
  1326. * ]]>
  1327. * </p>
  1328. * @param length int[optional] <p>
  1329. * If length is given and is positive, the string
  1330. * returned will contain at most length characters
  1331. * beginning from start (depending on the length of
  1332. * string).
  1333. * </p>
  1334. * <p>
  1335. * If length is given and is negative, then that many
  1336. * characters will be omitted from the end of string
  1337. * (after the start position has been calculated when a
  1338. * start is negative). If
  1339. * start denotes a position beyond this truncation,
  1340. * an empty string will be returned.
  1341. * </p>
  1342. * <p>
  1343. * If length is given and is 0,
  1344. * false or &null; an empty string will be returned.
  1345. * </p>
  1346. * Using a negative length
  1347. * ]]>
  1348. * @return string the extracted part of string&return.falseforfailure;.
  1349. */
  1350. function substr ($string, $start, $length = null) {}
  1351. /**
  1352. * Replace text within a portion of a string
  1353. * @link http://www.php.net/manual/en/function.substr-replace.php
  1354. * @param string mixed <p>
  1355. * The input string.
  1356. * </p>
  1357. * @param replacement string <p>
  1358. * The replacement string.
  1359. * </p>
  1360. * @param start int <p>
  1361. * If start is positive, the replacing will
  1362. * begin at the start'th offset into
  1363. * string.
  1364. * </p>
  1365. * <p>
  1366. * If start is negative, the replacing will
  1367. * begin at the start'th character from the
  1368. * end of string.
  1369. * </p>
  1370. * @param length int[optional] <p>
  1371. * If given and is positive, it represents the length of the portion of
  1372. * string which is to be replaced. If it is
  1373. * negative, it represents the number of characters from the end of
  1374. * string at which to stop replacing. If it
  1375. * is not given, then it will default to strlen(
  1376. * string ); i.e. end the replacing at the
  1377. * end of string. Of course, if
  1378. * length is zero then this function will have the
  1379. * effect of inserting replacement into
  1380. * string at the given
  1381. * start offset.
  1382. * </p>
  1383. * @return mixed The result string is returned. If string is an
  1384. * array then array is returned.
  1385. */
  1386. function substr_replace ($string, $replacement, $start, $length = null) {}
  1387. /**
  1388. * Quote meta characters
  1389. * @link http://www.php.net/manual/en/function.quotemeta.php
  1390. * @param str string <p>
  1391. * The input string.
  1392. * </p>
  1393. * @return string the string with meta characters quoted.
  1394. */
  1395. function quotemeta ($str) {}
  1396. /**
  1397. * Make a string's first character uppercase
  1398. * @link http://www.php.net/manual/en/function.ucfirst.php
  1399. * @param str string <p>
  1400. * The input string.
  1401. * </p>
  1402. * @return string the resulting string.
  1403. */
  1404. function ucfirst ($str) {}
  1405. /**
  1406. * Make a string's first character lowercase
  1407. * @link http://www.php.net/manual/en/function.lcfirst.php
  1408. * @param str string <p>
  1409. * The input string.
  1410. * </p>
  1411. * @return string the resulting string.
  1412. */
  1413. function lcfirst ($str) {}
  1414. /**
  1415. * Uppercase the first character of each word in a string
  1416. * @link http://www.php.net/manual/en/function.ucwords.php
  1417. * @param str string <p>
  1418. * The input string.
  1419. * </p>
  1420. * @return string the modified string.
  1421. */
  1422. function ucwords ($str) {}
  1423. /**
  1424. * Translate certain characters
  1425. * @link http://www.php.net/manual/en/function.strtr.php
  1426. * @param str string <p>
  1427. * The string being translated.
  1428. * </p>
  1429. * @param from string <p>
  1430. * The string being translated to to.
  1431. * </p>
  1432. * @param to string <p>
  1433. * The string replacing from.
  1434. * </p>
  1435. * @return string This function returns a copy of str,
  1436. * translating all occurrences of each character in
  1437. * from to the corresponding character in
  1438. * to.
  1439. */
  1440. function strtr ($str, $from, $to) {}
  1441. /**
  1442. * Quote string with slashes
  1443. * @link http://www.php.net/manual/en/function.addslashes.php
  1444. * @param str string <p>
  1445. * The string to be escaped.
  1446. * </p>
  1447. * @return string the escaped string.
  1448. */
  1449. function addslashes ($str) {}
  1450. /**
  1451. * Quote string with slashes in a C style
  1452. * @link http://www.php.net/manual/en/function.addcslashes.php
  1453. * @param str string <p>
  1454. * The string to be escaped.
  1455. * </p>
  1456. * @param charlist string <p>
  1457. * A list of characters to be escaped. If
  1458. * charlist contains characters
  1459. * \n, \r etc., they are
  1460. * converted in C-like style, while other non-alphanumeric characters
  1461. * with ASCII codes lower than 32 and higher than 126 converted to
  1462. * octal representation.
  1463. * </p>
  1464. * <p>
  1465. * When you define a sequence of characters in the charlist argument
  1466. * make sure that you know what characters come between the
  1467. * characters that you set as the start and end of the range.
  1468. * ]]>
  1469. * Also, if the first character in a range has a higher ASCII value
  1470. * than the second character in the range, no range will be
  1471. * constructed. Only the start, end and period characters will be
  1472. * escaped. Use the ord function to find the
  1473. * ASCII value for a character.
  1474. * ]]>
  1475. * </p>
  1476. * <p>
  1477. * Be careful if you choose to escape characters 0, a, b, f, n, r,
  1478. * t and v. They will be converted to \0, \a, \b, \f, \n, \r, \t
  1479. * and \v.
  1480. * In PHP \0 (NULL), \r (carriage return), \n (newline), \f (form feed),
  1481. * \v (vertical tab) and \t (tab) are predefined escape sequences,
  1482. * while in C all of these are predefined escape sequences.
  1483. * </p>
  1484. * @return string the escaped string.
  1485. */
  1486. function addcslashes ($str, $charlist) {}
  1487. /**
  1488. * Strip whitespace (or other characters) from the end of a string
  1489. * @link http://www.php.net/manual/en/function.rtrim.php
  1490. * @param str string <p>
  1491. * The input string.
  1492. * </p>
  1493. * @param charlist string[optional] <p>
  1494. * You can also specify the characters you want to strip, by means
  1495. * of the charlist parameter.
  1496. * Simply list all characters that you want to be stripped. With
  1497. * .. you can specify a range of characters.
  1498. * </p>
  1499. * @return string the modified string.
  1500. */
  1501. function rtrim ($str, $charlist = null) {}
  1502. /**
  1503. * Replace all occurrences of the search string with the replacement string
  1504. * @link http://www.php.net/manual/en/function.str-replace.php
  1505. * @param search mixed <p>
  1506. * The value being searched for, otherwise known as the needle.
  1507. * An array may be used to designate multiple needles.
  1508. * </p>
  1509. * @param replace mixed <p>
  1510. * The replacement value that replaces found search
  1511. * values. An array may be used to designate multiple replacements.
  1512. * </p>
  1513. * @param subject mixed <p>
  1514. * The string or array being searched and replaced on,
  1515. * otherwise known as the haystack.
  1516. * </p>
  1517. * <p>
  1518. * If subject is an array, then the search and
  1519. * replace is performed with every entry of
  1520. * subject, and the return value is an array as
  1521. * well.
  1522. * </p>
  1523. * @param count int[optional] If passed, this will hold the number of matched and replaced needles.
  1524. * @return mixed This function returns a string or an array with the replaced values.
  1525. */
  1526. function str_replace ($search, $replace, $subject, &$count = null) {}
  1527. /**
  1528. * Case-insensitive version of <function>str_replace</function>.
  1529. * @link http://www.php.net/manual/en/function.str-ireplace.php
  1530. * @param search mixed <p>
  1531. * Every replacement with search array is
  1532. * performed on the result of previous replacement.
  1533. * </p>
  1534. * @param replace mixed <p>
  1535. * </p>
  1536. * @param subject mixed <p>
  1537. * If subject is an array, then the search and
  1538. * replace is performed with every entry of
  1539. * subject, and the return value is an array as
  1540. * well.
  1541. * </p>
  1542. * @param count int[optional] <p>
  1543. * The number of matched and replaced needles will
  1544. * be returned in count which is passed by
  1545. * reference.
  1546. * </p>
  1547. * @return mixed a string or an array of replacements.
  1548. */
  1549. function str_ireplace ($search, $replace, $subject, &$count = null) {}
  1550. /**
  1551. * Repeat a string
  1552. * @link http://www.php.net/manual/en/function.str-repeat.php
  1553. * @param input string <p>
  1554. * The string to be repeated.
  1555. * </p>
  1556. * @param multiplier int <p>
  1557. * Number of time the input string should be
  1558. * repeated.
  1559. * </p>
  1560. * <p>
  1561. * multiplier has to be greater than or equal to 0.
  1562. * If the multiplier is set to 0, the function
  1563. * will return an empty string.
  1564. * </p>
  1565. * @return string the repeated string.
  1566. */
  1567. function str_repeat ($input, $multiplier) {}
  1568. /**
  1569. * Return information about characters used in a string
  1570. * @link http://www.php.net/manual/en/function.count-chars.php
  1571. * @param string string <p>
  1572. * The examined string.
  1573. * </p>
  1574. * @param mode int[optional] <p>
  1575. * See return values.
  1576. * </p>
  1577. * @return mixed Depending on mode
  1578. * count_chars returns one of the following:
  1579. * 0 - an array with the byte-value as key and the frequency of
  1580. * every byte as value.
  1581. * 1 - same as 0 but only byte-values with a frequency greater
  1582. * than zero are listed.
  1583. * 2 - same as 0 but only byte-values with a frequency equal to
  1584. * zero are listed.
  1585. * 3 - a string containing all unique characters is returned.
  1586. * 4 - a string containing all not used characters is returned.
  1587. */
  1588. function count_chars ($string, $mode = null) {}
  1589. /**
  1590. * Split a string into smaller chunks
  1591. * @link http://www.php.net/manual/en/function.chunk-split.php
  1592. * @param body string <p>
  1593. * The string to be chunked.
  1594. * </p>
  1595. * @param chunklen int[optional] <p>
  1596. * The chunk length.
  1597. * </p>
  1598. * @param end string[optional] <p>
  1599. * The line ending sequence.
  1600. * </p>
  1601. * @return string the chunked string.
  1602. */
  1603. function chunk_split ($body, $chunklen = null, $end = null) {}
  1604. /**
  1605. * Strip whitespace (or other characters) from the beginning and end of a string
  1606. * @link http://www.php.net/manual/en/function.trim.php
  1607. * @param str string <p>
  1608. * The string that will be trimmed.
  1609. * </p>
  1610. * @param charlist string[optional] <p>
  1611. * Optionally, the stripped characters can also be specified using
  1612. * the charlist parameter.
  1613. * Simply list all characters that you want to be stripped. With
  1614. * .. you can specify a range of characters.
  1615. * </p>
  1616. * @return string The trimmed string.
  1617. */
  1618. function trim ($str, $charlist = null) {}
  1619. /**
  1620. * Strip whitespace (or other characters) from the beginning of a string
  1621. * @link http://www.php.net/manual/en/function.ltrim.php
  1622. * @param str string <p>
  1623. * The input string.
  1624. * </p>
  1625. * @param charlist string[optional] <p>
  1626. * You can also specify the characters you want to strip, by means of the
  1627. * charlist parameter.
  1628. * Simply list all characters that you want to be stripped. With
  1629. * .. you can specify a range of characters.
  1630. * </p>
  1631. * @return string This function returns a string with whitespace stripped from the
  1632. * beginning of str.
  1633. * Without the second parameter,
  1634. * ltrim will strip these characters:
  1635. * " " (ASCII 32
  1636. * (0x20)), an ordinary space.
  1637. * "\t" (ASCII 9
  1638. * (0x09)), a tab.
  1639. * "\n" (ASCII 10
  1640. * (0x0A)), a new line (line feed).
  1641. * "\r" (ASCII 13
  1642. * (0x0D)), a carriage return.
  1643. * "\0" (ASCII 0
  1644. * (0x00)), the NUL-byte.
  1645. * "\x0B" (ASCII 11
  1646. * (0x0B)), a vertical tab.
  1647. */
  1648. function ltrim ($str, $charlist = null) {}
  1649. /**
  1650. * Strip HTML and PHP tags from a string
  1651. * @link http://www.php.net/manual/en/function.strip-tags.php
  1652. * @param str string <p>
  1653. * The input string.
  1654. * </p>
  1655. * @param allowable_tags string[optional] <p>
  1656. * You can use the optional second parameter to specify tags which should
  1657. * not be stripped.
  1658. * </p>
  1659. * <p>
  1660. * HTML comments and PHP tags are also stripped. This is hardcoded and
  1661. * can not be changed with allowable_tags.
  1662. * </p>
  1663. * @return string the stripped string.
  1664. */
  1665. function strip_tags ($str, $allowable_tags = null) {}
  1666. /**
  1667. * Calculate the similarity between two strings
  1668. * @link http://www.php.net/manual/en/function.similar-text.php
  1669. * @param first string <p>
  1670. * The first string.
  1671. * </p>
  1672. * @param second string <p>
  1673. * The second string.
  1674. * </p>
  1675. * @param percent float[optional] <p>
  1676. * By passing a reference as third argument,
  1677. * similar_text will calculate the similarity in
  1678. * percent for you.
  1679. * </p>
  1680. * @return int the number of matching chars in both strings.
  1681. */
  1682. function similar_text ($first, $second, &$percent = null) {}
  1683. /**
  1684. * Split a string by string
  1685. * @link http://www.php.net/manual/en/function.explode.php
  1686. * @param delimiter string <p>
  1687. * The boundary string.
  1688. * </p>
  1689. * @param string string <p>
  1690. * The input string.
  1691. * </p>
  1692. * @param limit int[optional] <p>
  1693. * If limit is set and positive, the returned array will contain
  1694. * a maximum of limit elements with the last
  1695. * element containing the rest of string.
  1696. * </p>
  1697. * <p>
  1698. * If the limit parameter is negative, all components
  1699. * except the last -limit are returned.
  1700. * </p>
  1701. * <p>
  1702. * If the limit parameter is zero, then this is treated as 1.
  1703. * </p>
  1704. * @return array If delimiter is an empty string (""),
  1705. * explode will return false.
  1706. * If delimiter contains a value that is not
  1707. * contained in string and a negative
  1708. * limit is used, then an empty array will be
  1709. * returned. For any other limit, an array containing
  1710. * string will be returned.
  1711. */
  1712. function explode ($delimiter, $string, $limit = null) {}
  1713. /**
  1714. * Join array elements with a string
  1715. * @link http://www.php.net/manual/en/function.implode.php
  1716. * @param glue string <p>
  1717. * Defaults to an empty string. This is not the preferred usage of
  1718. * implode as glue would be
  1719. * the second parameter and thus, the bad prototype would be used.
  1720. * </p>
  1721. * @param pieces array <p>
  1722. * The array of strings to implode.
  1723. * </p>
  1724. * @return string a string containing a string representation of all the array
  1725. * elements in the same order, with the glue string between each element.
  1726. */
  1727. function implode ($glue, array $pieces) {}
  1728. /**
  1729. * &Alias; <function>implode</function>
  1730. * @link http://www.php.net/manual/en/function.join.php
  1731. * @param glue
  1732. * @param pieces
  1733. */
  1734. function join ($glue, $pieces) {}
  1735. /**
  1736. * Set locale information
  1737. * @link http://www.php.net/manual/en/function.setlocale.php
  1738. * @param category int <p>
  1739. * category is a named constant specifying the
  1740. * category of the functions affected by the locale setting:
  1741. * LC_ALL for all of the below
  1742. * @param locale string <p>
  1743. * If locale is &null; or the empty string
  1744. * "", the locale names will be set from the
  1745. * values of environment variables with the same names as the above
  1746. * categories, or from "LANG".
  1747. * </p>
  1748. * <p>
  1749. * If locale is "0",
  1750. * the locale setting is not affected, only the current setting is returned.
  1751. * </p>
  1752. * <p>
  1753. * If locale is an array or followed by additional
  1754. * parameters then each array element or parameter is tried to be set as
  1755. * new locale until success. This is useful if a locale is known under
  1756. * different names on different systems or for providing a fallback
  1757. * for a possibly not available locale.
  1758. * </p>
  1759. * @param _ string[optional]
  1760. * @return string the new current locale, or false if the locale functionality is
  1761. * not implemented on your platform, the specified locale does not exist or
  1762. * the category name is invalid.
  1763. * </p>
  1764. * <p>
  1765. * An invalid category name also causes a warning message. Category/locale
  1766. * names can be found in RFC 1766
  1767. * and ISO 639.
  1768. * Different systems have different naming schemes for locales.
  1769. * </p>
  1770. * <p>
  1771. * The return value of setlocale depends
  1772. * on the system that PHP is running. It returns exactly
  1773. * what the system setlocale function returns.
  1774. */
  1775. function setlocale ($category, $locale, $_ = null) {}
  1776. /**
  1777. * Get numeric formatting information
  1778. * @link http://www.php.net/manual/en/function.localeconv.php
  1779. * @return array localeconv returns data based upon the current locale
  1780. * as set by setlocale. The associative array that is
  1781. * returned contains the following fields:
  1782. * <tr valign="top">
  1783. * <td>Array element</td>
  1784. * <td>Description</td>
  1785. * </tr>
  1786. * <tr valign="top">
  1787. * <td>decimal_point</td>
  1788. * <td>Decimal point character</td>
  1789. * </tr>
  1790. * <tr valign="top">
  1791. * <td>thousands_sep</td>
  1792. * <td>Thousands separator</td>
  1793. * </tr>
  1794. * <tr valign="top">
  1795. * <td>grouping</td>
  1796. * <td>Array containing numeric groupings</td>
  1797. * </tr>
  1798. * <tr valign="top">
  1799. * <td>int_curr_symbol</td>
  1800. * <td>International currency symbol (i.e. USD)</td>
  1801. * </tr>
  1802. * <tr valign="top">
  1803. * <td>currency_symbol</td>
  1804. * <td>Local currency symbol (i.e. $)</td>
  1805. * </tr>
  1806. * <tr valign="top">
  1807. * <td>mon_decimal_point</td>
  1808. * <td>Monetary decimal point character</td>
  1809. * </tr>
  1810. * <tr valign="top">
  1811. * <td>mon_thousands_sep</td>
  1812. * <td>Monetary thousands separator</td>
  1813. * </tr>
  1814. * <tr valign="top">
  1815. * <td>mon_grouping</td>
  1816. * <td>Array containing monetary groupings</td>
  1817. * </tr>
  1818. * <tr valign="top">
  1819. * <td>positive_sign</td>
  1820. * <td>Sign for positive values</td>
  1821. * </tr>
  1822. * <tr valign="top">
  1823. * <td>negative_sign</td>
  1824. * <td>Sign for negative values</td>
  1825. * </tr>
  1826. * <tr valign="top">
  1827. * <td>int_frac_digits</td>
  1828. * <td>International fractional digits</td>
  1829. * </tr>
  1830. * <tr valign="top">
  1831. * <td>frac_digits</td>
  1832. * <td>Local fractional digits</td>
  1833. * </tr>
  1834. * <tr valign="top">
  1835. * <td>p_cs_precedes</td>
  1836. * <td>
  1837. * true if currency_symbol precedes a positive value, false
  1838. * if it succeeds one
  1839. * </td>
  1840. * </tr>
  1841. * <tr valign="top">
  1842. * <td>p_sep_by_space</td>
  1843. * <td>
  1844. * true if a space separates currency_symbol from a positive
  1845. * value, false otherwise
  1846. * </td>
  1847. * </tr>
  1848. * <tr valign="top">
  1849. * <td>n_cs_precedes</td>
  1850. * <td>
  1851. * true if currency_symbol precedes a negative value, false
  1852. * if it succeeds one
  1853. * </td>
  1854. * </tr>
  1855. * <tr valign="top">
  1856. * <td>n_sep_by_space</td>
  1857. * <td>
  1858. * true if a space separates currency_symbol from a negative
  1859. * value, false otherwise
  1860. * </td>
  1861. * </tr>
  1862. * <td>p_sign_posn</td>
  1863. * <td>
  1864. * 0 - Parentheses surround the quantity and currency_symbol
  1865. * 1 - The sign string precedes the quantity and currency_symbol
  1866. * 2 - The sign string succeeds the quantity and currency_symbol
  1867. * 3 - The sign string immediately precedes the currency_symbol
  1868. * 4 - The sign string immediately succeeds the currency_symbol
  1869. * </td>
  1870. * </tr>
  1871. * <td>n_sign_posn</td>
  1872. * <td>
  1873. * 0 - Parentheses surround the quantity and currency_symbol
  1874. * 1 - The sign string precedes the quantity and currency_symbol
  1875. * 2 - The sign string succeeds the quantity and currency_symbol
  1876. * 3 - The sign string immediately precedes the currency_symbol
  1877. * 4 - The sign string immediately succeeds the currency_symbol
  1878. * </td>
  1879. * </tr>
  1880. * </p>
  1881. * <p>
  1882. * The p_sign_posn, and n_sign_posn contain a string
  1883. * of formatting options. Each number representing one of the above listed conditions.
  1884. * </p>
  1885. * <p>
  1886. * The grouping fields contain arrays that define the way numbers should be
  1887. * grouped. For example, the monetary grouping field for the nl_NL locale (in
  1888. * UTF-8 mode with the euro sign), would contain a 2 item array with the
  1889. * values 3 and 3. The higher the index in the array, the farther left the
  1890. * grouping is. If an array element is equal to CHAR_MAX,
  1891. * no further grouping is done. If an array element is equal to 0, the previous
  1892. * element should be used.
  1893. */
  1894. function localeconv () {}
  1895. /**
  1896. * Calculate the soundex key of a string
  1897. * @link http://www.php.net/manual/en/function.soundex.php
  1898. * @param str string <p>
  1899. * The input string.
  1900. * </p>
  1901. * @return string the soundex key as a string.
  1902. */
  1903. function soundex ($str) {}
  1904. /**
  1905. * Calculate Levenshtein distance between two strings
  1906. * @link http://www.php.net/manual/en/function.levenshtein.php
  1907. * @param str1 string <p>
  1908. * One of the strings being evaluated for Levenshtein distance.
  1909. * </p>
  1910. * @param str2 string <p>
  1911. * One of the strings being evaluated for Levenshtein distance.
  1912. * </p>
  1913. * @return int This function returns the Levenshtein-Distance between the
  1914. * two argument strings or -1, if one of the argument strings
  1915. * is longer than the limit of 255 characters.
  1916. */
  1917. function levenshtein ($str1, $str2) {}
  1918. /**
  1919. * Return a specific character
  1920. * @link http://www.php.net/manual/en/function.chr.php
  1921. * @param ascii int <p>
  1922. * The ascii code.
  1923. * </p>
  1924. * @return string the specified character.
  1925. */
  1926. function chr ($ascii) {}
  1927. /**
  1928. * Return ASCII value of character
  1929. * @link http://www.php.net/manual/en/function.ord.php
  1930. * @param string string <p>
  1931. * A character.
  1932. * </p>
  1933. * @return int the ASCII value as an integer.
  1934. */
  1935. function ord ($string) {}
  1936. /**
  1937. * Parses the string into variables
  1938. * @link http://www.php.net/manual/en/function.parse-str.php
  1939. * @param str string <p>
  1940. * The input string.
  1941. * </p>
  1942. * @param arr array[optional] <p>
  1943. * If the second parameter arr is present,
  1944. * variables are stored in this variable as array elements instead.
  1945. * </p>
  1946. * @return void
  1947. */
  1948. function parse_str ($str, array &$arr = null) {}
  1949. /**
  1950. * Parse a CSV string into an array
  1951. * @link http://www.php.net/manual/en/function.str-getcsv.php
  1952. * @param input string <p>
  1953. * The string to parse.
  1954. * </p>
  1955. * @param delimiter string[optional] <p>
  1956. * Set the field delimiter (one character only).
  1957. * </p>
  1958. * @param enclosure string[optional] <p>
  1959. * Set the field enclosure character (one character only).
  1960. * </p>
  1961. * @param escape string[optional] <p>
  1962. * Set the escape character (one character only). Defaults as a backslash
  1963. * (\)
  1964. * </p>
  1965. * @return array an indexed array containing the fields read.
  1966. */
  1967. function str_getcsv ($input, $delimiter = null, $enclosure = null, $escape = null) {}
  1968. /**
  1969. * Pad a string to a certain length with another string
  1970. * @link http://www.php.net/manual/en/function.str-pad.php
  1971. * @param input string <p>
  1972. * The input string.
  1973. * </p>
  1974. * @param pad_length int <p>
  1975. * If the value of pad_length is negative,
  1976. * less than, or equal to the length of the input string, no padding
  1977. * takes place.
  1978. * </p>
  1979. * @param pad_string string[optional] <p>
  1980. * The pad_string may be truncated if the
  1981. * required number of padding characters can't be evenly divided by the
  1982. * pad_string's length.
  1983. * </p>
  1984. * @param pad_type int[optional] <p>
  1985. * Optional argument pad_type can be
  1986. * STR_PAD_RIGHT, STR_PAD_LEFT,
  1987. * or STR_PAD_BOTH. If
  1988. * pad_type is not specified it is assumed to be
  1989. * STR_PAD_RIGHT.
  1990. * </p>
  1991. * @return string the padded string.
  1992. */
  1993. function str_pad ($input, $pad_length, $pad_string = null, $pad_type = null) {}
  1994. /**
  1995. * &Alias; <function>rtrim</function>
  1996. * @link http://www.php.net/manual/en/function.chop.php
  1997. * @param str
  1998. * @param character_mask[optional]
  1999. */
  2000. function chop ($str, $character_mask) {}
  2001. /**
  2002. * &Alias; <function>strstr</function>
  2003. * @link http://www.php.net/manual/en/function.strchr.php
  2004. * @param haystack
  2005. * @param needle
  2006. * @param part[optional]
  2007. */
  2008. function strchr ($haystack, $needle, $part) {}
  2009. /**
  2010. * Return a formatted string
  2011. * @link http://www.php.net/manual/en/function.sprintf.php
  2012. * @param format string <p>
  2013. * The format string is composed of zero or more directives:
  2014. * ordinary characters (excluding %) that are
  2015. * copied directly to the result, and conversion
  2016. * specifications, each of which results in fetching its
  2017. * own parameter. This applies to both sprintf
  2018. * and printf.
  2019. * </p>
  2020. * <p>
  2021. * Each conversion specification consists of a percent sign
  2022. * (%), followed by one or more of these
  2023. * elements, in order:
  2024. * An optional sign specifier that forces a sign
  2025. * (- or +) to be used on a number. By default, only the - sign is used
  2026. * on a number if it's negative. This specifier forces positive numbers
  2027. * to have the + sign attached as well, and was added in PHP 4.3.0.
  2028. * @param args mixed[optional] <p>
  2029. * </p>
  2030. * @param _ mixed[optional]
  2031. * @return string a string produced according to the formatting string
  2032. * format.
  2033. */
  2034. function sprintf ($format, $args = null, $_ = null) {}
  2035. /**
  2036. * Output a formatted string
  2037. * @link http://www.php.net/manual/en/function.printf.php
  2038. * @param format string <p>
  2039. * See sprintf for a description of
  2040. * format.
  2041. * </p>
  2042. * @param args mixed[optional] <p>
  2043. * </p>
  2044. * @param _ mixed[optional]
  2045. * @return int the length of the outputted string.
  2046. */
  2047. function printf ($format, $args = null, $_ = null) {}
  2048. /**
  2049. * Output a formatted string
  2050. * @link http://www.php.net/manual/en/function.vprintf.php
  2051. * @param format string <p>
  2052. * See sprintf for a description of
  2053. * format.
  2054. * </p>
  2055. * @param args array <p>
  2056. * </p>
  2057. * @return int the length of the outputted string.
  2058. */
  2059. function vprintf ($format, array $args) {}
  2060. /**
  2061. * Return a formatted string
  2062. * @link http://www.php.net/manual/en/function.vsprintf.php
  2063. * @param format string <p>
  2064. * See sprintf for a description of
  2065. * format.
  2066. * </p>
  2067. * @param args array <p>
  2068. * </p>
  2069. * @return string Return array values as a formatted string according to
  2070. * format (which is described in the documentation
  2071. * for sprintf).
  2072. */
  2073. function vsprintf ($format, array $args) {}
  2074. /**
  2075. * Write a formatted string to a stream
  2076. * @link http://www.php.net/manual/en/function.fprintf.php
  2077. * @param handle resource &fs.file.pointer;
  2078. * @param format string <p>
  2079. * See sprintf for a description of
  2080. * format.
  2081. * </p>
  2082. * @param args mixed[optional] <p>
  2083. * </p>
  2084. * @param _ mixed[optional]
  2085. * @return int the length of the string written.
  2086. */
  2087. function fprintf ($handle, $format, $args = null, $_ = null) {}
  2088. /**
  2089. * Write a formatted string to a stream
  2090. * @link http://www.php.net/manual/en/function.vfprintf.php
  2091. * @param handle resource <p>
  2092. * </p>
  2093. * @param format string <p>
  2094. * See sprintf for a description of
  2095. * format.
  2096. * </p>
  2097. * @param args array <p>
  2098. * </p>
  2099. * @return int the length of the outputted string.
  2100. */
  2101. function vfprintf ($handle, $format, array $args) {}
  2102. /**
  2103. * Parses input from a string according to a format
  2104. * @link http://www.php.net/manual/en/function.sscanf.php
  2105. * @param str string <p>
  2106. * The input string being parsed.
  2107. * </p>
  2108. * @param format string <p>
  2109. * The interpreted format for str, which is
  2110. * described in the documentation for sprintf with
  2111. * following differences:
  2112. * Function is not locale-aware.
  2113. * F, g, G and
  2114. * b are not supported.
  2115. * D stands for decimal number.
  2116. * i stands for integer with base detection.
  2117. * n stands for number of characters processed so far.
  2118. * </p>
  2119. * @param _ mixed[optional]
  2120. * @return mixed If only
  2121. * two parameters were passed to this function, the values parsed
  2122. * will be returned as an array. Otherwise, if optional parameters are passed,
  2123. * the function will return the number of assigned values. The optional
  2124. * parameters must be passed by reference.
  2125. */
  2126. function sscanf ($str, $format, &$_ = null) {}
  2127. /**
  2128. * Parses input from a file according to a format
  2129. * @link http://www.php.net/manual/en/function.fscanf.php
  2130. * @param handle resource &fs.file.pointer;
  2131. * @param format string <p>
  2132. * The specified format as described in the
  2133. * sprintf documentation.
  2134. * </p>
  2135. * @param _ mixed[optional]
  2136. * @return mixed If only two parameters were passed to this function, the values parsed will be
  2137. * returned as an array. Otherwise, if optional parameters are passed, the
  2138. * function will return the number of assigned values. The optional
  2139. * parameters must be passed by reference.
  2140. */
  2141. function fscanf ($handle, $format, &$_ = null) {}
  2142. /**
  2143. * Parse a URL and return its components
  2144. * @link http://www.php.net/manual/en/function.parse-url.php
  2145. * @param url string <p>
  2146. * The URL to parse. Invalid characters are replaced by
  2147. * _.
  2148. * </p>
  2149. * @param component int[optional] <p>
  2150. * Specify one of PHP_URL_SCHEME,
  2151. * PHP_URL_HOST, PHP_URL_PORT,
  2152. * PHP_URL_USER, PHP_URL_PASS,
  2153. * PHP_URL_PATH, PHP_URL_QUERY
  2154. * or PHP_URL_FRAGMENT to retrieve just a specific
  2155. * URL component as a string.
  2156. * </p>
  2157. * @return mixed On seriously malformed URLs, parse_url may return
  2158. * false and emit a E_WARNING. Otherwise an associative
  2159. * array is returned, whose components may be (at least one):
  2160. * scheme - e.g. http
  2161. * host
  2162. * port
  2163. * user
  2164. * pass
  2165. * path
  2166. * query - after the question mark ?
  2167. * fragment - after the hashmark #
  2168. * </p>
  2169. * <p>
  2170. * If the component parameter is specified a
  2171. * string is returned instead of an array.
  2172. */
  2173. function parse_url ($url, $component = null) {}
  2174. /**
  2175. * URL-encodes string
  2176. * @link http://www.php.net/manual/en/function.urlencode.php
  2177. * @param str string <p>
  2178. * The string to be encoded.
  2179. * </p>
  2180. * @return string a string in which all non-alphanumeric characters except
  2181. * -_. have been replaced with a percent
  2182. * (%) sign followed by two hex digits and spaces encoded
  2183. * as plus (+) signs. It is encoded the same way that the
  2184. * posted data from a WWW form is encoded, that is the same way as in
  2185. * application/x-www-form-urlencoded media type. This
  2186. * differs from the RFC 1738 encoding (see
  2187. * rawurlencode) in that for historical reasons, spaces
  2188. * are encoded as plus (+) signs.
  2189. */
  2190. function urlencode ($str) {}
  2191. /**
  2192. * Decodes URL-encoded string
  2193. * @link http://www.php.net/manual/en/function.urldecode.php
  2194. * @param str string <p>
  2195. * The string to be decoded.
  2196. * </p>
  2197. * @return string the decoded string.
  2198. */
  2199. function urldecode ($str) {}
  2200. /**
  2201. * URL-encode according to RFC 1738
  2202. * @link http://www.php.net/manual/en/function.rawurlencode.php
  2203. * @param str string <p>
  2204. * The URL to be encoded.
  2205. * </p>
  2206. * @return string a string in which all non-alphanumeric characters except
  2207. * -_. have been replaced with a percent
  2208. * (%) sign followed by two hex digits. This is the
  2209. * encoding described in RFC 1738 for
  2210. * protecting literal characters from being interpreted as special URL
  2211. * delimiters, and for protecting URLs from being mangled by transmission
  2212. * media with character conversions (like some email systems).
  2213. */
  2214. function rawurlencode ($str) {}
  2215. /**
  2216. * Decode URL-encoded strings
  2217. * @link http://www.php.net/manual/en/function.rawurldecode.php
  2218. * @param str string <p>
  2219. * The URL to be decoded.
  2220. * </p>
  2221. * @return string the decoded URL, as a string.
  2222. */
  2223. function rawurldecode ($str) {}
  2224. /**
  2225. * Generate URL-encoded query string
  2226. * @link http://www.php.net/manual/en/function.http-build-query.php
  2227. * @param formdata array <p>
  2228. * May be an array or object containing properties.
  2229. * </p>
  2230. * <p>
  2231. * The array form may be a simple one-dimensional structure, or an array
  2232. * of arrays (who in turn may contain other arrays).
  2233. * </p>
  2234. * @param numeric_prefix string[optional] <p>
  2235. * If numeric indices are used in the base array and this parameter is
  2236. * provided, it will be prepended to the numeric index for elements in
  2237. * the base array only.
  2238. * </p>
  2239. * <p>
  2240. * This is meant to allow for legal variable names when the data is
  2241. * decoded by PHP or another CGI application later on.
  2242. * </p>
  2243. * @param arg_separator string[optional] <p>
  2244. * arg_separator.output
  2245. * is used to separate arguments, unless this parameter is specified,
  2246. * and is then used.
  2247. * </p>
  2248. * @return string a URL-encoded string.
  2249. */
  2250. function http_build_query (array $formdata, $numeric_prefix = null, $arg_separator = null) {}
  2251. /**
  2252. * Gets information about a link
  2253. * @link http://www.php.net/manual/en/function.linkinfo.php
  2254. * @param path string <p>
  2255. * Path to the link.
  2256. * </p>
  2257. * @return int linkinfo returns the st_dev field
  2258. * of the Unix C stat structure returned by the lstat
  2259. * system call. Returns 0 or false in case of error.
  2260. */
  2261. function linkinfo ($path) {}
  2262. /**
  2263. * Create a hard link
  2264. * @link http://www.php.net/manual/en/function.link.php
  2265. * @param from_path string <p>
  2266. * The link name.
  2267. * </p>
  2268. * @param to_path string <p>
  2269. * Target of the link.
  2270. * </p>
  2271. * @return bool Returns true on success or false on failure.
  2272. */
  2273. function link ($from_path, $to_path) {}
  2274. /**
  2275. * Deletes a file
  2276. * @link http://www.php.net/manual/en/function.unlink.php
  2277. * @param filename string <p>
  2278. * Path to the file.
  2279. * </p>
  2280. * @param context resource[optional] &note.context-support;
  2281. * @return bool Returns true on success or false on failure.
  2282. */
  2283. function unlink ($filename, $context = null) {}
  2284. /**
  2285. * Execute an external program
  2286. * @link http://www.php.net/manual/en/function.exec.php
  2287. * @param command string <p>
  2288. * The command that will be executed.
  2289. * </p>
  2290. * @param output array[optional] <p>
  2291. * If the output argument is present, then the
  2292. * specified array will be filled with every line of output from the
  2293. * command. Trailing whitespace, such as \n, is not
  2294. * included in this array. Note that if the array already contains some
  2295. * elements, exec will append to the end of the array.
  2296. * If you do not want the function to append elements, call
  2297. * unset on the array before passing it to
  2298. * exec.
  2299. * </p>
  2300. * @param return_var int[optional] <p>
  2301. * If the return_var argument is present
  2302. * along with the output argument, then the
  2303. * return status of the executed command will be written to this
  2304. * variable.
  2305. * </p>
  2306. * @return string The last line from the result of the command. If you need to execute a
  2307. * command and have all the data from the command passed directly back without
  2308. * any interference, use the passthru function.
  2309. * </p>
  2310. * <p>
  2311. * To get the output of the executed command, be sure to set and use the
  2312. * output parameter.
  2313. */
  2314. function exec ($command, array &$output = null, &$return_var = null) {}
  2315. /**
  2316. * Execute an external program and display the output
  2317. * @link http://www.php.net/manual/en/function.system.php
  2318. * @param command string <p>
  2319. * The command that will be executed.
  2320. * </p>
  2321. * @param return_var int[optional] <p>
  2322. * If the return_var argument is present, then the
  2323. * return status of the executed command will be written to this
  2324. * variable.
  2325. * </p>
  2326. * @return string the last line of the command output on success, and false
  2327. * on failure.
  2328. */
  2329. function system ($command, &$return_var = null) {}
  2330. /**
  2331. * Escape shell metacharacters
  2332. * @link http://www.php.net/manual/en/function.escapeshellcmd.php
  2333. * @param command string <p>
  2334. * The command that will be escaped.
  2335. * </p>
  2336. * @return string The escaped string.
  2337. */
  2338. function escapeshellcmd ($command) {}
  2339. /**
  2340. * Escape a string to be used as a shell argument
  2341. * @link http://www.php.net/manual/en/function.escapeshellarg.php
  2342. * @param arg string <p>
  2343. * The argument that will be escaped.
  2344. * </p>
  2345. * @return string The escaped string.
  2346. */
  2347. function escapeshellarg ($arg) {}
  2348. /**
  2349. * Execute an external program and display raw output
  2350. * @link http://www.php.net/manual/en/function.passthru.php
  2351. * @param command string <p>
  2352. * The command that will be executed.
  2353. * </p>
  2354. * @param return_var int[optional] <p>
  2355. * If the return_var argument is present, the
  2356. * return status of the Unix command will be placed here.
  2357. * </p>
  2358. * @return void
  2359. */
  2360. function passthru ($command, &$return_var = null) {}
  2361. /**
  2362. * Execute command via shell and return the complete output as a string
  2363. * @link http://www.php.net/manual/en/function.shell-exec.php
  2364. * @param cmd string <p>
  2365. * The command that will be executed.
  2366. * </p>
  2367. * @return string The output from the executed command.
  2368. */
  2369. function shell_exec ($cmd) {}
  2370. /**
  2371. * Execute a command and open file pointers for input/output
  2372. * @link http://www.php.net/manual/en/function.proc-open.php
  2373. * @param cmd string <p>
  2374. * The command to execute
  2375. * </p>
  2376. * @param descriptorspec array <p>
  2377. * An indexed array where the key represents the descriptor number and the
  2378. * value represents how PHP will pass that descriptor to the child
  2379. * process. 0 is stdin, 1 is stdout, while 2 is stderr.
  2380. * </p>
  2381. * <p>
  2382. * Each element can be:
  2383. * An array describing the pipe to pass to the process. The first
  2384. * element is the descriptor type and the second element is an option for
  2385. * the given type. Valid types are pipe (the second
  2386. * element is either r to pass the read end of the pipe
  2387. * to the process, or w to pass the write end) and
  2388. * file (the second element is a filename).
  2389. * A stream resource representing a real file descriptor (e.g. opened file,
  2390. * a socket, STDIN).
  2391. * </p>
  2392. * <p>
  2393. * The file descriptor numbers are not limited to 0, 1 and 2 - you may
  2394. * specify any valid file descriptor number and it will be passed to the
  2395. * child process. This allows your script to interoperate with other
  2396. * scripts that run as "co-processes". In particular, this is useful for
  2397. * passing passphrases to programs like PGP, GPG and openssl in a more
  2398. * secure manner. It is also useful for reading status information
  2399. * provided by those programs on auxiliary file descriptors.
  2400. * </p>
  2401. * @param pipes array <p>
  2402. * Will be set to an indexed array of file pointers that correspond to
  2403. * PHP's end of any pipes that are created.
  2404. * </p>
  2405. * @param cwd string[optional] <p>
  2406. * The initial working dir for the command. This must be an
  2407. * absolute directory path, or &null;
  2408. * if you want to use the default value (the working dir of the current
  2409. * PHP process)
  2410. * </p>
  2411. * @param env array[optional] <p>
  2412. * An array with the environment variables for the command that will be
  2413. * run, or &null; to use the same environment as the current PHP process
  2414. * </p>
  2415. * @param other_options array[optional] <p>
  2416. * Allows you to specify additional options. Currently supported options
  2417. * include:
  2418. * suppress_errors (windows only): suppresses errors
  2419. * generated by this function when it's set to true
  2420. * bypass_shell (windows only): bypass
  2421. * cmd.exe shell when set to true
  2422. * context: stream context used when opening files
  2423. * (created with stream_context_create)
  2424. * binary_pipes: open pipes in binary mode, instead
  2425. * of using the usual stream_encoding
  2426. * </p>
  2427. * @return resource a resource representing the process, which should be freed using
  2428. * proc_close when you are finished with it. On failure
  2429. * returns false.
  2430. */
  2431. function proc_open ($cmd, array $descriptorspec, array &$pipes, $cwd = null, array $env = null, array $other_options = null) {}
  2432. /**
  2433. * Close a process opened by <function>proc_open</function> and return the exit code of that process
  2434. * @link http://www.php.net/manual/en/function.proc-close.php
  2435. * @param process resource <p>
  2436. * The proc_open resource that will
  2437. * be closed.
  2438. * </p>
  2439. * @return int the termination status of the process that was run.
  2440. */
  2441. function proc_close ($process) {}
  2442. /**
  2443. * Kills a process opened by proc_open
  2444. * @link http://www.php.net/manual/en/function.proc-terminate.php
  2445. * @param process resource <p>
  2446. * The proc_open resource that will
  2447. * be closed.
  2448. * </p>
  2449. * @param signal int[optional] <p>
  2450. * This optional parameter is only useful on POSIX
  2451. * operating systems; you may specify a signal to send to the process
  2452. * using the kill(2) system call. The default is
  2453. * SIGTERM.
  2454. * </p>
  2455. * @return bool the termination status of the process that was run.
  2456. */
  2457. function proc_terminate ($process, $signal = null) {}
  2458. /**
  2459. * Get information about a process opened by <function>proc_open</function>
  2460. * @link http://www.php.net/manual/en/function.proc-get-status.php
  2461. * @param process resource <p>
  2462. * The proc_open resource that will
  2463. * be evaluated.
  2464. * </p>
  2465. * @return array An array of collected information on success, and false
  2466. * on failure. The returned array contains the following elements:
  2467. * </p>
  2468. * <p>
  2469. * <tr valign="top"><td>element</td><td>type</td><td>description</td></tr>
  2470. * <tr valign="top">
  2471. * <td>command</td>
  2472. * <td>string</td>
  2473. * <td>
  2474. * The command string that was passed to proc_open.
  2475. * </td>
  2476. * </tr>
  2477. * <tr valign="top">
  2478. * <td>pid</td>
  2479. * <td>int</td>
  2480. * <td>process id</td>
  2481. * </tr>
  2482. * <tr valign="top">
  2483. * <td>running</td>
  2484. * <td>bool</td>
  2485. * <td>
  2486. * true if the process is still running, false if it has
  2487. * terminated.
  2488. * </td>
  2489. * </tr>
  2490. * <tr valign="top">
  2491. * <td>signaled</td>
  2492. * <td>bool</td>
  2493. * <td>
  2494. * true if the child process has been terminated by
  2495. * an uncaught signal. Always set to false on Windows.
  2496. * </td>
  2497. * </tr>
  2498. * <tr valign="top">
  2499. * <td>stopped</td>
  2500. * <td>bool</td>
  2501. * <td>
  2502. * true if the child process has been stopped by a
  2503. * signal. Always set to false on Windows.
  2504. * </td>
  2505. * </tr>
  2506. * <tr valign="top">
  2507. * <td>exitcode</td>
  2508. * <td>int</td>
  2509. * <td>
  2510. * The exit code returned by the process (which is only
  2511. * meaningful if running is false).
  2512. * Only first call of this function return real value, next calls return
  2513. * -1.
  2514. * </td>
  2515. * </tr>
  2516. * <tr valign="top">
  2517. * <td>termsig</td>
  2518. * <td>int</td>
  2519. * <td>
  2520. * The number of the signal that caused the child process to terminate
  2521. * its execution (only meaningful if signaled is true).
  2522. * </td>
  2523. * </tr>
  2524. * <tr valign="top">
  2525. * <td>stopsig</td>
  2526. * <td>int</td>
  2527. * <td>
  2528. * The number of the signal that caused the child process to stop its
  2529. * execution (only meaningful if stopped is true).
  2530. * </td>
  2531. * </tr>
  2532. */
  2533. function proc_get_status ($process) {}
  2534. /**
  2535. * Generate a random integer
  2536. * @link http://www.php.net/manual/en/function.rand.php
  2537. * @param min[optional]
  2538. * @param max[optional]
  2539. * @return int A pseudo random value between min
  2540. * (or 0) and max (or getrandmax, inclusive).
  2541. */
  2542. function rand ($min, $max) {}
  2543. /**
  2544. * Seed the random number generator
  2545. * @link http://www.php.net/manual/en/function.srand.php
  2546. * @param seed int[optional] <p>
  2547. * Optional seed value
  2548. * </p>
  2549. * @return void
  2550. */
  2551. function srand ($seed = null) {}
  2552. /**
  2553. * Show largest possible random value
  2554. * @link http://www.php.net/manual/en/function.getrandmax.php
  2555. * @return int The largest possible random value returned by rand
  2556. */
  2557. function getrandmax () {}
  2558. /**
  2559. * Generate a better random value
  2560. * @link http://www.php.net/manual/en/function.mt-rand.php
  2561. * @param min[optional]
  2562. * @param max[optional]
  2563. * @return int A random integer value between min (or 0)
  2564. * and max (or mt_getrandmax, inclusive)
  2565. */
  2566. function mt_rand ($min, $max) {}
  2567. /**
  2568. * Seed the better random number generator
  2569. * @link http://www.php.net/manual/en/function.mt-srand.php
  2570. * @param seed int[optional] <p>
  2571. * An optional seed value
  2572. * </p>
  2573. * @return void
  2574. */
  2575. function mt_srand ($seed = null) {}
  2576. /**
  2577. * Show largest possible random value
  2578. * @link http://www.php.net/manual/en/function.mt-getrandmax.php
  2579. * @return int the maximum random value returned by mt_rand
  2580. */
  2581. function mt_getrandmax () {}
  2582. /**
  2583. * Get port number associated with an Internet service and protocol
  2584. * @link http://www.php.net/manual/en/function.getservbyname.php
  2585. * @param service string <p>
  2586. * The Internet service name, as a string.
  2587. * </p>
  2588. * @param protocol string <p>
  2589. * protocol is either "tcp"
  2590. * or "udp" (in lowercase).
  2591. * </p>
  2592. * @return int the port number, or false if service or
  2593. * protocol is not found.
  2594. */
  2595. function getservbyname ($service, $protocol) {}
  2596. /**
  2597. * Get Internet service which corresponds to port and protocol
  2598. * @link http://www.php.net/manual/en/function.getservbyport.php
  2599. * @param port int <p>
  2600. * The port number.
  2601. * </p>
  2602. * @param protocol string <p>
  2603. * protocol is either "tcp"
  2604. * or "udp" (in lowercase).
  2605. * </p>
  2606. * @return string the Internet service name as a string.
  2607. */
  2608. function getservbyport ($port, $protocol) {}
  2609. /**
  2610. * Get protocol number associated with protocol name
  2611. * @link http://www.php.net/manual/en/function.getprotobyname.php
  2612. * @param name string <p>
  2613. * The protocol name.
  2614. * </p>
  2615. * @return int the protocol number or -1 if the protocol is not found.
  2616. */
  2617. function getprotobyname ($name) {}
  2618. /**
  2619. * Get protocol name associated with protocol number
  2620. * @link http://www.php.net/manual/en/function.getprotobynumber.php
  2621. * @param number int <p>
  2622. * The protocol number.
  2623. * </p>
  2624. * @return string the protocol name as a string.
  2625. */
  2626. function getprotobynumber ($number) {}
  2627. /**
  2628. * Gets PHP script owner's UID
  2629. * @link http://www.php.net/manual/en/function.getmyuid.php
  2630. * @return int the user ID of the current script, or false on error.
  2631. */
  2632. function getmyuid () {}
  2633. /**
  2634. * Get PHP script owner's GID
  2635. * @link http://www.php.net/manual/en/function.getmygid.php
  2636. * @return int the group ID of the current script, or false on error.
  2637. */
  2638. function getmygid () {}
  2639. /**
  2640. * Gets PHP's process ID
  2641. * @link http://www.php.net/manual/en/function.getmypid.php
  2642. * @return int the current PHP process ID, or false on error.
  2643. */
  2644. function getmypid () {}
  2645. /**
  2646. * Gets the inode of the current script
  2647. * @link http://www.php.net/manual/en/function.getmyinode.php
  2648. * @return int the current script's inode as an integer, or false on error.
  2649. */
  2650. function getmyinode () {}
  2651. /**
  2652. * Gets time of last page modification
  2653. * @link http://www.php.net/manual/en/function.getlastmod.php
  2654. * @return int the time of the last modification of the current
  2655. * page. The value returned is a Unix timestamp, suitable for
  2656. * feeding to date. Returns false on error.
  2657. */
  2658. function getlastmod () {}
  2659. /**
  2660. * Decodes data encoded with MIME base64
  2661. * @link http://www.php.net/manual/en/function.base64-decode.php
  2662. * @param data string <p>
  2663. * The encoded data.
  2664. * </p>
  2665. * @param strict bool[optional] <p>
  2666. * Returns false if input contains character from outside the base64
  2667. * alphabet.
  2668. * </p>
  2669. * @return string the original data&return.falseforfailure;. The returned data may be
  2670. * binary.
  2671. */
  2672. function base64_decode ($data, $strict = null) {}
  2673. /**
  2674. * Encodes data with MIME base64
  2675. * @link http://www.php.net/manual/en/function.base64-encode.php
  2676. * @param data string <p>
  2677. * The data to encode.
  2678. * </p>
  2679. * @return string The encoded data, as a string.
  2680. */
  2681. function base64_encode ($data) {}
  2682. /**
  2683. * Uuencode a string
  2684. * @link http://www.php.net/manual/en/function.convert-uuencode.php
  2685. * @param data string <p>
  2686. * The data to be encoded.
  2687. * </p>
  2688. * @return string the uuencoded data.
  2689. */
  2690. function convert_uuencode ($data) {}
  2691. /**
  2692. * Decode a uuencoded string
  2693. * @link http://www.php.net/manual/en/function.convert-uudecode.php
  2694. * @param data string <p>
  2695. * The uuencoded data.
  2696. * </p>
  2697. * @return string the decoded data as a string.
  2698. */
  2699. function convert_uudecode ($data) {}
  2700. /**
  2701. * Absolute value
  2702. * @link http://www.php.net/manual/en/function.abs.php
  2703. * @param number mixed <p>
  2704. * The numeric value to process
  2705. * </p>
  2706. * @return number The absolute value of number. If the
  2707. * argument number is
  2708. * of type float, the return type is also float,
  2709. * otherwise it is integer (as float usually has a
  2710. * bigger value range than integer).
  2711. */
  2712. function abs ($number) {}
  2713. /**
  2714. * Round fractions up
  2715. * @link http://www.php.net/manual/en/function.ceil.php
  2716. * @param value float <p>
  2717. * The value to round
  2718. * </p>
  2719. * @return float value rounded up to the next highest
  2720. * integer.
  2721. * The return value of ceil is still of type
  2722. * float as the value range of float is
  2723. * usually bigger than that of integer.
  2724. */
  2725. function ceil ($value) {}
  2726. /**
  2727. * Round fractions down
  2728. * @link http://www.php.net/manual/en/function.floor.php
  2729. * @param value float <p>
  2730. * The numeric value to round
  2731. * </p>
  2732. * @return float value rounded to the next lowest integer.
  2733. * The return value of floor is still of type
  2734. * float because the value range of float is
  2735. * usually bigger than that of integer.
  2736. */
  2737. function floor ($value) {}
  2738. /**
  2739. * Rounds a float
  2740. * @link http://www.php.net/manual/en/function.round.php
  2741. * @param val float <p>
  2742. * The value to round
  2743. * </p>
  2744. * @param precision int[optional] <p>
  2745. * The optional number of decimal digits to round to.
  2746. * </p>
  2747. * @param mode int[optional] <p>
  2748. * One of PHP_ROUND_HALF_UP,
  2749. * PHP_ROUND_HALF_DOWN,
  2750. * PHP_ROUND_HALF_EVEN, or
  2751. * PHP_ROUND_HALF_ODD.
  2752. * </p>
  2753. * @return float The rounded value
  2754. */
  2755. function round ($val, $precision = null, $mode = null) {}
  2756. /**
  2757. * Sine
  2758. * @link http://www.php.net/manual/en/function.sin.php
  2759. * @param arg float <p>
  2760. * A value in radians
  2761. * </p>
  2762. * @return float The sine of arg
  2763. */
  2764. function sin ($arg) {}
  2765. /**
  2766. * Cosine
  2767. * @link http://www.php.net/manual/en/function.cos.php
  2768. * @param arg float <p>
  2769. * An angle in radians
  2770. * </p>
  2771. * @return float The cosine of arg
  2772. */
  2773. function cos ($arg) {}
  2774. /**
  2775. * Tangent
  2776. * @link http://www.php.net/manual/en/function.tan.php
  2777. * @param arg float <p>
  2778. * The argument to process in radians
  2779. * </p>
  2780. * @return float The tangent of arg
  2781. */
  2782. function tan ($arg) {}
  2783. /**
  2784. * Arc sine
  2785. * @link http://www.php.net/manual/en/function.asin.php
  2786. * @param arg float <p>
  2787. * The argument to process
  2788. * </p>
  2789. * @return float The arc sine of arg in radians
  2790. */
  2791. function asin ($arg) {}
  2792. /**
  2793. * Arc cosine
  2794. * @link http://www.php.net/manual/en/function.acos.php
  2795. * @param arg float <p>
  2796. * The argument to process
  2797. * </p>
  2798. * @return float The arc cosine of arg in radians.
  2799. */
  2800. function acos ($arg) {}
  2801. /**
  2802. * Arc tangent
  2803. * @link http://www.php.net/manual/en/function.atan.php
  2804. * @param arg float <p>
  2805. * The argument to process
  2806. * </p>
  2807. * @return float The arc tangent of arg in radians.
  2808. */
  2809. function atan ($arg) {}
  2810. /**
  2811. * Inverse hyperbolic tangent
  2812. * @link http://www.php.net/manual/en/function.atanh.php
  2813. * @param arg float <p>
  2814. * The argument to process
  2815. * </p>
  2816. * @return float Inverse hyperbolic tangent of arg
  2817. */
  2818. function atanh ($arg) {}
  2819. /**
  2820. * Arc tangent of two variables
  2821. * @link http://www.php.net/manual/en/function.atan2.php
  2822. * @param y float <p>
  2823. * Dividend parameter
  2824. * </p>
  2825. * @param x float <p>
  2826. * Divisor parameter
  2827. * </p>
  2828. * @return float The arc tangent of y/x
  2829. * in radians.
  2830. */
  2831. function atan2 ($y, $x) {}
  2832. /**
  2833. * Hyperbolic sine
  2834. * @link http://www.php.net/manual/en/function.sinh.php
  2835. * @param arg float <p>
  2836. * The argument to process
  2837. * </p>
  2838. * @return float The hyperbolic sine of arg
  2839. */
  2840. function sinh ($arg) {}
  2841. /**
  2842. * Hyperbolic cosine
  2843. * @link http://www.php.net/manual/en/function.cosh.php
  2844. * @param arg float <p>
  2845. * The argument to process
  2846. * </p>
  2847. * @return float The hyperbolic cosine of arg
  2848. */
  2849. function cosh ($arg) {}
  2850. /**
  2851. * Hyperbolic tangent
  2852. * @link http://www.php.net/manual/en/function.tanh.php
  2853. * @param arg float <p>
  2854. * The argument to process
  2855. * </p>
  2856. * @return float The hyperbolic tangent of arg
  2857. */
  2858. function tanh ($arg) {}
  2859. /**
  2860. * Inverse hyperbolic sine
  2861. * @link http://www.php.net/manual/en/function.asinh.php
  2862. * @param arg float <p>
  2863. * The argument to process
  2864. * </p>
  2865. * @return float The inverse hyperbolic sine of arg
  2866. */
  2867. function asinh ($arg) {}
  2868. /**
  2869. * Inverse hyperbolic cosine
  2870. * @link http://www.php.net/manual/en/function.acosh.php
  2871. * @param arg float <p>
  2872. * The value to process
  2873. * </p>
  2874. * @return float The inverse hyperbolic cosine of arg
  2875. */
  2876. function acosh ($arg) {}
  2877. /**
  2878. * Returns exp(number) - 1, computed in a way that is accurate even
  2879. when the value of number is close to zero
  2880. * @link http://www.php.net/manual/en/function.expm1.php
  2881. * @param arg float <p>
  2882. * The argument to process
  2883. * </p>
  2884. * @return float 'e' to the power of arg minus one
  2885. */
  2886. function expm1 ($arg) {}
  2887. /**
  2888. * Returns log(1 + number), computed in a way that is accurate even when
  2889. the value of number is close to zero
  2890. * @link http://www.php.net/manual/en/function.log1p.php
  2891. * @param number float <p>
  2892. * The argument to process
  2893. * </p>
  2894. * @return float log(1 + number)
  2895. */
  2896. function log1p ($number) {}
  2897. /**
  2898. * Get value of pi
  2899. * @link http://www.php.net/manual/en/function.pi.php
  2900. * @return float The value of pi as float.
  2901. */
  2902. function pi () {}
  2903. /**
  2904. * Finds whether a value is a legal finite number
  2905. * @link http://www.php.net/manual/en/function.is-finite.php
  2906. * @param val float <p>
  2907. * The value to check
  2908. * </p>
  2909. * @return bool true if val is a legal finite
  2910. * number within the allowed range for a PHP float on this platform,
  2911. * else false.
  2912. */
  2913. function is_finite ($val) {}
  2914. /**
  2915. * Finds whether a value is not a number
  2916. * @link http://www.php.net/manual/en/function.is-nan.php
  2917. * @param val float <p>
  2918. * The value to check
  2919. * </p>
  2920. * @return bool true if val is 'not a number',
  2921. * else false.
  2922. */
  2923. function is_nan ($val) {}
  2924. /**
  2925. * Finds whether a value is infinite
  2926. * @link http://www.php.net/manual/en/function.is-infinite.php
  2927. * @param val float <p>
  2928. * The value to check
  2929. * </p>
  2930. * @return bool true if val is infinite, else false.
  2931. */
  2932. function is_infinite ($val) {}
  2933. /**
  2934. * Exponential expression
  2935. * @link http://www.php.net/manual/en/function.pow.php
  2936. * @param base number <p>
  2937. * The base to use
  2938. * </p>
  2939. * @param exp number <p>
  2940. * The exponent
  2941. * </p>
  2942. * @return number base raised to the power of exp.
  2943. * If the result can be represented as integer it will be returned as type
  2944. * integer, else it will be returned as type float.
  2945. * If the power cannot be computed false will be returned instead.
  2946. */
  2947. function pow ($base, $exp) {}
  2948. /**
  2949. * Calculates the exponent of <constant>e</constant>
  2950. * @link http://www.php.net/manual/en/function.exp.php
  2951. * @param arg float <p>
  2952. * The argument to process
  2953. * </p>
  2954. * @return float 'e' raised to the power of arg
  2955. */
  2956. function exp ($arg) {}
  2957. /**
  2958. * Natural logarithm
  2959. * @link http://www.php.net/manual/en/function.log.php
  2960. * @param arg float <p>
  2961. * The value to calculate the logarithm for
  2962. * </p>
  2963. * @param base float[optional] <p>
  2964. * The optional logarithmic base to use
  2965. * (defaults to 'e' and so to the natural logarithm).
  2966. * </p>
  2967. * @return float The logarithm of arg to
  2968. * base, if given, or the
  2969. * natural logarithm.
  2970. */
  2971. function log ($arg, $base = null) {}
  2972. /**
  2973. * Base-10 logarithm
  2974. * @link http://www.php.net/manual/en/function.log10.php
  2975. * @param arg float <p>
  2976. * The argument to process
  2977. * </p>
  2978. * @return float The base-10 logarithm of arg
  2979. */
  2980. function log10 ($arg) {}
  2981. /**
  2982. * Square root
  2983. * @link http://www.php.net/manual/en/function.sqrt.php
  2984. * @param arg float <p>
  2985. * The argument to process
  2986. * </p>
  2987. * @return float The square root of arg
  2988. * or the special value NAN for negative numbers.
  2989. */
  2990. function sqrt ($arg) {}
  2991. /**
  2992. * Calculate the length of the hypotenuse of a right-angle triangle
  2993. * @link http://www.php.net/manual/en/function.hypot.php
  2994. * @param x float <p>
  2995. * Length of first side
  2996. * </p>
  2997. * @param y float <p>
  2998. * Length of second side
  2999. * </p>
  3000. * @return float Calculated length of the hypotenuse
  3001. */
  3002. function hypot ($x, $y) {}
  3003. /**
  3004. * Converts the number in degrees to the radian equivalent
  3005. * @link http://www.php.net/manual/en/function.deg2rad.php
  3006. * @param number float <p>
  3007. * Angular value in degrees
  3008. * </p>
  3009. * @return float The radian equivalent of number
  3010. */
  3011. function deg2rad ($number) {}
  3012. /**
  3013. * Converts the radian number to the equivalent number in degrees
  3014. * @link http://www.php.net/manual/en/function.rad2deg.php
  3015. * @param number float <p>
  3016. * A radian value
  3017. * </p>
  3018. * @return float The equivalent of number in degrees
  3019. */
  3020. function rad2deg ($number) {}
  3021. /**
  3022. * Binary to decimal
  3023. * @link http://www.php.net/manual/en/function.bindec.php
  3024. * @param binary_string string <p>
  3025. * The binary string to convert
  3026. * </p>
  3027. * @return number The decimal value of binary_string
  3028. */
  3029. function bindec ($binary_string) {}
  3030. /**
  3031. * Hexadecimal to decimal
  3032. * @link http://www.php.net/manual/en/function.hexdec.php
  3033. * @param hex_string string <p>
  3034. * The hexadecimal string to convert
  3035. * </p>
  3036. * @return number The decimal representation of hex_string
  3037. */
  3038. function hexdec ($hex_string) {}
  3039. /**
  3040. * Octal to decimal
  3041. * @link http://www.php.net/manual/en/function.octdec.php
  3042. * @param octal_string string <p>
  3043. * The octal string to convert
  3044. * </p>
  3045. * @return number The decimal representation of octal_string
  3046. */
  3047. function octdec ($octal_string) {}
  3048. /**
  3049. * Decimal to binary
  3050. * @link http://www.php.net/manual/en/function.decbin.php
  3051. * @param number int <p>
  3052. * Decimal value to convert
  3053. * </p>
  3054. * <table>
  3055. * Range of inputs on 32-bit machines
  3056. * <tr valign="top">
  3057. * <td>positive number</td>
  3058. * <td>negative number</td>
  3059. * <td>return value</td>
  3060. * </tr>
  3061. * <tr valign="top">
  3062. * <td>0</td>
  3063. * <td></td>
  3064. * <td>0</td>
  3065. * </tr>
  3066. * <tr valign="top">
  3067. * <td>1</td>
  3068. * <td></td>
  3069. * <td>1</td>
  3070. * </tr>
  3071. * <tr valign="top">
  3072. * <td>2</td>
  3073. * <td></td>
  3074. * <td>10</td>
  3075. * </tr>
  3076. * <tr valign="top">
  3077. * ... normal progression ...</td>
  3078. * </tr>
  3079. * <tr valign="top">
  3080. * <td>2147483646</td>
  3081. * <td></td>
  3082. * <td>1111111111111111111111111111110</td>
  3083. * </tr>
  3084. * <tr valign="top">
  3085. * <td>2147483647 (largest signed integer)</td>
  3086. * <td></td>
  3087. * <td>1111111111111111111111111111111 (31 1's)</td>
  3088. * </tr>
  3089. * <tr valign="top">
  3090. * <td>2147483648</td>
  3091. * <td>-2147483648</td>
  3092. * <td>10000000000000000000000000000000</td>
  3093. * </tr>
  3094. * <tr valign="top">
  3095. * ... normal progression ...</td>
  3096. * </tr>
  3097. * <tr valign="top">
  3098. * <td>4294967294</td>
  3099. * <td>-2</td>
  3100. * <td>11111111111111111111111111111110</td>
  3101. * </tr>
  3102. * <tr valign="top">
  3103. * <td>4294967295 (largest unsigned integer)</td>
  3104. * <td>-1</td>
  3105. * <td>11111111111111111111111111111111 (32 1's)</td>
  3106. * </tr>
  3107. * </table>
  3108. * <table>
  3109. * Range of inputs on 64-bit machines
  3110. * <tr valign="top">
  3111. * <td>positive number</td>
  3112. * <td>negative number</td>
  3113. * <td>return value</td>
  3114. * </tr>
  3115. * <tr valign="top">
  3116. * <td>0</td>
  3117. * <td></td>
  3118. * <td>0</td>
  3119. * </tr>
  3120. * <tr valign="top">
  3121. * <td>1</td>
  3122. * <td></td>
  3123. * <td>1</td>
  3124. * </tr>
  3125. * <tr valign="top">
  3126. * <td>2</td>
  3127. * <td></td>
  3128. * <td>10</td>
  3129. * </tr>
  3130. * <tr valign="top">
  3131. * ... normal progression ...</td>
  3132. * </tr>
  3133. * <tr valign="top">
  3134. * <td>9223372036854775806</td>
  3135. * <td></td>
  3136. * <td>111111111111111111111111111111111111111111111111111111111111110</td>
  3137. * </tr>
  3138. * <tr valign="top">
  3139. * <td>9223372036854775807 (largest signed integer)</td>
  3140. * <td></td>
  3141. * <td>111111111111111111111111111111111111111111111111111111111111111 (31 1's)</td>
  3142. * </tr>
  3143. * <tr valign="top">
  3144. * <td></td>
  3145. * <td>-9223372036854775808</td>
  3146. * <td>1000000000000000000000000000000000000000000000000000000000000000</td>
  3147. * </tr>
  3148. * <tr valign="top">
  3149. * ... normal progression ...</td>
  3150. * </tr>
  3151. * <tr valign="top">
  3152. * <td></td>
  3153. * <td>-2</td>
  3154. * <td>1111111111111111111111111111111111111111111111111111111111111110</td>
  3155. * </tr>
  3156. * <tr valign="top">
  3157. * <td></td>
  3158. * <td>-1</td>
  3159. * <td>1111111111111111111111111111111111111111111111111111111111111111 (64 1's)</td>
  3160. * </tr>
  3161. * </table>
  3162. * @return string Binary string representation of number
  3163. */
  3164. function decbin ($number) {}
  3165. /**
  3166. * Decimal to octal
  3167. * @link http://www.php.net/manual/en/function.decoct.php
  3168. * @param number int <p>
  3169. * Decimal value to convert
  3170. * </p>
  3171. * @return string Octal string representation of number
  3172. */
  3173. function decoct ($number) {}
  3174. /**
  3175. * Decimal to hexadecimal
  3176. * @link http://www.php.net/manual/en/function.dechex.php
  3177. * @param number int <p>
  3178. * Decimal value to convert
  3179. * </p>
  3180. * @return string Hexadecimal string representation of number
  3181. */
  3182. function dechex ($number) {}
  3183. /**
  3184. * Convert a number between arbitrary bases
  3185. * @link http://www.php.net/manual/en/function.base-convert.php
  3186. * @param number string <p>
  3187. * The number to convert
  3188. * </p>
  3189. * @param frombase int <p>
  3190. * The base number is in
  3191. * </p>
  3192. * @param tobase int <p>
  3193. * The base to convert number to
  3194. * </p>
  3195. * @return string number converted to base tobase
  3196. */
  3197. function base_convert ($number, $frombase, $tobase) {}
  3198. /**
  3199. * Format a number with grouped thousands
  3200. * @link http://www.php.net/manual/en/function.number-format.php
  3201. * @param number float <p>
  3202. * The number being formatted.
  3203. * </p>
  3204. * @param decimals int[optional] <p>
  3205. * Sets the number of decimal points.
  3206. * </p>
  3207. * @return string A formatted version of number.
  3208. */
  3209. function number_format ($number, $decimals = null) {}
  3210. /**
  3211. * Returns the floating point remainder (modulo) of the division
  3212. of the arguments
  3213. * @link http://www.php.net/manual/en/function.fmod.php
  3214. * @param x float <p>
  3215. * The dividend
  3216. * </p>
  3217. * @param y float <p>
  3218. * The divisor
  3219. * </p>
  3220. * @return float The floating point remainder of
  3221. * x/y
  3222. */
  3223. function fmod ($x, $y) {}
  3224. /**
  3225. * Converts a packed internet address to a human readable representation
  3226. * @link http://www.php.net/manual/en/function.inet-ntop.php
  3227. * @param in_addr string <p>
  3228. * A 32bit IPv4, or 128bit IPv6 address.
  3229. * </p>
  3230. * @return string a string representation of the address&return.falseforfailure;.
  3231. */
  3232. function inet_ntop ($in_addr) {}
  3233. /**
  3234. * Converts a human readable IP address to its packed in_addr representation
  3235. * @link http://www.php.net/manual/en/function.inet-pton.php
  3236. * @param address string <p>
  3237. * A human readable IPv4 or IPv6 address.
  3238. * </p>
  3239. * @return string the in_addr representation of the given
  3240. * address
  3241. */
  3242. function inet_pton ($address) {}
  3243. /**
  3244. * Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address
  3245. * @link http://www.php.net/manual/en/function.ip2long.php
  3246. * @param ip_address string <p>
  3247. * A standard format address.
  3248. * </p>
  3249. * @return int the IPv4 address or false if ip_address
  3250. * is invalid.
  3251. */
  3252. function ip2long ($ip_address) {}
  3253. /**
  3254. * Converts an (IPv4) Internet network address into a string in Internet standard dotted format
  3255. * @link http://www.php.net/manual/en/function.long2ip.php
  3256. * @param proper_address string <p>
  3257. * A proper address representation.
  3258. * </p>
  3259. * @return string the Internet IP address as a string.
  3260. */
  3261. function long2ip ($proper_address) {}
  3262. /**
  3263. * Gets the value of an environment variable
  3264. * @link http://www.php.net/manual/en/function.getenv.php
  3265. * @param varname string <p>
  3266. * The variable name.
  3267. * </p>
  3268. * @return string the value of the environment variable
  3269. * varname, or false on an error.
  3270. */
  3271. function getenv ($varname) {}
  3272. /**
  3273. * Sets the value of an environment variable
  3274. * @link http://www.php.net/manual/en/function.putenv.php
  3275. * @param setting string <p>
  3276. * The setting, like "FOO=BAR"
  3277. * </p>
  3278. * @return bool Returns true on success or false on failure.
  3279. */
  3280. function putenv ($setting) {}
  3281. /**
  3282. * Gets options from the command line argument list
  3283. * @link http://www.php.net/manual/en/function.getopt.php
  3284. * @param options string Each character in this string will be used as option characters and
  3285. * matched against options passed to the script starting with a single
  3286. * hyphen (-).
  3287. * For example, an option string "x" recognizes an
  3288. * option -x.
  3289. * Only a-z, A-Z and 0-9 are allowed.
  3290. * @param longopts array[optional] An array of options. Each element in this array will be used as option
  3291. * strings and matched against options passed to the script starting with
  3292. * two hyphens (--).
  3293. * For example, an longopts element "opt" recognizes an
  3294. * option --opt.
  3295. * Prior to PHP5.3.0 this parameter was only available on few systems
  3296. * @return array This function will return an array of option / argument pairs or false on
  3297. * failure.
  3298. * </p>
  3299. * <p>
  3300. * The parsing of options will end at the first non-option found, anything
  3301. * that follows is discarded.
  3302. */
  3303. function getopt ($options, array $longopts = null) {}
  3304. /**
  3305. * Return current Unix timestamp with microseconds
  3306. * @link http://www.php.net/manual/en/function.microtime.php
  3307. * @param get_as_float bool[optional] <p>
  3308. * When called without the optional argument, this function returns the string
  3309. * "msec sec" where sec is the current time measured in the number of
  3310. * seconds since the Unix Epoch (0:00:00 January 1, 1970 GMT), and
  3311. * msec is the microseconds part.
  3312. * Both portions of the string are returned in units of seconds.
  3313. * </p>
  3314. * <p>
  3315. * If the optional get_as_float is set to
  3316. * true then a float (in seconds) is returned.
  3317. * </p>
  3318. * @return mixed
  3319. */
  3320. function microtime ($get_as_float = null) {}
  3321. /**
  3322. * Get current time
  3323. * @link http://www.php.net/manual/en/function.gettimeofday.php
  3324. * @param return_float bool[optional] <p>
  3325. * When set to true, a float instead of an array is returned.
  3326. * </p>
  3327. * @return mixed By default an array is returned. If return_float
  3328. * is set, then a float is returned.
  3329. * </p>
  3330. * <p>
  3331. * Array keys:
  3332. * "sec" - seconds since the Unix Epoch
  3333. * "usec" - microseconds
  3334. * "minuteswest" - minutes west of Greenwich
  3335. * "dsttime" - type of dst correction
  3336. */
  3337. function gettimeofday ($return_float = null) {}
  3338. /**
  3339. * Generate a unique ID
  3340. * @link http://www.php.net/manual/en/function.uniqid.php
  3341. * @param prefix string[optional] <p>
  3342. * Can be useful, for instance, if you generate identifiers
  3343. * simultaneously on several hosts that might happen to generate the
  3344. * identifier at the same microsecond.
  3345. * </p>
  3346. * <p>
  3347. * With an empty prefix, the returned string will
  3348. * be 13 characters long. If more_entropy is
  3349. * true, it will be 23 characters.
  3350. * </p>
  3351. * @param more_entropy bool[optional] <p>
  3352. * If set to true, uniqid will add additional
  3353. * entropy (using the combined linear congruential generator) at the end
  3354. * of the return value, which should make the results more unique.
  3355. * </p>
  3356. * @return string the unique identifier, as a string.
  3357. */
  3358. function uniqid ($prefix = null, $more_entropy = null) {}
  3359. /**
  3360. * Convert a quoted-printable string to an 8 bit string
  3361. * @link http://www.php.net/manual/en/function.quoted-printable-decode.php
  3362. * @param str string <p>
  3363. * The input string.
  3364. * </p>
  3365. * @return string the 8-bit binary string.
  3366. */
  3367. function quoted_printable_decode ($str) {}
  3368. /**
  3369. * Convert a 8 bit string to a quoted-printable string
  3370. * @link http://www.php.net/manual/en/function.quoted-printable-encode.php
  3371. * @param str string <p>
  3372. * The input string.
  3373. * </p>
  3374. * @return string the encoded string.
  3375. */
  3376. function quoted_printable_encode ($str) {}
  3377. /**
  3378. * Convert from one Cyrillic character set to another
  3379. * @link http://www.php.net/manual/en/function.convert-cyr-string.php
  3380. * @param str string <p>
  3381. * The string to be converted.
  3382. * </p>
  3383. * @param from string <p>
  3384. * The source Cyrillic character set, as a single character.
  3385. * </p>
  3386. * @param to string <p>
  3387. * The target Cyrillic character set, as a single character.
  3388. * </p>
  3389. * @return string the converted string.
  3390. */
  3391. function convert_cyr_string ($str, $from, $to) {}
  3392. /**
  3393. * Gets the name of the owner of the current PHP script
  3394. * @link http://www.php.net/manual/en/function.get-current-user.php
  3395. * @return string the username as a string.
  3396. */
  3397. function get_current_user () {}
  3398. /**
  3399. * Limits the maximum execution time
  3400. * @link http://www.php.net/manual/en/function.set-time-limit.php
  3401. * @param seconds int <p>
  3402. * The maximum execution time, in seconds. If set to zero, no time limit
  3403. * is imposed.
  3404. * </p>
  3405. * @return void
  3406. */
  3407. function set_time_limit ($seconds) {}
  3408. /**
  3409. * Gets the value of a PHP configuration option
  3410. * @link http://www.php.net/manual/en/function.get-cfg-var.php
  3411. * @param option string <p>
  3412. * The configuration option name.
  3413. * </p>
  3414. * @return string the current value of the PHP configuration variable specified by
  3415. * option, or false if an error occurs.
  3416. */
  3417. function get_cfg_var ($option) {}
  3418. /**
  3419. * &Alias; <function>set_magic_quotes_runtime</function>
  3420. * @link http://www.php.net/manual/en/function.magic-quotes-runtime.php
  3421. * @param new_setting
  3422. */
  3423. function magic_quotes_runtime ($new_setting) {}
  3424. /**
  3425. * Sets the current active configuration setting of magic_quotes_runtime
  3426. * @link http://www.php.net/manual/en/function.set-magic-quotes-runtime.php
  3427. * @param new_setting bool <p>
  3428. * false for off, true for on.
  3429. * </p>
  3430. * @return bool Returns true on success or false on failure.
  3431. */
  3432. function set_magic_quotes_runtime ($new_setting) {}
  3433. /**
  3434. * Gets the current configuration setting of magic_quotes_gpc
  3435. * @link http://www.php.net/manual/en/function.get-magic-quotes-gpc.php
  3436. * @return int 0 if magic_quotes_gpc is off, 1 otherwise.
  3437. */
  3438. function get_magic_quotes_gpc () {}
  3439. /**
  3440. * Gets the current active configuration setting of magic_quotes_runtime
  3441. * @link http://www.php.net/manual/en/function.get-magic-quotes-runtime.php
  3442. * @return int 0 if magic_quotes_runtime is off, 1 otherwise.
  3443. */
  3444. function get_magic_quotes_runtime () {}
  3445. /**
  3446. * Import GET/POST/Cookie variables into the global scope
  3447. * @link http://www.php.net/manual/en/function.import-request-variables.php
  3448. * @param types string <p>
  3449. * Using the types parameter, you can specify
  3450. * which request variables to import. You can use 'G', 'P' and 'C'
  3451. * characters respectively for GET, POST and Cookie. These characters are
  3452. * not case sensitive, so you can also use any combination of 'g', 'p'
  3453. * and 'c'. POST includes the POST uploaded file information.
  3454. * </p>
  3455. * <p>
  3456. * Note that the order of the letters matters, as when using
  3457. * "GP", the
  3458. * POST variables will overwrite GET variables with the same name. Any
  3459. * other letters than GPC are discarded.
  3460. * </p>
  3461. * @param prefix string[optional] <p>
  3462. * Variable name prefix, prepended before all variable's name imported
  3463. * into the global scope. So if you have a GET value named
  3464. * "userid", and provide a prefix
  3465. * "pref_", then you'll get a global variable named
  3466. * $pref_userid.
  3467. * </p>
  3468. * <p>
  3469. * Although the prefix parameter is optional, you
  3470. * will get an E_NOTICE level
  3471. * error if you specify no prefix, or specify an empty string as a
  3472. * prefix. This is a possible security hazard. Notice level errors are
  3473. * not displayed using the default error reporting level.
  3474. * </p>
  3475. * @return bool Returns true on success or false on failure.
  3476. */
  3477. function import_request_variables ($types, $prefix = null) {}
  3478. /**
  3479. * Send an error message somewhere
  3480. * @link http://www.php.net/manual/en/function.error-log.php
  3481. * @param message string <p>
  3482. * The error message that should be logged.
  3483. * </p>
  3484. * @param message_type int[optional] <p>
  3485. * Says where the error should go. The possible message types are as
  3486. * follows:
  3487. * </p>
  3488. * <p>
  3489. * <table>
  3490. * error_log log types
  3491. * <tr valign="top">
  3492. * <td>0</td>
  3493. * <td>
  3494. * message is sent to PHP's system logger, using
  3495. * the Operating System's system logging mechanism or a file, depending
  3496. * on what the error_log
  3497. * configuration directive is set to. This is the default option.
  3498. * </td>
  3499. * </tr>
  3500. * <tr valign="top">
  3501. * <td>1</td>
  3502. * <td>
  3503. * message is sent by email to the address in
  3504. * the destination parameter. This is the only
  3505. * message type where the fourth parameter,
  3506. * extra_headers is used.
  3507. * </td>
  3508. * </tr>
  3509. * <tr valign="top">
  3510. * <td>2</td>
  3511. * <td>
  3512. * No longer an option.
  3513. * </td>
  3514. * </tr>
  3515. * <tr valign="top">
  3516. * <td>3</td>
  3517. * <td>
  3518. * message is appended to the file
  3519. * destination. A newline is not automatically
  3520. * added to the end of the message string.
  3521. * </td>
  3522. * </tr>
  3523. * <tr valign="top">
  3524. * <td>4</td>
  3525. * <td>
  3526. * message is sent directly to the SAPI logging
  3527. * handler.
  3528. * </td>
  3529. * </tr>
  3530. * </table>
  3531. * </p>
  3532. * @param destination string[optional] <p>
  3533. * The destination. Its meaning depends on the
  3534. * message_type parameter as described above.
  3535. * </p>
  3536. * @param extra_headers string[optional] <p>
  3537. * The extra headers. It's used when the message_type
  3538. * parameter is set to 1.
  3539. * This message type uses the same internal function as
  3540. * mail does.
  3541. * </p>
  3542. * @return bool Returns true on success or false on failure.
  3543. */
  3544. function error_log ($message, $message_type = null, $destination = null, $extra_headers = null) {}
  3545. /**
  3546. * Get the last occurred error
  3547. * @link http://www.php.net/manual/en/function.error-get-last.php
  3548. * @return array an associative array describing the last error with keys "type",
  3549. * "message", "file" and "line". Returns &null; if there hasn't been an error
  3550. * yet.
  3551. */
  3552. function error_get_last () {}
  3553. /**
  3554. * Call a user function given by the first parameter
  3555. * @link http://www.php.net/manual/en/function.call-user-func.php
  3556. * @param function callback <p>
  3557. * The function to be called. Class methods may also be invoked
  3558. * statically using this function by passing
  3559. * array($classname, $methodname) to this parameter.
  3560. * Additionally class methods of an object instance may be called by passing
  3561. * array($objectinstance, $methodname) to this parameter.
  3562. * </p>
  3563. * @param parameter mixed[optional] <p>
  3564. * Zero or more parameters to be passed to the function.
  3565. * </p>
  3566. * <p>
  3567. * Note that the parameters for call_user_func are
  3568. * not passed by reference.
  3569. * call_user_func example and references
  3570. * ]]>
  3571. * &example.outputs;
  3572. * </p>
  3573. * @param _ mixed[optional]
  3574. * @return mixed the function result, or false on error.
  3575. */
  3576. function call_user_func ($function, $parameter = null, $_ = null) {}
  3577. /**
  3578. * Call a user function given with an array of parameters
  3579. * @link http://www.php.net/manual/en/function.call-user-func-array.php
  3580. * @param function callback <p>
  3581. * The function to be called.
  3582. * </p>
  3583. * @param param_arr array <p>
  3584. * The parameters to be passed to the function, as an indexed array.
  3585. * </p>
  3586. * @return mixed the function result, or false on error.
  3587. */
  3588. function call_user_func_array ($function, array $param_arr) {}
  3589. /**
  3590. * Call a user method on an specific object [deprecated]
  3591. * @link http://www.php.net/manual/en/function.call-user-method.php
  3592. * @param method_name string
  3593. * @param obj object
  3594. * @param parameter mixed[optional]
  3595. * @param _ mixed[optional]
  3596. * @return mixed
  3597. */
  3598. function call_user_method ($method_name, &$obj, $parameter = null, $_ = null) {}
  3599. /**
  3600. * Call a user method given with an array of parameters [deprecated]
  3601. * @link http://www.php.net/manual/en/function.call-user-method-array.php
  3602. * @param method_name string
  3603. * @param obj object
  3604. * @param params array
  3605. * @return mixed
  3606. */
  3607. function call_user_method_array ($method_name, &$obj, array $params) {}
  3608. /**
  3609. * Call a static method
  3610. * @link http://www.php.net/manual/en/function.forward-static-call.php
  3611. * @param function callback <p>
  3612. * The function or method to be called. This parameter may be an array,
  3613. * with the name of the class, and the method, or a string, with a function
  3614. * name.
  3615. * </p>
  3616. * @param parameter mixed[optional] <p>
  3617. * Zero or more parameters to be passed to the function.
  3618. * </p>
  3619. * @param _ mixed[optional]
  3620. * @return mixed the function result, or false on error.
  3621. */
  3622. function forward_static_call ($function, $parameter = null, $_ = null) {}
  3623. /**
  3624. * Call a static method and pass the arguments as array
  3625. * @link http://www.php.net/manual/en/function.forward-static-call-array.php
  3626. * @param function callback <p>
  3627. * The function or method to be called. This parameter may be an &array;,
  3628. * with the name of the class, and the method, or a &string;, with a function
  3629. * name.
  3630. * </p>
  3631. * @param parameters array[optional]
  3632. * @return mixed the function result, or false on error.
  3633. */
  3634. function forward_static_call_array ($function, array $parameters = null) {}
  3635. /**
  3636. * Generates a storable representation of a value
  3637. * @link http://www.php.net/manual/en/function.serialize.php
  3638. * @param value mixed <p>
  3639. * The value to be serialized. serialize
  3640. * handles all types, except the resource-type.
  3641. * You can even serialize arrays that contain
  3642. * references to itself. Circular references inside the array/object you
  3643. * are serializing will also be stored. Any other
  3644. * reference will be lost.
  3645. * </p>
  3646. * <p>
  3647. * When serializing objects, PHP will attempt to call the member function
  3648. * __sleep prior to serialization.
  3649. * This is to allow the object to do any last minute clean-up, etc. prior
  3650. * to being serialized. Likewise, when the object is restored using
  3651. * unserialize the __wakeup member function is called.
  3652. * </p>
  3653. * <p>
  3654. * Object's private members have the class name prepended to the member
  3655. * name; protected members have a '*' prepended to the member name.
  3656. * These prepended values have null bytes on either side.
  3657. * </p>
  3658. * @return string a string containing a byte-stream representation of
  3659. * value that can be stored anywhere.
  3660. */
  3661. function serialize ($value) {}
  3662. /**
  3663. * Creates a PHP value from a stored representation
  3664. * @link http://www.php.net/manual/en/function.unserialize.php
  3665. * @param str string <p>
  3666. * The serialized string.
  3667. * </p>
  3668. * <p>
  3669. * If the variable being unserialized is an object, after successfully
  3670. * reconstructing the object PHP will automatically attempt to call the
  3671. * __wakeup member function (if it exists).
  3672. * </p>
  3673. * <p>
  3674. * unserialize_callback_func directive
  3675. * <p>
  3676. * It's possible to set a callback-function which will be called,
  3677. * if an undefined class should be instantiated during unserializing.
  3678. * (to prevent getting an incomplete object "__PHP_Incomplete_Class".)
  3679. * Use your &php.ini;, ini_set or &htaccess;
  3680. * to define 'unserialize_callback_func'. Everytime an undefined class
  3681. * should be instantiated, it'll be called. To disable this feature just
  3682. * empty this setting.
  3683. * </p>
  3684. * </p>
  3685. * @return mixed The converted value is returned, and can be a boolean,
  3686. * integer, float, string,
  3687. * array or object.
  3688. * </p>
  3689. * <p>
  3690. * In case the passed string is not unserializeable, false is returned and
  3691. * E_NOTICE is issued.
  3692. */
  3693. function unserialize ($str) {}
  3694. /**
  3695. * Dumps information about a variable
  3696. * @link http://www.php.net/manual/en/function.var-dump.php
  3697. * @param expression mixed <p>
  3698. * The variable you want to export.
  3699. * </p>
  3700. * @param expression mixed[optional]
  3701. * @return void
  3702. */
  3703. function var_dump ($expression, $expression = null) {}
  3704. /**
  3705. * Outputs or returns a parsable string representation of a variable
  3706. * @link http://www.php.net/manual/en/function.var-export.php
  3707. * @param expression mixed <p>
  3708. * The variable you want to export.
  3709. * </p>
  3710. * @param return bool[optional] <p>
  3711. * If used and set to true, var_export will return
  3712. * the variable representation instead of outputing it.
  3713. * </p>
  3714. * &note.uses-ob;
  3715. * @return mixed the variable representation when the return
  3716. * parameter is used and evaluates to true. Otherwise, this function will
  3717. * return &null;.
  3718. */
  3719. function var_export ($expression, $return = null) {}
  3720. /**
  3721. * Dumps a string representation of an internal zend value to output
  3722. * @link http://www.php.net/manual/en/function.debug-zval-dump.php
  3723. * @param variable mixed <p>
  3724. * The variable being evaluated.
  3725. * </p>
  3726. * @return void
  3727. */
  3728. function debug_zval_dump ($variable) {}
  3729. /**
  3730. * Prints human-readable information about a variable
  3731. * @link http://www.php.net/manual/en/function.print-r.php
  3732. * @param expression mixed <p>
  3733. * The expression to be printed.
  3734. * </p>
  3735. * @param return bool[optional] <p>
  3736. * If you would like to capture the output of print_r,
  3737. * use the return parameter. When this parameter is set
  3738. * to true, print_r will return the information rather than print it.
  3739. * </p>
  3740. * @return mixed If given a string, integer or float,
  3741. * the value itself will be printed. If given an array, values
  3742. * will be presented in a format that shows keys and elements. Similar
  3743. * notation is used for objects.
  3744. * </p>
  3745. * <p>
  3746. * When the return parameter is true, this function
  3747. * will return a string. Otherwise, the return value is true.
  3748. */
  3749. function print_r ($expression, $return = null) {}
  3750. /**
  3751. * Returns the amount of memory allocated to PHP
  3752. * @link http://www.php.net/manual/en/function.memory-get-usage.php
  3753. * @param real_usage bool[optional] <p>
  3754. * Set this to true to get the real size of memory allocated from
  3755. * system. If not set or false only the memory used by
  3756. * emalloc() is reported.
  3757. * </p>
  3758. * @return int the memory amount in bytes.
  3759. */
  3760. function memory_get_usage ($real_usage = null) {}
  3761. /**
  3762. * Returns the peak of memory allocated by PHP
  3763. * @link http://www.php.net/manual/en/function.memory-get-peak-usage.php
  3764. * @param real_usage bool[optional] <p>
  3765. * Set this to true to get the real size of memory allocated from
  3766. * system. If not set or false only the memory used by
  3767. * emalloc() is reported.
  3768. * </p>
  3769. * @return int the memory peak in bytes.
  3770. */
  3771. function memory_get_peak_usage ($real_usage = null) {}
  3772. /**
  3773. * Register a function for execution on shutdown
  3774. * @link http://www.php.net/manual/en/function.register-shutdown-function.php
  3775. * @param function callback <p>
  3776. * The shutdown function to register.
  3777. * </p>
  3778. * <p>
  3779. * The shutdown functions are called as the part of the request so that
  3780. * it's possible to send the output from them. There is currently no way
  3781. * to process the data with output buffering functions in the shutdown
  3782. * function.
  3783. * </p>
  3784. * <p>
  3785. * Shutdown functions are called after closing all opened output buffers
  3786. * thus, for example, its output will not be compressed if zlib.output_compression is
  3787. * enabled.
  3788. * </p>
  3789. * @param parameter mixed[optional] <p>
  3790. * It is possible to pass parameters to the shutdown function by passing
  3791. * additional parameters.
  3792. * </p>
  3793. * @param _ mixed[optional]
  3794. * @return void
  3795. */
  3796. function register_shutdown_function ($function, $parameter = null, $_ = null) {}
  3797. /**
  3798. * Register a function for execution on each tick
  3799. * @link http://www.php.net/manual/en/function.register-tick-function.php
  3800. * @param function callback <p>
  3801. * The function name as a string, or an array consisting of an object and
  3802. * a method.
  3803. * </p>
  3804. * @param arg mixed[optional] <p>
  3805. * </p>
  3806. * @param _ mixed[optional]
  3807. * @return bool Returns true on success or false on failure.
  3808. */
  3809. function register_tick_function ($function, $arg = null, $_ = null) {}
  3810. /**
  3811. * De-register a function for execution on each tick
  3812. * @link http://www.php.net/manual/en/function.unregister-tick-function.php
  3813. * @param function_name string <p>
  3814. * The function name, as a string.
  3815. * </p>
  3816. * @return void
  3817. */
  3818. function unregister_tick_function ($function_name) {}
  3819. /**
  3820. * Syntax highlighting of a file
  3821. * @link http://www.php.net/manual/en/function.highlight-file.php
  3822. * @param filename string <p>
  3823. * Path to the PHP file to be highlighted.
  3824. * </p>
  3825. * @param return bool[optional] <p>
  3826. * Set this parameter to true to make this function return the
  3827. * highlighted code.
  3828. * </p>
  3829. * @return mixed If return is set to true, returns the highlighted
  3830. * code as a string instead of printing it out. Otherwise, it will return
  3831. * true on success, false on failure.
  3832. */
  3833. function highlight_file ($filename, $return = null) {}
  3834. /**
  3835. * &Alias; <function>highlight_file</function>
  3836. * @link http://www.php.net/manual/en/function.show-source.php
  3837. * @param file_name
  3838. * @param return[optional]
  3839. */
  3840. function show_source ($file_name, $return) {}
  3841. /**
  3842. * Syntax highlighting of a string
  3843. * @link http://www.php.net/manual/en/function.highlight-string.php
  3844. * @param str string <p>
  3845. * The PHP code to be highlighted. This should include the opening tag.
  3846. * </p>
  3847. * @param return bool[optional] <p>
  3848. * Set this parameter to true to make this function return the
  3849. * highlighted code.
  3850. * </p>
  3851. * @return mixed If return is set to true, returns the highlighted
  3852. * code as a string instead of printing it out. Otherwise, it will return
  3853. * true on success, false on failure.
  3854. */
  3855. function highlight_string ($str, $return = null) {}
  3856. /**
  3857. * Return source with stripped comments and whitespace
  3858. * @link http://www.php.net/manual/en/function.php-strip-whitespace.php
  3859. * @param filename string <p>
  3860. * Path to the PHP file.
  3861. * </p>
  3862. * @return string The stripped source code will be returned on success, or an empty string
  3863. * on failure.
  3864. * </p>
  3865. * <p>
  3866. * This function works as described as of PHP 5.0.1. Before this it would
  3867. * only return an empty string. For more information on this bug and its
  3868. * prior behavior, see bug report
  3869. * #29606.
  3870. */
  3871. function php_strip_whitespace ($filename) {}
  3872. /**
  3873. * Gets the value of a configuration option
  3874. * @link http://www.php.net/manual/en/function.ini-get.php
  3875. * @param varname string <p>
  3876. * The configuration option name.
  3877. * </p>
  3878. * @return string the value of the configuration option as a string on success, or
  3879. * an empty string on failure or for null values.
  3880. */
  3881. function ini_get ($varname) {}
  3882. /**
  3883. * Gets all configuration options
  3884. * @link http://www.php.net/manual/en/function.ini-get-all.php
  3885. * @param extension string[optional] <p>
  3886. * An optional extension name. If set, the function return only options
  3887. * specific for that extension.
  3888. * </p>
  3889. * @param details bool[optional] <p>
  3890. * Retrieve details settings or only the current value for each setting.
  3891. * Default is true (retrieve details).
  3892. * </p>
  3893. * @return array an associative array with directive name as the array key.
  3894. * </p>
  3895. * <p>
  3896. * When details is true (default) the array will
  3897. * contain global_value (set in
  3898. * &php.ini;), local_value (perhaps set with
  3899. * ini_set or &htaccess;), and
  3900. * access (the access level).
  3901. * </p>
  3902. * <p>
  3903. * When details is false the value will be the
  3904. * current value of the option.
  3905. * </p>
  3906. * <p>
  3907. * See the manual section
  3908. * for information on what access levels mean.
  3909. * </p>
  3910. * <p>
  3911. * It's possible for a directive to have multiple access levels, which is
  3912. * why access shows the appropriate bitmask values.
  3913. */
  3914. function ini_get_all ($extension = null, $details = null) {}
  3915. /**
  3916. * Sets the value of a configuration option
  3917. * @link http://www.php.net/manual/en/function.ini-set.php
  3918. * @param varname string <p>
  3919. * </p>
  3920. * <p>
  3921. * Not all the available options can be changed using
  3922. * ini_set. There is a list of all available options
  3923. * in the appendix.
  3924. * </p>
  3925. * @param newvalue string <p>
  3926. * The new value for the option.
  3927. * </p>
  3928. * @return string the old value on success, false on failure.
  3929. */
  3930. function ini_set ($varname, $newvalue) {}
  3931. /**
  3932. * &Alias; <function>ini_set</function>
  3933. * @link http://www.php.net/manual/en/function.ini-alter.php
  3934. * @param varname
  3935. * @param newvalue
  3936. */
  3937. function ini_alter ($varname, $newvalue) {}
  3938. /**
  3939. * Restores the value of a configuration option
  3940. * @link http://www.php.net/manual/en/function.ini-restore.php
  3941. * @param varname string <p>
  3942. * The configuration option name.
  3943. * </p>
  3944. * @return void
  3945. */
  3946. function ini_restore ($varname) {}
  3947. /**
  3948. * Gets the current include_path configuration option
  3949. * @link http://www.php.net/manual/en/function.get-include-path.php
  3950. * @return string the path, as a string.
  3951. */
  3952. function get_include_path () {}
  3953. /**
  3954. * Sets the include_path configuration option
  3955. * @link http://www.php.net/manual/en/function.set-include-path.php
  3956. * @param new_include_path string <p>
  3957. * The new value for the include_path
  3958. * </p>
  3959. * @return string the old include_path on
  3960. * success&return.falseforfailure;.
  3961. */
  3962. function set_include_path ($new_include_path) {}
  3963. /**
  3964. * Restores the value of the include_path configuration option
  3965. * @link http://www.php.net/manual/en/function.restore-include-path.php
  3966. * @return void
  3967. */
  3968. function restore_include_path () {}
  3969. /**
  3970. * Send a cookie
  3971. * @link http://www.php.net/manual/en/function.setcookie.php
  3972. * @param name string <p>
  3973. * The name of the cookie.
  3974. * </p>
  3975. * @param value string[optional] <p>
  3976. * The value of the cookie. This value is stored on the clients
  3977. * computer; do not store sensitive information.
  3978. * Assuming the name is 'cookiename', this
  3979. * value is retrieved through $_COOKIE['cookiename']
  3980. * </p>
  3981. * @param expire int[optional] <p>
  3982. * The time the cookie expires. This is a Unix timestamp so is
  3983. * in number of seconds since the epoch. In other words, you'll
  3984. * most likely set this with the time function
  3985. * plus the number of seconds before you want it to expire. Or
  3986. * you might use mktime.
  3987. * time()+60*60*24*30 will set the cookie to
  3988. * expire in 30 days. If set to 0, or omitted, the cookie will expire at
  3989. * the end of the session (when the browser closes).
  3990. * </p>
  3991. * <p>
  3992. * <p>
  3993. * You may notice the expire parameter takes on a
  3994. * Unix timestamp, as opposed to the date format Wdy, DD-Mon-YYYY
  3995. * HH:MM:SS GMT, this is because PHP does this conversion
  3996. * internally.
  3997. * </p>
  3998. * <p>
  3999. * expire is compared to the client's time which can
  4000. * differ from server's time.
  4001. * </p>
  4002. * </p>
  4003. * @param path string[optional] <p>
  4004. * The path on the server in which the cookie will be available on.
  4005. * If set to '/', the cookie will be available
  4006. * within the entire domain. If set to
  4007. * '/foo/', the cookie will only be available
  4008. * within the /foo/ directory and all
  4009. * sub-directories such as /foo/bar/ of
  4010. * domain. The default value is the
  4011. * current directory that the cookie is being set in.
  4012. * </p>
  4013. * @param domain string[optional] <p>
  4014. * The domain that the cookie is available.
  4015. * To make the cookie available on all subdomains of example.com
  4016. * then you'd set it to '.example.com'. The
  4017. * . is not required but makes it compatible
  4018. * with more browsers. Setting it to www.example.com
  4019. * will make the cookie only available in the www
  4020. * subdomain. Refer to tail matching in the
  4021. * spec for details.
  4022. * </p>
  4023. * @param secure bool[optional] <p>
  4024. * Indicates that the cookie should only be transmitted over a
  4025. * secure HTTPS connection from the client. When set to true, the
  4026. * cookie will only be set if a secure connection exists.
  4027. * On the server-side, it's on the programmer to send this
  4028. * kind of cookie only on secure connection (e.g. with respect to
  4029. * $_SERVER["HTTPS"]).
  4030. * </p>
  4031. * @param httponly bool[optional] <p>
  4032. * When true the cookie will be made accessible only through the HTTP
  4033. * protocol. This means that the cookie won't be accessible by
  4034. * scripting languages, such as JavaScript. This setting can effectively
  4035. * help to reduce identity theft through XSS attacks (although it is
  4036. * not supported by all browsers). Added in PHP 5.2.0.
  4037. * true or false
  4038. * </p>
  4039. * @return bool If output exists prior to calling this function,
  4040. * setcookie will fail and return false. If
  4041. * setcookie successfully runs, it will return true.
  4042. * This does not indicate whether the user accepted the cookie.
  4043. */
  4044. function setcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  4045. /**
  4046. * Send a cookie without urlencoding the cookie value
  4047. * @link http://www.php.net/manual/en/function.setrawcookie.php
  4048. * @param name string
  4049. * @param value string[optional]
  4050. * @param expire int[optional]
  4051. * @param path string[optional]
  4052. * @param domain string[optional]
  4053. * @param secure bool[optional]
  4054. * @param httponly bool[optional]
  4055. * @return bool Returns true on success or false on failure.
  4056. */
  4057. function setrawcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  4058. /**
  4059. * Send a raw HTTP header
  4060. * @link http://www.php.net/manual/en/function.header.php
  4061. * @param string string <p>
  4062. * The header string.
  4063. * </p>
  4064. * <p>
  4065. * There are two special-case header calls. The first is a header
  4066. * that starts with the string "HTTP/" (case is not
  4067. * significant), which will be used to figure out the HTTP status
  4068. * code to send. For example, if you have configured Apache to
  4069. * use a PHP script to handle requests for missing files (using
  4070. * the ErrorDocument directive), you may want to
  4071. * make sure that your script generates the proper status code.
  4072. * </p>
  4073. * <p>
  4074. * ]]>
  4075. * </p>
  4076. * <p>
  4077. * The second special case is the "Location:" header. Not only does
  4078. * it send this header back to the browser, but it also returns a
  4079. * REDIRECT (302) status code to the browser
  4080. * unless the 201 or
  4081. * a 3xx status code has already been set.
  4082. * </p>
  4083. * <p>
  4084. * ]]>
  4085. * </p>
  4086. * @param replace bool[optional] <p>
  4087. * The optional replace parameter indicates
  4088. * whether the header should replace a previous similar header, or
  4089. * add a second header of the same type. By default it will replace,
  4090. * but if you pass in false as the second argument you can force
  4091. * multiple headers of the same type. For example:
  4092. * </p>
  4093. * <p>
  4094. * ]]>
  4095. * </p>
  4096. * @param http_response_code int[optional] <p>
  4097. * Forces the HTTP response code to the specified value.
  4098. * </p>
  4099. * @return void
  4100. */
  4101. function header ($string, $replace = null, $http_response_code = null) {}
  4102. /**
  4103. * Remove previously set headers
  4104. * @link http://www.php.net/manual/en/function.header-remove.php
  4105. * @param name string[optional] <p>
  4106. * The header name to be removed.
  4107. * </p>
  4108. * This parameter is case-insensitive.
  4109. * @return void
  4110. */
  4111. function header_remove ($name = null) {}
  4112. /**
  4113. * Checks if or where headers have been sent
  4114. * @link http://www.php.net/manual/en/function.headers-sent.php
  4115. * @param file string[optional] <p>
  4116. * If the optional file and
  4117. * line parameters are set,
  4118. * headers_sent will put the PHP source file name
  4119. * and line number where output started in the file
  4120. * and line variables.
  4121. * </p>
  4122. * @param line int[optional] <p>
  4123. * The line number where the output started.
  4124. * </p>
  4125. * @return bool headers_sent will return false if no HTTP headers
  4126. * have already been sent or true otherwise.
  4127. */
  4128. function headers_sent (&$file = null, &$line = null) {}
  4129. /**
  4130. * Returns a list of response headers sent (or ready to send)
  4131. * @link http://www.php.net/manual/en/function.headers-list.php
  4132. * @return array a numerically indexed array of headers.
  4133. */
  4134. function headers_list () {}
  4135. /**
  4136. * Check whether client disconnected
  4137. * @link http://www.php.net/manual/en/function.connection-aborted.php
  4138. * @return int 1 if client disconnected, 0 otherwise.
  4139. */
  4140. function connection_aborted () {}
  4141. /**
  4142. * Returns connection status bitfield
  4143. * @link http://www.php.net/manual/en/function.connection-status.php
  4144. * @return int the connection status bitfield, which can be used against the
  4145. * CONNECTION_XXX constants to determine the connection
  4146. * status.
  4147. */
  4148. function connection_status () {}
  4149. /**
  4150. * Set whether a client disconnect should abort script execution
  4151. * @link http://www.php.net/manual/en/function.ignore-user-abort.php
  4152. * @param value string[optional] <p>
  4153. * If set, this function will set the ignore_user_abort ini setting
  4154. * to the given value. If not, this function will
  4155. * only return the previous setting without changing it.
  4156. * </p>
  4157. * @return int the previous setting, as an integer.
  4158. */
  4159. function ignore_user_abort ($value = null) {}
  4160. /**
  4161. * Parse a configuration file
  4162. * @link http://www.php.net/manual/en/function.parse-ini-file.php
  4163. * @param filename string <p>
  4164. * The filename of the ini file being parsed.
  4165. * </p>
  4166. * @param process_sections bool[optional] <p>
  4167. * By setting the process_sections
  4168. * parameter to true, you get a multidimensional array, with
  4169. * the section names and settings included. The default
  4170. * for process_sections is false
  4171. * </p>
  4172. * @param scanner_mode int[optional] <p>
  4173. * Can either be INI_SCANNER_NORMAL (default) or
  4174. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  4175. * is supplied, then option values will not be parsed.
  4176. * </p>
  4177. * @return array The settings are returned as an associative array on success,
  4178. * and false on failure.
  4179. */
  4180. function parse_ini_file ($filename, $process_sections = null, $scanner_mode = null) {}
  4181. /**
  4182. * Parse a configuration string
  4183. * @link http://www.php.net/manual/en/function.parse-ini-string.php
  4184. * @param ini string <p>
  4185. * The contents of the ini file being parsed.
  4186. * </p>
  4187. * @param process_sections bool[optional] <p>
  4188. * By setting the process_sections
  4189. * parameter to true, you get a multidimensional array, with
  4190. * the section names and settings included. The default
  4191. * for process_sections is false
  4192. * </p>
  4193. * @param scanner_mode int[optional] <p>
  4194. * Can either be INI_SCANNER_NORMAL (default) or
  4195. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  4196. * is supplied, then option values will not be parsed.
  4197. * </p>
  4198. * @return array The settings are returned as an associative array on success,
  4199. * and false on failure.
  4200. */
  4201. function parse_ini_string ($ini, $process_sections = null, $scanner_mode = null) {}
  4202. /**
  4203. * Tells whether the file was uploaded via HTTP POST
  4204. * @link http://www.php.net/manual/en/function.is-uploaded-file.php
  4205. * @param filename string <p>
  4206. * The filename being checked.
  4207. * </p>
  4208. * @return bool Returns true on success or false on failure.
  4209. */
  4210. function is_uploaded_file ($filename) {}
  4211. /**
  4212. * Moves an uploaded file to a new location
  4213. * @link http://www.php.net/manual/en/function.move-uploaded-file.php
  4214. * @param filename string <p>
  4215. * The filename of the uploaded file.
  4216. * </p>
  4217. * @param destination string <p>
  4218. * The destination of the moved file.
  4219. * </p>
  4220. * @return bool If filename is not a valid upload file,
  4221. * then no action will occur, and
  4222. * move_uploaded_file will return
  4223. * false.
  4224. * </p>
  4225. * <p>
  4226. * If filename is a valid upload file, but
  4227. * cannot be moved for some reason, no action will occur, and
  4228. * move_uploaded_file will return
  4229. * false. Additionally, a warning will be issued.
  4230. */
  4231. function move_uploaded_file ($filename, $destination) {}
  4232. /**
  4233. * Get the Internet host name corresponding to a given IP address
  4234. * @link http://www.php.net/manual/en/function.gethostbyaddr.php
  4235. * @param ip_address string <p>
  4236. * The host IP address.
  4237. * </p>
  4238. * @return string the host name or the unmodified ip_address
  4239. * on failure.
  4240. */
  4241. function gethostbyaddr ($ip_address) {}
  4242. /**
  4243. * Get the IPv4 address corresponding to a given Internet host name
  4244. * @link http://www.php.net/manual/en/function.gethostbyname.php
  4245. * @param hostname string <p>
  4246. * The host name.
  4247. * </p>
  4248. * @return string the IPv4 address or a string containing the unmodified
  4249. * hostname on failure.
  4250. */
  4251. function gethostbyname ($hostname) {}
  4252. /**
  4253. * Get a list of IPv4 addresses corresponding to a given Internet host
  4254. name
  4255. * @link http://www.php.net/manual/en/function.gethostbynamel.php
  4256. * @param hostname string <p>
  4257. * The host name.
  4258. * </p>
  4259. * @return array an array of IPv4 addresses or false if
  4260. * hostname could not be resolved.
  4261. */
  4262. function gethostbynamel ($hostname) {}
  4263. /**
  4264. * Gets the host name
  4265. * @link http://www.php.net/manual/en/function.gethostname.php
  4266. * @return string a string with the hostname on success, otherwise false is
  4267. * returned.
  4268. */
  4269. function gethostname () {}
  4270. /**
  4271. * &Alias; <function>checkdnsrr</function>
  4272. * @link http://www.php.net/manual/en/function.dns-check-record.php
  4273. * @param host
  4274. * @param type[optional]
  4275. */
  4276. function dns_check_record ($host, $type) {}
  4277. /**
  4278. * Check DNS records corresponding to a given Internet host name or IP address
  4279. * @link http://www.php.net/manual/en/function.checkdnsrr.php
  4280. * @param host string <p>
  4281. * host may either be the IP address in
  4282. * dotted-quad notation or the host name.
  4283. * </p>
  4284. * @param type string[optional] <p>
  4285. * type may be any one of: A, MX, NS, SOA,
  4286. * PTR, CNAME, AAAA, A6, SRV, NAPTR, TXT or ANY.
  4287. * </p>
  4288. * @return bool true if any records are found; returns false if no records
  4289. * were found or if an error occurred.
  4290. */
  4291. function checkdnsrr ($host, $type = null) {}
  4292. /**
  4293. * &Alias; <function>getmxrr</function>
  4294. * @link http://www.php.net/manual/en/function.dns-get-mx.php
  4295. * @param hostname
  4296. * @param mxhosts
  4297. * @param weight[optional]
  4298. */
  4299. function dns_get_mx ($hostname, &$mxhosts, &$weight) {}
  4300. /**
  4301. * Get MX records corresponding to a given Internet host name
  4302. * @link http://www.php.net/manual/en/function.getmxrr.php
  4303. * @param hostname string <p>
  4304. * The Internet host name.
  4305. * </p>
  4306. * @param mxhosts array <p>
  4307. * A list of the MX records found is placed into the array
  4308. * mxhosts.
  4309. * </p>
  4310. * @param weight array[optional] <p>
  4311. * If the weight array is given, it will be filled
  4312. * with the weight information gathered.
  4313. * </p>
  4314. * @return bool true if any records are found; returns false if no records
  4315. * were found or if an error occurred.
  4316. */
  4317. function getmxrr ($hostname, array &$mxhosts, array &$weight = null) {}
  4318. /**
  4319. * Fetch DNS Resource Records associated with a hostname
  4320. * @link http://www.php.net/manual/en/function.dns-get-record.php
  4321. * @param hostname string <p>
  4322. * hostname should be a valid DNS hostname such
  4323. * as "www.example.com". Reverse lookups can be generated
  4324. * using in-addr.arpa notation, but
  4325. * gethostbyaddr is more suitable for
  4326. * the majority of reverse lookups.
  4327. * </p>
  4328. * <p>
  4329. * Per DNS standards, email addresses are given in user.host format (for
  4330. * example: hostmaster.example.com as opposed to hostmaster@example.com),
  4331. * be sure to check this value and modify if necessary before using it
  4332. * with a functions such as mail.
  4333. * </p>
  4334. * @param type int[optional] <p>
  4335. * By default, dns_get_record will search for any
  4336. * resource records associated with hostname.
  4337. * To limit the query, specify the optional type
  4338. * parameter. May be any one of the following:
  4339. * DNS_A, DNS_CNAME,
  4340. * DNS_HINFO, DNS_MX,
  4341. * DNS_NS, DNS_PTR,
  4342. * DNS_SOA, DNS_TXT,
  4343. * DNS_AAAA, DNS_SRV,
  4344. * DNS_NAPTR, DNS_A6,
  4345. * DNS_ALL or DNS_ANY.
  4346. * </p>
  4347. * <p>
  4348. * Because of eccentricities in the performance of libresolv
  4349. * between platforms, DNS_ANY will not
  4350. * always return every record, the slower DNS_ALL
  4351. * will collect all records more reliably.
  4352. * </p>
  4353. * @param authns array[optional] <p>
  4354. * Passed by reference and, if given, will be populated with Resource
  4355. * Records for the Authoritative Name Servers.
  4356. * </p>
  4357. * @param addtl array[optional] <p>
  4358. * Passed by reference and, if given, will be populated with any
  4359. * Additional Records.
  4360. * </p>
  4361. * @return array This function returns an array of associative arrays. Each associative array contains
  4362. * at minimum the following keys:
  4363. * <table>
  4364. * Basic DNS attributes
  4365. * <tr valign="top">
  4366. * <td>Attribute</td>
  4367. * <td>Meaning</td>
  4368. * </tr>
  4369. * <tr valign="top">
  4370. * <td>host</td>
  4371. * <td>
  4372. * The record in the DNS namespace to which the rest of the associated data refers.
  4373. * </td>
  4374. * </tr>
  4375. * <tr valign="top">
  4376. * <td>class</td>
  4377. * <td>
  4378. * dns_get_record only returns Internet class records and as
  4379. * such this parameter will always return IN.
  4380. * </td>
  4381. * </tr>
  4382. * <tr valign="top">
  4383. * <td>type</td>
  4384. * <td>
  4385. * String containing the record type. Additional attributes will also be contained
  4386. * in the resulting array dependant on the value of type. See table below.
  4387. * </td>
  4388. * </tr>
  4389. * <tr valign="top">
  4390. * <td>ttl</td>
  4391. * <td>
  4392. * "Time To Live" remaining for this record. This will not equal
  4393. * the record's original ttl, but will rather equal the original ttl minus whatever
  4394. * length of time has passed since the authoritative name server was queried.
  4395. * </td>
  4396. * </tr>
  4397. * </table>
  4398. * </p>
  4399. * <p>
  4400. * <table>
  4401. * Other keys in associative arrays dependant on 'type'
  4402. * <tr valign="top">
  4403. * <td>Type</td>
  4404. * <td>Extra Columns</td>
  4405. * </tr>
  4406. * <tr valign="top">
  4407. * <td>A</td>
  4408. * <td>
  4409. * ip: An IPv4 addresses in dotted decimal notation.
  4410. * </td>
  4411. * </tr>
  4412. * <tr valign="top">
  4413. * <td>MX</td>
  4414. * <td>
  4415. * pri: Priority of mail exchanger.
  4416. * Lower numbers indicate greater priority.
  4417. * target: FQDN of the mail exchanger.
  4418. * See also dns_get_mx.
  4419. * </td>
  4420. * </tr>
  4421. * <tr valign="top">
  4422. * <td>CNAME</td>
  4423. * <td>
  4424. * target: FQDN of location in DNS namespace to which
  4425. * the record is aliased.
  4426. * </td>
  4427. * </tr>
  4428. * <tr valign="top">
  4429. * <td>NS</td>
  4430. * <td>
  4431. * target: FQDN of the name server which is authoritative
  4432. * for this hostname.
  4433. * </td>
  4434. * </tr>
  4435. * <tr valign="top">
  4436. * <td>PTR</td>
  4437. * <td>
  4438. * target: Location within the DNS namespace to which
  4439. * this record points.
  4440. * </td>
  4441. * </tr>
  4442. * <tr valign="top">
  4443. * <td>TXT</td>
  4444. * <td>
  4445. * txt: Arbitrary string data associated with this record.
  4446. * </td>
  4447. * </tr>
  4448. * <tr valign="top">
  4449. * <td>HINFO</td>
  4450. * <td>
  4451. * cpu: IANA number designating the CPU of the machine
  4452. * referenced by this record.
  4453. * os: IANA number designating the Operating System on
  4454. * the machine referenced by this record.
  4455. * See IANA's Operating System
  4456. * Names for the meaning of these values.
  4457. * </td>
  4458. * </tr>
  4459. * <tr valign="top">
  4460. * <td>SOA</td>
  4461. * <td>
  4462. * mname: FQDN of the machine from which the resource
  4463. * records originated.
  4464. * rname: Email address of the administrative contain
  4465. * for this domain.
  4466. * serial: Serial # of this revision of the requested
  4467. * domain.
  4468. * refresh: Refresh interval (seconds) secondary name
  4469. * servers should use when updating remote copies of this domain.
  4470. * retry: Length of time (seconds) to wait after a
  4471. * failed refresh before making a second attempt.
  4472. * expire: Maximum length of time (seconds) a secondary
  4473. * DNS server should retain remote copies of the zone data without a
  4474. * successful refresh before discarding.
  4475. * minimum-ttl: Minimum length of time (seconds) a
  4476. * client can continue to use a DNS resolution before it should request
  4477. * a new resolution from the server. Can be overridden by individual
  4478. * resource records.
  4479. * </td>
  4480. * </tr>
  4481. * <tr valign="top">
  4482. * <td>AAAA</td>
  4483. * <td>
  4484. * ipv6: IPv6 address
  4485. * </td>
  4486. * </tr>
  4487. * <tr valign="top">
  4488. * <td>A6(PHP &gt;= 5.1.0)</td>
  4489. * <td>
  4490. * masklen: Length (in bits) to inherit from the target
  4491. * specified by chain.
  4492. * ipv6: Address for this specific record to merge with
  4493. * chain.
  4494. * chain: Parent record to merge with
  4495. * ipv6 data.
  4496. * </td>
  4497. * </tr>
  4498. * <tr valign="top">
  4499. * <td>SRV</td>
  4500. * <td>
  4501. * pri: (Priority) lowest priorities should be used first.
  4502. * weight: Ranking to weight which of commonly prioritized
  4503. * targets should be chosen at random.
  4504. * target and port: hostname and port
  4505. * where the requested service can be found.
  4506. * For additional information see: RFC 2782
  4507. * </td>
  4508. * </tr>
  4509. * <tr valign="top">
  4510. * <td>NAPTR</td>
  4511. * <td>
  4512. * order and pref: Equivalent to
  4513. * pri and weight above.
  4514. * flags, services, regex,
  4515. * and replacement: Parameters as defined by
  4516. * RFC 2915.
  4517. * </td>
  4518. * </tr>
  4519. * </table>
  4520. */
  4521. function dns_get_record ($hostname, $type = null, array &$authns = null, array &$addtl = null) {}
  4522. /**
  4523. * Get the integer value of a variable
  4524. * @link http://www.php.net/manual/en/function.intval.php
  4525. * @param var mixed <p>
  4526. * The scalar value being converted to an integer
  4527. * </p>
  4528. * @param base int[optional] <p>
  4529. * The base for the conversion
  4530. * </p>
  4531. * @return int The integer value of var on success, or 0 on
  4532. * failure. Empty arrays and objects return 0, non-empty arrays and
  4533. * objects return 1.
  4534. * </p>
  4535. * <p>
  4536. * The maximum value depends on the system. 32 bit systems have a
  4537. * maximum signed integer range of -2147483648 to 2147483647. So for example
  4538. * on such a system, intval('1000000000000') will return
  4539. * 2147483647. The maximum signed integer value for 64 bit systems is
  4540. * 9223372036854775807.
  4541. * </p>
  4542. * <p>
  4543. * Strings will most likely return 0 although this depends on the
  4544. * leftmost characters of the string. The common rules of
  4545. * integer casting
  4546. * apply.
  4547. */
  4548. function intval ($var, $base = null) {}
  4549. /**
  4550. * Get float value of a variable
  4551. * @link http://www.php.net/manual/en/function.floatval.php
  4552. * @param var mixed <p>
  4553. * May be any scalar type. floatval should not be used
  4554. * on objects, as doing so will emit an E_NOTICE level
  4555. * error and return 1.
  4556. * </p>
  4557. * @return float The float value of the given variable. Empty arrays return 0, non-empty
  4558. * arrays return 1.
  4559. */
  4560. function floatval ($var) {}
  4561. /**
  4562. * &Alias; <function>floatval</function>
  4563. * @link http://www.php.net/manual/en/function.doubleval.php
  4564. * @param var
  4565. */
  4566. function doubleval ($var) {}
  4567. /**
  4568. * Get string value of a variable
  4569. * @link http://www.php.net/manual/en/function.strval.php
  4570. * @param var mixed <p>
  4571. * The variable that is being converted to a string.
  4572. * </p>
  4573. * <p>
  4574. * var may be any scalar type. You cannot use
  4575. * strval on arrays or objects.
  4576. * </p>
  4577. * @return string The string value of var.
  4578. */
  4579. function strval ($var) {}
  4580. /**
  4581. * Get the type of a variable
  4582. * @link http://www.php.net/manual/en/function.gettype.php
  4583. * @param var mixed <p>
  4584. * The variable being type checked.
  4585. * </p>
  4586. * @return string Possibles values for the returned string are:
  4587. * "boolean"
  4588. * "integer"
  4589. * "double" (for historical reasons "double" is
  4590. * returned in case of a float, and not simply
  4591. * "float")
  4592. * "string"
  4593. * "array"
  4594. * "object"
  4595. * "resource"
  4596. * "NULL"
  4597. * "unknown type"
  4598. */
  4599. function gettype ($var) {}
  4600. /**
  4601. * Set the type of a variable
  4602. * @link http://www.php.net/manual/en/function.settype.php
  4603. * @param var mixed <p>
  4604. * The variable being converted.
  4605. * </p>
  4606. * @param type string <p>
  4607. * Possibles values of type are:
  4608. * "boolean" (or, since PHP 4.2.0, "bool")
  4609. * @return bool Returns true on success or false on failure.
  4610. */
  4611. function settype (&$var, $type) {}
  4612. /**
  4613. * Finds whether a variable is &null;
  4614. * @link http://www.php.net/manual/en/function.is-null.php
  4615. * @param var mixed <p>
  4616. * The variable being evaluated.
  4617. * </p>
  4618. * @return bool true if var is null, false
  4619. * otherwise.
  4620. */
  4621. function is_null ($var) {}
  4622. /**
  4623. * Finds whether a variable is a resource
  4624. * @link http://www.php.net/manual/en/function.is-resource.php
  4625. * @param var mixed <p>
  4626. * The variable being evaluated.
  4627. * </p>
  4628. * @return bool true if var is a resource,
  4629. * false otherwise.
  4630. */
  4631. function is_resource ($var) {}
  4632. /**
  4633. * Finds out whether a variable is a boolean
  4634. * @link http://www.php.net/manual/en/function.is-bool.php
  4635. * @param var mixed <p>
  4636. * The variable being evaluated.
  4637. * </p>
  4638. * @return bool true if var is a boolean,
  4639. * false otherwise.
  4640. */
  4641. function is_bool ($var) {}
  4642. /**
  4643. * &Alias; <function>is_int</function>
  4644. * @link http://www.php.net/manual/en/function.is-long.php
  4645. * @param var
  4646. */
  4647. function is_long ($var) {}
  4648. /**
  4649. * Finds whether the type of a variable is float
  4650. * @link http://www.php.net/manual/en/function.is-float.php
  4651. * @param var mixed <p>
  4652. * The variable being evaluated.
  4653. * </p>
  4654. * @return bool true if var is a float,
  4655. * false otherwise.
  4656. */
  4657. function is_float ($var) {}
  4658. /**
  4659. * Find whether the type of a variable is integer
  4660. * @link http://www.php.net/manual/en/function.is-int.php
  4661. * @param var mixed <p>
  4662. * The variable being evaluated.
  4663. * </p>
  4664. * @return bool true if var is an integer,
  4665. * false otherwise.
  4666. */
  4667. function is_int ($var) {}
  4668. /**
  4669. * &Alias; <function>is_int</function>
  4670. * @link http://www.php.net/manual/en/function.is-integer.php
  4671. * @param var
  4672. */
  4673. function is_integer ($var) {}
  4674. /**
  4675. * &Alias; <function>is_float</function>
  4676. * @link http://www.php.net/manual/en/function.is-double.php
  4677. * @param var
  4678. */
  4679. function is_double ($var) {}
  4680. /**
  4681. * &Alias; <function>is_float</function>
  4682. * @link http://www.php.net/manual/en/function.is-real.php
  4683. * @param var
  4684. */
  4685. function is_real ($var) {}
  4686. /**
  4687. * Finds whether a variable is a number or a numeric string
  4688. * @link http://www.php.net/manual/en/function.is-numeric.php
  4689. * @param var mixed <p>
  4690. * The variable being evaluated.
  4691. * </p>
  4692. * @return bool true if var is a number or a numeric
  4693. * string, false otherwise.
  4694. */
  4695. function is_numeric ($var) {}
  4696. /**
  4697. * Find whether the type of a variable is string
  4698. * @link http://www.php.net/manual/en/function.is-string.php
  4699. * @param var mixed <p>
  4700. * The variable being evaluated.
  4701. * </p>
  4702. * @return bool true if var is of type string,
  4703. * false otherwise.
  4704. */
  4705. function is_string ($var) {}
  4706. /**
  4707. * Finds whether a variable is an array
  4708. * @link http://www.php.net/manual/en/function.is-array.php
  4709. * @param var mixed <p>
  4710. * The variable being evaluated.
  4711. * </p>
  4712. * @return bool true if var is an array,
  4713. * false otherwise.
  4714. */
  4715. function is_array ($var) {}
  4716. /**
  4717. * Finds whether a variable is an object
  4718. * @link http://www.php.net/manual/en/function.is-object.php
  4719. * @param var mixed <p>
  4720. * The variable being evaluated.
  4721. * </p>
  4722. * @return bool true if var is an object,
  4723. * false otherwise.
  4724. */
  4725. function is_object ($var) {}
  4726. /**
  4727. * Finds whether a variable is a scalar
  4728. * @link http://www.php.net/manual/en/function.is-scalar.php
  4729. * @param var mixed <p>
  4730. * The variable being evaluated.
  4731. * </p>
  4732. * @return bool true if var is a scalar false
  4733. * otherwise.
  4734. */
  4735. function is_scalar ($var) {}
  4736. /**
  4737. * Verify that the contents of a variable can be called as a function
  4738. * @link http://www.php.net/manual/en/function.is-callable.php
  4739. * @param name callback <p>
  4740. * Can be either the name of a function stored in a string variable, or
  4741. * an object and the name of a method within the object, like this:
  4742. * array($SomeObject, 'MethodName')
  4743. * </p>
  4744. * @param syntax_only bool[optional] <p>
  4745. * If set to true the function only verifies that
  4746. * name might be a function or method. It will only
  4747. * reject simple variables that are not strings, or an array that does
  4748. * not have a valid structure to be used as a callback. The valid ones
  4749. * are supposed to have only 2 entries, the first of which is an object
  4750. * or a string, and the second a string.
  4751. * </p>
  4752. * @param callable_name string[optional] <p>
  4753. * Receives the "callable name". In the example below it is
  4754. * "someClass::someMethod". Note, however, that despite the implication
  4755. * that someClass::SomeMethod() is a callable static method, this is not
  4756. * the case.
  4757. * </p>
  4758. * @return bool true if name is callable, false
  4759. * otherwise.
  4760. */
  4761. function is_callable ($name, $syntax_only = null, &$callable_name = null) {}
  4762. /**
  4763. * Closes process file pointer
  4764. * @link http://www.php.net/manual/en/function.pclose.php
  4765. * @param handle resource <p>
  4766. * The file pointer must be valid, and must have been returned by a
  4767. * successful call to popen.
  4768. * </p>
  4769. * @return int the termination status of the process that was run.
  4770. */
  4771. function pclose ($handle) {}
  4772. /**
  4773. * Opens process file pointer
  4774. * @link http://www.php.net/manual/en/function.popen.php
  4775. * @param command string <p>
  4776. * The command
  4777. * </p>
  4778. * @param mode string <p>
  4779. * The mode
  4780. * </p>
  4781. * @return resource a file pointer identical to that returned by
  4782. * fopen, except that it is unidirectional (may
  4783. * only be used for reading or writing) and must be closed with
  4784. * pclose. This pointer may be used with
  4785. * fgets, fgetss, and
  4786. * fwrite.
  4787. * </p>
  4788. * <p>
  4789. * If an error occurs, returns false.
  4790. */
  4791. function popen ($command, $mode) {}
  4792. /**
  4793. * Outputs a file
  4794. * @link http://www.php.net/manual/en/function.readfile.php
  4795. * @param filename string <p>
  4796. * The filename being read.
  4797. * </p>
  4798. * @param use_include_path bool[optional] <p>
  4799. * You can use the optional second parameter and set it to true, if
  4800. * you want to search for the file in the include_path, too.
  4801. * </p>
  4802. * @param context resource[optional] <p>
  4803. * A context stream resource.
  4804. * </p>
  4805. * @return int the number of bytes read from the file. If an error
  4806. * occurs, false is returned and unless the function was called as
  4807. * @readfile, an error message is printed.
  4808. */
  4809. function readfile ($filename, $use_include_path = null, $context = null) {}
  4810. /**
  4811. * Rewind the position of a file pointer
  4812. * @link http://www.php.net/manual/en/function.rewind.php
  4813. * @param handle resource <p>
  4814. * The file pointer must be valid, and must point to a file
  4815. * successfully opened by fopen.
  4816. * </p>
  4817. * @return bool Returns true on success or false on failure.
  4818. */
  4819. function rewind ($handle) {}
  4820. /**
  4821. * Removes directory
  4822. * @link http://www.php.net/manual/en/function.rmdir.php
  4823. * @param dirname string <p>
  4824. * Path to the directory.
  4825. * </p>
  4826. * @param context resource[optional] &note.context-support;
  4827. * @return bool Returns true on success or false on failure.
  4828. */
  4829. function rmdir ($dirname, $context = null) {}
  4830. /**
  4831. * Changes the current umask
  4832. * @link http://www.php.net/manual/en/function.umask.php
  4833. * @param mask int[optional] <p>
  4834. * The new umask.
  4835. * </p>
  4836. * @return int umask without arguments simply returns the
  4837. * current umask otherwise the old umask is returned.
  4838. */
  4839. function umask ($mask = null) {}
  4840. /**
  4841. * Closes an open file pointer
  4842. * @link http://www.php.net/manual/en/function.fclose.php
  4843. * @param handle resource <p>
  4844. * The file pointer must be valid, and must point to a file successfully
  4845. * opened by fopen or fsockopen.
  4846. * </p>
  4847. * @return bool Returns true on success or false on failure.
  4848. */
  4849. function fclose ($handle) {}
  4850. /**
  4851. * Tests for end-of-file on a file pointer
  4852. * @link http://www.php.net/manual/en/function.feof.php
  4853. * @param handle resource &fs.validfp.all;
  4854. * @return bool true if the file pointer is at EOF or an error occurs
  4855. * (including socket timeout); otherwise returns false.
  4856. */
  4857. function feof ($handle) {}
  4858. /**
  4859. * Gets character from file pointer
  4860. * @link http://www.php.net/manual/en/function.fgetc.php
  4861. * @param handle resource &fs.validfp.all;
  4862. * @return string a string containing a single character read from the file pointed
  4863. * to by handle. Returns false on EOF.
  4864. */
  4865. function fgetc ($handle) {}
  4866. /**
  4867. * Gets line from file pointer
  4868. * @link http://www.php.net/manual/en/function.fgets.php
  4869. * @param handle resource &fs.validfp.all;
  4870. * @param length int[optional] <p>
  4871. * Reading ends when length - 1 bytes have been
  4872. * read, on a newline (which is included in the return value), or on EOF
  4873. * (whichever comes first). If no length is specified, it will keep
  4874. * reading from the stream until it reaches the end of the line.
  4875. * </p>
  4876. * <p>
  4877. * Until PHP 4.3.0, omitting it would assume 1024 as the line length.
  4878. * If the majority of the lines in the file are all larger than 8KB,
  4879. * it is more resource efficient for your script to specify the maximum
  4880. * line length.
  4881. * </p>
  4882. * @return string a string of up to length - 1 bytes read from
  4883. * the file pointed to by handle.
  4884. * </p>
  4885. * <p>
  4886. * If an error occurs, returns false.
  4887. */
  4888. function fgets ($handle, $length = null) {}
  4889. /**
  4890. * Gets line from file pointer and strip HTML tags
  4891. * @link http://www.php.net/manual/en/function.fgetss.php
  4892. * @param handle resource &fs.validfp.all;
  4893. * @param length int[optional] <p>
  4894. * Length of the data to be retrieved.
  4895. * </p>
  4896. * @param allowable_tags string[optional] <p>
  4897. * You can use the optional third parameter to specify tags which should
  4898. * not be stripped.
  4899. * </p>
  4900. * @return string a string of up to length - 1 bytes read from
  4901. * the file pointed to by handle, with all HTML and PHP
  4902. * code stripped.
  4903. * </p>
  4904. * <p>
  4905. * If an error occurs, returns false.
  4906. */
  4907. function fgetss ($handle, $length = null, $allowable_tags = null) {}
  4908. /**
  4909. * Binary-safe file read
  4910. * @link http://www.php.net/manual/en/function.fread.php
  4911. * @param handle resource &fs.file.pointer;
  4912. * @param length int <p>
  4913. * Up to length number of bytes read.
  4914. * </p>
  4915. * @return string the read string &return.falseforfailure;.
  4916. */
  4917. function fread ($handle, $length) {}
  4918. /**
  4919. * Opens file or URL
  4920. * @link http://www.php.net/manual/en/function.fopen.php
  4921. * @param filename string <p>
  4922. * If filename is of the form "scheme://...", it
  4923. * is assumed to be a URL and PHP will search for a protocol handler
  4924. * (also known as a wrapper) for that scheme. If no wrappers for that
  4925. * protocol are registered, PHP will emit a notice to help you track
  4926. * potential problems in your script and then continue as though
  4927. * filename specifies a regular file.
  4928. * </p>
  4929. * <p>
  4930. * If PHP has decided that filename specifies
  4931. * a local file, then it will try to open a stream on that file.
  4932. * The file must be accessible to PHP, so you need to ensure that
  4933. * the file access permissions allow this access.
  4934. * If you have enabled &safemode;,
  4935. * or open_basedir further
  4936. * restrictions may apply.
  4937. * </p>
  4938. * <p>
  4939. * If PHP has decided that filename specifies
  4940. * a registered protocol, and that protocol is registered as a
  4941. * network URL, PHP will check to make sure that
  4942. * allow_url_fopen is
  4943. * enabled. If it is switched off, PHP will emit a warning and
  4944. * the fopen call will fail.
  4945. * </p>
  4946. * <p>
  4947. * The list of supported protocols can be found in . Some protocols (also referred to as
  4948. * wrappers) support context
  4949. * and/or &php.ini; options. Refer to the specific page for the
  4950. * protocol in use for a list of options which can be set. (e.g.
  4951. * &php.ini; value user_agent used by the
  4952. * http wrapper).
  4953. * </p>
  4954. * <p>
  4955. * On the Windows platform, be careful to escape any backslashes
  4956. * used in the path to the file, or use forward slashes.
  4957. * ]]>
  4958. * </p>
  4959. * @param mode string <p>
  4960. * The mode parameter specifies the type of access
  4961. * you require to the stream. It may be any of the following:
  4962. * <table>
  4963. * A list of possible modes for fopen
  4964. * using mode
  4965. * <tr valign="top">
  4966. * <td>mode</td>
  4967. * <td>Description</td>
  4968. * </tr>
  4969. * <tr valign="top">
  4970. * <td>'r'</td>
  4971. * <td>
  4972. * Open for reading only; place the file pointer at the
  4973. * beginning of the file.
  4974. * </td>
  4975. * </tr>
  4976. * <tr valign="top">
  4977. * <td>'r+'</td>
  4978. * <td>
  4979. * Open for reading and writing; place the file pointer at
  4980. * the beginning of the file.
  4981. * </td>
  4982. * </tr>
  4983. * <tr valign="top">
  4984. * <td>'w'</td>
  4985. * <td>
  4986. * Open for writing only; place the file pointer at the
  4987. * beginning of the file and truncate the file to zero length.
  4988. * If the file does not exist, attempt to create it.
  4989. * </td>
  4990. * </tr>
  4991. * <tr valign="top">
  4992. * <td>'w+'</td>
  4993. * <td>
  4994. * Open for reading and writing; place the file pointer at
  4995. * the beginning of the file and truncate the file to zero
  4996. * length. If the file does not exist, attempt to create it.
  4997. * </td>
  4998. * </tr>
  4999. * <tr valign="top">
  5000. * <td>'a'</td>
  5001. * <td>
  5002. * Open for writing only; place the file pointer at the end of
  5003. * the file. If the file does not exist, attempt to create it.
  5004. * </td>
  5005. * </tr>
  5006. * <tr valign="top">
  5007. * <td>'a+'</td>
  5008. * <td>
  5009. * Open for reading and writing; place the file pointer at
  5010. * the end of the file. If the file does not exist, attempt to
  5011. * create it.
  5012. * </td>
  5013. * </tr>
  5014. * <tr valign="top">
  5015. * <td>'x'</td>
  5016. * <td>
  5017. * Create and open for writing only; place the file pointer at the
  5018. * beginning of the file. If the file already exists, the
  5019. * fopen call will fail by returning false and
  5020. * generating an error of level E_WARNING. If
  5021. * the file does not exist, attempt to create it. This is equivalent
  5022. * to specifying O_EXCL|O_CREAT flags for the
  5023. * underlying open(2) system call.
  5024. * </td>
  5025. * </tr>
  5026. * <tr valign="top">
  5027. * <td>'x+'</td>
  5028. * <td>
  5029. * Create and open for reading and writing; place the file pointer at
  5030. * the beginning of the file. If the file already exists, the
  5031. * fopen call will fail by returning false and
  5032. * generating an error of level E_WARNING. If
  5033. * the file does not exist, attempt to create it. This is equivalent
  5034. * to specifying O_EXCL|O_CREAT flags for the
  5035. * underlying open(2) system call.
  5036. * </td>
  5037. * </tr>
  5038. * </table>
  5039. * </p>
  5040. * <p>
  5041. * Different operating system families have different line-ending
  5042. * conventions. When you write a text file and want to insert a line
  5043. * break, you need to use the correct line-ending character(s) for your
  5044. * operating system. Unix based systems use \n as the
  5045. * line ending character, Windows based systems use \r\n
  5046. * as the line ending characters and Macintosh based systems use
  5047. * \r as the line ending character.
  5048. * </p>
  5049. * <p>
  5050. * If you use the wrong line ending characters when writing your files, you
  5051. * might find that other applications that open those files will "look
  5052. * funny".
  5053. * </p>
  5054. * <p>
  5055. * Windows offers a text-mode translation flag ('t')
  5056. * which will transparently translate \n to
  5057. * \r\n when working with the file. In contrast, you
  5058. * can also use 'b' to force binary mode, which will not
  5059. * translate your data. To use these flags, specify either
  5060. * 'b' or 't' as the last character
  5061. * of the mode parameter.
  5062. * </p>
  5063. * <p>
  5064. * The default translation mode depends on the SAPI and version of PHP that
  5065. * you are using, so you are encouraged to always specify the appropriate
  5066. * flag for portability reasons. You should use the 't'
  5067. * mode if you are working with plain-text files and you use
  5068. * \n to delimit your line endings in your script, but
  5069. * expect your files to be readable with applications such as notepad. You
  5070. * should use the 'b' in all other cases.
  5071. * </p>
  5072. * <p>
  5073. * If you do not specify the 'b' flag when working with binary files, you
  5074. * may experience strange problems with your data, including broken image
  5075. * files and strange problems with \r\n characters.
  5076. * </p>
  5077. * <p>
  5078. * For portability, it is strongly recommended that you always
  5079. * use the 'b' flag when opening files with fopen.
  5080. * </p>
  5081. * <p>
  5082. * Again, for portability, it is also strongly recommended that
  5083. * you re-write code that uses or relies upon the 't'
  5084. * mode so that it uses the correct line endings and
  5085. * 'b' mode instead.
  5086. * </p>
  5087. * @param use_include_path bool[optional] <p>
  5088. * The optional third use_include_path parameter
  5089. * can be set to '1' or true if you want to search for the file in the
  5090. * include_path, too.
  5091. * </p>
  5092. * @param context resource[optional] &note.context-support;
  5093. * @return resource a file pointer resource on success, or false on error.
  5094. */
  5095. function fopen ($filename, $mode, $use_include_path = null, $context = null) {}
  5096. /**
  5097. * Output all remaining data on a file pointer
  5098. * @link http://www.php.net/manual/en/function.fpassthru.php
  5099. * @param handle resource &fs.validfp.all;
  5100. * @return int If an error occurs, fpassthru returns
  5101. * false. Otherwise, fpassthru returns
  5102. * the number of characters read from handle
  5103. * and passed through to the output.
  5104. */
  5105. function fpassthru ($handle) {}
  5106. /**
  5107. * Truncates a file to a given length
  5108. * @link http://www.php.net/manual/en/function.ftruncate.php
  5109. * @param handle resource <p>
  5110. * The file pointer.
  5111. * </p>
  5112. * <p>
  5113. * The handle must be open for writing.
  5114. * </p>
  5115. * @param size int <p>
  5116. * The size to truncate to.
  5117. * </p>
  5118. * <p>
  5119. * If size is larger than the file it is extended
  5120. * with null bytes.
  5121. * </p>
  5122. * <p>
  5123. * If size is smaller than the extra data
  5124. * will be lost.
  5125. * </p>
  5126. * @return bool Returns true on success or false on failure.
  5127. */
  5128. function ftruncate ($handle, $size) {}
  5129. /**
  5130. * Gets information about a file using an open file pointer
  5131. * @link http://www.php.net/manual/en/function.fstat.php
  5132. * @param handle resource &fs.file.pointer;
  5133. * @return array an array with the statistics of the file; the format of the array
  5134. * is described in detail on the stat manual page.
  5135. */
  5136. function fstat ($handle) {}
  5137. /**
  5138. * Seeks on a file pointer
  5139. * @link http://www.php.net/manual/en/function.fseek.php
  5140. * @param handle resource &fs.file.pointer;
  5141. * @param offset int <p>
  5142. * The offset.
  5143. * </p>
  5144. * <p>
  5145. * To move to a position before the end-of-file, you need to pass
  5146. * a negative value in offset and
  5147. * set whence
  5148. * to SEEK_END.
  5149. * </p>
  5150. * @param whence int[optional] <p>
  5151. * whence values are:
  5152. * SEEK_SET - Set position equal to offset bytes.
  5153. * SEEK_CUR - Set position to current location plus offset.
  5154. * SEEK_END - Set position to end-of-file plus offset.
  5155. * </p>
  5156. * <p>
  5157. * If whence is not specified, it is assumed to be
  5158. * SEEK_SET.
  5159. * </p>
  5160. * @return int Upon success, returns 0; otherwise, returns -1. Note that seeking
  5161. * past EOF is not considered an error.
  5162. */
  5163. function fseek ($handle, $offset, $whence = null) {}
  5164. /**
  5165. * Returns the current position of the file read/write pointer
  5166. * @link http://www.php.net/manual/en/function.ftell.php
  5167. * @param handle resource <p>
  5168. * The file pointer must be valid, and must point to a file successfully
  5169. * opened by fopen or popen.
  5170. * ftell gives undefined results for append-only streams
  5171. * (opened with "a" flag).
  5172. * </p>
  5173. * @return int the position of the file pointer referenced by
  5174. * handle as an integer; i.e., its offset into the file stream.
  5175. * </p>
  5176. * <p>
  5177. * If an error occurs, returns false.
  5178. */
  5179. function ftell ($handle) {}
  5180. /**
  5181. * Flushes the output to a file
  5182. * @link http://www.php.net/manual/en/function.fflush.php
  5183. * @param handle resource &fs.validfp.all;
  5184. * @return bool Returns true on success or false on failure.
  5185. */
  5186. function fflush ($handle) {}
  5187. /**
  5188. * Binary-safe file write
  5189. * @link http://www.php.net/manual/en/function.fwrite.php
  5190. * @param handle resource &fs.file.pointer;
  5191. * @param string string <p>
  5192. * The string that is to be written.
  5193. * </p>
  5194. * @param length int[optional] <p>
  5195. * If the length argument is given, writing will
  5196. * stop after length bytes have been written or
  5197. * the end of string is reached, whichever comes
  5198. * first.
  5199. * </p>
  5200. * <p>
  5201. * Note that if the length argument is given,
  5202. * then the magic_quotes_runtime
  5203. * configuration option will be ignored and no slashes will be
  5204. * stripped from string.
  5205. * </p>
  5206. * @return int
  5207. */
  5208. function fwrite ($handle, $string, $length = null) {}
  5209. /**
  5210. * &Alias; <function>fwrite</function>
  5211. * @link http://www.php.net/manual/en/function.fputs.php
  5212. * @param fp
  5213. * @param str
  5214. * @param length[optional]
  5215. */
  5216. function fputs ($fp, $str, $length) {}
  5217. /**
  5218. * Makes directory
  5219. * @link http://www.php.net/manual/en/function.mkdir.php
  5220. * @param pathname string <p>
  5221. * The directory path.
  5222. * </p>
  5223. * @param mode int[optional] <p>
  5224. * The mode is 0777 by default, which means the widest possible
  5225. * access. For more information on modes, read the details
  5226. * on the chmod page.
  5227. * </p>
  5228. * <p>
  5229. * mode is ignored on Windows.
  5230. * </p>
  5231. * <p>
  5232. * Note that you probably want to specify the mode as an octal number,
  5233. * which means it should have a leading zero. The mode is also modified
  5234. * by the current umask, which you can change using
  5235. * umask.
  5236. * </p>
  5237. * @param recursive bool[optional] <p>
  5238. * Default to false.
  5239. * </p>
  5240. * @param context resource[optional] &note.context-support;
  5241. * @return bool Returns true on success or false on failure.
  5242. */
  5243. function mkdir ($pathname, $mode = null, $recursive = null, $context = null) {}
  5244. /**
  5245. * Renames a file or directory
  5246. * @link http://www.php.net/manual/en/function.rename.php
  5247. * @param oldname string <p>
  5248. * </p>
  5249. * <p>
  5250. * The old name. The wrapper used in oldname
  5251. * must match the wrapper used in
  5252. * newname.
  5253. * </p>
  5254. * @param newname string <p>
  5255. * The new name.
  5256. * </p>
  5257. * @param context resource[optional] &note.context-support;
  5258. * @return bool Returns true on success or false on failure.
  5259. */
  5260. function rename ($oldname, $newname, $context = null) {}
  5261. /**
  5262. * Copies file
  5263. * @link http://www.php.net/manual/en/function.copy.php
  5264. * @param source string <p>
  5265. * Path to the source file.
  5266. * </p>
  5267. * @param dest string <p>
  5268. * The destination path. If dest is a URL, the
  5269. * copy operation may fail if the wrapper does not support overwriting of
  5270. * existing files.
  5271. * </p>
  5272. * <p>
  5273. * If the destination file already exists, it will be overwritten.
  5274. * </p>
  5275. * @param context resource[optional] <p>
  5276. * A valid context resource created with
  5277. * stream_context_create.
  5278. * </p>
  5279. * @return bool Returns true on success or false on failure.
  5280. */
  5281. function copy ($source, $dest, $context = null) {}
  5282. /**
  5283. * Create file with unique file name
  5284. * @link http://www.php.net/manual/en/function.tempnam.php
  5285. * @param dir string <p>
  5286. * The directory where the temporary filename will be created.
  5287. * </p>
  5288. * @param prefix string <p>
  5289. * The prefix of the generated temporary filename.
  5290. * </p>
  5291. * Windows uses only the first three characters of prefix.
  5292. * @return string the new temporary filename, or false on
  5293. * failure.
  5294. */
  5295. function tempnam ($dir, $prefix) {}
  5296. /**
  5297. * Creates a temporary file
  5298. * @link http://www.php.net/manual/en/function.tmpfile.php
  5299. * @return resource a file handle, similar to the one returned by
  5300. * fopen, for the new file&return.falseforfailure;.
  5301. */
  5302. function tmpfile () {}
  5303. /**
  5304. * Reads entire file into an array
  5305. * @link http://www.php.net/manual/en/function.file.php
  5306. * @param filename string <p>
  5307. * Path to the file.
  5308. * </p>
  5309. * &tip.fopen-wrapper;
  5310. * @param flags int[optional] <p>
  5311. * The optional parameter flags can be one, or
  5312. * more, of the following constants:
  5313. * FILE_USE_INCLUDE_PATH
  5314. * Search for the file in the include_path.
  5315. * @param context resource[optional] <p>
  5316. * A context resource created with the
  5317. * stream_context_create function.
  5318. * </p>
  5319. * <p>
  5320. * &note.context-support;
  5321. * </p>
  5322. * @return array the file in an array. Each element of the array corresponds to a
  5323. * line in the file, with the newline still attached. Upon failure,
  5324. * file returns false.
  5325. * </p>
  5326. * <p>
  5327. * Each line in the resulting array will include the line ending, unless
  5328. * FILE_IGNORE_NEW_LINES is used, so you still need to
  5329. * use rtrim if you do not want the line ending
  5330. * present.
  5331. */
  5332. function file ($filename, $flags = null, $context = null) {}
  5333. /**
  5334. * Reads entire file into a string
  5335. * @link http://www.php.net/manual/en/function.file-get-contents.php
  5336. * @param filename string <p>
  5337. * Name of the file to read.
  5338. * </p>
  5339. * @param flags int[optional] <p>
  5340. * Prior to PHP 6, this parameter is called
  5341. * use_include_path and is a bool.
  5342. * As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
  5343. * to trigger include path
  5344. * search.
  5345. * </p>
  5346. * <p>
  5347. * The value of flags can be any combination of
  5348. * the following flags (with some restrictions), joined with the
  5349. * binary OR (|)
  5350. * operator.
  5351. * </p>
  5352. * <p>
  5353. * <table>
  5354. * Available flags
  5355. * <tr valign="top">
  5356. * <td>Flag</td>
  5357. * <td>Description</td>
  5358. * </tr>
  5359. * <tr valign="top">
  5360. * <td>
  5361. * FILE_USE_INCLUDE_PATH
  5362. * </td>
  5363. * <td>
  5364. * Search for filename in the include directory.
  5365. * See include_path for more
  5366. * information.
  5367. * </td>
  5368. * </tr>
  5369. * <tr valign="top">
  5370. * <td>
  5371. * FILE_TEXT
  5372. * </td>
  5373. * <td>
  5374. * As of PHP 6, the default encoding of the read
  5375. * data is UTF-8. You can specify a different encoding by creating a
  5376. * custom context or by changing the default using
  5377. * stream_default_encoding. This flag cannot be
  5378. * used with FILE_BINARY.
  5379. * </td>
  5380. * </tr>
  5381. * <tr valign="top">
  5382. * <td>
  5383. * FILE_BINARY
  5384. * </td>
  5385. * <td>
  5386. * With this flag, the file is read in binary mode. This is the default
  5387. * setting and cannot be used with FILE_TEXT.
  5388. * </td>
  5389. * </tr>
  5390. * </table>
  5391. * </p>
  5392. * @param context resource[optional] <p>
  5393. * A valid context resource created with
  5394. * stream_context_create. If you don't need to use a
  5395. * custom context, you can skip this parameter by &null;.
  5396. * </p>
  5397. * @param offset int[optional] <p>
  5398. * The offset where the reading starts.
  5399. * </p>
  5400. * @param maxlen int[optional] <p>
  5401. * Maximum length of data read. The default is to read until end
  5402. * of file is reached.
  5403. * </p>
  5404. * @return string The function returns the read data&return.falseforfailure;.
  5405. */
  5406. function file_get_contents ($filename, $flags = null, $context = null, $offset = null, $maxlen = null) {}
  5407. /**
  5408. * Write a string to a file
  5409. * @link http://www.php.net/manual/en/function.file-put-contents.php
  5410. * @param filename string <p>
  5411. * Path to the file where to write the data.
  5412. * </p>
  5413. * @param data mixed <p>
  5414. * The data to write. Can be either a string, an
  5415. * array or a stream resource.
  5416. * </p>
  5417. * <p>
  5418. * If data is a stream resource, the
  5419. * remaining buffer of that stream will be copied to the specified file.
  5420. * This is similar with using stream_copy_to_stream.
  5421. * </p>
  5422. * <p>
  5423. * You can also specify the data parameter as a single
  5424. * dimension array. This is equivalent to
  5425. * file_put_contents($filename, implode('', $array)).
  5426. * </p>
  5427. * @param flags int[optional] <p>
  5428. * The value of flags can be any combination of
  5429. * the following flags (with some restrictions), joined with the binary OR
  5430. * (|) operator.
  5431. * </p>
  5432. * <p>
  5433. * <table>
  5434. * Available flags
  5435. * <tr valign="top">
  5436. * <td>Flag</td>
  5437. * <td>Description</td>
  5438. * </tr>
  5439. * <tr valign="top">
  5440. * <td>
  5441. * FILE_USE_INCLUDE_PATH
  5442. * </td>
  5443. * <td>
  5444. * Search for filename in the include directory.
  5445. * See include_path for more
  5446. * information.
  5447. * </td>
  5448. * </tr>
  5449. * <tr valign="top">
  5450. * <td>
  5451. * FILE_APPEND
  5452. * </td>
  5453. * <td>
  5454. * If file filename already exists, append
  5455. * the data to the file instead of overwriting it. Mutually
  5456. * exclusive with LOCK_EX since appends are atomic and thus there
  5457. * is no reason to lock.
  5458. * </td>
  5459. * </tr>
  5460. * <tr valign="top">
  5461. * <td>
  5462. * LOCK_EX
  5463. * </td>
  5464. * <td>
  5465. * Acquire an exclusive lock on the file while proceeding to the
  5466. * writing. Mutually exclusive with FILE_APPEND.
  5467. * </td>
  5468. * </tr>
  5469. * <tr valign="top">
  5470. * <td>
  5471. * FILE_TEXT
  5472. * </td>
  5473. * <td>
  5474. * data is written in text mode. If unicode
  5475. * semantics are enabled, the default encoding is UTF-8.
  5476. * You can specify a different encoding by creating a custom context
  5477. * or by using the stream_default_encoding to
  5478. * change the default. This flag cannot be used with
  5479. * FILE_BINARY. This flag is only available since
  5480. * PHP 6.
  5481. * </td>
  5482. * </tr>
  5483. * <tr valign="top">
  5484. * <td>
  5485. * FILE_BINARY
  5486. * </td>
  5487. * <td>
  5488. * data will be written in binary mode. This
  5489. * is the default setting and cannot be used with
  5490. * FILE_TEXT. This flag is only available since
  5491. * PHP 6.
  5492. * </td>
  5493. * </tr>
  5494. * </table>
  5495. * </p>
  5496. * @param context resource[optional] <p>
  5497. * A valid context resource created with
  5498. * stream_context_create.
  5499. * </p>
  5500. * @return int The function returns the number of bytes that were written to the file, or
  5501. * false on failure.
  5502. */
  5503. function file_put_contents ($filename, $data, $flags = null, $context = null) {}
  5504. /**
  5505. * Runs the equivalent of the select() system call on the given
  5506. arrays of streams with a timeout specified by tv_sec and tv_usec
  5507. * @link http://www.php.net/manual/en/function.stream-select.php
  5508. * @param read array <p>
  5509. * The streams listed in the read array will be watched to
  5510. * see if characters become available for reading (more precisely, to see if
  5511. * a read will not block - in particular, a stream resource is also ready on
  5512. * end-of-file, in which case an fread will return
  5513. * a zero length string).
  5514. * </p>
  5515. * @param write array <p>
  5516. * The streams listed in the write array will be
  5517. * watched to see if a write will not block.
  5518. * </p>
  5519. * @param except array <p>
  5520. * The streams listed in the except array will be
  5521. * watched for high priority exceptional ("out-of-band") data arriving.
  5522. * </p>
  5523. * <p>
  5524. * When stream_select returns, the arrays
  5525. * read, write and
  5526. * except are modified to indicate which stream
  5527. * resource(s) actually changed status.
  5528. * </p>
  5529. * You do not need to pass every array to
  5530. * stream_select. You can leave it out and use an
  5531. * empty array or &null; instead. Also do not forget that those arrays are
  5532. * passed by reference and will be modified after
  5533. * stream_select returns.
  5534. * @param tv_sec int <p>
  5535. * The tv_sec and tv_usec
  5536. * together form the timeout parameter,
  5537. * tv_sec specifies the number of seconds while
  5538. * tv_usec the number of microseconds.
  5539. * The timeout is an upper bound on the amount of time
  5540. * that stream_select will wait before it returns.
  5541. * If tv_sec and tv_usec are
  5542. * both set to 0, stream_select will
  5543. * not wait for data - instead it will return immediately, indicating the
  5544. * current status of the streams.
  5545. * </p>
  5546. * <p>
  5547. * If tv_sec is &null; stream_select
  5548. * can block indefinitely, returning only when an event on one of the
  5549. * watched streams occurs (or if a signal interrupts the system call).
  5550. * </p>
  5551. * <p>
  5552. * Using a timeout value of 0 allows you to
  5553. * instantaneously poll the status of the streams, however, it is NOT a
  5554. * good idea to use a 0 timeout value in a loop as it
  5555. * will cause your script to consume too much CPU time.
  5556. * </p>
  5557. * <p>
  5558. * It is much better to specify a timeout value of a few seconds, although
  5559. * if you need to be checking and running other code concurrently, using a
  5560. * timeout value of at least 200000 microseconds will
  5561. * help reduce the CPU usage of your script.
  5562. * </p>
  5563. * <p>
  5564. * Remember that the timeout value is the maximum time that will elapse;
  5565. * stream_select will return as soon as the
  5566. * requested streams are ready for use.
  5567. * </p>
  5568. * @param tv_usec int[optional] <p>
  5569. * See tv_sec description.
  5570. * </p>
  5571. * @return int On success stream_select returns the number of
  5572. * stream resources contained in the modified arrays, which may be zero if
  5573. * the timeout expires before anything interesting happens. On error false
  5574. * is returned and a warning raised (this can happen if the system call is
  5575. * interrupted by an incoming signal).
  5576. */
  5577. function stream_select (array &$read, array &$write, array &$except, $tv_sec, $tv_usec = null) {}
  5578. /**
  5579. * Create a streams context
  5580. * @link http://www.php.net/manual/en/function.stream-context-create.php
  5581. * @param options array[optional] <p>
  5582. * Must be an associative array of associative arrays in the format
  5583. * $arr['wrapper']['option'] = $value.
  5584. * </p>
  5585. * <p>
  5586. * Default to an empty array.
  5587. * </p>
  5588. * @param params array[optional] <p>
  5589. * Must be an associative array in the format
  5590. * $arr['parameter'] = $value.
  5591. * Refer to context parameters for
  5592. * a listing of standard stream parameters.
  5593. * </p>
  5594. * @return resource A stream context resource.
  5595. */
  5596. function stream_context_create (array $options = null, array $params = null) {}
  5597. /**
  5598. * Set parameters for a stream/wrapper/context
  5599. * @link http://www.php.net/manual/en/function.stream-context-set-params.php
  5600. * @param stream_or_context resource <p>
  5601. * The stream or context to apply the parameters too.
  5602. * </p>
  5603. * @param params array <p>
  5604. * An array of parameters to set.
  5605. * </p>
  5606. * <p>
  5607. * params should be an associative array of the structure:
  5608. * $params['paramname'] = "paramvalue";.
  5609. * </p>
  5610. * @return bool Returns true on success or false on failure.
  5611. */
  5612. function stream_context_set_params ($stream_or_context, array $params) {}
  5613. /**
  5614. * Retrieves parameters from a context
  5615. * @link http://www.php.net/manual/en/function.stream-context-get-params.php
  5616. * @param stream_or_context resource <p>
  5617. * A stream resource or a
  5618. * context resource
  5619. * </p>
  5620. * @return array an associate array containing all context options and parameters.
  5621. */
  5622. function stream_context_get_params ($stream_or_context) {}
  5623. /**
  5624. * Sets an option for a stream/wrapper/context
  5625. * @link http://www.php.net/manual/en/function.stream-context-set-option.php
  5626. * @param stream_or_context resource <p>
  5627. * The stream or context resource to apply the options too.
  5628. * </p>
  5629. * @param wrapper string
  5630. * @param option string
  5631. * @param value mixed
  5632. * @return bool Returns true on success or false on failure.
  5633. */
  5634. function stream_context_set_option ($stream_or_context, $wrapper, $option, $value) {}
  5635. /**
  5636. * Retrieve options for a stream/wrapper/context
  5637. * @link http://www.php.net/manual/en/function.stream-context-get-options.php
  5638. * @param stream_or_context resource <p>
  5639. * The stream or context to get options from
  5640. * </p>
  5641. * @return array an associative array with the options.
  5642. */
  5643. function stream_context_get_options ($stream_or_context) {}
  5644. /**
  5645. * Retreive the default streams context
  5646. * @link http://www.php.net/manual/en/function.stream-context-get-default.php
  5647. * @param options array[optional] options must be an associative
  5648. * array of associative arrays in the format
  5649. * $arr['wrapper']['option'] = $value.
  5650. * <p>
  5651. * As of PHP 5.3.0, the stream_context_set_default function
  5652. * can be used to set the default context.
  5653. * </p>
  5654. * @return resource A stream context resource.
  5655. */
  5656. function stream_context_get_default (array $options = null) {}
  5657. /**
  5658. * Set the default streams context
  5659. * @link http://www.php.net/manual/en/function.stream-context-set-default.php
  5660. * @param options array <p>
  5661. * The options to set for the default context.
  5662. * </p>
  5663. * <p>
  5664. * options must be an associative
  5665. * array of associative arrays in the format
  5666. * $arr['wrapper']['option'] = $value.
  5667. * </p>
  5668. * @return resource the default stream context.
  5669. */
  5670. function stream_context_set_default (array $options) {}
  5671. /**
  5672. * Attach a filter to a stream
  5673. * @link http://www.php.net/manual/en/function.stream-filter-prepend.php
  5674. * @param stream resource <p>
  5675. * The target stream.
  5676. * </p>
  5677. * @param filtername string <p>
  5678. * The filter name.
  5679. * </p>
  5680. * @param read_write int[optional] <p>
  5681. * By default, stream_filter_prepend will
  5682. * attach the filter to the read filter chain
  5683. * if the file was opened for reading (i.e. File Mode:
  5684. * r, and/or +). The filter
  5685. * will also be attached to the write filter chain
  5686. * if the file was opened for writing (i.e. File Mode:
  5687. * w, a, and/or +).
  5688. * STREAM_FILTER_READ,
  5689. * STREAM_FILTER_WRITE, and/or
  5690. * STREAM_FILTER_ALL can also be passed to the
  5691. * read_write parameter to override this behavior.
  5692. * See stream_filter_append for an example of
  5693. * using this parameter.
  5694. * </p>
  5695. * @param params mixed[optional] <p>
  5696. * This filter will be added with the specified params
  5697. * to the beginning of the list and will therefore be
  5698. * called first during stream operations. To add a filter to the end of the
  5699. * list, use stream_filter_append.
  5700. * </p>
  5701. * @return resource a resource which can be used to refer to this filter
  5702. * instance during a call to stream_filter_remove.
  5703. */
  5704. function stream_filter_prepend ($stream, $filtername, $read_write = null, $params = null) {}
  5705. /**
  5706. * Attach a filter to a stream
  5707. * @link http://www.php.net/manual/en/function.stream-filter-append.php
  5708. * @param stream resource <p>
  5709. * The target stream.
  5710. * </p>
  5711. * @param filtername string <p>
  5712. * The filter name.
  5713. * </p>
  5714. * @param read_write int[optional] <p>
  5715. * By default, stream_filter_append will
  5716. * attach the filter to the read filter chain
  5717. * if the file was opened for reading (i.e. File Mode:
  5718. * r, and/or +). The filter
  5719. * will also be attached to the write filter chain
  5720. * if the file was opened for writing (i.e. File Mode:
  5721. * w, a, and/or +).
  5722. * STREAM_FILTER_READ,
  5723. * STREAM_FILTER_WRITE, and/or
  5724. * STREAM_FILTER_ALL can also be passed to the
  5725. * read_write parameter to override this behavior.
  5726. * </p>
  5727. * @param params mixed[optional] <p>
  5728. * This filter will be added with the specified
  5729. * params to the end of
  5730. * the list and will therefore be called last during stream operations.
  5731. * To add a filter to the beginning of the list, use
  5732. * stream_filter_prepend.
  5733. * </p>
  5734. * @return resource a resource which can be used to refer to this filter
  5735. * instance during a call to stream_filter_remove.
  5736. */
  5737. function stream_filter_append ($stream, $filtername, $read_write = null, $params = null) {}
  5738. /**
  5739. * Remove a filter from a stream
  5740. * @link http://www.php.net/manual/en/function.stream-filter-remove.php
  5741. * @param stream_filter resource <p>
  5742. * The stream filter to be removed.
  5743. * </p>
  5744. * @return bool Returns true on success or false on failure.
  5745. */
  5746. function stream_filter_remove ($stream_filter) {}
  5747. /**
  5748. * Open Internet or Unix domain socket connection
  5749. * @link http://www.php.net/manual/en/function.stream-socket-client.php
  5750. * @param remote_socket string <p>
  5751. * Address to the socket to connect to.
  5752. * </p>
  5753. * @param errno int[optional] <p>
  5754. * Will be set to the system level error number if connection fails.
  5755. * </p>
  5756. * @param errstr string[optional] <p>
  5757. * Will be set to the system level error message if the connection fails.
  5758. * </p>
  5759. * @param timeout float[optional] <p>
  5760. * Number of seconds until the connect() system call
  5761. * should timeout.
  5762. * This parameter only applies when not making asynchronous
  5763. * connection attempts.
  5764. * <p>
  5765. * To set a timeout for reading/writing data over the socket, use the
  5766. * stream_set_timeout, as the
  5767. * timeout only applies while making connecting
  5768. * the socket.
  5769. * </p>
  5770. * </p>
  5771. * @param flags int[optional] <p>
  5772. * Bitmask field which may be set to any combination of connection flags.
  5773. * Currently the select of connection flags is limited to
  5774. * STREAM_CLIENT_CONNECT (default),
  5775. * STREAM_CLIENT_ASYNC_CONNECT and
  5776. * STREAM_CLIENT_PERSISTENT.
  5777. * </p>
  5778. * @param context resource[optional] <p>
  5779. * A valid context resource created with stream_context_create.
  5780. * </p>
  5781. * @return resource On success a stream resource is returned which may
  5782. * be used together with the other file functions (such as
  5783. * fgets, fgetss,
  5784. * fwrite, fclose, and
  5785. * feof), false on failure.
  5786. */
  5787. function stream_socket_client ($remote_socket, &$errno = null, &$errstr = null, $timeout = null, $flags = null, $context = null) {}
  5788. /**
  5789. * Create an Internet or Unix domain server socket
  5790. * @link http://www.php.net/manual/en/function.stream-socket-server.php
  5791. * @param local_socket string <p>
  5792. * The type of socket created is determined by the transport specified
  5793. * using standard URL formatting: transport://target.
  5794. * </p>
  5795. * <p>
  5796. * For Internet Domain sockets (AF_INET) such as TCP and UDP, the
  5797. * target portion of the
  5798. * remote_socket parameter should consist of a
  5799. * hostname or IP address followed by a colon and a port number. For
  5800. * Unix domain sockets, the target portion should
  5801. * point to the socket file on the filesystem.
  5802. * </p>
  5803. * <p>
  5804. * Depending on the environment, Unix domain sockets may not be available.
  5805. * A list of available transports can be retrieved using
  5806. * stream_get_transports. See
  5807. * for a list of bulitin transports.
  5808. * </p>
  5809. * @param errno int[optional] <p>
  5810. * If the optional errno and errstr
  5811. * arguments are present they will be set to indicate the actual system
  5812. * level error that occurred in the system-level socket(),
  5813. * bind(), and listen() calls. If
  5814. * the value returned in errno is
  5815. * 0 and the function returned false, it is an
  5816. * indication that the error occurred before the bind()
  5817. * call. This is most likely due to a problem initializing the socket.
  5818. * Note that the errno and
  5819. * errstr arguments will always be passed by reference.
  5820. * </p>
  5821. * @param errstr string[optional] <p>
  5822. * See errno description.
  5823. * </p>
  5824. * @param flags int[optional] <p>
  5825. * A bitmask field which may be set to any combination of socket creation
  5826. * flags.
  5827. * </p>
  5828. * <p>
  5829. * For UDP sockets, you must use STREAM_SERVER_BIND as
  5830. * the flags parameter.
  5831. * </p>
  5832. * @param context resource[optional] <p>
  5833. * </p>
  5834. * @return resource the created stream, or false on error.
  5835. */
  5836. function stream_socket_server ($local_socket, &$errno = null, &$errstr = null, $flags = null, $context = null) {}
  5837. /**
  5838. * Accept a connection on a socket created by <function>stream_socket_server</function>
  5839. * @link http://www.php.net/manual/en/function.stream-socket-accept.php
  5840. * @param server_socket resource
  5841. * @param timeout float[optional] <p>
  5842. * Override the default socket accept timeout. Time should be given in
  5843. * seconds.
  5844. * </p>
  5845. * @param peername string[optional] <p>
  5846. * Will be set to the name (address) of the client which connected, if
  5847. * included and available from the selected transport.
  5848. * </p>
  5849. * <p>
  5850. * Can also be determined later using
  5851. * stream_socket_get_name.
  5852. * </p>
  5853. * @return resource Returns true on success or false on failure.
  5854. */
  5855. function stream_socket_accept ($server_socket, $timeout = null, &$peername = null) {}
  5856. /**
  5857. * Retrieve the name of the local or remote sockets
  5858. * @link http://www.php.net/manual/en/function.stream-socket-get-name.php
  5859. * @param handle resource <p>
  5860. * The socket to get the name of.
  5861. * </p>
  5862. * @param want_peer bool <p>
  5863. * If set to true the remote socket name will be returned, if set
  5864. * to false the local socket name will be returned.
  5865. * </p>
  5866. * @return string The name of the socket.
  5867. */
  5868. function stream_socket_get_name ($handle, $want_peer) {}
  5869. /**
  5870. * Receives data from a socket, connected or not
  5871. * @link http://www.php.net/manual/en/function.stream-socket-recvfrom.php
  5872. * @param socket resource <p>
  5873. * The remote socket.
  5874. * </p>
  5875. * @param length int <p>
  5876. * The number of bytes to receive from the socket.
  5877. * </p>
  5878. * @param flags int[optional] <p>
  5879. * The value of flags can be any combination
  5880. * of the following:
  5881. * <table>
  5882. * Possible values for flags
  5883. * <tr valign="top">
  5884. * <td>STREAM_OOB</td>
  5885. * <td>
  5886. * Process OOB (out-of-band) data.
  5887. * </td>
  5888. * </tr>
  5889. * <tr valign="top">
  5890. * <td>STREAM_PEEK</td>
  5891. * <td>
  5892. * Retrieve data from the socket, but do not consume the buffer.
  5893. * Subsequent calls to fread or
  5894. * stream_socket_recvfrom will see
  5895. * the same data.
  5896. * </td>
  5897. * </tr>
  5898. * </table>
  5899. * </p>
  5900. * @param address string[optional] <p>
  5901. * If address is provided it will be populated with
  5902. * the address of the remote socket.
  5903. * </p>
  5904. * @return string the read data, as a string
  5905. */
  5906. function stream_socket_recvfrom ($socket, $length, $flags = null, &$address = null) {}
  5907. /**
  5908. * Sends a message to a socket, whether it is connected or not
  5909. * @link http://www.php.net/manual/en/function.stream-socket-sendto.php
  5910. * @param socket resource <p>
  5911. * The socket to send data to.
  5912. * </p>
  5913. * @param data string <p>
  5914. * The data to be sent.
  5915. * </p>
  5916. * @param flags int[optional] <p>
  5917. * The value of flags can be any combination
  5918. * of the following:
  5919. * <table>
  5920. * possible values for flags
  5921. * <tr valign="top">
  5922. * <td>STREAM_OOB</td>
  5923. * <td>
  5924. * Process OOB (out-of-band) data.
  5925. * </td>
  5926. * </tr>
  5927. * </table>
  5928. * </p>
  5929. * @param address string[optional] <p>
  5930. * The address specified when the socket stream was created will be used
  5931. * unless an alternate address is specified in address.
  5932. * </p>
  5933. * <p>
  5934. * If specified, it must be in dotted quad (or [ipv6]) format.
  5935. * </p>
  5936. * @return int a result code, as an integer.
  5937. */
  5938. function stream_socket_sendto ($socket, $data, $flags = null, $address = null) {}
  5939. /**
  5940. * Turns encryption on/off on an already connected socket
  5941. * @link http://www.php.net/manual/en/function.stream-socket-enable-crypto.php
  5942. * @param stream resource <p>
  5943. * The stream resource.
  5944. * </p>
  5945. * @param enable bool <p>
  5946. * Enable/disable cryptography on the stream.
  5947. * </p>
  5948. * @param crypto_type int[optional] <p>
  5949. * Setup encryption on the stream.
  5950. * Valid methods are
  5951. * STREAM_CRYPTO_METHOD_SSLv2_CLIENT
  5952. * @param session_stream resource[optional] <p>
  5953. * Seed the stream with settings from session_stream.
  5954. * </p>
  5955. * @return mixed true on success, false if negotiation has failed or
  5956. * 0 if there isn't enough data and you should try again
  5957. * (only for non-blocking sockets).
  5958. */
  5959. function stream_socket_enable_crypto ($stream, $enable, $crypto_type = null, $session_stream = null) {}
  5960. /**
  5961. * Shutdown a full-duplex connection
  5962. * @link http://www.php.net/manual/en/function.stream-socket-shutdown.php
  5963. * @param stream resource <p>
  5964. * An open stream (opened with stream_socket_client,
  5965. * for example)
  5966. * </p>
  5967. * @param how int <p>
  5968. * One of the following constants: STREAM_SHUT_RD
  5969. * (disable further receptions), STREAM_SHUT_WR
  5970. * (disable further transmissions) or
  5971. * STREAM_SHUT_RDWR (disable further receptions and
  5972. * transmissions).
  5973. * </p>
  5974. * @return bool Returns true on success or false on failure.
  5975. */
  5976. function stream_socket_shutdown ($stream, $how) {}
  5977. /**
  5978. * Creates a pair of connected, indistinguishable socket streams
  5979. * @link http://www.php.net/manual/en/function.stream-socket-pair.php
  5980. * @param domain int <p>
  5981. * The protocol family to be used: STREAM_PF_INET,
  5982. * STREAM_PF_INET6 or
  5983. * STREAM_PF_UNIX
  5984. * </p>
  5985. * @param type int <p>
  5986. * The type of communication to be used:
  5987. * STREAM_SOCK_DGRAM,
  5988. * STREAM_SOCK_RAW,
  5989. * STREAM_SOCK_RDM,
  5990. * STREAM_SOCK_SEQPACKET or
  5991. * STREAM_SOCK_STREAM
  5992. * </p>
  5993. * @param protocol int <p>
  5994. * The protocol to be used: STREAM_IPPROTO_ICMP,
  5995. * STREAM_IPPROTO_IP,
  5996. * STREAM_IPPROTO_RAW,
  5997. * STREAM_IPPROTO_TCP or
  5998. * STREAM_IPPROTO_UDP
  5999. * </p>
  6000. * @return array an array with the two socket resources on success, or
  6001. * false on failure.
  6002. */
  6003. function stream_socket_pair ($domain, $type, $protocol) {}
  6004. /**
  6005. * Copies data from one stream to another
  6006. * @link http://www.php.net/manual/en/function.stream-copy-to-stream.php
  6007. * @param source resource <p>
  6008. * The source stream
  6009. * </p>
  6010. * @param dest resource <p>
  6011. * The destination stream
  6012. * </p>
  6013. * @param maxlength int[optional] <p>
  6014. * Maximum bytes to copy
  6015. * </p>
  6016. * @param offset int[optional] <p>
  6017. * The offset where to start to copy data
  6018. * </p>
  6019. * @return int the total count of bytes copied.
  6020. */
  6021. function stream_copy_to_stream ($source, $dest, $maxlength = null, $offset = null) {}
  6022. /**
  6023. * Reads remainder of a stream into a string
  6024. * @link http://www.php.net/manual/en/function.stream-get-contents.php
  6025. * @param handle resource <p>
  6026. * A stream resource (e.g. returned from fopen)
  6027. * </p>
  6028. * @param maxlength int[optional] <p>
  6029. * The maximum bytes to read. Defaults to -1 (read all the remaining
  6030. * buffer).
  6031. * </p>
  6032. * @param offset int[optional] <p>
  6033. * Seek to the specified offset before reading.
  6034. * </p>
  6035. * @return string a string&return.falseforfailure;.
  6036. */
  6037. function stream_get_contents ($handle, $maxlength = null, $offset = null) {}
  6038. /**
  6039. * Tells whether the stream supports locking.
  6040. * @link http://www.php.net/manual/en/function.stream-supports-lock.php
  6041. * @param stream resource <p>
  6042. * The stream to check.
  6043. * </p>
  6044. * @return bool Returns true on success or false on failure.
  6045. */
  6046. function stream_supports_lock ($stream) {}
  6047. /**
  6048. * Gets line from file pointer and parse for CSV fields
  6049. * @link http://www.php.net/manual/en/function.fgetcsv.php
  6050. * @param handle resource <p>
  6051. * A valid file pointer to a file successfully opened by
  6052. * fopen, popen, or
  6053. * fsockopen.
  6054. * </p>
  6055. * @param length int[optional] <p>
  6056. * Must be greater than the longest line (in characters) to be found in
  6057. * the CSV file (allowing for trailing line-end characters). It became
  6058. * optional in PHP 5. Omitting this parameter (or setting it to 0 in PHP
  6059. * 5.0.4 and later) the maximum line length is not limited, which is
  6060. * slightly slower.
  6061. * </p>
  6062. * @param delimiter string[optional] <p>
  6063. * Set the field delimiter (one character only).
  6064. * </p>
  6065. * @param enclosure string[optional] <p>
  6066. * Set the field enclosure character (one character only).
  6067. * </p>
  6068. * @param escape string[optional] <p>
  6069. * Set the escape character (one character only). Defaults as a backslash.
  6070. * </p>
  6071. * @return array an indexed array containing the fields read.
  6072. * </p>
  6073. * <p>
  6074. * A blank line in a CSV file will be returned as an array
  6075. * comprising a single null field, and will not be treated
  6076. * as an error.
  6077. * </p>
  6078. * &note.line-endings;
  6079. * <p>
  6080. * fgetcsv returns &null; if an invalid
  6081. * handle is supplied or false on other errors,
  6082. * including end of file.
  6083. */
  6084. function fgetcsv ($handle, $length = null, $delimiter = null, $enclosure = null, $escape = null) {}
  6085. /**
  6086. * Format line as CSV and write to file pointer
  6087. * @link http://www.php.net/manual/en/function.fputcsv.php
  6088. * @param handle resource &fs.validfp.all;
  6089. * @param fields array <p>
  6090. * An array of values.
  6091. * </p>
  6092. * @param delimiter string[optional] <p>
  6093. * The optional delimiter parameter sets the field
  6094. * delimiter (one character only).
  6095. * </p>
  6096. * @param enclosure string[optional] <p>
  6097. * The optional enclosure parameter sets the field
  6098. * enclosure (one character only).
  6099. * </p>
  6100. * @return int the length of the written string&return.falseforfailure;.
  6101. */
  6102. function fputcsv ($handle, array $fields, $delimiter = null, $enclosure = null) {}
  6103. /**
  6104. * Portable advisory file locking
  6105. * @link http://www.php.net/manual/en/function.flock.php
  6106. * @param handle resource <p>
  6107. * An open file pointer.
  6108. * </p>
  6109. * @param operation int <p>
  6110. * operation is one of the following:
  6111. * LOCK_SH to acquire a shared lock (reader).
  6112. * @param wouldblock int[optional] <p>
  6113. * The optional third argument is set to true if the lock would block
  6114. * (EWOULDBLOCK errno condition). (not supported on Windows)
  6115. * </p>
  6116. * @return bool Returns true on success or false on failure.
  6117. */
  6118. function flock ($handle, $operation, &$wouldblock = null) {}
  6119. /**
  6120. * Extracts all meta tag content attributes from a file and returns an array
  6121. * @link http://www.php.net/manual/en/function.get-meta-tags.php
  6122. * @param filename string <p>
  6123. * The path to the HTML file, as a string. This can be a local file or an
  6124. * URL.
  6125. * </p>
  6126. * <p>
  6127. * What get_meta_tags parses
  6128. * ]]>
  6129. * (pay attention to line endings - PHP uses a native function to
  6130. * parse the input, so a Mac file won't work on Unix).
  6131. * </p>
  6132. * @param use_include_path bool[optional] <p>
  6133. * Setting use_include_path to true will result
  6134. * in PHP trying to open the file along the standard include path as per
  6135. * the include_path directive.
  6136. * This is used for local files, not URLs.
  6137. * </p>
  6138. * @return array an array with all the parsed meta tags.
  6139. * </p>
  6140. * <p>
  6141. * The value of the name property becomes the key, the value of the content
  6142. * property becomes the value of the returned array, so you can easily use
  6143. * standard array functions to traverse it or access single values.
  6144. * Special characters in the value of the name property are substituted with
  6145. * '_', the rest is converted to lower case. If two meta tags have the same
  6146. * name, only the last one is returned.
  6147. */
  6148. function get_meta_tags ($filename, $use_include_path = null) {}
  6149. /**
  6150. * Sets file buffering on the given stream
  6151. * @link http://www.php.net/manual/en/function.stream-set-write-buffer.php
  6152. * @param stream resource <p>
  6153. * The file pointer.
  6154. * </p>
  6155. * @param buffer int <p>
  6156. * The number of bytes to buffer. If buffer
  6157. * is 0 then write operations are unbuffered. This ensures that all writes
  6158. * with fwrite are completed before other processes are
  6159. * allowed to write to that output stream.
  6160. * </p>
  6161. * @return int 0 on success, or EOF if the request cannot be honored.
  6162. */
  6163. function stream_set_write_buffer ($stream, $buffer) {}
  6164. /**
  6165. * &Alias; <function>stream_set_write_buffer</function>
  6166. * @link http://www.php.net/manual/en/function.set-file-buffer.php
  6167. * @param fp
  6168. * @param buffer
  6169. */
  6170. function set_file_buffer ($fp, $buffer) {}
  6171. /**
  6172. * &Alias; <function>stream_set_blocking</function>
  6173. * @link http://www.php.net/manual/en/function.set-socket-blocking.php
  6174. * @param socket
  6175. * @param mode
  6176. */
  6177. function set_socket_blocking ($socket, $mode) {}
  6178. /**
  6179. * Set blocking/non-blocking mode on a stream
  6180. * @link http://www.php.net/manual/en/function.stream-set-blocking.php
  6181. * @param stream resource <p>
  6182. * The stream.
  6183. * </p>
  6184. * @param mode int <p>
  6185. * If mode is 0, the given stream
  6186. * will be switched to non-blocking mode, and if 1, it
  6187. * will be switched to blocking mode. This affects calls like
  6188. * fgets and fread
  6189. * that read from the stream. In non-blocking mode an
  6190. * fgets call will always return right away
  6191. * while in blocking mode it will wait for data to become available
  6192. * on the stream.
  6193. * </p>
  6194. * @return bool Returns true on success or false on failure.
  6195. */
  6196. function stream_set_blocking ($stream, $mode) {}
  6197. /**
  6198. * &Alias; <function>stream_set_blocking</function>
  6199. * @link http://www.php.net/manual/en/function.socket-set-blocking.php
  6200. * @param socket
  6201. * @param mode
  6202. */
  6203. function socket_set_blocking ($socket, $mode) {}
  6204. /**
  6205. * Retrieves header/meta data from streams/file pointers
  6206. * @link http://www.php.net/manual/en/function.stream-get-meta-data.php
  6207. * @param stream resource <p>
  6208. * The stream can be any stream created by fopen,
  6209. * fsockopen and pfsockopen.
  6210. * </p>
  6211. * @return array The result array contains the following items:
  6212. * </p>
  6213. * <p>
  6214. * timed_out (bool) - true if the stream
  6215. * timed out while waiting for data on the last call to
  6216. * fread or fgets.
  6217. * </p>
  6218. * <p>
  6219. * blocked (bool) - true if the stream is
  6220. * in blocking IO mode. See stream_set_blocking.
  6221. * </p>
  6222. * <p>
  6223. * eof (bool) - true if the stream has reached
  6224. * end-of-file. Note that for socket streams this member can be true
  6225. * even when unread_bytes is non-zero. To
  6226. * determine if there is more data to be read, use
  6227. * feof instead of reading this item.
  6228. * </p>
  6229. * <p>
  6230. * unread_bytes (int) - the number of bytes
  6231. * currently contained in the PHP's own internal buffer.
  6232. * </p>
  6233. * You shouldn't use this value in a script.
  6234. * <p>
  6235. * stream_type (string) - a label describing
  6236. * the underlying implementation of the stream.
  6237. * </p>
  6238. * <p>
  6239. * wrapper_type (string) - a label describing
  6240. * the protocol wrapper implementation layered over the stream.
  6241. * See for more information about wrappers.
  6242. * </p>
  6243. * <p>
  6244. * wrapper_data (mixed) - wrapper specific
  6245. * data attached to this stream. See for
  6246. * more information about wrappers and their wrapper data.
  6247. * </p>
  6248. * <p>
  6249. * filters (array) - and array containing
  6250. * the names of any filters that have been stacked onto this stream.
  6251. * Documentation on filters can be found in the
  6252. * Filters appendix.
  6253. * </p>
  6254. * <p>
  6255. * mode (string) - the type of access required for
  6256. * this stream (see Table 1 of the fopen() reference)
  6257. * </p>
  6258. * <p>
  6259. * seekable (bool) - whether the current stream can
  6260. * be seeked.
  6261. * </p>
  6262. * <p>
  6263. * uri (string) - the URI/filename associated with this
  6264. * stream.
  6265. */
  6266. function stream_get_meta_data ($stream) {}
  6267. /**
  6268. * Gets line from stream resource up to a given delimiter
  6269. * @link http://www.php.net/manual/en/function.stream-get-line.php
  6270. * @param handle resource <p>
  6271. * A valid file handle.
  6272. * </p>
  6273. * @param length int <p>
  6274. * The number of bytes to read from the handle.
  6275. * </p>
  6276. * @param ending string[optional] <p>
  6277. * An optional string delimiter.
  6278. * </p>
  6279. * @return string a string of up to length bytes read from the file
  6280. * pointed to by handle.
  6281. * </p>
  6282. * <p>
  6283. * If an error occurs, returns false.
  6284. */
  6285. function stream_get_line ($handle, $length, $ending = null) {}
  6286. /**
  6287. * Register a URL wrapper implemented as a PHP class
  6288. * @link http://www.php.net/manual/en/function.stream-wrapper-register.php
  6289. * @param protocol string <p>
  6290. * The wrapper name to be registered.
  6291. * </p>
  6292. * @param classname string <p>
  6293. * The classname which implements the protocol.
  6294. * </p>
  6295. * @param flags int[optional] <p>
  6296. * Should be set to STREAM_IS_URL if
  6297. * protocol is a URL protocol. Default is 0, local
  6298. * stream.
  6299. * </p>
  6300. * @return bool Returns true on success or false on failure.
  6301. * </p>
  6302. * <p>
  6303. * stream_wrapper_register will return false if the
  6304. * protocol already has a handler.
  6305. */
  6306. function stream_wrapper_register ($protocol, $classname, $flags = null) {}
  6307. /**
  6308. * &Alias; <function>stream_wrapper_register</function>
  6309. * @link http://www.php.net/manual/en/function.stream-register-wrapper.php
  6310. * @param protocol
  6311. * @param classname
  6312. * @param flags[optional]
  6313. */
  6314. function stream_register_wrapper ($protocol, $classname, $flags) {}
  6315. /**
  6316. * Unregister a URL wrapper
  6317. * @link http://www.php.net/manual/en/function.stream-wrapper-unregister.php
  6318. * @param protocol string <p>
  6319. * </p>
  6320. * @return bool Returns true on success or false on failure.
  6321. */
  6322. function stream_wrapper_unregister ($protocol) {}
  6323. /**
  6324. * Restores a previously unregistered built-in wrapper
  6325. * @link http://www.php.net/manual/en/function.stream-wrapper-restore.php
  6326. * @param protocol string <p>
  6327. * </p>
  6328. * @return bool Returns true on success or false on failure.
  6329. */
  6330. function stream_wrapper_restore ($protocol) {}
  6331. /**
  6332. * Retrieve list of registered streams
  6333. * @link http://www.php.net/manual/en/function.stream-get-wrappers.php
  6334. * @return array an indexed array containing the name of all stream wrappers
  6335. * available on the running system.
  6336. */
  6337. function stream_get_wrappers () {}
  6338. /**
  6339. * Retrieve list of registered socket transports
  6340. * @link http://www.php.net/manual/en/function.stream-get-transports.php
  6341. * @return array an indexed array of socket transports names.
  6342. */
  6343. function stream_get_transports () {}
  6344. /**
  6345. * Checks if a stream is a local stream
  6346. * @link http://www.php.net/manual/en/function.stream-is-local.php
  6347. * @param stream_or_url mixed <p>
  6348. * The stream resource or URL to check.
  6349. * </p>
  6350. * @return bool Returns true on success or false on failure.
  6351. */
  6352. function stream_is_local ($stream_or_url) {}
  6353. /**
  6354. * Fetches all the headers sent by the server in response to a HTTP request
  6355. * @link http://www.php.net/manual/en/function.get-headers.php
  6356. * @param url string <p>
  6357. * The target URL.
  6358. * </p>
  6359. * @param format int[optional] <p>
  6360. * If the optional format parameter is set to non-zero,
  6361. * get_headers parses the response and sets the
  6362. * array's keys.
  6363. * </p>
  6364. * @return array an indexed or associative array with the headers, or false on
  6365. * failure.
  6366. */
  6367. function get_headers ($url, $format = null) {}
  6368. /**
  6369. * Set timeout period on a stream
  6370. * @link http://www.php.net/manual/en/function.stream-set-timeout.php
  6371. * @param stream resource <p>
  6372. * The target stream.
  6373. * </p>
  6374. * @param seconds int <p>
  6375. * The seconds part of the timeout to be set.
  6376. * </p>
  6377. * @param microseconds int[optional] <p>
  6378. * The microseconds part of the timeout to be set.
  6379. * </p>
  6380. * @return bool Returns true on success or false on failure.
  6381. */
  6382. function stream_set_timeout ($stream, $seconds, $microseconds = null) {}
  6383. /**
  6384. * &Alias; <function>stream_set_timeout</function>
  6385. * @link http://www.php.net/manual/en/function.socket-set-timeout.php
  6386. * @param stream
  6387. * @param seconds
  6388. * @param microseconds
  6389. */
  6390. function socket_set_timeout ($stream, $seconds, $microseconds) {}
  6391. /**
  6392. * &Alias; <function>stream_get_meta_data</function>
  6393. * @link http://www.php.net/manual/en/function.socket-get-status.php
  6394. * @param fp
  6395. */
  6396. function socket_get_status ($fp) {}
  6397. /**
  6398. * Returns canonicalized absolute pathname
  6399. * @link http://www.php.net/manual/en/function.realpath.php
  6400. * @param path string <p>
  6401. * The path being checked.
  6402. * </p>
  6403. * @return string the canonicalized absolute pathname on success. The resulting path
  6404. * will have no symbolic link, '/./' or '/../' components.
  6405. * </p>
  6406. * <p>
  6407. * realpath returns false on failure, e.g. if
  6408. * the file does not exist.
  6409. * </p>
  6410. * <p>
  6411. * The running script must have executable permissions on all directories in
  6412. * the hierarchy, otherwise realpath will return
  6413. * false.
  6414. */
  6415. function realpath ($path) {}
  6416. /**
  6417. * Match filename against a pattern
  6418. * @link http://www.php.net/manual/en/function.fnmatch.php
  6419. * @param pattern string <p>
  6420. * The shell wildcard pattern.
  6421. * </p>
  6422. * @param string string <p>
  6423. * The tested string. This function is especially useful for filenames,
  6424. * but may also be used on regular strings.
  6425. * </p>
  6426. * <p>
  6427. * The average user may be used to shell patterns or at least in their
  6428. * simplest form to '?' and '*'
  6429. * wildcards so using fnmatch instead of
  6430. * preg_match for
  6431. * frontend search expression input may be way more convenient for
  6432. * non-programming users.
  6433. * </p>
  6434. * @param flags int[optional] <p>
  6435. * The value of flags can be any combination of
  6436. * the following flags, joined with the
  6437. * binary OR (|) operator.
  6438. * <table>
  6439. * A list of possible flags for fnmatch
  6440. * <tr valign="top">
  6441. * <td>Flag</td>
  6442. * <td>Description</td>
  6443. * </tr>
  6444. * <tr valign="top">
  6445. * <td>FNM_NOESCAPE</td>
  6446. * <td>
  6447. * Disable backslash escaping.
  6448. * </td>
  6449. * </tr>
  6450. * <tr valign="top">
  6451. * <td>FNM_PATHNAME</td>
  6452. * <td>
  6453. * Slash in string only matches slash in the given pattern.
  6454. * </td>
  6455. * </tr>
  6456. * <tr valign="top">
  6457. * <td>FNM_PERIOD</td>
  6458. * <td>
  6459. * Leading period in string must be exactly matched by period in the given pattern.
  6460. * </td>
  6461. * </tr>
  6462. * <tr valign="top">
  6463. * <td>FNM_CASEFOLD</td>
  6464. * <td>
  6465. * Caseless match. Part of the GNU extension.
  6466. * </td>
  6467. * </tr>
  6468. * </table>
  6469. * </p>
  6470. * @return bool true if there is a match, false otherwise.
  6471. */
  6472. function fnmatch ($pattern, $string, $flags = null) {}
  6473. /**
  6474. * Open Internet or Unix domain socket connection
  6475. * @link http://www.php.net/manual/en/function.fsockopen.php
  6476. * @param hostname string <p>
  6477. * If you have compiled in OpenSSL support, you may prefix the
  6478. * hostname with either ssl://
  6479. * or tls:// to use an SSL or TLS client connection
  6480. * over TCP/IP to connect to the remote host.
  6481. * </p>
  6482. * @param port int[optional] <p>
  6483. * The port number.
  6484. * </p>
  6485. * @param errno int[optional] <p>
  6486. * If provided, holds the system level error number that occurred in the
  6487. * system-level connect() call.
  6488. * </p>
  6489. * <p>
  6490. * If the value returned in errno is
  6491. * 0 and the function returned false, it is an
  6492. * indication that the error occurred before the
  6493. * connect() call. This is most likely due to a
  6494. * problem initializing the socket.
  6495. * </p>
  6496. * @param errstr string[optional] <p>
  6497. * The error message as a string.
  6498. * </p>
  6499. * @param timeout float[optional] <p>
  6500. * The connection timeout, in seconds.
  6501. * </p>
  6502. * <p>
  6503. * If you need to set a timeout for reading/writing data over the
  6504. * socket, use stream_set_timeout, as the
  6505. * timeout parameter to
  6506. * fsockopen only applies while connecting the
  6507. * socket.
  6508. * </p>
  6509. * @return resource fsockopen returns a file pointer which may be used
  6510. * together with the other file functions (such as
  6511. * fgets, fgetss,
  6512. * fwrite, fclose, and
  6513. * feof). If the call fails, it will return false
  6514. */
  6515. function fsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  6516. /**
  6517. * Open persistent Internet or Unix domain socket connection
  6518. * @link http://www.php.net/manual/en/function.pfsockopen.php
  6519. * @param hostname string
  6520. * @param port int[optional]
  6521. * @param errno int[optional]
  6522. * @param errstr string[optional]
  6523. * @param timeout float[optional]
  6524. * @return resource
  6525. */
  6526. function pfsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  6527. /**
  6528. * Pack data into binary string
  6529. * @link http://www.php.net/manual/en/function.pack.php
  6530. * @param format string <p>
  6531. * The format string consists of format codes
  6532. * followed by an optional repeater argument. The repeater argument can
  6533. * be either an integer value or * for repeating to
  6534. * the end of the input data. For a, A, h, H the repeat count specifies
  6535. * how many characters of one data argument are taken, for @ it is the
  6536. * absolute position where to put the next data, for everything else the
  6537. * repeat count specifies how many data arguments are consumed and packed
  6538. * into the resulting binary string.
  6539. * </p>
  6540. * <p>
  6541. * Currently implemented formats are:
  6542. * <table>
  6543. * pack format characters
  6544. * <tr valign="top">
  6545. * <td>Code</td>
  6546. * <td>Description</td>
  6547. * </tr>
  6548. * <tr valign="top">
  6549. * <td>a</td>
  6550. * <td>NUL-padded string</td>
  6551. * </tr>
  6552. * <tr valign="top">
  6553. * <td>A</td>
  6554. * <td>SPACE-padded string</td></tr>
  6555. * <tr valign="top">
  6556. * <td>h</td>
  6557. * <td>Hex string, low nibble first</td></tr>
  6558. * <tr valign="top">
  6559. * <td>H</td>
  6560. * <td>Hex string, high nibble first</td></tr>
  6561. * <tr valign="top"><td>c</td><td>signed char</td></tr>
  6562. * <tr valign="top">
  6563. * <td>C</td>
  6564. * <td>unsigned char</td></tr>
  6565. * <tr valign="top">
  6566. * <td>s</td>
  6567. * <td>signed short (always 16 bit, machine byte order)</td>
  6568. * </tr>
  6569. * <tr valign="top">
  6570. * <td>S</td>
  6571. * <td>unsigned short (always 16 bit, machine byte order)</td>
  6572. * </tr>
  6573. * <tr valign="top">
  6574. * <td>n</td>
  6575. * <td>unsigned short (always 16 bit, big endian byte order)</td>
  6576. * </tr>
  6577. * <tr valign="top">
  6578. * <td>v</td>
  6579. * <td>unsigned short (always 16 bit, little endian byte order)</td>
  6580. * </tr>
  6581. * <tr valign="top">
  6582. * <td>i</td>
  6583. * <td>signed integer (machine dependent size and byte order)</td>
  6584. * </tr>
  6585. * <tr valign="top">
  6586. * <td>I</td>
  6587. * <td>unsigned integer (machine dependent size and byte order)</td>
  6588. * </tr>
  6589. * <tr valign="top">
  6590. * <td>l</td>
  6591. * <td>signed long (always 32 bit, machine byte order)</td>
  6592. * </tr>
  6593. * <tr valign="top">
  6594. * <td>L</td>
  6595. * <td>unsigned long (always 32 bit, machine byte order)</td>
  6596. * </tr>
  6597. * <tr valign="top">
  6598. * <td>N</td>
  6599. * <td>unsigned long (always 32 bit, big endian byte order)</td>
  6600. * </tr>
  6601. * <tr valign="top">
  6602. * <td>V</td>
  6603. * <td>unsigned long (always 32 bit, little endian byte order)</td>
  6604. * </tr>
  6605. * <tr valign="top">
  6606. * <td>f</td>
  6607. * <td>float (machine dependent size and representation)</td>
  6608. * </tr>
  6609. * <tr valign="top">
  6610. * <td>d</td>
  6611. * <td>double (machine dependent size and representation)</td>
  6612. * </tr>
  6613. * <tr valign="top">
  6614. * <td>x</td>
  6615. * <td>NUL byte</td>
  6616. * </tr>
  6617. * <tr valign="top">
  6618. * <td>X</td>
  6619. * <td>Back up one byte</td>
  6620. * </tr>
  6621. * <tr valign="top">
  6622. * <td>@</td>
  6623. * <td>NUL-fill to absolute position</td>
  6624. * </tr>
  6625. * </table>
  6626. * </p>
  6627. * @param args mixed[optional] <p>
  6628. * </p>
  6629. * @param _ mixed[optional]
  6630. * @return string a binary string containing data.
  6631. */
  6632. function pack ($format, $args = null, $_ = null) {}
  6633. /**
  6634. * Unpack data from binary string
  6635. * @link http://www.php.net/manual/en/function.unpack.php
  6636. * @param format string <p>
  6637. * See pack for an explanation of the format codes.
  6638. * </p>
  6639. * @param data string <p>
  6640. * The packed data.
  6641. * </p>
  6642. * @return array an associative array containing unpacked elements of binary
  6643. * string.
  6644. */
  6645. function unpack ($format, $data) {}
  6646. /**
  6647. * Tells what the user's browser is capable of
  6648. * @link http://www.php.net/manual/en/function.get-browser.php
  6649. * @param user_agent string[optional] <p>
  6650. * The User Agent to be analyzed. By default, the value of HTTP
  6651. * User-Agent header is used; however, you can alter this (i.e., look up
  6652. * another browser's info) by passing this parameter.
  6653. * </p>
  6654. * <p>
  6655. * You can bypass this parameter with a &null; value.
  6656. * </p>
  6657. * @param return_array bool[optional] <p>
  6658. * If set to true, this function will return an array
  6659. * instead of an object.
  6660. * </p>
  6661. * @return mixed The information is returned in an object or an array which will contain
  6662. * various data elements representing, for instance, the browser's major and
  6663. * minor version numbers and ID string; true/false values for features
  6664. * such as frames, JavaScript, and cookies; and so forth.
  6665. * </p>
  6666. * <p>
  6667. * The cookies value simply means that the browser
  6668. * itself is capable of accepting cookies and does not mean the user has
  6669. * enabled the browser to accept cookies or not. The only way to test if
  6670. * cookies are accepted is to set one with setcookie,
  6671. * reload, and check for the value.
  6672. */
  6673. function get_browser ($user_agent = null, $return_array = null) {}
  6674. /**
  6675. * One-way string hashing
  6676. * @link http://www.php.net/manual/en/function.crypt.php
  6677. * @param str string <p>
  6678. * The string to be hashed.
  6679. * </p>
  6680. * @param salt string[optional] <p>
  6681. * An optional salt string to base the hashing on. If not provided,
  6682. * one will be randomly generated by PHP each time you call this function.
  6683. * </p>
  6684. * <p>
  6685. * If you are using the supplied salt, you should be aware that the salt
  6686. * is generated once. If you are calling this function repeatedly, this
  6687. * may impact both appearance and security.
  6688. * </p>
  6689. * @return string the hashed string or a string that is shorter than 13 characters
  6690. * and is guaranteed to differ from the salt on failure.
  6691. */
  6692. function crypt ($str, $salt = null) {}
  6693. /**
  6694. * Open directory handle
  6695. * @link http://www.php.net/manual/en/function.opendir.php
  6696. * @param path string <p>
  6697. * The directory path that is to be opened
  6698. * </p>
  6699. * @param context resource[optional] <p>
  6700. * For a description of the context parameter,
  6701. * refer to the streams section of
  6702. * the manual.
  6703. * </p>
  6704. * @return resource a directory handle resource on success, or
  6705. * false on failure.
  6706. * </p>
  6707. * <p>
  6708. * If path is not a valid directory or the
  6709. * directory can not be opened due to permission restrictions or
  6710. * filesystem errors, opendir returns false and
  6711. * generates a PHP error of level
  6712. * E_WARNING. You can suppress the error output of
  6713. * opendir by prepending
  6714. * '@' to the
  6715. * front of the function name.
  6716. */
  6717. function opendir ($path, $context = null) {}
  6718. /**
  6719. * Close directory handle
  6720. * @link http://www.php.net/manual/en/function.closedir.php
  6721. * @param dir_handle resource[optional] <p>
  6722. * The directory handle resource previously opened
  6723. * with opendir. If the directory handle is
  6724. * not specified, the last link opened by opendir
  6725. * is assumed.
  6726. * </p>
  6727. * @return void
  6728. */
  6729. function closedir ($dir_handle = null) {}
  6730. /**
  6731. * Change directory
  6732. * @link http://www.php.net/manual/en/function.chdir.php
  6733. * @param directory string <p>
  6734. * The new current directory
  6735. * </p>
  6736. * @return bool Returns true on success or false on failure.
  6737. */
  6738. function chdir ($directory) {}
  6739. /**
  6740. * Gets the current working directory
  6741. * @link http://www.php.net/manual/en/function.getcwd.php
  6742. * @return string the current working directory on success, or false on
  6743. * failure.
  6744. * </p>
  6745. * <p>
  6746. * On some Unix variants, getcwd will return
  6747. * false if any one of the parent directories does not have the
  6748. * readable or search mode set, even if the current directory
  6749. * does. See chmod for more information on
  6750. * modes and permissions.
  6751. */
  6752. function getcwd () {}
  6753. /**
  6754. * Rewind directory handle
  6755. * @link http://www.php.net/manual/en/function.rewinddir.php
  6756. * @param dir_handle resource[optional] <p>
  6757. * The directory handle resource previously opened
  6758. * with opendir. If the directory handle is
  6759. * not specified, the last link opened by opendir
  6760. * is assumed.
  6761. * </p>
  6762. * @return void
  6763. */
  6764. function rewinddir ($dir_handle = null) {}
  6765. /**
  6766. * Read entry from directory handle
  6767. * @link http://www.php.net/manual/en/function.readdir.php
  6768. * @param dir_handle resource[optional] <p>
  6769. * The directory handle resource previously opened
  6770. * with opendir. If the directory handle is
  6771. * not specified, the last link opened by opendir
  6772. * is assumed.
  6773. * </p>
  6774. * @return string the filename on success&return.falseforfailure;.
  6775. */
  6776. function readdir ($dir_handle = null) {}
  6777. /**
  6778. * Return an instance of the Directory class
  6779. * @link http://www.php.net/manual/en/class.dir.php
  6780. * @param directory
  6781. * @param context[optional]
  6782. * @return string
  6783. */
  6784. function dir ($directory, $context) {}
  6785. /**
  6786. * List files and directories inside the specified path
  6787. * @link http://www.php.net/manual/en/function.scandir.php
  6788. * @param directory string <p>
  6789. * The directory that will be scanned.
  6790. * </p>
  6791. * @param sorting_order int[optional] <p>
  6792. * By default, the sorted order is alphabetical in ascending order. If
  6793. * the optional sorting_order is set to non-zero,
  6794. * then the sort order is alphabetical in descending order.
  6795. * </p>
  6796. * @param context resource[optional] <p>
  6797. * For a description of the context parameter,
  6798. * refer to the streams section of
  6799. * the manual.
  6800. * </p>
  6801. * @return array an array of filenames on success, or false on
  6802. * failure. If directory is not a directory, then
  6803. * boolean false is returned, and an error of level
  6804. * E_WARNING is generated.
  6805. */
  6806. function scandir ($directory, $sorting_order = null, $context = null) {}
  6807. /**
  6808. * Find pathnames matching a pattern
  6809. * @link http://www.php.net/manual/en/function.glob.php
  6810. * @param pattern string <p>
  6811. * The pattern. No tilde expansion or parameter substitution is done.
  6812. * </p>
  6813. * @param flags int[optional] <p>
  6814. * Valid flags:
  6815. * GLOB_MARK - Adds a slash to each directory returned
  6816. * @return array an array containing the matched files/directories, an empty array
  6817. * if no file matched or false on error.
  6818. * </p>
  6819. * <p>
  6820. * On some systems it is impossible to distinguish between empty match and an
  6821. * error.
  6822. */
  6823. function glob ($pattern, $flags = null) {}
  6824. /**
  6825. * Gets last access time of file
  6826. * @link http://www.php.net/manual/en/function.fileatime.php
  6827. * @param filename string <p>
  6828. * Path to the file.
  6829. * </p>
  6830. * @return int the time the file was last accessed, &return.falseforfailure;.
  6831. * The time is returned as a Unix timestamp.
  6832. */
  6833. function fileatime ($filename) {}
  6834. /**
  6835. * Gets inode change time of file
  6836. * @link http://www.php.net/manual/en/function.filectime.php
  6837. * @param filename string <p>
  6838. * Path to the file.
  6839. * </p>
  6840. * @return int the time the file was last changed, &return.falseforfailure;.
  6841. * The time is returned as a Unix timestamp.
  6842. */
  6843. function filectime ($filename) {}
  6844. /**
  6845. * Gets file group
  6846. * @link http://www.php.net/manual/en/function.filegroup.php
  6847. * @param filename string <p>
  6848. * Path to the file.
  6849. * </p>
  6850. * @return int the group ID of the file, or false in case
  6851. * of an error. The group ID is returned in numerical format, use
  6852. * posix_getgrgid to resolve it to a group name.
  6853. * Upon failure, false is returned.
  6854. */
  6855. function filegroup ($filename) {}
  6856. /**
  6857. * Gets file inode
  6858. * @link http://www.php.net/manual/en/function.fileinode.php
  6859. * @param filename string <p>
  6860. * Path to the file.
  6861. * </p>
  6862. * @return int the inode number of the file, &return.falseforfailure;.
  6863. */
  6864. function fileinode ($filename) {}
  6865. /**
  6866. * Gets file modification time
  6867. * @link http://www.php.net/manual/en/function.filemtime.php
  6868. * @param filename string <p>
  6869. * Path to the file.
  6870. * </p>
  6871. * @return int the time the file was last modified, &return.falseforfailure;.
  6872. * The time is returned as a Unix timestamp, which is
  6873. * suitable for the date function.
  6874. */
  6875. function filemtime ($filename) {}
  6876. /**
  6877. * Gets file owner
  6878. * @link http://www.php.net/manual/en/function.fileowner.php
  6879. * @param filename string <p>
  6880. * Path to the file.
  6881. * </p>
  6882. * @return int the user ID of the owner of the file, &return.falseforfailure;.
  6883. * The user ID is returned in numerical format, use
  6884. * posix_getpwuid to resolve it to a username.
  6885. */
  6886. function fileowner ($filename) {}
  6887. /**
  6888. * Gets file permissions
  6889. * @link http://www.php.net/manual/en/function.fileperms.php
  6890. * @param filename string <p>
  6891. * Path to the file.
  6892. * </p>
  6893. * @return int the permissions on the file, &return.falseforfailure;.
  6894. */
  6895. function fileperms ($filename) {}
  6896. /**
  6897. * Gets file size
  6898. * @link http://www.php.net/manual/en/function.filesize.php
  6899. * @param filename string <p>
  6900. * Path to the file.
  6901. * </p>
  6902. * @return int the size of the file in bytes, or false (and generates an error
  6903. * of level E_WARNING) in case of an error.
  6904. */
  6905. function filesize ($filename) {}
  6906. /**
  6907. * Gets file type
  6908. * @link http://www.php.net/manual/en/function.filetype.php
  6909. * @param filename string <p>
  6910. * Path to the file.
  6911. * </p>
  6912. * @return string the type of the file. Possible values are fifo, char,
  6913. * dir, block, link, file, socket and unknown.
  6914. * </p>
  6915. * <p>
  6916. * Returns false if an error occurs. filetype will also
  6917. * produce an E_NOTICE message if the stat call fails
  6918. * or if the file type is unknown.
  6919. */
  6920. function filetype ($filename) {}
  6921. /**
  6922. * Checks whether a file or directory exists
  6923. * @link http://www.php.net/manual/en/function.file-exists.php
  6924. * @param filename string <p>
  6925. * Path to the file or directory.
  6926. * </p>
  6927. * <p>
  6928. * On windows, use //computername/share/filename or
  6929. * \\computername\share\filename to check files on
  6930. * network shares.
  6931. * </p>
  6932. * @return bool true if the file or directory specified by
  6933. * filename exists; false otherwise.
  6934. * </p>
  6935. * <p>
  6936. * This function will return false for symlinks pointing to non-existing
  6937. * files.
  6938. * </p>
  6939. * <p>
  6940. * This function returns false for files inaccessible due to safe mode restrictions. However these
  6941. * files still can be included if
  6942. * they are located in safe_mode_include_dir.
  6943. * </p>
  6944. * <p>
  6945. * The check is done using the real UID/GID instead of the effective one.
  6946. */
  6947. function file_exists ($filename) {}
  6948. /**
  6949. * Tells whether the filename is writable
  6950. * @link http://www.php.net/manual/en/function.is-writable.php
  6951. * @param filename string <p>
  6952. * The filename being checked.
  6953. * </p>
  6954. * @return bool true if the filename exists and is
  6955. * writable.
  6956. */
  6957. function is_writable ($filename) {}
  6958. /**
  6959. * &Alias; <function>is_writable</function>
  6960. * @link http://www.php.net/manual/en/function.is-writeable.php
  6961. * @param filename
  6962. */
  6963. function is_writeable ($filename) {}
  6964. /**
  6965. * Tells whether a file exists and is readable
  6966. * @link http://www.php.net/manual/en/function.is-readable.php
  6967. * @param filename string <p>
  6968. * Path to the file.
  6969. * </p>
  6970. * @return bool true if the file or directory specified by
  6971. * filename exists and is readable, false otherwise.
  6972. */
  6973. function is_readable ($filename) {}
  6974. /**
  6975. * Tells whether the filename is executable
  6976. * @link http://www.php.net/manual/en/function.is-executable.php
  6977. * @param filename string <p>
  6978. * Path to the file.
  6979. * </p>
  6980. * @return bool true if the filename exists and is executable, or false on
  6981. * error.
  6982. */
  6983. function is_executable ($filename) {}
  6984. /**
  6985. * Tells whether the filename is a regular file
  6986. * @link http://www.php.net/manual/en/function.is-file.php
  6987. * @param filename string <p>
  6988. * Path to the file.
  6989. * </p>
  6990. * @return bool true if the filename exists and is a regular file, false
  6991. * otherwise.
  6992. */
  6993. function is_file ($filename) {}
  6994. /**
  6995. * Tells whether the filename is a directory
  6996. * @link http://www.php.net/manual/en/function.is-dir.php
  6997. * @param filename string <p>
  6998. * Path to the file. If filename is a relative
  6999. * filename, it will be checked relative to the current working
  7000. * directory. If filename is a symbolic or hard link
  7001. * then the link will be resolved and checked. If you have enabled &safemode;,
  7002. * or open_basedir further
  7003. * restrictions may apply.
  7004. * </p>
  7005. * @return bool true if the filename exists and is a directory, false
  7006. * otherwise.
  7007. */
  7008. function is_dir ($filename) {}
  7009. /**
  7010. * Tells whether the filename is a symbolic link
  7011. * @link http://www.php.net/manual/en/function.is-link.php
  7012. * @param filename string <p>
  7013. * Path to the file.
  7014. * </p>
  7015. * @return bool true if the filename exists and is a symbolic link, false
  7016. * otherwise.
  7017. */
  7018. function is_link ($filename) {}
  7019. /**
  7020. * Gives information about a file
  7021. * @link http://www.php.net/manual/en/function.stat.php
  7022. * @param filename string <p>
  7023. * Path to the file.
  7024. * </p>
  7025. * @return array <table>
  7026. * stat and fstat result
  7027. * format
  7028. * <tr valign="top">
  7029. * <td>Numeric</td>
  7030. * <td>Associative (since PHP 4.0.6)</td>
  7031. * <td>Description</td>
  7032. * </tr>
  7033. * <tr valign="top">
  7034. * <td>0</td>
  7035. * <td>dev</td>
  7036. * <td>device number</td>
  7037. * </tr>
  7038. * <tr valign="top">
  7039. * <td>1</td>
  7040. * <td>ino</td>
  7041. * <td>inode number *</td>
  7042. * </tr>
  7043. * <tr valign="top">
  7044. * <td>2</td>
  7045. * <td>mode</td>
  7046. * <td>inode protection mode</td>
  7047. * </tr>
  7048. * <tr valign="top">
  7049. * <td>3</td>
  7050. * <td>nlink</td>
  7051. * <td>number of links</td>
  7052. * </tr>
  7053. * <tr valign="top">
  7054. * <td>4</td>
  7055. * <td>uid</td>
  7056. * <td>userid of owner *</td>
  7057. * </tr>
  7058. * <tr valign="top">
  7059. * <td>5</td>
  7060. * <td>gid</td>
  7061. * <td>groupid of owner *</td>
  7062. * </tr>
  7063. * <tr valign="top">
  7064. * <td>6</td>
  7065. * <td>rdev</td>
  7066. * <td>device type, if inode device</td>
  7067. * </tr>
  7068. * <tr valign="top">
  7069. * <td>7</td>
  7070. * <td>size</td>
  7071. * <td>size in bytes</td>
  7072. * </tr>
  7073. * <tr valign="top">
  7074. * <td>8</td>
  7075. * <td>atime</td>
  7076. * <td>time of last access (Unix timestamp)</td>
  7077. * </tr>
  7078. * <tr valign="top">
  7079. * <td>9</td>
  7080. * <td>mtime</td>
  7081. * <td>time of last modification (Unix timestamp)</td>
  7082. * </tr>
  7083. * <tr valign="top">
  7084. * <td>10</td>
  7085. * <td>ctime</td>
  7086. * <td>time of last inode change (Unix timestamp)</td>
  7087. * </tr>
  7088. * <tr valign="top">
  7089. * <td>11</td>
  7090. * <td>blksize</td>
  7091. * <td>blocksize of filesystem IO **</td>
  7092. * </tr>
  7093. * <tr valign="top">
  7094. * <td>12</td>
  7095. * <td>blocks</td>
  7096. * <td>number of 512-byte blocks allocated **</td>
  7097. * </tr>
  7098. * </table>
  7099. * * On Windows this will always be 0.
  7100. * </p>
  7101. * <p>
  7102. * ** Only valid on systems supporting the st_blksize type - other
  7103. * systems (e.g. Windows) return -1.
  7104. * </p>
  7105. * <p>
  7106. * In case of error, stat returns false.
  7107. */
  7108. function stat ($filename) {}
  7109. /**
  7110. * Gives information about a file or symbolic link
  7111. * @link http://www.php.net/manual/en/function.lstat.php
  7112. * @param filename string <p>
  7113. * Path to a file or a symbolic link.
  7114. * </p>
  7115. * @return array See the manual page for stat for information on
  7116. * the structure of the array that lstat returns.
  7117. * This function is identical to the stat function
  7118. * except that if the filename parameter is a symbolic
  7119. * link, the status of the symbolic link is returned, not the status of the
  7120. * file pointed to by the symbolic link.
  7121. */
  7122. function lstat ($filename) {}
  7123. /**
  7124. * Changes file owner
  7125. * @link http://www.php.net/manual/en/function.chown.php
  7126. * @param filename string <p>
  7127. * Path to the file.
  7128. * </p>
  7129. * @param user mixed <p>
  7130. * A user name or number.
  7131. * </p>
  7132. * @return bool Returns true on success or false on failure.
  7133. */
  7134. function chown ($filename, $user) {}
  7135. /**
  7136. * Changes file group
  7137. * @link http://www.php.net/manual/en/function.chgrp.php
  7138. * @param filename string <p>
  7139. * Path to the file.
  7140. * </p>
  7141. * @param group mixed <p>
  7142. * A group name or number.
  7143. * </p>
  7144. * @return bool Returns true on success or false on failure.
  7145. */
  7146. function chgrp ($filename, $group) {}
  7147. /**
  7148. * Changes file mode
  7149. * @link http://www.php.net/manual/en/function.chmod.php
  7150. * @param filename string <p>
  7151. * Path to the file.
  7152. * </p>
  7153. * @param mode int <p>
  7154. * Note that mode is not automatically
  7155. * assumed to be an octal value, so strings (such as "g+w") will
  7156. * not work properly. To ensure the expected operation,
  7157. * you need to prefix mode with a zero (0):
  7158. * </p>
  7159. * <p>
  7160. * ]]>
  7161. * </p>
  7162. * <p>
  7163. * The mode parameter consists of three octal
  7164. * number components specifying access restrictions for the owner,
  7165. * the user group in which the owner is in, and to everybody else in
  7166. * this order. One component can be computed by adding up the needed
  7167. * permissions for that target user base. Number 1 means that you
  7168. * grant execute rights, number 2 means that you make the file
  7169. * writeable, number 4 means that you make the file readable. Add
  7170. * up these numbers to specify needed rights. You can also read more
  7171. * about modes on Unix systems with 'man 1 chmod'
  7172. * and 'man 2 chmod'.
  7173. * </p>
  7174. * <p>
  7175. * @return bool Returns true on success or false on failure.
  7176. */
  7177. function chmod ($filename, $mode) {}
  7178. /**
  7179. * Sets access and modification time of file
  7180. * @link http://www.php.net/manual/en/function.touch.php
  7181. * @param filename string <p>
  7182. * The name of the file being touched.
  7183. * </p>
  7184. * @param time int[optional] <p>
  7185. * The touch time. If time is not supplied,
  7186. * the current system time is used.
  7187. * </p>
  7188. * @param atime int[optional] <p>
  7189. * If present, the access time of the given filename is set to
  7190. * the value of atime. Otherwise, it is set to
  7191. * time.
  7192. * </p>
  7193. * @return bool Returns true on success or false on failure.
  7194. */
  7195. function touch ($filename, $time = null, $atime = null) {}
  7196. /**
  7197. * Clears file status cache
  7198. * @link http://www.php.net/manual/en/function.clearstatcache.php
  7199. * @param clear_realpath_cache bool[optional] <p>
  7200. * Whenever to clear realpath cache or not.
  7201. * </p>
  7202. * @param filename string[optional] <p>
  7203. * Clear realpath cache on a specific filename, only used if
  7204. * clear_realpath_cache is true.
  7205. * </p>
  7206. * @return void
  7207. */
  7208. function clearstatcache ($clear_realpath_cache = null, $filename = null) {}
  7209. /**
  7210. * Returns the total size of a directory
  7211. * @link http://www.php.net/manual/en/function.disk-total-space.php
  7212. * @param directory string <p>
  7213. * A directory of the filesystem or disk partition.
  7214. * </p>
  7215. * @return float the total number of bytes as a float
  7216. * &return.falseforfailure;.
  7217. */
  7218. function disk_total_space ($directory) {}
  7219. /**
  7220. * Returns available space in directory
  7221. * @link http://www.php.net/manual/en/function.disk-free-space.php
  7222. * @param directory string <p>
  7223. * A directory of the filesystem or disk partition.
  7224. * </p>
  7225. * <p>
  7226. * Given a file name instead of a directory, the behaviour of the
  7227. * function is unspecified and may differ between operating systems and
  7228. * PHP versions.
  7229. * </p>
  7230. * @return float the number of available bytes as a float
  7231. * &return.falseforfailure;.
  7232. */
  7233. function disk_free_space ($directory) {}
  7234. /**
  7235. * &Alias; <function>disk_free_space</function>
  7236. * @link http://www.php.net/manual/en/function.diskfreespace.php
  7237. * @param path
  7238. */
  7239. function diskfreespace ($path) {}
  7240. /**
  7241. * Send mail
  7242. * @link http://www.php.net/manual/en/function.mail.php
  7243. * @param to string <p>
  7244. * Receiver, or receivers of the mail.
  7245. * </p>
  7246. * <p>
  7247. * The formatting of this string must comply with
  7248. * RFC 2822. Some examples are:
  7249. * user@example.com
  7250. * user@example.com, anotheruser@example.com
  7251. * User &lt;user@example.com&gt;
  7252. * User &lt;user@example.com&gt;, Another User &lt;anotheruser@example.com&gt;
  7253. * </p>
  7254. * @param subject string <p>
  7255. * Subject of the email to be sent.
  7256. * </p>
  7257. * <p>
  7258. * Subject must satisfy RFC 2047.
  7259. * </p>
  7260. * @param message string <p>
  7261. * Message to be sent.
  7262. * </p>
  7263. * <p>
  7264. * Each line should be separated with a LF (\n). Lines should not be larger
  7265. * than 70 characters.
  7266. * </p>
  7267. * <p>
  7268. * (Windows only) When PHP is talking to a SMTP server directly, if a full
  7269. * stop is found on the start of a line, it is removed. To counter-act this,
  7270. * replace these occurrences with a double dot.
  7271. * ]]>
  7272. * </p>
  7273. * @param additional_headers string[optional] <p>
  7274. * String to be inserted at the end of the email header.
  7275. * </p>
  7276. * <p>
  7277. * This is typically used to add extra headers (From, Cc, and Bcc).
  7278. * Multiple extra headers should be separated with a CRLF (\r\n).
  7279. * </p>
  7280. * <p>
  7281. * When sending mail, the mail must contain
  7282. * a From header. This can be set with the
  7283. * additional_headers parameter, or a default
  7284. * can be set in &php.ini;.
  7285. * </p>
  7286. * <p>
  7287. * Failing to do this will result in an error
  7288. * message similar to Warning: mail(): "sendmail_from" not
  7289. * set in php.ini or custom "From:" header missing.
  7290. * The From header sets also
  7291. * Return-Path under Windows.
  7292. * </p>
  7293. * <p>
  7294. * If messages are not received, try using a LF (\n) only.
  7295. * Some poor quality Unix mail transfer agents replace LF by CRLF
  7296. * automatically (which leads to doubling CR if CRLF is used).
  7297. * This should be a last resort, as it does not comply with
  7298. * RFC 2822.
  7299. * </p>
  7300. * @param additional_parameters string[optional] <p>
  7301. * The additional_parameters parameter
  7302. * can be used to pass additional flags as command line options to the
  7303. * program configured to be used when sending mail, as defined by the
  7304. * sendmail_path configuration setting. For example,
  7305. * this can be used to set the envelope sender address when using
  7306. * sendmail with the -f sendmail option.
  7307. * </p>
  7308. * <p>
  7309. * The user that the webserver runs as should be added as a trusted user to the
  7310. * sendmail configuration to prevent a 'X-Warning' header from being added
  7311. * to the message when the envelope sender (-f) is set using this method.
  7312. * For sendmail users, this file is /etc/mail/trusted-users.
  7313. * </p>
  7314. * @return bool true if the mail was successfully accepted for delivery, false otherwise.
  7315. * </p>
  7316. * <p>
  7317. * It is important to note that just because the mail was accepted for delivery,
  7318. * it does NOT mean the mail will actually reach the intended destination.
  7319. */
  7320. function mail ($to, $subject, $message, $additional_headers = null, $additional_parameters = null) {}
  7321. /**
  7322. * Calculate the hash value needed by EZMLM
  7323. * @link http://www.php.net/manual/en/function.ezmlm-hash.php
  7324. * @param addr string <p>
  7325. * The email address that's being hashed.
  7326. * </p>
  7327. * @return int The hash value of addr.
  7328. */
  7329. function ezmlm_hash ($addr) {}
  7330. /**
  7331. * Open connection to system logger
  7332. * @link http://www.php.net/manual/en/function.openlog.php
  7333. * @param ident string <p>
  7334. * The string ident is added to each message.
  7335. * </p>
  7336. * @param option int <p>
  7337. * The option argument is used to indicate
  7338. * what logging options will be used when generating a log message.
  7339. * <table>
  7340. * openlog Options
  7341. * <tr valign="top">
  7342. * <td>Constant</td>
  7343. * <td>Description</td>
  7344. * </tr>
  7345. * <tr valign="top">
  7346. * <td>LOG_CONS</td>
  7347. * <td>
  7348. * if there is an error while sending data to the system logger,
  7349. * write directly to the system console
  7350. * </td>
  7351. * </tr>
  7352. * <tr valign="top">
  7353. * <td>LOG_NDELAY</td>
  7354. * <td>
  7355. * open the connection to the logger immediately
  7356. * </td>
  7357. * </tr>
  7358. * <tr valign="top">
  7359. * <td>LOG_ODELAY</td>
  7360. * <td>
  7361. * (default) delay opening the connection until the first
  7362. * message is logged
  7363. * </td>
  7364. * </tr>
  7365. * <tr valign="top">
  7366. * <td>LOG_PERROR</td>
  7367. * <td>print log message also to standard error</td>
  7368. * </tr>
  7369. * <tr valign="top">
  7370. * <td>LOG_PID</td>
  7371. * <td>include PID with each message</td>
  7372. * </tr>
  7373. * </table>
  7374. * You can use one or more of this options. When using multiple options
  7375. * you need to OR them, i.e. to open the connection
  7376. * immediately, write to the console and include the PID in each message,
  7377. * you will use: LOG_CONS | LOG_NDELAY | LOG_PID
  7378. * </p>
  7379. * @param facility int <p>
  7380. * The facility argument is used to specify what
  7381. * type of program is logging the message. This allows you to specify
  7382. * (in your machine's syslog configuration) how messages coming from
  7383. * different facilities will be handled.
  7384. * <table>
  7385. * openlog Facilities
  7386. * <tr valign="top">
  7387. * <td>Constant</td>
  7388. * <td>Description</td>
  7389. * </tr>
  7390. * <tr valign="top">
  7391. * <td>LOG_AUTH</td>
  7392. * <td>
  7393. * security/authorization messages (use
  7394. * LOG_AUTHPRIV instead
  7395. * in systems where that constant is defined)
  7396. * </td>
  7397. * </tr>
  7398. * <tr valign="top">
  7399. * <td>LOG_AUTHPRIV</td>
  7400. * <td>security/authorization messages (private)</td>
  7401. * </tr>
  7402. * <tr valign="top">
  7403. * <td>LOG_CRON</td>
  7404. * <td>clock daemon (cron and at)</td>
  7405. * </tr>
  7406. * <tr valign="top">
  7407. * <td>LOG_DAEMON</td>
  7408. * <td>other system daemons</td>
  7409. * </tr>
  7410. * <tr valign="top">
  7411. * <td>LOG_KERN</td>
  7412. * <td>kernel messages</td>
  7413. * </tr>
  7414. * <tr valign="top">
  7415. * <td>LOG_LOCAL0 ... LOG_LOCAL7</td>
  7416. * <td>reserved for local use, these are not available in Windows</td>
  7417. * </tr>
  7418. * <tr valign="top">
  7419. * <td>LOG_LPR</td>
  7420. * <td>line printer subsystem</td>
  7421. * </tr>
  7422. * <tr valign="top">
  7423. * <td>LOG_MAIL</td>
  7424. * <td>mail subsystem</td>
  7425. * </tr>
  7426. * <tr valign="top">
  7427. * <td>LOG_NEWS</td>
  7428. * <td>USENET news subsystem</td>
  7429. * </tr>
  7430. * <tr valign="top">
  7431. * <td>LOG_SYSLOG</td>
  7432. * <td>messages generated internally by syslogd</td>
  7433. * </tr>
  7434. * <tr valign="top">
  7435. * <td>LOG_USER</td>
  7436. * <td>generic user-level messages</td>
  7437. * </tr>
  7438. * <tr valign="top">
  7439. * <td>LOG_UUCP</td>
  7440. * <td>UUCP subsystem</td>
  7441. * </tr>
  7442. * </table>
  7443. * </p>
  7444. * <p>
  7445. * LOG_USER is the only valid log type under Windows
  7446. * operating systems
  7447. * </p>
  7448. * @return bool Returns true on success or false on failure.
  7449. */
  7450. function openlog ($ident, $option, $facility) {}
  7451. /**
  7452. * Generate a system log message
  7453. * @link http://www.php.net/manual/en/function.syslog.php
  7454. * @param priority int <p>
  7455. * priority is a combination of the facility and
  7456. * the level. Possible values are:
  7457. * <table>
  7458. * syslog Priorities (in descending order)
  7459. * <tr valign="top">
  7460. * <td>Constant</td>
  7461. * <td>Description</td>
  7462. * </tr>
  7463. * <tr valign="top">
  7464. * <td>LOG_EMERG</td>
  7465. * <td>system is unusable</td>
  7466. * </tr>
  7467. * <tr valign="top">
  7468. * <td>LOG_ALERT</td>
  7469. * <td>action must be taken immediately</td>
  7470. * </tr>
  7471. * <tr valign="top">
  7472. * <td>LOG_CRIT</td>
  7473. * <td>critical conditions</td>
  7474. * </tr>
  7475. * <tr valign="top">
  7476. * <td>LOG_ERR</td>
  7477. * <td>error conditions</td>
  7478. * </tr>
  7479. * <tr valign="top">
  7480. * <td>LOG_WARNING</td>
  7481. * <td>warning conditions</td>
  7482. * </tr>
  7483. * <tr valign="top">
  7484. * <td>LOG_NOTICE</td>
  7485. * <td>normal, but significant, condition</td>
  7486. * </tr>
  7487. * <tr valign="top">
  7488. * <td>LOG_INFO</td>
  7489. * <td>informational message</td>
  7490. * </tr>
  7491. * <tr valign="top">
  7492. * <td>LOG_DEBUG</td>
  7493. * <td>debug-level message</td>
  7494. * </tr>
  7495. * </table>
  7496. * </p>
  7497. * @param message string <p>
  7498. * The message to send, except that the two characters
  7499. * %m will be replaced by the error message string
  7500. * (strerror) corresponding to the present value of
  7501. * errno.
  7502. * </p>
  7503. * @return bool Returns true on success or false on failure.
  7504. */
  7505. function syslog ($priority, $message) {}
  7506. /**
  7507. * Close connection to system logger
  7508. * @link http://www.php.net/manual/en/function.closelog.php
  7509. * @return bool Returns true on success or false on failure.
  7510. */
  7511. function closelog () {}
  7512. /**
  7513. * Initializes all syslog related variables
  7514. * @link http://www.php.net/manual/en/function.define-syslog-variables.php
  7515. * @return void
  7516. */
  7517. function define_syslog_variables () {}
  7518. /**
  7519. * Combined linear congruential generator
  7520. * @link http://www.php.net/manual/en/function.lcg-value.php
  7521. * @return float A pseudo random float value in the range of (0, 1)
  7522. */
  7523. function lcg_value () {}
  7524. /**
  7525. * Calculate the metaphone key of a string
  7526. * @link http://www.php.net/manual/en/function.metaphone.php
  7527. * @param str string <p>
  7528. * The input string.
  7529. * </p>
  7530. * @param phones int[optional] <p>
  7531. * </p>
  7532. * @return string the metaphone key as a string.
  7533. */
  7534. function metaphone ($str, $phones = null) {}
  7535. /**
  7536. * Turn on output buffering
  7537. * @link http://www.php.net/manual/en/function.ob-start.php
  7538. * @param output_callback callback[optional] <p>
  7539. * An optional output_callback function may be
  7540. * specified. This function takes a string as a parameter and should
  7541. * return a string. The function will be called when
  7542. * the output buffer is flushed (sent) or cleaned (with
  7543. * ob_flush, ob_clean or similar
  7544. * function) or when the output buffer
  7545. * is flushed to the browser at the end of the request. When
  7546. * output_callback is called, it will receive the
  7547. * contents of the output buffer as its parameter and is expected to
  7548. * return a new output buffer as a result, which will be sent to the
  7549. * browser. If the output_callback is not a
  7550. * callable function, this function will return false.
  7551. * </p>
  7552. * <p>
  7553. * If the callback function has two parameters, the second parameter is
  7554. * filled with a bit-field consisting of
  7555. * PHP_OUTPUT_HANDLER_START,
  7556. * PHP_OUTPUT_HANDLER_CONT and
  7557. * PHP_OUTPUT_HANDLER_END.
  7558. * </p>
  7559. * <p>
  7560. * If output_callback returns false original
  7561. * input is sent to the browser.
  7562. * </p>
  7563. * <p>
  7564. * The output_callback parameter may be bypassed
  7565. * by passing a &null; value.
  7566. * </p>
  7567. * <p>
  7568. * ob_end_clean, ob_end_flush,
  7569. * ob_clean, ob_flush and
  7570. * ob_start may not be called from a callback
  7571. * function. If you call them from callback function, the behavior is
  7572. * undefined. If you would like to delete the contents of a buffer,
  7573. * return "" (a null string) from callback function.
  7574. * You can't even call functions using the output buffering functions like
  7575. * print_r($expression, true) or
  7576. * highlight_file($filename, true) from a callback
  7577. * function.
  7578. * </p>
  7579. * <p>
  7580. * In PHP 4.0.4, ob_gzhandler was introduced to
  7581. * facilitate sending gz-encoded data to web browsers that support
  7582. * compressed web pages. ob_gzhandler determines
  7583. * what type of content encoding the browser will accept and will return
  7584. * its output accordingly.
  7585. * </p>
  7586. * @param chunk_size int[optional] <p>
  7587. * If the optional parameter chunk_size is passed, the
  7588. * buffer will be flushed after any output call which causes the buffer's
  7589. * length to equal or exceed chunk_size.
  7590. * Default value 0 means that the function is called only in the end,
  7591. * other special value 1 sets chunk_size to 4096.
  7592. * </p>
  7593. * @param erase bool[optional] <p>
  7594. * If the optional parameter erase is set to false,
  7595. * the buffer will not be deleted until the script finishes.
  7596. * This causes that flushing and cleaning functions would issue a notice
  7597. * and return false if called.
  7598. * </p>
  7599. * @return bool Returns true on success or false on failure.
  7600. */
  7601. function ob_start ($output_callback = null, $chunk_size = null, $erase = null) {}
  7602. /**
  7603. * Flush (send) the output buffer
  7604. * @link http://www.php.net/manual/en/function.ob-flush.php
  7605. * @return void
  7606. */
  7607. function ob_flush () {}
  7608. /**
  7609. * Clean (erase) the output buffer
  7610. * @link http://www.php.net/manual/en/function.ob-clean.php
  7611. * @return void
  7612. */
  7613. function ob_clean () {}
  7614. /**
  7615. * Flush (send) the output buffer and turn off output buffering
  7616. * @link http://www.php.net/manual/en/function.ob-end-flush.php
  7617. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  7618. * function without an active buffer or that for some reason a buffer could
  7619. * not be deleted (possible for special buffer).
  7620. */
  7621. function ob_end_flush () {}
  7622. /**
  7623. * Clean (erase) the output buffer and turn off output buffering
  7624. * @link http://www.php.net/manual/en/function.ob-end-clean.php
  7625. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  7626. * function without an active buffer or that for some reason a buffer could
  7627. * not be deleted (possible for special buffer).
  7628. */
  7629. function ob_end_clean () {}
  7630. /**
  7631. * Flush the output buffer, return it as a string and turn off output buffering
  7632. * @link http://www.php.net/manual/en/function.ob-get-flush.php
  7633. * @return string the output buffer or false if no buffering is active.
  7634. */
  7635. function ob_get_flush () {}
  7636. /**
  7637. * Get current buffer contents and delete current output buffer
  7638. * @link http://www.php.net/manual/en/function.ob-get-clean.php
  7639. * @return string the contents of the output buffer and end output buffering.
  7640. * If output buffering isn't active then false is returned.
  7641. */
  7642. function ob_get_clean () {}
  7643. /**
  7644. * Return the length of the output buffer
  7645. * @link http://www.php.net/manual/en/function.ob-get-length.php
  7646. * @return int the length of the output buffer contents or false if no
  7647. * buffering is active.
  7648. */
  7649. function ob_get_length () {}
  7650. /**
  7651. * Return the nesting level of the output buffering mechanism
  7652. * @link http://www.php.net/manual/en/function.ob-get-level.php
  7653. * @return int the level of nested output buffering handlers or zero if output
  7654. * buffering is not active.
  7655. */
  7656. function ob_get_level () {}
  7657. /**
  7658. * Get status of output buffers
  7659. * @link http://www.php.net/manual/en/function.ob-get-status.php
  7660. * @param full_status bool[optional] <p>
  7661. * true to return all active output buffer levels. If false or not
  7662. * set, only the top level output buffer is returned.
  7663. * </p>
  7664. * @return array If called without the full_status parameter
  7665. * or with full_status = false a simple array
  7666. * with the following elements is returned:
  7667. * 2
  7668. * [type] => 0
  7669. * [status] => 0
  7670. * [name] => URL-Rewriter
  7671. * [del] => 1
  7672. * )
  7673. * ]]>
  7674. * Simple ob_get_status results
  7675. * KeyValue
  7676. * levelOutput nesting level
  7677. * typePHP_OUTPUT_HANDLER_INTERNAL (0) or PHP_OUTPUT_HANDLER_USER (1)
  7678. * statusOne of PHP_OUTPUT_HANDLER_START (0), PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2)
  7679. * nameName of active output handler or ' default output handler' if none is set
  7680. * delErase-flag as set by ob_start
  7681. * </p>
  7682. * <p>
  7683. * If called with full_status = true an array
  7684. * with one element for each active output buffer level is returned.
  7685. * The output level is used as key of the top level array and each array
  7686. * element itself is another array holding status information
  7687. * on one active output level.
  7688. * Array
  7689. * (
  7690. * [chunk_size] => 0
  7691. * [size] => 40960
  7692. * [block_size] => 10240
  7693. * [type] => 1
  7694. * [status] => 0
  7695. * [name] => default output handler
  7696. * [del] => 1
  7697. * )
  7698. * [1] => Array
  7699. * (
  7700. * [chunk_size] => 0
  7701. * [size] => 40960
  7702. * [block_size] => 10240
  7703. * [type] => 0
  7704. * [buffer_size] => 0
  7705. * [status] => 0
  7706. * [name] => URL-Rewriter
  7707. * [del] => 1
  7708. * )
  7709. * )
  7710. * ]]>
  7711. * </p>
  7712. * <p>
  7713. * The full output contains these additional elements:
  7714. * Full ob_get_status results
  7715. * KeyValue
  7716. * chunk_sizeChunk size as set by ob_start
  7717. * size...
  7718. * blocksize...
  7719. */
  7720. function ob_get_status ($full_status = null) {}
  7721. /**
  7722. * Return the contents of the output buffer
  7723. * @link http://www.php.net/manual/en/function.ob-get-contents.php
  7724. * @return string This will return the contents of the output buffer or false, if output
  7725. * buffering isn't active.
  7726. */
  7727. function ob_get_contents () {}
  7728. /**
  7729. * Turn implicit flush on/off
  7730. * @link http://www.php.net/manual/en/function.ob-implicit-flush.php
  7731. * @param flag int[optional] <p>
  7732. * true to turn implicit flushing on, false otherwise.
  7733. * </p>
  7734. * @return void
  7735. */
  7736. function ob_implicit_flush ($flag = null) {}
  7737. /**
  7738. * List all output handlers in use
  7739. * @link http://www.php.net/manual/en/function.ob-list-handlers.php
  7740. * @return array This will return an array with the output handlers in use (if any). If
  7741. * output_buffering is enabled or
  7742. * an anonymous function was used with ob_start,
  7743. * ob_list_handlers will return "default output
  7744. * handler".
  7745. */
  7746. function ob_list_handlers () {}
  7747. /**
  7748. * Sort an array by key
  7749. * @link http://www.php.net/manual/en/function.ksort.php
  7750. * @param array array <p>
  7751. * The input array.
  7752. * </p>
  7753. * @param sort_flags int[optional] <p>
  7754. * You may modify the behavior of the sort using the optional
  7755. * parameter sort_flags, for details
  7756. * see sort.
  7757. * </p>
  7758. * @return bool Returns true on success or false on failure.
  7759. */
  7760. function ksort (array &$array, $sort_flags = null) {}
  7761. /**
  7762. * Sort an array by key in reverse order
  7763. * @link http://www.php.net/manual/en/function.krsort.php
  7764. * @param array array <p>
  7765. * The input array.
  7766. * </p>
  7767. * @param sort_flags int[optional] <p>
  7768. * You may modify the behavior of the sort using the optional parameter
  7769. * sort_flags, for details see
  7770. * sort.
  7771. * </p>
  7772. * @return bool Returns true on success or false on failure.
  7773. */
  7774. function krsort (array &$array, $sort_flags = null) {}
  7775. /**
  7776. * Sort an array using a "natural order" algorithm
  7777. * @link http://www.php.net/manual/en/function.natsort.php
  7778. * @param array array <p>
  7779. * The input array.
  7780. * </p>
  7781. * @return bool Returns true on success or false on failure.
  7782. */
  7783. function natsort (array &$array) {}
  7784. /**
  7785. * Sort an array using a case insensitive "natural order" algorithm
  7786. * @link http://www.php.net/manual/en/function.natcasesort.php
  7787. * @param array array <p>
  7788. * The input array.
  7789. * </p>
  7790. * @return bool Returns true on success or false on failure.
  7791. */
  7792. function natcasesort (array &$array) {}
  7793. /**
  7794. * Sort an array and maintain index association
  7795. * @link http://www.php.net/manual/en/function.asort.php
  7796. * @param array array <p>
  7797. * The input array.
  7798. * </p>
  7799. * @param sort_flags int[optional] <p>
  7800. * You may modify the behavior of the sort using the optional
  7801. * parameter sort_flags, for details
  7802. * see sort.
  7803. * </p>
  7804. * @return bool Returns true on success or false on failure.
  7805. */
  7806. function asort (array &$array, $sort_flags = null) {}
  7807. /**
  7808. * Sort an array in reverse order and maintain index association
  7809. * @link http://www.php.net/manual/en/function.arsort.php
  7810. * @param array array <p>
  7811. * The input array.
  7812. * </p>
  7813. * @param sort_flags int[optional] <p>
  7814. * You may modify the behavior of the sort using the optional parameter
  7815. * sort_flags, for details see
  7816. * sort.
  7817. * </p>
  7818. * @return bool Returns true on success or false on failure.
  7819. */
  7820. function arsort (array &$array, $sort_flags = null) {}
  7821. /**
  7822. * Sort an array
  7823. * @link http://www.php.net/manual/en/function.sort.php
  7824. * @param array array <p>
  7825. * The input array.
  7826. * </p>
  7827. * @param sort_flags int[optional] <p>
  7828. * The optional second parameter sort_flags
  7829. * may be used to modify the sorting behavior using these values:
  7830. * </p>
  7831. * <p>
  7832. * Sorting type flags:
  7833. * SORT_REGULAR - compare items normally
  7834. * (don't change types)
  7835. * @return bool Returns true on success or false on failure.
  7836. */
  7837. function sort (array &$array, $sort_flags = null) {}
  7838. /**
  7839. * Sort an array in reverse order
  7840. * @link http://www.php.net/manual/en/function.rsort.php
  7841. * @param array array <p>
  7842. * The input array.
  7843. * </p>
  7844. * @param sort_flags int[optional] <p>
  7845. * You may modify the behavior of the sort using the optional
  7846. * parameter sort_flags, for details see
  7847. * sort.
  7848. * </p>
  7849. * @return bool Returns true on success or false on failure.
  7850. */
  7851. function rsort (array &$array, $sort_flags = null) {}
  7852. /**
  7853. * Sort an array by values using a user-defined comparison function
  7854. * @link http://www.php.net/manual/en/function.usort.php
  7855. * @param array array <p>
  7856. * The input array.
  7857. * </p>
  7858. * @param cmp_function callback <p>
  7859. * The comparison function must return an integer less than, equal to, or
  7860. * greater than zero if the first argument is considered to be
  7861. * respectively less than, equal to, or greater than the second.
  7862. * </p>
  7863. * @return bool Returns true on success or false on failure.
  7864. */
  7865. function usort (array &$array, $cmp_function) {}
  7866. /**
  7867. * Sort an array with a user-defined comparison function and maintain index association
  7868. * @link http://www.php.net/manual/en/function.uasort.php
  7869. * @param array array <p>
  7870. * The input array.
  7871. * </p>
  7872. * @param cmp_function callback <p>
  7873. * See usort and uksort for
  7874. * examples of user-defined comparison functions.
  7875. * </p>
  7876. * @return bool Returns true on success or false on failure.
  7877. */
  7878. function uasort (array &$array, $cmp_function) {}
  7879. /**
  7880. * Sort an array by keys using a user-defined comparison function
  7881. * @link http://www.php.net/manual/en/function.uksort.php
  7882. * @param array array <p>
  7883. * The input array.
  7884. * </p>
  7885. * @param cmp_function callback <p>
  7886. * The callback comparison function.
  7887. * </p>
  7888. * <p>
  7889. * Function cmp_function should accept two
  7890. * parameters which will be filled by pairs of array keys.
  7891. * The comparison function must return an integer less than, equal
  7892. * to, or greater than zero if the first argument is considered to
  7893. * be respectively less than, equal to, or greater than the
  7894. * second.
  7895. * </p>
  7896. * @return bool Returns true on success or false on failure.
  7897. */
  7898. function uksort (array &$array, $cmp_function) {}
  7899. /**
  7900. * Shuffle an array
  7901. * @link http://www.php.net/manual/en/function.shuffle.php
  7902. * @param array array <p>
  7903. * The array.
  7904. * </p>
  7905. * @return bool Returns true on success or false on failure.
  7906. */
  7907. function shuffle (array &$array) {}
  7908. /**
  7909. * Apply a user function to every member of an array
  7910. * @link http://www.php.net/manual/en/function.array-walk.php
  7911. * @param array array <p>
  7912. * The input array.
  7913. * </p>
  7914. * @param funcname callback <p>
  7915. * Typically, funcname takes on two parameters.
  7916. * The array parameter's value being the first, and
  7917. * the key/index second.
  7918. * </p>
  7919. * <p>
  7920. * If funcname needs to be working with the
  7921. * actual values of the array, specify the first parameter of
  7922. * funcname as a
  7923. * reference. Then,
  7924. * any changes made to those elements will be made in the
  7925. * original array itself.
  7926. * </p>
  7927. * <p>
  7928. * Users may not change the array itself from the
  7929. * callback function. e.g. Add/delete elements, unset elements, etc. If
  7930. * the array that array_walk is applied to is
  7931. * changed, the behavior of this function is undefined, and unpredictable.
  7932. * </p>
  7933. * @param userdata mixed[optional] <p>
  7934. * If the optional userdata parameter is supplied,
  7935. * it will be passed as the third parameter to the callback
  7936. * funcname.
  7937. * </p>
  7938. * @return bool Returns true on success or false on failure.
  7939. */
  7940. function array_walk (array &$array, $funcname, $userdata = null) {}
  7941. /**
  7942. * Apply a user function recursively to every member of an array
  7943. * @link http://www.php.net/manual/en/function.array-walk-recursive.php
  7944. * @param input array <p>
  7945. * The input array.
  7946. * </p>
  7947. * @param funcname callback <p>
  7948. * Typically, funcname takes on two parameters.
  7949. * The input parameter's value being the first, and
  7950. * the key/index second.
  7951. * </p>
  7952. * <p>
  7953. * If funcname needs to be working with the
  7954. * actual values of the array, specify the first parameter of
  7955. * funcname as a
  7956. * reference. Then,
  7957. * any changes made to those elements will be made in the
  7958. * original array itself.
  7959. * </p>
  7960. * @param userdata mixed[optional] <p>
  7961. * If the optional userdata parameter is supplied,
  7962. * it will be passed as the third parameter to the callback
  7963. * funcname.
  7964. * </p>
  7965. * @return bool Returns true on success or false on failure.
  7966. */
  7967. function array_walk_recursive (array &$input, $funcname, $userdata = null) {}
  7968. /**
  7969. * Count all elements in an array, or properties in an object
  7970. * @link http://www.php.net/manual/en/function.count.php
  7971. * @param var mixed <p>
  7972. * The array.
  7973. * </p>
  7974. * @param mode int[optional] <p>
  7975. * If the optional mode parameter is set to
  7976. * COUNT_RECURSIVE (or 1), count
  7977. * will recursively count the array. This is particularly useful for
  7978. * counting all the elements of a multidimensional array.
  7979. * count does not detect infinite recursion.
  7980. * </p>
  7981. * @return int the number of elements in var, which is
  7982. * typically an array, since anything else will have one
  7983. * element.
  7984. * </p>
  7985. * <p>
  7986. * If var is not an array or an object with
  7987. * implemented Countable interface,
  7988. * 1 will be returned.
  7989. * There is one exception, if var is &null;,
  7990. * 0 will be returned.
  7991. * </p>
  7992. * <p>
  7993. * count may return 0 for a variable that isn't set,
  7994. * but it may also return 0 for a variable that has been initialized with an
  7995. * empty array. Use isset to test if a variable is set.
  7996. */
  7997. function count ($var, $mode = null) {}
  7998. /**
  7999. * Set the internal pointer of an array to its last element
  8000. * @link http://www.php.net/manual/en/function.end.php
  8001. * @param array array <p>
  8002. * The array. This array is passed by reference because it is modified by
  8003. * the function. This means you must pass it a real variable and not
  8004. * a function returning an array because only actual variables may be
  8005. * passed by reference.
  8006. * </p>
  8007. * @return mixed the value of the last element or false for empty array.
  8008. */
  8009. function end (array &$array) {}
  8010. /**
  8011. * Rewind the internal array pointer
  8012. * @link http://www.php.net/manual/en/function.prev.php
  8013. * @param array array <p>
  8014. * The input array.
  8015. * </p>
  8016. * @return mixed the array value in the previous place that's pointed to by
  8017. * the internal array pointer, or false if there are no more
  8018. * elements.
  8019. */
  8020. function prev (array &$array) {}
  8021. /**
  8022. * Advance the internal array pointer of an array
  8023. * @link http://www.php.net/manual/en/function.next.php
  8024. * @param array array <p>
  8025. * The array being affected.
  8026. * </p>
  8027. * @return mixed the array value in the next place that's pointed to by the
  8028. * internal array pointer, or false if there are no more elements.
  8029. */
  8030. function next (array &$array) {}
  8031. /**
  8032. * Set the internal pointer of an array to its first element
  8033. * @link http://www.php.net/manual/en/function.reset.php
  8034. * @param array array <p>
  8035. * The input array.
  8036. * </p>
  8037. * @return mixed the value of the first array element, or false if the array is
  8038. * empty.
  8039. */
  8040. function reset (array &$array) {}
  8041. /**
  8042. * Return the current element in an array
  8043. * @link http://www.php.net/manual/en/function.current.php
  8044. * @param array array <p>
  8045. * The array.
  8046. * </p>
  8047. * @return mixed The current function simply returns the
  8048. * value of the array element that's currently being pointed to by the
  8049. * internal pointer. It does not move the pointer in any way. If the
  8050. * internal pointer points beyond the end of the elements list or the array is
  8051. * empty, current returns false.
  8052. */
  8053. function current (array &$array) {}
  8054. /**
  8055. * Fetch a key from an array
  8056. * @link http://www.php.net/manual/en/function.key.php
  8057. * @param array array <p>
  8058. * The array.
  8059. * </p>
  8060. * @return mixed The key function simply returns the
  8061. * key of the array element that's currently being pointed to by the
  8062. * internal pointer. It does not move the pointer in any way. If the
  8063. * internal pointer points beyond the end of the elements list or the array is
  8064. * empty, key returns &null;.
  8065. */
  8066. function key (array &$array) {}
  8067. /**
  8068. * Find lowest value
  8069. * @link http://www.php.net/manual/en/function.min.php
  8070. * @param values array <p>
  8071. * An array containing the values.
  8072. * </p>
  8073. * @return mixed min returns the numerically lowest of the
  8074. * parameter values.
  8075. */
  8076. function min (array $values) {}
  8077. /**
  8078. * Find highest value
  8079. * @link http://www.php.net/manual/en/function.max.php
  8080. * @param values array <p>
  8081. * An array containing the values.
  8082. * </p>
  8083. * @return mixed max returns the numerically highest of the
  8084. * parameter values. If multiple values can be considered of the same size,
  8085. * the one that is listed first will be returned.
  8086. * </p>
  8087. * <p>
  8088. * When max is given multiple arrays, the
  8089. * longest array is returned. If all the arrays have the same length,
  8090. * max will use lexicographic ordering to find the return
  8091. * value.
  8092. * </p>
  8093. * <p>
  8094. * When given a string it will be cast as an integer
  8095. * when comparing.
  8096. */
  8097. function max (array $values) {}
  8098. /**
  8099. * Checks if a value exists in an array
  8100. * @link http://www.php.net/manual/en/function.in-array.php
  8101. * @param needle mixed <p>
  8102. * The searched value.
  8103. * </p>
  8104. * <p>
  8105. * If needle is a string, the comparison is done
  8106. * in a case-sensitive manner.
  8107. * </p>
  8108. * @param haystack array <p>
  8109. * The array.
  8110. * </p>
  8111. * @param strict bool[optional] <p>
  8112. * If the third parameter strict is set to true
  8113. * then the in_array function will also check the
  8114. * types of the
  8115. * needle in the haystack.
  8116. * </p>
  8117. * @return bool true if needle is found in the array,
  8118. * false otherwise.
  8119. */
  8120. function in_array ($needle, array $haystack, $strict = null) {}
  8121. /**
  8122. * Searches the array for a given value and returns the corresponding key if successful
  8123. * @link http://www.php.net/manual/en/function.array-search.php
  8124. * @param needle mixed <p>
  8125. * The searched value.
  8126. * </p>
  8127. * <p>
  8128. * If needle is a string, the comparison is done
  8129. * in a case-sensitive manner.
  8130. * </p>
  8131. * @param haystack array <p>
  8132. * The array.
  8133. * </p>
  8134. * @param strict bool[optional] <p>
  8135. * If the third parameter strict is set to true
  8136. * then the array_search function will also check the
  8137. * types of the
  8138. * needle in the haystack.
  8139. * </p>
  8140. * @return mixed the key for needle if it is found in the
  8141. * array, false otherwise.
  8142. * </p>
  8143. * <p>
  8144. * If needle is found in haystack
  8145. * more than once, the first matching key is returned. To return the keys for
  8146. * all matching values, use array_keys with the optional
  8147. * search_value parameter instead.
  8148. */
  8149. function array_search ($needle, array $haystack, $strict = null) {}
  8150. /**
  8151. * Import variables into the current symbol table from an array
  8152. * @link http://www.php.net/manual/en/function.extract.php
  8153. * @param var_array array <p>
  8154. * Note that prefix is only required if
  8155. * extract_type is EXTR_PREFIX_SAME,
  8156. * EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID
  8157. * or EXTR_PREFIX_IF_EXISTS. If
  8158. * the prefixed result is not a valid variable name, it is not
  8159. * imported into the symbol table. Prefixes are automatically separated from
  8160. * the array key by an underscore character.
  8161. * </p>
  8162. * @param extract_type int[optional] <p>
  8163. * The way invalid/numeric keys and collisions are treated is determined
  8164. * by the extract_type. It can be one of the
  8165. * following values:
  8166. * EXTR_OVERWRITE
  8167. * If there is a collision, overwrite the existing variable.
  8168. * @param prefix string[optional] Only overwrite the variable if it already exists in the
  8169. * current symbol table, otherwise do nothing. This is useful
  8170. * for defining a list of valid variables and then extracting
  8171. * only those variables you have defined out of
  8172. * $_REQUEST, for example.
  8173. * @return int the number of variables successfully imported into the symbol
  8174. * table.
  8175. */
  8176. function extract (array $var_array, $extract_type = null, $prefix = null) {}
  8177. /**
  8178. * Create array containing variables and their values
  8179. * @link http://www.php.net/manual/en/function.compact.php
  8180. * @param varname mixed <p>
  8181. * compact takes a variable number of parameters.
  8182. * Each parameter can be either a string containing the name of the
  8183. * variable, or an array of variable names. The array can contain other
  8184. * arrays of variable names inside it; compact
  8185. * handles it recursively.
  8186. * </p>
  8187. * @param _ mixed[optional]
  8188. * @return array the output array with all the variables added to it.
  8189. */
  8190. function compact ($varname, $_ = null) {}
  8191. /**
  8192. * Fill an array with values
  8193. * @link http://www.php.net/manual/en/function.array-fill.php
  8194. * @param start_index int <p>
  8195. * The first index of the returned array.
  8196. * Supports non-negative indexes only.
  8197. * </p>
  8198. * @param num int <p>
  8199. * Number of elements to insert
  8200. * </p>
  8201. * @param value mixed <p>
  8202. * Value to use for filling
  8203. * </p>
  8204. * @return array the filled array
  8205. */
  8206. function array_fill ($start_index, $num, $value) {}
  8207. /**
  8208. * Fill an array with values, specifying keys
  8209. * @link http://www.php.net/manual/en/function.array-fill-keys.php
  8210. * @param keys array <p>
  8211. * Array of values that will be used as keys. Illegal values
  8212. * for key will be converted to string.
  8213. * </p>
  8214. * @param value mixed <p>
  8215. * Value to use for filling
  8216. * </p>
  8217. * @return array the filled array
  8218. */
  8219. function array_fill_keys (array $keys, $value) {}
  8220. /**
  8221. * Create an array containing a range of elements
  8222. * @link http://www.php.net/manual/en/function.range.php
  8223. * @param low mixed <p>
  8224. * Low value.
  8225. * </p>
  8226. * @param high mixed <p>
  8227. * High value.
  8228. * </p>
  8229. * @param step number[optional] <p>
  8230. * If a step value is given, it will be used as the
  8231. * increment between elements in the sequence. step
  8232. * should be given as a positive number. If not specified,
  8233. * step will default to 1.
  8234. * </p>
  8235. * @return array an array of elements from low to
  8236. * high, inclusive. If low > high, the sequence will
  8237. * be from high to low.
  8238. */
  8239. function range ($low, $high, $step = null) {}
  8240. /**
  8241. * Sort multiple or multi-dimensional arrays
  8242. * @link http://www.php.net/manual/en/function.array-multisort.php
  8243. * @param arr array <p>
  8244. * An array being sorted.
  8245. * </p>
  8246. * @param arg mixed[optional] <p>
  8247. * Optionally another array, or sort options for the
  8248. * previous array argument:
  8249. * SORT_ASC,
  8250. * SORT_DESC,
  8251. * SORT_REGULAR,
  8252. * SORT_NUMERIC,
  8253. * SORT_STRING.
  8254. * </p>
  8255. * @param arg mixed[optional]
  8256. * @param _ mixed[optional]
  8257. * @return bool Returns true on success or false on failure.
  8258. */
  8259. function array_multisort (array &$arr, $arg = null, $arg = null, $_ = null) {}
  8260. /**
  8261. * Push one or more elements onto the end of array
  8262. * @link http://www.php.net/manual/en/function.array-push.php
  8263. * @param array array <p>
  8264. * The input array.
  8265. * </p>
  8266. * @param var mixed <p>
  8267. * The pushed value.
  8268. * </p>
  8269. * @param _ mixed[optional]
  8270. * @return int the new number of elements in the array.
  8271. */
  8272. function array_push (array &$array, $var, $_ = null) {}
  8273. /**
  8274. * Pop the element off the end of array
  8275. * @link http://www.php.net/manual/en/function.array-pop.php
  8276. * @param array array <p>
  8277. * The array to get the value from.
  8278. * </p>
  8279. * @return mixed the last value of array.
  8280. * If array is empty (or is not an array),
  8281. * &null; will be returned.
  8282. */
  8283. function array_pop (array &$array) {}
  8284. /**
  8285. * Shift an element off the beginning of array
  8286. * @link http://www.php.net/manual/en/function.array-shift.php
  8287. * @param array array <p>
  8288. * The input array.
  8289. * </p>
  8290. * @return mixed the shifted value, or &null; if array is
  8291. * empty or is not an array.
  8292. */
  8293. function array_shift (array &$array) {}
  8294. /**
  8295. * Prepend one or more elements to the beginning of an array
  8296. * @link http://www.php.net/manual/en/function.array-unshift.php
  8297. * @param array array <p>
  8298. * The input array.
  8299. * </p>
  8300. * @param var mixed <p>
  8301. * The prepended variable.
  8302. * </p>
  8303. * @param _ mixed[optional]
  8304. * @return int the new number of elements in the array.
  8305. */
  8306. function array_unshift (array &$array, $var, $_ = null) {}
  8307. /**
  8308. * Remove a portion of the array and replace it with something else
  8309. * @link http://www.php.net/manual/en/function.array-splice.php
  8310. * @param input array <p>
  8311. * The input array.
  8312. * </p>
  8313. * @param offset int <p>
  8314. * If offset is positive then the start of removed
  8315. * portion is at that offset from the beginning of the
  8316. * input array. If offset
  8317. * is negative then it starts that far from the end of the
  8318. * input array.
  8319. * </p>
  8320. * @param length int[optional] <p>
  8321. * If length is omitted, removes everything
  8322. * from offset to the end of the array. If
  8323. * length is specified and is positive, then
  8324. * that many elements will be removed. If
  8325. * length is specified and is negative then
  8326. * the end of the removed portion will be that many elements from
  8327. * the end of the array. Tip: to remove everything from
  8328. * offset to the end of the array when
  8329. * replacement is also specified, use
  8330. * count($input) for
  8331. * length.
  8332. * </p>
  8333. * @param replacement mixed[optional] <p>
  8334. * If replacement array is specified, then the
  8335. * removed elements are replaced with elements from this array.
  8336. * </p>
  8337. * <p>
  8338. * If offset and length
  8339. * are such that nothing is removed, then the elements from the
  8340. * replacement array are inserted in the place
  8341. * specified by the offset. Note that keys in
  8342. * replacement array are not preserved.
  8343. * </p>
  8344. * <p>
  8345. * If replacement is just one element it is
  8346. * not necessary to put array()
  8347. * around it, unless the element is an array itself.
  8348. * </p>
  8349. * @return array the array consisting of the extracted elements.
  8350. */
  8351. function array_splice (array &$input, $offset, $length = null, $replacement = null) {}
  8352. /**
  8353. * Extract a slice of the array
  8354. * @link http://www.php.net/manual/en/function.array-slice.php
  8355. * @param array array <p>
  8356. * The input array.
  8357. * </p>
  8358. * @param offset int <p>
  8359. * If offset is non-negative, the sequence will
  8360. * start at that offset in the array. If
  8361. * offset is negative, the sequence will
  8362. * start that far from the end of the array.
  8363. * </p>
  8364. * @param length int[optional] <p>
  8365. * If length is given and is positive, then
  8366. * the sequence will have that many elements in it. If
  8367. * length is given and is negative then the
  8368. * sequence will stop that many elements from the end of the
  8369. * array. If it is omitted, then the sequence will have everything
  8370. * from offset up until the end of the
  8371. * array.
  8372. * </p>
  8373. * @param preserve_keys bool[optional] <p>
  8374. * Note that array_slice will reorder and reset the
  8375. * array indices by default. You can change this behaviour by setting
  8376. * preserve_keys to true.
  8377. * </p>
  8378. * @return array the slice.
  8379. */
  8380. function array_slice (array $array, $offset, $length = null, $preserve_keys = null) {}
  8381. /**
  8382. * Merge one or more arrays
  8383. * @link http://www.php.net/manual/en/function.array-merge.php
  8384. * @param array1 array <p>
  8385. * Initial array to merge.
  8386. * </p>
  8387. * @param array2 array[optional]
  8388. * @param _ array[optional]
  8389. * @return array the resulting array.
  8390. */
  8391. function array_merge (array $array1, array $array2 = null, array $_ = null) {}
  8392. /**
  8393. * Merge two or more arrays recursively
  8394. * @link http://www.php.net/manual/en/function.array-merge-recursive.php
  8395. * @param array1 array <p>
  8396. * Initial array to merge.
  8397. * </p>
  8398. * @param _ array[optional]
  8399. * @return array An array of values resulted from merging the arguments together.
  8400. */
  8401. function array_merge_recursive (array $array1, array $_ = null) {}
  8402. /**
  8403. * Replaces elements from passed arrays into the first array
  8404. * @link http://www.php.net/manual/en/function.array-replace.php
  8405. * @param array array <p>
  8406. * The array in which elements are replaced.
  8407. * </p>
  8408. * @param array1 array <p>
  8409. * The array from which elements will be extracted.
  8410. * </p>
  8411. * @param array2 array[optional]
  8412. * @param _ array[optional]
  8413. * @return array an array, or &null; if an error occurs.
  8414. */
  8415. function array_replace (array &$array, array &$array1, array &$array2 = null, array &$_ = null) {}
  8416. /**
  8417. * Replaces elements from passed arrays into the first array recursively
  8418. * @link http://www.php.net/manual/en/function.array-replace-recursive.php
  8419. * @param array array <p>
  8420. * The array in which elements are replaced.
  8421. * </p>
  8422. * @param array1 array <p>
  8423. * The array from which elements will be extracted.
  8424. * </p>
  8425. * @param array2 array[optional]
  8426. * @param _ array[optional]
  8427. * @return array an array, or &null; if an error occurs.
  8428. */
  8429. function array_replace_recursive (array &$array, array &$array1, array &$array2 = null, array &$_ = null) {}
  8430. /**
  8431. * Return all the keys of an array
  8432. * @link http://www.php.net/manual/en/function.array-keys.php
  8433. * @param input array <p>
  8434. * An array containing keys to return.
  8435. * </p>
  8436. * @param search_value mixed[optional] <p>
  8437. * If specified, then only keys containing these values are returned.
  8438. * </p>
  8439. * @param strict bool[optional] <p>
  8440. * Determines if strict comparison (===) should be used during the search.
  8441. * </p>
  8442. * @return array an array of all the keys in input.
  8443. */
  8444. function array_keys (array $input, $search_value = null, $strict = null) {}
  8445. /**
  8446. * Return all the values of an array
  8447. * @link http://www.php.net/manual/en/function.array-values.php
  8448. * @param input array <p>
  8449. * The array.
  8450. * </p>
  8451. * @return array an indexed array of values.
  8452. */
  8453. function array_values (array $input) {}
  8454. /**
  8455. * Counts all the values of an array
  8456. * @link http://www.php.net/manual/en/function.array-count-values.php
  8457. * @param input array <p>
  8458. * The array of values to count
  8459. * </p>
  8460. * @return array an associative array of values from input as
  8461. * keys and their count as value.
  8462. */
  8463. function array_count_values (array $input) {}
  8464. /**
  8465. * Return an array with elements in reverse order
  8466. * @link http://www.php.net/manual/en/function.array-reverse.php
  8467. * @param array array <p>
  8468. * The input array.
  8469. * </p>
  8470. * @param preserve_keys bool[optional] <p>
  8471. * If set to true keys are preserved.
  8472. * </p>
  8473. * @return array the reversed array.
  8474. */
  8475. function array_reverse (array $array, $preserve_keys = null) {}
  8476. /**
  8477. * Iteratively reduce the array to a single value using a callback function
  8478. * @link http://www.php.net/manual/en/function.array-reduce.php
  8479. * @param input array <p>
  8480. * The input array.
  8481. * </p>
  8482. * @param function callback <p>
  8483. * The callback function.
  8484. * </p>
  8485. * @param initial mixed[optional] <p>
  8486. * If the optional initial is available, it will
  8487. * be used at the beginning of the process, or as a final result in case
  8488. * the array is empty.
  8489. * </p>
  8490. * @return mixed the resulting value.
  8491. * </p>
  8492. * <p>
  8493. * If the array is empty and initial is not passed,
  8494. * array_reduce returns &null;.
  8495. */
  8496. function array_reduce (array $input, $function, $initial = null) {}
  8497. /**
  8498. * Pad array to the specified length with a value
  8499. * @link http://www.php.net/manual/en/function.array-pad.php
  8500. * @param input array <p>
  8501. * Initial array of values to pad.
  8502. * </p>
  8503. * @param pad_size int <p>
  8504. * New size of the array.
  8505. * </p>
  8506. * @param pad_value mixed <p>
  8507. * Value to pad if input is less than
  8508. * pad_size.
  8509. * </p>
  8510. * @return array a copy of the input padded to size specified
  8511. * by pad_size with value
  8512. * pad_value. If pad_size is
  8513. * positive then the array is padded on the right, if it's negative then
  8514. * on the left. If the absolute value of pad_size is less than or equal to
  8515. * the length of the input then no padding takes place.
  8516. */
  8517. function array_pad (array $input, $pad_size, $pad_value) {}
  8518. /**
  8519. * Exchanges all keys with their associated values in an array
  8520. * @link http://www.php.net/manual/en/function.array-flip.php
  8521. * @param trans array <p>
  8522. * An array of key/value pairs to be flipped.
  8523. * </p>
  8524. * @return array the flipped array on success and &null; on failure.
  8525. */
  8526. function array_flip (array $trans) {}
  8527. /**
  8528. * Changes all keys in an array
  8529. * @link http://www.php.net/manual/en/function.array-change-key-case.php
  8530. * @param input array <p>
  8531. * The array to work on
  8532. * </p>
  8533. * @param case int[optional] <p>
  8534. * Either CASE_UPPER or
  8535. * CASE_LOWER (default)
  8536. * </p>
  8537. * @return array an array with its keys lower or uppercased, or false if
  8538. * input is not an array.
  8539. */
  8540. function array_change_key_case (array $input, $case = null) {}
  8541. /**
  8542. * Pick one or more random entries out of an array
  8543. * @link http://www.php.net/manual/en/function.array-rand.php
  8544. * @param input array <p>
  8545. * The input array.
  8546. * </p>
  8547. * @param num_req int[optional] <p>
  8548. * Specifies how many entries you want to pick.
  8549. * </p>
  8550. * @return mixed If you are picking only one entry, array_rand
  8551. * returns the key for a random entry. Otherwise, it returns an array
  8552. * of keys for the random entries. This is done so that you can pick
  8553. * random keys as well as values out of the array.
  8554. */
  8555. function array_rand (array $input, $num_req = null) {}
  8556. /**
  8557. * Removes duplicate values from an array
  8558. * @link http://www.php.net/manual/en/function.array-unique.php
  8559. * @param array array <p>
  8560. * The input array.
  8561. * </p>
  8562. * @param sort_flags int[optional] <p>
  8563. * The optional second parameter sort_flags
  8564. * may be used to modify the sorting behavior using these values:
  8565. * </p>
  8566. * <p>
  8567. * Sorting type flags:
  8568. * SORT_REGULAR - compare items normally
  8569. * (don't change types)
  8570. * @return array the filtered array.
  8571. */
  8572. function array_unique (array $array, $sort_flags = null) {}
  8573. /**
  8574. * Computes the intersection of arrays
  8575. * @link http://www.php.net/manual/en/function.array-intersect.php
  8576. * @param array1 array <p>
  8577. * The array with master values to check.
  8578. * </p>
  8579. * @param array2 array <p>
  8580. * An array to compare values against.
  8581. * </p>
  8582. * @param _ array[optional]
  8583. * @return array an array containing all of the values in
  8584. * array1 whose values exist in all of the parameters.
  8585. */
  8586. function array_intersect (array $array1, array $array2, array $_ = null) {}
  8587. /**
  8588. * Computes the intersection of arrays using keys for comparison
  8589. * @link http://www.php.net/manual/en/function.array-intersect-key.php
  8590. * @param array1 array <p>
  8591. * The array with master keys to check.
  8592. * </p>
  8593. * @param array2 array <p>
  8594. * An array to compare keys against.
  8595. * </p>
  8596. * @param _ array[optional]
  8597. * @return array an associative array containing all the entries of
  8598. * array1 which have keys that are present in all
  8599. * arguments.
  8600. */
  8601. function array_intersect_key (array $array1, array $array2, array $_ = null) {}
  8602. /**
  8603. * Computes the intersection of arrays using a callback function on the keys for comparison
  8604. * @link http://www.php.net/manual/en/function.array-intersect-ukey.php
  8605. * @param array1 array <p>
  8606. * Initial array for comparison of the arrays.
  8607. * </p>
  8608. * @param array2 array <p>
  8609. * First array to compare keys against.
  8610. * </p>
  8611. * @param _ array[optional]
  8612. * @param key_compare_func callback <p>
  8613. * User supplied callback function to do the comparison.
  8614. * </p>
  8615. * @return array the values of array1 whose keys exist
  8616. * in all the arguments.
  8617. */
  8618. function array_intersect_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8619. /**
  8620. * Computes the intersection of arrays, compares data by a callback function
  8621. * @link http://www.php.net/manual/en/function.array-uintersect.php
  8622. * @param array1 array <p>
  8623. * The first array.
  8624. * </p>
  8625. * @param array2 array <p>
  8626. * The second array.
  8627. * </p>
  8628. * @param _ array[optional]
  8629. * @param data_compare_func callback <p>
  8630. * The callback comparison function.
  8631. * </p>
  8632. * <p>
  8633. * The user supplied callback function is used for comparison.
  8634. * It must return an integer less than, equal to, or greater than zero if
  8635. * the first argument is considered to be respectively less than, equal
  8636. * to, or greater than the second.
  8637. * </p>
  8638. * @return array an array containing all the values of array1
  8639. * that are present in all the arguments.
  8640. */
  8641. function array_uintersect (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8642. /**
  8643. * Computes the intersection of arrays with additional index check
  8644. * @link http://www.php.net/manual/en/function.array-intersect-assoc.php
  8645. * @param array1 array <p>
  8646. * The array with master values to check.
  8647. * </p>
  8648. * @param array2 array <p>
  8649. * An array to compare values against.
  8650. * </p>
  8651. * @param _ array[optional]
  8652. * @return array an associative array containing all the values in
  8653. * array1 that are present in all of the arguments.
  8654. */
  8655. function array_intersect_assoc (array $array1, array $array2, array $_ = null) {}
  8656. /**
  8657. * Computes the intersection of arrays with additional index check, compares data by a callback function
  8658. * @link http://www.php.net/manual/en/function.array-uintersect-assoc.php
  8659. * @param array1 array <p>
  8660. * The first array.
  8661. * </p>
  8662. * @param array2 array <p>
  8663. * The second array.
  8664. * </p>
  8665. * @param _ array[optional]
  8666. * @param data_compare_func callback <p>
  8667. * For comparison is used the user supplied callback function.
  8668. * It must return an integer less than, equal
  8669. * to, or greater than zero if the first argument is considered to
  8670. * be respectively less than, equal to, or greater than the
  8671. * second.
  8672. * </p>
  8673. * @return array an array containing all the values of
  8674. * array1 that are present in all the arguments.
  8675. */
  8676. function array_uintersect_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8677. /**
  8678. * Computes the intersection of arrays with additional index check, compares indexes by a callback function
  8679. * @link http://www.php.net/manual/en/function.array-intersect-uassoc.php
  8680. * @param array1 array <p>
  8681. * Initial array for comparison of the arrays.
  8682. * </p>
  8683. * @param array2 array <p>
  8684. * First array to compare keys against.
  8685. * </p>
  8686. * @param _ array[optional]
  8687. * @param key_compare_func callback <p>
  8688. * User supplied callback function to do the comparison.
  8689. * </p>
  8690. * @return array the values of array1 whose values exist
  8691. * in all of the arguments.
  8692. */
  8693. function array_intersect_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8694. /**
  8695. * Computes the intersection of arrays with additional index check, compares data and indexes by a callback functions
  8696. * @link http://www.php.net/manual/en/function.array-uintersect-uassoc.php
  8697. * @param array1 array <p>
  8698. * The first array.
  8699. * </p>
  8700. * @param array2 array <p>
  8701. * The second array.
  8702. * </p>
  8703. * @param _ array[optional]
  8704. * @param data_compare_func callback <p>
  8705. * For comparison is used the user supplied callback function.
  8706. * It must return an integer less than, equal
  8707. * to, or greater than zero if the first argument is considered to
  8708. * be respectively less than, equal to, or greater than the
  8709. * second.
  8710. * </p>
  8711. * @param key_compare_func callback <p>
  8712. * Key comparison callback function.
  8713. * </p>
  8714. * @return array an array containing all the values of
  8715. * array1 that are present in all the arguments.
  8716. */
  8717. function array_uintersect_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  8718. /**
  8719. * Computes the difference of arrays
  8720. * @link http://www.php.net/manual/en/function.array-diff.php
  8721. * @param array1 array <p>
  8722. * The array to compare from
  8723. * </p>
  8724. * @param array2 array <p>
  8725. * An array to compare against
  8726. * </p>
  8727. * @param _ array[optional]
  8728. * @return array an array containing all the entries from
  8729. * array1 that are not present in any of the other arrays.
  8730. */
  8731. function array_diff (array $array1, array $array2, array $_ = null) {}
  8732. /**
  8733. * Computes the difference of arrays using keys for comparison
  8734. * @link http://www.php.net/manual/en/function.array-diff-key.php
  8735. * @param array1 array <p>
  8736. * The array to compare from
  8737. * </p>
  8738. * @param array2 array <p>
  8739. * An array to compare against
  8740. * </p>
  8741. * @param _ array[optional]
  8742. * @return array an array containing all the entries from
  8743. * array1 whose keys are not present in any of the
  8744. * other arrays.
  8745. */
  8746. function array_diff_key (array $array1, array $array2, array $_ = null) {}
  8747. /**
  8748. * Computes the difference of arrays using a callback function on the keys for comparison
  8749. * @link http://www.php.net/manual/en/function.array-diff-ukey.php
  8750. * @param array1 array <p>
  8751. * The array to compare from
  8752. * </p>
  8753. * @param array2 array <p>
  8754. * An array to compare against
  8755. * </p>
  8756. * @param _ array[optional]
  8757. * @param key_compare_func callback <p>
  8758. * callback function to use.
  8759. * The callback function must return an integer less than, equal
  8760. * to, or greater than zero if the first argument is considered to
  8761. * be respectively less than, equal to, or greater than the second.
  8762. * </p>
  8763. * @return array an array containing all the entries from
  8764. * array1 that are not present in any of the other arrays.
  8765. */
  8766. function array_diff_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8767. /**
  8768. * Computes the difference of arrays by using a callback function for data comparison
  8769. * @link http://www.php.net/manual/en/function.array-udiff.php
  8770. * @param array1 array <p>
  8771. * The first array.
  8772. * </p>
  8773. * @param array2 array <p>
  8774. * The second array.
  8775. * </p>
  8776. * @param _ array[optional]
  8777. * @param data_compare_func callback <p>
  8778. * The callback comparison function.
  8779. * </p>
  8780. * <p>
  8781. * The user supplied callback function is used for comparison.
  8782. * It must return an integer less than, equal to, or greater than zero if
  8783. * the first argument is considered to be respectively less than, equal
  8784. * to, or greater than the second.
  8785. * </p>
  8786. * @return array an array containing all the values of array1
  8787. * that are not present in any of the other arguments.
  8788. */
  8789. function array_udiff (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8790. /**
  8791. * Computes the difference of arrays with additional index check
  8792. * @link http://www.php.net/manual/en/function.array-diff-assoc.php
  8793. * @param array1 array <p>
  8794. * The array to compare from
  8795. * </p>
  8796. * @param array2 array <p>
  8797. * An array to compare against
  8798. * </p>
  8799. * @param _ array[optional]
  8800. * @return array an array containing all the values from
  8801. * array1 that are not present in any of the other arrays.
  8802. */
  8803. function array_diff_assoc (array $array1, array $array2, array $_ = null) {}
  8804. /**
  8805. * Computes the difference of arrays with additional index check, compares data by a callback function
  8806. * @link http://www.php.net/manual/en/function.array-udiff-assoc.php
  8807. * @param array1 array <p>
  8808. * The first array.
  8809. * </p>
  8810. * @param array2 array <p>
  8811. * The second array.
  8812. * </p>
  8813. * @param _ array[optional]
  8814. * @param data_compare_func callback <p>
  8815. * The callback comparison function.
  8816. * </p>
  8817. * <p>
  8818. * The user supplied callback function is used for comparison.
  8819. * It must return an integer less than, equal to, or greater than zero if
  8820. * the first argument is considered to be respectively less than, equal
  8821. * to, or greater than the second.
  8822. * </p>
  8823. * @return array array_udiff_assoc returns an array
  8824. * containing all the values from array1
  8825. * that are not present in any of the other arguments.
  8826. * Note that the keys are used in the comparison unlike
  8827. * array_diff and array_udiff.
  8828. * The comparison of arrays' data is performed by using an user-supplied
  8829. * callback. In this aspect the behaviour is opposite to the behaviour of
  8830. * array_diff_assoc which uses internal function for
  8831. * comparison.
  8832. */
  8833. function array_udiff_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8834. /**
  8835. * Computes the difference of arrays with additional index check which is performed by a user supplied callback function
  8836. * @link http://www.php.net/manual/en/function.array-diff-uassoc.php
  8837. * @param array1 array <p>
  8838. * The array to compare from
  8839. * </p>
  8840. * @param array2 array <p>
  8841. * An array to compare against
  8842. * </p>
  8843. * @param _ array[optional]
  8844. * @param key_compare_func callback <p>
  8845. * callback function to use.
  8846. * The callback function must return an integer less than, equal
  8847. * to, or greater than zero if the first argument is considered to
  8848. * be respectively less than, equal to, or greater than the second.
  8849. * </p>
  8850. * @return array an array containing all the entries from
  8851. * array1 that are not present in any of the other arrays.
  8852. */
  8853. function array_diff_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8854. /**
  8855. * Computes the difference of arrays with additional index check, compares data and indexes by a callback function
  8856. * @link http://www.php.net/manual/en/function.array-udiff-uassoc.php
  8857. * @param array1 array <p>
  8858. * The first array.
  8859. * </p>
  8860. * @param array2 array <p>
  8861. * The second array.
  8862. * </p>
  8863. * @param _ array[optional]
  8864. * @param data_compare_func callback <p>
  8865. * The callback comparison function.
  8866. * </p>
  8867. * <p>
  8868. * The user supplied callback function is used for comparison.
  8869. * It must return an integer less than, equal to, or greater than zero if
  8870. * the first argument is considered to be respectively less than, equal
  8871. * to, or greater than the second.
  8872. * </p>
  8873. * <p>
  8874. * The comparison of arrays' data is performed by using an user-supplied
  8875. * callback : data_compare_func. In this aspect
  8876. * the behaviour is opposite to the behaviour of
  8877. * array_diff_assoc which uses internal function for
  8878. * comparison.
  8879. * </p>
  8880. * @param key_compare_func callback <p>
  8881. * The comparison of keys (indices) is done also by the callback function
  8882. * key_compare_func. This behaviour is unlike what
  8883. * array_udiff_assoc does, since the latter compares
  8884. * the indices by using an internal function.
  8885. * </p>
  8886. * @return array an array containing all the values from
  8887. * array1 that are not present in any of the other
  8888. * arguments.
  8889. */
  8890. function array_udiff_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  8891. /**
  8892. * Calculate the sum of values in an array
  8893. * @link http://www.php.net/manual/en/function.array-sum.php
  8894. * @param array array <p>
  8895. * The input array.
  8896. * </p>
  8897. * @return number the sum of values as an integer or float.
  8898. */
  8899. function array_sum (array $array) {}
  8900. /**
  8901. * Calculate the product of values in an array
  8902. * @link http://www.php.net/manual/en/function.array-product.php
  8903. * @param array array <p>
  8904. * The array.
  8905. * </p>
  8906. * @return number the product as an integer or float.
  8907. */
  8908. function array_product (array $array) {}
  8909. /**
  8910. * Filters elements of an array using a callback function
  8911. * @link http://www.php.net/manual/en/function.array-filter.php
  8912. * @param input array <p>
  8913. * The array to iterate over
  8914. * </p>
  8915. * @param callback callback[optional] <p>
  8916. * The callback function to use
  8917. * </p>
  8918. * <p>
  8919. * If no callback is supplied, all entries of
  8920. * input equal to false (see
  8921. * converting to
  8922. * boolean) will be removed.
  8923. * </p>
  8924. * @return array the filtered array.
  8925. */
  8926. function array_filter (array $input, $callback = null) {}
  8927. /**
  8928. * Applies the callback to the elements of the given arrays
  8929. * @link http://www.php.net/manual/en/function.array-map.php
  8930. * @param callback callback <p>
  8931. * Callback function to run for each element in each array.
  8932. * </p>
  8933. * @param arr1 array <p>
  8934. * An array to run through the callback function.
  8935. * </p>
  8936. * @param _ array[optional]
  8937. * @return array an array containing all the elements of arr1
  8938. * after applying the callback function to each one.
  8939. */
  8940. function array_map ($callback, array $arr1, array $_ = null) {}
  8941. /**
  8942. * Split an array into chunks
  8943. * @link http://www.php.net/manual/en/function.array-chunk.php
  8944. * @param input array <p>
  8945. * The array to work on
  8946. * </p>
  8947. * @param size int <p>
  8948. * The size of each chunk
  8949. * </p>
  8950. * @param preserve_keys bool[optional] <p>
  8951. * When set to true keys will be preserved.
  8952. * Default is false which will reindex the chunk numerically
  8953. * </p>
  8954. * @return array a multidimensional numerically indexed array, starting with zero,
  8955. * with each dimension containing size elements.
  8956. */
  8957. function array_chunk (array $input, $size, $preserve_keys = null) {}
  8958. /**
  8959. * Creates an array by using one array for keys and another for its values
  8960. * @link http://www.php.net/manual/en/function.array-combine.php
  8961. * @param keys array <p>
  8962. * Array of keys to be used. Illegal values for key will be
  8963. * converted to string.
  8964. * </p>
  8965. * @param values array <p>
  8966. * Array of values to be used
  8967. * </p>
  8968. * @return array the combined array, false if the number of elements
  8969. * for each array isn't equal or if the arrays are empty.
  8970. */
  8971. function array_combine (array $keys, array $values) {}
  8972. /**
  8973. * Checks if the given key or index exists in the array
  8974. * @link http://www.php.net/manual/en/function.array-key-exists.php
  8975. * @param key mixed <p>
  8976. * Value to check.
  8977. * </p>
  8978. * @param search array <p>
  8979. * An array with keys to check.
  8980. * </p>
  8981. * @return bool Returns true on success or false on failure.
  8982. */
  8983. function array_key_exists ($key, array $search) {}
  8984. /**
  8985. * &Alias; <function>current</function>
  8986. * @link http://www.php.net/manual/en/function.pos.php
  8987. * @param arg
  8988. */
  8989. function pos (&$arg) {}
  8990. /**
  8991. * &Alias; <function>count</function>
  8992. * @link http://www.php.net/manual/en/function.sizeof.php
  8993. * @param var
  8994. * @param mode[optional]
  8995. */
  8996. function sizeof ($var, $mode) {}
  8997. /**
  8998. * @param key
  8999. * @param search
  9000. */
  9001. function key_exists ($key, $search) {}
  9002. /**
  9003. * Checks if assertion is &false;
  9004. * @link http://www.php.net/manual/en/function.assert.php
  9005. * @param assertion mixed <p>
  9006. * The assertion.
  9007. * </p>
  9008. * @return bool false if the assertion is false, true otherwise.
  9009. */
  9010. function assert ($assertion) {}
  9011. /**
  9012. * Set/get the various assert flags
  9013. * @link http://www.php.net/manual/en/function.assert-options.php
  9014. * @param what int <p>
  9015. * <table>
  9016. * Assert Options
  9017. * <tr valign="top">
  9018. * <td>Option</td>
  9019. * <td>INI Setting</td>
  9020. * <td>Default value</td>
  9021. * <td>Description</td>
  9022. * </tr>
  9023. * <tr valign="top">
  9024. * <td>ASSERT_ACTIVE</td>
  9025. * <td>assert.active</td>
  9026. * <td>1</td>
  9027. * <td>enable assert evaluation</td>
  9028. * </tr>
  9029. * <tr valign="top">
  9030. * <td>ASSERT_WARNING</td>
  9031. * <td>assert.warning</td>
  9032. * <td>1</td>
  9033. * <td>issue a PHP warning for each failed assertion</td>
  9034. * </tr>
  9035. * <tr valign="top">
  9036. * <td>ASSERT_BAIL</td>
  9037. * <td>assert.bail</td>
  9038. * <td>0</td>
  9039. * <td>terminate execution on failed assertions</td>
  9040. * </tr>
  9041. * <tr valign="top">
  9042. * <td>ASSERT_QUIET_EVAL</td>
  9043. * <td>assert.quiet_eval</td>
  9044. * <td>0</td>
  9045. * <td>
  9046. * disable error_reporting during assertion expression
  9047. * evaluation
  9048. * </td>
  9049. * </tr>
  9050. * <tr valign="top">
  9051. * <td>ASSERT_CALLBACK</td>
  9052. * <td>assert.callback</td>
  9053. * <td)<&null;)</td>
  9054. * <td>Callback to call on failed assertions</td>
  9055. * </tr>
  9056. * </table>
  9057. * </p>
  9058. * @param value mixed[optional] <p>
  9059. * An optional new value for the option.
  9060. * </p>
  9061. * @return mixed the original setting of any option or false on errors.
  9062. */
  9063. function assert_options ($what, $value = null) {}
  9064. /**
  9065. * Compares two "PHP-standardized" version number strings
  9066. * @link http://www.php.net/manual/en/function.version-compare.php
  9067. * @param version1 string <p>
  9068. * First version number.
  9069. * </p>
  9070. * @param version2 string <p>
  9071. * Second version number.
  9072. * </p>
  9073. * @param operator string[optional] <p>
  9074. * If you specify the third optional operator
  9075. * argument, you can test for a particular relationship. The
  9076. * possible operators are: &lt;,
  9077. * lt, &lt;=,
  9078. * le, &gt;,
  9079. * gt, &gt;=,
  9080. * ge, ==,
  9081. * =, eq,
  9082. * !=, &lt;&gt;,
  9083. * ne respectively.
  9084. * </p>
  9085. * <p>
  9086. * This parameter is case-sensitive, so values should be lowercase.
  9087. * </p>
  9088. * @return mixed By default, version_compare returns
  9089. * -1 if the first version is lower than the second,
  9090. * 0 if they are equal, and
  9091. * 1 if the second is lower.
  9092. * </p>
  9093. * <p>
  9094. * When using the optional operator argument, the
  9095. * function will return true if the relationship is the one specified
  9096. * by the operator, false otherwise.
  9097. */
  9098. function version_compare ($version1, $version2, $operator = null) {}
  9099. /**
  9100. * Perform the rot13 transform on a string
  9101. * @link http://www.php.net/manual/en/function.str-rot13.php
  9102. * @param str string <p>
  9103. * The input string.
  9104. * </p>
  9105. * @return string the ROT13 version of the given string.
  9106. */
  9107. function str_rot13 ($str) {}
  9108. /**
  9109. * Retrieve list of registered filters
  9110. * @link http://www.php.net/manual/en/function.stream-get-filters.php
  9111. * @return array an indexed array containing the name of all stream filters
  9112. * available.
  9113. */
  9114. function stream_get_filters () {}
  9115. /**
  9116. * Register a user defined stream filter
  9117. * @link http://www.php.net/manual/en/function.stream-filter-register.php
  9118. * @param filtername string <p>
  9119. * The filter name to be registered.
  9120. * </p>
  9121. * @param classname string <p>
  9122. * To implement a filter, you need to define a class as an extension of
  9123. * php_user_filter with a number of member functions
  9124. * as defined below. When performing read/write operations on the stream
  9125. * to which your filter is attached, PHP will pass the data through your
  9126. * filter (and any other filters attached to that stream) so that the
  9127. * data may be modified as desired. You must implement the methods
  9128. * exactly as described below - doing otherwise will lead to undefined
  9129. * behaviour.
  9130. * </p>
  9131. * intfilter
  9132. * resourcein
  9133. * resourceout
  9134. * intconsumed
  9135. * boolclosing
  9136. * <p>
  9137. * This method is called whenever data is read from or written to
  9138. * the attached stream (such as with fread or fwrite).
  9139. * in is a resource pointing to a bucket brigade
  9140. * which contains one or more bucket objects containing data to be filtered.
  9141. * out is a resource pointing to a second bucket brigade
  9142. * into which your modified buckets should be placed.
  9143. * consumed, which must always
  9144. * be declared by reference, should be incremented by the length of the data
  9145. * which your filter reads in and alters. In most cases this means you will
  9146. * increment consumed by $bucket->datalen
  9147. * for each $bucket. If the stream is in the process of closing
  9148. * (and therefore this is the last pass through the filterchain),
  9149. * the closing parameter will be set to true.
  9150. * The filter method must return one of
  9151. * three values upon completion.
  9152. * <tr valign="top">
  9153. * <td>Return Value</td>
  9154. * <td>Meaning</td>
  9155. * </tr>
  9156. * <tr valign="top">
  9157. * <td>PSFS_PASS_ON</td>
  9158. * <td>
  9159. * Filter processed successfully with data available in the
  9160. * out bucket brigade.
  9161. * </td>
  9162. * </tr>
  9163. * <tr valign="top">
  9164. * <td>PSFS_FEED_ME</td>
  9165. * <td>
  9166. * Filter processed successfully, however no data was available to
  9167. * return. More data is required from the stream or prior filter.
  9168. * </td>
  9169. * </tr>
  9170. * <tr valign="top">
  9171. * <td>PSFS_ERR_FATAL (default)</td>
  9172. * <td>
  9173. * The filter experienced an unrecoverable error and cannot continue.
  9174. * </td>
  9175. * </tr>
  9176. * </p>
  9177. * boolonCreate
  9178. * This method is called during instantiation of the filter class
  9179. * object. If your filter allocates or initializes any other resources
  9180. * (such as a buffer), this is the place to do it. Your implementation of
  9181. * this method should return false on failure, or true on success.
  9182. * When your filter is first instantiated, and
  9183. * yourfilter-&gt;onCreate() is called, a number of properties
  9184. * will be available as shown in the table below.
  9185. * <p>
  9186. * <tr valign="top">
  9187. * <td>Property</td>
  9188. * <td>Contents</td>
  9189. * </tr>
  9190. * <tr valign="top">
  9191. * <td>FilterClass-&gt;filtername</td>
  9192. * <td>
  9193. * A string containing the name the filter was instantiated with.
  9194. * Filters may be registered under multiple names or under wildcards.
  9195. * Use this property to determine which name was used.
  9196. * </td>
  9197. * </tr>
  9198. * <tr valign="top">
  9199. * <td>FilterClass-&gt;params</td>
  9200. * <td>
  9201. * The contents of the params parameter passed
  9202. * to stream_filter_append
  9203. * or stream_filter_prepend.
  9204. * </td>
  9205. * </tr>
  9206. * <tr valign="top">
  9207. * <td>FilterClass-&gt;stream</td>
  9208. * <td>
  9209. * The stream resource being filtered. Maybe available only during
  9210. * filter calls when the
  9211. * closing parameter is set to false.
  9212. * </td>
  9213. * </tr>
  9214. * </p>
  9215. * voidonClose
  9216. * <p>
  9217. * This method is called upon filter shutdown (typically, this is also
  9218. * during stream shutdown), and is executed after
  9219. * the flush method is called. If any resources
  9220. * were allocated or initialized during onCreate()
  9221. * this would be the time to destroy or dispose of them.
  9222. * </p>
  9223. * @return bool Returns true on success or false on failure.
  9224. * </p>
  9225. * <p>
  9226. * stream_filter_register will return false if the
  9227. * filtername is already defined.
  9228. */
  9229. function stream_filter_register ($filtername, $classname) {}
  9230. /**
  9231. * Return a bucket object from the brigade for operating on
  9232. * @link http://www.php.net/manual/en/function.stream-bucket-make-writeable.php
  9233. * @param brigade resource
  9234. * @return object
  9235. */
  9236. function stream_bucket_make_writeable ($brigade) {}
  9237. /**
  9238. * Prepend bucket to brigade
  9239. * @link http://www.php.net/manual/en/function.stream-bucket-prepend.php
  9240. * @param brigade resource
  9241. * @param bucket resource
  9242. * @return void
  9243. */
  9244. function stream_bucket_prepend ($brigade, $bucket) {}
  9245. /**
  9246. * Append bucket to brigade
  9247. * @link http://www.php.net/manual/en/function.stream-bucket-append.php
  9248. * @param brigade resource
  9249. * @param bucket resource
  9250. * @return void
  9251. */
  9252. function stream_bucket_append ($brigade, $bucket) {}
  9253. /**
  9254. * Create a new bucket for use on the current stream
  9255. * @link http://www.php.net/manual/en/function.stream-bucket-new.php
  9256. * @param stream resource
  9257. * @param buffer string
  9258. * @return object
  9259. */
  9260. function stream_bucket_new ($stream, $buffer) {}
  9261. /**
  9262. * Add URL rewriter values
  9263. * @link http://www.php.net/manual/en/function.output-add-rewrite-var.php
  9264. * @param name string <p>
  9265. * The variable name.
  9266. * </p>
  9267. * @param value string <p>
  9268. * The variable value.
  9269. * </p>
  9270. * @return bool Returns true on success or false on failure.
  9271. */
  9272. function output_add_rewrite_var ($name, $value) {}
  9273. /**
  9274. * Reset URL rewriter values
  9275. * @link http://www.php.net/manual/en/function.output-reset-rewrite-vars.php
  9276. * @return bool Returns true on success or false on failure.
  9277. */
  9278. function output_reset_rewrite_vars () {}
  9279. /**
  9280. * Returns directory path used for temporary files
  9281. * @link http://www.php.net/manual/en/function.sys-get-temp-dir.php
  9282. * @return string the path of the temporary directory.
  9283. */
  9284. function sys_get_temp_dir () {}
  9285. define ('CONNECTION_ABORTED', 1);
  9286. define ('CONNECTION_NORMAL', 0);
  9287. define ('CONNECTION_TIMEOUT', 2);
  9288. define ('INI_USER', 1);
  9289. define ('INI_PERDIR', 2);
  9290. define ('INI_SYSTEM', 4);
  9291. define ('INI_ALL', 7);
  9292. define ('INI_SCANNER_NORMAL', 0);
  9293. define ('INI_SCANNER_RAW', 1);
  9294. define ('PHP_URL_SCHEME', 0);
  9295. define ('PHP_URL_HOST', 1);
  9296. define ('PHP_URL_PORT', 2);
  9297. define ('PHP_URL_USER', 3);
  9298. define ('PHP_URL_PASS', 4);
  9299. define ('PHP_URL_PATH', 5);
  9300. define ('PHP_URL_QUERY', 6);
  9301. define ('PHP_URL_FRAGMENT', 7);
  9302. define ('M_E', 2.718281828459);
  9303. define ('M_LOG2E', 1.442695040889);
  9304. define ('M_LOG10E', 0.43429448190325);
  9305. define ('M_LN2', 0.69314718055995);
  9306. define ('M_LN10', 2.302585092994);
  9307. define ('M_PI', 3.1415926535898);
  9308. define ('M_PI_2', 1.5707963267949);
  9309. define ('M_PI_4', 0.78539816339745);
  9310. define ('M_1_PI', 0.31830988618379);
  9311. define ('M_2_PI', 0.63661977236758);
  9312. define ('M_SQRTPI', 1.7724538509055);
  9313. define ('M_2_SQRTPI', 1.1283791670955);
  9314. define ('M_LNPI', 1.1447298858494);
  9315. define ('M_EULER', 0.57721566490153);
  9316. define ('M_SQRT2', 1.4142135623731);
  9317. define ('M_SQRT1_2', 0.70710678118655);
  9318. define ('M_SQRT3', 1.7320508075689);
  9319. define ('INF', INF);
  9320. define ('NAN', NAN);
  9321. define ('PHP_ROUND_HALF_UP', 1);
  9322. define ('PHP_ROUND_HALF_DOWN', 2);
  9323. define ('PHP_ROUND_HALF_EVEN', 3);
  9324. define ('PHP_ROUND_HALF_ODD', 4);
  9325. define ('INFO_GENERAL', 1);
  9326. define ('INFO_CREDITS', 2);
  9327. define ('INFO_CONFIGURATION', 4);
  9328. define ('INFO_MODULES', 8);
  9329. define ('INFO_ENVIRONMENT', 16);
  9330. define ('INFO_VARIABLES', 32);
  9331. define ('INFO_LICENSE', 64);
  9332. define ('INFO_ALL', -1);
  9333. define ('CREDITS_GROUP', 1);
  9334. define ('CREDITS_GENERAL', 2);
  9335. define ('CREDITS_SAPI', 4);
  9336. define ('CREDITS_MODULES', 8);
  9337. define ('CREDITS_DOCS', 16);
  9338. define ('CREDITS_FULLPAGE', 32);
  9339. define ('CREDITS_QA', 64);
  9340. define ('CREDITS_ALL', -1);
  9341. define ('HTML_SPECIALCHARS', 0);
  9342. define ('HTML_ENTITIES', 1);
  9343. define ('ENT_COMPAT', 2);
  9344. define ('ENT_QUOTES', 3);
  9345. define ('ENT_NOQUOTES', 0);
  9346. define ('ENT_IGNORE', 4);
  9347. define ('STR_PAD_LEFT', 0);
  9348. define ('STR_PAD_RIGHT', 1);
  9349. define ('STR_PAD_BOTH', 2);
  9350. define ('PATHINFO_DIRNAME', 1);
  9351. define ('PATHINFO_BASENAME', 2);
  9352. define ('PATHINFO_EXTENSION', 4);
  9353. define ('PATHINFO_FILENAME', 8);
  9354. define ('CHAR_MAX', 127);
  9355. define ('LC_CTYPE', 2);
  9356. define ('LC_NUMERIC', 4);
  9357. define ('LC_TIME', 5);
  9358. define ('LC_COLLATE', 1);
  9359. define ('LC_MONETARY', 3);
  9360. define ('LC_ALL', 0);
  9361. define ('SEEK_SET', 0);
  9362. define ('SEEK_CUR', 1);
  9363. define ('SEEK_END', 2);
  9364. define ('LOCK_SH', 1);
  9365. define ('LOCK_EX', 2);
  9366. define ('LOCK_UN', 3);
  9367. define ('LOCK_NB', 4);
  9368. define ('STREAM_NOTIFY_CONNECT', 2);
  9369. define ('STREAM_NOTIFY_AUTH_REQUIRED', 3);
  9370. define ('STREAM_NOTIFY_AUTH_RESULT', 10);
  9371. define ('STREAM_NOTIFY_MIME_TYPE_IS', 4);
  9372. define ('STREAM_NOTIFY_FILE_SIZE_IS', 5);
  9373. define ('STREAM_NOTIFY_REDIRECTED', 6);
  9374. define ('STREAM_NOTIFY_PROGRESS', 7);
  9375. define ('STREAM_NOTIFY_FAILURE', 9);
  9376. define ('STREAM_NOTIFY_COMPLETED', 8);
  9377. define ('STREAM_NOTIFY_RESOLVE', 1);
  9378. define ('STREAM_NOTIFY_SEVERITY_INFO', 0);
  9379. define ('STREAM_NOTIFY_SEVERITY_WARN', 1);
  9380. define ('STREAM_NOTIFY_SEVERITY_ERR', 2);
  9381. define ('STREAM_FILTER_READ', 1);
  9382. define ('STREAM_FILTER_WRITE', 2);
  9383. define ('STREAM_FILTER_ALL', 3);
  9384. define ('STREAM_CLIENT_PERSISTENT', 1);
  9385. define ('STREAM_CLIENT_ASYNC_CONNECT', 2);
  9386. define ('STREAM_CLIENT_CONNECT', 4);
  9387. define ('STREAM_CRYPTO_METHOD_SSLv2_CLIENT', 0);
  9388. define ('STREAM_CRYPTO_METHOD_SSLv3_CLIENT', 1);
  9389. define ('STREAM_CRYPTO_METHOD_SSLv23_CLIENT', 2);
  9390. define ('STREAM_CRYPTO_METHOD_TLS_CLIENT', 3);
  9391. define ('STREAM_CRYPTO_METHOD_SSLv2_SERVER', 4);
  9392. define ('STREAM_CRYPTO_METHOD_SSLv3_SERVER', 5);
  9393. define ('STREAM_CRYPTO_METHOD_SSLv23_SERVER', 6);
  9394. define ('STREAM_CRYPTO_METHOD_TLS_SERVER', 7);
  9395. define ('STREAM_SHUT_RD', 0);
  9396. define ('STREAM_SHUT_WR', 1);
  9397. define ('STREAM_SHUT_RDWR', 2);
  9398. define ('STREAM_PF_INET', 2);
  9399. define ('STREAM_PF_INET6', 23);
  9400. define ('STREAM_PF_UNIX', 1);
  9401. define ('STREAM_IPPROTO_IP', 0);
  9402. define ('STREAM_IPPROTO_TCP', 6);
  9403. define ('STREAM_IPPROTO_UDP', 17);
  9404. define ('STREAM_IPPROTO_ICMP', 1);
  9405. define ('STREAM_IPPROTO_RAW', 255);
  9406. define ('STREAM_SOCK_STREAM', 1);
  9407. define ('STREAM_SOCK_DGRAM', 2);
  9408. define ('STREAM_SOCK_RAW', 3);
  9409. define ('STREAM_SOCK_SEQPACKET', 5);
  9410. define ('STREAM_SOCK_RDM', 4);
  9411. define ('STREAM_PEEK', 2);
  9412. define ('STREAM_OOB', 1);
  9413. define ('STREAM_SERVER_BIND', 4);
  9414. define ('STREAM_SERVER_LISTEN', 8);
  9415. define ('FILE_USE_INCLUDE_PATH', 1);
  9416. define ('FILE_IGNORE_NEW_LINES', 2);
  9417. define ('FILE_SKIP_EMPTY_LINES', 4);
  9418. define ('FILE_APPEND', 8);
  9419. define ('FILE_NO_DEFAULT_CONTEXT', 16);
  9420. define ('FILE_TEXT', 0);
  9421. define ('FILE_BINARY', 0);
  9422. define ('FNM_NOESCAPE', 1);
  9423. define ('FNM_PATHNAME', 2);
  9424. define ('FNM_PERIOD', 4);
  9425. define ('FNM_CASEFOLD', 16);
  9426. define ('PSFS_PASS_ON', 2);
  9427. define ('PSFS_FEED_ME', 1);
  9428. define ('PSFS_ERR_FATAL', 0);
  9429. define ('PSFS_FLAG_NORMAL', 0);
  9430. define ('PSFS_FLAG_FLUSH_INC', 1);
  9431. define ('PSFS_FLAG_FLUSH_CLOSE', 2);
  9432. define ('CRYPT_SALT_LENGTH', 60);
  9433. define ('CRYPT_STD_DES', 1);
  9434. define ('CRYPT_EXT_DES', 1);
  9435. define ('CRYPT_MD5', 1);
  9436. define ('CRYPT_BLOWFISH', 1);
  9437. define ('DIRECTORY_SEPARATOR', "/");
  9438. define ('PATH_SEPARATOR', ";");
  9439. define ('GLOB_BRACE', 128);
  9440. define ('GLOB_MARK', 8);
  9441. define ('GLOB_NOSORT', 32);
  9442. define ('GLOB_NOCHECK', 16);
  9443. define ('GLOB_NOESCAPE', 4096);
  9444. define ('GLOB_ERR', 4);
  9445. define ('GLOB_ONLYDIR', 1073741824);
  9446. define ('GLOB_AVAILABLE_FLAGS', 1073746108);
  9447. define ('LOG_EMERG', 1);
  9448. define ('LOG_ALERT', 1);
  9449. define ('LOG_CRIT', 1);
  9450. define ('LOG_ERR', 4);
  9451. define ('LOG_WARNING', 5);
  9452. define ('LOG_NOTICE', 6);
  9453. define ('LOG_INFO', 6);
  9454. define ('LOG_DEBUG', 6);
  9455. define ('LOG_KERN', 0);
  9456. define ('LOG_USER', 8);
  9457. define ('LOG_MAIL', 16);
  9458. define ('LOG_DAEMON', 24);
  9459. define ('LOG_AUTH', 32);
  9460. define ('LOG_SYSLOG', 40);
  9461. define ('LOG_LPR', 48);
  9462. define ('LOG_NEWS', 56);
  9463. define ('LOG_UUCP', 64);
  9464. define ('LOG_CRON', 72);
  9465. define ('LOG_AUTHPRIV', 80);
  9466. define ('LOG_PID', 1);
  9467. define ('LOG_CONS', 2);
  9468. define ('LOG_ODELAY', 4);
  9469. define ('LOG_NDELAY', 8);
  9470. define ('LOG_NOWAIT', 16);
  9471. define ('LOG_PERROR', 32);
  9472. define ('EXTR_OVERWRITE', 0);
  9473. define ('EXTR_SKIP', 1);
  9474. define ('EXTR_PREFIX_SAME', 2);
  9475. define ('EXTR_PREFIX_ALL', 3);
  9476. define ('EXTR_PREFIX_INVALID', 4);
  9477. define ('EXTR_PREFIX_IF_EXISTS', 5);
  9478. define ('EXTR_IF_EXISTS', 6);
  9479. define ('EXTR_REFS', 256);
  9480. define ('SORT_ASC', 4);
  9481. define ('SORT_DESC', 3);
  9482. define ('SORT_REGULAR', 0);
  9483. define ('SORT_NUMERIC', 1);
  9484. define ('SORT_STRING', 2);
  9485. define ('SORT_LOCALE_STRING', 5);
  9486. define ('CASE_LOWER', 0);
  9487. define ('CASE_UPPER', 1);
  9488. define ('COUNT_NORMAL', 0);
  9489. define ('COUNT_RECURSIVE', 1);
  9490. define ('ASSERT_ACTIVE', 1);
  9491. define ('ASSERT_CALLBACK', 2);
  9492. define ('ASSERT_BAIL', 3);
  9493. define ('ASSERT_WARNING', 4);
  9494. define ('ASSERT_QUIET_EVAL', 5);
  9495. define ('STREAM_USE_PATH', 1);
  9496. define ('STREAM_IGNORE_URL', 2);
  9497. define ('STREAM_ENFORCE_SAFE_MODE', 4);
  9498. define ('STREAM_REPORT_ERRORS', 8);
  9499. define ('STREAM_MUST_SEEK', 16);
  9500. define ('STREAM_URL_STAT_LINK', 1);
  9501. define ('STREAM_URL_STAT_QUIET', 2);
  9502. define ('STREAM_MKDIR_RECURSIVE', 1);
  9503. define ('STREAM_IS_URL', 1);
  9504. define ('STREAM_OPTION_BLOCKING', 1);
  9505. define ('STREAM_OPTION_READ_TIMEOUT', 4);
  9506. define ('STREAM_OPTION_READ_BUFFER', 2);
  9507. define ('STREAM_OPTION_WRITE_BUFFER', 3);
  9508. define ('STREAM_BUFFER_NONE', 0);
  9509. define ('STREAM_BUFFER_LINE', 1);
  9510. define ('STREAM_BUFFER_FULL', 2);
  9511. define ('STREAM_CAST_AS_STREAM', 0);
  9512. define ('STREAM_CAST_FOR_SELECT', 3);
  9513. define ('IMAGETYPE_GIF', 1);
  9514. define ('IMAGETYPE_JPEG', 2);
  9515. define ('IMAGETYPE_PNG', 3);
  9516. define ('IMAGETYPE_SWF', 4);
  9517. define ('IMAGETYPE_PSD', 5);
  9518. define ('IMAGETYPE_BMP', 6);
  9519. define ('IMAGETYPE_TIFF_II', 7);
  9520. define ('IMAGETYPE_TIFF_MM', 8);
  9521. define ('IMAGETYPE_JPC', 9);
  9522. define ('IMAGETYPE_JP2', 10);
  9523. define ('IMAGETYPE_JPX', 11);
  9524. define ('IMAGETYPE_JB2', 12);
  9525. define ('IMAGETYPE_SWC', 13);
  9526. define ('IMAGETYPE_IFF', 14);
  9527. define ('IMAGETYPE_WBMP', 15);
  9528. define ('IMAGETYPE_JPEG2000', 9);
  9529. define ('IMAGETYPE_XBM', 16);
  9530. define ('IMAGETYPE_ICO', 17);
  9531. define ('IMAGETYPE_UNKNOWN', 0);
  9532. define ('IMAGETYPE_COUNT', 18);
  9533. define ('DNS_A', 1);
  9534. define ('DNS_NS', 2);
  9535. define ('DNS_CNAME', 16);
  9536. define ('DNS_SOA', 32);
  9537. define ('DNS_PTR', 2048);
  9538. define ('DNS_HINFO', 4096);
  9539. define ('DNS_MX', 16384);
  9540. define ('DNS_TXT', 32768);
  9541. define ('DNS_SRV', 33554432);
  9542. define ('DNS_NAPTR', 67108864);
  9543. define ('DNS_AAAA', 134217728);
  9544. define ('DNS_A6', 16777216);
  9545. define ('DNS_ANY', 268435456);
  9546. define ('DNS_ALL', 251713587);
  9547. // End of standard v.5.3.0
  9548. ?>