PageRenderTime 90ms CodeModel.GetById 21ms RepoModel.GetById 1ms app.codeStats 1ms

/configuration/org.eclipse.osgi/bundles/322/1/.cp/Resources/language/php5.4/standard.php

https://bitbucket.org/2GAndre/myeclipse4php
PHP | 11747 lines | 888 code | 691 blank | 10168 comment | 0 complexity | 36c6b0622c62961190ea431965c3076c MD5 | raw file
Possible License(s): LGPL-2.1, Apache-2.0, BSD-3-Clause
  1. <?php
  2. // Start of standard v.5.4.0RC6
  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. /**
  20. * Close directory handle
  21. * @link http://www.php.net/manual/en/directory.close.php
  22. * @param dir_handle resource[optional]
  23. * @return void
  24. */
  25. public function close ($dir_handle = null) {}
  26. /**
  27. * Rewind directory handle
  28. * @link http://www.php.net/manual/en/directory.rewind.php
  29. * @param dir_handle resource[optional]
  30. * @return void
  31. */
  32. public function rewind ($dir_handle = null) {}
  33. /**
  34. * Read entry from directory handle
  35. * @link http://www.php.net/manual/en/directory.read.php
  36. * @param dir_handle resource[optional]
  37. * @return string
  38. */
  39. public function read ($dir_handle = null) {}
  40. }
  41. /**
  42. * Returns the value of a constant
  43. * @link http://www.php.net/manual/en/function.constant.php
  44. * @param name string <p>
  45. * The constant name.
  46. * </p>
  47. * @return mixed the value of the constant, or &null; if the constant is not
  48. * defined.
  49. */
  50. function constant ($name) {}
  51. /**
  52. * Convert binary data into hexadecimal representation
  53. * @link http://www.php.net/manual/en/function.bin2hex.php
  54. * @param str string <p>
  55. * A string.
  56. * </p>
  57. * @return string the hexadecimal representation of the given string.
  58. */
  59. function bin2hex ($str) {}
  60. /**
  61. * Convert hex to binary
  62. * @link http://www.php.net/manual/en/function.hex2bin.php
  63. * @param data string <p>
  64. * Hexadecimal representation of data.
  65. * </p>
  66. * @return string the binary representation of the given data.
  67. */
  68. function hex2bin ($data) {}
  69. /**
  70. * Delay execution
  71. * @link http://www.php.net/manual/en/function.sleep.php
  72. * @param seconds int <p>
  73. * Halt time in seconds.
  74. * </p>
  75. * @return int zero on success, or false on error.
  76. * </p>
  77. * <p>
  78. * If the call was interrupted by a signal, sleep returns
  79. * a non-zero value. On Windows, this value will always be
  80. * 192 (the value of the
  81. * WAIT_IO_COMPLETION constant within the Windows API).
  82. * On other platforms, the return value will be the number of seconds left to
  83. * sleep.
  84. */
  85. function sleep ($seconds) {}
  86. /**
  87. * Delay execution in microseconds
  88. * @link http://www.php.net/manual/en/function.usleep.php
  89. * @param micro_seconds int <p>
  90. * Halt time in micro seconds. A micro second is one millionth of a
  91. * second.
  92. * </p>
  93. * @return void
  94. */
  95. function usleep ($micro_seconds) {}
  96. /**
  97. * Delay for a number of seconds and nanoseconds
  98. * @link http://www.php.net/manual/en/function.time-nanosleep.php
  99. * @param seconds int <p>
  100. * Must be a non-negative integer.
  101. * </p>
  102. * @param nanoseconds int <p>
  103. * Must be a non-negative integer less than 1 billion.
  104. * </p>
  105. * @return mixed Returns true on success or false on failure.
  106. * </p>
  107. * <p>
  108. * If the delay was interrupted by a signal, an associative array will be
  109. * returned with the components:
  110. * seconds - number of seconds remaining in
  111. * the delay
  112. * nanoseconds - number of nanoseconds
  113. * remaining in the delay
  114. */
  115. function time_nanosleep ($seconds, $nanoseconds) {}
  116. /**
  117. * Make the script sleep until the specified time
  118. * @link http://www.php.net/manual/en/function.time-sleep-until.php
  119. * @param timestamp float <p>
  120. * The timestamp when the script should wake.
  121. * </p>
  122. * @return bool Returns true on success or false on failure.
  123. */
  124. function time_sleep_until ($timestamp) {}
  125. /**
  126. * Parse a time/date generated with <function>strftime</function>
  127. * @link http://www.php.net/manual/en/function.strptime.php
  128. * @param date string <p>
  129. * The string to parse (e.g. returned from strftime).
  130. * </p>
  131. * @param format string <p>
  132. * The format used in date (e.g. the same as
  133. * used in strftime). Note that some of the format
  134. * options available to strftime may not have any
  135. * effect within strptime; the exact subset that are
  136. * supported will vary based on the operating system and C library in
  137. * use.
  138. * </p>
  139. * <p>
  140. * For more information about the format options, read the
  141. * strftime page.
  142. * </p>
  143. * @return array an array&return.falseforfailure;.
  144. * </p>
  145. * <p>
  146. * <table>
  147. * The following parameters are returned in the array
  148. * <tr valign="top">
  149. * <td>parameters</td>
  150. * <td>Description</td>
  151. * </tr>
  152. * <tr valign="top">
  153. * <td>"tm_sec"</td>
  154. * <td>Seconds after the minute (0-61)</td>
  155. * </tr>
  156. * <tr valign="top">
  157. * <td>"tm_min"</td>
  158. * <td>Minutes after the hour (0-59)</td>
  159. * </tr>
  160. * <tr valign="top">
  161. * <td>"tm_hour"</td>
  162. * <td>Hour since midnight (0-23)</td>
  163. * </tr>
  164. * <tr valign="top">
  165. * <td>"tm_mday"</td>
  166. * <td>Day of the month (1-31)</td>
  167. * </tr>
  168. * <tr valign="top">
  169. * <td>"tm_mon"</td>
  170. * <td>Months since January (0-11)</td>
  171. * </tr>
  172. * <tr valign="top">
  173. * <td>"tm_year"</td>
  174. * <td>Years since 1900</td>
  175. * </tr>
  176. * <tr valign="top">
  177. * <td>"tm_wday"</td>
  178. * <td>Days since Sunday (0-6)</td>
  179. * </tr>
  180. * <tr valign="top">
  181. * <td>"tm_yday"</td>
  182. * <td>Days since January 1 (0-365)</td>
  183. * </tr>
  184. * <tr valign="top">
  185. * <td>"unparsed"</td>
  186. * <td>the date part which was not
  187. * recognized using the specified format</td>
  188. * </tr>
  189. * </table>
  190. */
  191. function strptime ($date, $format) {}
  192. /**
  193. * Flush the output buffer
  194. * @link http://www.php.net/manual/en/function.flush.php
  195. * @return void
  196. */
  197. function flush () {}
  198. /**
  199. * Wraps a string to a given number of characters
  200. * @link http://www.php.net/manual/en/function.wordwrap.php
  201. * @param str string <p>
  202. * The input string.
  203. * </p>
  204. * @param width int[optional] <p>
  205. * The column width.
  206. * </p>
  207. * @param break string[optional] <p>
  208. * The line is broken using the optional
  209. * break parameter.
  210. * </p>
  211. * @param cut bool[optional] <p>
  212. * If the cut is set to true, the string is
  213. * always wrapped at or before the specified width. So if you have
  214. * a word that is larger than the given width, it is broken apart.
  215. * (See second example).
  216. * </p>
  217. * @return string the given string wrapped at the specified column.
  218. */
  219. function wordwrap ($str, $width = null, $break = null, $cut = null) {}
  220. /**
  221. * Convert special characters to HTML entities
  222. * @link http://www.php.net/manual/en/function.htmlspecialchars.php
  223. * @param string string <p>
  224. * The string being converted.
  225. * </p>
  226. * @param flags int[optional] <p>
  227. * A bitmask of one or more of the following flags, which specify how to handle quotes,
  228. * invalid code unit sequences and the used document type. The default is
  229. * ENT_COMPAT | ENT_HTML401.
  230. * <table>
  231. * Available flags 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. * <tr valign="top">
  249. * <td>ENT_IGNORE</td>
  250. * <td>
  251. * Silently discard invalid code unit sequences instead of returning
  252. * an empty string. Using this flag is discouraged as it
  253. * may have security implications.
  254. * </td>
  255. * </tr>
  256. * <tr valign="top">
  257. * <td>ENT_SUBSTITUTE</td>
  258. * <td>
  259. * Replace invalid code unit sequences with a Unicode Replacement Character
  260. * U+FFFD (UTF-8) or &amp;#FFFD; (otherwise) instead of returning an empty string.
  261. * </td>
  262. * </tr>
  263. * <tr valign="top">
  264. * <td>ENT_DISALLOWED</td>
  265. * <td>
  266. * Replace code unit sequences, which are invalid in the specified document type,
  267. * with a Unicode Replacement Character U+FFFD (UTF-8) or &amp;#FFFD; (otherwise).
  268. * </td>
  269. * </tr>
  270. * <tr valign="top">
  271. * <td>ENT_HTML401</td>
  272. * <td>
  273. * Handle code as HTML 4.01.
  274. * </td>
  275. * </tr>
  276. * <tr valign="top">
  277. * <td>ENT_XML1</td>
  278. * <td>
  279. * Handle code as XML 1.
  280. * </td>
  281. * </tr>
  282. * <tr valign="top">
  283. * <td>ENT_XHTML</td>
  284. * <td>
  285. * Handle code as XHTML.
  286. * </td>
  287. * </tr>
  288. * <tr valign="top">
  289. * <td>ENT_HTML5</td>
  290. * <td>
  291. * Handle code as HTML 5.
  292. * </td>
  293. * </tr>
  294. * </table>
  295. * </p>
  296. * @param charset string[optional] <p>
  297. * Defines character set used in conversion.
  298. * If omitted, the default value for this argument is ISO-8859-1 in
  299. * versions of PHP prior to 5.4.0, and UTF-8 from PHP 5.4.0 onwards.
  300. * </p>
  301. * <p>
  302. * For the purposes of this function, the charsets
  303. * ISO-8859-1, ISO-8859-15,
  304. * UTF-8, cp866,
  305. * cp1251, cp1252, and
  306. * KOI8-R are effectively equivalent, provided the
  307. * string itself is valid for the character set, as
  308. * the characters affected by htmlspecialchars occupy
  309. * the same positions in all of these charsets.
  310. * </p>
  311. * &reference.strings.charsets;
  312. * @param double_encode bool[optional] <p>
  313. * When double_encode is turned off PHP will not
  314. * encode existing html entities, the default is to convert everything.
  315. * </p>
  316. * @return string The converted string.
  317. * </p>
  318. * <p>
  319. * If the input string contains an invalid code unit
  320. * sequence within the given charset an empty string
  321. * will be returned, unless either the ENT_IGNORE or
  322. * ENT_SUBSTITUTE flags are set.
  323. */
  324. function htmlspecialchars ($string, $flags = null, $charset = null, $double_encode = null) {}
  325. /**
  326. * Convert all applicable characters to HTML entities
  327. * @link http://www.php.net/manual/en/function.htmlentities.php
  328. * @param string string <p>
  329. * The input string.
  330. * </p>
  331. * @param flags int[optional] <p>
  332. * A bitmask of one or more of the following flags, which specify how to handle quotes,
  333. * invalid code unit sequences and the used document type. The default is
  334. * ENT_COMPAT | ENT_HTML401.
  335. * <table>
  336. * Available flags constants
  337. * <tr valign="top">
  338. * <td>Constant Name</td>
  339. * <td>Description</td>
  340. * </tr>
  341. * <tr valign="top">
  342. * <td>ENT_COMPAT</td>
  343. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  344. * </tr>
  345. * <tr valign="top">
  346. * <td>ENT_QUOTES</td>
  347. * <td>Will convert both double and single quotes.</td>
  348. * </tr>
  349. * <tr valign="top">
  350. * <td>ENT_NOQUOTES</td>
  351. * <td>Will leave both double and single quotes unconverted.</td>
  352. * </tr>
  353. * <tr valign="top">
  354. * <td>ENT_IGNORE</td>
  355. * <td>
  356. * Silently discard invalid code unit sequences instead of returning
  357. * an empty string. Using this flag is discouraged as it
  358. * may have security implications.
  359. * </td>
  360. * </tr>
  361. * <tr valign="top">
  362. * <td>ENT_SUBSTITUTE</td>
  363. * <td>
  364. * Replace invalid code unit sequences with a Unicode Replacement Character
  365. * U+FFFD (UTF-8) or &amp;#FFFD; (otherwise) instead of returning an empty string.
  366. * </td>
  367. * </tr>
  368. * <tr valign="top">
  369. * <td>ENT_DISALLOWED</td>
  370. * <td>
  371. * Replace code unit sequences, which are invalid in the specified document type,
  372. * with a Unicode Replacement Character U+FFFD (UTF-8) or &amp;#FFFD; (otherwise).
  373. * </td>
  374. * </tr>
  375. * <tr valign="top">
  376. * <td>ENT_HTML401</td>
  377. * <td>
  378. * Handle code as HTML 4.01.
  379. * </td>
  380. * </tr>
  381. * <tr valign="top">
  382. * <td>ENT_XML1</td>
  383. * <td>
  384. * Handle code as XML 1.
  385. * </td>
  386. * </tr>
  387. * <tr valign="top">
  388. * <td>ENT_XHTML</td>
  389. * <td>
  390. * Handle code as XHTML.
  391. * </td>
  392. * </tr>
  393. * <tr valign="top">
  394. * <td>ENT_HTML5</td>
  395. * <td>
  396. * Handle code as HTML 5.
  397. * </td>
  398. * </tr>
  399. * </table>
  400. * </p>
  401. * @param charset string[optional] <p>
  402. * Like htmlspecialchars,
  403. * htmlentities takes an optional third argument
  404. * charset which defines character set used in
  405. * conversion.
  406. * If omitted, the default value for this argument is ISO-8859-1 in
  407. * versions of PHP prior to 5.4.0, and UTF-8 from PHP 5.4.0 onwards.
  408. * Although this argument is technically optional, you are highly
  409. * encouraged to specify the correct value for your code.
  410. * </p>
  411. * &reference.strings.charsets;
  412. * @param double_encode bool[optional] <p>
  413. * When double_encode is turned off PHP will not
  414. * encode existing html entities. The default is to convert everything.
  415. * </p>
  416. * @return string the encoded string.
  417. * </p>
  418. * <p>
  419. * If the input string contains an invalid code unit
  420. * sequence within the given charset an empty string
  421. * will be returned, unless either the ENT_IGNORE or
  422. * ENT_SUBSTITUTE flags are set.
  423. */
  424. function htmlentities ($string, $flags = null, $charset = null, $double_encode = null) {}
  425. /**
  426. * Convert all HTML entities to their applicable characters
  427. * @link http://www.php.net/manual/en/function.html-entity-decode.php
  428. * @param string string <p>
  429. * The input string.
  430. * </p>
  431. * @param flags int[optional] <p>
  432. * A bitmask of one or more of the following flags, which specify how to handle quotes and
  433. * which document type to use. The default is ENT_COMPAT | ENT_HTML401.
  434. * <table>
  435. * Available flags constants
  436. * <tr valign="top">
  437. * <td>Constant Name</td>
  438. * <td>Description</td>
  439. * </tr>
  440. * <tr valign="top">
  441. * <td>ENT_COMPAT</td>
  442. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  443. * </tr>
  444. * <tr valign="top">
  445. * <td>ENT_QUOTES</td>
  446. * <td>Will convert both double and single quotes.</td>
  447. * </tr>
  448. * <tr valign="top">
  449. * <td>ENT_NOQUOTES</td>
  450. * <td>Will leave both double and single quotes unconverted.</td>
  451. * </tr>
  452. * <tr valign="top">
  453. * <td>ENT_HTML401</td>
  454. * <td>
  455. * Handle code as HTML 4.01.
  456. * </td>
  457. * </tr>
  458. * <tr valign="top">
  459. * <td>ENT_XML1</td>
  460. * <td>
  461. * Handle code as XML 1.
  462. * </td>
  463. * </tr>
  464. * <tr valign="top">
  465. * <td>ENT_XHTML</td>
  466. * <td>
  467. * Handle code as XHTML.
  468. * </td>
  469. * </tr>
  470. * <tr valign="top">
  471. * <td>ENT_HTML5</td>
  472. * <td>
  473. * Handle code as HTML 5.
  474. * </td>
  475. * </tr>
  476. * </table>
  477. * </p>
  478. * @param charset string[optional] <p>
  479. * Character set to use.
  480. * If omitted, the default value for this argument is ISO-8859-1 in
  481. * versions of PHP prior to 5.4.0, and UTF-8 from PHP 5.4.0 onwards.
  482. * </p>
  483. * &reference.strings.charsets;
  484. * @return string the decoded string.
  485. */
  486. function html_entity_decode ($string, $flags = null, $charset = null) {}
  487. /**
  488. * Convert special HTML entities back to characters
  489. * @link http://www.php.net/manual/en/function.htmlspecialchars-decode.php
  490. * @param string string <p>
  491. * The string to decode.
  492. * </p>
  493. * @param flags int[optional] <p>
  494. * A bitmask of one or more of the following flags, which specify how to handle quotes and
  495. * which document type to use. The default is ENT_COMPAT | ENT_HTML401.
  496. * <table>
  497. * Available flags constants
  498. * <tr valign="top">
  499. * <td>Constant Name</td>
  500. * <td>Description</td>
  501. * </tr>
  502. * <tr valign="top">
  503. * <td>ENT_COMPAT</td>
  504. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  505. * </tr>
  506. * <tr valign="top">
  507. * <td>ENT_QUOTES</td>
  508. * <td>Will convert both double and single quotes.</td>
  509. * </tr>
  510. * <tr valign="top">
  511. * <td>ENT_NOQUOTES</td>
  512. * <td>Will leave both double and single quotes unconverted.</td>
  513. * </tr>
  514. * <tr valign="top">
  515. * <td>ENT_HTML401</td>
  516. * <td>
  517. * Handle code as HTML 4.01.
  518. * </td>
  519. * </tr>
  520. * <tr valign="top">
  521. * <td>ENT_XML1</td>
  522. * <td>
  523. * Handle code as XML 1.
  524. * </td>
  525. * </tr>
  526. * <tr valign="top">
  527. * <td>ENT_XHTML</td>
  528. * <td>
  529. * Handle code as XHTML.
  530. * </td>
  531. * </tr>
  532. * <tr valign="top">
  533. * <td>ENT_HTML5</td>
  534. * <td>
  535. * Handle code as HTML 5.
  536. * </td>
  537. * </tr>
  538. * </table>
  539. * </p>
  540. * @return string the decoded string.
  541. */
  542. function htmlspecialchars_decode ($string, $flags = null) {}
  543. /**
  544. * Returns the translation table used by <function>htmlspecialchars</function> and <function>htmlentities</function>
  545. * @link http://www.php.net/manual/en/function.get-html-translation-table.php
  546. * @param table int[optional] <p>
  547. * Which table to return. Either HTML_ENTITIES or
  548. * HTML_SPECIALCHARS.
  549. * </p>
  550. * @param flags int[optional] <p>
  551. * A bitmask of one or more of the following flags, which specify which quotes the
  552. * table will contain as well as which document type the table is for. The default is
  553. * ENT_COMPAT | ENT_HTML401.
  554. * <table>
  555. * Available flags constants
  556. * <tr valign="top">
  557. * <td>Constant Name</td>
  558. * <td>Description</td>
  559. * </tr>
  560. * <tr valign="top">
  561. * <td>ENT_COMPAT</td>
  562. * <td>Table will contain entities for double-quotes, but not for single-quotes.</td>
  563. * </tr>
  564. * <tr valign="top">
  565. * <td>ENT_QUOTES</td>
  566. * <td>Table will contain entities for both double and single quotes.</td>
  567. * </tr>
  568. * <tr valign="top">
  569. * <td>ENT_NOQUOTES</td>
  570. * <td>Table will neither contain entities for single quotes nor for double quotes.</td>
  571. * </tr>
  572. * <tr valign="top">
  573. * <td>ENT_HTML401</td>
  574. * <td>Table for HTML 4.01.</td>
  575. * </tr>
  576. * <tr valign="top">
  577. * <td>ENT_XML1</td>
  578. * <td>Table for XML 1.</td>
  579. * </tr>
  580. * <tr valign="top">
  581. * <td>ENT_XHTML</td>
  582. * <td>Table for XHTML.</td>
  583. * </tr>
  584. * <tr valign="top">
  585. * <td>ENT_HTML5</td>
  586. * <td>Table for HTML 5.</td>
  587. * </tr>
  588. * </table>
  589. * </p>
  590. * @param charset string[optional] <p>
  591. * Character set to use.
  592. * If omitted, the default value for this argument is ISO-8859-1 in
  593. * versions of PHP prior to 5.4.0, and UTF-8 from PHP 5.4.0 onwards.
  594. * </p>
  595. * &reference.strings.charsets;
  596. * @return array the translation table as an array, with the original characters
  597. * as keys and entities as values.
  598. */
  599. function get_html_translation_table ($table = null, $flags = null, $charset = null) {}
  600. /**
  601. * Calculate the sha1 hash of a string
  602. * @link http://www.php.net/manual/en/function.sha1.php
  603. * @param str string <p>
  604. * The input string.
  605. * </p>
  606. * @param raw_output bool[optional] <p>
  607. * If the optional raw_output is set to true,
  608. * then the sha1 digest is instead returned in raw binary format with a
  609. * length of 20, otherwise the returned value is a 40-character
  610. * hexadecimal number.
  611. * </p>
  612. * @return string the sha1 hash as a string.
  613. */
  614. function sha1 ($str, $raw_output = null) {}
  615. /**
  616. * Calculate the sha1 hash of a file
  617. * @link http://www.php.net/manual/en/function.sha1-file.php
  618. * @param filename string <p>
  619. * The filename of the file to hash.
  620. * </p>
  621. * @param raw_output bool[optional] <p>
  622. * When true, returns the digest in raw binary format with a length of
  623. * 20.
  624. * </p>
  625. * @return string a string on success, false otherwise.
  626. */
  627. function sha1_file ($filename, $raw_output = null) {}
  628. /**
  629. * Calculate the md5 hash of a string
  630. * @link http://www.php.net/manual/en/function.md5.php
  631. * @param str string <p>
  632. * The string.
  633. * </p>
  634. * @param raw_output bool[optional] <p>
  635. * If the optional raw_output is set to true,
  636. * then the md5 digest is instead returned in raw binary format with a
  637. * length of 16.
  638. * </p>
  639. * @return string the hash as a 32-character hexadecimal number.
  640. */
  641. function md5 ($str, $raw_output = null) {}
  642. /**
  643. * Calculates the md5 hash of a given file
  644. * @link http://www.php.net/manual/en/function.md5-file.php
  645. * @param filename string <p>
  646. * The filename
  647. * </p>
  648. * @param raw_output bool[optional] <p>
  649. * When true, returns the digest in raw binary format with a length of
  650. * 16.
  651. * </p>
  652. * @return string a string on success, false otherwise.
  653. */
  654. function md5_file ($filename, $raw_output = null) {}
  655. /**
  656. * Calculates the crc32 polynomial of a string
  657. * @link http://www.php.net/manual/en/function.crc32.php
  658. * @param str string <p>
  659. * The data.
  660. * </p>
  661. * @return int the crc32 checksum of str as an integer.
  662. */
  663. function crc32 ($str) {}
  664. /**
  665. * Parse a binary IPTC block into single tags.
  666. * @link http://www.php.net/manual/en/function.iptcparse.php
  667. * @param iptcblock string <p>
  668. * A binary IPTC block.
  669. * </p>
  670. * @return array an array using the tagmarker as an index and the value as the
  671. * value. It returns false on error or if no IPTC data was found.
  672. */
  673. function iptcparse ($iptcblock) {}
  674. /**
  675. * Embeds binary IPTC data into a JPEG image
  676. * @link http://www.php.net/manual/en/function.iptcembed.php
  677. * @param iptcdata string <p>
  678. * The data to be written.
  679. * </p>
  680. * @param jpeg_file_name string <p>
  681. * Path to the JPEG image.
  682. * </p>
  683. * @param spool int[optional] <p>
  684. * Spool flag. If the spool flag is over 2 then the JPEG will be
  685. * returned as a string.
  686. * </p>
  687. * @return mixed If success and spool flag is lower than 2 then the JPEG will not be
  688. * returned as a string, false on errors.
  689. */
  690. function iptcembed ($iptcdata, $jpeg_file_name, $spool = null) {}
  691. /**
  692. * Get the size of an image
  693. * @link http://www.php.net/manual/en/function.getimagesize.php
  694. * @param filename string <p>
  695. * This parameter specifies the file you wish to retrieve information
  696. * about. It can reference a local file or (configuration permitting) a
  697. * remote file using one of the supported streams.
  698. * </p>
  699. * @param imageinfo array[optional] <p>
  700. * This optional parameter allows you to extract some extended
  701. * information from the image file. Currently, this will return the
  702. * different JPG APP markers as an associative array.
  703. * Some programs use these APP markers to embed text information in
  704. * images. A very common one is to embed
  705. * IPTC information in the APP13 marker.
  706. * You can use the iptcparse function to parse the
  707. * binary APP13 marker into something readable.
  708. * </p>
  709. * @return array an array with 7 elements.
  710. * </p>
  711. * <p>
  712. * Index 0 and 1 contains respectively the width and the height of the image.
  713. * </p>
  714. * <p>
  715. * Some formats may contain no image or may contain multiple images. In these
  716. * cases, getimagesize might not be able to properly
  717. * determine the image size. getimagesize will return
  718. * zero for width and height in these cases.
  719. * </p>
  720. * <p>
  721. * Index 2 is one of the IMAGETYPE_XXX constants indicating
  722. * the type of the image.
  723. * </p>
  724. * <p>
  725. * Index 3 is a text string with the correct
  726. * height="yyy" width="xxx" string that can be used
  727. * directly in an IMG tag.
  728. * </p>
  729. * <p>
  730. * mime is the correspondant MIME type of the image.
  731. * This information can be used to deliver images with the correct HTTP
  732. * Content-type header:
  733. * getimagesize and MIME types
  734. * ]]>
  735. * </p>
  736. * <p>
  737. * channels will be 3 for RGB pictures and 4 for CMYK
  738. * pictures.
  739. * </p>
  740. * <p>
  741. * bits is the number of bits for each color.
  742. * </p>
  743. * <p>
  744. * For some image types, the presence of channels and
  745. * bits values can be a bit
  746. * confusing. As an example, GIF always uses 3 channels
  747. * per pixel, but the number of bits per pixel cannot be calculated for an
  748. * animated GIF with a global color table.
  749. * </p>
  750. * <p>
  751. * On failure, false is returned.
  752. */
  753. function getimagesize ($filename, array &$imageinfo = null) {}
  754. /**
  755. * @param imagefile
  756. * @param info[optional]
  757. */
  758. function getimagesizefromstring ($imagefile, &$info) {}
  759. /**
  760. * Get Mime-Type for image-type returned by getimagesize,
  761. exif_read_data, exif_thumbnail, exif_imagetype
  762. * @link http://www.php.net/manual/en/function.image-type-to-mime-type.php
  763. * @param imagetype int <p>
  764. * One of the IMAGETYPE_XXX constants.
  765. * </p>
  766. * @return string The returned values are as follows
  767. * <table>
  768. * Returned values Constants
  769. * <tr valign="top">
  770. * <td>imagetype</td>
  771. * <td>Returned value</td>
  772. * </tr>
  773. * <tr valign="top">
  774. * <td>IMAGETYPE_GIF</td>
  775. * <td>image/gif</td>
  776. * </tr>
  777. * <tr valign="top">
  778. * <td>IMAGETYPE_JPEG</td>
  779. * <td>image/jpeg</td>
  780. * </tr>
  781. * <tr valign="top">
  782. * <td>IMAGETYPE_PNG</td>
  783. * <td>image/png</td>
  784. * </tr>
  785. * <tr valign="top">
  786. * <td>IMAGETYPE_SWF</td>
  787. * <td>application/x-shockwave-flash</td>
  788. * </tr>
  789. * <tr valign="top">
  790. * <td>IMAGETYPE_PSD</td>
  791. * <td>image/psd</td>
  792. * </tr>
  793. * <tr valign="top">
  794. * <td>IMAGETYPE_BMP</td>
  795. * <td>image/bmp</td>
  796. * </tr>
  797. * <tr valign="top">
  798. * <td>IMAGETYPE_TIFF_II (intel byte order)</td>
  799. * <td>image/tiff</td>
  800. * </tr>
  801. * <tr valign="top">
  802. * <td>
  803. * IMAGETYPE_TIFF_MM (motorola byte order)
  804. * </td>
  805. * <td>image/tiff</td>
  806. * </tr>
  807. * <tr valign="top">
  808. * <td>IMAGETYPE_JPC</td>
  809. * <td>application/octet-stream</td>
  810. * </tr>
  811. * <tr valign="top">
  812. * <td>IMAGETYPE_JP2</td>
  813. * <td>image/jp2</td>
  814. * </tr>
  815. * <tr valign="top">
  816. * <td>IMAGETYPE_JPX</td>
  817. * <td>application/octet-stream</td>
  818. * </tr>
  819. * <tr valign="top">
  820. * <td>IMAGETYPE_JB2</td>
  821. * <td>application/octet-stream</td>
  822. * </tr>
  823. * <tr valign="top">
  824. * <td>IMAGETYPE_SWC</td>
  825. * <td>application/x-shockwave-flash</td>
  826. * </tr>
  827. * <tr valign="top">
  828. * <td>IMAGETYPE_IFF</td>
  829. * <td>image/iff</td>
  830. * </tr>
  831. * <tr valign="top">
  832. * <td>IMAGETYPE_WBMP</td>
  833. * <td>image/vnd.wap.wbmp</td>
  834. * </tr>
  835. * <tr valign="top">
  836. * <td>IMAGETYPE_XBM</td>
  837. * <td>image/xbm</td>
  838. * </tr>
  839. * <tr valign="top">
  840. * <td>IMAGETYPE_ICO</td>
  841. * <td>image/vnd.microsoft.icon</td>
  842. * </tr>
  843. * </table>
  844. */
  845. function image_type_to_mime_type ($imagetype) {}
  846. /**
  847. * Get file extension for image type
  848. * @link http://www.php.net/manual/en/function.image-type-to-extension.php
  849. * @param imagetype int <p>
  850. * One of the IMAGETYPE_XXX constant.
  851. * </p>
  852. * @param include_dot bool[optional] <p>
  853. * Whether to prepend a dot to the extension or not. Default to true.
  854. * </p>
  855. * @return string A string with the extension corresponding to the given image type.
  856. */
  857. function image_type_to_extension ($imagetype, $include_dot = null) {}
  858. /**
  859. * Outputs information about PHP's configuration
  860. * @link http://www.php.net/manual/en/function.phpinfo.php
  861. * @param what int[optional] <p>
  862. * The output may be customized by passing one or more of the
  863. * following constants bitwise values summed
  864. * together in the optional what parameter.
  865. * One can also combine the respective constants or bitwise values
  866. * together with the or operator.
  867. * </p>
  868. * <p>
  869. * <table>
  870. * phpinfo options
  871. * <tr valign="top">
  872. * <td>Name (constant)</td>
  873. * <td>Value</td>
  874. * <td>Description</td>
  875. * </tr>
  876. * <tr valign="top">
  877. * <td>INFO_GENERAL</td>
  878. * <td>1</td>
  879. * <td>
  880. * The configuration line, &php.ini; location, build date, Web
  881. * Server, System and more.
  882. * </td>
  883. * </tr>
  884. * <tr valign="top">
  885. * <td>INFO_CREDITS</td>
  886. * <td>2</td>
  887. * <td>
  888. * PHP Credits. See also phpcredits.
  889. * </td>
  890. * </tr>
  891. * <tr valign="top">
  892. * <td>INFO_CONFIGURATION</td>
  893. * <td>4</td>
  894. * <td>
  895. * Current Local and Master values for PHP directives. See
  896. * also ini_get.
  897. * </td>
  898. * </tr>
  899. * <tr valign="top">
  900. * <td>INFO_MODULES</td>
  901. * <td>8</td>
  902. * <td>
  903. * Loaded modules and their respective settings. See also
  904. * get_loaded_extensions.
  905. * </td>
  906. * </tr>
  907. * <tr valign="top">
  908. * <td>INFO_ENVIRONMENT</td>
  909. * <td>16</td>
  910. * <td>
  911. * Environment Variable information that's also available in
  912. * $_ENV.
  913. * </td>
  914. * </tr>
  915. * <tr valign="top">
  916. * <td>INFO_VARIABLES</td>
  917. * <td>32</td>
  918. * <td>
  919. * Shows all
  920. * predefined variables from EGPCS (Environment, GET,
  921. * POST, Cookie, Server).
  922. * </td>
  923. * </tr>
  924. * <tr valign="top">
  925. * <td>INFO_LICENSE</td>
  926. * <td>64</td>
  927. * <td>
  928. * PHP License information. See also the license FAQ.
  929. * </td>
  930. * </tr>
  931. * <tr valign="top">
  932. * <td>INFO_ALL</td>
  933. * <td>-1</td>
  934. * <td>
  935. * Shows all of the above.
  936. * </td>
  937. * </tr>
  938. * </table>
  939. * </p>
  940. * @return bool Returns true on success or false on failure.
  941. */
  942. function phpinfo ($what = null) {}
  943. /**
  944. * Gets the current PHP version
  945. * @link http://www.php.net/manual/en/function.phpversion.php
  946. * @param extension string[optional] <p>
  947. * An optional extension name.
  948. * </p>
  949. * @return string If the optional extension parameter is
  950. * specified, phpversion returns the version of that
  951. * extension, or false if there is no version information associated or
  952. * the extension isn't enabled.
  953. */
  954. function phpversion ($extension = null) {}
  955. /**
  956. * Prints out the credits for PHP
  957. * @link http://www.php.net/manual/en/function.phpcredits.php
  958. * @param flag int[optional] <p>
  959. * To generate a custom credits page, you may want to use the
  960. * flag parameter.
  961. * </p>
  962. * <p>
  963. * <table>
  964. * Pre-defined phpcredits flags
  965. * <tr valign="top">
  966. * <td>name</td>
  967. * <td>description</td>
  968. * </tr>
  969. * <tr valign="top">
  970. * <td>CREDITS_ALL</td>
  971. * <td>
  972. * All the credits, equivalent to using: CREDITS_DOCS +
  973. * CREDITS_GENERAL + CREDITS_GROUP +
  974. * CREDITS_MODULES + CREDITS_FULLPAGE.
  975. * It generates a complete stand-alone HTML page with the appropriate tags.
  976. * </td>
  977. * </tr>
  978. * <tr valign="top">
  979. * <td>CREDITS_DOCS</td>
  980. * <td>The credits for the documentation team</td>
  981. * </tr>
  982. * <tr valign="top">
  983. * <td>CREDITS_FULLPAGE</td>
  984. * <td>
  985. * Usually used in combination with the other flags. Indicates
  986. * that a complete stand-alone HTML page needs to be
  987. * printed including the information indicated by the other
  988. * flags.
  989. * </td>
  990. * </tr>
  991. * <tr valign="top">
  992. * <td>CREDITS_GENERAL</td>
  993. * <td>
  994. * General credits: Language design and concept, PHP authors
  995. * and SAPI module.
  996. * </td>
  997. * </tr>
  998. * <tr valign="top">
  999. * <td>CREDITS_GROUP</td>
  1000. * <td>A list of the core developers</td>
  1001. * </tr>
  1002. * <tr valign="top">
  1003. * <td>CREDITS_MODULES</td>
  1004. * <td>
  1005. * A list of the extension modules for PHP, and their authors
  1006. * </td>
  1007. * </tr>
  1008. * <tr valign="top">
  1009. * <td>CREDITS_SAPI</td>
  1010. * <td>
  1011. * A list of the server API modules for PHP, and their authors
  1012. * </td>
  1013. * </tr>
  1014. * </table>
  1015. * </p>
  1016. * @return bool Returns true on success or false on failure.
  1017. */
  1018. function phpcredits ($flag = null) {}
  1019. /**
  1020. * Gets the logo guid
  1021. * @link http://www.php.net/manual/en/function.php-logo-guid.php
  1022. * @return string PHPE9568F34-D428-11d2-A769-00AA001ACF42.
  1023. */
  1024. function php_logo_guid () {}
  1025. function php_real_logo_guid () {}
  1026. function php_egg_logo_guid () {}
  1027. /**
  1028. * Gets the Zend guid
  1029. * @link http://www.php.net/manual/en/function.zend-logo-guid.php
  1030. * @return string PHPE9568F35-D428-11d2-A769-00AA001ACF42.
  1031. */
  1032. function zend_logo_guid () {}
  1033. /**
  1034. * Returns the type of interface between web server and PHP
  1035. * @link http://www.php.net/manual/en/function.php-sapi-name.php
  1036. * @return string the interface type, as a lowercase string.
  1037. * </p>
  1038. * <p>
  1039. * Although not exhaustive, the possible return values include
  1040. * aolserver, apache,
  1041. * apache2filter, apache2handler,
  1042. * caudium, cgi (until PHP 5.3),
  1043. * cgi-fcgi, cli,
  1044. * continuity, embed,
  1045. * isapi, litespeed,
  1046. * milter, nsapi,
  1047. * phttpd, pi3web, roxen,
  1048. * thttpd, tux, and webjames.
  1049. */
  1050. function php_sapi_name () {}
  1051. /**
  1052. * Returns information about the operating system PHP is running on
  1053. * @link http://www.php.net/manual/en/function.php-uname.php
  1054. * @param mode string[optional] <p>
  1055. * mode is a single character that defines what
  1056. * information is returned:
  1057. * 'a': This is the default. Contains all modes in
  1058. * the sequence "s n r v m".
  1059. * @return string the description, as a string.
  1060. */
  1061. function php_uname ($mode = null) {}
  1062. /**
  1063. * Return a list of .ini files parsed from the additional ini dir
  1064. * @link http://www.php.net/manual/en/function.php-ini-scanned-files.php
  1065. * @return string a comma-separated string of .ini files on success. Each comma is
  1066. * followed by a newline. If the directive --with-config-file-scan-dir wasn't set,
  1067. * false is returned. If it was set and the directory was empty, an
  1068. * empty string is returned. If a file is unrecognizable, the file will
  1069. * still make it into the returned string but a PHP error will also result.
  1070. * This PHP error will be seen both at compile time and while using
  1071. * php_ini_scanned_files.
  1072. */
  1073. function php_ini_scanned_files () {}
  1074. /**
  1075. * Retrieve a path to the loaded php.ini file
  1076. * @link http://www.php.net/manual/en/function.php-ini-loaded-file.php
  1077. * @return string The loaded &php.ini; path, or false if one is not loaded.
  1078. */
  1079. function php_ini_loaded_file () {}
  1080. /**
  1081. * String comparisons using a "natural order" algorithm
  1082. * @link http://www.php.net/manual/en/function.strnatcmp.php
  1083. * @param str1 string <p>
  1084. * The first string.
  1085. * </p>
  1086. * @param str2 string <p>
  1087. * The second string.
  1088. * </p>
  1089. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  1090. * str1 is less than str2; &gt;
  1091. * 0 if str1 is greater than
  1092. * str2, and 0 if they are equal.
  1093. */
  1094. function strnatcmp ($str1, $str2) {}
  1095. /**
  1096. * Case insensitive string comparisons using a "natural order" algorithm
  1097. * @link http://www.php.net/manual/en/function.strnatcasecmp.php
  1098. * @param str1 string <p>
  1099. * The first string.
  1100. * </p>
  1101. * @param str2 string <p>
  1102. * The second string.
  1103. * </p>
  1104. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  1105. * str1 is less than str2 &gt;
  1106. * 0 if str1 is greater than
  1107. * str2, and 0 if they are equal.
  1108. */
  1109. function strnatcasecmp ($str1, $str2) {}
  1110. /**
  1111. * Count the number of substring occurrences
  1112. * @link http://www.php.net/manual/en/function.substr-count.php
  1113. * @param haystack string <p>
  1114. * The string to search in
  1115. * </p>
  1116. * @param needle string <p>
  1117. * The substring to search for
  1118. * </p>
  1119. * @param offset int[optional] <p>
  1120. * The offset where to start counting
  1121. * </p>
  1122. * @param length int[optional] <p>
  1123. * The maximum length after the specified offset to search for the
  1124. * substring. It outputs a warning if the offset plus the length is
  1125. * greater than the haystack length.
  1126. * </p>
  1127. * @return int This function returns an integer.
  1128. */
  1129. function substr_count ($haystack, $needle, $offset = null, $length = null) {}
  1130. /**
  1131. * Finds the length of the initial segment of a string consisting
  1132. entirely of characters contained within a given mask.
  1133. * @link http://www.php.net/manual/en/function.strspn.php
  1134. * @param subject string <p>
  1135. * The string to examine.
  1136. * </p>
  1137. * @param mask string <p>
  1138. * The list of allowable characters.
  1139. * </p>
  1140. * @param start int[optional] <p>
  1141. * The position in subject to
  1142. * start searching.
  1143. * </p>
  1144. * <p>
  1145. * If start is given and is non-negative,
  1146. * then strspn will begin
  1147. * examining subject at
  1148. * the start'th position. For instance, in
  1149. * the string 'abcdef', the character at
  1150. * position 0 is 'a', the
  1151. * character at position 2 is
  1152. * 'c', and so forth.
  1153. * </p>
  1154. * <p>
  1155. * If start is given and is negative,
  1156. * then strspn will begin
  1157. * examining subject at
  1158. * the start'th position from the end
  1159. * of subject.
  1160. * </p>
  1161. * @param length int[optional] <p>
  1162. * The length of the segment from subject
  1163. * to examine.
  1164. * </p>
  1165. * <p>
  1166. * If length is given and is non-negative,
  1167. * then subject will be examined
  1168. * for length characters after the starting
  1169. * position.
  1170. * </p>
  1171. * <p>
  1172. * If lengthis given and is negative,
  1173. * then subject will be examined from the
  1174. * starting position up to length
  1175. * characters from the end of subject.
  1176. * </p>
  1177. * @return int the length of the initial segment of subject
  1178. * which consists entirely of characters in mask.
  1179. */
  1180. function strspn ($subject, $mask, $start = null, $length = null) {}
  1181. /**
  1182. * Find length of initial segment not matching mask
  1183. * @link http://www.php.net/manual/en/function.strcspn.php
  1184. * @param str1 string <p>
  1185. * The first string.
  1186. * </p>
  1187. * @param str2 string <p>
  1188. * The second string.
  1189. * </p>
  1190. * @param start int[optional] <p>
  1191. * The start position of the string to examine.
  1192. * </p>
  1193. * @param length int[optional] <p>
  1194. * The length of the string to examine.
  1195. * </p>
  1196. * @return int the length of the segment as an integer.
  1197. */
  1198. function strcspn ($str1, $str2, $start = null, $length = null) {}
  1199. /**
  1200. * Tokenize string
  1201. * @link http://www.php.net/manual/en/function.strtok.php
  1202. * @param str string <p>
  1203. * The string being split up into smaller strings (tokens).
  1204. * </p>
  1205. * @param token string <p>
  1206. * The delimiter used when splitting up str.
  1207. * </p>
  1208. * @return string A string token.
  1209. */
  1210. function strtok ($str, $token) {}
  1211. /**
  1212. * Make a string uppercase
  1213. * @link http://www.php.net/manual/en/function.strtoupper.php
  1214. * @param string string <p>
  1215. * The input string.
  1216. * </p>
  1217. * @return string the uppercased string.
  1218. */
  1219. function strtoupper ($string) {}
  1220. /**
  1221. * Make a string lowercase
  1222. * @link http://www.php.net/manual/en/function.strtolower.php
  1223. * @param str string <p>
  1224. * The input string.
  1225. * </p>
  1226. * @return string the lowercased string.
  1227. */
  1228. function strtolower ($str) {}
  1229. /**
  1230. * Find the position of the first occurrence of a substring in a string
  1231. * @link http://www.php.net/manual/en/function.strpos.php
  1232. * @param haystack string <p>
  1233. * The string to search in.
  1234. * </p>
  1235. * @param needle mixed <p>
  1236. * If needle is not a string, it is converted
  1237. * to an integer and applied as the ordinal value of a character.
  1238. * </p>
  1239. * @param offset int[optional] <p>
  1240. * If specified, search will start this number of characters counted from
  1241. * the beginning of the string. Unlike strrpos and
  1242. * strripos, the offset cannot be negative.
  1243. * </p>
  1244. * @return int the position of where the needle exists relative to the beginning of
  1245. * the haystack string (independent of offset).
  1246. * Also note that string positions start at 0, and not 1.
  1247. * </p>
  1248. * <p>
  1249. * Returns false if the needle was not found.
  1250. */
  1251. function strpos ($haystack, $needle, $offset = null) {}
  1252. /**
  1253. * Find the position of the first occurrence of a case-insensitive substring in a string
  1254. * @link http://www.php.net/manual/en/function.stripos.php
  1255. * @param haystack string <p>
  1256. * The string to search in.
  1257. * </p>
  1258. * @param needle string <p>
  1259. * Note that the needle may be a string of one or
  1260. * more characters.
  1261. * </p>
  1262. * <p>
  1263. * If needle is not a string, it is converted to
  1264. * an integer and applied as the ordinal value of a character.
  1265. * </p>
  1266. * @param offset int[optional] <p>
  1267. * If specified, search will start this number of characters counted from
  1268. * the beginning of the string. Unlike strrpos and
  1269. * strripos, the offset cannot be negative.
  1270. * </p>
  1271. * @return int the position of where the needle exists relative to the beginnning of
  1272. * the haystack string (independent of offset).
  1273. * Also note that string positions start at 0, and not 1.
  1274. * </p>
  1275. * <p>
  1276. * Returns false if the needle was not found.
  1277. */
  1278. function stripos ($haystack, $needle, $offset = null) {}
  1279. /**
  1280. * Find the position of the last occurrence of a substring in a string
  1281. * @link http://www.php.net/manual/en/function.strrpos.php
  1282. * @param haystack string <p>
  1283. * The string to search in.
  1284. * </p>
  1285. * @param needle string <p>
  1286. * If needle is not a string, it is converted
  1287. * to an integer and applied as the ordinal value of a character.
  1288. * </p>
  1289. * @param offset int[optional] <p>
  1290. * If specified, search will start this number of characters counted from the
  1291. * beginning of the string. If the value is negative, search will instead start
  1292. * from that many characters from the end of the string, searching backwards.
  1293. * </p>
  1294. * @return int the position where the needle exists relative to the beginnning of
  1295. * the haystack string (independent of search direction
  1296. * or offset).
  1297. * Also note that string positions start at 0, and not 1.
  1298. * </p>
  1299. * <p>
  1300. * Returns false if the needle was not found.
  1301. */
  1302. function strrpos ($haystack, $needle, $offset = null) {}
  1303. /**
  1304. * Find the position of the last occurrence of a case-insensitive substring in a string
  1305. * @link http://www.php.net/manual/en/function.strripos.php
  1306. * @param haystack string <p>
  1307. * The string to search in.
  1308. * </p>
  1309. * @param needle string <p>
  1310. * If needle is not a string, it is converted
  1311. * to an integer and applied as the ordinal value of a character.
  1312. * </p>
  1313. * @param offset int[optional] <p>
  1314. * If specified, search will start this number of characters counted from the
  1315. * beginning of the string. If the value is negative, search will instead start
  1316. * from that many characters from the end of the string, searching backwards.
  1317. * </p>
  1318. * @return int the position where the needle exists relative to the beginnning of
  1319. * the haystack string (independent of search direction
  1320. * or offset).
  1321. * Also note that string positions start at 0, and not 1.
  1322. * </p>
  1323. * <p>
  1324. * Returns false if the needle was not found.
  1325. */
  1326. function strripos ($haystack, $needle, $offset = null) {}
  1327. /**
  1328. * Reverse a string
  1329. * @link http://www.php.net/manual/en/function.strrev.php
  1330. * @param string string <p>
  1331. * The string to be reversed.
  1332. * </p>
  1333. * @return string the reversed string.
  1334. */
  1335. function strrev ($string) {}
  1336. /**
  1337. * Convert logical Hebrew text to visual text
  1338. * @link http://www.php.net/manual/en/function.hebrev.php
  1339. * @param hebrew_text string <p>
  1340. * A Hebrew input string.
  1341. * </p>
  1342. * @param max_chars_per_line int[optional] <p>
  1343. * This optional parameter indicates maximum number of characters per
  1344. * line that will be returned.
  1345. * </p>
  1346. * @return string the visual string.
  1347. */
  1348. function hebrev ($hebrew_text, $max_chars_per_line = null) {}
  1349. /**
  1350. * Convert logical Hebrew text to visual text with newline conversion
  1351. * @link http://www.php.net/manual/en/function.hebrevc.php
  1352. * @param hebrew_text string <p>
  1353. * A Hebrew input string.
  1354. * </p>
  1355. * @param max_chars_per_line int[optional] <p>
  1356. * This optional parameter indicates maximum number of characters per
  1357. * line that will be returned.
  1358. * </p>
  1359. * @return string the visual string.
  1360. */
  1361. function hebrevc ($hebrew_text, $max_chars_per_line = null) {}
  1362. /**
  1363. * Inserts HTML line breaks before all newlines in a string
  1364. * @link http://www.php.net/manual/en/function.nl2br.php
  1365. * @param string string <p>
  1366. * The input string.
  1367. * </p>
  1368. * @param is_xhtml bool[optional] <p>
  1369. * Whenever to use XHTML compatible line breaks or not.
  1370. * </p>
  1371. * @return string the altered string.
  1372. */
  1373. function nl2br ($string, $is_xhtml = null) {}
  1374. /**
  1375. * Returns trailing name component of path
  1376. * @link http://www.php.net/manual/en/function.basename.php
  1377. * @param path string <p>
  1378. * A path.
  1379. * </p>
  1380. * <p>
  1381. * On Windows, both slash (/) and backslash
  1382. * (\) are used as directory separator character. In
  1383. * other environments, it is the forward slash (/).
  1384. * </p>
  1385. * @param suffix string[optional] <p>
  1386. * If the name component ends in suffix this will also
  1387. * be cut off.
  1388. * </p>
  1389. * @return string the base name of the given path.
  1390. */
  1391. function basename ($path, $suffix = null) {}
  1392. /**
  1393. * Returns parent directory's path
  1394. * @link http://www.php.net/manual/en/function.dirname.php
  1395. * @param path string <p>
  1396. * A path.
  1397. * </p>
  1398. * <p>
  1399. * On Windows, both slash (/) and backslash
  1400. * (\) are used as directory separator character. In
  1401. * other environments, it is the forward slash (/).
  1402. * </p>
  1403. * @return string the path of the parent directory. If there are no slashes in
  1404. * path, a dot ('.') is returned,
  1405. * indicating the current directory. Otherwise, the returned string is
  1406. * path with any trailing
  1407. * /component removed.
  1408. */
  1409. function dirname ($path) {}
  1410. /**
  1411. * Returns information about a file path
  1412. * @link http://www.php.net/manual/en/function.pathinfo.php
  1413. * @param path string <p>
  1414. * The path to be parsed.
  1415. * </p>
  1416. * @param options int[optional] <p>
  1417. * If present, specifies a specific element to be returned; one of
  1418. * PATHINFO_DIRNAME,
  1419. * PATHINFO_BASENAME,
  1420. * PATHINFO_EXTENSION or
  1421. * PATHINFO_FILENAME.
  1422. * </p>
  1423. * <p>If options is not specified, returns all
  1424. * available elements.
  1425. * </p>
  1426. * @return mixed If the options parameter is not passed, an
  1427. * associative array containing the following elements is
  1428. * returned:
  1429. * dirname, basename,
  1430. * extension (if any), and filename.
  1431. * </p>
  1432. * <p>
  1433. * If the path does not have an extension, no
  1434. * extension element will be returned
  1435. * (see second example below).
  1436. * </p>
  1437. * <p>
  1438. * If options is present, returns a
  1439. * string containing the requested element.
  1440. */
  1441. function pathinfo ($path, $options = null) {}
  1442. /**
  1443. * Un-quotes a quoted string
  1444. * @link http://www.php.net/manual/en/function.stripslashes.php
  1445. * @param str string <p>
  1446. * The input string.
  1447. * </p>
  1448. * @return string a string with backslashes stripped off.
  1449. * (\' becomes ' and so on.)
  1450. * Double backslashes (\\) are made into a single
  1451. * backslash (\).
  1452. */
  1453. function stripslashes ($str) {}
  1454. /**
  1455. * Un-quote string quoted with <function>addcslashes</function>
  1456. * @link http://www.php.net/manual/en/function.stripcslashes.php
  1457. * @param str string <p>
  1458. * The string to be unescaped.
  1459. * </p>
  1460. * @return string the unescaped string.
  1461. */
  1462. function stripcslashes ($str) {}
  1463. /**
  1464. * Find the first occurrence of a string
  1465. * @link http://www.php.net/manual/en/function.strstr.php
  1466. * @param haystack string <p>
  1467. * The input string.
  1468. * </p>
  1469. * @param needle mixed <p>
  1470. * If needle is not a string, it is converted to
  1471. * an integer and applied as the ordinal value of a character.
  1472. * </p>
  1473. * @param before_needle bool[optional] <p>
  1474. * If true, strstr returns
  1475. * the part of the haystack before the first
  1476. * occurrence of the needle.
  1477. * </p>
  1478. * @return string the portion of string, or false if needle
  1479. * is not found.
  1480. */
  1481. function strstr ($haystack, $needle, $before_needle = null) {}
  1482. /**
  1483. * Case-insensitive <function>strstr</function>
  1484. * @link http://www.php.net/manual/en/function.stristr.php
  1485. * @param haystack string <p>
  1486. * The string to search in
  1487. * </p>
  1488. * @param needle mixed <p>
  1489. * If needle is not a string, it is converted to
  1490. * an integer and applied as the ordinal value of a character.
  1491. * </p>
  1492. * @param before_needle bool[optional] <p>
  1493. * If true, stristr
  1494. * returns the part of the haystack before the
  1495. * first occurrence of the needle.
  1496. * </p>
  1497. * @return string the matched substring. If needle is not
  1498. * found, returns false.
  1499. */
  1500. function stristr ($haystack, $needle, $before_needle = null) {}
  1501. /**
  1502. * Find the last occurrence of a character in a string
  1503. * @link http://www.php.net/manual/en/function.strrchr.php
  1504. * @param haystack string <p>
  1505. * The string to search in
  1506. * </p>
  1507. * @param needle mixed <p>
  1508. * If needle contains more than one character,
  1509. * only the first is used. This behavior is different from that of
  1510. * strstr.
  1511. * </p>
  1512. * <p>
  1513. * If needle is not a string, it is converted to
  1514. * an integer and applied as the ordinal value of a character.
  1515. * </p>
  1516. * @return string This function returns the portion of string, or false if
  1517. * needle is not found.
  1518. */
  1519. function strrchr ($haystack, $needle) {}
  1520. /**
  1521. * Randomly shuffles a string
  1522. * @link http://www.php.net/manual/en/function.str-shuffle.php
  1523. * @param str string <p>
  1524. * The input string.
  1525. * </p>
  1526. * @return string the shuffled string.
  1527. */
  1528. function str_shuffle ($str) {}
  1529. /**
  1530. * Return information about words used in a string
  1531. * @link http://www.php.net/manual/en/function.str-word-count.php
  1532. * @param string string <p>
  1533. * The string
  1534. * </p>
  1535. * @param format int[optional] <p>
  1536. * Specify the return value of this function. The current supported values
  1537. * are:
  1538. * 0 - returns the number of words found
  1539. * @param charlist string[optional] <p>
  1540. * A list of additional characters which will be considered as 'word'
  1541. * </p>
  1542. * @return mixed an array or an integer, depending on the
  1543. * format chosen.
  1544. */
  1545. function str_word_count ($string, $format = null, $charlist = null) {}
  1546. /**
  1547. * Convert a string to an array
  1548. * @link http://www.php.net/manual/en/function.str-split.php
  1549. * @param string string <p>
  1550. * The input string.
  1551. * </p>
  1552. * @param split_length int[optional] <p>
  1553. * Maximum length of the chunk.
  1554. * </p>
  1555. * @return array If the optional split_length parameter is
  1556. * specified, the returned array will be broken down into chunks with each
  1557. * being split_length in length, otherwise each chunk
  1558. * will be one character in length.
  1559. * </p>
  1560. * <p>
  1561. * false is returned if split_length is less than 1.
  1562. * If the split_length length exceeds the length of
  1563. * string, the entire string is returned as the first
  1564. * (and only) array element.
  1565. */
  1566. function str_split ($string, $split_length = null) {}
  1567. /**
  1568. * Search a string for any of a set of characters
  1569. * @link http://www.php.net/manual/en/function.strpbrk.php
  1570. * @param haystack string <p>
  1571. * The string where char_list is looked for.
  1572. * </p>
  1573. * @param char_list string <p>
  1574. * This parameter is case sensitive.
  1575. * </p>
  1576. * @return string a string starting from the character found, or false if it is
  1577. * not found.
  1578. */
  1579. function strpbrk ($haystack, $char_list) {}
  1580. /**
  1581. * Binary safe comparison of two strings from an offset, up to length characters
  1582. * @link http://www.php.net/manual/en/function.substr-compare.php
  1583. * @param main_str string <p>
  1584. * The main string being compared.
  1585. * </p>
  1586. * @param str string <p>
  1587. * The secondary string being compared.
  1588. * </p>
  1589. * @param offset int <p>
  1590. * The start position for the comparison. If negative, it starts counting
  1591. * from the end of the string.
  1592. * </p>
  1593. * @param length int[optional] <p>
  1594. * The length of the comparison. The default value is the largest of the
  1595. * length of the str compared to the length of
  1596. * main_str less the
  1597. * offset.
  1598. * </p>
  1599. * @param case_insensitivity bool[optional] <p>
  1600. * If case_insensitivity is true, comparison is
  1601. * case insensitive.
  1602. * </p>
  1603. * @return int &lt; 0 if main_str from position
  1604. * offset is less than str, &gt;
  1605. * 0 if it is greater than str, and 0 if they are equal.
  1606. * If offset is equal to or greater than the length of
  1607. * main_str or length is set and
  1608. * is less than 1, substr_compare prints a warning and returns
  1609. * false.
  1610. */
  1611. function substr_compare ($main_str, $str, $offset, $length = null, $case_insensitivity = null) {}
  1612. /**
  1613. * Locale based string comparison
  1614. * @link http://www.php.net/manual/en/function.strcoll.php
  1615. * @param str1 string <p>
  1616. * The first string.
  1617. * </p>
  1618. * @param str2 string <p>
  1619. * The second string.
  1620. * </p>
  1621. * @return int &lt; 0 if str1 is less than
  1622. * str2; &gt; 0 if
  1623. * str1 is greater than
  1624. * str2, and 0 if they are equal.
  1625. */
  1626. function strcoll ($str1, $str2) {}
  1627. /**
  1628. * Formats a number as a currency string
  1629. * @link http://www.php.net/manual/en/function.money-format.php
  1630. * @param format string <p>
  1631. * The format specification consists of the following sequence:
  1632. * <p>a % character</p>
  1633. * @param number float <p>
  1634. * The number to be formatted.
  1635. * </p>
  1636. * @return string the formatted string. Characters before and after the formatting
  1637. * string will be returned unchanged.
  1638. * Non-numeric number causes returning &null; and
  1639. * emitting E_WARNING.
  1640. */
  1641. function money_format ($format, $number) {}
  1642. /**
  1643. * Return part of a string
  1644. * @link http://www.php.net/manual/en/function.substr.php
  1645. * @param string string <p>
  1646. * The input string. Must be one character or longer.
  1647. * </p>
  1648. * @param start int <p>
  1649. * If start is non-negative, the returned string
  1650. * will start at the start'th position in
  1651. * string, counting from zero. For instance,
  1652. * in the string 'abcdef', the character at
  1653. * position 0 is 'a', the
  1654. * character at position 2 is
  1655. * 'c', and so forth.
  1656. * </p>
  1657. * <p>
  1658. * If start is negative, the returned string
  1659. * will start at the start'th character
  1660. * from the end of string.
  1661. * </p>
  1662. * <p>
  1663. * If string is less than or equal to
  1664. * start characters long, false will be returned.
  1665. * </p>
  1666. * <p>
  1667. * Using a negative start
  1668. * ]]>
  1669. * </p>
  1670. * @param length int[optional] <p>
  1671. * If length is given and is positive, the string
  1672. * returned will contain at most length characters
  1673. * beginning from start (depending on the length of
  1674. * string).
  1675. * </p>
  1676. * <p>
  1677. * If length is given and is negative, then that many
  1678. * characters will be omitted from the end of string
  1679. * (after the start position has been calculated when a
  1680. * start is negative). If
  1681. * start denotes the position of this truncation or
  1682. * beyond, false will be returned.
  1683. * </p>
  1684. * <p>
  1685. * If length is given and is 0,
  1686. * false or &null; an empty string will be returned.
  1687. * </p>
  1688. * <p>
  1689. * If length is omitted, the substring starting from
  1690. * start until the end of the string will be
  1691. * returned.
  1692. * </p>
  1693. * Using a negative length
  1694. * ]]>
  1695. * @return string the extracted part of string, &return.falseforfailure; or an empty string.
  1696. */
  1697. function substr ($string, $start, $length = null) {}
  1698. /**
  1699. * Replace text within a portion of a string
  1700. * @link http://www.php.net/manual/en/function.substr-replace.php
  1701. * @param string mixed <p>
  1702. * The input string.
  1703. * </p>
  1704. * <p>
  1705. * An array of strings can be provided, in which
  1706. * case the replacements will occur on each string in turn. In this case,
  1707. * the replacement, start
  1708. * and length parameters may be provided either as
  1709. * scalar values to be applied to each input string in turn, or as
  1710. * arrays, in which case the corresponding array element will
  1711. * be used for each input string.
  1712. * </p>
  1713. * @param replacement mixed <p>
  1714. * The replacement string.
  1715. * </p>
  1716. * @param start mixed <p>
  1717. * If start is positive, the replacing will
  1718. * begin at the start'th offset into
  1719. * string.
  1720. * </p>
  1721. * <p>
  1722. * If start is negative, the replacing will
  1723. * begin at the start'th character from the
  1724. * end of string.
  1725. * </p>
  1726. * @param length mixed[optional] <p>
  1727. * If given and is positive, it represents the length of the portion of
  1728. * string which is to be replaced. If it is
  1729. * negative, it represents the number of characters from the end of
  1730. * string at which to stop replacing. If it
  1731. * is not given, then it will default to strlen(
  1732. * string ); i.e. end the replacing at the
  1733. * end of string. Of course, if
  1734. * length is zero then this function will have the
  1735. * effect of inserting replacement into
  1736. * string at the given
  1737. * start offset.
  1738. * </p>
  1739. * @return mixed The result string is returned. If string is an
  1740. * array then array is returned.
  1741. */
  1742. function substr_replace ($string, $replacement, $start, $length = null) {}
  1743. /**
  1744. * Quote meta characters
  1745. * @link http://www.php.net/manual/en/function.quotemeta.php
  1746. * @param str string <p>
  1747. * The input string.
  1748. * </p>
  1749. * @return string the string with meta characters quoted, or false if an empty
  1750. * string is given as str.
  1751. */
  1752. function quotemeta ($str) {}
  1753. /**
  1754. * Make a string's first character uppercase
  1755. * @link http://www.php.net/manual/en/function.ucfirst.php
  1756. * @param str string <p>
  1757. * The input string.
  1758. * </p>
  1759. * @return string the resulting string.
  1760. */
  1761. function ucfirst ($str) {}
  1762. /**
  1763. * Make a string's first character lowercase
  1764. * @link http://www.php.net/manual/en/function.lcfirst.php
  1765. * @param str string <p>
  1766. * The input string.
  1767. * </p>
  1768. * @return string the resulting string.
  1769. */
  1770. function lcfirst ($str) {}
  1771. /**
  1772. * Uppercase the first character of each word in a string
  1773. * @link http://www.php.net/manual/en/function.ucwords.php
  1774. * @param str string <p>
  1775. * The input string.
  1776. * </p>
  1777. * @return string the modified string.
  1778. */
  1779. function ucwords ($str) {}
  1780. /**
  1781. * Translate characters or replace substrings
  1782. * @link http://www.php.net/manual/en/function.strtr.php
  1783. * @param str string <p>
  1784. * The string being translated.
  1785. * </p>
  1786. * @param from string <p>
  1787. * The string being translated to to.
  1788. * </p>
  1789. * @param to string <p>
  1790. * The string replacing from.
  1791. * </p>
  1792. * @return string the translated string.
  1793. * </p>
  1794. * <p>
  1795. * If replace_pairs contains a key which
  1796. * is an empty string (""),
  1797. * false will be returned.
  1798. */
  1799. function strtr ($str, $from, $to) {}
  1800. /**
  1801. * Quote string with slashes
  1802. * @link http://www.php.net/manual/en/function.addslashes.php
  1803. * @param str string <p>
  1804. * The string to be escaped.
  1805. * </p>
  1806. * @return string the escaped string.
  1807. */
  1808. function addslashes ($str) {}
  1809. /**
  1810. * Quote string with slashes in a C style
  1811. * @link http://www.php.net/manual/en/function.addcslashes.php
  1812. * @param str string <p>
  1813. * The string to be escaped.
  1814. * </p>
  1815. * @param charlist string <p>
  1816. * A list of characters to be escaped. If
  1817. * charlist contains characters
  1818. * \n, \r etc., they are
  1819. * converted in C-like style, while other non-alphanumeric characters
  1820. * with ASCII codes lower than 32 and higher than 126 converted to
  1821. * octal representation.
  1822. * </p>
  1823. * <p>
  1824. * When you define a sequence of characters in the charlist argument
  1825. * make sure that you know what characters come between the
  1826. * characters that you set as the start and end of the range.
  1827. * ]]>
  1828. * Also, if the first character in a range has a higher ASCII value
  1829. * than the second character in the range, no range will be
  1830. * constructed. Only the start, end and period characters will be
  1831. * escaped. Use the ord function to find the
  1832. * ASCII value for a character.
  1833. * ]]>
  1834. * </p>
  1835. * <p>
  1836. * Be careful if you choose to escape characters 0, a, b, f, n, r,
  1837. * t and v. They will be converted to \0, \a, \b, \f, \n, \r, \t
  1838. * and \v.
  1839. * In PHP \0 (NULL), \r (carriage return), \n (newline), \f (form feed),
  1840. * \v (vertical tab) and \t (tab) are predefined escape sequences,
  1841. * while in C all of these are predefined escape sequences.
  1842. * </p>
  1843. * @return string the escaped string.
  1844. */
  1845. function addcslashes ($str, $charlist) {}
  1846. /**
  1847. * Strip whitespace (or other characters) from the end of a string
  1848. * @link http://www.php.net/manual/en/function.rtrim.php
  1849. * @param str string <p>
  1850. * The input string.
  1851. * </p>
  1852. * @param charlist string[optional] <p>
  1853. * You can also specify the characters you want to strip, by means
  1854. * of the charlist parameter.
  1855. * Simply list all characters that you want to be stripped. With
  1856. * .. you can specify a range of characters.
  1857. * </p>
  1858. * @return string the modified string.
  1859. */
  1860. function rtrim ($str, $charlist = null) {}
  1861. /**
  1862. * Replace all occurrences of the search string with the replacement string
  1863. * @link http://www.php.net/manual/en/function.str-replace.php
  1864. * @param search mixed <p>
  1865. * The value being searched for, otherwise known as the needle.
  1866. * An array may be used to designate multiple needles.
  1867. * </p>
  1868. * @param replace mixed <p>
  1869. * The replacement value that replaces found search
  1870. * values. An array may be used to designate multiple replacements.
  1871. * </p>
  1872. * @param subject mixed <p>
  1873. * The string or array being searched and replaced on,
  1874. * otherwise known as the haystack.
  1875. * </p>
  1876. * <p>
  1877. * If subject is an array, then the search and
  1878. * replace is performed with every entry of
  1879. * subject, and the return value is an array as
  1880. * well.
  1881. * </p>
  1882. * @param count int[optional] <p>
  1883. * If passed, this will be set to the number of replacements performed.
  1884. * </p>
  1885. * @return mixed This function returns a string or an array with the replaced values.
  1886. */
  1887. function str_replace ($search, $replace, $subject, &$count = null) {}
  1888. /**
  1889. * Case-insensitive version of <function>str_replace</function>.
  1890. * @link http://www.php.net/manual/en/function.str-ireplace.php
  1891. * @param search mixed <p>
  1892. * The value being searched for, otherwise known as the
  1893. * needle. An array may be used to designate
  1894. * multiple needles.
  1895. * </p>
  1896. * @param replace mixed <p>
  1897. * The replacement value that replaces found search
  1898. * values. An array may be used to designate multiple replacements.
  1899. * </p>
  1900. * @param subject mixed <p>
  1901. * The string or array being searched and replaced on,
  1902. * otherwise known as the haystack.
  1903. * </p>
  1904. * <p>
  1905. * If subject is an array, then the search and
  1906. * replace is performed with every entry of
  1907. * subject, and the return value is an array as
  1908. * well.
  1909. * </p>
  1910. * @param count int[optional] <p>
  1911. * If passed, this will be set to the number of replacements performed.
  1912. * </p>
  1913. * @return mixed a string or an array of replacements.
  1914. */
  1915. function str_ireplace ($search, $replace, $subject, &$count = null) {}
  1916. /**
  1917. * Repeat a string
  1918. * @link http://www.php.net/manual/en/function.str-repeat.php
  1919. * @param input string <p>
  1920. * The string to be repeated.
  1921. * </p>
  1922. * @param multiplier int <p>
  1923. * Number of time the input string should be
  1924. * repeated.
  1925. * </p>
  1926. * <p>
  1927. * multiplier has to be greater than or equal to 0.
  1928. * If the multiplier is set to 0, the function
  1929. * will return an empty string.
  1930. * </p>
  1931. * @return string the repeated string.
  1932. */
  1933. function str_repeat ($input, $multiplier) {}
  1934. /**
  1935. * Return information about characters used in a string
  1936. * @link http://www.php.net/manual/en/function.count-chars.php
  1937. * @param string string <p>
  1938. * The examined string.
  1939. * </p>
  1940. * @param mode int[optional] <p>
  1941. * See return values.
  1942. * </p>
  1943. * @return mixed Depending on mode
  1944. * count_chars returns one of the following:
  1945. * 0 - an array with the byte-value as key and the frequency of
  1946. * every byte as value.
  1947. * 1 - same as 0 but only byte-values with a frequency greater
  1948. * than zero are listed.
  1949. * 2 - same as 0 but only byte-values with a frequency equal to
  1950. * zero are listed.
  1951. * 3 - a string containing all unique characters is returned.
  1952. * 4 - a string containing all not used characters is returned.
  1953. */
  1954. function count_chars ($string, $mode = null) {}
  1955. /**
  1956. * Split a string into smaller chunks
  1957. * @link http://www.php.net/manual/en/function.chunk-split.php
  1958. * @param body string <p>
  1959. * The string to be chunked.
  1960. * </p>
  1961. * @param chunklen int[optional] <p>
  1962. * The chunk length.
  1963. * </p>
  1964. * @param end string[optional] <p>
  1965. * The line ending sequence.
  1966. * </p>
  1967. * @return string the chunked string.
  1968. */
  1969. function chunk_split ($body, $chunklen = null, $end = null) {}
  1970. /**
  1971. * Strip whitespace (or other characters) from the beginning and end of a string
  1972. * @link http://www.php.net/manual/en/function.trim.php
  1973. * @param str string <p>
  1974. * The string that will be trimmed.
  1975. * </p>
  1976. * @param charlist string[optional] <p>
  1977. * Optionally, the stripped characters can also be specified using
  1978. * the charlist parameter.
  1979. * Simply list all characters that you want to be stripped. With
  1980. * .. you can specify a range of characters.
  1981. * </p>
  1982. * @return string The trimmed string.
  1983. */
  1984. function trim ($str, $charlist = null) {}
  1985. /**
  1986. * Strip whitespace (or other characters) from the beginning of a string
  1987. * @link http://www.php.net/manual/en/function.ltrim.php
  1988. * @param str string <p>
  1989. * The input string.
  1990. * </p>
  1991. * @param charlist string[optional] <p>
  1992. * You can also specify the characters you want to strip, by means of the
  1993. * charlist parameter.
  1994. * Simply list all characters that you want to be stripped. With
  1995. * .. you can specify a range of characters.
  1996. * </p>
  1997. * @return string This function returns a string with whitespace stripped from the
  1998. * beginning of str.
  1999. * Without the second parameter,
  2000. * ltrim will strip these characters:
  2001. * " " (ASCII 32
  2002. * (0x20)), an ordinary space.
  2003. * "\t" (ASCII 9
  2004. * (0x09)), a tab.
  2005. * "\n" (ASCII 10
  2006. * (0x0A)), a new line (line feed).
  2007. * "\r" (ASCII 13
  2008. * (0x0D)), a carriage return.
  2009. * "\0" (ASCII 0
  2010. * (0x00)), the NUL-byte.
  2011. * "\x0B" (ASCII 11
  2012. * (0x0B)), a vertical tab.
  2013. */
  2014. function ltrim ($str, $charlist = null) {}
  2015. /**
  2016. * Strip HTML and PHP tags from a string
  2017. * @link http://www.php.net/manual/en/function.strip-tags.php
  2018. * @param str string <p>
  2019. * The input string.
  2020. * </p>
  2021. * @param allowable_tags string[optional] <p>
  2022. * You can use the optional second parameter to specify tags which should
  2023. * not be stripped.
  2024. * </p>
  2025. * <p>
  2026. * HTML comments and PHP tags are also stripped. This is hardcoded and
  2027. * can not be changed with allowable_tags.
  2028. * </p>
  2029. * <p>
  2030. * This parameter should not contain whitespace.
  2031. * strip_tags sees a tag as a case-insensitive
  2032. * string between &lt; and the first whitespace or
  2033. * &gt;. It means that
  2034. * strip_tags("&lt;br/&gt;", "&lt;br&gt;") returns an
  2035. * empty string.
  2036. * </p>
  2037. * @return string the stripped string.
  2038. */
  2039. function strip_tags ($str, $allowable_tags = null) {}
  2040. /**
  2041. * Calculate the similarity between two strings
  2042. * @link http://www.php.net/manual/en/function.similar-text.php
  2043. * @param first string <p>
  2044. * The first string.
  2045. * </p>
  2046. * @param second string <p>
  2047. * The second string.
  2048. * </p>
  2049. * @param percent float[optional] <p>
  2050. * By passing a reference as third argument,
  2051. * similar_text will calculate the similarity in
  2052. * percent for you.
  2053. * </p>
  2054. * @return int the number of matching chars in both strings.
  2055. */
  2056. function similar_text ($first, $second, &$percent = null) {}
  2057. /**
  2058. * Split a string by string
  2059. * @link http://www.php.net/manual/en/function.explode.php
  2060. * @param delimiter string <p>
  2061. * The boundary string.
  2062. * </p>
  2063. * @param string string <p>
  2064. * The input string.
  2065. * </p>
  2066. * @param limit int[optional] <p>
  2067. * If limit is set and positive, the returned array will contain
  2068. * a maximum of limit elements with the last
  2069. * element containing the rest of string.
  2070. * </p>
  2071. * <p>
  2072. * If the limit parameter is negative, all components
  2073. * except the last -limit are returned.
  2074. * </p>
  2075. * <p>
  2076. * If the limit parameter is zero, then this is treated as 1.
  2077. * </p>
  2078. * @return array an array of strings
  2079. * created by splitting the string parameter on
  2080. * boundaries formed by the delimiter.
  2081. * </p>
  2082. * <p>
  2083. * If delimiter is an empty string (""),
  2084. * explode will return false.
  2085. * If delimiter contains a value that is not
  2086. * contained in string and a negative
  2087. * limit is used, then an empty array will be
  2088. * returned, otherwise an array containing
  2089. * string will be returned.
  2090. */
  2091. function explode ($delimiter, $string, $limit = null) {}
  2092. /**
  2093. * Join array elements with a string
  2094. * @link http://www.php.net/manual/en/function.implode.php
  2095. * @param glue string <p>
  2096. * Defaults to an empty string. This is not the preferred usage of
  2097. * implode as glue would be
  2098. * the second parameter and thus, the bad prototype would be used.
  2099. * </p>
  2100. * @param pieces array <p>
  2101. * The array of strings to implode.
  2102. * </p>
  2103. * @return string a string containing a string representation of all the array
  2104. * elements in the same order, with the glue string between each element.
  2105. */
  2106. function implode ($glue, array $pieces) {}
  2107. /**
  2108. * &Alias; <function>implode</function>
  2109. * @link http://www.php.net/manual/en/function.join.php
  2110. * @param glue
  2111. * @param pieces
  2112. */
  2113. function join ($glue, $pieces) {}
  2114. /**
  2115. * Set locale information
  2116. * @link http://www.php.net/manual/en/function.setlocale.php
  2117. * @param category int <p>
  2118. * category is a named constant specifying the
  2119. * category of the functions affected by the locale setting:
  2120. * LC_ALL for all of the below
  2121. * @param locale string <p>
  2122. * If locale is &null; or the empty string
  2123. * "", the locale names will be set from the
  2124. * values of environment variables with the same names as the above
  2125. * categories, or from "LANG".
  2126. * </p>
  2127. * <p>
  2128. * If locale is "0",
  2129. * the locale setting is not affected, only the current setting is returned.
  2130. * </p>
  2131. * <p>
  2132. * If locale is an array or followed by additional
  2133. * parameters then each array element or parameter is tried to be set as
  2134. * new locale until success. This is useful if a locale is known under
  2135. * different names on different systems or for providing a fallback
  2136. * for a possibly not available locale.
  2137. * </p>
  2138. * @param _ string[optional]
  2139. * @return string the new current locale, or false if the locale functionality is
  2140. * not implemented on your platform, the specified locale does not exist or
  2141. * the category name is invalid.
  2142. * </p>
  2143. * <p>
  2144. * An invalid category name also causes a warning message. Category/locale
  2145. * names can be found in RFC 1766
  2146. * and ISO 639.
  2147. * Different systems have different naming schemes for locales.
  2148. * </p>
  2149. * <p>
  2150. * The return value of setlocale depends
  2151. * on the system that PHP is running. It returns exactly
  2152. * what the system setlocale function returns.
  2153. */
  2154. function setlocale ($category, $locale, $_ = null) {}
  2155. /**
  2156. * Get numeric formatting information
  2157. * @link http://www.php.net/manual/en/function.localeconv.php
  2158. * @return array localeconv returns data based upon the current locale
  2159. * as set by setlocale. The associative array that is
  2160. * returned contains the following fields:
  2161. * <tr valign="top">
  2162. * <td>Array element</td>
  2163. * <td>Description</td>
  2164. * </tr>
  2165. * <tr valign="top">
  2166. * <td>decimal_point</td>
  2167. * <td>Decimal point character</td>
  2168. * </tr>
  2169. * <tr valign="top">
  2170. * <td>thousands_sep</td>
  2171. * <td>Thousands separator</td>
  2172. * </tr>
  2173. * <tr valign="top">
  2174. * <td>grouping</td>
  2175. * <td>Array containing numeric groupings</td>
  2176. * </tr>
  2177. * <tr valign="top">
  2178. * <td>int_curr_symbol</td>
  2179. * <td>International currency symbol (i.e. USD)</td>
  2180. * </tr>
  2181. * <tr valign="top">
  2182. * <td>currency_symbol</td>
  2183. * <td>Local currency symbol (i.e. $)</td>
  2184. * </tr>
  2185. * <tr valign="top">
  2186. * <td>mon_decimal_point</td>
  2187. * <td>Monetary decimal point character</td>
  2188. * </tr>
  2189. * <tr valign="top">
  2190. * <td>mon_thousands_sep</td>
  2191. * <td>Monetary thousands separator</td>
  2192. * </tr>
  2193. * <tr valign="top">
  2194. * <td>mon_grouping</td>
  2195. * <td>Array containing monetary groupings</td>
  2196. * </tr>
  2197. * <tr valign="top">
  2198. * <td>positive_sign</td>
  2199. * <td>Sign for positive values</td>
  2200. * </tr>
  2201. * <tr valign="top">
  2202. * <td>negative_sign</td>
  2203. * <td>Sign for negative values</td>
  2204. * </tr>
  2205. * <tr valign="top">
  2206. * <td>int_frac_digits</td>
  2207. * <td>International fractional digits</td>
  2208. * </tr>
  2209. * <tr valign="top">
  2210. * <td>frac_digits</td>
  2211. * <td>Local fractional digits</td>
  2212. * </tr>
  2213. * <tr valign="top">
  2214. * <td>p_cs_precedes</td>
  2215. * <td>
  2216. * true if currency_symbol precedes a positive value, false
  2217. * if it succeeds one
  2218. * </td>
  2219. * </tr>
  2220. * <tr valign="top">
  2221. * <td>p_sep_by_space</td>
  2222. * <td>
  2223. * true if a space separates currency_symbol from a positive
  2224. * value, false otherwise
  2225. * </td>
  2226. * </tr>
  2227. * <tr valign="top">
  2228. * <td>n_cs_precedes</td>
  2229. * <td>
  2230. * true if currency_symbol precedes a negative value, false
  2231. * if it succeeds one
  2232. * </td>
  2233. * </tr>
  2234. * <tr valign="top">
  2235. * <td>n_sep_by_space</td>
  2236. * <td>
  2237. * true if a space separates currency_symbol from a negative
  2238. * value, false otherwise
  2239. * </td>
  2240. * </tr>
  2241. * <td>p_sign_posn</td>
  2242. * <td>
  2243. * 0 - Parentheses surround the quantity and currency_symbol
  2244. * 1 - The sign string precedes the quantity and currency_symbol
  2245. * 2 - The sign string succeeds the quantity and currency_symbol
  2246. * 3 - The sign string immediately precedes the currency_symbol
  2247. * 4 - The sign string immediately succeeds the currency_symbol
  2248. * </td>
  2249. * </tr>
  2250. * <td>n_sign_posn</td>
  2251. * <td>
  2252. * 0 - Parentheses surround the quantity and currency_symbol
  2253. * 1 - The sign string precedes the quantity and currency_symbol
  2254. * 2 - The sign string succeeds the quantity and currency_symbol
  2255. * 3 - The sign string immediately precedes the currency_symbol
  2256. * 4 - The sign string immediately succeeds the currency_symbol
  2257. * </td>
  2258. * </tr>
  2259. * </p>
  2260. * <p>
  2261. * The p_sign_posn, and n_sign_posn contain a string
  2262. * of formatting options. Each number representing one of the above listed conditions.
  2263. * </p>
  2264. * <p>
  2265. * The grouping fields contain arrays that define the way numbers should be
  2266. * grouped. For example, the monetary grouping field for the nl_NL locale (in
  2267. * UTF-8 mode with the euro sign), would contain a 2 item array with the
  2268. * values 3 and 3. The higher the index in the array, the farther left the
  2269. * grouping is. If an array element is equal to CHAR_MAX,
  2270. * no further grouping is done. If an array element is equal to 0, the previous
  2271. * element should be used.
  2272. */
  2273. function localeconv () {}
  2274. /**
  2275. * Query language and locale information
  2276. * @link http://www.php.net/manual/en/function.nl-langinfo.php
  2277. * @param item int <p>
  2278. * item may be an integer value of the element or the
  2279. * constant name of the element. The following is a list of constant names
  2280. * for item that may be used and their description.
  2281. * Some of these constants may not be defined or hold no value for certain
  2282. * locales.
  2283. * <table>
  2284. * nl_langinfo Constants
  2285. * <tr valign="top">
  2286. * <td>Constant</td>
  2287. * <td>Description</td>
  2288. * </tr>
  2289. * <tr valign="top">
  2290. * LC_TIME Category Constants</td>
  2291. * </tr>
  2292. * <tr valign="top">
  2293. * <td>ABDAY_(1-7)</td>
  2294. * <td>Abbreviated name of n-th day of the week.</td>
  2295. * </tr>
  2296. * <tr valign="top">
  2297. * <td>DAY_(1-7)</td>
  2298. * <td>Name of the n-th day of the week (DAY_1 = Sunday).</td>
  2299. * </tr>
  2300. * <tr valign="top">
  2301. * <td>ABMON_(1-12)</td>
  2302. * <td>Abbreviated name of the n-th month of the year.</td>
  2303. * </tr>
  2304. * <tr valign="top">
  2305. * <td>MON_(1-12)</td>
  2306. * <td>Name of the n-th month of the year.</td>
  2307. * </tr>
  2308. * <tr valign="top">
  2309. * <td>AM_STR</td>
  2310. * <td>String for Ante meridian.</td>
  2311. * </tr>
  2312. * <tr valign="top">
  2313. * <td>PM_STR</td>
  2314. * <td>String for Post meridian.</td>
  2315. * </tr>
  2316. * <tr valign="top">
  2317. * <td>D_T_FMT</td>
  2318. * <td>String that can be used as the format string for strftime to represent time and date.</td>
  2319. * </tr>
  2320. * <tr valign="top">
  2321. * <td>D_FMT</td>
  2322. * <td>String that can be used as the format string for strftime to represent date.</td>
  2323. * </tr>
  2324. * <tr valign="top">
  2325. * <td>T_FMT</td>
  2326. * <td>String that can be used as the format string for strftime to represent time.</td>
  2327. * </tr>
  2328. * <tr valign="top">
  2329. * <td>T_FMT_AMPM</td>
  2330. * <td>String that can be used as the format string for strftime to represent time in 12-hour format with ante/post meridian.</td>
  2331. * </tr>
  2332. * <tr valign="top">
  2333. * <td>ERA</td>
  2334. * <td>Alternate era.</td>
  2335. * </tr>
  2336. * <tr valign="top">
  2337. * <td>ERA_YEAR</td>
  2338. * <td>Year in alternate era format.</td>
  2339. * </tr>
  2340. * <tr valign="top">
  2341. * <td>ERA_D_T_FMT</td>
  2342. * <td>Date and time in alternate era format (string can be used in strftime).</td>
  2343. * </tr>
  2344. * <tr valign="top">
  2345. * <td>ERA_D_FMT</td>
  2346. * <td>Date in alternate era format (string can be used in strftime).</td>
  2347. * </tr>
  2348. * <tr valign="top">
  2349. * <td>ERA_T_FMT</td>
  2350. * <td>Time in alternate era format (string can be used in strftime).</td>
  2351. * </tr>
  2352. * <tr valign="top">
  2353. * LC_MONETARY Category Constants</td>
  2354. * </tr>
  2355. * <tr valign="top">
  2356. * <td>INT_CURR_SYMBOL</td>
  2357. * <td>International currency symbol.</td>
  2358. * </tr>
  2359. * <tr valign="top">
  2360. * <td>CURRENCY_SYMBOL</td>
  2361. * <td>Local currency symbol.</td>
  2362. * </tr>
  2363. * <tr valign="top">
  2364. * <td>CRNCYSTR</td>
  2365. * <td>Same value as CURRENCY_SYMBOL.</td>
  2366. * </tr>
  2367. * <tr valign="top">
  2368. * <td>MON_DECIMAL_POINT</td>
  2369. * <td>Decimal point character.</td>
  2370. * </tr>
  2371. * <tr valign="top">
  2372. * <td>MON_THOUSANDS_SEP</td>
  2373. * <td>Thousands separator (groups of three digits).</td>
  2374. * </tr>
  2375. * <tr valign="top">
  2376. * <td>MON_GROUPING</td>
  2377. * <td>Like "grouping" element.</td>
  2378. * </tr>
  2379. * <tr valign="top">
  2380. * <td>POSITIVE_SIGN</td>
  2381. * <td>Sign for positive values.</td>
  2382. * </tr>
  2383. * <tr valign="top">
  2384. * <td>NEGATIVE_SIGN</td>
  2385. * <td>Sign for negative values.</td>
  2386. * </tr>
  2387. * <tr valign="top">
  2388. * <td>INT_FRAC_DIGITS</td>
  2389. * <td>International fractional digits.</td>
  2390. * </tr>
  2391. * <tr valign="top">
  2392. * <td>FRAC_DIGITS</td>
  2393. * <td>Local fractional digits.</td>
  2394. * </tr>
  2395. * <tr valign="top">
  2396. * <td>P_CS_PRECEDES</td>
  2397. * <td>Returns 1 if CURRENCY_SYMBOL precedes a positive value.</td>
  2398. * </tr>
  2399. * <tr valign="top">
  2400. * <td>P_SEP_BY_SPACE</td>
  2401. * <td>Returns 1 if a space separates CURRENCY_SYMBOL from a positive value.</td>
  2402. * </tr>
  2403. * <tr valign="top">
  2404. * <td>N_CS_PRECEDES</td>
  2405. * <td>Returns 1 if CURRENCY_SYMBOL precedes a negative value.</td>
  2406. * </tr>
  2407. * <tr valign="top">
  2408. * <td>N_SEP_BY_SPACE</td>
  2409. * <td>Returns 1 if a space separates CURRENCY_SYMBOL from a negative value.</td>
  2410. * </tr>
  2411. * <tr valign="top">
  2412. * <td>P_SIGN_POSN</td>
  2413. * Returns 0 if parentheses surround the quantity and CURRENCY_SYMBOL.
  2414. * @return string the element as a string, or false if item
  2415. * is not valid.
  2416. */
  2417. function nl_langinfo ($item) {}
  2418. /**
  2419. * Calculate the soundex key of a string
  2420. * @link http://www.php.net/manual/en/function.soundex.php
  2421. * @param str string <p>
  2422. * The input string.
  2423. * </p>
  2424. * @return string the soundex key as a string.
  2425. */
  2426. function soundex ($str) {}
  2427. /**
  2428. * Calculate Levenshtein distance between two strings
  2429. * @link http://www.php.net/manual/en/function.levenshtein.php
  2430. * @param str1 string <p>
  2431. * One of the strings being evaluated for Levenshtein distance.
  2432. * </p>
  2433. * @param str2 string <p>
  2434. * One of the strings being evaluated for Levenshtein distance.
  2435. * </p>
  2436. * @return int This function returns the Levenshtein-Distance between the
  2437. * two argument strings or -1, if one of the argument strings
  2438. * is longer than the limit of 255 characters.
  2439. */
  2440. function levenshtein ($str1, $str2) {}
  2441. /**
  2442. * Return a specific character
  2443. * @link http://www.php.net/manual/en/function.chr.php
  2444. * @param ascii int <p>
  2445. * The ascii code.
  2446. * </p>
  2447. * @return string the specified character.
  2448. */
  2449. function chr ($ascii) {}
  2450. /**
  2451. * Return ASCII value of character
  2452. * @link http://www.php.net/manual/en/function.ord.php
  2453. * @param string string <p>
  2454. * A character.
  2455. * </p>
  2456. * @return int the ASCII value as an integer.
  2457. */
  2458. function ord ($string) {}
  2459. /**
  2460. * Parses the string into variables
  2461. * @link http://www.php.net/manual/en/function.parse-str.php
  2462. * @param str string <p>
  2463. * The input string.
  2464. * </p>
  2465. * @param arr array[optional] <p>
  2466. * If the second parameter arr is present,
  2467. * variables are stored in this variable as array elements instead.
  2468. * </p>
  2469. * @return void
  2470. */
  2471. function parse_str ($str, array &$arr = null) {}
  2472. /**
  2473. * Parse a CSV string into an array
  2474. * @link http://www.php.net/manual/en/function.str-getcsv.php
  2475. * @param input string <p>
  2476. * The string to parse.
  2477. * </p>
  2478. * @param delimiter string[optional] <p>
  2479. * Set the field delimiter (one character only).
  2480. * </p>
  2481. * @param enclosure string[optional] <p>
  2482. * Set the field enclosure character (one character only).
  2483. * </p>
  2484. * @param escape string[optional] <p>
  2485. * Set the escape character (one character only). Defaults as a backslash
  2486. * (\)
  2487. * </p>
  2488. * @return array an indexed array containing the fields read.
  2489. */
  2490. function str_getcsv ($input, $delimiter = null, $enclosure = null, $escape = null) {}
  2491. /**
  2492. * Pad a string to a certain length with another string
  2493. * @link http://www.php.net/manual/en/function.str-pad.php
  2494. * @param input string <p>
  2495. * The input string.
  2496. * </p>
  2497. * @param pad_length int <p>
  2498. * If the value of pad_length is negative,
  2499. * less than, or equal to the length of the input string, no padding
  2500. * takes place.
  2501. * </p>
  2502. * @param pad_string string[optional] <p>
  2503. * The pad_string may be truncated if the
  2504. * required number of padding characters can't be evenly divided by the
  2505. * pad_string's length.
  2506. * </p>
  2507. * @param pad_type int[optional] <p>
  2508. * Optional argument pad_type can be
  2509. * STR_PAD_RIGHT, STR_PAD_LEFT,
  2510. * or STR_PAD_BOTH. If
  2511. * pad_type is not specified it is assumed to be
  2512. * STR_PAD_RIGHT.
  2513. * </p>
  2514. * @return string the padded string.
  2515. */
  2516. function str_pad ($input, $pad_length, $pad_string = null, $pad_type = null) {}
  2517. /**
  2518. * &Alias; <function>rtrim</function>
  2519. * @link http://www.php.net/manual/en/function.chop.php
  2520. * @param str
  2521. * @param character_mask[optional]
  2522. */
  2523. function chop ($str, $character_mask) {}
  2524. /**
  2525. * &Alias; <function>strstr</function>
  2526. * @link http://www.php.net/manual/en/function.strchr.php
  2527. * @param haystack
  2528. * @param needle
  2529. * @param part[optional]
  2530. */
  2531. function strchr ($haystack, $needle, $part) {}
  2532. /**
  2533. * Return a formatted string
  2534. * @link http://www.php.net/manual/en/function.sprintf.php
  2535. * @param format string <p>
  2536. * The format string is composed of zero or more directives:
  2537. * ordinary characters (excluding %) that are
  2538. * copied directly to the result, and conversion
  2539. * specifications, each of which results in fetching its
  2540. * own parameter. This applies to both sprintf
  2541. * and printf.
  2542. * </p>
  2543. * <p>
  2544. * Each conversion specification consists of a percent sign
  2545. * (%), followed by one or more of these
  2546. * elements, in order:
  2547. * An optional sign specifier that forces a sign
  2548. * (- or +) to be used on a number. By default, only the - sign is used
  2549. * on a number if it's negative. This specifier forces positive numbers
  2550. * to have the + sign attached as well, and was added in PHP 4.3.0.
  2551. * @param args mixed[optional] <p>
  2552. * </p>
  2553. * @param _ mixed[optional]
  2554. * @return string a string produced according to the formatting string
  2555. * format.
  2556. */
  2557. function sprintf ($format, $args = null, $_ = null) {}
  2558. /**
  2559. * Output a formatted string
  2560. * @link http://www.php.net/manual/en/function.printf.php
  2561. * @param format string <p>
  2562. * See sprintf for a description of
  2563. * format.
  2564. * </p>
  2565. * @param args mixed[optional] <p>
  2566. * </p>
  2567. * @param _ mixed[optional]
  2568. * @return int the length of the outputted string.
  2569. */
  2570. function printf ($format, $args = null, $_ = null) {}
  2571. /**
  2572. * Output a formatted string
  2573. * @link http://www.php.net/manual/en/function.vprintf.php
  2574. * @param format string <p>
  2575. * See sprintf for a description of
  2576. * format.
  2577. * </p>
  2578. * @param args array <p>
  2579. * </p>
  2580. * @return int the length of the outputted string.
  2581. */
  2582. function vprintf ($format, array $args) {}
  2583. /**
  2584. * Return a formatted string
  2585. * @link http://www.php.net/manual/en/function.vsprintf.php
  2586. * @param format string <p>
  2587. * See sprintf for a description of
  2588. * format.
  2589. * </p>
  2590. * @param args array <p>
  2591. * </p>
  2592. * @return string Return array values as a formatted string according to
  2593. * format (which is described in the documentation
  2594. * for sprintf).
  2595. */
  2596. function vsprintf ($format, array $args) {}
  2597. /**
  2598. * Write a formatted string to a stream
  2599. * @link http://www.php.net/manual/en/function.fprintf.php
  2600. * @param handle resource &fs.file.pointer;
  2601. * @param format string <p>
  2602. * See sprintf for a description of
  2603. * format.
  2604. * </p>
  2605. * @param args mixed[optional] <p>
  2606. * </p>
  2607. * @param _ mixed[optional]
  2608. * @return int the length of the string written.
  2609. */
  2610. function fprintf ($handle, $format, $args = null, $_ = null) {}
  2611. /**
  2612. * Write a formatted string to a stream
  2613. * @link http://www.php.net/manual/en/function.vfprintf.php
  2614. * @param handle resource <p>
  2615. * </p>
  2616. * @param format string <p>
  2617. * See sprintf for a description of
  2618. * format.
  2619. * </p>
  2620. * @param args array <p>
  2621. * </p>
  2622. * @return int the length of the outputted string.
  2623. */
  2624. function vfprintf ($handle, $format, array $args) {}
  2625. /**
  2626. * Parses input from a string according to a format
  2627. * @link http://www.php.net/manual/en/function.sscanf.php
  2628. * @param str string <p>
  2629. * The input string being parsed.
  2630. * </p>
  2631. * @param format string <p>
  2632. * The interpreted format for str, which is
  2633. * described in the documentation for sprintf with
  2634. * following differences:
  2635. * Function is not locale-aware.
  2636. * F, g, G and
  2637. * b are not supported.
  2638. * D stands for decimal number.
  2639. * i stands for integer with base detection.
  2640. * n stands for number of characters processed so far.
  2641. * </p>
  2642. * @param _ mixed[optional]
  2643. * @return mixed If only
  2644. * two parameters were passed to this function, the values parsed
  2645. * will be returned as an array. Otherwise, if optional parameters are passed,
  2646. * the function will return the number of assigned values. The optional
  2647. * parameters must be passed by reference.
  2648. */
  2649. function sscanf ($str, $format, &$_ = null) {}
  2650. /**
  2651. * Parses input from a file according to a format
  2652. * @link http://www.php.net/manual/en/function.fscanf.php
  2653. * @param handle resource &fs.file.pointer;
  2654. * @param format string <p>
  2655. * The specified format as described in the
  2656. * sprintf documentation.
  2657. * </p>
  2658. * @param _ mixed[optional]
  2659. * @return mixed If only two parameters were passed to this function, the values parsed will be
  2660. * returned as an array. Otherwise, if optional parameters are passed, the
  2661. * function will return the number of assigned values. The optional
  2662. * parameters must be passed by reference.
  2663. */
  2664. function fscanf ($handle, $format, &$_ = null) {}
  2665. /**
  2666. * Parse a URL and return its components
  2667. * @link http://www.php.net/manual/en/function.parse-url.php
  2668. * @param url string <p>
  2669. * The URL to parse. Invalid characters are replaced by
  2670. * _.
  2671. * </p>
  2672. * @param component int[optional] <p>
  2673. * Specify one of PHP_URL_SCHEME,
  2674. * PHP_URL_HOST, PHP_URL_PORT,
  2675. * PHP_URL_USER, PHP_URL_PASS,
  2676. * PHP_URL_PATH, PHP_URL_QUERY
  2677. * or PHP_URL_FRAGMENT to retrieve just a specific
  2678. * URL component as a string (except when
  2679. * PHP_URL_PORT is given, in which case the return
  2680. * value will be an integer).
  2681. * </p>
  2682. * @return mixed On seriously malformed URLs, parse_url may return
  2683. * false.
  2684. * </p>
  2685. * <p>
  2686. * If the component parameter is omitted, an
  2687. * associative array is returned. At least one element will be
  2688. * present within the array. Potential keys within this array are:
  2689. * scheme - e.g. http
  2690. * host
  2691. * port
  2692. * user
  2693. * pass
  2694. * path
  2695. * query - after the question mark ?
  2696. * fragment - after the hashmark #
  2697. * </p>
  2698. * <p>
  2699. * If the component parameter is specified,
  2700. * parse_url returns a string (or an
  2701. * integer, in the case of PHP_URL_PORT)
  2702. * instead of an array. If the requested component doesn't exist
  2703. * within the given URL, &null; will be returned.
  2704. */
  2705. function parse_url ($url, $component = null) {}
  2706. /**
  2707. * URL-encodes string
  2708. * @link http://www.php.net/manual/en/function.urlencode.php
  2709. * @param str string <p>
  2710. * The string to be encoded.
  2711. * </p>
  2712. * @return string a string in which all non-alphanumeric characters except
  2713. * -_. have been replaced with a percent
  2714. * (%) sign followed by two hex digits and spaces encoded
  2715. * as plus (+) signs. It is encoded the same way that the
  2716. * posted data from a WWW form is encoded, that is the same way as in
  2717. * application/x-www-form-urlencoded media type. This
  2718. * differs from the RFC 3986 encoding (see
  2719. * rawurlencode) in that for historical reasons, spaces
  2720. * are encoded as plus (+) signs.
  2721. */
  2722. function urlencode ($str) {}
  2723. /**
  2724. * Decodes URL-encoded string
  2725. * @link http://www.php.net/manual/en/function.urldecode.php
  2726. * @param str string <p>
  2727. * The string to be decoded.
  2728. * </p>
  2729. * @return string the decoded string.
  2730. */
  2731. function urldecode ($str) {}
  2732. /**
  2733. * URL-encode according to RFC 3986
  2734. * @link http://www.php.net/manual/en/function.rawurlencode.php
  2735. * @param str string <p>
  2736. * The URL to be encoded.
  2737. * </p>
  2738. * @return string a string in which all non-alphanumeric characters except
  2739. * -_.~ have been replaced with a percent
  2740. * (%) sign followed by two hex digits. This is the
  2741. * encoding described in RFC 3986 for
  2742. * protecting literal characters from being interpreted as special URL
  2743. * delimiters, and for protecting URLs from being mangled by transmission
  2744. * media with character conversions (like some email systems).
  2745. * <p>
  2746. * Prior to PHP 5.3.0, rawurlencode encoded tildes (~) as per
  2747. * RFC 1738.
  2748. * </p>
  2749. */
  2750. function rawurlencode ($str) {}
  2751. /**
  2752. * Decode URL-encoded strings
  2753. * @link http://www.php.net/manual/en/function.rawurldecode.php
  2754. * @param str string <p>
  2755. * The URL to be decoded.
  2756. * </p>
  2757. * @return string the decoded URL, as a string.
  2758. */
  2759. function rawurldecode ($str) {}
  2760. /**
  2761. * Generate URL-encoded query string
  2762. * @link http://www.php.net/manual/en/function.http-build-query.php
  2763. * @param query_data mixed <p>
  2764. * May be an array or object containing properties.
  2765. * </p>
  2766. * <p>
  2767. * If query_data is an array, it may be a simple
  2768. * one-dimensional structure, or an array of arrays (which in
  2769. * turn may contain other arrays).
  2770. * </p>
  2771. * <p>
  2772. * If query_data is an object, then only public
  2773. * properties will be incorporated into the result.
  2774. * </p>
  2775. * @param numeric_prefix string[optional] <p>
  2776. * If numeric indices are used in the base array and this parameter is
  2777. * provided, it will be prepended to the numeric index for elements in
  2778. * the base array only.
  2779. * </p>
  2780. * <p>
  2781. * This is meant to allow for legal variable names when the data is
  2782. * decoded by PHP or another CGI application later on.
  2783. * </p>
  2784. * @param arg_separator string[optional] <p>
  2785. * arg_separator.output
  2786. * is used to separate arguments, unless this parameter is specified,
  2787. * and is then used.
  2788. * </p>
  2789. * @param enc_type int[optional] <p>
  2790. * By default, PHP_QUERY_RFC1738.
  2791. * </p>
  2792. * <p>
  2793. * If enc_type is
  2794. * PHP_QUERY_RFC1738, then encoding is performed per
  2795. * RFC 1738 and the
  2796. * application/x-www-form-urlencoded media type, which
  2797. * implies that spaces are encoded as plus (+) signs.
  2798. * </p>
  2799. * <p>
  2800. * If enc_type is
  2801. * PHP_QUERY_RFC3986, then encoding is performed
  2802. * according to RFC 3986, and
  2803. * spaces will be percent encoded (%20).
  2804. * </p>
  2805. * @return string a URL-encoded string.
  2806. */
  2807. function http_build_query ($query_data, $numeric_prefix = null, $arg_separator = null, $enc_type = null) {}
  2808. /**
  2809. * Returns the target of a symbolic link
  2810. * @link http://www.php.net/manual/en/function.readlink.php
  2811. * @param path string <p>
  2812. * The symbolic link path.
  2813. * </p>
  2814. * @return string the contents of the symbolic link path or false on error.
  2815. */
  2816. function readlink ($path) {}
  2817. /**
  2818. * Gets information about a link
  2819. * @link http://www.php.net/manual/en/function.linkinfo.php
  2820. * @param path string <p>
  2821. * Path to the link.
  2822. * </p>
  2823. * @return int linkinfo returns the st_dev field
  2824. * of the Unix C stat structure returned by the lstat
  2825. * system call. Returns 0 or false in case of error.
  2826. */
  2827. function linkinfo ($path) {}
  2828. /**
  2829. * Creates a symbolic link
  2830. * @link http://www.php.net/manual/en/function.symlink.php
  2831. * @param target string <p>
  2832. * Target of the link.
  2833. * </p>
  2834. * @param link string <p>
  2835. * The link name.
  2836. * </p>
  2837. * @return bool Returns true on success or false on failure.
  2838. */
  2839. function symlink ($target, $link) {}
  2840. /**
  2841. * Create a hard link
  2842. * @link http://www.php.net/manual/en/function.link.php
  2843. * @param target string <p>
  2844. * Target of the link.
  2845. * </p>
  2846. * @param link string <p>
  2847. * The link name.
  2848. * </p>
  2849. * @return bool Returns true on success or false on failure.
  2850. */
  2851. function link ($target, $link) {}
  2852. /**
  2853. * Deletes a file
  2854. * @link http://www.php.net/manual/en/function.unlink.php
  2855. * @param filename string <p>
  2856. * Path to the file.
  2857. * </p>
  2858. * @param context resource[optional] &note.context-support;
  2859. * @return bool Returns true on success or false on failure.
  2860. */
  2861. function unlink ($filename, $context = null) {}
  2862. /**
  2863. * Execute an external program
  2864. * @link http://www.php.net/manual/en/function.exec.php
  2865. * @param command string <p>
  2866. * The command that will be executed.
  2867. * </p>
  2868. * @param output array[optional] <p>
  2869. * If the output argument is present, then the
  2870. * specified array will be filled with every line of output from the
  2871. * command. Trailing whitespace, such as \n, is not
  2872. * included in this array. Note that if the array already contains some
  2873. * elements, exec will append to the end of the array.
  2874. * If you do not want the function to append elements, call
  2875. * unset on the array before passing it to
  2876. * exec.
  2877. * </p>
  2878. * @param return_var int[optional] <p>
  2879. * If the return_var argument is present
  2880. * along with the output argument, then the
  2881. * return status of the executed command will be written to this
  2882. * variable.
  2883. * </p>
  2884. * @return string The last line from the result of the command. If you need to execute a
  2885. * command and have all the data from the command passed directly back without
  2886. * any interference, use the passthru function.
  2887. * </p>
  2888. * <p>
  2889. * To get the output of the executed command, be sure to set and use the
  2890. * output parameter.
  2891. */
  2892. function exec ($command, array &$output = null, &$return_var = null) {}
  2893. /**
  2894. * Execute an external program and display the output
  2895. * @link http://www.php.net/manual/en/function.system.php
  2896. * @param command string <p>
  2897. * The command that will be executed.
  2898. * </p>
  2899. * @param return_var int[optional] <p>
  2900. * If the return_var argument is present, then the
  2901. * return status of the executed command will be written to this
  2902. * variable.
  2903. * </p>
  2904. * @return string the last line of the command output on success, and false
  2905. * on failure.
  2906. */
  2907. function system ($command, &$return_var = null) {}
  2908. /**
  2909. * Escape shell metacharacters
  2910. * @link http://www.php.net/manual/en/function.escapeshellcmd.php
  2911. * @param command string <p>
  2912. * The command that will be escaped.
  2913. * </p>
  2914. * @return string The escaped string.
  2915. */
  2916. function escapeshellcmd ($command) {}
  2917. /**
  2918. * Escape a string to be used as a shell argument
  2919. * @link http://www.php.net/manual/en/function.escapeshellarg.php
  2920. * @param arg string <p>
  2921. * The argument that will be escaped.
  2922. * </p>
  2923. * @return string The escaped string.
  2924. */
  2925. function escapeshellarg ($arg) {}
  2926. /**
  2927. * Execute an external program and display raw output
  2928. * @link http://www.php.net/manual/en/function.passthru.php
  2929. * @param command string <p>
  2930. * The command that will be executed.
  2931. * </p>
  2932. * @param return_var int[optional] <p>
  2933. * If the return_var argument is present, the
  2934. * return status of the Unix command will be placed here.
  2935. * </p>
  2936. * @return void
  2937. */
  2938. function passthru ($command, &$return_var = null) {}
  2939. /**
  2940. * Execute command via shell and return the complete output as a string
  2941. * @link http://www.php.net/manual/en/function.shell-exec.php
  2942. * @param cmd string <p>
  2943. * The command that will be executed.
  2944. * </p>
  2945. * @return string The output from the executed command or &null; if an error occurred.
  2946. */
  2947. function shell_exec ($cmd) {}
  2948. /**
  2949. * Execute a command and open file pointers for input/output
  2950. * @link http://www.php.net/manual/en/function.proc-open.php
  2951. * @param cmd string <p>
  2952. * The command to execute
  2953. * </p>
  2954. * @param descriptorspec array <p>
  2955. * An indexed array where the key represents the descriptor number and the
  2956. * value represents how PHP will pass that descriptor to the child
  2957. * process. 0 is stdin, 1 is stdout, while 2 is stderr.
  2958. * </p>
  2959. * <p>
  2960. * Each element can be:
  2961. * An array describing the pipe to pass to the process. The first
  2962. * element is the descriptor type and the second element is an option for
  2963. * the given type. Valid types are pipe (the second
  2964. * element is either r to pass the read end of the pipe
  2965. * to the process, or w to pass the write end) and
  2966. * file (the second element is a filename).
  2967. * A stream resource representing a real file descriptor (e.g. opened file,
  2968. * a socket, STDIN).
  2969. * </p>
  2970. * <p>
  2971. * The file descriptor numbers are not limited to 0, 1 and 2 - you may
  2972. * specify any valid file descriptor number and it will be passed to the
  2973. * child process. This allows your script to interoperate with other
  2974. * scripts that run as "co-processes". In particular, this is useful for
  2975. * passing passphrases to programs like PGP, GPG and openssl in a more
  2976. * secure manner. It is also useful for reading status information
  2977. * provided by those programs on auxiliary file descriptors.
  2978. * </p>
  2979. * @param pipes array <p>
  2980. * Will be set to an indexed array of file pointers that correspond to
  2981. * PHP's end of any pipes that are created.
  2982. * </p>
  2983. * @param cwd string[optional] <p>
  2984. * The initial working dir for the command. This must be an
  2985. * absolute directory path, or &null;
  2986. * if you want to use the default value (the working dir of the current
  2987. * PHP process)
  2988. * </p>
  2989. * @param env array[optional] <p>
  2990. * An array with the environment variables for the command that will be
  2991. * run, or &null; to use the same environment as the current PHP process
  2992. * </p>
  2993. * @param other_options array[optional] <p>
  2994. * Allows you to specify additional options. Currently supported options
  2995. * include:
  2996. * suppress_errors (windows only): suppresses errors
  2997. * generated by this function when it's set to true
  2998. * bypass_shell (windows only): bypass
  2999. * cmd.exe shell when set to true
  3000. * context: stream context used when opening files
  3001. * (created with stream_context_create)
  3002. * </p>
  3003. * @return resource a resource representing the process, which should be freed using
  3004. * proc_close when you are finished with it. On failure
  3005. * returns false.
  3006. */
  3007. function proc_open ($cmd, array $descriptorspec, array &$pipes, $cwd = null, array $env = null, array $other_options = null) {}
  3008. /**
  3009. * Close a process opened by <function>proc_open</function> and return the exit code of that process
  3010. * @link http://www.php.net/manual/en/function.proc-close.php
  3011. * @param process resource <p>
  3012. * The proc_open resource that will
  3013. * be closed.
  3014. * </p>
  3015. * @return int the termination status of the process that was run. In case of
  3016. * an error then -1 is returned.
  3017. */
  3018. function proc_close ($process) {}
  3019. /**
  3020. * Kills a process opened by proc_open
  3021. * @link http://www.php.net/manual/en/function.proc-terminate.php
  3022. * @param process resource <p>
  3023. * The proc_open resource that will
  3024. * be closed.
  3025. * </p>
  3026. * @param signal int[optional] <p>
  3027. * This optional parameter is only useful on POSIX
  3028. * operating systems; you may specify a signal to send to the process
  3029. * using the kill(2) system call. The default is
  3030. * SIGTERM.
  3031. * </p>
  3032. * @return bool the termination status of the process that was run.
  3033. */
  3034. function proc_terminate ($process, $signal = null) {}
  3035. /**
  3036. * Get information about a process opened by <function>proc_open</function>
  3037. * @link http://www.php.net/manual/en/function.proc-get-status.php
  3038. * @param process resource <p>
  3039. * The proc_open resource that will
  3040. * be evaluated.
  3041. * </p>
  3042. * @return array An array of collected information on success, and false
  3043. * on failure. The returned array contains the following elements:
  3044. * </p>
  3045. * <p>
  3046. * <tr valign="top"><td>element</td><td>type</td><td>description</td></tr>
  3047. * <tr valign="top">
  3048. * <td>command</td>
  3049. * <td>string</td>
  3050. * <td>
  3051. * The command string that was passed to proc_open.
  3052. * </td>
  3053. * </tr>
  3054. * <tr valign="top">
  3055. * <td>pid</td>
  3056. * <td>int</td>
  3057. * <td>process id</td>
  3058. * </tr>
  3059. * <tr valign="top">
  3060. * <td>running</td>
  3061. * <td>bool</td>
  3062. * <td>
  3063. * true if the process is still running, false if it has
  3064. * terminated.
  3065. * </td>
  3066. * </tr>
  3067. * <tr valign="top">
  3068. * <td>signaled</td>
  3069. * <td>bool</td>
  3070. * <td>
  3071. * true if the child process has been terminated by
  3072. * an uncaught signal. Always set to false on Windows.
  3073. * </td>
  3074. * </tr>
  3075. * <tr valign="top">
  3076. * <td>stopped</td>
  3077. * <td>bool</td>
  3078. * <td>
  3079. * true if the child process has been stopped by a
  3080. * signal. Always set to false on Windows.
  3081. * </td>
  3082. * </tr>
  3083. * <tr valign="top">
  3084. * <td>exitcode</td>
  3085. * <td>int</td>
  3086. * <td>
  3087. * The exit code returned by the process (which is only
  3088. * meaningful if running is false).
  3089. * Only first call of this function return real value, next calls return
  3090. * -1.
  3091. * </td>
  3092. * </tr>
  3093. * <tr valign="top">
  3094. * <td>termsig</td>
  3095. * <td>int</td>
  3096. * <td>
  3097. * The number of the signal that caused the child process to terminate
  3098. * its execution (only meaningful if signaled is true).
  3099. * </td>
  3100. * </tr>
  3101. * <tr valign="top">
  3102. * <td>stopsig</td>
  3103. * <td>int</td>
  3104. * <td>
  3105. * The number of the signal that caused the child process to stop its
  3106. * execution (only meaningful if stopped is true).
  3107. * </td>
  3108. * </tr>
  3109. */
  3110. function proc_get_status ($process) {}
  3111. /**
  3112. * Change the priority of the current process
  3113. * @link http://www.php.net/manual/en/function.proc-nice.php
  3114. * @param increment int <p>
  3115. * The increment value of the priority change.
  3116. * </p>
  3117. * @return bool Returns true on success or false on failure.
  3118. * If an error occurs, like the user lacks permission to change the priority,
  3119. * an error of level E_WARNING is also generated.
  3120. */
  3121. function proc_nice ($increment) {}
  3122. /**
  3123. * Generate a random integer
  3124. * @link http://www.php.net/manual/en/function.rand.php
  3125. * @param min[optional]
  3126. * @param max[optional]
  3127. * @return int A pseudo random value between min
  3128. * (or 0) and max (or getrandmax, inclusive).
  3129. */
  3130. function rand ($min, $max) {}
  3131. /**
  3132. * Seed the random number generator
  3133. * @link http://www.php.net/manual/en/function.srand.php
  3134. * @param seed int[optional] <p>
  3135. * Optional seed value
  3136. * </p>
  3137. * @return void
  3138. */
  3139. function srand ($seed = null) {}
  3140. /**
  3141. * Show largest possible random value
  3142. * @link http://www.php.net/manual/en/function.getrandmax.php
  3143. * @return int The largest possible random value returned by rand
  3144. */
  3145. function getrandmax () {}
  3146. /**
  3147. * Generate a better random value
  3148. * @link http://www.php.net/manual/en/function.mt-rand.php
  3149. * @param min[optional]
  3150. * @param max[optional]
  3151. * @return int A random integer value between min (or 0)
  3152. * and max (or mt_getrandmax, inclusive)
  3153. */
  3154. function mt_rand ($min, $max) {}
  3155. /**
  3156. * Seed the better random number generator
  3157. * @link http://www.php.net/manual/en/function.mt-srand.php
  3158. * @param seed int[optional] <p>
  3159. * An optional seed value
  3160. * </p>
  3161. * @return void
  3162. */
  3163. function mt_srand ($seed = null) {}
  3164. /**
  3165. * Show largest possible random value
  3166. * @link http://www.php.net/manual/en/function.mt-getrandmax.php
  3167. * @return int the maximum random value returned by mt_rand
  3168. */
  3169. function mt_getrandmax () {}
  3170. /**
  3171. * Get port number associated with an Internet service and protocol
  3172. * @link http://www.php.net/manual/en/function.getservbyname.php
  3173. * @param service string <p>
  3174. * The Internet service name, as a string.
  3175. * </p>
  3176. * @param protocol string <p>
  3177. * protocol is either "tcp"
  3178. * or "udp" (in lowercase).
  3179. * </p>
  3180. * @return int the port number, or false if service or
  3181. * protocol is not found.
  3182. */
  3183. function getservbyname ($service, $protocol) {}
  3184. /**
  3185. * Get Internet service which corresponds to port and protocol
  3186. * @link http://www.php.net/manual/en/function.getservbyport.php
  3187. * @param port int <p>
  3188. * The port number.
  3189. * </p>
  3190. * @param protocol string <p>
  3191. * protocol is either "tcp"
  3192. * or "udp" (in lowercase).
  3193. * </p>
  3194. * @return string the Internet service name as a string.
  3195. */
  3196. function getservbyport ($port, $protocol) {}
  3197. /**
  3198. * Get protocol number associated with protocol name
  3199. * @link http://www.php.net/manual/en/function.getprotobyname.php
  3200. * @param name string <p>
  3201. * The protocol name.
  3202. * </p>
  3203. * @return int the protocol number, &return.falseforfailure;.
  3204. */
  3205. function getprotobyname ($name) {}
  3206. /**
  3207. * Get protocol name associated with protocol number
  3208. * @link http://www.php.net/manual/en/function.getprotobynumber.php
  3209. * @param number int <p>
  3210. * The protocol number.
  3211. * </p>
  3212. * @return string the protocol name as a string, &return.falseforfailure;.
  3213. */
  3214. function getprotobynumber ($number) {}
  3215. /**
  3216. * Gets PHP script owner's UID
  3217. * @link http://www.php.net/manual/en/function.getmyuid.php
  3218. * @return int the user ID of the current script, or false on error.
  3219. */
  3220. function getmyuid () {}
  3221. /**
  3222. * Get PHP script owner's GID
  3223. * @link http://www.php.net/manual/en/function.getmygid.php
  3224. * @return int the group ID of the current script, or false on error.
  3225. */
  3226. function getmygid () {}
  3227. /**
  3228. * Gets PHP's process ID
  3229. * @link http://www.php.net/manual/en/function.getmypid.php
  3230. * @return int the current PHP process ID, or false on error.
  3231. */
  3232. function getmypid () {}
  3233. /**
  3234. * Gets the inode of the current script
  3235. * @link http://www.php.net/manual/en/function.getmyinode.php
  3236. * @return int the current script's inode as an integer, or false on error.
  3237. */
  3238. function getmyinode () {}
  3239. /**
  3240. * Gets time of last page modification
  3241. * @link http://www.php.net/manual/en/function.getlastmod.php
  3242. * @return int the time of the last modification of the current
  3243. * page. The value returned is a Unix timestamp, suitable for
  3244. * feeding to date. Returns false on error.
  3245. */
  3246. function getlastmod () {}
  3247. /**
  3248. * Decodes data encoded with MIME base64
  3249. * @link http://www.php.net/manual/en/function.base64-decode.php
  3250. * @param data string <p>
  3251. * The encoded data.
  3252. * </p>
  3253. * @param strict bool[optional] <p>
  3254. * Returns false if input contains character from outside the base64
  3255. * alphabet.
  3256. * </p>
  3257. * @return string the original data&return.falseforfailure;. The returned data may be
  3258. * binary.
  3259. */
  3260. function base64_decode ($data, $strict = null) {}
  3261. /**
  3262. * Encodes data with MIME base64
  3263. * @link http://www.php.net/manual/en/function.base64-encode.php
  3264. * @param data string <p>
  3265. * The data to encode.
  3266. * </p>
  3267. * @return string The encoded data, as a string&return.falseforfailure;.
  3268. */
  3269. function base64_encode ($data) {}
  3270. /**
  3271. * Uuencode a string
  3272. * @link http://www.php.net/manual/en/function.convert-uuencode.php
  3273. * @param data string <p>
  3274. * The data to be encoded.
  3275. * </p>
  3276. * @return string the uuencoded data.
  3277. */
  3278. function convert_uuencode ($data) {}
  3279. /**
  3280. * Decode a uuencoded string
  3281. * @link http://www.php.net/manual/en/function.convert-uudecode.php
  3282. * @param data string <p>
  3283. * The uuencoded data.
  3284. * </p>
  3285. * @return string the decoded data as a string.
  3286. */
  3287. function convert_uudecode ($data) {}
  3288. /**
  3289. * Absolute value
  3290. * @link http://www.php.net/manual/en/function.abs.php
  3291. * @param number mixed <p>
  3292. * The numeric value to process
  3293. * </p>
  3294. * @return number The absolute value of number. If the
  3295. * argument number is
  3296. * of type float, the return type is also float,
  3297. * otherwise it is integer (as float usually has a
  3298. * bigger value range than integer).
  3299. */
  3300. function abs ($number) {}
  3301. /**
  3302. * Round fractions up
  3303. * @link http://www.php.net/manual/en/function.ceil.php
  3304. * @param value float <p>
  3305. * The value to round
  3306. * </p>
  3307. * @return float value rounded up to the next highest
  3308. * integer.
  3309. * The return value of ceil is still of type
  3310. * float as the value range of float is
  3311. * usually bigger than that of integer.
  3312. */
  3313. function ceil ($value) {}
  3314. /**
  3315. * Round fractions down
  3316. * @link http://www.php.net/manual/en/function.floor.php
  3317. * @param value float <p>
  3318. * The numeric value to round
  3319. * </p>
  3320. * @return float value rounded to the next lowest integer.
  3321. * The return value of floor is still of type
  3322. * float because the value range of float is
  3323. * usually bigger than that of integer.
  3324. */
  3325. function floor ($value) {}
  3326. /**
  3327. * Rounds a float
  3328. * @link http://www.php.net/manual/en/function.round.php
  3329. * @param val float <p>
  3330. * The value to round
  3331. * </p>
  3332. * @param precision int[optional] <p>
  3333. * The optional number of decimal digits to round to.
  3334. * </p>
  3335. * @param mode int[optional] <p>
  3336. * One of PHP_ROUND_HALF_UP,
  3337. * PHP_ROUND_HALF_DOWN,
  3338. * PHP_ROUND_HALF_EVEN, or
  3339. * PHP_ROUND_HALF_ODD.
  3340. * </p>
  3341. * @return float The rounded value
  3342. */
  3343. function round ($val, $precision = null, $mode = null) {}
  3344. /**
  3345. * Sine
  3346. * @link http://www.php.net/manual/en/function.sin.php
  3347. * @param arg float <p>
  3348. * A value in radians
  3349. * </p>
  3350. * @return float The sine of arg
  3351. */
  3352. function sin ($arg) {}
  3353. /**
  3354. * Cosine
  3355. * @link http://www.php.net/manual/en/function.cos.php
  3356. * @param arg float <p>
  3357. * An angle in radians
  3358. * </p>
  3359. * @return float The cosine of arg
  3360. */
  3361. function cos ($arg) {}
  3362. /**
  3363. * Tangent
  3364. * @link http://www.php.net/manual/en/function.tan.php
  3365. * @param arg float <p>
  3366. * The argument to process in radians
  3367. * </p>
  3368. * @return float The tangent of arg
  3369. */
  3370. function tan ($arg) {}
  3371. /**
  3372. * Arc sine
  3373. * @link http://www.php.net/manual/en/function.asin.php
  3374. * @param arg float <p>
  3375. * The argument to process
  3376. * </p>
  3377. * @return float The arc sine of arg in radians
  3378. */
  3379. function asin ($arg) {}
  3380. /**
  3381. * Arc cosine
  3382. * @link http://www.php.net/manual/en/function.acos.php
  3383. * @param arg float <p>
  3384. * The argument to process
  3385. * </p>
  3386. * @return float The arc cosine of arg in radians.
  3387. */
  3388. function acos ($arg) {}
  3389. /**
  3390. * Arc tangent
  3391. * @link http://www.php.net/manual/en/function.atan.php
  3392. * @param arg float <p>
  3393. * The argument to process
  3394. * </p>
  3395. * @return float The arc tangent of arg in radians.
  3396. */
  3397. function atan ($arg) {}
  3398. /**
  3399. * Inverse hyperbolic tangent
  3400. * @link http://www.php.net/manual/en/function.atanh.php
  3401. * @param arg float <p>
  3402. * The argument to process
  3403. * </p>
  3404. * @return float Inverse hyperbolic tangent of arg
  3405. */
  3406. function atanh ($arg) {}
  3407. /**
  3408. * Arc tangent of two variables
  3409. * @link http://www.php.net/manual/en/function.atan2.php
  3410. * @param y float <p>
  3411. * Dividend parameter
  3412. * </p>
  3413. * @param x float <p>
  3414. * Divisor parameter
  3415. * </p>
  3416. * @return float The arc tangent of y/x
  3417. * in radians.
  3418. */
  3419. function atan2 ($y, $x) {}
  3420. /**
  3421. * Hyperbolic sine
  3422. * @link http://www.php.net/manual/en/function.sinh.php
  3423. * @param arg float <p>
  3424. * The argument to process
  3425. * </p>
  3426. * @return float The hyperbolic sine of arg
  3427. */
  3428. function sinh ($arg) {}
  3429. /**
  3430. * Hyperbolic cosine
  3431. * @link http://www.php.net/manual/en/function.cosh.php
  3432. * @param arg float <p>
  3433. * The argument to process
  3434. * </p>
  3435. * @return float The hyperbolic cosine of arg
  3436. */
  3437. function cosh ($arg) {}
  3438. /**
  3439. * Hyperbolic tangent
  3440. * @link http://www.php.net/manual/en/function.tanh.php
  3441. * @param arg float <p>
  3442. * The argument to process
  3443. * </p>
  3444. * @return float The hyperbolic tangent of arg
  3445. */
  3446. function tanh ($arg) {}
  3447. /**
  3448. * Inverse hyperbolic sine
  3449. * @link http://www.php.net/manual/en/function.asinh.php
  3450. * @param arg float <p>
  3451. * The argument to process
  3452. * </p>
  3453. * @return float The inverse hyperbolic sine of arg
  3454. */
  3455. function asinh ($arg) {}
  3456. /**
  3457. * Inverse hyperbolic cosine
  3458. * @link http://www.php.net/manual/en/function.acosh.php
  3459. * @param arg float <p>
  3460. * The value to process
  3461. * </p>
  3462. * @return float The inverse hyperbolic cosine of arg
  3463. */
  3464. function acosh ($arg) {}
  3465. /**
  3466. * Returns exp(number) - 1, computed in a way that is accurate even
  3467. when the value of number is close to zero
  3468. * @link http://www.php.net/manual/en/function.expm1.php
  3469. * @param arg float <p>
  3470. * The argument to process
  3471. * </p>
  3472. * @return float 'e' to the power of arg minus one
  3473. */
  3474. function expm1 ($arg) {}
  3475. /**
  3476. * Returns log(1 + number), computed in a way that is accurate even when
  3477. the value of number is close to zero
  3478. * @link http://www.php.net/manual/en/function.log1p.php
  3479. * @param number float <p>
  3480. * The argument to process
  3481. * </p>
  3482. * @return float log(1 + number)
  3483. */
  3484. function log1p ($number) {}
  3485. /**
  3486. * Get value of pi
  3487. * @link http://www.php.net/manual/en/function.pi.php
  3488. * @return float The value of pi as float.
  3489. */
  3490. function pi () {}
  3491. /**
  3492. * Finds whether a value is a legal finite number
  3493. * @link http://www.php.net/manual/en/function.is-finite.php
  3494. * @param val float <p>
  3495. * The value to check
  3496. * </p>
  3497. * @return bool true if val is a legal finite
  3498. * number within the allowed range for a PHP float on this platform,
  3499. * else false.
  3500. */
  3501. function is_finite ($val) {}
  3502. /**
  3503. * Finds whether a value is not a number
  3504. * @link http://www.php.net/manual/en/function.is-nan.php
  3505. * @param val float <p>
  3506. * The value to check
  3507. * </p>
  3508. * @return bool true if val is 'not a number',
  3509. * else false.
  3510. */
  3511. function is_nan ($val) {}
  3512. /**
  3513. * Finds whether a value is infinite
  3514. * @link http://www.php.net/manual/en/function.is-infinite.php
  3515. * @param val float <p>
  3516. * The value to check
  3517. * </p>
  3518. * @return bool true if val is infinite, else false.
  3519. */
  3520. function is_infinite ($val) {}
  3521. /**
  3522. * Exponential expression
  3523. * @link http://www.php.net/manual/en/function.pow.php
  3524. * @param base number <p>
  3525. * The base to use
  3526. * </p>
  3527. * @param exp number <p>
  3528. * The exponent
  3529. * </p>
  3530. * @return number base raised to the power of exp.
  3531. * If the result can be represented as integer it will be returned as type
  3532. * integer, else it will be returned as type float.
  3533. */
  3534. function pow ($base, $exp) {}
  3535. /**
  3536. * Calculates the exponent of <constant>e</constant>
  3537. * @link http://www.php.net/manual/en/function.exp.php
  3538. * @param arg float <p>
  3539. * The argument to process
  3540. * </p>
  3541. * @return float 'e' raised to the power of arg
  3542. */
  3543. function exp ($arg) {}
  3544. /**
  3545. * Natural logarithm
  3546. * @link http://www.php.net/manual/en/function.log.php
  3547. * @param arg float <p>
  3548. * The value to calculate the logarithm for
  3549. * </p>
  3550. * @param base float[optional] <p>
  3551. * The optional logarithmic base to use
  3552. * (defaults to 'e' and so to the natural logarithm).
  3553. * </p>
  3554. * @return float The logarithm of arg to
  3555. * base, if given, or the
  3556. * natural logarithm.
  3557. */
  3558. function log ($arg, $base = null) {}
  3559. /**
  3560. * Base-10 logarithm
  3561. * @link http://www.php.net/manual/en/function.log10.php
  3562. * @param arg float <p>
  3563. * The argument to process
  3564. * </p>
  3565. * @return float The base-10 logarithm of arg
  3566. */
  3567. function log10 ($arg) {}
  3568. /**
  3569. * Square root
  3570. * @link http://www.php.net/manual/en/function.sqrt.php
  3571. * @param arg float <p>
  3572. * The argument to process
  3573. * </p>
  3574. * @return float The square root of arg
  3575. * or the special value NAN for negative numbers.
  3576. */
  3577. function sqrt ($arg) {}
  3578. /**
  3579. * Calculate the length of the hypotenuse of a right-angle triangle
  3580. * @link http://www.php.net/manual/en/function.hypot.php
  3581. * @param x float <p>
  3582. * Length of first side
  3583. * </p>
  3584. * @param y float <p>
  3585. * Length of second side
  3586. * </p>
  3587. * @return float Calculated length of the hypotenuse
  3588. */
  3589. function hypot ($x, $y) {}
  3590. /**
  3591. * Converts the number in degrees to the radian equivalent
  3592. * @link http://www.php.net/manual/en/function.deg2rad.php
  3593. * @param number float <p>
  3594. * Angular value in degrees
  3595. * </p>
  3596. * @return float The radian equivalent of number
  3597. */
  3598. function deg2rad ($number) {}
  3599. /**
  3600. * Converts the radian number to the equivalent number in degrees
  3601. * @link http://www.php.net/manual/en/function.rad2deg.php
  3602. * @param number float <p>
  3603. * A radian value
  3604. * </p>
  3605. * @return float The equivalent of number in degrees
  3606. */
  3607. function rad2deg ($number) {}
  3608. /**
  3609. * Binary to decimal
  3610. * @link http://www.php.net/manual/en/function.bindec.php
  3611. * @param binary_string string <p>
  3612. * The binary string to convert
  3613. * </p>
  3614. * @return number The decimal value of binary_string
  3615. */
  3616. function bindec ($binary_string) {}
  3617. /**
  3618. * Hexadecimal to decimal
  3619. * @link http://www.php.net/manual/en/function.hexdec.php
  3620. * @param hex_string string <p>
  3621. * The hexadecimal string to convert
  3622. * </p>
  3623. * @return number The decimal representation of hex_string
  3624. */
  3625. function hexdec ($hex_string) {}
  3626. /**
  3627. * Octal to decimal
  3628. * @link http://www.php.net/manual/en/function.octdec.php
  3629. * @param octal_string string <p>
  3630. * The octal string to convert
  3631. * </p>
  3632. * @return number The decimal representation of octal_string
  3633. */
  3634. function octdec ($octal_string) {}
  3635. /**
  3636. * Decimal to binary
  3637. * @link http://www.php.net/manual/en/function.decbin.php
  3638. * @param number int <p>
  3639. * Decimal value to convert
  3640. * </p>
  3641. * <table>
  3642. * Range of inputs on 32-bit machines
  3643. * <tr valign="top">
  3644. * <td>positive number</td>
  3645. * <td>negative number</td>
  3646. * <td>return value</td>
  3647. * </tr>
  3648. * <tr valign="top">
  3649. * <td>0</td>
  3650. * <td></td>
  3651. * <td>0</td>
  3652. * </tr>
  3653. * <tr valign="top">
  3654. * <td>1</td>
  3655. * <td></td>
  3656. * <td>1</td>
  3657. * </tr>
  3658. * <tr valign="top">
  3659. * <td>2</td>
  3660. * <td></td>
  3661. * <td>10</td>
  3662. * </tr>
  3663. * <tr valign="top">
  3664. * ... normal progression ...</td>
  3665. * </tr>
  3666. * <tr valign="top">
  3667. * <td>2147483646</td>
  3668. * <td></td>
  3669. * <td>1111111111111111111111111111110</td>
  3670. * </tr>
  3671. * <tr valign="top">
  3672. * <td>2147483647 (largest signed integer)</td>
  3673. * <td></td>
  3674. * <td>1111111111111111111111111111111 (31 1's)</td>
  3675. * </tr>
  3676. * <tr valign="top">
  3677. * <td>2147483648</td>
  3678. * <td>-2147483648</td>
  3679. * <td>10000000000000000000000000000000</td>
  3680. * </tr>
  3681. * <tr valign="top">
  3682. * ... normal progression ...</td>
  3683. * </tr>
  3684. * <tr valign="top">
  3685. * <td>4294967294</td>
  3686. * <td>-2</td>
  3687. * <td>11111111111111111111111111111110</td>
  3688. * </tr>
  3689. * <tr valign="top">
  3690. * <td>4294967295 (largest unsigned integer)</td>
  3691. * <td>-1</td>
  3692. * <td>11111111111111111111111111111111 (32 1's)</td>
  3693. * </tr>
  3694. * </table>
  3695. * <table>
  3696. * Range of inputs on 64-bit machines
  3697. * <tr valign="top">
  3698. * <td>positive number</td>
  3699. * <td>negative number</td>
  3700. * <td>return value</td>
  3701. * </tr>
  3702. * <tr valign="top">
  3703. * <td>0</td>
  3704. * <td></td>
  3705. * <td>0</td>
  3706. * </tr>
  3707. * <tr valign="top">
  3708. * <td>1</td>
  3709. * <td></td>
  3710. * <td>1</td>
  3711. * </tr>
  3712. * <tr valign="top">
  3713. * <td>2</td>
  3714. * <td></td>
  3715. * <td>10</td>
  3716. * </tr>
  3717. * <tr valign="top">
  3718. * ... normal progression ...</td>
  3719. * </tr>
  3720. * <tr valign="top">
  3721. * <td>9223372036854775806</td>
  3722. * <td></td>
  3723. * <td>111111111111111111111111111111111111111111111111111111111111110</td>
  3724. * </tr>
  3725. * <tr valign="top">
  3726. * <td>9223372036854775807 (largest signed integer)</td>
  3727. * <td></td>
  3728. * <td>111111111111111111111111111111111111111111111111111111111111111 (63 1's)</td>
  3729. * </tr>
  3730. * <tr valign="top">
  3731. * <td></td>
  3732. * <td>-9223372036854775808</td>
  3733. * <td>1000000000000000000000000000000000000000000000000000000000000000</td>
  3734. * </tr>
  3735. * <tr valign="top">
  3736. * ... normal progression ...</td>
  3737. * </tr>
  3738. * <tr valign="top">
  3739. * <td></td>
  3740. * <td>-2</td>
  3741. * <td>1111111111111111111111111111111111111111111111111111111111111110</td>
  3742. * </tr>
  3743. * <tr valign="top">
  3744. * <td></td>
  3745. * <td>-1</td>
  3746. * <td>1111111111111111111111111111111111111111111111111111111111111111 (64 1's)</td>
  3747. * </tr>
  3748. * </table>
  3749. * @return string Binary string representation of number
  3750. */
  3751. function decbin ($number) {}
  3752. /**
  3753. * Decimal to octal
  3754. * @link http://www.php.net/manual/en/function.decoct.php
  3755. * @param number int <p>
  3756. * Decimal value to convert
  3757. * </p>
  3758. * @return string Octal string representation of number
  3759. */
  3760. function decoct ($number) {}
  3761. /**
  3762. * Decimal to hexadecimal
  3763. * @link http://www.php.net/manual/en/function.dechex.php
  3764. * @param number int <p>
  3765. * Decimal value to convert
  3766. * </p>
  3767. * @return string Hexadecimal string representation of number
  3768. */
  3769. function dechex ($number) {}
  3770. /**
  3771. * Convert a number between arbitrary bases
  3772. * @link http://www.php.net/manual/en/function.base-convert.php
  3773. * @param number string <p>
  3774. * The number to convert
  3775. * </p>
  3776. * @param frombase int <p>
  3777. * The base number is in
  3778. * </p>
  3779. * @param tobase int <p>
  3780. * The base to convert number to
  3781. * </p>
  3782. * @return string number converted to base tobase
  3783. */
  3784. function base_convert ($number, $frombase, $tobase) {}
  3785. /**
  3786. * Format a number with grouped thousands
  3787. * @link http://www.php.net/manual/en/function.number-format.php
  3788. * @param number float <p>
  3789. * The number being formatted.
  3790. * </p>
  3791. * @param decimals int[optional] <p>
  3792. * Sets the number of decimal points.
  3793. * </p>
  3794. * @return string A formatted version of number.
  3795. */
  3796. function number_format ($number, $decimals = null) {}
  3797. /**
  3798. * Returns the floating point remainder (modulo) of the division
  3799. of the arguments
  3800. * @link http://www.php.net/manual/en/function.fmod.php
  3801. * @param x float <p>
  3802. * The dividend
  3803. * </p>
  3804. * @param y float <p>
  3805. * The divisor
  3806. * </p>
  3807. * @return float The floating point remainder of
  3808. * x/y
  3809. */
  3810. function fmod ($x, $y) {}
  3811. /**
  3812. * Converts a packed internet address to a human readable representation
  3813. * @link http://www.php.net/manual/en/function.inet-ntop.php
  3814. * @param in_addr string <p>
  3815. * A 32bit IPv4, or 128bit IPv6 address.
  3816. * </p>
  3817. * @return string a string representation of the address&return.falseforfailure;.
  3818. */
  3819. function inet_ntop ($in_addr) {}
  3820. /**
  3821. * Converts a human readable IP address to its packed in_addr representation
  3822. * @link http://www.php.net/manual/en/function.inet-pton.php
  3823. * @param address string <p>
  3824. * A human readable IPv4 or IPv6 address.
  3825. * </p>
  3826. * @return string the in_addr representation of the given
  3827. * address, or false if a syntactically invalid
  3828. * address is given (for example, an IPv4 address
  3829. * without dots or an IPv6 address without colons).
  3830. */
  3831. function inet_pton ($address) {}
  3832. /**
  3833. * Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address
  3834. * @link http://www.php.net/manual/en/function.ip2long.php
  3835. * @param ip_address string <p>
  3836. * A standard format address.
  3837. * </p>
  3838. * @return int the IPv4 address or false if ip_address
  3839. * is invalid.
  3840. */
  3841. function ip2long ($ip_address) {}
  3842. /**
  3843. * Converts an (IPv4) Internet network address into a string in Internet standard dotted format
  3844. * @link http://www.php.net/manual/en/function.long2ip.php
  3845. * @param proper_address string <p>
  3846. * A proper address representation.
  3847. * </p>
  3848. * @return string the Internet IP address as a string.
  3849. */
  3850. function long2ip ($proper_address) {}
  3851. /**
  3852. * Gets the value of an environment variable
  3853. * @link http://www.php.net/manual/en/function.getenv.php
  3854. * @param varname string <p>
  3855. * The variable name.
  3856. * </p>
  3857. * @return string the value of the environment variable
  3858. * varname, or false if the environment
  3859. * variable varname does not exist.
  3860. */
  3861. function getenv ($varname) {}
  3862. /**
  3863. * Sets the value of an environment variable
  3864. * @link http://www.php.net/manual/en/function.putenv.php
  3865. * @param setting string <p>
  3866. * The setting, like "FOO=BAR"
  3867. * </p>
  3868. * @return bool Returns true on success or false on failure.
  3869. */
  3870. function putenv ($setting) {}
  3871. /**
  3872. * Gets options from the command line argument list
  3873. * @link http://www.php.net/manual/en/function.getopt.php
  3874. * @param options string Each character in this string will be used as option characters and
  3875. * matched against options passed to the script starting with a single
  3876. * hyphen (-).
  3877. * For example, an option string "x" recognizes an
  3878. * option -x.
  3879. * Only a-z, A-Z and 0-9 are allowed.
  3880. * @param longopts array[optional] An array of options. Each element in this array will be used as option
  3881. * strings and matched against options passed to the script starting with
  3882. * two hyphens (--).
  3883. * For example, an longopts element "opt" recognizes an
  3884. * option --opt.
  3885. * @return array This function will return an array of option / argument pairs or false on
  3886. * failure.
  3887. * </p>
  3888. * <p>
  3889. * The parsing of options will end at the first non-option found, anything
  3890. * that follows is discarded.
  3891. */
  3892. function getopt ($options, array $longopts = null) {}
  3893. /**
  3894. * Gets system load average
  3895. * @link http://www.php.net/manual/en/function.sys-getloadavg.php
  3896. * @return array an array with three samples (last 1, 5 and 15
  3897. * minutes).
  3898. */
  3899. function sys_getloadavg () {}
  3900. /**
  3901. * Return current Unix timestamp with microseconds
  3902. * @link http://www.php.net/manual/en/function.microtime.php
  3903. * @param get_as_float bool[optional] <p>
  3904. * If used and set to true, microtime will return a
  3905. * float instead of a string, as described in
  3906. * the return values section below.
  3907. * </p>
  3908. * @return mixed By default, microtime returns a string in
  3909. * the form "msec sec", where sec is the current time
  3910. * measured in the number of seconds since the Unix epoch (0:00:00 January 1,
  3911. * 1970 GMT), and msec is the number of microseconds that
  3912. * have elapsed since sec expressed in seconds.
  3913. * </p>
  3914. * <p>
  3915. * If get_as_float is set to true, then
  3916. * microtime returns a float, which
  3917. * represents the current time in seconds since the Unix epoch accurate to the
  3918. * nearest microsecond.
  3919. */
  3920. function microtime ($get_as_float = null) {}
  3921. /**
  3922. * Get current time
  3923. * @link http://www.php.net/manual/en/function.gettimeofday.php
  3924. * @param return_float bool[optional] <p>
  3925. * When set to true, a float instead of an array is returned.
  3926. * </p>
  3927. * @return mixed By default an array is returned. If return_float
  3928. * is set, then a float is returned.
  3929. * </p>
  3930. * <p>
  3931. * Array keys:
  3932. * "sec" - seconds since the Unix Epoch
  3933. * "usec" - microseconds
  3934. * "minuteswest" - minutes west of Greenwich
  3935. * "dsttime" - type of dst correction
  3936. */
  3937. function gettimeofday ($return_float = null) {}
  3938. /**
  3939. * Gets the current resource usages
  3940. * @link http://www.php.net/manual/en/function.getrusage.php
  3941. * @param who int[optional] <p>
  3942. * If who is 1, getrusage will be called with
  3943. * RUSAGE_CHILDREN.
  3944. * </p>
  3945. * @return array an associative array containing the data returned from the system
  3946. * call. All entries are accessible by using their documented field names.
  3947. */
  3948. function getrusage ($who = null) {}
  3949. /**
  3950. * Generate a unique ID
  3951. * @link http://www.php.net/manual/en/function.uniqid.php
  3952. * @param prefix string[optional] <p>
  3953. * Can be useful, for instance, if you generate identifiers
  3954. * simultaneously on several hosts that might happen to generate the
  3955. * identifier at the same microsecond.
  3956. * </p>
  3957. * <p>
  3958. * With an empty prefix, the returned string will
  3959. * be 13 characters long. If more_entropy is
  3960. * true, it will be 23 characters.
  3961. * </p>
  3962. * @param more_entropy bool[optional] <p>
  3963. * If set to true, uniqid will add additional
  3964. * entropy (using the combined linear congruential generator) at the end
  3965. * of the return value, which should make the results more unique.
  3966. * </p>
  3967. * @return string the unique identifier, as a string.
  3968. */
  3969. function uniqid ($prefix = null, $more_entropy = null) {}
  3970. /**
  3971. * Convert a quoted-printable string to an 8 bit string
  3972. * @link http://www.php.net/manual/en/function.quoted-printable-decode.php
  3973. * @param str string <p>
  3974. * The input string.
  3975. * </p>
  3976. * @return string the 8-bit binary string.
  3977. */
  3978. function quoted_printable_decode ($str) {}
  3979. /**
  3980. * Convert a 8 bit string to a quoted-printable string
  3981. * @link http://www.php.net/manual/en/function.quoted-printable-encode.php
  3982. * @param str string <p>
  3983. * The input string.
  3984. * </p>
  3985. * @return string the encoded string.
  3986. */
  3987. function quoted_printable_encode ($str) {}
  3988. /**
  3989. * Convert from one Cyrillic character set to another
  3990. * @link http://www.php.net/manual/en/function.convert-cyr-string.php
  3991. * @param str string <p>
  3992. * The string to be converted.
  3993. * </p>
  3994. * @param from string <p>
  3995. * The source Cyrillic character set, as a single character.
  3996. * </p>
  3997. * @param to string <p>
  3998. * The target Cyrillic character set, as a single character.
  3999. * </p>
  4000. * @return string the converted string.
  4001. */
  4002. function convert_cyr_string ($str, $from, $to) {}
  4003. /**
  4004. * Gets the name of the owner of the current PHP script
  4005. * @link http://www.php.net/manual/en/function.get-current-user.php
  4006. * @return string the username as a string.
  4007. */
  4008. function get_current_user () {}
  4009. /**
  4010. * Limits the maximum execution time
  4011. * @link http://www.php.net/manual/en/function.set-time-limit.php
  4012. * @param seconds int <p>
  4013. * The maximum execution time, in seconds. If set to zero, no time limit
  4014. * is imposed.
  4015. * </p>
  4016. * @return void
  4017. */
  4018. function set_time_limit ($seconds) {}
  4019. /**
  4020. * Call a header function
  4021. * @link http://www.php.net/manual/en/function.header-register-callback.php
  4022. * @param callback callback <p>
  4023. * Function called just before the headers are sent. It gets no parameters
  4024. * and the return value is ignored.
  4025. * </p>
  4026. * @return bool Returns true on success or false on failure.
  4027. */
  4028. function header_register_callback ($callback) {}
  4029. /**
  4030. * Gets the value of a PHP configuration option
  4031. * @link http://www.php.net/manual/en/function.get-cfg-var.php
  4032. * @param option string <p>
  4033. * The configuration option name.
  4034. * </p>
  4035. * @return string the current value of the PHP configuration variable specified by
  4036. * option, or false if an error occurs.
  4037. */
  4038. function get_cfg_var ($option) {}
  4039. /**
  4040. * &Alias; <function>set_magic_quotes_runtime</function>
  4041. * @link http://www.php.net/manual/en/function.magic-quotes-runtime.php
  4042. * @param new_setting
  4043. */
  4044. function magic_quotes_runtime ($new_setting) {}
  4045. /**
  4046. * Sets the current active configuration setting of magic_quotes_runtime
  4047. * @link http://www.php.net/manual/en/function.set-magic-quotes-runtime.php
  4048. * @param new_setting bool <p>
  4049. * false for off, true for on.
  4050. * </p>
  4051. * @return bool Returns true on success or false on failure.
  4052. */
  4053. function set_magic_quotes_runtime ($new_setting) {}
  4054. /**
  4055. * Gets the current configuration setting of magic_quotes_gpc
  4056. * @link http://www.php.net/manual/en/function.get-magic-quotes-gpc.php
  4057. * @return int 0 if magic_quotes_gpc is off, 1 otherwise.
  4058. */
  4059. function get_magic_quotes_gpc () {}
  4060. /**
  4061. * Gets the current active configuration setting of magic_quotes_runtime
  4062. * @link http://www.php.net/manual/en/function.get-magic-quotes-runtime.php
  4063. * @return int 0 if magic_quotes_runtime is off, 1 otherwise.
  4064. */
  4065. function get_magic_quotes_runtime () {}
  4066. /**
  4067. * Send an error message somewhere
  4068. * @link http://www.php.net/manual/en/function.error-log.php
  4069. * @param message string <p>
  4070. * The error message that should be logged.
  4071. * </p>
  4072. * @param message_type int[optional] <p>
  4073. * Says where the error should go. The possible message types are as
  4074. * follows:
  4075. * </p>
  4076. * <p>
  4077. * <table>
  4078. * error_log log types
  4079. * <tr valign="top">
  4080. * <td>0</td>
  4081. * <td>
  4082. * message is sent to PHP's system logger, using
  4083. * the Operating System's system logging mechanism or a file, depending
  4084. * on what the error_log
  4085. * configuration directive is set to. This is the default option.
  4086. * </td>
  4087. * </tr>
  4088. * <tr valign="top">
  4089. * <td>1</td>
  4090. * <td>
  4091. * message is sent by email to the address in
  4092. * the destination parameter. This is the only
  4093. * message type where the fourth parameter,
  4094. * extra_headers is used.
  4095. * </td>
  4096. * </tr>
  4097. * <tr valign="top">
  4098. * <td>2</td>
  4099. * <td>
  4100. * No longer an option.
  4101. * </td>
  4102. * </tr>
  4103. * <tr valign="top">
  4104. * <td>3</td>
  4105. * <td>
  4106. * message is appended to the file
  4107. * destination. A newline is not automatically
  4108. * added to the end of the message string.
  4109. * </td>
  4110. * </tr>
  4111. * <tr valign="top">
  4112. * <td>4</td>
  4113. * <td>
  4114. * message is sent directly to the SAPI logging
  4115. * handler.
  4116. * </td>
  4117. * </tr>
  4118. * </table>
  4119. * </p>
  4120. * @param destination string[optional] <p>
  4121. * The destination. Its meaning depends on the
  4122. * message_type parameter as described above.
  4123. * </p>
  4124. * @param extra_headers string[optional] <p>
  4125. * The extra headers. It's used when the message_type
  4126. * parameter is set to 1.
  4127. * This message type uses the same internal function as
  4128. * mail does.
  4129. * </p>
  4130. * @return bool Returns true on success or false on failure.
  4131. */
  4132. function error_log ($message, $message_type = null, $destination = null, $extra_headers = null) {}
  4133. /**
  4134. * Get the last occurred error
  4135. * @link http://www.php.net/manual/en/function.error-get-last.php
  4136. * @return array an associative array describing the last error with keys "type",
  4137. * "message", "file" and "line". If the error has been caused by a PHP
  4138. * internal function then the "message" begins with its name.
  4139. * Returns &null; if there hasn't been an error yet.
  4140. */
  4141. function error_get_last () {}
  4142. /**
  4143. * Call the callback given by the first parameter
  4144. * @link http://www.php.net/manual/en/function.call-user-func.php
  4145. * @param callback callback <p>
  4146. * The callback to be called.
  4147. * </p>
  4148. * @param parameter mixed[optional] <p>
  4149. * Zero or more parameters to be passed to the callback.
  4150. * </p>
  4151. * <p>
  4152. * Note that the parameters for call_user_func are
  4153. * not passed by reference.
  4154. * call_user_func example and references
  4155. * ]]>
  4156. * &example.outputs;
  4157. * </p>
  4158. * @param _ mixed[optional]
  4159. * @return mixed the return value of the callback, or false on error.
  4160. */
  4161. function call_user_func ($callback, $parameter = null, $_ = null) {}
  4162. /**
  4163. * Call a callback with an array of parameters
  4164. * @link http://www.php.net/manual/en/function.call-user-func-array.php
  4165. * @param callback callback <p>
  4166. * The callback to be called.
  4167. * </p>
  4168. * @param param_arr array <p>
  4169. * The parameters to be passed to the callback, as an indexed array.
  4170. * </p>
  4171. * @return mixed the return value of the callback, or false on error.
  4172. */
  4173. function call_user_func_array ($callback, array $param_arr) {}
  4174. /**
  4175. * Call a user method on an specific object [deprecated]
  4176. * @link http://www.php.net/manual/en/function.call-user-method.php
  4177. * @param method_name string <p>
  4178. * The method name being called.
  4179. * </p>
  4180. * @param obj object <p>
  4181. * The object that method_name
  4182. * is being called on.
  4183. * </p>
  4184. * @param parameter mixed[optional]
  4185. * @param _ mixed[optional]
  4186. * @return mixed
  4187. */
  4188. function call_user_method ($method_name, &$obj, $parameter = null, $_ = null) {}
  4189. /**
  4190. * Call a user method given with an array of parameters [deprecated]
  4191. * @link http://www.php.net/manual/en/function.call-user-method-array.php
  4192. * @param method_name string <p>
  4193. * The method name being called.
  4194. * </p>
  4195. * @param obj object <p>
  4196. * The object that method_name
  4197. * is being called on.
  4198. * </p>
  4199. * @param params array <p>
  4200. * An array of parameters.
  4201. * </p>
  4202. * @return mixed
  4203. */
  4204. function call_user_method_array ($method_name, &$obj, array $params) {}
  4205. /**
  4206. * Call a static method
  4207. * @link http://www.php.net/manual/en/function.forward-static-call.php
  4208. * @param function callback <p>
  4209. * The function or method to be called. This parameter may be an array,
  4210. * with the name of the class, and the method, or a string, with a function
  4211. * name.
  4212. * </p>
  4213. * @param parameter mixed[optional] <p>
  4214. * Zero or more parameters to be passed to the function.
  4215. * </p>
  4216. * @param _ mixed[optional]
  4217. * @return mixed the function result, or false on error.
  4218. */
  4219. function forward_static_call ($function, $parameter = null, $_ = null) {}
  4220. /**
  4221. * Call a static method and pass the arguments as array
  4222. * @link http://www.php.net/manual/en/function.forward-static-call-array.php
  4223. * @param function callback <p>
  4224. * The function or method to be called. This parameter may be an &array;,
  4225. * with the name of the class, and the method, or a &string;, with a function
  4226. * name.
  4227. * </p>
  4228. * @param parameters array
  4229. * @return mixed the function result, or false on error.
  4230. */
  4231. function forward_static_call_array ($function, array $parameters) {}
  4232. /**
  4233. * Generates a storable representation of a value
  4234. * @link http://www.php.net/manual/en/function.serialize.php
  4235. * @param value mixed <p>
  4236. * The value to be serialized. serialize
  4237. * handles all types, except the resource-type.
  4238. * You can even serialize arrays that contain
  4239. * references to itself. Circular references inside the array/object you
  4240. * are serializing will also be stored. Any other
  4241. * reference will be lost.
  4242. * </p>
  4243. * <p>
  4244. * When serializing objects, PHP will attempt to call the member function
  4245. * __sleep() prior to serialization.
  4246. * This is to allow the object to do any last minute clean-up, etc. prior
  4247. * to being serialized. Likewise, when the object is restored using
  4248. * unserialize the __wakeup() member function is called.
  4249. * </p>
  4250. * <p>
  4251. * Object's private members have the class name prepended to the member
  4252. * name; protected members have a '*' prepended to the member name.
  4253. * These prepended values have null bytes on either side.
  4254. * </p>
  4255. * @return string a string containing a byte-stream representation of
  4256. * value that can be stored anywhere.
  4257. */
  4258. function serialize ($value) {}
  4259. /**
  4260. * Creates a PHP value from a stored representation
  4261. * @link http://www.php.net/manual/en/function.unserialize.php
  4262. * @param str string <p>
  4263. * The serialized string.
  4264. * </p>
  4265. * <p>
  4266. * If the variable being unserialized is an object, after successfully
  4267. * reconstructing the object PHP will automatically attempt to call the
  4268. * __wakeup() member
  4269. * function (if it exists).
  4270. * </p>
  4271. * <p>
  4272. * unserialize_callback_func directive
  4273. * <p>
  4274. * It's possible to set a callback-function which will be called,
  4275. * if an undefined class should be instantiated during unserializing.
  4276. * (to prevent getting an incomplete object "__PHP_Incomplete_Class".)
  4277. * Use your &php.ini;, ini_set or &htaccess;
  4278. * to define 'unserialize_callback_func'. Everytime an undefined class
  4279. * should be instantiated, it'll be called. To disable this feature just
  4280. * empty this setting.
  4281. * </p>
  4282. * </p>
  4283. * @return mixed The converted value is returned, and can be a boolean,
  4284. * integer, float, string,
  4285. * array or object.
  4286. * </p>
  4287. * <p>
  4288. * In case the passed string is not unserializeable, false is returned and
  4289. * E_NOTICE is issued.
  4290. */
  4291. function unserialize ($str) {}
  4292. /**
  4293. * Dumps information about a variable
  4294. * @link http://www.php.net/manual/en/function.var-dump.php
  4295. * @param expression mixed <p>
  4296. * The variable you want to dump.
  4297. * </p>
  4298. * @param _ mixed[optional]
  4299. * @return void
  4300. */
  4301. function var_dump ($expression, $_ = null) {}
  4302. /**
  4303. * Outputs or returns a parsable string representation of a variable
  4304. * @link http://www.php.net/manual/en/function.var-export.php
  4305. * @param expression mixed <p>
  4306. * The variable you want to export.
  4307. * </p>
  4308. * @param return bool[optional] <p>
  4309. * If used and set to true, var_export will return
  4310. * the variable representation instead of outputing it.
  4311. * </p>
  4312. * @return mixed the variable representation when the return
  4313. * parameter is used and evaluates to true. Otherwise, this function will
  4314. * return &null;.
  4315. */
  4316. function var_export ($expression, $return = null) {}
  4317. /**
  4318. * Dumps a string representation of an internal zend value to output
  4319. * @link http://www.php.net/manual/en/function.debug-zval-dump.php
  4320. * @param variable mixed <p>
  4321. * The variable being evaluated.
  4322. * </p>
  4323. * @return void
  4324. */
  4325. function debug_zval_dump ($variable) {}
  4326. /**
  4327. * Prints human-readable information about a variable
  4328. * @link http://www.php.net/manual/en/function.print-r.php
  4329. * @param expression mixed <p>
  4330. * The expression to be printed.
  4331. * </p>
  4332. * @param return bool[optional] <p>
  4333. * If you would like to capture the output of print_r,
  4334. * use the return parameter. When this parameter is set
  4335. * to true, print_r will return the information rather than print it.
  4336. * </p>
  4337. * @return mixed If given a string, integer or float,
  4338. * the value itself will be printed. If given an array, values
  4339. * will be presented in a format that shows keys and elements. Similar
  4340. * notation is used for objects.
  4341. * </p>
  4342. * <p>
  4343. * When the return parameter is true, this function
  4344. * will return a string. Otherwise, the return value is true.
  4345. */
  4346. function print_r ($expression, $return = null) {}
  4347. /**
  4348. * Returns the amount of memory allocated to PHP
  4349. * @link http://www.php.net/manual/en/function.memory-get-usage.php
  4350. * @param real_usage bool[optional] <p>
  4351. * Set this to true to get the real size of memory allocated from
  4352. * system. If not set or false only the memory used by
  4353. * emalloc() is reported.
  4354. * </p>
  4355. * @return int the memory amount in bytes.
  4356. */
  4357. function memory_get_usage ($real_usage = null) {}
  4358. /**
  4359. * Returns the peak of memory allocated by PHP
  4360. * @link http://www.php.net/manual/en/function.memory-get-peak-usage.php
  4361. * @param real_usage bool[optional] <p>
  4362. * Set this to true to get the real size of memory allocated from
  4363. * system. If not set or false only the memory used by
  4364. * emalloc() is reported.
  4365. * </p>
  4366. * @return int the memory peak in bytes.
  4367. */
  4368. function memory_get_peak_usage ($real_usage = null) {}
  4369. /**
  4370. * Register a function for execution on shutdown
  4371. * @link http://www.php.net/manual/en/function.register-shutdown-function.php
  4372. * @param callback callback <p>
  4373. * The shutdown callback to register.
  4374. * </p>
  4375. * <p>
  4376. * The shutdown callbacks are executed as the part of the request, so
  4377. * it's possible to send output from them and access output buffers.
  4378. * </p>
  4379. * @param parameter mixed[optional] <p>
  4380. * It is possible to pass parameters to the shutdown function by passing
  4381. * additional parameters.
  4382. * </p>
  4383. * @param _ mixed[optional]
  4384. * @return void
  4385. */
  4386. function register_shutdown_function ($callback, $parameter = null, $_ = null) {}
  4387. /**
  4388. * Register a function for execution on each tick
  4389. * @link http://www.php.net/manual/en/function.register-tick-function.php
  4390. * @param function callback <p>
  4391. * The function name as a string, or an array consisting of an object and
  4392. * a method.
  4393. * </p>
  4394. * @param arg mixed[optional] <p>
  4395. * </p>
  4396. * @param _ mixed[optional]
  4397. * @return bool Returns true on success or false on failure.
  4398. */
  4399. function register_tick_function ($function, $arg = null, $_ = null) {}
  4400. /**
  4401. * De-register a function for execution on each tick
  4402. * @link http://www.php.net/manual/en/function.unregister-tick-function.php
  4403. * @param function_name string <p>
  4404. * The function name, as a string.
  4405. * </p>
  4406. * @return void
  4407. */
  4408. function unregister_tick_function ($function_name) {}
  4409. /**
  4410. * Syntax highlighting of a file
  4411. * @link http://www.php.net/manual/en/function.highlight-file.php
  4412. * @param filename string <p>
  4413. * Path to the PHP file to be highlighted.
  4414. * </p>
  4415. * @param return bool[optional] <p>
  4416. * Set this parameter to true to make this function return the
  4417. * highlighted code.
  4418. * </p>
  4419. * @return mixed If return is set to true, returns the highlighted
  4420. * code as a string instead of printing it out. Otherwise, it will return
  4421. * true on success, false on failure.
  4422. */
  4423. function highlight_file ($filename, $return = null) {}
  4424. /**
  4425. * &Alias; <function>highlight_file</function>
  4426. * @link http://www.php.net/manual/en/function.show-source.php
  4427. * @param file_name
  4428. * @param return[optional]
  4429. */
  4430. function show_source ($file_name, $return) {}
  4431. /**
  4432. * Syntax highlighting of a string
  4433. * @link http://www.php.net/manual/en/function.highlight-string.php
  4434. * @param str string <p>
  4435. * The PHP code to be highlighted. This should include the opening tag.
  4436. * </p>
  4437. * @param return bool[optional] <p>
  4438. * Set this parameter to true to make this function return the
  4439. * highlighted code.
  4440. * </p>
  4441. * @return mixed If return is set to true, returns the highlighted
  4442. * code as a string instead of printing it out. Otherwise, it will return
  4443. * true on success, false on failure.
  4444. */
  4445. function highlight_string ($str, $return = null) {}
  4446. /**
  4447. * Return source with stripped comments and whitespace
  4448. * @link http://www.php.net/manual/en/function.php-strip-whitespace.php
  4449. * @param filename string <p>
  4450. * Path to the PHP file.
  4451. * </p>
  4452. * @return string The stripped source code will be returned on success, or an empty string
  4453. * on failure.
  4454. * </p>
  4455. * <p>
  4456. * This function works as described as of PHP 5.0.1. Before this it would
  4457. * only return an empty string. For more information on this bug and its
  4458. * prior behavior, see bug report
  4459. * #29606.
  4460. */
  4461. function php_strip_whitespace ($filename) {}
  4462. /**
  4463. * Gets the value of a configuration option
  4464. * @link http://www.php.net/manual/en/function.ini-get.php
  4465. * @param varname string <p>
  4466. * The configuration option name.
  4467. * </p>
  4468. * @return string the value of the configuration option as a string on success, or an
  4469. * empty string for null values. Returns false if the
  4470. * configuration option doesn't exist.
  4471. */
  4472. function ini_get ($varname) {}
  4473. /**
  4474. * Gets all configuration options
  4475. * @link http://www.php.net/manual/en/function.ini-get-all.php
  4476. * @param extension string[optional] <p>
  4477. * An optional extension name. If set, the function return only options
  4478. * specific for that extension.
  4479. * </p>
  4480. * @param details bool[optional] <p>
  4481. * Retrieve details settings or only the current value for each setting.
  4482. * Default is true (retrieve details).
  4483. * </p>
  4484. * @return array an associative array with directive name as the array key.
  4485. * </p>
  4486. * <p>
  4487. * When details is true (default) the array will
  4488. * contain global_value (set in
  4489. * &php.ini;), local_value (perhaps set with
  4490. * ini_set or &htaccess;), and
  4491. * access (the access level).
  4492. * </p>
  4493. * <p>
  4494. * When details is false the value will be the
  4495. * current value of the option.
  4496. * </p>
  4497. * <p>
  4498. * See the manual section
  4499. * for information on what access levels mean.
  4500. * </p>
  4501. * <p>
  4502. * It's possible for a directive to have multiple access levels, which is
  4503. * why access shows the appropriate bitmask values.
  4504. */
  4505. function ini_get_all ($extension = null, $details = null) {}
  4506. /**
  4507. * Sets the value of a configuration option
  4508. * @link http://www.php.net/manual/en/function.ini-set.php
  4509. * @param varname string <p>
  4510. * </p>
  4511. * <p>
  4512. * Not all the available options can be changed using
  4513. * ini_set. There is a list of all available options
  4514. * in the appendix.
  4515. * </p>
  4516. * @param newvalue string <p>
  4517. * The new value for the option.
  4518. * </p>
  4519. * @return string the old value on success, false on failure.
  4520. */
  4521. function ini_set ($varname, $newvalue) {}
  4522. /**
  4523. * &Alias; <function>ini_set</function>
  4524. * @link http://www.php.net/manual/en/function.ini-alter.php
  4525. * @param varname
  4526. * @param newvalue
  4527. */
  4528. function ini_alter ($varname, $newvalue) {}
  4529. /**
  4530. * Restores the value of a configuration option
  4531. * @link http://www.php.net/manual/en/function.ini-restore.php
  4532. * @param varname string <p>
  4533. * The configuration option name.
  4534. * </p>
  4535. * @return void
  4536. */
  4537. function ini_restore ($varname) {}
  4538. /**
  4539. * Gets the current include_path configuration option
  4540. * @link http://www.php.net/manual/en/function.get-include-path.php
  4541. * @return string the path, as a string.
  4542. */
  4543. function get_include_path () {}
  4544. /**
  4545. * Sets the include_path configuration option
  4546. * @link http://www.php.net/manual/en/function.set-include-path.php
  4547. * @param new_include_path string <p>
  4548. * The new value for the include_path
  4549. * </p>
  4550. * @return string the old include_path on
  4551. * success&return.falseforfailure;.
  4552. */
  4553. function set_include_path ($new_include_path) {}
  4554. /**
  4555. * Restores the value of the include_path configuration option
  4556. * @link http://www.php.net/manual/en/function.restore-include-path.php
  4557. * @return void
  4558. */
  4559. function restore_include_path () {}
  4560. /**
  4561. * Send a cookie
  4562. * @link http://www.php.net/manual/en/function.setcookie.php
  4563. * @param name string <p>
  4564. * The name of the cookie.
  4565. * </p>
  4566. * @param value string[optional] <p>
  4567. * The value of the cookie. This value is stored on the clients computer;
  4568. * do not store sensitive information. Assuming the
  4569. * name is 'cookiename', this
  4570. * value is retrieved through $_COOKIE['cookiename']
  4571. * </p>
  4572. * @param expire int[optional] <p>
  4573. * The time the cookie expires. This is a Unix timestamp so is
  4574. * in number of seconds since the epoch. In other words, you'll
  4575. * most likely set this with the time function
  4576. * plus the number of seconds before you want it to expire. Or
  4577. * you might use mktime.
  4578. * time()+60*60*24*30 will set the cookie to
  4579. * expire in 30 days. If set to 0, or omitted, the cookie will expire at
  4580. * the end of the session (when the browser closes).
  4581. * </p>
  4582. * <p>
  4583. * <p>
  4584. * You may notice the expire parameter takes on a
  4585. * Unix timestamp, as opposed to the date format Wdy, DD-Mon-YYYY
  4586. * HH:MM:SS GMT, this is because PHP does this conversion
  4587. * internally.
  4588. * </p>
  4589. * </p>
  4590. * @param path string[optional] <p>
  4591. * The path on the server in which the cookie will be available on.
  4592. * If set to '/', the cookie will be available
  4593. * within the entire domain. If set to
  4594. * '/foo/', the cookie will only be available
  4595. * within the /foo/ directory and all
  4596. * sub-directories such as /foo/bar/ of
  4597. * domain. The default value is the
  4598. * current directory that the cookie is being set in.
  4599. * </p>
  4600. * @param domain string[optional] <p>
  4601. * The domain that the cookie is available to. Setting the domain to
  4602. * 'www.example.com' will make the cookie
  4603. * available in the www subdomain and higher subdomains.
  4604. * Cookies available to a lower domain, such as
  4605. * 'example.com' will be available to higher subdomains,
  4606. * such as 'www.example.com'.
  4607. * Older browsers still implementing the deprecated
  4608. * RFC 2109 may require a leading
  4609. * . to match all subdomains.
  4610. * </p>
  4611. * @param secure bool[optional] <p>
  4612. * Indicates that the cookie should only be transmitted over a
  4613. * secure HTTPS connection from the client. When set to true, the
  4614. * cookie will only be set if a secure connection exists.
  4615. * On the server-side, it's on the programmer to send this
  4616. * kind of cookie only on secure connection (e.g. with respect to
  4617. * $_SERVER["HTTPS"]).
  4618. * </p>
  4619. * @param httponly bool[optional] <p>
  4620. * When true the cookie will be made accessible only through the HTTP
  4621. * protocol. This means that the cookie won't be accessible by
  4622. * scripting languages, such as JavaScript. It has been suggested that
  4623. * this setting can effectively help to reduce identity theft through
  4624. * XSS attacks (although it is not supported by all browsers), but that
  4625. * claim is often disputed. Added in PHP 5.2.0.
  4626. * true or false
  4627. * </p>
  4628. * @return bool If output exists prior to calling this function,
  4629. * setcookie will fail and return false. If
  4630. * setcookie successfully runs, it will return true.
  4631. * This does not indicate whether the user accepted the cookie.
  4632. */
  4633. function setcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  4634. /**
  4635. * Send a cookie without urlencoding the cookie value
  4636. * @link http://www.php.net/manual/en/function.setrawcookie.php
  4637. * @param name string
  4638. * @param value string[optional]
  4639. * @param expire int[optional]
  4640. * @param path string[optional]
  4641. * @param domain string[optional]
  4642. * @param secure bool[optional]
  4643. * @param httponly bool[optional]
  4644. * @return bool Returns true on success or false on failure.
  4645. */
  4646. function setrawcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  4647. /**
  4648. * Send a raw HTTP header
  4649. * @link http://www.php.net/manual/en/function.header.php
  4650. * @param string string <p>
  4651. * The header string.
  4652. * </p>
  4653. * <p>
  4654. * There are two special-case header calls. The first is a header
  4655. * that starts with the string "HTTP/" (case is not
  4656. * significant), which will be used to figure out the HTTP status
  4657. * code to send. For example, if you have configured Apache to
  4658. * use a PHP script to handle requests for missing files (using
  4659. * the ErrorDocument directive), you may want to
  4660. * make sure that your script generates the proper status code.
  4661. * </p>
  4662. * <p>
  4663. * ]]>
  4664. * </p>
  4665. * <p>
  4666. * For FastCGI you must use the following for a 404 response:
  4667. * ]]>
  4668. * </p>
  4669. * <p>
  4670. * The second special case is the "Location:" header. Not only does
  4671. * it send this header back to the browser, but it also returns a
  4672. * REDIRECT (302) status code to the browser
  4673. * unless the 201 or
  4674. * a 3xx status code has already been set.
  4675. * </p>
  4676. * <p>
  4677. * ]]>
  4678. * </p>
  4679. * @param replace bool[optional] <p>
  4680. * The optional replace parameter indicates
  4681. * whether the header should replace a previous similar header, or
  4682. * add a second header of the same type. By default it will replace,
  4683. * but if you pass in false as the second argument you can force
  4684. * multiple headers of the same type. For example:
  4685. * </p>
  4686. * <p>
  4687. * ]]>
  4688. * </p>
  4689. * @param http_response_code int[optional] <p>
  4690. * Forces the HTTP response code to the specified value. Note that this
  4691. * parameter only has an effect if the string is
  4692. * not empty.
  4693. * </p>
  4694. * @return void
  4695. */
  4696. function header ($string, $replace = null, $http_response_code = null) {}
  4697. /**
  4698. * Remove previously set headers
  4699. * @link http://www.php.net/manual/en/function.header-remove.php
  4700. * @param name string[optional] <p>
  4701. * The header name to be removed.
  4702. * </p>
  4703. * This parameter is case-insensitive.
  4704. * @return void
  4705. */
  4706. function header_remove ($name = null) {}
  4707. /**
  4708. * Checks if or where headers have been sent
  4709. * @link http://www.php.net/manual/en/function.headers-sent.php
  4710. * @param file string[optional] <p>
  4711. * If the optional file and
  4712. * line parameters are set,
  4713. * headers_sent will put the PHP source file name
  4714. * and line number where output started in the file
  4715. * and line variables.
  4716. * </p>
  4717. * @param line int[optional] <p>
  4718. * The line number where the output started.
  4719. * </p>
  4720. * @return bool headers_sent will return false if no HTTP headers
  4721. * have already been sent or true otherwise.
  4722. */
  4723. function headers_sent (&$file = null, &$line = null) {}
  4724. /**
  4725. * Returns a list of response headers sent (or ready to send)
  4726. * @link http://www.php.net/manual/en/function.headers-list.php
  4727. * @return array a numerically indexed array of headers.
  4728. */
  4729. function headers_list () {}
  4730. /**
  4731. * Get or Set the HTTP response code
  4732. * @link http://www.php.net/manual/en/function.http-response-code.php
  4733. * @param response_code int[optional] <p>
  4734. * The optional response_code will set the response code.
  4735. * </p>
  4736. * <p>
  4737. * ]]>
  4738. * </p>
  4739. * @return int The current response code. By default the return value is int(200).
  4740. */
  4741. function http_response_code ($response_code = null) {}
  4742. /**
  4743. * Check whether client disconnected
  4744. * @link http://www.php.net/manual/en/function.connection-aborted.php
  4745. * @return int 1 if client disconnected, 0 otherwise.
  4746. */
  4747. function connection_aborted () {}
  4748. /**
  4749. * Returns connection status bitfield
  4750. * @link http://www.php.net/manual/en/function.connection-status.php
  4751. * @return int the connection status bitfield, which can be used against the
  4752. * CONNECTION_XXX constants to determine the connection
  4753. * status.
  4754. */
  4755. function connection_status () {}
  4756. /**
  4757. * Set whether a client disconnect should abort script execution
  4758. * @link http://www.php.net/manual/en/function.ignore-user-abort.php
  4759. * @param value string[optional] <p>
  4760. * If set, this function will set the ignore_user_abort ini setting
  4761. * to the given value. If not, this function will
  4762. * only return the previous setting without changing it.
  4763. * </p>
  4764. * @return int the previous setting, as an integer.
  4765. */
  4766. function ignore_user_abort ($value = null) {}
  4767. /**
  4768. * Parse a configuration file
  4769. * @link http://www.php.net/manual/en/function.parse-ini-file.php
  4770. * @param filename string <p>
  4771. * The filename of the ini file being parsed.
  4772. * </p>
  4773. * @param process_sections bool[optional] <p>
  4774. * By setting the process_sections
  4775. * parameter to true, you get a multidimensional array, with
  4776. * the section names and settings included. The default
  4777. * for process_sections is false
  4778. * </p>
  4779. * @param scanner_mode int[optional] <p>
  4780. * Can either be INI_SCANNER_NORMAL (default) or
  4781. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  4782. * is supplied, then option values will not be parsed.
  4783. * </p>
  4784. * @return array The settings are returned as an associative array on success,
  4785. * and false on failure.
  4786. */
  4787. function parse_ini_file ($filename, $process_sections = null, $scanner_mode = null) {}
  4788. /**
  4789. * Parse a configuration string
  4790. * @link http://www.php.net/manual/en/function.parse-ini-string.php
  4791. * @param ini string <p>
  4792. * The contents of the ini file being parsed.
  4793. * </p>
  4794. * @param process_sections bool[optional] <p>
  4795. * By setting the process_sections
  4796. * parameter to true, you get a multidimensional array, with
  4797. * the section names and settings included. The default
  4798. * for process_sections is false
  4799. * </p>
  4800. * @param scanner_mode int[optional] <p>
  4801. * Can either be INI_SCANNER_NORMAL (default) or
  4802. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  4803. * is supplied, then option values will not be parsed.
  4804. * </p>
  4805. * @return array The settings are returned as an associative array on success,
  4806. * and false on failure.
  4807. */
  4808. function parse_ini_string ($ini, $process_sections = null, $scanner_mode = null) {}
  4809. /**
  4810. * Tells whether the file was uploaded via HTTP POST
  4811. * @link http://www.php.net/manual/en/function.is-uploaded-file.php
  4812. * @param filename string <p>
  4813. * The filename being checked.
  4814. * </p>
  4815. * @return bool Returns true on success or false on failure.
  4816. */
  4817. function is_uploaded_file ($filename) {}
  4818. /**
  4819. * Moves an uploaded file to a new location
  4820. * @link http://www.php.net/manual/en/function.move-uploaded-file.php
  4821. * @param filename string <p>
  4822. * The filename of the uploaded file.
  4823. * </p>
  4824. * @param destination string <p>
  4825. * The destination of the moved file.
  4826. * </p>
  4827. * @return bool true on success.
  4828. * </p>
  4829. * <p>
  4830. * If filename is not a valid upload file,
  4831. * then no action will occur, and
  4832. * move_uploaded_file will return
  4833. * false.
  4834. * </p>
  4835. * <p>
  4836. * If filename is a valid upload file, but
  4837. * cannot be moved for some reason, no action will occur, and
  4838. * move_uploaded_file will return
  4839. * false. Additionally, a warning will be issued.
  4840. */
  4841. function move_uploaded_file ($filename, $destination) {}
  4842. /**
  4843. * Get the Internet host name corresponding to a given IP address
  4844. * @link http://www.php.net/manual/en/function.gethostbyaddr.php
  4845. * @param ip_address string <p>
  4846. * The host IP address.
  4847. * </p>
  4848. * @return string the host name on success, the unmodified ip_address
  4849. * on failure, or false on malformed input.
  4850. */
  4851. function gethostbyaddr ($ip_address) {}
  4852. /**
  4853. * Get the IPv4 address corresponding to a given Internet host name
  4854. * @link http://www.php.net/manual/en/function.gethostbyname.php
  4855. * @param hostname string <p>
  4856. * The host name.
  4857. * </p>
  4858. * @return string the IPv4 address or a string containing the unmodified
  4859. * hostname on failure.
  4860. */
  4861. function gethostbyname ($hostname) {}
  4862. /**
  4863. * Get a list of IPv4 addresses corresponding to a given Internet host
  4864. name
  4865. * @link http://www.php.net/manual/en/function.gethostbynamel.php
  4866. * @param hostname string <p>
  4867. * The host name.
  4868. * </p>
  4869. * @return array an array of IPv4 addresses or false if
  4870. * hostname could not be resolved.
  4871. */
  4872. function gethostbynamel ($hostname) {}
  4873. /**
  4874. * Gets the host name
  4875. * @link http://www.php.net/manual/en/function.gethostname.php
  4876. * @return string a string with the hostname on success, otherwise false is
  4877. * returned.
  4878. */
  4879. function gethostname () {}
  4880. /**
  4881. * &Alias; <function>checkdnsrr</function>
  4882. * @link http://www.php.net/manual/en/function.dns-check-record.php
  4883. * @param host
  4884. * @param type[optional]
  4885. */
  4886. function dns_check_record ($host, $type) {}
  4887. /**
  4888. * Check DNS records corresponding to a given Internet host name or IP address
  4889. * @link http://www.php.net/manual/en/function.checkdnsrr.php
  4890. * @param host string <p>
  4891. * host may either be the IP address in
  4892. * dotted-quad notation or the host name.
  4893. * </p>
  4894. * @param type string[optional] <p>
  4895. * type may be any one of: A, MX, NS, SOA,
  4896. * PTR, CNAME, AAAA, A6, SRV, NAPTR, TXT or ANY.
  4897. * </p>
  4898. * @return bool true if any records are found; returns false if no records
  4899. * were found or if an error occurred.
  4900. */
  4901. function checkdnsrr ($host, $type = null) {}
  4902. /**
  4903. * &Alias; <function>getmxrr</function>
  4904. * @link http://www.php.net/manual/en/function.dns-get-mx.php
  4905. * @param hostname
  4906. * @param mxhosts
  4907. * @param weight[optional]
  4908. */
  4909. function dns_get_mx ($hostname, &$mxhosts, &$weight) {}
  4910. /**
  4911. * Get MX records corresponding to a given Internet host name
  4912. * @link http://www.php.net/manual/en/function.getmxrr.php
  4913. * @param hostname string <p>
  4914. * The Internet host name.
  4915. * </p>
  4916. * @param mxhosts array <p>
  4917. * A list of the MX records found is placed into the array
  4918. * mxhosts.
  4919. * </p>
  4920. * @param weight array[optional] <p>
  4921. * If the weight array is given, it will be filled
  4922. * with the weight information gathered.
  4923. * </p>
  4924. * @return bool true if any records are found; returns false if no records
  4925. * were found or if an error occurred.
  4926. */
  4927. function getmxrr ($hostname, array &$mxhosts, array &$weight = null) {}
  4928. /**
  4929. * Fetch DNS Resource Records associated with a hostname
  4930. * @link http://www.php.net/manual/en/function.dns-get-record.php
  4931. * @param hostname string <p>
  4932. * hostname should be a valid DNS hostname such
  4933. * as "www.example.com". Reverse lookups can be generated
  4934. * using in-addr.arpa notation, but
  4935. * gethostbyaddr is more suitable for
  4936. * the majority of reverse lookups.
  4937. * </p>
  4938. * <p>
  4939. * Per DNS standards, email addresses are given in user.host format (for
  4940. * example: hostmaster.example.com as opposed to hostmaster@example.com),
  4941. * be sure to check this value and modify if necessary before using it
  4942. * with a functions such as mail.
  4943. * </p>
  4944. * @param type int[optional] <p>
  4945. * By default, dns_get_record will search for any
  4946. * resource records associated with hostname.
  4947. * To limit the query, specify the optional type
  4948. * parameter. May be any one of the following:
  4949. * DNS_A, DNS_CNAME,
  4950. * DNS_HINFO, DNS_MX,
  4951. * DNS_NS, DNS_PTR,
  4952. * DNS_SOA, DNS_TXT,
  4953. * DNS_AAAA, DNS_SRV,
  4954. * DNS_NAPTR, DNS_A6,
  4955. * DNS_ALL or DNS_ANY.
  4956. * </p>
  4957. * <p>
  4958. * Because of eccentricities in the performance of libresolv
  4959. * between platforms, DNS_ANY will not
  4960. * always return every record, the slower DNS_ALL
  4961. * will collect all records more reliably.
  4962. * </p>
  4963. * @param authns array[optional] <p>
  4964. * Passed by reference and, if given, will be populated with Resource
  4965. * Records for the Authoritative Name Servers.
  4966. * </p>
  4967. * @param addtl array[optional] <p>
  4968. * Passed by reference and, if given, will be populated with any
  4969. * Additional Records.
  4970. * </p>
  4971. * @return array This function returns an array of associative arrays,
  4972. * &return.falseforfailure;. Each associative array contains
  4973. * at minimum the following keys:
  4974. * <table>
  4975. * Basic DNS attributes
  4976. * <tr valign="top">
  4977. * <td>Attribute</td>
  4978. * <td>Meaning</td>
  4979. * </tr>
  4980. * <tr valign="top">
  4981. * <td>host</td>
  4982. * <td>
  4983. * The record in the DNS namespace to which the rest of the associated data refers.
  4984. * </td>
  4985. * </tr>
  4986. * <tr valign="top">
  4987. * <td>class</td>
  4988. * <td>
  4989. * dns_get_record only returns Internet class records and as
  4990. * such this parameter will always return IN.
  4991. * </td>
  4992. * </tr>
  4993. * <tr valign="top">
  4994. * <td>type</td>
  4995. * <td>
  4996. * String containing the record type. Additional attributes will also be contained
  4997. * in the resulting array dependant on the value of type. See table below.
  4998. * </td>
  4999. * </tr>
  5000. * <tr valign="top">
  5001. * <td>ttl</td>
  5002. * <td>
  5003. * "Time To Live" remaining for this record. This will not equal
  5004. * the record's original ttl, but will rather equal the original ttl minus whatever
  5005. * length of time has passed since the authoritative name server was queried.
  5006. * </td>
  5007. * </tr>
  5008. * </table>
  5009. * </p>
  5010. * <p>
  5011. * <table>
  5012. * Other keys in associative arrays dependant on 'type'
  5013. * <tr valign="top">
  5014. * <td>Type</td>
  5015. * <td>Extra Columns</td>
  5016. * </tr>
  5017. * <tr valign="top">
  5018. * <td>A</td>
  5019. * <td>
  5020. * ip: An IPv4 addresses in dotted decimal notation.
  5021. * </td>
  5022. * </tr>
  5023. * <tr valign="top">
  5024. * <td>MX</td>
  5025. * <td>
  5026. * pri: Priority of mail exchanger.
  5027. * Lower numbers indicate greater priority.
  5028. * target: FQDN of the mail exchanger.
  5029. * See also dns_get_mx.
  5030. * </td>
  5031. * </tr>
  5032. * <tr valign="top">
  5033. * <td>CNAME</td>
  5034. * <td>
  5035. * target: FQDN of location in DNS namespace to which
  5036. * the record is aliased.
  5037. * </td>
  5038. * </tr>
  5039. * <tr valign="top">
  5040. * <td>NS</td>
  5041. * <td>
  5042. * target: FQDN of the name server which is authoritative
  5043. * for this hostname.
  5044. * </td>
  5045. * </tr>
  5046. * <tr valign="top">
  5047. * <td>PTR</td>
  5048. * <td>
  5049. * target: Location within the DNS namespace to which
  5050. * this record points.
  5051. * </td>
  5052. * </tr>
  5053. * <tr valign="top">
  5054. * <td>TXT</td>
  5055. * <td>
  5056. * txt: Arbitrary string data associated with this record.
  5057. * </td>
  5058. * </tr>
  5059. * <tr valign="top">
  5060. * <td>HINFO</td>
  5061. * <td>
  5062. * cpu: IANA number designating the CPU of the machine
  5063. * referenced by this record.
  5064. * os: IANA number designating the Operating System on
  5065. * the machine referenced by this record.
  5066. * See IANA's Operating System
  5067. * Names for the meaning of these values.
  5068. * </td>
  5069. * </tr>
  5070. * <tr valign="top">
  5071. * <td>SOA</td>
  5072. * <td>
  5073. * mname: FQDN of the machine from which the resource
  5074. * records originated.
  5075. * rname: Email address of the administrative contain
  5076. * for this domain.
  5077. * serial: Serial # of this revision of the requested
  5078. * domain.
  5079. * refresh: Refresh interval (seconds) secondary name
  5080. * servers should use when updating remote copies of this domain.
  5081. * retry: Length of time (seconds) to wait after a
  5082. * failed refresh before making a second attempt.
  5083. * expire: Maximum length of time (seconds) a secondary
  5084. * DNS server should retain remote copies of the zone data without a
  5085. * successful refresh before discarding.
  5086. * minimum-ttl: Minimum length of time (seconds) a
  5087. * client can continue to use a DNS resolution before it should request
  5088. * a new resolution from the server. Can be overridden by individual
  5089. * resource records.
  5090. * </td>
  5091. * </tr>
  5092. * <tr valign="top">
  5093. * <td>AAAA</td>
  5094. * <td>
  5095. * ipv6: IPv6 address
  5096. * </td>
  5097. * </tr>
  5098. * <tr valign="top">
  5099. * <td>A6(PHP &gt;= 5.1.0)</td>
  5100. * <td>
  5101. * masklen: Length (in bits) to inherit from the target
  5102. * specified by chain.
  5103. * ipv6: Address for this specific record to merge with
  5104. * chain.
  5105. * chain: Parent record to merge with
  5106. * ipv6 data.
  5107. * </td>
  5108. * </tr>
  5109. * <tr valign="top">
  5110. * <td>SRV</td>
  5111. * <td>
  5112. * pri: (Priority) lowest priorities should be used first.
  5113. * weight: Ranking to weight which of commonly prioritized
  5114. * targets should be chosen at random.
  5115. * target and port: hostname and port
  5116. * where the requested service can be found.
  5117. * For additional information see: RFC 2782
  5118. * </td>
  5119. * </tr>
  5120. * <tr valign="top">
  5121. * <td>NAPTR</td>
  5122. * <td>
  5123. * order and pref: Equivalent to
  5124. * pri and weight above.
  5125. * flags, services, regex,
  5126. * and replacement: Parameters as defined by
  5127. * RFC 2915.
  5128. * </td>
  5129. * </tr>
  5130. * </table>
  5131. */
  5132. function dns_get_record ($hostname, $type = null, array &$authns = null, array &$addtl = null) {}
  5133. /**
  5134. * Get the integer value of a variable
  5135. * @link http://www.php.net/manual/en/function.intval.php
  5136. * @param var mixed <p>
  5137. * The scalar value being converted to an integer
  5138. * </p>
  5139. * @param base int[optional] <p>
  5140. * The base for the conversion
  5141. * </p>
  5142. * @return int The integer value of var on success, or 0 on
  5143. * failure. Empty arrays return 0, non-empty arrays return 1.
  5144. * </p>
  5145. * <p>
  5146. * The maximum value depends on the system. 32 bit systems have a
  5147. * maximum signed integer range of -2147483648 to 2147483647. So for example
  5148. * on such a system, intval('1000000000000') will return
  5149. * 2147483647. The maximum signed integer value for 64 bit systems is
  5150. * 9223372036854775807.
  5151. * </p>
  5152. * <p>
  5153. * Strings will most likely return 0 although this depends on the
  5154. * leftmost characters of the string. The common rules of
  5155. * integer casting
  5156. * apply.
  5157. */
  5158. function intval ($var, $base = null) {}
  5159. /**
  5160. * Get float value of a variable
  5161. * @link http://www.php.net/manual/en/function.floatval.php
  5162. * @param var mixed <p>
  5163. * May be any scalar type. floatval should not be used
  5164. * on objects, as doing so will emit an E_NOTICE level
  5165. * error and return 1.
  5166. * </p>
  5167. * @return float The float value of the given variable. Empty arrays return 0, non-empty
  5168. * arrays return 1.
  5169. */
  5170. function floatval ($var) {}
  5171. /**
  5172. * &Alias; <function>floatval</function>
  5173. * @link http://www.php.net/manual/en/function.doubleval.php
  5174. * @param var
  5175. */
  5176. function doubleval ($var) {}
  5177. /**
  5178. * Get string value of a variable
  5179. * @link http://www.php.net/manual/en/function.strval.php
  5180. * @param var mixed <p>
  5181. * The variable that is being converted to a string.
  5182. * </p>
  5183. * <p>
  5184. * var may be any scalar type or an object that
  5185. * implements the __toString()
  5186. * method. You cannot use strval on arrays or on
  5187. * objects that do not implement the
  5188. * __toString() method.
  5189. * </p>
  5190. * @return string The string value of var.
  5191. */
  5192. function strval ($var) {}
  5193. /**
  5194. * Get the type of a variable
  5195. * @link http://www.php.net/manual/en/function.gettype.php
  5196. * @param var mixed <p>
  5197. * The variable being type checked.
  5198. * </p>
  5199. * @return string Possibles values for the returned string are:
  5200. * "boolean"
  5201. * "integer"
  5202. * "double" (for historical reasons "double" is
  5203. * returned in case of a float, and not simply
  5204. * "float")
  5205. * "string"
  5206. * "array"
  5207. * "object"
  5208. * "resource"
  5209. * "NULL"
  5210. * "unknown type"
  5211. */
  5212. function gettype ($var) {}
  5213. /**
  5214. * Set the type of a variable
  5215. * @link http://www.php.net/manual/en/function.settype.php
  5216. * @param var mixed <p>
  5217. * The variable being converted.
  5218. * </p>
  5219. * @param type string <p>
  5220. * Possibles values of type are:
  5221. * "boolean" (or, since PHP 4.2.0, "bool")
  5222. * @return bool Returns true on success or false on failure.
  5223. */
  5224. function settype (&$var, $type) {}
  5225. /**
  5226. * Finds whether a variable is &null;
  5227. * @link http://www.php.net/manual/en/function.is-null.php
  5228. * @param var mixed <p>
  5229. * The variable being evaluated.
  5230. * </p>
  5231. * @return bool true if var is null, false
  5232. * otherwise.
  5233. */
  5234. function is_null ($var) {}
  5235. /**
  5236. * Finds whether a variable is a resource
  5237. * @link http://www.php.net/manual/en/function.is-resource.php
  5238. * @param var mixed <p>
  5239. * The variable being evaluated.
  5240. * </p>
  5241. * @return bool true if var is a resource,
  5242. * false otherwise.
  5243. */
  5244. function is_resource ($var) {}
  5245. /**
  5246. * Finds out whether a variable is a boolean
  5247. * @link http://www.php.net/manual/en/function.is-bool.php
  5248. * @param var mixed <p>
  5249. * The variable being evaluated.
  5250. * </p>
  5251. * @return bool true if var is a boolean,
  5252. * false otherwise.
  5253. */
  5254. function is_bool ($var) {}
  5255. /**
  5256. * &Alias; <function>is_int</function>
  5257. * @link http://www.php.net/manual/en/function.is-long.php
  5258. * @param var
  5259. */
  5260. function is_long ($var) {}
  5261. /**
  5262. * Finds whether the type of a variable is float
  5263. * @link http://www.php.net/manual/en/function.is-float.php
  5264. * @param var mixed <p>
  5265. * The variable being evaluated.
  5266. * </p>
  5267. * @return bool true if var is a float,
  5268. * false otherwise.
  5269. */
  5270. function is_float ($var) {}
  5271. /**
  5272. * Find whether the type of a variable is integer
  5273. * @link http://www.php.net/manual/en/function.is-int.php
  5274. * @param var mixed <p>
  5275. * The variable being evaluated.
  5276. * </p>
  5277. * @return bool true if var is an integer,
  5278. * false otherwise.
  5279. */
  5280. function is_int ($var) {}
  5281. /**
  5282. * &Alias; <function>is_int</function>
  5283. * @link http://www.php.net/manual/en/function.is-integer.php
  5284. * @param var
  5285. */
  5286. function is_integer ($var) {}
  5287. /**
  5288. * &Alias; <function>is_float</function>
  5289. * @link http://www.php.net/manual/en/function.is-double.php
  5290. * @param var
  5291. */
  5292. function is_double ($var) {}
  5293. /**
  5294. * &Alias; <function>is_float</function>
  5295. * @link http://www.php.net/manual/en/function.is-real.php
  5296. * @param var
  5297. */
  5298. function is_real ($var) {}
  5299. /**
  5300. * Finds whether a variable is a number or a numeric string
  5301. * @link http://www.php.net/manual/en/function.is-numeric.php
  5302. * @param var mixed <p>
  5303. * The variable being evaluated.
  5304. * </p>
  5305. * @return bool true if var is a number or a numeric
  5306. * string, false otherwise.
  5307. */
  5308. function is_numeric ($var) {}
  5309. /**
  5310. * Find whether the type of a variable is string
  5311. * @link http://www.php.net/manual/en/function.is-string.php
  5312. * @param var mixed <p>
  5313. * The variable being evaluated.
  5314. * </p>
  5315. * @return bool true if var is of type string,
  5316. * false otherwise.
  5317. */
  5318. function is_string ($var) {}
  5319. /**
  5320. * Finds whether a variable is an array
  5321. * @link http://www.php.net/manual/en/function.is-array.php
  5322. * @param var mixed <p>
  5323. * The variable being evaluated.
  5324. * </p>
  5325. * @return bool true if var is an array,
  5326. * false otherwise.
  5327. */
  5328. function is_array ($var) {}
  5329. /**
  5330. * Finds whether a variable is an object
  5331. * @link http://www.php.net/manual/en/function.is-object.php
  5332. * @param var mixed <p>
  5333. * The variable being evaluated.
  5334. * </p>
  5335. * @return bool true if var is an object,
  5336. * false otherwise.
  5337. */
  5338. function is_object ($var) {}
  5339. /**
  5340. * Finds whether a variable is a scalar
  5341. * @link http://www.php.net/manual/en/function.is-scalar.php
  5342. * @param var mixed <p>
  5343. * The variable being evaluated.
  5344. * </p>
  5345. * @return bool true if var is a scalar false
  5346. * otherwise.
  5347. */
  5348. function is_scalar ($var) {}
  5349. /**
  5350. * Verify that the contents of a variable can be called as a function
  5351. * @link http://www.php.net/manual/en/function.is-callable.php
  5352. * @param name callback <p>
  5353. * The callback function to check
  5354. * </p>
  5355. * @param syntax_only bool[optional] <p>
  5356. * If set to true the function only verifies that
  5357. * name might be a function or method. It will only
  5358. * reject simple variables that are not strings, or an array that does
  5359. * not have a valid structure to be used as a callback. The valid ones
  5360. * are supposed to have only 2 entries, the first of which is an object
  5361. * or a string, and the second a string.
  5362. * </p>
  5363. * @param callable_name string[optional] <p>
  5364. * Receives the "callable name". In the example below it is
  5365. * "someClass::someMethod". Note, however, that despite the implication
  5366. * that someClass::SomeMethod() is a callable static method, this is not
  5367. * the case.
  5368. * </p>
  5369. * @return bool true if name is callable, false
  5370. * otherwise.
  5371. */
  5372. function is_callable ($name, $syntax_only = null, &$callable_name = null) {}
  5373. /**
  5374. * Closes process file pointer
  5375. * @link http://www.php.net/manual/en/function.pclose.php
  5376. * @param handle resource <p>
  5377. * The file pointer must be valid, and must have been returned by a
  5378. * successful call to popen.
  5379. * </p>
  5380. * @return int the termination status of the process that was run. In case of
  5381. * an error then -1 is returned.
  5382. */
  5383. function pclose ($handle) {}
  5384. /**
  5385. * Opens process file pointer
  5386. * @link http://www.php.net/manual/en/function.popen.php
  5387. * @param command string <p>
  5388. * The command
  5389. * </p>
  5390. * @param mode string <p>
  5391. * The mode
  5392. * </p>
  5393. * @return resource a file pointer identical to that returned by
  5394. * fopen, except that it is unidirectional (may
  5395. * only be used for reading or writing) and must be closed with
  5396. * pclose. This pointer may be used with
  5397. * fgets, fgetss, and
  5398. * fwrite. When the mode is 'r', the returned
  5399. * file pointer equals to the STDOUT of the command, when the mode
  5400. * is 'w', the returned file pointer equals to the STDIN of the
  5401. * command.
  5402. * </p>
  5403. * <p>
  5404. * If an error occurs, returns false.
  5405. */
  5406. function popen ($command, $mode) {}
  5407. /**
  5408. * Outputs a file
  5409. * @link http://www.php.net/manual/en/function.readfile.php
  5410. * @param filename string <p>
  5411. * The filename being read.
  5412. * </p>
  5413. * @param use_include_path bool[optional] <p>
  5414. * You can use the optional second parameter and set it to true, if
  5415. * you want to search for the file in the include_path, too.
  5416. * </p>
  5417. * @param context resource[optional] <p>
  5418. * A context stream resource.
  5419. * </p>
  5420. * @return int the number of bytes read from the file. If an error
  5421. * occurs, false is returned and unless the function was called as
  5422. * @readfile, an error message is printed.
  5423. */
  5424. function readfile ($filename, $use_include_path = null, $context = null) {}
  5425. /**
  5426. * Rewind the position of a file pointer
  5427. * @link http://www.php.net/manual/en/function.rewind.php
  5428. * @param handle resource <p>
  5429. * The file pointer must be valid, and must point to a file
  5430. * successfully opened by fopen.
  5431. * </p>
  5432. * @return bool Returns true on success or false on failure.
  5433. */
  5434. function rewind ($handle) {}
  5435. /**
  5436. * Removes directory
  5437. * @link http://www.php.net/manual/en/function.rmdir.php
  5438. * @param dirname string <p>
  5439. * Path to the directory.
  5440. * </p>
  5441. * @param context resource[optional] &note.context-support;
  5442. * @return bool Returns true on success or false on failure.
  5443. */
  5444. function rmdir ($dirname, $context = null) {}
  5445. /**
  5446. * Changes the current umask
  5447. * @link http://www.php.net/manual/en/function.umask.php
  5448. * @param mask int[optional] <p>
  5449. * The new umask.
  5450. * </p>
  5451. * @return int umask without arguments simply returns the
  5452. * current umask otherwise the old umask is returned.
  5453. */
  5454. function umask ($mask = null) {}
  5455. /**
  5456. * Closes an open file pointer
  5457. * @link http://www.php.net/manual/en/function.fclose.php
  5458. * @param handle resource <p>
  5459. * The file pointer must be valid, and must point to a file successfully
  5460. * opened by fopen or fsockopen.
  5461. * </p>
  5462. * @return bool Returns true on success or false on failure.
  5463. */
  5464. function fclose ($handle) {}
  5465. /**
  5466. * Tests for end-of-file on a file pointer
  5467. * @link http://www.php.net/manual/en/function.feof.php
  5468. * @param handle resource &fs.validfp.all;
  5469. * @return bool true if the file pointer is at EOF or an error occurs
  5470. * (including socket timeout); otherwise returns false.
  5471. */
  5472. function feof ($handle) {}
  5473. /**
  5474. * Gets character from file pointer
  5475. * @link http://www.php.net/manual/en/function.fgetc.php
  5476. * @param handle resource &fs.validfp.all;
  5477. * @return string a string containing a single character read from the file pointed
  5478. * to by handle. Returns false on EOF.
  5479. */
  5480. function fgetc ($handle) {}
  5481. /**
  5482. * Gets line from file pointer
  5483. * @link http://www.php.net/manual/en/function.fgets.php
  5484. * @param handle resource &fs.validfp.all;
  5485. * @param length int[optional] <p>
  5486. * Reading ends when length - 1 bytes have been
  5487. * read, on a newline (which is included in the return value), or on EOF
  5488. * (whichever comes first). If no length is specified, it will keep
  5489. * reading from the stream until it reaches the end of the line.
  5490. * </p>
  5491. * <p>
  5492. * Until PHP 4.3.0, omitting it would assume 1024 as the line length.
  5493. * If the majority of the lines in the file are all larger than 8KB,
  5494. * it is more resource efficient for your script to specify the maximum
  5495. * line length.
  5496. * </p>
  5497. * @return string a string of up to length - 1 bytes read from
  5498. * the file pointed to by handle. If there is no more data
  5499. * to read in the file pointer, then false is returned.
  5500. * </p>
  5501. * <p>
  5502. * If an error occurs, false is returned.
  5503. */
  5504. function fgets ($handle, $length = null) {}
  5505. /**
  5506. * Gets line from file pointer and strip HTML tags
  5507. * @link http://www.php.net/manual/en/function.fgetss.php
  5508. * @param handle resource &fs.validfp.all;
  5509. * @param length int[optional] <p>
  5510. * Length of the data to be retrieved.
  5511. * </p>
  5512. * @param allowable_tags string[optional] <p>
  5513. * You can use the optional third parameter to specify tags which should
  5514. * not be stripped.
  5515. * </p>
  5516. * @return string a string of up to length - 1 bytes read from
  5517. * the file pointed to by handle, with all HTML and PHP
  5518. * code stripped.
  5519. * </p>
  5520. * <p>
  5521. * If an error occurs, returns false.
  5522. */
  5523. function fgetss ($handle, $length = null, $allowable_tags = null) {}
  5524. /**
  5525. * Binary-safe file read
  5526. * @link http://www.php.net/manual/en/function.fread.php
  5527. * @param handle resource &fs.file.pointer;
  5528. * @param length int <p>
  5529. * Up to length number of bytes read.
  5530. * </p>
  5531. * @return string the read string &return.falseforfailure;.
  5532. */
  5533. function fread ($handle, $length) {}
  5534. /**
  5535. * Opens file or URL
  5536. * @link http://www.php.net/manual/en/function.fopen.php
  5537. * @param filename string <p>
  5538. * If filename is of the form "scheme://...", it
  5539. * is assumed to be a URL and PHP will search for a protocol handler
  5540. * (also known as a wrapper) for that scheme. If no wrappers for that
  5541. * protocol are registered, PHP will emit a notice to help you track
  5542. * potential problems in your script and then continue as though
  5543. * filename specifies a regular file.
  5544. * </p>
  5545. * <p>
  5546. * If PHP has decided that filename specifies
  5547. * a local file, then it will try to open a stream on that file.
  5548. * The file must be accessible to PHP, so you need to ensure that
  5549. * the file access permissions allow this access.
  5550. * If you have enabled &safemode;,
  5551. * or open_basedir further
  5552. * restrictions may apply.
  5553. * </p>
  5554. * <p>
  5555. * If PHP has decided that filename specifies
  5556. * a registered protocol, and that protocol is registered as a
  5557. * network URL, PHP will check to make sure that
  5558. * allow_url_fopen is
  5559. * enabled. If it is switched off, PHP will emit a warning and
  5560. * the fopen call will fail.
  5561. * </p>
  5562. * <p>
  5563. * The list of supported protocols can be found in . Some protocols (also referred to as
  5564. * wrappers) support context
  5565. * and/or &php.ini; options. Refer to the specific page for the
  5566. * protocol in use for a list of options which can be set. (e.g.
  5567. * &php.ini; value user_agent used by the
  5568. * http wrapper).
  5569. * </p>
  5570. * <p>
  5571. * On the Windows platform, be careful to escape any backslashes
  5572. * used in the path to the file, or use forward slashes.
  5573. * ]]>
  5574. * </p>
  5575. * @param mode string <p>
  5576. * The mode parameter specifies the type of access
  5577. * you require to the stream. It may be any of the following:
  5578. * <table>
  5579. * A list of possible modes for fopen
  5580. * using mode
  5581. * <tr valign="top">
  5582. * <td>mode</td>
  5583. * <td>Description</td>
  5584. * </tr>
  5585. * <tr valign="top">
  5586. * <td>'r'</td>
  5587. * <td>
  5588. * Open for reading only; place the file pointer at the
  5589. * beginning of the file.
  5590. * </td>
  5591. * </tr>
  5592. * <tr valign="top">
  5593. * <td>'r+'</td>
  5594. * <td>
  5595. * Open for reading and writing; place the file pointer at
  5596. * the beginning of the file.
  5597. * </td>
  5598. * </tr>
  5599. * <tr valign="top">
  5600. * <td>'w'</td>
  5601. * <td>
  5602. * Open for writing only; place the file pointer at the
  5603. * beginning of the file and truncate the file to zero length.
  5604. * If the file does not exist, attempt to create it.
  5605. * </td>
  5606. * </tr>
  5607. * <tr valign="top">
  5608. * <td>'w+'</td>
  5609. * <td>
  5610. * Open for reading and writing; place the file pointer at
  5611. * the beginning of the file and truncate the file to zero
  5612. * length. If the file does not exist, attempt to create it.
  5613. * </td>
  5614. * </tr>
  5615. * <tr valign="top">
  5616. * <td>'a'</td>
  5617. * <td>
  5618. * Open for writing only; place the file pointer at the end of
  5619. * the file. If the file does not exist, attempt to create it.
  5620. * </td>
  5621. * </tr>
  5622. * <tr valign="top">
  5623. * <td>'a+'</td>
  5624. * <td>
  5625. * Open for reading and writing; place the file pointer at
  5626. * the end of the file. If the file does not exist, attempt to
  5627. * create it.
  5628. * </td>
  5629. * </tr>
  5630. * <tr valign="top">
  5631. * <td>'x'</td>
  5632. * <td>
  5633. * Create and open for writing only; place the file pointer at the
  5634. * beginning of the file. If the file already exists, the
  5635. * fopen call will fail by returning false and
  5636. * generating an error of level E_WARNING. If
  5637. * the file does not exist, attempt to create it. This is equivalent
  5638. * to specifying O_EXCL|O_CREAT flags for the
  5639. * underlying open(2) system call.
  5640. * </td>
  5641. * </tr>
  5642. * <tr valign="top">
  5643. * <td>'x+'</td>
  5644. * <td>
  5645. * Create and open for reading and writing; otherwise it has the
  5646. * same behavior as 'x'.
  5647. * </td>
  5648. * </tr>
  5649. * <tr valign="top">
  5650. * <td>'c'</td>
  5651. * <td>
  5652. * Open the file for writing only. If the file does not exist, it is
  5653. * created. If it exists, it is neither truncated (as opposed to
  5654. * 'w'), nor the call to this function fails (as is
  5655. * the case with 'x'). The file pointer is
  5656. * positioned on the beginning of the file. This may be useful if it's
  5657. * desired to get an advisory lock (see flock)
  5658. * before attempting to modify the file, as using
  5659. * 'w' could truncate the file before the lock
  5660. * was obtained (if truncation is desired,
  5661. * ftruncate can be used after the lock is
  5662. * requested).
  5663. * </td>
  5664. * </tr>
  5665. * <tr valign="top">
  5666. * <td>'c+'</td>
  5667. * <td>
  5668. * Open the file for reading and writing; otherwise it has the same
  5669. * behavior as 'c'.
  5670. * </td>
  5671. * </tr>
  5672. * </table>
  5673. * </p>
  5674. * <p>
  5675. * Different operating system families have different line-ending
  5676. * conventions. When you write a text file and want to insert a line
  5677. * break, you need to use the correct line-ending character(s) for your
  5678. * operating system. Unix based systems use \n as the
  5679. * line ending character, Windows based systems use \r\n
  5680. * as the line ending characters and Macintosh based systems use
  5681. * \r as the line ending character.
  5682. * </p>
  5683. * <p>
  5684. * If you use the wrong line ending characters when writing your files, you
  5685. * might find that other applications that open those files will "look
  5686. * funny".
  5687. * </p>
  5688. * <p>
  5689. * Windows offers a text-mode translation flag ('t')
  5690. * which will transparently translate \n to
  5691. * \r\n when working with the file. In contrast, you
  5692. * can also use 'b' to force binary mode, which will not
  5693. * translate your data. To use these flags, specify either
  5694. * 'b' or 't' as the last character
  5695. * of the mode parameter.
  5696. * </p>
  5697. * <p>
  5698. * The default translation mode depends on the SAPI and version of PHP that
  5699. * you are using, so you are encouraged to always specify the appropriate
  5700. * flag for portability reasons. You should use the 't'
  5701. * mode if you are working with plain-text files and you use
  5702. * \n to delimit your line endings in your script, but
  5703. * expect your files to be readable with applications such as notepad. You
  5704. * should use the 'b' in all other cases.
  5705. * </p>
  5706. * <p>
  5707. * If you do not specify the 'b' flag when working with binary files, you
  5708. * may experience strange problems with your data, including broken image
  5709. * files and strange problems with \r\n characters.
  5710. * </p>
  5711. * <p>
  5712. * For portability, it is strongly recommended that you always
  5713. * use the 'b' flag when opening files with fopen.
  5714. * </p>
  5715. * <p>
  5716. * Again, for portability, it is also strongly recommended that
  5717. * you re-write code that uses or relies upon the 't'
  5718. * mode so that it uses the correct line endings and
  5719. * 'b' mode instead.
  5720. * </p>
  5721. * @param use_include_path bool[optional] <p>
  5722. * The optional third use_include_path parameter
  5723. * can be set to '1' or true if you want to search for the file in the
  5724. * include_path, too.
  5725. * </p>
  5726. * @param context resource[optional] &note.context-support;
  5727. * @return resource a file pointer resource on success, or false on error.
  5728. */
  5729. function fopen ($filename, $mode, $use_include_path = null, $context = null) {}
  5730. /**
  5731. * Output all remaining data on a file pointer
  5732. * @link http://www.php.net/manual/en/function.fpassthru.php
  5733. * @param handle resource &fs.validfp.all;
  5734. * @return int If an error occurs, fpassthru returns
  5735. * false. Otherwise, fpassthru returns
  5736. * the number of characters read from handle
  5737. * and passed through to the output.
  5738. */
  5739. function fpassthru ($handle) {}
  5740. /**
  5741. * Truncates a file to a given length
  5742. * @link http://www.php.net/manual/en/function.ftruncate.php
  5743. * @param handle resource <p>
  5744. * The file pointer.
  5745. * </p>
  5746. * <p>
  5747. * The handle must be open for writing.
  5748. * </p>
  5749. * @param size int <p>
  5750. * The size to truncate to.
  5751. * </p>
  5752. * <p>
  5753. * If size is larger than the file then the file
  5754. * is extended with null bytes.
  5755. * </p>
  5756. * <p>
  5757. * If size is smaller than the file then the file
  5758. * is truncated to that size.
  5759. * </p>
  5760. * @return bool Returns true on success or false on failure.
  5761. */
  5762. function ftruncate ($handle, $size) {}
  5763. /**
  5764. * Gets information about a file using an open file pointer
  5765. * @link http://www.php.net/manual/en/function.fstat.php
  5766. * @param handle resource &fs.file.pointer;
  5767. * @return array an array with the statistics of the file; the format of the array
  5768. * is described in detail on the stat manual page.
  5769. */
  5770. function fstat ($handle) {}
  5771. /**
  5772. * Seeks on a file pointer
  5773. * @link http://www.php.net/manual/en/function.fseek.php
  5774. * @param handle resource &fs.file.pointer;
  5775. * @param offset int <p>
  5776. * The offset.
  5777. * </p>
  5778. * <p>
  5779. * To move to a position before the end-of-file, you need to pass
  5780. * a negative value in offset and
  5781. * set whence
  5782. * to SEEK_END.
  5783. * </p>
  5784. * @param whence int[optional] <p>
  5785. * whence values are:
  5786. * SEEK_SET - Set position equal to offset bytes.
  5787. * SEEK_CUR - Set position to current location plus offset.
  5788. * SEEK_END - Set position to end-of-file plus offset.
  5789. * </p>
  5790. * @return int Upon success, returns 0; otherwise, returns -1.
  5791. */
  5792. function fseek ($handle, $offset, $whence = null) {}
  5793. /**
  5794. * Returns the current position of the file read/write pointer
  5795. * @link http://www.php.net/manual/en/function.ftell.php
  5796. * @param handle resource <p>
  5797. * The file pointer must be valid, and must point to a file successfully
  5798. * opened by fopen or popen.
  5799. * ftell gives undefined results for append-only streams
  5800. * (opened with "a" flag).
  5801. * </p>
  5802. * @return int the position of the file pointer referenced by
  5803. * handle as an integer; i.e., its offset into the file stream.
  5804. * </p>
  5805. * <p>
  5806. * If an error occurs, returns false.
  5807. */
  5808. function ftell ($handle) {}
  5809. /**
  5810. * Flushes the output to a file
  5811. * @link http://www.php.net/manual/en/function.fflush.php
  5812. * @param handle resource &fs.validfp.all;
  5813. * @return bool Returns true on success or false on failure.
  5814. */
  5815. function fflush ($handle) {}
  5816. /**
  5817. * Binary-safe file write
  5818. * @link http://www.php.net/manual/en/function.fwrite.php
  5819. * @param handle resource &fs.file.pointer;
  5820. * @param string string <p>
  5821. * The string that is to be written.
  5822. * </p>
  5823. * @param length int[optional] <p>
  5824. * If the length argument is given, writing will
  5825. * stop after length bytes have been written or
  5826. * the end of string is reached, whichever comes
  5827. * first.
  5828. * </p>
  5829. * <p>
  5830. * Note that if the length argument is given,
  5831. * then the magic_quotes_runtime
  5832. * configuration option will be ignored and no slashes will be
  5833. * stripped from string.
  5834. * </p>
  5835. * @return int
  5836. */
  5837. function fwrite ($handle, $string, $length = null) {}
  5838. /**
  5839. * &Alias; <function>fwrite</function>
  5840. * @link http://www.php.net/manual/en/function.fputs.php
  5841. * @param fp
  5842. * @param str
  5843. * @param length[optional]
  5844. */
  5845. function fputs ($fp, $str, $length) {}
  5846. /**
  5847. * Makes directory
  5848. * @link http://www.php.net/manual/en/function.mkdir.php
  5849. * @param pathname string <p>
  5850. * The directory path.
  5851. * </p>
  5852. * @param mode int[optional] <p>
  5853. * The mode is 0777 by default, which means the widest possible
  5854. * access. For more information on modes, read the details
  5855. * on the chmod page.
  5856. * </p>
  5857. * <p>
  5858. * mode is ignored on Windows.
  5859. * </p>
  5860. * <p>
  5861. * Note that you probably want to specify the mode as an octal number,
  5862. * which means it should have a leading zero. The mode is also modified
  5863. * by the current umask, which you can change using
  5864. * umask.
  5865. * </p>
  5866. * @param recursive bool[optional] <p>
  5867. * Allows the creation of nested directories specified in the
  5868. * pathname. Defaults to false.
  5869. * </p>
  5870. * @param context resource[optional] &note.context-support;
  5871. * @return bool Returns true on success or false on failure.
  5872. */
  5873. function mkdir ($pathname, $mode = null, $recursive = null, $context = null) {}
  5874. /**
  5875. * Renames a file or directory
  5876. * @link http://www.php.net/manual/en/function.rename.php
  5877. * @param oldname string <p>
  5878. * </p>
  5879. * <p>
  5880. * The old name. The wrapper used in oldname
  5881. * must match the wrapper used in
  5882. * newname.
  5883. * </p>
  5884. * @param newname string <p>
  5885. * The new name.
  5886. * </p>
  5887. * @param context resource[optional] &note.context-support;
  5888. * @return bool Returns true on success or false on failure.
  5889. */
  5890. function rename ($oldname, $newname, $context = null) {}
  5891. /**
  5892. * Copies file
  5893. * @link http://www.php.net/manual/en/function.copy.php
  5894. * @param source string <p>
  5895. * Path to the source file.
  5896. * </p>
  5897. * @param dest string <p>
  5898. * The destination path. If dest is a URL, the
  5899. * copy operation may fail if the wrapper does not support overwriting of
  5900. * existing files.
  5901. * </p>
  5902. * <p>
  5903. * If the destination file already exists, it will be overwritten.
  5904. * </p>
  5905. * @param context resource[optional] <p>
  5906. * A valid context resource created with
  5907. * stream_context_create.
  5908. * </p>
  5909. * @return bool Returns true on success or false on failure.
  5910. */
  5911. function copy ($source, $dest, $context = null) {}
  5912. /**
  5913. * Create file with unique file name
  5914. * @link http://www.php.net/manual/en/function.tempnam.php
  5915. * @param dir string <p>
  5916. * The directory where the temporary filename will be created.
  5917. * </p>
  5918. * @param prefix string <p>
  5919. * The prefix of the generated temporary filename.
  5920. * </p>
  5921. * Windows uses only the first three characters of prefix.
  5922. * @return string the new temporary filename, or false on
  5923. * failure.
  5924. */
  5925. function tempnam ($dir, $prefix) {}
  5926. /**
  5927. * Creates a temporary file
  5928. * @link http://www.php.net/manual/en/function.tmpfile.php
  5929. * @return resource a file handle, similar to the one returned by
  5930. * fopen, for the new file&return.falseforfailure;.
  5931. */
  5932. function tmpfile () {}
  5933. /**
  5934. * Reads entire file into an array
  5935. * @link http://www.php.net/manual/en/function.file.php
  5936. * @param filename string <p>
  5937. * Path to the file.
  5938. * </p>
  5939. * &tip.fopen-wrapper;
  5940. * @param flags int[optional] <p>
  5941. * The optional parameter flags can be one, or
  5942. * more, of the following constants:
  5943. * FILE_USE_INCLUDE_PATH
  5944. * Search for the file in the include_path.
  5945. * @param context resource[optional] <p>
  5946. * A context resource created with the
  5947. * stream_context_create function.
  5948. * </p>
  5949. * <p>
  5950. * &note.context-support;
  5951. * </p>
  5952. * @return array the file in an array. Each element of the array corresponds to a
  5953. * line in the file, with the newline still attached. Upon failure,
  5954. * file returns false.
  5955. * </p>
  5956. * <p>
  5957. * Each line in the resulting array will include the line ending, unless
  5958. * FILE_IGNORE_NEW_LINES is used, so you still need to
  5959. * use rtrim if you do not want the line ending
  5960. * present.
  5961. */
  5962. function file ($filename, $flags = null, $context = null) {}
  5963. /**
  5964. * Reads entire file into a string
  5965. * @link http://www.php.net/manual/en/function.file-get-contents.php
  5966. * @param filename string <p>
  5967. * Name of the file to read.
  5968. * </p>
  5969. * @param use_include_path bool[optional] <p>
  5970. * As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
  5971. * to trigger include path
  5972. * search.
  5973. * </p>
  5974. * @param context resource[optional] <p>
  5975. * A valid context resource created with
  5976. * stream_context_create. If you don't need to use a
  5977. * custom context, you can skip this parameter by &null;.
  5978. * </p>
  5979. * @param offset int[optional] <p>
  5980. * The offset where the reading starts on the original stream.
  5981. * </p>
  5982. * <p>
  5983. * Seeking (offset) is not supported with remote files.
  5984. * Attempting to seek on non-local files may work with small offsets, but this
  5985. * is unpredictable because it works on the buffered stream.
  5986. * </p>
  5987. * @param maxlen int[optional] <p>
  5988. * Maximum length of data read. The default is to read until end
  5989. * of file is reached. Note that this parameter is applied to the
  5990. * stream processed by the filters.
  5991. * </p>
  5992. * @return string The function returns the read data&return.falseforfailure;.
  5993. */
  5994. function file_get_contents ($filename, $use_include_path = null, $context = null, $offset = null, $maxlen = null) {}
  5995. /**
  5996. * Write a string to a file
  5997. * @link http://www.php.net/manual/en/function.file-put-contents.php
  5998. * @param filename string <p>
  5999. * Path to the file where to write the data.
  6000. * </p>
  6001. * @param data mixed <p>
  6002. * The data to write. Can be either a string, an
  6003. * array or a stream resource.
  6004. * </p>
  6005. * <p>
  6006. * If data is a stream resource, the
  6007. * remaining buffer of that stream will be copied to the specified file.
  6008. * This is similar with using stream_copy_to_stream.
  6009. * </p>
  6010. * <p>
  6011. * You can also specify the data parameter as a single
  6012. * dimension array. This is equivalent to
  6013. * file_put_contents($filename, implode('', $array)).
  6014. * </p>
  6015. * @param flags int[optional] <p>
  6016. * The value of flags can be any combination of
  6017. * the following flags, joined with the binary OR (|)
  6018. * operator.
  6019. * </p>
  6020. * <p>
  6021. * <table>
  6022. * Available flags
  6023. * <tr valign="top">
  6024. * <td>Flag</td>
  6025. * <td>Description</td>
  6026. * </tr>
  6027. * <tr valign="top">
  6028. * <td>
  6029. * FILE_USE_INCLUDE_PATH
  6030. * </td>
  6031. * <td>
  6032. * Search for filename in the include directory.
  6033. * See include_path for more
  6034. * information.
  6035. * </td>
  6036. * </tr>
  6037. * <tr valign="top">
  6038. * <td>
  6039. * FILE_APPEND
  6040. * </td>
  6041. * <td>
  6042. * If file filename already exists, append
  6043. * the data to the file instead of overwriting it.
  6044. * </td>
  6045. * </tr>
  6046. * <tr valign="top">
  6047. * <td>
  6048. * LOCK_EX
  6049. * </td>
  6050. * <td>
  6051. * Acquire an exclusive lock on the file while proceeding to the
  6052. * writing.
  6053. * </td>
  6054. * </tr>
  6055. * </table>
  6056. * </p>
  6057. * @param context resource[optional] <p>
  6058. * A valid context resource created with
  6059. * stream_context_create.
  6060. * </p>
  6061. * @return int The function returns the number of bytes that were written to the file, or
  6062. * false on failure.
  6063. */
  6064. function file_put_contents ($filename, $data, $flags = null, $context = null) {}
  6065. /**
  6066. * Runs the equivalent of the select() system call on the given
  6067. arrays of streams with a timeout specified by tv_sec and tv_usec
  6068. * @link http://www.php.net/manual/en/function.stream-select.php
  6069. * @param read array <p>
  6070. * The streams listed in the read array will be watched to
  6071. * see if characters become available for reading (more precisely, to see if
  6072. * a read will not block - in particular, a stream resource is also ready on
  6073. * end-of-file, in which case an fread will return
  6074. * a zero length string).
  6075. * </p>
  6076. * @param write array <p>
  6077. * The streams listed in the write array will be
  6078. * watched to see if a write will not block.
  6079. * </p>
  6080. * @param except array <p>
  6081. * The streams listed in the except array will be
  6082. * watched for high priority exceptional ("out-of-band") data arriving.
  6083. * </p>
  6084. * <p>
  6085. * When stream_select returns, the arrays
  6086. * read, write and
  6087. * except are modified to indicate which stream
  6088. * resource(s) actually changed status.
  6089. * </p>
  6090. * You do not need to pass every array to
  6091. * stream_select. You can leave it out and use an
  6092. * empty array or &null; instead. Also do not forget that those arrays are
  6093. * passed by reference and will be modified after
  6094. * stream_select returns.
  6095. * @param tv_sec int <p>
  6096. * The tv_sec and tv_usec
  6097. * together form the timeout parameter,
  6098. * tv_sec specifies the number of seconds while
  6099. * tv_usec the number of microseconds.
  6100. * The timeout is an upper bound on the amount of time
  6101. * that stream_select will wait before it returns.
  6102. * If tv_sec and tv_usec are
  6103. * both set to 0, stream_select will
  6104. * not wait for data - instead it will return immediately, indicating the
  6105. * current status of the streams.
  6106. * </p>
  6107. * <p>
  6108. * If tv_sec is &null; stream_select
  6109. * can block indefinitely, returning only when an event on one of the
  6110. * watched streams occurs (or if a signal interrupts the system call).
  6111. * </p>
  6112. * <p>
  6113. * Using a timeout value of 0 allows you to
  6114. * instantaneously poll the status of the streams, however, it is NOT a
  6115. * good idea to use a 0 timeout value in a loop as it
  6116. * will cause your script to consume too much CPU time.
  6117. * </p>
  6118. * <p>
  6119. * It is much better to specify a timeout value of a few seconds, although
  6120. * if you need to be checking and running other code concurrently, using a
  6121. * timeout value of at least 200000 microseconds will
  6122. * help reduce the CPU usage of your script.
  6123. * </p>
  6124. * <p>
  6125. * Remember that the timeout value is the maximum time that will elapse;
  6126. * stream_select will return as soon as the
  6127. * requested streams are ready for use.
  6128. * </p>
  6129. * @param tv_usec int[optional] <p>
  6130. * See tv_sec description.
  6131. * </p>
  6132. * @return int On success stream_select returns the number of
  6133. * stream resources contained in the modified arrays, which may be zero if
  6134. * the timeout expires before anything interesting happens. On error false
  6135. * is returned and a warning raised (this can happen if the system call is
  6136. * interrupted by an incoming signal).
  6137. */
  6138. function stream_select (array &$read, array &$write, array &$except, $tv_sec, $tv_usec = null) {}
  6139. /**
  6140. * Create a streams context
  6141. * @link http://www.php.net/manual/en/function.stream-context-create.php
  6142. * @param options array[optional] <p>
  6143. * Must be an associative array of associative arrays in the format
  6144. * $arr['wrapper']['option'] = $value.
  6145. * </p>
  6146. * <p>
  6147. * Default to an empty array.
  6148. * </p>
  6149. * @param params array[optional] <p>
  6150. * Must be an associative array in the format
  6151. * $arr['parameter'] = $value.
  6152. * Refer to context parameters for
  6153. * a listing of standard stream parameters.
  6154. * </p>
  6155. * @return resource A stream context resource.
  6156. */
  6157. function stream_context_create (array $options = null, array $params = null) {}
  6158. /**
  6159. * Set parameters for a stream/wrapper/context
  6160. * @link http://www.php.net/manual/en/function.stream-context-set-params.php
  6161. * @param stream_or_context resource <p>
  6162. * The stream or context to apply the parameters too.
  6163. * </p>
  6164. * @param params array <p>
  6165. * An array of parameters to set.
  6166. * </p>
  6167. * <p>
  6168. * params should be an associative array of the structure:
  6169. * $params['paramname'] = "paramvalue";.
  6170. * </p>
  6171. * @return bool Returns true on success or false on failure.
  6172. */
  6173. function stream_context_set_params ($stream_or_context, array $params) {}
  6174. /**
  6175. * Retrieves parameters from a context
  6176. * @link http://www.php.net/manual/en/function.stream-context-get-params.php
  6177. * @param stream_or_context resource <p>
  6178. * A stream resource or a
  6179. * context resource
  6180. * </p>
  6181. * @return array an associate array containing all context options and parameters.
  6182. */
  6183. function stream_context_get_params ($stream_or_context) {}
  6184. /**
  6185. * Sets an option for a stream/wrapper/context
  6186. * @link http://www.php.net/manual/en/function.stream-context-set-option.php
  6187. * @param stream_or_context resource <p>
  6188. * The stream or context resource to apply the options too.
  6189. * </p>
  6190. * @param wrapper string
  6191. * @param option string
  6192. * @param value mixed
  6193. * @return bool Returns true on success or false on failure.
  6194. */
  6195. function stream_context_set_option ($stream_or_context, $wrapper, $option, $value) {}
  6196. /**
  6197. * Retrieve options for a stream/wrapper/context
  6198. * @link http://www.php.net/manual/en/function.stream-context-get-options.php
  6199. * @param stream_or_context resource <p>
  6200. * The stream or context to get options from
  6201. * </p>
  6202. * @return array an associative array with the options.
  6203. */
  6204. function stream_context_get_options ($stream_or_context) {}
  6205. /**
  6206. * Retrieve the default streams context
  6207. * @link http://www.php.net/manual/en/function.stream-context-get-default.php
  6208. * @param options array[optional] options must be an associative
  6209. * array of associative arrays in the format
  6210. * $arr['wrapper']['option'] = $value.
  6211. * <p>
  6212. * As of PHP 5.3.0, the stream_context_set_default function
  6213. * can be used to set the default context.
  6214. * </p>
  6215. * @return resource A stream context resource.
  6216. */
  6217. function stream_context_get_default (array $options = null) {}
  6218. /**
  6219. * Set the default streams context
  6220. * @link http://www.php.net/manual/en/function.stream-context-set-default.php
  6221. * @param options array <p>
  6222. * The options to set for the default context.
  6223. * </p>
  6224. * <p>
  6225. * options must be an associative
  6226. * array of associative arrays in the format
  6227. * $arr['wrapper']['option'] = $value.
  6228. * </p>
  6229. * @return resource the default stream context.
  6230. */
  6231. function stream_context_set_default (array $options) {}
  6232. /**
  6233. * Attach a filter to a stream
  6234. * @link http://www.php.net/manual/en/function.stream-filter-prepend.php
  6235. * @param stream resource <p>
  6236. * The target stream.
  6237. * </p>
  6238. * @param filtername string <p>
  6239. * The filter name.
  6240. * </p>
  6241. * @param read_write int[optional] <p>
  6242. * By default, stream_filter_prepend will
  6243. * attach the filter to the read filter chain
  6244. * if the file was opened for reading (i.e. File Mode:
  6245. * r, and/or +). The filter
  6246. * will also be attached to the write filter chain
  6247. * if the file was opened for writing (i.e. File Mode:
  6248. * w, a, and/or +).
  6249. * STREAM_FILTER_READ,
  6250. * STREAM_FILTER_WRITE, and/or
  6251. * STREAM_FILTER_ALL can also be passed to the
  6252. * read_write parameter to override this behavior.
  6253. * See stream_filter_append for an example of
  6254. * using this parameter.
  6255. * </p>
  6256. * @param params mixed[optional] <p>
  6257. * This filter will be added with the specified params
  6258. * to the beginning of the list and will therefore be
  6259. * called first during stream operations. To add a filter to the end of the
  6260. * list, use stream_filter_append.
  6261. * </p>
  6262. * @return resource a resource which can be used to refer to this filter
  6263. * instance during a call to stream_filter_remove.
  6264. */
  6265. function stream_filter_prepend ($stream, $filtername, $read_write = null, $params = null) {}
  6266. /**
  6267. * Attach a filter to a stream
  6268. * @link http://www.php.net/manual/en/function.stream-filter-append.php
  6269. * @param stream resource <p>
  6270. * The target stream.
  6271. * </p>
  6272. * @param filtername string <p>
  6273. * The filter name.
  6274. * </p>
  6275. * @param read_write int[optional] <p>
  6276. * By default, stream_filter_append will
  6277. * attach the filter to the read filter chain
  6278. * if the file was opened for reading (i.e. File Mode:
  6279. * r, and/or +). The filter
  6280. * will also be attached to the write filter chain
  6281. * if the file was opened for writing (i.e. File Mode:
  6282. * w, a, and/or +).
  6283. * STREAM_FILTER_READ,
  6284. * STREAM_FILTER_WRITE, and/or
  6285. * STREAM_FILTER_ALL can also be passed to the
  6286. * read_write parameter to override this behavior.
  6287. * </p>
  6288. * @param params mixed[optional] <p>
  6289. * This filter will be added with the specified
  6290. * params to the end of
  6291. * the list and will therefore be called last during stream operations.
  6292. * To add a filter to the beginning of the list, use
  6293. * stream_filter_prepend.
  6294. * </p>
  6295. * @return resource a resource which can be used to refer to this filter
  6296. * instance during a call to stream_filter_remove.
  6297. */
  6298. function stream_filter_append ($stream, $filtername, $read_write = null, $params = null) {}
  6299. /**
  6300. * Remove a filter from a stream
  6301. * @link http://www.php.net/manual/en/function.stream-filter-remove.php
  6302. * @param stream_filter resource <p>
  6303. * The stream filter to be removed.
  6304. * </p>
  6305. * @return bool Returns true on success or false on failure.
  6306. */
  6307. function stream_filter_remove ($stream_filter) {}
  6308. /**
  6309. * Open Internet or Unix domain socket connection
  6310. * @link http://www.php.net/manual/en/function.stream-socket-client.php
  6311. * @param remote_socket string <p>
  6312. * Address to the socket to connect to.
  6313. * </p>
  6314. * @param errno int[optional] <p>
  6315. * Will be set to the system level error number if connection fails.
  6316. * </p>
  6317. * @param errstr string[optional] <p>
  6318. * Will be set to the system level error message if the connection fails.
  6319. * </p>
  6320. * @param timeout float[optional] <p>
  6321. * Number of seconds until the connect() system call
  6322. * should timeout.
  6323. * This parameter only applies when not making asynchronous
  6324. * connection attempts.
  6325. * <p>
  6326. * To set a timeout for reading/writing data over the socket, use the
  6327. * stream_set_timeout, as the
  6328. * timeout only applies while making connecting
  6329. * the socket.
  6330. * </p>
  6331. * </p>
  6332. * @param flags int[optional] <p>
  6333. * Bitmask field which may be set to any combination of connection flags.
  6334. * Currently the select of connection flags is limited to
  6335. * STREAM_CLIENT_CONNECT (default),
  6336. * STREAM_CLIENT_ASYNC_CONNECT and
  6337. * STREAM_CLIENT_PERSISTENT.
  6338. * </p>
  6339. * @param context resource[optional] <p>
  6340. * A valid context resource created with stream_context_create.
  6341. * </p>
  6342. * @return resource On success a stream resource is returned which may
  6343. * be used together with the other file functions (such as
  6344. * fgets, fgetss,
  6345. * fwrite, fclose, and
  6346. * feof), false on failure.
  6347. */
  6348. function stream_socket_client ($remote_socket, &$errno = null, &$errstr = null, $timeout = null, $flags = null, $context = null) {}
  6349. /**
  6350. * Create an Internet or Unix domain server socket
  6351. * @link http://www.php.net/manual/en/function.stream-socket-server.php
  6352. * @param local_socket string <p>
  6353. * The type of socket created is determined by the transport specified
  6354. * using standard URL formatting: transport://target.
  6355. * </p>
  6356. * <p>
  6357. * For Internet Domain sockets (AF_INET) such as TCP and UDP, the
  6358. * target portion of the
  6359. * remote_socket parameter should consist of a
  6360. * hostname or IP address followed by a colon and a port number. For
  6361. * Unix domain sockets, the target portion should
  6362. * point to the socket file on the filesystem.
  6363. * </p>
  6364. * <p>
  6365. * Depending on the environment, Unix domain sockets may not be available.
  6366. * A list of available transports can be retrieved using
  6367. * stream_get_transports. See
  6368. * for a list of bulitin transports.
  6369. * </p>
  6370. * @param errno int[optional] <p>
  6371. * If the optional errno and errstr
  6372. * arguments are present they will be set to indicate the actual system
  6373. * level error that occurred in the system-level socket(),
  6374. * bind(), and listen() calls. If
  6375. * the value returned in errno is
  6376. * 0 and the function returned false, it is an
  6377. * indication that the error occurred before the bind()
  6378. * call. This is most likely due to a problem initializing the socket.
  6379. * Note that the errno and
  6380. * errstr arguments will always be passed by reference.
  6381. * </p>
  6382. * @param errstr string[optional] <p>
  6383. * See errno description.
  6384. * </p>
  6385. * @param flags int[optional] <p>
  6386. * A bitmask field which may be set to any combination of socket creation
  6387. * flags.
  6388. * </p>
  6389. * <p>
  6390. * For UDP sockets, you must use STREAM_SERVER_BIND as
  6391. * the flags parameter.
  6392. * </p>
  6393. * @param context resource[optional] <p>
  6394. * </p>
  6395. * @return resource the created stream, or false on error.
  6396. */
  6397. function stream_socket_server ($local_socket, &$errno = null, &$errstr = null, $flags = null, $context = null) {}
  6398. /**
  6399. * Accept a connection on a socket created by <function>stream_socket_server</function>
  6400. * @link http://www.php.net/manual/en/function.stream-socket-accept.php
  6401. * @param server_socket resource <p>
  6402. * The server socket to accept a connection from.
  6403. * </p>
  6404. * @param timeout float[optional] <p>
  6405. * Override the default socket accept timeout. Time should be given in
  6406. * seconds.
  6407. * </p>
  6408. * @param peername string[optional] <p>
  6409. * Will be set to the name (address) of the client which connected, if
  6410. * included and available from the selected transport.
  6411. * </p>
  6412. * <p>
  6413. * Can also be determined later using
  6414. * stream_socket_get_name.
  6415. * </p>
  6416. * @return resource a stream to the accepted socket connection&return.falseforfailure;.
  6417. */
  6418. function stream_socket_accept ($server_socket, $timeout = null, &$peername = null) {}
  6419. /**
  6420. * Retrieve the name of the local or remote sockets
  6421. * @link http://www.php.net/manual/en/function.stream-socket-get-name.php
  6422. * @param handle resource <p>
  6423. * The socket to get the name of.
  6424. * </p>
  6425. * @param want_peer bool <p>
  6426. * If set to true the remote socket name will be returned, if set
  6427. * to false the local socket name will be returned.
  6428. * </p>
  6429. * @return string The name of the socket.
  6430. */
  6431. function stream_socket_get_name ($handle, $want_peer) {}
  6432. /**
  6433. * Receives data from a socket, connected or not
  6434. * @link http://www.php.net/manual/en/function.stream-socket-recvfrom.php
  6435. * @param socket resource <p>
  6436. * The remote socket.
  6437. * </p>
  6438. * @param length int <p>
  6439. * The number of bytes to receive from the socket.
  6440. * </p>
  6441. * @param flags int[optional] <p>
  6442. * The value of flags can be any combination
  6443. * of the following:
  6444. * <table>
  6445. * Possible values for flags
  6446. * <tr valign="top">
  6447. * <td>STREAM_OOB</td>
  6448. * <td>
  6449. * Process OOB (out-of-band) data.
  6450. * </td>
  6451. * </tr>
  6452. * <tr valign="top">
  6453. * <td>STREAM_PEEK</td>
  6454. * <td>
  6455. * Retrieve data from the socket, but do not consume the buffer.
  6456. * Subsequent calls to fread or
  6457. * stream_socket_recvfrom will see
  6458. * the same data.
  6459. * </td>
  6460. * </tr>
  6461. * </table>
  6462. * </p>
  6463. * @param address string[optional] <p>
  6464. * If address is provided it will be populated with
  6465. * the address of the remote socket.
  6466. * </p>
  6467. * @return string the read data, as a string
  6468. */
  6469. function stream_socket_recvfrom ($socket, $length, $flags = null, &$address = null) {}
  6470. /**
  6471. * Sends a message to a socket, whether it is connected or not
  6472. * @link http://www.php.net/manual/en/function.stream-socket-sendto.php
  6473. * @param socket resource <p>
  6474. * The socket to send data to.
  6475. * </p>
  6476. * @param data string <p>
  6477. * The data to be sent.
  6478. * </p>
  6479. * @param flags int[optional] <p>
  6480. * The value of flags can be any combination
  6481. * of the following:
  6482. * <table>
  6483. * possible values for flags
  6484. * <tr valign="top">
  6485. * <td>STREAM_OOB</td>
  6486. * <td>
  6487. * Process OOB (out-of-band) data.
  6488. * </td>
  6489. * </tr>
  6490. * </table>
  6491. * </p>
  6492. * @param address string[optional] <p>
  6493. * The address specified when the socket stream was created will be used
  6494. * unless an alternate address is specified in address.
  6495. * </p>
  6496. * <p>
  6497. * If specified, it must be in dotted quad (or [ipv6]) format.
  6498. * </p>
  6499. * @return int a result code, as an integer.
  6500. */
  6501. function stream_socket_sendto ($socket, $data, $flags = null, $address = null) {}
  6502. /**
  6503. * Turns encryption on/off on an already connected socket
  6504. * @link http://www.php.net/manual/en/function.stream-socket-enable-crypto.php
  6505. * @param stream resource <p>
  6506. * The stream resource.
  6507. * </p>
  6508. * @param enable bool <p>
  6509. * Enable/disable cryptography on the stream.
  6510. * </p>
  6511. * @param crypto_type int[optional] <p>
  6512. * Setup encryption on the stream.
  6513. * Valid methods are
  6514. * STREAM_CRYPTO_METHOD_SSLv2_CLIENT
  6515. * @param session_stream resource[optional] <p>
  6516. * Seed the stream with settings from session_stream.
  6517. * </p>
  6518. * @return mixed true on success, false if negotiation has failed or
  6519. * 0 if there isn't enough data and you should try again
  6520. * (only for non-blocking sockets).
  6521. */
  6522. function stream_socket_enable_crypto ($stream, $enable, $crypto_type = null, $session_stream = null) {}
  6523. /**
  6524. * Shutdown a full-duplex connection
  6525. * @link http://www.php.net/manual/en/function.stream-socket-shutdown.php
  6526. * @param stream resource <p>
  6527. * An open stream (opened with stream_socket_client,
  6528. * for example)
  6529. * </p>
  6530. * @param how int <p>
  6531. * One of the following constants: STREAM_SHUT_RD
  6532. * (disable further receptions), STREAM_SHUT_WR
  6533. * (disable further transmissions) or
  6534. * STREAM_SHUT_RDWR (disable further receptions and
  6535. * transmissions).
  6536. * </p>
  6537. * @return bool Returns true on success or false on failure.
  6538. */
  6539. function stream_socket_shutdown ($stream, $how) {}
  6540. /**
  6541. * Creates a pair of connected, indistinguishable socket streams
  6542. * @link http://www.php.net/manual/en/function.stream-socket-pair.php
  6543. * @param domain int <p>
  6544. * The protocol family to be used: STREAM_PF_INET,
  6545. * STREAM_PF_INET6 or
  6546. * STREAM_PF_UNIX
  6547. * </p>
  6548. * @param type int <p>
  6549. * The type of communication to be used:
  6550. * STREAM_SOCK_DGRAM,
  6551. * STREAM_SOCK_RAW,
  6552. * STREAM_SOCK_RDM,
  6553. * STREAM_SOCK_SEQPACKET or
  6554. * STREAM_SOCK_STREAM
  6555. * </p>
  6556. * @param protocol int <p>
  6557. * The protocol to be used: STREAM_IPPROTO_ICMP,
  6558. * STREAM_IPPROTO_IP,
  6559. * STREAM_IPPROTO_RAW,
  6560. * STREAM_IPPROTO_TCP or
  6561. * STREAM_IPPROTO_UDP
  6562. * </p>
  6563. * @return array an array with the two socket resources on success, or
  6564. * false on failure.
  6565. */
  6566. function stream_socket_pair ($domain, $type, $protocol) {}
  6567. /**
  6568. * Copies data from one stream to another
  6569. * @link http://www.php.net/manual/en/function.stream-copy-to-stream.php
  6570. * @param source resource <p>
  6571. * The source stream
  6572. * </p>
  6573. * @param dest resource <p>
  6574. * The destination stream
  6575. * </p>
  6576. * @param maxlength int[optional] <p>
  6577. * Maximum bytes to copy
  6578. * </p>
  6579. * @param offset int[optional] <p>
  6580. * The offset where to start to copy data
  6581. * </p>
  6582. * @return int the total count of bytes copied.
  6583. */
  6584. function stream_copy_to_stream ($source, $dest, $maxlength = null, $offset = null) {}
  6585. /**
  6586. * Reads remainder of a stream into a string
  6587. * @link http://www.php.net/manual/en/function.stream-get-contents.php
  6588. * @param handle resource <p>
  6589. * A stream resource (e.g. returned from fopen)
  6590. * </p>
  6591. * @param maxlength int[optional] <p>
  6592. * The maximum bytes to read. Defaults to -1 (read all the remaining
  6593. * buffer).
  6594. * </p>
  6595. * @param offset int[optional] <p>
  6596. * Seek to the specified offset before reading. If this number is negative,
  6597. * no seeking will occur and reading will start from the current position.
  6598. * </p>
  6599. * @return string a string&return.falseforfailure;.
  6600. */
  6601. function stream_get_contents ($handle, $maxlength = null, $offset = null) {}
  6602. /**
  6603. * Tells whether the stream supports locking.
  6604. * @link http://www.php.net/manual/en/function.stream-supports-lock.php
  6605. * @param stream resource <p>
  6606. * The stream to check.
  6607. * </p>
  6608. * @return bool Returns true on success or false on failure.
  6609. */
  6610. function stream_supports_lock ($stream) {}
  6611. /**
  6612. * Gets line from file pointer and parse for CSV fields
  6613. * @link http://www.php.net/manual/en/function.fgetcsv.php
  6614. * @param handle resource <p>
  6615. * A valid file pointer to a file successfully opened by
  6616. * fopen, popen, or
  6617. * fsockopen.
  6618. * </p>
  6619. * @param length int[optional] <p>
  6620. * Must be greater than the longest line (in characters) to be found in
  6621. * the CSV file (allowing for trailing line-end characters). It became
  6622. * optional in PHP 5. Omitting this parameter (or setting it to 0 in PHP
  6623. * 5.0.4 and later) the maximum line length is not limited, which is
  6624. * slightly slower.
  6625. * </p>
  6626. * @param delimiter string[optional] <p>
  6627. * Set the field delimiter (one character only).
  6628. * </p>
  6629. * @param enclosure string[optional] <p>
  6630. * Set the field enclosure character (one character only).
  6631. * </p>
  6632. * @param escape string[optional] <p>
  6633. * Set the escape character (one character only). Defaults as a backslash.
  6634. * </p>
  6635. * @return array an indexed array containing the fields read.
  6636. * </p>
  6637. * <p>
  6638. * A blank line in a CSV file will be returned as an array
  6639. * comprising a single null field, and will not be treated
  6640. * as an error.
  6641. * </p>
  6642. * &note.line-endings;
  6643. * <p>
  6644. * fgetcsv returns &null; if an invalid
  6645. * handle is supplied or false on other errors,
  6646. * including end of file.
  6647. */
  6648. function fgetcsv ($handle, $length = null, $delimiter = null, $enclosure = null, $escape = null) {}
  6649. /**
  6650. * Format line as CSV and write to file pointer
  6651. * @link http://www.php.net/manual/en/function.fputcsv.php
  6652. * @param handle resource &fs.validfp.all;
  6653. * @param fields array <p>
  6654. * An array of values.
  6655. * </p>
  6656. * @param delimiter string[optional] <p>
  6657. * The optional delimiter parameter sets the field
  6658. * delimiter (one character only).
  6659. * </p>
  6660. * @param enclosure string[optional] <p>
  6661. * The optional enclosure parameter sets the field
  6662. * enclosure (one character only).
  6663. * </p>
  6664. * @return int the length of the written string&return.falseforfailure;.
  6665. */
  6666. function fputcsv ($handle, array $fields, $delimiter = null, $enclosure = null) {}
  6667. /**
  6668. * Portable advisory file locking
  6669. * @link http://www.php.net/manual/en/function.flock.php
  6670. * @param handle resource &fs.file.pointer;
  6671. * @param operation int <p>
  6672. * operation is one of the following:
  6673. * LOCK_SH to acquire a shared lock (reader).
  6674. * @param wouldblock int[optional] <p>
  6675. * The optional third argument is set to true if the lock would block
  6676. * (EWOULDBLOCK errno condition). (not supported on Windows)
  6677. * </p>
  6678. * @return bool Returns true on success or false on failure.
  6679. */
  6680. function flock ($handle, $operation, &$wouldblock = null) {}
  6681. /**
  6682. * Extracts all meta tag content attributes from a file and returns an array
  6683. * @link http://www.php.net/manual/en/function.get-meta-tags.php
  6684. * @param filename string <p>
  6685. * The path to the HTML file, as a string. This can be a local file or an
  6686. * URL.
  6687. * </p>
  6688. * <p>
  6689. * What get_meta_tags parses
  6690. * ]]>
  6691. * (pay attention to line endings - PHP uses a native function to
  6692. * parse the input, so a Mac file won't work on Unix).
  6693. * </p>
  6694. * @param use_include_path bool[optional] <p>
  6695. * Setting use_include_path to true will result
  6696. * in PHP trying to open the file along the standard include path as per
  6697. * the include_path directive.
  6698. * This is used for local files, not URLs.
  6699. * </p>
  6700. * @return array an array with all the parsed meta tags.
  6701. * </p>
  6702. * <p>
  6703. * The value of the name property becomes the key, the value of the content
  6704. * property becomes the value of the returned array, so you can easily use
  6705. * standard array functions to traverse it or access single values.
  6706. * Special characters in the value of the name property are substituted with
  6707. * '_', the rest is converted to lower case. If two meta tags have the same
  6708. * name, only the last one is returned.
  6709. */
  6710. function get_meta_tags ($filename, $use_include_path = null) {}
  6711. /**
  6712. * Set read file buffering on the given stream
  6713. * @link http://www.php.net/manual/en/function.stream-set-read-buffer.php
  6714. * @param stream resource <p>
  6715. * The file pointer.
  6716. * </p>
  6717. * @param buffer int <p>
  6718. * The number of bytes to buffer. If buffer
  6719. * is 0 then read operations are unbuffered. This ensures that all reads
  6720. * with fread are completed before other processes are
  6721. * allowed to write to that output stream.
  6722. * </p>
  6723. * @return int 0 on success, or EOF if the request
  6724. * cannot be honored.
  6725. */
  6726. function stream_set_read_buffer ($stream, $buffer) {}
  6727. /**
  6728. * Sets write file buffering on the given stream
  6729. * @link http://www.php.net/manual/en/function.stream-set-write-buffer.php
  6730. * @param stream resource <p>
  6731. * The file pointer.
  6732. * </p>
  6733. * @param buffer int <p>
  6734. * The number of bytes to buffer. If buffer
  6735. * is 0 then write operations are unbuffered. This ensures that all writes
  6736. * with fwrite are completed before other processes are
  6737. * allowed to write to that output stream.
  6738. * </p>
  6739. * @return int 0 on success, or EOF if the request cannot be honored.
  6740. */
  6741. function stream_set_write_buffer ($stream, $buffer) {}
  6742. /**
  6743. * &Alias; <function>stream_set_write_buffer</function>
  6744. * @link http://www.php.net/manual/en/function.set-file-buffer.php
  6745. * @param fp
  6746. * @param buffer
  6747. */
  6748. function set_file_buffer ($fp, $buffer) {}
  6749. /**
  6750. * @param fp
  6751. * @param chunk_size
  6752. */
  6753. function stream_set_chunk_size ($fp, $chunk_size) {}
  6754. /**
  6755. * &Alias; <function>stream_set_blocking</function>
  6756. * @link http://www.php.net/manual/en/function.set-socket-blocking.php
  6757. * @param socket
  6758. * @param mode
  6759. */
  6760. function set_socket_blocking ($socket, $mode) {}
  6761. /**
  6762. * Set blocking/non-blocking mode on a stream
  6763. * @link http://www.php.net/manual/en/function.stream-set-blocking.php
  6764. * @param stream resource <p>
  6765. * The stream.
  6766. * </p>
  6767. * @param mode int <p>
  6768. * If mode is 0, the given stream
  6769. * will be switched to non-blocking mode, and if 1, it
  6770. * will be switched to blocking mode. This affects calls like
  6771. * fgets and fread
  6772. * that read from the stream. In non-blocking mode an
  6773. * fgets call will always return right away
  6774. * while in blocking mode it will wait for data to become available
  6775. * on the stream.
  6776. * </p>
  6777. * @return bool Returns true on success or false on failure.
  6778. */
  6779. function stream_set_blocking ($stream, $mode) {}
  6780. /**
  6781. * &Alias; <function>stream_set_blocking</function>
  6782. * @link http://www.php.net/manual/en/function.socket-set-blocking.php
  6783. * @param socket
  6784. * @param mode
  6785. */
  6786. function socket_set_blocking ($socket, $mode) {}
  6787. /**
  6788. * Retrieves header/meta data from streams/file pointers
  6789. * @link http://www.php.net/manual/en/function.stream-get-meta-data.php
  6790. * @param stream resource <p>
  6791. * The stream can be any stream created by fopen,
  6792. * fsockopen and pfsockopen.
  6793. * </p>
  6794. * @return array The result array contains the following items:
  6795. * </p>
  6796. * <p>
  6797. * timed_out (bool) - true if the stream
  6798. * timed out while waiting for data on the last call to
  6799. * fread or fgets.
  6800. * </p>
  6801. * <p>
  6802. * blocked (bool) - true if the stream is
  6803. * in blocking IO mode. See stream_set_blocking.
  6804. * </p>
  6805. * <p>
  6806. * eof (bool) - true if the stream has reached
  6807. * end-of-file. Note that for socket streams this member can be true
  6808. * even when unread_bytes is non-zero. To
  6809. * determine if there is more data to be read, use
  6810. * feof instead of reading this item.
  6811. * </p>
  6812. * <p>
  6813. * unread_bytes (int) - the number of bytes
  6814. * currently contained in the PHP's own internal buffer.
  6815. * </p>
  6816. * You shouldn't use this value in a script.
  6817. * <p>
  6818. * stream_type (string) - a label describing
  6819. * the underlying implementation of the stream.
  6820. * </p>
  6821. * <p>
  6822. * wrapper_type (string) - a label describing
  6823. * the protocol wrapper implementation layered over the stream.
  6824. * See for more information about wrappers.
  6825. * </p>
  6826. * <p>
  6827. * wrapper_data (mixed) - wrapper specific
  6828. * data attached to this stream. See for
  6829. * more information about wrappers and their wrapper data.
  6830. * </p>
  6831. * <p>
  6832. * filters (array) - and array containing
  6833. * the names of any filters that have been stacked onto this stream.
  6834. * Documentation on filters can be found in the
  6835. * Filters appendix.
  6836. * </p>
  6837. * <p>
  6838. * mode (string) - the type of access required for
  6839. * this stream (see Table 1 of the fopen() reference)
  6840. * </p>
  6841. * <p>
  6842. * seekable (bool) - whether the current stream can
  6843. * be seeked.
  6844. * </p>
  6845. * <p>
  6846. * uri (string) - the URI/filename associated with this
  6847. * stream.
  6848. */
  6849. function stream_get_meta_data ($stream) {}
  6850. /**
  6851. * Gets line from stream resource up to a given delimiter
  6852. * @link http://www.php.net/manual/en/function.stream-get-line.php
  6853. * @param handle resource <p>
  6854. * A valid file handle.
  6855. * </p>
  6856. * @param length int <p>
  6857. * The number of bytes to read from the handle.
  6858. * </p>
  6859. * @param ending string[optional] <p>
  6860. * An optional string delimiter.
  6861. * </p>
  6862. * @return string a string of up to length bytes read from the file
  6863. * pointed to by handle.
  6864. * </p>
  6865. * <p>
  6866. * If an error occurs, returns false.
  6867. */
  6868. function stream_get_line ($handle, $length, $ending = null) {}
  6869. /**
  6870. * Register a URL wrapper implemented as a PHP class
  6871. * @link http://www.php.net/manual/en/function.stream-wrapper-register.php
  6872. * @param protocol string <p>
  6873. * The wrapper name to be registered.
  6874. * </p>
  6875. * @param classname string <p>
  6876. * The classname which implements the protocol.
  6877. * </p>
  6878. * @param flags int[optional] <p>
  6879. * Should be set to STREAM_IS_URL if
  6880. * protocol is a URL protocol. Default is 0, local
  6881. * stream.
  6882. * </p>
  6883. * @return bool Returns true on success or false on failure.
  6884. * </p>
  6885. * <p>
  6886. * stream_wrapper_register will return false if the
  6887. * protocol already has a handler.
  6888. */
  6889. function stream_wrapper_register ($protocol, $classname, $flags = null) {}
  6890. /**
  6891. * &Alias; <function>stream_wrapper_register</function>
  6892. * @link http://www.php.net/manual/en/function.stream-register-wrapper.php
  6893. * @param protocol
  6894. * @param classname
  6895. * @param flags[optional]
  6896. */
  6897. function stream_register_wrapper ($protocol, $classname, $flags) {}
  6898. /**
  6899. * Unregister a URL wrapper
  6900. * @link http://www.php.net/manual/en/function.stream-wrapper-unregister.php
  6901. * @param protocol string <p>
  6902. * </p>
  6903. * @return bool Returns true on success or false on failure.
  6904. */
  6905. function stream_wrapper_unregister ($protocol) {}
  6906. /**
  6907. * Restores a previously unregistered built-in wrapper
  6908. * @link http://www.php.net/manual/en/function.stream-wrapper-restore.php
  6909. * @param protocol string <p>
  6910. * </p>
  6911. * @return bool Returns true on success or false on failure.
  6912. */
  6913. function stream_wrapper_restore ($protocol) {}
  6914. /**
  6915. * Retrieve list of registered streams
  6916. * @link http://www.php.net/manual/en/function.stream-get-wrappers.php
  6917. * @return array an indexed array containing the name of all stream wrappers
  6918. * available on the running system.
  6919. */
  6920. function stream_get_wrappers () {}
  6921. /**
  6922. * Retrieve list of registered socket transports
  6923. * @link http://www.php.net/manual/en/function.stream-get-transports.php
  6924. * @return array an indexed array of socket transports names.
  6925. */
  6926. function stream_get_transports () {}
  6927. /**
  6928. * Resolve filename against the include path
  6929. * @link http://www.php.net/manual/en/function.stream-resolve-include-path.php
  6930. * @param filename string <p>
  6931. * The filename to resolve.
  6932. * </p>
  6933. * @param context resource[optional] <p>
  6934. * A valid context resource created with stream_context_create.
  6935. * </p>
  6936. * @return string a string containing the resolved absolute filename, &return.falseforfailure;.
  6937. */
  6938. function stream_resolve_include_path ($filename, $context = null) {}
  6939. /**
  6940. * Checks if a stream is a local stream
  6941. * @link http://www.php.net/manual/en/function.stream-is-local.php
  6942. * @param stream_or_url mixed <p>
  6943. * The stream resource or URL to check.
  6944. * </p>
  6945. * @return bool Returns true on success or false on failure.
  6946. */
  6947. function stream_is_local ($stream_or_url) {}
  6948. /**
  6949. * Fetches all the headers sent by the server in response to a HTTP request
  6950. * @link http://www.php.net/manual/en/function.get-headers.php
  6951. * @param url string <p>
  6952. * The target URL.
  6953. * </p>
  6954. * @param format int[optional] <p>
  6955. * If the optional format parameter is set to non-zero,
  6956. * get_headers parses the response and sets the
  6957. * array's keys.
  6958. * </p>
  6959. * @return array an indexed or associative array with the headers, or false on
  6960. * failure.
  6961. */
  6962. function get_headers ($url, $format = null) {}
  6963. /**
  6964. * Set timeout period on a stream
  6965. * @link http://www.php.net/manual/en/function.stream-set-timeout.php
  6966. * @param stream resource <p>
  6967. * The target stream.
  6968. * </p>
  6969. * @param seconds int <p>
  6970. * The seconds part of the timeout to be set.
  6971. * </p>
  6972. * @param microseconds int[optional] <p>
  6973. * The microseconds part of the timeout to be set.
  6974. * </p>
  6975. * @return bool Returns true on success or false on failure.
  6976. */
  6977. function stream_set_timeout ($stream, $seconds, $microseconds = null) {}
  6978. /**
  6979. * &Alias; <function>stream_set_timeout</function>
  6980. * @link http://www.php.net/manual/en/function.socket-set-timeout.php
  6981. * @param stream
  6982. * @param seconds
  6983. * @param microseconds
  6984. */
  6985. function socket_set_timeout ($stream, $seconds, $microseconds) {}
  6986. /**
  6987. * &Alias; <function>stream_get_meta_data</function>
  6988. * @link http://www.php.net/manual/en/function.socket-get-status.php
  6989. * @param fp
  6990. */
  6991. function socket_get_status ($fp) {}
  6992. /**
  6993. * Returns canonicalized absolute pathname
  6994. * @link http://www.php.net/manual/en/function.realpath.php
  6995. * @param path string <p>
  6996. * The path being checked.
  6997. * <p>
  6998. * Whilst a path must be supplied, the value can be blank or &null;
  6999. * In these cases, the value is interpreted as the current directory.
  7000. * </p>
  7001. * </p>
  7002. * @return string the canonicalized absolute pathname on success. The resulting path
  7003. * will have no symbolic link, '/./' or '/../' components.
  7004. * </p>
  7005. * <p>
  7006. * realpath returns false on failure, e.g. if
  7007. * the file does not exist.
  7008. * </p>
  7009. * <p>
  7010. * The running script must have executable permissions on all directories in
  7011. * the hierarchy, otherwise realpath will return
  7012. * false.
  7013. */
  7014. function realpath ($path) {}
  7015. /**
  7016. * Match filename against a pattern
  7017. * @link http://www.php.net/manual/en/function.fnmatch.php
  7018. * @param pattern string <p>
  7019. * The shell wildcard pattern.
  7020. * </p>
  7021. * @param string string <p>
  7022. * The tested string. This function is especially useful for filenames,
  7023. * but may also be used on regular strings.
  7024. * </p>
  7025. * <p>
  7026. * The average user may be used to shell patterns or at least in their
  7027. * simplest form to '?' and '*'
  7028. * wildcards so using fnmatch instead of
  7029. * preg_match for
  7030. * frontend search expression input may be way more convenient for
  7031. * non-programming users.
  7032. * </p>
  7033. * @param flags int[optional] <p>
  7034. * The value of flags can be any combination of
  7035. * the following flags, joined with the
  7036. * binary OR (|) operator.
  7037. * <table>
  7038. * A list of possible flags for fnmatch
  7039. * <tr valign="top">
  7040. * <td>Flag</td>
  7041. * <td>Description</td>
  7042. * </tr>
  7043. * <tr valign="top">
  7044. * <td>FNM_NOESCAPE</td>
  7045. * <td>
  7046. * Disable backslash escaping.
  7047. * </td>
  7048. * </tr>
  7049. * <tr valign="top">
  7050. * <td>FNM_PATHNAME</td>
  7051. * <td>
  7052. * Slash in string only matches slash in the given pattern.
  7053. * </td>
  7054. * </tr>
  7055. * <tr valign="top">
  7056. * <td>FNM_PERIOD</td>
  7057. * <td>
  7058. * Leading period in string must be exactly matched by period in the given pattern.
  7059. * </td>
  7060. * </tr>
  7061. * <tr valign="top">
  7062. * <td>FNM_CASEFOLD</td>
  7063. * <td>
  7064. * Caseless match. Part of the GNU extension.
  7065. * </td>
  7066. * </tr>
  7067. * </table>
  7068. * </p>
  7069. * @return bool true if there is a match, false otherwise.
  7070. */
  7071. function fnmatch ($pattern, $string, $flags = null) {}
  7072. /**
  7073. * Open Internet or Unix domain socket connection
  7074. * @link http://www.php.net/manual/en/function.fsockopen.php
  7075. * @param hostname string <p>
  7076. * If OpenSSL support is
  7077. * installed, you may prefix the hostname
  7078. * with either ssl:// or tls:// to
  7079. * use an SSL or TLS client connection over TCP/IP to connect to the
  7080. * remote host.
  7081. * </p>
  7082. * @param port int[optional] <p>
  7083. * The port number.
  7084. * </p>
  7085. * @param errno int[optional] <p>
  7086. * If provided, holds the system level error number that occurred in the
  7087. * system-level connect() call.
  7088. * </p>
  7089. * <p>
  7090. * If the value returned in errno is
  7091. * 0 and the function returned false, it is an
  7092. * indication that the error occurred before the
  7093. * connect() call. This is most likely due to a
  7094. * problem initializing the socket.
  7095. * </p>
  7096. * @param errstr string[optional] <p>
  7097. * The error message as a string.
  7098. * </p>
  7099. * @param timeout float[optional] <p>
  7100. * The connection timeout, in seconds.
  7101. * </p>
  7102. * <p>
  7103. * If you need to set a timeout for reading/writing data over the
  7104. * socket, use stream_set_timeout, as the
  7105. * timeout parameter to
  7106. * fsockopen only applies while connecting the
  7107. * socket.
  7108. * </p>
  7109. * @return resource fsockopen returns a file pointer which may be used
  7110. * together with the other file functions (such as
  7111. * fgets, fgetss,
  7112. * fwrite, fclose, and
  7113. * feof). If the call fails, it will return false
  7114. */
  7115. function fsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  7116. /**
  7117. * Open persistent Internet or Unix domain socket connection
  7118. * @link http://www.php.net/manual/en/function.pfsockopen.php
  7119. * @param hostname string
  7120. * @param port int[optional]
  7121. * @param errno int[optional]
  7122. * @param errstr string[optional]
  7123. * @param timeout float[optional]
  7124. * @return resource
  7125. */
  7126. function pfsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  7127. /**
  7128. * Pack data into binary string
  7129. * @link http://www.php.net/manual/en/function.pack.php
  7130. * @param format string <p>
  7131. * The format string consists of format codes
  7132. * followed by an optional repeater argument. The repeater argument can
  7133. * be either an integer value or * for repeating to
  7134. * the end of the input data. For a, A, h, H the repeat count specifies
  7135. * how many characters of one data argument are taken, for @ it is the
  7136. * absolute position where to put the next data, for everything else the
  7137. * repeat count specifies how many data arguments are consumed and packed
  7138. * into the resulting binary string.
  7139. * </p>
  7140. * <p>
  7141. * Currently implemented formats are:
  7142. * <table>
  7143. * pack format characters
  7144. * <tr valign="top">
  7145. * <td>Code</td>
  7146. * <td>Description</td>
  7147. * </tr>
  7148. * <tr valign="top">
  7149. * <td>a</td>
  7150. * <td>NUL-padded string</td>
  7151. * </tr>
  7152. * <tr valign="top">
  7153. * <td>A</td>
  7154. * <td>SPACE-padded string</td></tr>
  7155. * <tr valign="top">
  7156. * <td>h</td>
  7157. * <td>Hex string, low nibble first</td></tr>
  7158. * <tr valign="top">
  7159. * <td>H</td>
  7160. * <td>Hex string, high nibble first</td></tr>
  7161. * <tr valign="top"><td>c</td><td>signed char</td></tr>
  7162. * <tr valign="top">
  7163. * <td>C</td>
  7164. * <td>unsigned char</td></tr>
  7165. * <tr valign="top">
  7166. * <td>s</td>
  7167. * <td>signed short (always 16 bit, machine byte order)</td>
  7168. * </tr>
  7169. * <tr valign="top">
  7170. * <td>S</td>
  7171. * <td>unsigned short (always 16 bit, machine byte order)</td>
  7172. * </tr>
  7173. * <tr valign="top">
  7174. * <td>n</td>
  7175. * <td>unsigned short (always 16 bit, big endian byte order)</td>
  7176. * </tr>
  7177. * <tr valign="top">
  7178. * <td>v</td>
  7179. * <td>unsigned short (always 16 bit, little endian byte order)</td>
  7180. * </tr>
  7181. * <tr valign="top">
  7182. * <td>i</td>
  7183. * <td>signed integer (machine dependent size and byte order)</td>
  7184. * </tr>
  7185. * <tr valign="top">
  7186. * <td>I</td>
  7187. * <td>unsigned integer (machine dependent size and byte order)</td>
  7188. * </tr>
  7189. * <tr valign="top">
  7190. * <td>l</td>
  7191. * <td>signed long (always 32 bit, machine byte order)</td>
  7192. * </tr>
  7193. * <tr valign="top">
  7194. * <td>L</td>
  7195. * <td>unsigned long (always 32 bit, machine byte order)</td>
  7196. * </tr>
  7197. * <tr valign="top">
  7198. * <td>N</td>
  7199. * <td>unsigned long (always 32 bit, big endian byte order)</td>
  7200. * </tr>
  7201. * <tr valign="top">
  7202. * <td>V</td>
  7203. * <td>unsigned long (always 32 bit, little endian byte order)</td>
  7204. * </tr>
  7205. * <tr valign="top">
  7206. * <td>f</td>
  7207. * <td>float (machine dependent size and representation)</td>
  7208. * </tr>
  7209. * <tr valign="top">
  7210. * <td>d</td>
  7211. * <td>double (machine dependent size and representation)</td>
  7212. * </tr>
  7213. * <tr valign="top">
  7214. * <td>x</td>
  7215. * <td>NUL byte</td>
  7216. * </tr>
  7217. * <tr valign="top">
  7218. * <td>X</td>
  7219. * <td>Back up one byte</td>
  7220. * </tr>
  7221. * <tr valign="top">
  7222. * <td>@</td>
  7223. * <td>NUL-fill to absolute position</td>
  7224. * </tr>
  7225. * </table>
  7226. * </p>
  7227. * @param args mixed[optional] <p>
  7228. * </p>
  7229. * @param _ mixed[optional]
  7230. * @return string a binary string containing data.
  7231. */
  7232. function pack ($format, $args = null, $_ = null) {}
  7233. /**
  7234. * Unpack data from binary string
  7235. * @link http://www.php.net/manual/en/function.unpack.php
  7236. * @param format string <p>
  7237. * See pack for an explanation of the format codes.
  7238. * </p>
  7239. * @param data string <p>
  7240. * The packed data.
  7241. * </p>
  7242. * @return array an associative array containing unpacked elements of binary
  7243. * string.
  7244. */
  7245. function unpack ($format, $data) {}
  7246. /**
  7247. * Tells what the user's browser is capable of
  7248. * @link http://www.php.net/manual/en/function.get-browser.php
  7249. * @param user_agent string[optional] <p>
  7250. * The User Agent to be analyzed. By default, the value of HTTP
  7251. * User-Agent header is used; however, you can alter this (i.e., look up
  7252. * another browser's info) by passing this parameter.
  7253. * </p>
  7254. * <p>
  7255. * You can bypass this parameter with a &null; value.
  7256. * </p>
  7257. * @param return_array bool[optional] <p>
  7258. * If set to true, this function will return an array
  7259. * instead of an object.
  7260. * </p>
  7261. * @return mixed The information is returned in an object or an array which will contain
  7262. * various data elements representing, for instance, the browser's major and
  7263. * minor version numbers and ID string; true/false values for features
  7264. * such as frames, JavaScript, and cookies; and so forth.
  7265. * </p>
  7266. * <p>
  7267. * The cookies value simply means that the browser
  7268. * itself is capable of accepting cookies and does not mean the user has
  7269. * enabled the browser to accept cookies or not. The only way to test if
  7270. * cookies are accepted is to set one with setcookie,
  7271. * reload, and check for the value.
  7272. */
  7273. function get_browser ($user_agent = null, $return_array = null) {}
  7274. /**
  7275. * One-way string hashing
  7276. * @link http://www.php.net/manual/en/function.crypt.php
  7277. * @param str string <p>
  7278. * The string to be hashed.
  7279. * </p>
  7280. * @param salt string[optional] <p>
  7281. * An optional salt string to base the hashing on. If not provided, the
  7282. * behaviour is defined by the algorithm implementation and can lead to
  7283. * unexpected results.
  7284. * </p>
  7285. * @return string the hashed string or a string that is shorter than 13 characters
  7286. * and is guaranteed to differ from the salt on failure.
  7287. */
  7288. function crypt ($str, $salt = null) {}
  7289. /**
  7290. * Open directory handle
  7291. * @link http://www.php.net/manual/en/function.opendir.php
  7292. * @param path string <p>
  7293. * The directory path that is to be opened
  7294. * </p>
  7295. * @param context resource[optional] <p>
  7296. * For a description of the context parameter,
  7297. * refer to the streams section of
  7298. * the manual.
  7299. * </p>
  7300. * @return resource a directory handle resource on success, or
  7301. * false on failure.
  7302. * </p>
  7303. * <p>
  7304. * If path is not a valid directory or the
  7305. * directory can not be opened due to permission restrictions or
  7306. * filesystem errors, opendir returns false and
  7307. * generates a PHP error of level
  7308. * E_WARNING. You can suppress the error output of
  7309. * opendir by prepending
  7310. * '@' to the
  7311. * front of the function name.
  7312. */
  7313. function opendir ($path, $context = null) {}
  7314. /**
  7315. * Close directory handle
  7316. * @link http://www.php.net/manual/en/function.closedir.php
  7317. * @param dir_handle resource[optional] <p>
  7318. * The directory handle resource previously opened
  7319. * with opendir. If the directory handle is
  7320. * not specified, the last link opened by opendir
  7321. * is assumed.
  7322. * </p>
  7323. * @return void
  7324. */
  7325. function closedir ($dir_handle = null) {}
  7326. /**
  7327. * Change directory
  7328. * @link http://www.php.net/manual/en/function.chdir.php
  7329. * @param directory string <p>
  7330. * The new current directory
  7331. * </p>
  7332. * @return bool Returns true on success or false on failure.
  7333. */
  7334. function chdir ($directory) {}
  7335. /**
  7336. * Change the root directory
  7337. * @link http://www.php.net/manual/en/function.chroot.php
  7338. * @param directory string <p>
  7339. * The path to change the root directory to.
  7340. * </p>
  7341. * @return bool Returns true on success or false on failure.
  7342. */
  7343. function chroot ($directory) {}
  7344. /**
  7345. * Gets the current working directory
  7346. * @link http://www.php.net/manual/en/function.getcwd.php
  7347. * @return string the current working directory on success, or false on
  7348. * failure.
  7349. * </p>
  7350. * <p>
  7351. * On some Unix variants, getcwd will return
  7352. * false if any one of the parent directories does not have the
  7353. * readable or search mode set, even if the current directory
  7354. * does. See chmod for more information on
  7355. * modes and permissions.
  7356. */
  7357. function getcwd () {}
  7358. /**
  7359. * Rewind directory handle
  7360. * @link http://www.php.net/manual/en/function.rewinddir.php
  7361. * @param dir_handle resource[optional] <p>
  7362. * The directory handle resource previously opened
  7363. * with opendir. If the directory handle is
  7364. * not specified, the last link opened by opendir
  7365. * is assumed.
  7366. * </p>
  7367. * @return void
  7368. */
  7369. function rewinddir ($dir_handle = null) {}
  7370. /**
  7371. * Read entry from directory handle
  7372. * @link http://www.php.net/manual/en/function.readdir.php
  7373. * @param dir_handle resource[optional] <p>
  7374. * The directory handle resource previously opened
  7375. * with opendir. If the directory handle is
  7376. * not specified, the last link opened by opendir
  7377. * is assumed.
  7378. * </p>
  7379. * @return string the entry name on success&return.falseforfailure;.
  7380. */
  7381. function readdir ($dir_handle = null) {}
  7382. /**
  7383. * Return an instance of the Directory class
  7384. * @link http://www.php.net/manual/en/function.dir.php
  7385. * @param directory string <p>
  7386. * Directory to open
  7387. * </p>
  7388. * @param context resource[optional] <p>
  7389. * &note.context-support;
  7390. * </p>
  7391. * @return Directory an instance of Directory, or &null; with
  7392. * wrong parameters, or false in case of another error.
  7393. */
  7394. function dir ($directory, $context = null) {}
  7395. /**
  7396. * List files and directories inside the specified path
  7397. * @link http://www.php.net/manual/en/function.scandir.php
  7398. * @param directory string <p>
  7399. * The directory that will be scanned.
  7400. * </p>
  7401. * @param sorting_order int[optional] <p>
  7402. * By default, the sorted order is alphabetical in ascending order. If
  7403. * the optional sorting_order is set to
  7404. * SCANDIR_SORT_DESCENDING, then the sort order is
  7405. * alphabetical in descending order. If it is set to
  7406. * SCANDIR_SORT_NONE then the result is unsorted.
  7407. * </p>
  7408. * @param context resource[optional] <p>
  7409. * For a description of the context parameter,
  7410. * refer to the streams section of
  7411. * the manual.
  7412. * </p>
  7413. * @return array an array of filenames on success, or false on
  7414. * failure. If directory is not a directory, then
  7415. * boolean false is returned, and an error of level
  7416. * E_WARNING is generated.
  7417. */
  7418. function scandir ($directory, $sorting_order = null, $context = null) {}
  7419. /**
  7420. * Find pathnames matching a pattern
  7421. * @link http://www.php.net/manual/en/function.glob.php
  7422. * @param pattern string <p>
  7423. * The pattern. No tilde expansion or parameter substitution is done.
  7424. * </p>
  7425. * @param flags int[optional] <p>
  7426. * Valid flags:
  7427. * GLOB_MARK - Adds a slash to each directory returned
  7428. * @return array an array containing the matched files/directories, an empty array
  7429. * if no file matched or false on error.
  7430. * </p>
  7431. * <p>
  7432. * On some systems it is impossible to distinguish between empty match and an
  7433. * error.
  7434. */
  7435. function glob ($pattern, $flags = null) {}
  7436. /**
  7437. * Gets last access time of file
  7438. * @link http://www.php.net/manual/en/function.fileatime.php
  7439. * @param filename string <p>
  7440. * Path to the file.
  7441. * </p>
  7442. * @return int the time the file was last accessed, &return.falseforfailure;.
  7443. * The time is returned as a Unix timestamp.
  7444. */
  7445. function fileatime ($filename) {}
  7446. /**
  7447. * Gets inode change time of file
  7448. * @link http://www.php.net/manual/en/function.filectime.php
  7449. * @param filename string <p>
  7450. * Path to the file.
  7451. * </p>
  7452. * @return int the time the file was last changed, &return.falseforfailure;.
  7453. * The time is returned as a Unix timestamp.
  7454. */
  7455. function filectime ($filename) {}
  7456. /**
  7457. * Gets file group
  7458. * @link http://www.php.net/manual/en/function.filegroup.php
  7459. * @param filename string <p>
  7460. * Path to the file.
  7461. * </p>
  7462. * @return int the group ID of the file, or false if
  7463. * an error occurs. The group ID is returned in numerical format, use
  7464. * posix_getgrgid to resolve it to a group name.
  7465. * Upon failure, false is returned.
  7466. */
  7467. function filegroup ($filename) {}
  7468. /**
  7469. * Gets file inode
  7470. * @link http://www.php.net/manual/en/function.fileinode.php
  7471. * @param filename string <p>
  7472. * Path to the file.
  7473. * </p>
  7474. * @return int the inode number of the file, &return.falseforfailure;.
  7475. */
  7476. function fileinode ($filename) {}
  7477. /**
  7478. * Gets file modification time
  7479. * @link http://www.php.net/manual/en/function.filemtime.php
  7480. * @param filename string <p>
  7481. * Path to the file.
  7482. * </p>
  7483. * @return int the time the file was last modified, &return.falseforfailure;.
  7484. * The time is returned as a Unix timestamp, which is
  7485. * suitable for the date function.
  7486. */
  7487. function filemtime ($filename) {}
  7488. /**
  7489. * Gets file owner
  7490. * @link http://www.php.net/manual/en/function.fileowner.php
  7491. * @param filename string <p>
  7492. * Path to the file.
  7493. * </p>
  7494. * @return int the user ID of the owner of the file, &return.falseforfailure;.
  7495. * The user ID is returned in numerical format, use
  7496. * posix_getpwuid to resolve it to a username.
  7497. */
  7498. function fileowner ($filename) {}
  7499. /**
  7500. * Gets file permissions
  7501. * @link http://www.php.net/manual/en/function.fileperms.php
  7502. * @param filename string <p>
  7503. * Path to the file.
  7504. * </p>
  7505. * @return int the file's permissions as a numeric mode. Lower bits of this mode
  7506. * are the same as the permissions expected by chmod,
  7507. * however on most platforms the return value will also include information on
  7508. * the type of file given as filename. The examples
  7509. * below demonstrate how to test the return value for specific permissions and
  7510. * file types on POSIX systems, including Linux and Mac OS X.
  7511. * </p>
  7512. * <p>
  7513. * For local files, the specific return value is that of the
  7514. * st_mode member of the structure returned by the C
  7515. * library's stat function. Exactly which bits are set
  7516. * can vary from platform to platform, and looking up your specific platform's
  7517. * documentation is recommended if parsing the non-permission bits of the
  7518. * return value is required.
  7519. */
  7520. function fileperms ($filename) {}
  7521. /**
  7522. * Gets file size
  7523. * @link http://www.php.net/manual/en/function.filesize.php
  7524. * @param filename string <p>
  7525. * Path to the file.
  7526. * </p>
  7527. * @return int the size of the file in bytes, or false (and generates an error
  7528. * of level E_WARNING) in case of an error.
  7529. */
  7530. function filesize ($filename) {}
  7531. /**
  7532. * Gets file type
  7533. * @link http://www.php.net/manual/en/function.filetype.php
  7534. * @param filename string <p>
  7535. * Path to the file.
  7536. * </p>
  7537. * @return string the type of the file. Possible values are fifo, char,
  7538. * dir, block, link, file, socket and unknown.
  7539. * </p>
  7540. * <p>
  7541. * Returns false if an error occurs. filetype will also
  7542. * produce an E_NOTICE message if the stat call fails
  7543. * or if the file type is unknown.
  7544. */
  7545. function filetype ($filename) {}
  7546. /**
  7547. * Checks whether a file or directory exists
  7548. * @link http://www.php.net/manual/en/function.file-exists.php
  7549. * @param filename string <p>
  7550. * Path to the file or directory.
  7551. * </p>
  7552. * <p>
  7553. * On windows, use //computername/share/filename or
  7554. * \\computername\share\filename to check files on
  7555. * network shares.
  7556. * </p>
  7557. * @return bool true if the file or directory specified by
  7558. * filename exists; false otherwise.
  7559. * </p>
  7560. * <p>
  7561. * This function will return false for symlinks pointing to non-existing
  7562. * files.
  7563. * </p>
  7564. * <p>
  7565. * This function returns false for files inaccessible due to safe mode restrictions. However these
  7566. * files still can be included if
  7567. * they are located in safe_mode_include_dir.
  7568. * </p>
  7569. * <p>
  7570. * The check is done using the real UID/GID instead of the effective one.
  7571. */
  7572. function file_exists ($filename) {}
  7573. /**
  7574. * Tells whether the filename is writable
  7575. * @link http://www.php.net/manual/en/function.is-writable.php
  7576. * @param filename string <p>
  7577. * The filename being checked.
  7578. * </p>
  7579. * @return bool true if the filename exists and is
  7580. * writable.
  7581. */
  7582. function is_writable ($filename) {}
  7583. /**
  7584. * &Alias; <function>is_writable</function>
  7585. * @link http://www.php.net/manual/en/function.is-writeable.php
  7586. * @param filename
  7587. */
  7588. function is_writeable ($filename) {}
  7589. /**
  7590. * Tells whether a file exists and is readable
  7591. * @link http://www.php.net/manual/en/function.is-readable.php
  7592. * @param filename string <p>
  7593. * Path to the file.
  7594. * </p>
  7595. * @return bool true if the file or directory specified by
  7596. * filename exists and is readable, false otherwise.
  7597. */
  7598. function is_readable ($filename) {}
  7599. /**
  7600. * Tells whether the filename is executable
  7601. * @link http://www.php.net/manual/en/function.is-executable.php
  7602. * @param filename string <p>
  7603. * Path to the file.
  7604. * </p>
  7605. * @return bool true if the filename exists and is executable, or false on
  7606. * error.
  7607. */
  7608. function is_executable ($filename) {}
  7609. /**
  7610. * Tells whether the filename is a regular file
  7611. * @link http://www.php.net/manual/en/function.is-file.php
  7612. * @param filename string <p>
  7613. * Path to the file.
  7614. * </p>
  7615. * @return bool true if the filename exists and is a regular file, false
  7616. * otherwise.
  7617. */
  7618. function is_file ($filename) {}
  7619. /**
  7620. * Tells whether the filename is a directory
  7621. * @link http://www.php.net/manual/en/function.is-dir.php
  7622. * @param filename string <p>
  7623. * Path to the file. If filename is a relative
  7624. * filename, it will be checked relative to the current working
  7625. * directory. If filename is a symbolic or hard link
  7626. * then the link will be resolved and checked. If you have enabled &safemode;,
  7627. * or open_basedir further
  7628. * restrictions may apply.
  7629. * </p>
  7630. * @return bool true if the filename exists and is a directory, false
  7631. * otherwise.
  7632. */
  7633. function is_dir ($filename) {}
  7634. /**
  7635. * Tells whether the filename is a symbolic link
  7636. * @link http://www.php.net/manual/en/function.is-link.php
  7637. * @param filename string <p>
  7638. * Path to the file.
  7639. * </p>
  7640. * @return bool true if the filename exists and is a symbolic link, false
  7641. * otherwise.
  7642. */
  7643. function is_link ($filename) {}
  7644. /**
  7645. * Gives information about a file
  7646. * @link http://www.php.net/manual/en/function.stat.php
  7647. * @param filename string <p>
  7648. * Path to the file.
  7649. * </p>
  7650. * @return array <table>
  7651. * stat and fstat result
  7652. * format
  7653. * <tr valign="top">
  7654. * <td>Numeric</td>
  7655. * <td>Associative (since PHP 4.0.6)</td>
  7656. * <td>Description</td>
  7657. * </tr>
  7658. * <tr valign="top">
  7659. * <td>0</td>
  7660. * <td>dev</td>
  7661. * <td>device number</td>
  7662. * </tr>
  7663. * <tr valign="top">
  7664. * <td>1</td>
  7665. * <td>ino</td>
  7666. * <td>inode number *</td>
  7667. * </tr>
  7668. * <tr valign="top">
  7669. * <td>2</td>
  7670. * <td>mode</td>
  7671. * <td>inode protection mode</td>
  7672. * </tr>
  7673. * <tr valign="top">
  7674. * <td>3</td>
  7675. * <td>nlink</td>
  7676. * <td>number of links</td>
  7677. * </tr>
  7678. * <tr valign="top">
  7679. * <td>4</td>
  7680. * <td>uid</td>
  7681. * <td>userid of owner *</td>
  7682. * </tr>
  7683. * <tr valign="top">
  7684. * <td>5</td>
  7685. * <td>gid</td>
  7686. * <td>groupid of owner *</td>
  7687. * </tr>
  7688. * <tr valign="top">
  7689. * <td>6</td>
  7690. * <td>rdev</td>
  7691. * <td>device type, if inode device</td>
  7692. * </tr>
  7693. * <tr valign="top">
  7694. * <td>7</td>
  7695. * <td>size</td>
  7696. * <td>size in bytes</td>
  7697. * </tr>
  7698. * <tr valign="top">
  7699. * <td>8</td>
  7700. * <td>atime</td>
  7701. * <td>time of last access (Unix timestamp)</td>
  7702. * </tr>
  7703. * <tr valign="top">
  7704. * <td>9</td>
  7705. * <td>mtime</td>
  7706. * <td>time of last modification (Unix timestamp)</td>
  7707. * </tr>
  7708. * <tr valign="top">
  7709. * <td>10</td>
  7710. * <td>ctime</td>
  7711. * <td>time of last inode change (Unix timestamp)</td>
  7712. * </tr>
  7713. * <tr valign="top">
  7714. * <td>11</td>
  7715. * <td>blksize</td>
  7716. * <td>blocksize of filesystem IO **</td>
  7717. * </tr>
  7718. * <tr valign="top">
  7719. * <td>12</td>
  7720. * <td>blocks</td>
  7721. * <td>number of 512-byte blocks allocated **</td>
  7722. * </tr>
  7723. * </table>
  7724. * * On Windows this will always be 0.
  7725. * </p>
  7726. * <p>
  7727. * ** Only valid on systems supporting the st_blksize type - other
  7728. * systems (e.g. Windows) return -1.
  7729. * </p>
  7730. * <p>
  7731. * In case of error, stat returns false.
  7732. */
  7733. function stat ($filename) {}
  7734. /**
  7735. * Gives information about a file or symbolic link
  7736. * @link http://www.php.net/manual/en/function.lstat.php
  7737. * @param filename string <p>
  7738. * Path to a file or a symbolic link.
  7739. * </p>
  7740. * @return array See the manual page for stat for information on
  7741. * the structure of the array that lstat returns.
  7742. * This function is identical to the stat function
  7743. * except that if the filename parameter is a symbolic
  7744. * link, the status of the symbolic link is returned, not the status of the
  7745. * file pointed to by the symbolic link.
  7746. */
  7747. function lstat ($filename) {}
  7748. /**
  7749. * Changes file owner
  7750. * @link http://www.php.net/manual/en/function.chown.php
  7751. * @param filename string <p>
  7752. * Path to the file.
  7753. * </p>
  7754. * @param user mixed <p>
  7755. * A user name or number.
  7756. * </p>
  7757. * @return bool Returns true on success or false on failure.
  7758. */
  7759. function chown ($filename, $user) {}
  7760. /**
  7761. * Changes file group
  7762. * @link http://www.php.net/manual/en/function.chgrp.php
  7763. * @param filename string <p>
  7764. * Path to the file.
  7765. * </p>
  7766. * @param group mixed <p>
  7767. * A group name or number.
  7768. * </p>
  7769. * @return bool Returns true on success or false on failure.
  7770. */
  7771. function chgrp ($filename, $group) {}
  7772. /**
  7773. * Changes user ownership of symlink
  7774. * @link http://www.php.net/manual/en/function.lchown.php
  7775. * @param filename string <p>
  7776. * Path to the file.
  7777. * </p>
  7778. * @param user mixed <p>
  7779. * User name or number.
  7780. * </p>
  7781. * @return bool Returns true on success or false on failure.
  7782. */
  7783. function lchown ($filename, $user) {}
  7784. /**
  7785. * Changes group ownership of symlink
  7786. * @link http://www.php.net/manual/en/function.lchgrp.php
  7787. * @param filename string <p>
  7788. * Path to the symlink.
  7789. * </p>
  7790. * @param group mixed <p>
  7791. * The group specified by name or number.
  7792. * </p>
  7793. * @return bool Returns true on success or false on failure.
  7794. */
  7795. function lchgrp ($filename, $group) {}
  7796. /**
  7797. * Changes file mode
  7798. * @link http://www.php.net/manual/en/function.chmod.php
  7799. * @param filename string <p>
  7800. * Path to the file.
  7801. * </p>
  7802. * @param mode int <p>
  7803. * Note that mode is not automatically
  7804. * assumed to be an octal value, so strings (such as "g+w") will
  7805. * not work properly. To ensure the expected operation,
  7806. * you need to prefix mode with a zero (0):
  7807. * </p>
  7808. * <p>
  7809. * ]]>
  7810. * </p>
  7811. * <p>
  7812. * The mode parameter consists of three octal
  7813. * number components specifying access restrictions for the owner,
  7814. * the user group in which the owner is in, and to everybody else in
  7815. * this order. One component can be computed by adding up the needed
  7816. * permissions for that target user base. Number 1 means that you
  7817. * grant execute rights, number 2 means that you make the file
  7818. * writeable, number 4 means that you make the file readable. Add
  7819. * up these numbers to specify needed rights. You can also read more
  7820. * about modes on Unix systems with 'man 1 chmod'
  7821. * and 'man 2 chmod'.
  7822. * </p>
  7823. * <p>
  7824. * @return bool Returns true on success or false on failure.
  7825. */
  7826. function chmod ($filename, $mode) {}
  7827. /**
  7828. * Sets access and modification time of file
  7829. * @link http://www.php.net/manual/en/function.touch.php
  7830. * @param filename string <p>
  7831. * The name of the file being touched.
  7832. * </p>
  7833. * @param time int[optional] <p>
  7834. * The touch time. If time is not supplied,
  7835. * the current system time is used.
  7836. * </p>
  7837. * @param atime int[optional] <p>
  7838. * If present, the access time of the given filename is set to
  7839. * the value of atime. Otherwise, it is set to
  7840. * the value passed to the time parameter.
  7841. * If neither are present, the current system time is used.
  7842. * </p>
  7843. * @return bool Returns true on success or false on failure.
  7844. */
  7845. function touch ($filename, $time = null, $atime = null) {}
  7846. /**
  7847. * Clears file status cache
  7848. * @link http://www.php.net/manual/en/function.clearstatcache.php
  7849. * @param clear_realpath_cache bool[optional] <p>
  7850. * Whether to clear the realpath cache or not.
  7851. * </p>
  7852. * @param filename string[optional] <p>
  7853. * Clear the realpath cache for a specific filename; only used if
  7854. * clear_realpath_cache is true.
  7855. * </p>
  7856. * @return void
  7857. */
  7858. function clearstatcache ($clear_realpath_cache = null, $filename = null) {}
  7859. /**
  7860. * Returns the total size of a filesystem or disk partition
  7861. * @link http://www.php.net/manual/en/function.disk-total-space.php
  7862. * @param directory string <p>
  7863. * A directory of the filesystem or disk partition.
  7864. * </p>
  7865. * @return float the total number of bytes as a float
  7866. * &return.falseforfailure;.
  7867. */
  7868. function disk_total_space ($directory) {}
  7869. /**
  7870. * Returns available space on filesystem or disk partition
  7871. * @link http://www.php.net/manual/en/function.disk-free-space.php
  7872. * @param directory string <p>
  7873. * A directory of the filesystem or disk partition.
  7874. * </p>
  7875. * <p>
  7876. * Given a file name instead of a directory, the behaviour of the
  7877. * function is unspecified and may differ between operating systems and
  7878. * PHP versions.
  7879. * </p>
  7880. * @return float the number of available bytes as a float
  7881. * &return.falseforfailure;.
  7882. */
  7883. function disk_free_space ($directory) {}
  7884. /**
  7885. * &Alias; <function>disk_free_space</function>
  7886. * @link http://www.php.net/manual/en/function.diskfreespace.php
  7887. * @param path
  7888. */
  7889. function diskfreespace ($path) {}
  7890. /**
  7891. * Get realpath cache size
  7892. * @link http://www.php.net/manual/en/function.realpath-cache-size.php
  7893. * @return int how much memory realpath cache is using.
  7894. */
  7895. function realpath_cache_size () {}
  7896. /**
  7897. * Get realpath cache entries
  7898. * @link http://www.php.net/manual/en/function.realpath-cache-get.php
  7899. * @return array an array of realpath cache entries. The keys are original path
  7900. * entries, and the values are arrays of data items, containing the resolved
  7901. * path, expiration date, and other options kept in the cache.
  7902. */
  7903. function realpath_cache_get () {}
  7904. /**
  7905. * Send mail
  7906. * @link http://www.php.net/manual/en/function.mail.php
  7907. * @param to string <p>
  7908. * Receiver, or receivers of the mail.
  7909. * </p>
  7910. * <p>
  7911. * The formatting of this string must comply with
  7912. * RFC 2822. Some examples are:
  7913. * user@example.com
  7914. * user@example.com, anotheruser@example.com
  7915. * User &lt;user@example.com&gt;
  7916. * User &lt;user@example.com&gt;, Another User &lt;anotheruser@example.com&gt;
  7917. * </p>
  7918. * @param subject string <p>
  7919. * Subject of the email to be sent.
  7920. * </p>
  7921. * <p>
  7922. * Subject must satisfy RFC 2047.
  7923. * </p>
  7924. * @param message string <p>
  7925. * Message to be sent.
  7926. * </p>
  7927. * <p>
  7928. * Each line should be separated with a LF (\n). Lines should not be larger
  7929. * than 70 characters.
  7930. * </p>
  7931. * <p>
  7932. * (Windows only) When PHP is talking to a SMTP server directly, if a full
  7933. * stop is found on the start of a line, it is removed. To counter-act this,
  7934. * replace these occurrences with a double dot.
  7935. * ]]>
  7936. * </p>
  7937. * @param additional_headers string[optional] <p>
  7938. * String to be inserted at the end of the email header.
  7939. * </p>
  7940. * <p>
  7941. * This is typically used to add extra headers (From, Cc, and Bcc).
  7942. * Multiple extra headers should be separated with a CRLF (\r\n).
  7943. * </p>
  7944. * <p>
  7945. * When sending mail, the mail must contain
  7946. * a From header. This can be set with the
  7947. * additional_headers parameter, or a default
  7948. * can be set in &php.ini;.
  7949. * </p>
  7950. * <p>
  7951. * Failing to do this will result in an error
  7952. * message similar to Warning: mail(): "sendmail_from" not
  7953. * set in php.ini or custom "From:" header missing.
  7954. * The From header sets also
  7955. * Return-Path under Windows.
  7956. * </p>
  7957. * <p>
  7958. * If messages are not received, try using a LF (\n) only.
  7959. * Some poor quality Unix mail transfer agents replace LF by CRLF
  7960. * automatically (which leads to doubling CR if CRLF is used).
  7961. * This should be a last resort, as it does not comply with
  7962. * RFC 2822.
  7963. * </p>
  7964. * @param additional_parameters string[optional] <p>
  7965. * The additional_parameters parameter
  7966. * can be used to pass additional flags as command line options to the
  7967. * program configured to be used when sending mail, as defined by the
  7968. * sendmail_path configuration setting. For example,
  7969. * this can be used to set the envelope sender address when using
  7970. * sendmail with the -f sendmail option.
  7971. * </p>
  7972. * <p>
  7973. * The user that the webserver runs as should be added as a trusted user to the
  7974. * sendmail configuration to prevent a 'X-Warning' header from being added
  7975. * to the message when the envelope sender (-f) is set using this method.
  7976. * For sendmail users, this file is /etc/mail/trusted-users.
  7977. * </p>
  7978. * @return bool true if the mail was successfully accepted for delivery, false otherwise.
  7979. * </p>
  7980. * <p>
  7981. * It is important to note that just because the mail was accepted for delivery,
  7982. * it does NOT mean the mail will actually reach the intended destination.
  7983. */
  7984. function mail ($to, $subject, $message, $additional_headers = null, $additional_parameters = null) {}
  7985. /**
  7986. * Calculate the hash value needed by EZMLM
  7987. * @link http://www.php.net/manual/en/function.ezmlm-hash.php
  7988. * @param addr string <p>
  7989. * The email address that's being hashed.
  7990. * </p>
  7991. * @return int The hash value of addr.
  7992. */
  7993. function ezmlm_hash ($addr) {}
  7994. /**
  7995. * Open connection to system logger
  7996. * @link http://www.php.net/manual/en/function.openlog.php
  7997. * @param ident string <p>
  7998. * The string ident is added to each message.
  7999. * </p>
  8000. * @param option int <p>
  8001. * The option argument is used to indicate
  8002. * what logging options will be used when generating a log message.
  8003. * <table>
  8004. * openlog Options
  8005. * <tr valign="top">
  8006. * <td>Constant</td>
  8007. * <td>Description</td>
  8008. * </tr>
  8009. * <tr valign="top">
  8010. * <td>LOG_CONS</td>
  8011. * <td>
  8012. * if there is an error while sending data to the system logger,
  8013. * write directly to the system console
  8014. * </td>
  8015. * </tr>
  8016. * <tr valign="top">
  8017. * <td>LOG_NDELAY</td>
  8018. * <td>
  8019. * open the connection to the logger immediately
  8020. * </td>
  8021. * </tr>
  8022. * <tr valign="top">
  8023. * <td>LOG_ODELAY</td>
  8024. * <td>
  8025. * (default) delay opening the connection until the first
  8026. * message is logged
  8027. * </td>
  8028. * </tr>
  8029. * <tr valign="top">
  8030. * <td>LOG_PERROR</td>
  8031. * <td>print log message also to standard error</td>
  8032. * </tr>
  8033. * <tr valign="top">
  8034. * <td>LOG_PID</td>
  8035. * <td>include PID with each message</td>
  8036. * </tr>
  8037. * </table>
  8038. * You can use one or more of this options. When using multiple options
  8039. * you need to OR them, i.e. to open the connection
  8040. * immediately, write to the console and include the PID in each message,
  8041. * you will use: LOG_CONS | LOG_NDELAY | LOG_PID
  8042. * </p>
  8043. * @param facility int <p>
  8044. * The facility argument is used to specify what
  8045. * type of program is logging the message. This allows you to specify
  8046. * (in your machine's syslog configuration) how messages coming from
  8047. * different facilities will be handled.
  8048. * <table>
  8049. * openlog Facilities
  8050. * <tr valign="top">
  8051. * <td>Constant</td>
  8052. * <td>Description</td>
  8053. * </tr>
  8054. * <tr valign="top">
  8055. * <td>LOG_AUTH</td>
  8056. * <td>
  8057. * security/authorization messages (use
  8058. * LOG_AUTHPRIV instead
  8059. * in systems where that constant is defined)
  8060. * </td>
  8061. * </tr>
  8062. * <tr valign="top">
  8063. * <td>LOG_AUTHPRIV</td>
  8064. * <td>security/authorization messages (private)</td>
  8065. * </tr>
  8066. * <tr valign="top">
  8067. * <td>LOG_CRON</td>
  8068. * <td>clock daemon (cron and at)</td>
  8069. * </tr>
  8070. * <tr valign="top">
  8071. * <td>LOG_DAEMON</td>
  8072. * <td>other system daemons</td>
  8073. * </tr>
  8074. * <tr valign="top">
  8075. * <td>LOG_KERN</td>
  8076. * <td>kernel messages</td>
  8077. * </tr>
  8078. * <tr valign="top">
  8079. * <td>LOG_LOCAL0 ... LOG_LOCAL7</td>
  8080. * <td>reserved for local use, these are not available in Windows</td>
  8081. * </tr>
  8082. * <tr valign="top">
  8083. * <td>LOG_LPR</td>
  8084. * <td>line printer subsystem</td>
  8085. * </tr>
  8086. * <tr valign="top">
  8087. * <td>LOG_MAIL</td>
  8088. * <td>mail subsystem</td>
  8089. * </tr>
  8090. * <tr valign="top">
  8091. * <td>LOG_NEWS</td>
  8092. * <td>USENET news subsystem</td>
  8093. * </tr>
  8094. * <tr valign="top">
  8095. * <td>LOG_SYSLOG</td>
  8096. * <td>messages generated internally by syslogd</td>
  8097. * </tr>
  8098. * <tr valign="top">
  8099. * <td>LOG_USER</td>
  8100. * <td>generic user-level messages</td>
  8101. * </tr>
  8102. * <tr valign="top">
  8103. * <td>LOG_UUCP</td>
  8104. * <td>UUCP subsystem</td>
  8105. * </tr>
  8106. * </table>
  8107. * </p>
  8108. * <p>
  8109. * LOG_USER is the only valid log type under Windows
  8110. * operating systems
  8111. * </p>
  8112. * @return bool Returns true on success or false on failure.
  8113. */
  8114. function openlog ($ident, $option, $facility) {}
  8115. /**
  8116. * Generate a system log message
  8117. * @link http://www.php.net/manual/en/function.syslog.php
  8118. * @param priority int <p>
  8119. * priority is a combination of the facility and
  8120. * the level. Possible values are:
  8121. * <table>
  8122. * syslog Priorities (in descending order)
  8123. * <tr valign="top">
  8124. * <td>Constant</td>
  8125. * <td>Description</td>
  8126. * </tr>
  8127. * <tr valign="top">
  8128. * <td>LOG_EMERG</td>
  8129. * <td>system is unusable</td>
  8130. * </tr>
  8131. * <tr valign="top">
  8132. * <td>LOG_ALERT</td>
  8133. * <td>action must be taken immediately</td>
  8134. * </tr>
  8135. * <tr valign="top">
  8136. * <td>LOG_CRIT</td>
  8137. * <td>critical conditions</td>
  8138. * </tr>
  8139. * <tr valign="top">
  8140. * <td>LOG_ERR</td>
  8141. * <td>error conditions</td>
  8142. * </tr>
  8143. * <tr valign="top">
  8144. * <td>LOG_WARNING</td>
  8145. * <td>warning conditions</td>
  8146. * </tr>
  8147. * <tr valign="top">
  8148. * <td>LOG_NOTICE</td>
  8149. * <td>normal, but significant, condition</td>
  8150. * </tr>
  8151. * <tr valign="top">
  8152. * <td>LOG_INFO</td>
  8153. * <td>informational message</td>
  8154. * </tr>
  8155. * <tr valign="top">
  8156. * <td>LOG_DEBUG</td>
  8157. * <td>debug-level message</td>
  8158. * </tr>
  8159. * </table>
  8160. * </p>
  8161. * @param message string <p>
  8162. * The message to send, except that the two characters
  8163. * %m will be replaced by the error message string
  8164. * (strerror) corresponding to the present value of
  8165. * errno.
  8166. * </p>
  8167. * @return bool Returns true on success or false on failure.
  8168. */
  8169. function syslog ($priority, $message) {}
  8170. /**
  8171. * Close connection to system logger
  8172. * @link http://www.php.net/manual/en/function.closelog.php
  8173. * @return bool Returns true on success or false on failure.
  8174. */
  8175. function closelog () {}
  8176. /**
  8177. * Combined linear congruential generator
  8178. * @link http://www.php.net/manual/en/function.lcg-value.php
  8179. * @return float A pseudo random float value in the range of (0, 1)
  8180. */
  8181. function lcg_value () {}
  8182. /**
  8183. * Calculate the metaphone key of a string
  8184. * @link http://www.php.net/manual/en/function.metaphone.php
  8185. * @param str string <p>
  8186. * The input string.
  8187. * </p>
  8188. * @param phonemes int[optional] <p>
  8189. * This parameter restricts the returned metaphone key to
  8190. * phonemes characters in length.
  8191. * The default value of 0 means no restriction.
  8192. * </p>
  8193. * @return string the metaphone key as a string, &return.falseforfailure;.
  8194. */
  8195. function metaphone ($str, $phonemes = null) {}
  8196. /**
  8197. * Turn on output buffering
  8198. * @link http://www.php.net/manual/en/function.ob-start.php
  8199. * @param output_callback callback[optional] <p>
  8200. * An optional output_callback function may be
  8201. * specified. This function takes a string as a parameter and should
  8202. * return a string. The function will be called when
  8203. * the output buffer is flushed (sent) or cleaned (with
  8204. * ob_flush, ob_clean or similar
  8205. * function) or when the output buffer
  8206. * is flushed to the browser at the end of the request. When
  8207. * output_callback is called, it will receive the
  8208. * contents of the output buffer as its parameter and is expected to
  8209. * return a new output buffer as a result, which will be sent to the
  8210. * browser. If the output_callback is not a
  8211. * callable function, this function will return false.
  8212. * </p>
  8213. * <p>
  8214. * If the callback function has two parameters, the second parameter is
  8215. * filled with a bit-field consisting of
  8216. * PHP_OUTPUT_HANDLER_START,
  8217. * PHP_OUTPUT_HANDLER_CONT and
  8218. * PHP_OUTPUT_HANDLER_END.
  8219. * </p>
  8220. * <p>
  8221. * If output_callback returns false original
  8222. * input is sent to the browser.
  8223. * </p>
  8224. * <p>
  8225. * The output_callback parameter may be bypassed
  8226. * by passing a &null; value.
  8227. * </p>
  8228. * <p>
  8229. * ob_end_clean, ob_end_flush,
  8230. * ob_clean, ob_flush and
  8231. * ob_start may not be called from a callback
  8232. * function. If you call them from callback function, the behavior is
  8233. * undefined. If you would like to delete the contents of a buffer,
  8234. * return "" (a null string) from callback function.
  8235. * You can't even call functions using the output buffering functions like
  8236. * print_r($expression, true) or
  8237. * highlight_file($filename, true) from a callback
  8238. * function.
  8239. * </p>
  8240. * <p>
  8241. * In PHP 4.0.4, ob_gzhandler was introduced to
  8242. * facilitate sending gz-encoded data to web browsers that support
  8243. * compressed web pages. ob_gzhandler determines
  8244. * what type of content encoding the browser will accept and will return
  8245. * its output accordingly.
  8246. * </p>
  8247. * @param chunk_size int[optional] <p>
  8248. * If the optional parameter chunk_size is passed, the
  8249. * buffer will be flushed after any output call which causes the buffer's
  8250. * length to equal or exceed chunk_size. The default
  8251. * value 0 means that the output function will only be
  8252. * called when the output buffer is closed.
  8253. * </p>
  8254. * <p>
  8255. * Prior to PHP 5.4.0, the value 1 was a special case
  8256. * value that set the chunk size to 4096 bytes.
  8257. * </p>
  8258. * @param erase bool[optional] <p>
  8259. * If the optional parameter erase is set to false,
  8260. * the buffer will not be deleted until the script finishes.
  8261. * This causes that flushing and cleaning functions would issue a notice
  8262. * and return false if called.
  8263. * </p>
  8264. * @return bool Returns true on success or false on failure.
  8265. */
  8266. function ob_start ($output_callback = null, $chunk_size = null, $erase = null) {}
  8267. /**
  8268. * Flush (send) the output buffer
  8269. * @link http://www.php.net/manual/en/function.ob-flush.php
  8270. * @return void
  8271. */
  8272. function ob_flush () {}
  8273. /**
  8274. * Clean (erase) the output buffer
  8275. * @link http://www.php.net/manual/en/function.ob-clean.php
  8276. * @return void
  8277. */
  8278. function ob_clean () {}
  8279. /**
  8280. * Flush (send) the output buffer and turn off output buffering
  8281. * @link http://www.php.net/manual/en/function.ob-end-flush.php
  8282. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  8283. * function without an active buffer or that for some reason a buffer could
  8284. * not be deleted (possible for special buffer).
  8285. */
  8286. function ob_end_flush () {}
  8287. /**
  8288. * Clean (erase) the output buffer and turn off output buffering
  8289. * @link http://www.php.net/manual/en/function.ob-end-clean.php
  8290. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  8291. * function without an active buffer or that for some reason a buffer could
  8292. * not be deleted (possible for special buffer).
  8293. */
  8294. function ob_end_clean () {}
  8295. /**
  8296. * Flush the output buffer, return it as a string and turn off output buffering
  8297. * @link http://www.php.net/manual/en/function.ob-get-flush.php
  8298. * @return string the output buffer or false if no buffering is active.
  8299. */
  8300. function ob_get_flush () {}
  8301. /**
  8302. * Get current buffer contents and delete current output buffer
  8303. * @link http://www.php.net/manual/en/function.ob-get-clean.php
  8304. * @return string the contents of the output buffer and end output buffering.
  8305. * If output buffering isn't active then false is returned.
  8306. */
  8307. function ob_get_clean () {}
  8308. /**
  8309. * Return the length of the output buffer
  8310. * @link http://www.php.net/manual/en/function.ob-get-length.php
  8311. * @return int the length of the output buffer contents or false if no
  8312. * buffering is active.
  8313. */
  8314. function ob_get_length () {}
  8315. /**
  8316. * Return the nesting level of the output buffering mechanism
  8317. * @link http://www.php.net/manual/en/function.ob-get-level.php
  8318. * @return int the level of nested output buffering handlers or zero if output
  8319. * buffering is not active.
  8320. */
  8321. function ob_get_level () {}
  8322. /**
  8323. * Get status of output buffers
  8324. * @link http://www.php.net/manual/en/function.ob-get-status.php
  8325. * @param full_status bool[optional] <p>
  8326. * true to return all active output buffer levels. If false or not
  8327. * set, only the top level output buffer is returned.
  8328. * </p>
  8329. * @return array If called without the full_status parameter
  8330. * or with full_status = false a simple array
  8331. * with the following elements is returned:
  8332. * 2
  8333. * [type] => 0
  8334. * [status] => 0
  8335. * [name] => URL-Rewriter
  8336. * [del] => 1
  8337. * )
  8338. * ]]>
  8339. * Simple ob_get_status results
  8340. * KeyValue
  8341. * levelOutput nesting level
  8342. * typePHP_OUTPUT_HANDLER_INTERNAL (0) or PHP_OUTPUT_HANDLER_USER (1)
  8343. * statusOne of PHP_OUTPUT_HANDLER_START (0), PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2)
  8344. * nameName of active output handler or ' default output handler' if none is set
  8345. * delErase-flag as set by ob_start
  8346. * </p>
  8347. * <p>
  8348. * If called with full_status = true an array
  8349. * with one element for each active output buffer level is returned.
  8350. * The output level is used as key of the top level array and each array
  8351. * element itself is another array holding status information
  8352. * on one active output level.
  8353. * Array
  8354. * (
  8355. * [chunk_size] => 0
  8356. * [size] => 40960
  8357. * [block_size] => 10240
  8358. * [type] => 1
  8359. * [status] => 0
  8360. * [name] => default output handler
  8361. * [del] => 1
  8362. * )
  8363. * [1] => Array
  8364. * (
  8365. * [chunk_size] => 0
  8366. * [size] => 40960
  8367. * [block_size] => 10240
  8368. * [type] => 0
  8369. * [buffer_size] => 0
  8370. * [status] => 0
  8371. * [name] => URL-Rewriter
  8372. * [del] => 1
  8373. * )
  8374. * )
  8375. * ]]>
  8376. * </p>
  8377. * <p>
  8378. * The full output contains these additional elements:
  8379. * Full ob_get_status results
  8380. * KeyValue
  8381. * chunk_sizeChunk size as set by ob_start
  8382. * size...
  8383. * blocksize...
  8384. */
  8385. function ob_get_status ($full_status = null) {}
  8386. /**
  8387. * Return the contents of the output buffer
  8388. * @link http://www.php.net/manual/en/function.ob-get-contents.php
  8389. * @return string This will return the contents of the output buffer or false, if output
  8390. * buffering isn't active.
  8391. */
  8392. function ob_get_contents () {}
  8393. /**
  8394. * Turn implicit flush on/off
  8395. * @link http://www.php.net/manual/en/function.ob-implicit-flush.php
  8396. * @param flag int[optional] <p>
  8397. * true to turn implicit flushing on, false otherwise.
  8398. * </p>
  8399. * @return void
  8400. */
  8401. function ob_implicit_flush ($flag = null) {}
  8402. /**
  8403. * List all output handlers in use
  8404. * @link http://www.php.net/manual/en/function.ob-list-handlers.php
  8405. * @return array This will return an array with the output handlers in use (if any). If
  8406. * output_buffering is enabled or
  8407. * an anonymous function was used with ob_start,
  8408. * ob_list_handlers will return "default output
  8409. * handler".
  8410. */
  8411. function ob_list_handlers () {}
  8412. /**
  8413. * Sort an array by key
  8414. * @link http://www.php.net/manual/en/function.ksort.php
  8415. * @param array array <p>
  8416. * The input array.
  8417. * </p>
  8418. * @param sort_flags int[optional] <p>
  8419. * You may modify the behavior of the sort using the optional
  8420. * parameter sort_flags, for details
  8421. * see sort.
  8422. * </p>
  8423. * @return bool Returns true on success or false on failure.
  8424. */
  8425. function ksort (array &$array, $sort_flags = null) {}
  8426. /**
  8427. * Sort an array by key in reverse order
  8428. * @link http://www.php.net/manual/en/function.krsort.php
  8429. * @param array array <p>
  8430. * The input array.
  8431. * </p>
  8432. * @param sort_flags int[optional] <p>
  8433. * You may modify the behavior of the sort using the optional parameter
  8434. * sort_flags, for details see
  8435. * sort.
  8436. * </p>
  8437. * @return bool Returns true on success or false on failure.
  8438. */
  8439. function krsort (array &$array, $sort_flags = null) {}
  8440. /**
  8441. * Sort an array using a "natural order" algorithm
  8442. * @link http://www.php.net/manual/en/function.natsort.php
  8443. * @param array array <p>
  8444. * The input array.
  8445. * </p>
  8446. * @return bool Returns true on success or false on failure.
  8447. */
  8448. function natsort (array &$array) {}
  8449. /**
  8450. * Sort an array using a case insensitive "natural order" algorithm
  8451. * @link http://www.php.net/manual/en/function.natcasesort.php
  8452. * @param array array <p>
  8453. * The input array.
  8454. * </p>
  8455. * @return bool Returns true on success or false on failure.
  8456. */
  8457. function natcasesort (array &$array) {}
  8458. /**
  8459. * Sort an array and maintain index association
  8460. * @link http://www.php.net/manual/en/function.asort.php
  8461. * @param array array <p>
  8462. * The input array.
  8463. * </p>
  8464. * @param sort_flags int[optional] <p>
  8465. * You may modify the behavior of the sort using the optional
  8466. * parameter sort_flags, for details
  8467. * see sort.
  8468. * </p>
  8469. * @return bool Returns true on success or false on failure.
  8470. */
  8471. function asort (array &$array, $sort_flags = null) {}
  8472. /**
  8473. * Sort an array in reverse order and maintain index association
  8474. * @link http://www.php.net/manual/en/function.arsort.php
  8475. * @param array array <p>
  8476. * The input array.
  8477. * </p>
  8478. * @param sort_flags int[optional] <p>
  8479. * You may modify the behavior of the sort using the optional parameter
  8480. * sort_flags, for details see
  8481. * sort.
  8482. * </p>
  8483. * @return bool Returns true on success or false on failure.
  8484. */
  8485. function arsort (array &$array, $sort_flags = null) {}
  8486. /**
  8487. * Sort an array
  8488. * @link http://www.php.net/manual/en/function.sort.php
  8489. * @param array array <p>
  8490. * The input array.
  8491. * </p>
  8492. * @param sort_flags int[optional] <p>
  8493. * The optional second parameter sort_flags
  8494. * may be used to modify the sorting behavior using these values:
  8495. * </p>
  8496. * <p>
  8497. * Sorting type flags:
  8498. * SORT_REGULAR - compare items normally
  8499. * (don't change types)
  8500. * @return bool Returns true on success or false on failure.
  8501. */
  8502. function sort (array &$array, $sort_flags = null) {}
  8503. /**
  8504. * Sort an array in reverse order
  8505. * @link http://www.php.net/manual/en/function.rsort.php
  8506. * @param array array <p>
  8507. * The input array.
  8508. * </p>
  8509. * @param sort_flags int[optional] <p>
  8510. * You may modify the behavior of the sort using the optional
  8511. * parameter sort_flags, for details see
  8512. * sort.
  8513. * </p>
  8514. * @return bool Returns true on success or false on failure.
  8515. */
  8516. function rsort (array &$array, $sort_flags = null) {}
  8517. /**
  8518. * Sort an array by values using a user-defined comparison function
  8519. * @link http://www.php.net/manual/en/function.usort.php
  8520. * @param array array <p>
  8521. * The input array.
  8522. * </p>
  8523. * @param cmp_function callback <p>
  8524. * The comparison function must return an integer less than, equal to, or
  8525. * greater than zero if the first argument is considered to be
  8526. * respectively less than, equal to, or greater than the second.
  8527. * </p>
  8528. * @return bool Returns true on success or false on failure.
  8529. */
  8530. function usort (array &$array, $cmp_function) {}
  8531. /**
  8532. * Sort an array with a user-defined comparison function and maintain index association
  8533. * @link http://www.php.net/manual/en/function.uasort.php
  8534. * @param array array <p>
  8535. * The input array.
  8536. * </p>
  8537. * @param cmp_function callback <p>
  8538. * See usort and uksort for
  8539. * examples of user-defined comparison functions.
  8540. * </p>
  8541. * @return bool Returns true on success or false on failure.
  8542. */
  8543. function uasort (array &$array, $cmp_function) {}
  8544. /**
  8545. * Sort an array by keys using a user-defined comparison function
  8546. * @link http://www.php.net/manual/en/function.uksort.php
  8547. * @param array array <p>
  8548. * The input array.
  8549. * </p>
  8550. * @param cmp_function callback <p>
  8551. * The callback comparison function.
  8552. * </p>
  8553. * <p>
  8554. * Function cmp_function should accept two
  8555. * parameters which will be filled by pairs of array keys.
  8556. * The comparison function must return an integer less than, equal
  8557. * to, or greater than zero if the first argument is considered to
  8558. * be respectively less than, equal to, or greater than the
  8559. * second.
  8560. * </p>
  8561. * @return bool Returns true on success or false on failure.
  8562. */
  8563. function uksort (array &$array, $cmp_function) {}
  8564. /**
  8565. * Shuffle an array
  8566. * @link http://www.php.net/manual/en/function.shuffle.php
  8567. * @param array array <p>
  8568. * The array.
  8569. * </p>
  8570. * @return bool Returns true on success or false on failure.
  8571. */
  8572. function shuffle (array &$array) {}
  8573. /**
  8574. * Apply a user function to every member of an array
  8575. * @link http://www.php.net/manual/en/function.array-walk.php
  8576. * @param array array <p>
  8577. * The input array.
  8578. * </p>
  8579. * @param funcname callback <p>
  8580. * Typically, funcname takes on two parameters.
  8581. * The array parameter's value being the first, and
  8582. * the key/index second.
  8583. * </p>
  8584. * <p>
  8585. * If funcname needs to be working with the
  8586. * actual values of the array, specify the first parameter of
  8587. * funcname as a
  8588. * reference. Then,
  8589. * any changes made to those elements will be made in the
  8590. * original array itself.
  8591. * </p>
  8592. * <p>
  8593. * Many internal functions (for example strtolower)
  8594. * will throw a warning if more than the expected number of argument
  8595. * are passed in and are not usable directly as
  8596. * funcname.
  8597. * </p>
  8598. * <p>
  8599. * Only the values of the array may potentially be
  8600. * changed; its structure cannot be altered, i.e., the programmer cannot
  8601. * add, unset or reorder elements. If the callback does not respect this
  8602. * requirement, the behavior of this function is undefined, and
  8603. * unpredictable.
  8604. * </p>
  8605. * @param userdata mixed[optional] <p>
  8606. * If the optional userdata parameter is supplied,
  8607. * it will be passed as the third parameter to the callback
  8608. * funcname.
  8609. * </p>
  8610. * @return bool Returns true on success or false on failure.
  8611. */
  8612. function array_walk (array &$array, $funcname, $userdata = null) {}
  8613. /**
  8614. * Apply a user function recursively to every member of an array
  8615. * @link http://www.php.net/manual/en/function.array-walk-recursive.php
  8616. * @param input array <p>
  8617. * The input array.
  8618. * </p>
  8619. * @param funcname callback <p>
  8620. * Typically, funcname takes on two parameters.
  8621. * The input parameter's value being the first, and
  8622. * the key/index second.
  8623. * </p>
  8624. * <p>
  8625. * If funcname needs to be working with the
  8626. * actual values of the array, specify the first parameter of
  8627. * funcname as a
  8628. * reference. Then,
  8629. * any changes made to those elements will be made in the
  8630. * original array itself.
  8631. * </p>
  8632. * @param userdata mixed[optional] <p>
  8633. * If the optional userdata parameter is supplied,
  8634. * it will be passed as the third parameter to the callback
  8635. * funcname.
  8636. * </p>
  8637. * @return bool Returns true on success or false on failure.
  8638. */
  8639. function array_walk_recursive (array &$input, $funcname, $userdata = null) {}
  8640. /**
  8641. * Count all elements in an array, or something in an object
  8642. * @link http://www.php.net/manual/en/function.count.php
  8643. * @param var mixed <p>
  8644. * The array or the object.
  8645. * </p>
  8646. * @param mode int[optional] <p>
  8647. * If the optional mode parameter is set to
  8648. * COUNT_RECURSIVE (or 1), count
  8649. * will recursively count the array. This is particularly useful for
  8650. * counting all the elements of a multidimensional array.
  8651. * count does not detect infinite recursion.
  8652. * </p>
  8653. * @return int the number of elements in var.
  8654. * If var is not an array or an object with
  8655. * implemented Countable interface,
  8656. * 1 will be returned.
  8657. * There is one exception, if var is &null;,
  8658. * 0 will be returned.
  8659. * </p>
  8660. * <p>
  8661. * count may return 0 for a variable that isn't set,
  8662. * but it may also return 0 for a variable that has been initialized with an
  8663. * empty array. Use isset to test if a variable is set.
  8664. */
  8665. function count ($var, $mode = null) {}
  8666. /**
  8667. * Set the internal pointer of an array to its last element
  8668. * @link http://www.php.net/manual/en/function.end.php
  8669. * @param array array <p>
  8670. * The array. This array is passed by reference because it is modified by
  8671. * the function. This means you must pass it a real variable and not
  8672. * a function returning an array because only actual variables may be
  8673. * passed by reference.
  8674. * </p>
  8675. * @return mixed the value of the last element or false for empty array.
  8676. */
  8677. function end (array &$array) {}
  8678. /**
  8679. * Rewind the internal array pointer
  8680. * @link http://www.php.net/manual/en/function.prev.php
  8681. * @param array array <p>
  8682. * The input array.
  8683. * </p>
  8684. * @return mixed the array value in the previous place that's pointed to by
  8685. * the internal array pointer, or false if there are no more
  8686. * elements.
  8687. */
  8688. function prev (array &$array) {}
  8689. /**
  8690. * Advance the internal array pointer of an array
  8691. * @link http://www.php.net/manual/en/function.next.php
  8692. * @param array array <p>
  8693. * The array being affected.
  8694. * </p>
  8695. * @return mixed the array value in the next place that's pointed to by the
  8696. * internal array pointer, or false if there are no more elements.
  8697. */
  8698. function next (array &$array) {}
  8699. /**
  8700. * Set the internal pointer of an array to its first element
  8701. * @link http://www.php.net/manual/en/function.reset.php
  8702. * @param array array <p>
  8703. * The input array.
  8704. * </p>
  8705. * @return mixed the value of the first array element, or false if the array is
  8706. * empty.
  8707. */
  8708. function reset (array &$array) {}
  8709. /**
  8710. * Return the current element in an array
  8711. * @link http://www.php.net/manual/en/function.current.php
  8712. * @param array array <p>
  8713. * The array.
  8714. * </p>
  8715. * @return mixed The current function simply returns the
  8716. * value of the array element that's currently being pointed to by the
  8717. * internal pointer. It does not move the pointer in any way. If the
  8718. * internal pointer points beyond the end of the elements list or the array is
  8719. * empty, current returns false.
  8720. */
  8721. function current (array &$array) {}
  8722. /**
  8723. * Fetch a key from an array
  8724. * @link http://www.php.net/manual/en/function.key.php
  8725. * @param array array <p>
  8726. * The array.
  8727. * </p>
  8728. * @return mixed The key function simply returns the
  8729. * key of the array element that's currently being pointed to by the
  8730. * internal pointer. It does not move the pointer in any way. If the
  8731. * internal pointer points beyond the end of the elements list or the array is
  8732. * empty, key returns &null;.
  8733. */
  8734. function key (array &$array) {}
  8735. /**
  8736. * Find lowest value
  8737. * @link http://www.php.net/manual/en/function.min.php
  8738. * @param values array <p>
  8739. * An array containing the values.
  8740. * </p>
  8741. * @return mixed min returns the numerically lowest of the
  8742. * parameter values.
  8743. */
  8744. function min (array $values) {}
  8745. /**
  8746. * Find highest value
  8747. * @link http://www.php.net/manual/en/function.max.php
  8748. * @param values array <p>
  8749. * An array containing the values.
  8750. * </p>
  8751. * @return mixed max returns the numerically highest of the
  8752. * parameter values. If multiple values can be considered of the same size,
  8753. * the one that is listed first will be returned.
  8754. * </p>
  8755. * <p>
  8756. * When max is given multiple arrays, the
  8757. * longest array is returned. If all the arrays have the same length,
  8758. * max will use lexicographic ordering to find the return
  8759. * value.
  8760. * </p>
  8761. * <p>
  8762. * When given a string it will be cast as an integer
  8763. * when comparing.
  8764. */
  8765. function max (array $values) {}
  8766. /**
  8767. * Checks if a value exists in an array
  8768. * @link http://www.php.net/manual/en/function.in-array.php
  8769. * @param needle mixed <p>
  8770. * The searched value.
  8771. * </p>
  8772. * <p>
  8773. * If needle is a string, the comparison is done
  8774. * in a case-sensitive manner.
  8775. * </p>
  8776. * @param haystack array <p>
  8777. * The array.
  8778. * </p>
  8779. * @param strict bool[optional] <p>
  8780. * If the third parameter strict is set to true
  8781. * then the in_array function will also check the
  8782. * types of the
  8783. * needle in the haystack.
  8784. * </p>
  8785. * @return bool true if needle is found in the array,
  8786. * false otherwise.
  8787. */
  8788. function in_array ($needle, array $haystack, $strict = null) {}
  8789. /**
  8790. * Searches the array for a given value and returns the corresponding key if successful
  8791. * @link http://www.php.net/manual/en/function.array-search.php
  8792. * @param needle mixed <p>
  8793. * The searched value.
  8794. * </p>
  8795. * <p>
  8796. * If needle is a string, the comparison is done
  8797. * in a case-sensitive manner.
  8798. * </p>
  8799. * @param haystack array <p>
  8800. * The array.
  8801. * </p>
  8802. * @param strict bool[optional] <p>
  8803. * If the third parameter strict is set to true
  8804. * then the array_search function will search for
  8805. * identical elements in the
  8806. * haystack. This means it will also check the
  8807. * types of the
  8808. * needle in the haystack,
  8809. * and objects must be the same instance.
  8810. * </p>
  8811. * @return mixed the key for needle if it is found in the
  8812. * array, false otherwise.
  8813. * </p>
  8814. * <p>
  8815. * If needle is found in haystack
  8816. * more than once, the first matching key is returned. To return the keys for
  8817. * all matching values, use array_keys with the optional
  8818. * search_value parameter instead.
  8819. */
  8820. function array_search ($needle, array $haystack, $strict = null) {}
  8821. /**
  8822. * Import variables into the current symbol table from an array
  8823. * @link http://www.php.net/manual/en/function.extract.php
  8824. * @param var_array array <p>
  8825. * Note that prefix is only required if
  8826. * extract_type is EXTR_PREFIX_SAME,
  8827. * EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID
  8828. * or EXTR_PREFIX_IF_EXISTS. If
  8829. * the prefixed result is not a valid variable name, it is not
  8830. * imported into the symbol table. Prefixes are automatically separated from
  8831. * the array key by an underscore character.
  8832. * </p>
  8833. * @param extract_type int[optional] <p>
  8834. * The way invalid/numeric keys and collisions are treated is determined
  8835. * by the extract_type. It can be one of the
  8836. * following values:
  8837. * EXTR_OVERWRITE
  8838. * If there is a collision, overwrite the existing variable.
  8839. * @param prefix string[optional] Only overwrite the variable if it already exists in the
  8840. * current symbol table, otherwise do nothing. This is useful
  8841. * for defining a list of valid variables and then extracting
  8842. * only those variables you have defined out of
  8843. * $_REQUEST, for example.
  8844. * @return int the number of variables successfully imported into the symbol
  8845. * table.
  8846. */
  8847. function extract (array &$var_array, $extract_type = null, $prefix = null) {}
  8848. /**
  8849. * Create array containing variables and their values
  8850. * @link http://www.php.net/manual/en/function.compact.php
  8851. * @param varname mixed <p>
  8852. * compact takes a variable number of parameters.
  8853. * Each parameter can be either a string containing the name of the
  8854. * variable, or an array of variable names. The array can contain other
  8855. * arrays of variable names inside it; compact
  8856. * handles it recursively.
  8857. * </p>
  8858. * @param _ mixed[optional]
  8859. * @return array the output array with all the variables added to it.
  8860. */
  8861. function compact ($varname, $_ = null) {}
  8862. /**
  8863. * Fill an array with values
  8864. * @link http://www.php.net/manual/en/function.array-fill.php
  8865. * @param start_index int <p>
  8866. * The first index of the returned array.
  8867. * </p>
  8868. * <p>
  8869. * If start_index is negative,
  8870. * the first index of the returned array will be
  8871. * start_index and the following
  8872. * indices will start from zero
  8873. * (see example).
  8874. * </p>
  8875. * @param num int <p>
  8876. * Number of elements to insert.
  8877. * Must be greater than zero.
  8878. * </p>
  8879. * @param value mixed <p>
  8880. * Value to use for filling
  8881. * </p>
  8882. * @return array the filled array
  8883. */
  8884. function array_fill ($start_index, $num, $value) {}
  8885. /**
  8886. * Fill an array with values, specifying keys
  8887. * @link http://www.php.net/manual/en/function.array-fill-keys.php
  8888. * @param keys array <p>
  8889. * Array of values that will be used as keys. Illegal values
  8890. * for key will be converted to string.
  8891. * </p>
  8892. * @param value mixed <p>
  8893. * Value to use for filling
  8894. * </p>
  8895. * @return array the filled array
  8896. */
  8897. function array_fill_keys (array $keys, $value) {}
  8898. /**
  8899. * Create an array containing a range of elements
  8900. * @link http://www.php.net/manual/en/function.range.php
  8901. * @param start mixed <p>
  8902. * First value of the sequence.
  8903. * </p>
  8904. * @param limit mixed <p>
  8905. * The sequence is ended upon reaching the
  8906. * limit value.
  8907. * </p>
  8908. * @param step number[optional] <p>
  8909. * If a step value is given, it will be used as the
  8910. * increment between elements in the sequence. step
  8911. * should be given as a positive number. If not specified,
  8912. * step will default to 1.
  8913. * </p>
  8914. * @return array an array of elements from start to
  8915. * limit, inclusive.
  8916. */
  8917. function range ($start, $limit, $step = null) {}
  8918. /**
  8919. * Sort multiple or multi-dimensional arrays
  8920. * @link http://www.php.net/manual/en/function.array-multisort.php
  8921. * @param arr array <p>
  8922. * An array being sorted.
  8923. * </p>
  8924. * @param arg mixed[optional] <p>
  8925. * Optionally another array, or sort options for the
  8926. * previous array argument:
  8927. * SORT_ASC,
  8928. * SORT_DESC,
  8929. * SORT_REGULAR,
  8930. * SORT_NUMERIC,
  8931. * SORT_STRING.
  8932. * </p>
  8933. * @param arg mixed[optional]
  8934. * @param _ mixed[optional]
  8935. * @return bool Returns true on success or false on failure.
  8936. */
  8937. function array_multisort (array &$arr, $arg = null, $arg = null, $_ = null) {}
  8938. /**
  8939. * Push one or more elements onto the end of array
  8940. * @link http://www.php.net/manual/en/function.array-push.php
  8941. * @param array array <p>
  8942. * The input array.
  8943. * </p>
  8944. * @param var mixed <p>
  8945. * The pushed value.
  8946. * </p>
  8947. * @param _ mixed[optional]
  8948. * @return int the new number of elements in the array.
  8949. */
  8950. function array_push (array &$array, $var, $_ = null) {}
  8951. /**
  8952. * Pop the element off the end of array
  8953. * @link http://www.php.net/manual/en/function.array-pop.php
  8954. * @param array array <p>
  8955. * The array to get the value from.
  8956. * </p>
  8957. * @return mixed the last value of array.
  8958. * If array is empty (or is not an array),
  8959. * &null; will be returned.
  8960. */
  8961. function array_pop (array &$array) {}
  8962. /**
  8963. * Shift an element off the beginning of array
  8964. * @link http://www.php.net/manual/en/function.array-shift.php
  8965. * @param array array <p>
  8966. * The input array.
  8967. * </p>
  8968. * @return mixed the shifted value, or &null; if array is
  8969. * empty or is not an array.
  8970. */
  8971. function array_shift (array &$array) {}
  8972. /**
  8973. * Prepend one or more elements to the beginning of an array
  8974. * @link http://www.php.net/manual/en/function.array-unshift.php
  8975. * @param array array <p>
  8976. * The input array.
  8977. * </p>
  8978. * @param var mixed <p>
  8979. * The prepended variable.
  8980. * </p>
  8981. * @param _ mixed[optional]
  8982. * @return int the new number of elements in the array.
  8983. */
  8984. function array_unshift (array &$array, $var, $_ = null) {}
  8985. /**
  8986. * Remove a portion of the array and replace it with something else
  8987. * @link http://www.php.net/manual/en/function.array-splice.php
  8988. * @param input array <p>
  8989. * The input array.
  8990. * </p>
  8991. * @param offset int <p>
  8992. * If offset is positive then the start of removed
  8993. * portion is at that offset from the beginning of the
  8994. * input array. If offset
  8995. * is negative then it starts that far from the end of the
  8996. * input array.
  8997. * </p>
  8998. * @param length int[optional] <p>
  8999. * If length is omitted, removes everything
  9000. * from offset to the end of the array. If
  9001. * length is specified and is positive, then
  9002. * that many elements will be removed. If
  9003. * length is specified and is negative then
  9004. * the end of the removed portion will be that many elements from
  9005. * the end of the array. Tip: to remove everything from
  9006. * offset to the end of the array when
  9007. * replacement is also specified, use
  9008. * count($input) for
  9009. * length.
  9010. * </p>
  9011. * @param replacement mixed[optional] <p>
  9012. * If replacement array is specified, then the
  9013. * removed elements are replaced with elements from this array.
  9014. * </p>
  9015. * <p>
  9016. * If offset and length
  9017. * are such that nothing is removed, then the elements from the
  9018. * replacement array are inserted in the place
  9019. * specified by the offset. Note that keys in
  9020. * replacement array are not preserved.
  9021. * </p>
  9022. * <p>
  9023. * If replacement is just one element it is
  9024. * not necessary to put array()
  9025. * around it, unless the element is an array itself, an object or &null;.
  9026. * </p>
  9027. * @return array the array consisting of the extracted elements.
  9028. */
  9029. function array_splice (array &$input, $offset, $length = null, $replacement = null) {}
  9030. /**
  9031. * Extract a slice of the array
  9032. * @link http://www.php.net/manual/en/function.array-slice.php
  9033. * @param array array <p>
  9034. * The input array.
  9035. * </p>
  9036. * @param offset int <p>
  9037. * If offset is non-negative, the sequence will
  9038. * start at that offset in the array. If
  9039. * offset is negative, the sequence will
  9040. * start that far from the end of the array.
  9041. * </p>
  9042. * @param length int[optional] <p>
  9043. * If length is given and is positive, then
  9044. * the sequence will have up to that many elements in it. If the array
  9045. * is shorter than the length, then only the
  9046. * available array elements will be present. If
  9047. * length is given and is negative then the
  9048. * sequence will stop that many elements from the end of the
  9049. * array. If it is omitted, then the sequence will have everything
  9050. * from offset up until the end of the
  9051. * array.
  9052. * </p>
  9053. * @param preserve_keys bool[optional] <p>
  9054. * Note that array_slice will reorder and reset the
  9055. * array indices by default. You can change this behaviour by setting
  9056. * preserve_keys to true.
  9057. * </p>
  9058. * @return array the slice.
  9059. */
  9060. function array_slice (array $array, $offset, $length = null, $preserve_keys = null) {}
  9061. /**
  9062. * Merge one or more arrays
  9063. * @link http://www.php.net/manual/en/function.array-merge.php
  9064. * @param array1 array <p>
  9065. * Initial array to merge.
  9066. * </p>
  9067. * @param _ array[optional]
  9068. * @return array the resulting array.
  9069. */
  9070. function array_merge (array $array1, array $_ = null) {}
  9071. /**
  9072. * Merge two or more arrays recursively
  9073. * @link http://www.php.net/manual/en/function.array-merge-recursive.php
  9074. * @param array1 array <p>
  9075. * Initial array to merge.
  9076. * </p>
  9077. * @param _ array[optional]
  9078. * @return array An array of values resulted from merging the arguments together.
  9079. */
  9080. function array_merge_recursive (array $array1, array $_ = null) {}
  9081. /**
  9082. * Replaces elements from passed arrays into the first array
  9083. * @link http://www.php.net/manual/en/function.array-replace.php
  9084. * @param array array <p>
  9085. * The array in which elements are replaced.
  9086. * </p>
  9087. * @param array1 array <p>
  9088. * The array from which elements will be extracted.
  9089. * </p>
  9090. * @param _ array[optional]
  9091. * @return array an array, or &null; if an error occurs.
  9092. */
  9093. function array_replace (array &$array, array &$array1, array &$_ = null) {}
  9094. /**
  9095. * Replaces elements from passed arrays into the first array recursively
  9096. * @link http://www.php.net/manual/en/function.array-replace-recursive.php
  9097. * @param array array <p>
  9098. * The array in which elements are replaced.
  9099. * </p>
  9100. * @param array1 array <p>
  9101. * The array from which elements will be extracted.
  9102. * </p>
  9103. * @param _ array[optional]
  9104. * @return array an array, or &null; if an error occurs.
  9105. */
  9106. function array_replace_recursive (array &$array, array &$array1, array &$_ = null) {}
  9107. /**
  9108. * Return all the keys or a subset of the keys of an array
  9109. * @link http://www.php.net/manual/en/function.array-keys.php
  9110. * @param input array <p>
  9111. * An array containing keys to return.
  9112. * </p>
  9113. * @param search_value mixed[optional] <p>
  9114. * If specified, then only keys containing these values are returned.
  9115. * </p>
  9116. * @param strict bool[optional] <p>
  9117. * Determines if strict comparison (===) should be used during the search.
  9118. * </p>
  9119. * @return array an array of all the keys in input.
  9120. */
  9121. function array_keys (array $input, $search_value = null, $strict = null) {}
  9122. /**
  9123. * Return all the values of an array
  9124. * @link http://www.php.net/manual/en/function.array-values.php
  9125. * @param input array <p>
  9126. * The array.
  9127. * </p>
  9128. * @return array an indexed array of values.
  9129. */
  9130. function array_values (array $input) {}
  9131. /**
  9132. * Counts all the values of an array
  9133. * @link http://www.php.net/manual/en/function.array-count-values.php
  9134. * @param input array <p>
  9135. * The array of values to count
  9136. * </p>
  9137. * @return array an associative array of values from input as
  9138. * keys and their count as value.
  9139. */
  9140. function array_count_values (array $input) {}
  9141. /**
  9142. * Return an array with elements in reverse order
  9143. * @link http://www.php.net/manual/en/function.array-reverse.php
  9144. * @param array array <p>
  9145. * The input array.
  9146. * </p>
  9147. * @param preserve_keys bool[optional] <p>
  9148. * If set to true numeric keys are preserved.
  9149. * Non-numeric keys are not affected by this setting and will always be preserved.
  9150. * </p>
  9151. * @return array the reversed array.
  9152. */
  9153. function array_reverse (array $array, $preserve_keys = null) {}
  9154. /**
  9155. * Iteratively reduce the array to a single value using a callback function
  9156. * @link http://www.php.net/manual/en/function.array-reduce.php
  9157. * @param input array <p>
  9158. * The input array.
  9159. * </p>
  9160. * @param function callback <p>
  9161. * The callback function.
  9162. * </p>
  9163. * @param initial mixed[optional] <p>
  9164. * If the optional initial is available, it will
  9165. * be used at the beginning of the process, or as a final result in case
  9166. * the array is empty.
  9167. * </p>
  9168. * @return mixed the resulting value.
  9169. * </p>
  9170. * <p>
  9171. * If the array is empty and initial is not passed,
  9172. * array_reduce returns &null;.
  9173. */
  9174. function array_reduce (array $input, $function, $initial = null) {}
  9175. /**
  9176. * Pad array to the specified length with a value
  9177. * @link http://www.php.net/manual/en/function.array-pad.php
  9178. * @param input array <p>
  9179. * Initial array of values to pad.
  9180. * </p>
  9181. * @param pad_size int <p>
  9182. * New size of the array.
  9183. * </p>
  9184. * @param pad_value mixed <p>
  9185. * Value to pad if input is less than
  9186. * pad_size.
  9187. * </p>
  9188. * @return array a copy of the input padded to size specified
  9189. * by pad_size with value
  9190. * pad_value. If pad_size is
  9191. * positive then the array is padded on the right, if it's negative then
  9192. * on the left. If the absolute value of pad_size is less
  9193. * than or equal to the length of the input then no
  9194. * padding takes place.
  9195. */
  9196. function array_pad (array $input, $pad_size, $pad_value) {}
  9197. /**
  9198. * Exchanges all keys with their associated values in an array
  9199. * @link http://www.php.net/manual/en/function.array-flip.php
  9200. * @param trans array <p>
  9201. * An array of key/value pairs to be flipped.
  9202. * </p>
  9203. * @return array the flipped array on success and &null; on failure.
  9204. */
  9205. function array_flip (array $trans) {}
  9206. /**
  9207. * Changes all keys in an array
  9208. * @link http://www.php.net/manual/en/function.array-change-key-case.php
  9209. * @param input array <p>
  9210. * The array to work on
  9211. * </p>
  9212. * @param case int[optional] <p>
  9213. * Either CASE_UPPER or
  9214. * CASE_LOWER (default)
  9215. * </p>
  9216. * @return array an array with its keys lower or uppercased, or false if
  9217. * input is not an array.
  9218. */
  9219. function array_change_key_case (array $input, $case = null) {}
  9220. /**
  9221. * Pick one or more random entries out of an array
  9222. * @link http://www.php.net/manual/en/function.array-rand.php
  9223. * @param input array <p>
  9224. * The input array.
  9225. * </p>
  9226. * @param num_req int[optional] <p>
  9227. * Specifies how many entries you want to pick. Trying to pick more
  9228. * elements than there are in the array will result in an
  9229. * E_WARNING level error.
  9230. * </p>
  9231. * @return mixed If you are picking only one entry, array_rand
  9232. * returns the key for a random entry. Otherwise, it returns an array
  9233. * of keys for the random entries. This is done so that you can pick
  9234. * random keys as well as values out of the array.
  9235. */
  9236. function array_rand (array $input, $num_req = null) {}
  9237. /**
  9238. * Removes duplicate values from an array
  9239. * @link http://www.php.net/manual/en/function.array-unique.php
  9240. * @param array array <p>
  9241. * The input array.
  9242. * </p>
  9243. * @param sort_flags int[optional] <p>
  9244. * The optional second parameter sort_flags
  9245. * may be used to modify the sorting behavior using these values:
  9246. * </p>
  9247. * <p>
  9248. * Sorting type flags:
  9249. * SORT_REGULAR - compare items normally
  9250. * (don't change types)
  9251. * @return array the filtered array.
  9252. */
  9253. function array_unique (array $array, $sort_flags = null) {}
  9254. /**
  9255. * Computes the intersection of arrays
  9256. * @link http://www.php.net/manual/en/function.array-intersect.php
  9257. * @param array1 array <p>
  9258. * The array with master values to check.
  9259. * </p>
  9260. * @param array2 array <p>
  9261. * An array to compare values against.
  9262. * </p>
  9263. * @param _ array[optional]
  9264. * @return array an array containing all of the values in
  9265. * array1 whose values exist in all of the parameters.
  9266. */
  9267. function array_intersect (array $array1, array $array2, array $_ = null) {}
  9268. /**
  9269. * Computes the intersection of arrays using keys for comparison
  9270. * @link http://www.php.net/manual/en/function.array-intersect-key.php
  9271. * @param array1 array <p>
  9272. * The array with master keys to check.
  9273. * </p>
  9274. * @param array2 array <p>
  9275. * An array to compare keys against.
  9276. * </p>
  9277. * @param _ array[optional]
  9278. * @return array an associative array containing all the entries of
  9279. * array1 which have keys that are present in all
  9280. * arguments.
  9281. */
  9282. function array_intersect_key (array $array1, array $array2, array $_ = null) {}
  9283. /**
  9284. * Computes the intersection of arrays using a callback function on the keys for comparison
  9285. * @link http://www.php.net/manual/en/function.array-intersect-ukey.php
  9286. * @param array1 array <p>
  9287. * Initial array for comparison of the arrays.
  9288. * </p>
  9289. * @param array2 array <p>
  9290. * First array to compare keys against.
  9291. * </p>
  9292. * @param _ array[optional]
  9293. * @param key_compare_func callback <p>
  9294. * User supplied callback function to do the comparison.
  9295. * </p>
  9296. * @return array the values of array1 whose keys exist
  9297. * in all the arguments.
  9298. */
  9299. function array_intersect_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9300. /**
  9301. * Computes the intersection of arrays, compares data by a callback function
  9302. * @link http://www.php.net/manual/en/function.array-uintersect.php
  9303. * @param array1 array <p>
  9304. * The first array.
  9305. * </p>
  9306. * @param array2 array <p>
  9307. * The second array.
  9308. * </p>
  9309. * @param _ array[optional]
  9310. * @param data_compare_func callback <p>
  9311. * The callback comparison function.
  9312. * </p>
  9313. * <p>
  9314. * The user supplied callback function is used for comparison.
  9315. * It must return an integer less than, equal to, or greater than zero if
  9316. * the first argument is considered to be respectively less than, equal
  9317. * to, or greater than the second.
  9318. * </p>
  9319. * @return array an array containing all the values of array1
  9320. * that are present in all the arguments.
  9321. */
  9322. function array_uintersect (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9323. /**
  9324. * Computes the intersection of arrays with additional index check
  9325. * @link http://www.php.net/manual/en/function.array-intersect-assoc.php
  9326. * @param array1 array <p>
  9327. * The array with master values to check.
  9328. * </p>
  9329. * @param array2 array <p>
  9330. * An array to compare values against.
  9331. * </p>
  9332. * @param _ array[optional]
  9333. * @return array an associative array containing all the values in
  9334. * array1 that are present in all of the arguments.
  9335. */
  9336. function array_intersect_assoc (array $array1, array $array2, array $_ = null) {}
  9337. /**
  9338. * Computes the intersection of arrays with additional index check, compares data by a callback function
  9339. * @link http://www.php.net/manual/en/function.array-uintersect-assoc.php
  9340. * @param array1 array <p>
  9341. * The first array.
  9342. * </p>
  9343. * @param array2 array <p>
  9344. * The second array.
  9345. * </p>
  9346. * @param _ array[optional]
  9347. * @param data_compare_func callback <p>
  9348. * For comparison is used the user supplied callback function.
  9349. * It must return an integer less than, equal
  9350. * to, or greater than zero if the first argument is considered to
  9351. * be respectively less than, equal to, or greater than the
  9352. * second.
  9353. * </p>
  9354. * @return array an array containing all the values of
  9355. * array1 that are present in all the arguments.
  9356. */
  9357. function array_uintersect_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9358. /**
  9359. * Computes the intersection of arrays with additional index check, compares indexes by a callback function
  9360. * @link http://www.php.net/manual/en/function.array-intersect-uassoc.php
  9361. * @param array1 array <p>
  9362. * Initial array for comparison of the arrays.
  9363. * </p>
  9364. * @param array2 array <p>
  9365. * First array to compare keys against.
  9366. * </p>
  9367. * @param _ array[optional]
  9368. * @param key_compare_func callback <p>
  9369. * User supplied callback function to do the comparison.
  9370. * </p>
  9371. * @return array the values of array1 whose values exist
  9372. * in all of the arguments.
  9373. */
  9374. function array_intersect_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9375. /**
  9376. * Computes the intersection of arrays with additional index check, compares data and indexes by a callback functions
  9377. * @link http://www.php.net/manual/en/function.array-uintersect-uassoc.php
  9378. * @param array1 array <p>
  9379. * The first array.
  9380. * </p>
  9381. * @param array2 array <p>
  9382. * The second array.
  9383. * </p>
  9384. * @param _ array[optional]
  9385. * @param data_compare_func callback <p>
  9386. * For comparison is used the user supplied callback function.
  9387. * It must return an integer less than, equal
  9388. * to, or greater than zero if the first argument is considered to
  9389. * be respectively less than, equal to, or greater than the
  9390. * second.
  9391. * </p>
  9392. * @param key_compare_func callback <p>
  9393. * Key comparison callback function.
  9394. * </p>
  9395. * @return array an array containing all the values of
  9396. * array1 that are present in all the arguments.
  9397. */
  9398. function array_uintersect_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  9399. /**
  9400. * Computes the difference of arrays
  9401. * @link http://www.php.net/manual/en/function.array-diff.php
  9402. * @param array1 array <p>
  9403. * The array to compare from
  9404. * </p>
  9405. * @param array2 array <p>
  9406. * An array to compare against
  9407. * </p>
  9408. * @param _ array[optional]
  9409. * @return array an array containing all the entries from
  9410. * array1 that are not present in any of the other arrays.
  9411. */
  9412. function array_diff (array $array1, array $array2, array $_ = null) {}
  9413. /**
  9414. * Computes the difference of arrays using keys for comparison
  9415. * @link http://www.php.net/manual/en/function.array-diff-key.php
  9416. * @param array1 array <p>
  9417. * The array to compare from
  9418. * </p>
  9419. * @param array2 array <p>
  9420. * An array to compare against
  9421. * </p>
  9422. * @param _ array[optional]
  9423. * @return array an array containing all the entries from
  9424. * array1 whose keys are not present in any of the
  9425. * other arrays.
  9426. */
  9427. function array_diff_key (array $array1, array $array2, array $_ = null) {}
  9428. /**
  9429. * Computes the difference of arrays using a callback function on the keys for comparison
  9430. * @link http://www.php.net/manual/en/function.array-diff-ukey.php
  9431. * @param array1 array <p>
  9432. * The array to compare from
  9433. * </p>
  9434. * @param array2 array <p>
  9435. * An array to compare against
  9436. * </p>
  9437. * @param _ array[optional]
  9438. * @param key_compare_func callback <p>
  9439. * callback function to use.
  9440. * The callback function must return an integer less than, equal
  9441. * to, or greater than zero if the first argument is considered to
  9442. * be respectively less than, equal to, or greater than the second.
  9443. * </p>
  9444. * @return array an array containing all the entries from
  9445. * array1 that are not present in any of the other arrays.
  9446. */
  9447. function array_diff_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9448. /**
  9449. * Computes the difference of arrays by using a callback function for data comparison
  9450. * @link http://www.php.net/manual/en/function.array-udiff.php
  9451. * @param array1 array <p>
  9452. * The first array.
  9453. * </p>
  9454. * @param array2 array <p>
  9455. * The second array.
  9456. * </p>
  9457. * @param _ array[optional]
  9458. * @param data_compare_func callback <p>
  9459. * The callback comparison function.
  9460. * </p>
  9461. * <p>
  9462. * The user supplied callback function is used for comparison.
  9463. * It must return an integer less than, equal to, or greater than zero if
  9464. * the first argument is considered to be respectively less than, equal
  9465. * to, or greater than the second.
  9466. * </p>
  9467. * @return array an array containing all the values of array1
  9468. * that are not present in any of the other arguments.
  9469. */
  9470. function array_udiff (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9471. /**
  9472. * Computes the difference of arrays with additional index check
  9473. * @link http://www.php.net/manual/en/function.array-diff-assoc.php
  9474. * @param array1 array <p>
  9475. * The array to compare from
  9476. * </p>
  9477. * @param array2 array <p>
  9478. * An array to compare against
  9479. * </p>
  9480. * @param _ array[optional]
  9481. * @return array an array containing all the values from
  9482. * array1 that are not present in any of the other arrays.
  9483. */
  9484. function array_diff_assoc (array $array1, array $array2, array $_ = null) {}
  9485. /**
  9486. * Computes the difference of arrays with additional index check, compares data by a callback function
  9487. * @link http://www.php.net/manual/en/function.array-udiff-assoc.php
  9488. * @param array1 array <p>
  9489. * The first array.
  9490. * </p>
  9491. * @param array2 array <p>
  9492. * The second array.
  9493. * </p>
  9494. * @param _ array[optional]
  9495. * @param data_compare_func callback <p>
  9496. * The callback comparison function.
  9497. * </p>
  9498. * <p>
  9499. * The user supplied callback function is used for comparison.
  9500. * It must return an integer less than, equal to, or greater than zero if
  9501. * the first argument is considered to be respectively less than, equal
  9502. * to, or greater than the second.
  9503. * </p>
  9504. * @return array array_udiff_assoc returns an array
  9505. * containing all the values from array1
  9506. * that are not present in any of the other arguments.
  9507. * Note that the keys are used in the comparison unlike
  9508. * array_diff and array_udiff.
  9509. * The comparison of arrays' data is performed by using an user-supplied
  9510. * callback. In this aspect the behaviour is opposite to the behaviour of
  9511. * array_diff_assoc which uses internal function for
  9512. * comparison.
  9513. */
  9514. function array_udiff_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9515. /**
  9516. * Computes the difference of arrays with additional index check which is performed by a user supplied callback function
  9517. * @link http://www.php.net/manual/en/function.array-diff-uassoc.php
  9518. * @param array1 array <p>
  9519. * The array to compare from
  9520. * </p>
  9521. * @param array2 array <p>
  9522. * An array to compare against
  9523. * </p>
  9524. * @param _ array[optional]
  9525. * @param key_compare_func callback <p>
  9526. * callback function to use.
  9527. * The callback function must return an integer less than, equal
  9528. * to, or greater than zero if the first argument is considered to
  9529. * be respectively less than, equal to, or greater than the second.
  9530. * </p>
  9531. * @return array an array containing all the entries from
  9532. * array1 that are not present in any of the other arrays.
  9533. */
  9534. function array_diff_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9535. /**
  9536. * Computes the difference of arrays with additional index check, compares data and indexes by a callback function
  9537. * @link http://www.php.net/manual/en/function.array-udiff-uassoc.php
  9538. * @param array1 array <p>
  9539. * The first array.
  9540. * </p>
  9541. * @param array2 array <p>
  9542. * The second array.
  9543. * </p>
  9544. * @param _ array[optional]
  9545. * @param data_compare_func callback <p>
  9546. * The callback comparison function.
  9547. * </p>
  9548. * <p>
  9549. * The user supplied callback function is used for comparison.
  9550. * It must return an integer less than, equal to, or greater than zero if
  9551. * the first argument is considered to be respectively less than, equal
  9552. * to, or greater than the second.
  9553. * </p>
  9554. * <p>
  9555. * The comparison of arrays' data is performed by using an user-supplied
  9556. * callback : data_compare_func. In this aspect
  9557. * the behaviour is opposite to the behaviour of
  9558. * array_diff_assoc which uses internal function for
  9559. * comparison.
  9560. * </p>
  9561. * @param key_compare_func callback <p>
  9562. * The comparison of keys (indices) is done also by the callback function
  9563. * key_compare_func. This behaviour is unlike what
  9564. * array_udiff_assoc does, since the latter compares
  9565. * the indices by using an internal function.
  9566. * </p>
  9567. * @return array an array containing all the values from
  9568. * array1 that are not present in any of the other
  9569. * arguments.
  9570. */
  9571. function array_udiff_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  9572. /**
  9573. * Calculate the sum of values in an array
  9574. * @link http://www.php.net/manual/en/function.array-sum.php
  9575. * @param array array <p>
  9576. * The input array.
  9577. * </p>
  9578. * @return number the sum of values as an integer or float.
  9579. */
  9580. function array_sum (array $array) {}
  9581. /**
  9582. * Calculate the product of values in an array
  9583. * @link http://www.php.net/manual/en/function.array-product.php
  9584. * @param array array <p>
  9585. * The array.
  9586. * </p>
  9587. * @return number the product as an integer or float.
  9588. */
  9589. function array_product (array $array) {}
  9590. /**
  9591. * Filters elements of an array using a callback function
  9592. * @link http://www.php.net/manual/en/function.array-filter.php
  9593. * @param input array <p>
  9594. * The array to iterate over
  9595. * </p>
  9596. * @param callback callback[optional] <p>
  9597. * The callback function to use
  9598. * </p>
  9599. * <p>
  9600. * If no callback is supplied, all entries of
  9601. * input equal to false (see
  9602. * converting to
  9603. * boolean) will be removed.
  9604. * </p>
  9605. * @return array the filtered array.
  9606. */
  9607. function array_filter (array $input, $callback = null) {}
  9608. /**
  9609. * Applies the callback to the elements of the given arrays
  9610. * @link http://www.php.net/manual/en/function.array-map.php
  9611. * @param callback callback <p>
  9612. * Callback function to run for each element in each array.
  9613. * </p>
  9614. * @param arr1 array <p>
  9615. * An array to run through the callback function.
  9616. * </p>
  9617. * @param _ array[optional]
  9618. * @return array an array containing all the elements of arr1
  9619. * after applying the callback function to each one.
  9620. */
  9621. function array_map ($callback, array $arr1, array $_ = null) {}
  9622. /**
  9623. * Split an array into chunks
  9624. * @link http://www.php.net/manual/en/function.array-chunk.php
  9625. * @param input array <p>
  9626. * The array to work on
  9627. * </p>
  9628. * @param size int <p>
  9629. * The size of each chunk
  9630. * </p>
  9631. * @param preserve_keys bool[optional] <p>
  9632. * When set to true keys will be preserved.
  9633. * Default is false which will reindex the chunk numerically
  9634. * </p>
  9635. * @return array a multidimensional numerically indexed array, starting with zero,
  9636. * with each dimension containing size elements.
  9637. */
  9638. function array_chunk (array $input, $size, $preserve_keys = null) {}
  9639. /**
  9640. * Creates an array by using one array for keys and another for its values
  9641. * @link http://www.php.net/manual/en/function.array-combine.php
  9642. * @param keys array <p>
  9643. * Array of keys to be used. Illegal values for key will be
  9644. * converted to string.
  9645. * </p>
  9646. * @param values array <p>
  9647. * Array of values to be used
  9648. * </p>
  9649. * @return array the combined array, false if the number of elements
  9650. * for each array isn't equal.
  9651. */
  9652. function array_combine (array $keys, array $values) {}
  9653. /**
  9654. * Checks if the given key or index exists in the array
  9655. * @link http://www.php.net/manual/en/function.array-key-exists.php
  9656. * @param key mixed <p>
  9657. * Value to check.
  9658. * </p>
  9659. * @param search array <p>
  9660. * An array with keys to check.
  9661. * </p>
  9662. * @return bool Returns true on success or false on failure.
  9663. */
  9664. function array_key_exists ($key, array $search) {}
  9665. /**
  9666. * &Alias; <function>current</function>
  9667. * @link http://www.php.net/manual/en/function.pos.php
  9668. * @param arg
  9669. */
  9670. function pos (&$arg) {}
  9671. /**
  9672. * &Alias; <function>count</function>
  9673. * @link http://www.php.net/manual/en/function.sizeof.php
  9674. * @param var
  9675. * @param mode[optional]
  9676. */
  9677. function sizeof ($var, $mode) {}
  9678. /**
  9679. * @param key
  9680. * @param search
  9681. */
  9682. function key_exists ($key, $search) {}
  9683. /**
  9684. * Checks if assertion is &false;
  9685. * @link http://www.php.net/manual/en/function.assert.php
  9686. * @param assertion mixed <p>
  9687. * The assertion.
  9688. * </p>
  9689. * @return bool false if the assertion is false, true otherwise.
  9690. */
  9691. function assert ($assertion) {}
  9692. /**
  9693. * Set/get the various assert flags
  9694. * @link http://www.php.net/manual/en/function.assert-options.php
  9695. * @param what int <p>
  9696. * <table>
  9697. * Assert Options
  9698. * <tr valign="top">
  9699. * <td>Option</td>
  9700. * <td>INI Setting</td>
  9701. * <td>Default value</td>
  9702. * <td>Description</td>
  9703. * </tr>
  9704. * <tr valign="top">
  9705. * <td>ASSERT_ACTIVE</td>
  9706. * <td>assert.active</td>
  9707. * <td>1</td>
  9708. * <td>enable assert evaluation</td>
  9709. * </tr>
  9710. * <tr valign="top">
  9711. * <td>ASSERT_WARNING</td>
  9712. * <td>assert.warning</td>
  9713. * <td>1</td>
  9714. * <td>issue a PHP warning for each failed assertion</td>
  9715. * </tr>
  9716. * <tr valign="top">
  9717. * <td>ASSERT_BAIL</td>
  9718. * <td>assert.bail</td>
  9719. * <td>0</td>
  9720. * <td>terminate execution on failed assertions</td>
  9721. * </tr>
  9722. * <tr valign="top">
  9723. * <td>ASSERT_QUIET_EVAL</td>
  9724. * <td>assert.quiet_eval</td>
  9725. * <td>0</td>
  9726. * <td>
  9727. * disable error_reporting during assertion expression
  9728. * evaluation
  9729. * </td>
  9730. * </tr>
  9731. * <tr valign="top">
  9732. * <td>ASSERT_CALLBACK</td>
  9733. * <td>assert.callback</td>
  9734. * <td)<&null;)</td>
  9735. * <td>Callback to call on failed assertions</td>
  9736. * </tr>
  9737. * </table>
  9738. * </p>
  9739. * @param value mixed[optional] <p>
  9740. * An optional new value for the option.
  9741. * </p>
  9742. * @return mixed the original setting of any option or false on errors.
  9743. */
  9744. function assert_options ($what, $value = null) {}
  9745. /**
  9746. * Compares two "PHP-standardized" version number strings
  9747. * @link http://www.php.net/manual/en/function.version-compare.php
  9748. * @param version1 string <p>
  9749. * First version number.
  9750. * </p>
  9751. * @param version2 string <p>
  9752. * Second version number.
  9753. * </p>
  9754. * @param operator string[optional] <p>
  9755. * If you specify the third optional operator
  9756. * argument, you can test for a particular relationship. The
  9757. * possible operators are: &lt;,
  9758. * lt, &lt;=,
  9759. * le, &gt;,
  9760. * gt, &gt;=,
  9761. * ge, ==,
  9762. * =, eq,
  9763. * !=, &lt;&gt;,
  9764. * ne respectively.
  9765. * </p>
  9766. * <p>
  9767. * This parameter is case-sensitive, so values should be lowercase.
  9768. * </p>
  9769. * @return mixed By default, version_compare returns
  9770. * -1 if the first version is lower than the second,
  9771. * 0 if they are equal, and
  9772. * 1 if the second is lower.
  9773. * </p>
  9774. * <p>
  9775. * When using the optional operator argument, the
  9776. * function will return true if the relationship is the one specified
  9777. * by the operator, false otherwise.
  9778. */
  9779. function version_compare ($version1, $version2, $operator = null) {}
  9780. /**
  9781. * Convert a pathname and a project identifier to a System V IPC key
  9782. * @link http://www.php.net/manual/en/function.ftok.php
  9783. * @param pathname string <p>
  9784. * Path to an accessible file.
  9785. * </p>
  9786. * @param proj string <p>
  9787. * Project identifier. This must be a one character string.
  9788. * </p>
  9789. * @return int On success the return value will be the created key value, otherwise
  9790. * -1 is returned.
  9791. */
  9792. function ftok ($pathname, $proj) {}
  9793. /**
  9794. * Perform the rot13 transform on a string
  9795. * @link http://www.php.net/manual/en/function.str-rot13.php
  9796. * @param str string <p>
  9797. * The input string.
  9798. * </p>
  9799. * @return string the ROT13 version of the given string.
  9800. */
  9801. function str_rot13 ($str) {}
  9802. /**
  9803. * Retrieve list of registered filters
  9804. * @link http://www.php.net/manual/en/function.stream-get-filters.php
  9805. * @return array an indexed array containing the name of all stream filters
  9806. * available.
  9807. */
  9808. function stream_get_filters () {}
  9809. /**
  9810. * Register a user defined stream filter
  9811. * @link http://www.php.net/manual/en/function.stream-filter-register.php
  9812. * @param filtername string <p>
  9813. * The filter name to be registered.
  9814. * </p>
  9815. * @param classname string <p>
  9816. * To implement a filter, you need to define a class as an extension of
  9817. * php_user_filter with a number of member functions
  9818. * as defined below. When performing read/write operations on the stream
  9819. * to which your filter is attached, PHP will pass the data through your
  9820. * filter (and any other filters attached to that stream) so that the
  9821. * data may be modified as desired. You must implement the methods
  9822. * exactly as described below - doing otherwise will lead to undefined
  9823. * behaviour.
  9824. * </p>
  9825. * intfilter
  9826. * resourcein
  9827. * resourceout
  9828. * intconsumed
  9829. * boolclosing
  9830. * <p>
  9831. * This method is called whenever data is read from or written to
  9832. * the attached stream (such as with fread or fwrite).
  9833. * in is a resource pointing to a bucket brigade
  9834. * which contains one or more bucket objects containing data to be filtered.
  9835. * out is a resource pointing to a second bucket brigade
  9836. * into which your modified buckets should be placed.
  9837. * consumed, which must always
  9838. * be declared by reference, should be incremented by the length of the data
  9839. * which your filter reads in and alters. In most cases this means you will
  9840. * increment consumed by $bucket->datalen
  9841. * for each $bucket. If the stream is in the process of closing
  9842. * (and therefore this is the last pass through the filterchain),
  9843. * the closing parameter will be set to true.
  9844. * The filter method must return one of
  9845. * three values upon completion.
  9846. * <tr valign="top">
  9847. * <td>Return Value</td>
  9848. * <td>Meaning</td>
  9849. * </tr>
  9850. * <tr valign="top">
  9851. * <td>PSFS_PASS_ON</td>
  9852. * <td>
  9853. * Filter processed successfully with data available in the
  9854. * out bucket brigade.
  9855. * </td>
  9856. * </tr>
  9857. * <tr valign="top">
  9858. * <td>PSFS_FEED_ME</td>
  9859. * <td>
  9860. * Filter processed successfully, however no data was available to
  9861. * return. More data is required from the stream or prior filter.
  9862. * </td>
  9863. * </tr>
  9864. * <tr valign="top">
  9865. * <td>PSFS_ERR_FATAL (default)</td>
  9866. * <td>
  9867. * The filter experienced an unrecoverable error and cannot continue.
  9868. * </td>
  9869. * </tr>
  9870. * </p>
  9871. * boolonCreate
  9872. * This method is called during instantiation of the filter class
  9873. * object. If your filter allocates or initializes any other resources
  9874. * (such as a buffer), this is the place to do it. Your implementation of
  9875. * this method should return false on failure, or true on success.
  9876. * When your filter is first instantiated, and
  9877. * yourfilter-&gt;onCreate() is called, a number of properties
  9878. * will be available as shown in the table below.
  9879. * <p>
  9880. * <tr valign="top">
  9881. * <td>Property</td>
  9882. * <td>Contents</td>
  9883. * </tr>
  9884. * <tr valign="top">
  9885. * <td>FilterClass-&gt;filtername</td>
  9886. * <td>
  9887. * A string containing the name the filter was instantiated with.
  9888. * Filters may be registered under multiple names or under wildcards.
  9889. * Use this property to determine which name was used.
  9890. * </td>
  9891. * </tr>
  9892. * <tr valign="top">
  9893. * <td>FilterClass-&gt;params</td>
  9894. * <td>
  9895. * The contents of the params parameter passed
  9896. * to stream_filter_append
  9897. * or stream_filter_prepend.
  9898. * </td>
  9899. * </tr>
  9900. * <tr valign="top">
  9901. * <td>FilterClass-&gt;stream</td>
  9902. * <td>
  9903. * The stream resource being filtered. Maybe available only during
  9904. * filter calls when the
  9905. * closing parameter is set to false.
  9906. * </td>
  9907. * </tr>
  9908. * </p>
  9909. * voidonClose
  9910. * <p>
  9911. * This method is called upon filter shutdown (typically, this is also
  9912. * during stream shutdown), and is executed after
  9913. * the flush method is called. If any resources
  9914. * were allocated or initialized during onCreate()
  9915. * this would be the time to destroy or dispose of them.
  9916. * </p>
  9917. * @return bool Returns true on success or false on failure.
  9918. * </p>
  9919. * <p>
  9920. * stream_filter_register will return false if the
  9921. * filtername is already defined.
  9922. */
  9923. function stream_filter_register ($filtername, $classname) {}
  9924. /**
  9925. * Return a bucket object from the brigade for operating on
  9926. * @link http://www.php.net/manual/en/function.stream-bucket-make-writeable.php
  9927. * @param brigade resource
  9928. * @return object
  9929. */
  9930. function stream_bucket_make_writeable ($brigade) {}
  9931. /**
  9932. * Prepend bucket to brigade
  9933. * @link http://www.php.net/manual/en/function.stream-bucket-prepend.php
  9934. * @param brigade resource
  9935. * @param bucket resource
  9936. * @return void
  9937. */
  9938. function stream_bucket_prepend ($brigade, $bucket) {}
  9939. /**
  9940. * Append bucket to brigade
  9941. * @link http://www.php.net/manual/en/function.stream-bucket-append.php
  9942. * @param brigade resource
  9943. * @param bucket resource
  9944. * @return void
  9945. */
  9946. function stream_bucket_append ($brigade, $bucket) {}
  9947. /**
  9948. * Create a new bucket for use on the current stream
  9949. * @link http://www.php.net/manual/en/function.stream-bucket-new.php
  9950. * @param stream resource
  9951. * @param buffer string
  9952. * @return object
  9953. */
  9954. function stream_bucket_new ($stream, $buffer) {}
  9955. /**
  9956. * Add URL rewriter values
  9957. * @link http://www.php.net/manual/en/function.output-add-rewrite-var.php
  9958. * @param name string <p>
  9959. * The variable name.
  9960. * </p>
  9961. * @param value string <p>
  9962. * The variable value.
  9963. * </p>
  9964. * @return bool Returns true on success or false on failure.
  9965. */
  9966. function output_add_rewrite_var ($name, $value) {}
  9967. /**
  9968. * Reset URL rewriter values
  9969. * @link http://www.php.net/manual/en/function.output-reset-rewrite-vars.php
  9970. * @return bool Returns true on success or false on failure.
  9971. */
  9972. function output_reset_rewrite_vars () {}
  9973. /**
  9974. * Returns directory path used for temporary files
  9975. * @link http://www.php.net/manual/en/function.sys-get-temp-dir.php
  9976. * @return string the path of the temporary directory.
  9977. */
  9978. function sys_get_temp_dir () {}
  9979. define ('CONNECTION_ABORTED', 1);
  9980. define ('CONNECTION_NORMAL', 0);
  9981. define ('CONNECTION_TIMEOUT', 2);
  9982. define ('INI_USER', 1);
  9983. define ('INI_PERDIR', 2);
  9984. define ('INI_SYSTEM', 4);
  9985. define ('INI_ALL', 7);
  9986. /**
  9987. * Normal INI scanner mode (since PHP 5.3).
  9988. * @link http://www.php.net/manual/en/filesystem.constants.php
  9989. */
  9990. define ('INI_SCANNER_NORMAL', 0);
  9991. /**
  9992. * Raw INI scanner mode (since PHP 5.3).
  9993. * @link http://www.php.net/manual/en/filesystem.constants.php
  9994. */
  9995. define ('INI_SCANNER_RAW', 1);
  9996. define ('PHP_URL_SCHEME', 0);
  9997. define ('PHP_URL_HOST', 1);
  9998. define ('PHP_URL_PORT', 2);
  9999. define ('PHP_URL_USER', 3);
  10000. define ('PHP_URL_PASS', 4);
  10001. define ('PHP_URL_PATH', 5);
  10002. define ('PHP_URL_QUERY', 6);
  10003. define ('PHP_URL_FRAGMENT', 7);
  10004. define ('PHP_QUERY_RFC1738', 1);
  10005. define ('PHP_QUERY_RFC3986', 2);
  10006. define ('M_E', 2.718281828459);
  10007. define ('M_LOG2E', 1.442695040889);
  10008. define ('M_LOG10E', 0.43429448190325);
  10009. define ('M_LN2', 0.69314718055995);
  10010. define ('M_LN10', 2.302585092994);
  10011. /**
  10012. * Round halves up
  10013. * @link http://www.php.net/manual/en/math.constants.php
  10014. */
  10015. define ('M_PI', 3.1415926535898);
  10016. define ('M_PI_2', 1.5707963267949);
  10017. define ('M_PI_4', 0.78539816339745);
  10018. define ('M_1_PI', 0.31830988618379);
  10019. define ('M_2_PI', 0.63661977236758);
  10020. define ('M_SQRTPI', 1.7724538509055);
  10021. define ('M_2_SQRTPI', 1.1283791670955);
  10022. define ('M_LNPI', 1.1447298858494);
  10023. define ('M_EULER', 0.57721566490153);
  10024. define ('M_SQRT2', 1.4142135623731);
  10025. define ('M_SQRT1_2', 0.70710678118655);
  10026. define ('M_SQRT3', 1.7320508075689);
  10027. define ('INF', INF);
  10028. define ('NAN', NAN);
  10029. define ('PHP_ROUND_HALF_UP', 1);
  10030. /**
  10031. * Round halves down
  10032. * @link http://www.php.net/manual/en/math.constants.php
  10033. */
  10034. define ('PHP_ROUND_HALF_DOWN', 2);
  10035. /**
  10036. * Round halves to even numbers
  10037. * @link http://www.php.net/manual/en/math.constants.php
  10038. */
  10039. define ('PHP_ROUND_HALF_EVEN', 3);
  10040. /**
  10041. * Round halves to odd numbers
  10042. * @link http://www.php.net/manual/en/math.constants.php
  10043. */
  10044. define ('PHP_ROUND_HALF_ODD', 4);
  10045. define ('INFO_GENERAL', 1);
  10046. /**
  10047. * PHP Credits. See also phpcredits.
  10048. * @link http://www.php.net/manual/en/info.constants.php
  10049. */
  10050. define ('INFO_CREDITS', 2);
  10051. /**
  10052. * Current Local and Master values for PHP directives. See
  10053. * also ini_get.
  10054. * @link http://www.php.net/manual/en/info.constants.php
  10055. */
  10056. define ('INFO_CONFIGURATION', 4);
  10057. /**
  10058. * Loaded modules and their respective settings.
  10059. * @link http://www.php.net/manual/en/info.constants.php
  10060. */
  10061. define ('INFO_MODULES', 8);
  10062. /**
  10063. * Environment Variable information that's also available in
  10064. * $_ENV.
  10065. * @link http://www.php.net/manual/en/info.constants.php
  10066. */
  10067. define ('INFO_ENVIRONMENT', 16);
  10068. /**
  10069. * Shows all
  10070. * predefined variables from EGPCS (Environment, GET,
  10071. * POST, Cookie, Server).
  10072. * @link http://www.php.net/manual/en/info.constants.php
  10073. */
  10074. define ('INFO_VARIABLES', 32);
  10075. /**
  10076. * PHP License information. See also the license faq.
  10077. * @link http://www.php.net/manual/en/info.constants.php
  10078. */
  10079. define ('INFO_LICENSE', 64);
  10080. define ('INFO_ALL', -1);
  10081. /**
  10082. * A list of the core developers
  10083. * @link http://www.php.net/manual/en/info.constants.php
  10084. */
  10085. define ('CREDITS_GROUP', 1);
  10086. /**
  10087. * General credits: Language design and concept, PHP
  10088. * authors and SAPI module.
  10089. * @link http://www.php.net/manual/en/info.constants.php
  10090. */
  10091. define ('CREDITS_GENERAL', 2);
  10092. /**
  10093. * A list of the server API modules for PHP, and their authors.
  10094. * @link http://www.php.net/manual/en/info.constants.php
  10095. */
  10096. define ('CREDITS_SAPI', 4);
  10097. /**
  10098. * A list of the extension modules for PHP, and their authors.
  10099. * @link http://www.php.net/manual/en/info.constants.php
  10100. */
  10101. define ('CREDITS_MODULES', 8);
  10102. /**
  10103. * The credits for the documentation team.
  10104. * @link http://www.php.net/manual/en/info.constants.php
  10105. */
  10106. define ('CREDITS_DOCS', 16);
  10107. /**
  10108. * Usually used in combination with the other flags. Indicates
  10109. * that a complete stand-alone HTML page needs to be
  10110. * printed including the information indicated by the other
  10111. * flags.
  10112. * @link http://www.php.net/manual/en/info.constants.php
  10113. */
  10114. define ('CREDITS_FULLPAGE', 32);
  10115. /**
  10116. * The credits for the quality assurance team.
  10117. * @link http://www.php.net/manual/en/info.constants.php
  10118. */
  10119. define ('CREDITS_QA', 64);
  10120. /**
  10121. * The configuration line, &php.ini; location, build date, Web
  10122. * Server, System and more.
  10123. * @link http://www.php.net/manual/en/info.constants.php
  10124. */
  10125. define ('CREDITS_ALL', -1);
  10126. define ('HTML_SPECIALCHARS', 0);
  10127. define ('HTML_ENTITIES', 1);
  10128. define ('ENT_COMPAT', 2);
  10129. define ('ENT_QUOTES', 3);
  10130. define ('ENT_NOQUOTES', 0);
  10131. define ('ENT_IGNORE', 4);
  10132. define ('ENT_SUBSTITUTE', 8);
  10133. define ('ENT_DISALLOWED', 128);
  10134. define ('ENT_HTML401', 0);
  10135. define ('ENT_XML1', 16);
  10136. define ('ENT_XHTML', 32);
  10137. define ('ENT_HTML5', 48);
  10138. define ('STR_PAD_LEFT', 0);
  10139. define ('STR_PAD_RIGHT', 1);
  10140. define ('STR_PAD_BOTH', 2);
  10141. define ('PATHINFO_DIRNAME', 1);
  10142. define ('PATHINFO_BASENAME', 2);
  10143. define ('PATHINFO_EXTENSION', 4);
  10144. /**
  10145. * Since PHP 5.2.0.
  10146. * @link http://www.php.net/manual/en/filesystem.constants.php
  10147. */
  10148. define ('PATHINFO_FILENAME', 8);
  10149. define ('CHAR_MAX', 127);
  10150. define ('LC_CTYPE', 0);
  10151. define ('LC_NUMERIC', 1);
  10152. define ('LC_TIME', 2);
  10153. define ('LC_COLLATE', 3);
  10154. define ('LC_MONETARY', 4);
  10155. define ('LC_ALL', 6);
  10156. define ('LC_MESSAGES', 5);
  10157. define ('SEEK_SET', 0);
  10158. define ('SEEK_CUR', 1);
  10159. define ('SEEK_END', 2);
  10160. define ('LOCK_SH', 1);
  10161. define ('LOCK_EX', 2);
  10162. define ('LOCK_UN', 3);
  10163. define ('LOCK_NB', 4);
  10164. /**
  10165. * A connection with an external resource has been established.
  10166. * @link http://www.php.net/manual/en/stream.constants.php
  10167. */
  10168. define ('STREAM_NOTIFY_CONNECT', 2);
  10169. /**
  10170. * Additional authorization is required to access the specified resource.
  10171. * Typical issued with severity level of
  10172. * STREAM_NOTIFY_SEVERITY_ERR.
  10173. * @link http://www.php.net/manual/en/stream.constants.php
  10174. */
  10175. define ('STREAM_NOTIFY_AUTH_REQUIRED', 3);
  10176. /**
  10177. * Authorization has been completed (with or without success).
  10178. * @link http://www.php.net/manual/en/stream.constants.php
  10179. */
  10180. define ('STREAM_NOTIFY_AUTH_RESULT', 10);
  10181. /**
  10182. * The mime-type of resource has been identified,
  10183. * refer to message for a description of the
  10184. * discovered type.
  10185. * @link http://www.php.net/manual/en/stream.constants.php
  10186. */
  10187. define ('STREAM_NOTIFY_MIME_TYPE_IS', 4);
  10188. /**
  10189. * The size of the resource has been discovered.
  10190. * @link http://www.php.net/manual/en/stream.constants.php
  10191. */
  10192. define ('STREAM_NOTIFY_FILE_SIZE_IS', 5);
  10193. /**
  10194. * The external resource has redirected the stream to an alternate
  10195. * location. Refer to message.
  10196. * @link http://www.php.net/manual/en/stream.constants.php
  10197. */
  10198. define ('STREAM_NOTIFY_REDIRECTED', 6);
  10199. /**
  10200. * Indicates current progress of the stream transfer in
  10201. * bytes_transferred and possibly
  10202. * bytes_max as well.
  10203. * @link http://www.php.net/manual/en/stream.constants.php
  10204. */
  10205. define ('STREAM_NOTIFY_PROGRESS', 7);
  10206. /**
  10207. * A generic error occurred on the stream, consult
  10208. * message and message_code
  10209. * for details.
  10210. * @link http://www.php.net/manual/en/stream.constants.php
  10211. */
  10212. define ('STREAM_NOTIFY_FAILURE', 9);
  10213. /**
  10214. * There is no more data available on the stream.
  10215. * @link http://www.php.net/manual/en/stream.constants.php
  10216. */
  10217. define ('STREAM_NOTIFY_COMPLETED', 8);
  10218. /**
  10219. * A remote address required for this stream has been resolved, or the resolution
  10220. * failed. See severity for an indication of which happened.
  10221. * @link http://www.php.net/manual/en/stream.constants.php
  10222. */
  10223. define ('STREAM_NOTIFY_RESOLVE', 1);
  10224. /**
  10225. * Normal, non-error related, notification.
  10226. * @link http://www.php.net/manual/en/stream.constants.php
  10227. */
  10228. define ('STREAM_NOTIFY_SEVERITY_INFO', 0);
  10229. /**
  10230. * Non critical error condition. Processing may continue.
  10231. * @link http://www.php.net/manual/en/stream.constants.php
  10232. */
  10233. define ('STREAM_NOTIFY_SEVERITY_WARN', 1);
  10234. /**
  10235. * A critical error occurred. Processing cannot continue.
  10236. * @link http://www.php.net/manual/en/stream.constants.php
  10237. */
  10238. define ('STREAM_NOTIFY_SEVERITY_ERR', 2);
  10239. /**
  10240. * Used with stream_filter_append and
  10241. * stream_filter_prepend to indicate
  10242. * that the specified filter should only be applied when
  10243. * reading
  10244. * @link http://www.php.net/manual/en/stream.constants.php
  10245. */
  10246. define ('STREAM_FILTER_READ', 1);
  10247. /**
  10248. * Used with stream_filter_append and
  10249. * stream_filter_prepend to indicate
  10250. * that the specified filter should only be applied when
  10251. * writing
  10252. * @link http://www.php.net/manual/en/stream.constants.php
  10253. */
  10254. define ('STREAM_FILTER_WRITE', 2);
  10255. /**
  10256. * This constant is equivalent to
  10257. * STREAM_FILTER_READ | STREAM_FILTER_WRITE
  10258. * @link http://www.php.net/manual/en/stream.constants.php
  10259. */
  10260. define ('STREAM_FILTER_ALL', 3);
  10261. /**
  10262. * Client socket opened with stream_socket_client
  10263. * should remain persistent between page loads.
  10264. * @link http://www.php.net/manual/en/stream.constants.php
  10265. */
  10266. define ('STREAM_CLIENT_PERSISTENT', 1);
  10267. /**
  10268. * Open client socket asynchronously. This option must be used
  10269. * together with the STREAM_CLIENT_CONNECT flag.
  10270. * Used with stream_socket_client.
  10271. * @link http://www.php.net/manual/en/stream.constants.php
  10272. */
  10273. define ('STREAM_CLIENT_ASYNC_CONNECT', 2);
  10274. /**
  10275. * Open client socket connection. Client sockets should always
  10276. * include this flag. Used with stream_socket_client.
  10277. * @link http://www.php.net/manual/en/stream.constants.php
  10278. */
  10279. define ('STREAM_CLIENT_CONNECT', 4);
  10280. define ('STREAM_CRYPTO_METHOD_SSLv2_CLIENT', 0);
  10281. define ('STREAM_CRYPTO_METHOD_SSLv3_CLIENT', 1);
  10282. define ('STREAM_CRYPTO_METHOD_SSLv23_CLIENT', 2);
  10283. define ('STREAM_CRYPTO_METHOD_TLS_CLIENT', 3);
  10284. define ('STREAM_CRYPTO_METHOD_SSLv2_SERVER', 4);
  10285. define ('STREAM_CRYPTO_METHOD_SSLv3_SERVER', 5);
  10286. define ('STREAM_CRYPTO_METHOD_SSLv23_SERVER', 6);
  10287. define ('STREAM_CRYPTO_METHOD_TLS_SERVER', 7);
  10288. /**
  10289. * Used with stream_socket_shutdown to disable
  10290. * further receptions. Added in PHP 5.2.1.
  10291. * @link http://www.php.net/manual/en/stream.constants.php
  10292. */
  10293. define ('STREAM_SHUT_RD', 0);
  10294. /**
  10295. * Used with stream_socket_shutdown to disable
  10296. * further transmissions. Added in PHP 5.2.1.
  10297. * @link http://www.php.net/manual/en/stream.constants.php
  10298. */
  10299. define ('STREAM_SHUT_WR', 1);
  10300. /**
  10301. * Used with stream_socket_shutdown to disable
  10302. * further receptions and transmissions. Added in PHP 5.2.1.
  10303. * @link http://www.php.net/manual/en/stream.constants.php
  10304. */
  10305. define ('STREAM_SHUT_RDWR', 2);
  10306. /**
  10307. * Internet Protocol Version 4 (IPv4).
  10308. * @link http://www.php.net/manual/en/stream.constants.php
  10309. */
  10310. define ('STREAM_PF_INET', 2);
  10311. /**
  10312. * Internet Protocol Version 6 (IPv6).
  10313. * @link http://www.php.net/manual/en/stream.constants.php
  10314. */
  10315. define ('STREAM_PF_INET6', 10);
  10316. /**
  10317. * Unix system internal protocols.
  10318. * @link http://www.php.net/manual/en/stream.constants.php
  10319. */
  10320. define ('STREAM_PF_UNIX', 1);
  10321. /**
  10322. * Provides a IP socket.
  10323. * @link http://www.php.net/manual/en/stream.constants.php
  10324. */
  10325. define ('STREAM_IPPROTO_IP', 0);
  10326. /**
  10327. * Provides a TCP socket.
  10328. * @link http://www.php.net/manual/en/stream.constants.php
  10329. */
  10330. define ('STREAM_IPPROTO_TCP', 6);
  10331. /**
  10332. * Provides a UDP socket.
  10333. * @link http://www.php.net/manual/en/stream.constants.php
  10334. */
  10335. define ('STREAM_IPPROTO_UDP', 17);
  10336. /**
  10337. * Provides a ICMP socket.
  10338. * @link http://www.php.net/manual/en/stream.constants.php
  10339. */
  10340. define ('STREAM_IPPROTO_ICMP', 1);
  10341. /**
  10342. * Provides a RAW socket.
  10343. * @link http://www.php.net/manual/en/stream.constants.php
  10344. */
  10345. define ('STREAM_IPPROTO_RAW', 255);
  10346. /**
  10347. * Provides sequenced, two-way byte streams with a transmission mechanism
  10348. * for out-of-band data (TCP, for example).
  10349. * @link http://www.php.net/manual/en/stream.constants.php
  10350. */
  10351. define ('STREAM_SOCK_STREAM', 1);
  10352. /**
  10353. * Provides datagrams, which are connectionless messages (UDP, for
  10354. * example).
  10355. * @link http://www.php.net/manual/en/stream.constants.php
  10356. */
  10357. define ('STREAM_SOCK_DGRAM', 2);
  10358. /**
  10359. * Provides a raw socket, which provides access to internal network
  10360. * protocols and interfaces. Usually this type of socket is just available
  10361. * to the root user.
  10362. * @link http://www.php.net/manual/en/stream.constants.php
  10363. */
  10364. define ('STREAM_SOCK_RAW', 3);
  10365. /**
  10366. * Provides a sequenced packet stream socket.
  10367. * @link http://www.php.net/manual/en/stream.constants.php
  10368. */
  10369. define ('STREAM_SOCK_SEQPACKET', 5);
  10370. /**
  10371. * Provides a RDM (Reliably-delivered messages) socket.
  10372. * @link http://www.php.net/manual/en/stream.constants.php
  10373. */
  10374. define ('STREAM_SOCK_RDM', 4);
  10375. define ('STREAM_PEEK', 2);
  10376. define ('STREAM_OOB', 1);
  10377. /**
  10378. * Tells a stream created with stream_socket_server
  10379. * to bind to the specified target. Server sockets should always include this flag.
  10380. * @link http://www.php.net/manual/en/stream.constants.php
  10381. */
  10382. define ('STREAM_SERVER_BIND', 4);
  10383. /**
  10384. * Tells a stream created with stream_socket_server
  10385. * and bound using the STREAM_SERVER_BIND flag to start
  10386. * listening on the socket. Connection-orientated transports (such as TCP)
  10387. * must use this flag, otherwise the server socket will not be enabled.
  10388. * Using this flag for connect-less transports (such as UDP) is an error.
  10389. * @link http://www.php.net/manual/en/stream.constants.php
  10390. */
  10391. define ('STREAM_SERVER_LISTEN', 8);
  10392. /**
  10393. * Search for filename in
  10394. * include_path (since PHP 5).
  10395. * @link http://www.php.net/manual/en/filesystem.constants.php
  10396. */
  10397. define ('FILE_USE_INCLUDE_PATH', 1);
  10398. /**
  10399. * Strip EOL characters (since PHP 5).
  10400. * @link http://www.php.net/manual/en/filesystem.constants.php
  10401. */
  10402. define ('FILE_IGNORE_NEW_LINES', 2);
  10403. /**
  10404. * Skip empty lines (since PHP 5).
  10405. * @link http://www.php.net/manual/en/filesystem.constants.php
  10406. */
  10407. define ('FILE_SKIP_EMPTY_LINES', 4);
  10408. /**
  10409. * Append content to existing file.
  10410. * @link http://www.php.net/manual/en/filesystem.constants.php
  10411. */
  10412. define ('FILE_APPEND', 8);
  10413. define ('FILE_NO_DEFAULT_CONTEXT', 16);
  10414. /**
  10415. * <p>
  10416. * Text mode (since PHP 5.2.7).
  10417. * <p>
  10418. * This constant has no effect, and is only available for
  10419. * forward compatibility.
  10420. * </p>
  10421. * </p>
  10422. * @link http://www.php.net/manual/en/filesystem.constants.php
  10423. */
  10424. define ('FILE_TEXT', 0);
  10425. /**
  10426. * <p>
  10427. * Binary mode (since PHP 5.2.7).
  10428. * <p>
  10429. * This constant has no effect, and is only available for
  10430. * forward compatibility.
  10431. * </p>
  10432. * </p>
  10433. * @link http://www.php.net/manual/en/filesystem.constants.php
  10434. */
  10435. define ('FILE_BINARY', 0);
  10436. /**
  10437. * Disable backslash escaping.
  10438. * @link http://www.php.net/manual/en/filesystem.constants.php
  10439. */
  10440. define ('FNM_NOESCAPE', 2);
  10441. /**
  10442. * Slash in string only matches slash in the given pattern.
  10443. * @link http://www.php.net/manual/en/filesystem.constants.php
  10444. */
  10445. define ('FNM_PATHNAME', 1);
  10446. /**
  10447. * Leading period in string must be exactly matched by period in the given pattern.
  10448. * @link http://www.php.net/manual/en/filesystem.constants.php
  10449. */
  10450. define ('FNM_PERIOD', 4);
  10451. /**
  10452. * Caseless match. Part of the GNU extension.
  10453. * @link http://www.php.net/manual/en/filesystem.constants.php
  10454. */
  10455. define ('FNM_CASEFOLD', 16);
  10456. /**
  10457. * Return Code indicating that the
  10458. * userspace filter returned buckets in $out.
  10459. * @link http://www.php.net/manual/en/stream.constants.php
  10460. */
  10461. define ('PSFS_PASS_ON', 2);
  10462. /**
  10463. * Return Code indicating that the
  10464. * userspace filter did not return buckets in $out
  10465. * (i.e. No data available).
  10466. * @link http://www.php.net/manual/en/stream.constants.php
  10467. */
  10468. define ('PSFS_FEED_ME', 1);
  10469. /**
  10470. * Return Code indicating that the
  10471. * userspace filter encountered an unrecoverable error
  10472. * (i.e. Invalid data received).
  10473. * @link http://www.php.net/manual/en/stream.constants.php
  10474. */
  10475. define ('PSFS_ERR_FATAL', 0);
  10476. /**
  10477. * Regular read/write.
  10478. * @link http://www.php.net/manual/en/stream.constants.php
  10479. */
  10480. define ('PSFS_FLAG_NORMAL', 0);
  10481. /**
  10482. * An incremental flush.
  10483. * @link http://www.php.net/manual/en/stream.constants.php
  10484. */
  10485. define ('PSFS_FLAG_FLUSH_INC', 1);
  10486. /**
  10487. * Final flush prior to closing.
  10488. * @link http://www.php.net/manual/en/stream.constants.php
  10489. */
  10490. define ('PSFS_FLAG_FLUSH_CLOSE', 2);
  10491. define ('ABDAY_1', 131072);
  10492. define ('ABDAY_2', 131073);
  10493. define ('ABDAY_3', 131074);
  10494. define ('ABDAY_4', 131075);
  10495. define ('ABDAY_5', 131076);
  10496. define ('ABDAY_6', 131077);
  10497. define ('ABDAY_7', 131078);
  10498. define ('DAY_1', 131079);
  10499. define ('DAY_2', 131080);
  10500. define ('DAY_3', 131081);
  10501. define ('DAY_4', 131082);
  10502. define ('DAY_5', 131083);
  10503. define ('DAY_6', 131084);
  10504. define ('DAY_7', 131085);
  10505. define ('ABMON_1', 131086);
  10506. define ('ABMON_2', 131087);
  10507. define ('ABMON_3', 131088);
  10508. define ('ABMON_4', 131089);
  10509. define ('ABMON_5', 131090);
  10510. define ('ABMON_6', 131091);
  10511. define ('ABMON_7', 131092);
  10512. define ('ABMON_8', 131093);
  10513. define ('ABMON_9', 131094);
  10514. define ('ABMON_10', 131095);
  10515. define ('ABMON_11', 131096);
  10516. define ('ABMON_12', 131097);
  10517. define ('MON_1', 131098);
  10518. define ('MON_2', 131099);
  10519. define ('MON_3', 131100);
  10520. define ('MON_4', 131101);
  10521. define ('MON_5', 131102);
  10522. define ('MON_6', 131103);
  10523. define ('MON_7', 131104);
  10524. define ('MON_8', 131105);
  10525. define ('MON_9', 131106);
  10526. define ('MON_10', 131107);
  10527. define ('MON_11', 131108);
  10528. define ('MON_12', 131109);
  10529. define ('AM_STR', 131110);
  10530. define ('PM_STR', 131111);
  10531. define ('D_T_FMT', 131112);
  10532. define ('D_FMT', 131113);
  10533. define ('T_FMT', 131114);
  10534. define ('T_FMT_AMPM', 131115);
  10535. define ('ERA', 131116);
  10536. define ('ERA_D_T_FMT', 131120);
  10537. define ('ERA_D_FMT', 131118);
  10538. define ('ERA_T_FMT', 131121);
  10539. define ('ALT_DIGITS', 131119);
  10540. define ('CRNCYSTR', 262159);
  10541. define ('RADIXCHAR', 65536);
  10542. define ('THOUSEP', 65537);
  10543. define ('YESEXPR', 327680);
  10544. define ('NOEXPR', 327681);
  10545. define ('CODESET', 14);
  10546. define ('CRYPT_SALT_LENGTH', 123);
  10547. define ('CRYPT_STD_DES', 1);
  10548. define ('CRYPT_EXT_DES', 1);
  10549. define ('CRYPT_MD5', 1);
  10550. define ('CRYPT_BLOWFISH', 1);
  10551. define ('CRYPT_SHA256', 1);
  10552. define ('CRYPT_SHA512', 1);
  10553. define ('DIRECTORY_SEPARATOR', "/");
  10554. /**
  10555. * Available since PHP 4.3.0. Semicolon on Windows, colon otherwise.
  10556. * @link http://www.php.net/manual/en/dir.constants.php
  10557. */
  10558. define ('PATH_SEPARATOR', ":");
  10559. /**
  10560. * Available since PHP 5.4.0.
  10561. * @link http://www.php.net/manual/en/dir.constants.php
  10562. */
  10563. define ('SCANDIR_SORT_ASCENDING', 0);
  10564. /**
  10565. * Available since PHP 5.4.0.
  10566. * @link http://www.php.net/manual/en/dir.constants.php
  10567. */
  10568. define ('SCANDIR_SORT_DESCENDING', 1);
  10569. /**
  10570. * Available since PHP 5.4.0.
  10571. * @link http://www.php.net/manual/en/dir.constants.php
  10572. */
  10573. define ('SCANDIR_SORT_NONE', 2);
  10574. define ('GLOB_BRACE', 1024);
  10575. define ('GLOB_MARK', 2);
  10576. define ('GLOB_NOSORT', 4);
  10577. define ('GLOB_NOCHECK', 16);
  10578. define ('GLOB_NOESCAPE', 64);
  10579. define ('GLOB_ERR', 1);
  10580. define ('GLOB_ONLYDIR', 8192);
  10581. define ('GLOB_AVAILABLE_FLAGS', 9303);
  10582. /**
  10583. * system is unusable
  10584. * @link http://www.php.net/manual/en/network.constants.php
  10585. */
  10586. define ('LOG_EMERG', 0);
  10587. /**
  10588. * action must be taken immediately
  10589. * @link http://www.php.net/manual/en/network.constants.php
  10590. */
  10591. define ('LOG_ALERT', 1);
  10592. /**
  10593. * critical conditions
  10594. * @link http://www.php.net/manual/en/network.constants.php
  10595. */
  10596. define ('LOG_CRIT', 2);
  10597. /**
  10598. * error conditions
  10599. * @link http://www.php.net/manual/en/network.constants.php
  10600. */
  10601. define ('LOG_ERR', 3);
  10602. /**
  10603. * warning conditions
  10604. * @link http://www.php.net/manual/en/network.constants.php
  10605. */
  10606. define ('LOG_WARNING', 4);
  10607. /**
  10608. * normal, but significant, condition
  10609. * @link http://www.php.net/manual/en/network.constants.php
  10610. */
  10611. define ('LOG_NOTICE', 5);
  10612. /**
  10613. * informational message
  10614. * @link http://www.php.net/manual/en/network.constants.php
  10615. */
  10616. define ('LOG_INFO', 6);
  10617. /**
  10618. * debug-level message
  10619. * @link http://www.php.net/manual/en/network.constants.php
  10620. */
  10621. define ('LOG_DEBUG', 7);
  10622. /**
  10623. * kernel messages
  10624. * @link http://www.php.net/manual/en/network.constants.php
  10625. */
  10626. define ('LOG_KERN', 0);
  10627. /**
  10628. * generic user-level messages
  10629. * @link http://www.php.net/manual/en/network.constants.php
  10630. */
  10631. define ('LOG_USER', 8);
  10632. /**
  10633. * mail subsystem
  10634. * @link http://www.php.net/manual/en/network.constants.php
  10635. */
  10636. define ('LOG_MAIL', 16);
  10637. /**
  10638. * other system daemons
  10639. * @link http://www.php.net/manual/en/network.constants.php
  10640. */
  10641. define ('LOG_DAEMON', 24);
  10642. /**
  10643. * security/authorization messages (use LOG_AUTHPRIV instead
  10644. * in systems where that constant is defined)
  10645. * @link http://www.php.net/manual/en/network.constants.php
  10646. */
  10647. define ('LOG_AUTH', 32);
  10648. /**
  10649. * messages generated internally by syslogd
  10650. * @link http://www.php.net/manual/en/network.constants.php
  10651. */
  10652. define ('LOG_SYSLOG', 40);
  10653. /**
  10654. * line printer subsystem
  10655. * @link http://www.php.net/manual/en/network.constants.php
  10656. */
  10657. define ('LOG_LPR', 48);
  10658. /**
  10659. * USENET news subsystem
  10660. * @link http://www.php.net/manual/en/network.constants.php
  10661. */
  10662. define ('LOG_NEWS', 56);
  10663. /**
  10664. * UUCP subsystem
  10665. * @link http://www.php.net/manual/en/network.constants.php
  10666. */
  10667. define ('LOG_UUCP', 64);
  10668. /**
  10669. * clock daemon (cron and at)
  10670. * @link http://www.php.net/manual/en/network.constants.php
  10671. */
  10672. define ('LOG_CRON', 72);
  10673. /**
  10674. * security/authorization messages (private)
  10675. * @link http://www.php.net/manual/en/network.constants.php
  10676. */
  10677. define ('LOG_AUTHPRIV', 80);
  10678. define ('LOG_LOCAL0', 128);
  10679. define ('LOG_LOCAL1', 136);
  10680. define ('LOG_LOCAL2', 144);
  10681. define ('LOG_LOCAL3', 152);
  10682. define ('LOG_LOCAL4', 160);
  10683. define ('LOG_LOCAL5', 168);
  10684. define ('LOG_LOCAL6', 176);
  10685. define ('LOG_LOCAL7', 184);
  10686. /**
  10687. * include PID with each message
  10688. * @link http://www.php.net/manual/en/network.constants.php
  10689. */
  10690. define ('LOG_PID', 1);
  10691. /**
  10692. * if there is an error while sending data to the system logger,
  10693. * write directly to the system console
  10694. * @link http://www.php.net/manual/en/network.constants.php
  10695. */
  10696. define ('LOG_CONS', 2);
  10697. /**
  10698. * (default) delay opening the connection until the first
  10699. * message is logged
  10700. * @link http://www.php.net/manual/en/network.constants.php
  10701. */
  10702. define ('LOG_ODELAY', 4);
  10703. /**
  10704. * open the connection to the logger immediately
  10705. * @link http://www.php.net/manual/en/network.constants.php
  10706. */
  10707. define ('LOG_NDELAY', 8);
  10708. define ('LOG_NOWAIT', 16);
  10709. /**
  10710. * print log message also to standard error
  10711. * @link http://www.php.net/manual/en/network.constants.php
  10712. */
  10713. define ('LOG_PERROR', 32);
  10714. define ('EXTR_OVERWRITE', 0);
  10715. define ('EXTR_SKIP', 1);
  10716. define ('EXTR_PREFIX_SAME', 2);
  10717. define ('EXTR_PREFIX_ALL', 3);
  10718. define ('EXTR_PREFIX_INVALID', 4);
  10719. define ('EXTR_PREFIX_IF_EXISTS', 5);
  10720. define ('EXTR_IF_EXISTS', 6);
  10721. define ('EXTR_REFS', 256);
  10722. /**
  10723. * SORT_ASC is used with
  10724. * array_multisort to sort in ascending order.
  10725. * @link http://www.php.net/manual/en/array.constants.php
  10726. */
  10727. define ('SORT_ASC', 4);
  10728. /**
  10729. * SORT_DESC is used with
  10730. * array_multisort to sort in descending order.
  10731. * @link http://www.php.net/manual/en/array.constants.php
  10732. */
  10733. define ('SORT_DESC', 3);
  10734. /**
  10735. * SORT_REGULAR is used to compare items normally.
  10736. * @link http://www.php.net/manual/en/array.constants.php
  10737. */
  10738. define ('SORT_REGULAR', 0);
  10739. /**
  10740. * SORT_NUMERIC is used to compare items numerically.
  10741. * @link http://www.php.net/manual/en/array.constants.php
  10742. */
  10743. define ('SORT_NUMERIC', 1);
  10744. /**
  10745. * SORT_STRING is used to compare items as strings.
  10746. * @link http://www.php.net/manual/en/array.constants.php
  10747. */
  10748. define ('SORT_STRING', 2);
  10749. /**
  10750. * SORT_LOCALE_STRING is used to compare items as
  10751. * strings, based on the current locale. Added in PHP 4.4.0 and 5.0.2.
  10752. * @link http://www.php.net/manual/en/array.constants.php
  10753. */
  10754. define ('SORT_LOCALE_STRING', 5);
  10755. define ('SORT_NATURAL', 6);
  10756. define ('SORT_FLAG_CASE', 8);
  10757. /**
  10758. * CASE_LOWER is used with
  10759. * array_change_key_case and is used to convert array
  10760. * keys to lower case. This is also the default case for
  10761. * array_change_key_case.
  10762. * @link http://www.php.net/manual/en/array.constants.php
  10763. */
  10764. define ('CASE_LOWER', 0);
  10765. /**
  10766. * CASE_UPPER is used with
  10767. * array_change_key_case and is used to convert array
  10768. * keys to upper case.
  10769. * @link http://www.php.net/manual/en/array.constants.php
  10770. */
  10771. define ('CASE_UPPER', 1);
  10772. define ('COUNT_NORMAL', 0);
  10773. define ('COUNT_RECURSIVE', 1);
  10774. define ('ASSERT_ACTIVE', 1);
  10775. define ('ASSERT_CALLBACK', 2);
  10776. define ('ASSERT_BAIL', 3);
  10777. define ('ASSERT_WARNING', 4);
  10778. define ('ASSERT_QUIET_EVAL', 5);
  10779. /**
  10780. * Flag indicating if the stream
  10781. * used the include path.
  10782. * @link http://www.php.net/manual/en/stream.constants.php
  10783. */
  10784. define ('STREAM_USE_PATH', 1);
  10785. define ('STREAM_IGNORE_URL', 2);
  10786. /**
  10787. * Flag indicating if the wrapper
  10788. * is responsible for raising errors using trigger_error
  10789. * during opening of the stream. If this flag is not set, you
  10790. * should not raise any errors.
  10791. * @link http://www.php.net/manual/en/stream.constants.php
  10792. */
  10793. define ('STREAM_REPORT_ERRORS', 8);
  10794. /**
  10795. * This flag is useful when your extension really must be able to randomly
  10796. * seek around in a stream. Some streams may not be seekable in their
  10797. * native form, so this flag asks the streams API to check to see if the
  10798. * stream does support seeking. If it does not, it will copy the stream
  10799. * into temporary storage (which may be a temporary file or a memory
  10800. * stream) which does support seeking.
  10801. * Please note that this flag is not useful when you want to seek the
  10802. * stream and write to it, because the stream you are accessing might
  10803. * not be bound to the actual resource you requested.
  10804. * If the requested resource is network based, this flag will cause the
  10805. * opener to block until the whole contents have been downloaded.
  10806. * @link http://www.php.net/manual/en/internals2.ze1.streams.constants.php
  10807. */
  10808. define ('STREAM_MUST_SEEK', 16);
  10809. define ('STREAM_URL_STAT_LINK', 1);
  10810. define ('STREAM_URL_STAT_QUIET', 2);
  10811. define ('STREAM_MKDIR_RECURSIVE', 1);
  10812. define ('STREAM_IS_URL', 1);
  10813. define ('STREAM_OPTION_BLOCKING', 1);
  10814. define ('STREAM_OPTION_READ_TIMEOUT', 4);
  10815. define ('STREAM_OPTION_READ_BUFFER', 2);
  10816. define ('STREAM_OPTION_WRITE_BUFFER', 3);
  10817. define ('STREAM_BUFFER_NONE', 0);
  10818. define ('STREAM_BUFFER_LINE', 1);
  10819. define ('STREAM_BUFFER_FULL', 2);
  10820. /**
  10821. * Stream casting, when stream_cast is called
  10822. * otherwise (see above).
  10823. * @link http://www.php.net/manual/en/stream.constants.php
  10824. */
  10825. define ('STREAM_CAST_AS_STREAM', 0);
  10826. /**
  10827. * Stream casting, for when stream_select is
  10828. * calling stream_cast.
  10829. * @link http://www.php.net/manual/en/stream.constants.php
  10830. */
  10831. define ('STREAM_CAST_FOR_SELECT', 3);
  10832. /**
  10833. * Used with stream_metadata, to specify touch call.
  10834. * @link http://www.php.net/manual/en/stream.constants.php
  10835. */
  10836. define ('STREAM_META_TOUCH', 1);
  10837. /**
  10838. * Used with stream_metadata, to specify chown call.
  10839. * @link http://www.php.net/manual/en/stream.constants.php
  10840. */
  10841. define ('STREAM_META_OWNER', 3);
  10842. /**
  10843. * Used with stream_metadata, to specify chown call.
  10844. * @link http://www.php.net/manual/en/stream.constants.php
  10845. */
  10846. define ('STREAM_META_OWNER_NAME', 2);
  10847. /**
  10848. * Used with stream_metadata, to specify chgrp call.
  10849. * @link http://www.php.net/manual/en/stream.constants.php
  10850. */
  10851. define ('STREAM_META_GROUP', 5);
  10852. /**
  10853. * Used with stream_metadata, to specify chgrp call.
  10854. * @link http://www.php.net/manual/en/stream.constants.php
  10855. */
  10856. define ('STREAM_META_GROUP_NAME', 4);
  10857. /**
  10858. * Used with stream_metadata, to specify chmod call.
  10859. * @link http://www.php.net/manual/en/stream.constants.php
  10860. */
  10861. define ('STREAM_META_ACCESS', 6);
  10862. /**
  10863. * Image type constant used by the
  10864. * image_type_to_mime_type and
  10865. * image_type_to_extension functions.
  10866. * @link http://www.php.net/manual/en/image.constants.php
  10867. */
  10868. define ('IMAGETYPE_GIF', 1);
  10869. /**
  10870. * Image type constant used by the
  10871. * image_type_to_mime_type and
  10872. * image_type_to_extension functions.
  10873. * @link http://www.php.net/manual/en/image.constants.php
  10874. */
  10875. define ('IMAGETYPE_JPEG', 2);
  10876. /**
  10877. * Image type constant used by the
  10878. * image_type_to_mime_type and
  10879. * image_type_to_extension functions.
  10880. * @link http://www.php.net/manual/en/image.constants.php
  10881. */
  10882. define ('IMAGETYPE_PNG', 3);
  10883. /**
  10884. * Image type constant used by the
  10885. * image_type_to_mime_type and
  10886. * image_type_to_extension functions.
  10887. * @link http://www.php.net/manual/en/image.constants.php
  10888. */
  10889. define ('IMAGETYPE_SWF', 4);
  10890. /**
  10891. * Image type constant used by the
  10892. * image_type_to_mime_type and
  10893. * image_type_to_extension functions.
  10894. * @link http://www.php.net/manual/en/image.constants.php
  10895. */
  10896. define ('IMAGETYPE_PSD', 5);
  10897. /**
  10898. * Image type constant used by the
  10899. * image_type_to_mime_type and
  10900. * image_type_to_extension functions.
  10901. * @link http://www.php.net/manual/en/image.constants.php
  10902. */
  10903. define ('IMAGETYPE_BMP', 6);
  10904. /**
  10905. * Image type constant used by the
  10906. * image_type_to_mime_type and
  10907. * image_type_to_extension functions.
  10908. * @link http://www.php.net/manual/en/image.constants.php
  10909. */
  10910. define ('IMAGETYPE_TIFF_II', 7);
  10911. /**
  10912. * Image type constant used by the
  10913. * image_type_to_mime_type and
  10914. * image_type_to_extension functions.
  10915. * @link http://www.php.net/manual/en/image.constants.php
  10916. */
  10917. define ('IMAGETYPE_TIFF_MM', 8);
  10918. /**
  10919. * Image type constant used by the
  10920. * image_type_to_mime_type and
  10921. * image_type_to_extension functions.
  10922. * @link http://www.php.net/manual/en/image.constants.php
  10923. */
  10924. define ('IMAGETYPE_JPC', 9);
  10925. /**
  10926. * Image type constant used by the
  10927. * image_type_to_mime_type and
  10928. * image_type_to_extension functions.
  10929. * @link http://www.php.net/manual/en/image.constants.php
  10930. */
  10931. define ('IMAGETYPE_JP2', 10);
  10932. /**
  10933. * Image type constant used by the
  10934. * image_type_to_mime_type and
  10935. * image_type_to_extension functions.
  10936. * @link http://www.php.net/manual/en/image.constants.php
  10937. */
  10938. define ('IMAGETYPE_JPX', 11);
  10939. /**
  10940. * Image type constant used by the
  10941. * image_type_to_mime_type and
  10942. * image_type_to_extension functions.
  10943. * @link http://www.php.net/manual/en/image.constants.php
  10944. */
  10945. define ('IMAGETYPE_JB2', 12);
  10946. /**
  10947. * Image type constant used by the
  10948. * image_type_to_mime_type and
  10949. * image_type_to_extension functions.
  10950. * @link http://www.php.net/manual/en/image.constants.php
  10951. */
  10952. define ('IMAGETYPE_SWC', 13);
  10953. /**
  10954. * Image type constant used by the
  10955. * image_type_to_mime_type and
  10956. * image_type_to_extension functions.
  10957. * @link http://www.php.net/manual/en/image.constants.php
  10958. */
  10959. define ('IMAGETYPE_IFF', 14);
  10960. /**
  10961. * Image type constant used by the
  10962. * image_type_to_mime_type and
  10963. * image_type_to_extension functions.
  10964. * @link http://www.php.net/manual/en/image.constants.php
  10965. */
  10966. define ('IMAGETYPE_WBMP', 15);
  10967. /**
  10968. * Image type constant used by the
  10969. * image_type_to_mime_type and
  10970. * image_type_to_extension functions.
  10971. * @link http://www.php.net/manual/en/image.constants.php
  10972. */
  10973. define ('IMAGETYPE_JPEG2000', 9);
  10974. /**
  10975. * Image type constant used by the
  10976. * image_type_to_mime_type and
  10977. * image_type_to_extension functions.
  10978. * @link http://www.php.net/manual/en/image.constants.php
  10979. */
  10980. define ('IMAGETYPE_XBM', 16);
  10981. /**
  10982. * Image type constant used by the
  10983. * image_type_to_mime_type and
  10984. * image_type_to_extension functions.
  10985. * (Available as of PHP 5.3.0)
  10986. * @link http://www.php.net/manual/en/image.constants.php
  10987. */
  10988. define ('IMAGETYPE_ICO', 17);
  10989. define ('IMAGETYPE_UNKNOWN', 0);
  10990. define ('IMAGETYPE_COUNT', 18);
  10991. /**
  10992. * IPv4 Address Resource
  10993. * @link http://www.php.net/manual/en/network.constants.php
  10994. */
  10995. define ('DNS_A', 1);
  10996. /**
  10997. * Authoritative Name Server Resource
  10998. * @link http://www.php.net/manual/en/network.constants.php
  10999. */
  11000. define ('DNS_NS', 2);
  11001. /**
  11002. * Alias (Canonical Name) Resource
  11003. * @link http://www.php.net/manual/en/network.constants.php
  11004. */
  11005. define ('DNS_CNAME', 16);
  11006. /**
  11007. * Start of Authority Resource
  11008. * @link http://www.php.net/manual/en/network.constants.php
  11009. */
  11010. define ('DNS_SOA', 32);
  11011. /**
  11012. * Pointer Resource
  11013. * @link http://www.php.net/manual/en/network.constants.php
  11014. */
  11015. define ('DNS_PTR', 2048);
  11016. /**
  11017. * Host Info Resource (See IANA's
  11018. * Operating System Names
  11019. * for the meaning of these values)
  11020. * @link http://www.php.net/manual/en/network.constants.php
  11021. */
  11022. define ('DNS_HINFO', 4096);
  11023. /**
  11024. * Mail Exchanger Resource
  11025. * @link http://www.php.net/manual/en/network.constants.php
  11026. */
  11027. define ('DNS_MX', 16384);
  11028. /**
  11029. * Text Resource
  11030. * @link http://www.php.net/manual/en/network.constants.php
  11031. */
  11032. define ('DNS_TXT', 32768);
  11033. define ('DNS_SRV', 33554432);
  11034. define ('DNS_NAPTR', 67108864);
  11035. /**
  11036. * IPv6 Address Resource
  11037. * @link http://www.php.net/manual/en/network.constants.php
  11038. */
  11039. define ('DNS_AAAA', 134217728);
  11040. define ('DNS_A6', 16777216);
  11041. /**
  11042. * Any Resource Record. On most systems
  11043. * this returns all resource records, however
  11044. * it should not be counted upon for critical
  11045. * uses. Try DNS_ALL instead.
  11046. * @link http://www.php.net/manual/en/network.constants.php
  11047. */
  11048. define ('DNS_ANY', 268435456);
  11049. /**
  11050. * Iteratively query the name server for
  11051. * each available record type.
  11052. * @link http://www.php.net/manual/en/network.constants.php
  11053. */
  11054. define ('DNS_ALL', 251713587);
  11055. // End of standard v.5.4.0RC6
  11056. ?>