PageRenderTime 79ms CodeModel.GetById 13ms RepoModel.GetById 1ms app.codeStats 0ms

/ide/eclipse/jaggery/org.eclipse.php.core/Resources/language/php5.3/standard.php

https://github.com/blue666man/tools
PHP | 11255 lines | 865 code | 676 blank | 9714 comment | 0 complexity | 4d1813f557251982a602c1f767affcaf MD5 | raw file
Possible License(s): 0BSD
  1. <?php
  2. // Start of standard v.5.3.2
  3. class __PHP_Incomplete_Class {
  4. }
  5. class php_user_filter {
  6. public $filtername;
  7. public $params;
  8. /**
  9. * @param in
  10. * @param out
  11. * @param consumed
  12. * @param closing
  13. */
  14. public function filter ($in, $out, &$consumed, $closing) {}
  15. public function onCreate () {}
  16. public function onClose () {}
  17. }
  18. class Directory {
  19. public function close () {}
  20. public function rewind () {}
  21. public function read () {}
  22. }
  23. /**
  24. * Returns the value of a constant
  25. * @link http://www.php.net/manual/en/function.constant.php
  26. * @param name string <p>
  27. * The constant name.
  28. * </p>
  29. * @return mixed the value of the constant, or &null; if the constant is not
  30. * defined.
  31. */
  32. function constant ($name) {}
  33. /**
  34. * Convert binary data into hexadecimal representation
  35. * @link http://www.php.net/manual/en/function.bin2hex.php
  36. * @param str string <p>
  37. * A character.
  38. * </p>
  39. * @return string the hexadecimal representation of the given string.
  40. */
  41. function bin2hex ($str) {}
  42. /**
  43. * Delay execution
  44. * @link http://www.php.net/manual/en/function.sleep.php
  45. * @param seconds int <p>
  46. * Halt time in seconds.
  47. * </p>
  48. * @return int zero on success, or false on errors. If the call was interrupted
  49. * by a signal, sleep returns the number of seconds left
  50. * to sleep.
  51. */
  52. function sleep ($seconds) {}
  53. /**
  54. * Delay execution in microseconds
  55. * @link http://www.php.net/manual/en/function.usleep.php
  56. * @param micro_seconds int <p>
  57. * Halt time in micro seconds. A micro second is one millionth of a
  58. * second.
  59. * </p>
  60. * @return void
  61. */
  62. function usleep ($micro_seconds) {}
  63. /**
  64. * Delay for a number of seconds and nanoseconds
  65. * @link http://www.php.net/manual/en/function.time-nanosleep.php
  66. * @param seconds int <p>
  67. * Must be a positive integer.
  68. * </p>
  69. * @param nanoseconds int <p>
  70. * Must be a positive integer less than 1 billion.
  71. * </p>
  72. * @return mixed Returns true on success or false on failure.
  73. * </p>
  74. * <p>
  75. * If the delay was interrupted by a signal, an associative array will be
  76. * returned with the components:
  77. * seconds - number of seconds remaining in
  78. * the delay
  79. * nanoseconds - number of nanoseconds
  80. * remaining in the delay
  81. */
  82. function time_nanosleep ($seconds, $nanoseconds) {}
  83. /**
  84. * Make the script sleep until the specified time
  85. * @link http://www.php.net/manual/en/function.time-sleep-until.php
  86. * @param timestamp float <p>
  87. * The timestamp when the script should wake.
  88. * </p>
  89. * @return bool Returns true on success or false on failure.
  90. */
  91. function time_sleep_until ($timestamp) {}
  92. /**
  93. * Parse a time/date generated with <function>strftime</function>
  94. * @link http://www.php.net/manual/en/function.strptime.php
  95. * @param date string <p>
  96. * The string to parse (e.g. returned from strftime)
  97. * </p>
  98. * @param format string <p>
  99. * The format used in date (e.g. the same as
  100. * used in strftime).
  101. * </p>
  102. * <p>
  103. * For more information about the format options, read the
  104. * strftime page.
  105. * </p>
  106. * @return array an array&return.falseforfailure;.
  107. * </p>
  108. * <p>
  109. * <table>
  110. * The following parameters are returned in the array
  111. * <tr valign="top">
  112. * <td>parameters</td>
  113. * <td>Description</td>
  114. * </tr>
  115. * <tr valign="top">
  116. * <td>"tm_sec"</td>
  117. * <td>Seconds after the minute (0-61)</td>
  118. * </tr>
  119. * <tr valign="top">
  120. * <td>"tm_min"</td>
  121. * <td>Minutes after the hour (0-59)</td>
  122. * </tr>
  123. * <tr valign="top">
  124. * <td>"tm_hour"</td>
  125. * <td>Hour since midnight (0-23)</td>
  126. * </tr>
  127. * <tr valign="top">
  128. * <td>"tm_mday"</td>
  129. * <td>Day of the month (1-31)</td>
  130. * </tr>
  131. * <tr valign="top">
  132. * <td>"tm_mon"</td>
  133. * <td>Months since January (0-11)</td>
  134. * </tr>
  135. * <tr valign="top">
  136. * <td>"tm_year"</td>
  137. * <td>Years since 1900</td>
  138. * </tr>
  139. * <tr valign="top">
  140. * <td>"tm_wday"</td>
  141. * <td>Days since Sunday (0-6)</td>
  142. * </tr>
  143. * <tr valign="top">
  144. * <td>"tm_yday"</td>
  145. * <td>Days since January 1 (0-365)</td>
  146. * </tr>
  147. * <tr valign="top">
  148. * <td>"unparsed"</td>
  149. * <td>the date part which was not
  150. * recognized using the specified format</td>
  151. * </tr>
  152. * </table>
  153. */
  154. function strptime ($date, $format) {}
  155. /**
  156. * Flush the output buffer
  157. * @link http://www.php.net/manual/en/function.flush.php
  158. * @return void
  159. */
  160. function flush () {}
  161. /**
  162. * Wraps a string to a given number of characters
  163. * @link http://www.php.net/manual/en/function.wordwrap.php
  164. * @param str string <p>
  165. * The input string.
  166. * </p>
  167. * @param width int[optional] <p>
  168. * The column width.
  169. * </p>
  170. * @param break string[optional] <p>
  171. * The line is broken using the optional
  172. * break parameter.
  173. * </p>
  174. * @param cut bool[optional] <p>
  175. * If the cut is set to true, the string is
  176. * always wrapped at or before the specified width. So if you have
  177. * a word that is larger than the given width, it is broken apart.
  178. * (See second example).
  179. * </p>
  180. * @return string the given string wrapped at the specified column.
  181. */
  182. function wordwrap ($str, $width = null, $break = null, $cut = null) {}
  183. /**
  184. * Convert special characters to HTML entities
  185. * @link http://www.php.net/manual/en/function.htmlspecialchars.php
  186. * @param string string <p>
  187. * The string being converted.
  188. * </p>
  189. * @param quote_style int[optional] <p>
  190. * The optional second argument, quote_style, tells
  191. * the function what to do with single and double quote characters.
  192. * The default mode, ENT_COMPAT, is the backwards compatible mode
  193. * which only translates the double-quote character and leaves the
  194. * single-quote untranslated. If ENT_QUOTES is set, both single and
  195. * double quotes are translated and if ENT_NOQUOTES is set neither
  196. * single nor double quotes are translated.
  197. * </p>
  198. * @param charset string[optional] <p>
  199. * Defines character set used in conversion.
  200. * The default character set is ISO-8859-1.
  201. * </p>
  202. * <p>
  203. * For the purposes of this function, the charsets
  204. * ISO-8859-1, ISO-8859-15,
  205. * UTF-8, cp866,
  206. * cp1251, cp1252, and
  207. * KOI8-R are effectively equivalent, as the
  208. * characters affected by htmlspecialchars
  209. * occupy the same positions in all of these charsets.
  210. * </p>
  211. * &reference.strings.charsets;
  212. * @param double_encode bool[optional] <p>
  213. * When double_encode is turned off PHP will not
  214. * encode existing html entities, the default is to convert everything.
  215. * </p>
  216. * @return string The converted string.
  217. */
  218. function htmlspecialchars ($string, $quote_style = null, $charset = null, $double_encode = null) {}
  219. /**
  220. * Convert all applicable characters to HTML entities
  221. * @link http://www.php.net/manual/en/function.htmlentities.php
  222. * @param string string <p>
  223. * The input string.
  224. * </p>
  225. * @param quote_style int[optional] <p>
  226. * Like htmlspecialchars, the optional second
  227. * quote_style parameter lets you define what will
  228. * be done with 'single' and "double" quotes. It takes on one of three
  229. * constants with the default being ENT_COMPAT:
  230. * <table>
  231. * Available quote_style constants
  232. * <tr valign="top">
  233. * <td>Constant Name</td>
  234. * <td>Description</td>
  235. * </tr>
  236. * <tr valign="top">
  237. * <td>ENT_COMPAT</td>
  238. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  239. * </tr>
  240. * <tr valign="top">
  241. * <td>ENT_QUOTES</td>
  242. * <td>Will convert both double and single quotes.</td>
  243. * </tr>
  244. * <tr valign="top">
  245. * <td>ENT_NOQUOTES</td>
  246. * <td>Will leave both double and single quotes unconverted.</td>
  247. * </tr>
  248. * </table>
  249. * </p>
  250. * @param charset string[optional] <p>
  251. * Like htmlspecialchars, it takes an optional
  252. * third argument charset which defines character
  253. * set used in conversion.
  254. * Presently, the ISO-8859-1 character set is used as the default.
  255. * </p>
  256. * &reference.strings.charsets;
  257. * @param double_encode bool[optional] <p>
  258. * When double_encode is turned off PHP will not
  259. * encode existing html entities. The default is to convert everything.
  260. * </p>
  261. * @return string the encoded string.
  262. */
  263. function htmlentities ($string, $quote_style = null, $charset = null, $double_encode = null) {}
  264. /**
  265. * Convert all HTML entities to their applicable characters
  266. * @link http://www.php.net/manual/en/function.html-entity-decode.php
  267. * @param string string <p>
  268. * The input string.
  269. * </p>
  270. * @param quote_style int[optional] <p>
  271. * The optional second quote_style parameter lets
  272. * you define what will be done with 'single' and "double" quotes. It takes
  273. * on one of three constants with the default being
  274. * ENT_COMPAT:
  275. * <table>
  276. * Available quote_style constants
  277. * <tr valign="top">
  278. * <td>Constant Name</td>
  279. * <td>Description</td>
  280. * </tr>
  281. * <tr valign="top">
  282. * <td>ENT_COMPAT</td>
  283. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  284. * </tr>
  285. * <tr valign="top">
  286. * <td>ENT_QUOTES</td>
  287. * <td>Will convert both double and single quotes.</td>
  288. * </tr>
  289. * <tr valign="top">
  290. * <td>ENT_NOQUOTES</td>
  291. * <td>Will leave both double and single quotes unconverted.</td>
  292. * </tr>
  293. * </table>
  294. * </p>
  295. * @param charset string[optional] <p>
  296. * The ISO-8859-1 character set is used as default for the optional third
  297. * charset. This defines the character set used in
  298. * conversion.
  299. * </p>
  300. * &reference.strings.charsets;
  301. * @return string the decoded string.
  302. */
  303. function html_entity_decode ($string, $quote_style = null, $charset = null) {}
  304. /**
  305. * Convert special HTML entities back to characters
  306. * @link http://www.php.net/manual/en/function.htmlspecialchars-decode.php
  307. * @param string string <p>
  308. * The string to decode
  309. * </p>
  310. * @param quote_style int[optional] <p>
  311. * The quote style. One of the following constants:
  312. * <table>
  313. * quote_style constants
  314. * <tr valign="top">
  315. * <td>Constant Name</td>
  316. * <td>Description</td>
  317. * </tr>
  318. * <tr valign="top">
  319. * <td>ENT_COMPAT</td>
  320. * <td>Will convert double-quotes and leave single-quotes alone
  321. * (default)</td>
  322. * </tr>
  323. * <tr valign="top">
  324. * <td>ENT_QUOTES</td>
  325. * <td>Will convert both double and single quotes</td>
  326. * </tr>
  327. * <tr valign="top">
  328. * <td>ENT_NOQUOTES</td>
  329. * <td>Will leave both double and single quotes unconverted</td>
  330. * </tr>
  331. * </table>
  332. * </p>
  333. * @return string the decoded string.
  334. */
  335. function htmlspecialchars_decode ($string, $quote_style = null) {}
  336. /**
  337. * Returns the translation table used by <function>htmlspecialchars</function> and <function>htmlentities</function>
  338. * @link http://www.php.net/manual/en/function.get-html-translation-table.php
  339. * @param table int[optional] <p>
  340. * There are two new constants (HTML_ENTITIES,
  341. * HTML_SPECIALCHARS) that allow you to specify the
  342. * table you want.
  343. * </p>
  344. * @param quote_style int[optional] <p>
  345. * Like the htmlspecialchars and
  346. * htmlentities functions you can optionally specify
  347. * the quote_style you are working with.
  348. * See the description
  349. * of these modes in htmlspecialchars.
  350. * </p>
  351. * @return array the translation table as an array.
  352. */
  353. function get_html_translation_table ($table = null, $quote_style = null) {}
  354. /**
  355. * Calculate the sha1 hash of a string
  356. * @link http://www.php.net/manual/en/function.sha1.php
  357. * @param str string <p>
  358. * The input string.
  359. * </p>
  360. * @param raw_output bool[optional] <p>
  361. * If the optional raw_output is set to true,
  362. * then the sha1 digest is instead returned in raw binary format with a
  363. * length of 20, otherwise the returned value is a 40-character
  364. * hexadecimal number.
  365. * </p>
  366. * @return string the sha1 hash as a string.
  367. */
  368. function sha1 ($str, $raw_output = null) {}
  369. /**
  370. * Calculate the sha1 hash of a file
  371. * @link http://www.php.net/manual/en/function.sha1-file.php
  372. * @param filename string <p>
  373. * The filename of the file to hash.
  374. * </p>
  375. * @param raw_output bool[optional] <p>
  376. * When true, returns the digest in raw binary format with a length of
  377. * 20.
  378. * </p>
  379. * @return string a string on success, false otherwise.
  380. */
  381. function sha1_file ($filename, $raw_output = null) {}
  382. /**
  383. * Calculate the md5 hash of a string
  384. * @link http://www.php.net/manual/en/function.md5.php
  385. * @param str string <p>
  386. * The string.
  387. * </p>
  388. * @param raw_output bool[optional] <p>
  389. * If the optional raw_output is set to true,
  390. * then the md5 digest is instead returned in raw binary format with a
  391. * length of 16.
  392. * </p>
  393. * @return string the hash as a 32-character hexadecimal number.
  394. */
  395. function md5 ($str, $raw_output = null) {}
  396. /**
  397. * Calculates the md5 hash of a given file
  398. * @link http://www.php.net/manual/en/function.md5-file.php
  399. * @param filename string <p>
  400. * The filename
  401. * </p>
  402. * @param raw_output bool[optional] <p>
  403. * When true, returns the digest in raw binary format with a length of
  404. * 16.
  405. * </p>
  406. * @return string a string on success, false otherwise.
  407. */
  408. function md5_file ($filename, $raw_output = null) {}
  409. /**
  410. * Calculates the crc32 polynomial of a string
  411. * @link http://www.php.net/manual/en/function.crc32.php
  412. * @param str string <p>
  413. * The data.
  414. * </p>
  415. * @return int the crc32 checksum of str as an integer.
  416. */
  417. function crc32 ($str) {}
  418. /**
  419. * Parse a binary IPTC block into single tags.
  420. * @link http://www.php.net/manual/en/function.iptcparse.php
  421. * @param iptcblock string <p>
  422. * A binary IPTC block.
  423. * </p>
  424. * @return array an array using the tagmarker as an index and the value as the
  425. * value. It returns false on error or if no IPTC data was found.
  426. */
  427. function iptcparse ($iptcblock) {}
  428. /**
  429. * Embeds binary IPTC data into a JPEG image
  430. * @link http://www.php.net/manual/en/function.iptcembed.php
  431. * @param iptcdata string <p>
  432. * The data to be written.
  433. * </p>
  434. * @param jpeg_file_name string <p>
  435. * Path to the JPEG image.
  436. * </p>
  437. * @param spool int[optional] <p>
  438. * Spool flag. If the spool flag is over 2 then the JPEG will be
  439. * returned as a string.
  440. * </p>
  441. * @return mixed If success and spool flag is lower than 2 then the JPEG will not be
  442. * returned as a string, false on errors.
  443. */
  444. function iptcembed ($iptcdata, $jpeg_file_name, $spool = null) {}
  445. /**
  446. * Get the size of an image
  447. * @link http://www.php.net/manual/en/function.getimagesize.php
  448. * @param filename string <p>
  449. * This parameter specifies the file you wish to retrieve information
  450. * about. It can reference a local file or (configuration permitting) a
  451. * remote file using one of the supported streams.
  452. * </p>
  453. * @param imageinfo array[optional] <p>
  454. * This optional parameter allows you to extract some extended
  455. * information from the image file. Currently, this will return the
  456. * different JPG APP markers as an associative array.
  457. * Some programs use these APP markers to embed text information in
  458. * images. A very common one is to embed
  459. * IPTC information in the APP13 marker.
  460. * You can use the iptcparse function to parse the
  461. * binary APP13 marker into something readable.
  462. * </p>
  463. * @return array an array with 7 elements.
  464. * </p>
  465. * <p>
  466. * Index 0 and 1 contains respectively the width and the height of the image.
  467. * </p>
  468. * <p>
  469. * Some formats may contain no image or may contain multiple images. In these
  470. * cases, getimagesize might not be able to properly
  471. * determine the image size. getimagesize will return
  472. * zero for width and height in these cases.
  473. * </p>
  474. * <p>
  475. * Index 2 is one of the IMAGETYPE_XXX constants indicating
  476. * the type of the image.
  477. * </p>
  478. * <p>
  479. * Index 3 is a text string with the correct
  480. * height="yyy" width="xxx" string that can be used
  481. * directly in an IMG tag.
  482. * </p>
  483. * <p>
  484. * mime is the correspondant MIME type of the image.
  485. * This information can be used to deliver images with correct the HTTP
  486. * Content-type header:
  487. * getimagesize and MIME types
  488. * ]]>
  489. * </p>
  490. * <p>
  491. * channels will be 3 for RGB pictures and 4 for CMYK
  492. * pictures.
  493. * </p>
  494. * <p>
  495. * bits is the number of bits for each color.
  496. * </p>
  497. * <p>
  498. * For some image types, the presence of channels and
  499. * bits values can be a bit
  500. * confusing. As an example, GIF always uses 3 channels
  501. * per pixel, but the number of bits per pixel cannot be calculated for an
  502. * animated GIF with a global color table.
  503. * </p>
  504. * <p>
  505. * On failure, false is returned.
  506. */
  507. function getimagesize ($filename, array &$imageinfo = null) {}
  508. /**
  509. * Get Mime-Type for image-type returned by getimagesize,
  510. exif_read_data, exif_thumbnail, exif_imagetype
  511. * @link http://www.php.net/manual/en/function.image-type-to-mime-type.php
  512. * @param imagetype int <p>
  513. * One of the IMAGETYPE_XXX constants.
  514. * </p>
  515. * @return string The returned values are as follows
  516. * <table>
  517. * Returned values Constants
  518. * <tr valign="top">
  519. * <td>imagetype</td>
  520. * <td>Returned value</td>
  521. * </tr>
  522. * <tr valign="top">
  523. * <td>IMAGETYPE_GIF</td>
  524. * <td>image/gif</td>
  525. * </tr>
  526. * <tr valign="top">
  527. * <td>IMAGETYPE_JPEG</td>
  528. * <td>image/jpeg</td>
  529. * </tr>
  530. * <tr valign="top">
  531. * <td>IMAGETYPE_PNG</td>
  532. * <td>image/png</td>
  533. * </tr>
  534. * <tr valign="top">
  535. * <td>IMAGETYPE_SWF</td>
  536. * <td>application/x-shockwave-flash</td>
  537. * </tr>
  538. * <tr valign="top">
  539. * <td>IMAGETYPE_PSD</td>
  540. * <td>image/psd</td>
  541. * </tr>
  542. * <tr valign="top">
  543. * <td>IMAGETYPE_BMP</td>
  544. * <td>image/bmp</td>
  545. * </tr>
  546. * <tr valign="top">
  547. * <td>IMAGETYPE_TIFF_II (intel byte order)</td>
  548. * <td>image/tiff</td>
  549. * </tr>
  550. * <tr valign="top">
  551. * <td>
  552. * IMAGETYPE_TIFF_MM (motorola byte order)
  553. * </td>
  554. * <td>image/tiff</td>
  555. * </tr>
  556. * <tr valign="top">
  557. * <td>IMAGETYPE_JPC</td>
  558. * <td>application/octet-stream</td>
  559. * </tr>
  560. * <tr valign="top">
  561. * <td>IMAGETYPE_JP2</td>
  562. * <td>image/jp2</td>
  563. * </tr>
  564. * <tr valign="top">
  565. * <td>IMAGETYPE_JPX</td>
  566. * <td>application/octet-stream</td>
  567. * </tr>
  568. * <tr valign="top">
  569. * <td>IMAGETYPE_JB2</td>
  570. * <td>application/octet-stream</td>
  571. * </tr>
  572. * <tr valign="top">
  573. * <td>IMAGETYPE_SWC</td>
  574. * <td>application/x-shockwave-flash</td>
  575. * </tr>
  576. * <tr valign="top">
  577. * <td>IMAGETYPE_IFF</td>
  578. * <td>image/iff</td>
  579. * </tr>
  580. * <tr valign="top">
  581. * <td>IMAGETYPE_WBMP</td>
  582. * <td>image/vnd.wap.wbmp</td>
  583. * </tr>
  584. * <tr valign="top">
  585. * <td>IMAGETYPE_XBM</td>
  586. * <td>image/xbm</td>
  587. * </tr>
  588. * <tr valign="top">
  589. * <td>IMAGETYPE_ICO</td>
  590. * <td>image/vnd.microsoft.icon</td>
  591. * </tr>
  592. * </table>
  593. */
  594. function image_type_to_mime_type ($imagetype) {}
  595. /**
  596. * Get file extension for image type
  597. * @link http://www.php.net/manual/en/function.image-type-to-extension.php
  598. * @param imagetype int <p>
  599. * One of the IMAGETYPE_XXX constant.
  600. * </p>
  601. * @param include_dot bool[optional] <p>
  602. * Whether to prepend a dot to the extension or not. Default to true.
  603. * </p>
  604. * @return string A string with the extension corresponding to the given image type.
  605. */
  606. function image_type_to_extension ($imagetype, $include_dot = null) {}
  607. /**
  608. * Outputs information about PHP's configuration
  609. * @link http://www.php.net/manual/en/function.phpinfo.php
  610. * @param what int[optional] <p>
  611. * The output may be customized by passing one or more of the
  612. * following constants bitwise values summed
  613. * together in the optional what parameter.
  614. * One can also combine the respective constants or bitwise values
  615. * together with the or operator.
  616. * </p>
  617. * <p>
  618. * <table>
  619. * phpinfo options
  620. * <tr valign="top">
  621. * <td>Name (constant)</td>
  622. * <td>Value</td>
  623. * <td>Description</td>
  624. * </tr>
  625. * <tr valign="top">
  626. * <td>INFO_GENERAL</td>
  627. * <td>1</td>
  628. * <td>
  629. * The configuration line, &php.ini; location, build date, Web
  630. * Server, System and more.
  631. * </td>
  632. * </tr>
  633. * <tr valign="top">
  634. * <td>INFO_CREDITS</td>
  635. * <td>2</td>
  636. * <td>
  637. * PHP Credits. See also phpcredits.
  638. * </td>
  639. * </tr>
  640. * <tr valign="top">
  641. * <td>INFO_CONFIGURATION</td>
  642. * <td>4</td>
  643. * <td>
  644. * Current Local and Master values for PHP directives. See
  645. * also ini_get.
  646. * </td>
  647. * </tr>
  648. * <tr valign="top">
  649. * <td>INFO_MODULES</td>
  650. * <td>8</td>
  651. * <td>
  652. * Loaded modules and their respective settings. See also
  653. * get_loaded_extensions.
  654. * </td>
  655. * </tr>
  656. * <tr valign="top">
  657. * <td>INFO_ENVIRONMENT</td>
  658. * <td>16</td>
  659. * <td>
  660. * Environment Variable information that's also available in
  661. * $_ENV.
  662. * </td>
  663. * </tr>
  664. * <tr valign="top">
  665. * <td>INFO_VARIABLES</td>
  666. * <td>32</td>
  667. * <td>
  668. * Shows all
  669. * predefined variables from EGPCS (Environment, GET,
  670. * POST, Cookie, Server).
  671. * </td>
  672. * </tr>
  673. * <tr valign="top">
  674. * <td>INFO_LICENSE</td>
  675. * <td>64</td>
  676. * <td>
  677. * PHP License information. See also the license FAQ.
  678. * </td>
  679. * </tr>
  680. * <tr valign="top">
  681. * <td>INFO_ALL</td>
  682. * <td>-1</td>
  683. * <td>
  684. * Shows all of the above.
  685. * </td>
  686. * </tr>
  687. * </table>
  688. * </p>
  689. * @return bool Returns true on success or false on failure.
  690. */
  691. function phpinfo ($what = null) {}
  692. /**
  693. * Gets the current PHP version
  694. * @link http://www.php.net/manual/en/function.phpversion.php
  695. * @param extension string[optional] <p>
  696. * An optional extension name.
  697. * </p>
  698. * @return string If the optional extension parameter is
  699. * specified, phpversion returns the version of that
  700. * extension, or false if there is no version information associated or
  701. * the extension isn't enabled.
  702. */
  703. function phpversion ($extension = null) {}
  704. /**
  705. * Prints out the credits for PHP
  706. * @link http://www.php.net/manual/en/function.phpcredits.php
  707. * @param flag int[optional] <p>
  708. * To generate a custom credits page, you may want to use the
  709. * flag parameter.
  710. * </p>
  711. * <p>
  712. * <table>
  713. * Pre-defined phpcredits flags
  714. * <tr valign="top">
  715. * <td>name</td>
  716. * <td>description</td>
  717. * </tr>
  718. * <tr valign="top">
  719. * <td>CREDITS_ALL</td>
  720. * <td>
  721. * All the credits, equivalent to using: CREDITS_DOCS +
  722. * CREDITS_GENERAL + CREDITS_GROUP +
  723. * CREDITS_MODULES + CREDITS_FULLPAGE.
  724. * It generates a complete stand-alone HTML page with the appropriate tags.
  725. * </td>
  726. * </tr>
  727. * <tr valign="top">
  728. * <td>CREDITS_DOCS</td>
  729. * <td>The credits for the documentation team</td>
  730. * </tr>
  731. * <tr valign="top">
  732. * <td>CREDITS_FULLPAGE</td>
  733. * <td>
  734. * Usually used in combination with the other flags. Indicates
  735. * that a complete stand-alone HTML page needs to be
  736. * printed including the information indicated by the other
  737. * flags.
  738. * </td>
  739. * </tr>
  740. * <tr valign="top">
  741. * <td>CREDITS_GENERAL</td>
  742. * <td>
  743. * General credits: Language design and concept, PHP authors
  744. * and SAPI module.
  745. * </td>
  746. * </tr>
  747. * <tr valign="top">
  748. * <td>CREDITS_GROUP</td>
  749. * <td>A list of the core developers</td>
  750. * </tr>
  751. * <tr valign="top">
  752. * <td>CREDITS_MODULES</td>
  753. * <td>
  754. * A list of the extension modules for PHP, and their authors
  755. * </td>
  756. * </tr>
  757. * <tr valign="top">
  758. * <td>CREDITS_SAPI</td>
  759. * <td>
  760. * A list of the server API modules for PHP, and their authors
  761. * </td>
  762. * </tr>
  763. * </table>
  764. * </p>
  765. * @return bool Returns true on success or false on failure.
  766. */
  767. function phpcredits ($flag = null) {}
  768. /**
  769. * Gets the logo guid
  770. * @link http://www.php.net/manual/en/function.php-logo-guid.php
  771. * @return string PHPE9568F34-D428-11d2-A769-00AA001ACF42.
  772. */
  773. function php_logo_guid () {}
  774. function php_real_logo_guid () {}
  775. function php_egg_logo_guid () {}
  776. /**
  777. * Gets the Zend guid
  778. * @link http://www.php.net/manual/en/function.zend-logo-guid.php
  779. * @return string PHPE9568F35-D428-11d2-A769-00AA001ACF42.
  780. */
  781. function zend_logo_guid () {}
  782. /**
  783. * Returns the type of interface between web server and PHP
  784. * @link http://www.php.net/manual/en/function.php-sapi-name.php
  785. * @return string the interface type, as a lowercase string.
  786. * </p>
  787. * <p>
  788. * Although not exhaustive, the possible return values include
  789. * aolserver, apache,
  790. * apache2filter, apache2handler,
  791. * caudium, cgi (until PHP 5.3),
  792. * cgi-fcgi, cli,
  793. * continuity, embed,
  794. * isapi, litespeed,
  795. * milter, nsapi,
  796. * phttpd, pi3web, roxen,
  797. * thttpd, tux, and webjames.
  798. */
  799. function php_sapi_name () {}
  800. /**
  801. * Returns information about the operating system PHP is running on
  802. * @link http://www.php.net/manual/en/function.php-uname.php
  803. * @param mode string[optional] <p>
  804. * mode is a single character that defines what
  805. * information is returned:
  806. * 'a': This is the default. Contains all modes in
  807. * the sequence "s n r v m".
  808. * @return string the description, as a string.
  809. */
  810. function php_uname ($mode = null) {}
  811. /**
  812. * Return a list of .ini files parsed from the additional ini dir
  813. * @link http://www.php.net/manual/en/function.php-ini-scanned-files.php
  814. * @return string a comma-separated string of .ini files on success. Each comma is
  815. * followed by a newline. If the directive --with-config-file-scan-dir wasn't set,
  816. * false is returned. If it was set and the directory was empty, an
  817. * empty string is returned. If a file is unrecognizable, the file will
  818. * still make it into the returned string but a PHP error will also result.
  819. * This PHP error will be seen both at compile time and while using
  820. * php_ini_scanned_files.
  821. */
  822. function php_ini_scanned_files () {}
  823. /**
  824. * Retrieve a path to the loaded php.ini file
  825. * @link http://www.php.net/manual/en/function.php-ini-loaded-file.php
  826. * @return string The loaded &php.ini; path, or false if one is not loaded.
  827. */
  828. function php_ini_loaded_file () {}
  829. /**
  830. * String comparisons using a "natural order" algorithm
  831. * @link http://www.php.net/manual/en/function.strnatcmp.php
  832. * @param str1 string <p>
  833. * The first string.
  834. * </p>
  835. * @param str2 string <p>
  836. * The second string.
  837. * </p>
  838. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  839. * str1 is less than str2; &gt;
  840. * 0 if str1 is greater than
  841. * str2, and 0 if they are equal.
  842. */
  843. function strnatcmp ($str1, $str2) {}
  844. /**
  845. * Case insensitive string comparisons using a "natural order" algorithm
  846. * @link http://www.php.net/manual/en/function.strnatcasecmp.php
  847. * @param str1 string <p>
  848. * The first string.
  849. * </p>
  850. * @param str2 string <p>
  851. * The second string.
  852. * </p>
  853. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  854. * str1 is less than str2 &gt;
  855. * 0 if str1 is greater than
  856. * str2, and 0 if they are equal.
  857. */
  858. function strnatcasecmp ($str1, $str2) {}
  859. /**
  860. * Count the number of substring occurrences
  861. * @link http://www.php.net/manual/en/function.substr-count.php
  862. * @param haystack string <p>
  863. * The string to search in
  864. * </p>
  865. * @param needle string <p>
  866. * The substring to search for
  867. * </p>
  868. * @param offset int[optional] <p>
  869. * The offset where to start counting
  870. * </p>
  871. * @param length int[optional] <p>
  872. * The maximum length after the specified offset to search for the
  873. * substring. It outputs a warning if the offset plus the length is
  874. * greater than the haystack length.
  875. * </p>
  876. * @return int This functions returns an integer.
  877. */
  878. function substr_count ($haystack, $needle, $offset = null, $length = null) {}
  879. /**
  880. * Finds the length of the first segment of a string consisting
  881. entirely of characters contained within a given mask.
  882. * @link http://www.php.net/manual/en/function.strspn.php
  883. * @param subject string <p>
  884. * The string to examine.
  885. * </p>
  886. * @param mask string <p>
  887. * The list of allowable characters to include in counted segments.
  888. * </p>
  889. * @param start int[optional] <p>
  890. * The position in subject to
  891. * start searching.
  892. * </p>
  893. * <p>
  894. * If start is given and is non-negative,
  895. * then strspn will begin
  896. * examining subject at
  897. * the start'th position. For instance, in
  898. * the string 'abcdef', the character at
  899. * position 0 is 'a', the
  900. * character at position 2 is
  901. * 'c', and so forth.
  902. * </p>
  903. * <p>
  904. * If start is given and is negative,
  905. * then strspn will begin
  906. * examining subject at
  907. * the start'th position from the end
  908. * of subject.
  909. * </p>
  910. * @param length int[optional] <p>
  911. * The length of the segment from subject
  912. * to examine.
  913. * </p>
  914. * <p>
  915. * If length is given and is non-negative,
  916. * then subject will be examined
  917. * for length characters after the starting
  918. * position.
  919. * </p>
  920. * <p>
  921. * If lengthis given and is negative,
  922. * then subject will be examined from the
  923. * starting position up to length
  924. * characters from the end of subject.
  925. * </p>
  926. * @return int the length of the initial segment of str1
  927. * which consists entirely of characters in str2.
  928. */
  929. function strspn ($subject, $mask, $start = null, $length = null) {}
  930. /**
  931. * Find length of initial segment not matching mask
  932. * @link http://www.php.net/manual/en/function.strcspn.php
  933. * @param str1 string <p>
  934. * The first string.
  935. * </p>
  936. * @param str2 string <p>
  937. * The second string.
  938. * </p>
  939. * @param start int[optional] <p>
  940. * The start position of the string to examine.
  941. * </p>
  942. * @param length int[optional] <p>
  943. * The length of the string to examine.
  944. * </p>
  945. * @return int the length of the segment as an integer.
  946. */
  947. function strcspn ($str1, $str2, $start = null, $length = null) {}
  948. /**
  949. * Tokenize string
  950. * @link http://www.php.net/manual/en/function.strtok.php
  951. * @param str string <p>
  952. * The string being split up into smaller strings (tokens).
  953. * </p>
  954. * @param token string <p>
  955. * The delimiter used when splitting up str.
  956. * </p>
  957. * @return string A string token.
  958. */
  959. function strtok ($str, $token) {}
  960. /**
  961. * Make a string uppercase
  962. * @link http://www.php.net/manual/en/function.strtoupper.php
  963. * @param string string <p>
  964. * The input string.
  965. * </p>
  966. * @return string the uppercased string.
  967. */
  968. function strtoupper ($string) {}
  969. /**
  970. * Make a string lowercase
  971. * @link http://www.php.net/manual/en/function.strtolower.php
  972. * @param str string <p>
  973. * The input string.
  974. * </p>
  975. * @return string the lowercased string.
  976. */
  977. function strtolower ($str) {}
  978. /**
  979. * Find position of first occurrence of a string
  980. * @link http://www.php.net/manual/en/function.strpos.php
  981. * @param haystack string <p>
  982. * The string to search in
  983. * </p>
  984. * @param needle mixed <p>
  985. * If needle is not a string, it is converted
  986. * to an integer and applied as the ordinal value of a character.
  987. * </p>
  988. * @param offset int[optional] <p>
  989. * The optional offset parameter allows you
  990. * to specify which character in haystack to
  991. * start searching. The position returned is still relative to the
  992. * beginning of haystack.
  993. * </p>
  994. * @return int the position as an integer. If needle is
  995. * not found, strpos will return boolean
  996. * false.
  997. */
  998. function strpos ($haystack, $needle, $offset = null) {}
  999. /**
  1000. * Find position of first occurrence of a case-insensitive string
  1001. * @link http://www.php.net/manual/en/function.stripos.php
  1002. * @param haystack string <p>
  1003. * The string to search in
  1004. * </p>
  1005. * @param needle string <p>
  1006. * Note that the needle may be a string of one or
  1007. * more characters.
  1008. * </p>
  1009. * <p>
  1010. * If needle is not a string, it is converted to
  1011. * an integer and applied as the ordinal value of a character.
  1012. * </p>
  1013. * @param offset int[optional] <p>
  1014. * The optional offset parameter allows you
  1015. * to specify which character in haystack to
  1016. * start searching. The position returned is still relative to the
  1017. * beginning of haystack.
  1018. * </p>
  1019. * @return int If needle is not found,
  1020. * stripos will return boolean false.
  1021. */
  1022. function stripos ($haystack, $needle, $offset = null) {}
  1023. /**
  1024. * Find position of last occurrence of a char in a string
  1025. * @link http://www.php.net/manual/en/function.strrpos.php
  1026. * @param haystack string <p>
  1027. * The string to search in.
  1028. * </p>
  1029. * @param needle string <p>
  1030. * If needle is not a string, it is converted
  1031. * to an integer and applied as the ordinal value of a character.
  1032. * </p>
  1033. * @param offset int[optional] <p>
  1034. * May be specified to begin searching an arbitrary number of characters into
  1035. * the string. Negative values will stop searching at an arbitrary point
  1036. * prior to the end of the string.
  1037. * </p>
  1038. * @return int the position where the needle exists. Returns false if the needle
  1039. * was not found.
  1040. */
  1041. function strrpos ($haystack, $needle, $offset = null) {}
  1042. /**
  1043. * Find position of last occurrence of a case-insensitive string in a string
  1044. * @link http://www.php.net/manual/en/function.strripos.php
  1045. * @param haystack string <p>
  1046. * The string to search in
  1047. * </p>
  1048. * @param needle string <p>
  1049. * Note that the needle may be a string of one or
  1050. * more characters.
  1051. * </p>
  1052. * @param offset int[optional] <p>
  1053. * The offset parameter may be specified to begin
  1054. * searching an arbitrary number of characters into the string.
  1055. * </p>
  1056. * <p>
  1057. * Negative offset values will start the search at
  1058. * offset characters from the
  1059. * start of the string.
  1060. * </p>
  1061. * @return int the numerical position of the last occurrence of
  1062. * needle. Also note that string positions start at 0,
  1063. * and not 1.
  1064. * </p>
  1065. * <p>
  1066. * If needle is not found, false is returned.
  1067. */
  1068. function strripos ($haystack, $needle, $offset = null) {}
  1069. /**
  1070. * Reverse a string
  1071. * @link http://www.php.net/manual/en/function.strrev.php
  1072. * @param string string <p>
  1073. * The string to be reversed.
  1074. * </p>
  1075. * @return string the reversed string.
  1076. */
  1077. function strrev ($string) {}
  1078. /**
  1079. * Convert logical Hebrew text to visual text
  1080. * @link http://www.php.net/manual/en/function.hebrev.php
  1081. * @param hebrew_text string <p>
  1082. * A Hebrew input string.
  1083. * </p>
  1084. * @param max_chars_per_line int[optional] <p>
  1085. * This optional parameter indicates maximum number of characters per
  1086. * line that will be returned.
  1087. * </p>
  1088. * @return string the visual string.
  1089. */
  1090. function hebrev ($hebrew_text, $max_chars_per_line = null) {}
  1091. /**
  1092. * Convert logical Hebrew text to visual text with newline conversion
  1093. * @link http://www.php.net/manual/en/function.hebrevc.php
  1094. * @param hebrew_text string <p>
  1095. * A Hebrew input string.
  1096. * </p>
  1097. * @param max_chars_per_line int[optional] <p>
  1098. * This optional parameter indicates maximum number of characters per
  1099. * line that will be returned.
  1100. * </p>
  1101. * @return string the visual string.
  1102. */
  1103. function hebrevc ($hebrew_text, $max_chars_per_line = null) {}
  1104. /**
  1105. * Inserts HTML line breaks before all newlines in a string
  1106. * @link http://www.php.net/manual/en/function.nl2br.php
  1107. * @param string string <p>
  1108. * The input string.
  1109. * </p>
  1110. * @param is_xhtml bool[optional] <p>
  1111. * Whenever to use XHTML compatible line breaks or not.
  1112. * </p>
  1113. * @return string the altered string.
  1114. */
  1115. function nl2br ($string, $is_xhtml = null) {}
  1116. /**
  1117. * Returns filename component of path
  1118. * @link http://www.php.net/manual/en/function.basename.php
  1119. * @param path string <p>
  1120. * A path.
  1121. * </p>
  1122. * <p>
  1123. * On Windows, both slash (/) and backslash
  1124. * (\) are used as directory separator character. In
  1125. * other environments, it is the forward slash (/).
  1126. * </p>
  1127. * @param suffix string[optional] <p>
  1128. * If the filename ends in suffix this will also
  1129. * be cut off.
  1130. * </p>
  1131. * @return string the base name of the given path.
  1132. */
  1133. function basename ($path, $suffix = null) {}
  1134. /**
  1135. * Returns directory name component of path
  1136. * @link http://www.php.net/manual/en/function.dirname.php
  1137. * @param path string <p>
  1138. * A path.
  1139. * </p>
  1140. * <p>
  1141. * On Windows, both slash (/) and backslash
  1142. * (\) are used as directory separator character. In
  1143. * other environments, it is the forward slash (/).
  1144. * </p>
  1145. * @return string the name of the directory. If there are no slashes in
  1146. * path, a dot ('.') is returned,
  1147. * indicating the current directory. Otherwise, the returned string is
  1148. * path with any trailing
  1149. * /component removed.
  1150. */
  1151. function dirname ($path) {}
  1152. /**
  1153. * Returns information about a file path
  1154. * @link http://www.php.net/manual/en/function.pathinfo.php
  1155. * @param path string <p>
  1156. * The path being checked.
  1157. * </p>
  1158. * @param options int[optional] <p>
  1159. * You can specify which elements are returned with optional parameter
  1160. * options. It composes from
  1161. * PATHINFO_DIRNAME,
  1162. * PATHINFO_BASENAME,
  1163. * PATHINFO_EXTENSION and
  1164. * PATHINFO_FILENAME. It
  1165. * defaults to return all elements.
  1166. * </p>
  1167. * @return mixed The following associative array elements are returned:
  1168. * dirname, basename,
  1169. * extension (if any), and filename.
  1170. * </p>
  1171. * <p>
  1172. * If options is used, this function will return a
  1173. * string if not all elements are requested.
  1174. */
  1175. function pathinfo ($path, $options = null) {}
  1176. /**
  1177. * Un-quotes a quoted string
  1178. * @link http://www.php.net/manual/en/function.stripslashes.php
  1179. * @param str string <p>
  1180. * The input string.
  1181. * </p>
  1182. * @return string a string with backslashes stripped off.
  1183. * (\' becomes ' and so on.)
  1184. * Double backslashes (\\) are made into a single
  1185. * backslash (\).
  1186. */
  1187. function stripslashes ($str) {}
  1188. /**
  1189. * Un-quote string quoted with <function>addcslashes</function>
  1190. * @link http://www.php.net/manual/en/function.stripcslashes.php
  1191. * @param str string <p>
  1192. * The string to be unescaped.
  1193. * </p>
  1194. * @return string the unescaped string.
  1195. */
  1196. function stripcslashes ($str) {}
  1197. /**
  1198. * Find first occurrence of a string
  1199. * @link http://www.php.net/manual/en/function.strstr.php
  1200. * @param haystack string <p>
  1201. * The input string.
  1202. * </p>
  1203. * @param needle mixed <p>
  1204. * If needle is not a string, it is converted to
  1205. * an integer and applied as the ordinal value of a character.
  1206. * </p>
  1207. * @param before_needle bool[optional] <p>
  1208. * If true, strstr returns
  1209. * the part of the haystack before the first
  1210. * occurrence of the needle.
  1211. * </p>
  1212. * @return string the portion of string, or false if needle
  1213. * is not found.
  1214. */
  1215. function strstr ($haystack, $needle, $before_needle = null) {}
  1216. /**
  1217. * Case-insensitive <function>strstr</function>
  1218. * @link http://www.php.net/manual/en/function.stristr.php
  1219. * @param haystack string <p>
  1220. * The string to search in
  1221. * </p>
  1222. * @param needle mixed <p>
  1223. * If needle is not a string, it is converted to
  1224. * an integer and applied as the ordinal value of a character.
  1225. * </p>
  1226. * @param before_needle bool[optional] <p>
  1227. * If true, stristr
  1228. * returns the part of the haystack before the
  1229. * first occurrence of the needle.
  1230. * </p>
  1231. * @return string the matched substring. If needle is not
  1232. * found, returns false.
  1233. */
  1234. function stristr ($haystack, $needle, $before_needle = null) {}
  1235. /**
  1236. * Find the last occurrence of a character in a string
  1237. * @link http://www.php.net/manual/en/function.strrchr.php
  1238. * @param haystack string <p>
  1239. * The string to search in
  1240. * </p>
  1241. * @param needle mixed <p>
  1242. * If needle contains more than one character,
  1243. * only the first is used. This behavior is different from that of
  1244. * strstr.
  1245. * </p>
  1246. * <p>
  1247. * If needle is not a string, it is converted to
  1248. * an integer and applied as the ordinal value of a character.
  1249. * </p>
  1250. * @return string This function returns the portion of string, or false if
  1251. * needle is not found.
  1252. */
  1253. function strrchr ($haystack, $needle) {}
  1254. /**
  1255. * Randomly shuffles a string
  1256. * @link http://www.php.net/manual/en/function.str-shuffle.php
  1257. * @param str string <p>
  1258. * The input string.
  1259. * </p>
  1260. * @return string the shuffled string.
  1261. */
  1262. function str_shuffle ($str) {}
  1263. /**
  1264. * Return information about words used in a string
  1265. * @link http://www.php.net/manual/en/function.str-word-count.php
  1266. * @param string string <p>
  1267. * The string
  1268. * </p>
  1269. * @param format int[optional] <p>
  1270. * Specify the return value of this function. The current supported values
  1271. * are:
  1272. * 0 - returns the number of words found
  1273. * @param charlist string[optional] <p>
  1274. * A list of additional characters which will be considered as 'word'
  1275. * </p>
  1276. * @return mixed an array or an integer, depending on the
  1277. * format chosen.
  1278. */
  1279. function str_word_count ($string, $format = null, $charlist = null) {}
  1280. /**
  1281. * Convert a string to an array
  1282. * @link http://www.php.net/manual/en/function.str-split.php
  1283. * @param string string <p>
  1284. * The input string.
  1285. * </p>
  1286. * @param split_length int[optional] <p>
  1287. * Maximum length of the chunk.
  1288. * </p>
  1289. * @return array If the optional split_length parameter is
  1290. * specified, the returned array will be broken down into chunks with each
  1291. * being split_length in length, otherwise each chunk
  1292. * will be one character in length.
  1293. * </p>
  1294. * <p>
  1295. * false is returned if split_length is less than 1.
  1296. * If the split_length length exceeds the length of
  1297. * string, the entire string is returned as the first
  1298. * (and only) array element.
  1299. */
  1300. function str_split ($string, $split_length = null) {}
  1301. /**
  1302. * Search a string for any of a set of characters
  1303. * @link http://www.php.net/manual/en/function.strpbrk.php
  1304. * @param haystack string <p>
  1305. * The string where char_list is looked for.
  1306. * </p>
  1307. * @param char_list string <p>
  1308. * This parameter is case sensitive.
  1309. * </p>
  1310. * @return string a string starting from the character found, or false if it is
  1311. * not found.
  1312. */
  1313. function strpbrk ($haystack, $char_list) {}
  1314. /**
  1315. * Binary safe comparison of two strings from an offset, up to length characters
  1316. * @link http://www.php.net/manual/en/function.substr-compare.php
  1317. * @param main_str string <p>
  1318. * The main string being compared.
  1319. * </p>
  1320. * @param str string <p>
  1321. * The secondary string being compared.
  1322. * </p>
  1323. * @param offset int <p>
  1324. * The start position for the comparison. If negative, it starts counting
  1325. * from the end of the string.
  1326. * </p>
  1327. * @param length int[optional] <p>
  1328. * The length of the comparison. The default value is the largest of the
  1329. * length of the str compared to the length of
  1330. * main_str less the
  1331. * offset.
  1332. * </p>
  1333. * @param case_insensitivity bool[optional] <p>
  1334. * If case_insensitivity is true, comparison is
  1335. * case insensitive.
  1336. * </p>
  1337. * @return int &lt; 0 if main_str from position
  1338. * offset is less than str, &gt;
  1339. * 0 if it is greater than str, and 0 if they are equal.
  1340. * If offset is equal to or greater than the length of
  1341. * main_str or length is set and
  1342. * is less than 1, substr_compare prints a warning and returns
  1343. * false.
  1344. */
  1345. function substr_compare ($main_str, $str, $offset, $length = null, $case_insensitivity = null) {}
  1346. /**
  1347. * Locale based string comparison
  1348. * @link http://www.php.net/manual/en/function.strcoll.php
  1349. * @param str1 string <p>
  1350. * The first string.
  1351. * </p>
  1352. * @param str2 string <p>
  1353. * The second string.
  1354. * </p>
  1355. * @return int &lt; 0 if str1 is less than
  1356. * str2; &gt; 0 if
  1357. * str1 is greater than
  1358. * str2, and 0 if they are equal.
  1359. */
  1360. function strcoll ($str1, $str2) {}
  1361. /**
  1362. * Formats a number as a currency string
  1363. * @link http://www.php.net/manual/en/function.money-format.php
  1364. * @param format string <p>
  1365. * The format specification consists of the following sequence:
  1366. * <p>a % character</p>
  1367. * @param number float <p>
  1368. * The number to be formatted.
  1369. * </p>
  1370. * @return string the formatted string. Characters before and after the formatting
  1371. * string will be returned unchanged.
  1372. * Non-numeric number causes returning &null; and
  1373. * emitting E_WARNING.
  1374. */
  1375. function money_format ($format, $number) {}
  1376. /**
  1377. * Return part of a string
  1378. * @link http://www.php.net/manual/en/function.substr.php
  1379. * @param string string <p>
  1380. * The input string.
  1381. * </p>
  1382. * @param start int <p>
  1383. * If start is non-negative, the returned string
  1384. * will start at the start'th position in
  1385. * string, counting from zero. For instance,
  1386. * in the string 'abcdef', the character at
  1387. * position 0 is 'a', the
  1388. * character at position 2 is
  1389. * 'c', and so forth.
  1390. * </p>
  1391. * <p>
  1392. * If start is negative, the returned string
  1393. * will start at the start'th character
  1394. * from the end of string.
  1395. * </p>
  1396. * <p>
  1397. * If string is less than or equal to
  1398. * start characters long, false will be returned.
  1399. * </p>
  1400. * <p>
  1401. * Using a negative start
  1402. * ]]>
  1403. * </p>
  1404. * @param length int[optional] <p>
  1405. * If length is given and is positive, the string
  1406. * returned will contain at most length characters
  1407. * beginning from start (depending on the length of
  1408. * string).
  1409. * </p>
  1410. * <p>
  1411. * If length is given and is negative, then that many
  1412. * characters will be omitted from the end of string
  1413. * (after the start position has been calculated when a
  1414. * start is negative). If
  1415. * start denotes a position beyond this truncation,
  1416. * an empty string will be returned.
  1417. * </p>
  1418. * <p>
  1419. * If length is given and is 0,
  1420. * false or &null; an empty string will be returned.
  1421. * </p>
  1422. * Using a negative length
  1423. * ]]>
  1424. * @return string the extracted part of string&return.falseforfailure;.
  1425. */
  1426. function substr ($string, $start, $length = null) {}
  1427. /**
  1428. * Replace text within a portion of a string
  1429. * @link http://www.php.net/manual/en/function.substr-replace.php
  1430. * @param string mixed <p>
  1431. * The input string.
  1432. * </p>
  1433. * @param replacement string <p>
  1434. * The replacement string.
  1435. * </p>
  1436. * @param start int <p>
  1437. * If start is positive, the replacing will
  1438. * begin at the start'th offset into
  1439. * string.
  1440. * </p>
  1441. * <p>
  1442. * If start is negative, the replacing will
  1443. * begin at the start'th character from the
  1444. * end of string.
  1445. * </p>
  1446. * @param length int[optional] <p>
  1447. * If given and is positive, it represents the length of the portion of
  1448. * string which is to be replaced. If it is
  1449. * negative, it represents the number of characters from the end of
  1450. * string at which to stop replacing. If it
  1451. * is not given, then it will default to strlen(
  1452. * string ); i.e. end the replacing at the
  1453. * end of string. Of course, if
  1454. * length is zero then this function will have the
  1455. * effect of inserting replacement into
  1456. * string at the given
  1457. * start offset.
  1458. * </p>
  1459. * @return mixed The result string is returned. If string is an
  1460. * array then array is returned.
  1461. */
  1462. function substr_replace ($string, $replacement, $start, $length = null) {}
  1463. /**
  1464. * Quote meta characters
  1465. * @link http://www.php.net/manual/en/function.quotemeta.php
  1466. * @param str string <p>
  1467. * The input string.
  1468. * </p>
  1469. * @return string the string with meta characters quoted.
  1470. */
  1471. function quotemeta ($str) {}
  1472. /**
  1473. * Make a string's first character uppercase
  1474. * @link http://www.php.net/manual/en/function.ucfirst.php
  1475. * @param str string <p>
  1476. * The input string.
  1477. * </p>
  1478. * @return string the resulting string.
  1479. */
  1480. function ucfirst ($str) {}
  1481. /**
  1482. * Make a string's first character lowercase
  1483. * @link http://www.php.net/manual/en/function.lcfirst.php
  1484. * @param str string <p>
  1485. * The input string.
  1486. * </p>
  1487. * @return string the resulting string.
  1488. */
  1489. function lcfirst ($str) {}
  1490. /**
  1491. * Uppercase the first character of each word in a string
  1492. * @link http://www.php.net/manual/en/function.ucwords.php
  1493. * @param str string <p>
  1494. * The input string.
  1495. * </p>
  1496. * @return string the modified string.
  1497. */
  1498. function ucwords ($str) {}
  1499. /**
  1500. * Translate certain characters
  1501. * @link http://www.php.net/manual/en/function.strtr.php
  1502. * @param str string <p>
  1503. * The string being translated.
  1504. * </p>
  1505. * @param from string <p>
  1506. * The string being translated to to.
  1507. * </p>
  1508. * @param to string <p>
  1509. * The string replacing from.
  1510. * </p>
  1511. * @return string This function returns a copy of str,
  1512. * translating all occurrences of each character in
  1513. * from to the corresponding character in
  1514. * to.
  1515. */
  1516. function strtr ($str, $from, $to) {}
  1517. /**
  1518. * Quote string with slashes
  1519. * @link http://www.php.net/manual/en/function.addslashes.php
  1520. * @param str string <p>
  1521. * The string to be escaped.
  1522. * </p>
  1523. * @return string the escaped string.
  1524. */
  1525. function addslashes ($str) {}
  1526. /**
  1527. * Quote string with slashes in a C style
  1528. * @link http://www.php.net/manual/en/function.addcslashes.php
  1529. * @param str string <p>
  1530. * The string to be escaped.
  1531. * </p>
  1532. * @param charlist string <p>
  1533. * A list of characters to be escaped. If
  1534. * charlist contains characters
  1535. * \n, \r etc., they are
  1536. * converted in C-like style, while other non-alphanumeric characters
  1537. * with ASCII codes lower than 32 and higher than 126 converted to
  1538. * octal representation.
  1539. * </p>
  1540. * <p>
  1541. * When you define a sequence of characters in the charlist argument
  1542. * make sure that you know what characters come between the
  1543. * characters that you set as the start and end of the range.
  1544. * ]]>
  1545. * Also, if the first character in a range has a higher ASCII value
  1546. * than the second character in the range, no range will be
  1547. * constructed. Only the start, end and period characters will be
  1548. * escaped. Use the ord function to find the
  1549. * ASCII value for a character.
  1550. * ]]>
  1551. * </p>
  1552. * <p>
  1553. * Be careful if you choose to escape characters 0, a, b, f, n, r,
  1554. * t and v. They will be converted to \0, \a, \b, \f, \n, \r, \t
  1555. * and \v.
  1556. * In PHP \0 (NULL), \r (carriage return), \n (newline), \f (form feed),
  1557. * \v (vertical tab) and \t (tab) are predefined escape sequences,
  1558. * while in C all of these are predefined escape sequences.
  1559. * </p>
  1560. * @return string the escaped string.
  1561. */
  1562. function addcslashes ($str, $charlist) {}
  1563. /**
  1564. * Strip whitespace (or other characters) from the end of a string
  1565. * @link http://www.php.net/manual/en/function.rtrim.php
  1566. * @param str string <p>
  1567. * The input string.
  1568. * </p>
  1569. * @param charlist string[optional] <p>
  1570. * You can also specify the characters you want to strip, by means
  1571. * of the charlist parameter.
  1572. * Simply list all characters that you want to be stripped. With
  1573. * .. you can specify a range of characters.
  1574. * </p>
  1575. * @return string the modified string.
  1576. */
  1577. function rtrim ($str, $charlist = null) {}
  1578. /**
  1579. * Replace all occurrences of the search string with the replacement string
  1580. * @link http://www.php.net/manual/en/function.str-replace.php
  1581. * @param search mixed <p>
  1582. * The value being searched for, otherwise known as the needle.
  1583. * An array may be used to designate multiple needles.
  1584. * </p>
  1585. * @param replace mixed <p>
  1586. * The replacement value that replaces found search
  1587. * values. An array may be used to designate multiple replacements.
  1588. * </p>
  1589. * @param subject mixed <p>
  1590. * The string or array being searched and replaced on,
  1591. * otherwise known as the haystack.
  1592. * </p>
  1593. * <p>
  1594. * If subject is an array, then the search and
  1595. * replace is performed with every entry of
  1596. * subject, and the return value is an array as
  1597. * well.
  1598. * </p>
  1599. * @param count int[optional] If passed, this will hold the number of matched and replaced needles.
  1600. * @return mixed This function returns a string or an array with the replaced values.
  1601. */
  1602. function str_replace ($search, $replace, $subject, &$count = null) {}
  1603. /**
  1604. * Case-insensitive version of <function>str_replace</function>.
  1605. * @link http://www.php.net/manual/en/function.str-ireplace.php
  1606. * @param search mixed <p>
  1607. * Every replacement with search array is
  1608. * performed on the result of previous replacement.
  1609. * </p>
  1610. * @param replace mixed <p>
  1611. * </p>
  1612. * @param subject mixed <p>
  1613. * If subject is an array, then the search and
  1614. * replace is performed with every entry of
  1615. * subject, and the return value is an array as
  1616. * well.
  1617. * </p>
  1618. * @param count int[optional] <p>
  1619. * The number of matched and replaced needles will
  1620. * be returned in count which is passed by
  1621. * reference.
  1622. * </p>
  1623. * @return mixed a string or an array of replacements.
  1624. */
  1625. function str_ireplace ($search, $replace, $subject, &$count = null) {}
  1626. /**
  1627. * Repeat a string
  1628. * @link http://www.php.net/manual/en/function.str-repeat.php
  1629. * @param input string <p>
  1630. * The string to be repeated.
  1631. * </p>
  1632. * @param multiplier int <p>
  1633. * Number of time the input string should be
  1634. * repeated.
  1635. * </p>
  1636. * <p>
  1637. * multiplier has to be greater than or equal to 0.
  1638. * If the multiplier is set to 0, the function
  1639. * will return an empty string.
  1640. * </p>
  1641. * @return string the repeated string.
  1642. */
  1643. function str_repeat ($input, $multiplier) {}
  1644. /**
  1645. * Return information about characters used in a string
  1646. * @link http://www.php.net/manual/en/function.count-chars.php
  1647. * @param string string <p>
  1648. * The examined string.
  1649. * </p>
  1650. * @param mode int[optional] <p>
  1651. * See return values.
  1652. * </p>
  1653. * @return mixed Depending on mode
  1654. * count_chars returns one of the following:
  1655. * 0 - an array with the byte-value as key and the frequency of
  1656. * every byte as value.
  1657. * 1 - same as 0 but only byte-values with a frequency greater
  1658. * than zero are listed.
  1659. * 2 - same as 0 but only byte-values with a frequency equal to
  1660. * zero are listed.
  1661. * 3 - a string containing all unique characters is returned.
  1662. * 4 - a string containing all not used characters is returned.
  1663. */
  1664. function count_chars ($string, $mode = null) {}
  1665. /**
  1666. * Split a string into smaller chunks
  1667. * @link http://www.php.net/manual/en/function.chunk-split.php
  1668. * @param body string <p>
  1669. * The string to be chunked.
  1670. * </p>
  1671. * @param chunklen int[optional] <p>
  1672. * The chunk length.
  1673. * </p>
  1674. * @param end string[optional] <p>
  1675. * The line ending sequence.
  1676. * </p>
  1677. * @return string the chunked string.
  1678. */
  1679. function chunk_split ($body, $chunklen = null, $end = null) {}
  1680. /**
  1681. * Strip whitespace (or other characters) from the beginning and end of a string
  1682. * @link http://www.php.net/manual/en/function.trim.php
  1683. * @param str string <p>
  1684. * The string that will be trimmed.
  1685. * </p>
  1686. * @param charlist string[optional] <p>
  1687. * Optionally, the stripped characters can also be specified using
  1688. * the charlist parameter.
  1689. * Simply list all characters that you want to be stripped. With
  1690. * .. you can specify a range of characters.
  1691. * </p>
  1692. * @return string The trimmed string.
  1693. */
  1694. function trim ($str, $charlist = null) {}
  1695. /**
  1696. * Strip whitespace (or other characters) from the beginning of a string
  1697. * @link http://www.php.net/manual/en/function.ltrim.php
  1698. * @param str string <p>
  1699. * The input string.
  1700. * </p>
  1701. * @param charlist string[optional] <p>
  1702. * You can also specify the characters you want to strip, by means of the
  1703. * charlist parameter.
  1704. * Simply list all characters that you want to be stripped. With
  1705. * .. you can specify a range of characters.
  1706. * </p>
  1707. * @return string This function returns a string with whitespace stripped from the
  1708. * beginning of str.
  1709. * Without the second parameter,
  1710. * ltrim will strip these characters:
  1711. * " " (ASCII 32
  1712. * (0x20)), an ordinary space.
  1713. * "\t" (ASCII 9
  1714. * (0x09)), a tab.
  1715. * "\n" (ASCII 10
  1716. * (0x0A)), a new line (line feed).
  1717. * "\r" (ASCII 13
  1718. * (0x0D)), a carriage return.
  1719. * "\0" (ASCII 0
  1720. * (0x00)), the NUL-byte.
  1721. * "\x0B" (ASCII 11
  1722. * (0x0B)), a vertical tab.
  1723. */
  1724. function ltrim ($str, $charlist = null) {}
  1725. /**
  1726. * Strip HTML and PHP tags from a string
  1727. * @link http://www.php.net/manual/en/function.strip-tags.php
  1728. * @param str string <p>
  1729. * The input string.
  1730. * </p>
  1731. * @param allowable_tags string[optional] <p>
  1732. * You can use the optional second parameter to specify tags which should
  1733. * not be stripped.
  1734. * </p>
  1735. * <p>
  1736. * HTML comments and PHP tags are also stripped. This is hardcoded and
  1737. * can not be changed with allowable_tags.
  1738. * </p>
  1739. * @return string the stripped string.
  1740. */
  1741. function strip_tags ($str, $allowable_tags = null) {}
  1742. /**
  1743. * Calculate the similarity between two strings
  1744. * @link http://www.php.net/manual/en/function.similar-text.php
  1745. * @param first string <p>
  1746. * The first string.
  1747. * </p>
  1748. * @param second string <p>
  1749. * The second string.
  1750. * </p>
  1751. * @param percent float[optional] <p>
  1752. * By passing a reference as third argument,
  1753. * similar_text will calculate the similarity in
  1754. * percent for you.
  1755. * </p>
  1756. * @return int the number of matching chars in both strings.
  1757. */
  1758. function similar_text ($first, $second, &$percent = null) {}
  1759. /**
  1760. * Split a string by string
  1761. * @link http://www.php.net/manual/en/function.explode.php
  1762. * @param delimiter string <p>
  1763. * The boundary string.
  1764. * </p>
  1765. * @param string string <p>
  1766. * The input string.
  1767. * </p>
  1768. * @param limit int[optional] <p>
  1769. * If limit is set and positive, the returned array will contain
  1770. * a maximum of limit elements with the last
  1771. * element containing the rest of string.
  1772. * </p>
  1773. * <p>
  1774. * If the limit parameter is negative, all components
  1775. * except the last -limit are returned.
  1776. * </p>
  1777. * <p>
  1778. * If the limit parameter is zero, then this is treated as 1.
  1779. * </p>
  1780. * @return array If delimiter is an empty string (""),
  1781. * explode will return false.
  1782. * If delimiter contains a value that is not
  1783. * contained in string and a negative
  1784. * limit is used, then an empty array will be
  1785. * returned. For any other limit, an array containing
  1786. * string will be returned.
  1787. */
  1788. function explode ($delimiter, $string, $limit = null) {}
  1789. /**
  1790. * Join array elements with a string
  1791. * @link http://www.php.net/manual/en/function.implode.php
  1792. * @param glue string <p>
  1793. * Defaults to an empty string. This is not the preferred usage of
  1794. * implode as glue would be
  1795. * the second parameter and thus, the bad prototype would be used.
  1796. * </p>
  1797. * @param pieces array <p>
  1798. * The array of strings to implode.
  1799. * </p>
  1800. * @return string a string containing a string representation of all the array
  1801. * elements in the same order, with the glue string between each element.
  1802. */
  1803. function implode ($glue, array $pieces) {}
  1804. /**
  1805. * &Alias; <function>implode</function>
  1806. * @link http://www.php.net/manual/en/function.join.php
  1807. * @param glue
  1808. * @param pieces
  1809. */
  1810. function join ($glue, $pieces) {}
  1811. /**
  1812. * Set locale information
  1813. * @link http://www.php.net/manual/en/function.setlocale.php
  1814. * @param category int <p>
  1815. * category is a named constant specifying the
  1816. * category of the functions affected by the locale setting:
  1817. * LC_ALL for all of the below
  1818. * @param locale string <p>
  1819. * If locale is &null; or the empty string
  1820. * "", the locale names will be set from the
  1821. * values of environment variables with the same names as the above
  1822. * categories, or from "LANG".
  1823. * </p>
  1824. * <p>
  1825. * If locale is "0",
  1826. * the locale setting is not affected, only the current setting is returned.
  1827. * </p>
  1828. * <p>
  1829. * If locale is an array or followed by additional
  1830. * parameters then each array element or parameter is tried to be set as
  1831. * new locale until success. This is useful if a locale is known under
  1832. * different names on different systems or for providing a fallback
  1833. * for a possibly not available locale.
  1834. * </p>
  1835. * @param _ string[optional]
  1836. * @return string the new current locale, or false if the locale functionality is
  1837. * not implemented on your platform, the specified locale does not exist or
  1838. * the category name is invalid.
  1839. * </p>
  1840. * <p>
  1841. * An invalid category name also causes a warning message. Category/locale
  1842. * names can be found in RFC 1766
  1843. * and ISO 639.
  1844. * Different systems have different naming schemes for locales.
  1845. * </p>
  1846. * <p>
  1847. * The return value of setlocale depends
  1848. * on the system that PHP is running. It returns exactly
  1849. * what the system setlocale function returns.
  1850. */
  1851. function setlocale ($category, $locale, $_ = null) {}
  1852. /**
  1853. * Get numeric formatting information
  1854. * @link http://www.php.net/manual/en/function.localeconv.php
  1855. * @return array localeconv returns data based upon the current locale
  1856. * as set by setlocale. The associative array that is
  1857. * returned contains the following fields:
  1858. * <tr valign="top">
  1859. * <td>Array element</td>
  1860. * <td>Description</td>
  1861. * </tr>
  1862. * <tr valign="top">
  1863. * <td>decimal_point</td>
  1864. * <td>Decimal point character</td>
  1865. * </tr>
  1866. * <tr valign="top">
  1867. * <td>thousands_sep</td>
  1868. * <td>Thousands separator</td>
  1869. * </tr>
  1870. * <tr valign="top">
  1871. * <td>grouping</td>
  1872. * <td>Array containing numeric groupings</td>
  1873. * </tr>
  1874. * <tr valign="top">
  1875. * <td>int_curr_symbol</td>
  1876. * <td>International currency symbol (i.e. USD)</td>
  1877. * </tr>
  1878. * <tr valign="top">
  1879. * <td>currency_symbol</td>
  1880. * <td>Local currency symbol (i.e. $)</td>
  1881. * </tr>
  1882. * <tr valign="top">
  1883. * <td>mon_decimal_point</td>
  1884. * <td>Monetary decimal point character</td>
  1885. * </tr>
  1886. * <tr valign="top">
  1887. * <td>mon_thousands_sep</td>
  1888. * <td>Monetary thousands separator</td>
  1889. * </tr>
  1890. * <tr valign="top">
  1891. * <td>mon_grouping</td>
  1892. * <td>Array containing monetary groupings</td>
  1893. * </tr>
  1894. * <tr valign="top">
  1895. * <td>positive_sign</td>
  1896. * <td>Sign for positive values</td>
  1897. * </tr>
  1898. * <tr valign="top">
  1899. * <td>negative_sign</td>
  1900. * <td>Sign for negative values</td>
  1901. * </tr>
  1902. * <tr valign="top">
  1903. * <td>int_frac_digits</td>
  1904. * <td>International fractional digits</td>
  1905. * </tr>
  1906. * <tr valign="top">
  1907. * <td>frac_digits</td>
  1908. * <td>Local fractional digits</td>
  1909. * </tr>
  1910. * <tr valign="top">
  1911. * <td>p_cs_precedes</td>
  1912. * <td>
  1913. * true if currency_symbol precedes a positive value, false
  1914. * if it succeeds one
  1915. * </td>
  1916. * </tr>
  1917. * <tr valign="top">
  1918. * <td>p_sep_by_space</td>
  1919. * <td>
  1920. * true if a space separates currency_symbol from a positive
  1921. * value, false otherwise
  1922. * </td>
  1923. * </tr>
  1924. * <tr valign="top">
  1925. * <td>n_cs_precedes</td>
  1926. * <td>
  1927. * true if currency_symbol precedes a negative value, false
  1928. * if it succeeds one
  1929. * </td>
  1930. * </tr>
  1931. * <tr valign="top">
  1932. * <td>n_sep_by_space</td>
  1933. * <td>
  1934. * true if a space separates currency_symbol from a negative
  1935. * value, false otherwise
  1936. * </td>
  1937. * </tr>
  1938. * <td>p_sign_posn</td>
  1939. * <td>
  1940. * 0 - Parentheses surround the quantity and currency_symbol
  1941. * 1 - The sign string precedes the quantity and currency_symbol
  1942. * 2 - The sign string succeeds the quantity and currency_symbol
  1943. * 3 - The sign string immediately precedes the currency_symbol
  1944. * 4 - The sign string immediately succeeds the currency_symbol
  1945. * </td>
  1946. * </tr>
  1947. * <td>n_sign_posn</td>
  1948. * <td>
  1949. * 0 - Parentheses surround the quantity and currency_symbol
  1950. * 1 - The sign string precedes the quantity and currency_symbol
  1951. * 2 - The sign string succeeds the quantity and currency_symbol
  1952. * 3 - The sign string immediately precedes the currency_symbol
  1953. * 4 - The sign string immediately succeeds the currency_symbol
  1954. * </td>
  1955. * </tr>
  1956. * </p>
  1957. * <p>
  1958. * The p_sign_posn, and n_sign_posn contain a string
  1959. * of formatting options. Each number representing one of the above listed conditions.
  1960. * </p>
  1961. * <p>
  1962. * The grouping fields contain arrays that define the way numbers should be
  1963. * grouped. For example, the monetary grouping field for the nl_NL locale (in
  1964. * UTF-8 mode with the euro sign), would contain a 2 item array with the
  1965. * values 3 and 3. The higher the index in the array, the farther left the
  1966. * grouping is. If an array element is equal to CHAR_MAX,
  1967. * no further grouping is done. If an array element is equal to 0, the previous
  1968. * element should be used.
  1969. */
  1970. function localeconv () {}
  1971. /**
  1972. * Query language and locale information
  1973. * @link http://www.php.net/manual/en/function.nl-langinfo.php
  1974. * @param item int <p>
  1975. * item may be an integer value of the element or the
  1976. * constant name of the element. The following is a list of constant names
  1977. * for item that may be used and their description.
  1978. * Some of these constants may not be defined or hold no value for certain
  1979. * locales.
  1980. * <table>
  1981. * nl_langinfo Constants
  1982. * <tr valign="top">
  1983. * <td>Constant</td>
  1984. * <td>Description</td>
  1985. * </tr>
  1986. * <tr valign="top">
  1987. * LC_TIME Category Constants</td>
  1988. * </tr>
  1989. * <tr valign="top">
  1990. * <td>ABDAY_(1-7)</td>
  1991. * <td>Abbreviated name of n-th day of the week.</td>
  1992. * </tr>
  1993. * <tr valign="top">
  1994. * <td>DAY_(1-7)</td>
  1995. * <td>Name of the n-th day of the week (DAY_1 = Sunday).</td>
  1996. * </tr>
  1997. * <tr valign="top">
  1998. * <td>ABMON_(1-12)</td>
  1999. * <td>Abbreviated name of the n-th month of the year.</td>
  2000. * </tr>
  2001. * <tr valign="top">
  2002. * <td>MON_(1-12)</td>
  2003. * <td>Name of the n-th month of the year.</td>
  2004. * </tr>
  2005. * <tr valign="top">
  2006. * <td>AM_STR</td>
  2007. * <td>String for Ante meridian.</td>
  2008. * </tr>
  2009. * <tr valign="top">
  2010. * <td>PM_STR</td>
  2011. * <td>String for Post meridian.</td>
  2012. * </tr>
  2013. * <tr valign="top">
  2014. * <td>D_T_FMT</td>
  2015. * <td>String that can be used as the format string for strftime to represent time and date.</td>
  2016. * </tr>
  2017. * <tr valign="top">
  2018. * <td>D_FMT</td>
  2019. * <td>String that can be used as the format string for strftime to represent date.</td>
  2020. * </tr>
  2021. * <tr valign="top">
  2022. * <td>T_FMT</td>
  2023. * <td>String that can be used as the format string for strftime to represent time.</td>
  2024. * </tr>
  2025. * <tr valign="top">
  2026. * <td>T_FMT_AMPM</td>
  2027. * <td>String that can be used as the format string for strftime to represent time in 12-hour format with ante/post meridian.</td>
  2028. * </tr>
  2029. * <tr valign="top">
  2030. * <td>ERA</td>
  2031. * <td>Alternate era.</td>
  2032. * </tr>
  2033. * <tr valign="top">
  2034. * <td>ERA_YEAR</td>
  2035. * <td>Year in alternate era format.</td>
  2036. * </tr>
  2037. * <tr valign="top">
  2038. * <td>ERA_D_T_FMT</td>
  2039. * <td>Date and time in alternate era format (string can be used in strftime).</td>
  2040. * </tr>
  2041. * <tr valign="top">
  2042. * <td>ERA_D_FMT</td>
  2043. * <td>Date in alternate era format (string can be used in strftime).</td>
  2044. * </tr>
  2045. * <tr valign="top">
  2046. * <td>ERA_T_FMT</td>
  2047. * <td>Time in alternate era format (string can be used in strftime).</td>
  2048. * </tr>
  2049. * <tr valign="top">
  2050. * LC_MONETARY Category Constants</td>
  2051. * </tr>
  2052. * <tr valign="top">
  2053. * <td>INT_CURR_SYMBOL</td>
  2054. * <td>International currency symbol.</td>
  2055. * </tr>
  2056. * <tr valign="top">
  2057. * <td>CURRENCY_SYMBOL</td>
  2058. * <td>Local currency symbol.</td>
  2059. * </tr>
  2060. * <tr valign="top">
  2061. * <td>CRNCYSTR</td>
  2062. * <td>Same value as CURRENCY_SYMBOL.</td>
  2063. * </tr>
  2064. * <tr valign="top">
  2065. * <td>MON_DECIMAL_POINT</td>
  2066. * <td>Decimal point character.</td>
  2067. * </tr>
  2068. * <tr valign="top">
  2069. * <td>MON_THOUSANDS_SEP</td>
  2070. * <td>Thousands separator (groups of three digits).</td>
  2071. * </tr>
  2072. * <tr valign="top">
  2073. * <td>MON_GROUPING</td>
  2074. * <td>Like "grouping" element.</td>
  2075. * </tr>
  2076. * <tr valign="top">
  2077. * <td>POSITIVE_SIGN</td>
  2078. * <td>Sign for positive values.</td>
  2079. * </tr>
  2080. * <tr valign="top">
  2081. * <td>NEGATIVE_SIGN</td>
  2082. * <td>Sign for negative values.</td>
  2083. * </tr>
  2084. * <tr valign="top">
  2085. * <td>INT_FRAC_DIGITS</td>
  2086. * <td>International fractional digits.</td>
  2087. * </tr>
  2088. * <tr valign="top">
  2089. * <td>FRAC_DIGITS</td>
  2090. * <td>Local fractional digits.</td>
  2091. * </tr>
  2092. * <tr valign="top">
  2093. * <td>P_CS_PRECEDES</td>
  2094. * <td>Returns 1 if CURRENCY_SYMBOL precedes a positive value.</td>
  2095. * </tr>
  2096. * <tr valign="top">
  2097. * <td>P_SEP_BY_SPACE</td>
  2098. * <td>Returns 1 if a space separates CURRENCY_SYMBOL from a positive value.</td>
  2099. * </tr>
  2100. * <tr valign="top">
  2101. * <td>N_CS_PRECEDES</td>
  2102. * <td>Returns 1 if CURRENCY_SYMBOL precedes a negative value.</td>
  2103. * </tr>
  2104. * <tr valign="top">
  2105. * <td>N_SEP_BY_SPACE</td>
  2106. * <td>Returns 1 if a space separates CURRENCY_SYMBOL from a negative value.</td>
  2107. * </tr>
  2108. * <tr valign="top">
  2109. * <td>P_SIGN_POSN</td>
  2110. * Returns 0 if parentheses surround the quantity and CURRENCY_SYMBOL.
  2111. * @return string the element as a string, or false if item
  2112. * is not valid.
  2113. */
  2114. function nl_langinfo ($item) {}
  2115. /**
  2116. * Calculate the soundex key of a string
  2117. * @link http://www.php.net/manual/en/function.soundex.php
  2118. * @param str string <p>
  2119. * The input string.
  2120. * </p>
  2121. * @return string the soundex key as a string.
  2122. */
  2123. function soundex ($str) {}
  2124. /**
  2125. * Calculate Levenshtein distance between two strings
  2126. * @link http://www.php.net/manual/en/function.levenshtein.php
  2127. * @param str1 string <p>
  2128. * One of the strings being evaluated for Levenshtein distance.
  2129. * </p>
  2130. * @param str2 string <p>
  2131. * One of the strings being evaluated for Levenshtein distance.
  2132. * </p>
  2133. * @return int This function returns the Levenshtein-Distance between the
  2134. * two argument strings or -1, if one of the argument strings
  2135. * is longer than the limit of 255 characters.
  2136. */
  2137. function levenshtein ($str1, $str2) {}
  2138. /**
  2139. * Return a specific character
  2140. * @link http://www.php.net/manual/en/function.chr.php
  2141. * @param ascii int <p>
  2142. * The ascii code.
  2143. * </p>
  2144. * @return string the specified character.
  2145. */
  2146. function chr ($ascii) {}
  2147. /**
  2148. * Return ASCII value of character
  2149. * @link http://www.php.net/manual/en/function.ord.php
  2150. * @param string string <p>
  2151. * A character.
  2152. * </p>
  2153. * @return int the ASCII value as an integer.
  2154. */
  2155. function ord ($string) {}
  2156. /**
  2157. * Parses the string into variables
  2158. * @link http://www.php.net/manual/en/function.parse-str.php
  2159. * @param str string <p>
  2160. * The input string.
  2161. * </p>
  2162. * @param arr array[optional] <p>
  2163. * If the second parameter arr is present,
  2164. * variables are stored in this variable as array elements instead.
  2165. * </p>
  2166. * @return void
  2167. */
  2168. function parse_str ($str, array &$arr = null) {}
  2169. /**
  2170. * Parse a CSV string into an array
  2171. * @link http://www.php.net/manual/en/function.str-getcsv.php
  2172. * @param input string <p>
  2173. * The string to parse.
  2174. * </p>
  2175. * @param delimiter string[optional] <p>
  2176. * Set the field delimiter (one character only).
  2177. * </p>
  2178. * @param enclosure string[optional] <p>
  2179. * Set the field enclosure character (one character only).
  2180. * </p>
  2181. * @param escape string[optional] <p>
  2182. * Set the escape character (one character only). Defaults as a backslash
  2183. * (\)
  2184. * </p>
  2185. * @return array an indexed array containing the fields read.
  2186. */
  2187. function str_getcsv ($input, $delimiter = null, $enclosure = null, $escape = null) {}
  2188. /**
  2189. * Pad a string to a certain length with another string
  2190. * @link http://www.php.net/manual/en/function.str-pad.php
  2191. * @param input string <p>
  2192. * The input string.
  2193. * </p>
  2194. * @param pad_length int <p>
  2195. * If the value of pad_length is negative,
  2196. * less than, or equal to the length of the input string, no padding
  2197. * takes place.
  2198. * </p>
  2199. * @param pad_string string[optional] <p>
  2200. * The pad_string may be truncated if the
  2201. * required number of padding characters can't be evenly divided by the
  2202. * pad_string's length.
  2203. * </p>
  2204. * @param pad_type int[optional] <p>
  2205. * Optional argument pad_type can be
  2206. * STR_PAD_RIGHT, STR_PAD_LEFT,
  2207. * or STR_PAD_BOTH. If
  2208. * pad_type is not specified it is assumed to be
  2209. * STR_PAD_RIGHT.
  2210. * </p>
  2211. * @return string the padded string.
  2212. */
  2213. function str_pad ($input, $pad_length, $pad_string = null, $pad_type = null) {}
  2214. /**
  2215. * &Alias; <function>rtrim</function>
  2216. * @link http://www.php.net/manual/en/function.chop.php
  2217. * @param str
  2218. * @param character_mask[optional]
  2219. */
  2220. function chop ($str, $character_mask) {}
  2221. /**
  2222. * &Alias; <function>strstr</function>
  2223. * @link http://www.php.net/manual/en/function.strchr.php
  2224. * @param haystack
  2225. * @param needle
  2226. * @param part[optional]
  2227. */
  2228. function strchr ($haystack, $needle, $part) {}
  2229. /**
  2230. * Return a formatted string
  2231. * @link http://www.php.net/manual/en/function.sprintf.php
  2232. * @param format string <p>
  2233. * The format string is composed of zero or more directives:
  2234. * ordinary characters (excluding %) that are
  2235. * copied directly to the result, and conversion
  2236. * specifications, each of which results in fetching its
  2237. * own parameter. This applies to both sprintf
  2238. * and printf.
  2239. * </p>
  2240. * <p>
  2241. * Each conversion specification consists of a percent sign
  2242. * (%), followed by one or more of these
  2243. * elements, in order:
  2244. * An optional sign specifier that forces a sign
  2245. * (- or +) to be used on a number. By default, only the - sign is used
  2246. * on a number if it's negative. This specifier forces positive numbers
  2247. * to have the + sign attached as well, and was added in PHP 4.3.0.
  2248. * @param args mixed[optional] <p>
  2249. * </p>
  2250. * @param _ mixed[optional]
  2251. * @return string a string produced according to the formatting string
  2252. * format.
  2253. */
  2254. function sprintf ($format, $args = null, $_ = null) {}
  2255. /**
  2256. * Output a formatted string
  2257. * @link http://www.php.net/manual/en/function.printf.php
  2258. * @param format string <p>
  2259. * See sprintf for a description of
  2260. * format.
  2261. * </p>
  2262. * @param args mixed[optional] <p>
  2263. * </p>
  2264. * @param _ mixed[optional]
  2265. * @return int the length of the outputted string.
  2266. */
  2267. function printf ($format, $args = null, $_ = null) {}
  2268. /**
  2269. * Output a formatted string
  2270. * @link http://www.php.net/manual/en/function.vprintf.php
  2271. * @param format string <p>
  2272. * See sprintf for a description of
  2273. * format.
  2274. * </p>
  2275. * @param args array <p>
  2276. * </p>
  2277. * @return int the length of the outputted string.
  2278. */
  2279. function vprintf ($format, array $args) {}
  2280. /**
  2281. * Return a formatted string
  2282. * @link http://www.php.net/manual/en/function.vsprintf.php
  2283. * @param format string <p>
  2284. * See sprintf for a description of
  2285. * format.
  2286. * </p>
  2287. * @param args array <p>
  2288. * </p>
  2289. * @return string Return array values as a formatted string according to
  2290. * format (which is described in the documentation
  2291. * for sprintf).
  2292. */
  2293. function vsprintf ($format, array $args) {}
  2294. /**
  2295. * Write a formatted string to a stream
  2296. * @link http://www.php.net/manual/en/function.fprintf.php
  2297. * @param handle resource &fs.file.pointer;
  2298. * @param format string <p>
  2299. * See sprintf for a description of
  2300. * format.
  2301. * </p>
  2302. * @param args mixed[optional] <p>
  2303. * </p>
  2304. * @param _ mixed[optional]
  2305. * @return int the length of the string written.
  2306. */
  2307. function fprintf ($handle, $format, $args = null, $_ = null) {}
  2308. /**
  2309. * Write a formatted string to a stream
  2310. * @link http://www.php.net/manual/en/function.vfprintf.php
  2311. * @param handle resource <p>
  2312. * </p>
  2313. * @param format string <p>
  2314. * See sprintf for a description of
  2315. * format.
  2316. * </p>
  2317. * @param args array <p>
  2318. * </p>
  2319. * @return int the length of the outputted string.
  2320. */
  2321. function vfprintf ($handle, $format, array $args) {}
  2322. /**
  2323. * Parses input from a string according to a format
  2324. * @link http://www.php.net/manual/en/function.sscanf.php
  2325. * @param str string <p>
  2326. * The input string being parsed.
  2327. * </p>
  2328. * @param format string <p>
  2329. * The interpreted format for str, which is
  2330. * described in the documentation for sprintf with
  2331. * following differences:
  2332. * Function is not locale-aware.
  2333. * F, g, G and
  2334. * b are not supported.
  2335. * D stands for decimal number.
  2336. * i stands for integer with base detection.
  2337. * n stands for number of characters processed so far.
  2338. * </p>
  2339. * @param _ mixed[optional]
  2340. * @return mixed If only
  2341. * two parameters were passed to this function, the values parsed
  2342. * will be returned as an array. Otherwise, if optional parameters are passed,
  2343. * the function will return the number of assigned values. The optional
  2344. * parameters must be passed by reference.
  2345. */
  2346. function sscanf ($str, $format, &$_ = null) {}
  2347. /**
  2348. * Parses input from a file according to a format
  2349. * @link http://www.php.net/manual/en/function.fscanf.php
  2350. * @param handle resource &fs.file.pointer;
  2351. * @param format string <p>
  2352. * The specified format as described in the
  2353. * sprintf documentation.
  2354. * </p>
  2355. * @param _ mixed[optional]
  2356. * @return mixed If only two parameters were passed to this function, the values parsed will be
  2357. * returned as an array. Otherwise, if optional parameters are passed, the
  2358. * function will return the number of assigned values. The optional
  2359. * parameters must be passed by reference.
  2360. */
  2361. function fscanf ($handle, $format, &$_ = null) {}
  2362. /**
  2363. * Parse a URL and return its components
  2364. * @link http://www.php.net/manual/en/function.parse-url.php
  2365. * @param url string <p>
  2366. * The URL to parse. Invalid characters are replaced by
  2367. * _.
  2368. * </p>
  2369. * @param component int[optional] <p>
  2370. * Specify one of PHP_URL_SCHEME,
  2371. * PHP_URL_HOST, PHP_URL_PORT,
  2372. * PHP_URL_USER, PHP_URL_PASS,
  2373. * PHP_URL_PATH, PHP_URL_QUERY
  2374. * or PHP_URL_FRAGMENT to retrieve just a specific
  2375. * URL component as a string.
  2376. * </p>
  2377. * @return mixed On seriously malformed URLs, parse_url may return
  2378. * false and emit a E_WARNING. Otherwise an associative
  2379. * array is returned, whose components may be (at least one):
  2380. * scheme - e.g. http
  2381. * host
  2382. * port
  2383. * user
  2384. * pass
  2385. * path
  2386. * query - after the question mark ?
  2387. * fragment - after the hashmark #
  2388. * </p>
  2389. * <p>
  2390. * If the component parameter is specified a
  2391. * string is returned instead of an array.
  2392. */
  2393. function parse_url ($url, $component = null) {}
  2394. /**
  2395. * URL-encodes string
  2396. * @link http://www.php.net/manual/en/function.urlencode.php
  2397. * @param str string <p>
  2398. * The string to be encoded.
  2399. * </p>
  2400. * @return string a string in which all non-alphanumeric characters except
  2401. * -_. have been replaced with a percent
  2402. * (%) sign followed by two hex digits and spaces encoded
  2403. * as plus (+) signs. It is encoded the same way that the
  2404. * posted data from a WWW form is encoded, that is the same way as in
  2405. * application/x-www-form-urlencoded media type. This
  2406. * differs from the RFC 1738 encoding (see
  2407. * rawurlencode) in that for historical reasons, spaces
  2408. * are encoded as plus (+) signs.
  2409. */
  2410. function urlencode ($str) {}
  2411. /**
  2412. * Decodes URL-encoded string
  2413. * @link http://www.php.net/manual/en/function.urldecode.php
  2414. * @param str string <p>
  2415. * The string to be decoded.
  2416. * </p>
  2417. * @return string the decoded string.
  2418. */
  2419. function urldecode ($str) {}
  2420. /**
  2421. * URL-encode according to RFC 1738
  2422. * @link http://www.php.net/manual/en/function.rawurlencode.php
  2423. * @param str string <p>
  2424. * The URL to be encoded.
  2425. * </p>
  2426. * @return string a string in which all non-alphanumeric characters except
  2427. * -_. have been replaced with a percent
  2428. * (%) sign followed by two hex digits. This is the
  2429. * encoding described in RFC 1738 for
  2430. * protecting literal characters from being interpreted as special URL
  2431. * delimiters, and for protecting URLs from being mangled by transmission
  2432. * media with character conversions (like some email systems).
  2433. */
  2434. function rawurlencode ($str) {}
  2435. /**
  2436. * Decode URL-encoded strings
  2437. * @link http://www.php.net/manual/en/function.rawurldecode.php
  2438. * @param str string <p>
  2439. * The URL to be decoded.
  2440. * </p>
  2441. * @return string the decoded URL, as a string.
  2442. */
  2443. function rawurldecode ($str) {}
  2444. /**
  2445. * Generate URL-encoded query string
  2446. * @link http://www.php.net/manual/en/function.http-build-query.php
  2447. * @param formdata array <p>
  2448. * May be an array or object containing properties.
  2449. * </p>
  2450. * <p>
  2451. * The array form may be a simple one-dimensional structure, or an array
  2452. * of arrays (who in turn may contain other arrays).
  2453. * </p>
  2454. * @param numeric_prefix string[optional] <p>
  2455. * If numeric indices are used in the base array and this parameter is
  2456. * provided, it will be prepended to the numeric index for elements in
  2457. * the base array only.
  2458. * </p>
  2459. * <p>
  2460. * This is meant to allow for legal variable names when the data is
  2461. * decoded by PHP or another CGI application later on.
  2462. * </p>
  2463. * @param arg_separator string[optional] <p>
  2464. * arg_separator.output
  2465. * is used to separate arguments, unless this parameter is specified,
  2466. * and is then used.
  2467. * </p>
  2468. * @return string a URL-encoded string.
  2469. */
  2470. function http_build_query (array $formdata, $numeric_prefix = null, $arg_separator = null) {}
  2471. /**
  2472. * Returns the target of a symbolic link
  2473. * @link http://www.php.net/manual/en/function.readlink.php
  2474. * @param path string <p>
  2475. * The symbolic link path.
  2476. * </p>
  2477. * @return string the contents of the symbolic link path or false on error.
  2478. */
  2479. function readlink ($path) {}
  2480. /**
  2481. * Gets information about a link
  2482. * @link http://www.php.net/manual/en/function.linkinfo.php
  2483. * @param path string <p>
  2484. * Path to the link.
  2485. * </p>
  2486. * @return int linkinfo returns the st_dev field
  2487. * of the Unix C stat structure returned by the lstat
  2488. * system call. Returns 0 or false in case of error.
  2489. */
  2490. function linkinfo ($path) {}
  2491. /**
  2492. * @param target
  2493. * @param link
  2494. */
  2495. function symlink ($target, $link) {}
  2496. /**
  2497. * Create a hard link
  2498. * @link http://www.php.net/manual/en/function.link.php
  2499. * @param from_path string <p>
  2500. * The link name.
  2501. * </p>
  2502. * @param to_path string <p>
  2503. * Target of the link.
  2504. * </p>
  2505. * @return bool Returns true on success or false on failure.
  2506. */
  2507. function link ($from_path, $to_path) {}
  2508. /**
  2509. * Deletes a file
  2510. * @link http://www.php.net/manual/en/function.unlink.php
  2511. * @param filename string <p>
  2512. * Path to the file.
  2513. * </p>
  2514. * @param context resource[optional] &note.context-support;
  2515. * @return bool Returns true on success or false on failure.
  2516. */
  2517. function unlink ($filename, $context = null) {}
  2518. /**
  2519. * Execute an external program
  2520. * @link http://www.php.net/manual/en/function.exec.php
  2521. * @param command string <p>
  2522. * The command that will be executed.
  2523. * </p>
  2524. * @param output array[optional] <p>
  2525. * If the output argument is present, then the
  2526. * specified array will be filled with every line of output from the
  2527. * command. Trailing whitespace, such as \n, is not
  2528. * included in this array. Note that if the array already contains some
  2529. * elements, exec will append to the end of the array.
  2530. * If you do not want the function to append elements, call
  2531. * unset on the array before passing it to
  2532. * exec.
  2533. * </p>
  2534. * @param return_var int[optional] <p>
  2535. * If the return_var argument is present
  2536. * along with the output argument, then the
  2537. * return status of the executed command will be written to this
  2538. * variable.
  2539. * </p>
  2540. * @return string The last line from the result of the command. If you need to execute a
  2541. * command and have all the data from the command passed directly back without
  2542. * any interference, use the passthru function.
  2543. * </p>
  2544. * <p>
  2545. * To get the output of the executed command, be sure to set and use the
  2546. * output parameter.
  2547. */
  2548. function exec ($command, array &$output = null, &$return_var = null) {}
  2549. /**
  2550. * Execute an external program and display the output
  2551. * @link http://www.php.net/manual/en/function.system.php
  2552. * @param command string <p>
  2553. * The command that will be executed.
  2554. * </p>
  2555. * @param return_var int[optional] <p>
  2556. * If the return_var argument is present, then the
  2557. * return status of the executed command will be written to this
  2558. * variable.
  2559. * </p>
  2560. * @return string the last line of the command output on success, and false
  2561. * on failure.
  2562. */
  2563. function system ($command, &$return_var = null) {}
  2564. /**
  2565. * Escape shell metacharacters
  2566. * @link http://www.php.net/manual/en/function.escapeshellcmd.php
  2567. * @param command string <p>
  2568. * The command that will be escaped.
  2569. * </p>
  2570. * @return string The escaped string.
  2571. */
  2572. function escapeshellcmd ($command) {}
  2573. /**
  2574. * Escape a string to be used as a shell argument
  2575. * @link http://www.php.net/manual/en/function.escapeshellarg.php
  2576. * @param arg string <p>
  2577. * The argument that will be escaped.
  2578. * </p>
  2579. * @return string The escaped string.
  2580. */
  2581. function escapeshellarg ($arg) {}
  2582. /**
  2583. * Execute an external program and display raw output
  2584. * @link http://www.php.net/manual/en/function.passthru.php
  2585. * @param command string <p>
  2586. * The command that will be executed.
  2587. * </p>
  2588. * @param return_var int[optional] <p>
  2589. * If the return_var argument is present, the
  2590. * return status of the Unix command will be placed here.
  2591. * </p>
  2592. * @return void
  2593. */
  2594. function passthru ($command, &$return_var = null) {}
  2595. /**
  2596. * Execute command via shell and return the complete output as a string
  2597. * @link http://www.php.net/manual/en/function.shell-exec.php
  2598. * @param cmd string <p>
  2599. * The command that will be executed.
  2600. * </p>
  2601. * @return string The output from the executed command.
  2602. */
  2603. function shell_exec ($cmd) {}
  2604. /**
  2605. * Execute a command and open file pointers for input/output
  2606. * @link http://www.php.net/manual/en/function.proc-open.php
  2607. * @param cmd string <p>
  2608. * The command to execute
  2609. * </p>
  2610. * @param descriptorspec array <p>
  2611. * An indexed array where the key represents the descriptor number and the
  2612. * value represents how PHP will pass that descriptor to the child
  2613. * process. 0 is stdin, 1 is stdout, while 2 is stderr.
  2614. * </p>
  2615. * <p>
  2616. * Each element can be:
  2617. * An array describing the pipe to pass to the process. The first
  2618. * element is the descriptor type and the second element is an option for
  2619. * the given type. Valid types are pipe (the second
  2620. * element is either r to pass the read end of the pipe
  2621. * to the process, or w to pass the write end) and
  2622. * file (the second element is a filename).
  2623. * A stream resource representing a real file descriptor (e.g. opened file,
  2624. * a socket, STDIN).
  2625. * </p>
  2626. * <p>
  2627. * The file descriptor numbers are not limited to 0, 1 and 2 - you may
  2628. * specify any valid file descriptor number and it will be passed to the
  2629. * child process. This allows your script to interoperate with other
  2630. * scripts that run as "co-processes". In particular, this is useful for
  2631. * passing passphrases to programs like PGP, GPG and openssl in a more
  2632. * secure manner. It is also useful for reading status information
  2633. * provided by those programs on auxiliary file descriptors.
  2634. * </p>
  2635. * @param pipes array <p>
  2636. * Will be set to an indexed array of file pointers that correspond to
  2637. * PHP's end of any pipes that are created.
  2638. * </p>
  2639. * @param cwd string[optional] <p>
  2640. * The initial working dir for the command. This must be an
  2641. * absolute directory path, or &null;
  2642. * if you want to use the default value (the working dir of the current
  2643. * PHP process)
  2644. * </p>
  2645. * @param env array[optional] <p>
  2646. * An array with the environment variables for the command that will be
  2647. * run, or &null; to use the same environment as the current PHP process
  2648. * </p>
  2649. * @param other_options array[optional] <p>
  2650. * Allows you to specify additional options. Currently supported options
  2651. * include:
  2652. * suppress_errors (windows only): suppresses errors
  2653. * generated by this function when it's set to true
  2654. * bypass_shell (windows only): bypass
  2655. * cmd.exe shell when set to true
  2656. * context: stream context used when opening files
  2657. * (created with stream_context_create)
  2658. * binary_pipes: open pipes in binary mode, instead
  2659. * of using the usual stream_encoding
  2660. * </p>
  2661. * @return resource a resource representing the process, which should be freed using
  2662. * proc_close when you are finished with it. On failure
  2663. * returns false.
  2664. */
  2665. function proc_open ($cmd, array $descriptorspec, array &$pipes, $cwd = null, array $env = null, array $other_options = null) {}
  2666. /**
  2667. * Close a process opened by <function>proc_open</function> and return the exit code of that process
  2668. * @link http://www.php.net/manual/en/function.proc-close.php
  2669. * @param process resource <p>
  2670. * The proc_open resource that will
  2671. * be closed.
  2672. * </p>
  2673. * @return int the termination status of the process that was run.
  2674. */
  2675. function proc_close ($process) {}
  2676. /**
  2677. * Kills a process opened by proc_open
  2678. * @link http://www.php.net/manual/en/function.proc-terminate.php
  2679. * @param process resource <p>
  2680. * The proc_open resource that will
  2681. * be closed.
  2682. * </p>
  2683. * @param signal int[optional] <p>
  2684. * This optional parameter is only useful on POSIX
  2685. * operating systems; you may specify a signal to send to the process
  2686. * using the kill(2) system call. The default is
  2687. * SIGTERM.
  2688. * </p>
  2689. * @return bool the termination status of the process that was run.
  2690. */
  2691. function proc_terminate ($process, $signal = null) {}
  2692. /**
  2693. * Get information about a process opened by <function>proc_open</function>
  2694. * @link http://www.php.net/manual/en/function.proc-get-status.php
  2695. * @param process resource <p>
  2696. * The proc_open resource that will
  2697. * be evaluated.
  2698. * </p>
  2699. * @return array An array of collected information on success, and false
  2700. * on failure. The returned array contains the following elements:
  2701. * </p>
  2702. * <p>
  2703. * <tr valign="top"><td>element</td><td>type</td><td>description</td></tr>
  2704. * <tr valign="top">
  2705. * <td>command</td>
  2706. * <td>string</td>
  2707. * <td>
  2708. * The command string that was passed to proc_open.
  2709. * </td>
  2710. * </tr>
  2711. * <tr valign="top">
  2712. * <td>pid</td>
  2713. * <td>int</td>
  2714. * <td>process id</td>
  2715. * </tr>
  2716. * <tr valign="top">
  2717. * <td>running</td>
  2718. * <td>bool</td>
  2719. * <td>
  2720. * true if the process is still running, false if it has
  2721. * terminated.
  2722. * </td>
  2723. * </tr>
  2724. * <tr valign="top">
  2725. * <td>signaled</td>
  2726. * <td>bool</td>
  2727. * <td>
  2728. * true if the child process has been terminated by
  2729. * an uncaught signal. Always set to false on Windows.
  2730. * </td>
  2731. * </tr>
  2732. * <tr valign="top">
  2733. * <td>stopped</td>
  2734. * <td>bool</td>
  2735. * <td>
  2736. * true if the child process has been stopped by a
  2737. * signal. Always set to false on Windows.
  2738. * </td>
  2739. * </tr>
  2740. * <tr valign="top">
  2741. * <td>exitcode</td>
  2742. * <td>int</td>
  2743. * <td>
  2744. * The exit code returned by the process (which is only
  2745. * meaningful if running is false).
  2746. * Only first call of this function return real value, next calls return
  2747. * -1.
  2748. * </td>
  2749. * </tr>
  2750. * <tr valign="top">
  2751. * <td>termsig</td>
  2752. * <td>int</td>
  2753. * <td>
  2754. * The number of the signal that caused the child process to terminate
  2755. * its execution (only meaningful if signaled is true).
  2756. * </td>
  2757. * </tr>
  2758. * <tr valign="top">
  2759. * <td>stopsig</td>
  2760. * <td>int</td>
  2761. * <td>
  2762. * The number of the signal that caused the child process to stop its
  2763. * execution (only meaningful if stopped is true).
  2764. * </td>
  2765. * </tr>
  2766. */
  2767. function proc_get_status ($process) {}
  2768. /**
  2769. * Change the priority of the current process
  2770. * @link http://www.php.net/manual/en/function.proc-nice.php
  2771. * @param increment int <p>
  2772. * The increment value of the priority change.
  2773. * </p>
  2774. * @return bool Returns true on success or false on failure.
  2775. * If an error occurs, like the user lacks permission to change the priority,
  2776. * an error of level E_WARNING is also generated.
  2777. */
  2778. function proc_nice ($increment) {}
  2779. /**
  2780. * Generate a random integer
  2781. * @link http://www.php.net/manual/en/function.rand.php
  2782. * @param min[optional]
  2783. * @param max[optional]
  2784. * @return int A pseudo random value between min
  2785. * (or 0) and max (or getrandmax, inclusive).
  2786. */
  2787. function rand ($min, $max) {}
  2788. /**
  2789. * Seed the random number generator
  2790. * @link http://www.php.net/manual/en/function.srand.php
  2791. * @param seed int[optional] <p>
  2792. * Optional seed value
  2793. * </p>
  2794. * @return void
  2795. */
  2796. function srand ($seed = null) {}
  2797. /**
  2798. * Show largest possible random value
  2799. * @link http://www.php.net/manual/en/function.getrandmax.php
  2800. * @return int The largest possible random value returned by rand
  2801. */
  2802. function getrandmax () {}
  2803. /**
  2804. * Generate a better random value
  2805. * @link http://www.php.net/manual/en/function.mt-rand.php
  2806. * @param min[optional]
  2807. * @param max[optional]
  2808. * @return int A random integer value between min (or 0)
  2809. * and max (or mt_getrandmax, inclusive)
  2810. */
  2811. function mt_rand ($min, $max) {}
  2812. /**
  2813. * Seed the better random number generator
  2814. * @link http://www.php.net/manual/en/function.mt-srand.php
  2815. * @param seed int[optional] <p>
  2816. * An optional seed value
  2817. * </p>
  2818. * @return void
  2819. */
  2820. function mt_srand ($seed = null) {}
  2821. /**
  2822. * Show largest possible random value
  2823. * @link http://www.php.net/manual/en/function.mt-getrandmax.php
  2824. * @return int the maximum random value returned by mt_rand
  2825. */
  2826. function mt_getrandmax () {}
  2827. /**
  2828. * Get port number associated with an Internet service and protocol
  2829. * @link http://www.php.net/manual/en/function.getservbyname.php
  2830. * @param service string <p>
  2831. * The Internet service name, as a string.
  2832. * </p>
  2833. * @param protocol string <p>
  2834. * protocol is either "tcp"
  2835. * or "udp" (in lowercase).
  2836. * </p>
  2837. * @return int the port number, or false if service or
  2838. * protocol is not found.
  2839. */
  2840. function getservbyname ($service, $protocol) {}
  2841. /**
  2842. * Get Internet service which corresponds to port and protocol
  2843. * @link http://www.php.net/manual/en/function.getservbyport.php
  2844. * @param port int <p>
  2845. * The port number.
  2846. * </p>
  2847. * @param protocol string <p>
  2848. * protocol is either "tcp"
  2849. * or "udp" (in lowercase).
  2850. * </p>
  2851. * @return string the Internet service name as a string.
  2852. */
  2853. function getservbyport ($port, $protocol) {}
  2854. /**
  2855. * Get protocol number associated with protocol name
  2856. * @link http://www.php.net/manual/en/function.getprotobyname.php
  2857. * @param name string <p>
  2858. * The protocol name.
  2859. * </p>
  2860. * @return int the protocol number or -1 if the protocol is not found.
  2861. */
  2862. function getprotobyname ($name) {}
  2863. /**
  2864. * Get protocol name associated with protocol number
  2865. * @link http://www.php.net/manual/en/function.getprotobynumber.php
  2866. * @param number int <p>
  2867. * The protocol number.
  2868. * </p>
  2869. * @return string the protocol name as a string.
  2870. */
  2871. function getprotobynumber ($number) {}
  2872. /**
  2873. * Gets PHP script owner's UID
  2874. * @link http://www.php.net/manual/en/function.getmyuid.php
  2875. * @return int the user ID of the current script, or false on error.
  2876. */
  2877. function getmyuid () {}
  2878. /**
  2879. * Get PHP script owner's GID
  2880. * @link http://www.php.net/manual/en/function.getmygid.php
  2881. * @return int the group ID of the current script, or false on error.
  2882. */
  2883. function getmygid () {}
  2884. /**
  2885. * Gets PHP's process ID
  2886. * @link http://www.php.net/manual/en/function.getmypid.php
  2887. * @return int the current PHP process ID, or false on error.
  2888. */
  2889. function getmypid () {}
  2890. /**
  2891. * Gets the inode of the current script
  2892. * @link http://www.php.net/manual/en/function.getmyinode.php
  2893. * @return int the current script's inode as an integer, or false on error.
  2894. */
  2895. function getmyinode () {}
  2896. /**
  2897. * Gets time of last page modification
  2898. * @link http://www.php.net/manual/en/function.getlastmod.php
  2899. * @return int the time of the last modification of the current
  2900. * page. The value returned is a Unix timestamp, suitable for
  2901. * feeding to date. Returns false on error.
  2902. */
  2903. function getlastmod () {}
  2904. /**
  2905. * Decodes data encoded with MIME base64
  2906. * @link http://www.php.net/manual/en/function.base64-decode.php
  2907. * @param data string <p>
  2908. * The encoded data.
  2909. * </p>
  2910. * @param strict bool[optional] <p>
  2911. * Returns false if input contains character from outside the base64
  2912. * alphabet.
  2913. * </p>
  2914. * @return string the original data&return.falseforfailure;. The returned data may be
  2915. * binary.
  2916. */
  2917. function base64_decode ($data, $strict = null) {}
  2918. /**
  2919. * Encodes data with MIME base64
  2920. * @link http://www.php.net/manual/en/function.base64-encode.php
  2921. * @param data string <p>
  2922. * The data to encode.
  2923. * </p>
  2924. * @return string The encoded data, as a string.
  2925. */
  2926. function base64_encode ($data) {}
  2927. /**
  2928. * Uuencode a string
  2929. * @link http://www.php.net/manual/en/function.convert-uuencode.php
  2930. * @param data string <p>
  2931. * The data to be encoded.
  2932. * </p>
  2933. * @return string the uuencoded data.
  2934. */
  2935. function convert_uuencode ($data) {}
  2936. /**
  2937. * Decode a uuencoded string
  2938. * @link http://www.php.net/manual/en/function.convert-uudecode.php
  2939. * @param data string <p>
  2940. * The uuencoded data.
  2941. * </p>
  2942. * @return string the decoded data as a string.
  2943. */
  2944. function convert_uudecode ($data) {}
  2945. /**
  2946. * Absolute value
  2947. * @link http://www.php.net/manual/en/function.abs.php
  2948. * @param number mixed <p>
  2949. * The numeric value to process
  2950. * </p>
  2951. * @return number The absolute value of number. If the
  2952. * argument number is
  2953. * of type float, the return type is also float,
  2954. * otherwise it is integer (as float usually has a
  2955. * bigger value range than integer).
  2956. */
  2957. function abs ($number) {}
  2958. /**
  2959. * Round fractions up
  2960. * @link http://www.php.net/manual/en/function.ceil.php
  2961. * @param value float <p>
  2962. * The value to round
  2963. * </p>
  2964. * @return float value rounded up to the next highest
  2965. * integer.
  2966. * The return value of ceil is still of type
  2967. * float as the value range of float is
  2968. * usually bigger than that of integer.
  2969. */
  2970. function ceil ($value) {}
  2971. /**
  2972. * Round fractions down
  2973. * @link http://www.php.net/manual/en/function.floor.php
  2974. * @param value float <p>
  2975. * The numeric value to round
  2976. * </p>
  2977. * @return float value rounded to the next lowest integer.
  2978. * The return value of floor is still of type
  2979. * float because the value range of float is
  2980. * usually bigger than that of integer.
  2981. */
  2982. function floor ($value) {}
  2983. /**
  2984. * Rounds a float
  2985. * @link http://www.php.net/manual/en/function.round.php
  2986. * @param val float <p>
  2987. * The value to round
  2988. * </p>
  2989. * @param precision int[optional] <p>
  2990. * The optional number of decimal digits to round to.
  2991. * </p>
  2992. * @param mode int[optional] <p>
  2993. * One of PHP_ROUND_HALF_UP,
  2994. * PHP_ROUND_HALF_DOWN,
  2995. * PHP_ROUND_HALF_EVEN, or
  2996. * PHP_ROUND_HALF_ODD.
  2997. * </p>
  2998. * @return float The rounded value
  2999. */
  3000. function round ($val, $precision = null, $mode = null) {}
  3001. /**
  3002. * Sine
  3003. * @link http://www.php.net/manual/en/function.sin.php
  3004. * @param arg float <p>
  3005. * A value in radians
  3006. * </p>
  3007. * @return float The sine of arg
  3008. */
  3009. function sin ($arg) {}
  3010. /**
  3011. * Cosine
  3012. * @link http://www.php.net/manual/en/function.cos.php
  3013. * @param arg float <p>
  3014. * An angle in radians
  3015. * </p>
  3016. * @return float The cosine of arg
  3017. */
  3018. function cos ($arg) {}
  3019. /**
  3020. * Tangent
  3021. * @link http://www.php.net/manual/en/function.tan.php
  3022. * @param arg float <p>
  3023. * The argument to process in radians
  3024. * </p>
  3025. * @return float The tangent of arg
  3026. */
  3027. function tan ($arg) {}
  3028. /**
  3029. * Arc sine
  3030. * @link http://www.php.net/manual/en/function.asin.php
  3031. * @param arg float <p>
  3032. * The argument to process
  3033. * </p>
  3034. * @return float The arc sine of arg in radians
  3035. */
  3036. function asin ($arg) {}
  3037. /**
  3038. * Arc cosine
  3039. * @link http://www.php.net/manual/en/function.acos.php
  3040. * @param arg float <p>
  3041. * The argument to process
  3042. * </p>
  3043. * @return float The arc cosine of arg in radians.
  3044. */
  3045. function acos ($arg) {}
  3046. /**
  3047. * Arc tangent
  3048. * @link http://www.php.net/manual/en/function.atan.php
  3049. * @param arg float <p>
  3050. * The argument to process
  3051. * </p>
  3052. * @return float The arc tangent of arg in radians.
  3053. */
  3054. function atan ($arg) {}
  3055. /**
  3056. * Inverse hyperbolic tangent
  3057. * @link http://www.php.net/manual/en/function.atanh.php
  3058. * @param arg float <p>
  3059. * The argument to process
  3060. * </p>
  3061. * @return float Inverse hyperbolic tangent of arg
  3062. */
  3063. function atanh ($arg) {}
  3064. /**
  3065. * Arc tangent of two variables
  3066. * @link http://www.php.net/manual/en/function.atan2.php
  3067. * @param y float <p>
  3068. * Dividend parameter
  3069. * </p>
  3070. * @param x float <p>
  3071. * Divisor parameter
  3072. * </p>
  3073. * @return float The arc tangent of y/x
  3074. * in radians.
  3075. */
  3076. function atan2 ($y, $x) {}
  3077. /**
  3078. * Hyperbolic sine
  3079. * @link http://www.php.net/manual/en/function.sinh.php
  3080. * @param arg float <p>
  3081. * The argument to process
  3082. * </p>
  3083. * @return float The hyperbolic sine of arg
  3084. */
  3085. function sinh ($arg) {}
  3086. /**
  3087. * Hyperbolic cosine
  3088. * @link http://www.php.net/manual/en/function.cosh.php
  3089. * @param arg float <p>
  3090. * The argument to process
  3091. * </p>
  3092. * @return float The hyperbolic cosine of arg
  3093. */
  3094. function cosh ($arg) {}
  3095. /**
  3096. * Hyperbolic tangent
  3097. * @link http://www.php.net/manual/en/function.tanh.php
  3098. * @param arg float <p>
  3099. * The argument to process
  3100. * </p>
  3101. * @return float The hyperbolic tangent of arg
  3102. */
  3103. function tanh ($arg) {}
  3104. /**
  3105. * Inverse hyperbolic sine
  3106. * @link http://www.php.net/manual/en/function.asinh.php
  3107. * @param arg float <p>
  3108. * The argument to process
  3109. * </p>
  3110. * @return float The inverse hyperbolic sine of arg
  3111. */
  3112. function asinh ($arg) {}
  3113. /**
  3114. * Inverse hyperbolic cosine
  3115. * @link http://www.php.net/manual/en/function.acosh.php
  3116. * @param arg float <p>
  3117. * The value to process
  3118. * </p>
  3119. * @return float The inverse hyperbolic cosine of arg
  3120. */
  3121. function acosh ($arg) {}
  3122. /**
  3123. * Returns exp(number) - 1, computed in a way that is accurate even
  3124. when the value of number is close to zero
  3125. * @link http://www.php.net/manual/en/function.expm1.php
  3126. * @param arg float <p>
  3127. * The argument to process
  3128. * </p>
  3129. * @return float 'e' to the power of arg minus one
  3130. */
  3131. function expm1 ($arg) {}
  3132. /**
  3133. * Returns log(1 + number), computed in a way that is accurate even when
  3134. the value of number is close to zero
  3135. * @link http://www.php.net/manual/en/function.log1p.php
  3136. * @param number float <p>
  3137. * The argument to process
  3138. * </p>
  3139. * @return float log(1 + number)
  3140. */
  3141. function log1p ($number) {}
  3142. /**
  3143. * Get value of pi
  3144. * @link http://www.php.net/manual/en/function.pi.php
  3145. * @return float The value of pi as float.
  3146. */
  3147. function pi () {}
  3148. /**
  3149. * Finds whether a value is a legal finite number
  3150. * @link http://www.php.net/manual/en/function.is-finite.php
  3151. * @param val float <p>
  3152. * The value to check
  3153. * </p>
  3154. * @return bool true if val is a legal finite
  3155. * number within the allowed range for a PHP float on this platform,
  3156. * else false.
  3157. */
  3158. function is_finite ($val) {}
  3159. /**
  3160. * Finds whether a value is not a number
  3161. * @link http://www.php.net/manual/en/function.is-nan.php
  3162. * @param val float <p>
  3163. * The value to check
  3164. * </p>
  3165. * @return bool true if val is 'not a number',
  3166. * else false.
  3167. */
  3168. function is_nan ($val) {}
  3169. /**
  3170. * Finds whether a value is infinite
  3171. * @link http://www.php.net/manual/en/function.is-infinite.php
  3172. * @param val float <p>
  3173. * The value to check
  3174. * </p>
  3175. * @return bool true if val is infinite, else false.
  3176. */
  3177. function is_infinite ($val) {}
  3178. /**
  3179. * Exponential expression
  3180. * @link http://www.php.net/manual/en/function.pow.php
  3181. * @param base number <p>
  3182. * The base to use
  3183. * </p>
  3184. * @param exp number <p>
  3185. * The exponent
  3186. * </p>
  3187. * @return number base raised to the power of exp.
  3188. * If the result can be represented as integer it will be returned as type
  3189. * integer, else it will be returned as type float.
  3190. * If the power cannot be computed false will be returned instead.
  3191. */
  3192. function pow ($base, $exp) {}
  3193. /**
  3194. * Calculates the exponent of <constant>e</constant>
  3195. * @link http://www.php.net/manual/en/function.exp.php
  3196. * @param arg float <p>
  3197. * The argument to process
  3198. * </p>
  3199. * @return float 'e' raised to the power of arg
  3200. */
  3201. function exp ($arg) {}
  3202. /**
  3203. * Natural logarithm
  3204. * @link http://www.php.net/manual/en/function.log.php
  3205. * @param arg float <p>
  3206. * The value to calculate the logarithm for
  3207. * </p>
  3208. * @param base float[optional] <p>
  3209. * The optional logarithmic base to use
  3210. * (defaults to 'e' and so to the natural logarithm).
  3211. * </p>
  3212. * @return float The logarithm of arg to
  3213. * base, if given, or the
  3214. * natural logarithm.
  3215. */
  3216. function log ($arg, $base = null) {}
  3217. /**
  3218. * Base-10 logarithm
  3219. * @link http://www.php.net/manual/en/function.log10.php
  3220. * @param arg float <p>
  3221. * The argument to process
  3222. * </p>
  3223. * @return float The base-10 logarithm of arg
  3224. */
  3225. function log10 ($arg) {}
  3226. /**
  3227. * Square root
  3228. * @link http://www.php.net/manual/en/function.sqrt.php
  3229. * @param arg float <p>
  3230. * The argument to process
  3231. * </p>
  3232. * @return float The square root of arg
  3233. * or the special value NAN for negative numbers.
  3234. */
  3235. function sqrt ($arg) {}
  3236. /**
  3237. * Calculate the length of the hypotenuse of a right-angle triangle
  3238. * @link http://www.php.net/manual/en/function.hypot.php
  3239. * @param x float <p>
  3240. * Length of first side
  3241. * </p>
  3242. * @param y float <p>
  3243. * Length of second side
  3244. * </p>
  3245. * @return float Calculated length of the hypotenuse
  3246. */
  3247. function hypot ($x, $y) {}
  3248. /**
  3249. * Converts the number in degrees to the radian equivalent
  3250. * @link http://www.php.net/manual/en/function.deg2rad.php
  3251. * @param number float <p>
  3252. * Angular value in degrees
  3253. * </p>
  3254. * @return float The radian equivalent of number
  3255. */
  3256. function deg2rad ($number) {}
  3257. /**
  3258. * Converts the radian number to the equivalent number in degrees
  3259. * @link http://www.php.net/manual/en/function.rad2deg.php
  3260. * @param number float <p>
  3261. * A radian value
  3262. * </p>
  3263. * @return float The equivalent of number in degrees
  3264. */
  3265. function rad2deg ($number) {}
  3266. /**
  3267. * Binary to decimal
  3268. * @link http://www.php.net/manual/en/function.bindec.php
  3269. * @param binary_string string <p>
  3270. * The binary string to convert
  3271. * </p>
  3272. * @return number The decimal value of binary_string
  3273. */
  3274. function bindec ($binary_string) {}
  3275. /**
  3276. * Hexadecimal to decimal
  3277. * @link http://www.php.net/manual/en/function.hexdec.php
  3278. * @param hex_string string <p>
  3279. * The hexadecimal string to convert
  3280. * </p>
  3281. * @return number The decimal representation of hex_string
  3282. */
  3283. function hexdec ($hex_string) {}
  3284. /**
  3285. * Octal to decimal
  3286. * @link http://www.php.net/manual/en/function.octdec.php
  3287. * @param octal_string string <p>
  3288. * The octal string to convert
  3289. * </p>
  3290. * @return number The decimal representation of octal_string
  3291. */
  3292. function octdec ($octal_string) {}
  3293. /**
  3294. * Decimal to binary
  3295. * @link http://www.php.net/manual/en/function.decbin.php
  3296. * @param number int <p>
  3297. * Decimal value to convert
  3298. * </p>
  3299. * <table>
  3300. * Range of inputs on 32-bit machines
  3301. * <tr valign="top">
  3302. * <td>positive number</td>
  3303. * <td>negative number</td>
  3304. * <td>return value</td>
  3305. * </tr>
  3306. * <tr valign="top">
  3307. * <td>0</td>
  3308. * <td></td>
  3309. * <td>0</td>
  3310. * </tr>
  3311. * <tr valign="top">
  3312. * <td>1</td>
  3313. * <td></td>
  3314. * <td>1</td>
  3315. * </tr>
  3316. * <tr valign="top">
  3317. * <td>2</td>
  3318. * <td></td>
  3319. * <td>10</td>
  3320. * </tr>
  3321. * <tr valign="top">
  3322. * ... normal progression ...</td>
  3323. * </tr>
  3324. * <tr valign="top">
  3325. * <td>2147483646</td>
  3326. * <td></td>
  3327. * <td>1111111111111111111111111111110</td>
  3328. * </tr>
  3329. * <tr valign="top">
  3330. * <td>2147483647 (largest signed integer)</td>
  3331. * <td></td>
  3332. * <td>1111111111111111111111111111111 (31 1's)</td>
  3333. * </tr>
  3334. * <tr valign="top">
  3335. * <td>2147483648</td>
  3336. * <td>-2147483648</td>
  3337. * <td>10000000000000000000000000000000</td>
  3338. * </tr>
  3339. * <tr valign="top">
  3340. * ... normal progression ...</td>
  3341. * </tr>
  3342. * <tr valign="top">
  3343. * <td>4294967294</td>
  3344. * <td>-2</td>
  3345. * <td>11111111111111111111111111111110</td>
  3346. * </tr>
  3347. * <tr valign="top">
  3348. * <td>4294967295 (largest unsigned integer)</td>
  3349. * <td>-1</td>
  3350. * <td>11111111111111111111111111111111 (32 1's)</td>
  3351. * </tr>
  3352. * </table>
  3353. * <table>
  3354. * Range of inputs on 64-bit machines
  3355. * <tr valign="top">
  3356. * <td>positive number</td>
  3357. * <td>negative number</td>
  3358. * <td>return value</td>
  3359. * </tr>
  3360. * <tr valign="top">
  3361. * <td>0</td>
  3362. * <td></td>
  3363. * <td>0</td>
  3364. * </tr>
  3365. * <tr valign="top">
  3366. * <td>1</td>
  3367. * <td></td>
  3368. * <td>1</td>
  3369. * </tr>
  3370. * <tr valign="top">
  3371. * <td>2</td>
  3372. * <td></td>
  3373. * <td>10</td>
  3374. * </tr>
  3375. * <tr valign="top">
  3376. * ... normal progression ...</td>
  3377. * </tr>
  3378. * <tr valign="top">
  3379. * <td>9223372036854775806</td>
  3380. * <td></td>
  3381. * <td>111111111111111111111111111111111111111111111111111111111111110</td>
  3382. * </tr>
  3383. * <tr valign="top">
  3384. * <td>9223372036854775807 (largest signed integer)</td>
  3385. * <td></td>
  3386. * <td>111111111111111111111111111111111111111111111111111111111111111 (31 1's)</td>
  3387. * </tr>
  3388. * <tr valign="top">
  3389. * <td></td>
  3390. * <td>-9223372036854775808</td>
  3391. * <td>1000000000000000000000000000000000000000000000000000000000000000</td>
  3392. * </tr>
  3393. * <tr valign="top">
  3394. * ... normal progression ...</td>
  3395. * </tr>
  3396. * <tr valign="top">
  3397. * <td></td>
  3398. * <td>-2</td>
  3399. * <td>1111111111111111111111111111111111111111111111111111111111111110</td>
  3400. * </tr>
  3401. * <tr valign="top">
  3402. * <td></td>
  3403. * <td>-1</td>
  3404. * <td>1111111111111111111111111111111111111111111111111111111111111111 (64 1's)</td>
  3405. * </tr>
  3406. * </table>
  3407. * @return string Binary string representation of number
  3408. */
  3409. function decbin ($number) {}
  3410. /**
  3411. * Decimal to octal
  3412. * @link http://www.php.net/manual/en/function.decoct.php
  3413. * @param number int <p>
  3414. * Decimal value to convert
  3415. * </p>
  3416. * @return string Octal string representation of number
  3417. */
  3418. function decoct ($number) {}
  3419. /**
  3420. * Decimal to hexadecimal
  3421. * @link http://www.php.net/manual/en/function.dechex.php
  3422. * @param number int <p>
  3423. * Decimal value to convert
  3424. * </p>
  3425. * @return string Hexadecimal string representation of number
  3426. */
  3427. function dechex ($number) {}
  3428. /**
  3429. * Convert a number between arbitrary bases
  3430. * @link http://www.php.net/manual/en/function.base-convert.php
  3431. * @param number string <p>
  3432. * The number to convert
  3433. * </p>
  3434. * @param frombase int <p>
  3435. * The base number is in
  3436. * </p>
  3437. * @param tobase int <p>
  3438. * The base to convert number to
  3439. * </p>
  3440. * @return string number converted to base tobase
  3441. */
  3442. function base_convert ($number, $frombase, $tobase) {}
  3443. /**
  3444. * Format a number with grouped thousands
  3445. * @link http://www.php.net/manual/en/function.number-format.php
  3446. * @param number float <p>
  3447. * The number being formatted.
  3448. * </p>
  3449. * @param decimals int[optional] <p>
  3450. * Sets the number of decimal points.
  3451. * </p>
  3452. * @return string A formatted version of number.
  3453. */
  3454. function number_format ($number, $decimals = null) {}
  3455. /**
  3456. * Returns the floating point remainder (modulo) of the division
  3457. of the arguments
  3458. * @link http://www.php.net/manual/en/function.fmod.php
  3459. * @param x float <p>
  3460. * The dividend
  3461. * </p>
  3462. * @param y float <p>
  3463. * The divisor
  3464. * </p>
  3465. * @return float The floating point remainder of
  3466. * x/y
  3467. */
  3468. function fmod ($x, $y) {}
  3469. /**
  3470. * Converts a packed internet address to a human readable representation
  3471. * @link http://www.php.net/manual/en/function.inet-ntop.php
  3472. * @param in_addr string <p>
  3473. * A 32bit IPv4, or 128bit IPv6 address.
  3474. * </p>
  3475. * @return string a string representation of the address&return.falseforfailure;.
  3476. */
  3477. function inet_ntop ($in_addr) {}
  3478. /**
  3479. * Converts a human readable IP address to its packed in_addr representation
  3480. * @link http://www.php.net/manual/en/function.inet-pton.php
  3481. * @param address string <p>
  3482. * A human readable IPv4 or IPv6 address.
  3483. * </p>
  3484. * @return string the in_addr representation of the given
  3485. * address
  3486. */
  3487. function inet_pton ($address) {}
  3488. /**
  3489. * Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address
  3490. * @link http://www.php.net/manual/en/function.ip2long.php
  3491. * @param ip_address string <p>
  3492. * A standard format address.
  3493. * </p>
  3494. * @return int the IPv4 address or false if ip_address
  3495. * is invalid.
  3496. */
  3497. function ip2long ($ip_address) {}
  3498. /**
  3499. * Converts an (IPv4) Internet network address into a string in Internet standard dotted format
  3500. * @link http://www.php.net/manual/en/function.long2ip.php
  3501. * @param proper_address string <p>
  3502. * A proper address representation.
  3503. * </p>
  3504. * @return string the Internet IP address as a string.
  3505. */
  3506. function long2ip ($proper_address) {}
  3507. /**
  3508. * Gets the value of an environment variable
  3509. * @link http://www.php.net/manual/en/function.getenv.php
  3510. * @param varname string <p>
  3511. * The variable name.
  3512. * </p>
  3513. * @return string the value of the environment variable
  3514. * varname, or false on an error.
  3515. */
  3516. function getenv ($varname) {}
  3517. /**
  3518. * Sets the value of an environment variable
  3519. * @link http://www.php.net/manual/en/function.putenv.php
  3520. * @param setting string <p>
  3521. * The setting, like "FOO=BAR"
  3522. * </p>
  3523. * @return bool Returns true on success or false on failure.
  3524. */
  3525. function putenv ($setting) {}
  3526. /**
  3527. * Gets options from the command line argument list
  3528. * @link http://www.php.net/manual/en/function.getopt.php
  3529. * @param options string Each character in this string will be used as option characters and
  3530. * matched against options passed to the script starting with a single
  3531. * hyphen (-).
  3532. * For example, an option string "x" recognizes an
  3533. * option -x.
  3534. * Only a-z, A-Z and 0-9 are allowed.
  3535. * @param longopts array[optional] An array of options. Each element in this array will be used as option
  3536. * strings and matched against options passed to the script starting with
  3537. * two hyphens (--).
  3538. * For example, an longopts element "opt" recognizes an
  3539. * option --opt.
  3540. * Prior to PHP5.3.0 this parameter was only available on few systems
  3541. * @return array This function will return an array of option / argument pairs or false on
  3542. * failure.
  3543. * </p>
  3544. * <p>
  3545. * The parsing of options will end at the first non-option found, anything
  3546. * that follows is discarded.
  3547. */
  3548. function getopt ($options, array $longopts = null) {}
  3549. /**
  3550. * Gets system load average
  3551. * @link http://www.php.net/manual/en/function.sys-getloadavg.php
  3552. * @return array an array with three samples (last 1, 5 and 15
  3553. * minutes).
  3554. */
  3555. function sys_getloadavg () {}
  3556. /**
  3557. * Return current Unix timestamp with microseconds
  3558. * @link http://www.php.net/manual/en/function.microtime.php
  3559. * @param get_as_float bool[optional] <p>
  3560. * When called without the optional argument, this function returns the string
  3561. * "msec sec" where sec is the current time measured in the number of
  3562. * seconds since the Unix Epoch (0:00:00 January 1, 1970 GMT), and
  3563. * msec is the microseconds part.
  3564. * Both portions of the string are returned in units of seconds.
  3565. * </p>
  3566. * <p>
  3567. * If the optional get_as_float is set to
  3568. * true then a float (in seconds) is returned.
  3569. * </p>
  3570. * @return mixed
  3571. */
  3572. function microtime ($get_as_float = null) {}
  3573. /**
  3574. * Get current time
  3575. * @link http://www.php.net/manual/en/function.gettimeofday.php
  3576. * @param return_float bool[optional] <p>
  3577. * When set to true, a float instead of an array is returned.
  3578. * </p>
  3579. * @return mixed By default an array is returned. If return_float
  3580. * is set, then a float is returned.
  3581. * </p>
  3582. * <p>
  3583. * Array keys:
  3584. * "sec" - seconds since the Unix Epoch
  3585. * "usec" - microseconds
  3586. * "minuteswest" - minutes west of Greenwich
  3587. * "dsttime" - type of dst correction
  3588. */
  3589. function gettimeofday ($return_float = null) {}
  3590. /**
  3591. * Gets the current resource usages
  3592. * @link http://www.php.net/manual/en/function.getrusage.php
  3593. * @param who int[optional] <p>
  3594. * If who is 1, getrusage will be called with
  3595. * RUSAGE_CHILDREN.
  3596. * </p>
  3597. * @return array an associative array containing the data returned from the system
  3598. * call. All entries are accessible by using their documented field names.
  3599. */
  3600. function getrusage ($who = null) {}
  3601. /**
  3602. * Generate a unique ID
  3603. * @link http://www.php.net/manual/en/function.uniqid.php
  3604. * @param prefix string[optional] <p>
  3605. * Can be useful, for instance, if you generate identifiers
  3606. * simultaneously on several hosts that might happen to generate the
  3607. * identifier at the same microsecond.
  3608. * </p>
  3609. * <p>
  3610. * With an empty prefix, the returned string will
  3611. * be 13 characters long. If more_entropy is
  3612. * true, it will be 23 characters.
  3613. * </p>
  3614. * @param more_entropy bool[optional] <p>
  3615. * If set to true, uniqid will add additional
  3616. * entropy (using the combined linear congruential generator) at the end
  3617. * of the return value, which should make the results more unique.
  3618. * </p>
  3619. * @return string the unique identifier, as a string.
  3620. */
  3621. function uniqid ($prefix = null, $more_entropy = null) {}
  3622. /**
  3623. * Convert a quoted-printable string to an 8 bit string
  3624. * @link http://www.php.net/manual/en/function.quoted-printable-decode.php
  3625. * @param str string <p>
  3626. * The input string.
  3627. * </p>
  3628. * @return string the 8-bit binary string.
  3629. */
  3630. function quoted_printable_decode ($str) {}
  3631. /**
  3632. * Convert a 8 bit string to a quoted-printable string
  3633. * @link http://www.php.net/manual/en/function.quoted-printable-encode.php
  3634. * @param str string <p>
  3635. * The input string.
  3636. * </p>
  3637. * @return string the encoded string.
  3638. */
  3639. function quoted_printable_encode ($str) {}
  3640. /**
  3641. * Convert from one Cyrillic character set to another
  3642. * @link http://www.php.net/manual/en/function.convert-cyr-string.php
  3643. * @param str string <p>
  3644. * The string to be converted.
  3645. * </p>
  3646. * @param from string <p>
  3647. * The source Cyrillic character set, as a single character.
  3648. * </p>
  3649. * @param to string <p>
  3650. * The target Cyrillic character set, as a single character.
  3651. * </p>
  3652. * @return string the converted string.
  3653. */
  3654. function convert_cyr_string ($str, $from, $to) {}
  3655. /**
  3656. * Gets the name of the owner of the current PHP script
  3657. * @link http://www.php.net/manual/en/function.get-current-user.php
  3658. * @return string the username as a string.
  3659. */
  3660. function get_current_user () {}
  3661. /**
  3662. * Limits the maximum execution time
  3663. * @link http://www.php.net/manual/en/function.set-time-limit.php
  3664. * @param seconds int <p>
  3665. * The maximum execution time, in seconds. If set to zero, no time limit
  3666. * is imposed.
  3667. * </p>
  3668. * @return void
  3669. */
  3670. function set_time_limit ($seconds) {}
  3671. /**
  3672. * Gets the value of a PHP configuration option
  3673. * @link http://www.php.net/manual/en/function.get-cfg-var.php
  3674. * @param option string <p>
  3675. * The configuration option name.
  3676. * </p>
  3677. * @return string the current value of the PHP configuration variable specified by
  3678. * option, or false if an error occurs.
  3679. */
  3680. function get_cfg_var ($option) {}
  3681. /**
  3682. * &Alias; <function>set_magic_quotes_runtime</function>
  3683. * @link http://www.php.net/manual/en/function.magic-quotes-runtime.php
  3684. * @param new_setting
  3685. * @deprecated Deprecated as of PHP 5.3.0. Relying on this feature is highly discouraged.
  3686. */
  3687. function magic_quotes_runtime ($new_setting) {}
  3688. /**
  3689. * Sets the current active configuration setting of magic_quotes_runtime
  3690. * @link http://www.php.net/manual/en/function.set-magic-quotes-runtime.php
  3691. * @param new_setting bool <p>
  3692. * false for off, true for on.
  3693. * </p>
  3694. * @deprecated Deprecated as of PHP 5.3.0. Relying on this feature is highly discouraged.
  3695. * @return bool Returns true on success or false on failure.
  3696. */
  3697. function set_magic_quotes_runtime ($new_setting) {}
  3698. /**
  3699. * Gets the current configuration setting of magic_quotes_gpc
  3700. * @link http://www.php.net/manual/en/function.get-magic-quotes-gpc.php
  3701. * @return int 0 if magic_quotes_gpc is off, 1 otherwise.
  3702. */
  3703. function get_magic_quotes_gpc () {}
  3704. /**
  3705. * Gets the current active configuration setting of magic_quotes_runtime
  3706. * @link http://www.php.net/manual/en/function.get-magic-quotes-runtime.php
  3707. * @return int 0 if magic_quotes_runtime is off, 1 otherwise.
  3708. */
  3709. function get_magic_quotes_runtime () {}
  3710. /**
  3711. * Import GET/POST/Cookie variables into the global scope
  3712. * @link http://www.php.net/manual/en/function.import-request-variables.php
  3713. * @param types string <p>
  3714. * Using the types parameter, you can specify
  3715. * which request variables to import. You can use 'G', 'P' and 'C'
  3716. * characters respectively for GET, POST and Cookie. These characters are
  3717. * not case sensitive, so you can also use any combination of 'g', 'p'
  3718. * and 'c'. POST includes the POST uploaded file information.
  3719. * </p>
  3720. * <p>
  3721. * Note that the order of the letters matters, as when using
  3722. * "GP", the
  3723. * POST variables will overwrite GET variables with the same name. Any
  3724. * other letters than GPC are discarded.
  3725. * </p>
  3726. * @param prefix string[optional] <p>
  3727. * Variable name prefix, prepended before all variable's name imported
  3728. * into the global scope. So if you have a GET value named
  3729. * "userid", and provide a prefix
  3730. * "pref_", then you'll get a global variable named
  3731. * $pref_userid.
  3732. * </p>
  3733. * <p>
  3734. * Although the prefix parameter is optional, you
  3735. * will get an E_NOTICE level
  3736. * error if you specify no prefix, or specify an empty string as a
  3737. * prefix. This is a possible security hazard. Notice level errors are
  3738. * not displayed using the default error reporting level.
  3739. * </p>
  3740. * @return bool Returns true on success or false on failure.
  3741. */
  3742. function import_request_variables ($types, $prefix = null) {}
  3743. /**
  3744. * Send an error message somewhere
  3745. * @link http://www.php.net/manual/en/function.error-log.php
  3746. * @param message string <p>
  3747. * The error message that should be logged.
  3748. * </p>
  3749. * @param message_type int[optional] <p>
  3750. * Says where the error should go. The possible message types are as
  3751. * follows:
  3752. * </p>
  3753. * <p>
  3754. * <table>
  3755. * error_log log types
  3756. * <tr valign="top">
  3757. * <td>0</td>
  3758. * <td>
  3759. * message is sent to PHP's system logger, using
  3760. * the Operating System's system logging mechanism or a file, depending
  3761. * on what the error_log
  3762. * configuration directive is set to. This is the default option.
  3763. * </td>
  3764. * </tr>
  3765. * <tr valign="top">
  3766. * <td>1</td>
  3767. * <td>
  3768. * message is sent by email to the address in
  3769. * the destination parameter. This is the only
  3770. * message type where the fourth parameter,
  3771. * extra_headers is used.
  3772. * </td>
  3773. * </tr>
  3774. * <tr valign="top">
  3775. * <td>2</td>
  3776. * <td>
  3777. * No longer an option.
  3778. * </td>
  3779. * </tr>
  3780. * <tr valign="top">
  3781. * <td>3</td>
  3782. * <td>
  3783. * message is appended to the file
  3784. * destination. A newline is not automatically
  3785. * added to the end of the message string.
  3786. * </td>
  3787. * </tr>
  3788. * <tr valign="top">
  3789. * <td>4</td>
  3790. * <td>
  3791. * message is sent directly to the SAPI logging
  3792. * handler.
  3793. * </td>
  3794. * </tr>
  3795. * </table>
  3796. * </p>
  3797. * @param destination string[optional] <p>
  3798. * The destination. Its meaning depends on the
  3799. * message_type parameter as described above.
  3800. * </p>
  3801. * @param extra_headers string[optional] <p>
  3802. * The extra headers. It's used when the message_type
  3803. * parameter is set to 1.
  3804. * This message type uses the same internal function as
  3805. * mail does.
  3806. * </p>
  3807. * @return bool Returns true on success or false on failure.
  3808. */
  3809. function error_log ($message, $message_type = null, $destination = null, $extra_headers = null) {}
  3810. /**
  3811. * Get the last occurred error
  3812. * @link http://www.php.net/manual/en/function.error-get-last.php
  3813. * @return array an associative array describing the last error with keys "type",
  3814. * "message", "file" and "line". Returns &null; if there hasn't been an error
  3815. * yet.
  3816. */
  3817. function error_get_last () {}
  3818. /**
  3819. * Call a user function given by the first parameter
  3820. * @link http://www.php.net/manual/en/function.call-user-func.php
  3821. * @param function callback <p>
  3822. * The function to be called. Class methods may also be invoked
  3823. * statically using this function by passing
  3824. * array($classname, $methodname) to this parameter.
  3825. * Additionally class methods of an object instance may be called by passing
  3826. * array($objectinstance, $methodname) to this parameter.
  3827. * </p>
  3828. * @param parameter mixed[optional] <p>
  3829. * Zero or more parameters to be passed to the function.
  3830. * </p>
  3831. * <p>
  3832. * Note that the parameters for call_user_func are
  3833. * not passed by reference.
  3834. * call_user_func example and references
  3835. * ]]>
  3836. * &example.outputs;
  3837. * </p>
  3838. * @param _ mixed[optional]
  3839. * @return mixed the function result, or false on error.
  3840. */
  3841. function call_user_func ($function, $parameter = null, $_ = null) {}
  3842. /**
  3843. * Call a user function given with an array of parameters
  3844. * @link http://www.php.net/manual/en/function.call-user-func-array.php
  3845. * @param function callback <p>
  3846. * The function to be called.
  3847. * </p>
  3848. * @param param_arr array <p>
  3849. * The parameters to be passed to the function, as an indexed array.
  3850. * </p>
  3851. * @return mixed the function result, or false on error.
  3852. */
  3853. function call_user_func_array ($function, array $param_arr) {}
  3854. /**
  3855. * Call a user method on an specific object [deprecated]
  3856. * @link http://www.php.net/manual/en/function.call-user-method.php
  3857. * @param method_name string <p>
  3858. * The method name being called.
  3859. * </p>
  3860. * @param obj object <p>
  3861. * The object that method_name
  3862. * is being called on.
  3863. * </p>
  3864. * @param parameter mixed[optional]
  3865. * @param _ mixed[optional]
  3866. * @deprecated Deprecated as of PHP 4.1.0 (use call_user_func() instead).
  3867. * @return mixed
  3868. */
  3869. function call_user_method ($method_name, &$obj, $parameter = null, $_ = null) {}
  3870. /**
  3871. * Call a user method given with an array of parameters [deprecated]
  3872. * @link http://www.php.net/manual/en/function.call-user-method-array.php
  3873. * @param method_name string <p>
  3874. * The method name being called.
  3875. * </p>
  3876. * @param obj object <p>
  3877. * The object that method_name
  3878. * is being called on.
  3879. * </p>
  3880. * @param params array <p>
  3881. * An array of parameters.
  3882. * </p>
  3883. * @deprecated Deprecated as of PHP 4.1.0 (use call_user_func_array() instead).
  3884. * @return mixed
  3885. */
  3886. function call_user_method_array ($method_name, &$obj, array $params) {}
  3887. /**
  3888. * Call a static method
  3889. * @link http://www.php.net/manual/en/function.forward-static-call.php
  3890. * @param function callback <p>
  3891. * The function or method to be called. This parameter may be an array,
  3892. * with the name of the class, and the method, or a string, with a function
  3893. * name.
  3894. * </p>
  3895. * @param parameter mixed[optional] <p>
  3896. * Zero or more parameters to be passed to the function.
  3897. * </p>
  3898. * @param _ mixed[optional]
  3899. * @return mixed the function result, or false on error.
  3900. */
  3901. function forward_static_call ($function, $parameter = null, $_ = null) {}
  3902. /**
  3903. * Call a static method and pass the arguments as array
  3904. * @link http://www.php.net/manual/en/function.forward-static-call-array.php
  3905. * @param function callback <p>
  3906. * The function or method to be called. This parameter may be an &array;,
  3907. * with the name of the class, and the method, or a &string;, with a function
  3908. * name.
  3909. * </p>
  3910. * @param parameters array[optional]
  3911. * @return mixed the function result, or false on error.
  3912. */
  3913. function forward_static_call_array ($function, array $parameters = null) {}
  3914. /**
  3915. * Generates a storable representation of a value
  3916. * @link http://www.php.net/manual/en/function.serialize.php
  3917. * @param value mixed <p>
  3918. * The value to be serialized. serialize
  3919. * handles all types, except the resource-type.
  3920. * You can even serialize arrays that contain
  3921. * references to itself. Circular references inside the array/object you
  3922. * are serializing will also be stored. Any other
  3923. * reference will be lost.
  3924. * </p>
  3925. * <p>
  3926. * When serializing objects, PHP will attempt to call the member function
  3927. * __sleep prior to serialization.
  3928. * This is to allow the object to do any last minute clean-up, etc. prior
  3929. * to being serialized. Likewise, when the object is restored using
  3930. * unserialize the __wakeup member function is called.
  3931. * </p>
  3932. * <p>
  3933. * Object's private members have the class name prepended to the member
  3934. * name; protected members have a '*' prepended to the member name.
  3935. * These prepended values have null bytes on either side.
  3936. * </p>
  3937. * @return string a string containing a byte-stream representation of
  3938. * value that can be stored anywhere.
  3939. */
  3940. function serialize ($value) {}
  3941. /**
  3942. * Creates a PHP value from a stored representation
  3943. * @link http://www.php.net/manual/en/function.unserialize.php
  3944. * @param str string <p>
  3945. * The serialized string.
  3946. * </p>
  3947. * <p>
  3948. * If the variable being unserialized is an object, after successfully
  3949. * reconstructing the object PHP will automatically attempt to call the
  3950. * __wakeup member function (if it exists).
  3951. * </p>
  3952. * <p>
  3953. * unserialize_callback_func directive
  3954. * <p>
  3955. * It's possible to set a callback-function which will be called,
  3956. * if an undefined class should be instantiated during unserializing.
  3957. * (to prevent getting an incomplete object "__PHP_Incomplete_Class".)
  3958. * Use your &php.ini;, ini_set or &htaccess;
  3959. * to define 'unserialize_callback_func'. Everytime an undefined class
  3960. * should be instantiated, it'll be called. To disable this feature just
  3961. * empty this setting.
  3962. * </p>
  3963. * </p>
  3964. * @return mixed The converted value is returned, and can be a boolean,
  3965. * integer, float, string,
  3966. * array or object.
  3967. * </p>
  3968. * <p>
  3969. * In case the passed string is not unserializeable, false is returned and
  3970. * E_NOTICE is issued.
  3971. */
  3972. function unserialize ($str) {}
  3973. /**
  3974. * Dumps information about a variable
  3975. * @link http://www.php.net/manual/en/function.var-dump.php
  3976. * @param expression mixed <p>
  3977. * The variable you want to export.
  3978. * </p>
  3979. * @param expression mixed[optional]
  3980. * @return void
  3981. */
  3982. function var_dump ($expression, $expression = null) {}
  3983. /**
  3984. * Outputs or returns a parsable string representation of a variable
  3985. * @link http://www.php.net/manual/en/function.var-export.php
  3986. * @param expression mixed <p>
  3987. * The variable you want to export.
  3988. * </p>
  3989. * @param return bool[optional] <p>
  3990. * If used and set to true, var_export will return
  3991. * the variable representation instead of outputing it.
  3992. * </p>
  3993. * &note.uses-ob;
  3994. * @return mixed the variable representation when the return
  3995. * parameter is used and evaluates to true. Otherwise, this function will
  3996. * return &null;.
  3997. */
  3998. function var_export ($expression, $return = null) {}
  3999. /**
  4000. * Dumps a string representation of an internal zend value to output
  4001. * @link http://www.php.net/manual/en/function.debug-zval-dump.php
  4002. * @param variable mixed <p>
  4003. * The variable being evaluated.
  4004. * </p>
  4005. * @return void
  4006. */
  4007. function debug_zval_dump ($variable) {}
  4008. /**
  4009. * Prints human-readable information about a variable
  4010. * @link http://www.php.net/manual/en/function.print-r.php
  4011. * @param expression mixed <p>
  4012. * The expression to be printed.
  4013. * </p>
  4014. * @param return bool[optional] <p>
  4015. * If you would like to capture the output of print_r,
  4016. * use the return parameter. When this parameter is set
  4017. * to true, print_r will return the information rather than print it.
  4018. * </p>
  4019. * @return mixed If given a string, integer or float,
  4020. * the value itself will be printed. If given an array, values
  4021. * will be presented in a format that shows keys and elements. Similar
  4022. * notation is used for objects.
  4023. * </p>
  4024. * <p>
  4025. * When the return parameter is true, this function
  4026. * will return a string. Otherwise, the return value is true.
  4027. */
  4028. function print_r ($expression, $return = null) {}
  4029. /**
  4030. * Returns the amount of memory allocated to PHP
  4031. * @link http://www.php.net/manual/en/function.memory-get-usage.php
  4032. * @param real_usage bool[optional] <p>
  4033. * Set this to true to get the real size of memory allocated from
  4034. * system. If not set or false only the memory used by
  4035. * emalloc() is reported.
  4036. * </p>
  4037. * @return int the memory amount in bytes.
  4038. */
  4039. function memory_get_usage ($real_usage = null) {}
  4040. /**
  4041. * Returns the peak of memory allocated by PHP
  4042. * @link http://www.php.net/manual/en/function.memory-get-peak-usage.php
  4043. * @param real_usage bool[optional] <p>
  4044. * Set this to true to get the real size of memory allocated from
  4045. * system. If not set or false only the memory used by
  4046. * emalloc() is reported.
  4047. * </p>
  4048. * @return int the memory peak in bytes.
  4049. */
  4050. function memory_get_peak_usage ($real_usage = null) {}
  4051. /**
  4052. * Register a function for execution on shutdown
  4053. * @link http://www.php.net/manual/en/function.register-shutdown-function.php
  4054. * @param function callback <p>
  4055. * The shutdown function to register.
  4056. * </p>
  4057. * <p>
  4058. * The shutdown functions are called as the part of the request so that
  4059. * it's possible to send the output from them. There is currently no way
  4060. * to process the data with output buffering functions in the shutdown
  4061. * function.
  4062. * </p>
  4063. * <p>
  4064. * Shutdown functions are called after closing all opened output buffers
  4065. * thus, for example, its output will not be compressed if zlib.output_compression is
  4066. * enabled.
  4067. * </p>
  4068. * @param parameter mixed[optional] <p>
  4069. * It is possible to pass parameters to the shutdown function by passing
  4070. * additional parameters.
  4071. * </p>
  4072. * @param _ mixed[optional]
  4073. * @return void
  4074. */
  4075. function register_shutdown_function ($function, $parameter = null, $_ = null) {}
  4076. /**
  4077. * Register a function for execution on each tick
  4078. * @link http://www.php.net/manual/en/function.register-tick-function.php
  4079. * @param function callback <p>
  4080. * The function name as a string, or an array consisting of an object and
  4081. * a method.
  4082. * </p>
  4083. * @param arg mixed[optional] <p>
  4084. * </p>
  4085. * @param _ mixed[optional]
  4086. * @return bool Returns true on success or false on failure.
  4087. */
  4088. function register_tick_function ($function, $arg = null, $_ = null) {}
  4089. /**
  4090. * De-register a function for execution on each tick
  4091. * @link http://www.php.net/manual/en/function.unregister-tick-function.php
  4092. * @param function_name string <p>
  4093. * The function name, as a string.
  4094. * </p>
  4095. * @return void
  4096. */
  4097. function unregister_tick_function ($function_name) {}
  4098. /**
  4099. * Syntax highlighting of a file
  4100. * @link http://www.php.net/manual/en/function.highlight-file.php
  4101. * @param filename string <p>
  4102. * Path to the PHP file to be highlighted.
  4103. * </p>
  4104. * @param return bool[optional] <p>
  4105. * Set this parameter to true to make this function return the
  4106. * highlighted code.
  4107. * </p>
  4108. * @return mixed If return is set to true, returns the highlighted
  4109. * code as a string instead of printing it out. Otherwise, it will return
  4110. * true on success, false on failure.
  4111. */
  4112. function highlight_file ($filename, $return = null) {}
  4113. /**
  4114. * &Alias; <function>highlight_file</function>
  4115. * @link http://www.php.net/manual/en/function.show-source.php
  4116. * @param file_name
  4117. * @param return[optional]
  4118. */
  4119. function show_source ($file_name, $return) {}
  4120. /**
  4121. * Syntax highlighting of a string
  4122. * @link http://www.php.net/manual/en/function.highlight-string.php
  4123. * @param str string <p>
  4124. * The PHP code to be highlighted. This should include the opening tag.
  4125. * </p>
  4126. * @param return bool[optional] <p>
  4127. * Set this parameter to true to make this function return the
  4128. * highlighted code.
  4129. * </p>
  4130. * @return mixed If return is set to true, returns the highlighted
  4131. * code as a string instead of printing it out. Otherwise, it will return
  4132. * true on success, false on failure.
  4133. */
  4134. function highlight_string ($str, $return = null) {}
  4135. /**
  4136. * Return source with stripped comments and whitespace
  4137. * @link http://www.php.net/manual/en/function.php-strip-whitespace.php
  4138. * @param filename string <p>
  4139. * Path to the PHP file.
  4140. * </p>
  4141. * @return string The stripped source code will be returned on success, or an empty string
  4142. * on failure.
  4143. * </p>
  4144. * <p>
  4145. * This function works as described as of PHP 5.0.1. Before this it would
  4146. * only return an empty string. For more information on this bug and its
  4147. * prior behavior, see bug report
  4148. * #29606.
  4149. */
  4150. function php_strip_whitespace ($filename) {}
  4151. /**
  4152. * Gets the value of a configuration option
  4153. * @link http://www.php.net/manual/en/function.ini-get.php
  4154. * @param varname string <p>
  4155. * The configuration option name.
  4156. * </p>
  4157. * @return string the value of the configuration option as a string on success, or
  4158. * an empty string on failure or for null values.
  4159. */
  4160. function ini_get ($varname) {}
  4161. /**
  4162. * Gets all configuration options
  4163. * @link http://www.php.net/manual/en/function.ini-get-all.php
  4164. * @param extension string[optional] <p>
  4165. * An optional extension name. If set, the function return only options
  4166. * specific for that extension.
  4167. * </p>
  4168. * @param details bool[optional] <p>
  4169. * Retrieve details settings or only the current value for each setting.
  4170. * Default is true (retrieve details).
  4171. * </p>
  4172. * @return array an associative array with directive name as the array key.
  4173. * </p>
  4174. * <p>
  4175. * When details is true (default) the array will
  4176. * contain global_value (set in
  4177. * &php.ini;), local_value (perhaps set with
  4178. * ini_set or &htaccess;), and
  4179. * access (the access level).
  4180. * </p>
  4181. * <p>
  4182. * When details is false the value will be the
  4183. * current value of the option.
  4184. * </p>
  4185. * <p>
  4186. * See the manual section
  4187. * for information on what access levels mean.
  4188. * </p>
  4189. * <p>
  4190. * It's possible for a directive to have multiple access levels, which is
  4191. * why access shows the appropriate bitmask values.
  4192. */
  4193. function ini_get_all ($extension = null, $details = null) {}
  4194. /**
  4195. * Sets the value of a configuration option
  4196. * @link http://www.php.net/manual/en/function.ini-set.php
  4197. * @param varname string <p>
  4198. * </p>
  4199. * <p>
  4200. * Not all the available options can be changed using
  4201. * ini_set. There is a list of all available options
  4202. * in the appendix.
  4203. * </p>
  4204. * @param newvalue string <p>
  4205. * The new value for the option.
  4206. * </p>
  4207. * @return string the old value on success, false on failure.
  4208. */
  4209. function ini_set ($varname, $newvalue) {}
  4210. /**
  4211. * &Alias; <function>ini_set</function>
  4212. * @link http://www.php.net/manual/en/function.ini-alter.php
  4213. * @param varname
  4214. * @param newvalue
  4215. */
  4216. function ini_alter ($varname, $newvalue) {}
  4217. /**
  4218. * Restores the value of a configuration option
  4219. * @link http://www.php.net/manual/en/function.ini-restore.php
  4220. * @param varname string <p>
  4221. * The configuration option name.
  4222. * </p>
  4223. * @return void
  4224. */
  4225. function ini_restore ($varname) {}
  4226. /**
  4227. * Gets the current include_path configuration option
  4228. * @link http://www.php.net/manual/en/function.get-include-path.php
  4229. * @return string the path, as a string.
  4230. */
  4231. function get_include_path () {}
  4232. /**
  4233. * Sets the include_path configuration option
  4234. * @link http://www.php.net/manual/en/function.set-include-path.php
  4235. * @param new_include_path string <p>
  4236. * The new value for the include_path
  4237. * </p>
  4238. * @return string the old include_path on
  4239. * success&return.falseforfailure;.
  4240. */
  4241. function set_include_path ($new_include_path) {}
  4242. /**
  4243. * Restores the value of the include_path configuration option
  4244. * @link http://www.php.net/manual/en/function.restore-include-path.php
  4245. * @return void
  4246. */
  4247. function restore_include_path () {}
  4248. /**
  4249. * Send a cookie
  4250. * @link http://www.php.net/manual/en/function.setcookie.php
  4251. * @param name string <p>
  4252. * The name of the cookie.
  4253. * </p>
  4254. * @param value string[optional] <p>
  4255. * The value of the cookie. This value is stored on the clients
  4256. * computer; do not store sensitive information.
  4257. * Assuming the name is 'cookiename', this
  4258. * value is retrieved through $_COOKIE['cookiename']
  4259. * </p>
  4260. * @param expire int[optional] <p>
  4261. * The time the cookie expires. This is a Unix timestamp so is
  4262. * in number of seconds since the epoch. In other words, you'll
  4263. * most likely set this with the time function
  4264. * plus the number of seconds before you want it to expire. Or
  4265. * you might use mktime.
  4266. * time()+60*60*24*30 will set the cookie to
  4267. * expire in 30 days. If set to 0, or omitted, the cookie will expire at
  4268. * the end of the session (when the browser closes).
  4269. * </p>
  4270. * <p>
  4271. * <p>
  4272. * You may notice the expire parameter takes on a
  4273. * Unix timestamp, as opposed to the date format Wdy, DD-Mon-YYYY
  4274. * HH:MM:SS GMT, this is because PHP does this conversion
  4275. * internally.
  4276. * </p>
  4277. * <p>
  4278. * expire is compared to the client's time which can
  4279. * differ from server's time.
  4280. * </p>
  4281. * </p>
  4282. * @param path string[optional] <p>
  4283. * The path on the server in which the cookie will be available on.
  4284. * If set to '/', the cookie will be available
  4285. * within the entire domain. If set to
  4286. * '/foo/', the cookie will only be available
  4287. * within the /foo/ directory and all
  4288. * sub-directories such as /foo/bar/ of
  4289. * domain. The default value is the
  4290. * current directory that the cookie is being set in.
  4291. * </p>
  4292. * @param domain string[optional] <p>
  4293. * The domain that the cookie is available.
  4294. * To make the cookie available on all subdomains of example.com
  4295. * then you'd set it to '.example.com'. The
  4296. * . is not required but makes it compatible
  4297. * with more browsers. Setting it to www.example.com
  4298. * will make the cookie only available in the www
  4299. * subdomain. Refer to tail matching in the
  4300. * spec for details.
  4301. * </p>
  4302. * @param secure bool[optional] <p>
  4303. * Indicates that the cookie should only be transmitted over a
  4304. * secure HTTPS connection from the client. When set to true, the
  4305. * cookie will only be set if a secure connection exists.
  4306. * On the server-side, it's on the programmer to send this
  4307. * kind of cookie only on secure connection (e.g. with respect to
  4308. * $_SERVER["HTTPS"]).
  4309. * </p>
  4310. * @param httponly bool[optional] <p>
  4311. * When true the cookie will be made accessible only through the HTTP
  4312. * protocol. This means that the cookie won't be accessible by
  4313. * scripting languages, such as JavaScript. This setting can effectively
  4314. * help to reduce identity theft through XSS attacks (although it is
  4315. * not supported by all browsers). Added in PHP 5.2.0.
  4316. * true or false
  4317. * </p>
  4318. * @return bool If output exists prior to calling this function,
  4319. * setcookie will fail and return false. If
  4320. * setcookie successfully runs, it will return true.
  4321. * This does not indicate whether the user accepted the cookie.
  4322. */
  4323. function setcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  4324. /**
  4325. * Send a cookie without urlencoding the cookie value
  4326. * @link http://www.php.net/manual/en/function.setrawcookie.php
  4327. * @param name string
  4328. * @param value string[optional]
  4329. * @param expire int[optional]
  4330. * @param path string[optional]
  4331. * @param domain string[optional]
  4332. * @param secure bool[optional]
  4333. * @param httponly bool[optional]
  4334. * @return bool Returns true on success or false on failure.
  4335. */
  4336. function setrawcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  4337. /**
  4338. * Send a raw HTTP header
  4339. * @link http://www.php.net/manual/en/function.header.php
  4340. * @param string string <p>
  4341. * The header string.
  4342. * </p>
  4343. * <p>
  4344. * There are two special-case header calls. The first is a header
  4345. * that starts with the string "HTTP/" (case is not
  4346. * significant), which will be used to figure out the HTTP status
  4347. * code to send. For example, if you have configured Apache to
  4348. * use a PHP script to handle requests for missing files (using
  4349. * the ErrorDocument directive), you may want to
  4350. * make sure that your script generates the proper status code.
  4351. * </p>
  4352. * <p>
  4353. * ]]>
  4354. * </p>
  4355. * <p>
  4356. * The second special case is the "Location:" header. Not only does
  4357. * it send this header back to the browser, but it also returns a
  4358. * REDIRECT (302) status code to the browser
  4359. * unless the 201 or
  4360. * a 3xx status code has already been set.
  4361. * </p>
  4362. * <p>
  4363. * ]]>
  4364. * </p>
  4365. * @param replace bool[optional] <p>
  4366. * The optional replace parameter indicates
  4367. * whether the header should replace a previous similar header, or
  4368. * add a second header of the same type. By default it will replace,
  4369. * but if you pass in false as the second argument you can force
  4370. * multiple headers of the same type. For example:
  4371. * </p>
  4372. * <p>
  4373. * ]]>
  4374. * </p>
  4375. * @param http_response_code int[optional] <p>
  4376. * Forces the HTTP response code to the specified value.
  4377. * </p>
  4378. * @return void
  4379. */
  4380. function header ($string, $replace = null, $http_response_code = null) {}
  4381. /**
  4382. * Remove previously set headers
  4383. * @link http://www.php.net/manual/en/function.header-remove.php
  4384. * @param name string[optional] <p>
  4385. * The header name to be removed.
  4386. * </p>
  4387. * This parameter is case-insensitive.
  4388. * @return void
  4389. */
  4390. function header_remove ($name = null) {}
  4391. /**
  4392. * Checks if or where headers have been sent
  4393. * @link http://www.php.net/manual/en/function.headers-sent.php
  4394. * @param file string[optional] <p>
  4395. * If the optional file and
  4396. * line parameters are set,
  4397. * headers_sent will put the PHP source file name
  4398. * and line number where output started in the file
  4399. * and line variables.
  4400. * </p>
  4401. * @param line int[optional] <p>
  4402. * The line number where the output started.
  4403. * </p>
  4404. * @return bool headers_sent will return false if no HTTP headers
  4405. * have already been sent or true otherwise.
  4406. */
  4407. function headers_sent (&$file = null, &$line = null) {}
  4408. /**
  4409. * Returns a list of response headers sent (or ready to send)
  4410. * @link http://www.php.net/manual/en/function.headers-list.php
  4411. * @return array a numerically indexed array of headers.
  4412. */
  4413. function headers_list () {}
  4414. /**
  4415. * Check whether client disconnected
  4416. * @link http://www.php.net/manual/en/function.connection-aborted.php
  4417. * @return int 1 if client disconnected, 0 otherwise.
  4418. */
  4419. function connection_aborted () {}
  4420. /**
  4421. * Returns connection status bitfield
  4422. * @link http://www.php.net/manual/en/function.connection-status.php
  4423. * @return int the connection status bitfield, which can be used against the
  4424. * CONNECTION_XXX constants to determine the connection
  4425. * status.
  4426. */
  4427. function connection_status () {}
  4428. /**
  4429. * Set whether a client disconnect should abort script execution
  4430. * @link http://www.php.net/manual/en/function.ignore-user-abort.php
  4431. * @param value string[optional] <p>
  4432. * If set, this function will set the ignore_user_abort ini setting
  4433. * to the given value. If not, this function will
  4434. * only return the previous setting without changing it.
  4435. * </p>
  4436. * @return int the previous setting, as an integer.
  4437. */
  4438. function ignore_user_abort ($value = null) {}
  4439. /**
  4440. * Parse a configuration file
  4441. * @link http://www.php.net/manual/en/function.parse-ini-file.php
  4442. * @param filename string <p>
  4443. * The filename of the ini file being parsed.
  4444. * </p>
  4445. * @param process_sections bool[optional] <p>
  4446. * By setting the process_sections
  4447. * parameter to true, you get a multidimensional array, with
  4448. * the section names and settings included. The default
  4449. * for process_sections is false
  4450. * </p>
  4451. * @param scanner_mode int[optional] <p>
  4452. * Can either be INI_SCANNER_NORMAL (default) or
  4453. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  4454. * is supplied, then option values will not be parsed.
  4455. * </p>
  4456. * @return array The settings are returned as an associative array on success,
  4457. * and false on failure.
  4458. */
  4459. function parse_ini_file ($filename, $process_sections = null, $scanner_mode = null) {}
  4460. /**
  4461. * Parse a configuration string
  4462. * @link http://www.php.net/manual/en/function.parse-ini-string.php
  4463. * @param ini string <p>
  4464. * The contents of the ini file being parsed.
  4465. * </p>
  4466. * @param process_sections bool[optional] <p>
  4467. * By setting the process_sections
  4468. * parameter to true, you get a multidimensional array, with
  4469. * the section names and settings included. The default
  4470. * for process_sections is false
  4471. * </p>
  4472. * @param scanner_mode int[optional] <p>
  4473. * Can either be INI_SCANNER_NORMAL (default) or
  4474. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  4475. * is supplied, then option values will not be parsed.
  4476. * </p>
  4477. * @return array The settings are returned as an associative array on success,
  4478. * and false on failure.
  4479. */
  4480. function parse_ini_string ($ini, $process_sections = null, $scanner_mode = null) {}
  4481. /**
  4482. * Tells whether the file was uploaded via HTTP POST
  4483. * @link http://www.php.net/manual/en/function.is-uploaded-file.php
  4484. * @param filename string <p>
  4485. * The filename being checked.
  4486. * </p>
  4487. * @return bool Returns true on success or false on failure.
  4488. */
  4489. function is_uploaded_file ($filename) {}
  4490. /**
  4491. * Moves an uploaded file to a new location
  4492. * @link http://www.php.net/manual/en/function.move-uploaded-file.php
  4493. * @param filename string <p>
  4494. * The filename of the uploaded file.
  4495. * </p>
  4496. * @param destination string <p>
  4497. * The destination of the moved file.
  4498. * </p>
  4499. * @return bool If filename is not a valid upload file,
  4500. * then no action will occur, and
  4501. * move_uploaded_file will return
  4502. * false.
  4503. * </p>
  4504. * <p>
  4505. * If filename is a valid upload file, but
  4506. * cannot be moved for some reason, no action will occur, and
  4507. * move_uploaded_file will return
  4508. * false. Additionally, a warning will be issued.
  4509. */
  4510. function move_uploaded_file ($filename, $destination) {}
  4511. /**
  4512. * Get the Internet host name corresponding to a given IP address
  4513. * @link http://www.php.net/manual/en/function.gethostbyaddr.php
  4514. * @param ip_address string <p>
  4515. * The host IP address.
  4516. * </p>
  4517. * @return string the host name or the unmodified ip_address
  4518. * on failure.
  4519. */
  4520. function gethostbyaddr ($ip_address) {}
  4521. /**
  4522. * Get the IPv4 address corresponding to a given Internet host name
  4523. * @link http://www.php.net/manual/en/function.gethostbyname.php
  4524. * @param hostname string <p>
  4525. * The host name.
  4526. * </p>
  4527. * @return string the IPv4 address or a string containing the unmodified
  4528. * hostname on failure.
  4529. */
  4530. function gethostbyname ($hostname) {}
  4531. /**
  4532. * Get a list of IPv4 addresses corresponding to a given Internet host
  4533. name
  4534. * @link http://www.php.net/manual/en/function.gethostbynamel.php
  4535. * @param hostname string <p>
  4536. * The host name.
  4537. * </p>
  4538. * @return array an array of IPv4 addresses or false if
  4539. * hostname could not be resolved.
  4540. */
  4541. function gethostbynamel ($hostname) {}
  4542. /**
  4543. * Gets the host name
  4544. * @link http://www.php.net/manual/en/function.gethostname.php
  4545. * @return string a string with the hostname on success, otherwise false is
  4546. * returned.
  4547. */
  4548. function gethostname () {}
  4549. /**
  4550. * &Alias; <function>checkdnsrr</function>
  4551. * @link http://www.php.net/manual/en/function.dns-check-record.php
  4552. * @param host
  4553. * @param type[optional]
  4554. */
  4555. function dns_check_record ($host, $type) {}
  4556. /**
  4557. * Check DNS records corresponding to a given Internet host name or IP address
  4558. * @link http://www.php.net/manual/en/function.checkdnsrr.php
  4559. * @param host string <p>
  4560. * host may either be the IP address in
  4561. * dotted-quad notation or the host name.
  4562. * </p>
  4563. * @param type string[optional] <p>
  4564. * type may be any one of: A, MX, NS, SOA,
  4565. * PTR, CNAME, AAAA, A6, SRV, NAPTR, TXT or ANY.
  4566. * </p>
  4567. * @return bool true if any records are found; returns false if no records
  4568. * were found or if an error occurred.
  4569. */
  4570. function checkdnsrr ($host, $type = null) {}
  4571. /**
  4572. * &Alias; <function>getmxrr</function>
  4573. * @link http://www.php.net/manual/en/function.dns-get-mx.php
  4574. * @param hostname
  4575. * @param mxhosts
  4576. * @param weight[optional]
  4577. */
  4578. function dns_get_mx ($hostname, &$mxhosts, &$weight) {}
  4579. /**
  4580. * Get MX records corresponding to a given Internet host name
  4581. * @link http://www.php.net/manual/en/function.getmxrr.php
  4582. * @param hostname string <p>
  4583. * The Internet host name.
  4584. * </p>
  4585. * @param mxhosts array <p>
  4586. * A list of the MX records found is placed into the array
  4587. * mxhosts.
  4588. * </p>
  4589. * @param weight array[optional] <p>
  4590. * If the weight array is given, it will be filled
  4591. * with the weight information gathered.
  4592. * </p>
  4593. * @return bool true if any records are found; returns false if no records
  4594. * were found or if an error occurred.
  4595. */
  4596. function getmxrr ($hostname, array &$mxhosts, array &$weight = null) {}
  4597. /**
  4598. * Fetch DNS Resource Records associated with a hostname
  4599. * @link http://www.php.net/manual/en/function.dns-get-record.php
  4600. * @param hostname string <p>
  4601. * hostname should be a valid DNS hostname such
  4602. * as "www.example.com". Reverse lookups can be generated
  4603. * using in-addr.arpa notation, but
  4604. * gethostbyaddr is more suitable for
  4605. * the majority of reverse lookups.
  4606. * </p>
  4607. * <p>
  4608. * Per DNS standards, email addresses are given in user.host format (for
  4609. * example: hostmaster.example.com as opposed to hostmaster@example.com),
  4610. * be sure to check this value and modify if necessary before using it
  4611. * with a functions such as mail.
  4612. * </p>
  4613. * @param type int[optional] <p>
  4614. * By default, dns_get_record will search for any
  4615. * resource records associated with hostname.
  4616. * To limit the query, specify the optional type
  4617. * parameter. May be any one of the following:
  4618. * DNS_A, DNS_CNAME,
  4619. * DNS_HINFO, DNS_MX,
  4620. * DNS_NS, DNS_PTR,
  4621. * DNS_SOA, DNS_TXT,
  4622. * DNS_AAAA, DNS_SRV,
  4623. * DNS_NAPTR, DNS_A6,
  4624. * DNS_ALL or DNS_ANY.
  4625. * </p>
  4626. * <p>
  4627. * Because of eccentricities in the performance of libresolv
  4628. * between platforms, DNS_ANY will not
  4629. * always return every record, the slower DNS_ALL
  4630. * will collect all records more reliably.
  4631. * </p>
  4632. * @param authns array[optional] <p>
  4633. * Passed by reference and, if given, will be populated with Resource
  4634. * Records for the Authoritative Name Servers.
  4635. * </p>
  4636. * @param addtl array[optional] <p>
  4637. * Passed by reference and, if given, will be populated with any
  4638. * Additional Records.
  4639. * </p>
  4640. * @return array This function returns an array of associative arrays. Each associative array contains
  4641. * at minimum the following keys:
  4642. * <table>
  4643. * Basic DNS attributes
  4644. * <tr valign="top">
  4645. * <td>Attribute</td>
  4646. * <td>Meaning</td>
  4647. * </tr>
  4648. * <tr valign="top">
  4649. * <td>host</td>
  4650. * <td>
  4651. * The record in the DNS namespace to which the rest of the associated data refers.
  4652. * </td>
  4653. * </tr>
  4654. * <tr valign="top">
  4655. * <td>class</td>
  4656. * <td>
  4657. * dns_get_record only returns Internet class records and as
  4658. * such this parameter will always return IN.
  4659. * </td>
  4660. * </tr>
  4661. * <tr valign="top">
  4662. * <td>type</td>
  4663. * <td>
  4664. * String containing the record type. Additional attributes will also be contained
  4665. * in the resulting array dependant on the value of type. See table below.
  4666. * </td>
  4667. * </tr>
  4668. * <tr valign="top">
  4669. * <td>ttl</td>
  4670. * <td>
  4671. * "Time To Live" remaining for this record. This will not equal
  4672. * the record's original ttl, but will rather equal the original ttl minus whatever
  4673. * length of time has passed since the authoritative name server was queried.
  4674. * </td>
  4675. * </tr>
  4676. * </table>
  4677. * </p>
  4678. * <p>
  4679. * <table>
  4680. * Other keys in associative arrays dependant on 'type'
  4681. * <tr valign="top">
  4682. * <td>Type</td>
  4683. * <td>Extra Columns</td>
  4684. * </tr>
  4685. * <tr valign="top">
  4686. * <td>A</td>
  4687. * <td>
  4688. * ip: An IPv4 addresses in dotted decimal notation.
  4689. * </td>
  4690. * </tr>
  4691. * <tr valign="top">
  4692. * <td>MX</td>
  4693. * <td>
  4694. * pri: Priority of mail exchanger.
  4695. * Lower numbers indicate greater priority.
  4696. * target: FQDN of the mail exchanger.
  4697. * See also dns_get_mx.
  4698. * </td>
  4699. * </tr>
  4700. * <tr valign="top">
  4701. * <td>CNAME</td>
  4702. * <td>
  4703. * target: FQDN of location in DNS namespace to which
  4704. * the record is aliased.
  4705. * </td>
  4706. * </tr>
  4707. * <tr valign="top">
  4708. * <td>NS</td>
  4709. * <td>
  4710. * target: FQDN of the name server which is authoritative
  4711. * for this hostname.
  4712. * </td>
  4713. * </tr>
  4714. * <tr valign="top">
  4715. * <td>PTR</td>
  4716. * <td>
  4717. * target: Location within the DNS namespace to which
  4718. * this record points.
  4719. * </td>
  4720. * </tr>
  4721. * <tr valign="top">
  4722. * <td>TXT</td>
  4723. * <td>
  4724. * txt: Arbitrary string data associated with this record.
  4725. * </td>
  4726. * </tr>
  4727. * <tr valign="top">
  4728. * <td>HINFO</td>
  4729. * <td>
  4730. * cpu: IANA number designating the CPU of the machine
  4731. * referenced by this record.
  4732. * os: IANA number designating the Operating System on
  4733. * the machine referenced by this record.
  4734. * See IANA's Operating System
  4735. * Names for the meaning of these values.
  4736. * </td>
  4737. * </tr>
  4738. * <tr valign="top">
  4739. * <td>SOA</td>
  4740. * <td>
  4741. * mname: FQDN of the machine from which the resource
  4742. * records originated.
  4743. * rname: Email address of the administrative contain
  4744. * for this domain.
  4745. * serial: Serial # of this revision of the requested
  4746. * domain.
  4747. * refresh: Refresh interval (seconds) secondary name
  4748. * servers should use when updating remote copies of this domain.
  4749. * retry: Length of time (seconds) to wait after a
  4750. * failed refresh before making a second attempt.
  4751. * expire: Maximum length of time (seconds) a secondary
  4752. * DNS server should retain remote copies of the zone data without a
  4753. * successful refresh before discarding.
  4754. * minimum-ttl: Minimum length of time (seconds) a
  4755. * client can continue to use a DNS resolution before it should request
  4756. * a new resolution from the server. Can be overridden by individual
  4757. * resource records.
  4758. * </td>
  4759. * </tr>
  4760. * <tr valign="top">
  4761. * <td>AAAA</td>
  4762. * <td>
  4763. * ipv6: IPv6 address
  4764. * </td>
  4765. * </tr>
  4766. * <tr valign="top">
  4767. * <td>A6(PHP &gt;= 5.1.0)</td>
  4768. * <td>
  4769. * masklen: Length (in bits) to inherit from the target
  4770. * specified by chain.
  4771. * ipv6: Address for this specific record to merge with
  4772. * chain.
  4773. * chain: Parent record to merge with
  4774. * ipv6 data.
  4775. * </td>
  4776. * </tr>
  4777. * <tr valign="top">
  4778. * <td>SRV</td>
  4779. * <td>
  4780. * pri: (Priority) lowest priorities should be used first.
  4781. * weight: Ranking to weight which of commonly prioritized
  4782. * targets should be chosen at random.
  4783. * target and port: hostname and port
  4784. * where the requested service can be found.
  4785. * For additional information see: RFC 2782
  4786. * </td>
  4787. * </tr>
  4788. * <tr valign="top">
  4789. * <td>NAPTR</td>
  4790. * <td>
  4791. * order and pref: Equivalent to
  4792. * pri and weight above.
  4793. * flags, services, regex,
  4794. * and replacement: Parameters as defined by
  4795. * RFC 2915.
  4796. * </td>
  4797. * </tr>
  4798. * </table>
  4799. */
  4800. function dns_get_record ($hostname, $type = null, array &$authns = null, array &$addtl = null) {}
  4801. /**
  4802. * Get the integer value of a variable
  4803. * @link http://www.php.net/manual/en/function.intval.php
  4804. * @param var mixed <p>
  4805. * The scalar value being converted to an integer
  4806. * </p>
  4807. * @param base int[optional] <p>
  4808. * The base for the conversion
  4809. * </p>
  4810. * @return int The integer value of var on success, or 0 on
  4811. * failure. Empty arrays and objects return 0, non-empty arrays and
  4812. * objects return 1.
  4813. * </p>
  4814. * <p>
  4815. * The maximum value depends on the system. 32 bit systems have a
  4816. * maximum signed integer range of -2147483648 to 2147483647. So for example
  4817. * on such a system, intval('1000000000000') will return
  4818. * 2147483647. The maximum signed integer value for 64 bit systems is
  4819. * 9223372036854775807.
  4820. * </p>
  4821. * <p>
  4822. * Strings will most likely return 0 although this depends on the
  4823. * leftmost characters of the string. The common rules of
  4824. * integer casting
  4825. * apply.
  4826. */
  4827. function intval ($var, $base = null) {}
  4828. /**
  4829. * Get float value of a variable
  4830. * @link http://www.php.net/manual/en/function.floatval.php
  4831. * @param var mixed <p>
  4832. * May be any scalar type. floatval should not be used
  4833. * on objects, as doing so will emit an E_NOTICE level
  4834. * error and return 1.
  4835. * </p>
  4836. * @return float The float value of the given variable. Empty arrays return 0, non-empty
  4837. * arrays return 1.
  4838. */
  4839. function floatval ($var) {}
  4840. /**
  4841. * &Alias; <function>floatval</function>
  4842. * @link http://www.php.net/manual/en/function.doubleval.php
  4843. * @param var
  4844. */
  4845. function doubleval ($var) {}
  4846. /**
  4847. * Get string value of a variable
  4848. * @link http://www.php.net/manual/en/function.strval.php
  4849. * @param var mixed <p>
  4850. * The variable that is being converted to a string.
  4851. * </p>
  4852. * <p>
  4853. * var may be any scalar type. You cannot use
  4854. * strval on arrays or objects.
  4855. * </p>
  4856. * @return string The string value of var.
  4857. */
  4858. function strval ($var) {}
  4859. /**
  4860. * Get the type of a variable
  4861. * @link http://www.php.net/manual/en/function.gettype.php
  4862. * @param var mixed <p>
  4863. * The variable being type checked.
  4864. * </p>
  4865. * @return string Possibles values for the returned string are:
  4866. * "boolean"
  4867. * "integer"
  4868. * "double" (for historical reasons "double" is
  4869. * returned in case of a float, and not simply
  4870. * "float")
  4871. * "string"
  4872. * "array"
  4873. * "object"
  4874. * "resource"
  4875. * "NULL"
  4876. * "unknown type"
  4877. */
  4878. function gettype ($var) {}
  4879. /**
  4880. * Set the type of a variable
  4881. * @link http://www.php.net/manual/en/function.settype.php
  4882. * @param var mixed <p>
  4883. * The variable being converted.
  4884. * </p>
  4885. * @param type string <p>
  4886. * Possibles values of type are:
  4887. * "boolean" (or, since PHP 4.2.0, "bool")
  4888. * @return bool Returns true on success or false on failure.
  4889. */
  4890. function settype (&$var, $type) {}
  4891. /**
  4892. * Finds whether a variable is &null;
  4893. * @link http://www.php.net/manual/en/function.is-null.php
  4894. * @param var mixed <p>
  4895. * The variable being evaluated.
  4896. * </p>
  4897. * @return bool true if var is null, false
  4898. * otherwise.
  4899. */
  4900. function is_null ($var) {}
  4901. /**
  4902. * Finds whether a variable is a resource
  4903. * @link http://www.php.net/manual/en/function.is-resource.php
  4904. * @param var mixed <p>
  4905. * The variable being evaluated.
  4906. * </p>
  4907. * @return bool true if var is a resource,
  4908. * false otherwise.
  4909. */
  4910. function is_resource ($var) {}
  4911. /**
  4912. * Finds out whether a variable is a boolean
  4913. * @link http://www.php.net/manual/en/function.is-bool.php
  4914. * @param var mixed <p>
  4915. * The variable being evaluated.
  4916. * </p>
  4917. * @return bool true if var is a boolean,
  4918. * false otherwise.
  4919. */
  4920. function is_bool ($var) {}
  4921. /**
  4922. * &Alias; <function>is_int</function>
  4923. * @link http://www.php.net/manual/en/function.is-long.php
  4924. * @param var
  4925. */
  4926. function is_long ($var) {}
  4927. /**
  4928. * Finds whether the type of a variable is float
  4929. * @link http://www.php.net/manual/en/function.is-float.php
  4930. * @param var mixed <p>
  4931. * The variable being evaluated.
  4932. * </p>
  4933. * @return bool true if var is a float,
  4934. * false otherwise.
  4935. */
  4936. function is_float ($var) {}
  4937. /**
  4938. * Find whether the type of a variable is integer
  4939. * @link http://www.php.net/manual/en/function.is-int.php
  4940. * @param var mixed <p>
  4941. * The variable being evaluated.
  4942. * </p>
  4943. * @return bool true if var is an integer,
  4944. * false otherwise.
  4945. */
  4946. function is_int ($var) {}
  4947. /**
  4948. * &Alias; <function>is_int</function>
  4949. * @link http://www.php.net/manual/en/function.is-integer.php
  4950. * @param var
  4951. */
  4952. function is_integer ($var) {}
  4953. /**
  4954. * &Alias; <function>is_float</function>
  4955. * @link http://www.php.net/manual/en/function.is-double.php
  4956. * @param var
  4957. */
  4958. function is_double ($var) {}
  4959. /**
  4960. * &Alias; <function>is_float</function>
  4961. * @link http://www.php.net/manual/en/function.is-real.php
  4962. * @param var
  4963. */
  4964. function is_real ($var) {}
  4965. /**
  4966. * Finds whether a variable is a number or a numeric string
  4967. * @link http://www.php.net/manual/en/function.is-numeric.php
  4968. * @param var mixed <p>
  4969. * The variable being evaluated.
  4970. * </p>
  4971. * @return bool true if var is a number or a numeric
  4972. * string, false otherwise.
  4973. */
  4974. function is_numeric ($var) {}
  4975. /**
  4976. * Find whether the type of a variable is string
  4977. * @link http://www.php.net/manual/en/function.is-string.php
  4978. * @param var mixed <p>
  4979. * The variable being evaluated.
  4980. * </p>
  4981. * @return bool true if var is of type string,
  4982. * false otherwise.
  4983. */
  4984. function is_string ($var) {}
  4985. /**
  4986. * Finds whether a variable is an array
  4987. * @link http://www.php.net/manual/en/function.is-array.php
  4988. * @param var mixed <p>
  4989. * The variable being evaluated.
  4990. * </p>
  4991. * @return bool true if var is an array,
  4992. * false otherwise.
  4993. */
  4994. function is_array ($var) {}
  4995. /**
  4996. * Finds whether a variable is an object
  4997. * @link http://www.php.net/manual/en/function.is-object.php
  4998. * @param var mixed <p>
  4999. * The variable being evaluated.
  5000. * </p>
  5001. * @return bool true if var is an object,
  5002. * false otherwise.
  5003. */
  5004. function is_object ($var) {}
  5005. /**
  5006. * Finds whether a variable is a scalar
  5007. * @link http://www.php.net/manual/en/function.is-scalar.php
  5008. * @param var mixed <p>
  5009. * The variable being evaluated.
  5010. * </p>
  5011. * @return bool true if var is a scalar false
  5012. * otherwise.
  5013. */
  5014. function is_scalar ($var) {}
  5015. /**
  5016. * Verify that the contents of a variable can be called as a function
  5017. * @link http://www.php.net/manual/en/function.is-callable.php
  5018. * @param name callback <p>
  5019. * Can be either the name of a function stored in a string variable, or
  5020. * an object and the name of a method within the object, like this:
  5021. * array($SomeObject, 'MethodName')
  5022. * </p>
  5023. * @param syntax_only bool[optional] <p>
  5024. * If set to true the function only verifies that
  5025. * name might be a function or method. It will only
  5026. * reject simple variables that are not strings, or an array that does
  5027. * not have a valid structure to be used as a callback. The valid ones
  5028. * are supposed to have only 2 entries, the first of which is an object
  5029. * or a string, and the second a string.
  5030. * </p>
  5031. * @param callable_name string[optional] <p>
  5032. * Receives the "callable name". In the example below it is
  5033. * "someClass::someMethod". Note, however, that despite the implication
  5034. * that someClass::SomeMethod() is a callable static method, this is not
  5035. * the case.
  5036. * </p>
  5037. * @return bool true if name is callable, false
  5038. * otherwise.
  5039. */
  5040. function is_callable ($name, $syntax_only = null, &$callable_name = null) {}
  5041. /**
  5042. * Closes process file pointer
  5043. * @link http://www.php.net/manual/en/function.pclose.php
  5044. * @param handle resource <p>
  5045. * The file pointer must be valid, and must have been returned by a
  5046. * successful call to popen.
  5047. * </p>
  5048. * @return int the termination status of the process that was run.
  5049. */
  5050. function pclose ($handle) {}
  5051. /**
  5052. * Opens process file pointer
  5053. * @link http://www.php.net/manual/en/function.popen.php
  5054. * @param command string <p>
  5055. * The command
  5056. * </p>
  5057. * @param mode string <p>
  5058. * The mode
  5059. * </p>
  5060. * @return resource a file pointer identical to that returned by
  5061. * fopen, except that it is unidirectional (may
  5062. * only be used for reading or writing) and must be closed with
  5063. * pclose. This pointer may be used with
  5064. * fgets, fgetss, and
  5065. * fwrite.
  5066. * </p>
  5067. * <p>
  5068. * If an error occurs, returns false.
  5069. */
  5070. function popen ($command, $mode) {}
  5071. /**
  5072. * Outputs a file
  5073. * @link http://www.php.net/manual/en/function.readfile.php
  5074. * @param filename string <p>
  5075. * The filename being read.
  5076. * </p>
  5077. * @param use_include_path bool[optional] <p>
  5078. * You can use the optional second parameter and set it to true, if
  5079. * you want to search for the file in the include_path, too.
  5080. * </p>
  5081. * @param context resource[optional] <p>
  5082. * A context stream resource.
  5083. * </p>
  5084. * @return int the number of bytes read from the file. If an error
  5085. * occurs, false is returned and unless the function was called as
  5086. * @readfile, an error message is printed.
  5087. */
  5088. function readfile ($filename, $use_include_path = null, $context = null) {}
  5089. /**
  5090. * Rewind the position of a file pointer
  5091. * @link http://www.php.net/manual/en/function.rewind.php
  5092. * @param handle resource <p>
  5093. * The file pointer must be valid, and must point to a file
  5094. * successfully opened by fopen.
  5095. * </p>
  5096. * @return bool Returns true on success or false on failure.
  5097. */
  5098. function rewind ($handle) {}
  5099. /**
  5100. * Removes directory
  5101. * @link http://www.php.net/manual/en/function.rmdir.php
  5102. * @param dirname string <p>
  5103. * Path to the directory.
  5104. * </p>
  5105. * @param context resource[optional] &note.context-support;
  5106. * @return bool Returns true on success or false on failure.
  5107. */
  5108. function rmdir ($dirname, $context = null) {}
  5109. /**
  5110. * Changes the current umask
  5111. * @link http://www.php.net/manual/en/function.umask.php
  5112. * @param mask int[optional] <p>
  5113. * The new umask.
  5114. * </p>
  5115. * @return int umask without arguments simply returns the
  5116. * current umask otherwise the old umask is returned.
  5117. */
  5118. function umask ($mask = null) {}
  5119. /**
  5120. * Closes an open file pointer
  5121. * @link http://www.php.net/manual/en/function.fclose.php
  5122. * @param handle resource <p>
  5123. * The file pointer must be valid, and must point to a file successfully
  5124. * opened by fopen or fsockopen.
  5125. * </p>
  5126. * @return bool Returns true on success or false on failure.
  5127. */
  5128. function fclose ($handle) {}
  5129. /**
  5130. * Tests for end-of-file on a file pointer
  5131. * @link http://www.php.net/manual/en/function.feof.php
  5132. * @param handle resource &fs.validfp.all;
  5133. * @return bool true if the file pointer is at EOF or an error occurs
  5134. * (including socket timeout); otherwise returns false.
  5135. */
  5136. function feof ($handle) {}
  5137. /**
  5138. * Gets character from file pointer
  5139. * @link http://www.php.net/manual/en/function.fgetc.php
  5140. * @param handle resource &fs.validfp.all;
  5141. * @return string a string containing a single character read from the file pointed
  5142. * to by handle. Returns false on EOF.
  5143. */
  5144. function fgetc ($handle) {}
  5145. /**
  5146. * Gets line from file pointer
  5147. * @link http://www.php.net/manual/en/function.fgets.php
  5148. * @param handle resource &fs.validfp.all;
  5149. * @param length int[optional] <p>
  5150. * Reading ends when length - 1 bytes have been
  5151. * read, on a newline (which is included in the return value), or on EOF
  5152. * (whichever comes first). If no length is specified, it will keep
  5153. * reading from the stream until it reaches the end of the line.
  5154. * </p>
  5155. * <p>
  5156. * Until PHP 4.3.0, omitting it would assume 1024 as the line length.
  5157. * If the majority of the lines in the file are all larger than 8KB,
  5158. * it is more resource efficient for your script to specify the maximum
  5159. * line length.
  5160. * </p>
  5161. * @return string a string of up to length - 1 bytes read from
  5162. * the file pointed to by handle.
  5163. * </p>
  5164. * <p>
  5165. * If an error occurs, returns false.
  5166. */
  5167. function fgets ($handle, $length = null) {}
  5168. /**
  5169. * Gets line from file pointer and strip HTML tags
  5170. * @link http://www.php.net/manual/en/function.fgetss.php
  5171. * @param handle resource &fs.validfp.all;
  5172. * @param length int[optional] <p>
  5173. * Length of the data to be retrieved.
  5174. * </p>
  5175. * @param allowable_tags string[optional] <p>
  5176. * You can use the optional third parameter to specify tags which should
  5177. * not be stripped.
  5178. * </p>
  5179. * @return string a string of up to length - 1 bytes read from
  5180. * the file pointed to by handle, with all HTML and PHP
  5181. * code stripped.
  5182. * </p>
  5183. * <p>
  5184. * If an error occurs, returns false.
  5185. */
  5186. function fgetss ($handle, $length = null, $allowable_tags = null) {}
  5187. /**
  5188. * Binary-safe file read
  5189. * @link http://www.php.net/manual/en/function.fread.php
  5190. * @param handle resource &fs.file.pointer;
  5191. * @param length int <p>
  5192. * Up to length number of bytes read.
  5193. * </p>
  5194. * @return string the read string &return.falseforfailure;.
  5195. */
  5196. function fread ($handle, $length) {}
  5197. /**
  5198. * Opens file or URL
  5199. * @link http://www.php.net/manual/en/function.fopen.php
  5200. * @param filename string <p>
  5201. * If filename is of the form "scheme://...", it
  5202. * is assumed to be a URL and PHP will search for a protocol handler
  5203. * (also known as a wrapper) for that scheme. If no wrappers for that
  5204. * protocol are registered, PHP will emit a notice to help you track
  5205. * potential problems in your script and then continue as though
  5206. * filename specifies a regular file.
  5207. * </p>
  5208. * <p>
  5209. * If PHP has decided that filename specifies
  5210. * a local file, then it will try to open a stream on that file.
  5211. * The file must be accessible to PHP, so you need to ensure that
  5212. * the file access permissions allow this access.
  5213. * If you have enabled &safemode;,
  5214. * or open_basedir further
  5215. * restrictions may apply.
  5216. * </p>
  5217. * <p>
  5218. * If PHP has decided that filename specifies
  5219. * a registered protocol, and that protocol is registered as a
  5220. * network URL, PHP will check to make sure that
  5221. * allow_url_fopen is
  5222. * enabled. If it is switched off, PHP will emit a warning and
  5223. * the fopen call will fail.
  5224. * </p>
  5225. * <p>
  5226. * The list of supported protocols can be found in . Some protocols (also referred to as
  5227. * wrappers) support context
  5228. * and/or &php.ini; options. Refer to the specific page for the
  5229. * protocol in use for a list of options which can be set. (e.g.
  5230. * &php.ini; value user_agent used by the
  5231. * http wrapper).
  5232. * </p>
  5233. * <p>
  5234. * On the Windows platform, be careful to escape any backslashes
  5235. * used in the path to the file, or use forward slashes.
  5236. * ]]>
  5237. * </p>
  5238. * @param mode string <p>
  5239. * The mode parameter specifies the type of access
  5240. * you require to the stream. It may be any of the following:
  5241. * <table>
  5242. * A list of possible modes for fopen
  5243. * using mode
  5244. * <tr valign="top">
  5245. * <td>mode</td>
  5246. * <td>Description</td>
  5247. * </tr>
  5248. * <tr valign="top">
  5249. * <td>'r'</td>
  5250. * <td>
  5251. * Open for reading only; place the file pointer at the
  5252. * beginning of the file.
  5253. * </td>
  5254. * </tr>
  5255. * <tr valign="top">
  5256. * <td>'r+'</td>
  5257. * <td>
  5258. * Open for reading and writing; place the file pointer at
  5259. * the beginning of the file.
  5260. * </td>
  5261. * </tr>
  5262. * <tr valign="top">
  5263. * <td>'w'</td>
  5264. * <td>
  5265. * Open for writing only; place the file pointer at the
  5266. * beginning of the file and truncate the file to zero length.
  5267. * If the file does not exist, attempt to create it.
  5268. * </td>
  5269. * </tr>
  5270. * <tr valign="top">
  5271. * <td>'w+'</td>
  5272. * <td>
  5273. * Open for reading and writing; place the file pointer at
  5274. * the beginning of the file and truncate the file to zero
  5275. * length. If the file does not exist, attempt to create it.
  5276. * </td>
  5277. * </tr>
  5278. * <tr valign="top">
  5279. * <td>'a'</td>
  5280. * <td>
  5281. * Open for writing only; place the file pointer at the end of
  5282. * the file. If the file does not exist, attempt to create it.
  5283. * </td>
  5284. * </tr>
  5285. * <tr valign="top">
  5286. * <td>'a+'</td>
  5287. * <td>
  5288. * Open for reading and writing; place the file pointer at
  5289. * the end of the file. If the file does not exist, attempt to
  5290. * create it.
  5291. * </td>
  5292. * </tr>
  5293. * <tr valign="top">
  5294. * <td>'x'</td>
  5295. * <td>
  5296. * Create and open for writing only; place the file pointer at the
  5297. * beginning of the file. If the file already exists, the
  5298. * fopen call will fail by returning false and
  5299. * generating an error of level E_WARNING. If
  5300. * the file does not exist, attempt to create it. This is equivalent
  5301. * to specifying O_EXCL|O_CREAT flags for the
  5302. * underlying open(2) system call.
  5303. * </td>
  5304. * </tr>
  5305. * <tr valign="top">
  5306. * <td>'x+'</td>
  5307. * <td>
  5308. * Create and open for reading and writing; place the file pointer at
  5309. * the beginning of the file. If the file already exists, the
  5310. * fopen call will fail by returning false and
  5311. * generating an error of level E_WARNING. If
  5312. * the file does not exist, attempt to create it. This is equivalent
  5313. * to specifying O_EXCL|O_CREAT flags for the
  5314. * underlying open(2) system call.
  5315. * </td>
  5316. * </tr>
  5317. * </table>
  5318. * </p>
  5319. * <p>
  5320. * Different operating system families have different line-ending
  5321. * conventions. When you write a text file and want to insert a line
  5322. * break, you need to use the correct line-ending character(s) for your
  5323. * operating system. Unix based systems use \n as the
  5324. * line ending character, Windows based systems use \r\n
  5325. * as the line ending characters and Macintosh based systems use
  5326. * \r as the line ending character.
  5327. * </p>
  5328. * <p>
  5329. * If you use the wrong line ending characters when writing your files, you
  5330. * might find that other applications that open those files will "look
  5331. * funny".
  5332. * </p>
  5333. * <p>
  5334. * Windows offers a text-mode translation flag ('t')
  5335. * which will transparently translate \n to
  5336. * \r\n when working with the file. In contrast, you
  5337. * can also use 'b' to force binary mode, which will not
  5338. * translate your data. To use these flags, specify either
  5339. * 'b' or 't' as the last character
  5340. * of the mode parameter.
  5341. * </p>
  5342. * <p>
  5343. * The default translation mode depends on the SAPI and version of PHP that
  5344. * you are using, so you are encouraged to always specify the appropriate
  5345. * flag for portability reasons. You should use the 't'
  5346. * mode if you are working with plain-text files and you use
  5347. * \n to delimit your line endings in your script, but
  5348. * expect your files to be readable with applications such as notepad. You
  5349. * should use the 'b' in all other cases.
  5350. * </p>
  5351. * <p>
  5352. * If you do not specify the 'b' flag when working with binary files, you
  5353. * may experience strange problems with your data, including broken image
  5354. * files and strange problems with \r\n characters.
  5355. * </p>
  5356. * <p>
  5357. * For portability, it is strongly recommended that you always
  5358. * use the 'b' flag when opening files with fopen.
  5359. * </p>
  5360. * <p>
  5361. * Again, for portability, it is also strongly recommended that
  5362. * you re-write code that uses or relies upon the 't'
  5363. * mode so that it uses the correct line endings and
  5364. * 'b' mode instead.
  5365. * </p>
  5366. * @param use_include_path bool[optional] <p>
  5367. * The optional third use_include_path parameter
  5368. * can be set to '1' or true if you want to search for the file in the
  5369. * include_path, too.
  5370. * </p>
  5371. * @param context resource[optional] &note.context-support;
  5372. * @return resource a file pointer resource on success, or false on error.
  5373. */
  5374. function fopen ($filename, $mode, $use_include_path = null, $context = null) {}
  5375. /**
  5376. * Output all remaining data on a file pointer
  5377. * @link http://www.php.net/manual/en/function.fpassthru.php
  5378. * @param handle resource &fs.validfp.all;
  5379. * @return int If an error occurs, fpassthru returns
  5380. * false. Otherwise, fpassthru returns
  5381. * the number of characters read from handle
  5382. * and passed through to the output.
  5383. */
  5384. function fpassthru ($handle) {}
  5385. /**
  5386. * Truncates a file to a given length
  5387. * @link http://www.php.net/manual/en/function.ftruncate.php
  5388. * @param handle resource <p>
  5389. * The file pointer.
  5390. * </p>
  5391. * <p>
  5392. * The handle must be open for writing.
  5393. * </p>
  5394. * @param size int <p>
  5395. * The size to truncate to.
  5396. * </p>
  5397. * <p>
  5398. * If size is larger than the file it is extended
  5399. * with null bytes.
  5400. * </p>
  5401. * <p>
  5402. * If size is smaller than the extra data
  5403. * will be lost.
  5404. * </p>
  5405. * @return bool Returns true on success or false on failure.
  5406. */
  5407. function ftruncate ($handle, $size) {}
  5408. /**
  5409. * Gets information about a file using an open file pointer
  5410. * @link http://www.php.net/manual/en/function.fstat.php
  5411. * @param handle resource &fs.file.pointer;
  5412. * @return array an array with the statistics of the file; the format of the array
  5413. * is described in detail on the stat manual page.
  5414. */
  5415. function fstat ($handle) {}
  5416. /**
  5417. * Seeks on a file pointer
  5418. * @link http://www.php.net/manual/en/function.fseek.php
  5419. * @param handle resource &fs.file.pointer;
  5420. * @param offset int <p>
  5421. * The offset.
  5422. * </p>
  5423. * <p>
  5424. * To move to a position before the end-of-file, you need to pass
  5425. * a negative value in offset and
  5426. * set whence
  5427. * to SEEK_END.
  5428. * </p>
  5429. * @param whence int[optional] <p>
  5430. * whence values are:
  5431. * SEEK_SET - Set position equal to offset bytes.
  5432. * SEEK_CUR - Set position to current location plus offset.
  5433. * SEEK_END - Set position to end-of-file plus offset.
  5434. * </p>
  5435. * @return int Upon success, returns 0; otherwise, returns -1. Note that seeking
  5436. * past EOF is not considered an error.
  5437. */
  5438. function fseek ($handle, $offset, $whence = null) {}
  5439. /**
  5440. * Returns the current position of the file read/write pointer
  5441. * @link http://www.php.net/manual/en/function.ftell.php
  5442. * @param handle resource <p>
  5443. * The file pointer must be valid, and must point to a file successfully
  5444. * opened by fopen or popen.
  5445. * ftell gives undefined results for append-only streams
  5446. * (opened with "a" flag).
  5447. * </p>
  5448. * @return int the position of the file pointer referenced by
  5449. * handle as an integer; i.e., its offset into the file stream.
  5450. * </p>
  5451. * <p>
  5452. * If an error occurs, returns false.
  5453. */
  5454. function ftell ($handle) {}
  5455. /**
  5456. * Flushes the output to a file
  5457. * @link http://www.php.net/manual/en/function.fflush.php
  5458. * @param handle resource &fs.validfp.all;
  5459. * @return bool Returns true on success or false on failure.
  5460. */
  5461. function fflush ($handle) {}
  5462. /**
  5463. * Binary-safe file write
  5464. * @link http://www.php.net/manual/en/function.fwrite.php
  5465. * @param handle resource &fs.file.pointer;
  5466. * @param string string <p>
  5467. * The string that is to be written.
  5468. * </p>
  5469. * @param length int[optional] <p>
  5470. * If the length argument is given, writing will
  5471. * stop after length bytes have been written or
  5472. * the end of string is reached, whichever comes
  5473. * first.
  5474. * </p>
  5475. * <p>
  5476. * Note that if the length argument is given,
  5477. * then the magic_quotes_runtime
  5478. * configuration option will be ignored and no slashes will be
  5479. * stripped from string.
  5480. * </p>
  5481. * @return int
  5482. */
  5483. function fwrite ($handle, $string, $length = null) {}
  5484. /**
  5485. * &Alias; <function>fwrite</function>
  5486. * @link http://www.php.net/manual/en/function.fputs.php
  5487. * @param fp
  5488. * @param str
  5489. * @param length[optional]
  5490. */
  5491. function fputs ($fp, $str, $length) {}
  5492. /**
  5493. * Makes directory
  5494. * @link http://www.php.net/manual/en/function.mkdir.php
  5495. * @param pathname string <p>
  5496. * The directory path.
  5497. * </p>
  5498. * @param mode int[optional] <p>
  5499. * The mode is 0777 by default, which means the widest possible
  5500. * access. For more information on modes, read the details
  5501. * on the chmod page.
  5502. * </p>
  5503. * <p>
  5504. * mode is ignored on Windows.
  5505. * </p>
  5506. * <p>
  5507. * Note that you probably want to specify the mode as an octal number,
  5508. * which means it should have a leading zero. The mode is also modified
  5509. * by the current umask, which you can change using
  5510. * umask.
  5511. * </p>
  5512. * @param recursive bool[optional] <p>
  5513. * Allows the creation of nested directories specified in the
  5514. * pathname. Defaults to false.
  5515. * </p>
  5516. * @param context resource[optional] &note.context-support;
  5517. * @return bool Returns true on success or false on failure.
  5518. */
  5519. function mkdir ($pathname, $mode = null, $recursive = null, $context = null) {}
  5520. /**
  5521. * Renames a file or directory
  5522. * @link http://www.php.net/manual/en/function.rename.php
  5523. * @param oldname string <p>
  5524. * </p>
  5525. * <p>
  5526. * The old name. The wrapper used in oldname
  5527. * must match the wrapper used in
  5528. * newname.
  5529. * </p>
  5530. * @param newname string <p>
  5531. * The new name.
  5532. * </p>
  5533. * @param context resource[optional] &note.context-support;
  5534. * @return bool Returns true on success or false on failure.
  5535. */
  5536. function rename ($oldname, $newname, $context = null) {}
  5537. /**
  5538. * Copies file
  5539. * @link http://www.php.net/manual/en/function.copy.php
  5540. * @param source string <p>
  5541. * Path to the source file.
  5542. * </p>
  5543. * @param dest string <p>
  5544. * The destination path. If dest is a URL, the
  5545. * copy operation may fail if the wrapper does not support overwriting of
  5546. * existing files.
  5547. * </p>
  5548. * <p>
  5549. * If the destination file already exists, it will be overwritten.
  5550. * </p>
  5551. * @param context resource[optional] <p>
  5552. * A valid context resource created with
  5553. * stream_context_create.
  5554. * </p>
  5555. * @return bool Returns true on success or false on failure.
  5556. */
  5557. function copy ($source, $dest, $context = null) {}
  5558. /**
  5559. * Create file with unique file name
  5560. * @link http://www.php.net/manual/en/function.tempnam.php
  5561. * @param dir string <p>
  5562. * The directory where the temporary filename will be created.
  5563. * </p>
  5564. * @param prefix string <p>
  5565. * The prefix of the generated temporary filename.
  5566. * </p>
  5567. * Windows uses only the first three characters of prefix.
  5568. * @return string the new temporary filename, or false on
  5569. * failure.
  5570. */
  5571. function tempnam ($dir, $prefix) {}
  5572. /**
  5573. * Creates a temporary file
  5574. * @link http://www.php.net/manual/en/function.tmpfile.php
  5575. * @return resource a file handle, similar to the one returned by
  5576. * fopen, for the new file&return.falseforfailure;.
  5577. */
  5578. function tmpfile () {}
  5579. /**
  5580. * Reads entire file into an array
  5581. * @link http://www.php.net/manual/en/function.file.php
  5582. * @param filename string <p>
  5583. * Path to the file.
  5584. * </p>
  5585. * &tip.fopen-wrapper;
  5586. * @param flags int[optional] <p>
  5587. * The optional parameter flags can be one, or
  5588. * more, of the following constants:
  5589. * FILE_USE_INCLUDE_PATH
  5590. * Search for the file in the include_path.
  5591. * @param context resource[optional] <p>
  5592. * A context resource created with the
  5593. * stream_context_create function.
  5594. * </p>
  5595. * <p>
  5596. * &note.context-support;
  5597. * </p>
  5598. * @return array the file in an array. Each element of the array corresponds to a
  5599. * line in the file, with the newline still attached. Upon failure,
  5600. * file returns false.
  5601. * </p>
  5602. * <p>
  5603. * Each line in the resulting array will include the line ending, unless
  5604. * FILE_IGNORE_NEW_LINES is used, so you still need to
  5605. * use rtrim if you do not want the line ending
  5606. * present.
  5607. */
  5608. function file ($filename, $flags = null, $context = null) {}
  5609. /**
  5610. * Reads entire file into a string
  5611. * @link http://www.php.net/manual/en/function.file-get-contents.php
  5612. * @param filename string <p>
  5613. * Name of the file to read.
  5614. * </p>
  5615. * @param use_include_path bool[optional] <p>
  5616. * As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
  5617. * to trigger include path
  5618. * search.
  5619. * </p>
  5620. * @param context resource[optional] <p>
  5621. * A valid context resource created with
  5622. * stream_context_create. If you don't need to use a
  5623. * custom context, you can skip this parameter by &null;.
  5624. * </p>
  5625. * @param offset int[optional] <p>
  5626. * The offset where the reading starts on the original stream.
  5627. * </p>
  5628. * @param maxlen int[optional] <p>
  5629. * Maximum length of data read. The default is to read until end
  5630. * of file is reached. Note that this parameter is applied to the
  5631. * stream processed by the filters.
  5632. * </p>
  5633. * @return string The function returns the read data&return.falseforfailure;.
  5634. */
  5635. function file_get_contents ($filename, $use_include_path = null, $context = null, $offset = null, $maxlen = null) {}
  5636. /**
  5637. * Write a string to a file
  5638. * @link http://www.php.net/manual/en/function.file-put-contents.php
  5639. * @param filename string <p>
  5640. * Path to the file where to write the data.
  5641. * </p>
  5642. * @param data mixed <p>
  5643. * The data to write. Can be either a string, an
  5644. * array or a stream resource.
  5645. * </p>
  5646. * <p>
  5647. * If data is a stream resource, the
  5648. * remaining buffer of that stream will be copied to the specified file.
  5649. * This is similar with using stream_copy_to_stream.
  5650. * </p>
  5651. * <p>
  5652. * You can also specify the data parameter as a single
  5653. * dimension array. This is equivalent to
  5654. * file_put_contents($filename, implode('', $array)).
  5655. * </p>
  5656. * @param flags int[optional] <p>
  5657. * The value of flags can be any combination of
  5658. * the following flags (with some restrictions), joined with the binary OR
  5659. * (|) operator.
  5660. * </p>
  5661. * <p>
  5662. * <table>
  5663. * Available flags
  5664. * <tr valign="top">
  5665. * <td>Flag</td>
  5666. * <td>Description</td>
  5667. * </tr>
  5668. * <tr valign="top">
  5669. * <td>
  5670. * FILE_USE_INCLUDE_PATH
  5671. * </td>
  5672. * <td>
  5673. * Search for filename in the include directory.
  5674. * See include_path for more
  5675. * information.
  5676. * </td>
  5677. * </tr>
  5678. * <tr valign="top">
  5679. * <td>
  5680. * FILE_APPEND
  5681. * </td>
  5682. * <td>
  5683. * If file filename already exists, append
  5684. * the data to the file instead of overwriting it. Mutually
  5685. * exclusive with LOCK_EX since appends are atomic and thus there
  5686. * is no reason to lock.
  5687. * </td>
  5688. * </tr>
  5689. * <tr valign="top">
  5690. * <td>
  5691. * LOCK_EX
  5692. * </td>
  5693. * <td>
  5694. * Acquire an exclusive lock on the file while proceeding to the
  5695. * writing. Mutually exclusive with FILE_APPEND.
  5696. * </td>
  5697. * </tr>
  5698. * </table>
  5699. * </p>
  5700. * @param context resource[optional] <p>
  5701. * A valid context resource created with
  5702. * stream_context_create.
  5703. * </p>
  5704. * @return int The function returns the number of bytes that were written to the file, or
  5705. * false on failure.
  5706. */
  5707. function file_put_contents ($filename, $data, $flags = null, $context = null) {}
  5708. /**
  5709. * Runs the equivalent of the select() system call on the given
  5710. arrays of streams with a timeout specified by tv_sec and tv_usec
  5711. * @link http://www.php.net/manual/en/function.stream-select.php
  5712. * @param read array <p>
  5713. * The streams listed in the read array will be watched to
  5714. * see if characters become available for reading (more precisely, to see if
  5715. * a read will not block - in particular, a stream resource is also ready on
  5716. * end-of-file, in which case an fread will return
  5717. * a zero length string).
  5718. * </p>
  5719. * @param write array <p>
  5720. * The streams listed in the write array will be
  5721. * watched to see if a write will not block.
  5722. * </p>
  5723. * @param except array <p>
  5724. * The streams listed in the except array will be
  5725. * watched for high priority exceptional ("out-of-band") data arriving.
  5726. * </p>
  5727. * <p>
  5728. * When stream_select returns, the arrays
  5729. * read, write and
  5730. * except are modified to indicate which stream
  5731. * resource(s) actually changed status.
  5732. * </p>
  5733. * You do not need to pass every array to
  5734. * stream_select. You can leave it out and use an
  5735. * empty array or &null; instead. Also do not forget that those arrays are
  5736. * passed by reference and will be modified after
  5737. * stream_select returns.
  5738. * @param tv_sec int <p>
  5739. * The tv_sec and tv_usec
  5740. * together form the timeout parameter,
  5741. * tv_sec specifies the number of seconds while
  5742. * tv_usec the number of microseconds.
  5743. * The timeout is an upper bound on the amount of time
  5744. * that stream_select will wait before it returns.
  5745. * If tv_sec and tv_usec are
  5746. * both set to 0, stream_select will
  5747. * not wait for data - instead it will return immediately, indicating the
  5748. * current status of the streams.
  5749. * </p>
  5750. * <p>
  5751. * If tv_sec is &null; stream_select
  5752. * can block indefinitely, returning only when an event on one of the
  5753. * watched streams occurs (or if a signal interrupts the system call).
  5754. * </p>
  5755. * <p>
  5756. * Using a timeout value of 0 allows you to
  5757. * instantaneously poll the status of the streams, however, it is NOT a
  5758. * good idea to use a 0 timeout value in a loop as it
  5759. * will cause your script to consume too much CPU time.
  5760. * </p>
  5761. * <p>
  5762. * It is much better to specify a timeout value of a few seconds, although
  5763. * if you need to be checking and running other code concurrently, using a
  5764. * timeout value of at least 200000 microseconds will
  5765. * help reduce the CPU usage of your script.
  5766. * </p>
  5767. * <p>
  5768. * Remember that the timeout value is the maximum time that will elapse;
  5769. * stream_select will return as soon as the
  5770. * requested streams are ready for use.
  5771. * </p>
  5772. * @param tv_usec int[optional] <p>
  5773. * See tv_sec description.
  5774. * </p>
  5775. * @return int On success stream_select returns the number of
  5776. * stream resources contained in the modified arrays, which may be zero if
  5777. * the timeout expires before anything interesting happens. On error false
  5778. * is returned and a warning raised (this can happen if the system call is
  5779. * interrupted by an incoming signal).
  5780. */
  5781. function stream_select (array &$read, array &$write, array &$except, $tv_sec, $tv_usec = null) {}
  5782. /**
  5783. * Create a streams context
  5784. * @link http://www.php.net/manual/en/function.stream-context-create.php
  5785. * @param options array[optional] <p>
  5786. * Must be an associative array of associative arrays in the format
  5787. * $arr['wrapper']['option'] = $value.
  5788. * </p>
  5789. * <p>
  5790. * Default to an empty array.
  5791. * </p>
  5792. * @param params array[optional] <p>
  5793. * Must be an associative array in the format
  5794. * $arr['parameter'] = $value.
  5795. * Refer to context parameters for
  5796. * a listing of standard stream parameters.
  5797. * </p>
  5798. * @return resource A stream context resource.
  5799. */
  5800. function stream_context_create (array $options = null, array $params = null) {}
  5801. /**
  5802. * Set parameters for a stream/wrapper/context
  5803. * @link http://www.php.net/manual/en/function.stream-context-set-params.php
  5804. * @param stream_or_context resource <p>
  5805. * The stream or context to apply the parameters too.
  5806. * </p>
  5807. * @param params array <p>
  5808. * An array of parameters to set.
  5809. * </p>
  5810. * <p>
  5811. * params should be an associative array of the structure:
  5812. * $params['paramname'] = "paramvalue";.
  5813. * </p>
  5814. * @return bool Returns true on success or false on failure.
  5815. */
  5816. function stream_context_set_params ($stream_or_context, array $params) {}
  5817. /**
  5818. * Retrieves parameters from a context
  5819. * @link http://www.php.net/manual/en/function.stream-context-get-params.php
  5820. * @param stream_or_context resource <p>
  5821. * A stream resource or a
  5822. * context resource
  5823. * </p>
  5824. * @return array an associate array containing all context options and parameters.
  5825. */
  5826. function stream_context_get_params ($stream_or_context) {}
  5827. /**
  5828. * Sets an option for a stream/wrapper/context
  5829. * @link http://www.php.net/manual/en/function.stream-context-set-option.php
  5830. * @param stream_or_context resource <p>
  5831. * The stream or context resource to apply the options too.
  5832. * </p>
  5833. * @param wrapper string
  5834. * @param option string
  5835. * @param value mixed
  5836. * @return bool Returns true on success or false on failure.
  5837. */
  5838. function stream_context_set_option ($stream_or_context, $wrapper, $option, $value) {}
  5839. /**
  5840. * Retrieve options for a stream/wrapper/context
  5841. * @link http://www.php.net/manual/en/function.stream-context-get-options.php
  5842. * @param stream_or_context resource <p>
  5843. * The stream or context to get options from
  5844. * </p>
  5845. * @return array an associative array with the options.
  5846. */
  5847. function stream_context_get_options ($stream_or_context) {}
  5848. /**
  5849. * Retreive the default streams context
  5850. * @link http://www.php.net/manual/en/function.stream-context-get-default.php
  5851. * @param options array[optional] options must be an associative
  5852. * array of associative arrays in the format
  5853. * $arr['wrapper']['option'] = $value.
  5854. * <p>
  5855. * As of PHP 5.3.0, the stream_context_set_default function
  5856. * can be used to set the default context.
  5857. * </p>
  5858. * @return resource A stream context resource.
  5859. */
  5860. function stream_context_get_default (array $options = null) {}
  5861. /**
  5862. * Set the default streams context
  5863. * @link http://www.php.net/manual/en/function.stream-context-set-default.php
  5864. * @param options array <p>
  5865. * The options to set for the default context.
  5866. * </p>
  5867. * <p>
  5868. * options must be an associative
  5869. * array of associative arrays in the format
  5870. * $arr['wrapper']['option'] = $value.
  5871. * </p>
  5872. * @return resource the default stream context.
  5873. */
  5874. function stream_context_set_default (array $options) {}
  5875. /**
  5876. * Attach a filter to a stream
  5877. * @link http://www.php.net/manual/en/function.stream-filter-prepend.php
  5878. * @param stream resource <p>
  5879. * The target stream.
  5880. * </p>
  5881. * @param filtername string <p>
  5882. * The filter name.
  5883. * </p>
  5884. * @param read_write int[optional] <p>
  5885. * By default, stream_filter_prepend will
  5886. * attach the filter to the read filter chain
  5887. * if the file was opened for reading (i.e. File Mode:
  5888. * r, and/or +). The filter
  5889. * will also be attached to the write filter chain
  5890. * if the file was opened for writing (i.e. File Mode:
  5891. * w, a, and/or +).
  5892. * STREAM_FILTER_READ,
  5893. * STREAM_FILTER_WRITE, and/or
  5894. * STREAM_FILTER_ALL can also be passed to the
  5895. * read_write parameter to override this behavior.
  5896. * See stream_filter_append for an example of
  5897. * using this parameter.
  5898. * </p>
  5899. * @param params mixed[optional] <p>
  5900. * This filter will be added with the specified params
  5901. * to the beginning of the list and will therefore be
  5902. * called first during stream operations. To add a filter to the end of the
  5903. * list, use stream_filter_append.
  5904. * </p>
  5905. * @return resource a resource which can be used to refer to this filter
  5906. * instance during a call to stream_filter_remove.
  5907. */
  5908. function stream_filter_prepend ($stream, $filtername, $read_write = null, $params = null) {}
  5909. /**
  5910. * Attach a filter to a stream
  5911. * @link http://www.php.net/manual/en/function.stream-filter-append.php
  5912. * @param stream resource <p>
  5913. * The target stream.
  5914. * </p>
  5915. * @param filtername string <p>
  5916. * The filter name.
  5917. * </p>
  5918. * @param read_write int[optional] <p>
  5919. * By default, stream_filter_append will
  5920. * attach the filter to the read filter chain
  5921. * if the file was opened for reading (i.e. File Mode:
  5922. * r, and/or +). The filter
  5923. * will also be attached to the write filter chain
  5924. * if the file was opened for writing (i.e. File Mode:
  5925. * w, a, and/or +).
  5926. * STREAM_FILTER_READ,
  5927. * STREAM_FILTER_WRITE, and/or
  5928. * STREAM_FILTER_ALL can also be passed to the
  5929. * read_write parameter to override this behavior.
  5930. * </p>
  5931. * @param params mixed[optional] <p>
  5932. * This filter will be added with the specified
  5933. * params to the end of
  5934. * the list and will therefore be called last during stream operations.
  5935. * To add a filter to the beginning of the list, use
  5936. * stream_filter_prepend.
  5937. * </p>
  5938. * @return resource a resource which can be used to refer to this filter
  5939. * instance during a call to stream_filter_remove.
  5940. */
  5941. function stream_filter_append ($stream, $filtername, $read_write = null, $params = null) {}
  5942. /**
  5943. * Remove a filter from a stream
  5944. * @link http://www.php.net/manual/en/function.stream-filter-remove.php
  5945. * @param stream_filter resource <p>
  5946. * The stream filter to be removed.
  5947. * </p>
  5948. * @return bool Returns true on success or false on failure.
  5949. */
  5950. function stream_filter_remove ($stream_filter) {}
  5951. /**
  5952. * Open Internet or Unix domain socket connection
  5953. * @link http://www.php.net/manual/en/function.stream-socket-client.php
  5954. * @param remote_socket string <p>
  5955. * Address to the socket to connect to.
  5956. * </p>
  5957. * @param errno int[optional] <p>
  5958. * Will be set to the system level error number if connection fails.
  5959. * </p>
  5960. * @param errstr string[optional] <p>
  5961. * Will be set to the system level error message if the connection fails.
  5962. * </p>
  5963. * @param timeout float[optional] <p>
  5964. * Number of seconds until the connect() system call
  5965. * should timeout.
  5966. * This parameter only applies when not making asynchronous
  5967. * connection attempts.
  5968. * <p>
  5969. * To set a timeout for reading/writing data over the socket, use the
  5970. * stream_set_timeout, as the
  5971. * timeout only applies while making connecting
  5972. * the socket.
  5973. * </p>
  5974. * </p>
  5975. * @param flags int[optional] <p>
  5976. * Bitmask field which may be set to any combination of connection flags.
  5977. * Currently the select of connection flags is limited to
  5978. * STREAM_CLIENT_CONNECT (default),
  5979. * STREAM_CLIENT_ASYNC_CONNECT and
  5980. * STREAM_CLIENT_PERSISTENT.
  5981. * </p>
  5982. * @param context resource[optional] <p>
  5983. * A valid context resource created with stream_context_create.
  5984. * </p>
  5985. * @return resource On success a stream resource is returned which may
  5986. * be used together with the other file functions (such as
  5987. * fgets, fgetss,
  5988. * fwrite, fclose, and
  5989. * feof), false on failure.
  5990. */
  5991. function stream_socket_client ($remote_socket, &$errno = null, &$errstr = null, $timeout = null, $flags = null, $context = null) {}
  5992. /**
  5993. * Create an Internet or Unix domain server socket
  5994. * @link http://www.php.net/manual/en/function.stream-socket-server.php
  5995. * @param local_socket string <p>
  5996. * The type of socket created is determined by the transport specified
  5997. * using standard URL formatting: transport://target.
  5998. * </p>
  5999. * <p>
  6000. * For Internet Domain sockets (AF_INET) such as TCP and UDP, the
  6001. * target portion of the
  6002. * remote_socket parameter should consist of a
  6003. * hostname or IP address followed by a colon and a port number. For
  6004. * Unix domain sockets, the target portion should
  6005. * point to the socket file on the filesystem.
  6006. * </p>
  6007. * <p>
  6008. * Depending on the environment, Unix domain sockets may not be available.
  6009. * A list of available transports can be retrieved using
  6010. * stream_get_transports. See
  6011. * for a list of bulitin transports.
  6012. * </p>
  6013. * @param errno int[optional] <p>
  6014. * If the optional errno and errstr
  6015. * arguments are present they will be set to indicate the actual system
  6016. * level error that occurred in the system-level socket(),
  6017. * bind(), and listen() calls. If
  6018. * the value returned in errno is
  6019. * 0 and the function returned false, it is an
  6020. * indication that the error occurred before the bind()
  6021. * call. This is most likely due to a problem initializing the socket.
  6022. * Note that the errno and
  6023. * errstr arguments will always be passed by reference.
  6024. * </p>
  6025. * @param errstr string[optional] <p>
  6026. * See errno description.
  6027. * </p>
  6028. * @param flags int[optional] <p>
  6029. * A bitmask field which may be set to any combination of socket creation
  6030. * flags.
  6031. * </p>
  6032. * <p>
  6033. * For UDP sockets, you must use STREAM_SERVER_BIND as
  6034. * the flags parameter.
  6035. * </p>
  6036. * @param context resource[optional] <p>
  6037. * </p>
  6038. * @return resource the created stream, or false on error.
  6039. */
  6040. function stream_socket_server ($local_socket, &$errno = null, &$errstr = null, $flags = null, $context = null) {}
  6041. /**
  6042. * Accept a connection on a socket created by <function>stream_socket_server</function>
  6043. * @link http://www.php.net/manual/en/function.stream-socket-accept.php
  6044. * @param server_socket resource
  6045. * @param timeout float[optional] <p>
  6046. * Override the default socket accept timeout. Time should be given in
  6047. * seconds.
  6048. * </p>
  6049. * @param peername string[optional] <p>
  6050. * Will be set to the name (address) of the client which connected, if
  6051. * included and available from the selected transport.
  6052. * </p>
  6053. * <p>
  6054. * Can also be determined later using
  6055. * stream_socket_get_name.
  6056. * </p>
  6057. * @return resource Returns true on success or false on failure.
  6058. */
  6059. function stream_socket_accept ($server_socket, $timeout = null, &$peername = null) {}
  6060. /**
  6061. * Retrieve the name of the local or remote sockets
  6062. * @link http://www.php.net/manual/en/function.stream-socket-get-name.php
  6063. * @param handle resource <p>
  6064. * The socket to get the name of.
  6065. * </p>
  6066. * @param want_peer bool <p>
  6067. * If set to true the remote socket name will be returned, if set
  6068. * to false the local socket name will be returned.
  6069. * </p>
  6070. * @return string The name of the socket.
  6071. */
  6072. function stream_socket_get_name ($handle, $want_peer) {}
  6073. /**
  6074. * Receives data from a socket, connected or not
  6075. * @link http://www.php.net/manual/en/function.stream-socket-recvfrom.php
  6076. * @param socket resource <p>
  6077. * The remote socket.
  6078. * </p>
  6079. * @param length int <p>
  6080. * The number of bytes to receive from the socket.
  6081. * </p>
  6082. * @param flags int[optional] <p>
  6083. * The value of flags can be any combination
  6084. * of the following:
  6085. * <table>
  6086. * Possible values for flags
  6087. * <tr valign="top">
  6088. * <td>STREAM_OOB</td>
  6089. * <td>
  6090. * Process OOB (out-of-band) data.
  6091. * </td>
  6092. * </tr>
  6093. * <tr valign="top">
  6094. * <td>STREAM_PEEK</td>
  6095. * <td>
  6096. * Retrieve data from the socket, but do not consume the buffer.
  6097. * Subsequent calls to fread or
  6098. * stream_socket_recvfrom will see
  6099. * the same data.
  6100. * </td>
  6101. * </tr>
  6102. * </table>
  6103. * </p>
  6104. * @param address string[optional] <p>
  6105. * If address is provided it will be populated with
  6106. * the address of the remote socket.
  6107. * </p>
  6108. * @return string the read data, as a string
  6109. */
  6110. function stream_socket_recvfrom ($socket, $length, $flags = null, &$address = null) {}
  6111. /**
  6112. * Sends a message to a socket, whether it is connected or not
  6113. * @link http://www.php.net/manual/en/function.stream-socket-sendto.php
  6114. * @param socket resource <p>
  6115. * The socket to send data to.
  6116. * </p>
  6117. * @param data string <p>
  6118. * The data to be sent.
  6119. * </p>
  6120. * @param flags int[optional] <p>
  6121. * The value of flags can be any combination
  6122. * of the following:
  6123. * <table>
  6124. * possible values for flags
  6125. * <tr valign="top">
  6126. * <td>STREAM_OOB</td>
  6127. * <td>
  6128. * Process OOB (out-of-band) data.
  6129. * </td>
  6130. * </tr>
  6131. * </table>
  6132. * </p>
  6133. * @param address string[optional] <p>
  6134. * The address specified when the socket stream was created will be used
  6135. * unless an alternate address is specified in address.
  6136. * </p>
  6137. * <p>
  6138. * If specified, it must be in dotted quad (or [ipv6]) format.
  6139. * </p>
  6140. * @return int a result code, as an integer.
  6141. */
  6142. function stream_socket_sendto ($socket, $data, $flags = null, $address = null) {}
  6143. /**
  6144. * Turns encryption on/off on an already connected socket
  6145. * @link http://www.php.net/manual/en/function.stream-socket-enable-crypto.php
  6146. * @param stream resource <p>
  6147. * The stream resource.
  6148. * </p>
  6149. * @param enable bool <p>
  6150. * Enable/disable cryptography on the stream.
  6151. * </p>
  6152. * @param crypto_type int[optional] <p>
  6153. * Setup encryption on the stream.
  6154. * Valid methods are
  6155. * STREAM_CRYPTO_METHOD_SSLv2_CLIENT
  6156. * @param session_stream resource[optional] <p>
  6157. * Seed the stream with settings from session_stream.
  6158. * </p>
  6159. * @return mixed true on success, false if negotiation has failed or
  6160. * 0 if there isn't enough data and you should try again
  6161. * (only for non-blocking sockets).
  6162. */
  6163. function stream_socket_enable_crypto ($stream, $enable, $crypto_type = null, $session_stream = null) {}
  6164. /**
  6165. * Shutdown a full-duplex connection
  6166. * @link http://www.php.net/manual/en/function.stream-socket-shutdown.php
  6167. * @param stream resource <p>
  6168. * An open stream (opened with stream_socket_client,
  6169. * for example)
  6170. * </p>
  6171. * @param how int <p>
  6172. * One of the following constants: STREAM_SHUT_RD
  6173. * (disable further receptions), STREAM_SHUT_WR
  6174. * (disable further transmissions) or
  6175. * STREAM_SHUT_RDWR (disable further receptions and
  6176. * transmissions).
  6177. * </p>
  6178. * @return bool Returns true on success or false on failure.
  6179. */
  6180. function stream_socket_shutdown ($stream, $how) {}
  6181. /**
  6182. * Creates a pair of connected, indistinguishable socket streams
  6183. * @link http://www.php.net/manual/en/function.stream-socket-pair.php
  6184. * @param domain int <p>
  6185. * The protocol family to be used: STREAM_PF_INET,
  6186. * STREAM_PF_INET6 or
  6187. * STREAM_PF_UNIX
  6188. * </p>
  6189. * @param type int <p>
  6190. * The type of communication to be used:
  6191. * STREAM_SOCK_DGRAM,
  6192. * STREAM_SOCK_RAW,
  6193. * STREAM_SOCK_RDM,
  6194. * STREAM_SOCK_SEQPACKET or
  6195. * STREAM_SOCK_STREAM
  6196. * </p>
  6197. * @param protocol int <p>
  6198. * The protocol to be used: STREAM_IPPROTO_ICMP,
  6199. * STREAM_IPPROTO_IP,
  6200. * STREAM_IPPROTO_RAW,
  6201. * STREAM_IPPROTO_TCP or
  6202. * STREAM_IPPROTO_UDP
  6203. * </p>
  6204. * @return array an array with the two socket resources on success, or
  6205. * false on failure.
  6206. */
  6207. function stream_socket_pair ($domain, $type, $protocol) {}
  6208. /**
  6209. * Copies data from one stream to another
  6210. * @link http://www.php.net/manual/en/function.stream-copy-to-stream.php
  6211. * @param source resource <p>
  6212. * The source stream
  6213. * </p>
  6214. * @param dest resource <p>
  6215. * The destination stream
  6216. * </p>
  6217. * @param maxlength int[optional] <p>
  6218. * Maximum bytes to copy
  6219. * </p>
  6220. * @param offset int[optional] <p>
  6221. * The offset where to start to copy data
  6222. * </p>
  6223. * @return int the total count of bytes copied.
  6224. */
  6225. function stream_copy_to_stream ($source, $dest, $maxlength = null, $offset = null) {}
  6226. /**
  6227. * Reads remainder of a stream into a string
  6228. * @link http://www.php.net/manual/en/function.stream-get-contents.php
  6229. * @param handle resource <p>
  6230. * A stream resource (e.g. returned from fopen)
  6231. * </p>
  6232. * @param maxlength int[optional] <p>
  6233. * The maximum bytes to read. Defaults to -1 (read all the remaining
  6234. * buffer).
  6235. * </p>
  6236. * @param offset int[optional] <p>
  6237. * Seek to the specified offset before reading.
  6238. * </p>
  6239. * @return string a string&return.falseforfailure;.
  6240. */
  6241. function stream_get_contents ($handle, $maxlength = null, $offset = null) {}
  6242. /**
  6243. * Tells whether the stream supports locking.
  6244. * @link http://www.php.net/manual/en/function.stream-supports-lock.php
  6245. * @param stream resource <p>
  6246. * The stream to check.
  6247. * </p>
  6248. * @return bool Returns true on success or false on failure.
  6249. */
  6250. function stream_supports_lock ($stream) {}
  6251. /**
  6252. * Gets line from file pointer and parse for CSV fields
  6253. * @link http://www.php.net/manual/en/function.fgetcsv.php
  6254. * @param handle resource <p>
  6255. * A valid file pointer to a file successfully opened by
  6256. * fopen, popen, or
  6257. * fsockopen.
  6258. * </p>
  6259. * @param length int[optional] <p>
  6260. * Must be greater than the longest line (in characters) to be found in
  6261. * the CSV file (allowing for trailing line-end characters). It became
  6262. * optional in PHP 5. Omitting this parameter (or setting it to 0 in PHP
  6263. * 5.0.4 and later) the maximum line length is not limited, which is
  6264. * slightly slower.
  6265. * </p>
  6266. * @param delimiter string[optional] <p>
  6267. * Set the field delimiter (one character only).
  6268. * </p>
  6269. * @param enclosure string[optional] <p>
  6270. * Set the field enclosure character (one character only).
  6271. * </p>
  6272. * @param escape string[optional] <p>
  6273. * Set the escape character (one character only). Defaults as a backslash.
  6274. * </p>
  6275. * @return array an indexed array containing the fields read.
  6276. * </p>
  6277. * <p>
  6278. * A blank line in a CSV file will be returned as an array
  6279. * comprising a single null field, and will not be treated
  6280. * as an error.
  6281. * </p>
  6282. * &note.line-endings;
  6283. * <p>
  6284. * fgetcsv returns &null; if an invalid
  6285. * handle is supplied or false on other errors,
  6286. * including end of file.
  6287. */
  6288. function fgetcsv ($handle, $length = null, $delimiter = null, $enclosure = null, $escape = null) {}
  6289. /**
  6290. * Format line as CSV and write to file pointer
  6291. * @link http://www.php.net/manual/en/function.fputcsv.php
  6292. * @param handle resource &fs.validfp.all;
  6293. * @param fields array <p>
  6294. * An array of values.
  6295. * </p>
  6296. * @param delimiter string[optional] <p>
  6297. * The optional delimiter parameter sets the field
  6298. * delimiter (one character only).
  6299. * </p>
  6300. * @param enclosure string[optional] <p>
  6301. * The optional enclosure parameter sets the field
  6302. * enclosure (one character only).
  6303. * </p>
  6304. * @return int the length of the written string&return.falseforfailure;.
  6305. */
  6306. function fputcsv ($handle, array $fields, $delimiter = null, $enclosure = null) {}
  6307. /**
  6308. * Portable advisory file locking
  6309. * @link http://www.php.net/manual/en/function.flock.php
  6310. * @param handle resource <p>
  6311. * An open file pointer.
  6312. * </p>
  6313. * @param operation int <p>
  6314. * operation is one of the following:
  6315. * LOCK_SH to acquire a shared lock (reader).
  6316. * @param wouldblock int[optional] <p>
  6317. * The optional third argument is set to true if the lock would block
  6318. * (EWOULDBLOCK errno condition). (not supported on Windows)
  6319. * </p>
  6320. * @return bool Returns true on success or false on failure.
  6321. */
  6322. function flock ($handle, $operation, &$wouldblock = null) {}
  6323. /**
  6324. * Extracts all meta tag content attributes from a file and returns an array
  6325. * @link http://www.php.net/manual/en/function.get-meta-tags.php
  6326. * @param filename string <p>
  6327. * The path to the HTML file, as a string. This can be a local file or an
  6328. * URL.
  6329. * </p>
  6330. * <p>
  6331. * What get_meta_tags parses
  6332. * ]]>
  6333. * (pay attention to line endings - PHP uses a native function to
  6334. * parse the input, so a Mac file won't work on Unix).
  6335. * </p>
  6336. * @param use_include_path bool[optional] <p>
  6337. * Setting use_include_path to true will result
  6338. * in PHP trying to open the file along the standard include path as per
  6339. * the include_path directive.
  6340. * This is used for local files, not URLs.
  6341. * </p>
  6342. * @return array an array with all the parsed meta tags.
  6343. * </p>
  6344. * <p>
  6345. * The value of the name property becomes the key, the value of the content
  6346. * property becomes the value of the returned array, so you can easily use
  6347. * standard array functions to traverse it or access single values.
  6348. * Special characters in the value of the name property are substituted with
  6349. * '_', the rest is converted to lower case. If two meta tags have the same
  6350. * name, only the last one is returned.
  6351. */
  6352. function get_meta_tags ($filename, $use_include_path = null) {}
  6353. /**
  6354. * Sets file buffering on the given stream
  6355. * @link http://www.php.net/manual/en/function.stream-set-write-buffer.php
  6356. * @param stream resource <p>
  6357. * The file pointer.
  6358. * </p>
  6359. * @param buffer int <p>
  6360. * The number of bytes to buffer. If buffer
  6361. * is 0 then write operations are unbuffered. This ensures that all writes
  6362. * with fwrite are completed before other processes are
  6363. * allowed to write to that output stream.
  6364. * </p>
  6365. * @return int 0 on success, or EOF if the request cannot be honored.
  6366. */
  6367. function stream_set_write_buffer ($stream, $buffer) {}
  6368. /**
  6369. * &Alias; <function>stream_set_write_buffer</function>
  6370. * @link http://www.php.net/manual/en/function.set-file-buffer.php
  6371. * @param fp
  6372. * @param buffer
  6373. */
  6374. function set_file_buffer ($fp, $buffer) {}
  6375. /**
  6376. * &Alias; <function>stream_set_blocking</function>
  6377. * @link http://www.php.net/manual/en/function.set-socket-blocking.php
  6378. * @param socket
  6379. * @param mode
  6380. * @deprecated Deprecated as of PHP 5.3.0. Relying on this feature is highly discouraged (use stream_set_blocking() instead).
  6381. */
  6382. function set_socket_blocking ($socket, $mode) {}
  6383. /**
  6384. * Set blocking/non-blocking mode on a stream
  6385. * @link http://www.php.net/manual/en/function.stream-set-blocking.php
  6386. * @param stream resource <p>
  6387. * The stream.
  6388. * </p>
  6389. * @param mode int <p>
  6390. * If mode is 0, the given stream
  6391. * will be switched to non-blocking mode, and if 1, it
  6392. * will be switched to blocking mode. This affects calls like
  6393. * fgets and fread
  6394. * that read from the stream. In non-blocking mode an
  6395. * fgets call will always return right away
  6396. * while in blocking mode it will wait for data to become available
  6397. * on the stream.
  6398. * </p>
  6399. * @return bool Returns true on success or false on failure.
  6400. */
  6401. function stream_set_blocking ($stream, $mode) {}
  6402. /**
  6403. * &Alias; <function>stream_set_blocking</function>
  6404. * @link http://www.php.net/manual/en/function.socket-set-blocking.php
  6405. * @param socket
  6406. * @param mode
  6407. */
  6408. function socket_set_blocking ($socket, $mode) {}
  6409. /**
  6410. * Retrieves header/meta data from streams/file pointers
  6411. * @link http://www.php.net/manual/en/function.stream-get-meta-data.php
  6412. * @param stream resource <p>
  6413. * The stream can be any stream created by fopen,
  6414. * fsockopen and pfsockopen.
  6415. * </p>
  6416. * @return array The result array contains the following items:
  6417. * </p>
  6418. * <p>
  6419. * timed_out (bool) - true if the stream
  6420. * timed out while waiting for data on the last call to
  6421. * fread or fgets.
  6422. * </p>
  6423. * <p>
  6424. * blocked (bool) - true if the stream is
  6425. * in blocking IO mode. See stream_set_blocking.
  6426. * </p>
  6427. * <p>
  6428. * eof (bool) - true if the stream has reached
  6429. * end-of-file. Note that for socket streams this member can be true
  6430. * even when unread_bytes is non-zero. To
  6431. * determine if there is more data to be read, use
  6432. * feof instead of reading this item.
  6433. * </p>
  6434. * <p>
  6435. * unread_bytes (int) - the number of bytes
  6436. * currently contained in the PHP's own internal buffer.
  6437. * </p>
  6438. * You shouldn't use this value in a script.
  6439. * <p>
  6440. * stream_type (string) - a label describing
  6441. * the underlying implementation of the stream.
  6442. * </p>
  6443. * <p>
  6444. * wrapper_type (string) - a label describing
  6445. * the protocol wrapper implementation layered over the stream.
  6446. * See for more information about wrappers.
  6447. * </p>
  6448. * <p>
  6449. * wrapper_data (mixed) - wrapper specific
  6450. * data attached to this stream. See for
  6451. * more information about wrappers and their wrapper data.
  6452. * </p>
  6453. * <p>
  6454. * filters (array) - and array containing
  6455. * the names of any filters that have been stacked onto this stream.
  6456. * Documentation on filters can be found in the
  6457. * Filters appendix.
  6458. * </p>
  6459. * <p>
  6460. * mode (string) - the type of access required for
  6461. * this stream (see Table 1 of the fopen() reference)
  6462. * </p>
  6463. * <p>
  6464. * seekable (bool) - whether the current stream can
  6465. * be seeked.
  6466. * </p>
  6467. * <p>
  6468. * uri (string) - the URI/filename associated with this
  6469. * stream.
  6470. */
  6471. function stream_get_meta_data ($stream) {}
  6472. /**
  6473. * Gets line from stream resource up to a given delimiter
  6474. * @link http://www.php.net/manual/en/function.stream-get-line.php
  6475. * @param handle resource <p>
  6476. * A valid file handle.
  6477. * </p>
  6478. * @param length int <p>
  6479. * The number of bytes to read from the handle.
  6480. * </p>
  6481. * @param ending string[optional] <p>
  6482. * An optional string delimiter.
  6483. * </p>
  6484. * @return string a string of up to length bytes read from the file
  6485. * pointed to by handle.
  6486. * </p>
  6487. * <p>
  6488. * If an error occurs, returns false.
  6489. */
  6490. function stream_get_line ($handle, $length, $ending = null) {}
  6491. /**
  6492. * Register a URL wrapper implemented as a PHP class
  6493. * @link http://www.php.net/manual/en/function.stream-wrapper-register.php
  6494. * @param protocol string <p>
  6495. * The wrapper name to be registered.
  6496. * </p>
  6497. * @param classname string <p>
  6498. * The classname which implements the protocol.
  6499. * </p>
  6500. * @param flags int[optional] <p>
  6501. * Should be set to STREAM_IS_URL if
  6502. * protocol is a URL protocol. Default is 0, local
  6503. * stream.
  6504. * </p>
  6505. * @return bool Returns true on success or false on failure.
  6506. * </p>
  6507. * <p>
  6508. * stream_wrapper_register will return false if the
  6509. * protocol already has a handler.
  6510. */
  6511. function stream_wrapper_register ($protocol, $classname, $flags = null) {}
  6512. /**
  6513. * &Alias; <function>stream_wrapper_register</function>
  6514. * @link http://www.php.net/manual/en/function.stream-register-wrapper.php
  6515. * @param protocol
  6516. * @param classname
  6517. * @param flags[optional]
  6518. */
  6519. function stream_register_wrapper ($protocol, $classname, $flags) {}
  6520. /**
  6521. * Unregister a URL wrapper
  6522. * @link http://www.php.net/manual/en/function.stream-wrapper-unregister.php
  6523. * @param protocol string <p>
  6524. * </p>
  6525. * @return bool Returns true on success or false on failure.
  6526. */
  6527. function stream_wrapper_unregister ($protocol) {}
  6528. /**
  6529. * Restores a previously unregistered built-in wrapper
  6530. * @link http://www.php.net/manual/en/function.stream-wrapper-restore.php
  6531. * @param protocol string <p>
  6532. * </p>
  6533. * @return bool Returns true on success or false on failure.
  6534. */
  6535. function stream_wrapper_restore ($protocol) {}
  6536. /**
  6537. * Retrieve list of registered streams
  6538. * @link http://www.php.net/manual/en/function.stream-get-wrappers.php
  6539. * @return array an indexed array containing the name of all stream wrappers
  6540. * available on the running system.
  6541. */
  6542. function stream_get_wrappers () {}
  6543. /**
  6544. * Retrieve list of registered socket transports
  6545. * @link http://www.php.net/manual/en/function.stream-get-transports.php
  6546. * @return array an indexed array of socket transports names.
  6547. */
  6548. function stream_get_transports () {}
  6549. /**
  6550. * Resolve filename against the include path
  6551. * @link http://www.php.net/manual/en/function.stream-resolve-include-path.php
  6552. * @param filename string
  6553. * @param context resource[optional] <p>
  6554. * A valid context resource created with stream_context_create.
  6555. * </p>
  6556. * @return string On success, the resolved absolute filename is returned. On failure, false is returned.
  6557. */
  6558. function stream_resolve_include_path ($filename, $context = null) {}
  6559. /**
  6560. * Checks if a stream is a local stream
  6561. * @link http://www.php.net/manual/en/function.stream-is-local.php
  6562. * @param stream_or_url mixed <p>
  6563. * The stream resource or URL to check.
  6564. * </p>
  6565. * @return bool Returns true on success or false on failure.
  6566. */
  6567. function stream_is_local ($stream_or_url) {}
  6568. /**
  6569. * Fetches all the headers sent by the server in response to a HTTP request
  6570. * @link http://www.php.net/manual/en/function.get-headers.php
  6571. * @param url string <p>
  6572. * The target URL.
  6573. * </p>
  6574. * @param format int[optional] <p>
  6575. * If the optional format parameter is set to non-zero,
  6576. * get_headers parses the response and sets the
  6577. * array's keys.
  6578. * </p>
  6579. * @return array an indexed or associative array with the headers, or false on
  6580. * failure.
  6581. */
  6582. function get_headers ($url, $format = null) {}
  6583. /**
  6584. * Set timeout period on a stream
  6585. * @link http://www.php.net/manual/en/function.stream-set-timeout.php
  6586. * @param stream resource <p>
  6587. * The target stream.
  6588. * </p>
  6589. * @param seconds int <p>
  6590. * The seconds part of the timeout to be set.
  6591. * </p>
  6592. * @param microseconds int[optional] <p>
  6593. * The microseconds part of the timeout to be set.
  6594. * </p>
  6595. * @return bool Returns true on success or false on failure.
  6596. */
  6597. function stream_set_timeout ($stream, $seconds, $microseconds = null) {}
  6598. /**
  6599. * &Alias; <function>stream_set_timeout</function>
  6600. * @link http://www.php.net/manual/en/function.socket-set-timeout.php
  6601. * @param stream
  6602. * @param seconds
  6603. * @param microseconds
  6604. */
  6605. function socket_set_timeout ($stream, $seconds, $microseconds) {}
  6606. /**
  6607. * &Alias; <function>stream_get_meta_data</function>
  6608. * @link http://www.php.net/manual/en/function.socket-get-status.php
  6609. * @param fp
  6610. */
  6611. function socket_get_status ($fp) {}
  6612. /**
  6613. * Returns canonicalized absolute pathname
  6614. * @link http://www.php.net/manual/en/function.realpath.php
  6615. * @param path string <p>
  6616. * The path being checked.
  6617. * </p>
  6618. * @return string the canonicalized absolute pathname on success. The resulting path
  6619. * will have no symbolic link, '/./' or '/../' components.
  6620. * </p>
  6621. * <p>
  6622. * realpath returns false on failure, e.g. if
  6623. * the file does not exist.
  6624. * </p>
  6625. * <p>
  6626. * The running script must have executable permissions on all directories in
  6627. * the hierarchy, otherwise realpath will return
  6628. * false.
  6629. */
  6630. function realpath ($path) {}
  6631. /**
  6632. * Match filename against a pattern
  6633. * @link http://www.php.net/manual/en/function.fnmatch.php
  6634. * @param pattern string <p>
  6635. * The shell wildcard pattern.
  6636. * </p>
  6637. * @param string string <p>
  6638. * The tested string. This function is especially useful for filenames,
  6639. * but may also be used on regular strings.
  6640. * </p>
  6641. * <p>
  6642. * The average user may be used to shell patterns or at least in their
  6643. * simplest form to '?' and '*'
  6644. * wildcards so using fnmatch instead of
  6645. * preg_match for
  6646. * frontend search expression input may be way more convenient for
  6647. * non-programming users.
  6648. * </p>
  6649. * @param flags int[optional] <p>
  6650. * The value of flags can be any combination of
  6651. * the following flags, joined with the
  6652. * binary OR (|) operator.
  6653. * <table>
  6654. * A list of possible flags for fnmatch
  6655. * <tr valign="top">
  6656. * <td>Flag</td>
  6657. * <td>Description</td>
  6658. * </tr>
  6659. * <tr valign="top">
  6660. * <td>FNM_NOESCAPE</td>
  6661. * <td>
  6662. * Disable backslash escaping.
  6663. * </td>
  6664. * </tr>
  6665. * <tr valign="top">
  6666. * <td>FNM_PATHNAME</td>
  6667. * <td>
  6668. * Slash in string only matches slash in the given pattern.
  6669. * </td>
  6670. * </tr>
  6671. * <tr valign="top">
  6672. * <td>FNM_PERIOD</td>
  6673. * <td>
  6674. * Leading period in string must be exactly matched by period in the given pattern.
  6675. * </td>
  6676. * </tr>
  6677. * <tr valign="top">
  6678. * <td>FNM_CASEFOLD</td>
  6679. * <td>
  6680. * Caseless match. Part of the GNU extension.
  6681. * </td>
  6682. * </tr>
  6683. * </table>
  6684. * </p>
  6685. * @return bool true if there is a match, false otherwise.
  6686. */
  6687. function fnmatch ($pattern, $string, $flags = null) {}
  6688. /**
  6689. * Open Internet or Unix domain socket connection
  6690. * @link http://www.php.net/manual/en/function.fsockopen.php
  6691. * @param hostname string <p>
  6692. * If you have compiled in OpenSSL support, you may prefix the
  6693. * hostname with either ssl://
  6694. * or tls:// to use an SSL or TLS client connection
  6695. * over TCP/IP to connect to the remote host.
  6696. * </p>
  6697. * @param port int[optional] <p>
  6698. * The port number.
  6699. * </p>
  6700. * @param errno int[optional] <p>
  6701. * If provided, holds the system level error number that occurred in the
  6702. * system-level connect() call.
  6703. * </p>
  6704. * <p>
  6705. * If the value returned in errno is
  6706. * 0 and the function returned false, it is an
  6707. * indication that the error occurred before the
  6708. * connect() call. This is most likely due to a
  6709. * problem initializing the socket.
  6710. * </p>
  6711. * @param errstr string[optional] <p>
  6712. * The error message as a string.
  6713. * </p>
  6714. * @param timeout float[optional] <p>
  6715. * The connection timeout, in seconds.
  6716. * </p>
  6717. * <p>
  6718. * If you need to set a timeout for reading/writing data over the
  6719. * socket, use stream_set_timeout, as the
  6720. * timeout parameter to
  6721. * fsockopen only applies while connecting the
  6722. * socket.
  6723. * </p>
  6724. * @return resource fsockopen returns a file pointer which may be used
  6725. * together with the other file functions (such as
  6726. * fgets, fgetss,
  6727. * fwrite, fclose, and
  6728. * feof). If the call fails, it will return false
  6729. */
  6730. function fsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  6731. /**
  6732. * Open persistent Internet or Unix domain socket connection
  6733. * @link http://www.php.net/manual/en/function.pfsockopen.php
  6734. * @param hostname string
  6735. * @param port int[optional]
  6736. * @param errno int[optional]
  6737. * @param errstr string[optional]
  6738. * @param timeout float[optional]
  6739. * @return resource
  6740. */
  6741. function pfsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  6742. /**
  6743. * Pack data into binary string
  6744. * @link http://www.php.net/manual/en/function.pack.php
  6745. * @param format string <p>
  6746. * The format string consists of format codes
  6747. * followed by an optional repeater argument. The repeater argument can
  6748. * be either an integer value or * for repeating to
  6749. * the end of the input data. For a, A, h, H the repeat count specifies
  6750. * how many characters of one data argument are taken, for @ it is the
  6751. * absolute position where to put the next data, for everything else the
  6752. * repeat count specifies how many data arguments are consumed and packed
  6753. * into the resulting binary string.
  6754. * </p>
  6755. * <p>
  6756. * Currently implemented formats are:
  6757. * <table>
  6758. * pack format characters
  6759. * <tr valign="top">
  6760. * <td>Code</td>
  6761. * <td>Description</td>
  6762. * </tr>
  6763. * <tr valign="top">
  6764. * <td>a</td>
  6765. * <td>NUL-padded string</td>
  6766. * </tr>
  6767. * <tr valign="top">
  6768. * <td>A</td>
  6769. * <td>SPACE-padded string</td></tr>
  6770. * <tr valign="top">
  6771. * <td>h</td>
  6772. * <td>Hex string, low nibble first</td></tr>
  6773. * <tr valign="top">
  6774. * <td>H</td>
  6775. * <td>Hex string, high nibble first</td></tr>
  6776. * <tr valign="top"><td>c</td><td>signed char</td></tr>
  6777. * <tr valign="top">
  6778. * <td>C</td>
  6779. * <td>unsigned char</td></tr>
  6780. * <tr valign="top">
  6781. * <td>s</td>
  6782. * <td>signed short (always 16 bit, machine byte order)</td>
  6783. * </tr>
  6784. * <tr valign="top">
  6785. * <td>S</td>
  6786. * <td>unsigned short (always 16 bit, machine byte order)</td>
  6787. * </tr>
  6788. * <tr valign="top">
  6789. * <td>n</td>
  6790. * <td>unsigned short (always 16 bit, big endian byte order)</td>
  6791. * </tr>
  6792. * <tr valign="top">
  6793. * <td>v</td>
  6794. * <td>unsigned short (always 16 bit, little endian byte order)</td>
  6795. * </tr>
  6796. * <tr valign="top">
  6797. * <td>i</td>
  6798. * <td>signed integer (machine dependent size and byte order)</td>
  6799. * </tr>
  6800. * <tr valign="top">
  6801. * <td>I</td>
  6802. * <td>unsigned integer (machine dependent size and byte order)</td>
  6803. * </tr>
  6804. * <tr valign="top">
  6805. * <td>l</td>
  6806. * <td>signed long (always 32 bit, machine byte order)</td>
  6807. * </tr>
  6808. * <tr valign="top">
  6809. * <td>L</td>
  6810. * <td>unsigned long (always 32 bit, machine byte order)</td>
  6811. * </tr>
  6812. * <tr valign="top">
  6813. * <td>N</td>
  6814. * <td>unsigned long (always 32 bit, big endian byte order)</td>
  6815. * </tr>
  6816. * <tr valign="top">
  6817. * <td>V</td>
  6818. * <td>unsigned long (always 32 bit, little endian byte order)</td>
  6819. * </tr>
  6820. * <tr valign="top">
  6821. * <td>f</td>
  6822. * <td>float (machine dependent size and representation)</td>
  6823. * </tr>
  6824. * <tr valign="top">
  6825. * <td>d</td>
  6826. * <td>double (machine dependent size and representation)</td>
  6827. * </tr>
  6828. * <tr valign="top">
  6829. * <td>x</td>
  6830. * <td>NUL byte</td>
  6831. * </tr>
  6832. * <tr valign="top">
  6833. * <td>X</td>
  6834. * <td>Back up one byte</td>
  6835. * </tr>
  6836. * <tr valign="top">
  6837. * <td>@</td>
  6838. * <td>NUL-fill to absolute position</td>
  6839. * </tr>
  6840. * </table>
  6841. * </p>
  6842. * @param args mixed[optional] <p>
  6843. * </p>
  6844. * @param _ mixed[optional]
  6845. * @return string a binary string containing data.
  6846. */
  6847. function pack ($format, $args = null, $_ = null) {}
  6848. /**
  6849. * Unpack data from binary string
  6850. * @link http://www.php.net/manual/en/function.unpack.php
  6851. * @param format string <p>
  6852. * See pack for an explanation of the format codes.
  6853. * </p>
  6854. * @param data string <p>
  6855. * The packed data.
  6856. * </p>
  6857. * @return array an associative array containing unpacked elements of binary
  6858. * string.
  6859. */
  6860. function unpack ($format, $data) {}
  6861. /**
  6862. * Tells what the user's browser is capable of
  6863. * @link http://www.php.net/manual/en/function.get-browser.php
  6864. * @param user_agent string[optional] <p>
  6865. * The User Agent to be analyzed. By default, the value of HTTP
  6866. * User-Agent header is used; however, you can alter this (i.e., look up
  6867. * another browser's info) by passing this parameter.
  6868. * </p>
  6869. * <p>
  6870. * You can bypass this parameter with a &null; value.
  6871. * </p>
  6872. * @param return_array bool[optional] <p>
  6873. * If set to true, this function will return an array
  6874. * instead of an object.
  6875. * </p>
  6876. * @return mixed The information is returned in an object or an array which will contain
  6877. * various data elements representing, for instance, the browser's major and
  6878. * minor version numbers and ID string; true/false values for features
  6879. * such as frames, JavaScript, and cookies; and so forth.
  6880. * </p>
  6881. * <p>
  6882. * The cookies value simply means that the browser
  6883. * itself is capable of accepting cookies and does not mean the user has
  6884. * enabled the browser to accept cookies or not. The only way to test if
  6885. * cookies are accepted is to set one with setcookie,
  6886. * reload, and check for the value.
  6887. */
  6888. function get_browser ($user_agent = null, $return_array = null) {}
  6889. /**
  6890. * One-way string hashing
  6891. * @link http://www.php.net/manual/en/function.crypt.php
  6892. * @param str string <p>
  6893. * The string to be hashed.
  6894. * </p>
  6895. * @param salt string[optional] <p>
  6896. * An optional salt string to base the hashing on. If not provided,
  6897. * one will be randomly generated by PHP each time you call this function.
  6898. * </p>
  6899. * <p>
  6900. * If you are using the supplied salt, you should be aware that the salt
  6901. * is generated once. If you are calling this function repeatedly, this
  6902. * may impact both appearance and security.
  6903. * </p>
  6904. * @return string the hashed string or a string that is shorter than 13 characters
  6905. * and is guaranteed to differ from the salt on failure.
  6906. */
  6907. function crypt ($str, $salt = null) {}
  6908. /**
  6909. * Open directory handle
  6910. * @link http://www.php.net/manual/en/function.opendir.php
  6911. * @param path string <p>
  6912. * The directory path that is to be opened
  6913. * </p>
  6914. * @param context resource[optional] <p>
  6915. * For a description of the context parameter,
  6916. * refer to the streams section of
  6917. * the manual.
  6918. * </p>
  6919. * @return resource a directory handle resource on success, or
  6920. * false on failure.
  6921. * </p>
  6922. * <p>
  6923. * If path is not a valid directory or the
  6924. * directory can not be opened due to permission restrictions or
  6925. * filesystem errors, opendir returns false and
  6926. * generates a PHP error of level
  6927. * E_WARNING. You can suppress the error output of
  6928. * opendir by prepending
  6929. * '@' to the
  6930. * front of the function name.
  6931. */
  6932. function opendir ($path, $context = null) {}
  6933. /**
  6934. * Close directory handle
  6935. * @link http://www.php.net/manual/en/function.closedir.php
  6936. * @param dir_handle resource[optional] <p>
  6937. * The directory handle resource previously opened
  6938. * with opendir. If the directory handle is
  6939. * not specified, the last link opened by opendir
  6940. * is assumed.
  6941. * </p>
  6942. * @return void
  6943. */
  6944. function closedir ($dir_handle = null) {}
  6945. /**
  6946. * Change directory
  6947. * @link http://www.php.net/manual/en/function.chdir.php
  6948. * @param directory string <p>
  6949. * The new current directory
  6950. * </p>
  6951. * @return bool Returns true on success or false on failure.
  6952. */
  6953. function chdir ($directory) {}
  6954. /**
  6955. * Gets the current working directory
  6956. * @link http://www.php.net/manual/en/function.getcwd.php
  6957. * @return string the current working directory on success, or false on
  6958. * failure.
  6959. * </p>
  6960. * <p>
  6961. * On some Unix variants, getcwd will return
  6962. * false if any one of the parent directories does not have the
  6963. * readable or search mode set, even if the current directory
  6964. * does. See chmod for more information on
  6965. * modes and permissions.
  6966. */
  6967. function getcwd () {}
  6968. /**
  6969. * Rewind directory handle
  6970. * @link http://www.php.net/manual/en/function.rewinddir.php
  6971. * @param dir_handle resource[optional] <p>
  6972. * The directory handle resource previously opened
  6973. * with opendir. If the directory handle is
  6974. * not specified, the last link opened by opendir
  6975. * is assumed.
  6976. * </p>
  6977. * @return void
  6978. */
  6979. function rewinddir ($dir_handle = null) {}
  6980. /**
  6981. * Read entry from directory handle
  6982. * @link http://www.php.net/manual/en/function.readdir.php
  6983. * @param dir_handle resource[optional] <p>
  6984. * The directory handle resource previously opened
  6985. * with opendir. If the directory handle is
  6986. * not specified, the last link opened by opendir
  6987. * is assumed.
  6988. * </p>
  6989. * @return string the filename on success&return.falseforfailure;.
  6990. */
  6991. function readdir ($dir_handle = null) {}
  6992. /**
  6993. * Return an instance of the Directory class
  6994. * @link http://www.php.net/manual/en/class.dir.php
  6995. * @param directory
  6996. * @param context[optional]
  6997. * @return string
  6998. */
  6999. function dir ($directory, $context) {}
  7000. /**
  7001. * List files and directories inside the specified path
  7002. * @link http://www.php.net/manual/en/function.scandir.php
  7003. * @param directory string <p>
  7004. * The directory that will be scanned.
  7005. * </p>
  7006. * @param sorting_order int[optional] <p>
  7007. * By default, the sorted order is alphabetical in ascending order. If
  7008. * the optional sorting_order is set to non-zero,
  7009. * then the sort order is alphabetical in descending order.
  7010. * </p>
  7011. * @param context resource[optional] <p>
  7012. * For a description of the context parameter,
  7013. * refer to the streams section of
  7014. * the manual.
  7015. * </p>
  7016. * @return array an array of filenames on success, or false on
  7017. * failure. If directory is not a directory, then
  7018. * boolean false is returned, and an error of level
  7019. * E_WARNING is generated.
  7020. */
  7021. function scandir ($directory, $sorting_order = null, $context = null) {}
  7022. /**
  7023. * Find pathnames matching a pattern
  7024. * @link http://www.php.net/manual/en/function.glob.php
  7025. * @param pattern string <p>
  7026. * The pattern. No tilde expansion or parameter substitution is done.
  7027. * </p>
  7028. * @param flags int[optional] <p>
  7029. * Valid flags:
  7030. * GLOB_MARK - Adds a slash to each directory returned
  7031. * @return array an array containing the matched files/directories, an empty array
  7032. * if no file matched or false on error.
  7033. * </p>
  7034. * <p>
  7035. * On some systems it is impossible to distinguish between empty match and an
  7036. * error.
  7037. */
  7038. function glob ($pattern, $flags = null) {}
  7039. /**
  7040. * Gets last access time of file
  7041. * @link http://www.php.net/manual/en/function.fileatime.php
  7042. * @param filename string <p>
  7043. * Path to the file.
  7044. * </p>
  7045. * @return int the time the file was last accessed, &return.falseforfailure;.
  7046. * The time is returned as a Unix timestamp.
  7047. */
  7048. function fileatime ($filename) {}
  7049. /**
  7050. * Gets inode change time of file
  7051. * @link http://www.php.net/manual/en/function.filectime.php
  7052. * @param filename string <p>
  7053. * Path to the file.
  7054. * </p>
  7055. * @return int the time the file was last changed, &return.falseforfailure;.
  7056. * The time is returned as a Unix timestamp.
  7057. */
  7058. function filectime ($filename) {}
  7059. /**
  7060. * Gets file group
  7061. * @link http://www.php.net/manual/en/function.filegroup.php
  7062. * @param filename string <p>
  7063. * Path to the file.
  7064. * </p>
  7065. * @return int the group ID of the file, or false in case
  7066. * of an error. The group ID is returned in numerical format, use
  7067. * posix_getgrgid to resolve it to a group name.
  7068. * Upon failure, false is returned.
  7069. */
  7070. function filegroup ($filename) {}
  7071. /**
  7072. * Gets file inode
  7073. * @link http://www.php.net/manual/en/function.fileinode.php
  7074. * @param filename string <p>
  7075. * Path to the file.
  7076. * </p>
  7077. * @return int the inode number of the file, &return.falseforfailure;.
  7078. */
  7079. function fileinode ($filename) {}
  7080. /**
  7081. * Gets file modification time
  7082. * @link http://www.php.net/manual/en/function.filemtime.php
  7083. * @param filename string <p>
  7084. * Path to the file.
  7085. * </p>
  7086. * @return int the time the file was last modified, &return.falseforfailure;.
  7087. * The time is returned as a Unix timestamp, which is
  7088. * suitable for the date function.
  7089. */
  7090. function filemtime ($filename) {}
  7091. /**
  7092. * Gets file owner
  7093. * @link http://www.php.net/manual/en/function.fileowner.php
  7094. * @param filename string <p>
  7095. * Path to the file.
  7096. * </p>
  7097. * @return int the user ID of the owner of the file, &return.falseforfailure;.
  7098. * The user ID is returned in numerical format, use
  7099. * posix_getpwuid to resolve it to a username.
  7100. */
  7101. function fileowner ($filename) {}
  7102. /**
  7103. * Gets file permissions
  7104. * @link http://www.php.net/manual/en/function.fileperms.php
  7105. * @param filename string <p>
  7106. * Path to the file.
  7107. * </p>
  7108. * @return int the permissions on the file, &return.falseforfailure;.
  7109. */
  7110. function fileperms ($filename) {}
  7111. /**
  7112. * Gets file size
  7113. * @link http://www.php.net/manual/en/function.filesize.php
  7114. * @param filename string <p>
  7115. * Path to the file.
  7116. * </p>
  7117. * @return int the size of the file in bytes, or false (and generates an error
  7118. * of level E_WARNING) in case of an error.
  7119. */
  7120. function filesize ($filename) {}
  7121. /**
  7122. * Gets file type
  7123. * @link http://www.php.net/manual/en/function.filetype.php
  7124. * @param filename string <p>
  7125. * Path to the file.
  7126. * </p>
  7127. * @return string the type of the file. Possible values are fifo, char,
  7128. * dir, block, link, file, socket and unknown.
  7129. * </p>
  7130. * <p>
  7131. * Returns false if an error occurs. filetype will also
  7132. * produce an E_NOTICE message if the stat call fails
  7133. * or if the file type is unknown.
  7134. */
  7135. function filetype ($filename) {}
  7136. /**
  7137. * Checks whether a file or directory exists
  7138. * @link http://www.php.net/manual/en/function.file-exists.php
  7139. * @param filename string <p>
  7140. * Path to the file or directory.
  7141. * </p>
  7142. * <p>
  7143. * On windows, use //computername/share/filename or
  7144. * \\computername\share\filename to check files on
  7145. * network shares.
  7146. * </p>
  7147. * @return bool true if the file or directory specified by
  7148. * filename exists; false otherwise.
  7149. * </p>
  7150. * <p>
  7151. * This function will return false for symlinks pointing to non-existing
  7152. * files.
  7153. * </p>
  7154. * <p>
  7155. * This function returns false for files inaccessible due to safe mode restrictions. However these
  7156. * files still can be included if
  7157. * they are located in safe_mode_include_dir.
  7158. * </p>
  7159. * <p>
  7160. * The check is done using the real UID/GID instead of the effective one.
  7161. */
  7162. function file_exists ($filename) {}
  7163. /**
  7164. * Tells whether the filename is writable
  7165. * @link http://www.php.net/manual/en/function.is-writable.php
  7166. * @param filename string <p>
  7167. * The filename being checked.
  7168. * </p>
  7169. * @return bool true if the filename exists and is
  7170. * writable.
  7171. */
  7172. function is_writable ($filename) {}
  7173. /**
  7174. * &Alias; <function>is_writable</function>
  7175. * @link http://www.php.net/manual/en/function.is-writeable.php
  7176. * @param filename
  7177. */
  7178. function is_writeable ($filename) {}
  7179. /**
  7180. * Tells whether a file exists and is readable
  7181. * @link http://www.php.net/manual/en/function.is-readable.php
  7182. * @param filename string <p>
  7183. * Path to the file.
  7184. * </p>
  7185. * @return bool true if the file or directory specified by
  7186. * filename exists and is readable, false otherwise.
  7187. */
  7188. function is_readable ($filename) {}
  7189. /**
  7190. * Tells whether the filename is executable
  7191. * @link http://www.php.net/manual/en/function.is-executable.php
  7192. * @param filename string <p>
  7193. * Path to the file.
  7194. * </p>
  7195. * @return bool true if the filename exists and is executable, or false on
  7196. * error.
  7197. */
  7198. function is_executable ($filename) {}
  7199. /**
  7200. * Tells whether the filename is a regular file
  7201. * @link http://www.php.net/manual/en/function.is-file.php
  7202. * @param filename string <p>
  7203. * Path to the file.
  7204. * </p>
  7205. * @return bool true if the filename exists and is a regular file, false
  7206. * otherwise.
  7207. */
  7208. function is_file ($filename) {}
  7209. /**
  7210. * Tells whether the filename is a directory
  7211. * @link http://www.php.net/manual/en/function.is-dir.php
  7212. * @param filename string <p>
  7213. * Path to the file. If filename is a relative
  7214. * filename, it will be checked relative to the current working
  7215. * directory. If filename is a symbolic or hard link
  7216. * then the link will be resolved and checked. If you have enabled &safemode;,
  7217. * or open_basedir further
  7218. * restrictions may apply.
  7219. * </p>
  7220. * @return bool true if the filename exists and is a directory, false
  7221. * otherwise.
  7222. */
  7223. function is_dir ($filename) {}
  7224. /**
  7225. * Tells whether the filename is a symbolic link
  7226. * @link http://www.php.net/manual/en/function.is-link.php
  7227. * @param filename string <p>
  7228. * Path to the file.
  7229. * </p>
  7230. * @return bool true if the filename exists and is a symbolic link, false
  7231. * otherwise.
  7232. */
  7233. function is_link ($filename) {}
  7234. /**
  7235. * Gives information about a file
  7236. * @link http://www.php.net/manual/en/function.stat.php
  7237. * @param filename string <p>
  7238. * Path to the file.
  7239. * </p>
  7240. * @return array <table>
  7241. * stat and fstat result
  7242. * format
  7243. * <tr valign="top">
  7244. * <td>Numeric</td>
  7245. * <td>Associative (since PHP 4.0.6)</td>
  7246. * <td>Description</td>
  7247. * </tr>
  7248. * <tr valign="top">
  7249. * <td>0</td>
  7250. * <td>dev</td>
  7251. * <td>device number</td>
  7252. * </tr>
  7253. * <tr valign="top">
  7254. * <td>1</td>
  7255. * <td>ino</td>
  7256. * <td>inode number *</td>
  7257. * </tr>
  7258. * <tr valign="top">
  7259. * <td>2</td>
  7260. * <td>mode</td>
  7261. * <td>inode protection mode</td>
  7262. * </tr>
  7263. * <tr valign="top">
  7264. * <td>3</td>
  7265. * <td>nlink</td>
  7266. * <td>number of links</td>
  7267. * </tr>
  7268. * <tr valign="top">
  7269. * <td>4</td>
  7270. * <td>uid</td>
  7271. * <td>userid of owner *</td>
  7272. * </tr>
  7273. * <tr valign="top">
  7274. * <td>5</td>
  7275. * <td>gid</td>
  7276. * <td>groupid of owner *</td>
  7277. * </tr>
  7278. * <tr valign="top">
  7279. * <td>6</td>
  7280. * <td>rdev</td>
  7281. * <td>device type, if inode device</td>
  7282. * </tr>
  7283. * <tr valign="top">
  7284. * <td>7</td>
  7285. * <td>size</td>
  7286. * <td>size in bytes</td>
  7287. * </tr>
  7288. * <tr valign="top">
  7289. * <td>8</td>
  7290. * <td>atime</td>
  7291. * <td>time of last access (Unix timestamp)</td>
  7292. * </tr>
  7293. * <tr valign="top">
  7294. * <td>9</td>
  7295. * <td>mtime</td>
  7296. * <td>time of last modification (Unix timestamp)</td>
  7297. * </tr>
  7298. * <tr valign="top">
  7299. * <td>10</td>
  7300. * <td>ctime</td>
  7301. * <td>time of last inode change (Unix timestamp)</td>
  7302. * </tr>
  7303. * <tr valign="top">
  7304. * <td>11</td>
  7305. * <td>blksize</td>
  7306. * <td>blocksize of filesystem IO **</td>
  7307. * </tr>
  7308. * <tr valign="top">
  7309. * <td>12</td>
  7310. * <td>blocks</td>
  7311. * <td>number of 512-byte blocks allocated **</td>
  7312. * </tr>
  7313. * </table>
  7314. * * On Windows this will always be 0.
  7315. * </p>
  7316. * <p>
  7317. * ** Only valid on systems supporting the st_blksize type - other
  7318. * systems (e.g. Windows) return -1.
  7319. * </p>
  7320. * <p>
  7321. * In case of error, stat returns false.
  7322. */
  7323. function stat ($filename) {}
  7324. /**
  7325. * Gives information about a file or symbolic link
  7326. * @link http://www.php.net/manual/en/function.lstat.php
  7327. * @param filename string <p>
  7328. * Path to a file or a symbolic link.
  7329. * </p>
  7330. * @return array See the manual page for stat for information on
  7331. * the structure of the array that lstat returns.
  7332. * This function is identical to the stat function
  7333. * except that if the filename parameter is a symbolic
  7334. * link, the status of the symbolic link is returned, not the status of the
  7335. * file pointed to by the symbolic link.
  7336. */
  7337. function lstat ($filename) {}
  7338. /**
  7339. * Changes file owner
  7340. * @link http://www.php.net/manual/en/function.chown.php
  7341. * @param filename string <p>
  7342. * Path to the file.
  7343. * </p>
  7344. * @param user mixed <p>
  7345. * A user name or number.
  7346. * </p>
  7347. * @return bool Returns true on success or false on failure.
  7348. */
  7349. function chown ($filename, $user) {}
  7350. /**
  7351. * Changes file group
  7352. * @link http://www.php.net/manual/en/function.chgrp.php
  7353. * @param filename string <p>
  7354. * Path to the file.
  7355. * </p>
  7356. * @param group mixed <p>
  7357. * A group name or number.
  7358. * </p>
  7359. * @return bool Returns true on success or false on failure.
  7360. */
  7361. function chgrp ($filename, $group) {}
  7362. /**
  7363. * Changes user ownership of symlink
  7364. * @link http://www.php.net/manual/en/function.lchown.php
  7365. * @param filename string <p>
  7366. * Path to the file.
  7367. * </p>
  7368. * @param user mixed <p>
  7369. * User name or number.
  7370. * </p>
  7371. * @return bool Returns true on success or false on failure.
  7372. */
  7373. function lchown ($filename, $user) {}
  7374. /**
  7375. * Changes group ownership of symlink
  7376. * @link http://www.php.net/manual/en/function.lchgrp.php
  7377. * @param filename string <p>
  7378. * Path to the symlink.
  7379. * </p>
  7380. * @param group mixed <p>
  7381. * The group specified by name or number.
  7382. * </p>
  7383. * @return bool Returns true on success or false on failure.
  7384. */
  7385. function lchgrp ($filename, $group) {}
  7386. /**
  7387. * Changes file mode
  7388. * @link http://www.php.net/manual/en/function.chmod.php
  7389. * @param filename string <p>
  7390. * Path to the file.
  7391. * </p>
  7392. * @param mode int <p>
  7393. * Note that mode is not automatically
  7394. * assumed to be an octal value, so strings (such as "g+w") will
  7395. * not work properly. To ensure the expected operation,
  7396. * you need to prefix mode with a zero (0):
  7397. * </p>
  7398. * <p>
  7399. * ]]>
  7400. * </p>
  7401. * <p>
  7402. * The mode parameter consists of three octal
  7403. * number components specifying access restrictions for the owner,
  7404. * the user group in which the owner is in, and to everybody else in
  7405. * this order. One component can be computed by adding up the needed
  7406. * permissions for that target user base. Number 1 means that you
  7407. * grant execute rights, number 2 means that you make the file
  7408. * writeable, number 4 means that you make the file readable. Add
  7409. * up these numbers to specify needed rights. You can also read more
  7410. * about modes on Unix systems with 'man 1 chmod'
  7411. * and 'man 2 chmod'.
  7412. * </p>
  7413. * <p>
  7414. * @return bool Returns true on success or false on failure.
  7415. */
  7416. function chmod ($filename, $mode) {}
  7417. /**
  7418. * Sets access and modification time of file
  7419. * @link http://www.php.net/manual/en/function.touch.php
  7420. * @param filename string <p>
  7421. * The name of the file being touched.
  7422. * </p>
  7423. * @param time int[optional] <p>
  7424. * The touch time. If time is not supplied,
  7425. * the current system time is used.
  7426. * </p>
  7427. * @param atime int[optional] <p>
  7428. * If present, the access time of the given filename is set to
  7429. * the value of atime. Otherwise, it is set to
  7430. * time.
  7431. * </p>
  7432. * @return bool Returns true on success or false on failure.
  7433. */
  7434. function touch ($filename, $time = null, $atime = null) {}
  7435. /**
  7436. * Clears file status cache
  7437. * @link http://www.php.net/manual/en/function.clearstatcache.php
  7438. * @param clear_realpath_cache bool[optional] <p>
  7439. * Whether to clear the realpath cache or not.
  7440. * </p>
  7441. * @param filename string[optional] <p>
  7442. * Clear the realpath cache for a specific filename; only used if
  7443. * clear_realpath_cache is true.
  7444. * </p>
  7445. * @return void
  7446. */
  7447. function clearstatcache ($clear_realpath_cache = null, $filename = null) {}
  7448. /**
  7449. * Returns the total size of a filesystem or disk partition
  7450. * @link http://www.php.net/manual/en/function.disk-total-space.php
  7451. * @param directory string <p>
  7452. * A directory of the filesystem or disk partition.
  7453. * </p>
  7454. * @return float the total number of bytes as a float
  7455. * &return.falseforfailure;.
  7456. */
  7457. function disk_total_space ($directory) {}
  7458. /**
  7459. * Returns available space on filesystem or disk partition
  7460. * @link http://www.php.net/manual/en/function.disk-free-space.php
  7461. * @param directory string <p>
  7462. * A directory of the filesystem or disk partition.
  7463. * </p>
  7464. * <p>
  7465. * Given a file name instead of a directory, the behaviour of the
  7466. * function is unspecified and may differ between operating systems and
  7467. * PHP versions.
  7468. * </p>
  7469. * @return float the number of available bytes as a float
  7470. * &return.falseforfailure;.
  7471. */
  7472. function disk_free_space ($directory) {}
  7473. /**
  7474. * &Alias; <function>disk_free_space</function>
  7475. * @link http://www.php.net/manual/en/function.diskfreespace.php
  7476. * @param path
  7477. */
  7478. function diskfreespace ($path) {}
  7479. /**
  7480. * Get realpath cache size
  7481. * @link http://www.php.net/manual/en/function.realpath_cache_size.php
  7482. * @return int how much memory realpath cache is using.
  7483. */
  7484. function realpath_cache_size () {}
  7485. /**
  7486. * Get realpath cache entries
  7487. * @link http://www.php.net/manual/en/function.realpath_cache_get.php
  7488. * @return array an array of realpath cache entries. The keys are original path
  7489. * entries, and the values are arrays of data items, containing the resolved
  7490. * path, expiration date, and other options kept in the cache.
  7491. */
  7492. function realpath_cache_get () {}
  7493. /**
  7494. * Send mail
  7495. * @link http://www.php.net/manual/en/function.mail.php
  7496. * @param to string <p>
  7497. * Receiver, or receivers of the mail.
  7498. * </p>
  7499. * <p>
  7500. * The formatting of this string must comply with
  7501. * RFC 2822. Some examples are:
  7502. * user@example.com
  7503. * user@example.com, anotheruser@example.com
  7504. * User &lt;user@example.com&gt;
  7505. * User &lt;user@example.com&gt;, Another User &lt;anotheruser@example.com&gt;
  7506. * </p>
  7507. * @param subject string <p>
  7508. * Subject of the email to be sent.
  7509. * </p>
  7510. * <p>
  7511. * Subject must satisfy RFC 2047.
  7512. * </p>
  7513. * @param message string <p>
  7514. * Message to be sent.
  7515. * </p>
  7516. * <p>
  7517. * Each line should be separated with a LF (\n). Lines should not be larger
  7518. * than 70 characters.
  7519. * </p>
  7520. * <p>
  7521. * (Windows only) When PHP is talking to a SMTP server directly, if a full
  7522. * stop is found on the start of a line, it is removed. To counter-act this,
  7523. * replace these occurrences with a double dot.
  7524. * ]]>
  7525. * </p>
  7526. * @param additional_headers string[optional] <p>
  7527. * String to be inserted at the end of the email header.
  7528. * </p>
  7529. * <p>
  7530. * This is typically used to add extra headers (From, Cc, and Bcc).
  7531. * Multiple extra headers should be separated with a CRLF (\r\n).
  7532. * </p>
  7533. * <p>
  7534. * When sending mail, the mail must contain
  7535. * a From header. This can be set with the
  7536. * additional_headers parameter, or a default
  7537. * can be set in &php.ini;.
  7538. * </p>
  7539. * <p>
  7540. * Failing to do this will result in an error
  7541. * message similar to Warning: mail(): "sendmail_from" not
  7542. * set in php.ini or custom "From:" header missing.
  7543. * The From header sets also
  7544. * Return-Path under Windows.
  7545. * </p>
  7546. * <p>
  7547. * If messages are not received, try using a LF (\n) only.
  7548. * Some poor quality Unix mail transfer agents replace LF by CRLF
  7549. * automatically (which leads to doubling CR if CRLF is used).
  7550. * This should be a last resort, as it does not comply with
  7551. * RFC 2822.
  7552. * </p>
  7553. * @param additional_parameters string[optional] <p>
  7554. * The additional_parameters parameter
  7555. * can be used to pass additional flags as command line options to the
  7556. * program configured to be used when sending mail, as defined by the
  7557. * sendmail_path configuration setting. For example,
  7558. * this can be used to set the envelope sender address when using
  7559. * sendmail with the -f sendmail option.
  7560. * </p>
  7561. * <p>
  7562. * The user that the webserver runs as should be added as a trusted user to the
  7563. * sendmail configuration to prevent a 'X-Warning' header from being added
  7564. * to the message when the envelope sender (-f) is set using this method.
  7565. * For sendmail users, this file is /etc/mail/trusted-users.
  7566. * </p>
  7567. * @return bool true if the mail was successfully accepted for delivery, false otherwise.
  7568. * </p>
  7569. * <p>
  7570. * It is important to note that just because the mail was accepted for delivery,
  7571. * it does NOT mean the mail will actually reach the intended destination.
  7572. */
  7573. function mail ($to, $subject, $message, $additional_headers = null, $additional_parameters = null) {}
  7574. /**
  7575. * Calculate the hash value needed by EZMLM
  7576. * @link http://www.php.net/manual/en/function.ezmlm-hash.php
  7577. * @param addr string <p>
  7578. * The email address that's being hashed.
  7579. * </p>
  7580. * @return int The hash value of addr.
  7581. */
  7582. function ezmlm_hash ($addr) {}
  7583. /**
  7584. * Open connection to system logger
  7585. * @link http://www.php.net/manual/en/function.openlog.php
  7586. * @param ident string <p>
  7587. * The string ident is added to each message.
  7588. * </p>
  7589. * @param option int <p>
  7590. * The option argument is used to indicate
  7591. * what logging options will be used when generating a log message.
  7592. * <table>
  7593. * openlog Options
  7594. * <tr valign="top">
  7595. * <td>Constant</td>
  7596. * <td>Description</td>
  7597. * </tr>
  7598. * <tr valign="top">
  7599. * <td>LOG_CONS</td>
  7600. * <td>
  7601. * if there is an error while sending data to the system logger,
  7602. * write directly to the system console
  7603. * </td>
  7604. * </tr>
  7605. * <tr valign="top">
  7606. * <td>LOG_NDELAY</td>
  7607. * <td>
  7608. * open the connection to the logger immediately
  7609. * </td>
  7610. * </tr>
  7611. * <tr valign="top">
  7612. * <td>LOG_ODELAY</td>
  7613. * <td>
  7614. * (default) delay opening the connection until the first
  7615. * message is logged
  7616. * </td>
  7617. * </tr>
  7618. * <tr valign="top">
  7619. * <td>LOG_PERROR</td>
  7620. * <td>print log message also to standard error</td>
  7621. * </tr>
  7622. * <tr valign="top">
  7623. * <td>LOG_PID</td>
  7624. * <td>include PID with each message</td>
  7625. * </tr>
  7626. * </table>
  7627. * You can use one or more of this options. When using multiple options
  7628. * you need to OR them, i.e. to open the connection
  7629. * immediately, write to the console and include the PID in each message,
  7630. * you will use: LOG_CONS | LOG_NDELAY | LOG_PID
  7631. * </p>
  7632. * @param facility int <p>
  7633. * The facility argument is used to specify what
  7634. * type of program is logging the message. This allows you to specify
  7635. * (in your machine's syslog configuration) how messages coming from
  7636. * different facilities will be handled.
  7637. * <table>
  7638. * openlog Facilities
  7639. * <tr valign="top">
  7640. * <td>Constant</td>
  7641. * <td>Description</td>
  7642. * </tr>
  7643. * <tr valign="top">
  7644. * <td>LOG_AUTH</td>
  7645. * <td>
  7646. * security/authorization messages (use
  7647. * LOG_AUTHPRIV instead
  7648. * in systems where that constant is defined)
  7649. * </td>
  7650. * </tr>
  7651. * <tr valign="top">
  7652. * <td>LOG_AUTHPRIV</td>
  7653. * <td>security/authorization messages (private)</td>
  7654. * </tr>
  7655. * <tr valign="top">
  7656. * <td>LOG_CRON</td>
  7657. * <td>clock daemon (cron and at)</td>
  7658. * </tr>
  7659. * <tr valign="top">
  7660. * <td>LOG_DAEMON</td>
  7661. * <td>other system daemons</td>
  7662. * </tr>
  7663. * <tr valign="top">
  7664. * <td>LOG_KERN</td>
  7665. * <td>kernel messages</td>
  7666. * </tr>
  7667. * <tr valign="top">
  7668. * <td>LOG_LOCAL0 ... LOG_LOCAL7</td>
  7669. * <td>reserved for local use, these are not available in Windows</td>
  7670. * </tr>
  7671. * <tr valign="top">
  7672. * <td>LOG_LPR</td>
  7673. * <td>line printer subsystem</td>
  7674. * </tr>
  7675. * <tr valign="top">
  7676. * <td>LOG_MAIL</td>
  7677. * <td>mail subsystem</td>
  7678. * </tr>
  7679. * <tr valign="top">
  7680. * <td>LOG_NEWS</td>
  7681. * <td>USENET news subsystem</td>
  7682. * </tr>
  7683. * <tr valign="top">
  7684. * <td>LOG_SYSLOG</td>
  7685. * <td>messages generated internally by syslogd</td>
  7686. * </tr>
  7687. * <tr valign="top">
  7688. * <td>LOG_USER</td>
  7689. * <td>generic user-level messages</td>
  7690. * </tr>
  7691. * <tr valign="top">
  7692. * <td>LOG_UUCP</td>
  7693. * <td>UUCP subsystem</td>
  7694. * </tr>
  7695. * </table>
  7696. * </p>
  7697. * <p>
  7698. * LOG_USER is the only valid log type under Windows
  7699. * operating systems
  7700. * </p>
  7701. * @return bool Returns true on success or false on failure.
  7702. */
  7703. function openlog ($ident, $option, $facility) {}
  7704. /**
  7705. * Generate a system log message
  7706. * @link http://www.php.net/manual/en/function.syslog.php
  7707. * @param priority int <p>
  7708. * priority is a combination of the facility and
  7709. * the level. Possible values are:
  7710. * <table>
  7711. * syslog Priorities (in descending order)
  7712. * <tr valign="top">
  7713. * <td>Constant</td>
  7714. * <td>Description</td>
  7715. * </tr>
  7716. * <tr valign="top">
  7717. * <td>LOG_EMERG</td>
  7718. * <td>system is unusable</td>
  7719. * </tr>
  7720. * <tr valign="top">
  7721. * <td>LOG_ALERT</td>
  7722. * <td>action must be taken immediately</td>
  7723. * </tr>
  7724. * <tr valign="top">
  7725. * <td>LOG_CRIT</td>
  7726. * <td>critical conditions</td>
  7727. * </tr>
  7728. * <tr valign="top">
  7729. * <td>LOG_ERR</td>
  7730. * <td>error conditions</td>
  7731. * </tr>
  7732. * <tr valign="top">
  7733. * <td>LOG_WARNING</td>
  7734. * <td>warning conditions</td>
  7735. * </tr>
  7736. * <tr valign="top">
  7737. * <td>LOG_NOTICE</td>
  7738. * <td>normal, but significant, condition</td>
  7739. * </tr>
  7740. * <tr valign="top">
  7741. * <td>LOG_INFO</td>
  7742. * <td>informational message</td>
  7743. * </tr>
  7744. * <tr valign="top">
  7745. * <td>LOG_DEBUG</td>
  7746. * <td>debug-level message</td>
  7747. * </tr>
  7748. * </table>
  7749. * </p>
  7750. * @param message string <p>
  7751. * The message to send, except that the two characters
  7752. * %m will be replaced by the error message string
  7753. * (strerror) corresponding to the present value of
  7754. * errno.
  7755. * </p>
  7756. * @return bool Returns true on success or false on failure.
  7757. */
  7758. function syslog ($priority, $message) {}
  7759. /**
  7760. * Close connection to system logger
  7761. * @link http://www.php.net/manual/en/function.closelog.php
  7762. * @return bool Returns true on success or false on failure.
  7763. */
  7764. function closelog () {}
  7765. /**
  7766. * Initializes all syslog related variables
  7767. * @link http://www.php.net/manual/en/function.define-syslog-variables.php
  7768. * @deprecated Deprecated as of PHP 5.3.0. Relying on this feature is highly discouraged.
  7769. * @return void
  7770. */
  7771. function define_syslog_variables () {}
  7772. /**
  7773. * Combined linear congruential generator
  7774. * @link http://www.php.net/manual/en/function.lcg-value.php
  7775. * @return float A pseudo random float value in the range of (0, 1)
  7776. */
  7777. function lcg_value () {}
  7778. /**
  7779. * Calculate the metaphone key of a string
  7780. * @link http://www.php.net/manual/en/function.metaphone.php
  7781. * @param str string <p>
  7782. * The input string.
  7783. * </p>
  7784. * @param phonemes int[optional] <p>
  7785. * This parameter restricts the returned metaphone key to
  7786. * phonemes characters in length.
  7787. * The default value of 0 means no restriction.
  7788. * </p>
  7789. * @return string the metaphone key as a string, &return.falseforfailure;.
  7790. */
  7791. function metaphone ($str, $phonemes = null) {}
  7792. /**
  7793. * Turn on output buffering
  7794. * @link http://www.php.net/manual/en/function.ob-start.php
  7795. * @param output_callback callback[optional] <p>
  7796. * An optional output_callback function may be
  7797. * specified. This function takes a string as a parameter and should
  7798. * return a string. The function will be called when
  7799. * the output buffer is flushed (sent) or cleaned (with
  7800. * ob_flush, ob_clean or similar
  7801. * function) or when the output buffer
  7802. * is flushed to the browser at the end of the request. When
  7803. * output_callback is called, it will receive the
  7804. * contents of the output buffer as its parameter and is expected to
  7805. * return a new output buffer as a result, which will be sent to the
  7806. * browser. If the output_callback is not a
  7807. * callable function, this function will return false.
  7808. * </p>
  7809. * <p>
  7810. * If the callback function has two parameters, the second parameter is
  7811. * filled with a bit-field consisting of
  7812. * PHP_OUTPUT_HANDLER_START,
  7813. * PHP_OUTPUT_HANDLER_CONT and
  7814. * PHP_OUTPUT_HANDLER_END.
  7815. * </p>
  7816. * <p>
  7817. * If output_callback returns false original
  7818. * input is sent to the browser.
  7819. * </p>
  7820. * <p>
  7821. * The output_callback parameter may be bypassed
  7822. * by passing a &null; value.
  7823. * </p>
  7824. * <p>
  7825. * ob_end_clean, ob_end_flush,
  7826. * ob_clean, ob_flush and
  7827. * ob_start may not be called from a callback
  7828. * function. If you call them from callback function, the behavior is
  7829. * undefined. If you would like to delete the contents of a buffer,
  7830. * return "" (a null string) from callback function.
  7831. * You can't even call functions using the output buffering functions like
  7832. * print_r($expression, true) or
  7833. * highlight_file($filename, true) from a callback
  7834. * function.
  7835. * </p>
  7836. * <p>
  7837. * In PHP 4.0.4, ob_gzhandler was introduced to
  7838. * facilitate sending gz-encoded data to web browsers that support
  7839. * compressed web pages. ob_gzhandler determines
  7840. * what type of content encoding the browser will accept and will return
  7841. * its output accordingly.
  7842. * </p>
  7843. * @param chunk_size int[optional] <p>
  7844. * If the optional parameter chunk_size is passed, the
  7845. * buffer will be flushed after any output call which causes the buffer's
  7846. * length to equal or exceed chunk_size.
  7847. * Default value 0 means that the function is called only in the end,
  7848. * other special value 1 sets chunk_size to 4096.
  7849. * </p>
  7850. * @param erase bool[optional] <p>
  7851. * If the optional parameter erase is set to false,
  7852. * the buffer will not be deleted until the script finishes.
  7853. * This causes that flushing and cleaning functions would issue a notice
  7854. * and return false if called.
  7855. * </p>
  7856. * @return bool Returns true on success or false on failure.
  7857. */
  7858. function ob_start ($output_callback = null, $chunk_size = null, $erase = null) {}
  7859. /**
  7860. * Flush (send) the output buffer
  7861. * @link http://www.php.net/manual/en/function.ob-flush.php
  7862. * @return void
  7863. */
  7864. function ob_flush () {}
  7865. /**
  7866. * Clean (erase) the output buffer
  7867. * @link http://www.php.net/manual/en/function.ob-clean.php
  7868. * @return void
  7869. */
  7870. function ob_clean () {}
  7871. /**
  7872. * Flush (send) the output buffer and turn off output buffering
  7873. * @link http://www.php.net/manual/en/function.ob-end-flush.php
  7874. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  7875. * function without an active buffer or that for some reason a buffer could
  7876. * not be deleted (possible for special buffer).
  7877. */
  7878. function ob_end_flush () {}
  7879. /**
  7880. * Clean (erase) the output buffer and turn off output buffering
  7881. * @link http://www.php.net/manual/en/function.ob-end-clean.php
  7882. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  7883. * function without an active buffer or that for some reason a buffer could
  7884. * not be deleted (possible for special buffer).
  7885. */
  7886. function ob_end_clean () {}
  7887. /**
  7888. * Flush the output buffer, return it as a string and turn off output buffering
  7889. * @link http://www.php.net/manual/en/function.ob-get-flush.php
  7890. * @return string the output buffer or false if no buffering is active.
  7891. */
  7892. function ob_get_flush () {}
  7893. /**
  7894. * Get current buffer contents and delete current output buffer
  7895. * @link http://www.php.net/manual/en/function.ob-get-clean.php
  7896. * @return string the contents of the output buffer and end output buffering.
  7897. * If output buffering isn't active then false is returned.
  7898. */
  7899. function ob_get_clean () {}
  7900. /**
  7901. * Return the length of the output buffer
  7902. * @link http://www.php.net/manual/en/function.ob-get-length.php
  7903. * @return int the length of the output buffer contents or false if no
  7904. * buffering is active.
  7905. */
  7906. function ob_get_length () {}
  7907. /**
  7908. * Return the nesting level of the output buffering mechanism
  7909. * @link http://www.php.net/manual/en/function.ob-get-level.php
  7910. * @return int the level of nested output buffering handlers or zero if output
  7911. * buffering is not active.
  7912. */
  7913. function ob_get_level () {}
  7914. /**
  7915. * Get status of output buffers
  7916. * @link http://www.php.net/manual/en/function.ob-get-status.php
  7917. * @param full_status bool[optional] <p>
  7918. * true to return all active output buffer levels. If false or not
  7919. * set, only the top level output buffer is returned.
  7920. * </p>
  7921. * @return array If called without the full_status parameter
  7922. * or with full_status = false a simple array
  7923. * with the following elements is returned:
  7924. * 2
  7925. * [type] => 0
  7926. * [status] => 0
  7927. * [name] => URL-Rewriter
  7928. * [del] => 1
  7929. * )
  7930. * ]]>
  7931. * Simple ob_get_status results
  7932. * KeyValue
  7933. * levelOutput nesting level
  7934. * typePHP_OUTPUT_HANDLER_INTERNAL (0) or PHP_OUTPUT_HANDLER_USER (1)
  7935. * statusOne of PHP_OUTPUT_HANDLER_START (0), PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2)
  7936. * nameName of active output handler or ' default output handler' if none is set
  7937. * delErase-flag as set by ob_start
  7938. * </p>
  7939. * <p>
  7940. * If called with full_status = true an array
  7941. * with one element for each active output buffer level is returned.
  7942. * The output level is used as key of the top level array and each array
  7943. * element itself is another array holding status information
  7944. * on one active output level.
  7945. * Array
  7946. * (
  7947. * [chunk_size] => 0
  7948. * [size] => 40960
  7949. * [block_size] => 10240
  7950. * [type] => 1
  7951. * [status] => 0
  7952. * [name] => default output handler
  7953. * [del] => 1
  7954. * )
  7955. * [1] => Array
  7956. * (
  7957. * [chunk_size] => 0
  7958. * [size] => 40960
  7959. * [block_size] => 10240
  7960. * [type] => 0
  7961. * [buffer_size] => 0
  7962. * [status] => 0
  7963. * [name] => URL-Rewriter
  7964. * [del] => 1
  7965. * )
  7966. * )
  7967. * ]]>
  7968. * </p>
  7969. * <p>
  7970. * The full output contains these additional elements:
  7971. * Full ob_get_status results
  7972. * KeyValue
  7973. * chunk_sizeChunk size as set by ob_start
  7974. * size...
  7975. * blocksize...
  7976. */
  7977. function ob_get_status ($full_status = null) {}
  7978. /**
  7979. * Return the contents of the output buffer
  7980. * @link http://www.php.net/manual/en/function.ob-get-contents.php
  7981. * @return string This will return the contents of the output buffer or false, if output
  7982. * buffering isn't active.
  7983. */
  7984. function ob_get_contents () {}
  7985. /**
  7986. * Turn implicit flush on/off
  7987. * @link http://www.php.net/manual/en/function.ob-implicit-flush.php
  7988. * @param flag int[optional] <p>
  7989. * true to turn implicit flushing on, false otherwise.
  7990. * </p>
  7991. * @return void
  7992. */
  7993. function ob_implicit_flush ($flag = null) {}
  7994. /**
  7995. * List all output handlers in use
  7996. * @link http://www.php.net/manual/en/function.ob-list-handlers.php
  7997. * @return array This will return an array with the output handlers in use (if any). If
  7998. * output_buffering is enabled or
  7999. * an anonymous function was used with ob_start,
  8000. * ob_list_handlers will return "default output
  8001. * handler".
  8002. */
  8003. function ob_list_handlers () {}
  8004. /**
  8005. * Sort an array by key
  8006. * @link http://www.php.net/manual/en/function.ksort.php
  8007. * @param array array <p>
  8008. * The input array.
  8009. * </p>
  8010. * @param sort_flags int[optional] <p>
  8011. * You may modify the behavior of the sort using the optional
  8012. * parameter sort_flags, for details
  8013. * see sort.
  8014. * </p>
  8015. * @return bool Returns true on success or false on failure.
  8016. */
  8017. function ksort (array &$array, $sort_flags = null) {}
  8018. /**
  8019. * Sort an array by key in reverse order
  8020. * @link http://www.php.net/manual/en/function.krsort.php
  8021. * @param array array <p>
  8022. * The input array.
  8023. * </p>
  8024. * @param sort_flags int[optional] <p>
  8025. * You may modify the behavior of the sort using the optional parameter
  8026. * sort_flags, for details see
  8027. * sort.
  8028. * </p>
  8029. * @return bool Returns true on success or false on failure.
  8030. */
  8031. function krsort (array &$array, $sort_flags = null) {}
  8032. /**
  8033. * Sort an array using a "natural order" algorithm
  8034. * @link http://www.php.net/manual/en/function.natsort.php
  8035. * @param array array <p>
  8036. * The input array.
  8037. * </p>
  8038. * @return bool Returns true on success or false on failure.
  8039. */
  8040. function natsort (array &$array) {}
  8041. /**
  8042. * Sort an array using a case insensitive "natural order" algorithm
  8043. * @link http://www.php.net/manual/en/function.natcasesort.php
  8044. * @param array array <p>
  8045. * The input array.
  8046. * </p>
  8047. * @return bool Returns true on success or false on failure.
  8048. */
  8049. function natcasesort (array &$array) {}
  8050. /**
  8051. * Sort an array and maintain index association
  8052. * @link http://www.php.net/manual/en/function.asort.php
  8053. * @param array array <p>
  8054. * The input array.
  8055. * </p>
  8056. * @param sort_flags int[optional] <p>
  8057. * You may modify the behavior of the sort using the optional
  8058. * parameter sort_flags, for details
  8059. * see sort.
  8060. * </p>
  8061. * @return bool Returns true on success or false on failure.
  8062. */
  8063. function asort (array &$array, $sort_flags = null) {}
  8064. /**
  8065. * Sort an array in reverse order and maintain index association
  8066. * @link http://www.php.net/manual/en/function.arsort.php
  8067. * @param array array <p>
  8068. * The input array.
  8069. * </p>
  8070. * @param sort_flags int[optional] <p>
  8071. * You may modify the behavior of the sort using the optional parameter
  8072. * sort_flags, for details see
  8073. * sort.
  8074. * </p>
  8075. * @return bool Returns true on success or false on failure.
  8076. */
  8077. function arsort (array &$array, $sort_flags = null) {}
  8078. /**
  8079. * Sort an array
  8080. * @link http://www.php.net/manual/en/function.sort.php
  8081. * @param array array <p>
  8082. * The input array.
  8083. * </p>
  8084. * @param sort_flags int[optional] <p>
  8085. * The optional second parameter sort_flags
  8086. * may be used to modify the sorting behavior using these values:
  8087. * </p>
  8088. * <p>
  8089. * Sorting type flags:
  8090. * SORT_REGULAR - compare items normally
  8091. * (don't change types)
  8092. * @return bool Returns true on success or false on failure.
  8093. */
  8094. function sort (array &$array, $sort_flags = null) {}
  8095. /**
  8096. * Sort an array in reverse order
  8097. * @link http://www.php.net/manual/en/function.rsort.php
  8098. * @param array array <p>
  8099. * The input array.
  8100. * </p>
  8101. * @param sort_flags int[optional] <p>
  8102. * You may modify the behavior of the sort using the optional
  8103. * parameter sort_flags, for details see
  8104. * sort.
  8105. * </p>
  8106. * @return bool Returns true on success or false on failure.
  8107. */
  8108. function rsort (array &$array, $sort_flags = null) {}
  8109. /**
  8110. * Sort an array by values using a user-defined comparison function
  8111. * @link http://www.php.net/manual/en/function.usort.php
  8112. * @param array array <p>
  8113. * The input array.
  8114. * </p>
  8115. * @param cmp_function callback <p>
  8116. * The comparison function must return an integer less than, equal to, or
  8117. * greater than zero if the first argument is considered to be
  8118. * respectively less than, equal to, or greater than the second.
  8119. * </p>
  8120. * @return bool Returns true on success or false on failure.
  8121. */
  8122. function usort (array &$array, $cmp_function) {}
  8123. /**
  8124. * Sort an array with a user-defined comparison function and maintain index association
  8125. * @link http://www.php.net/manual/en/function.uasort.php
  8126. * @param array array <p>
  8127. * The input array.
  8128. * </p>
  8129. * @param cmp_function callback <p>
  8130. * See usort and uksort for
  8131. * examples of user-defined comparison functions.
  8132. * </p>
  8133. * @return bool Returns true on success or false on failure.
  8134. */
  8135. function uasort (array &$array, $cmp_function) {}
  8136. /**
  8137. * Sort an array by keys using a user-defined comparison function
  8138. * @link http://www.php.net/manual/en/function.uksort.php
  8139. * @param array array <p>
  8140. * The input array.
  8141. * </p>
  8142. * @param cmp_function callback <p>
  8143. * The callback comparison function.
  8144. * </p>
  8145. * <p>
  8146. * Function cmp_function should accept two
  8147. * parameters which will be filled by pairs of array keys.
  8148. * The comparison function must return an integer less than, equal
  8149. * to, or greater than zero if the first argument is considered to
  8150. * be respectively less than, equal to, or greater than the
  8151. * second.
  8152. * </p>
  8153. * @return bool Returns true on success or false on failure.
  8154. */
  8155. function uksort (array &$array, $cmp_function) {}
  8156. /**
  8157. * Shuffle an array
  8158. * @link http://www.php.net/manual/en/function.shuffle.php
  8159. * @param array array <p>
  8160. * The array.
  8161. * </p>
  8162. * @return bool Returns true on success or false on failure.
  8163. */
  8164. function shuffle (array &$array) {}
  8165. /**
  8166. * Apply a user function to every member of an array
  8167. * @link http://www.php.net/manual/en/function.array-walk.php
  8168. * @param array array <p>
  8169. * The input array.
  8170. * </p>
  8171. * @param funcname callback <p>
  8172. * Typically, funcname takes on two parameters.
  8173. * The array parameter's value being the first, and
  8174. * the key/index second.
  8175. * </p>
  8176. * <p>
  8177. * If funcname needs to be working with the
  8178. * actual values of the array, specify the first parameter of
  8179. * funcname as a
  8180. * reference. Then,
  8181. * any changes made to those elements will be made in the
  8182. * original array itself.
  8183. * </p>
  8184. * <p>
  8185. * Users may not change the array itself from the
  8186. * callback function. e.g. Add/delete elements, unset elements, etc. If
  8187. * the array that array_walk is applied to is
  8188. * changed, the behavior of this function is undefined, and unpredictable.
  8189. * </p>
  8190. * @param userdata mixed[optional] <p>
  8191. * If the optional userdata parameter is supplied,
  8192. * it will be passed as the third parameter to the callback
  8193. * funcname.
  8194. * </p>
  8195. * @return bool Returns true on success or false on failure.
  8196. */
  8197. function array_walk (array &$array, $funcname, $userdata = null) {}
  8198. /**
  8199. * Apply a user function recursively to every member of an array
  8200. * @link http://www.php.net/manual/en/function.array-walk-recursive.php
  8201. * @param input array <p>
  8202. * The input array.
  8203. * </p>
  8204. * @param funcname callback <p>
  8205. * Typically, funcname takes on two parameters.
  8206. * The input parameter's value being the first, and
  8207. * the key/index second.
  8208. * </p>
  8209. * <p>
  8210. * If funcname needs to be working with the
  8211. * actual values of the array, specify the first parameter of
  8212. * funcname as a
  8213. * reference. Then,
  8214. * any changes made to those elements will be made in the
  8215. * original array itself.
  8216. * </p>
  8217. * @param userdata mixed[optional] <p>
  8218. * If the optional userdata parameter is supplied,
  8219. * it will be passed as the third parameter to the callback
  8220. * funcname.
  8221. * </p>
  8222. * @return bool Returns true on success or false on failure.
  8223. */
  8224. function array_walk_recursive (array &$input, $funcname, $userdata = null) {}
  8225. /**
  8226. * Count all elements in an array, or properties in an object
  8227. * @link http://www.php.net/manual/en/function.count.php
  8228. * @param var mixed <p>
  8229. * The array.
  8230. * </p>
  8231. * @param mode int[optional] <p>
  8232. * If the optional mode parameter is set to
  8233. * COUNT_RECURSIVE (or 1), count
  8234. * will recursively count the array. This is particularly useful for
  8235. * counting all the elements of a multidimensional array.
  8236. * count does not detect infinite recursion.
  8237. * </p>
  8238. * @return int the number of elements in var, which is
  8239. * typically an array, since anything else will have one
  8240. * element.
  8241. * </p>
  8242. * <p>
  8243. * If var is not an array or an object with
  8244. * implemented Countable interface,
  8245. * 1 will be returned.
  8246. * There is one exception, if var is &null;,
  8247. * 0 will be returned.
  8248. * </p>
  8249. * <p>
  8250. * count may return 0 for a variable that isn't set,
  8251. * but it may also return 0 for a variable that has been initialized with an
  8252. * empty array. Use isset to test if a variable is set.
  8253. */
  8254. function count ($var, $mode = null) {}
  8255. /**
  8256. * Set the internal pointer of an array to its last element
  8257. * @link http://www.php.net/manual/en/function.end.php
  8258. * @param array array <p>
  8259. * The array. This array is passed by reference because it is modified by
  8260. * the function. This means you must pass it a real variable and not
  8261. * a function returning an array because only actual variables may be
  8262. * passed by reference.
  8263. * </p>
  8264. * @return mixed the value of the last element or false for empty array.
  8265. */
  8266. function end (array &$array) {}
  8267. /**
  8268. * Rewind the internal array pointer
  8269. * @link http://www.php.net/manual/en/function.prev.php
  8270. * @param array array <p>
  8271. * The input array.
  8272. * </p>
  8273. * @return mixed the array value in the previous place that's pointed to by
  8274. * the internal array pointer, or false if there are no more
  8275. * elements.
  8276. */
  8277. function prev (array &$array) {}
  8278. /**
  8279. * Advance the internal array pointer of an array
  8280. * @link http://www.php.net/manual/en/function.next.php
  8281. * @param array array <p>
  8282. * The array being affected.
  8283. * </p>
  8284. * @return mixed the array value in the next place that's pointed to by the
  8285. * internal array pointer, or false if there are no more elements.
  8286. */
  8287. function next (array &$array) {}
  8288. /**
  8289. * Set the internal pointer of an array to its first element
  8290. * @link http://www.php.net/manual/en/function.reset.php
  8291. * @param array array <p>
  8292. * The input array.
  8293. * </p>
  8294. * @return mixed the value of the first array element, or false if the array is
  8295. * empty.
  8296. */
  8297. function reset (array &$array) {}
  8298. /**
  8299. * Return the current element in an array
  8300. * @link http://www.php.net/manual/en/function.current.php
  8301. * @param array array <p>
  8302. * The array.
  8303. * </p>
  8304. * @return mixed The current function simply returns the
  8305. * value of the array element that's currently being pointed to by the
  8306. * internal pointer. It does not move the pointer in any way. If the
  8307. * internal pointer points beyond the end of the elements list or the array is
  8308. * empty, current returns false.
  8309. */
  8310. function current (array &$array) {}
  8311. /**
  8312. * Fetch a key from an array
  8313. * @link http://www.php.net/manual/en/function.key.php
  8314. * @param array array <p>
  8315. * The array.
  8316. * </p>
  8317. * @return mixed The key function simply returns the
  8318. * key of the array element that's currently being pointed to by the
  8319. * internal pointer. It does not move the pointer in any way. If the
  8320. * internal pointer points beyond the end of the elements list or the array is
  8321. * empty, key returns &null;.
  8322. */
  8323. function key (array &$array) {}
  8324. /**
  8325. * Find lowest value
  8326. * @link http://www.php.net/manual/en/function.min.php
  8327. * @param values array <p>
  8328. * An array containing the values.
  8329. * </p>
  8330. * @return mixed min returns the numerically lowest of the
  8331. * parameter values.
  8332. */
  8333. function min (array $values) {}
  8334. /**
  8335. * Find highest value
  8336. * @link http://www.php.net/manual/en/function.max.php
  8337. * @param values array <p>
  8338. * An array containing the values.
  8339. * </p>
  8340. * @return mixed max returns the numerically highest of the
  8341. * parameter values. If multiple values can be considered of the same size,
  8342. * the one that is listed first will be returned.
  8343. * </p>
  8344. * <p>
  8345. * When max is given multiple arrays, the
  8346. * longest array is returned. If all the arrays have the same length,
  8347. * max will use lexicographic ordering to find the return
  8348. * value.
  8349. * </p>
  8350. * <p>
  8351. * When given a string it will be cast as an integer
  8352. * when comparing.
  8353. */
  8354. function max (array $values) {}
  8355. /**
  8356. * Checks if a value exists in an array
  8357. * @link http://www.php.net/manual/en/function.in-array.php
  8358. * @param needle mixed <p>
  8359. * The searched value.
  8360. * </p>
  8361. * <p>
  8362. * If needle is a string, the comparison is done
  8363. * in a case-sensitive manner.
  8364. * </p>
  8365. * @param haystack array <p>
  8366. * The array.
  8367. * </p>
  8368. * @param strict bool[optional] <p>
  8369. * If the third parameter strict is set to true
  8370. * then the in_array function will also check the
  8371. * types of the
  8372. * needle in the haystack.
  8373. * </p>
  8374. * @return bool true if needle is found in the array,
  8375. * false otherwise.
  8376. */
  8377. function in_array ($needle, array $haystack, $strict = null) {}
  8378. /**
  8379. * Searches the array for a given value and returns the corresponding key if successful
  8380. * @link http://www.php.net/manual/en/function.array-search.php
  8381. * @param needle mixed <p>
  8382. * The searched value.
  8383. * </p>
  8384. * <p>
  8385. * If needle is a string, the comparison is done
  8386. * in a case-sensitive manner.
  8387. * </p>
  8388. * @param haystack array <p>
  8389. * The array.
  8390. * </p>
  8391. * @param strict bool[optional] <p>
  8392. * If the third parameter strict is set to true
  8393. * then the array_search function will search for
  8394. * identical elements in the
  8395. * haystack. This means it will also check the
  8396. * types of the
  8397. * needle in the haystack,
  8398. * and objects must be the same instance.
  8399. * </p>
  8400. * @return mixed the key for needle if it is found in the
  8401. * array, false otherwise.
  8402. * </p>
  8403. * <p>
  8404. * If needle is found in haystack
  8405. * more than once, the first matching key is returned. To return the keys for
  8406. * all matching values, use array_keys with the optional
  8407. * search_value parameter instead.
  8408. */
  8409. function array_search ($needle, array $haystack, $strict = null) {}
  8410. /**
  8411. * Import variables into the current symbol table from an array
  8412. * @link http://www.php.net/manual/en/function.extract.php
  8413. * @param var_array array <p>
  8414. * Note that prefix is only required if
  8415. * extract_type is EXTR_PREFIX_SAME,
  8416. * EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID
  8417. * or EXTR_PREFIX_IF_EXISTS. If
  8418. * the prefixed result is not a valid variable name, it is not
  8419. * imported into the symbol table. Prefixes are automatically separated from
  8420. * the array key by an underscore character.
  8421. * </p>
  8422. * @param extract_type int[optional] <p>
  8423. * The way invalid/numeric keys and collisions are treated is determined
  8424. * by the extract_type. It can be one of the
  8425. * following values:
  8426. * EXTR_OVERWRITE
  8427. * If there is a collision, overwrite the existing variable.
  8428. * @param prefix string[optional] Only overwrite the variable if it already exists in the
  8429. * current symbol table, otherwise do nothing. This is useful
  8430. * for defining a list of valid variables and then extracting
  8431. * only those variables you have defined out of
  8432. * $_REQUEST, for example.
  8433. * @return int the number of variables successfully imported into the symbol
  8434. * table.
  8435. */
  8436. function extract (array $var_array, $extract_type = null, $prefix = null) {}
  8437. /**
  8438. * Create array containing variables and their values
  8439. * @link http://www.php.net/manual/en/function.compact.php
  8440. * @param varname mixed <p>
  8441. * compact takes a variable number of parameters.
  8442. * Each parameter can be either a string containing the name of the
  8443. * variable, or an array of variable names. The array can contain other
  8444. * arrays of variable names inside it; compact
  8445. * handles it recursively.
  8446. * </p>
  8447. * @param _ mixed[optional]
  8448. * @return array the output array with all the variables added to it.
  8449. */
  8450. function compact ($varname, $_ = null) {}
  8451. /**
  8452. * Fill an array with values
  8453. * @link http://www.php.net/manual/en/function.array-fill.php
  8454. * @param start_index int <p>
  8455. * The first index of the returned array.
  8456. * Supports non-negative indexes only.
  8457. * </p>
  8458. * @param num int <p>
  8459. * Number of elements to insert
  8460. * </p>
  8461. * @param value mixed <p>
  8462. * Value to use for filling
  8463. * </p>
  8464. * @return array the filled array
  8465. */
  8466. function array_fill ($start_index, $num, $value) {}
  8467. /**
  8468. * Fill an array with values, specifying keys
  8469. * @link http://www.php.net/manual/en/function.array-fill-keys.php
  8470. * @param keys array <p>
  8471. * Array of values that will be used as keys. Illegal values
  8472. * for key will be converted to string.
  8473. * </p>
  8474. * @param value mixed <p>
  8475. * Value to use for filling
  8476. * </p>
  8477. * @return array the filled array
  8478. */
  8479. function array_fill_keys (array $keys, $value) {}
  8480. /**
  8481. * Create an array containing a range of elements
  8482. * @link http://www.php.net/manual/en/function.range.php
  8483. * @param low mixed <p>
  8484. * Low value.
  8485. * </p>
  8486. * @param high mixed <p>
  8487. * High value.
  8488. * </p>
  8489. * @param step number[optional] <p>
  8490. * If a step value is given, it will be used as the
  8491. * increment between elements in the sequence. step
  8492. * should be given as a positive number. If not specified,
  8493. * step will default to 1.
  8494. * </p>
  8495. * @return array an array of elements from low to
  8496. * high, inclusive. If low > high, the sequence will
  8497. * be from high to low.
  8498. */
  8499. function range ($low, $high, $step = null) {}
  8500. /**
  8501. * Sort multiple or multi-dimensional arrays
  8502. * @link http://www.php.net/manual/en/function.array-multisort.php
  8503. * @param arr array <p>
  8504. * An array being sorted.
  8505. * </p>
  8506. * @param arg mixed[optional] <p>
  8507. * Optionally another array, or sort options for the
  8508. * previous array argument:
  8509. * SORT_ASC,
  8510. * SORT_DESC,
  8511. * SORT_REGULAR,
  8512. * SORT_NUMERIC,
  8513. * SORT_STRING.
  8514. * </p>
  8515. * @param arg mixed[optional]
  8516. * @param _ mixed[optional]
  8517. * @return bool Returns true on success or false on failure.
  8518. */
  8519. function array_multisort (array &$arr, $arg = null, $arg = null, $_ = null) {}
  8520. /**
  8521. * Push one or more elements onto the end of array
  8522. * @link http://www.php.net/manual/en/function.array-push.php
  8523. * @param array array <p>
  8524. * The input array.
  8525. * </p>
  8526. * @param var mixed <p>
  8527. * The pushed value.
  8528. * </p>
  8529. * @param _ mixed[optional]
  8530. * @return int the new number of elements in the array.
  8531. */
  8532. function array_push (array &$array, $var, $_ = null) {}
  8533. /**
  8534. * Pop the element off the end of array
  8535. * @link http://www.php.net/manual/en/function.array-pop.php
  8536. * @param array array <p>
  8537. * The array to get the value from.
  8538. * </p>
  8539. * @return mixed the last value of array.
  8540. * If array is empty (or is not an array),
  8541. * &null; will be returned.
  8542. */
  8543. function array_pop (array &$array) {}
  8544. /**
  8545. * Shift an element off the beginning of array
  8546. * @link http://www.php.net/manual/en/function.array-shift.php
  8547. * @param array array <p>
  8548. * The input array.
  8549. * </p>
  8550. * @return mixed the shifted value, or &null; if array is
  8551. * empty or is not an array.
  8552. */
  8553. function array_shift (array &$array) {}
  8554. /**
  8555. * Prepend one or more elements to the beginning of an array
  8556. * @link http://www.php.net/manual/en/function.array-unshift.php
  8557. * @param array array <p>
  8558. * The input array.
  8559. * </p>
  8560. * @param var mixed <p>
  8561. * The prepended variable.
  8562. * </p>
  8563. * @param _ mixed[optional]
  8564. * @return int the new number of elements in the array.
  8565. */
  8566. function array_unshift (array &$array, $var, $_ = null) {}
  8567. /**
  8568. * Remove a portion of the array and replace it with something else
  8569. * @link http://www.php.net/manual/en/function.array-splice.php
  8570. * @param input array <p>
  8571. * The input array.
  8572. * </p>
  8573. * @param offset int <p>
  8574. * If offset is positive then the start of removed
  8575. * portion is at that offset from the beginning of the
  8576. * input array. If offset
  8577. * is negative then it starts that far from the end of the
  8578. * input array.
  8579. * </p>
  8580. * @param length int[optional] <p>
  8581. * If length is omitted, removes everything
  8582. * from offset to the end of the array. If
  8583. * length is specified and is positive, then
  8584. * that many elements will be removed. If
  8585. * length is specified and is negative then
  8586. * the end of the removed portion will be that many elements from
  8587. * the end of the array. Tip: to remove everything from
  8588. * offset to the end of the array when
  8589. * replacement is also specified, use
  8590. * count($input) for
  8591. * length.
  8592. * </p>
  8593. * @param replacement mixed[optional] <p>
  8594. * If replacement array is specified, then the
  8595. * removed elements are replaced with elements from this array.
  8596. * </p>
  8597. * <p>
  8598. * If offset and length
  8599. * are such that nothing is removed, then the elements from the
  8600. * replacement array are inserted in the place
  8601. * specified by the offset. Note that keys in
  8602. * replacement array are not preserved.
  8603. * </p>
  8604. * <p>
  8605. * If replacement is just one element it is
  8606. * not necessary to put array()
  8607. * around it, unless the element is an array itself, an object or &null;.
  8608. * </p>
  8609. * @return array the array consisting of the extracted elements.
  8610. */
  8611. function array_splice (array &$input, $offset, $length = null, $replacement = null) {}
  8612. /**
  8613. * Extract a slice of the array
  8614. * @link http://www.php.net/manual/en/function.array-slice.php
  8615. * @param array array <p>
  8616. * The input array.
  8617. * </p>
  8618. * @param offset int <p>
  8619. * If offset is non-negative, the sequence will
  8620. * start at that offset in the array. If
  8621. * offset is negative, the sequence will
  8622. * start that far from the end of the array.
  8623. * </p>
  8624. * @param length int[optional] <p>
  8625. * If length is given and is positive, then
  8626. * the sequence will have that many elements in it. If
  8627. * length is given and is negative then the
  8628. * sequence will stop that many elements from the end of the
  8629. * array. If it is omitted, then the sequence will have everything
  8630. * from offset up until the end of the
  8631. * array.
  8632. * </p>
  8633. * @param preserve_keys bool[optional] <p>
  8634. * Note that array_slice will reorder and reset the
  8635. * array indices by default. You can change this behaviour by setting
  8636. * preserve_keys to true.
  8637. * </p>
  8638. * @return array the slice.
  8639. */
  8640. function array_slice (array $array, $offset, $length = null, $preserve_keys = null) {}
  8641. /**
  8642. * Merge one or more arrays
  8643. * @link http://www.php.net/manual/en/function.array-merge.php
  8644. * @param array1 array <p>
  8645. * Initial array to merge.
  8646. * </p>
  8647. * @param array2 array[optional]
  8648. * @param _ array[optional]
  8649. * @return array the resulting array.
  8650. */
  8651. function array_merge (array $array1, array $array2 = null, array $_ = null) {}
  8652. /**
  8653. * Merge two or more arrays recursively
  8654. * @link http://www.php.net/manual/en/function.array-merge-recursive.php
  8655. * @param array1 array <p>
  8656. * Initial array to merge.
  8657. * </p>
  8658. * @param _ array[optional]
  8659. * @return array An array of values resulted from merging the arguments together.
  8660. */
  8661. function array_merge_recursive (array $array1, array $_ = null) {}
  8662. /**
  8663. * Replaces elements from passed arrays into the first array
  8664. * @link http://www.php.net/manual/en/function.array-replace.php
  8665. * @param array array <p>
  8666. * The array in which elements are replaced.
  8667. * </p>
  8668. * @param array1 array <p>
  8669. * The array from which elements will be extracted.
  8670. * </p>
  8671. * @param array2 array[optional]
  8672. * @param _ array[optional]
  8673. * @return array an array, or &null; if an error occurs.
  8674. */
  8675. function array_replace (array &$array, array &$array1, array &$array2 = null, array &$_ = null) {}
  8676. /**
  8677. * Replaces elements from passed arrays into the first array recursively
  8678. * @link http://www.php.net/manual/en/function.array-replace-recursive.php
  8679. * @param array array <p>
  8680. * The array in which elements are replaced.
  8681. * </p>
  8682. * @param array1 array <p>
  8683. * The array from which elements will be extracted.
  8684. * </p>
  8685. * @param array2 array[optional]
  8686. * @param _ array[optional]
  8687. * @return array an array, or &null; if an error occurs.
  8688. */
  8689. function array_replace_recursive (array &$array, array &$array1, array &$array2 = null, array &$_ = null) {}
  8690. /**
  8691. * Return all the keys of an array
  8692. * @link http://www.php.net/manual/en/function.array-keys.php
  8693. * @param input array <p>
  8694. * An array containing keys to return.
  8695. * </p>
  8696. * @param search_value mixed[optional] <p>
  8697. * If specified, then only keys containing these values are returned.
  8698. * </p>
  8699. * @param strict bool[optional] <p>
  8700. * Determines if strict comparison (===) should be used during the search.
  8701. * </p>
  8702. * @return array an array of all the keys in input.
  8703. */
  8704. function array_keys (array $input, $search_value = null, $strict = null) {}
  8705. /**
  8706. * Return all the values of an array
  8707. * @link http://www.php.net/manual/en/function.array-values.php
  8708. * @param input array <p>
  8709. * The array.
  8710. * </p>
  8711. * @return array an indexed array of values.
  8712. */
  8713. function array_values (array $input) {}
  8714. /**
  8715. * Counts all the values of an array
  8716. * @link http://www.php.net/manual/en/function.array-count-values.php
  8717. * @param input array <p>
  8718. * The array of values to count
  8719. * </p>
  8720. * @return array an associative array of values from input as
  8721. * keys and their count as value.
  8722. */
  8723. function array_count_values (array $input) {}
  8724. /**
  8725. * Return an array with elements in reverse order
  8726. * @link http://www.php.net/manual/en/function.array-reverse.php
  8727. * @param array array <p>
  8728. * The input array.
  8729. * </p>
  8730. * @param preserve_keys bool[optional] <p>
  8731. * If set to true keys are preserved.
  8732. * </p>
  8733. * @return array the reversed array.
  8734. */
  8735. function array_reverse (array $array, $preserve_keys = null) {}
  8736. /**
  8737. * Iteratively reduce the array to a single value using a callback function
  8738. * @link http://www.php.net/manual/en/function.array-reduce.php
  8739. * @param input array <p>
  8740. * The input array.
  8741. * </p>
  8742. * @param function callback <p>
  8743. * The callback function.
  8744. * </p>
  8745. * @param initial mixed[optional] <p>
  8746. * If the optional initial is available, it will
  8747. * be used at the beginning of the process, or as a final result in case
  8748. * the array is empty.
  8749. * </p>
  8750. * @return mixed the resulting value.
  8751. * </p>
  8752. * <p>
  8753. * If the array is empty and initial is not passed,
  8754. * array_reduce returns &null;.
  8755. */
  8756. function array_reduce (array $input, $function, $initial = null) {}
  8757. /**
  8758. * Pad array to the specified length with a value
  8759. * @link http://www.php.net/manual/en/function.array-pad.php
  8760. * @param input array <p>
  8761. * Initial array of values to pad.
  8762. * </p>
  8763. * @param pad_size int <p>
  8764. * New size of the array.
  8765. * </p>
  8766. * @param pad_value mixed <p>
  8767. * Value to pad if input is less than
  8768. * pad_size.
  8769. * </p>
  8770. * @return array a copy of the input padded to size specified
  8771. * by pad_size with value
  8772. * pad_value. If pad_size is
  8773. * positive then the array is padded on the right, if it's negative then
  8774. * on the left. If the absolute value of pad_size is less than or equal to
  8775. * the length of the input then no padding takes place.
  8776. */
  8777. function array_pad (array $input, $pad_size, $pad_value) {}
  8778. /**
  8779. * Exchanges all keys with their associated values in an array
  8780. * @link http://www.php.net/manual/en/function.array-flip.php
  8781. * @param trans array <p>
  8782. * An array of key/value pairs to be flipped.
  8783. * </p>
  8784. * @return array the flipped array on success and &null; on failure.
  8785. */
  8786. function array_flip (array $trans) {}
  8787. /**
  8788. * Changes all keys in an array
  8789. * @link http://www.php.net/manual/en/function.array-change-key-case.php
  8790. * @param input array <p>
  8791. * The array to work on
  8792. * </p>
  8793. * @param case int[optional] <p>
  8794. * Either CASE_UPPER or
  8795. * CASE_LOWER (default)
  8796. * </p>
  8797. * @return array an array with its keys lower or uppercased, or false if
  8798. * input is not an array.
  8799. */
  8800. function array_change_key_case (array $input, $case = null) {}
  8801. /**
  8802. * Pick one or more random entries out of an array
  8803. * @link http://www.php.net/manual/en/function.array-rand.php
  8804. * @param input array <p>
  8805. * The input array.
  8806. * </p>
  8807. * @param num_req int[optional] <p>
  8808. * Specifies how many entries you want to pick. Trying to pick more
  8809. * elements than there are in the array will result in an
  8810. * E_WARNING level error.
  8811. * </p>
  8812. * @return mixed If you are picking only one entry, array_rand
  8813. * returns the key for a random entry. Otherwise, it returns an array
  8814. * of keys for the random entries. This is done so that you can pick
  8815. * random keys as well as values out of the array.
  8816. */
  8817. function array_rand (array $input, $num_req = null) {}
  8818. /**
  8819. * Removes duplicate values from an array
  8820. * @link http://www.php.net/manual/en/function.array-unique.php
  8821. * @param array array <p>
  8822. * The input array.
  8823. * </p>
  8824. * @param sort_flags int[optional] <p>
  8825. * The optional second parameter sort_flags
  8826. * may be used to modify the sorting behavior using these values:
  8827. * </p>
  8828. * <p>
  8829. * Sorting type flags:
  8830. * SORT_REGULAR - compare items normally
  8831. * (don't change types)
  8832. * @return array the filtered array.
  8833. */
  8834. function array_unique (array $array, $sort_flags = null) {}
  8835. /**
  8836. * Computes the intersection of arrays
  8837. * @link http://www.php.net/manual/en/function.array-intersect.php
  8838. * @param array1 array <p>
  8839. * The array with master values to check.
  8840. * </p>
  8841. * @param array2 array <p>
  8842. * An array to compare values against.
  8843. * </p>
  8844. * @param _ array[optional]
  8845. * @return array an array containing all of the values in
  8846. * array1 whose values exist in all of the parameters.
  8847. */
  8848. function array_intersect (array $array1, array $array2, array $_ = null) {}
  8849. /**
  8850. * Computes the intersection of arrays using keys for comparison
  8851. * @link http://www.php.net/manual/en/function.array-intersect-key.php
  8852. * @param array1 array <p>
  8853. * The array with master keys to check.
  8854. * </p>
  8855. * @param array2 array <p>
  8856. * An array to compare keys against.
  8857. * </p>
  8858. * @param _ array[optional]
  8859. * @return array an associative array containing all the entries of
  8860. * array1 which have keys that are present in all
  8861. * arguments.
  8862. */
  8863. function array_intersect_key (array $array1, array $array2, array $_ = null) {}
  8864. /**
  8865. * Computes the intersection of arrays using a callback function on the keys for comparison
  8866. * @link http://www.php.net/manual/en/function.array-intersect-ukey.php
  8867. * @param array1 array <p>
  8868. * Initial array for comparison of the arrays.
  8869. * </p>
  8870. * @param array2 array <p>
  8871. * First array to compare keys against.
  8872. * </p>
  8873. * @param _ array[optional]
  8874. * @param key_compare_func callback <p>
  8875. * User supplied callback function to do the comparison.
  8876. * </p>
  8877. * @return array the values of array1 whose keys exist
  8878. * in all the arguments.
  8879. */
  8880. function array_intersect_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8881. /**
  8882. * Computes the intersection of arrays, compares data by a callback function
  8883. * @link http://www.php.net/manual/en/function.array-uintersect.php
  8884. * @param array1 array <p>
  8885. * The first array.
  8886. * </p>
  8887. * @param array2 array <p>
  8888. * The second array.
  8889. * </p>
  8890. * @param _ array[optional]
  8891. * @param data_compare_func callback <p>
  8892. * The callback comparison function.
  8893. * </p>
  8894. * <p>
  8895. * The user supplied callback function is used for comparison.
  8896. * It must return an integer less than, equal to, or greater than zero if
  8897. * the first argument is considered to be respectively less than, equal
  8898. * to, or greater than the second.
  8899. * </p>
  8900. * @return array an array containing all the values of array1
  8901. * that are present in all the arguments.
  8902. */
  8903. function array_uintersect (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8904. /**
  8905. * Computes the intersection of arrays with additional index check
  8906. * @link http://www.php.net/manual/en/function.array-intersect-assoc.php
  8907. * @param array1 array <p>
  8908. * The array with master values to check.
  8909. * </p>
  8910. * @param array2 array <p>
  8911. * An array to compare values against.
  8912. * </p>
  8913. * @param _ array[optional]
  8914. * @return array an associative array containing all the values in
  8915. * array1 that are present in all of the arguments.
  8916. */
  8917. function array_intersect_assoc (array $array1, array $array2, array $_ = null) {}
  8918. /**
  8919. * Computes the intersection of arrays with additional index check, compares data by a callback function
  8920. * @link http://www.php.net/manual/en/function.array-uintersect-assoc.php
  8921. * @param array1 array <p>
  8922. * The first array.
  8923. * </p>
  8924. * @param array2 array <p>
  8925. * The second array.
  8926. * </p>
  8927. * @param _ array[optional]
  8928. * @param data_compare_func callback <p>
  8929. * For comparison is used the user supplied callback function.
  8930. * It must return an integer less than, equal
  8931. * to, or greater than zero if the first argument is considered to
  8932. * be respectively less than, equal to, or greater than the
  8933. * second.
  8934. * </p>
  8935. * @return array an array containing all the values of
  8936. * array1 that are present in all the arguments.
  8937. */
  8938. function array_uintersect_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  8939. /**
  8940. * Computes the intersection of arrays with additional index check, compares indexes by a callback function
  8941. * @link http://www.php.net/manual/en/function.array-intersect-uassoc.php
  8942. * @param array1 array <p>
  8943. * Initial array for comparison of the arrays.
  8944. * </p>
  8945. * @param array2 array <p>
  8946. * First array to compare keys against.
  8947. * </p>
  8948. * @param _ array[optional]
  8949. * @param key_compare_func callback <p>
  8950. * User supplied callback function to do the comparison.
  8951. * </p>
  8952. * @return array the values of array1 whose values exist
  8953. * in all of the arguments.
  8954. */
  8955. function array_intersect_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  8956. /**
  8957. * Computes the intersection of arrays with additional index check, compares data and indexes by a callback functions
  8958. * @link http://www.php.net/manual/en/function.array-uintersect-uassoc.php
  8959. * @param array1 array <p>
  8960. * The first array.
  8961. * </p>
  8962. * @param array2 array <p>
  8963. * The second array.
  8964. * </p>
  8965. * @param _ array[optional]
  8966. * @param data_compare_func callback <p>
  8967. * For comparison is used the user supplied callback function.
  8968. * It must return an integer less than, equal
  8969. * to, or greater than zero if the first argument is considered to
  8970. * be respectively less than, equal to, or greater than the
  8971. * second.
  8972. * </p>
  8973. * @param key_compare_func callback <p>
  8974. * Key comparison callback function.
  8975. * </p>
  8976. * @return array an array containing all the values of
  8977. * array1 that are present in all the arguments.
  8978. */
  8979. function array_uintersect_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  8980. /**
  8981. * Computes the difference of arrays
  8982. * @link http://www.php.net/manual/en/function.array-diff.php
  8983. * @param array1 array <p>
  8984. * The array to compare from
  8985. * </p>
  8986. * @param array2 array <p>
  8987. * An array to compare against
  8988. * </p>
  8989. * @param _ array[optional]
  8990. * @return array an array containing all the entries from
  8991. * array1 that are not present in any of the other arrays.
  8992. */
  8993. function array_diff (array $array1, array $array2, array $_ = null) {}
  8994. /**
  8995. * Computes the difference of arrays using keys for comparison
  8996. * @link http://www.php.net/manual/en/function.array-diff-key.php
  8997. * @param array1 array <p>
  8998. * The array to compare from
  8999. * </p>
  9000. * @param array2 array <p>
  9001. * An array to compare against
  9002. * </p>
  9003. * @param _ array[optional]
  9004. * @return array an array containing all the entries from
  9005. * array1 whose keys are not present in any of the
  9006. * other arrays.
  9007. */
  9008. function array_diff_key (array $array1, array $array2, array $_ = null) {}
  9009. /**
  9010. * Computes the difference of arrays using a callback function on the keys for comparison
  9011. * @link http://www.php.net/manual/en/function.array-diff-ukey.php
  9012. * @param array1 array <p>
  9013. * The array to compare from
  9014. * </p>
  9015. * @param array2 array <p>
  9016. * An array to compare against
  9017. * </p>
  9018. * @param _ array[optional]
  9019. * @param key_compare_func callback <p>
  9020. * callback function to use.
  9021. * The callback function must return an integer less than, equal
  9022. * to, or greater than zero if the first argument is considered to
  9023. * be respectively less than, equal to, or greater than the second.
  9024. * </p>
  9025. * @return array an array containing all the entries from
  9026. * array1 that are not present in any of the other arrays.
  9027. */
  9028. function array_diff_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9029. /**
  9030. * Computes the difference of arrays by using a callback function for data comparison
  9031. * @link http://www.php.net/manual/en/function.array-udiff.php
  9032. * @param array1 array <p>
  9033. * The first array.
  9034. * </p>
  9035. * @param array2 array <p>
  9036. * The second array.
  9037. * </p>
  9038. * @param _ array[optional]
  9039. * @param data_compare_func callback <p>
  9040. * The callback comparison function.
  9041. * </p>
  9042. * <p>
  9043. * The user supplied callback function is used for comparison.
  9044. * It must return an integer less than, equal to, or greater than zero if
  9045. * the first argument is considered to be respectively less than, equal
  9046. * to, or greater than the second.
  9047. * </p>
  9048. * @return array an array containing all the values of array1
  9049. * that are not present in any of the other arguments.
  9050. */
  9051. function array_udiff (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9052. /**
  9053. * Computes the difference of arrays with additional index check
  9054. * @link http://www.php.net/manual/en/function.array-diff-assoc.php
  9055. * @param array1 array <p>
  9056. * The array to compare from
  9057. * </p>
  9058. * @param array2 array <p>
  9059. * An array to compare against
  9060. * </p>
  9061. * @param _ array[optional]
  9062. * @return array an array containing all the values from
  9063. * array1 that are not present in any of the other arrays.
  9064. */
  9065. function array_diff_assoc (array $array1, array $array2, array $_ = null) {}
  9066. /**
  9067. * Computes the difference of arrays with additional index check, compares data by a callback function
  9068. * @link http://www.php.net/manual/en/function.array-udiff-assoc.php
  9069. * @param array1 array <p>
  9070. * The first array.
  9071. * </p>
  9072. * @param array2 array <p>
  9073. * The second array.
  9074. * </p>
  9075. * @param _ array[optional]
  9076. * @param data_compare_func callback <p>
  9077. * The callback comparison function.
  9078. * </p>
  9079. * <p>
  9080. * The user supplied callback function is used for comparison.
  9081. * It must return an integer less than, equal to, or greater than zero if
  9082. * the first argument is considered to be respectively less than, equal
  9083. * to, or greater than the second.
  9084. * </p>
  9085. * @return array array_udiff_assoc returns an array
  9086. * containing all the values from array1
  9087. * that are not present in any of the other arguments.
  9088. * Note that the keys are used in the comparison unlike
  9089. * array_diff and array_udiff.
  9090. * The comparison of arrays' data is performed by using an user-supplied
  9091. * callback. In this aspect the behaviour is opposite to the behaviour of
  9092. * array_diff_assoc which uses internal function for
  9093. * comparison.
  9094. */
  9095. function array_udiff_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9096. /**
  9097. * Computes the difference of arrays with additional index check which is performed by a user supplied callback function
  9098. * @link http://www.php.net/manual/en/function.array-diff-uassoc.php
  9099. * @param array1 array <p>
  9100. * The array to compare from
  9101. * </p>
  9102. * @param array2 array <p>
  9103. * An array to compare against
  9104. * </p>
  9105. * @param _ array[optional]
  9106. * @param key_compare_func callback <p>
  9107. * callback function to use.
  9108. * The callback function must return an integer less than, equal
  9109. * to, or greater than zero if the first argument is considered to
  9110. * be respectively less than, equal to, or greater than the second.
  9111. * </p>
  9112. * @return array an array containing all the entries from
  9113. * array1 that are not present in any of the other arrays.
  9114. */
  9115. function array_diff_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9116. /**
  9117. * Computes the difference of arrays with additional index check, compares data and indexes by a callback function
  9118. * @link http://www.php.net/manual/en/function.array-udiff-uassoc.php
  9119. * @param array1 array <p>
  9120. * The first array.
  9121. * </p>
  9122. * @param array2 array <p>
  9123. * The second array.
  9124. * </p>
  9125. * @param _ array[optional]
  9126. * @param data_compare_func callback <p>
  9127. * The callback comparison function.
  9128. * </p>
  9129. * <p>
  9130. * The user supplied callback function is used for comparison.
  9131. * It must return an integer less than, equal to, or greater than zero if
  9132. * the first argument is considered to be respectively less than, equal
  9133. * to, or greater than the second.
  9134. * </p>
  9135. * <p>
  9136. * The comparison of arrays' data is performed by using an user-supplied
  9137. * callback : data_compare_func. In this aspect
  9138. * the behaviour is opposite to the behaviour of
  9139. * array_diff_assoc which uses internal function for
  9140. * comparison.
  9141. * </p>
  9142. * @param key_compare_func callback <p>
  9143. * The comparison of keys (indices) is done also by the callback function
  9144. * key_compare_func. This behaviour is unlike what
  9145. * array_udiff_assoc does, since the latter compares
  9146. * the indices by using an internal function.
  9147. * </p>
  9148. * @return array an array containing all the values from
  9149. * array1 that are not present in any of the other
  9150. * arguments.
  9151. */
  9152. function array_udiff_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  9153. /**
  9154. * Calculate the sum of values in an array
  9155. * @link http://www.php.net/manual/en/function.array-sum.php
  9156. * @param array array <p>
  9157. * The input array.
  9158. * </p>
  9159. * @return number the sum of values as an integer or float.
  9160. */
  9161. function array_sum (array $array) {}
  9162. /**
  9163. * Calculate the product of values in an array
  9164. * @link http://www.php.net/manual/en/function.array-product.php
  9165. * @param array array <p>
  9166. * The array.
  9167. * </p>
  9168. * @return number the product as an integer or float.
  9169. */
  9170. function array_product (array $array) {}
  9171. /**
  9172. * Filters elements of an array using a callback function
  9173. * @link http://www.php.net/manual/en/function.array-filter.php
  9174. * @param input array <p>
  9175. * The array to iterate over
  9176. * </p>
  9177. * @param callback callback[optional] <p>
  9178. * The callback function to use
  9179. * </p>
  9180. * <p>
  9181. * If no callback is supplied, all entries of
  9182. * input equal to false (see
  9183. * converting to
  9184. * boolean) will be removed.
  9185. * </p>
  9186. * @return array the filtered array.
  9187. */
  9188. function array_filter (array $input, $callback = null) {}
  9189. /**
  9190. * Applies the callback to the elements of the given arrays
  9191. * @link http://www.php.net/manual/en/function.array-map.php
  9192. * @param callback callback <p>
  9193. * Callback function to run for each element in each array.
  9194. * </p>
  9195. * @param arr1 array <p>
  9196. * An array to run through the callback function.
  9197. * </p>
  9198. * @param _ array[optional]
  9199. * @return array an array containing all the elements of arr1
  9200. * after applying the callback function to each one.
  9201. */
  9202. function array_map ($callback, array $arr1, array $_ = null) {}
  9203. /**
  9204. * Split an array into chunks
  9205. * @link http://www.php.net/manual/en/function.array-chunk.php
  9206. * @param input array <p>
  9207. * The array to work on
  9208. * </p>
  9209. * @param size int <p>
  9210. * The size of each chunk
  9211. * </p>
  9212. * @param preserve_keys bool[optional] <p>
  9213. * When set to true keys will be preserved.
  9214. * Default is false which will reindex the chunk numerically
  9215. * </p>
  9216. * @return array a multidimensional numerically indexed array, starting with zero,
  9217. * with each dimension containing size elements.
  9218. */
  9219. function array_chunk (array $input, $size, $preserve_keys = null) {}
  9220. /**
  9221. * Creates an array by using one array for keys and another for its values
  9222. * @link http://www.php.net/manual/en/function.array-combine.php
  9223. * @param keys array <p>
  9224. * Array of keys to be used. Illegal values for key will be
  9225. * converted to string.
  9226. * </p>
  9227. * @param values array <p>
  9228. * Array of values to be used
  9229. * </p>
  9230. * @return array the combined array, false if the number of elements
  9231. * for each array isn't equal or if the arrays are empty.
  9232. */
  9233. function array_combine (array $keys, array $values) {}
  9234. /**
  9235. * Checks if the given key or index exists in the array
  9236. * @link http://www.php.net/manual/en/function.array-key-exists.php
  9237. * @param key mixed <p>
  9238. * Value to check.
  9239. * </p>
  9240. * @param search array <p>
  9241. * An array with keys to check.
  9242. * </p>
  9243. * @return bool Returns true on success or false on failure.
  9244. */
  9245. function array_key_exists ($key, array $search) {}
  9246. /**
  9247. * &Alias; <function>current</function>
  9248. * @link http://www.php.net/manual/en/function.pos.php
  9249. * @param arg
  9250. */
  9251. function pos (&$arg) {}
  9252. /**
  9253. * &Alias; <function>count</function>
  9254. * @link http://www.php.net/manual/en/function.sizeof.php
  9255. * @param var
  9256. * @param mode[optional]
  9257. */
  9258. function sizeof ($var, $mode) {}
  9259. /**
  9260. * @param key
  9261. * @param search
  9262. */
  9263. function key_exists ($key, $search) {}
  9264. /**
  9265. * Checks if assertion is &false;
  9266. * @link http://www.php.net/manual/en/function.assert.php
  9267. * @param assertion mixed <p>
  9268. * The assertion.
  9269. * </p>
  9270. * @return bool false if the assertion is false, true otherwise.
  9271. */
  9272. function assert ($assertion) {}
  9273. /**
  9274. * Set/get the various assert flags
  9275. * @link http://www.php.net/manual/en/function.assert-options.php
  9276. * @param what int <p>
  9277. * <table>
  9278. * Assert Options
  9279. * <tr valign="top">
  9280. * <td>Option</td>
  9281. * <td>INI Setting</td>
  9282. * <td>Default value</td>
  9283. * <td>Description</td>
  9284. * </tr>
  9285. * <tr valign="top">
  9286. * <td>ASSERT_ACTIVE</td>
  9287. * <td>assert.active</td>
  9288. * <td>1</td>
  9289. * <td>enable assert evaluation</td>
  9290. * </tr>
  9291. * <tr valign="top">
  9292. * <td>ASSERT_WARNING</td>
  9293. * <td>assert.warning</td>
  9294. * <td>1</td>
  9295. * <td>issue a PHP warning for each failed assertion</td>
  9296. * </tr>
  9297. * <tr valign="top">
  9298. * <td>ASSERT_BAIL</td>
  9299. * <td>assert.bail</td>
  9300. * <td>0</td>
  9301. * <td>terminate execution on failed assertions</td>
  9302. * </tr>
  9303. * <tr valign="top">
  9304. * <td>ASSERT_QUIET_EVAL</td>
  9305. * <td>assert.quiet_eval</td>
  9306. * <td>0</td>
  9307. * <td>
  9308. * disable error_reporting during assertion expression
  9309. * evaluation
  9310. * </td>
  9311. * </tr>
  9312. * <tr valign="top">
  9313. * <td>ASSERT_CALLBACK</td>
  9314. * <td>assert.callback</td>
  9315. * <td)<&null;)</td>
  9316. * <td>Callback to call on failed assertions</td>
  9317. * </tr>
  9318. * </table>
  9319. * </p>
  9320. * @param value mixed[optional] <p>
  9321. * An optional new value for the option.
  9322. * </p>
  9323. * @return mixed the original setting of any option or false on errors.
  9324. */
  9325. function assert_options ($what, $value = null) {}
  9326. /**
  9327. * Compares two "PHP-standardized" version number strings
  9328. * @link http://www.php.net/manual/en/function.version-compare.php
  9329. * @param version1 string <p>
  9330. * First version number.
  9331. * </p>
  9332. * @param version2 string <p>
  9333. * Second version number.
  9334. * </p>
  9335. * @param operator string[optional] <p>
  9336. * If you specify the third optional operator
  9337. * argument, you can test for a particular relationship. The
  9338. * possible operators are: &lt;,
  9339. * lt, &lt;=,
  9340. * le, &gt;,
  9341. * gt, &gt;=,
  9342. * ge, ==,
  9343. * =, eq,
  9344. * !=, &lt;&gt;,
  9345. * ne respectively.
  9346. * </p>
  9347. * <p>
  9348. * This parameter is case-sensitive, so values should be lowercase.
  9349. * </p>
  9350. * @return mixed By default, version_compare returns
  9351. * -1 if the first version is lower than the second,
  9352. * 0 if they are equal, and
  9353. * 1 if the second is lower.
  9354. * </p>
  9355. * <p>
  9356. * When using the optional operator argument, the
  9357. * function will return true if the relationship is the one specified
  9358. * by the operator, false otherwise.
  9359. */
  9360. function version_compare ($version1, $version2, $operator = null) {}
  9361. /**
  9362. * Convert a pathname and a project identifier to a System V IPC key
  9363. * @link http://www.php.net/manual/en/function.ftok.php
  9364. * @param pathname string <p>
  9365. * Path to an accessible file.
  9366. * </p>
  9367. * @param proj string <p>
  9368. * Project identifier. This must be a one character string.
  9369. * </p>
  9370. * @return int On success the return value will be the created key value, otherwise
  9371. * -1 is returned.
  9372. */
  9373. function ftok ($pathname, $proj) {}
  9374. /**
  9375. * Perform the rot13 transform on a string
  9376. * @link http://www.php.net/manual/en/function.str-rot13.php
  9377. * @param str string <p>
  9378. * The input string.
  9379. * </p>
  9380. * @return string the ROT13 version of the given string.
  9381. */
  9382. function str_rot13 ($str) {}
  9383. /**
  9384. * Retrieve list of registered filters
  9385. * @link http://www.php.net/manual/en/function.stream-get-filters.php
  9386. * @return array an indexed array containing the name of all stream filters
  9387. * available.
  9388. */
  9389. function stream_get_filters () {}
  9390. /**
  9391. * Register a user defined stream filter
  9392. * @link http://www.php.net/manual/en/function.stream-filter-register.php
  9393. * @param filtername string <p>
  9394. * The filter name to be registered.
  9395. * </p>
  9396. * @param classname string <p>
  9397. * To implement a filter, you need to define a class as an extension of
  9398. * php_user_filter with a number of member functions
  9399. * as defined below. When performing read/write operations on the stream
  9400. * to which your filter is attached, PHP will pass the data through your
  9401. * filter (and any other filters attached to that stream) so that the
  9402. * data may be modified as desired. You must implement the methods
  9403. * exactly as described below - doing otherwise will lead to undefined
  9404. * behaviour.
  9405. * </p>
  9406. * intfilter
  9407. * resourcein
  9408. * resourceout
  9409. * intconsumed
  9410. * boolclosing
  9411. * <p>
  9412. * This method is called whenever data is read from or written to
  9413. * the attached stream (such as with fread or fwrite).
  9414. * in is a resource pointing to a bucket brigade
  9415. * which contains one or more bucket objects containing data to be filtered.
  9416. * out is a resource pointing to a second bucket brigade
  9417. * into which your modified buckets should be placed.
  9418. * consumed, which must always
  9419. * be declared by reference, should be incremented by the length of the data
  9420. * which your filter reads in and alters. In most cases this means you will
  9421. * increment consumed by $bucket->datalen
  9422. * for each $bucket. If the stream is in the process of closing
  9423. * (and therefore this is the last pass through the filterchain),
  9424. * the closing parameter will be set to true.
  9425. * The filter method must return one of
  9426. * three values upon completion.
  9427. * <tr valign="top">
  9428. * <td>Return Value</td>
  9429. * <td>Meaning</td>
  9430. * </tr>
  9431. * <tr valign="top">
  9432. * <td>PSFS_PASS_ON</td>
  9433. * <td>
  9434. * Filter processed successfully with data available in the
  9435. * out bucket brigade.
  9436. * </td>
  9437. * </tr>
  9438. * <tr valign="top">
  9439. * <td>PSFS_FEED_ME</td>
  9440. * <td>
  9441. * Filter processed successfully, however no data was available to
  9442. * return. More data is required from the stream or prior filter.
  9443. * </td>
  9444. * </tr>
  9445. * <tr valign="top">
  9446. * <td>PSFS_ERR_FATAL (default)</td>
  9447. * <td>
  9448. * The filter experienced an unrecoverable error and cannot continue.
  9449. * </td>
  9450. * </tr>
  9451. * </p>
  9452. * boolonCreate
  9453. * This method is called during instantiation of the filter class
  9454. * object. If your filter allocates or initializes any other resources
  9455. * (such as a buffer), this is the place to do it. Your implementation of
  9456. * this method should return false on failure, or true on success.
  9457. * When your filter is first instantiated, and
  9458. * yourfilter-&gt;onCreate() is called, a number of properties
  9459. * will be available as shown in the table below.
  9460. * <p>
  9461. * <tr valign="top">
  9462. * <td>Property</td>
  9463. * <td>Contents</td>
  9464. * </tr>
  9465. * <tr valign="top">
  9466. * <td>FilterClass-&gt;filtername</td>
  9467. * <td>
  9468. * A string containing the name the filter was instantiated with.
  9469. * Filters may be registered under multiple names or under wildcards.
  9470. * Use this property to determine which name was used.
  9471. * </td>
  9472. * </tr>
  9473. * <tr valign="top">
  9474. * <td>FilterClass-&gt;params</td>
  9475. * <td>
  9476. * The contents of the params parameter passed
  9477. * to stream_filter_append
  9478. * or stream_filter_prepend.
  9479. * </td>
  9480. * </tr>
  9481. * <tr valign="top">
  9482. * <td>FilterClass-&gt;stream</td>
  9483. * <td>
  9484. * The stream resource being filtered. Maybe available only during
  9485. * filter calls when the
  9486. * closing parameter is set to false.
  9487. * </td>
  9488. * </tr>
  9489. * </p>
  9490. * voidonClose
  9491. * <p>
  9492. * This method is called upon filter shutdown (typically, this is also
  9493. * during stream shutdown), and is executed after
  9494. * the flush method is called. If any resources
  9495. * were allocated or initialized during onCreate()
  9496. * this would be the time to destroy or dispose of them.
  9497. * </p>
  9498. * @return bool Returns true on success or false on failure.
  9499. * </p>
  9500. * <p>
  9501. * stream_filter_register will return false if the
  9502. * filtername is already defined.
  9503. */
  9504. function stream_filter_register ($filtername, $classname) {}
  9505. /**
  9506. * Return a bucket object from the brigade for operating on
  9507. * @link http://www.php.net/manual/en/function.stream-bucket-make-writeable.php
  9508. * @param brigade resource
  9509. * @return object
  9510. */
  9511. function stream_bucket_make_writeable ($brigade) {}
  9512. /**
  9513. * Prepend bucket to brigade
  9514. * @link http://www.php.net/manual/en/function.stream-bucket-prepend.php
  9515. * @param brigade resource
  9516. * @param bucket resource
  9517. * @return void
  9518. */
  9519. function stream_bucket_prepend ($brigade, $bucket) {}
  9520. /**
  9521. * Append bucket to brigade
  9522. * @link http://www.php.net/manual/en/function.stream-bucket-append.php
  9523. * @param brigade resource
  9524. * @param bucket resource
  9525. * @return void
  9526. */
  9527. function stream_bucket_append ($brigade, $bucket) {}
  9528. /**
  9529. * Create a new bucket for use on the current stream
  9530. * @link http://www.php.net/manual/en/function.stream-bucket-new.php
  9531. * @param stream resource
  9532. * @param buffer string
  9533. * @return object
  9534. */
  9535. function stream_bucket_new ($stream, $buffer) {}
  9536. /**
  9537. * Add URL rewriter values
  9538. * @link http://www.php.net/manual/en/function.output-add-rewrite-var.php
  9539. * @param name string <p>
  9540. * The variable name.
  9541. * </p>
  9542. * @param value string <p>
  9543. * The variable value.
  9544. * </p>
  9545. * @return bool Returns true on success or false on failure.
  9546. */
  9547. function output_add_rewrite_var ($name, $value) {}
  9548. /**
  9549. * Reset URL rewriter values
  9550. * @link http://www.php.net/manual/en/function.output-reset-rewrite-vars.php
  9551. * @return bool Returns true on success or false on failure.
  9552. */
  9553. function output_reset_rewrite_vars () {}
  9554. /**
  9555. * Returns directory path used for temporary files
  9556. * @link http://www.php.net/manual/en/function.sys-get-temp-dir.php
  9557. * @return string the path of the temporary directory.
  9558. */
  9559. function sys_get_temp_dir () {}
  9560. define ('CONNECTION_ABORTED', 1);
  9561. define ('CONNECTION_NORMAL', 0);
  9562. define ('CONNECTION_TIMEOUT', 2);
  9563. define ('INI_USER', 1);
  9564. define ('INI_PERDIR', 2);
  9565. define ('INI_SYSTEM', 4);
  9566. define ('INI_ALL', 7);
  9567. /**
  9568. * Normal INI scanner mode (since PHP 5.3).
  9569. * @link http://www.php.net/manual/en/filesystem.constants.php
  9570. */
  9571. define ('INI_SCANNER_NORMAL', 0);
  9572. /**
  9573. * Raw INI scanner mode (since PHP 5.3).
  9574. * @link http://www.php.net/manual/en/filesystem.constants.php
  9575. */
  9576. define ('INI_SCANNER_RAW', 1);
  9577. define ('PHP_URL_SCHEME', 0);
  9578. define ('PHP_URL_HOST', 1);
  9579. define ('PHP_URL_PORT', 2);
  9580. define ('PHP_URL_USER', 3);
  9581. define ('PHP_URL_PASS', 4);
  9582. define ('PHP_URL_PATH', 5);
  9583. define ('PHP_URL_QUERY', 6);
  9584. define ('PHP_URL_FRAGMENT', 7);
  9585. define ('M_E', 2.718281828459);
  9586. define ('M_LOG2E', 1.442695040889);
  9587. define ('M_LOG10E', 0.43429448190325);
  9588. define ('M_LN2', 0.69314718055995);
  9589. define ('M_LN10', 2.302585092994);
  9590. /**
  9591. * Round halves up
  9592. * @link http://www.php.net/manual/en/math.constants.php
  9593. */
  9594. define ('M_PI', 3.1415926535898);
  9595. define ('M_PI_2', 1.5707963267949);
  9596. define ('M_PI_4', 0.78539816339745);
  9597. define ('M_1_PI', 0.31830988618379);
  9598. define ('M_2_PI', 0.63661977236758);
  9599. define ('M_SQRTPI', 1.7724538509055);
  9600. define ('M_2_SQRTPI', 1.1283791670955);
  9601. define ('M_LNPI', 1.1447298858494);
  9602. define ('M_EULER', 0.57721566490153);
  9603. define ('M_SQRT2', 1.4142135623731);
  9604. define ('M_SQRT1_2', 0.70710678118655);
  9605. define ('M_SQRT3', 1.7320508075689);
  9606. define ('INF', INF);
  9607. define ('NAN', NAN);
  9608. define ('PHP_ROUND_HALF_UP', 1);
  9609. /**
  9610. * Round halves down
  9611. * @link http://www.php.net/manual/en/math.constants.php
  9612. */
  9613. define ('PHP_ROUND_HALF_DOWN', 2);
  9614. /**
  9615. * Round halves to even numbers
  9616. * @link http://www.php.net/manual/en/math.constants.php
  9617. */
  9618. define ('PHP_ROUND_HALF_EVEN', 3);
  9619. /**
  9620. * Round halves to odd numbers
  9621. * @link http://www.php.net/manual/en/math.constants.php
  9622. */
  9623. define ('PHP_ROUND_HALF_ODD', 4);
  9624. define ('INFO_GENERAL', 1);
  9625. /**
  9626. * PHP Credits. See also phpcredits.
  9627. * @link http://www.php.net/manual/en/info.constants.php
  9628. */
  9629. define ('INFO_CREDITS', 2);
  9630. /**
  9631. * Current Local and Master values for PHP directives. See
  9632. * also ini_get.
  9633. * @link http://www.php.net/manual/en/info.constants.php
  9634. */
  9635. define ('INFO_CONFIGURATION', 4);
  9636. /**
  9637. * Loaded modules and their respective settings.
  9638. * @link http://www.php.net/manual/en/info.constants.php
  9639. */
  9640. define ('INFO_MODULES', 8);
  9641. /**
  9642. * Environment Variable information that's also available in
  9643. * $_ENV.
  9644. * @link http://www.php.net/manual/en/info.constants.php
  9645. */
  9646. define ('INFO_ENVIRONMENT', 16);
  9647. /**
  9648. * Shows all
  9649. * predefined variables from EGPCS (Environment, GET,
  9650. * POST, Cookie, Server).
  9651. * @link http://www.php.net/manual/en/info.constants.php
  9652. */
  9653. define ('INFO_VARIABLES', 32);
  9654. /**
  9655. * PHP License information. See also the license faq.
  9656. * @link http://www.php.net/manual/en/info.constants.php
  9657. */
  9658. define ('INFO_LICENSE', 64);
  9659. define ('INFO_ALL', -1);
  9660. /**
  9661. * A list of the core developers
  9662. * @link http://www.php.net/manual/en/info.constants.php
  9663. */
  9664. define ('CREDITS_GROUP', 1);
  9665. /**
  9666. * General credits: Language design and concept, PHP
  9667. * authors and SAPI module.
  9668. * @link http://www.php.net/manual/en/info.constants.php
  9669. */
  9670. define ('CREDITS_GENERAL', 2);
  9671. /**
  9672. * A list of the server API modules for PHP, and their authors.
  9673. * @link http://www.php.net/manual/en/info.constants.php
  9674. */
  9675. define ('CREDITS_SAPI', 4);
  9676. /**
  9677. * A list of the extension modules for PHP, and their authors.
  9678. * @link http://www.php.net/manual/en/info.constants.php
  9679. */
  9680. define ('CREDITS_MODULES', 8);
  9681. /**
  9682. * The credits for the documentation team.
  9683. * @link http://www.php.net/manual/en/info.constants.php
  9684. */
  9685. define ('CREDITS_DOCS', 16);
  9686. /**
  9687. * Usually used in combination with the other flags. Indicates
  9688. * that a complete stand-alone HTML page needs to be
  9689. * printed including the information indicated by the other
  9690. * flags.
  9691. * @link http://www.php.net/manual/en/info.constants.php
  9692. */
  9693. define ('CREDITS_FULLPAGE', 32);
  9694. /**
  9695. * The credits for the quality assurance team.
  9696. * @link http://www.php.net/manual/en/info.constants.php
  9697. */
  9698. define ('CREDITS_QA', 64);
  9699. /**
  9700. * The configuration line, &php.ini; location, build date, Web
  9701. * Server, System and more.
  9702. * @link http://www.php.net/manual/en/info.constants.php
  9703. */
  9704. define ('CREDITS_ALL', -1);
  9705. define ('HTML_SPECIALCHARS', 0);
  9706. define ('HTML_ENTITIES', 1);
  9707. define ('ENT_COMPAT', 2);
  9708. define ('ENT_QUOTES', 3);
  9709. define ('ENT_NOQUOTES', 0);
  9710. define ('ENT_IGNORE', 4);
  9711. define ('STR_PAD_LEFT', 0);
  9712. define ('STR_PAD_RIGHT', 1);
  9713. define ('STR_PAD_BOTH', 2);
  9714. define ('PATHINFO_DIRNAME', 1);
  9715. define ('PATHINFO_BASENAME', 2);
  9716. define ('PATHINFO_EXTENSION', 4);
  9717. /**
  9718. * Since PHP 5.2.0.
  9719. * @link http://www.php.net/manual/en/filesystem.constants.php
  9720. */
  9721. define ('PATHINFO_FILENAME', 8);
  9722. define ('CHAR_MAX', 127);
  9723. define ('LC_CTYPE', 0);
  9724. define ('LC_NUMERIC', 1);
  9725. define ('LC_TIME', 2);
  9726. define ('LC_COLLATE', 3);
  9727. define ('LC_MONETARY', 4);
  9728. define ('LC_ALL', 6);
  9729. define ('LC_MESSAGES', 5);
  9730. define ('SEEK_SET', 0);
  9731. define ('SEEK_CUR', 1);
  9732. define ('SEEK_END', 2);
  9733. define ('LOCK_SH', 1);
  9734. define ('LOCK_EX', 2);
  9735. define ('LOCK_UN', 3);
  9736. define ('LOCK_NB', 4);
  9737. /**
  9738. * A connection with an external resource has been established.
  9739. * @link http://www.php.net/manual/en/stream.constants.php
  9740. */
  9741. define ('STREAM_NOTIFY_CONNECT', 2);
  9742. /**
  9743. * Additional authorization is required to access the specified resource.
  9744. * Typical issued with severity level of
  9745. * STREAM_NOTIFY_SEVERITY_ERR.
  9746. * @link http://www.php.net/manual/en/stream.constants.php
  9747. */
  9748. define ('STREAM_NOTIFY_AUTH_REQUIRED', 3);
  9749. /**
  9750. * Authorization has been completed (with or without success).
  9751. * @link http://www.php.net/manual/en/stream.constants.php
  9752. */
  9753. define ('STREAM_NOTIFY_AUTH_RESULT', 10);
  9754. /**
  9755. * The mime-type of resource has been identified,
  9756. * refer to message for a description of the
  9757. * discovered type.
  9758. * @link http://www.php.net/manual/en/stream.constants.php
  9759. */
  9760. define ('STREAM_NOTIFY_MIME_TYPE_IS', 4);
  9761. /**
  9762. * The size of the resource has been discovered.
  9763. * @link http://www.php.net/manual/en/stream.constants.php
  9764. */
  9765. define ('STREAM_NOTIFY_FILE_SIZE_IS', 5);
  9766. /**
  9767. * The external resource has redirected the stream to an alternate
  9768. * location. Refer to message.
  9769. * @link http://www.php.net/manual/en/stream.constants.php
  9770. */
  9771. define ('STREAM_NOTIFY_REDIRECTED', 6);
  9772. /**
  9773. * Indicates current progress of the stream transfer in
  9774. * bytes_transferred and possibly
  9775. * bytes_max as well.
  9776. * @link http://www.php.net/manual/en/stream.constants.php
  9777. */
  9778. define ('STREAM_NOTIFY_PROGRESS', 7);
  9779. /**
  9780. * A generic error occurred on the stream, consult
  9781. * message and message_code
  9782. * for details.
  9783. * @link http://www.php.net/manual/en/stream.constants.php
  9784. */
  9785. define ('STREAM_NOTIFY_FAILURE', 9);
  9786. /**
  9787. * There is no more data available on the stream.
  9788. * @link http://www.php.net/manual/en/stream.constants.php
  9789. */
  9790. define ('STREAM_NOTIFY_COMPLETED', 8);
  9791. /**
  9792. * A remote address required for this stream has been resolved, or the resolution
  9793. * failed. See severity for an indication of which happened.
  9794. * @link http://www.php.net/manual/en/stream.constants.php
  9795. */
  9796. define ('STREAM_NOTIFY_RESOLVE', 1);
  9797. /**
  9798. * Normal, non-error related, notification.
  9799. * @link http://www.php.net/manual/en/stream.constants.php
  9800. */
  9801. define ('STREAM_NOTIFY_SEVERITY_INFO', 0);
  9802. /**
  9803. * Non critical error condition. Processing may continue.
  9804. * @link http://www.php.net/manual/en/stream.constants.php
  9805. */
  9806. define ('STREAM_NOTIFY_SEVERITY_WARN', 1);
  9807. /**
  9808. * A critical error occurred. Processing cannot continue.
  9809. * @link http://www.php.net/manual/en/stream.constants.php
  9810. */
  9811. define ('STREAM_NOTIFY_SEVERITY_ERR', 2);
  9812. /**
  9813. * Used with stream_filter_append and
  9814. * stream_filter_prepend to indicate
  9815. * that the specified filter should only be applied when
  9816. * reading
  9817. * @link http://www.php.net/manual/en/stream.constants.php
  9818. */
  9819. define ('STREAM_FILTER_READ', 1);
  9820. /**
  9821. * Used with stream_filter_append and
  9822. * stream_filter_prepend to indicate
  9823. * that the specified filter should only be applied when
  9824. * writing
  9825. * @link http://www.php.net/manual/en/stream.constants.php
  9826. */
  9827. define ('STREAM_FILTER_WRITE', 2);
  9828. /**
  9829. * This constant is equivalent to
  9830. * STREAM_FILTER_READ | STREAM_FILTER_WRITE
  9831. * @link http://www.php.net/manual/en/stream.constants.php
  9832. */
  9833. define ('STREAM_FILTER_ALL', 3);
  9834. /**
  9835. * Client socket opened with stream_socket_client
  9836. * should remain persistent between page loads.
  9837. * @link http://www.php.net/manual/en/stream.constants.php
  9838. */
  9839. define ('STREAM_CLIENT_PERSISTENT', 1);
  9840. /**
  9841. * Open client socket asynchronously. This option must be used
  9842. * together with the STREAM_CLIENT_CONNECT flag.
  9843. * Used with stream_socket_client.
  9844. * @link http://www.php.net/manual/en/stream.constants.php
  9845. */
  9846. define ('STREAM_CLIENT_ASYNC_CONNECT', 2);
  9847. /**
  9848. * Open client socket connection. Client sockets should always
  9849. * include this flag. Used with stream_socket_client.
  9850. * @link http://www.php.net/manual/en/stream.constants.php
  9851. */
  9852. define ('STREAM_CLIENT_CONNECT', 4);
  9853. define ('STREAM_CRYPTO_METHOD_SSLv2_CLIENT', 0);
  9854. define ('STREAM_CRYPTO_METHOD_SSLv3_CLIENT', 1);
  9855. define ('STREAM_CRYPTO_METHOD_SSLv23_CLIENT', 2);
  9856. define ('STREAM_CRYPTO_METHOD_TLS_CLIENT', 3);
  9857. define ('STREAM_CRYPTO_METHOD_SSLv2_SERVER', 4);
  9858. define ('STREAM_CRYPTO_METHOD_SSLv3_SERVER', 5);
  9859. define ('STREAM_CRYPTO_METHOD_SSLv23_SERVER', 6);
  9860. define ('STREAM_CRYPTO_METHOD_TLS_SERVER', 7);
  9861. /**
  9862. * Used with stream_socket_shutdown to disable
  9863. * further receptions. Added in PHP 5.2.1.
  9864. * @link http://www.php.net/manual/en/stream.constants.php
  9865. */
  9866. define ('STREAM_SHUT_RD', 0);
  9867. /**
  9868. * Used with stream_socket_shutdown to disable
  9869. * further transmissions. Added in PHP 5.2.1.
  9870. * @link http://www.php.net/manual/en/stream.constants.php
  9871. */
  9872. define ('STREAM_SHUT_WR', 1);
  9873. /**
  9874. * Used with stream_socket_shutdown to disable
  9875. * further receptions and transmissions. Added in PHP 5.2.1.
  9876. * @link http://www.php.net/manual/en/stream.constants.php
  9877. */
  9878. define ('STREAM_SHUT_RDWR', 2);
  9879. /**
  9880. * Internet Protocol Version 4 (IPv4).
  9881. * @link http://www.php.net/manual/en/stream.constants.php
  9882. */
  9883. define ('STREAM_PF_INET', 2);
  9884. /**
  9885. * Internet Protocol Version 6 (IPv6).
  9886. * @link http://www.php.net/manual/en/stream.constants.php
  9887. */
  9888. define ('STREAM_PF_INET6', 10);
  9889. /**
  9890. * Unix system internal protocols.
  9891. * @link http://www.php.net/manual/en/stream.constants.php
  9892. */
  9893. define ('STREAM_PF_UNIX', 1);
  9894. /**
  9895. * Provides a IP socket.
  9896. * @link http://www.php.net/manual/en/stream.constants.php
  9897. */
  9898. define ('STREAM_IPPROTO_IP', 0);
  9899. /**
  9900. * Provides a TCP socket.
  9901. * @link http://www.php.net/manual/en/stream.constants.php
  9902. */
  9903. define ('STREAM_IPPROTO_TCP', 6);
  9904. /**
  9905. * Provides a UDP socket.
  9906. * @link http://www.php.net/manual/en/stream.constants.php
  9907. */
  9908. define ('STREAM_IPPROTO_UDP', 17);
  9909. /**
  9910. * Provides a ICMP socket.
  9911. * @link http://www.php.net/manual/en/stream.constants.php
  9912. */
  9913. define ('STREAM_IPPROTO_ICMP', 1);
  9914. /**
  9915. * Provides a RAW socket.
  9916. * @link http://www.php.net/manual/en/stream.constants.php
  9917. */
  9918. define ('STREAM_IPPROTO_RAW', 255);
  9919. /**
  9920. * Provides sequenced, two-way byte streams with a transmission mechanism
  9921. * for out-of-band data (TCP, for example).
  9922. * @link http://www.php.net/manual/en/stream.constants.php
  9923. */
  9924. define ('STREAM_SOCK_STREAM', 1);
  9925. /**
  9926. * Provides datagrams, which are connectionless messages (UDP, for
  9927. * example).
  9928. * @link http://www.php.net/manual/en/stream.constants.php
  9929. */
  9930. define ('STREAM_SOCK_DGRAM', 2);
  9931. /**
  9932. * Provides a raw socket, which provides access to internal network
  9933. * protocols and interfaces. Usually this type of socket is just available
  9934. * to the root user.
  9935. * @link http://www.php.net/manual/en/stream.constants.php
  9936. */
  9937. define ('STREAM_SOCK_RAW', 3);
  9938. /**
  9939. * Provides a sequenced packet stream socket.
  9940. * @link http://www.php.net/manual/en/stream.constants.php
  9941. */
  9942. define ('STREAM_SOCK_SEQPACKET', 5);
  9943. /**
  9944. * Provides a RDM (Reliably-delivered messages) socket.
  9945. * @link http://www.php.net/manual/en/stream.constants.php
  9946. */
  9947. define ('STREAM_SOCK_RDM', 4);
  9948. define ('STREAM_PEEK', 2);
  9949. define ('STREAM_OOB', 1);
  9950. /**
  9951. * Tells a stream created with stream_socket_server
  9952. * to bind to the specified target. Server sockets should always include this flag.
  9953. * @link http://www.php.net/manual/en/stream.constants.php
  9954. */
  9955. define ('STREAM_SERVER_BIND', 4);
  9956. /**
  9957. * Tells a stream created with stream_socket_server
  9958. * and bound using the STREAM_SERVER_BIND flag to start
  9959. * listening on the socket. Connection-orientated transports (such as TCP)
  9960. * must use this flag, otherwise the server socket will not be enabled.
  9961. * Using this flag for connect-less transports (such as UDP) is an error.
  9962. * @link http://www.php.net/manual/en/stream.constants.php
  9963. */
  9964. define ('STREAM_SERVER_LISTEN', 8);
  9965. /**
  9966. * Search for filename in
  9967. * include_path (since PHP 5).
  9968. * @link http://www.php.net/manual/en/filesystem.constants.php
  9969. */
  9970. define ('FILE_USE_INCLUDE_PATH', 1);
  9971. /**
  9972. * Strip EOL characters (since PHP 5).
  9973. * @link http://www.php.net/manual/en/filesystem.constants.php
  9974. */
  9975. define ('FILE_IGNORE_NEW_LINES', 2);
  9976. /**
  9977. * Skip empty lines (since PHP 5).
  9978. * @link http://www.php.net/manual/en/filesystem.constants.php
  9979. */
  9980. define ('FILE_SKIP_EMPTY_LINES', 4);
  9981. /**
  9982. * Append content to existing file.
  9983. * @link http://www.php.net/manual/en/filesystem.constants.php
  9984. */
  9985. define ('FILE_APPEND', 8);
  9986. define ('FILE_NO_DEFAULT_CONTEXT', 16);
  9987. /**
  9988. * <p>
  9989. * Text mode (since PHP 5.2.7).
  9990. * <p>
  9991. * This constant has no effect, and is only available for
  9992. * forward compatibility.
  9993. * </p>
  9994. * </p>
  9995. * @link http://www.php.net/manual/en/filesystem.constants.php
  9996. */
  9997. define ('FILE_TEXT', 0);
  9998. /**
  9999. * <p>
  10000. * Binary mode (since PHP 5.2.7).
  10001. * <p>
  10002. * This constant has no effect, and is only available for
  10003. * forward compatibility.
  10004. * </p>
  10005. * </p>
  10006. * @link http://www.php.net/manual/en/filesystem.constants.php
  10007. */
  10008. define ('FILE_BINARY', 0);
  10009. /**
  10010. * Disable backslash escaping.
  10011. * @link http://www.php.net/manual/en/filesystem.constants.php
  10012. */
  10013. define ('FNM_NOESCAPE', 2);
  10014. /**
  10015. * Slash in string only matches slash in the given pattern.
  10016. * @link http://www.php.net/manual/en/filesystem.constants.php
  10017. */
  10018. define ('FNM_PATHNAME', 1);
  10019. /**
  10020. * Leading period in string must be exactly matched by period in the given pattern.
  10021. * @link http://www.php.net/manual/en/filesystem.constants.php
  10022. */
  10023. define ('FNM_PERIOD', 4);
  10024. /**
  10025. * Caseless match. Part of the GNU extension.
  10026. * @link http://www.php.net/manual/en/filesystem.constants.php
  10027. */
  10028. define ('FNM_CASEFOLD', 16);
  10029. /**
  10030. * Return Code indicating that the
  10031. * userspace filter returned buckets in $out.
  10032. * @link http://www.php.net/manual/en/stream.constants.php
  10033. */
  10034. define ('PSFS_PASS_ON', 2);
  10035. /**
  10036. * Return Code indicating that the
  10037. * userspace filter did not return buckets in $out
  10038. * (i.e. No data available).
  10039. * @link http://www.php.net/manual/en/stream.constants.php
  10040. */
  10041. define ('PSFS_FEED_ME', 1);
  10042. /**
  10043. * Return Code indicating that the
  10044. * userspace filter encountered an unrecoverable error
  10045. * (i.e. Invalid data received).
  10046. * @link http://www.php.net/manual/en/stream.constants.php
  10047. */
  10048. define ('PSFS_ERR_FATAL', 0);
  10049. /**
  10050. * Regular read/write.
  10051. * @link http://www.php.net/manual/en/stream.constants.php
  10052. */
  10053. define ('PSFS_FLAG_NORMAL', 0);
  10054. /**
  10055. * An incremental flush.
  10056. * @link http://www.php.net/manual/en/stream.constants.php
  10057. */
  10058. define ('PSFS_FLAG_FLUSH_INC', 1);
  10059. /**
  10060. * Final flush prior to closing.
  10061. * @link http://www.php.net/manual/en/stream.constants.php
  10062. */
  10063. define ('PSFS_FLAG_FLUSH_CLOSE', 2);
  10064. define ('ABDAY_1', 131072);
  10065. define ('ABDAY_2', 131073);
  10066. define ('ABDAY_3', 131074);
  10067. define ('ABDAY_4', 131075);
  10068. define ('ABDAY_5', 131076);
  10069. define ('ABDAY_6', 131077);
  10070. define ('ABDAY_7', 131078);
  10071. define ('DAY_1', 131079);
  10072. define ('DAY_2', 131080);
  10073. define ('DAY_3', 131081);
  10074. define ('DAY_4', 131082);
  10075. define ('DAY_5', 131083);
  10076. define ('DAY_6', 131084);
  10077. define ('DAY_7', 131085);
  10078. define ('ABMON_1', 131086);
  10079. define ('ABMON_2', 131087);
  10080. define ('ABMON_3', 131088);
  10081. define ('ABMON_4', 131089);
  10082. define ('ABMON_5', 131090);
  10083. define ('ABMON_6', 131091);
  10084. define ('ABMON_7', 131092);
  10085. define ('ABMON_8', 131093);
  10086. define ('ABMON_9', 131094);
  10087. define ('ABMON_10', 131095);
  10088. define ('ABMON_11', 131096);
  10089. define ('ABMON_12', 131097);
  10090. define ('MON_1', 131098);
  10091. define ('MON_2', 131099);
  10092. define ('MON_3', 131100);
  10093. define ('MON_4', 131101);
  10094. define ('MON_5', 131102);
  10095. define ('MON_6', 131103);
  10096. define ('MON_7', 131104);
  10097. define ('MON_8', 131105);
  10098. define ('MON_9', 131106);
  10099. define ('MON_10', 131107);
  10100. define ('MON_11', 131108);
  10101. define ('MON_12', 131109);
  10102. define ('AM_STR', 131110);
  10103. define ('PM_STR', 131111);
  10104. define ('D_T_FMT', 131112);
  10105. define ('D_FMT', 131113);
  10106. define ('T_FMT', 131114);
  10107. define ('T_FMT_AMPM', 131115);
  10108. define ('ERA', 131116);
  10109. define ('ERA_D_T_FMT', 131120);
  10110. define ('ERA_D_FMT', 131118);
  10111. define ('ERA_T_FMT', 131121);
  10112. define ('ALT_DIGITS', 131119);
  10113. define ('CRNCYSTR', 262159);
  10114. define ('RADIXCHAR', 65536);
  10115. define ('THOUSEP', 65537);
  10116. define ('YESEXPR', 327680);
  10117. define ('NOEXPR', 327681);
  10118. define ('CODESET', 14);
  10119. define ('CRYPT_SALT_LENGTH', 123);
  10120. define ('CRYPT_STD_DES', 1);
  10121. define ('CRYPT_EXT_DES', 1);
  10122. define ('CRYPT_MD5', 1);
  10123. define ('CRYPT_BLOWFISH', 1);
  10124. define ('CRYPT_SHA256', 1);
  10125. define ('CRYPT_SHA512', 1);
  10126. define ('DIRECTORY_SEPARATOR', "/");
  10127. define ('PATH_SEPARATOR', ":");
  10128. define ('GLOB_BRACE', 1024);
  10129. define ('GLOB_MARK', 2);
  10130. define ('GLOB_NOSORT', 4);
  10131. define ('GLOB_NOCHECK', 16);
  10132. define ('GLOB_NOESCAPE', 64);
  10133. define ('GLOB_ERR', 1);
  10134. define ('GLOB_ONLYDIR', 8192);
  10135. define ('GLOB_AVAILABLE_FLAGS', 9303);
  10136. /**
  10137. * system is unusable
  10138. * @link http://www.php.net/manual/en/network.constants.php
  10139. */
  10140. define ('LOG_EMERG', 0);
  10141. /**
  10142. * action must be taken immediately
  10143. * @link http://www.php.net/manual/en/network.constants.php
  10144. */
  10145. define ('LOG_ALERT', 1);
  10146. /**
  10147. * critical conditions
  10148. * @link http://www.php.net/manual/en/network.constants.php
  10149. */
  10150. define ('LOG_CRIT', 2);
  10151. /**
  10152. * error conditions
  10153. * @link http://www.php.net/manual/en/network.constants.php
  10154. */
  10155. define ('LOG_ERR', 3);
  10156. /**
  10157. * warning conditions
  10158. * @link http://www.php.net/manual/en/network.constants.php
  10159. */
  10160. define ('LOG_WARNING', 4);
  10161. /**
  10162. * normal, but significant, condition
  10163. * @link http://www.php.net/manual/en/network.constants.php
  10164. */
  10165. define ('LOG_NOTICE', 5);
  10166. /**
  10167. * informational message
  10168. * @link http://www.php.net/manual/en/network.constants.php
  10169. */
  10170. define ('LOG_INFO', 6);
  10171. /**
  10172. * debug-level message
  10173. * @link http://www.php.net/manual/en/network.constants.php
  10174. */
  10175. define ('LOG_DEBUG', 7);
  10176. /**
  10177. * kernel messages
  10178. * @link http://www.php.net/manual/en/network.constants.php
  10179. */
  10180. define ('LOG_KERN', 0);
  10181. /**
  10182. * generic user-level messages
  10183. * @link http://www.php.net/manual/en/network.constants.php
  10184. */
  10185. define ('LOG_USER', 8);
  10186. /**
  10187. * mail subsystem
  10188. * @link http://www.php.net/manual/en/network.constants.php
  10189. */
  10190. define ('LOG_MAIL', 16);
  10191. /**
  10192. * other system daemons
  10193. * @link http://www.php.net/manual/en/network.constants.php
  10194. */
  10195. define ('LOG_DAEMON', 24);
  10196. /**
  10197. * security/authorization messages (use LOG_AUTHPRIV instead
  10198. * in systems where that constant is defined)
  10199. * @link http://www.php.net/manual/en/network.constants.php
  10200. */
  10201. define ('LOG_AUTH', 32);
  10202. /**
  10203. * messages generated internally by syslogd
  10204. * @link http://www.php.net/manual/en/network.constants.php
  10205. */
  10206. define ('LOG_SYSLOG', 40);
  10207. /**
  10208. * line printer subsystem
  10209. * @link http://www.php.net/manual/en/network.constants.php
  10210. */
  10211. define ('LOG_LPR', 48);
  10212. /**
  10213. * USENET news subsystem
  10214. * @link http://www.php.net/manual/en/network.constants.php
  10215. */
  10216. define ('LOG_NEWS', 56);
  10217. /**
  10218. * UUCP subsystem
  10219. * @link http://www.php.net/manual/en/network.constants.php
  10220. */
  10221. define ('LOG_UUCP', 64);
  10222. /**
  10223. * clock daemon (cron and at)
  10224. * @link http://www.php.net/manual/en/network.constants.php
  10225. */
  10226. define ('LOG_CRON', 72);
  10227. /**
  10228. * security/authorization messages (private)
  10229. * @link http://www.php.net/manual/en/network.constants.php
  10230. */
  10231. define ('LOG_AUTHPRIV', 80);
  10232. define ('LOG_LOCAL0', 128);
  10233. define ('LOG_LOCAL1', 136);
  10234. define ('LOG_LOCAL2', 144);
  10235. define ('LOG_LOCAL3', 152);
  10236. define ('LOG_LOCAL4', 160);
  10237. define ('LOG_LOCAL5', 168);
  10238. define ('LOG_LOCAL6', 176);
  10239. define ('LOG_LOCAL7', 184);
  10240. /**
  10241. * include PID with each message
  10242. * @link http://www.php.net/manual/en/network.constants.php
  10243. */
  10244. define ('LOG_PID', 1);
  10245. /**
  10246. * if there is an error while sending data to the system logger,
  10247. * write directly to the system console
  10248. * @link http://www.php.net/manual/en/network.constants.php
  10249. */
  10250. define ('LOG_CONS', 2);
  10251. /**
  10252. * (default) delay opening the connection until the first
  10253. * message is logged
  10254. * @link http://www.php.net/manual/en/network.constants.php
  10255. */
  10256. define ('LOG_ODELAY', 4);
  10257. /**
  10258. * open the connection to the logger immediately
  10259. * @link http://www.php.net/manual/en/network.constants.php
  10260. */
  10261. define ('LOG_NDELAY', 8);
  10262. define ('LOG_NOWAIT', 16);
  10263. /**
  10264. * print log message also to standard error
  10265. * @link http://www.php.net/manual/en/network.constants.php
  10266. */
  10267. define ('LOG_PERROR', 32);
  10268. define ('EXTR_OVERWRITE', 0);
  10269. define ('EXTR_SKIP', 1);
  10270. define ('EXTR_PREFIX_SAME', 2);
  10271. define ('EXTR_PREFIX_ALL', 3);
  10272. define ('EXTR_PREFIX_INVALID', 4);
  10273. define ('EXTR_PREFIX_IF_EXISTS', 5);
  10274. define ('EXTR_IF_EXISTS', 6);
  10275. define ('EXTR_REFS', 256);
  10276. /**
  10277. * SORT_ASC is used with
  10278. * array_multisort to sort in ascending order.
  10279. * @link http://www.php.net/manual/en/array.constants.php
  10280. */
  10281. define ('SORT_ASC', 4);
  10282. /**
  10283. * SORT_DESC is used with
  10284. * array_multisort to sort in descending order.
  10285. * @link http://www.php.net/manual/en/array.constants.php
  10286. */
  10287. define ('SORT_DESC', 3);
  10288. /**
  10289. * SORT_REGULAR is used to compare items normally.
  10290. * @link http://www.php.net/manual/en/array.constants.php
  10291. */
  10292. define ('SORT_REGULAR', 0);
  10293. /**
  10294. * SORT_NUMERIC is used to compare items numerically.
  10295. * @link http://www.php.net/manual/en/array.constants.php
  10296. */
  10297. define ('SORT_NUMERIC', 1);
  10298. /**
  10299. * SORT_STRING is used to compare items as strings.
  10300. * @link http://www.php.net/manual/en/array.constants.php
  10301. */
  10302. define ('SORT_STRING', 2);
  10303. /**
  10304. * SORT_LOCALE_STRING is used to compare items as
  10305. * strings, based on the current locale. Added in PHP 4.4.0 and 5.0.2.
  10306. * @link http://www.php.net/manual/en/array.constants.php
  10307. */
  10308. define ('SORT_LOCALE_STRING', 5);
  10309. /**
  10310. * CASE_LOWER is used with
  10311. * array_change_key_case and is used to convert array
  10312. * keys to lower case. This is also the default case for
  10313. * array_change_key_case.
  10314. * @link http://www.php.net/manual/en/array.constants.php
  10315. */
  10316. define ('CASE_LOWER', 0);
  10317. /**
  10318. * CASE_UPPER is used with
  10319. * array_change_key_case and is used to convert array
  10320. * keys to upper case.
  10321. * @link http://www.php.net/manual/en/array.constants.php
  10322. */
  10323. define ('CASE_UPPER', 1);
  10324. define ('COUNT_NORMAL', 0);
  10325. define ('COUNT_RECURSIVE', 1);
  10326. define ('ASSERT_ACTIVE', 1);
  10327. define ('ASSERT_CALLBACK', 2);
  10328. define ('ASSERT_BAIL', 3);
  10329. define ('ASSERT_WARNING', 4);
  10330. define ('ASSERT_QUIET_EVAL', 5);
  10331. /**
  10332. * Flag indicating if the stream
  10333. * used the include path.
  10334. * @link http://www.php.net/manual/en/stream.constants.php
  10335. */
  10336. define ('STREAM_USE_PATH', 1);
  10337. define ('STREAM_IGNORE_URL', 2);
  10338. define ('STREAM_ENFORCE_SAFE_MODE', 4);
  10339. /**
  10340. * Flag indicating if the wrapper
  10341. * is responsible for raising errors using trigger_error
  10342. * during opening of the stream. If this flag is not set, you
  10343. * should not raise any errors.
  10344. * @link http://www.php.net/manual/en/stream.constants.php
  10345. */
  10346. define ('STREAM_REPORT_ERRORS', 8);
  10347. /**
  10348. * This flag is useful when your extension really must be able to randomly
  10349. * seek around in a stream. Some streams may not be seekable in their
  10350. * native form, so this flag asks the streams API to check to see if the
  10351. * stream does support seeking. If it does not, it will copy the stream
  10352. * into temporary storage (which may be a temporary file or a memory
  10353. * stream) which does support seeking.
  10354. * Please note that this flag is not useful when you want to seek the
  10355. * stream and write to it, because the stream you are accessing might
  10356. * not be bound to the actual resource you requested.
  10357. * If the requested resource is network based, this flag will cause the
  10358. * opener to block until the whole contents have been downloaded.
  10359. * @link http://www.php.net/manual/en/internals2.ze1.streams.constants.php
  10360. */
  10361. define ('STREAM_MUST_SEEK', 16);
  10362. define ('STREAM_URL_STAT_LINK', 1);
  10363. define ('STREAM_URL_STAT_QUIET', 2);
  10364. define ('STREAM_MKDIR_RECURSIVE', 1);
  10365. define ('STREAM_IS_URL', 1);
  10366. define ('STREAM_OPTION_BLOCKING', 1);
  10367. define ('STREAM_OPTION_READ_TIMEOUT', 4);
  10368. define ('STREAM_OPTION_READ_BUFFER', 2);
  10369. define ('STREAM_OPTION_WRITE_BUFFER', 3);
  10370. define ('STREAM_BUFFER_NONE', 0);
  10371. define ('STREAM_BUFFER_LINE', 1);
  10372. define ('STREAM_BUFFER_FULL', 2);
  10373. /**
  10374. * Stream casting, when stream_cast is called
  10375. * otherwise (see above).
  10376. * @link http://www.php.net/manual/en/stream.constants.php
  10377. */
  10378. define ('STREAM_CAST_AS_STREAM', 0);
  10379. /**
  10380. * Stream casting, for when stream_select is
  10381. * calling stream_cast.
  10382. * @link http://www.php.net/manual/en/stream.constants.php
  10383. */
  10384. define ('STREAM_CAST_FOR_SELECT', 3);
  10385. /**
  10386. * Image type constant used by the
  10387. * image_type_to_mime_type and
  10388. * image_type_to_extension functions.
  10389. * @link http://www.php.net/manual/en/image.constants.php
  10390. */
  10391. define ('IMAGETYPE_GIF', 1);
  10392. /**
  10393. * Image type constant used by the
  10394. * image_type_to_mime_type and
  10395. * image_type_to_extension functions.
  10396. * @link http://www.php.net/manual/en/image.constants.php
  10397. */
  10398. define ('IMAGETYPE_JPEG', 2);
  10399. /**
  10400. * Image type constant used by the
  10401. * image_type_to_mime_type and
  10402. * image_type_to_extension functions.
  10403. * @link http://www.php.net/manual/en/image.constants.php
  10404. */
  10405. define ('IMAGETYPE_PNG', 3);
  10406. /**
  10407. * Image type constant used by the
  10408. * image_type_to_mime_type and
  10409. * image_type_to_extension functions.
  10410. * @link http://www.php.net/manual/en/image.constants.php
  10411. */
  10412. define ('IMAGETYPE_SWF', 4);
  10413. /**
  10414. * Image type constant used by the
  10415. * image_type_to_mime_type and
  10416. * image_type_to_extension functions.
  10417. * @link http://www.php.net/manual/en/image.constants.php
  10418. */
  10419. define ('IMAGETYPE_PSD', 5);
  10420. /**
  10421. * Image type constant used by the
  10422. * image_type_to_mime_type and
  10423. * image_type_to_extension functions.
  10424. * @link http://www.php.net/manual/en/image.constants.php
  10425. */
  10426. define ('IMAGETYPE_BMP', 6);
  10427. /**
  10428. * Image type constant used by the
  10429. * image_type_to_mime_type and
  10430. * image_type_to_extension functions.
  10431. * @link http://www.php.net/manual/en/image.constants.php
  10432. */
  10433. define ('IMAGETYPE_TIFF_II', 7);
  10434. /**
  10435. * Image type constant used by the
  10436. * image_type_to_mime_type and
  10437. * image_type_to_extension functions.
  10438. * @link http://www.php.net/manual/en/image.constants.php
  10439. */
  10440. define ('IMAGETYPE_TIFF_MM', 8);
  10441. /**
  10442. * Image type constant used by the
  10443. * image_type_to_mime_type and
  10444. * image_type_to_extension functions.
  10445. * @link http://www.php.net/manual/en/image.constants.php
  10446. */
  10447. define ('IMAGETYPE_JPC', 9);
  10448. /**
  10449. * Image type constant used by the
  10450. * image_type_to_mime_type and
  10451. * image_type_to_extension functions.
  10452. * @link http://www.php.net/manual/en/image.constants.php
  10453. */
  10454. define ('IMAGETYPE_JP2', 10);
  10455. /**
  10456. * Image type constant used by the
  10457. * image_type_to_mime_type and
  10458. * image_type_to_extension functions.
  10459. * @link http://www.php.net/manual/en/image.constants.php
  10460. */
  10461. define ('IMAGETYPE_JPX', 11);
  10462. /**
  10463. * Image type constant used by the
  10464. * image_type_to_mime_type and
  10465. * image_type_to_extension functions.
  10466. * @link http://www.php.net/manual/en/image.constants.php
  10467. */
  10468. define ('IMAGETYPE_JB2', 12);
  10469. /**
  10470. * Image type constant used by the
  10471. * image_type_to_mime_type and
  10472. * image_type_to_extension functions.
  10473. * @link http://www.php.net/manual/en/image.constants.php
  10474. */
  10475. define ('IMAGETYPE_SWC', 13);
  10476. /**
  10477. * Image type constant used by the
  10478. * image_type_to_mime_type and
  10479. * image_type_to_extension functions.
  10480. * @link http://www.php.net/manual/en/image.constants.php
  10481. */
  10482. define ('IMAGETYPE_IFF', 14);
  10483. /**
  10484. * Image type constant used by the
  10485. * image_type_to_mime_type and
  10486. * image_type_to_extension functions.
  10487. * @link http://www.php.net/manual/en/image.constants.php
  10488. */
  10489. define ('IMAGETYPE_WBMP', 15);
  10490. /**
  10491. * Image type constant used by the
  10492. * image_type_to_mime_type and
  10493. * image_type_to_extension functions.
  10494. * @link http://www.php.net/manual/en/image.constants.php
  10495. */
  10496. define ('IMAGETYPE_JPEG2000', 9);
  10497. /**
  10498. * Image type constant used by the
  10499. * image_type_to_mime_type and
  10500. * image_type_to_extension functions.
  10501. * @link http://www.php.net/manual/en/image.constants.php
  10502. */
  10503. define ('IMAGETYPE_XBM', 16);
  10504. /**
  10505. * Image type constant used by the
  10506. * image_type_to_mime_type and
  10507. * image_type_to_extension functions.
  10508. * (Available as of PHP 5.3.0)
  10509. * @link http://www.php.net/manual/en/image.constants.php
  10510. */
  10511. define ('IMAGETYPE_ICO', 17);
  10512. define ('IMAGETYPE_UNKNOWN', 0);
  10513. define ('IMAGETYPE_COUNT', 18);
  10514. /**
  10515. * IPv4 Address Resource
  10516. * @link http://www.php.net/manual/en/network.constants.php
  10517. */
  10518. define ('DNS_A', 1);
  10519. /**
  10520. * Authoritative Name Server Resource
  10521. * @link http://www.php.net/manual/en/network.constants.php
  10522. */
  10523. define ('DNS_NS', 2);
  10524. /**
  10525. * Alias (Canonical Name) Resource
  10526. * @link http://www.php.net/manual/en/network.constants.php
  10527. */
  10528. define ('DNS_CNAME', 16);
  10529. /**
  10530. * Start of Authority Resource
  10531. * @link http://www.php.net/manual/en/network.constants.php
  10532. */
  10533. define ('DNS_SOA', 32);
  10534. /**
  10535. * Pointer Resource
  10536. * @link http://www.php.net/manual/en/network.constants.php
  10537. */
  10538. define ('DNS_PTR', 2048);
  10539. /**
  10540. * Host Info Resource (See IANA's
  10541. * Operating System Names
  10542. * for the meaning of these values)
  10543. * @link http://www.php.net/manual/en/network.constants.php
  10544. */
  10545. define ('DNS_HINFO', 4096);
  10546. /**
  10547. * Mail Exchanger Resource
  10548. * @link http://www.php.net/manual/en/network.constants.php
  10549. */
  10550. define ('DNS_MX', 16384);
  10551. /**
  10552. * Text Resource
  10553. * @link http://www.php.net/manual/en/network.constants.php
  10554. */
  10555. define ('DNS_TXT', 32768);
  10556. define ('DNS_SRV', 33554432);
  10557. define ('DNS_NAPTR', 67108864);
  10558. /**
  10559. * IPv6 Address Resource
  10560. * @link http://www.php.net/manual/en/network.constants.php
  10561. */
  10562. define ('DNS_AAAA', 134217728);
  10563. define ('DNS_A6', 16777216);
  10564. /**
  10565. * Any Resource Record. On most systems
  10566. * this returns all resource records, however
  10567. * it should not be counted upon for critical
  10568. * uses. Try DNS_ALL instead.
  10569. * @link http://www.php.net/manual/en/network.constants.php
  10570. */
  10571. define ('DNS_ANY', 268435456);
  10572. /**
  10573. * Iteratively query the name server for
  10574. * each available record type.
  10575. * @link http://www.php.net/manual/en/network.constants.php
  10576. */
  10577. define ('DNS_ALL', 251713587);
  10578. // End of standard v.5.3.2
  10579. ?>