PageRenderTime 86ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 1ms

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

https://gitlab.com/N3X15/studio3-php
PHP | 11723 lines | 887 code | 693 blank | 10143 comment | 0 complexity | 612bc99c2af4b523fe3d23ebe59c79c9 MD5 | raw file
  1. <?php
  2. // Start of standard v.5.4.4-2
  3. class __PHP_Incomplete_Class {
  4. }
  5. class php_user_filter {
  6. public $filtername;
  7. public $params;
  8. /**
  9. * Called when applying the filter
  10. * @link http://www.php.net/manual/en/php-user-filter.filter.php
  11. * @param in resource <p>
  12. * in is a resource pointing to a bucket brigade
  13. * which contains one or more bucket objects containing data to be filtered.
  14. * </p>
  15. * @param out resource <p>
  16. * out is a resource pointing to a second bucket brigade
  17. * into which your modified buckets should be placed.
  18. * </p>
  19. * @param consumed int <p>
  20. * consumed, which must always
  21. * be declared by reference, should be incremented by the length of the data
  22. * which your filter reads in and alters. In most cases this means you will
  23. * increment consumed by $bucket->datalen
  24. * for each $bucket.
  25. * </p>
  26. * @param closing bool <p>
  27. * If the stream is in the process of closing
  28. * (and therefore this is the last pass through the filterchain),
  29. * the closing parameter will be set to true.
  30. * </p>
  31. * @return int The filter method must return one of
  32. * three values upon completion.
  33. * <tr valign="top">
  34. * <td>Return Value</td>
  35. * <td>Meaning</td>
  36. * </tr>
  37. * <tr valign="top">
  38. * <td>PSFS_PASS_ON</td>
  39. * <td>
  40. * Filter processed successfully with data available in the
  41. * out bucket brigade.
  42. * </td>
  43. * </tr>
  44. * <tr valign="top">
  45. * <td>PSFS_FEED_ME</td>
  46. * <td>
  47. * Filter processed successfully, however no data was available to
  48. * return. More data is required from the stream or prior filter.
  49. * </td>
  50. * </tr>
  51. * <tr valign="top">
  52. * <td>PSFS_ERR_FATAL (default)</td>
  53. * <td>
  54. * The filter experienced an unrecoverable error and cannot continue.
  55. * </td>
  56. * </tr>
  57. */
  58. public function filter ($in, $out, &$consumed, $closing) {}
  59. /**
  60. * Called when creating the filter
  61. * @link http://www.php.net/manual/en/php-user-filter.oncreate.php
  62. * @return bool Your implementation of
  63. * this method should return false on failure, or true on success.
  64. */
  65. public function onCreate () {}
  66. /**
  67. * Called when closing the filter
  68. * @link http://www.php.net/manual/en/php-user-filter.onclose.php
  69. * @return void Return value is ignored.
  70. */
  71. public function onClose () {}
  72. }
  73. class Directory {
  74. /**
  75. * Close directory handle
  76. * @link http://www.php.net/manual/en/directory.close.php
  77. * @param dir_handle resource[optional]
  78. * @return void
  79. */
  80. public function close ($dir_handle = null) {}
  81. /**
  82. * Rewind directory handle
  83. * @link http://www.php.net/manual/en/directory.rewind.php
  84. * @param dir_handle resource[optional]
  85. * @return void
  86. */
  87. public function rewind ($dir_handle = null) {}
  88. /**
  89. * Read entry from directory handle
  90. * @link http://www.php.net/manual/en/directory.read.php
  91. * @param dir_handle resource[optional]
  92. * @return string
  93. */
  94. public function read ($dir_handle = null) {}
  95. }
  96. /**
  97. * Returns the value of a constant
  98. * @link http://www.php.net/manual/en/function.constant.php
  99. * @param name string <p>
  100. * The constant name.
  101. * </p>
  102. * @return mixed the value of the constant, or &null; if the constant is not
  103. * defined.
  104. */
  105. function constant ($name) {}
  106. /**
  107. * Convert binary data into hexadecimal representation
  108. * @link http://www.php.net/manual/en/function.bin2hex.php
  109. * @param str string <p>
  110. * A string.
  111. * </p>
  112. * @return string the hexadecimal representation of the given string.
  113. */
  114. function bin2hex ($str) {}
  115. /**
  116. * Decodes a hexadecimally encoded binary string
  117. * @link http://www.php.net/manual/en/function.hex2bin.php
  118. * @param data string <p>
  119. * Hexadecimal representation of data.
  120. * </p>
  121. * @return string the binary representation of the given data &return.falseforfailure;.
  122. */
  123. function hex2bin ($data) {}
  124. /**
  125. * Delay execution
  126. * @link http://www.php.net/manual/en/function.sleep.php
  127. * @param seconds int <p>
  128. * Halt time in seconds.
  129. * </p>
  130. * @return int zero on success, or false on error.
  131. * </p>
  132. * <p>
  133. * If the call was interrupted by a signal, sleep returns
  134. * a non-zero value. On Windows, this value will always be
  135. * 192 (the value of the
  136. * WAIT_IO_COMPLETION constant within the Windows API).
  137. * On other platforms, the return value will be the number of seconds left to
  138. * sleep.
  139. */
  140. function sleep ($seconds) {}
  141. /**
  142. * Delay execution in microseconds
  143. * @link http://www.php.net/manual/en/function.usleep.php
  144. * @param micro_seconds int <p>
  145. * Halt time in micro seconds. A micro second is one millionth of a
  146. * second.
  147. * </p>
  148. * @return void
  149. */
  150. function usleep ($micro_seconds) {}
  151. /**
  152. * Delay for a number of seconds and nanoseconds
  153. * @link http://www.php.net/manual/en/function.time-nanosleep.php
  154. * @param seconds int <p>
  155. * Must be a non-negative integer.
  156. * </p>
  157. * @param nanoseconds int <p>
  158. * Must be a non-negative integer less than 1 billion.
  159. * </p>
  160. * @return mixed Returns true on success or false on failure.
  161. * </p>
  162. * <p>
  163. * If the delay was interrupted by a signal, an associative array will be
  164. * returned with the components:
  165. * seconds - number of seconds remaining in
  166. * the delay
  167. * nanoseconds - number of nanoseconds
  168. * remaining in the delay
  169. */
  170. function time_nanosleep ($seconds, $nanoseconds) {}
  171. /**
  172. * Make the script sleep until the specified time
  173. * @link http://www.php.net/manual/en/function.time-sleep-until.php
  174. * @param timestamp float <p>
  175. * The timestamp when the script should wake.
  176. * </p>
  177. * @return bool Returns true on success or false on failure.
  178. */
  179. function time_sleep_until ($timestamp) {}
  180. /**
  181. * Parse a time/date generated with <function>strftime</function>
  182. * @link http://www.php.net/manual/en/function.strptime.php
  183. * @param date string <p>
  184. * The string to parse (e.g. returned from strftime).
  185. * </p>
  186. * @param format string <p>
  187. * The format used in date (e.g. the same as
  188. * used in strftime). Note that some of the format
  189. * options available to strftime may not have any
  190. * effect within strptime; the exact subset that are
  191. * supported will vary based on the operating system and C library in
  192. * use.
  193. * </p>
  194. * <p>
  195. * For more information about the format options, read the
  196. * strftime page.
  197. * </p>
  198. * @return array an array&return.falseforfailure;.
  199. * </p>
  200. * <p>
  201. * <table>
  202. * The following parameters are returned in the array
  203. * <tr valign="top">
  204. * <td>parameters</td>
  205. * <td>Description</td>
  206. * </tr>
  207. * <tr valign="top">
  208. * <td>"tm_sec"</td>
  209. * <td>Seconds after the minute (0-61)</td>
  210. * </tr>
  211. * <tr valign="top">
  212. * <td>"tm_min"</td>
  213. * <td>Minutes after the hour (0-59)</td>
  214. * </tr>
  215. * <tr valign="top">
  216. * <td>"tm_hour"</td>
  217. * <td>Hour since midnight (0-23)</td>
  218. * </tr>
  219. * <tr valign="top">
  220. * <td>"tm_mday"</td>
  221. * <td>Day of the month (1-31)</td>
  222. * </tr>
  223. * <tr valign="top">
  224. * <td>"tm_mon"</td>
  225. * <td>Months since January (0-11)</td>
  226. * </tr>
  227. * <tr valign="top">
  228. * <td>"tm_year"</td>
  229. * <td>Years since 1900</td>
  230. * </tr>
  231. * <tr valign="top">
  232. * <td>"tm_wday"</td>
  233. * <td>Days since Sunday (0-6)</td>
  234. * </tr>
  235. * <tr valign="top">
  236. * <td>"tm_yday"</td>
  237. * <td>Days since January 1 (0-365)</td>
  238. * </tr>
  239. * <tr valign="top">
  240. * <td>"unparsed"</td>
  241. * <td>the date part which was not
  242. * recognized using the specified format</td>
  243. * </tr>
  244. * </table>
  245. */
  246. function strptime ($date, $format) {}
  247. /**
  248. * Flush the output buffer
  249. * @link http://www.php.net/manual/en/function.flush.php
  250. * @return void
  251. */
  252. function flush () {}
  253. /**
  254. * Wraps a string to a given number of characters
  255. * @link http://www.php.net/manual/en/function.wordwrap.php
  256. * @param str string <p>
  257. * The input string.
  258. * </p>
  259. * @param width int[optional] <p>
  260. * The number of characters at which the string will be wrapped.
  261. * </p>
  262. * @param break string[optional] <p>
  263. * The line is broken using the optional
  264. * break parameter.
  265. * </p>
  266. * @param cut bool[optional] <p>
  267. * If the cut is set to true, the string is
  268. * always wrapped at or before the specified width. So if you have
  269. * a word that is larger than the given width, it is broken apart.
  270. * (See second example).
  271. * </p>
  272. * @return string the given string wrapped at the specified length.
  273. */
  274. function wordwrap ($str, $width = null, $break = null, $cut = null) {}
  275. /**
  276. * Convert special characters to HTML entities
  277. * @link http://www.php.net/manual/en/function.htmlspecialchars.php
  278. * @param string string <p>
  279. * The string being converted.
  280. * </p>
  281. * @param flags int[optional] <p>
  282. * A bitmask of one or more of the following flags, which specify how to handle quotes,
  283. * invalid code unit sequences and the used document type. The default is
  284. * ENT_COMPAT | ENT_HTML401.
  285. * <table>
  286. * Available flags constants
  287. * <tr valign="top">
  288. * <td>Constant Name</td>
  289. * <td>Description</td>
  290. * </tr>
  291. * <tr valign="top">
  292. * <td>ENT_COMPAT</td>
  293. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  294. * </tr>
  295. * <tr valign="top">
  296. * <td>ENT_QUOTES</td>
  297. * <td>Will convert both double and single quotes.</td>
  298. * </tr>
  299. * <tr valign="top">
  300. * <td>ENT_NOQUOTES</td>
  301. * <td>Will leave both double and single quotes unconverted.</td>
  302. * </tr>
  303. * <tr valign="top">
  304. * <td>ENT_IGNORE</td>
  305. * <td>
  306. * Silently discard invalid code unit sequences instead of returning
  307. * an empty string. Using this flag is discouraged as it
  308. * may have security implications.
  309. * </td>
  310. * </tr>
  311. * <tr valign="top">
  312. * <td>ENT_SUBSTITUTE</td>
  313. * <td>
  314. * Replace invalid code unit sequences with a Unicode Replacement Character
  315. * U+FFFD (UTF-8) or &amp;#FFFD; (otherwise) instead of returning an empty string.
  316. * </td>
  317. * </tr>
  318. * <tr valign="top">
  319. * <td>ENT_DISALLOWED</td>
  320. * <td>
  321. * Replace invalid code points for the given document type with a
  322. * Unicode Replacement Character U+FFFD (UTF-8) or &amp;#FFFD;
  323. * (otherwise) instead of leaving them as is. This may be useful, for
  324. * instance, to ensure the well-formedness of XML documents with
  325. * embedded external content.
  326. * </td>
  327. * </tr>
  328. * <tr valign="top">
  329. * <td>ENT_HTML401</td>
  330. * <td>
  331. * Handle code as HTML 4.01.
  332. * </td>
  333. * </tr>
  334. * <tr valign="top">
  335. * <td>ENT_XML1</td>
  336. * <td>
  337. * Handle code as XML 1.
  338. * </td>
  339. * </tr>
  340. * <tr valign="top">
  341. * <td>ENT_XHTML</td>
  342. * <td>
  343. * Handle code as XHTML.
  344. * </td>
  345. * </tr>
  346. * <tr valign="top">
  347. * <td>ENT_HTML5</td>
  348. * <td>
  349. * Handle code as HTML 5.
  350. * </td>
  351. * </tr>
  352. * </table>
  353. * </p>
  354. * @param encoding string[optional] <p>
  355. * Defines encoding used in conversion.
  356. * If omitted, the default value for this argument is ISO-8859-1 in
  357. * versions of PHP prior to 5.4.0, and UTF-8 from PHP 5.4.0 onwards.
  358. * </p>
  359. * <p>
  360. * For the purposes of this function, the encodings
  361. * ISO-8859-1, ISO-8859-15,
  362. * UTF-8, cp866,
  363. * cp1251, cp1252, and
  364. * KOI8-R are effectively equivalent, provided the
  365. * string itself is valid for the encoding, as
  366. * the characters affected by htmlspecialchars occupy
  367. * the same positions in all of these encodings.
  368. * </p>
  369. * &reference.strings.charsets;
  370. * @param double_encode bool[optional] <p>
  371. * When double_encode is turned off PHP will not
  372. * encode existing html entities, the default is to convert everything.
  373. * </p>
  374. * @return string The converted string.
  375. * </p>
  376. * <p>
  377. * If the input string contains an invalid code unit
  378. * sequence within the given encoding an empty string
  379. * will be returned, unless either the ENT_IGNORE or
  380. * ENT_SUBSTITUTE flags are set.
  381. */
  382. function htmlspecialchars ($string, $flags = null, $encoding = null, $double_encode = null) {}
  383. /**
  384. * Convert all applicable characters to HTML entities
  385. * @link http://www.php.net/manual/en/function.htmlentities.php
  386. * @param string string <p>
  387. * The input string.
  388. * </p>
  389. * @param flags int[optional] <p>
  390. * A bitmask of one or more of the following flags, which specify how to handle quotes,
  391. * invalid code unit sequences and the used document type. The default is
  392. * ENT_COMPAT | ENT_HTML401.
  393. * <table>
  394. * Available flags constants
  395. * <tr valign="top">
  396. * <td>Constant Name</td>
  397. * <td>Description</td>
  398. * </tr>
  399. * <tr valign="top">
  400. * <td>ENT_COMPAT</td>
  401. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  402. * </tr>
  403. * <tr valign="top">
  404. * <td>ENT_QUOTES</td>
  405. * <td>Will convert both double and single quotes.</td>
  406. * </tr>
  407. * <tr valign="top">
  408. * <td>ENT_NOQUOTES</td>
  409. * <td>Will leave both double and single quotes unconverted.</td>
  410. * </tr>
  411. * <tr valign="top">
  412. * <td>ENT_IGNORE</td>
  413. * <td>
  414. * Silently discard invalid code unit sequences instead of returning
  415. * an empty string. Using this flag is discouraged as it
  416. * may have security implications.
  417. * </td>
  418. * </tr>
  419. * <tr valign="top">
  420. * <td>ENT_SUBSTITUTE</td>
  421. * <td>
  422. * Replace invalid code unit sequences with a Unicode Replacement Character
  423. * U+FFFD (UTF-8) or &amp;#FFFD; (otherwise) instead of returning an empty string.
  424. * </td>
  425. * </tr>
  426. * <tr valign="top">
  427. * <td>ENT_DISALLOWED</td>
  428. * <td>
  429. * Replace invalid code points for the given document type with a
  430. * Unicode Replacement Character U+FFFD (UTF-8) or &amp;#FFFD;
  431. * (otherwise) instead of leaving them as is. This may be useful, for
  432. * instance, to ensure the well-formedness of XML documents with
  433. * embedded external content.
  434. * </td>
  435. * </tr>
  436. * <tr valign="top">
  437. * <td>ENT_HTML401</td>
  438. * <td>
  439. * Handle code as HTML 4.01.
  440. * </td>
  441. * </tr>
  442. * <tr valign="top">
  443. * <td>ENT_XML1</td>
  444. * <td>
  445. * Handle code as XML 1.
  446. * </td>
  447. * </tr>
  448. * <tr valign="top">
  449. * <td>ENT_XHTML</td>
  450. * <td>
  451. * Handle code as XHTML.
  452. * </td>
  453. * </tr>
  454. * <tr valign="top">
  455. * <td>ENT_HTML5</td>
  456. * <td>
  457. * Handle code as HTML 5.
  458. * </td>
  459. * </tr>
  460. * </table>
  461. * </p>
  462. * @param encoding string[optional] <p>
  463. * Like htmlspecialchars,
  464. * htmlentities takes an optional third argument
  465. * encoding which defines encoding used in
  466. * conversion.
  467. * If omitted, the default value for this argument is ISO-8859-1 in
  468. * versions of PHP prior to 5.4.0, and UTF-8 from PHP 5.4.0 onwards.
  469. * Although this argument is technically optional, you are highly
  470. * encouraged to specify the correct value for your code.
  471. * </p>
  472. * &reference.strings.charsets;
  473. * @param double_encode bool[optional] <p>
  474. * When double_encode is turned off PHP will not
  475. * encode existing html entities. The default is to convert everything.
  476. * </p>
  477. * @return string the encoded string.
  478. * </p>
  479. * <p>
  480. * If the input string contains an invalid code unit
  481. * sequence within the given encoding an empty string
  482. * will be returned, unless either the ENT_IGNORE or
  483. * ENT_SUBSTITUTE flags are set.
  484. */
  485. function htmlentities ($string, $flags = null, $encoding = null, $double_encode = null) {}
  486. /**
  487. * Convert all HTML entities to their applicable characters
  488. * @link http://www.php.net/manual/en/function.html-entity-decode.php
  489. * @param string string <p>
  490. * The input string.
  491. * </p>
  492. * @param flags int[optional] <p>
  493. * A bitmask of one or more of the following flags, which specify how to handle quotes and
  494. * which document type to use. The default is ENT_COMPAT | ENT_HTML401.
  495. * <table>
  496. * Available flags constants
  497. * <tr valign="top">
  498. * <td>Constant Name</td>
  499. * <td>Description</td>
  500. * </tr>
  501. * <tr valign="top">
  502. * <td>ENT_COMPAT</td>
  503. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  504. * </tr>
  505. * <tr valign="top">
  506. * <td>ENT_QUOTES</td>
  507. * <td>Will convert both double and single quotes.</td>
  508. * </tr>
  509. * <tr valign="top">
  510. * <td>ENT_NOQUOTES</td>
  511. * <td>Will leave both double and single quotes unconverted.</td>
  512. * </tr>
  513. * <tr valign="top">
  514. * <td>ENT_HTML401</td>
  515. * <td>
  516. * Handle code as HTML 4.01.
  517. * </td>
  518. * </tr>
  519. * <tr valign="top">
  520. * <td>ENT_XML1</td>
  521. * <td>
  522. * Handle code as XML 1.
  523. * </td>
  524. * </tr>
  525. * <tr valign="top">
  526. * <td>ENT_XHTML</td>
  527. * <td>
  528. * Handle code as XHTML.
  529. * </td>
  530. * </tr>
  531. * <tr valign="top">
  532. * <td>ENT_HTML5</td>
  533. * <td>
  534. * Handle code as HTML 5.
  535. * </td>
  536. * </tr>
  537. * </table>
  538. * </p>
  539. * @param encoding string[optional] <p>
  540. * Encoding to use.
  541. * If omitted, the default value for this argument is ISO-8859-1 in
  542. * versions of PHP prior to 5.4.0, and UTF-8 from PHP 5.4.0 onwards.
  543. * </p>
  544. * &reference.strings.charsets;
  545. * @return string the decoded string.
  546. */
  547. function html_entity_decode ($string, $flags = null, $encoding = null) {}
  548. /**
  549. * Convert special HTML entities back to characters
  550. * @link http://www.php.net/manual/en/function.htmlspecialchars-decode.php
  551. * @param string string <p>
  552. * The string to decode.
  553. * </p>
  554. * @param flags int[optional] <p>
  555. * A bitmask of one or more of the following flags, which specify how to handle quotes and
  556. * which document type to use. The default is ENT_COMPAT | ENT_HTML401.
  557. * <table>
  558. * Available flags constants
  559. * <tr valign="top">
  560. * <td>Constant Name</td>
  561. * <td>Description</td>
  562. * </tr>
  563. * <tr valign="top">
  564. * <td>ENT_COMPAT</td>
  565. * <td>Will convert double-quotes and leave single-quotes alone.</td>
  566. * </tr>
  567. * <tr valign="top">
  568. * <td>ENT_QUOTES</td>
  569. * <td>Will convert both double and single quotes.</td>
  570. * </tr>
  571. * <tr valign="top">
  572. * <td>ENT_NOQUOTES</td>
  573. * <td>Will leave both double and single quotes unconverted.</td>
  574. * </tr>
  575. * <tr valign="top">
  576. * <td>ENT_HTML401</td>
  577. * <td>
  578. * Handle code as HTML 4.01.
  579. * </td>
  580. * </tr>
  581. * <tr valign="top">
  582. * <td>ENT_XML1</td>
  583. * <td>
  584. * Handle code as XML 1.
  585. * </td>
  586. * </tr>
  587. * <tr valign="top">
  588. * <td>ENT_XHTML</td>
  589. * <td>
  590. * Handle code as XHTML.
  591. * </td>
  592. * </tr>
  593. * <tr valign="top">
  594. * <td>ENT_HTML5</td>
  595. * <td>
  596. * Handle code as HTML 5.
  597. * </td>
  598. * </tr>
  599. * </table>
  600. * </p>
  601. * @return string the decoded string.
  602. */
  603. function htmlspecialchars_decode ($string, $flags = null) {}
  604. /**
  605. * Returns the translation table used by <function>htmlspecialchars</function> and <function>htmlentities</function>
  606. * @link http://www.php.net/manual/en/function.get-html-translation-table.php
  607. * @param table int[optional] <p>
  608. * Which table to return. Either HTML_ENTITIES or
  609. * HTML_SPECIALCHARS.
  610. * </p>
  611. * @param flags int[optional] <p>
  612. * A bitmask of one or more of the following flags, which specify which quotes the
  613. * table will contain as well as which document type the table is for. The default is
  614. * ENT_COMPAT | ENT_HTML401.
  615. * <table>
  616. * Available flags constants
  617. * <tr valign="top">
  618. * <td>Constant Name</td>
  619. * <td>Description</td>
  620. * </tr>
  621. * <tr valign="top">
  622. * <td>ENT_COMPAT</td>
  623. * <td>Table will contain entities for double-quotes, but not for single-quotes.</td>
  624. * </tr>
  625. * <tr valign="top">
  626. * <td>ENT_QUOTES</td>
  627. * <td>Table will contain entities for both double and single quotes.</td>
  628. * </tr>
  629. * <tr valign="top">
  630. * <td>ENT_NOQUOTES</td>
  631. * <td>Table will neither contain entities for single quotes nor for double quotes.</td>
  632. * </tr>
  633. * <tr valign="top">
  634. * <td>ENT_HTML401</td>
  635. * <td>Table for HTML 4.01.</td>
  636. * </tr>
  637. * <tr valign="top">
  638. * <td>ENT_XML1</td>
  639. * <td>Table for XML 1.</td>
  640. * </tr>
  641. * <tr valign="top">
  642. * <td>ENT_XHTML</td>
  643. * <td>Table for XHTML.</td>
  644. * </tr>
  645. * <tr valign="top">
  646. * <td>ENT_HTML5</td>
  647. * <td>Table for HTML 5.</td>
  648. * </tr>
  649. * </table>
  650. * </p>
  651. * @param encoding string[optional] <p>
  652. * Encoding to use.
  653. * If omitted, the default value for this argument is ISO-8859-1 in
  654. * versions of PHP prior to 5.4.0, and UTF-8 from PHP 5.4.0 onwards.
  655. * </p>
  656. * &reference.strings.charsets;
  657. * @return array the translation table as an array, with the original characters
  658. * as keys and entities as values.
  659. */
  660. function get_html_translation_table ($table = null, $flags = null, $encoding = null) {}
  661. /**
  662. * Calculate the sha1 hash of a string
  663. * @link http://www.php.net/manual/en/function.sha1.php
  664. * @param str string <p>
  665. * The input string.
  666. * </p>
  667. * @param raw_output bool[optional] <p>
  668. * If the optional raw_output is set to true,
  669. * then the sha1 digest is instead returned in raw binary format with a
  670. * length of 20, otherwise the returned value is a 40-character
  671. * hexadecimal number.
  672. * </p>
  673. * @return string the sha1 hash as a string.
  674. */
  675. function sha1 ($str, $raw_output = null) {}
  676. /**
  677. * Calculate the sha1 hash of a file
  678. * @link http://www.php.net/manual/en/function.sha1-file.php
  679. * @param filename string <p>
  680. * The filename of the file to hash.
  681. * </p>
  682. * @param raw_output bool[optional] <p>
  683. * When true, returns the digest in raw binary format with a length of
  684. * 20.
  685. * </p>
  686. * @return string a string on success, false otherwise.
  687. */
  688. function sha1_file ($filename, $raw_output = null) {}
  689. /**
  690. * Calculate the md5 hash of a string
  691. * @link http://www.php.net/manual/en/function.md5.php
  692. * @param str string <p>
  693. * The string.
  694. * </p>
  695. * @param raw_output bool[optional] <p>
  696. * If the optional raw_output is set to true,
  697. * then the md5 digest is instead returned in raw binary format with a
  698. * length of 16.
  699. * </p>
  700. * @return string the hash as a 32-character hexadecimal number.
  701. */
  702. function md5 ($str, $raw_output = null) {}
  703. /**
  704. * Calculates the md5 hash of a given file
  705. * @link http://www.php.net/manual/en/function.md5-file.php
  706. * @param filename string <p>
  707. * The filename
  708. * </p>
  709. * @param raw_output bool[optional] <p>
  710. * When true, returns the digest in raw binary format with a length of
  711. * 16.
  712. * </p>
  713. * @return string a string on success, false otherwise.
  714. */
  715. function md5_file ($filename, $raw_output = null) {}
  716. /**
  717. * Calculates the crc32 polynomial of a string
  718. * @link http://www.php.net/manual/en/function.crc32.php
  719. * @param str string <p>
  720. * The data.
  721. * </p>
  722. * @return int the crc32 checksum of str as an integer.
  723. */
  724. function crc32 ($str) {}
  725. /**
  726. * Parse a binary IPTC block into single tags.
  727. * @link http://www.php.net/manual/en/function.iptcparse.php
  728. * @param iptcblock string <p>
  729. * A binary IPTC block.
  730. * </p>
  731. * @return array an array using the tagmarker as an index and the value as the
  732. * value. It returns false on error or if no IPTC data was found.
  733. */
  734. function iptcparse ($iptcblock) {}
  735. /**
  736. * Embeds binary IPTC data into a JPEG image
  737. * @link http://www.php.net/manual/en/function.iptcembed.php
  738. * @param iptcdata string <p>
  739. * The data to be written.
  740. * </p>
  741. * @param jpeg_file_name string <p>
  742. * Path to the JPEG image.
  743. * </p>
  744. * @param spool int[optional] <p>
  745. * Spool flag. If the spool flag is over 2 then the JPEG will be
  746. * returned as a string.
  747. * </p>
  748. * @return mixed If success and spool flag is lower than 2 then the JPEG will not be
  749. * returned as a string, false on errors.
  750. */
  751. function iptcembed ($iptcdata, $jpeg_file_name, $spool = null) {}
  752. /**
  753. * Get the size of an image
  754. * @link http://www.php.net/manual/en/function.getimagesize.php
  755. * @param filename string <p>
  756. * This parameter specifies the file you wish to retrieve information
  757. * about. It can reference a local file or (configuration permitting) a
  758. * remote file using one of the supported streams.
  759. * </p>
  760. * @param imageinfo array[optional] <p>
  761. * This optional parameter allows you to extract some extended
  762. * information from the image file. Currently, this will return the
  763. * different JPG APP markers as an associative array.
  764. * Some programs use these APP markers to embed text information in
  765. * images. A very common one is to embed
  766. * IPTC information in the APP13 marker.
  767. * You can use the iptcparse function to parse the
  768. * binary APP13 marker into something readable.
  769. * </p>
  770. * @return array an array with 7 elements.
  771. * </p>
  772. * <p>
  773. * Index 0 and 1 contains respectively the width and the height of the image.
  774. * </p>
  775. * <p>
  776. * Some formats may contain no image or may contain multiple images. In these
  777. * cases, getimagesize might not be able to properly
  778. * determine the image size. getimagesize will return
  779. * zero for width and height in these cases.
  780. * </p>
  781. * <p>
  782. * Index 2 is one of the IMAGETYPE_XXX constants indicating
  783. * the type of the image.
  784. * </p>
  785. * <p>
  786. * Index 3 is a text string with the correct
  787. * height="yyy" width="xxx" string that can be used
  788. * directly in an IMG tag.
  789. * </p>
  790. * <p>
  791. * mime is the correspondant MIME type of the image.
  792. * This information can be used to deliver images with the correct HTTP
  793. * Content-type header:
  794. * getimagesize and MIME types
  795. * ]]>
  796. * </p>
  797. * <p>
  798. * channels will be 3 for RGB pictures and 4 for CMYK
  799. * pictures.
  800. * </p>
  801. * <p>
  802. * bits is the number of bits for each color.
  803. * </p>
  804. * <p>
  805. * For some image types, the presence of channels and
  806. * bits values can be a bit
  807. * confusing. As an example, GIF always uses 3 channels
  808. * per pixel, but the number of bits per pixel cannot be calculated for an
  809. * animated GIF with a global color table.
  810. * </p>
  811. * <p>
  812. * On failure, false is returned.
  813. */
  814. function getimagesize ($filename, array &$imageinfo = null) {}
  815. /**
  816. * Get the size of an image from a string
  817. * @link http://www.php.net/manual/en/function.getimagesizefromstring.php
  818. * @param imagedata string <p>
  819. * The image data, as a string.
  820. * </p>
  821. * @param imageinfo array[optional] <p>
  822. * See getimagesize.
  823. * </p>
  824. * @return array See getimagesize.
  825. */
  826. function getimagesizefromstring ($imagedata, array &$imageinfo = null) {}
  827. /**
  828. * Get Mime-Type for image-type returned by getimagesize,
  829. exif_read_data, exif_thumbnail, exif_imagetype
  830. * @link http://www.php.net/manual/en/function.image-type-to-mime-type.php
  831. * @param imagetype int <p>
  832. * One of the IMAGETYPE_XXX constants.
  833. * </p>
  834. * @return string The returned values are as follows
  835. * <table>
  836. * Returned values Constants
  837. * <tr valign="top">
  838. * <td>imagetype</td>
  839. * <td>Returned value</td>
  840. * </tr>
  841. * <tr valign="top">
  842. * <td>IMAGETYPE_GIF</td>
  843. * <td>image/gif</td>
  844. * </tr>
  845. * <tr valign="top">
  846. * <td>IMAGETYPE_JPEG</td>
  847. * <td>image/jpeg</td>
  848. * </tr>
  849. * <tr valign="top">
  850. * <td>IMAGETYPE_PNG</td>
  851. * <td>image/png</td>
  852. * </tr>
  853. * <tr valign="top">
  854. * <td>IMAGETYPE_SWF</td>
  855. * <td>application/x-shockwave-flash</td>
  856. * </tr>
  857. * <tr valign="top">
  858. * <td>IMAGETYPE_PSD</td>
  859. * <td>image/psd</td>
  860. * </tr>
  861. * <tr valign="top">
  862. * <td>IMAGETYPE_BMP</td>
  863. * <td>image/bmp</td>
  864. * </tr>
  865. * <tr valign="top">
  866. * <td>IMAGETYPE_TIFF_II (intel byte order)</td>
  867. * <td>image/tiff</td>
  868. * </tr>
  869. * <tr valign="top">
  870. * <td>
  871. * IMAGETYPE_TIFF_MM (motorola byte order)
  872. * </td>
  873. * <td>image/tiff</td>
  874. * </tr>
  875. * <tr valign="top">
  876. * <td>IMAGETYPE_JPC</td>
  877. * <td>application/octet-stream</td>
  878. * </tr>
  879. * <tr valign="top">
  880. * <td>IMAGETYPE_JP2</td>
  881. * <td>image/jp2</td>
  882. * </tr>
  883. * <tr valign="top">
  884. * <td>IMAGETYPE_JPX</td>
  885. * <td>application/octet-stream</td>
  886. * </tr>
  887. * <tr valign="top">
  888. * <td>IMAGETYPE_JB2</td>
  889. * <td>application/octet-stream</td>
  890. * </tr>
  891. * <tr valign="top">
  892. * <td>IMAGETYPE_SWC</td>
  893. * <td>application/x-shockwave-flash</td>
  894. * </tr>
  895. * <tr valign="top">
  896. * <td>IMAGETYPE_IFF</td>
  897. * <td>image/iff</td>
  898. * </tr>
  899. * <tr valign="top">
  900. * <td>IMAGETYPE_WBMP</td>
  901. * <td>image/vnd.wap.wbmp</td>
  902. * </tr>
  903. * <tr valign="top">
  904. * <td>IMAGETYPE_XBM</td>
  905. * <td>image/xbm</td>
  906. * </tr>
  907. * <tr valign="top">
  908. * <td>IMAGETYPE_ICO</td>
  909. * <td>image/vnd.microsoft.icon</td>
  910. * </tr>
  911. * </table>
  912. */
  913. function image_type_to_mime_type ($imagetype) {}
  914. /**
  915. * Get file extension for image type
  916. * @link http://www.php.net/manual/en/function.image-type-to-extension.php
  917. * @param imagetype int <p>
  918. * One of the IMAGETYPE_XXX constant.
  919. * </p>
  920. * @param include_dot bool[optional] <p>
  921. * Whether to prepend a dot to the extension or not. Default to true.
  922. * </p>
  923. * @return string A string with the extension corresponding to the given image type.
  924. */
  925. function image_type_to_extension ($imagetype, $include_dot = null) {}
  926. /**
  927. * Outputs information about PHP's configuration
  928. * @link http://www.php.net/manual/en/function.phpinfo.php
  929. * @param what int[optional] <p>
  930. * The output may be customized by passing one or more of the
  931. * following constants bitwise values summed
  932. * together in the optional what parameter.
  933. * One can also combine the respective constants or bitwise values
  934. * together with the or operator.
  935. * </p>
  936. * <p>
  937. * <table>
  938. * phpinfo options
  939. * <tr valign="top">
  940. * <td>Name (constant)</td>
  941. * <td>Value</td>
  942. * <td>Description</td>
  943. * </tr>
  944. * <tr valign="top">
  945. * <td>INFO_GENERAL</td>
  946. * <td>1</td>
  947. * <td>
  948. * The configuration line, &php.ini; location, build date, Web
  949. * Server, System and more.
  950. * </td>
  951. * </tr>
  952. * <tr valign="top">
  953. * <td>INFO_CREDITS</td>
  954. * <td>2</td>
  955. * <td>
  956. * PHP Credits. See also phpcredits.
  957. * </td>
  958. * </tr>
  959. * <tr valign="top">
  960. * <td>INFO_CONFIGURATION</td>
  961. * <td>4</td>
  962. * <td>
  963. * Current Local and Master values for PHP directives. See
  964. * also ini_get.
  965. * </td>
  966. * </tr>
  967. * <tr valign="top">
  968. * <td>INFO_MODULES</td>
  969. * <td>8</td>
  970. * <td>
  971. * Loaded modules and their respective settings. See also
  972. * get_loaded_extensions.
  973. * </td>
  974. * </tr>
  975. * <tr valign="top">
  976. * <td>INFO_ENVIRONMENT</td>
  977. * <td>16</td>
  978. * <td>
  979. * Environment Variable information that's also available in
  980. * $_ENV.
  981. * </td>
  982. * </tr>
  983. * <tr valign="top">
  984. * <td>INFO_VARIABLES</td>
  985. * <td>32</td>
  986. * <td>
  987. * Shows all
  988. * predefined variables from EGPCS (Environment, GET,
  989. * POST, Cookie, Server).
  990. * </td>
  991. * </tr>
  992. * <tr valign="top">
  993. * <td>INFO_LICENSE</td>
  994. * <td>64</td>
  995. * <td>
  996. * PHP License information. See also the license FAQ.
  997. * </td>
  998. * </tr>
  999. * <tr valign="top">
  1000. * <td>INFO_ALL</td>
  1001. * <td>-1</td>
  1002. * <td>
  1003. * Shows all of the above.
  1004. * </td>
  1005. * </tr>
  1006. * </table>
  1007. * </p>
  1008. * @return bool Returns true on success or false on failure.
  1009. */
  1010. function phpinfo ($what = null) {}
  1011. /**
  1012. * Gets the current PHP version
  1013. * @link http://www.php.net/manual/en/function.phpversion.php
  1014. * @param extension string[optional] <p>
  1015. * An optional extension name.
  1016. * </p>
  1017. * @return string If the optional extension parameter is
  1018. * specified, phpversion returns the version of that
  1019. * extension, or false if there is no version information associated or
  1020. * the extension isn't enabled.
  1021. */
  1022. function phpversion ($extension = null) {}
  1023. /**
  1024. * Prints out the credits for PHP
  1025. * @link http://www.php.net/manual/en/function.phpcredits.php
  1026. * @param flag int[optional] <p>
  1027. * To generate a custom credits page, you may want to use the
  1028. * flag parameter.
  1029. * </p>
  1030. * <p>
  1031. * <table>
  1032. * Pre-defined phpcredits flags
  1033. * <tr valign="top">
  1034. * <td>name</td>
  1035. * <td>description</td>
  1036. * </tr>
  1037. * <tr valign="top">
  1038. * <td>CREDITS_ALL</td>
  1039. * <td>
  1040. * All the credits, equivalent to using: CREDITS_DOCS +
  1041. * CREDITS_GENERAL + CREDITS_GROUP +
  1042. * CREDITS_MODULES + CREDITS_FULLPAGE.
  1043. * It generates a complete stand-alone HTML page with the appropriate tags.
  1044. * </td>
  1045. * </tr>
  1046. * <tr valign="top">
  1047. * <td>CREDITS_DOCS</td>
  1048. * <td>The credits for the documentation team</td>
  1049. * </tr>
  1050. * <tr valign="top">
  1051. * <td>CREDITS_FULLPAGE</td>
  1052. * <td>
  1053. * Usually used in combination with the other flags. Indicates
  1054. * that a complete stand-alone HTML page needs to be
  1055. * printed including the information indicated by the other
  1056. * flags.
  1057. * </td>
  1058. * </tr>
  1059. * <tr valign="top">
  1060. * <td>CREDITS_GENERAL</td>
  1061. * <td>
  1062. * General credits: Language design and concept, PHP authors
  1063. * and SAPI module.
  1064. * </td>
  1065. * </tr>
  1066. * <tr valign="top">
  1067. * <td>CREDITS_GROUP</td>
  1068. * <td>A list of the core developers</td>
  1069. * </tr>
  1070. * <tr valign="top">
  1071. * <td>CREDITS_MODULES</td>
  1072. * <td>
  1073. * A list of the extension modules for PHP, and their authors
  1074. * </td>
  1075. * </tr>
  1076. * <tr valign="top">
  1077. * <td>CREDITS_SAPI</td>
  1078. * <td>
  1079. * A list of the server API modules for PHP, and their authors
  1080. * </td>
  1081. * </tr>
  1082. * </table>
  1083. * </p>
  1084. * @return bool Returns true on success or false on failure.
  1085. */
  1086. function phpcredits ($flag = null) {}
  1087. /**
  1088. * Gets the logo guid
  1089. * @link http://www.php.net/manual/en/function.php-logo-guid.php
  1090. * @return string PHPE9568F34-D428-11d2-A769-00AA001ACF42.
  1091. */
  1092. function php_logo_guid () {}
  1093. function php_real_logo_guid () {}
  1094. function php_egg_logo_guid () {}
  1095. /**
  1096. * Gets the Zend guid
  1097. * @link http://www.php.net/manual/en/function.zend-logo-guid.php
  1098. * @return string PHPE9568F35-D428-11d2-A769-00AA001ACF42.
  1099. */
  1100. function zend_logo_guid () {}
  1101. /**
  1102. * Returns the type of interface between web server and PHP
  1103. * @link http://www.php.net/manual/en/function.php-sapi-name.php
  1104. * @return string the interface type, as a lowercase string.
  1105. * </p>
  1106. * <p>
  1107. * Although not exhaustive, the possible return values include
  1108. * aolserver, apache,
  1109. * apache2filter, apache2handler,
  1110. * caudium, cgi (until PHP 5.3),
  1111. * cgi-fcgi, cli,
  1112. * continuity, embed,
  1113. * isapi, litespeed,
  1114. * milter, nsapi,
  1115. * phttpd, pi3web, roxen,
  1116. * thttpd, tux, and webjames.
  1117. */
  1118. function php_sapi_name () {}
  1119. /**
  1120. * Returns information about the operating system PHP is running on
  1121. * @link http://www.php.net/manual/en/function.php-uname.php
  1122. * @param mode string[optional] <p>
  1123. * mode is a single character that defines what
  1124. * information is returned:
  1125. * 'a': This is the default. Contains all modes in
  1126. * the sequence "s n r v m".
  1127. * @return string the description, as a string.
  1128. */
  1129. function php_uname ($mode = null) {}
  1130. /**
  1131. * Return a list of .ini files parsed from the additional ini dir
  1132. * @link http://www.php.net/manual/en/function.php-ini-scanned-files.php
  1133. * @return string a comma-separated string of .ini files on success. Each comma is
  1134. * followed by a newline. If the directive --with-config-file-scan-dir wasn't set,
  1135. * false is returned. If it was set and the directory was empty, an
  1136. * empty string is returned. If a file is unrecognizable, the file will
  1137. * still make it into the returned string but a PHP error will also result.
  1138. * This PHP error will be seen both at compile time and while using
  1139. * php_ini_scanned_files.
  1140. */
  1141. function php_ini_scanned_files () {}
  1142. /**
  1143. * Retrieve a path to the loaded php.ini file
  1144. * @link http://www.php.net/manual/en/function.php-ini-loaded-file.php
  1145. * @return string The loaded &php.ini; path, or false if one is not loaded.
  1146. */
  1147. function php_ini_loaded_file () {}
  1148. /**
  1149. * String comparisons using a "natural order" algorithm
  1150. * @link http://www.php.net/manual/en/function.strnatcmp.php
  1151. * @param str1 string <p>
  1152. * The first string.
  1153. * </p>
  1154. * @param str2 string <p>
  1155. * The second string.
  1156. * </p>
  1157. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  1158. * str1 is less than str2; &gt;
  1159. * 0 if str1 is greater than
  1160. * str2, and 0 if they are equal.
  1161. */
  1162. function strnatcmp ($str1, $str2) {}
  1163. /**
  1164. * Case insensitive string comparisons using a "natural order" algorithm
  1165. * @link http://www.php.net/manual/en/function.strnatcasecmp.php
  1166. * @param str1 string <p>
  1167. * The first string.
  1168. * </p>
  1169. * @param str2 string <p>
  1170. * The second string.
  1171. * </p>
  1172. * @return int Similar to other string comparison functions, this one returns &lt; 0 if
  1173. * str1 is less than str2 &gt;
  1174. * 0 if str1 is greater than
  1175. * str2, and 0 if they are equal.
  1176. */
  1177. function strnatcasecmp ($str1, $str2) {}
  1178. /**
  1179. * Count the number of substring occurrences
  1180. * @link http://www.php.net/manual/en/function.substr-count.php
  1181. * @param haystack string <p>
  1182. * The string to search in
  1183. * </p>
  1184. * @param needle string <p>
  1185. * The substring to search for
  1186. * </p>
  1187. * @param offset int[optional] <p>
  1188. * The offset where to start counting
  1189. * </p>
  1190. * @param length int[optional] <p>
  1191. * The maximum length after the specified offset to search for the
  1192. * substring. It outputs a warning if the offset plus the length is
  1193. * greater than the haystack length.
  1194. * </p>
  1195. * @return int This function returns an integer.
  1196. */
  1197. function substr_count ($haystack, $needle, $offset = null, $length = null) {}
  1198. /**
  1199. * Finds the length of the initial segment of a string consisting
  1200. entirely of characters contained within a given mask.
  1201. * @link http://www.php.net/manual/en/function.strspn.php
  1202. * @param subject string <p>
  1203. * The string to examine.
  1204. * </p>
  1205. * @param mask string <p>
  1206. * The list of allowable characters.
  1207. * </p>
  1208. * @param start int[optional] <p>
  1209. * The position in subject to
  1210. * start searching.
  1211. * </p>
  1212. * <p>
  1213. * If start is given and is non-negative,
  1214. * then strspn will begin
  1215. * examining subject at
  1216. * the start'th position. For instance, in
  1217. * the string 'abcdef', the character at
  1218. * position 0 is 'a', the
  1219. * character at position 2 is
  1220. * 'c', and so forth.
  1221. * </p>
  1222. * <p>
  1223. * If start is given and is negative,
  1224. * then strspn will begin
  1225. * examining subject at
  1226. * the start'th position from the end
  1227. * of subject.
  1228. * </p>
  1229. * @param length int[optional] <p>
  1230. * The length of the segment from subject
  1231. * to examine.
  1232. * </p>
  1233. * <p>
  1234. * If length is given and is non-negative,
  1235. * then subject will be examined
  1236. * for length characters after the starting
  1237. * position.
  1238. * </p>
  1239. * <p>
  1240. * If lengthis given and is negative,
  1241. * then subject will be examined from the
  1242. * starting position up to length
  1243. * characters from the end of subject.
  1244. * </p>
  1245. * @return int the length of the initial segment of subject
  1246. * which consists entirely of characters in mask.
  1247. */
  1248. function strspn ($subject, $mask, $start = null, $length = null) {}
  1249. /**
  1250. * Find length of initial segment not matching mask
  1251. * @link http://www.php.net/manual/en/function.strcspn.php
  1252. * @param str1 string <p>
  1253. * The first string.
  1254. * </p>
  1255. * @param str2 string <p>
  1256. * The second string.
  1257. * </p>
  1258. * @param start int[optional] <p>
  1259. * The start position of the string to examine.
  1260. * </p>
  1261. * @param length int[optional] <p>
  1262. * The length of the string to examine.
  1263. * </p>
  1264. * @return int the length of the segment as an integer.
  1265. */
  1266. function strcspn ($str1, $str2, $start = null, $length = null) {}
  1267. /**
  1268. * Tokenize string
  1269. * @link http://www.php.net/manual/en/function.strtok.php
  1270. * @param str string <p>
  1271. * The string being split up into smaller strings (tokens).
  1272. * </p>
  1273. * @param token string <p>
  1274. * The delimiter used when splitting up str.
  1275. * </p>
  1276. * @return string A string token.
  1277. */
  1278. function strtok ($str, $token) {}
  1279. /**
  1280. * Make a string uppercase
  1281. * @link http://www.php.net/manual/en/function.strtoupper.php
  1282. * @param string string <p>
  1283. * The input string.
  1284. * </p>
  1285. * @return string the uppercased string.
  1286. */
  1287. function strtoupper ($string) {}
  1288. /**
  1289. * Make a string lowercase
  1290. * @link http://www.php.net/manual/en/function.strtolower.php
  1291. * @param str string <p>
  1292. * The input string.
  1293. * </p>
  1294. * @return string the lowercased string.
  1295. */
  1296. function strtolower ($str) {}
  1297. /**
  1298. * Find the position of the first occurrence of a substring in a string
  1299. * @link http://www.php.net/manual/en/function.strpos.php
  1300. * @param haystack string <p>
  1301. * The string to search in.
  1302. * </p>
  1303. * @param needle mixed <p>
  1304. * If needle is not a string, it is converted
  1305. * to an integer and applied as the ordinal value of a character.
  1306. * </p>
  1307. * @param offset int[optional] <p>
  1308. * If specified, search will start this number of characters counted from
  1309. * the beginning of the string. Unlike strrpos and
  1310. * strripos, the offset cannot be negative.
  1311. * </p>
  1312. * @return int the position of where the needle exists relative to the beginning of
  1313. * the haystack string (independent of offset).
  1314. * Also note that string positions start at 0, and not 1.
  1315. * </p>
  1316. * <p>
  1317. * Returns false if the needle was not found.
  1318. */
  1319. function strpos ($haystack, $needle, $offset = null) {}
  1320. /**
  1321. * Find the position of the first occurrence of a case-insensitive substring in a string
  1322. * @link http://www.php.net/manual/en/function.stripos.php
  1323. * @param haystack string <p>
  1324. * The string to search in.
  1325. * </p>
  1326. * @param needle string <p>
  1327. * Note that the needle may be a string of one or
  1328. * more characters.
  1329. * </p>
  1330. * <p>
  1331. * If needle is not a string, it is converted to
  1332. * an integer and applied as the ordinal value of a character.
  1333. * </p>
  1334. * @param offset int[optional] <p>
  1335. * If specified, search will start this number of characters counted from
  1336. * the beginning of the string. Unlike strrpos and
  1337. * strripos, the offset cannot be negative.
  1338. * </p>
  1339. * @return int the position of where the needle exists relative to the beginnning of
  1340. * the haystack string (independent of offset).
  1341. * Also note that string positions start at 0, and not 1.
  1342. * </p>
  1343. * <p>
  1344. * Returns false if the needle was not found.
  1345. */
  1346. function stripos ($haystack, $needle, $offset = null) {}
  1347. /**
  1348. * Find the position of the last occurrence of a substring in a string
  1349. * @link http://www.php.net/manual/en/function.strrpos.php
  1350. * @param haystack string <p>
  1351. * The string to search in.
  1352. * </p>
  1353. * @param needle string <p>
  1354. * If needle is not a string, it is converted
  1355. * to an integer and applied as the ordinal value of a character.
  1356. * </p>
  1357. * @param offset int[optional] <p>
  1358. * If specified, search will start this number of characters counted from the
  1359. * beginning of the string. If the value is negative, search will instead start
  1360. * from that many characters from the end of the string, searching backwards.
  1361. * </p>
  1362. * @return int the position where the needle exists relative to the beginnning of
  1363. * the haystack string (independent of search direction
  1364. * or offset).
  1365. * Also note that string positions start at 0, and not 1.
  1366. * </p>
  1367. * <p>
  1368. * Returns false if the needle was not found.
  1369. */
  1370. function strrpos ($haystack, $needle, $offset = null) {}
  1371. /**
  1372. * Find the position of the last occurrence of a case-insensitive substring in a string
  1373. * @link http://www.php.net/manual/en/function.strripos.php
  1374. * @param haystack string <p>
  1375. * The string to search in.
  1376. * </p>
  1377. * @param needle string <p>
  1378. * If needle is not a string, it is converted
  1379. * to an integer and applied as the ordinal value of a character.
  1380. * </p>
  1381. * @param offset int[optional] <p>
  1382. * If specified, search will start this number of characters counted from the
  1383. * beginning of the string. If the value is negative, search will instead start
  1384. * from that many characters from the end of the string, searching backwards.
  1385. * </p>
  1386. * @return int the position where the needle exists relative to the beginnning of
  1387. * the haystack string (independent of search direction
  1388. * or offset).
  1389. * Also note that string positions start at 0, and not 1.
  1390. * </p>
  1391. * <p>
  1392. * Returns false if the needle was not found.
  1393. */
  1394. function strripos ($haystack, $needle, $offset = null) {}
  1395. /**
  1396. * Reverse a string
  1397. * @link http://www.php.net/manual/en/function.strrev.php
  1398. * @param string string <p>
  1399. * The string to be reversed.
  1400. * </p>
  1401. * @return string the reversed string.
  1402. */
  1403. function strrev ($string) {}
  1404. /**
  1405. * Convert logical Hebrew text to visual text
  1406. * @link http://www.php.net/manual/en/function.hebrev.php
  1407. * @param hebrew_text string <p>
  1408. * A Hebrew input string.
  1409. * </p>
  1410. * @param max_chars_per_line int[optional] <p>
  1411. * This optional parameter indicates maximum number of characters per
  1412. * line that will be returned.
  1413. * </p>
  1414. * @return string the visual string.
  1415. */
  1416. function hebrev ($hebrew_text, $max_chars_per_line = null) {}
  1417. /**
  1418. * Convert logical Hebrew text to visual text with newline conversion
  1419. * @link http://www.php.net/manual/en/function.hebrevc.php
  1420. * @param hebrew_text string <p>
  1421. * A Hebrew input string.
  1422. * </p>
  1423. * @param max_chars_per_line int[optional] <p>
  1424. * This optional parameter indicates maximum number of characters per
  1425. * line that will be returned.
  1426. * </p>
  1427. * @return string the visual string.
  1428. */
  1429. function hebrevc ($hebrew_text, $max_chars_per_line = null) {}
  1430. /**
  1431. * Inserts HTML line breaks before all newlines in a string
  1432. * @link http://www.php.net/manual/en/function.nl2br.php
  1433. * @param string string <p>
  1434. * The input string.
  1435. * </p>
  1436. * @param is_xhtml bool[optional] <p>
  1437. * Whether to use XHTML compatible line breaks or not.
  1438. * </p>
  1439. * @return string the altered string.
  1440. */
  1441. function nl2br ($string, $is_xhtml = null) {}
  1442. /**
  1443. * Returns trailing name component of path
  1444. * @link http://www.php.net/manual/en/function.basename.php
  1445. * @param path string <p>
  1446. * A path.
  1447. * </p>
  1448. * <p>
  1449. * On Windows, both slash (/) and backslash
  1450. * (\) are used as directory separator character. In
  1451. * other environments, it is the forward slash (/).
  1452. * </p>
  1453. * @param suffix string[optional] <p>
  1454. * If the name component ends in suffix this will also
  1455. * be cut off.
  1456. * </p>
  1457. * @return string the base name of the given path.
  1458. */
  1459. function basename ($path, $suffix = null) {}
  1460. /**
  1461. * Returns parent directory's path
  1462. * @link http://www.php.net/manual/en/function.dirname.php
  1463. * @param path string <p>
  1464. * A path.
  1465. * </p>
  1466. * <p>
  1467. * On Windows, both slash (/) and backslash
  1468. * (\) are used as directory separator character. In
  1469. * other environments, it is the forward slash (/).
  1470. * </p>
  1471. * @return string the path of the parent directory. If there are no slashes in
  1472. * path, a dot ('.') is returned,
  1473. * indicating the current directory. Otherwise, the returned string is
  1474. * path with any trailing
  1475. * /component removed.
  1476. */
  1477. function dirname ($path) {}
  1478. /**
  1479. * Returns information about a file path
  1480. * @link http://www.php.net/manual/en/function.pathinfo.php
  1481. * @param path string <p>
  1482. * The path to be parsed.
  1483. * </p>
  1484. * @param options int[optional] <p>
  1485. * If present, specifies a specific element to be returned; one of
  1486. * PATHINFO_DIRNAME,
  1487. * PATHINFO_BASENAME,
  1488. * PATHINFO_EXTENSION or
  1489. * PATHINFO_FILENAME.
  1490. * </p>
  1491. * <p>If options is not specified, returns all
  1492. * available elements.
  1493. * </p>
  1494. * @return mixed If the options parameter is not passed, an
  1495. * associative array containing the following elements is
  1496. * returned:
  1497. * dirname, basename,
  1498. * extension (if any), and filename.
  1499. * </p>
  1500. * <p>
  1501. * If the path does not have an extension, no
  1502. * extension element will be returned
  1503. * (see second example below).
  1504. * </p>
  1505. * <p>
  1506. * If options is present, returns a
  1507. * string containing the requested element.
  1508. */
  1509. function pathinfo ($path, $options = null) {}
  1510. /**
  1511. * Un-quotes a quoted string
  1512. * @link http://www.php.net/manual/en/function.stripslashes.php
  1513. * @param str string <p>
  1514. * The input string.
  1515. * </p>
  1516. * @return string a string with backslashes stripped off.
  1517. * (\' becomes ' and so on.)
  1518. * Double backslashes (\\) are made into a single
  1519. * backslash (\).
  1520. */
  1521. function stripslashes ($str) {}
  1522. /**
  1523. * Un-quote string quoted with <function>addcslashes</function>
  1524. * @link http://www.php.net/manual/en/function.stripcslashes.php
  1525. * @param str string <p>
  1526. * The string to be unescaped.
  1527. * </p>
  1528. * @return string the unescaped string.
  1529. */
  1530. function stripcslashes ($str) {}
  1531. /**
  1532. * Find the first occurrence of a string
  1533. * @link http://www.php.net/manual/en/function.strstr.php
  1534. * @param haystack string <p>
  1535. * The input string.
  1536. * </p>
  1537. * @param needle mixed <p>
  1538. * If needle is not a string, it is converted to
  1539. * an integer and applied as the ordinal value of a character.
  1540. * </p>
  1541. * @param before_needle bool[optional] <p>
  1542. * If true, strstr returns
  1543. * the part of the haystack before the first
  1544. * occurrence of the needle (excluding the needle).
  1545. * </p>
  1546. * @return string the portion of string, or false if needle
  1547. * is not found.
  1548. */
  1549. function strstr ($haystack, $needle, $before_needle = null) {}
  1550. /**
  1551. * Case-insensitive <function>strstr</function>
  1552. * @link http://www.php.net/manual/en/function.stristr.php
  1553. * @param haystack string <p>
  1554. * The string to search in
  1555. * </p>
  1556. * @param needle mixed <p>
  1557. * If needle is not a string, it is converted to
  1558. * an integer and applied as the ordinal value of a character.
  1559. * </p>
  1560. * @param before_needle bool[optional] <p>
  1561. * If true, stristr
  1562. * returns the part of the haystack before the
  1563. * first occurrence of the needle (excluding needle).
  1564. * </p>
  1565. * @return string the matched substring. If needle is not
  1566. * found, returns false.
  1567. */
  1568. function stristr ($haystack, $needle, $before_needle = null) {}
  1569. /**
  1570. * Find the last occurrence of a character in a string
  1571. * @link http://www.php.net/manual/en/function.strrchr.php
  1572. * @param haystack string <p>
  1573. * The string to search in
  1574. * </p>
  1575. * @param needle mixed <p>
  1576. * If needle contains more than one character,
  1577. * only the first is used. This behavior is different from that of
  1578. * strstr.
  1579. * </p>
  1580. * <p>
  1581. * If needle is not a string, it is converted to
  1582. * an integer and applied as the ordinal value of a character.
  1583. * </p>
  1584. * @return string This function returns the portion of string, or false if
  1585. * needle is not found.
  1586. */
  1587. function strrchr ($haystack, $needle) {}
  1588. /**
  1589. * Randomly shuffles a string
  1590. * @link http://www.php.net/manual/en/function.str-shuffle.php
  1591. * @param str string <p>
  1592. * The input string.
  1593. * </p>
  1594. * @return string the shuffled string.
  1595. */
  1596. function str_shuffle ($str) {}
  1597. /**
  1598. * Return information about words used in a string
  1599. * @link http://www.php.net/manual/en/function.str-word-count.php
  1600. * @param string string <p>
  1601. * The string
  1602. * </p>
  1603. * @param format int[optional] <p>
  1604. * Specify the return value of this function. The current supported values
  1605. * are:
  1606. * 0 - returns the number of words found
  1607. * @param charlist string[optional] <p>
  1608. * A list of additional characters which will be considered as 'word'
  1609. * </p>
  1610. * @return mixed an array or an integer, depending on the
  1611. * format chosen.
  1612. */
  1613. function str_word_count ($string, $format = null, $charlist = null) {}
  1614. /**
  1615. * Convert a string to an array
  1616. * @link http://www.php.net/manual/en/function.str-split.php
  1617. * @param string string <p>
  1618. * The input string.
  1619. * </p>
  1620. * @param split_length int[optional] <p>
  1621. * Maximum length of the chunk.
  1622. * </p>
  1623. * @return array If the optional split_length parameter is
  1624. * specified, the returned array will be broken down into chunks with each
  1625. * being split_length in length, otherwise each chunk
  1626. * will be one character in length.
  1627. * </p>
  1628. * <p>
  1629. * false is returned if split_length is less than 1.
  1630. * If the split_length length exceeds the length of
  1631. * string, the entire string is returned as the first
  1632. * (and only) array element.
  1633. */
  1634. function str_split ($string, $split_length = null) {}
  1635. /**
  1636. * Search a string for any of a set of characters
  1637. * @link http://www.php.net/manual/en/function.strpbrk.php
  1638. * @param haystack string <p>
  1639. * The string where char_list is looked for.
  1640. * </p>
  1641. * @param char_list string <p>
  1642. * This parameter is case sensitive.
  1643. * </p>
  1644. * @return string a string starting from the character found, or false if it is
  1645. * not found.
  1646. */
  1647. function strpbrk ($haystack, $char_list) {}
  1648. /**
  1649. * Binary safe comparison of two strings from an offset, up to length characters
  1650. * @link http://www.php.net/manual/en/function.substr-compare.php
  1651. * @param main_str string <p>
  1652. * The main string being compared.
  1653. * </p>
  1654. * @param str string <p>
  1655. * The secondary string being compared.
  1656. * </p>
  1657. * @param offset int <p>
  1658. * The start position for the comparison. If negative, it starts counting
  1659. * from the end of the string.
  1660. * </p>
  1661. * @param length int[optional] <p>
  1662. * The length of the comparison. The default value is the largest of the
  1663. * length of the str compared to the length of
  1664. * main_str less the
  1665. * offset.
  1666. * </p>
  1667. * @param case_insensitivity bool[optional] <p>
  1668. * If case_insensitivity is true, comparison is
  1669. * case insensitive.
  1670. * </p>
  1671. * @return int &lt; 0 if main_str from position
  1672. * offset is less than str, &gt;
  1673. * 0 if it is greater than str, and 0 if they are equal.
  1674. * If offset is equal to or greater than the length of
  1675. * main_str or length is set and
  1676. * is less than 1, substr_compare prints a warning and returns
  1677. * false.
  1678. */
  1679. function substr_compare ($main_str, $str, $offset, $length = null, $case_insensitivity = null) {}
  1680. /**
  1681. * Locale based string comparison
  1682. * @link http://www.php.net/manual/en/function.strcoll.php
  1683. * @param str1 string <p>
  1684. * The first string.
  1685. * </p>
  1686. * @param str2 string <p>
  1687. * The second string.
  1688. * </p>
  1689. * @return int &lt; 0 if str1 is less than
  1690. * str2; &gt; 0 if
  1691. * str1 is greater than
  1692. * str2, and 0 if they are equal.
  1693. */
  1694. function strcoll ($str1, $str2) {}
  1695. /**
  1696. * Formats a number as a currency string
  1697. * @link http://www.php.net/manual/en/function.money-format.php
  1698. * @param format string <p>
  1699. * The format specification consists of the following sequence:
  1700. * <p>a % character</p>
  1701. * @param number float <p>
  1702. * The number to be formatted.
  1703. * </p>
  1704. * @return string the formatted string. Characters before and after the formatting
  1705. * string will be returned unchanged.
  1706. * Non-numeric number causes returning &null; and
  1707. * emitting E_WARNING.
  1708. */
  1709. function money_format ($format, $number) {}
  1710. /**
  1711. * Return part of a string
  1712. * @link http://www.php.net/manual/en/function.substr.php
  1713. * @param string string <p>
  1714. * The input string. Must be one character or longer.
  1715. * </p>
  1716. * @param start int <p>
  1717. * If start is non-negative, the returned string
  1718. * will start at the start'th position in
  1719. * string, counting from zero. For instance,
  1720. * in the string 'abcdef', the character at
  1721. * position 0 is 'a', the
  1722. * character at position 2 is
  1723. * 'c', and so forth.
  1724. * </p>
  1725. * <p>
  1726. * If start is negative, the returned string
  1727. * will start at the start'th character
  1728. * from the end of string.
  1729. * </p>
  1730. * <p>
  1731. * If string is less than or equal to
  1732. * start characters long, false will be returned.
  1733. * </p>
  1734. * <p>
  1735. * Using a negative start
  1736. * ]]>
  1737. * </p>
  1738. * @param length int[optional] <p>
  1739. * If length is given and is positive, the string
  1740. * returned will contain at most length characters
  1741. * beginning from start (depending on the length of
  1742. * string).
  1743. * </p>
  1744. * <p>
  1745. * If length is given and is negative, then that many
  1746. * characters will be omitted from the end of string
  1747. * (after the start position has been calculated when a
  1748. * start is negative). If
  1749. * start denotes the position of this truncation or
  1750. * beyond, false will be returned.
  1751. * </p>
  1752. * <p>
  1753. * If length is given and is 0,
  1754. * false or &null; an empty string will be returned.
  1755. * </p>
  1756. * <p>
  1757. * If length is omitted, the substring starting from
  1758. * start until the end of the string will be
  1759. * returned.
  1760. * </p>
  1761. * Using a negative length
  1762. * ]]>
  1763. * @return string the extracted part of string; &return.falseforfailure;, or
  1764. * an empty string.
  1765. */
  1766. function substr ($string, $start, $length = null) {}
  1767. /**
  1768. * Replace text within a portion of a string
  1769. * @link http://www.php.net/manual/en/function.substr-replace.php
  1770. * @param string mixed <p>
  1771. * The input string.
  1772. * </p>
  1773. * <p>
  1774. * An array of strings can be provided, in which
  1775. * case the replacements will occur on each string in turn. In this case,
  1776. * the replacement, start
  1777. * and length parameters may be provided either as
  1778. * scalar values to be applied to each input string in turn, or as
  1779. * arrays, in which case the corresponding array element will
  1780. * be used for each input string.
  1781. * </p>
  1782. * @param replacement mixed <p>
  1783. * The replacement string.
  1784. * </p>
  1785. * @param start mixed <p>
  1786. * If start is positive, the replacing will
  1787. * begin at the start'th offset into
  1788. * string.
  1789. * </p>
  1790. * <p>
  1791. * If start is negative, the replacing will
  1792. * begin at the start'th character from the
  1793. * end of string.
  1794. * </p>
  1795. * @param length mixed[optional] <p>
  1796. * If given and is positive, it represents the length of the portion of
  1797. * string which is to be replaced. If it is
  1798. * negative, it represents the number of characters from the end of
  1799. * string at which to stop replacing. If it
  1800. * is not given, then it will default to strlen(
  1801. * string ); i.e. end the replacing at the
  1802. * end of string. Of course, if
  1803. * length is zero then this function will have the
  1804. * effect of inserting replacement into
  1805. * string at the given
  1806. * start offset.
  1807. * </p>
  1808. * @return mixed The result string is returned. If string is an
  1809. * array then array is returned.
  1810. */
  1811. function substr_replace ($string, $replacement, $start, $length = null) {}
  1812. /**
  1813. * Quote meta characters
  1814. * @link http://www.php.net/manual/en/function.quotemeta.php
  1815. * @param str string <p>
  1816. * The input string.
  1817. * </p>
  1818. * @return string the string with meta characters quoted, or false if an empty
  1819. * string is given as str.
  1820. */
  1821. function quotemeta ($str) {}
  1822. /**
  1823. * Make a string's first character uppercase
  1824. * @link http://www.php.net/manual/en/function.ucfirst.php
  1825. * @param str string <p>
  1826. * The input string.
  1827. * </p>
  1828. * @return string the resulting string.
  1829. */
  1830. function ucfirst ($str) {}
  1831. /**
  1832. * Make a string's first character lowercase
  1833. * @link http://www.php.net/manual/en/function.lcfirst.php
  1834. * @param str string <p>
  1835. * The input string.
  1836. * </p>
  1837. * @return string the resulting string.
  1838. */
  1839. function lcfirst ($str) {}
  1840. /**
  1841. * Uppercase the first character of each word in a string
  1842. * @link http://www.php.net/manual/en/function.ucwords.php
  1843. * @param str string <p>
  1844. * The input string.
  1845. * </p>
  1846. * @return string the modified string.
  1847. */
  1848. function ucwords ($str) {}
  1849. /**
  1850. * Translate characters or replace substrings
  1851. * @link http://www.php.net/manual/en/function.strtr.php
  1852. * @param str string <p>
  1853. * The string being translated.
  1854. * </p>
  1855. * @param from string <p>
  1856. * The string being translated to to.
  1857. * </p>
  1858. * @param to string <p>
  1859. * The string replacing from.
  1860. * </p>
  1861. * @return string the translated string.
  1862. * </p>
  1863. * <p>
  1864. * If replace_pairs contains a key which
  1865. * is an empty string (""),
  1866. * false will be returned.
  1867. */
  1868. function strtr ($str, $from, $to) {}
  1869. /**
  1870. * Quote string with slashes
  1871. * @link http://www.php.net/manual/en/function.addslashes.php
  1872. * @param str string <p>
  1873. * The string to be escaped.
  1874. * </p>
  1875. * @return string the escaped string.
  1876. */
  1877. function addslashes ($str) {}
  1878. /**
  1879. * Quote string with slashes in a C style
  1880. * @link http://www.php.net/manual/en/function.addcslashes.php
  1881. * @param str string <p>
  1882. * The string to be escaped.
  1883. * </p>
  1884. * @param charlist string <p>
  1885. * A list of characters to be escaped. If
  1886. * charlist contains characters
  1887. * \n, \r etc., they are
  1888. * converted in C-like style, while other non-alphanumeric characters
  1889. * with ASCII codes lower than 32 and higher than 126 converted to
  1890. * octal representation.
  1891. * </p>
  1892. * <p>
  1893. * When you define a sequence of characters in the charlist argument
  1894. * make sure that you know what characters come between the
  1895. * characters that you set as the start and end of the range.
  1896. * ]]>
  1897. * Also, if the first character in a range has a higher ASCII value
  1898. * than the second character in the range, no range will be
  1899. * constructed. Only the start, end and period characters will be
  1900. * escaped. Use the ord function to find the
  1901. * ASCII value for a character.
  1902. * ]]>
  1903. * </p>
  1904. * <p>
  1905. * Be careful if you choose to escape characters 0, a, b, f, n, r,
  1906. * t and v. They will be converted to \0, \a, \b, \f, \n, \r, \t
  1907. * and \v.
  1908. * In PHP \0 (NULL), \r (carriage return), \n (newline), \f (form feed),
  1909. * \v (vertical tab) and \t (tab) are predefined escape sequences,
  1910. * while in C all of these are predefined escape sequences.
  1911. * </p>
  1912. * @return string the escaped string.
  1913. */
  1914. function addcslashes ($str, $charlist) {}
  1915. /**
  1916. * Strip whitespace (or other characters) from the end of a string
  1917. * @link http://www.php.net/manual/en/function.rtrim.php
  1918. * @param str string <p>
  1919. * The input string.
  1920. * </p>
  1921. * @param charlist string[optional] <p>
  1922. * You can also specify the characters you want to strip, by means
  1923. * of the charlist parameter.
  1924. * Simply list all characters that you want to be stripped. With
  1925. * .. you can specify a range of characters.
  1926. * </p>
  1927. * @return string the modified string.
  1928. */
  1929. function rtrim ($str, $charlist = null) {}
  1930. /**
  1931. * Replace all occurrences of the search string with the replacement string
  1932. * @link http://www.php.net/manual/en/function.str-replace.php
  1933. * @param search mixed <p>
  1934. * The value being searched for, otherwise known as the needle.
  1935. * An array may be used to designate multiple needles.
  1936. * </p>
  1937. * @param replace mixed <p>
  1938. * The replacement value that replaces found search
  1939. * values. An array may be used to designate multiple replacements.
  1940. * </p>
  1941. * @param subject mixed <p>
  1942. * The string or array being searched and replaced on,
  1943. * otherwise known as the haystack.
  1944. * </p>
  1945. * <p>
  1946. * If subject is an array, then the search and
  1947. * replace is performed with every entry of
  1948. * subject, and the return value is an array as
  1949. * well.
  1950. * </p>
  1951. * @param count int[optional] <p>
  1952. * If passed, this will be set to the number of replacements performed.
  1953. * </p>
  1954. * @return mixed This function returns a string or an array with the replaced values.
  1955. */
  1956. function str_replace ($search, $replace, $subject, &$count = null) {}
  1957. /**
  1958. * Case-insensitive version of <function>str_replace</function>.
  1959. * @link http://www.php.net/manual/en/function.str-ireplace.php
  1960. * @param search mixed <p>
  1961. * The value being searched for, otherwise known as the
  1962. * needle. An array may be used to designate
  1963. * multiple needles.
  1964. * </p>
  1965. * @param replace mixed <p>
  1966. * The replacement value that replaces found search
  1967. * values. An array may be used to designate multiple replacements.
  1968. * </p>
  1969. * @param subject mixed <p>
  1970. * The string or array being searched and replaced on,
  1971. * otherwise known as the haystack.
  1972. * </p>
  1973. * <p>
  1974. * If subject is an array, then the search and
  1975. * replace is performed with every entry of
  1976. * subject, and the return value is an array as
  1977. * well.
  1978. * </p>
  1979. * @param count int[optional] <p>
  1980. * If passed, this will be set to the number of replacements performed.
  1981. * </p>
  1982. * @return mixed a string or an array of replacements.
  1983. */
  1984. function str_ireplace ($search, $replace, $subject, &$count = null) {}
  1985. /**
  1986. * Repeat a string
  1987. * @link http://www.php.net/manual/en/function.str-repeat.php
  1988. * @param input string <p>
  1989. * The string to be repeated.
  1990. * </p>
  1991. * @param multiplier int <p>
  1992. * Number of time the input string should be
  1993. * repeated.
  1994. * </p>
  1995. * <p>
  1996. * multiplier has to be greater than or equal to 0.
  1997. * If the multiplier is set to 0, the function
  1998. * will return an empty string.
  1999. * </p>
  2000. * @return string the repeated string.
  2001. */
  2002. function str_repeat ($input, $multiplier) {}
  2003. /**
  2004. * Return information about characters used in a string
  2005. * @link http://www.php.net/manual/en/function.count-chars.php
  2006. * @param string string <p>
  2007. * The examined string.
  2008. * </p>
  2009. * @param mode int[optional] <p>
  2010. * See return values.
  2011. * </p>
  2012. * @return mixed Depending on mode
  2013. * count_chars returns one of the following:
  2014. * 0 - an array with the byte-value as key and the frequency of
  2015. * every byte as value.
  2016. * 1 - same as 0 but only byte-values with a frequency greater
  2017. * than zero are listed.
  2018. * 2 - same as 0 but only byte-values with a frequency equal to
  2019. * zero are listed.
  2020. * 3 - a string containing all unique characters is returned.
  2021. * 4 - a string containing all not used characters is returned.
  2022. */
  2023. function count_chars ($string, $mode = null) {}
  2024. /**
  2025. * Split a string into smaller chunks
  2026. * @link http://www.php.net/manual/en/function.chunk-split.php
  2027. * @param body string <p>
  2028. * The string to be chunked.
  2029. * </p>
  2030. * @param chunklen int[optional] <p>
  2031. * The chunk length.
  2032. * </p>
  2033. * @param end string[optional] <p>
  2034. * The line ending sequence.
  2035. * </p>
  2036. * @return string the chunked string.
  2037. */
  2038. function chunk_split ($body, $chunklen = null, $end = null) {}
  2039. /**
  2040. * Strip whitespace (or other characters) from the beginning and end of a string
  2041. * @link http://www.php.net/manual/en/function.trim.php
  2042. * @param str string <p>
  2043. * The string that will be trimmed.
  2044. * </p>
  2045. * @param charlist string[optional] <p>
  2046. * Optionally, the stripped characters can also be specified using
  2047. * the charlist parameter.
  2048. * Simply list all characters that you want to be stripped. With
  2049. * .. you can specify a range of characters.
  2050. * </p>
  2051. * @return string The trimmed string.
  2052. */
  2053. function trim ($str, $charlist = null) {}
  2054. /**
  2055. * Strip whitespace (or other characters) from the beginning of a string
  2056. * @link http://www.php.net/manual/en/function.ltrim.php
  2057. * @param str string <p>
  2058. * The input string.
  2059. * </p>
  2060. * @param charlist string[optional] <p>
  2061. * You can also specify the characters you want to strip, by means of the
  2062. * charlist parameter.
  2063. * Simply list all characters that you want to be stripped. With
  2064. * .. you can specify a range of characters.
  2065. * </p>
  2066. * @return string This function returns a string with whitespace stripped from the
  2067. * beginning of str.
  2068. * Without the second parameter,
  2069. * ltrim will strip these characters:
  2070. * " " (ASCII 32
  2071. * (0x20)), an ordinary space.
  2072. * "\t" (ASCII 9
  2073. * (0x09)), a tab.
  2074. * "\n" (ASCII 10
  2075. * (0x0A)), a new line (line feed).
  2076. * "\r" (ASCII 13
  2077. * (0x0D)), a carriage return.
  2078. * "\0" (ASCII 0
  2079. * (0x00)), the NUL-byte.
  2080. * "\x0B" (ASCII 11
  2081. * (0x0B)), a vertical tab.
  2082. */
  2083. function ltrim ($str, $charlist = null) {}
  2084. /**
  2085. * Strip HTML and PHP tags from a string
  2086. * @link http://www.php.net/manual/en/function.strip-tags.php
  2087. * @param str string <p>
  2088. * The input string.
  2089. * </p>
  2090. * @param allowable_tags string[optional] <p>
  2091. * You can use the optional second parameter to specify tags which should
  2092. * not be stripped.
  2093. * </p>
  2094. * <p>
  2095. * HTML comments and PHP tags are also stripped. This is hardcoded and
  2096. * can not be changed with allowable_tags.
  2097. * </p>
  2098. * <p>
  2099. * This parameter should not contain whitespace.
  2100. * strip_tags sees a tag as a case-insensitive
  2101. * string between &lt; and the first whitespace or
  2102. * &gt;. It means that
  2103. * strip_tags("&lt;br/&gt;", "&lt;br&gt;") returns an
  2104. * empty string.
  2105. * </p>
  2106. * @return string the stripped string.
  2107. */
  2108. function strip_tags ($str, $allowable_tags = null) {}
  2109. /**
  2110. * Calculate the similarity between two strings
  2111. * @link http://www.php.net/manual/en/function.similar-text.php
  2112. * @param first string <p>
  2113. * The first string.
  2114. * </p>
  2115. * @param second string <p>
  2116. * The second string.
  2117. * </p>
  2118. * @param percent float[optional] <p>
  2119. * By passing a reference as third argument,
  2120. * similar_text will calculate the similarity in
  2121. * percent for you.
  2122. * </p>
  2123. * @return int the number of matching chars in both strings.
  2124. */
  2125. function similar_text ($first, $second, &$percent = null) {}
  2126. /**
  2127. * Split a string by string
  2128. * @link http://www.php.net/manual/en/function.explode.php
  2129. * @param delimiter string <p>
  2130. * The boundary string.
  2131. * </p>
  2132. * @param string string <p>
  2133. * The input string.
  2134. * </p>
  2135. * @param limit int[optional] <p>
  2136. * If limit is set and positive, the returned array will contain
  2137. * a maximum of limit elements with the last
  2138. * element containing the rest of string.
  2139. * </p>
  2140. * <p>
  2141. * If the limit parameter is negative, all components
  2142. * except the last -limit are returned.
  2143. * </p>
  2144. * <p>
  2145. * If the limit parameter is zero, then this is treated as 1.
  2146. * </p>
  2147. * @return array an array of strings
  2148. * created by splitting the string parameter on
  2149. * boundaries formed by the delimiter.
  2150. * </p>
  2151. * <p>
  2152. * If delimiter is an empty string (""),
  2153. * explode will return false.
  2154. * If delimiter contains a value that is not
  2155. * contained in string and a negative
  2156. * limit is used, then an empty array will be
  2157. * returned, otherwise an array containing
  2158. * string will be returned.
  2159. */
  2160. function explode ($delimiter, $string, $limit = null) {}
  2161. /**
  2162. * Join array elements with a string
  2163. * @link http://www.php.net/manual/en/function.implode.php
  2164. * @param glue string <p>
  2165. * Defaults to an empty string. This is not the preferred usage of
  2166. * implode as glue would be
  2167. * the second parameter and thus, the bad prototype would be used.
  2168. * </p>
  2169. * @param pieces array <p>
  2170. * The array of strings to implode.
  2171. * </p>
  2172. * @return string a string containing a string representation of all the array
  2173. * elements in the same order, with the glue string between each element.
  2174. */
  2175. function implode ($glue, array $pieces) {}
  2176. /**
  2177. * &Alias; <function>implode</function>
  2178. * @link http://www.php.net/manual/en/function.join.php
  2179. * @param glue
  2180. * @param pieces
  2181. */
  2182. function join ($glue, $pieces) {}
  2183. /**
  2184. * Set locale information
  2185. * @link http://www.php.net/manual/en/function.setlocale.php
  2186. * @param category int <p>
  2187. * category is a named constant specifying the
  2188. * category of the functions affected by the locale setting:
  2189. * LC_ALL for all of the below
  2190. * @param locale string <p>
  2191. * If locale is &null; or the empty string
  2192. * "", the locale names will be set from the
  2193. * values of environment variables with the same names as the above
  2194. * categories, or from "LANG".
  2195. * </p>
  2196. * <p>
  2197. * If locale is "0",
  2198. * the locale setting is not affected, only the current setting is returned.
  2199. * </p>
  2200. * <p>
  2201. * If locale is an array or followed by additional
  2202. * parameters then each array element or parameter is tried to be set as
  2203. * new locale until success. This is useful if a locale is known under
  2204. * different names on different systems or for providing a fallback
  2205. * for a possibly not available locale.
  2206. * </p>
  2207. * @param _ string[optional]
  2208. * @return string the new current locale, or false if the locale functionality is
  2209. * not implemented on your platform, the specified locale does not exist or
  2210. * the category name is invalid.
  2211. * </p>
  2212. * <p>
  2213. * An invalid category name also causes a warning message. Category/locale
  2214. * names can be found in RFC 1766
  2215. * and ISO 639.
  2216. * Different systems have different naming schemes for locales.
  2217. * </p>
  2218. * <p>
  2219. * The return value of setlocale depends
  2220. * on the system that PHP is running. It returns exactly
  2221. * what the system setlocale function returns.
  2222. */
  2223. function setlocale ($category, $locale, $_ = null) {}
  2224. /**
  2225. * Get numeric formatting information
  2226. * @link http://www.php.net/manual/en/function.localeconv.php
  2227. * @return array localeconv returns data based upon the current locale
  2228. * as set by setlocale. The associative array that is
  2229. * returned contains the following fields:
  2230. * <tr valign="top">
  2231. * <td>Array element</td>
  2232. * <td>Description</td>
  2233. * </tr>
  2234. * <tr valign="top">
  2235. * <td>decimal_point</td>
  2236. * <td>Decimal point character</td>
  2237. * </tr>
  2238. * <tr valign="top">
  2239. * <td>thousands_sep</td>
  2240. * <td>Thousands separator</td>
  2241. * </tr>
  2242. * <tr valign="top">
  2243. * <td>grouping</td>
  2244. * <td>Array containing numeric groupings</td>
  2245. * </tr>
  2246. * <tr valign="top">
  2247. * <td>int_curr_symbol</td>
  2248. * <td>International currency symbol (i.e. USD)</td>
  2249. * </tr>
  2250. * <tr valign="top">
  2251. * <td>currency_symbol</td>
  2252. * <td>Local currency symbol (i.e. $)</td>
  2253. * </tr>
  2254. * <tr valign="top">
  2255. * <td>mon_decimal_point</td>
  2256. * <td>Monetary decimal point character</td>
  2257. * </tr>
  2258. * <tr valign="top">
  2259. * <td>mon_thousands_sep</td>
  2260. * <td>Monetary thousands separator</td>
  2261. * </tr>
  2262. * <tr valign="top">
  2263. * <td>mon_grouping</td>
  2264. * <td>Array containing monetary groupings</td>
  2265. * </tr>
  2266. * <tr valign="top">
  2267. * <td>positive_sign</td>
  2268. * <td>Sign for positive values</td>
  2269. * </tr>
  2270. * <tr valign="top">
  2271. * <td>negative_sign</td>
  2272. * <td>Sign for negative values</td>
  2273. * </tr>
  2274. * <tr valign="top">
  2275. * <td>int_frac_digits</td>
  2276. * <td>International fractional digits</td>
  2277. * </tr>
  2278. * <tr valign="top">
  2279. * <td>frac_digits</td>
  2280. * <td>Local fractional digits</td>
  2281. * </tr>
  2282. * <tr valign="top">
  2283. * <td>p_cs_precedes</td>
  2284. * <td>
  2285. * true if currency_symbol precedes a positive value, false
  2286. * if it succeeds one
  2287. * </td>
  2288. * </tr>
  2289. * <tr valign="top">
  2290. * <td>p_sep_by_space</td>
  2291. * <td>
  2292. * true if a space separates currency_symbol from a positive
  2293. * value, false otherwise
  2294. * </td>
  2295. * </tr>
  2296. * <tr valign="top">
  2297. * <td>n_cs_precedes</td>
  2298. * <td>
  2299. * true if currency_symbol precedes a negative value, false
  2300. * if it succeeds one
  2301. * </td>
  2302. * </tr>
  2303. * <tr valign="top">
  2304. * <td>n_sep_by_space</td>
  2305. * <td>
  2306. * true if a space separates currency_symbol from a negative
  2307. * value, false otherwise
  2308. * </td>
  2309. * </tr>
  2310. * <td>p_sign_posn</td>
  2311. * <td>
  2312. * 0 - Parentheses surround the quantity and currency_symbol
  2313. * 1 - The sign string precedes the quantity and currency_symbol
  2314. * 2 - The sign string succeeds the quantity and currency_symbol
  2315. * 3 - The sign string immediately precedes the currency_symbol
  2316. * 4 - The sign string immediately succeeds the currency_symbol
  2317. * </td>
  2318. * </tr>
  2319. * <td>n_sign_posn</td>
  2320. * <td>
  2321. * 0 - Parentheses surround the quantity and currency_symbol
  2322. * 1 - The sign string precedes the quantity and currency_symbol
  2323. * 2 - The sign string succeeds the quantity and currency_symbol
  2324. * 3 - The sign string immediately precedes the currency_symbol
  2325. * 4 - The sign string immediately succeeds the currency_symbol
  2326. * </td>
  2327. * </tr>
  2328. * </p>
  2329. * <p>
  2330. * The p_sign_posn, and n_sign_posn contain a string
  2331. * of formatting options. Each number representing one of the above listed conditions.
  2332. * </p>
  2333. * <p>
  2334. * The grouping fields contain arrays that define the way numbers should be
  2335. * grouped. For example, the monetary grouping field for the nl_NL locale (in
  2336. * UTF-8 mode with the euro sign), would contain a 2 item array with the
  2337. * values 3 and 3. The higher the index in the array, the farther left the
  2338. * grouping is. If an array element is equal to CHAR_MAX,
  2339. * no further grouping is done. If an array element is equal to 0, the previous
  2340. * element should be used.
  2341. */
  2342. function localeconv () {}
  2343. /**
  2344. * Query language and locale information
  2345. * @link http://www.php.net/manual/en/function.nl-langinfo.php
  2346. * @param item int <p>
  2347. * item may be an integer value of the element or the
  2348. * constant name of the element. The following is a list of constant names
  2349. * for item that may be used and their description.
  2350. * Some of these constants may not be defined or hold no value for certain
  2351. * locales.
  2352. * <table>
  2353. * nl_langinfo Constants
  2354. * <tr valign="top">
  2355. * <td>Constant</td>
  2356. * <td>Description</td>
  2357. * </tr>
  2358. * <tr valign="top">
  2359. * LC_TIME Category Constants</td>
  2360. * </tr>
  2361. * <tr valign="top">
  2362. * <td>ABDAY_(1-7)</td>
  2363. * <td>Abbreviated name of n-th day of the week.</td>
  2364. * </tr>
  2365. * <tr valign="top">
  2366. * <td>DAY_(1-7)</td>
  2367. * <td>Name of the n-th day of the week (DAY_1 = Sunday).</td>
  2368. * </tr>
  2369. * <tr valign="top">
  2370. * <td>ABMON_(1-12)</td>
  2371. * <td>Abbreviated name of the n-th month of the year.</td>
  2372. * </tr>
  2373. * <tr valign="top">
  2374. * <td>MON_(1-12)</td>
  2375. * <td>Name of the n-th month of the year.</td>
  2376. * </tr>
  2377. * <tr valign="top">
  2378. * <td>AM_STR</td>
  2379. * <td>String for Ante meridian.</td>
  2380. * </tr>
  2381. * <tr valign="top">
  2382. * <td>PM_STR</td>
  2383. * <td>String for Post meridian.</td>
  2384. * </tr>
  2385. * <tr valign="top">
  2386. * <td>D_T_FMT</td>
  2387. * <td>String that can be used as the format string for strftime to represent time and date.</td>
  2388. * </tr>
  2389. * <tr valign="top">
  2390. * <td>D_FMT</td>
  2391. * <td>String that can be used as the format string for strftime to represent date.</td>
  2392. * </tr>
  2393. * <tr valign="top">
  2394. * <td>T_FMT</td>
  2395. * <td>String that can be used as the format string for strftime to represent time.</td>
  2396. * </tr>
  2397. * <tr valign="top">
  2398. * <td>T_FMT_AMPM</td>
  2399. * <td>String that can be used as the format string for strftime to represent time in 12-hour format with ante/post meridian.</td>
  2400. * </tr>
  2401. * <tr valign="top">
  2402. * <td>ERA</td>
  2403. * <td>Alternate era.</td>
  2404. * </tr>
  2405. * <tr valign="top">
  2406. * <td>ERA_YEAR</td>
  2407. * <td>Year in alternate era format.</td>
  2408. * </tr>
  2409. * <tr valign="top">
  2410. * <td>ERA_D_T_FMT</td>
  2411. * <td>Date and time in alternate era format (string can be used in strftime).</td>
  2412. * </tr>
  2413. * <tr valign="top">
  2414. * <td>ERA_D_FMT</td>
  2415. * <td>Date in alternate era format (string can be used in strftime).</td>
  2416. * </tr>
  2417. * <tr valign="top">
  2418. * <td>ERA_T_FMT</td>
  2419. * <td>Time in alternate era format (string can be used in strftime).</td>
  2420. * </tr>
  2421. * <tr valign="top">
  2422. * LC_MONETARY Category Constants</td>
  2423. * </tr>
  2424. * <tr valign="top">
  2425. * <td>INT_CURR_SYMBOL</td>
  2426. * <td>International currency symbol.</td>
  2427. * </tr>
  2428. * <tr valign="top">
  2429. * <td>CURRENCY_SYMBOL</td>
  2430. * <td>Local currency symbol.</td>
  2431. * </tr>
  2432. * <tr valign="top">
  2433. * <td>CRNCYSTR</td>
  2434. * <td>Same value as CURRENCY_SYMBOL.</td>
  2435. * </tr>
  2436. * <tr valign="top">
  2437. * <td>MON_DECIMAL_POINT</td>
  2438. * <td>Decimal point character.</td>
  2439. * </tr>
  2440. * <tr valign="top">
  2441. * <td>MON_THOUSANDS_SEP</td>
  2442. * <td>Thousands separator (groups of three digits).</td>
  2443. * </tr>
  2444. * <tr valign="top">
  2445. * <td>MON_GROUPING</td>
  2446. * <td>Like "grouping" element.</td>
  2447. * </tr>
  2448. * <tr valign="top">
  2449. * <td>POSITIVE_SIGN</td>
  2450. * <td>Sign for positive values.</td>
  2451. * </tr>
  2452. * <tr valign="top">
  2453. * <td>NEGATIVE_SIGN</td>
  2454. * <td>Sign for negative values.</td>
  2455. * </tr>
  2456. * <tr valign="top">
  2457. * <td>INT_FRAC_DIGITS</td>
  2458. * <td>International fractional digits.</td>
  2459. * </tr>
  2460. * <tr valign="top">
  2461. * <td>FRAC_DIGITS</td>
  2462. * <td>Local fractional digits.</td>
  2463. * </tr>
  2464. * <tr valign="top">
  2465. * <td>P_CS_PRECEDES</td>
  2466. * <td>Returns 1 if CURRENCY_SYMBOL precedes a positive value.</td>
  2467. * </tr>
  2468. * <tr valign="top">
  2469. * <td>P_SEP_BY_SPACE</td>
  2470. * <td>Returns 1 if a space separates CURRENCY_SYMBOL from a positive value.</td>
  2471. * </tr>
  2472. * <tr valign="top">
  2473. * <td>N_CS_PRECEDES</td>
  2474. * <td>Returns 1 if CURRENCY_SYMBOL precedes a negative value.</td>
  2475. * </tr>
  2476. * <tr valign="top">
  2477. * <td>N_SEP_BY_SPACE</td>
  2478. * <td>Returns 1 if a space separates CURRENCY_SYMBOL from a negative value.</td>
  2479. * </tr>
  2480. * <tr valign="top">
  2481. * <td>P_SIGN_POSN</td>
  2482. * Returns 0 if parentheses surround the quantity and CURRENCY_SYMBOL.
  2483. * @return string the element as a string, or false if item
  2484. * is not valid.
  2485. */
  2486. function nl_langinfo ($item) {}
  2487. /**
  2488. * Calculate the soundex key of a string
  2489. * @link http://www.php.net/manual/en/function.soundex.php
  2490. * @param str string <p>
  2491. * The input string.
  2492. * </p>
  2493. * @return string the soundex key as a string.
  2494. */
  2495. function soundex ($str) {}
  2496. /**
  2497. * Calculate Levenshtein distance between two strings
  2498. * @link http://www.php.net/manual/en/function.levenshtein.php
  2499. * @param str1 string <p>
  2500. * One of the strings being evaluated for Levenshtein distance.
  2501. * </p>
  2502. * @param str2 string <p>
  2503. * One of the strings being evaluated for Levenshtein distance.
  2504. * </p>
  2505. * @return int This function returns the Levenshtein-Distance between the
  2506. * two argument strings or -1, if one of the argument strings
  2507. * is longer than the limit of 255 characters.
  2508. */
  2509. function levenshtein ($str1, $str2) {}
  2510. /**
  2511. * Return a specific character
  2512. * @link http://www.php.net/manual/en/function.chr.php
  2513. * @param ascii int <p>
  2514. * The ascii code.
  2515. * </p>
  2516. * @return string the specified character.
  2517. */
  2518. function chr ($ascii) {}
  2519. /**
  2520. * Return ASCII value of character
  2521. * @link http://www.php.net/manual/en/function.ord.php
  2522. * @param string string <p>
  2523. * A character.
  2524. * </p>
  2525. * @return int the ASCII value as an integer.
  2526. */
  2527. function ord ($string) {}
  2528. /**
  2529. * Parses the string into variables
  2530. * @link http://www.php.net/manual/en/function.parse-str.php
  2531. * @param str string <p>
  2532. * The input string.
  2533. * </p>
  2534. * @param arr array[optional] <p>
  2535. * If the second parameter arr is present,
  2536. * variables are stored in this variable as array elements instead.
  2537. * </p>
  2538. * @return void
  2539. */
  2540. function parse_str ($str, array &$arr = null) {}
  2541. /**
  2542. * Parse a CSV string into an array
  2543. * @link http://www.php.net/manual/en/function.str-getcsv.php
  2544. * @param input string <p>
  2545. * The string to parse.
  2546. * </p>
  2547. * @param delimiter string[optional] <p>
  2548. * Set the field delimiter (one character only).
  2549. * </p>
  2550. * @param enclosure string[optional] <p>
  2551. * Set the field enclosure character (one character only).
  2552. * </p>
  2553. * @param escape string[optional] <p>
  2554. * Set the escape character (one character only). Defaults as a backslash
  2555. * (\)
  2556. * </p>
  2557. * @return array an indexed array containing the fields read.
  2558. */
  2559. function str_getcsv ($input, $delimiter = null, $enclosure = null, $escape = null) {}
  2560. /**
  2561. * Pad a string to a certain length with another string
  2562. * @link http://www.php.net/manual/en/function.str-pad.php
  2563. * @param input string <p>
  2564. * The input string.
  2565. * </p>
  2566. * @param pad_length int <p>
  2567. * If the value of pad_length is negative,
  2568. * less than, or equal to the length of the input string, no padding
  2569. * takes place.
  2570. * </p>
  2571. * @param pad_string string[optional] <p>
  2572. * The pad_string may be truncated if the
  2573. * required number of padding characters can't be evenly divided by the
  2574. * pad_string's length.
  2575. * </p>
  2576. * @param pad_type int[optional] <p>
  2577. * Optional argument pad_type can be
  2578. * STR_PAD_RIGHT, STR_PAD_LEFT,
  2579. * or STR_PAD_BOTH. If
  2580. * pad_type is not specified it is assumed to be
  2581. * STR_PAD_RIGHT.
  2582. * </p>
  2583. * @return string the padded string.
  2584. */
  2585. function str_pad ($input, $pad_length, $pad_string = null, $pad_type = null) {}
  2586. /**
  2587. * &Alias; <function>rtrim</function>
  2588. * @link http://www.php.net/manual/en/function.chop.php
  2589. * @param str
  2590. * @param character_mask[optional]
  2591. */
  2592. function chop ($str, $character_mask) {}
  2593. /**
  2594. * &Alias; <function>strstr</function>
  2595. * @link http://www.php.net/manual/en/function.strchr.php
  2596. * @param haystack
  2597. * @param needle
  2598. * @param part[optional]
  2599. */
  2600. function strchr ($haystack, $needle, $part) {}
  2601. /**
  2602. * Return a formatted string
  2603. * @link http://www.php.net/manual/en/function.sprintf.php
  2604. * @param format string <p>
  2605. * The format string is composed of zero or more directives:
  2606. * ordinary characters (excluding %) that are
  2607. * copied directly to the result, and conversion
  2608. * specifications, each of which results in fetching its
  2609. * own parameter. This applies to both sprintf
  2610. * and printf.
  2611. * </p>
  2612. * <p>
  2613. * Each conversion specification consists of a percent sign
  2614. * (%), followed by one or more of these
  2615. * elements, in order:
  2616. * An optional sign specifier that forces a sign
  2617. * (- or +) to be used on a number. By default, only the - sign is used
  2618. * on a number if it's negative. This specifier forces positive numbers
  2619. * to have the + sign attached as well, and was added in PHP 4.3.0.
  2620. * @param args mixed[optional] <p>
  2621. * </p>
  2622. * @param _ mixed[optional]
  2623. * @return string a string produced according to the formatting string
  2624. * format.
  2625. */
  2626. function sprintf ($format, $args = null, $_ = null) {}
  2627. /**
  2628. * Output a formatted string
  2629. * @link http://www.php.net/manual/en/function.printf.php
  2630. * @param format string <p>
  2631. * See sprintf for a description of
  2632. * format.
  2633. * </p>
  2634. * @param args mixed[optional] <p>
  2635. * </p>
  2636. * @param _ mixed[optional]
  2637. * @return int the length of the outputted string.
  2638. */
  2639. function printf ($format, $args = null, $_ = null) {}
  2640. /**
  2641. * Output a formatted string
  2642. * @link http://www.php.net/manual/en/function.vprintf.php
  2643. * @param format string <p>
  2644. * See sprintf for a description of
  2645. * format.
  2646. * </p>
  2647. * @param args array <p>
  2648. * </p>
  2649. * @return int the length of the outputted string.
  2650. */
  2651. function vprintf ($format, array $args) {}
  2652. /**
  2653. * Return a formatted string
  2654. * @link http://www.php.net/manual/en/function.vsprintf.php
  2655. * @param format string <p>
  2656. * See sprintf for a description of
  2657. * format.
  2658. * </p>
  2659. * @param args array <p>
  2660. * </p>
  2661. * @return string Return array values as a formatted string according to
  2662. * format (which is described in the documentation
  2663. * for sprintf).
  2664. */
  2665. function vsprintf ($format, array $args) {}
  2666. /**
  2667. * Write a formatted string to a stream
  2668. * @link http://www.php.net/manual/en/function.fprintf.php
  2669. * @param handle resource &fs.file.pointer;
  2670. * @param format string <p>
  2671. * See sprintf for a description of
  2672. * format.
  2673. * </p>
  2674. * @param args mixed[optional] <p>
  2675. * </p>
  2676. * @param _ mixed[optional]
  2677. * @return int the length of the string written.
  2678. */
  2679. function fprintf ($handle, $format, $args = null, $_ = null) {}
  2680. /**
  2681. * Write a formatted string to a stream
  2682. * @link http://www.php.net/manual/en/function.vfprintf.php
  2683. * @param handle resource <p>
  2684. * </p>
  2685. * @param format string <p>
  2686. * See sprintf for a description of
  2687. * format.
  2688. * </p>
  2689. * @param args array <p>
  2690. * </p>
  2691. * @return int the length of the outputted string.
  2692. */
  2693. function vfprintf ($handle, $format, array $args) {}
  2694. /**
  2695. * Parses input from a string according to a format
  2696. * @link http://www.php.net/manual/en/function.sscanf.php
  2697. * @param str string <p>
  2698. * The input string being parsed.
  2699. * </p>
  2700. * @param format string <p>
  2701. * The interpreted format for str, which is
  2702. * described in the documentation for sprintf with
  2703. * following differences:
  2704. * Function is not locale-aware.
  2705. * F, g, G and
  2706. * b are not supported.
  2707. * D stands for decimal number.
  2708. * i stands for integer with base detection.
  2709. * n stands for number of characters processed so far.
  2710. * </p>
  2711. * @param _ mixed[optional]
  2712. * @return mixed If only two parameters were passed to this function, the values parsed will
  2713. * be returned as an array. Otherwise, if optional parameters are passed, the
  2714. * function will return the number of assigned values. The optional parameters
  2715. * must be passed by reference.
  2716. * </p>
  2717. * <p>
  2718. * If there are more substrings expected in the format
  2719. * than there are available within str,
  2720. * -1 will be returned.
  2721. */
  2722. function sscanf ($str, $format, &$_ = null) {}
  2723. /**
  2724. * Parses input from a file according to a format
  2725. * @link http://www.php.net/manual/en/function.fscanf.php
  2726. * @param handle resource &fs.file.pointer;
  2727. * @param format string <p>
  2728. * The specified format as described in the
  2729. * sprintf documentation.
  2730. * </p>
  2731. * @param _ mixed[optional]
  2732. * @return mixed If only two parameters were passed to this function, the values parsed will be
  2733. * returned as an array. Otherwise, if optional parameters are passed, the
  2734. * function will return the number of assigned values. The optional
  2735. * parameters must be passed by reference.
  2736. */
  2737. function fscanf ($handle, $format, &$_ = null) {}
  2738. /**
  2739. * Parse a URL and return its components
  2740. * @link http://www.php.net/manual/en/function.parse-url.php
  2741. * @param url string <p>
  2742. * The URL to parse. Invalid characters are replaced by
  2743. * _.
  2744. * </p>
  2745. * @param component int[optional] <p>
  2746. * Specify one of PHP_URL_SCHEME,
  2747. * PHP_URL_HOST, PHP_URL_PORT,
  2748. * PHP_URL_USER, PHP_URL_PASS,
  2749. * PHP_URL_PATH, PHP_URL_QUERY
  2750. * or PHP_URL_FRAGMENT to retrieve just a specific
  2751. * URL component as a string (except when
  2752. * PHP_URL_PORT is given, in which case the return
  2753. * value will be an integer).
  2754. * </p>
  2755. * @return mixed On seriously malformed URLs, parse_url may return
  2756. * false.
  2757. * </p>
  2758. * <p>
  2759. * If the component parameter is omitted, an
  2760. * associative array is returned. At least one element will be
  2761. * present within the array. Potential keys within this array are:
  2762. * scheme - e.g. http
  2763. * host
  2764. * port
  2765. * user
  2766. * pass
  2767. * path
  2768. * query - after the question mark ?
  2769. * fragment - after the hashmark #
  2770. * </p>
  2771. * <p>
  2772. * If the component parameter is specified,
  2773. * parse_url returns a string (or an
  2774. * integer, in the case of PHP_URL_PORT)
  2775. * instead of an array. If the requested component doesn't exist
  2776. * within the given URL, &null; will be returned.
  2777. */
  2778. function parse_url ($url, $component = null) {}
  2779. /**
  2780. * URL-encodes string
  2781. * @link http://www.php.net/manual/en/function.urlencode.php
  2782. * @param str string <p>
  2783. * The string to be encoded.
  2784. * </p>
  2785. * @return string a string in which all non-alphanumeric characters except
  2786. * -_. have been replaced with a percent
  2787. * (%) sign followed by two hex digits and spaces encoded
  2788. * as plus (+) signs. It is encoded the same way that the
  2789. * posted data from a WWW form is encoded, that is the same way as in
  2790. * application/x-www-form-urlencoded media type. This
  2791. * differs from the RFC 3986 encoding (see
  2792. * rawurlencode) in that for historical reasons, spaces
  2793. * are encoded as plus (+) signs.
  2794. */
  2795. function urlencode ($str) {}
  2796. /**
  2797. * Decodes URL-encoded string
  2798. * @link http://www.php.net/manual/en/function.urldecode.php
  2799. * @param str string <p>
  2800. * The string to be decoded.
  2801. * </p>
  2802. * @return string the decoded string.
  2803. */
  2804. function urldecode ($str) {}
  2805. /**
  2806. * URL-encode according to RFC 3986
  2807. * @link http://www.php.net/manual/en/function.rawurlencode.php
  2808. * @param str string <p>
  2809. * The URL to be encoded.
  2810. * </p>
  2811. * @return string a string in which all non-alphanumeric characters except
  2812. * -_.~ have been replaced with a percent
  2813. * (%) sign followed by two hex digits. This is the
  2814. * encoding described in RFC 3986 for
  2815. * protecting literal characters from being interpreted as special URL
  2816. * delimiters, and for protecting URLs from being mangled by transmission
  2817. * media with character conversions (like some email systems).
  2818. * <p>
  2819. * Prior to PHP 5.3.0, rawurlencode encoded tildes (~) as per
  2820. * RFC 1738.
  2821. * </p>
  2822. */
  2823. function rawurlencode ($str) {}
  2824. /**
  2825. * Decode URL-encoded strings
  2826. * @link http://www.php.net/manual/en/function.rawurldecode.php
  2827. * @param str string <p>
  2828. * The URL to be decoded.
  2829. * </p>
  2830. * @return string the decoded URL, as a string.
  2831. */
  2832. function rawurldecode ($str) {}
  2833. /**
  2834. * Generate URL-encoded query string
  2835. * @link http://www.php.net/manual/en/function.http-build-query.php
  2836. * @param query_data mixed <p>
  2837. * May be an array or object containing properties.
  2838. * </p>
  2839. * <p>
  2840. * If query_data is an array, it may be a simple
  2841. * one-dimensional structure, or an array of arrays (which in
  2842. * turn may contain other arrays).
  2843. * </p>
  2844. * <p>
  2845. * If query_data is an object, then only public
  2846. * properties will be incorporated into the result.
  2847. * </p>
  2848. * @param numeric_prefix string[optional] <p>
  2849. * If numeric indices are used in the base array and this parameter is
  2850. * provided, it will be prepended to the numeric index for elements in
  2851. * the base array only.
  2852. * </p>
  2853. * <p>
  2854. * This is meant to allow for legal variable names when the data is
  2855. * decoded by PHP or another CGI application later on.
  2856. * </p>
  2857. * @param arg_separator string[optional] <p>
  2858. * arg_separator.output
  2859. * is used to separate arguments, unless this parameter is specified,
  2860. * and is then used.
  2861. * </p>
  2862. * @param enc_type int[optional] <p>
  2863. * By default, PHP_QUERY_RFC1738.
  2864. * </p>
  2865. * <p>
  2866. * If enc_type is
  2867. * PHP_QUERY_RFC1738, then encoding is performed per
  2868. * RFC 1738 and the
  2869. * application/x-www-form-urlencoded media type, which
  2870. * implies that spaces are encoded as plus (+) signs.
  2871. * </p>
  2872. * <p>
  2873. * If enc_type is
  2874. * PHP_QUERY_RFC3986, then encoding is performed
  2875. * according to RFC 3986, and
  2876. * spaces will be percent encoded (%20).
  2877. * </p>
  2878. * @return string a URL-encoded string.
  2879. */
  2880. function http_build_query ($query_data, $numeric_prefix = null, $arg_separator = null, $enc_type = null) {}
  2881. /**
  2882. * Returns the target of a symbolic link
  2883. * @link http://www.php.net/manual/en/function.readlink.php
  2884. * @param path string <p>
  2885. * The symbolic link path.
  2886. * </p>
  2887. * @return string the contents of the symbolic link path or false on error.
  2888. */
  2889. function readlink ($path) {}
  2890. /**
  2891. * Gets information about a link
  2892. * @link http://www.php.net/manual/en/function.linkinfo.php
  2893. * @param path string <p>
  2894. * Path to the link.
  2895. * </p>
  2896. * @return int linkinfo returns the st_dev field
  2897. * of the Unix C stat structure returned by the lstat
  2898. * system call. Returns 0 or false in case of error.
  2899. */
  2900. function linkinfo ($path) {}
  2901. /**
  2902. * Creates a symbolic link
  2903. * @link http://www.php.net/manual/en/function.symlink.php
  2904. * @param target string <p>
  2905. * Target of the link.
  2906. * </p>
  2907. * @param link string <p>
  2908. * The link name.
  2909. * </p>
  2910. * @return bool Returns true on success or false on failure.
  2911. */
  2912. function symlink ($target, $link) {}
  2913. /**
  2914. * Create a hard link
  2915. * @link http://www.php.net/manual/en/function.link.php
  2916. * @param target string <p>
  2917. * Target of the link.
  2918. * </p>
  2919. * @param link string <p>
  2920. * The link name.
  2921. * </p>
  2922. * @return bool Returns true on success or false on failure.
  2923. */
  2924. function link ($target, $link) {}
  2925. /**
  2926. * Deletes a file
  2927. * @link http://www.php.net/manual/en/function.unlink.php
  2928. * @param filename string <p>
  2929. * Path to the file.
  2930. * </p>
  2931. * @param context resource[optional] &note.context-support;
  2932. * @return bool Returns true on success or false on failure.
  2933. */
  2934. function unlink ($filename, $context = null) {}
  2935. /**
  2936. * Execute an external program
  2937. * @link http://www.php.net/manual/en/function.exec.php
  2938. * @param command string <p>
  2939. * The command that will be executed.
  2940. * </p>
  2941. * @param output array[optional] <p>
  2942. * If the output argument is present, then the
  2943. * specified array will be filled with every line of output from the
  2944. * command. Trailing whitespace, such as \n, is not
  2945. * included in this array. Note that if the array already contains some
  2946. * elements, exec will append to the end of the array.
  2947. * If you do not want the function to append elements, call
  2948. * unset on the array before passing it to
  2949. * exec.
  2950. * </p>
  2951. * @param return_var int[optional] <p>
  2952. * If the return_var argument is present
  2953. * along with the output argument, then the
  2954. * return status of the executed command will be written to this
  2955. * variable.
  2956. * </p>
  2957. * @return string The last line from the result of the command. If you need to execute a
  2958. * command and have all the data from the command passed directly back without
  2959. * any interference, use the passthru function.
  2960. * </p>
  2961. * <p>
  2962. * To get the output of the executed command, be sure to set and use the
  2963. * output parameter.
  2964. */
  2965. function exec ($command, array &$output = null, &$return_var = null) {}
  2966. /**
  2967. * Execute an external program and display the output
  2968. * @link http://www.php.net/manual/en/function.system.php
  2969. * @param command string <p>
  2970. * The command that will be executed.
  2971. * </p>
  2972. * @param return_var int[optional] <p>
  2973. * If the return_var argument is present, then the
  2974. * return status of the executed command will be written to this
  2975. * variable.
  2976. * </p>
  2977. * @return string the last line of the command output on success, and false
  2978. * on failure.
  2979. */
  2980. function system ($command, &$return_var = null) {}
  2981. /**
  2982. * Escape shell metacharacters
  2983. * @link http://www.php.net/manual/en/function.escapeshellcmd.php
  2984. * @param command string <p>
  2985. * The command that will be escaped.
  2986. * </p>
  2987. * @return string The escaped string.
  2988. */
  2989. function escapeshellcmd ($command) {}
  2990. /**
  2991. * Escape a string to be used as a shell argument
  2992. * @link http://www.php.net/manual/en/function.escapeshellarg.php
  2993. * @param arg string <p>
  2994. * The argument that will be escaped.
  2995. * </p>
  2996. * @return string The escaped string.
  2997. */
  2998. function escapeshellarg ($arg) {}
  2999. /**
  3000. * Execute an external program and display raw output
  3001. * @link http://www.php.net/manual/en/function.passthru.php
  3002. * @param command string <p>
  3003. * The command that will be executed.
  3004. * </p>
  3005. * @param return_var int[optional] <p>
  3006. * If the return_var argument is present, the
  3007. * return status of the Unix command will be placed here.
  3008. * </p>
  3009. * @return void
  3010. */
  3011. function passthru ($command, &$return_var = null) {}
  3012. /**
  3013. * Execute command via shell and return the complete output as a string
  3014. * @link http://www.php.net/manual/en/function.shell-exec.php
  3015. * @param cmd string <p>
  3016. * The command that will be executed.
  3017. * </p>
  3018. * @return string The output from the executed command or &null; if an error occurred.
  3019. */
  3020. function shell_exec ($cmd) {}
  3021. /**
  3022. * Execute a command and open file pointers for input/output
  3023. * @link http://www.php.net/manual/en/function.proc-open.php
  3024. * @param cmd string <p>
  3025. * The command to execute
  3026. * </p>
  3027. * @param descriptorspec array <p>
  3028. * An indexed array where the key represents the descriptor number and the
  3029. * value represents how PHP will pass that descriptor to the child
  3030. * process. 0 is stdin, 1 is stdout, while 2 is stderr.
  3031. * </p>
  3032. * <p>
  3033. * Each element can be:
  3034. * An array describing the pipe to pass to the process. The first
  3035. * element is the descriptor type and the second element is an option for
  3036. * the given type. Valid types are pipe (the second
  3037. * element is either r to pass the read end of the pipe
  3038. * to the process, or w to pass the write end) and
  3039. * file (the second element is a filename).
  3040. * A stream resource representing a real file descriptor (e.g. opened file,
  3041. * a socket, STDIN).
  3042. * </p>
  3043. * <p>
  3044. * The file descriptor numbers are not limited to 0, 1 and 2 - you may
  3045. * specify any valid file descriptor number and it will be passed to the
  3046. * child process. This allows your script to interoperate with other
  3047. * scripts that run as "co-processes". In particular, this is useful for
  3048. * passing passphrases to programs like PGP, GPG and openssl in a more
  3049. * secure manner. It is also useful for reading status information
  3050. * provided by those programs on auxiliary file descriptors.
  3051. * </p>
  3052. * @param pipes array <p>
  3053. * Will be set to an indexed array of file pointers that correspond to
  3054. * PHP's end of any pipes that are created.
  3055. * </p>
  3056. * @param cwd string[optional] <p>
  3057. * The initial working dir for the command. This must be an
  3058. * absolute directory path, or &null;
  3059. * if you want to use the default value (the working dir of the current
  3060. * PHP process)
  3061. * </p>
  3062. * @param env array[optional] <p>
  3063. * An array with the environment variables for the command that will be
  3064. * run, or &null; to use the same environment as the current PHP process
  3065. * </p>
  3066. * @param other_options array[optional] <p>
  3067. * Allows you to specify additional options. Currently supported options
  3068. * include:
  3069. * suppress_errors (windows only): suppresses errors
  3070. * generated by this function when it's set to true
  3071. * bypass_shell (windows only): bypass
  3072. * cmd.exe shell when set to true
  3073. * </p>
  3074. * @return resource a resource representing the process, which should be freed using
  3075. * proc_close when you are finished with it. On failure
  3076. * returns false.
  3077. */
  3078. function proc_open ($cmd, array $descriptorspec, array &$pipes, $cwd = null, array $env = null, array $other_options = null) {}
  3079. /**
  3080. * Close a process opened by <function>proc_open</function> and return the exit code of that process
  3081. * @link http://www.php.net/manual/en/function.proc-close.php
  3082. * @param process resource <p>
  3083. * The proc_open resource that will
  3084. * be closed.
  3085. * </p>
  3086. * @return int the termination status of the process that was run. In case of
  3087. * an error then -1 is returned.
  3088. */
  3089. function proc_close ($process) {}
  3090. /**
  3091. * Kills a process opened by proc_open
  3092. * @link http://www.php.net/manual/en/function.proc-terminate.php
  3093. * @param process resource <p>
  3094. * The proc_open resource that will
  3095. * be closed.
  3096. * </p>
  3097. * @param signal int[optional] <p>
  3098. * This optional parameter is only useful on POSIX
  3099. * operating systems; you may specify a signal to send to the process
  3100. * using the kill(2) system call. The default is
  3101. * SIGTERM.
  3102. * </p>
  3103. * @return bool the termination status of the process that was run.
  3104. */
  3105. function proc_terminate ($process, $signal = null) {}
  3106. /**
  3107. * Get information about a process opened by <function>proc_open</function>
  3108. * @link http://www.php.net/manual/en/function.proc-get-status.php
  3109. * @param process resource <p>
  3110. * The proc_open resource that will
  3111. * be evaluated.
  3112. * </p>
  3113. * @return array An array of collected information on success, and false
  3114. * on failure. The returned array contains the following elements:
  3115. * </p>
  3116. * <p>
  3117. * <tr valign="top"><td>element</td><td>type</td><td>description</td></tr>
  3118. * <tr valign="top">
  3119. * <td>command</td>
  3120. * <td>string</td>
  3121. * <td>
  3122. * The command string that was passed to proc_open.
  3123. * </td>
  3124. * </tr>
  3125. * <tr valign="top">
  3126. * <td>pid</td>
  3127. * <td>int</td>
  3128. * <td>process id</td>
  3129. * </tr>
  3130. * <tr valign="top">
  3131. * <td>running</td>
  3132. * <td>bool</td>
  3133. * <td>
  3134. * true if the process is still running, false if it has
  3135. * terminated.
  3136. * </td>
  3137. * </tr>
  3138. * <tr valign="top">
  3139. * <td>signaled</td>
  3140. * <td>bool</td>
  3141. * <td>
  3142. * true if the child process has been terminated by
  3143. * an uncaught signal. Always set to false on Windows.
  3144. * </td>
  3145. * </tr>
  3146. * <tr valign="top">
  3147. * <td>stopped</td>
  3148. * <td>bool</td>
  3149. * <td>
  3150. * true if the child process has been stopped by a
  3151. * signal. Always set to false on Windows.
  3152. * </td>
  3153. * </tr>
  3154. * <tr valign="top">
  3155. * <td>exitcode</td>
  3156. * <td>int</td>
  3157. * <td>
  3158. * The exit code returned by the process (which is only
  3159. * meaningful if running is false).
  3160. * Only first call of this function return real value, next calls return
  3161. * -1.
  3162. * </td>
  3163. * </tr>
  3164. * <tr valign="top">
  3165. * <td>termsig</td>
  3166. * <td>int</td>
  3167. * <td>
  3168. * The number of the signal that caused the child process to terminate
  3169. * its execution (only meaningful if signaled is true).
  3170. * </td>
  3171. * </tr>
  3172. * <tr valign="top">
  3173. * <td>stopsig</td>
  3174. * <td>int</td>
  3175. * <td>
  3176. * The number of the signal that caused the child process to stop its
  3177. * execution (only meaningful if stopped is true).
  3178. * </td>
  3179. * </tr>
  3180. */
  3181. function proc_get_status ($process) {}
  3182. /**
  3183. * Change the priority of the current process
  3184. * @link http://www.php.net/manual/en/function.proc-nice.php
  3185. * @param increment int <p>
  3186. * The increment value of the priority change.
  3187. * </p>
  3188. * @return bool Returns true on success or false on failure.
  3189. * If an error occurs, like the user lacks permission to change the priority,
  3190. * an error of level E_WARNING is also generated.
  3191. */
  3192. function proc_nice ($increment) {}
  3193. /**
  3194. * Generate a random integer
  3195. * @link http://www.php.net/manual/en/function.rand.php
  3196. * @param min[optional]
  3197. * @param max[optional]
  3198. * @return int A pseudo random value between min
  3199. * (or 0) and max (or getrandmax, inclusive).
  3200. */
  3201. function rand ($min, $max) {}
  3202. /**
  3203. * Seed the random number generator
  3204. * @link http://www.php.net/manual/en/function.srand.php
  3205. * @param seed int[optional] <p>
  3206. * Optional seed value
  3207. * </p>
  3208. * @return void
  3209. */
  3210. function srand ($seed = null) {}
  3211. /**
  3212. * Show largest possible random value
  3213. * @link http://www.php.net/manual/en/function.getrandmax.php
  3214. * @return int The largest possible random value returned by rand
  3215. */
  3216. function getrandmax () {}
  3217. /**
  3218. * Generate a better random value
  3219. * @link http://www.php.net/manual/en/function.mt-rand.php
  3220. * @param min[optional]
  3221. * @param max[optional]
  3222. * @return int A random integer value between min (or 0)
  3223. * and max (or mt_getrandmax, inclusive)
  3224. */
  3225. function mt_rand ($min, $max) {}
  3226. /**
  3227. * Seed the better random number generator
  3228. * @link http://www.php.net/manual/en/function.mt-srand.php
  3229. * @param seed int[optional] <p>
  3230. * An optional seed value
  3231. * </p>
  3232. * @return void
  3233. */
  3234. function mt_srand ($seed = null) {}
  3235. /**
  3236. * Show largest possible random value
  3237. * @link http://www.php.net/manual/en/function.mt-getrandmax.php
  3238. * @return int the maximum random value returned by mt_rand
  3239. */
  3240. function mt_getrandmax () {}
  3241. /**
  3242. * Get port number associated with an Internet service and protocol
  3243. * @link http://www.php.net/manual/en/function.getservbyname.php
  3244. * @param service string <p>
  3245. * The Internet service name, as a string.
  3246. * </p>
  3247. * @param protocol string <p>
  3248. * protocol is either "tcp"
  3249. * or "udp" (in lowercase).
  3250. * </p>
  3251. * @return int the port number, or false if service or
  3252. * protocol is not found.
  3253. */
  3254. function getservbyname ($service, $protocol) {}
  3255. /**
  3256. * Get Internet service which corresponds to port and protocol
  3257. * @link http://www.php.net/manual/en/function.getservbyport.php
  3258. * @param port int <p>
  3259. * The port number.
  3260. * </p>
  3261. * @param protocol string <p>
  3262. * protocol is either "tcp"
  3263. * or "udp" (in lowercase).
  3264. * </p>
  3265. * @return string the Internet service name as a string.
  3266. */
  3267. function getservbyport ($port, $protocol) {}
  3268. /**
  3269. * Get protocol number associated with protocol name
  3270. * @link http://www.php.net/manual/en/function.getprotobyname.php
  3271. * @param name string <p>
  3272. * The protocol name.
  3273. * </p>
  3274. * @return int the protocol number, &return.falseforfailure;.
  3275. */
  3276. function getprotobyname ($name) {}
  3277. /**
  3278. * Get protocol name associated with protocol number
  3279. * @link http://www.php.net/manual/en/function.getprotobynumber.php
  3280. * @param number int <p>
  3281. * The protocol number.
  3282. * </p>
  3283. * @return string the protocol name as a string, &return.falseforfailure;.
  3284. */
  3285. function getprotobynumber ($number) {}
  3286. /**
  3287. * Gets PHP script owner's UID
  3288. * @link http://www.php.net/manual/en/function.getmyuid.php
  3289. * @return int the user ID of the current script, or false on error.
  3290. */
  3291. function getmyuid () {}
  3292. /**
  3293. * Get PHP script owner's GID
  3294. * @link http://www.php.net/manual/en/function.getmygid.php
  3295. * @return int the group ID of the current script, or false on error.
  3296. */
  3297. function getmygid () {}
  3298. /**
  3299. * Gets PHP's process ID
  3300. * @link http://www.php.net/manual/en/function.getmypid.php
  3301. * @return int the current PHP process ID, or false on error.
  3302. */
  3303. function getmypid () {}
  3304. /**
  3305. * Gets the inode of the current script
  3306. * @link http://www.php.net/manual/en/function.getmyinode.php
  3307. * @return int the current script's inode as an integer, or false on error.
  3308. */
  3309. function getmyinode () {}
  3310. /**
  3311. * Gets time of last page modification
  3312. * @link http://www.php.net/manual/en/function.getlastmod.php
  3313. * @return int the time of the last modification of the current
  3314. * page. The value returned is a Unix timestamp, suitable for
  3315. * feeding to date. Returns false on error.
  3316. */
  3317. function getlastmod () {}
  3318. /**
  3319. * Decodes data encoded with MIME base64
  3320. * @link http://www.php.net/manual/en/function.base64-decode.php
  3321. * @param data string <p>
  3322. * The encoded data.
  3323. * </p>
  3324. * @param strict bool[optional] <p>
  3325. * Returns false if input contains character from outside the base64
  3326. * alphabet.
  3327. * </p>
  3328. * @return string the original data&return.falseforfailure;. The returned data may be
  3329. * binary.
  3330. */
  3331. function base64_decode ($data, $strict = null) {}
  3332. /**
  3333. * Encodes data with MIME base64
  3334. * @link http://www.php.net/manual/en/function.base64-encode.php
  3335. * @param data string <p>
  3336. * The data to encode.
  3337. * </p>
  3338. * @return string The encoded data, as a string&return.falseforfailure;.
  3339. */
  3340. function base64_encode ($data) {}
  3341. /**
  3342. * Uuencode a string
  3343. * @link http://www.php.net/manual/en/function.convert-uuencode.php
  3344. * @param data string <p>
  3345. * The data to be encoded.
  3346. * </p>
  3347. * @return string the uuencoded data.
  3348. */
  3349. function convert_uuencode ($data) {}
  3350. /**
  3351. * Decode a uuencoded string
  3352. * @link http://www.php.net/manual/en/function.convert-uudecode.php
  3353. * @param data string <p>
  3354. * The uuencoded data.
  3355. * </p>
  3356. * @return string the decoded data as a string.
  3357. */
  3358. function convert_uudecode ($data) {}
  3359. /**
  3360. * Absolute value
  3361. * @link http://www.php.net/manual/en/function.abs.php
  3362. * @param number mixed <p>
  3363. * The numeric value to process
  3364. * </p>
  3365. * @return number The absolute value of number. If the
  3366. * argument number is
  3367. * of type float, the return type is also float,
  3368. * otherwise it is integer (as float usually has a
  3369. * bigger value range than integer).
  3370. */
  3371. function abs ($number) {}
  3372. /**
  3373. * Round fractions up
  3374. * @link http://www.php.net/manual/en/function.ceil.php
  3375. * @param value float <p>
  3376. * The value to round
  3377. * </p>
  3378. * @return float value rounded up to the next highest
  3379. * integer.
  3380. * The return value of ceil is still of type
  3381. * float as the value range of float is
  3382. * usually bigger than that of integer.
  3383. */
  3384. function ceil ($value) {}
  3385. /**
  3386. * Round fractions down
  3387. * @link http://www.php.net/manual/en/function.floor.php
  3388. * @param value float <p>
  3389. * The numeric value to round
  3390. * </p>
  3391. * @return float value rounded to the next lowest integer.
  3392. * The return value of floor is still of type
  3393. * float because the value range of float is
  3394. * usually bigger than that of integer.
  3395. */
  3396. function floor ($value) {}
  3397. /**
  3398. * Rounds a float
  3399. * @link http://www.php.net/manual/en/function.round.php
  3400. * @param val float <p>
  3401. * The value to round
  3402. * </p>
  3403. * @param precision int[optional] <p>
  3404. * The optional number of decimal digits to round to.
  3405. * </p>
  3406. * @param mode int[optional] <p>
  3407. * One of PHP_ROUND_HALF_UP,
  3408. * PHP_ROUND_HALF_DOWN,
  3409. * PHP_ROUND_HALF_EVEN, or
  3410. * PHP_ROUND_HALF_ODD.
  3411. * </p>
  3412. * @return float The rounded value
  3413. */
  3414. function round ($val, $precision = null, $mode = null) {}
  3415. /**
  3416. * Sine
  3417. * @link http://www.php.net/manual/en/function.sin.php
  3418. * @param arg float <p>
  3419. * A value in radians
  3420. * </p>
  3421. * @return float The sine of arg
  3422. */
  3423. function sin ($arg) {}
  3424. /**
  3425. * Cosine
  3426. * @link http://www.php.net/manual/en/function.cos.php
  3427. * @param arg float <p>
  3428. * An angle in radians
  3429. * </p>
  3430. * @return float The cosine of arg
  3431. */
  3432. function cos ($arg) {}
  3433. /**
  3434. * Tangent
  3435. * @link http://www.php.net/manual/en/function.tan.php
  3436. * @param arg float <p>
  3437. * The argument to process in radians
  3438. * </p>
  3439. * @return float The tangent of arg
  3440. */
  3441. function tan ($arg) {}
  3442. /**
  3443. * Arc sine
  3444. * @link http://www.php.net/manual/en/function.asin.php
  3445. * @param arg float <p>
  3446. * The argument to process
  3447. * </p>
  3448. * @return float The arc sine of arg in radians
  3449. */
  3450. function asin ($arg) {}
  3451. /**
  3452. * Arc cosine
  3453. * @link http://www.php.net/manual/en/function.acos.php
  3454. * @param arg float <p>
  3455. * The argument to process
  3456. * </p>
  3457. * @return float The arc cosine of arg in radians.
  3458. */
  3459. function acos ($arg) {}
  3460. /**
  3461. * Arc tangent
  3462. * @link http://www.php.net/manual/en/function.atan.php
  3463. * @param arg float <p>
  3464. * The argument to process
  3465. * </p>
  3466. * @return float The arc tangent of arg in radians.
  3467. */
  3468. function atan ($arg) {}
  3469. /**
  3470. * Inverse hyperbolic tangent
  3471. * @link http://www.php.net/manual/en/function.atanh.php
  3472. * @param arg float <p>
  3473. * The argument to process
  3474. * </p>
  3475. * @return float Inverse hyperbolic tangent of arg
  3476. */
  3477. function atanh ($arg) {}
  3478. /**
  3479. * Arc tangent of two variables
  3480. * @link http://www.php.net/manual/en/function.atan2.php
  3481. * @param y float <p>
  3482. * Dividend parameter
  3483. * </p>
  3484. * @param x float <p>
  3485. * Divisor parameter
  3486. * </p>
  3487. * @return float The arc tangent of y/x
  3488. * in radians.
  3489. */
  3490. function atan2 ($y, $x) {}
  3491. /**
  3492. * Hyperbolic sine
  3493. * @link http://www.php.net/manual/en/function.sinh.php
  3494. * @param arg float <p>
  3495. * The argument to process
  3496. * </p>
  3497. * @return float The hyperbolic sine of arg
  3498. */
  3499. function sinh ($arg) {}
  3500. /**
  3501. * Hyperbolic cosine
  3502. * @link http://www.php.net/manual/en/function.cosh.php
  3503. * @param arg float <p>
  3504. * The argument to process
  3505. * </p>
  3506. * @return float The hyperbolic cosine of arg
  3507. */
  3508. function cosh ($arg) {}
  3509. /**
  3510. * Hyperbolic tangent
  3511. * @link http://www.php.net/manual/en/function.tanh.php
  3512. * @param arg float <p>
  3513. * The argument to process
  3514. * </p>
  3515. * @return float The hyperbolic tangent of arg
  3516. */
  3517. function tanh ($arg) {}
  3518. /**
  3519. * Inverse hyperbolic sine
  3520. * @link http://www.php.net/manual/en/function.asinh.php
  3521. * @param arg float <p>
  3522. * The argument to process
  3523. * </p>
  3524. * @return float The inverse hyperbolic sine of arg
  3525. */
  3526. function asinh ($arg) {}
  3527. /**
  3528. * Inverse hyperbolic cosine
  3529. * @link http://www.php.net/manual/en/function.acosh.php
  3530. * @param arg float <p>
  3531. * The value to process
  3532. * </p>
  3533. * @return float The inverse hyperbolic cosine of arg
  3534. */
  3535. function acosh ($arg) {}
  3536. /**
  3537. * Returns exp(number) - 1, computed in a way that is accurate even
  3538. when the value of number is close to zero
  3539. * @link http://www.php.net/manual/en/function.expm1.php
  3540. * @param arg float <p>
  3541. * The argument to process
  3542. * </p>
  3543. * @return float 'e' to the power of arg minus one
  3544. */
  3545. function expm1 ($arg) {}
  3546. /**
  3547. * Returns log(1 + number), computed in a way that is accurate even when
  3548. the value of number is close to zero
  3549. * @link http://www.php.net/manual/en/function.log1p.php
  3550. * @param number float <p>
  3551. * The argument to process
  3552. * </p>
  3553. * @return float log(1 + number)
  3554. */
  3555. function log1p ($number) {}
  3556. /**
  3557. * Get value of pi
  3558. * @link http://www.php.net/manual/en/function.pi.php
  3559. * @return float The value of pi as float.
  3560. */
  3561. function pi () {}
  3562. /**
  3563. * Finds whether a value is a legal finite number
  3564. * @link http://www.php.net/manual/en/function.is-finite.php
  3565. * @param val float <p>
  3566. * The value to check
  3567. * </p>
  3568. * @return bool true if val is a legal finite
  3569. * number within the allowed range for a PHP float on this platform,
  3570. * else false.
  3571. */
  3572. function is_finite ($val) {}
  3573. /**
  3574. * Finds whether a value is not a number
  3575. * @link http://www.php.net/manual/en/function.is-nan.php
  3576. * @param val float <p>
  3577. * The value to check
  3578. * </p>
  3579. * @return bool true if val is 'not a number',
  3580. * else false.
  3581. */
  3582. function is_nan ($val) {}
  3583. /**
  3584. * Finds whether a value is infinite
  3585. * @link http://www.php.net/manual/en/function.is-infinite.php
  3586. * @param val float <p>
  3587. * The value to check
  3588. * </p>
  3589. * @return bool true if val is infinite, else false.
  3590. */
  3591. function is_infinite ($val) {}
  3592. /**
  3593. * Exponential expression
  3594. * @link http://www.php.net/manual/en/function.pow.php
  3595. * @param base number <p>
  3596. * The base to use
  3597. * </p>
  3598. * @param exp number <p>
  3599. * The exponent
  3600. * </p>
  3601. * @return number base raised to the power of exp.
  3602. * If both arguments are non-negative integers and the result can be represented
  3603. * as an integer, the result will be returned with integer type,
  3604. * otherwise it will be returned as a float.
  3605. */
  3606. function pow ($base, $exp) {}
  3607. /**
  3608. * Calculates the exponent of <constant>e</constant>
  3609. * @link http://www.php.net/manual/en/function.exp.php
  3610. * @param arg float <p>
  3611. * The argument to process
  3612. * </p>
  3613. * @return float 'e' raised to the power of arg
  3614. */
  3615. function exp ($arg) {}
  3616. /**
  3617. * Natural logarithm
  3618. * @link http://www.php.net/manual/en/function.log.php
  3619. * @param arg float <p>
  3620. * The value to calculate the logarithm for
  3621. * </p>
  3622. * @param base float[optional] <p>
  3623. * The optional logarithmic base to use
  3624. * (defaults to 'e' and so to the natural logarithm).
  3625. * </p>
  3626. * @return float The logarithm of arg to
  3627. * base, if given, or the
  3628. * natural logarithm.
  3629. */
  3630. function log ($arg, $base = null) {}
  3631. /**
  3632. * Base-10 logarithm
  3633. * @link http://www.php.net/manual/en/function.log10.php
  3634. * @param arg float <p>
  3635. * The argument to process
  3636. * </p>
  3637. * @return float The base-10 logarithm of arg
  3638. */
  3639. function log10 ($arg) {}
  3640. /**
  3641. * Square root
  3642. * @link http://www.php.net/manual/en/function.sqrt.php
  3643. * @param arg float <p>
  3644. * The argument to process
  3645. * </p>
  3646. * @return float The square root of arg
  3647. * or the special value NAN for negative numbers.
  3648. */
  3649. function sqrt ($arg) {}
  3650. /**
  3651. * Calculate the length of the hypotenuse of a right-angle triangle
  3652. * @link http://www.php.net/manual/en/function.hypot.php
  3653. * @param x float <p>
  3654. * Length of first side
  3655. * </p>
  3656. * @param y float <p>
  3657. * Length of second side
  3658. * </p>
  3659. * @return float Calculated length of the hypotenuse
  3660. */
  3661. function hypot ($x, $y) {}
  3662. /**
  3663. * Converts the number in degrees to the radian equivalent
  3664. * @link http://www.php.net/manual/en/function.deg2rad.php
  3665. * @param number float <p>
  3666. * Angular value in degrees
  3667. * </p>
  3668. * @return float The radian equivalent of number
  3669. */
  3670. function deg2rad ($number) {}
  3671. /**
  3672. * Converts the radian number to the equivalent number in degrees
  3673. * @link http://www.php.net/manual/en/function.rad2deg.php
  3674. * @param number float <p>
  3675. * A radian value
  3676. * </p>
  3677. * @return float The equivalent of number in degrees
  3678. */
  3679. function rad2deg ($number) {}
  3680. /**
  3681. * Binary to decimal
  3682. * @link http://www.php.net/manual/en/function.bindec.php
  3683. * @param binary_string string <p>
  3684. * The binary string to convert
  3685. * </p>
  3686. * @return number The decimal value of binary_string
  3687. */
  3688. function bindec ($binary_string) {}
  3689. /**
  3690. * Hexadecimal to decimal
  3691. * @link http://www.php.net/manual/en/function.hexdec.php
  3692. * @param hex_string string <p>
  3693. * The hexadecimal string to convert
  3694. * </p>
  3695. * @return number The decimal representation of hex_string
  3696. */
  3697. function hexdec ($hex_string) {}
  3698. /**
  3699. * Octal to decimal
  3700. * @link http://www.php.net/manual/en/function.octdec.php
  3701. * @param octal_string string <p>
  3702. * The octal string to convert
  3703. * </p>
  3704. * @return number The decimal representation of octal_string
  3705. */
  3706. function octdec ($octal_string) {}
  3707. /**
  3708. * Decimal to binary
  3709. * @link http://www.php.net/manual/en/function.decbin.php
  3710. * @param number int <p>
  3711. * Decimal value to convert
  3712. * </p>
  3713. * <table>
  3714. * Range of inputs on 32-bit machines
  3715. * <tr valign="top">
  3716. * <td>positive number</td>
  3717. * <td>negative number</td>
  3718. * <td>return value</td>
  3719. * </tr>
  3720. * <tr valign="top">
  3721. * <td>0</td>
  3722. * <td></td>
  3723. * <td>0</td>
  3724. * </tr>
  3725. * <tr valign="top">
  3726. * <td>1</td>
  3727. * <td></td>
  3728. * <td>1</td>
  3729. * </tr>
  3730. * <tr valign="top">
  3731. * <td>2</td>
  3732. * <td></td>
  3733. * <td>10</td>
  3734. * </tr>
  3735. * <tr valign="top">
  3736. * ... normal progression ...</td>
  3737. * </tr>
  3738. * <tr valign="top">
  3739. * <td>2147483646</td>
  3740. * <td></td>
  3741. * <td>1111111111111111111111111111110</td>
  3742. * </tr>
  3743. * <tr valign="top">
  3744. * <td>2147483647 (largest signed integer)</td>
  3745. * <td></td>
  3746. * <td>1111111111111111111111111111111 (31 1's)</td>
  3747. * </tr>
  3748. * <tr valign="top">
  3749. * <td>2147483648</td>
  3750. * <td>-2147483648</td>
  3751. * <td>10000000000000000000000000000000</td>
  3752. * </tr>
  3753. * <tr valign="top">
  3754. * ... normal progression ...</td>
  3755. * </tr>
  3756. * <tr valign="top">
  3757. * <td>4294967294</td>
  3758. * <td>-2</td>
  3759. * <td>11111111111111111111111111111110</td>
  3760. * </tr>
  3761. * <tr valign="top">
  3762. * <td>4294967295 (largest unsigned integer)</td>
  3763. * <td>-1</td>
  3764. * <td>11111111111111111111111111111111 (32 1's)</td>
  3765. * </tr>
  3766. * </table>
  3767. * <table>
  3768. * Range of inputs on 64-bit machines
  3769. * <tr valign="top">
  3770. * <td>positive number</td>
  3771. * <td>negative number</td>
  3772. * <td>return value</td>
  3773. * </tr>
  3774. * <tr valign="top">
  3775. * <td>0</td>
  3776. * <td></td>
  3777. * <td>0</td>
  3778. * </tr>
  3779. * <tr valign="top">
  3780. * <td>1</td>
  3781. * <td></td>
  3782. * <td>1</td>
  3783. * </tr>
  3784. * <tr valign="top">
  3785. * <td>2</td>
  3786. * <td></td>
  3787. * <td>10</td>
  3788. * </tr>
  3789. * <tr valign="top">
  3790. * ... normal progression ...</td>
  3791. * </tr>
  3792. * <tr valign="top">
  3793. * <td>9223372036854775806</td>
  3794. * <td></td>
  3795. * <td>111111111111111111111111111111111111111111111111111111111111110</td>
  3796. * </tr>
  3797. * <tr valign="top">
  3798. * <td>9223372036854775807 (largest signed integer)</td>
  3799. * <td></td>
  3800. * <td>111111111111111111111111111111111111111111111111111111111111111 (63 1's)</td>
  3801. * </tr>
  3802. * <tr valign="top">
  3803. * <td></td>
  3804. * <td>-9223372036854775808</td>
  3805. * <td>1000000000000000000000000000000000000000000000000000000000000000</td>
  3806. * </tr>
  3807. * <tr valign="top">
  3808. * ... normal progression ...</td>
  3809. * </tr>
  3810. * <tr valign="top">
  3811. * <td></td>
  3812. * <td>-2</td>
  3813. * <td>1111111111111111111111111111111111111111111111111111111111111110</td>
  3814. * </tr>
  3815. * <tr valign="top">
  3816. * <td></td>
  3817. * <td>-1</td>
  3818. * <td>1111111111111111111111111111111111111111111111111111111111111111 (64 1's)</td>
  3819. * </tr>
  3820. * </table>
  3821. * @return string Binary string representation of number
  3822. */
  3823. function decbin ($number) {}
  3824. /**
  3825. * Decimal to octal
  3826. * @link http://www.php.net/manual/en/function.decoct.php
  3827. * @param number int <p>
  3828. * Decimal value to convert
  3829. * </p>
  3830. * @return string Octal string representation of number
  3831. */
  3832. function decoct ($number) {}
  3833. /**
  3834. * Decimal to hexadecimal
  3835. * @link http://www.php.net/manual/en/function.dechex.php
  3836. * @param number int <p>
  3837. * Decimal value to convert
  3838. * </p>
  3839. * @return string Hexadecimal string representation of number
  3840. */
  3841. function dechex ($number) {}
  3842. /**
  3843. * Convert a number between arbitrary bases
  3844. * @link http://www.php.net/manual/en/function.base-convert.php
  3845. * @param number string <p>
  3846. * The number to convert
  3847. * </p>
  3848. * @param frombase int <p>
  3849. * The base number is in
  3850. * </p>
  3851. * @param tobase int <p>
  3852. * The base to convert number to
  3853. * </p>
  3854. * @return string number converted to base tobase
  3855. */
  3856. function base_convert ($number, $frombase, $tobase) {}
  3857. /**
  3858. * Format a number with grouped thousands
  3859. * @link http://www.php.net/manual/en/function.number-format.php
  3860. * @param number float <p>
  3861. * The number being formatted.
  3862. * </p>
  3863. * @param decimals int[optional] <p>
  3864. * Sets the number of decimal points.
  3865. * </p>
  3866. * @return string A formatted version of number.
  3867. */
  3868. function number_format ($number, $decimals = null) {}
  3869. /**
  3870. * Returns the floating point remainder (modulo) of the division
  3871. of the arguments
  3872. * @link http://www.php.net/manual/en/function.fmod.php
  3873. * @param x float <p>
  3874. * The dividend
  3875. * </p>
  3876. * @param y float <p>
  3877. * The divisor
  3878. * </p>
  3879. * @return float The floating point remainder of
  3880. * x/y
  3881. */
  3882. function fmod ($x, $y) {}
  3883. /**
  3884. * Converts a packed internet address to a human readable representation
  3885. * @link http://www.php.net/manual/en/function.inet-ntop.php
  3886. * @param in_addr string <p>
  3887. * A 32bit IPv4, or 128bit IPv6 address.
  3888. * </p>
  3889. * @return string a string representation of the address&return.falseforfailure;.
  3890. */
  3891. function inet_ntop ($in_addr) {}
  3892. /**
  3893. * Converts a human readable IP address to its packed in_addr representation
  3894. * @link http://www.php.net/manual/en/function.inet-pton.php
  3895. * @param address string <p>
  3896. * A human readable IPv4 or IPv6 address.
  3897. * </p>
  3898. * @return string the in_addr representation of the given
  3899. * address, or false if a syntactically invalid
  3900. * address is given (for example, an IPv4 address
  3901. * without dots or an IPv6 address without colons).
  3902. */
  3903. function inet_pton ($address) {}
  3904. /**
  3905. * Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address
  3906. * @link http://www.php.net/manual/en/function.ip2long.php
  3907. * @param ip_address string <p>
  3908. * A standard format address.
  3909. * </p>
  3910. * @return int the IPv4 address or false if ip_address
  3911. * is invalid.
  3912. */
  3913. function ip2long ($ip_address) {}
  3914. /**
  3915. * Converts an (IPv4) Internet network address into a string in Internet standard dotted format
  3916. * @link http://www.php.net/manual/en/function.long2ip.php
  3917. * @param proper_address string <p>
  3918. * A proper address representation.
  3919. * </p>
  3920. * @return string the Internet IP address as a string.
  3921. */
  3922. function long2ip ($proper_address) {}
  3923. /**
  3924. * Gets the value of an environment variable
  3925. * @link http://www.php.net/manual/en/function.getenv.php
  3926. * @param varname string <p>
  3927. * The variable name.
  3928. * </p>
  3929. * @return string the value of the environment variable
  3930. * varname, or false if the environment
  3931. * variable varname does not exist.
  3932. */
  3933. function getenv ($varname) {}
  3934. /**
  3935. * Sets the value of an environment variable
  3936. * @link http://www.php.net/manual/en/function.putenv.php
  3937. * @param setting string <p>
  3938. * The setting, like "FOO=BAR"
  3939. * </p>
  3940. * @return bool Returns true on success or false on failure.
  3941. */
  3942. function putenv ($setting) {}
  3943. /**
  3944. * Gets options from the command line argument list
  3945. * @link http://www.php.net/manual/en/function.getopt.php
  3946. * @param options string Each character in this string will be used as option characters and
  3947. * matched against options passed to the script starting with a single
  3948. * hyphen (-).
  3949. * For example, an option string "x" recognizes an
  3950. * option -x.
  3951. * Only a-z, A-Z and 0-9 are allowed.
  3952. * @param longopts array[optional] An array of options. Each element in this array will be used as option
  3953. * strings and matched against options passed to the script starting with
  3954. * two hyphens (--).
  3955. * For example, an longopts element "opt" recognizes an
  3956. * option --opt.
  3957. * @return array This function will return an array of option / argument pairs or false on
  3958. * failure.
  3959. * </p>
  3960. * <p>
  3961. * The parsing of options will end at the first non-option found, anything
  3962. * that follows is discarded.
  3963. */
  3964. function getopt ($options, array $longopts = null) {}
  3965. /**
  3966. * Gets system load average
  3967. * @link http://www.php.net/manual/en/function.sys-getloadavg.php
  3968. * @return array an array with three samples (last 1, 5 and 15
  3969. * minutes).
  3970. */
  3971. function sys_getloadavg () {}
  3972. /**
  3973. * Return current Unix timestamp with microseconds
  3974. * @link http://www.php.net/manual/en/function.microtime.php
  3975. * @param get_as_float bool[optional] <p>
  3976. * If used and set to true, microtime will return a
  3977. * float instead of a string, as described in
  3978. * the return values section below.
  3979. * </p>
  3980. * @return mixed By default, microtime returns a string in
  3981. * the form "msec sec", where sec is the current time
  3982. * measured in the number of seconds since the Unix epoch (0:00:00 January 1,
  3983. * 1970 GMT), and msec is the number of microseconds that
  3984. * have elapsed since sec expressed in seconds.
  3985. * </p>
  3986. * <p>
  3987. * If get_as_float is set to true, then
  3988. * microtime returns a float, which
  3989. * represents the current time in seconds since the Unix epoch accurate to the
  3990. * nearest microsecond.
  3991. */
  3992. function microtime ($get_as_float = null) {}
  3993. /**
  3994. * Get current time
  3995. * @link http://www.php.net/manual/en/function.gettimeofday.php
  3996. * @param return_float bool[optional] <p>
  3997. * When set to true, a float instead of an array is returned.
  3998. * </p>
  3999. * @return mixed By default an array is returned. If return_float
  4000. * is set, then a float is returned.
  4001. * </p>
  4002. * <p>
  4003. * Array keys:
  4004. * "sec" - seconds since the Unix Epoch
  4005. * "usec" - microseconds
  4006. * "minuteswest" - minutes west of Greenwich
  4007. * "dsttime" - type of dst correction
  4008. */
  4009. function gettimeofday ($return_float = null) {}
  4010. /**
  4011. * Gets the current resource usages
  4012. * @link http://www.php.net/manual/en/function.getrusage.php
  4013. * @param who int[optional] <p>
  4014. * If who is 1, getrusage will be called with
  4015. * RUSAGE_CHILDREN.
  4016. * </p>
  4017. * @return array an associative array containing the data returned from the system
  4018. * call. All entries are accessible by using their documented field names.
  4019. */
  4020. function getrusage ($who = null) {}
  4021. /**
  4022. * Generate a unique ID
  4023. * @link http://www.php.net/manual/en/function.uniqid.php
  4024. * @param prefix string[optional] <p>
  4025. * Can be useful, for instance, if you generate identifiers
  4026. * simultaneously on several hosts that might happen to generate the
  4027. * identifier at the same microsecond.
  4028. * </p>
  4029. * <p>
  4030. * With an empty prefix, the returned string will
  4031. * be 13 characters long. If more_entropy is
  4032. * true, it will be 23 characters.
  4033. * </p>
  4034. * @param more_entropy bool[optional] <p>
  4035. * If set to true, uniqid will add additional
  4036. * entropy (using the combined linear congruential generator) at the end
  4037. * of the return value, which increases the likelihood that the result
  4038. * will be unique.
  4039. * </p>
  4040. * @return string the unique identifier, as a string.
  4041. */
  4042. function uniqid ($prefix = null, $more_entropy = null) {}
  4043. /**
  4044. * Convert a quoted-printable string to an 8 bit string
  4045. * @link http://www.php.net/manual/en/function.quoted-printable-decode.php
  4046. * @param str string <p>
  4047. * The input string.
  4048. * </p>
  4049. * @return string the 8-bit binary string.
  4050. */
  4051. function quoted_printable_decode ($str) {}
  4052. /**
  4053. * Convert a 8 bit string to a quoted-printable string
  4054. * @link http://www.php.net/manual/en/function.quoted-printable-encode.php
  4055. * @param str string <p>
  4056. * The input string.
  4057. * </p>
  4058. * @return string the encoded string.
  4059. */
  4060. function quoted_printable_encode ($str) {}
  4061. /**
  4062. * Convert from one Cyrillic character set to another
  4063. * @link http://www.php.net/manual/en/function.convert-cyr-string.php
  4064. * @param str string <p>
  4065. * The string to be converted.
  4066. * </p>
  4067. * @param from string <p>
  4068. * The source Cyrillic character set, as a single character.
  4069. * </p>
  4070. * @param to string <p>
  4071. * The target Cyrillic character set, as a single character.
  4072. * </p>
  4073. * @return string the converted string.
  4074. */
  4075. function convert_cyr_string ($str, $from, $to) {}
  4076. /**
  4077. * Gets the name of the owner of the current PHP script
  4078. * @link http://www.php.net/manual/en/function.get-current-user.php
  4079. * @return string the username as a string.
  4080. */
  4081. function get_current_user () {}
  4082. /**
  4083. * Limits the maximum execution time
  4084. * @link http://www.php.net/manual/en/function.set-time-limit.php
  4085. * @param seconds int <p>
  4086. * The maximum execution time, in seconds. If set to zero, no time limit
  4087. * is imposed.
  4088. * </p>
  4089. * @return void
  4090. */
  4091. function set_time_limit ($seconds) {}
  4092. /**
  4093. * Call a header function
  4094. * @link http://www.php.net/manual/en/function.header-register-callback.php
  4095. * @param callback callable <p>
  4096. * Function called just before the headers are sent. It gets no parameters
  4097. * and the return value is ignored.
  4098. * </p>
  4099. * @return bool Returns true on success or false on failure.
  4100. */
  4101. function header_register_callback ($callback) {}
  4102. /**
  4103. * Gets the value of a PHP configuration option
  4104. * @link http://www.php.net/manual/en/function.get-cfg-var.php
  4105. * @param option string <p>
  4106. * The configuration option name.
  4107. * </p>
  4108. * @return string the current value of the PHP configuration variable specified by
  4109. * option, or false if an error occurs.
  4110. */
  4111. function get_cfg_var ($option) {}
  4112. /**
  4113. * &Alias; <function>set_magic_quotes_runtime</function>
  4114. * @link http://www.php.net/manual/en/function.magic-quotes-runtime.php
  4115. * @param new_setting
  4116. */
  4117. function magic_quotes_runtime ($new_setting) {}
  4118. /**
  4119. * Sets the current active configuration setting of magic_quotes_runtime
  4120. * @link http://www.php.net/manual/en/function.set-magic-quotes-runtime.php
  4121. * @param new_setting bool <p>
  4122. * false for off, true for on.
  4123. * </p>
  4124. * @return bool Returns true on success or false on failure.
  4125. */
  4126. function set_magic_quotes_runtime ($new_setting) {}
  4127. /**
  4128. * Gets the current configuration setting of magic_quotes_gpc
  4129. * @link http://www.php.net/manual/en/function.get-magic-quotes-gpc.php
  4130. * @return bool 0 if magic_quotes_gpc is off, 1 otherwise.
  4131. * Or always returns false as of PHP 5.4.0.
  4132. */
  4133. function get_magic_quotes_gpc () {}
  4134. /**
  4135. * Gets the current active configuration setting of magic_quotes_runtime
  4136. * @link http://www.php.net/manual/en/function.get-magic-quotes-runtime.php
  4137. * @return bool 0 if magic_quotes_runtime is off, 1 otherwise.
  4138. * Or always returns false as of PHP 5.4.0.
  4139. */
  4140. function get_magic_quotes_runtime () {}
  4141. /**
  4142. * Send an error message somewhere
  4143. * @link http://www.php.net/manual/en/function.error-log.php
  4144. * @param message string <p>
  4145. * The error message that should be logged.
  4146. * </p>
  4147. * @param message_type int[optional] <p>
  4148. * Says where the error should go. The possible message types are as
  4149. * follows:
  4150. * </p>
  4151. * <p>
  4152. * <table>
  4153. * error_log log types
  4154. * <tr valign="top">
  4155. * <td>0</td>
  4156. * <td>
  4157. * message is sent to PHP's system logger, using
  4158. * the Operating System's system logging mechanism or a file, depending
  4159. * on what the error_log
  4160. * configuration directive is set to. This is the default option.
  4161. * </td>
  4162. * </tr>
  4163. * <tr valign="top">
  4164. * <td>1</td>
  4165. * <td>
  4166. * message is sent by email to the address in
  4167. * the destination parameter. This is the only
  4168. * message type where the fourth parameter,
  4169. * extra_headers is used.
  4170. * </td>
  4171. * </tr>
  4172. * <tr valign="top">
  4173. * <td>2</td>
  4174. * <td>
  4175. * No longer an option.
  4176. * </td>
  4177. * </tr>
  4178. * <tr valign="top">
  4179. * <td>3</td>
  4180. * <td>
  4181. * message is appended to the file
  4182. * destination. A newline is not automatically
  4183. * added to the end of the message string.
  4184. * </td>
  4185. * </tr>
  4186. * <tr valign="top">
  4187. * <td>4</td>
  4188. * <td>
  4189. * message is sent directly to the SAPI logging
  4190. * handler.
  4191. * </td>
  4192. * </tr>
  4193. * </table>
  4194. * </p>
  4195. * @param destination string[optional] <p>
  4196. * The destination. Its meaning depends on the
  4197. * message_type parameter as described above.
  4198. * </p>
  4199. * @param extra_headers string[optional] <p>
  4200. * The extra headers. It's used when the message_type
  4201. * parameter is set to 1.
  4202. * This message type uses the same internal function as
  4203. * mail does.
  4204. * </p>
  4205. * @return bool Returns true on success or false on failure.
  4206. */
  4207. function error_log ($message, $message_type = null, $destination = null, $extra_headers = null) {}
  4208. /**
  4209. * Get the last occurred error
  4210. * @link http://www.php.net/manual/en/function.error-get-last.php
  4211. * @return array an associative array describing the last error with keys "type",
  4212. * "message", "file" and "line". If the error has been caused by a PHP
  4213. * internal function then the "message" begins with its name.
  4214. * Returns &null; if there hasn't been an error yet.
  4215. */
  4216. function error_get_last () {}
  4217. /**
  4218. * Call the callback given by the first parameter
  4219. * @link http://www.php.net/manual/en/function.call-user-func.php
  4220. * @param callback callable <p>
  4221. * The callable to be called.
  4222. * </p>
  4223. * @param parameter mixed[optional] <p>
  4224. * Zero or more parameters to be passed to the callback.
  4225. * </p>
  4226. * <p>
  4227. * Note that the parameters for call_user_func are
  4228. * not passed by reference.
  4229. * call_user_func example and references
  4230. * ]]>
  4231. * &example.outputs;
  4232. * </p>
  4233. * @param _ mixed[optional]
  4234. * @return mixed the return value of the callback, or false on error.
  4235. */
  4236. function call_user_func ($callback, $parameter = null, $_ = null) {}
  4237. /**
  4238. * Call a callback with an array of parameters
  4239. * @link http://www.php.net/manual/en/function.call-user-func-array.php
  4240. * @param callback callable <p>
  4241. * The callable to be called.
  4242. * </p>
  4243. * @param param_arr array <p>
  4244. * The parameters to be passed to the callback, as an indexed array.
  4245. * </p>
  4246. * @return mixed the return value of the callback, or false on error.
  4247. */
  4248. function call_user_func_array ($callback, array $param_arr) {}
  4249. /**
  4250. * Call a user method on an specific object [deprecated]
  4251. * @link http://www.php.net/manual/en/function.call-user-method.php
  4252. * @param method_name string <p>
  4253. * The method name being called.
  4254. * </p>
  4255. * @param obj object <p>
  4256. * The object that method_name
  4257. * is being called on.
  4258. * </p>
  4259. * @param parameter mixed[optional]
  4260. * @param _ mixed[optional]
  4261. * @return mixed
  4262. */
  4263. function call_user_method ($method_name, &$obj, $parameter = null, $_ = null) {}
  4264. /**
  4265. * Call a user method given with an array of parameters [deprecated]
  4266. * @link http://www.php.net/manual/en/function.call-user-method-array.php
  4267. * @param method_name string <p>
  4268. * The method name being called.
  4269. * </p>
  4270. * @param obj object <p>
  4271. * The object that method_name
  4272. * is being called on.
  4273. * </p>
  4274. * @param params array <p>
  4275. * An array of parameters.
  4276. * </p>
  4277. * @return mixed
  4278. */
  4279. function call_user_method_array ($method_name, &$obj, array $params) {}
  4280. /**
  4281. * Call a static method
  4282. * @link http://www.php.net/manual/en/function.forward-static-call.php
  4283. * @param function callable <p>
  4284. * The function or method to be called. This parameter may be an array,
  4285. * with the name of the class, and the method, or a string, with a function
  4286. * name.
  4287. * </p>
  4288. * @param parameter mixed[optional] <p>
  4289. * Zero or more parameters to be passed to the function.
  4290. * </p>
  4291. * @param _ mixed[optional]
  4292. * @return mixed the function result, or false on error.
  4293. */
  4294. function forward_static_call ($function, $parameter = null, $_ = null) {}
  4295. /**
  4296. * Call a static method and pass the arguments as array
  4297. * @link http://www.php.net/manual/en/function.forward-static-call-array.php
  4298. * @param function callable <p>
  4299. * The function or method to be called. This parameter may be an &array;,
  4300. * with the name of the class, and the method, or a &string;, with a function
  4301. * name.
  4302. * </p>
  4303. * @param parameters array
  4304. * @return mixed the function result, or false on error.
  4305. */
  4306. function forward_static_call_array ($function, array $parameters) {}
  4307. /**
  4308. * Generates a storable representation of a value
  4309. * @link http://www.php.net/manual/en/function.serialize.php
  4310. * @param value mixed <p>
  4311. * The value to be serialized. serialize
  4312. * handles all types, except the resource-type.
  4313. * You can even serialize arrays that contain
  4314. * references to itself. Circular references inside the array/object you
  4315. * are serializing will also be stored. Any other
  4316. * reference will be lost.
  4317. * </p>
  4318. * <p>
  4319. * When serializing objects, PHP will attempt to call the member function
  4320. * __sleep() prior to serialization.
  4321. * This is to allow the object to do any last minute clean-up, etc. prior
  4322. * to being serialized. Likewise, when the object is restored using
  4323. * unserialize the __wakeup() member function is called.
  4324. * </p>
  4325. * <p>
  4326. * Object's private members have the class name prepended to the member
  4327. * name; protected members have a '*' prepended to the member name.
  4328. * These prepended values have null bytes on either side.
  4329. * </p>
  4330. * @return string a string containing a byte-stream representation of
  4331. * value that can be stored anywhere.
  4332. */
  4333. function serialize ($value) {}
  4334. /**
  4335. * Creates a PHP value from a stored representation
  4336. * @link http://www.php.net/manual/en/function.unserialize.php
  4337. * @param str string <p>
  4338. * The serialized string.
  4339. * </p>
  4340. * <p>
  4341. * If the variable being unserialized is an object, after successfully
  4342. * reconstructing the object PHP will automatically attempt to call the
  4343. * __wakeup() member
  4344. * function (if it exists).
  4345. * </p>
  4346. * <p>
  4347. * unserialize_callback_func directive
  4348. * <p>
  4349. * It's possible to set a callback-function which will be called,
  4350. * if an undefined class should be instantiated during unserializing.
  4351. * (to prevent getting an incomplete object "__PHP_Incomplete_Class".)
  4352. * Use your &php.ini;, ini_set or &htaccess;
  4353. * to define 'unserialize_callback_func'. Everytime an undefined class
  4354. * should be instantiated, it'll be called. To disable this feature just
  4355. * empty this setting.
  4356. * </p>
  4357. * </p>
  4358. * @return mixed The converted value is returned, and can be a boolean,
  4359. * integer, float, string,
  4360. * array or object.
  4361. * </p>
  4362. * <p>
  4363. * In case the passed string is not unserializeable, false is returned and
  4364. * E_NOTICE is issued.
  4365. */
  4366. function unserialize ($str) {}
  4367. /**
  4368. * Dumps information about a variable
  4369. * @link http://www.php.net/manual/en/function.var-dump.php
  4370. * @param expression mixed <p>
  4371. * The variable you want to dump.
  4372. * </p>
  4373. * @param _ mixed[optional]
  4374. * @return void
  4375. */
  4376. function var_dump ($expression, $_ = null) {}
  4377. /**
  4378. * Outputs or returns a parsable string representation of a variable
  4379. * @link http://www.php.net/manual/en/function.var-export.php
  4380. * @param expression mixed <p>
  4381. * The variable you want to export.
  4382. * </p>
  4383. * @param return bool[optional] <p>
  4384. * If used and set to true, var_export will return
  4385. * the variable representation instead of outputing it.
  4386. * </p>
  4387. * @return mixed the variable representation when the return
  4388. * parameter is used and evaluates to true. Otherwise, this function will
  4389. * return &null;.
  4390. */
  4391. function var_export ($expression, $return = null) {}
  4392. /**
  4393. * Dumps a string representation of an internal zend value to output
  4394. * @link http://www.php.net/manual/en/function.debug-zval-dump.php
  4395. * @param variable mixed <p>
  4396. * The variable being evaluated.
  4397. * </p>
  4398. * @return void
  4399. */
  4400. function debug_zval_dump ($variable) {}
  4401. /**
  4402. * Prints human-readable information about a variable
  4403. * @link http://www.php.net/manual/en/function.print-r.php
  4404. * @param expression mixed <p>
  4405. * The expression to be printed.
  4406. * </p>
  4407. * @param return bool[optional] <p>
  4408. * If you would like to capture the output of print_r,
  4409. * use the return parameter. When this parameter is set
  4410. * to true, print_r will return the information rather than print it.
  4411. * </p>
  4412. * @return mixed If given a string, integer or float,
  4413. * the value itself will be printed. If given an array, values
  4414. * will be presented in a format that shows keys and elements. Similar
  4415. * notation is used for objects.
  4416. * </p>
  4417. * <p>
  4418. * When the return parameter is true, this function
  4419. * will return a string. Otherwise, the return value is true.
  4420. */
  4421. function print_r ($expression, $return = null) {}
  4422. /**
  4423. * Returns the amount of memory allocated to PHP
  4424. * @link http://www.php.net/manual/en/function.memory-get-usage.php
  4425. * @param real_usage bool[optional] <p>
  4426. * Set this to true to get the real size of memory allocated from
  4427. * system. If not set or false only the memory used by
  4428. * emalloc() is reported.
  4429. * </p>
  4430. * @return int the memory amount in bytes.
  4431. */
  4432. function memory_get_usage ($real_usage = null) {}
  4433. /**
  4434. * Returns the peak of memory allocated by PHP
  4435. * @link http://www.php.net/manual/en/function.memory-get-peak-usage.php
  4436. * @param real_usage bool[optional] <p>
  4437. * Set this to true to get the real size of memory allocated from
  4438. * system. If not set or false only the memory used by
  4439. * emalloc() is reported.
  4440. * </p>
  4441. * @return int the memory peak in bytes.
  4442. */
  4443. function memory_get_peak_usage ($real_usage = null) {}
  4444. /**
  4445. * Register a function for execution on shutdown
  4446. * @link http://www.php.net/manual/en/function.register-shutdown-function.php
  4447. * @param callback callable <p>
  4448. * The shutdown callback to register.
  4449. * </p>
  4450. * <p>
  4451. * The shutdown callbacks are executed as the part of the request, so
  4452. * it's possible to send output from them and access output buffers.
  4453. * </p>
  4454. * @param parameter mixed[optional] <p>
  4455. * It is possible to pass parameters to the shutdown function by passing
  4456. * additional parameters.
  4457. * </p>
  4458. * @param _ mixed[optional]
  4459. * @return void
  4460. */
  4461. function register_shutdown_function ($callback, $parameter = null, $_ = null) {}
  4462. /**
  4463. * Register a function for execution on each tick
  4464. * @link http://www.php.net/manual/en/function.register-tick-function.php
  4465. * @param function callable <p>
  4466. * The function name as a string, or an array consisting of an object and
  4467. * a method.
  4468. * </p>
  4469. * @param arg mixed[optional] <p>
  4470. * </p>
  4471. * @param _ mixed[optional]
  4472. * @return bool Returns true on success or false on failure.
  4473. */
  4474. function register_tick_function ($function, $arg = null, $_ = null) {}
  4475. /**
  4476. * De-register a function for execution on each tick
  4477. * @link http://www.php.net/manual/en/function.unregister-tick-function.php
  4478. * @param function_name string <p>
  4479. * The function name, as a string.
  4480. * </p>
  4481. * @return void
  4482. */
  4483. function unregister_tick_function ($function_name) {}
  4484. /**
  4485. * Syntax highlighting of a file
  4486. * @link http://www.php.net/manual/en/function.highlight-file.php
  4487. * @param filename string <p>
  4488. * Path to the PHP file to be highlighted.
  4489. * </p>
  4490. * @param return bool[optional] <p>
  4491. * Set this parameter to true to make this function return the
  4492. * highlighted code.
  4493. * </p>
  4494. * @return mixed If return is set to true, returns the highlighted
  4495. * code as a string instead of printing it out. Otherwise, it will return
  4496. * true on success, false on failure.
  4497. */
  4498. function highlight_file ($filename, $return = null) {}
  4499. /**
  4500. * &Alias; <function>highlight_file</function>
  4501. * @link http://www.php.net/manual/en/function.show-source.php
  4502. * @param file_name
  4503. * @param return[optional]
  4504. */
  4505. function show_source ($file_name, $return) {}
  4506. /**
  4507. * Syntax highlighting of a string
  4508. * @link http://www.php.net/manual/en/function.highlight-string.php
  4509. * @param str string <p>
  4510. * The PHP code to be highlighted. This should include the opening tag.
  4511. * </p>
  4512. * @param return bool[optional] <p>
  4513. * Set this parameter to true to make this function return the
  4514. * highlighted code.
  4515. * </p>
  4516. * @return mixed If return is set to true, returns the highlighted
  4517. * code as a string instead of printing it out. Otherwise, it will return
  4518. * true on success, false on failure.
  4519. */
  4520. function highlight_string ($str, $return = null) {}
  4521. /**
  4522. * Return source with stripped comments and whitespace
  4523. * @link http://www.php.net/manual/en/function.php-strip-whitespace.php
  4524. * @param filename string <p>
  4525. * Path to the PHP file.
  4526. * </p>
  4527. * @return string The stripped source code will be returned on success, or an empty string
  4528. * on failure.
  4529. * </p>
  4530. * <p>
  4531. * This function works as described as of PHP 5.0.1. Before this it would
  4532. * only return an empty string. For more information on this bug and its
  4533. * prior behavior, see bug report
  4534. * #29606.
  4535. */
  4536. function php_strip_whitespace ($filename) {}
  4537. /**
  4538. * Gets the value of a configuration option
  4539. * @link http://www.php.net/manual/en/function.ini-get.php
  4540. * @param varname string <p>
  4541. * The configuration option name.
  4542. * </p>
  4543. * @return string the value of the configuration option as a string on success, or an
  4544. * empty string for null values. Returns false if the
  4545. * configuration option doesn't exist.
  4546. */
  4547. function ini_get ($varname) {}
  4548. /**
  4549. * Gets all configuration options
  4550. * @link http://www.php.net/manual/en/function.ini-get-all.php
  4551. * @param extension string[optional] <p>
  4552. * An optional extension name. If set, the function return only options
  4553. * specific for that extension.
  4554. * </p>
  4555. * @param details bool[optional] <p>
  4556. * Retrieve details settings or only the current value for each setting.
  4557. * Default is true (retrieve details).
  4558. * </p>
  4559. * @return array an associative array with directive name as the array key.
  4560. * </p>
  4561. * <p>
  4562. * When details is true (default) the array will
  4563. * contain global_value (set in
  4564. * &php.ini;), local_value (perhaps set with
  4565. * ini_set or &htaccess;), and
  4566. * access (the access level).
  4567. * </p>
  4568. * <p>
  4569. * When details is false the value will be the
  4570. * current value of the option.
  4571. * </p>
  4572. * <p>
  4573. * See the manual section
  4574. * for information on what access levels mean.
  4575. * </p>
  4576. * <p>
  4577. * It's possible for a directive to have multiple access levels, which is
  4578. * why access shows the appropriate bitmask values.
  4579. */
  4580. function ini_get_all ($extension = null, $details = null) {}
  4581. /**
  4582. * Sets the value of a configuration option
  4583. * @link http://www.php.net/manual/en/function.ini-set.php
  4584. * @param varname string <p>
  4585. * </p>
  4586. * <p>
  4587. * Not all the available options can be changed using
  4588. * ini_set. There is a list of all available options
  4589. * in the appendix.
  4590. * </p>
  4591. * @param newvalue string <p>
  4592. * The new value for the option.
  4593. * </p>
  4594. * @return string the old value on success, false on failure.
  4595. */
  4596. function ini_set ($varname, $newvalue) {}
  4597. /**
  4598. * &Alias; <function>ini_set</function>
  4599. * @link http://www.php.net/manual/en/function.ini-alter.php
  4600. * @param varname
  4601. * @param newvalue
  4602. */
  4603. function ini_alter ($varname, $newvalue) {}
  4604. /**
  4605. * Restores the value of a configuration option
  4606. * @link http://www.php.net/manual/en/function.ini-restore.php
  4607. * @param varname string <p>
  4608. * The configuration option name.
  4609. * </p>
  4610. * @return void
  4611. */
  4612. function ini_restore ($varname) {}
  4613. /**
  4614. * Gets the current include_path configuration option
  4615. * @link http://www.php.net/manual/en/function.get-include-path.php
  4616. * @return string the path, as a string.
  4617. */
  4618. function get_include_path () {}
  4619. /**
  4620. * Sets the include_path configuration option
  4621. * @link http://www.php.net/manual/en/function.set-include-path.php
  4622. * @param new_include_path string <p>
  4623. * The new value for the include_path
  4624. * </p>
  4625. * @return string the old include_path on
  4626. * success&return.falseforfailure;.
  4627. */
  4628. function set_include_path ($new_include_path) {}
  4629. /**
  4630. * Restores the value of the include_path configuration option
  4631. * @link http://www.php.net/manual/en/function.restore-include-path.php
  4632. * @return void
  4633. */
  4634. function restore_include_path () {}
  4635. /**
  4636. * Send a cookie
  4637. * @link http://www.php.net/manual/en/function.setcookie.php
  4638. * @param name string <p>
  4639. * The name of the cookie.
  4640. * </p>
  4641. * @param value string[optional] <p>
  4642. * The value of the cookie. This value is stored on the clients computer;
  4643. * do not store sensitive information. Assuming the
  4644. * name is 'cookiename', this
  4645. * value is retrieved through $_COOKIE['cookiename']
  4646. * </p>
  4647. * @param expire int[optional] <p>
  4648. * The time the cookie expires. This is a Unix timestamp so is
  4649. * in number of seconds since the epoch. In other words, you'll
  4650. * most likely set this with the time function
  4651. * plus the number of seconds before you want it to expire. Or
  4652. * you might use mktime.
  4653. * time()+60*60*24*30 will set the cookie to
  4654. * expire in 30 days. If set to 0, or omitted, the cookie will expire at
  4655. * the end of the session (when the browser closes).
  4656. * </p>
  4657. * <p>
  4658. * <p>
  4659. * You may notice the expire parameter takes on a
  4660. * Unix timestamp, as opposed to the date format Wdy, DD-Mon-YYYY
  4661. * HH:MM:SS GMT, this is because PHP does this conversion
  4662. * internally.
  4663. * </p>
  4664. * </p>
  4665. * @param path string[optional] <p>
  4666. * The path on the server in which the cookie will be available on.
  4667. * If set to '/', the cookie will be available
  4668. * within the entire domain. If set to
  4669. * '/foo/', the cookie will only be available
  4670. * within the /foo/ directory and all
  4671. * sub-directories such as /foo/bar/ of
  4672. * domain. The default value is the
  4673. * current directory that the cookie is being set in.
  4674. * </p>
  4675. * @param domain string[optional] <p>
  4676. * The domain that the cookie is available to. Setting the domain to
  4677. * 'www.example.com' will make the cookie
  4678. * available in the www subdomain and higher subdomains.
  4679. * Cookies available to a lower domain, such as
  4680. * 'example.com' will be available to higher subdomains,
  4681. * such as 'www.example.com'.
  4682. * Older browsers still implementing the deprecated
  4683. * RFC 2109 may require a leading
  4684. * . to match all subdomains.
  4685. * </p>
  4686. * @param secure bool[optional] <p>
  4687. * Indicates that the cookie should only be transmitted over a
  4688. * secure HTTPS connection from the client. When set to true, the
  4689. * cookie will only be set if a secure connection exists.
  4690. * On the server-side, it's on the programmer to send this
  4691. * kind of cookie only on secure connection (e.g. with respect to
  4692. * $_SERVER["HTTPS"]).
  4693. * </p>
  4694. * @param httponly bool[optional] <p>
  4695. * When true the cookie will be made accessible only through the HTTP
  4696. * protocol. This means that the cookie won't be accessible by
  4697. * scripting languages, such as JavaScript. It has been suggested that
  4698. * this setting can effectively help to reduce identity theft through
  4699. * XSS attacks (although it is not supported by all browsers), but that
  4700. * claim is often disputed. Added in PHP 5.2.0.
  4701. * true or false
  4702. * </p>
  4703. * @return bool If output exists prior to calling this function,
  4704. * setcookie will fail and return false. If
  4705. * setcookie successfully runs, it will return true.
  4706. * This does not indicate whether the user accepted the cookie.
  4707. */
  4708. function setcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  4709. /**
  4710. * Send a cookie without urlencoding the cookie value
  4711. * @link http://www.php.net/manual/en/function.setrawcookie.php
  4712. * @param name string
  4713. * @param value string[optional]
  4714. * @param expire int[optional]
  4715. * @param path string[optional]
  4716. * @param domain string[optional]
  4717. * @param secure bool[optional]
  4718. * @param httponly bool[optional]
  4719. * @return bool Returns true on success or false on failure.
  4720. */
  4721. function setrawcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  4722. /**
  4723. * Send a raw HTTP header
  4724. * @link http://www.php.net/manual/en/function.header.php
  4725. * @param string string <p>
  4726. * The header string.
  4727. * </p>
  4728. * <p>
  4729. * There are two special-case header calls. The first is a header
  4730. * that starts with the string "HTTP/" (case is not
  4731. * significant), which will be used to figure out the HTTP status
  4732. * code to send. For example, if you have configured Apache to
  4733. * use a PHP script to handle requests for missing files (using
  4734. * the ErrorDocument directive), you may want to
  4735. * make sure that your script generates the proper status code.
  4736. * </p>
  4737. * <p>
  4738. * ]]>
  4739. * </p>
  4740. * <p>
  4741. * For FastCGI you must use the following for a 404 response:
  4742. * ]]>
  4743. * </p>
  4744. * <p>
  4745. * The second special case is the "Location:" header. Not only does
  4746. * it send this header back to the browser, but it also returns a
  4747. * REDIRECT (302) status code to the browser
  4748. * unless the 201 or
  4749. * a 3xx status code has already been set.
  4750. * </p>
  4751. * <p>
  4752. * ]]>
  4753. * </p>
  4754. * @param replace bool[optional] <p>
  4755. * The optional replace parameter indicates
  4756. * whether the header should replace a previous similar header, or
  4757. * add a second header of the same type. By default it will replace,
  4758. * but if you pass in false as the second argument you can force
  4759. * multiple headers of the same type. For example:
  4760. * </p>
  4761. * <p>
  4762. * ]]>
  4763. * </p>
  4764. * @param http_response_code int[optional] <p>
  4765. * Forces the HTTP response code to the specified value. Note that this
  4766. * parameter only has an effect if the string is
  4767. * not empty.
  4768. * </p>
  4769. * @return void
  4770. */
  4771. function header ($string, $replace = null, $http_response_code = null) {}
  4772. /**
  4773. * Remove previously set headers
  4774. * @link http://www.php.net/manual/en/function.header-remove.php
  4775. * @param name string[optional] <p>
  4776. * The header name to be removed.
  4777. * </p>
  4778. * This parameter is case-insensitive.
  4779. * @return void
  4780. */
  4781. function header_remove ($name = null) {}
  4782. /**
  4783. * Checks if or where headers have been sent
  4784. * @link http://www.php.net/manual/en/function.headers-sent.php
  4785. * @param file string[optional] <p>
  4786. * If the optional file and
  4787. * line parameters are set,
  4788. * headers_sent will put the PHP source file name
  4789. * and line number where output started in the file
  4790. * and line variables.
  4791. * </p>
  4792. * @param line int[optional] <p>
  4793. * The line number where the output started.
  4794. * </p>
  4795. * @return bool headers_sent will return false if no HTTP headers
  4796. * have already been sent or true otherwise.
  4797. */
  4798. function headers_sent (&$file = null, &$line = null) {}
  4799. /**
  4800. * Returns a list of response headers sent (or ready to send)
  4801. * @link http://www.php.net/manual/en/function.headers-list.php
  4802. * @return array a numerically indexed array of headers.
  4803. */
  4804. function headers_list () {}
  4805. /**
  4806. * Get or Set the HTTP response code
  4807. * @link http://www.php.net/manual/en/function.http-response-code.php
  4808. * @param response_code int[optional] <p>
  4809. * The optional response_code will set the response code.
  4810. * </p>
  4811. * <p>
  4812. * ]]>
  4813. * </p>
  4814. * @return int The current response code. By default the return value is int(200).
  4815. */
  4816. function http_response_code ($response_code = null) {}
  4817. /**
  4818. * Check whether client disconnected
  4819. * @link http://www.php.net/manual/en/function.connection-aborted.php
  4820. * @return int 1 if client disconnected, 0 otherwise.
  4821. */
  4822. function connection_aborted () {}
  4823. /**
  4824. * Returns connection status bitfield
  4825. * @link http://www.php.net/manual/en/function.connection-status.php
  4826. * @return int the connection status bitfield, which can be used against the
  4827. * CONNECTION_XXX constants to determine the connection
  4828. * status.
  4829. */
  4830. function connection_status () {}
  4831. /**
  4832. * Set whether a client disconnect should abort script execution
  4833. * @link http://www.php.net/manual/en/function.ignore-user-abort.php
  4834. * @param value string[optional] <p>
  4835. * If set, this function will set the ignore_user_abort ini setting
  4836. * to the given value. If not, this function will
  4837. * only return the previous setting without changing it.
  4838. * </p>
  4839. * @return int the previous setting, as an integer.
  4840. */
  4841. function ignore_user_abort ($value = null) {}
  4842. /**
  4843. * Parse a configuration file
  4844. * @link http://www.php.net/manual/en/function.parse-ini-file.php
  4845. * @param filename string <p>
  4846. * The filename of the ini file being parsed.
  4847. * </p>
  4848. * @param process_sections bool[optional] <p>
  4849. * By setting the process_sections
  4850. * parameter to true, you get a multidimensional array, with
  4851. * the section names and settings included. The default
  4852. * for process_sections is false
  4853. * </p>
  4854. * @param scanner_mode int[optional] <p>
  4855. * Can either be INI_SCANNER_NORMAL (default) or
  4856. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  4857. * is supplied, then option values will not be parsed.
  4858. * </p>
  4859. * @return array The settings are returned as an associative array on success,
  4860. * and false on failure.
  4861. */
  4862. function parse_ini_file ($filename, $process_sections = null, $scanner_mode = null) {}
  4863. /**
  4864. * Parse a configuration string
  4865. * @link http://www.php.net/manual/en/function.parse-ini-string.php
  4866. * @param ini string <p>
  4867. * The contents of the ini file being parsed.
  4868. * </p>
  4869. * @param process_sections bool[optional] <p>
  4870. * By setting the process_sections
  4871. * parameter to true, you get a multidimensional array, with
  4872. * the section names and settings included. The default
  4873. * for process_sections is false
  4874. * </p>
  4875. * @param scanner_mode int[optional] <p>
  4876. * Can either be INI_SCANNER_NORMAL (default) or
  4877. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  4878. * is supplied, then option values will not be parsed.
  4879. * </p>
  4880. * @return array The settings are returned as an associative array on success,
  4881. * and false on failure.
  4882. */
  4883. function parse_ini_string ($ini, $process_sections = null, $scanner_mode = null) {}
  4884. /**
  4885. * Tells whether the file was uploaded via HTTP POST
  4886. * @link http://www.php.net/manual/en/function.is-uploaded-file.php
  4887. * @param filename string <p>
  4888. * The filename being checked.
  4889. * </p>
  4890. * @return bool Returns true on success or false on failure.
  4891. */
  4892. function is_uploaded_file ($filename) {}
  4893. /**
  4894. * Moves an uploaded file to a new location
  4895. * @link http://www.php.net/manual/en/function.move-uploaded-file.php
  4896. * @param filename string <p>
  4897. * The filename of the uploaded file.
  4898. * </p>
  4899. * @param destination string <p>
  4900. * The destination of the moved file.
  4901. * </p>
  4902. * @return bool true on success.
  4903. * </p>
  4904. * <p>
  4905. * If filename is not a valid upload file,
  4906. * then no action will occur, and
  4907. * move_uploaded_file will return
  4908. * false.
  4909. * </p>
  4910. * <p>
  4911. * If filename is a valid upload file, but
  4912. * cannot be moved for some reason, no action will occur, and
  4913. * move_uploaded_file will return
  4914. * false. Additionally, a warning will be issued.
  4915. */
  4916. function move_uploaded_file ($filename, $destination) {}
  4917. /**
  4918. * Get the Internet host name corresponding to a given IP address
  4919. * @link http://www.php.net/manual/en/function.gethostbyaddr.php
  4920. * @param ip_address string <p>
  4921. * The host IP address.
  4922. * </p>
  4923. * @return string the host name on success, the unmodified ip_address
  4924. * on failure, or false on malformed input.
  4925. */
  4926. function gethostbyaddr ($ip_address) {}
  4927. /**
  4928. * Get the IPv4 address corresponding to a given Internet host name
  4929. * @link http://www.php.net/manual/en/function.gethostbyname.php
  4930. * @param hostname string <p>
  4931. * The host name.
  4932. * </p>
  4933. * @return string the IPv4 address or a string containing the unmodified
  4934. * hostname on failure.
  4935. */
  4936. function gethostbyname ($hostname) {}
  4937. /**
  4938. * Get a list of IPv4 addresses corresponding to a given Internet host
  4939. name
  4940. * @link http://www.php.net/manual/en/function.gethostbynamel.php
  4941. * @param hostname string <p>
  4942. * The host name.
  4943. * </p>
  4944. * @return array an array of IPv4 addresses or false if
  4945. * hostname could not be resolved.
  4946. */
  4947. function gethostbynamel ($hostname) {}
  4948. /**
  4949. * Gets the host name
  4950. * @link http://www.php.net/manual/en/function.gethostname.php
  4951. * @return string a string with the hostname on success, otherwise false is
  4952. * returned.
  4953. */
  4954. function gethostname () {}
  4955. /**
  4956. * &Alias; <function>checkdnsrr</function>
  4957. * @link http://www.php.net/manual/en/function.dns-check-record.php
  4958. * @param host
  4959. * @param type[optional]
  4960. */
  4961. function dns_check_record ($host, $type) {}
  4962. /**
  4963. * Check DNS records corresponding to a given Internet host name or IP address
  4964. * @link http://www.php.net/manual/en/function.checkdnsrr.php
  4965. * @param host string <p>
  4966. * host may either be the IP address in
  4967. * dotted-quad notation or the host name.
  4968. * </p>
  4969. * @param type string[optional] <p>
  4970. * type may be any one of: A, MX, NS, SOA,
  4971. * PTR, CNAME, AAAA, A6, SRV, NAPTR, TXT or ANY.
  4972. * </p>
  4973. * @return bool true if any records are found; returns false if no records
  4974. * were found or if an error occurred.
  4975. */
  4976. function checkdnsrr ($host, $type = null) {}
  4977. /**
  4978. * &Alias; <function>getmxrr</function>
  4979. * @link http://www.php.net/manual/en/function.dns-get-mx.php
  4980. * @param hostname
  4981. * @param mxhosts
  4982. * @param weight[optional]
  4983. */
  4984. function dns_get_mx ($hostname, &$mxhosts, &$weight) {}
  4985. /**
  4986. * Get MX records corresponding to a given Internet host name
  4987. * @link http://www.php.net/manual/en/function.getmxrr.php
  4988. * @param hostname string <p>
  4989. * The Internet host name.
  4990. * </p>
  4991. * @param mxhosts array <p>
  4992. * A list of the MX records found is placed into the array
  4993. * mxhosts.
  4994. * </p>
  4995. * @param weight array[optional] <p>
  4996. * If the weight array is given, it will be filled
  4997. * with the weight information gathered.
  4998. * </p>
  4999. * @return bool true if any records are found; returns false if no records
  5000. * were found or if an error occurred.
  5001. */
  5002. function getmxrr ($hostname, array &$mxhosts, array &$weight = null) {}
  5003. /**
  5004. * Fetch DNS Resource Records associated with a hostname
  5005. * @link http://www.php.net/manual/en/function.dns-get-record.php
  5006. * @param hostname string <p>
  5007. * hostname should be a valid DNS hostname such
  5008. * as "www.example.com". Reverse lookups can be generated
  5009. * using in-addr.arpa notation, but
  5010. * gethostbyaddr is more suitable for
  5011. * the majority of reverse lookups.
  5012. * </p>
  5013. * <p>
  5014. * Per DNS standards, email addresses are given in user.host format (for
  5015. * example: hostmaster.example.com as opposed to hostmaster@example.com),
  5016. * be sure to check this value and modify if necessary before using it
  5017. * with a functions such as mail.
  5018. * </p>
  5019. * @param type int[optional] <p>
  5020. * By default, dns_get_record will search for any
  5021. * resource records associated with hostname.
  5022. * To limit the query, specify the optional type
  5023. * parameter. May be any one of the following:
  5024. * DNS_A, DNS_CNAME,
  5025. * DNS_HINFO, DNS_MX,
  5026. * DNS_NS, DNS_PTR,
  5027. * DNS_SOA, DNS_TXT,
  5028. * DNS_AAAA, DNS_SRV,
  5029. * DNS_NAPTR, DNS_A6,
  5030. * DNS_ALL or DNS_ANY.
  5031. * </p>
  5032. * <p>
  5033. * Because of eccentricities in the performance of libresolv
  5034. * between platforms, DNS_ANY will not
  5035. * always return every record, the slower DNS_ALL
  5036. * will collect all records more reliably.
  5037. * </p>
  5038. * @param authns array[optional] <p>
  5039. * Passed by reference and, if given, will be populated with Resource
  5040. * Records for the Authoritative Name Servers.
  5041. * </p>
  5042. * @param addtl array[optional] <p>
  5043. * Passed by reference and, if given, will be populated with any
  5044. * Additional Records.
  5045. * </p>
  5046. * @return array This function returns an array of associative arrays,
  5047. * &return.falseforfailure;. Each associative array contains
  5048. * at minimum the following keys:
  5049. * <table>
  5050. * Basic DNS attributes
  5051. * <tr valign="top">
  5052. * <td>Attribute</td>
  5053. * <td>Meaning</td>
  5054. * </tr>
  5055. * <tr valign="top">
  5056. * <td>host</td>
  5057. * <td>
  5058. * The record in the DNS namespace to which the rest of the associated data refers.
  5059. * </td>
  5060. * </tr>
  5061. * <tr valign="top">
  5062. * <td>class</td>
  5063. * <td>
  5064. * dns_get_record only returns Internet class records and as
  5065. * such this parameter will always return IN.
  5066. * </td>
  5067. * </tr>
  5068. * <tr valign="top">
  5069. * <td>type</td>
  5070. * <td>
  5071. * String containing the record type. Additional attributes will also be contained
  5072. * in the resulting array dependant on the value of type. See table below.
  5073. * </td>
  5074. * </tr>
  5075. * <tr valign="top">
  5076. * <td>ttl</td>
  5077. * <td>
  5078. * "Time To Live" remaining for this record. This will not equal
  5079. * the record's original ttl, but will rather equal the original ttl minus whatever
  5080. * length of time has passed since the authoritative name server was queried.
  5081. * </td>
  5082. * </tr>
  5083. * </table>
  5084. * </p>
  5085. * <p>
  5086. * <table>
  5087. * Other keys in associative arrays dependant on 'type'
  5088. * <tr valign="top">
  5089. * <td>Type</td>
  5090. * <td>Extra Columns</td>
  5091. * </tr>
  5092. * <tr valign="top">
  5093. * <td>A</td>
  5094. * <td>
  5095. * ip: An IPv4 addresses in dotted decimal notation.
  5096. * </td>
  5097. * </tr>
  5098. * <tr valign="top">
  5099. * <td>MX</td>
  5100. * <td>
  5101. * pri: Priority of mail exchanger.
  5102. * Lower numbers indicate greater priority.
  5103. * target: FQDN of the mail exchanger.
  5104. * See also dns_get_mx.
  5105. * </td>
  5106. * </tr>
  5107. * <tr valign="top">
  5108. * <td>CNAME</td>
  5109. * <td>
  5110. * target: FQDN of location in DNS namespace to which
  5111. * the record is aliased.
  5112. * </td>
  5113. * </tr>
  5114. * <tr valign="top">
  5115. * <td>NS</td>
  5116. * <td>
  5117. * target: FQDN of the name server which is authoritative
  5118. * for this hostname.
  5119. * </td>
  5120. * </tr>
  5121. * <tr valign="top">
  5122. * <td>PTR</td>
  5123. * <td>
  5124. * target: Location within the DNS namespace to which
  5125. * this record points.
  5126. * </td>
  5127. * </tr>
  5128. * <tr valign="top">
  5129. * <td>TXT</td>
  5130. * <td>
  5131. * txt: Arbitrary string data associated with this record.
  5132. * </td>
  5133. * </tr>
  5134. * <tr valign="top">
  5135. * <td>HINFO</td>
  5136. * <td>
  5137. * cpu: IANA number designating the CPU of the machine
  5138. * referenced by this record.
  5139. * os: IANA number designating the Operating System on
  5140. * the machine referenced by this record.
  5141. * See IANA's Operating System
  5142. * Names for the meaning of these values.
  5143. * </td>
  5144. * </tr>
  5145. * <tr valign="top">
  5146. * <td>SOA</td>
  5147. * <td>
  5148. * mname: FQDN of the machine from which the resource
  5149. * records originated.
  5150. * rname: Email address of the administrative contain
  5151. * for this domain.
  5152. * serial: Serial # of this revision of the requested
  5153. * domain.
  5154. * refresh: Refresh interval (seconds) secondary name
  5155. * servers should use when updating remote copies of this domain.
  5156. * retry: Length of time (seconds) to wait after a
  5157. * failed refresh before making a second attempt.
  5158. * expire: Maximum length of time (seconds) a secondary
  5159. * DNS server should retain remote copies of the zone data without a
  5160. * successful refresh before discarding.
  5161. * minimum-ttl: Minimum length of time (seconds) a
  5162. * client can continue to use a DNS resolution before it should request
  5163. * a new resolution from the server. Can be overridden by individual
  5164. * resource records.
  5165. * </td>
  5166. * </tr>
  5167. * <tr valign="top">
  5168. * <td>AAAA</td>
  5169. * <td>
  5170. * ipv6: IPv6 address
  5171. * </td>
  5172. * </tr>
  5173. * <tr valign="top">
  5174. * <td>A6(PHP &gt;= 5.1.0)</td>
  5175. * <td>
  5176. * masklen: Length (in bits) to inherit from the target
  5177. * specified by chain.
  5178. * ipv6: Address for this specific record to merge with
  5179. * chain.
  5180. * chain: Parent record to merge with
  5181. * ipv6 data.
  5182. * </td>
  5183. * </tr>
  5184. * <tr valign="top">
  5185. * <td>SRV</td>
  5186. * <td>
  5187. * pri: (Priority) lowest priorities should be used first.
  5188. * weight: Ranking to weight which of commonly prioritized
  5189. * targets should be chosen at random.
  5190. * target and port: hostname and port
  5191. * where the requested service can be found.
  5192. * For additional information see: RFC 2782
  5193. * </td>
  5194. * </tr>
  5195. * <tr valign="top">
  5196. * <td>NAPTR</td>
  5197. * <td>
  5198. * order and pref: Equivalent to
  5199. * pri and weight above.
  5200. * flags, services, regex,
  5201. * and replacement: Parameters as defined by
  5202. * RFC 2915.
  5203. * </td>
  5204. * </tr>
  5205. * </table>
  5206. */
  5207. function dns_get_record ($hostname, $type = null, array &$authns = null, array &$addtl = null) {}
  5208. /**
  5209. * Get the integer value of a variable
  5210. * @link http://www.php.net/manual/en/function.intval.php
  5211. * @param var mixed <p>
  5212. * The scalar value being converted to an integer
  5213. * </p>
  5214. * @param base int[optional] <p>
  5215. * The base for the conversion
  5216. * </p>
  5217. * @return int The integer value of var on success, or 0 on
  5218. * failure. Empty arrays return 0, non-empty arrays return 1.
  5219. * </p>
  5220. * <p>
  5221. * The maximum value depends on the system. 32 bit systems have a
  5222. * maximum signed integer range of -2147483648 to 2147483647. So for example
  5223. * on such a system, intval('1000000000000') will return
  5224. * 2147483647. The maximum signed integer value for 64 bit systems is
  5225. * 9223372036854775807.
  5226. * </p>
  5227. * <p>
  5228. * Strings will most likely return 0 although this depends on the
  5229. * leftmost characters of the string. The common rules of
  5230. * integer casting
  5231. * apply.
  5232. */
  5233. function intval ($var, $base = null) {}
  5234. /**
  5235. * Get float value of a variable
  5236. * @link http://www.php.net/manual/en/function.floatval.php
  5237. * @param var mixed <p>
  5238. * May be any scalar type. floatval should not be used
  5239. * on objects, as doing so will emit an E_NOTICE level
  5240. * error and return 1.
  5241. * </p>
  5242. * @return float The float value of the given variable. Empty arrays return 0, non-empty
  5243. * arrays return 1.
  5244. */
  5245. function floatval ($var) {}
  5246. /**
  5247. * &Alias; <function>floatval</function>
  5248. * @link http://www.php.net/manual/en/function.doubleval.php
  5249. * @param var
  5250. */
  5251. function doubleval ($var) {}
  5252. /**
  5253. * Get string value of a variable
  5254. * @link http://www.php.net/manual/en/function.strval.php
  5255. * @param var mixed <p>
  5256. * The variable that is being converted to a string.
  5257. * </p>
  5258. * <p>
  5259. * var may be any scalar type or an object that
  5260. * implements the __toString()
  5261. * method. You cannot use strval on arrays or on
  5262. * objects that do not implement the
  5263. * __toString() method.
  5264. * </p>
  5265. * @return string The string value of var.
  5266. */
  5267. function strval ($var) {}
  5268. /**
  5269. * Get the type of a variable
  5270. * @link http://www.php.net/manual/en/function.gettype.php
  5271. * @param var mixed <p>
  5272. * The variable being type checked.
  5273. * </p>
  5274. * @return string Possibles values for the returned string are:
  5275. * "boolean"
  5276. * "integer"
  5277. * "double" (for historical reasons "double" is
  5278. * returned in case of a float, and not simply
  5279. * "float")
  5280. * "string"
  5281. * "array"
  5282. * "object"
  5283. * "resource"
  5284. * "NULL"
  5285. * "unknown type"
  5286. */
  5287. function gettype ($var) {}
  5288. /**
  5289. * Set the type of a variable
  5290. * @link http://www.php.net/manual/en/function.settype.php
  5291. * @param var mixed <p>
  5292. * The variable being converted.
  5293. * </p>
  5294. * @param type string <p>
  5295. * Possibles values of type are:
  5296. * "boolean" (or, since PHP 4.2.0, "bool")
  5297. * @return bool Returns true on success or false on failure.
  5298. */
  5299. function settype (&$var, $type) {}
  5300. /**
  5301. * Finds whether a variable is &null;
  5302. * @link http://www.php.net/manual/en/function.is-null.php
  5303. * @param var mixed <p>
  5304. * The variable being evaluated.
  5305. * </p>
  5306. * @return bool true if var is null, false
  5307. * otherwise.
  5308. */
  5309. function is_null ($var) {}
  5310. /**
  5311. * Finds whether a variable is a resource
  5312. * @link http://www.php.net/manual/en/function.is-resource.php
  5313. * @param var mixed <p>
  5314. * The variable being evaluated.
  5315. * </p>
  5316. * @return bool true if var is a resource,
  5317. * false otherwise.
  5318. */
  5319. function is_resource ($var) {}
  5320. /**
  5321. * Finds out whether a variable is a boolean
  5322. * @link http://www.php.net/manual/en/function.is-bool.php
  5323. * @param var mixed <p>
  5324. * The variable being evaluated.
  5325. * </p>
  5326. * @return bool true if var is a boolean,
  5327. * false otherwise.
  5328. */
  5329. function is_bool ($var) {}
  5330. /**
  5331. * &Alias; <function>is_int</function>
  5332. * @link http://www.php.net/manual/en/function.is-long.php
  5333. * @param var
  5334. */
  5335. function is_long ($var) {}
  5336. /**
  5337. * Finds whether the type of a variable is float
  5338. * @link http://www.php.net/manual/en/function.is-float.php
  5339. * @param var mixed <p>
  5340. * The variable being evaluated.
  5341. * </p>
  5342. * @return bool true if var is a float,
  5343. * false otherwise.
  5344. */
  5345. function is_float ($var) {}
  5346. /**
  5347. * Find whether the type of a variable is integer
  5348. * @link http://www.php.net/manual/en/function.is-int.php
  5349. * @param var mixed <p>
  5350. * The variable being evaluated.
  5351. * </p>
  5352. * @return bool true if var is an integer,
  5353. * false otherwise.
  5354. */
  5355. function is_int ($var) {}
  5356. /**
  5357. * &Alias; <function>is_int</function>
  5358. * @link http://www.php.net/manual/en/function.is-integer.php
  5359. * @param var
  5360. */
  5361. function is_integer ($var) {}
  5362. /**
  5363. * &Alias; <function>is_float</function>
  5364. * @link http://www.php.net/manual/en/function.is-double.php
  5365. * @param var
  5366. */
  5367. function is_double ($var) {}
  5368. /**
  5369. * &Alias; <function>is_float</function>
  5370. * @link http://www.php.net/manual/en/function.is-real.php
  5371. * @param var
  5372. */
  5373. function is_real ($var) {}
  5374. /**
  5375. * Finds whether a variable is a number or a numeric string
  5376. * @link http://www.php.net/manual/en/function.is-numeric.php
  5377. * @param var mixed <p>
  5378. * The variable being evaluated.
  5379. * </p>
  5380. * @return bool true if var is a number or a numeric
  5381. * string, false otherwise.
  5382. */
  5383. function is_numeric ($var) {}
  5384. /**
  5385. * Find whether the type of a variable is string
  5386. * @link http://www.php.net/manual/en/function.is-string.php
  5387. * @param var mixed <p>
  5388. * The variable being evaluated.
  5389. * </p>
  5390. * @return bool true if var is of type string,
  5391. * false otherwise.
  5392. */
  5393. function is_string ($var) {}
  5394. /**
  5395. * Finds whether a variable is an array
  5396. * @link http://www.php.net/manual/en/function.is-array.php
  5397. * @param var mixed <p>
  5398. * The variable being evaluated.
  5399. * </p>
  5400. * @return bool true if var is an array,
  5401. * false otherwise.
  5402. */
  5403. function is_array ($var) {}
  5404. /**
  5405. * Finds whether a variable is an object
  5406. * @link http://www.php.net/manual/en/function.is-object.php
  5407. * @param var mixed <p>
  5408. * The variable being evaluated.
  5409. * </p>
  5410. * @return bool true if var is an object,
  5411. * false otherwise.
  5412. */
  5413. function is_object ($var) {}
  5414. /**
  5415. * Finds whether a variable is a scalar
  5416. * @link http://www.php.net/manual/en/function.is-scalar.php
  5417. * @param var mixed <p>
  5418. * The variable being evaluated.
  5419. * </p>
  5420. * @return bool true if var is a scalar false
  5421. * otherwise.
  5422. */
  5423. function is_scalar ($var) {}
  5424. /**
  5425. * Verify that the contents of a variable can be called as a function
  5426. * @link http://www.php.net/manual/en/function.is-callable.php
  5427. * @param name callable <p>
  5428. * The callback function to check
  5429. * </p>
  5430. * @param syntax_only bool[optional] <p>
  5431. * If set to true the function only verifies that
  5432. * name might be a function or method. It will only
  5433. * reject simple variables that are not strings, or an array that does
  5434. * not have a valid structure to be used as a callback. The valid ones
  5435. * are supposed to have only 2 entries, the first of which is an object
  5436. * or a string, and the second a string.
  5437. * </p>
  5438. * @param callable_name string[optional] <p>
  5439. * Receives the "callable name". In the example below it is
  5440. * "someClass::someMethod". Note, however, that despite the implication
  5441. * that someClass::SomeMethod() is a callable static method, this is not
  5442. * the case.
  5443. * </p>
  5444. * @return bool true if name is callable, false
  5445. * otherwise.
  5446. */
  5447. function is_callable ($name, $syntax_only = null, &$callable_name = null) {}
  5448. /**
  5449. * Closes process file pointer
  5450. * @link http://www.php.net/manual/en/function.pclose.php
  5451. * @param handle resource <p>
  5452. * The file pointer must be valid, and must have been returned by a
  5453. * successful call to popen.
  5454. * </p>
  5455. * @return int the termination status of the process that was run. In case of
  5456. * an error then -1 is returned.
  5457. */
  5458. function pclose ($handle) {}
  5459. /**
  5460. * Opens process file pointer
  5461. * @link http://www.php.net/manual/en/function.popen.php
  5462. * @param command string <p>
  5463. * The command
  5464. * </p>
  5465. * @param mode string <p>
  5466. * The mode
  5467. * </p>
  5468. * @return resource a file pointer identical to that returned by
  5469. * fopen, except that it is unidirectional (may
  5470. * only be used for reading or writing) and must be closed with
  5471. * pclose. This pointer may be used with
  5472. * fgets, fgetss, and
  5473. * fwrite. When the mode is 'r', the returned
  5474. * file pointer equals to the STDOUT of the command, when the mode
  5475. * is 'w', the returned file pointer equals to the STDIN of the
  5476. * command.
  5477. * </p>
  5478. * <p>
  5479. * If an error occurs, returns false.
  5480. */
  5481. function popen ($command, $mode) {}
  5482. /**
  5483. * Outputs a file
  5484. * @link http://www.php.net/manual/en/function.readfile.php
  5485. * @param filename string <p>
  5486. * The filename being read.
  5487. * </p>
  5488. * @param use_include_path bool[optional] <p>
  5489. * You can use the optional second parameter and set it to true, if
  5490. * you want to search for the file in the include_path, too.
  5491. * </p>
  5492. * @param context resource[optional] <p>
  5493. * A context stream resource.
  5494. * </p>
  5495. * @return int the number of bytes read from the file. If an error
  5496. * occurs, false is returned and unless the function was called as
  5497. * @readfile, an error message is printed.
  5498. */
  5499. function readfile ($filename, $use_include_path = null, $context = null) {}
  5500. /**
  5501. * Rewind the position of a file pointer
  5502. * @link http://www.php.net/manual/en/function.rewind.php
  5503. * @param handle resource <p>
  5504. * The file pointer must be valid, and must point to a file
  5505. * successfully opened by fopen.
  5506. * </p>
  5507. * @return bool Returns true on success or false on failure.
  5508. */
  5509. function rewind ($handle) {}
  5510. /**
  5511. * Removes directory
  5512. * @link http://www.php.net/manual/en/function.rmdir.php
  5513. * @param dirname string <p>
  5514. * Path to the directory.
  5515. * </p>
  5516. * @param context resource[optional] &note.context-support;
  5517. * @return bool Returns true on success or false on failure.
  5518. */
  5519. function rmdir ($dirname, $context = null) {}
  5520. /**
  5521. * Changes the current umask
  5522. * @link http://www.php.net/manual/en/function.umask.php
  5523. * @param mask int[optional] <p>
  5524. * The new umask.
  5525. * </p>
  5526. * @return int umask without arguments simply returns the
  5527. * current umask otherwise the old umask is returned.
  5528. */
  5529. function umask ($mask = null) {}
  5530. /**
  5531. * Closes an open file pointer
  5532. * @link http://www.php.net/manual/en/function.fclose.php
  5533. * @param handle resource <p>
  5534. * The file pointer must be valid, and must point to a file successfully
  5535. * opened by fopen or fsockopen.
  5536. * </p>
  5537. * @return bool Returns true on success or false on failure.
  5538. */
  5539. function fclose ($handle) {}
  5540. /**
  5541. * Tests for end-of-file on a file pointer
  5542. * @link http://www.php.net/manual/en/function.feof.php
  5543. * @param handle resource &fs.validfp.all;
  5544. * @return bool true if the file pointer is at EOF or an error occurs
  5545. * (including socket timeout); otherwise returns false.
  5546. */
  5547. function feof ($handle) {}
  5548. /**
  5549. * Gets character from file pointer
  5550. * @link http://www.php.net/manual/en/function.fgetc.php
  5551. * @param handle resource &fs.validfp.all;
  5552. * @return string a string containing a single character read from the file pointed
  5553. * to by handle. Returns false on EOF.
  5554. */
  5555. function fgetc ($handle) {}
  5556. /**
  5557. * Gets line from file pointer
  5558. * @link http://www.php.net/manual/en/function.fgets.php
  5559. * @param handle resource &fs.validfp.all;
  5560. * @param length int[optional] <p>
  5561. * Reading ends when length - 1 bytes have been
  5562. * read, on a newline (which is included in the return value), or on EOF
  5563. * (whichever comes first). If no length is specified, it will keep
  5564. * reading from the stream until it reaches the end of the line.
  5565. * </p>
  5566. * <p>
  5567. * Until PHP 4.3.0, omitting it would assume 1024 as the line length.
  5568. * If the majority of the lines in the file are all larger than 8KB,
  5569. * it is more resource efficient for your script to specify the maximum
  5570. * line length.
  5571. * </p>
  5572. * @return string a string of up to length - 1 bytes read from
  5573. * the file pointed to by handle. If there is no more data
  5574. * to read in the file pointer, then false is returned.
  5575. * </p>
  5576. * <p>
  5577. * If an error occurs, false is returned.
  5578. */
  5579. function fgets ($handle, $length = null) {}
  5580. /**
  5581. * Gets line from file pointer and strip HTML tags
  5582. * @link http://www.php.net/manual/en/function.fgetss.php
  5583. * @param handle resource &fs.validfp.all;
  5584. * @param length int[optional] <p>
  5585. * Length of the data to be retrieved.
  5586. * </p>
  5587. * @param allowable_tags string[optional] <p>
  5588. * You can use the optional third parameter to specify tags which should
  5589. * not be stripped.
  5590. * </p>
  5591. * @return string a string of up to length - 1 bytes read from
  5592. * the file pointed to by handle, with all HTML and PHP
  5593. * code stripped.
  5594. * </p>
  5595. * <p>
  5596. * If an error occurs, returns false.
  5597. */
  5598. function fgetss ($handle, $length = null, $allowable_tags = null) {}
  5599. /**
  5600. * Binary-safe file read
  5601. * @link http://www.php.net/manual/en/function.fread.php
  5602. * @param handle resource &fs.file.pointer;
  5603. * @param length int <p>
  5604. * Up to length number of bytes read.
  5605. * </p>
  5606. * @return string the read string &return.falseforfailure;.
  5607. */
  5608. function fread ($handle, $length) {}
  5609. /**
  5610. * Opens file or URL
  5611. * @link http://www.php.net/manual/en/function.fopen.php
  5612. * @param filename string <p>
  5613. * If filename is of the form "scheme://...", it
  5614. * is assumed to be a URL and PHP will search for a protocol handler
  5615. * (also known as a wrapper) for that scheme. If no wrappers for that
  5616. * protocol are registered, PHP will emit a notice to help you track
  5617. * potential problems in your script and then continue as though
  5618. * filename specifies a regular file.
  5619. * </p>
  5620. * <p>
  5621. * If PHP has decided that filename specifies
  5622. * a local file, then it will try to open a stream on that file.
  5623. * The file must be accessible to PHP, so you need to ensure that
  5624. * the file access permissions allow this access.
  5625. * If you have enabled &safemode;,
  5626. * or open_basedir further
  5627. * restrictions may apply.
  5628. * </p>
  5629. * <p>
  5630. * If PHP has decided that filename specifies
  5631. * a registered protocol, and that protocol is registered as a
  5632. * network URL, PHP will check to make sure that
  5633. * allow_url_fopen is
  5634. * enabled. If it is switched off, PHP will emit a warning and
  5635. * the fopen call will fail.
  5636. * </p>
  5637. * <p>
  5638. * The list of supported protocols can be found in . Some protocols (also referred to as
  5639. * wrappers) support context
  5640. * and/or &php.ini; options. Refer to the specific page for the
  5641. * protocol in use for a list of options which can be set. (e.g.
  5642. * &php.ini; value user_agent used by the
  5643. * http wrapper).
  5644. * </p>
  5645. * <p>
  5646. * On the Windows platform, be careful to escape any backslashes
  5647. * used in the path to the file, or use forward slashes.
  5648. * ]]>
  5649. * </p>
  5650. * @param mode string <p>
  5651. * The mode parameter specifies the type of access
  5652. * you require to the stream. It may be any of the following:
  5653. * <table>
  5654. * A list of possible modes for fopen
  5655. * using mode
  5656. * <tr valign="top">
  5657. * <td>mode</td>
  5658. * <td>Description</td>
  5659. * </tr>
  5660. * <tr valign="top">
  5661. * <td>'r'</td>
  5662. * <td>
  5663. * Open for reading only; place the file pointer at the
  5664. * beginning of the file.
  5665. * </td>
  5666. * </tr>
  5667. * <tr valign="top">
  5668. * <td>'r+'</td>
  5669. * <td>
  5670. * Open for reading and writing; place the file pointer at
  5671. * the beginning of the file.
  5672. * </td>
  5673. * </tr>
  5674. * <tr valign="top">
  5675. * <td>'w'</td>
  5676. * <td>
  5677. * Open for writing only; place the file pointer at the
  5678. * beginning of the file and truncate the file to zero length.
  5679. * If the file does not exist, attempt to create it.
  5680. * </td>
  5681. * </tr>
  5682. * <tr valign="top">
  5683. * <td>'w+'</td>
  5684. * <td>
  5685. * Open for reading and writing; place the file pointer at
  5686. * the beginning of the file and truncate the file to zero
  5687. * length. If the file does not exist, attempt to create it.
  5688. * </td>
  5689. * </tr>
  5690. * <tr valign="top">
  5691. * <td>'a'</td>
  5692. * <td>
  5693. * Open for writing only; place the file pointer at the end of
  5694. * the file. If the file does not exist, attempt to create it.
  5695. * </td>
  5696. * </tr>
  5697. * <tr valign="top">
  5698. * <td>'a+'</td>
  5699. * <td>
  5700. * Open for reading and writing; place the file pointer at
  5701. * the end of the file. If the file does not exist, attempt to
  5702. * create it.
  5703. * </td>
  5704. * </tr>
  5705. * <tr valign="top">
  5706. * <td>'x'</td>
  5707. * <td>
  5708. * Create and open for writing only; place the file pointer at the
  5709. * beginning of the file. If the file already exists, the
  5710. * fopen call will fail by returning false and
  5711. * generating an error of level E_WARNING. If
  5712. * the file does not exist, attempt to create it. This is equivalent
  5713. * to specifying O_EXCL|O_CREAT flags for the
  5714. * underlying open(2) system call.
  5715. * </td>
  5716. * </tr>
  5717. * <tr valign="top">
  5718. * <td>'x+'</td>
  5719. * <td>
  5720. * Create and open for reading and writing; otherwise it has the
  5721. * same behavior as 'x'.
  5722. * </td>
  5723. * </tr>
  5724. * <tr valign="top">
  5725. * <td>'c'</td>
  5726. * <td>
  5727. * Open the file for writing only. If the file does not exist, it is
  5728. * created. If it exists, it is neither truncated (as opposed to
  5729. * 'w'), nor the call to this function fails (as is
  5730. * the case with 'x'). The file pointer is
  5731. * positioned on the beginning of the file. This may be useful if it's
  5732. * desired to get an advisory lock (see flock)
  5733. * before attempting to modify the file, as using
  5734. * 'w' could truncate the file before the lock
  5735. * was obtained (if truncation is desired,
  5736. * ftruncate can be used after the lock is
  5737. * requested).
  5738. * </td>
  5739. * </tr>
  5740. * <tr valign="top">
  5741. * <td>'c+'</td>
  5742. * <td>
  5743. * Open the file for reading and writing; otherwise it has the same
  5744. * behavior as 'c'.
  5745. * </td>
  5746. * </tr>
  5747. * </table>
  5748. * </p>
  5749. * <p>
  5750. * Different operating system families have different line-ending
  5751. * conventions. When you write a text file and want to insert a line
  5752. * break, you need to use the correct line-ending character(s) for your
  5753. * operating system. Unix based systems use \n as the
  5754. * line ending character, Windows based systems use \r\n
  5755. * as the line ending characters and Macintosh based systems use
  5756. * \r as the line ending character.
  5757. * </p>
  5758. * <p>
  5759. * If you use the wrong line ending characters when writing your files, you
  5760. * might find that other applications that open those files will "look
  5761. * funny".
  5762. * </p>
  5763. * <p>
  5764. * Windows offers a text-mode translation flag ('t')
  5765. * which will transparently translate \n to
  5766. * \r\n when working with the file. In contrast, you
  5767. * can also use 'b' to force binary mode, which will not
  5768. * translate your data. To use these flags, specify either
  5769. * 'b' or 't' as the last character
  5770. * of the mode parameter.
  5771. * </p>
  5772. * <p>
  5773. * The default translation mode depends on the SAPI and version of PHP that
  5774. * you are using, so you are encouraged to always specify the appropriate
  5775. * flag for portability reasons. You should use the 't'
  5776. * mode if you are working with plain-text files and you use
  5777. * \n to delimit your line endings in your script, but
  5778. * expect your files to be readable with applications such as notepad. You
  5779. * should use the 'b' in all other cases.
  5780. * </p>
  5781. * <p>
  5782. * If you do not specify the 'b' flag when working with binary files, you
  5783. * may experience strange problems with your data, including broken image
  5784. * files and strange problems with \r\n characters.
  5785. * </p>
  5786. * <p>
  5787. * For portability, it is strongly recommended that you always
  5788. * use the 'b' flag when opening files with fopen.
  5789. * </p>
  5790. * <p>
  5791. * Again, for portability, it is also strongly recommended that
  5792. * you re-write code that uses or relies upon the 't'
  5793. * mode so that it uses the correct line endings and
  5794. * 'b' mode instead.
  5795. * </p>
  5796. * @param use_include_path bool[optional] <p>
  5797. * The optional third use_include_path parameter
  5798. * can be set to '1' or true if you want to search for the file in the
  5799. * include_path, too.
  5800. * </p>
  5801. * @param context resource[optional] &note.context-support;
  5802. * @return resource a file pointer resource on success, or false on error.
  5803. */
  5804. function fopen ($filename, $mode, $use_include_path = null, $context = null) {}
  5805. /**
  5806. * Output all remaining data on a file pointer
  5807. * @link http://www.php.net/manual/en/function.fpassthru.php
  5808. * @param handle resource &fs.validfp.all;
  5809. * @return int If an error occurs, fpassthru returns
  5810. * false. Otherwise, fpassthru returns
  5811. * the number of characters read from handle
  5812. * and passed through to the output.
  5813. */
  5814. function fpassthru ($handle) {}
  5815. /**
  5816. * Truncates a file to a given length
  5817. * @link http://www.php.net/manual/en/function.ftruncate.php
  5818. * @param handle resource <p>
  5819. * The file pointer.
  5820. * </p>
  5821. * <p>
  5822. * The handle must be open for writing.
  5823. * </p>
  5824. * @param size int <p>
  5825. * The size to truncate to.
  5826. * </p>
  5827. * <p>
  5828. * If size is larger than the file then the file
  5829. * is extended with null bytes.
  5830. * </p>
  5831. * <p>
  5832. * If size is smaller than the file then the file
  5833. * is truncated to that size.
  5834. * </p>
  5835. * @return bool Returns true on success or false on failure.
  5836. */
  5837. function ftruncate ($handle, $size) {}
  5838. /**
  5839. * Gets information about a file using an open file pointer
  5840. * @link http://www.php.net/manual/en/function.fstat.php
  5841. * @param handle resource &fs.file.pointer;
  5842. * @return array an array with the statistics of the file; the format of the array
  5843. * is described in detail on the stat manual page.
  5844. */
  5845. function fstat ($handle) {}
  5846. /**
  5847. * Seeks on a file pointer
  5848. * @link http://www.php.net/manual/en/function.fseek.php
  5849. * @param handle resource &fs.file.pointer;
  5850. * @param offset int <p>
  5851. * The offset.
  5852. * </p>
  5853. * <p>
  5854. * To move to a position before the end-of-file, you need to pass
  5855. * a negative value in offset and
  5856. * set whence
  5857. * to SEEK_END.
  5858. * </p>
  5859. * @param whence int[optional] <p>
  5860. * whence values are:
  5861. * SEEK_SET - Set position equal to offset bytes.
  5862. * SEEK_CUR - Set position to current location plus offset.
  5863. * SEEK_END - Set position to end-of-file plus offset.
  5864. * </p>
  5865. * @return int Upon success, returns 0; otherwise, returns -1.
  5866. */
  5867. function fseek ($handle, $offset, $whence = null) {}
  5868. /**
  5869. * Returns the current position of the file read/write pointer
  5870. * @link http://www.php.net/manual/en/function.ftell.php
  5871. * @param handle resource <p>
  5872. * The file pointer must be valid, and must point to a file successfully
  5873. * opened by fopen or popen.
  5874. * ftell gives undefined results for append-only streams
  5875. * (opened with "a" flag).
  5876. * </p>
  5877. * @return int the position of the file pointer referenced by
  5878. * handle as an integer; i.e., its offset into the file stream.
  5879. * </p>
  5880. * <p>
  5881. * If an error occurs, returns false.
  5882. */
  5883. function ftell ($handle) {}
  5884. /**
  5885. * Flushes the output to a file
  5886. * @link http://www.php.net/manual/en/function.fflush.php
  5887. * @param handle resource &fs.validfp.all;
  5888. * @return bool Returns true on success or false on failure.
  5889. */
  5890. function fflush ($handle) {}
  5891. /**
  5892. * Binary-safe file write
  5893. * @link http://www.php.net/manual/en/function.fwrite.php
  5894. * @param handle resource &fs.file.pointer;
  5895. * @param string string <p>
  5896. * The string that is to be written.
  5897. * </p>
  5898. * @param length int[optional] <p>
  5899. * If the length argument is given, writing will
  5900. * stop after length bytes have been written or
  5901. * the end of string is reached, whichever comes
  5902. * first.
  5903. * </p>
  5904. * <p>
  5905. * Note that if the length argument is given,
  5906. * then the magic_quotes_runtime
  5907. * configuration option will be ignored and no slashes will be
  5908. * stripped from string.
  5909. * </p>
  5910. * @return int
  5911. */
  5912. function fwrite ($handle, $string, $length = null) {}
  5913. /**
  5914. * &Alias; <function>fwrite</function>
  5915. * @link http://www.php.net/manual/en/function.fputs.php
  5916. * @param fp
  5917. * @param str
  5918. * @param length[optional]
  5919. */
  5920. function fputs ($fp, $str, $length) {}
  5921. /**
  5922. * Makes directory
  5923. * @link http://www.php.net/manual/en/function.mkdir.php
  5924. * @param pathname string <p>
  5925. * The directory path.
  5926. * </p>
  5927. * @param mode int[optional] <p>
  5928. * The mode is 0777 by default, which means the widest possible
  5929. * access. For more information on modes, read the details
  5930. * on the chmod page.
  5931. * </p>
  5932. * <p>
  5933. * mode is ignored on Windows.
  5934. * </p>
  5935. * <p>
  5936. * Note that you probably want to specify the mode as an octal number,
  5937. * which means it should have a leading zero. The mode is also modified
  5938. * by the current umask, which you can change using
  5939. * umask.
  5940. * </p>
  5941. * @param recursive bool[optional] <p>
  5942. * Allows the creation of nested directories specified in the
  5943. * pathname.
  5944. * </p>
  5945. * @param context resource[optional] &note.context-support;
  5946. * @return bool Returns true on success or false on failure.
  5947. */
  5948. function mkdir ($pathname, $mode = null, $recursive = null, $context = null) {}
  5949. /**
  5950. * Renames a file or directory
  5951. * @link http://www.php.net/manual/en/function.rename.php
  5952. * @param oldname string <p>
  5953. * </p>
  5954. * <p>
  5955. * The old name. The wrapper used in oldname
  5956. * must match the wrapper used in
  5957. * newname.
  5958. * </p>
  5959. * @param newname string <p>
  5960. * The new name.
  5961. * </p>
  5962. * @param context resource[optional] &note.context-support;
  5963. * @return bool Returns true on success or false on failure.
  5964. */
  5965. function rename ($oldname, $newname, $context = null) {}
  5966. /**
  5967. * Copies file
  5968. * @link http://www.php.net/manual/en/function.copy.php
  5969. * @param source string <p>
  5970. * Path to the source file.
  5971. * </p>
  5972. * @param dest string <p>
  5973. * The destination path. If dest is a URL, the
  5974. * copy operation may fail if the wrapper does not support overwriting of
  5975. * existing files.
  5976. * </p>
  5977. * <p>
  5978. * If the destination file already exists, it will be overwritten.
  5979. * </p>
  5980. * @param context resource[optional] <p>
  5981. * A valid context resource created with
  5982. * stream_context_create.
  5983. * </p>
  5984. * @return bool Returns true on success or false on failure.
  5985. */
  5986. function copy ($source, $dest, $context = null) {}
  5987. /**
  5988. * Create file with unique file name
  5989. * @link http://www.php.net/manual/en/function.tempnam.php
  5990. * @param dir string <p>
  5991. * The directory where the temporary filename will be created.
  5992. * </p>
  5993. * @param prefix string <p>
  5994. * The prefix of the generated temporary filename.
  5995. * </p>
  5996. * Windows uses only the first three characters of prefix.
  5997. * @return string the new temporary filename, or false on
  5998. * failure.
  5999. */
  6000. function tempnam ($dir, $prefix) {}
  6001. /**
  6002. * Creates a temporary file
  6003. * @link http://www.php.net/manual/en/function.tmpfile.php
  6004. * @return resource a file handle, similar to the one returned by
  6005. * fopen, for the new file&return.falseforfailure;.
  6006. */
  6007. function tmpfile () {}
  6008. /**
  6009. * Reads entire file into an array
  6010. * @link http://www.php.net/manual/en/function.file.php
  6011. * @param filename string <p>
  6012. * Path to the file.
  6013. * </p>
  6014. * &tip.fopen-wrapper;
  6015. * @param flags int[optional] <p>
  6016. * The optional parameter flags can be one, or
  6017. * more, of the following constants:
  6018. * FILE_USE_INCLUDE_PATH
  6019. * Search for the file in the include_path.
  6020. * @param context resource[optional] <p>
  6021. * A context resource created with the
  6022. * stream_context_create function.
  6023. * </p>
  6024. * <p>
  6025. * &note.context-support;
  6026. * </p>
  6027. * @return array the file in an array. Each element of the array corresponds to a
  6028. * line in the file, with the newline still attached. Upon failure,
  6029. * file returns false.
  6030. * </p>
  6031. * <p>
  6032. * Each line in the resulting array will include the line ending, unless
  6033. * FILE_IGNORE_NEW_LINES is used, so you still need to
  6034. * use rtrim if you do not want the line ending
  6035. * present.
  6036. */
  6037. function file ($filename, $flags = null, $context = null) {}
  6038. /**
  6039. * Reads entire file into a string
  6040. * @link http://www.php.net/manual/en/function.file-get-contents.php
  6041. * @param filename string <p>
  6042. * Name of the file to read.
  6043. * </p>
  6044. * @param use_include_path bool[optional] <p>
  6045. * As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
  6046. * to trigger include path
  6047. * search.
  6048. * </p>
  6049. * @param context resource[optional] <p>
  6050. * A valid context resource created with
  6051. * stream_context_create. If you don't need to use a
  6052. * custom context, you can skip this parameter by &null;.
  6053. * </p>
  6054. * @param offset int[optional] <p>
  6055. * The offset where the reading starts on the original stream.
  6056. * </p>
  6057. * <p>
  6058. * Seeking (offset) is not supported with remote files.
  6059. * Attempting to seek on non-local files may work with small offsets, but this
  6060. * is unpredictable because it works on the buffered stream.
  6061. * </p>
  6062. * @param maxlen int[optional] <p>
  6063. * Maximum length of data read. The default is to read until end
  6064. * of file is reached. Note that this parameter is applied to the
  6065. * stream processed by the filters.
  6066. * </p>
  6067. * @return string The function returns the read data&return.falseforfailure;.
  6068. */
  6069. function file_get_contents ($filename, $use_include_path = null, $context = null, $offset = null, $maxlen = null) {}
  6070. /**
  6071. * Write a string to a file
  6072. * @link http://www.php.net/manual/en/function.file-put-contents.php
  6073. * @param filename string <p>
  6074. * Path to the file where to write the data.
  6075. * </p>
  6076. * @param data mixed <p>
  6077. * The data to write. Can be either a string, an
  6078. * array or a stream resource.
  6079. * </p>
  6080. * <p>
  6081. * If data is a stream resource, the
  6082. * remaining buffer of that stream will be copied to the specified file.
  6083. * This is similar with using stream_copy_to_stream.
  6084. * </p>
  6085. * <p>
  6086. * You can also specify the data parameter as a single
  6087. * dimension array. This is equivalent to
  6088. * file_put_contents($filename, implode('', $array)).
  6089. * </p>
  6090. * @param flags int[optional] <p>
  6091. * The value of flags can be any combination of
  6092. * the following flags, joined with the binary OR (|)
  6093. * operator.
  6094. * </p>
  6095. * <p>
  6096. * <table>
  6097. * Available flags
  6098. * <tr valign="top">
  6099. * <td>Flag</td>
  6100. * <td>Description</td>
  6101. * </tr>
  6102. * <tr valign="top">
  6103. * <td>
  6104. * FILE_USE_INCLUDE_PATH
  6105. * </td>
  6106. * <td>
  6107. * Search for filename in the include directory.
  6108. * See include_path for more
  6109. * information.
  6110. * </td>
  6111. * </tr>
  6112. * <tr valign="top">
  6113. * <td>
  6114. * FILE_APPEND
  6115. * </td>
  6116. * <td>
  6117. * If file filename already exists, append
  6118. * the data to the file instead of overwriting it.
  6119. * </td>
  6120. * </tr>
  6121. * <tr valign="top">
  6122. * <td>
  6123. * LOCK_EX
  6124. * </td>
  6125. * <td>
  6126. * Acquire an exclusive lock on the file while proceeding to the
  6127. * writing.
  6128. * </td>
  6129. * </tr>
  6130. * </table>
  6131. * </p>
  6132. * @param context resource[optional] <p>
  6133. * A valid context resource created with
  6134. * stream_context_create.
  6135. * </p>
  6136. * @return int The function returns the number of bytes that were written to the file, or
  6137. * false on failure.
  6138. */
  6139. function file_put_contents ($filename, $data, $flags = null, $context = null) {}
  6140. /**
  6141. * Runs the equivalent of the select() system call on the given
  6142. arrays of streams with a timeout specified by tv_sec and tv_usec
  6143. * @link http://www.php.net/manual/en/function.stream-select.php
  6144. * @param read array <p>
  6145. * The streams listed in the read array will be watched to
  6146. * see if characters become available for reading (more precisely, to see if
  6147. * a read will not block - in particular, a stream resource is also ready on
  6148. * end-of-file, in which case an fread will return
  6149. * a zero length string).
  6150. * </p>
  6151. * @param write array <p>
  6152. * The streams listed in the write array will be
  6153. * watched to see if a write will not block.
  6154. * </p>
  6155. * @param except array <p>
  6156. * The streams listed in the except array will be
  6157. * watched for high priority exceptional ("out-of-band") data arriving.
  6158. * </p>
  6159. * <p>
  6160. * When stream_select returns, the arrays
  6161. * read, write and
  6162. * except are modified to indicate which stream
  6163. * resource(s) actually changed status.
  6164. * </p>
  6165. * You do not need to pass every array to
  6166. * stream_select. You can leave it out and use an
  6167. * empty array or &null; instead. Also do not forget that those arrays are
  6168. * passed by reference and will be modified after
  6169. * stream_select returns.
  6170. * @param tv_sec int <p>
  6171. * The tv_sec and tv_usec
  6172. * together form the timeout parameter,
  6173. * tv_sec specifies the number of seconds while
  6174. * tv_usec the number of microseconds.
  6175. * The timeout is an upper bound on the amount of time
  6176. * that stream_select will wait before it returns.
  6177. * If tv_sec and tv_usec are
  6178. * both set to 0, stream_select will
  6179. * not wait for data - instead it will return immediately, indicating the
  6180. * current status of the streams.
  6181. * </p>
  6182. * <p>
  6183. * If tv_sec is &null; stream_select
  6184. * can block indefinitely, returning only when an event on one of the
  6185. * watched streams occurs (or if a signal interrupts the system call).
  6186. * </p>
  6187. * <p>
  6188. * Using a timeout value of 0 allows you to
  6189. * instantaneously poll the status of the streams, however, it is NOT a
  6190. * good idea to use a 0 timeout value in a loop as it
  6191. * will cause your script to consume too much CPU time.
  6192. * </p>
  6193. * <p>
  6194. * It is much better to specify a timeout value of a few seconds, although
  6195. * if you need to be checking and running other code concurrently, using a
  6196. * timeout value of at least 200000 microseconds will
  6197. * help reduce the CPU usage of your script.
  6198. * </p>
  6199. * <p>
  6200. * Remember that the timeout value is the maximum time that will elapse;
  6201. * stream_select will return as soon as the
  6202. * requested streams are ready for use.
  6203. * </p>
  6204. * @param tv_usec int[optional] <p>
  6205. * See tv_sec description.
  6206. * </p>
  6207. * @return int On success stream_select returns the number of
  6208. * stream resources contained in the modified arrays, which may be zero if
  6209. * the timeout expires before anything interesting happens. On error false
  6210. * is returned and a warning raised (this can happen if the system call is
  6211. * interrupted by an incoming signal).
  6212. */
  6213. function stream_select (array &$read, array &$write, array &$except, $tv_sec, $tv_usec = null) {}
  6214. /**
  6215. * Creates a stream context
  6216. * @link http://www.php.net/manual/en/function.stream-context-create.php
  6217. * @param options array[optional] <p>
  6218. * Must be an associative array of associative arrays in the format
  6219. * $arr['wrapper']['option'] = $value.
  6220. * </p>
  6221. * <p>
  6222. * Default to an empty array.
  6223. * </p>
  6224. * @param params array[optional] <p>
  6225. * Must be an associative array in the format
  6226. * $arr['parameter'] = $value.
  6227. * Refer to context parameters for
  6228. * a listing of standard stream parameters.
  6229. * </p>
  6230. * @return resource A stream context resource.
  6231. */
  6232. function stream_context_create (array $options = null, array $params = null) {}
  6233. /**
  6234. * Set parameters for a stream/wrapper/context
  6235. * @link http://www.php.net/manual/en/function.stream-context-set-params.php
  6236. * @param stream_or_context resource <p>
  6237. * The stream or context to apply the parameters too.
  6238. * </p>
  6239. * @param params array <p>
  6240. * An array of parameters to set.
  6241. * </p>
  6242. * <p>
  6243. * params should be an associative array of the structure:
  6244. * $params['paramname'] = "paramvalue";.
  6245. * </p>
  6246. * @return bool Returns true on success or false on failure.
  6247. */
  6248. function stream_context_set_params ($stream_or_context, array $params) {}
  6249. /**
  6250. * Retrieves parameters from a context
  6251. * @link http://www.php.net/manual/en/function.stream-context-get-params.php
  6252. * @param stream_or_context resource <p>
  6253. * A stream resource or a
  6254. * context resource
  6255. * </p>
  6256. * @return array an associate array containing all context options and parameters.
  6257. */
  6258. function stream_context_get_params ($stream_or_context) {}
  6259. /**
  6260. * Sets an option for a stream/wrapper/context
  6261. * @link http://www.php.net/manual/en/function.stream-context-set-option.php
  6262. * @param stream_or_context resource <p>
  6263. * The stream or context resource to apply the options too.
  6264. * </p>
  6265. * @param wrapper string
  6266. * @param option string
  6267. * @param value mixed
  6268. * @return bool Returns true on success or false on failure.
  6269. */
  6270. function stream_context_set_option ($stream_or_context, $wrapper, $option, $value) {}
  6271. /**
  6272. * Retrieve options for a stream/wrapper/context
  6273. * @link http://www.php.net/manual/en/function.stream-context-get-options.php
  6274. * @param stream_or_context resource <p>
  6275. * The stream or context to get options from
  6276. * </p>
  6277. * @return array an associative array with the options.
  6278. */
  6279. function stream_context_get_options ($stream_or_context) {}
  6280. /**
  6281. * Retrieve the default stream context
  6282. * @link http://www.php.net/manual/en/function.stream-context-get-default.php
  6283. * @param options array[optional] options must be an associative
  6284. * array of associative arrays in the format
  6285. * $arr['wrapper']['option'] = $value.
  6286. * <p>
  6287. * As of PHP 5.3.0, the stream_context_set_default function
  6288. * can be used to set the default context.
  6289. * </p>
  6290. * @return resource A stream context resource.
  6291. */
  6292. function stream_context_get_default (array $options = null) {}
  6293. /**
  6294. * Set the default stream context
  6295. * @link http://www.php.net/manual/en/function.stream-context-set-default.php
  6296. * @param options array <p>
  6297. * The options to set for the default context.
  6298. * </p>
  6299. * <p>
  6300. * options must be an associative
  6301. * array of associative arrays in the format
  6302. * $arr['wrapper']['option'] = $value.
  6303. * </p>
  6304. * @return resource the default stream context.
  6305. */
  6306. function stream_context_set_default (array $options) {}
  6307. /**
  6308. * Attach a filter to a stream
  6309. * @link http://www.php.net/manual/en/function.stream-filter-prepend.php
  6310. * @param stream resource <p>
  6311. * The target stream.
  6312. * </p>
  6313. * @param filtername string <p>
  6314. * The filter name.
  6315. * </p>
  6316. * @param read_write int[optional] <p>
  6317. * By default, stream_filter_prepend will
  6318. * attach the filter to the read filter chain
  6319. * if the file was opened for reading (i.e. File Mode:
  6320. * r, and/or +). The filter
  6321. * will also be attached to the write filter chain
  6322. * if the file was opened for writing (i.e. File Mode:
  6323. * w, a, and/or +).
  6324. * STREAM_FILTER_READ,
  6325. * STREAM_FILTER_WRITE, and/or
  6326. * STREAM_FILTER_ALL can also be passed to the
  6327. * read_write parameter to override this behavior.
  6328. * See stream_filter_append for an example of
  6329. * using this parameter.
  6330. * </p>
  6331. * @param params mixed[optional] <p>
  6332. * This filter will be added with the specified params
  6333. * to the beginning of the list and will therefore be
  6334. * called first during stream operations. To add a filter to the end of the
  6335. * list, use stream_filter_append.
  6336. * </p>
  6337. * @return resource a resource which can be used to refer to this filter
  6338. * instance during a call to stream_filter_remove.
  6339. */
  6340. function stream_filter_prepend ($stream, $filtername, $read_write = null, $params = null) {}
  6341. /**
  6342. * Attach a filter to a stream
  6343. * @link http://www.php.net/manual/en/function.stream-filter-append.php
  6344. * @param stream resource <p>
  6345. * The target stream.
  6346. * </p>
  6347. * @param filtername string <p>
  6348. * The filter name.
  6349. * </p>
  6350. * @param read_write int[optional] <p>
  6351. * By default, stream_filter_append will
  6352. * attach the filter to the read filter chain
  6353. * if the file was opened for reading (i.e. File Mode:
  6354. * r, and/or +). The filter
  6355. * will also be attached to the write filter chain
  6356. * if the file was opened for writing (i.e. File Mode:
  6357. * w, a, and/or +).
  6358. * STREAM_FILTER_READ,
  6359. * STREAM_FILTER_WRITE, and/or
  6360. * STREAM_FILTER_ALL can also be passed to the
  6361. * read_write parameter to override this behavior.
  6362. * </p>
  6363. * @param params mixed[optional] <p>
  6364. * This filter will be added with the specified
  6365. * params to the end of
  6366. * the list and will therefore be called last during stream operations.
  6367. * To add a filter to the beginning of the list, use
  6368. * stream_filter_prepend.
  6369. * </p>
  6370. * @return resource a resource which can be used to refer to this filter
  6371. * instance during a call to stream_filter_remove.
  6372. */
  6373. function stream_filter_append ($stream, $filtername, $read_write = null, $params = null) {}
  6374. /**
  6375. * Remove a filter from a stream
  6376. * @link http://www.php.net/manual/en/function.stream-filter-remove.php
  6377. * @param stream_filter resource <p>
  6378. * The stream filter to be removed.
  6379. * </p>
  6380. * @return bool Returns true on success or false on failure.
  6381. */
  6382. function stream_filter_remove ($stream_filter) {}
  6383. /**
  6384. * Open Internet or Unix domain socket connection
  6385. * @link http://www.php.net/manual/en/function.stream-socket-client.php
  6386. * @param remote_socket string <p>
  6387. * Address to the socket to connect to.
  6388. * </p>
  6389. * @param errno int[optional] <p>
  6390. * Will be set to the system level error number if connection fails.
  6391. * </p>
  6392. * @param errstr string[optional] <p>
  6393. * Will be set to the system level error message if the connection fails.
  6394. * </p>
  6395. * @param timeout float[optional] <p>
  6396. * Number of seconds until the connect() system call
  6397. * should timeout.
  6398. * This parameter only applies when not making asynchronous
  6399. * connection attempts.
  6400. * <p>
  6401. * To set a timeout for reading/writing data over the socket, use the
  6402. * stream_set_timeout, as the
  6403. * timeout only applies while making connecting
  6404. * the socket.
  6405. * </p>
  6406. * </p>
  6407. * @param flags int[optional] <p>
  6408. * Bitmask field which may be set to any combination of connection flags.
  6409. * Currently the select of connection flags is limited to
  6410. * STREAM_CLIENT_CONNECT (default),
  6411. * STREAM_CLIENT_ASYNC_CONNECT and
  6412. * STREAM_CLIENT_PERSISTENT.
  6413. * </p>
  6414. * @param context resource[optional] <p>
  6415. * A valid context resource created with stream_context_create.
  6416. * </p>
  6417. * @return resource On success a stream resource is returned which may
  6418. * be used together with the other file functions (such as
  6419. * fgets, fgetss,
  6420. * fwrite, fclose, and
  6421. * feof), false on failure.
  6422. */
  6423. function stream_socket_client ($remote_socket, &$errno = null, &$errstr = null, $timeout = null, $flags = null, $context = null) {}
  6424. /**
  6425. * Create an Internet or Unix domain server socket
  6426. * @link http://www.php.net/manual/en/function.stream-socket-server.php
  6427. * @param local_socket string <p>
  6428. * The type of socket created is determined by the transport specified
  6429. * using standard URL formatting: transport://target.
  6430. * </p>
  6431. * <p>
  6432. * For Internet Domain sockets (AF_INET) such as TCP and UDP, the
  6433. * target portion of the
  6434. * remote_socket parameter should consist of a
  6435. * hostname or IP address followed by a colon and a port number. For
  6436. * Unix domain sockets, the target portion should
  6437. * point to the socket file on the filesystem.
  6438. * </p>
  6439. * <p>
  6440. * Depending on the environment, Unix domain sockets may not be available.
  6441. * A list of available transports can be retrieved using
  6442. * stream_get_transports. See
  6443. * for a list of bulitin transports.
  6444. * </p>
  6445. * @param errno int[optional] <p>
  6446. * If the optional errno and errstr
  6447. * arguments are present they will be set to indicate the actual system
  6448. * level error that occurred in the system-level socket(),
  6449. * bind(), and listen() calls. If
  6450. * the value returned in errno is
  6451. * 0 and the function returned false, it is an
  6452. * indication that the error occurred before the bind()
  6453. * call. This is most likely due to a problem initializing the socket.
  6454. * Note that the errno and
  6455. * errstr arguments will always be passed by reference.
  6456. * </p>
  6457. * @param errstr string[optional] <p>
  6458. * See errno description.
  6459. * </p>
  6460. * @param flags int[optional] <p>
  6461. * A bitmask field which may be set to any combination of socket creation
  6462. * flags.
  6463. * </p>
  6464. * <p>
  6465. * For UDP sockets, you must use STREAM_SERVER_BIND as
  6466. * the flags parameter.
  6467. * </p>
  6468. * @param context resource[optional] <p>
  6469. * </p>
  6470. * @return resource the created stream, or false on error.
  6471. */
  6472. function stream_socket_server ($local_socket, &$errno = null, &$errstr = null, $flags = null, $context = null) {}
  6473. /**
  6474. * Accept a connection on a socket created by <function>stream_socket_server</function>
  6475. * @link http://www.php.net/manual/en/function.stream-socket-accept.php
  6476. * @param server_socket resource <p>
  6477. * The server socket to accept a connection from.
  6478. * </p>
  6479. * @param timeout float[optional] <p>
  6480. * Override the default socket accept timeout. Time should be given in
  6481. * seconds.
  6482. * </p>
  6483. * @param peername string[optional] <p>
  6484. * Will be set to the name (address) of the client which connected, if
  6485. * included and available from the selected transport.
  6486. * </p>
  6487. * <p>
  6488. * Can also be determined later using
  6489. * stream_socket_get_name.
  6490. * </p>
  6491. * @return resource a stream to the accepted socket connection&return.falseforfailure;.
  6492. */
  6493. function stream_socket_accept ($server_socket, $timeout = null, &$peername = null) {}
  6494. /**
  6495. * Retrieve the name of the local or remote sockets
  6496. * @link http://www.php.net/manual/en/function.stream-socket-get-name.php
  6497. * @param handle resource <p>
  6498. * The socket to get the name of.
  6499. * </p>
  6500. * @param want_peer bool <p>
  6501. * If set to true the remote socket name will be returned, if set
  6502. * to false the local socket name will be returned.
  6503. * </p>
  6504. * @return string The name of the socket.
  6505. */
  6506. function stream_socket_get_name ($handle, $want_peer) {}
  6507. /**
  6508. * Receives data from a socket, connected or not
  6509. * @link http://www.php.net/manual/en/function.stream-socket-recvfrom.php
  6510. * @param socket resource <p>
  6511. * The remote socket.
  6512. * </p>
  6513. * @param length int <p>
  6514. * The number of bytes to receive from the socket.
  6515. * </p>
  6516. * @param flags int[optional] <p>
  6517. * The value of flags can be any combination
  6518. * of the following:
  6519. * <table>
  6520. * Possible values for flags
  6521. * <tr valign="top">
  6522. * <td>STREAM_OOB</td>
  6523. * <td>
  6524. * Process OOB (out-of-band) data.
  6525. * </td>
  6526. * </tr>
  6527. * <tr valign="top">
  6528. * <td>STREAM_PEEK</td>
  6529. * <td>
  6530. * Retrieve data from the socket, but do not consume the buffer.
  6531. * Subsequent calls to fread or
  6532. * stream_socket_recvfrom will see
  6533. * the same data.
  6534. * </td>
  6535. * </tr>
  6536. * </table>
  6537. * </p>
  6538. * @param address string[optional] <p>
  6539. * If address is provided it will be populated with
  6540. * the address of the remote socket.
  6541. * </p>
  6542. * @return string the read data, as a string
  6543. */
  6544. function stream_socket_recvfrom ($socket, $length, $flags = null, &$address = null) {}
  6545. /**
  6546. * Sends a message to a socket, whether it is connected or not
  6547. * @link http://www.php.net/manual/en/function.stream-socket-sendto.php
  6548. * @param socket resource <p>
  6549. * The socket to send data to.
  6550. * </p>
  6551. * @param data string <p>
  6552. * The data to be sent.
  6553. * </p>
  6554. * @param flags int[optional] <p>
  6555. * The value of flags can be any combination
  6556. * of the following:
  6557. * <table>
  6558. * possible values for flags
  6559. * <tr valign="top">
  6560. * <td>STREAM_OOB</td>
  6561. * <td>
  6562. * Process OOB (out-of-band) data.
  6563. * </td>
  6564. * </tr>
  6565. * </table>
  6566. * </p>
  6567. * @param address string[optional] <p>
  6568. * The address specified when the socket stream was created will be used
  6569. * unless an alternate address is specified in address.
  6570. * </p>
  6571. * <p>
  6572. * If specified, it must be in dotted quad (or [ipv6]) format.
  6573. * </p>
  6574. * @return int a result code, as an integer.
  6575. */
  6576. function stream_socket_sendto ($socket, $data, $flags = null, $address = null) {}
  6577. /**
  6578. * Turns encryption on/off on an already connected socket
  6579. * @link http://www.php.net/manual/en/function.stream-socket-enable-crypto.php
  6580. * @param stream resource <p>
  6581. * The stream resource.
  6582. * </p>
  6583. * @param enable bool <p>
  6584. * Enable/disable cryptography on the stream.
  6585. * </p>
  6586. * @param crypto_type int[optional] <p>
  6587. * Setup encryption on the stream.
  6588. * Valid methods are
  6589. * STREAM_CRYPTO_METHOD_SSLv2_CLIENT
  6590. * @param session_stream resource[optional] <p>
  6591. * Seed the stream with settings from session_stream.
  6592. * </p>
  6593. * @return mixed true on success, false if negotiation has failed or
  6594. * 0 if there isn't enough data and you should try again
  6595. * (only for non-blocking sockets).
  6596. */
  6597. function stream_socket_enable_crypto ($stream, $enable, $crypto_type = null, $session_stream = null) {}
  6598. /**
  6599. * Shutdown a full-duplex connection
  6600. * @link http://www.php.net/manual/en/function.stream-socket-shutdown.php
  6601. * @param stream resource <p>
  6602. * An open stream (opened with stream_socket_client,
  6603. * for example)
  6604. * </p>
  6605. * @param how int <p>
  6606. * One of the following constants: STREAM_SHUT_RD
  6607. * (disable further receptions), STREAM_SHUT_WR
  6608. * (disable further transmissions) or
  6609. * STREAM_SHUT_RDWR (disable further receptions and
  6610. * transmissions).
  6611. * </p>
  6612. * @return bool Returns true on success or false on failure.
  6613. */
  6614. function stream_socket_shutdown ($stream, $how) {}
  6615. /**
  6616. * Creates a pair of connected, indistinguishable socket streams
  6617. * @link http://www.php.net/manual/en/function.stream-socket-pair.php
  6618. * @param domain int <p>
  6619. * The protocol family to be used: STREAM_PF_INET,
  6620. * STREAM_PF_INET6 or
  6621. * STREAM_PF_UNIX
  6622. * </p>
  6623. * @param type int <p>
  6624. * The type of communication to be used:
  6625. * STREAM_SOCK_DGRAM,
  6626. * STREAM_SOCK_RAW,
  6627. * STREAM_SOCK_RDM,
  6628. * STREAM_SOCK_SEQPACKET or
  6629. * STREAM_SOCK_STREAM
  6630. * </p>
  6631. * @param protocol int <p>
  6632. * The protocol to be used: STREAM_IPPROTO_ICMP,
  6633. * STREAM_IPPROTO_IP,
  6634. * STREAM_IPPROTO_RAW,
  6635. * STREAM_IPPROTO_TCP or
  6636. * STREAM_IPPROTO_UDP
  6637. * </p>
  6638. * @return array an array with the two socket resources on success, or
  6639. * false on failure.
  6640. */
  6641. function stream_socket_pair ($domain, $type, $protocol) {}
  6642. /**
  6643. * Copies data from one stream to another
  6644. * @link http://www.php.net/manual/en/function.stream-copy-to-stream.php
  6645. * @param source resource <p>
  6646. * The source stream
  6647. * </p>
  6648. * @param dest resource <p>
  6649. * The destination stream
  6650. * </p>
  6651. * @param maxlength int[optional] <p>
  6652. * Maximum bytes to copy
  6653. * </p>
  6654. * @param offset int[optional] <p>
  6655. * The offset where to start to copy data
  6656. * </p>
  6657. * @return int the total count of bytes copied.
  6658. */
  6659. function stream_copy_to_stream ($source, $dest, $maxlength = null, $offset = null) {}
  6660. /**
  6661. * Reads remainder of a stream into a string
  6662. * @link http://www.php.net/manual/en/function.stream-get-contents.php
  6663. * @param handle resource <p>
  6664. * A stream resource (e.g. returned from fopen)
  6665. * </p>
  6666. * @param maxlength int[optional] <p>
  6667. * The maximum bytes to read. Defaults to -1 (read all the remaining
  6668. * buffer).
  6669. * </p>
  6670. * @param offset int[optional] <p>
  6671. * Seek to the specified offset before reading. If this number is negative,
  6672. * no seeking will occur and reading will start from the current position.
  6673. * </p>
  6674. * @return string a string&return.falseforfailure;.
  6675. */
  6676. function stream_get_contents ($handle, $maxlength = null, $offset = null) {}
  6677. /**
  6678. * Tells whether the stream supports locking.
  6679. * @link http://www.php.net/manual/en/function.stream-supports-lock.php
  6680. * @param stream resource <p>
  6681. * The stream to check.
  6682. * </p>
  6683. * @return bool Returns true on success or false on failure.
  6684. */
  6685. function stream_supports_lock ($stream) {}
  6686. /**
  6687. * Gets line from file pointer and parse for CSV fields
  6688. * @link http://www.php.net/manual/en/function.fgetcsv.php
  6689. * @param handle resource <p>
  6690. * A valid file pointer to a file successfully opened by
  6691. * fopen, popen, or
  6692. * fsockopen.
  6693. * </p>
  6694. * @param length int[optional] <p>
  6695. * Must be greater than the longest line (in characters) to be found in
  6696. * the CSV file (allowing for trailing line-end characters). It became
  6697. * optional in PHP 5. Omitting this parameter (or setting it to 0 in PHP
  6698. * 5.0.4 and later) the maximum line length is not limited, which is
  6699. * slightly slower.
  6700. * </p>
  6701. * @param delimiter string[optional] <p>
  6702. * Set the field delimiter (one character only).
  6703. * </p>
  6704. * @param enclosure string[optional] <p>
  6705. * Set the field enclosure character (one character only).
  6706. * </p>
  6707. * @param escape string[optional] <p>
  6708. * Set the escape character (one character only). Defaults as a backslash.
  6709. * </p>
  6710. * @return array an indexed array containing the fields read.
  6711. * </p>
  6712. * <p>
  6713. * A blank line in a CSV file will be returned as an array
  6714. * comprising a single null field, and will not be treated
  6715. * as an error.
  6716. * </p>
  6717. * &note.line-endings;
  6718. * <p>
  6719. * fgetcsv returns &null; if an invalid
  6720. * handle is supplied or false on other errors,
  6721. * including end of file.
  6722. */
  6723. function fgetcsv ($handle, $length = null, $delimiter = null, $enclosure = null, $escape = null) {}
  6724. /**
  6725. * Format line as CSV and write to file pointer
  6726. * @link http://www.php.net/manual/en/function.fputcsv.php
  6727. * @param handle resource &fs.validfp.all;
  6728. * @param fields array <p>
  6729. * An array of values.
  6730. * </p>
  6731. * @param delimiter string[optional] <p>
  6732. * The optional delimiter parameter sets the field
  6733. * delimiter (one character only).
  6734. * </p>
  6735. * @param enclosure string[optional] <p>
  6736. * The optional enclosure parameter sets the field
  6737. * enclosure (one character only).
  6738. * </p>
  6739. * @return int the length of the written string&return.falseforfailure;.
  6740. */
  6741. function fputcsv ($handle, array $fields, $delimiter = null, $enclosure = null) {}
  6742. /**
  6743. * Portable advisory file locking
  6744. * @link http://www.php.net/manual/en/function.flock.php
  6745. * @param handle resource &fs.file.pointer;
  6746. * @param operation int <p>
  6747. * operation is one of the following:
  6748. * LOCK_SH to acquire a shared lock (reader).
  6749. * @param wouldblock int[optional] <p>
  6750. * The optional third argument is set to true if the lock would block
  6751. * (EWOULDBLOCK errno condition). (not supported on Windows)
  6752. * </p>
  6753. * @return bool Returns true on success or false on failure.
  6754. */
  6755. function flock ($handle, $operation, &$wouldblock = null) {}
  6756. /**
  6757. * Extracts all meta tag content attributes from a file and returns an array
  6758. * @link http://www.php.net/manual/en/function.get-meta-tags.php
  6759. * @param filename string <p>
  6760. * The path to the HTML file, as a string. This can be a local file or an
  6761. * URL.
  6762. * </p>
  6763. * <p>
  6764. * What get_meta_tags parses
  6765. * ]]>
  6766. * (pay attention to line endings - PHP uses a native function to
  6767. * parse the input, so a Mac file won't work on Unix).
  6768. * </p>
  6769. * @param use_include_path bool[optional] <p>
  6770. * Setting use_include_path to true will result
  6771. * in PHP trying to open the file along the standard include path as per
  6772. * the include_path directive.
  6773. * This is used for local files, not URLs.
  6774. * </p>
  6775. * @return array an array with all the parsed meta tags.
  6776. * </p>
  6777. * <p>
  6778. * The value of the name property becomes the key, the value of the content
  6779. * property becomes the value of the returned array, so you can easily use
  6780. * standard array functions to traverse it or access single values.
  6781. * Special characters in the value of the name property are substituted with
  6782. * '_', the rest is converted to lower case. If two meta tags have the same
  6783. * name, only the last one is returned.
  6784. */
  6785. function get_meta_tags ($filename, $use_include_path = null) {}
  6786. /**
  6787. * Set read file buffering on the given stream
  6788. * @link http://www.php.net/manual/en/function.stream-set-read-buffer.php
  6789. * @param stream resource <p>
  6790. * The file pointer.
  6791. * </p>
  6792. * @param buffer int <p>
  6793. * The number of bytes to buffer. If buffer
  6794. * is 0 then read operations are unbuffered. This ensures that all reads
  6795. * with fread are completed before other processes are
  6796. * allowed to write to that output stream.
  6797. * </p>
  6798. * @return int 0 on success, or EOF if the request
  6799. * cannot be honored.
  6800. */
  6801. function stream_set_read_buffer ($stream, $buffer) {}
  6802. /**
  6803. * Sets write file buffering on the given stream
  6804. * @link http://www.php.net/manual/en/function.stream-set-write-buffer.php
  6805. * @param stream resource <p>
  6806. * The file pointer.
  6807. * </p>
  6808. * @param buffer int <p>
  6809. * The number of bytes to buffer. If buffer
  6810. * is 0 then write operations are unbuffered. This ensures that all writes
  6811. * with fwrite are completed before other processes are
  6812. * allowed to write to that output stream.
  6813. * </p>
  6814. * @return int 0 on success, or EOF if the request cannot be honored.
  6815. */
  6816. function stream_set_write_buffer ($stream, $buffer) {}
  6817. /**
  6818. * &Alias; <function>stream_set_write_buffer</function>
  6819. * @link http://www.php.net/manual/en/function.set-file-buffer.php
  6820. * @param fp
  6821. * @param buffer
  6822. */
  6823. function set_file_buffer ($fp, $buffer) {}
  6824. /**
  6825. * Set the stream chunk size
  6826. * @link http://www.php.net/manual/en/function.stream-set-chunk-size.php
  6827. * @param fp resource <p>
  6828. * The target stream.
  6829. * </p>
  6830. * @param chunk_size int <p>
  6831. * The desired new chunk size.
  6832. * </p>
  6833. * @return int the previous chunk size on success.
  6834. * </p>
  6835. * <p>
  6836. * Will return false if chunk_size is less than 1 or
  6837. * greater than PHP_INT_MAX.
  6838. */
  6839. function stream_set_chunk_size ($fp, $chunk_size) {}
  6840. /**
  6841. * &Alias; <function>stream_set_blocking</function>
  6842. * @link http://www.php.net/manual/en/function.set-socket-blocking.php
  6843. * @param socket
  6844. * @param mode
  6845. */
  6846. function set_socket_blocking ($socket, $mode) {}
  6847. /**
  6848. * Set blocking/non-blocking mode on a stream
  6849. * @link http://www.php.net/manual/en/function.stream-set-blocking.php
  6850. * @param stream resource <p>
  6851. * The stream.
  6852. * </p>
  6853. * @param mode int <p>
  6854. * If mode is 0, the given stream
  6855. * will be switched to non-blocking mode, and if 1, it
  6856. * will be switched to blocking mode. This affects calls like
  6857. * fgets and fread
  6858. * that read from the stream. In non-blocking mode an
  6859. * fgets call will always return right away
  6860. * while in blocking mode it will wait for data to become available
  6861. * on the stream.
  6862. * </p>
  6863. * @return bool Returns true on success or false on failure.
  6864. */
  6865. function stream_set_blocking ($stream, $mode) {}
  6866. /**
  6867. * &Alias; <function>stream_set_blocking</function>
  6868. * @link http://www.php.net/manual/en/function.socket-set-blocking.php
  6869. * @param socket
  6870. * @param mode
  6871. */
  6872. function socket_set_blocking ($socket, $mode) {}
  6873. /**
  6874. * Retrieves header/meta data from streams/file pointers
  6875. * @link http://www.php.net/manual/en/function.stream-get-meta-data.php
  6876. * @param stream resource <p>
  6877. * The stream can be any stream created by fopen,
  6878. * fsockopen and pfsockopen.
  6879. * </p>
  6880. * @return array The result array contains the following items:
  6881. * </p>
  6882. * <p>
  6883. * timed_out (bool) - true if the stream
  6884. * timed out while waiting for data on the last call to
  6885. * fread or fgets.
  6886. * </p>
  6887. * <p>
  6888. * blocked (bool) - true if the stream is
  6889. * in blocking IO mode. See stream_set_blocking.
  6890. * </p>
  6891. * <p>
  6892. * eof (bool) - true if the stream has reached
  6893. * end-of-file. Note that for socket streams this member can be true
  6894. * even when unread_bytes is non-zero. To
  6895. * determine if there is more data to be read, use
  6896. * feof instead of reading this item.
  6897. * </p>
  6898. * <p>
  6899. * unread_bytes (int) - the number of bytes
  6900. * currently contained in the PHP's own internal buffer.
  6901. * </p>
  6902. * You shouldn't use this value in a script.
  6903. * <p>
  6904. * stream_type (string) - a label describing
  6905. * the underlying implementation of the stream.
  6906. * </p>
  6907. * <p>
  6908. * wrapper_type (string) - a label describing
  6909. * the protocol wrapper implementation layered over the stream.
  6910. * See for more information about wrappers.
  6911. * </p>
  6912. * <p>
  6913. * wrapper_data (mixed) - wrapper specific
  6914. * data attached to this stream. See for
  6915. * more information about wrappers and their wrapper data.
  6916. * </p>
  6917. * <p>
  6918. * filters (array) - and array containing
  6919. * the names of any filters that have been stacked onto this stream.
  6920. * Documentation on filters can be found in the
  6921. * Filters appendix.
  6922. * </p>
  6923. * <p>
  6924. * mode (string) - the type of access required for
  6925. * this stream (see Table 1 of the fopen() reference)
  6926. * </p>
  6927. * <p>
  6928. * seekable (bool) - whether the current stream can
  6929. * be seeked.
  6930. * </p>
  6931. * <p>
  6932. * uri (string) - the URI/filename associated with this
  6933. * stream.
  6934. */
  6935. function stream_get_meta_data ($stream) {}
  6936. /**
  6937. * Gets line from stream resource up to a given delimiter
  6938. * @link http://www.php.net/manual/en/function.stream-get-line.php
  6939. * @param handle resource <p>
  6940. * A valid file handle.
  6941. * </p>
  6942. * @param length int <p>
  6943. * The number of bytes to read from the handle.
  6944. * </p>
  6945. * @param ending string[optional] <p>
  6946. * An optional string delimiter.
  6947. * </p>
  6948. * @return string a string of up to length bytes read from the file
  6949. * pointed to by handle.
  6950. * </p>
  6951. * <p>
  6952. * If an error occurs, returns false.
  6953. */
  6954. function stream_get_line ($handle, $length, $ending = null) {}
  6955. /**
  6956. * Register a URL wrapper implemented as a PHP class
  6957. * @link http://www.php.net/manual/en/function.stream-wrapper-register.php
  6958. * @param protocol string <p>
  6959. * The wrapper name to be registered.
  6960. * </p>
  6961. * @param classname string <p>
  6962. * The classname which implements the protocol.
  6963. * </p>
  6964. * @param flags int[optional] <p>
  6965. * Should be set to STREAM_IS_URL if
  6966. * protocol is a URL protocol. Default is 0, local
  6967. * stream.
  6968. * </p>
  6969. * @return bool Returns true on success or false on failure.
  6970. * </p>
  6971. * <p>
  6972. * stream_wrapper_register will return false if the
  6973. * protocol already has a handler.
  6974. */
  6975. function stream_wrapper_register ($protocol, $classname, $flags = null) {}
  6976. /**
  6977. * &Alias; <function>stream_wrapper_register</function>
  6978. * @link http://www.php.net/manual/en/function.stream-register-wrapper.php
  6979. * @param protocol
  6980. * @param classname
  6981. * @param flags[optional]
  6982. */
  6983. function stream_register_wrapper ($protocol, $classname, $flags) {}
  6984. /**
  6985. * Unregister a URL wrapper
  6986. * @link http://www.php.net/manual/en/function.stream-wrapper-unregister.php
  6987. * @param protocol string <p>
  6988. * </p>
  6989. * @return bool Returns true on success or false on failure.
  6990. */
  6991. function stream_wrapper_unregister ($protocol) {}
  6992. /**
  6993. * Restores a previously unregistered built-in wrapper
  6994. * @link http://www.php.net/manual/en/function.stream-wrapper-restore.php
  6995. * @param protocol string <p>
  6996. * </p>
  6997. * @return bool Returns true on success or false on failure.
  6998. */
  6999. function stream_wrapper_restore ($protocol) {}
  7000. /**
  7001. * Retrieve list of registered streams
  7002. * @link http://www.php.net/manual/en/function.stream-get-wrappers.php
  7003. * @return array an indexed array containing the name of all stream wrappers
  7004. * available on the running system.
  7005. */
  7006. function stream_get_wrappers () {}
  7007. /**
  7008. * Retrieve list of registered socket transports
  7009. * @link http://www.php.net/manual/en/function.stream-get-transports.php
  7010. * @return array an indexed array of socket transports names.
  7011. */
  7012. function stream_get_transports () {}
  7013. /**
  7014. * Resolve filename against the include path
  7015. * @link http://www.php.net/manual/en/function.stream-resolve-include-path.php
  7016. * @param filename string <p>
  7017. * The filename to resolve.
  7018. * </p>
  7019. * @param context resource[optional] <p>
  7020. * A valid context resource created with stream_context_create.
  7021. * </p>
  7022. * @return string a string containing the resolved absolute filename, &return.falseforfailure;.
  7023. */
  7024. function stream_resolve_include_path ($filename, $context = null) {}
  7025. /**
  7026. * Checks if a stream is a local stream
  7027. * @link http://www.php.net/manual/en/function.stream-is-local.php
  7028. * @param stream_or_url mixed <p>
  7029. * The stream resource or URL to check.
  7030. * </p>
  7031. * @return bool Returns true on success or false on failure.
  7032. */
  7033. function stream_is_local ($stream_or_url) {}
  7034. /**
  7035. * Fetches all the headers sent by the server in response to a HTTP request
  7036. * @link http://www.php.net/manual/en/function.get-headers.php
  7037. * @param url string <p>
  7038. * The target URL.
  7039. * </p>
  7040. * @param format int[optional] <p>
  7041. * If the optional format parameter is set to non-zero,
  7042. * get_headers parses the response and sets the
  7043. * array's keys.
  7044. * </p>
  7045. * @return array an indexed or associative array with the headers, or false on
  7046. * failure.
  7047. */
  7048. function get_headers ($url, $format = null) {}
  7049. /**
  7050. * Set timeout period on a stream
  7051. * @link http://www.php.net/manual/en/function.stream-set-timeout.php
  7052. * @param stream resource <p>
  7053. * The target stream.
  7054. * </p>
  7055. * @param seconds int <p>
  7056. * The seconds part of the timeout to be set.
  7057. * </p>
  7058. * @param microseconds int[optional] <p>
  7059. * The microseconds part of the timeout to be set.
  7060. * </p>
  7061. * @return bool Returns true on success or false on failure.
  7062. */
  7063. function stream_set_timeout ($stream, $seconds, $microseconds = null) {}
  7064. /**
  7065. * &Alias; <function>stream_set_timeout</function>
  7066. * @link http://www.php.net/manual/en/function.socket-set-timeout.php
  7067. * @param stream
  7068. * @param seconds
  7069. * @param microseconds
  7070. */
  7071. function socket_set_timeout ($stream, $seconds, $microseconds) {}
  7072. /**
  7073. * &Alias; <function>stream_get_meta_data</function>
  7074. * @link http://www.php.net/manual/en/function.socket-get-status.php
  7075. * @param fp
  7076. */
  7077. function socket_get_status ($fp) {}
  7078. /**
  7079. * Returns canonicalized absolute pathname
  7080. * @link http://www.php.net/manual/en/function.realpath.php
  7081. * @param path string <p>
  7082. * The path being checked.
  7083. * <p>
  7084. * Whilst a path must be supplied, the value can be blank or &null;
  7085. * In these cases, the value is interpreted as the current directory.
  7086. * </p>
  7087. * </p>
  7088. * @return string the canonicalized absolute pathname on success. The resulting path
  7089. * will have no symbolic link, '/./' or '/../' components.
  7090. * </p>
  7091. * <p>
  7092. * realpath returns false on failure, e.g. if
  7093. * the file does not exist.
  7094. * </p>
  7095. * <p>
  7096. * The running script must have executable permissions on all directories in
  7097. * the hierarchy, otherwise realpath will return
  7098. * false.
  7099. */
  7100. function realpath ($path) {}
  7101. /**
  7102. * Match filename against a pattern
  7103. * @link http://www.php.net/manual/en/function.fnmatch.php
  7104. * @param pattern string <p>
  7105. * The shell wildcard pattern.
  7106. * </p>
  7107. * @param string string <p>
  7108. * The tested string. This function is especially useful for filenames,
  7109. * but may also be used on regular strings.
  7110. * </p>
  7111. * <p>
  7112. * The average user may be used to shell patterns or at least in their
  7113. * simplest form to '?' and '*'
  7114. * wildcards so using fnmatch instead of
  7115. * preg_match for
  7116. * frontend search expression input may be way more convenient for
  7117. * non-programming users.
  7118. * </p>
  7119. * @param flags int[optional] <p>
  7120. * The value of flags can be any combination of
  7121. * the following flags, joined with the
  7122. * binary OR (|) operator.
  7123. * <table>
  7124. * A list of possible flags for fnmatch
  7125. * <tr valign="top">
  7126. * <td>Flag</td>
  7127. * <td>Description</td>
  7128. * </tr>
  7129. * <tr valign="top">
  7130. * <td>FNM_NOESCAPE</td>
  7131. * <td>
  7132. * Disable backslash escaping.
  7133. * </td>
  7134. * </tr>
  7135. * <tr valign="top">
  7136. * <td>FNM_PATHNAME</td>
  7137. * <td>
  7138. * Slash in string only matches slash in the given pattern.
  7139. * </td>
  7140. * </tr>
  7141. * <tr valign="top">
  7142. * <td>FNM_PERIOD</td>
  7143. * <td>
  7144. * Leading period in string must be exactly matched by period in the given pattern.
  7145. * </td>
  7146. * </tr>
  7147. * <tr valign="top">
  7148. * <td>FNM_CASEFOLD</td>
  7149. * <td>
  7150. * Caseless match. Part of the GNU extension.
  7151. * </td>
  7152. * </tr>
  7153. * </table>
  7154. * </p>
  7155. * @return bool true if there is a match, false otherwise.
  7156. */
  7157. function fnmatch ($pattern, $string, $flags = null) {}
  7158. /**
  7159. * Open Internet or Unix domain socket connection
  7160. * @link http://www.php.net/manual/en/function.fsockopen.php
  7161. * @param hostname string <p>
  7162. * If OpenSSL support is
  7163. * installed, you may prefix the hostname
  7164. * with either ssl:// or tls:// to
  7165. * use an SSL or TLS client connection over TCP/IP to connect to the
  7166. * remote host.
  7167. * </p>
  7168. * @param port int[optional] <p>
  7169. * The port number.
  7170. * </p>
  7171. * @param errno int[optional] <p>
  7172. * If provided, holds the system level error number that occurred in the
  7173. * system-level connect() call.
  7174. * </p>
  7175. * <p>
  7176. * If the value returned in errno is
  7177. * 0 and the function returned false, it is an
  7178. * indication that the error occurred before the
  7179. * connect() call. This is most likely due to a
  7180. * problem initializing the socket.
  7181. * </p>
  7182. * @param errstr string[optional] <p>
  7183. * The error message as a string.
  7184. * </p>
  7185. * @param timeout float[optional] <p>
  7186. * The connection timeout, in seconds.
  7187. * </p>
  7188. * <p>
  7189. * If you need to set a timeout for reading/writing data over the
  7190. * socket, use stream_set_timeout, as the
  7191. * timeout parameter to
  7192. * fsockopen only applies while connecting the
  7193. * socket.
  7194. * </p>
  7195. * @return resource fsockopen returns a file pointer which may be used
  7196. * together with the other file functions (such as
  7197. * fgets, fgetss,
  7198. * fwrite, fclose, and
  7199. * feof). If the call fails, it will return false
  7200. */
  7201. function fsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  7202. /**
  7203. * Open persistent Internet or Unix domain socket connection
  7204. * @link http://www.php.net/manual/en/function.pfsockopen.php
  7205. * @param hostname string
  7206. * @param port int[optional]
  7207. * @param errno int[optional]
  7208. * @param errstr string[optional]
  7209. * @param timeout float[optional]
  7210. * @return resource
  7211. */
  7212. function pfsockopen ($hostname, $port = null, &$errno = null, &$errstr = null, $timeout = null) {}
  7213. /**
  7214. * Pack data into binary string
  7215. * @link http://www.php.net/manual/en/function.pack.php
  7216. * @param format string <p>
  7217. * The format string consists of format codes
  7218. * followed by an optional repeater argument. The repeater argument can
  7219. * be either an integer value or * for repeating to
  7220. * the end of the input data. For a, A, h, H the repeat count specifies
  7221. * how many characters of one data argument are taken, for @ it is the
  7222. * absolute position where to put the next data, for everything else the
  7223. * repeat count specifies how many data arguments are consumed and packed
  7224. * into the resulting binary string.
  7225. * </p>
  7226. * <p>
  7227. * Currently implemented formats are:
  7228. * <table>
  7229. * pack format characters
  7230. * <tr valign="top">
  7231. * <td>Code</td>
  7232. * <td>Description</td>
  7233. * </tr>
  7234. * <tr valign="top">
  7235. * <td>a</td>
  7236. * <td>NUL-padded string</td>
  7237. * </tr>
  7238. * <tr valign="top">
  7239. * <td>A</td>
  7240. * <td>SPACE-padded string</td></tr>
  7241. * <tr valign="top">
  7242. * <td>h</td>
  7243. * <td>Hex string, low nibble first</td></tr>
  7244. * <tr valign="top">
  7245. * <td>H</td>
  7246. * <td>Hex string, high nibble first</td></tr>
  7247. * <tr valign="top"><td>c</td><td>signed char</td></tr>
  7248. * <tr valign="top">
  7249. * <td>C</td>
  7250. * <td>unsigned char</td></tr>
  7251. * <tr valign="top">
  7252. * <td>s</td>
  7253. * <td>signed short (always 16 bit, machine byte order)</td>
  7254. * </tr>
  7255. * <tr valign="top">
  7256. * <td>S</td>
  7257. * <td>unsigned short (always 16 bit, machine byte order)</td>
  7258. * </tr>
  7259. * <tr valign="top">
  7260. * <td>n</td>
  7261. * <td>unsigned short (always 16 bit, big endian byte order)</td>
  7262. * </tr>
  7263. * <tr valign="top">
  7264. * <td>v</td>
  7265. * <td>unsigned short (always 16 bit, little endian byte order)</td>
  7266. * </tr>
  7267. * <tr valign="top">
  7268. * <td>i</td>
  7269. * <td>signed integer (machine dependent size and byte order)</td>
  7270. * </tr>
  7271. * <tr valign="top">
  7272. * <td>I</td>
  7273. * <td>unsigned integer (machine dependent size and byte order)</td>
  7274. * </tr>
  7275. * <tr valign="top">
  7276. * <td>l</td>
  7277. * <td>signed long (always 32 bit, machine byte order)</td>
  7278. * </tr>
  7279. * <tr valign="top">
  7280. * <td>L</td>
  7281. * <td>unsigned long (always 32 bit, machine byte order)</td>
  7282. * </tr>
  7283. * <tr valign="top">
  7284. * <td>N</td>
  7285. * <td>unsigned long (always 32 bit, big endian byte order)</td>
  7286. * </tr>
  7287. * <tr valign="top">
  7288. * <td>V</td>
  7289. * <td>unsigned long (always 32 bit, little endian byte order)</td>
  7290. * </tr>
  7291. * <tr valign="top">
  7292. * <td>f</td>
  7293. * <td>float (machine dependent size and representation)</td>
  7294. * </tr>
  7295. * <tr valign="top">
  7296. * <td>d</td>
  7297. * <td>double (machine dependent size and representation)</td>
  7298. * </tr>
  7299. * <tr valign="top">
  7300. * <td>x</td>
  7301. * <td>NUL byte</td>
  7302. * </tr>
  7303. * <tr valign="top">
  7304. * <td>X</td>
  7305. * <td>Back up one byte</td>
  7306. * </tr>
  7307. * <tr valign="top">
  7308. * <td>@</td>
  7309. * <td>NUL-fill to absolute position</td>
  7310. * </tr>
  7311. * </table>
  7312. * </p>
  7313. * @param args mixed[optional] <p>
  7314. * </p>
  7315. * @param _ mixed[optional]
  7316. * @return string a binary string containing data.
  7317. */
  7318. function pack ($format, $args = null, $_ = null) {}
  7319. /**
  7320. * Unpack data from binary string
  7321. * @link http://www.php.net/manual/en/function.unpack.php
  7322. * @param format string <p>
  7323. * See pack for an explanation of the format codes.
  7324. * </p>
  7325. * @param data string <p>
  7326. * The packed data.
  7327. * </p>
  7328. * @return array an associative array containing unpacked elements of binary
  7329. * string.
  7330. */
  7331. function unpack ($format, $data) {}
  7332. /**
  7333. * Tells what the user's browser is capable of
  7334. * @link http://www.php.net/manual/en/function.get-browser.php
  7335. * @param user_agent string[optional] <p>
  7336. * The User Agent to be analyzed. By default, the value of HTTP
  7337. * User-Agent header is used; however, you can alter this (i.e., look up
  7338. * another browser's info) by passing this parameter.
  7339. * </p>
  7340. * <p>
  7341. * You can bypass this parameter with a &null; value.
  7342. * </p>
  7343. * @param return_array bool[optional] <p>
  7344. * If set to true, this function will return an array
  7345. * instead of an object.
  7346. * </p>
  7347. * @return mixed The information is returned in an object or an array which will contain
  7348. * various data elements representing, for instance, the browser's major and
  7349. * minor version numbers and ID string; true/false values for features
  7350. * such as frames, JavaScript, and cookies; and so forth.
  7351. * </p>
  7352. * <p>
  7353. * The cookies value simply means that the browser
  7354. * itself is capable of accepting cookies and does not mean the user has
  7355. * enabled the browser to accept cookies or not. The only way to test if
  7356. * cookies are accepted is to set one with setcookie,
  7357. * reload, and check for the value.
  7358. */
  7359. function get_browser ($user_agent = null, $return_array = null) {}
  7360. /**
  7361. * One-way string hashing
  7362. * @link http://www.php.net/manual/en/function.crypt.php
  7363. * @param str string <p>
  7364. * The string to be hashed.
  7365. * </p>
  7366. * @param salt string[optional] <p>
  7367. * An optional salt string to base the hashing on. If not provided, the
  7368. * behaviour is defined by the algorithm implementation and can lead to
  7369. * unexpected results.
  7370. * </p>
  7371. * @return string the hashed string or a string that is shorter than 13 characters
  7372. * and is guaranteed to differ from the salt on failure.
  7373. */
  7374. function crypt ($str, $salt = null) {}
  7375. /**
  7376. * Open directory handle
  7377. * @link http://www.php.net/manual/en/function.opendir.php
  7378. * @param path string <p>
  7379. * The directory path that is to be opened
  7380. * </p>
  7381. * @param context resource[optional] <p>
  7382. * For a description of the context parameter,
  7383. * refer to the streams section of
  7384. * the manual.
  7385. * </p>
  7386. * @return resource a directory handle resource on success, or
  7387. * false on failure.
  7388. * </p>
  7389. * <p>
  7390. * If path is not a valid directory or the
  7391. * directory can not be opened due to permission restrictions or
  7392. * filesystem errors, opendir returns false and
  7393. * generates a PHP error of level
  7394. * E_WARNING. You can suppress the error output of
  7395. * opendir by prepending
  7396. * '@' to the
  7397. * front of the function name.
  7398. */
  7399. function opendir ($path, $context = null) {}
  7400. /**
  7401. * Close directory handle
  7402. * @link http://www.php.net/manual/en/function.closedir.php
  7403. * @param dir_handle resource[optional] <p>
  7404. * The directory handle resource previously opened
  7405. * with opendir. If the directory handle is
  7406. * not specified, the last link opened by opendir
  7407. * is assumed.
  7408. * </p>
  7409. * @return void
  7410. */
  7411. function closedir ($dir_handle = null) {}
  7412. /**
  7413. * Change directory
  7414. * @link http://www.php.net/manual/en/function.chdir.php
  7415. * @param directory string <p>
  7416. * The new current directory
  7417. * </p>
  7418. * @return bool Returns true on success or false on failure.
  7419. */
  7420. function chdir ($directory) {}
  7421. /**
  7422. * Gets the current working directory
  7423. * @link http://www.php.net/manual/en/function.getcwd.php
  7424. * @return string the current working directory on success, or false on
  7425. * failure.
  7426. * </p>
  7427. * <p>
  7428. * On some Unix variants, getcwd will return
  7429. * false if any one of the parent directories does not have the
  7430. * readable or search mode set, even if the current directory
  7431. * does. See chmod for more information on
  7432. * modes and permissions.
  7433. */
  7434. function getcwd () {}
  7435. /**
  7436. * Rewind directory handle
  7437. * @link http://www.php.net/manual/en/function.rewinddir.php
  7438. * @param dir_handle resource[optional] <p>
  7439. * The directory handle resource previously opened
  7440. * with opendir. If the directory handle is
  7441. * not specified, the last link opened by opendir
  7442. * is assumed.
  7443. * </p>
  7444. * @return void
  7445. */
  7446. function rewinddir ($dir_handle = null) {}
  7447. /**
  7448. * Read entry from directory handle
  7449. * @link http://www.php.net/manual/en/function.readdir.php
  7450. * @param dir_handle resource[optional] <p>
  7451. * The directory handle resource previously opened
  7452. * with opendir. If the directory handle is
  7453. * not specified, the last link opened by opendir
  7454. * is assumed.
  7455. * </p>
  7456. * @return string the entry name on success&return.falseforfailure;.
  7457. */
  7458. function readdir ($dir_handle = null) {}
  7459. /**
  7460. * Return an instance of the Directory class
  7461. * @link http://www.php.net/manual/en/function.dir.php
  7462. * @param directory string <p>
  7463. * Directory to open
  7464. * </p>
  7465. * @param context resource[optional] <p>
  7466. * &note.context-support;
  7467. * </p>
  7468. * @return Directory an instance of Directory, or &null; with
  7469. * wrong parameters, or false in case of another error.
  7470. */
  7471. function dir ($directory, $context = null) {}
  7472. /**
  7473. * List files and directories inside the specified path
  7474. * @link http://www.php.net/manual/en/function.scandir.php
  7475. * @param directory string <p>
  7476. * The directory that will be scanned.
  7477. * </p>
  7478. * @param sorting_order int[optional] <p>
  7479. * By default, the sorted order is alphabetical in ascending order. If
  7480. * the optional sorting_order is set to
  7481. * SCANDIR_SORT_DESCENDING, then the sort order is
  7482. * alphabetical in descending order. If it is set to
  7483. * SCANDIR_SORT_NONE then the result is unsorted.
  7484. * </p>
  7485. * @param context resource[optional] <p>
  7486. * For a description of the context parameter,
  7487. * refer to the streams section of
  7488. * the manual.
  7489. * </p>
  7490. * @return array an array of filenames on success, or false on
  7491. * failure. If directory is not a directory, then
  7492. * boolean false is returned, and an error of level
  7493. * E_WARNING is generated.
  7494. */
  7495. function scandir ($directory, $sorting_order = null, $context = null) {}
  7496. /**
  7497. * Find pathnames matching a pattern
  7498. * @link http://www.php.net/manual/en/function.glob.php
  7499. * @param pattern string <p>
  7500. * The pattern. No tilde expansion or parameter substitution is done.
  7501. * </p>
  7502. * @param flags int[optional] <p>
  7503. * Valid flags:
  7504. * GLOB_MARK - Adds a slash to each directory returned
  7505. * @return array an array containing the matched files/directories, an empty array
  7506. * if no file matched or false on error.
  7507. * </p>
  7508. * <p>
  7509. * On some systems it is impossible to distinguish between empty match and an
  7510. * error.
  7511. */
  7512. function glob ($pattern, $flags = null) {}
  7513. /**
  7514. * Gets last access time of file
  7515. * @link http://www.php.net/manual/en/function.fileatime.php
  7516. * @param filename string <p>
  7517. * Path to the file.
  7518. * </p>
  7519. * @return int the time the file was last accessed, &return.falseforfailure;.
  7520. * The time is returned as a Unix timestamp.
  7521. */
  7522. function fileatime ($filename) {}
  7523. /**
  7524. * Gets inode change time of file
  7525. * @link http://www.php.net/manual/en/function.filectime.php
  7526. * @param filename string <p>
  7527. * Path to the file.
  7528. * </p>
  7529. * @return int the time the file was last changed, &return.falseforfailure;.
  7530. * The time is returned as a Unix timestamp.
  7531. */
  7532. function filectime ($filename) {}
  7533. /**
  7534. * Gets file group
  7535. * @link http://www.php.net/manual/en/function.filegroup.php
  7536. * @param filename string <p>
  7537. * Path to the file.
  7538. * </p>
  7539. * @return int the group ID of the file, or false if
  7540. * an error occurs. The group ID is returned in numerical format, use
  7541. * posix_getgrgid to resolve it to a group name.
  7542. * Upon failure, false is returned.
  7543. */
  7544. function filegroup ($filename) {}
  7545. /**
  7546. * Gets file inode
  7547. * @link http://www.php.net/manual/en/function.fileinode.php
  7548. * @param filename string <p>
  7549. * Path to the file.
  7550. * </p>
  7551. * @return int the inode number of the file, &return.falseforfailure;.
  7552. */
  7553. function fileinode ($filename) {}
  7554. /**
  7555. * Gets file modification time
  7556. * @link http://www.php.net/manual/en/function.filemtime.php
  7557. * @param filename string <p>
  7558. * Path to the file.
  7559. * </p>
  7560. * @return int the time the file was last modified, &return.falseforfailure;.
  7561. * The time is returned as a Unix timestamp, which is
  7562. * suitable for the date function.
  7563. */
  7564. function filemtime ($filename) {}
  7565. /**
  7566. * Gets file owner
  7567. * @link http://www.php.net/manual/en/function.fileowner.php
  7568. * @param filename string <p>
  7569. * Path to the file.
  7570. * </p>
  7571. * @return int the user ID of the owner of the file, &return.falseforfailure;.
  7572. * The user ID is returned in numerical format, use
  7573. * posix_getpwuid to resolve it to a username.
  7574. */
  7575. function fileowner ($filename) {}
  7576. /**
  7577. * Gets file permissions
  7578. * @link http://www.php.net/manual/en/function.fileperms.php
  7579. * @param filename string <p>
  7580. * Path to the file.
  7581. * </p>
  7582. * @return int the file's permissions as a numeric mode. Lower bits of this mode
  7583. * are the same as the permissions expected by chmod,
  7584. * however on most platforms the return value will also include information on
  7585. * the type of file given as filename. The examples
  7586. * below demonstrate how to test the return value for specific permissions and
  7587. * file types on POSIX systems, including Linux and Mac OS X.
  7588. * </p>
  7589. * <p>
  7590. * For local files, the specific return value is that of the
  7591. * st_mode member of the structure returned by the C
  7592. * library's stat function. Exactly which bits are set
  7593. * can vary from platform to platform, and looking up your specific platform's
  7594. * documentation is recommended if parsing the non-permission bits of the
  7595. * return value is required.
  7596. */
  7597. function fileperms ($filename) {}
  7598. /**
  7599. * Gets file size
  7600. * @link http://www.php.net/manual/en/function.filesize.php
  7601. * @param filename string <p>
  7602. * Path to the file.
  7603. * </p>
  7604. * @return int the size of the file in bytes, or false (and generates an error
  7605. * of level E_WARNING) in case of an error.
  7606. */
  7607. function filesize ($filename) {}
  7608. /**
  7609. * Gets file type
  7610. * @link http://www.php.net/manual/en/function.filetype.php
  7611. * @param filename string <p>
  7612. * Path to the file.
  7613. * </p>
  7614. * @return string the type of the file. Possible values are fifo, char,
  7615. * dir, block, link, file, socket and unknown.
  7616. * </p>
  7617. * <p>
  7618. * Returns false if an error occurs. filetype will also
  7619. * produce an E_NOTICE message if the stat call fails
  7620. * or if the file type is unknown.
  7621. */
  7622. function filetype ($filename) {}
  7623. /**
  7624. * Checks whether a file or directory exists
  7625. * @link http://www.php.net/manual/en/function.file-exists.php
  7626. * @param filename string <p>
  7627. * Path to the file or directory.
  7628. * </p>
  7629. * <p>
  7630. * On windows, use //computername/share/filename or
  7631. * \\computername\share\filename to check files on
  7632. * network shares.
  7633. * </p>
  7634. * @return bool true if the file or directory specified by
  7635. * filename exists; false otherwise.
  7636. * </p>
  7637. * <p>
  7638. * This function will return false for symlinks pointing to non-existing
  7639. * files.
  7640. * </p>
  7641. * <p>
  7642. * This function returns false for files inaccessible due to safe mode restrictions. However these
  7643. * files still can be included if
  7644. * they are located in safe_mode_include_dir.
  7645. * </p>
  7646. * <p>
  7647. * The check is done using the real UID/GID instead of the effective one.
  7648. */
  7649. function file_exists ($filename) {}
  7650. /**
  7651. * Tells whether the filename is writable
  7652. * @link http://www.php.net/manual/en/function.is-writable.php
  7653. * @param filename string <p>
  7654. * The filename being checked.
  7655. * </p>
  7656. * @return bool true if the filename exists and is
  7657. * writable.
  7658. */
  7659. function is_writable ($filename) {}
  7660. /**
  7661. * &Alias; <function>is_writable</function>
  7662. * @link http://www.php.net/manual/en/function.is-writeable.php
  7663. * @param filename
  7664. */
  7665. function is_writeable ($filename) {}
  7666. /**
  7667. * Tells whether a file exists and is readable
  7668. * @link http://www.php.net/manual/en/function.is-readable.php
  7669. * @param filename string <p>
  7670. * Path to the file.
  7671. * </p>
  7672. * @return bool true if the file or directory specified by
  7673. * filename exists and is readable, false otherwise.
  7674. */
  7675. function is_readable ($filename) {}
  7676. /**
  7677. * Tells whether the filename is executable
  7678. * @link http://www.php.net/manual/en/function.is-executable.php
  7679. * @param filename string <p>
  7680. * Path to the file.
  7681. * </p>
  7682. * @return bool true if the filename exists and is executable, or false on
  7683. * error.
  7684. */
  7685. function is_executable ($filename) {}
  7686. /**
  7687. * Tells whether the filename is a regular file
  7688. * @link http://www.php.net/manual/en/function.is-file.php
  7689. * @param filename string <p>
  7690. * Path to the file.
  7691. * </p>
  7692. * @return bool true if the filename exists and is a regular file, false
  7693. * otherwise.
  7694. */
  7695. function is_file ($filename) {}
  7696. /**
  7697. * Tells whether the filename is a directory
  7698. * @link http://www.php.net/manual/en/function.is-dir.php
  7699. * @param filename string <p>
  7700. * Path to the file. If filename is a relative
  7701. * filename, it will be checked relative to the current working
  7702. * directory. If filename is a symbolic or hard link
  7703. * then the link will be resolved and checked. If you have enabled &safemode;,
  7704. * or open_basedir further
  7705. * restrictions may apply.
  7706. * </p>
  7707. * @return bool true if the filename exists and is a directory, false
  7708. * otherwise.
  7709. */
  7710. function is_dir ($filename) {}
  7711. /**
  7712. * Tells whether the filename is a symbolic link
  7713. * @link http://www.php.net/manual/en/function.is-link.php
  7714. * @param filename string <p>
  7715. * Path to the file.
  7716. * </p>
  7717. * @return bool true if the filename exists and is a symbolic link, false
  7718. * otherwise.
  7719. */
  7720. function is_link ($filename) {}
  7721. /**
  7722. * Gives information about a file
  7723. * @link http://www.php.net/manual/en/function.stat.php
  7724. * @param filename string <p>
  7725. * Path to the file.
  7726. * </p>
  7727. * @return array <table>
  7728. * stat and fstat result
  7729. * format
  7730. * <tr valign="top">
  7731. * <td>Numeric</td>
  7732. * <td>Associative (since PHP 4.0.6)</td>
  7733. * <td>Description</td>
  7734. * </tr>
  7735. * <tr valign="top">
  7736. * <td>0</td>
  7737. * <td>dev</td>
  7738. * <td>device number</td>
  7739. * </tr>
  7740. * <tr valign="top">
  7741. * <td>1</td>
  7742. * <td>ino</td>
  7743. * <td>inode number *</td>
  7744. * </tr>
  7745. * <tr valign="top">
  7746. * <td>2</td>
  7747. * <td>mode</td>
  7748. * <td>inode protection mode</td>
  7749. * </tr>
  7750. * <tr valign="top">
  7751. * <td>3</td>
  7752. * <td>nlink</td>
  7753. * <td>number of links</td>
  7754. * </tr>
  7755. * <tr valign="top">
  7756. * <td>4</td>
  7757. * <td>uid</td>
  7758. * <td>userid of owner *</td>
  7759. * </tr>
  7760. * <tr valign="top">
  7761. * <td>5</td>
  7762. * <td>gid</td>
  7763. * <td>groupid of owner *</td>
  7764. * </tr>
  7765. * <tr valign="top">
  7766. * <td>6</td>
  7767. * <td>rdev</td>
  7768. * <td>device type, if inode device</td>
  7769. * </tr>
  7770. * <tr valign="top">
  7771. * <td>7</td>
  7772. * <td>size</td>
  7773. * <td>size in bytes</td>
  7774. * </tr>
  7775. * <tr valign="top">
  7776. * <td>8</td>
  7777. * <td>atime</td>
  7778. * <td>time of last access (Unix timestamp)</td>
  7779. * </tr>
  7780. * <tr valign="top">
  7781. * <td>9</td>
  7782. * <td>mtime</td>
  7783. * <td>time of last modification (Unix timestamp)</td>
  7784. * </tr>
  7785. * <tr valign="top">
  7786. * <td>10</td>
  7787. * <td>ctime</td>
  7788. * <td>time of last inode change (Unix timestamp)</td>
  7789. * </tr>
  7790. * <tr valign="top">
  7791. * <td>11</td>
  7792. * <td>blksize</td>
  7793. * <td>blocksize of filesystem IO **</td>
  7794. * </tr>
  7795. * <tr valign="top">
  7796. * <td>12</td>
  7797. * <td>blocks</td>
  7798. * <td>number of 512-byte blocks allocated **</td>
  7799. * </tr>
  7800. * </table>
  7801. * * On Windows this will always be 0.
  7802. * </p>
  7803. * <p>
  7804. * ** Only valid on systems supporting the st_blksize type - other
  7805. * systems (e.g. Windows) return -1.
  7806. * </p>
  7807. * <p>
  7808. * In case of error, stat returns false.
  7809. */
  7810. function stat ($filename) {}
  7811. /**
  7812. * Gives information about a file or symbolic link
  7813. * @link http://www.php.net/manual/en/function.lstat.php
  7814. * @param filename string <p>
  7815. * Path to a file or a symbolic link.
  7816. * </p>
  7817. * @return array See the manual page for stat for information on
  7818. * the structure of the array that lstat returns.
  7819. * This function is identical to the stat function
  7820. * except that if the filename parameter is a symbolic
  7821. * link, the status of the symbolic link is returned, not the status of the
  7822. * file pointed to by the symbolic link.
  7823. */
  7824. function lstat ($filename) {}
  7825. /**
  7826. * Changes file owner
  7827. * @link http://www.php.net/manual/en/function.chown.php
  7828. * @param filename string <p>
  7829. * Path to the file.
  7830. * </p>
  7831. * @param user mixed <p>
  7832. * A user name or number.
  7833. * </p>
  7834. * @return bool Returns true on success or false on failure.
  7835. */
  7836. function chown ($filename, $user) {}
  7837. /**
  7838. * Changes file group
  7839. * @link http://www.php.net/manual/en/function.chgrp.php
  7840. * @param filename string <p>
  7841. * Path to the file.
  7842. * </p>
  7843. * @param group mixed <p>
  7844. * A group name or number.
  7845. * </p>
  7846. * @return bool Returns true on success or false on failure.
  7847. */
  7848. function chgrp ($filename, $group) {}
  7849. /**
  7850. * Changes user ownership of symlink
  7851. * @link http://www.php.net/manual/en/function.lchown.php
  7852. * @param filename string <p>
  7853. * Path to the file.
  7854. * </p>
  7855. * @param user mixed <p>
  7856. * User name or number.
  7857. * </p>
  7858. * @return bool Returns true on success or false on failure.
  7859. */
  7860. function lchown ($filename, $user) {}
  7861. /**
  7862. * Changes group ownership of symlink
  7863. * @link http://www.php.net/manual/en/function.lchgrp.php
  7864. * @param filename string <p>
  7865. * Path to the symlink.
  7866. * </p>
  7867. * @param group mixed <p>
  7868. * The group specified by name or number.
  7869. * </p>
  7870. * @return bool Returns true on success or false on failure.
  7871. */
  7872. function lchgrp ($filename, $group) {}
  7873. /**
  7874. * Changes file mode
  7875. * @link http://www.php.net/manual/en/function.chmod.php
  7876. * @param filename string <p>
  7877. * Path to the file.
  7878. * </p>
  7879. * @param mode int <p>
  7880. * Note that mode is not automatically
  7881. * assumed to be an octal value, so strings (such as "g+w") will
  7882. * not work properly. To ensure the expected operation,
  7883. * you need to prefix mode with a zero (0):
  7884. * </p>
  7885. * <p>
  7886. * ]]>
  7887. * </p>
  7888. * <p>
  7889. * The mode parameter consists of three octal
  7890. * number components specifying access restrictions for the owner,
  7891. * the user group in which the owner is in, and to everybody else in
  7892. * this order. One component can be computed by adding up the needed
  7893. * permissions for that target user base. Number 1 means that you
  7894. * grant execute rights, number 2 means that you make the file
  7895. * writeable, number 4 means that you make the file readable. Add
  7896. * up these numbers to specify needed rights. You can also read more
  7897. * about modes on Unix systems with 'man 1 chmod'
  7898. * and 'man 2 chmod'.
  7899. * </p>
  7900. * <p>
  7901. * @return bool Returns true on success or false on failure.
  7902. */
  7903. function chmod ($filename, $mode) {}
  7904. /**
  7905. * Sets access and modification time of file
  7906. * @link http://www.php.net/manual/en/function.touch.php
  7907. * @param filename string <p>
  7908. * The name of the file being touched.
  7909. * </p>
  7910. * @param time int[optional] <p>
  7911. * The touch time. If time is not supplied,
  7912. * the current system time is used.
  7913. * </p>
  7914. * @param atime int[optional] <p>
  7915. * If present, the access time of the given filename is set to
  7916. * the value of atime. Otherwise, it is set to
  7917. * the value passed to the time parameter.
  7918. * If neither are present, the current system time is used.
  7919. * </p>
  7920. * @return bool Returns true on success or false on failure.
  7921. */
  7922. function touch ($filename, $time = null, $atime = null) {}
  7923. /**
  7924. * Clears file status cache
  7925. * @link http://www.php.net/manual/en/function.clearstatcache.php
  7926. * @param clear_realpath_cache bool[optional] <p>
  7927. * Whether to clear the realpath cache or not.
  7928. * </p>
  7929. * @param filename string[optional] <p>
  7930. * Clear the realpath cache for a specific filename; only used if
  7931. * clear_realpath_cache is true.
  7932. * </p>
  7933. * @return void
  7934. */
  7935. function clearstatcache ($clear_realpath_cache = null, $filename = null) {}
  7936. /**
  7937. * Returns the total size of a filesystem or disk partition
  7938. * @link http://www.php.net/manual/en/function.disk-total-space.php
  7939. * @param directory string <p>
  7940. * A directory of the filesystem or disk partition.
  7941. * </p>
  7942. * @return float the total number of bytes as a float
  7943. * &return.falseforfailure;.
  7944. */
  7945. function disk_total_space ($directory) {}
  7946. /**
  7947. * Returns available space on filesystem or disk partition
  7948. * @link http://www.php.net/manual/en/function.disk-free-space.php
  7949. * @param directory string <p>
  7950. * A directory of the filesystem or disk partition.
  7951. * </p>
  7952. * <p>
  7953. * Given a file name instead of a directory, the behaviour of the
  7954. * function is unspecified and may differ between operating systems and
  7955. * PHP versions.
  7956. * </p>
  7957. * @return float the number of available bytes as a float
  7958. * &return.falseforfailure;.
  7959. */
  7960. function disk_free_space ($directory) {}
  7961. /**
  7962. * &Alias; <function>disk_free_space</function>
  7963. * @link http://www.php.net/manual/en/function.diskfreespace.php
  7964. * @param path
  7965. */
  7966. function diskfreespace ($path) {}
  7967. /**
  7968. * Get realpath cache size
  7969. * @link http://www.php.net/manual/en/function.realpath-cache-size.php
  7970. * @return int how much memory realpath cache is using.
  7971. */
  7972. function realpath_cache_size () {}
  7973. /**
  7974. * Get realpath cache entries
  7975. * @link http://www.php.net/manual/en/function.realpath-cache-get.php
  7976. * @return array an array of realpath cache entries. The keys are original path
  7977. * entries, and the values are arrays of data items, containing the resolved
  7978. * path, expiration date, and other options kept in the cache.
  7979. */
  7980. function realpath_cache_get () {}
  7981. /**
  7982. * Send mail
  7983. * @link http://www.php.net/manual/en/function.mail.php
  7984. * @param to string <p>
  7985. * Receiver, or receivers of the mail.
  7986. * </p>
  7987. * <p>
  7988. * The formatting of this string must comply with
  7989. * RFC 2822. Some examples are:
  7990. * user@example.com
  7991. * user@example.com, anotheruser@example.com
  7992. * User &lt;user@example.com&gt;
  7993. * User &lt;user@example.com&gt;, Another User &lt;anotheruser@example.com&gt;
  7994. * </p>
  7995. * @param subject string <p>
  7996. * Subject of the email to be sent.
  7997. * </p>
  7998. * <p>
  7999. * Subject must satisfy RFC 2047.
  8000. * </p>
  8001. * @param message string <p>
  8002. * Message to be sent.
  8003. * </p>
  8004. * <p>
  8005. * Each line should be separated with a LF (\n). Lines should not be larger
  8006. * than 70 characters.
  8007. * </p>
  8008. * <p>
  8009. * (Windows only) When PHP is talking to a SMTP server directly, if a full
  8010. * stop is found on the start of a line, it is removed. To counter-act this,
  8011. * replace these occurrences with a double dot.
  8012. * ]]>
  8013. * </p>
  8014. * @param additional_headers string[optional] <p>
  8015. * String to be inserted at the end of the email header.
  8016. * </p>
  8017. * <p>
  8018. * This is typically used to add extra headers (From, Cc, and Bcc).
  8019. * Multiple extra headers should be separated with a CRLF (\r\n).
  8020. * </p>
  8021. * <p>
  8022. * When sending mail, the mail must contain
  8023. * a From header. This can be set with the
  8024. * additional_headers parameter, or a default
  8025. * can be set in &php.ini;.
  8026. * </p>
  8027. * <p>
  8028. * Failing to do this will result in an error
  8029. * message similar to Warning: mail(): "sendmail_from" not
  8030. * set in php.ini or custom "From:" header missing.
  8031. * The From header sets also
  8032. * Return-Path under Windows.
  8033. * </p>
  8034. * <p>
  8035. * If messages are not received, try using a LF (\n) only.
  8036. * Some poor quality Unix mail transfer agents replace LF by CRLF
  8037. * automatically (which leads to doubling CR if CRLF is used).
  8038. * This should be a last resort, as it does not comply with
  8039. * RFC 2822.
  8040. * </p>
  8041. * @param additional_parameters string[optional] <p>
  8042. * The additional_parameters parameter
  8043. * can be used to pass additional flags as command line options to the
  8044. * program configured to be used when sending mail, as defined by the
  8045. * sendmail_path configuration setting. For example,
  8046. * this can be used to set the envelope sender address when using
  8047. * sendmail with the -f sendmail option.
  8048. * </p>
  8049. * <p>
  8050. * The user that the webserver runs as should be added as a trusted user to the
  8051. * sendmail configuration to prevent a 'X-Warning' header from being added
  8052. * to the message when the envelope sender (-f) is set using this method.
  8053. * For sendmail users, this file is /etc/mail/trusted-users.
  8054. * </p>
  8055. * @return bool true if the mail was successfully accepted for delivery, false otherwise.
  8056. * </p>
  8057. * <p>
  8058. * It is important to note that just because the mail was accepted for delivery,
  8059. * it does NOT mean the mail will actually reach the intended destination.
  8060. */
  8061. function mail ($to, $subject, $message, $additional_headers = null, $additional_parameters = null) {}
  8062. /**
  8063. * Calculate the hash value needed by EZMLM
  8064. * @link http://www.php.net/manual/en/function.ezmlm-hash.php
  8065. * @param addr string <p>
  8066. * The email address that's being hashed.
  8067. * </p>
  8068. * @return int The hash value of addr.
  8069. */
  8070. function ezmlm_hash ($addr) {}
  8071. /**
  8072. * Open connection to system logger
  8073. * @link http://www.php.net/manual/en/function.openlog.php
  8074. * @param ident string <p>
  8075. * The string ident is added to each message.
  8076. * </p>
  8077. * @param option int <p>
  8078. * The option argument is used to indicate
  8079. * what logging options will be used when generating a log message.
  8080. * <table>
  8081. * openlog Options
  8082. * <tr valign="top">
  8083. * <td>Constant</td>
  8084. * <td>Description</td>
  8085. * </tr>
  8086. * <tr valign="top">
  8087. * <td>LOG_CONS</td>
  8088. * <td>
  8089. * if there is an error while sending data to the system logger,
  8090. * write directly to the system console
  8091. * </td>
  8092. * </tr>
  8093. * <tr valign="top">
  8094. * <td>LOG_NDELAY</td>
  8095. * <td>
  8096. * open the connection to the logger immediately
  8097. * </td>
  8098. * </tr>
  8099. * <tr valign="top">
  8100. * <td>LOG_ODELAY</td>
  8101. * <td>
  8102. * (default) delay opening the connection until the first
  8103. * message is logged
  8104. * </td>
  8105. * </tr>
  8106. * <tr valign="top">
  8107. * <td>LOG_PERROR</td>
  8108. * <td>print log message also to standard error</td>
  8109. * </tr>
  8110. * <tr valign="top">
  8111. * <td>LOG_PID</td>
  8112. * <td>include PID with each message</td>
  8113. * </tr>
  8114. * </table>
  8115. * You can use one or more of this options. When using multiple options
  8116. * you need to OR them, i.e. to open the connection
  8117. * immediately, write to the console and include the PID in each message,
  8118. * you will use: LOG_CONS | LOG_NDELAY | LOG_PID
  8119. * </p>
  8120. * @param facility int <p>
  8121. * The facility argument is used to specify what
  8122. * type of program is logging the message. This allows you to specify
  8123. * (in your machine's syslog configuration) how messages coming from
  8124. * different facilities will be handled.
  8125. * <table>
  8126. * openlog Facilities
  8127. * <tr valign="top">
  8128. * <td>Constant</td>
  8129. * <td>Description</td>
  8130. * </tr>
  8131. * <tr valign="top">
  8132. * <td>LOG_AUTH</td>
  8133. * <td>
  8134. * security/authorization messages (use
  8135. * LOG_AUTHPRIV instead
  8136. * in systems where that constant is defined)
  8137. * </td>
  8138. * </tr>
  8139. * <tr valign="top">
  8140. * <td>LOG_AUTHPRIV</td>
  8141. * <td>security/authorization messages (private)</td>
  8142. * </tr>
  8143. * <tr valign="top">
  8144. * <td>LOG_CRON</td>
  8145. * <td>clock daemon (cron and at)</td>
  8146. * </tr>
  8147. * <tr valign="top">
  8148. * <td>LOG_DAEMON</td>
  8149. * <td>other system daemons</td>
  8150. * </tr>
  8151. * <tr valign="top">
  8152. * <td>LOG_KERN</td>
  8153. * <td>kernel messages</td>
  8154. * </tr>
  8155. * <tr valign="top">
  8156. * <td>LOG_LOCAL0 ... LOG_LOCAL7</td>
  8157. * <td>reserved for local use, these are not available in Windows</td>
  8158. * </tr>
  8159. * <tr valign="top">
  8160. * <td>LOG_LPR</td>
  8161. * <td>line printer subsystem</td>
  8162. * </tr>
  8163. * <tr valign="top">
  8164. * <td>LOG_MAIL</td>
  8165. * <td>mail subsystem</td>
  8166. * </tr>
  8167. * <tr valign="top">
  8168. * <td>LOG_NEWS</td>
  8169. * <td>USENET news subsystem</td>
  8170. * </tr>
  8171. * <tr valign="top">
  8172. * <td>LOG_SYSLOG</td>
  8173. * <td>messages generated internally by syslogd</td>
  8174. * </tr>
  8175. * <tr valign="top">
  8176. * <td>LOG_USER</td>
  8177. * <td>generic user-level messages</td>
  8178. * </tr>
  8179. * <tr valign="top">
  8180. * <td>LOG_UUCP</td>
  8181. * <td>UUCP subsystem</td>
  8182. * </tr>
  8183. * </table>
  8184. * </p>
  8185. * <p>
  8186. * LOG_USER is the only valid log type under Windows
  8187. * operating systems
  8188. * </p>
  8189. * @return bool Returns true on success or false on failure.
  8190. */
  8191. function openlog ($ident, $option, $facility) {}
  8192. /**
  8193. * Generate a system log message
  8194. * @link http://www.php.net/manual/en/function.syslog.php
  8195. * @param priority int <p>
  8196. * priority is a combination of the facility and
  8197. * the level. Possible values are:
  8198. * <table>
  8199. * syslog Priorities (in descending order)
  8200. * <tr valign="top">
  8201. * <td>Constant</td>
  8202. * <td>Description</td>
  8203. * </tr>
  8204. * <tr valign="top">
  8205. * <td>LOG_EMERG</td>
  8206. * <td>system is unusable</td>
  8207. * </tr>
  8208. * <tr valign="top">
  8209. * <td>LOG_ALERT</td>
  8210. * <td>action must be taken immediately</td>
  8211. * </tr>
  8212. * <tr valign="top">
  8213. * <td>LOG_CRIT</td>
  8214. * <td>critical conditions</td>
  8215. * </tr>
  8216. * <tr valign="top">
  8217. * <td>LOG_ERR</td>
  8218. * <td>error conditions</td>
  8219. * </tr>
  8220. * <tr valign="top">
  8221. * <td>LOG_WARNING</td>
  8222. * <td>warning conditions</td>
  8223. * </tr>
  8224. * <tr valign="top">
  8225. * <td>LOG_NOTICE</td>
  8226. * <td>normal, but significant, condition</td>
  8227. * </tr>
  8228. * <tr valign="top">
  8229. * <td>LOG_INFO</td>
  8230. * <td>informational message</td>
  8231. * </tr>
  8232. * <tr valign="top">
  8233. * <td>LOG_DEBUG</td>
  8234. * <td>debug-level message</td>
  8235. * </tr>
  8236. * </table>
  8237. * </p>
  8238. * @param message string <p>
  8239. * The message to send, except that the two characters
  8240. * %m will be replaced by the error message string
  8241. * (strerror) corresponding to the present value of
  8242. * errno.
  8243. * </p>
  8244. * @return bool Returns true on success or false on failure.
  8245. */
  8246. function syslog ($priority, $message) {}
  8247. /**
  8248. * Close connection to system logger
  8249. * @link http://www.php.net/manual/en/function.closelog.php
  8250. * @return bool Returns true on success or false on failure.
  8251. */
  8252. function closelog () {}
  8253. /**
  8254. * Combined linear congruential generator
  8255. * @link http://www.php.net/manual/en/function.lcg-value.php
  8256. * @return float A pseudo random float value in the range of (0, 1)
  8257. */
  8258. function lcg_value () {}
  8259. /**
  8260. * Calculate the metaphone key of a string
  8261. * @link http://www.php.net/manual/en/function.metaphone.php
  8262. * @param str string <p>
  8263. * The input string.
  8264. * </p>
  8265. * @param phonemes int[optional] <p>
  8266. * This parameter restricts the returned metaphone key to
  8267. * phonemes characters in length.
  8268. * The default value of 0 means no restriction.
  8269. * </p>
  8270. * @return string the metaphone key as a string, &return.falseforfailure;.
  8271. */
  8272. function metaphone ($str, $phonemes = null) {}
  8273. /**
  8274. * Turn on output buffering
  8275. * @link http://www.php.net/manual/en/function.ob-start.php
  8276. * @param output_callback callable[optional] <p>
  8277. * An optional output_callback function may be
  8278. * specified. This function takes a string as a parameter and should
  8279. * return a string. The function will be called when
  8280. * the output buffer is flushed (sent) or cleaned (with
  8281. * ob_flush, ob_clean or similar
  8282. * function) or when the output buffer
  8283. * is flushed to the browser at the end of the request. When
  8284. * output_callback is called, it will receive the
  8285. * contents of the output buffer as its parameter and is expected to
  8286. * return a new output buffer as a result, which will be sent to the
  8287. * browser. If the output_callback is not a
  8288. * callable function, this function will return false.
  8289. * </p>
  8290. * <p>
  8291. * If the callback function has two parameters, the second parameter is
  8292. * filled with a bit-field consisting of
  8293. * PHP_OUTPUT_HANDLER_* constants.
  8294. * </p>
  8295. * <p>
  8296. * If output_callback returns false original
  8297. * input is sent to the browser.
  8298. * </p>
  8299. * <p>
  8300. * The output_callback parameter may be bypassed
  8301. * by passing a &null; value.
  8302. * </p>
  8303. * <p>
  8304. * ob_end_clean, ob_end_flush,
  8305. * ob_clean, ob_flush and
  8306. * ob_start may not be called from a callback
  8307. * function. If you call them from callback function, the behavior is
  8308. * undefined. If you would like to delete the contents of a buffer,
  8309. * return "" (a null string) from callback function.
  8310. * You can't even call functions using the output buffering functions like
  8311. * print_r($expression, true) or
  8312. * highlight_file($filename, true) from a callback
  8313. * function.
  8314. * </p>
  8315. * <p>
  8316. * In PHP 4.0.4, ob_gzhandler was introduced to
  8317. * facilitate sending gz-encoded data to web browsers that support
  8318. * compressed web pages. ob_gzhandler determines
  8319. * what type of content encoding the browser will accept and will return
  8320. * its output accordingly.
  8321. * </p>
  8322. * @param chunk_size int[optional] <p>
  8323. * If the optional parameter chunk_size is passed, the
  8324. * buffer will be flushed after any output call which causes the buffer's
  8325. * length to equal or exceed chunk_size. The default
  8326. * value 0 means that the output function will only be
  8327. * called when the output buffer is closed.
  8328. * </p>
  8329. * <p>
  8330. * Prior to PHP 5.4.0, the value 1 was a special case
  8331. * value that set the chunk size to 4096 bytes.
  8332. * </p>
  8333. * @param erase bool[optional] <p>
  8334. * If the optional parameter erase is set to false,
  8335. * the buffer will not be deleted until the script finishes.
  8336. * This causes that flushing and cleaning functions would issue a notice
  8337. * and return false if called.
  8338. * </p>
  8339. * @return bool Returns true on success or false on failure.
  8340. */
  8341. function ob_start ($output_callback = null, $chunk_size = null, $erase = null) {}
  8342. /**
  8343. * Flush (send) the output buffer
  8344. * @link http://www.php.net/manual/en/function.ob-flush.php
  8345. * @return void
  8346. */
  8347. function ob_flush () {}
  8348. /**
  8349. * Clean (erase) the output buffer
  8350. * @link http://www.php.net/manual/en/function.ob-clean.php
  8351. * @return void
  8352. */
  8353. function ob_clean () {}
  8354. /**
  8355. * Flush (send) the output buffer and turn off output buffering
  8356. * @link http://www.php.net/manual/en/function.ob-end-flush.php
  8357. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  8358. * function without an active buffer or that for some reason a buffer could
  8359. * not be deleted (possible for special buffer).
  8360. */
  8361. function ob_end_flush () {}
  8362. /**
  8363. * Clean (erase) the output buffer and turn off output buffering
  8364. * @link http://www.php.net/manual/en/function.ob-end-clean.php
  8365. * @return bool Returns true on success or false on failure. Reasons for failure are first that you called the
  8366. * function without an active buffer or that for some reason a buffer could
  8367. * not be deleted (possible for special buffer).
  8368. */
  8369. function ob_end_clean () {}
  8370. /**
  8371. * Flush the output buffer, return it as a string and turn off output buffering
  8372. * @link http://www.php.net/manual/en/function.ob-get-flush.php
  8373. * @return string the output buffer or false if no buffering is active.
  8374. */
  8375. function ob_get_flush () {}
  8376. /**
  8377. * Get current buffer contents and delete current output buffer
  8378. * @link http://www.php.net/manual/en/function.ob-get-clean.php
  8379. * @return string the contents of the output buffer and end output buffering.
  8380. * If output buffering isn't active then false is returned.
  8381. */
  8382. function ob_get_clean () {}
  8383. /**
  8384. * Return the length of the output buffer
  8385. * @link http://www.php.net/manual/en/function.ob-get-length.php
  8386. * @return int the length of the output buffer contents or false if no
  8387. * buffering is active.
  8388. */
  8389. function ob_get_length () {}
  8390. /**
  8391. * Return the nesting level of the output buffering mechanism
  8392. * @link http://www.php.net/manual/en/function.ob-get-level.php
  8393. * @return int the level of nested output buffering handlers or zero if output
  8394. * buffering is not active.
  8395. */
  8396. function ob_get_level () {}
  8397. /**
  8398. * Get status of output buffers
  8399. * @link http://www.php.net/manual/en/function.ob-get-status.php
  8400. * @param full_status bool[optional] <p>
  8401. * true to return all active output buffer levels. If false or not
  8402. * set, only the top level output buffer is returned.
  8403. * </p>
  8404. * @return array If called without the full_status parameter
  8405. * or with full_status = false a simple array
  8406. * with the following elements is returned:
  8407. * 2
  8408. * [type] => 0
  8409. * [status] => 0
  8410. * [name] => URL-Rewriter
  8411. * [del] => 1
  8412. * )
  8413. * ]]>
  8414. * Simple ob_get_status results
  8415. * KeyValue
  8416. * levelOutput nesting level
  8417. * typePHP_OUTPUT_HANDLER_INTERNAL (0) or PHP_OUTPUT_HANDLER_USER (1)
  8418. * statusOne of PHP_OUTPUT_HANDLER_START (0), PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2)
  8419. * nameName of active output handler or ' default output handler' if none is set
  8420. * delErase-flag as set by ob_start
  8421. * </p>
  8422. * <p>
  8423. * If called with full_status = true an array
  8424. * with one element for each active output buffer level is returned.
  8425. * The output level is used as key of the top level array and each array
  8426. * element itself is another array holding status information
  8427. * on one active output level.
  8428. * Array
  8429. * (
  8430. * [chunk_size] => 0
  8431. * [size] => 40960
  8432. * [block_size] => 10240
  8433. * [type] => 1
  8434. * [status] => 0
  8435. * [name] => default output handler
  8436. * [del] => 1
  8437. * )
  8438. * [1] => Array
  8439. * (
  8440. * [chunk_size] => 0
  8441. * [size] => 40960
  8442. * [block_size] => 10240
  8443. * [type] => 0
  8444. * [buffer_size] => 0
  8445. * [status] => 0
  8446. * [name] => URL-Rewriter
  8447. * [del] => 1
  8448. * )
  8449. * )
  8450. * ]]>
  8451. * </p>
  8452. * <p>
  8453. * The full output contains these additional elements:
  8454. * Full ob_get_status results
  8455. * KeyValue
  8456. * chunk_sizeChunk size as set by ob_start
  8457. * size...
  8458. * blocksize...
  8459. */
  8460. function ob_get_status ($full_status = null) {}
  8461. /**
  8462. * Return the contents of the output buffer
  8463. * @link http://www.php.net/manual/en/function.ob-get-contents.php
  8464. * @return string This will return the contents of the output buffer or false, if output
  8465. * buffering isn't active.
  8466. */
  8467. function ob_get_contents () {}
  8468. /**
  8469. * Turn implicit flush on/off
  8470. * @link http://www.php.net/manual/en/function.ob-implicit-flush.php
  8471. * @param flag int[optional] <p>
  8472. * true to turn implicit flushing on, false otherwise.
  8473. * </p>
  8474. * @return void
  8475. */
  8476. function ob_implicit_flush ($flag = null) {}
  8477. /**
  8478. * List all output handlers in use
  8479. * @link http://www.php.net/manual/en/function.ob-list-handlers.php
  8480. * @return array This will return an array with the output handlers in use (if any). If
  8481. * output_buffering is enabled or
  8482. * an anonymous function was used with ob_start,
  8483. * ob_list_handlers will return "default output
  8484. * handler".
  8485. */
  8486. function ob_list_handlers () {}
  8487. /**
  8488. * Sort an array by key
  8489. * @link http://www.php.net/manual/en/function.ksort.php
  8490. * @param array array <p>
  8491. * The input array.
  8492. * </p>
  8493. * @param sort_flags int[optional] <p>
  8494. * You may modify the behavior of the sort using the optional
  8495. * parameter sort_flags, for details
  8496. * see sort.
  8497. * </p>
  8498. * @return bool Returns true on success or false on failure.
  8499. */
  8500. function ksort (array &$array, $sort_flags = null) {}
  8501. /**
  8502. * Sort an array by key in reverse order
  8503. * @link http://www.php.net/manual/en/function.krsort.php
  8504. * @param array array <p>
  8505. * The input array.
  8506. * </p>
  8507. * @param sort_flags int[optional] <p>
  8508. * You may modify the behavior of the sort using the optional parameter
  8509. * sort_flags, for details see
  8510. * sort.
  8511. * </p>
  8512. * @return bool Returns true on success or false on failure.
  8513. */
  8514. function krsort (array &$array, $sort_flags = null) {}
  8515. /**
  8516. * Sort an array using a "natural order" algorithm
  8517. * @link http://www.php.net/manual/en/function.natsort.php
  8518. * @param array array <p>
  8519. * The input array.
  8520. * </p>
  8521. * @return bool Returns true on success or false on failure.
  8522. */
  8523. function natsort (array &$array) {}
  8524. /**
  8525. * Sort an array using a case insensitive "natural order" algorithm
  8526. * @link http://www.php.net/manual/en/function.natcasesort.php
  8527. * @param array array <p>
  8528. * The input array.
  8529. * </p>
  8530. * @return bool Returns true on success or false on failure.
  8531. */
  8532. function natcasesort (array &$array) {}
  8533. /**
  8534. * Sort an array and maintain index association
  8535. * @link http://www.php.net/manual/en/function.asort.php
  8536. * @param array array <p>
  8537. * The input array.
  8538. * </p>
  8539. * @param sort_flags int[optional] <p>
  8540. * You may modify the behavior of the sort using the optional
  8541. * parameter sort_flags, for details
  8542. * see sort.
  8543. * </p>
  8544. * @return bool Returns true on success or false on failure.
  8545. */
  8546. function asort (array &$array, $sort_flags = null) {}
  8547. /**
  8548. * Sort an array in reverse order and maintain index association
  8549. * @link http://www.php.net/manual/en/function.arsort.php
  8550. * @param array array <p>
  8551. * The input array.
  8552. * </p>
  8553. * @param sort_flags int[optional] <p>
  8554. * You may modify the behavior of the sort using the optional parameter
  8555. * sort_flags, for details see
  8556. * sort.
  8557. * </p>
  8558. * @return bool Returns true on success or false on failure.
  8559. */
  8560. function arsort (array &$array, $sort_flags = null) {}
  8561. /**
  8562. * Sort an array
  8563. * @link http://www.php.net/manual/en/function.sort.php
  8564. * @param array array <p>
  8565. * The input array.
  8566. * </p>
  8567. * @param sort_flags int[optional] <p>
  8568. * The optional second parameter sort_flags
  8569. * may be used to modify the sorting behavior using these values:
  8570. * </p>
  8571. * <p>
  8572. * Sorting type flags:
  8573. * SORT_REGULAR - compare items normally
  8574. * (don't change types)
  8575. * @return bool Returns true on success or false on failure.
  8576. */
  8577. function sort (array &$array, $sort_flags = null) {}
  8578. /**
  8579. * Sort an array in reverse order
  8580. * @link http://www.php.net/manual/en/function.rsort.php
  8581. * @param array array <p>
  8582. * The input array.
  8583. * </p>
  8584. * @param sort_flags int[optional] <p>
  8585. * You may modify the behavior of the sort using the optional
  8586. * parameter sort_flags, for details see
  8587. * sort.
  8588. * </p>
  8589. * @return bool Returns true on success or false on failure.
  8590. */
  8591. function rsort (array &$array, $sort_flags = null) {}
  8592. /**
  8593. * Sort an array by values using a user-defined comparison function
  8594. * @link http://www.php.net/manual/en/function.usort.php
  8595. * @param array array <p>
  8596. * The input array.
  8597. * </p>
  8598. * @param cmp_function callable <p>
  8599. * &return.callbacksort;
  8600. * </p>
  8601. * &callback.cmp;
  8602. * <p>
  8603. * Returning non-integer values from the comparison
  8604. * function, such as float, will result in an internal cast to
  8605. * integer of the callback's return value. So values such as
  8606. * 0.99 and 0.1 will both be cast to an integer value of 0, which will
  8607. * compare such values as equal.
  8608. * </p>
  8609. * @return bool Returns true on success or false on failure.
  8610. */
  8611. function usort (array &$array, $cmp_function) {}
  8612. /**
  8613. * Sort an array with a user-defined comparison function and maintain index association
  8614. * @link http://www.php.net/manual/en/function.uasort.php
  8615. * @param array array <p>
  8616. * The input array.
  8617. * </p>
  8618. * @param cmp_function callable <p>
  8619. * See usort and uksort for
  8620. * examples of user-defined comparison functions.
  8621. * </p>
  8622. * @return bool Returns true on success or false on failure.
  8623. */
  8624. function uasort (array &$array, $cmp_function) {}
  8625. /**
  8626. * Sort an array by keys using a user-defined comparison function
  8627. * @link http://www.php.net/manual/en/function.uksort.php
  8628. * @param array array <p>
  8629. * The input array.
  8630. * </p>
  8631. * @param cmp_function callable <p>
  8632. * &return.callbacksort;
  8633. * </p>
  8634. * &callback.cmp;
  8635. * @return bool Returns true on success or false on failure.
  8636. */
  8637. function uksort (array &$array, $cmp_function) {}
  8638. /**
  8639. * Shuffle an array
  8640. * @link http://www.php.net/manual/en/function.shuffle.php
  8641. * @param array array <p>
  8642. * The array.
  8643. * </p>
  8644. * @return bool Returns true on success or false on failure.
  8645. */
  8646. function shuffle (array &$array) {}
  8647. /**
  8648. * Apply a user function to every member of an array
  8649. * @link http://www.php.net/manual/en/function.array-walk.php
  8650. * @param array array <p>
  8651. * The input array.
  8652. * </p>
  8653. * @param funcname callable <p>
  8654. * Typically, funcname takes on two parameters.
  8655. * The array parameter's value being the first, and
  8656. * the key/index second.
  8657. * </p>
  8658. * <p>
  8659. * If funcname needs to be working with the
  8660. * actual values of the array, specify the first parameter of
  8661. * funcname as a
  8662. * reference. Then,
  8663. * any changes made to those elements will be made in the
  8664. * original array itself.
  8665. * </p>
  8666. * <p>
  8667. * Many internal functions (for example strtolower)
  8668. * will throw a warning if more than the expected number of argument
  8669. * are passed in and are not usable directly as
  8670. * funcname.
  8671. * </p>
  8672. * <p>
  8673. * Only the values of the array may potentially be
  8674. * changed; its structure cannot be altered, i.e., the programmer cannot
  8675. * add, unset or reorder elements. If the callback does not respect this
  8676. * requirement, the behavior of this function is undefined, and
  8677. * unpredictable.
  8678. * </p>
  8679. * @param userdata mixed[optional] <p>
  8680. * If the optional userdata parameter is supplied,
  8681. * it will be passed as the third parameter to the callback
  8682. * funcname.
  8683. * </p>
  8684. * @return bool Returns true on success or false on failure.
  8685. */
  8686. function array_walk (array &$array, $funcname, $userdata = null) {}
  8687. /**
  8688. * Apply a user function recursively to every member of an array
  8689. * @link http://www.php.net/manual/en/function.array-walk-recursive.php
  8690. * @param input array <p>
  8691. * The input array.
  8692. * </p>
  8693. * @param funcname callable <p>
  8694. * Typically, funcname takes on two parameters.
  8695. * The input parameter's value being the first, and
  8696. * the key/index second.
  8697. * </p>
  8698. * <p>
  8699. * If funcname needs to be working with the
  8700. * actual values of the array, specify the first parameter of
  8701. * funcname as a
  8702. * reference. Then,
  8703. * any changes made to those elements will be made in the
  8704. * original array itself.
  8705. * </p>
  8706. * @param userdata mixed[optional] <p>
  8707. * If the optional userdata parameter is supplied,
  8708. * it will be passed as the third parameter to the callback
  8709. * funcname.
  8710. * </p>
  8711. * @return bool Returns true on success or false on failure.
  8712. */
  8713. function array_walk_recursive (array &$input, $funcname, $userdata = null) {}
  8714. /**
  8715. * Count all elements in an array, or something in an object
  8716. * @link http://www.php.net/manual/en/function.count.php
  8717. * @param var mixed <p>
  8718. * The array or the object.
  8719. * </p>
  8720. * @param mode int[optional] <p>
  8721. * If the optional mode parameter is set to
  8722. * COUNT_RECURSIVE (or 1), count
  8723. * will recursively count the array. This is particularly useful for
  8724. * counting all the elements of a multidimensional array.
  8725. * count does not detect infinite recursion.
  8726. * </p>
  8727. * @return int the number of elements in var.
  8728. * If var is not an array or an object with
  8729. * implemented Countable interface,
  8730. * 1 will be returned.
  8731. * There is one exception, if var is &null;,
  8732. * 0 will be returned.
  8733. * </p>
  8734. * <p>
  8735. * count may return 0 for a variable that isn't set,
  8736. * but it may also return 0 for a variable that has been initialized with an
  8737. * empty array. Use isset to test if a variable is set.
  8738. */
  8739. function count ($var, $mode = null) {}
  8740. /**
  8741. * Set the internal pointer of an array to its last element
  8742. * @link http://www.php.net/manual/en/function.end.php
  8743. * @param array array <p>
  8744. * The array. This array is passed by reference because it is modified by
  8745. * the function. This means you must pass it a real variable and not
  8746. * a function returning an array because only actual variables may be
  8747. * passed by reference.
  8748. * </p>
  8749. * @return mixed the value of the last element or false for empty array.
  8750. */
  8751. function end (array &$array) {}
  8752. /**
  8753. * Rewind the internal array pointer
  8754. * @link http://www.php.net/manual/en/function.prev.php
  8755. * @param array array <p>
  8756. * The input array.
  8757. * </p>
  8758. * @return mixed the array value in the previous place that's pointed to by
  8759. * the internal array pointer, or false if there are no more
  8760. * elements.
  8761. */
  8762. function prev (array &$array) {}
  8763. /**
  8764. * Advance the internal array pointer of an array
  8765. * @link http://www.php.net/manual/en/function.next.php
  8766. * @param array array <p>
  8767. * The array being affected.
  8768. * </p>
  8769. * @return mixed the array value in the next place that's pointed to by the
  8770. * internal array pointer, or false if there are no more elements.
  8771. */
  8772. function next (array &$array) {}
  8773. /**
  8774. * Set the internal pointer of an array to its first element
  8775. * @link http://www.php.net/manual/en/function.reset.php
  8776. * @param array array <p>
  8777. * The input array.
  8778. * </p>
  8779. * @return mixed the value of the first array element, or false if the array is
  8780. * empty.
  8781. */
  8782. function reset (array &$array) {}
  8783. /**
  8784. * Return the current element in an array
  8785. * @link http://www.php.net/manual/en/function.current.php
  8786. * @param array array <p>
  8787. * The array.
  8788. * </p>
  8789. * @return mixed The current function simply returns the
  8790. * value of the array element that's currently being pointed to by the
  8791. * internal pointer. It does not move the pointer in any way. If the
  8792. * internal pointer points beyond the end of the elements list or the array is
  8793. * empty, current returns false.
  8794. */
  8795. function current (array &$array) {}
  8796. /**
  8797. * Fetch a key from an array
  8798. * @link http://www.php.net/manual/en/function.key.php
  8799. * @param array array <p>
  8800. * The array.
  8801. * </p>
  8802. * @return mixed The key function simply returns the
  8803. * key of the array element that's currently being pointed to by the
  8804. * internal pointer. It does not move the pointer in any way. If the
  8805. * internal pointer points beyond the end of the elements list or the array is
  8806. * empty, key returns &null;.
  8807. */
  8808. function key (array &$array) {}
  8809. /**
  8810. * Find lowest value
  8811. * @link http://www.php.net/manual/en/function.min.php
  8812. * @param values array <p>
  8813. * An array containing the values.
  8814. * </p>
  8815. * @return mixed min returns the numerically lowest of the
  8816. * parameter values.
  8817. */
  8818. function min (array $values) {}
  8819. /**
  8820. * Find highest value
  8821. * @link http://www.php.net/manual/en/function.max.php
  8822. * @param values array <p>
  8823. * An array containing the values.
  8824. * </p>
  8825. * @return mixed max returns the numerically highest of the
  8826. * parameter values. If multiple values can be considered of the same size,
  8827. * the one that is listed first will be returned.
  8828. * </p>
  8829. * <p>
  8830. * When max is given multiple arrays, the
  8831. * longest array is returned. If all the arrays have the same length,
  8832. * max will use lexicographic ordering to find the return
  8833. * value.
  8834. * </p>
  8835. * <p>
  8836. * When given a string it will be cast as an integer
  8837. * when comparing.
  8838. */
  8839. function max (array $values) {}
  8840. /**
  8841. * Checks if a value exists in an array
  8842. * @link http://www.php.net/manual/en/function.in-array.php
  8843. * @param needle mixed <p>
  8844. * The searched value.
  8845. * </p>
  8846. * <p>
  8847. * If needle is a string, the comparison is done
  8848. * in a case-sensitive manner.
  8849. * </p>
  8850. * @param haystack array <p>
  8851. * The array.
  8852. * </p>
  8853. * @param strict bool[optional] <p>
  8854. * If the third parameter strict is set to true
  8855. * then the in_array function will also check the
  8856. * types of the
  8857. * needle in the haystack.
  8858. * </p>
  8859. * @return bool true if needle is found in the array,
  8860. * false otherwise.
  8861. */
  8862. function in_array ($needle, array $haystack, $strict = null) {}
  8863. /**
  8864. * Searches the array for a given value and returns the corresponding key if successful
  8865. * @link http://www.php.net/manual/en/function.array-search.php
  8866. * @param needle mixed <p>
  8867. * The searched value.
  8868. * </p>
  8869. * <p>
  8870. * If needle is a string, the comparison is done
  8871. * in a case-sensitive manner.
  8872. * </p>
  8873. * @param haystack array <p>
  8874. * The array.
  8875. * </p>
  8876. * @param strict bool[optional] <p>
  8877. * If the third parameter strict is set to true
  8878. * then the array_search function will search for
  8879. * identical elements in the
  8880. * haystack. This means it will also check the
  8881. * types of the
  8882. * needle in the haystack,
  8883. * and objects must be the same instance.
  8884. * </p>
  8885. * @return mixed the key for needle if it is found in the
  8886. * array, false otherwise.
  8887. * </p>
  8888. * <p>
  8889. * If needle is found in haystack
  8890. * more than once, the first matching key is returned. To return the keys for
  8891. * all matching values, use array_keys with the optional
  8892. * search_value parameter instead.
  8893. */
  8894. function array_search ($needle, array $haystack, $strict = null) {}
  8895. /**
  8896. * Import variables into the current symbol table from an array
  8897. * @link http://www.php.net/manual/en/function.extract.php
  8898. * @param var_array array <p>
  8899. * Note that prefix is only required if
  8900. * extract_type is EXTR_PREFIX_SAME,
  8901. * EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID
  8902. * or EXTR_PREFIX_IF_EXISTS. If
  8903. * the prefixed result is not a valid variable name, it is not
  8904. * imported into the symbol table. Prefixes are automatically separated from
  8905. * the array key by an underscore character.
  8906. * </p>
  8907. * @param extract_type int[optional] <p>
  8908. * The way invalid/numeric keys and collisions are treated is determined
  8909. * by the extract_type. It can be one of the
  8910. * following values:
  8911. * EXTR_OVERWRITE
  8912. * If there is a collision, overwrite the existing variable.
  8913. * @param prefix string[optional] Only overwrite the variable if it already exists in the
  8914. * current symbol table, otherwise do nothing. This is useful
  8915. * for defining a list of valid variables and then extracting
  8916. * only those variables you have defined out of
  8917. * $_REQUEST, for example.
  8918. * @return int the number of variables successfully imported into the symbol
  8919. * table.
  8920. */
  8921. function extract (array &$var_array, $extract_type = null, $prefix = null) {}
  8922. /**
  8923. * Create array containing variables and their values
  8924. * @link http://www.php.net/manual/en/function.compact.php
  8925. * @param varname mixed <p>
  8926. * compact takes a variable number of parameters.
  8927. * Each parameter can be either a string containing the name of the
  8928. * variable, or an array of variable names. The array can contain other
  8929. * arrays of variable names inside it; compact
  8930. * handles it recursively.
  8931. * </p>
  8932. * @param _ mixed[optional]
  8933. * @return array the output array with all the variables added to it.
  8934. */
  8935. function compact ($varname, $_ = null) {}
  8936. /**
  8937. * Fill an array with values
  8938. * @link http://www.php.net/manual/en/function.array-fill.php
  8939. * @param start_index int <p>
  8940. * The first index of the returned array.
  8941. * </p>
  8942. * <p>
  8943. * If start_index is negative,
  8944. * the first index of the returned array will be
  8945. * start_index and the following
  8946. * indices will start from zero
  8947. * (see example).
  8948. * </p>
  8949. * @param num int <p>
  8950. * Number of elements to insert.
  8951. * Must be greater than zero.
  8952. * </p>
  8953. * @param value mixed <p>
  8954. * Value to use for filling
  8955. * </p>
  8956. * @return array the filled array
  8957. */
  8958. function array_fill ($start_index, $num, $value) {}
  8959. /**
  8960. * Fill an array with values, specifying keys
  8961. * @link http://www.php.net/manual/en/function.array-fill-keys.php
  8962. * @param keys array <p>
  8963. * Array of values that will be used as keys. Illegal values
  8964. * for key will be converted to string.
  8965. * </p>
  8966. * @param value mixed <p>
  8967. * Value to use for filling
  8968. * </p>
  8969. * @return array the filled array
  8970. */
  8971. function array_fill_keys (array $keys, $value) {}
  8972. /**
  8973. * Create an array containing a range of elements
  8974. * @link http://www.php.net/manual/en/function.range.php
  8975. * @param start mixed <p>
  8976. * First value of the sequence.
  8977. * </p>
  8978. * @param limit mixed <p>
  8979. * The sequence is ended upon reaching the
  8980. * limit value.
  8981. * </p>
  8982. * @param step number[optional] <p>
  8983. * If a step value is given, it will be used as the
  8984. * increment between elements in the sequence. step
  8985. * should be given as a positive number. If not specified,
  8986. * step will default to 1.
  8987. * </p>
  8988. * @return array an array of elements from start to
  8989. * limit, inclusive.
  8990. */
  8991. function range ($start, $limit, $step = null) {}
  8992. /**
  8993. * Sort multiple or multi-dimensional arrays
  8994. * @link http://www.php.net/manual/en/function.array-multisort.php
  8995. * @param arr array <p>
  8996. * An array being sorted.
  8997. * </p>
  8998. * @param arg mixed[optional] <p>
  8999. * Optionally another array, or sort options for the
  9000. * previous array argument:
  9001. * SORT_ASC,
  9002. * SORT_DESC,
  9003. * SORT_REGULAR,
  9004. * SORT_NUMERIC,
  9005. * SORT_STRING.
  9006. * </p>
  9007. * @param arg mixed[optional]
  9008. * @param _ mixed[optional]
  9009. * @return bool Returns true on success or false on failure.
  9010. */
  9011. function array_multisort (array &$arr, $arg = null, $arg = null, $_ = null) {}
  9012. /**
  9013. * Push one or more elements onto the end of array
  9014. * @link http://www.php.net/manual/en/function.array-push.php
  9015. * @param array array <p>
  9016. * The input array.
  9017. * </p>
  9018. * @param var mixed <p>
  9019. * The pushed value.
  9020. * </p>
  9021. * @param _ mixed[optional]
  9022. * @return int the new number of elements in the array.
  9023. */
  9024. function array_push (array &$array, $var, $_ = null) {}
  9025. /**
  9026. * Pop the element off the end of array
  9027. * @link http://www.php.net/manual/en/function.array-pop.php
  9028. * @param array array <p>
  9029. * The array to get the value from.
  9030. * </p>
  9031. * @return mixed the last value of array.
  9032. * If array is empty (or is not an array),
  9033. * &null; will be returned.
  9034. */
  9035. function array_pop (array &$array) {}
  9036. /**
  9037. * Shift an element off the beginning of array
  9038. * @link http://www.php.net/manual/en/function.array-shift.php
  9039. * @param array array <p>
  9040. * The input array.
  9041. * </p>
  9042. * @return mixed the shifted value, or &null; if array is
  9043. * empty or is not an array.
  9044. */
  9045. function array_shift (array &$array) {}
  9046. /**
  9047. * Prepend one or more elements to the beginning of an array
  9048. * @link http://www.php.net/manual/en/function.array-unshift.php
  9049. * @param array array <p>
  9050. * The input array.
  9051. * </p>
  9052. * @param var mixed <p>
  9053. * The prepended variable.
  9054. * </p>
  9055. * @param _ mixed[optional]
  9056. * @return int the new number of elements in the array.
  9057. */
  9058. function array_unshift (array &$array, $var, $_ = null) {}
  9059. /**
  9060. * Remove a portion of the array and replace it with something else
  9061. * @link http://www.php.net/manual/en/function.array-splice.php
  9062. * @param input array <p>
  9063. * The input array.
  9064. * </p>
  9065. * @param offset int <p>
  9066. * If offset is positive then the start of removed
  9067. * portion is at that offset from the beginning of the
  9068. * input array. If offset
  9069. * is negative then it starts that far from the end of the
  9070. * input array.
  9071. * </p>
  9072. * @param length int[optional] <p>
  9073. * If length is omitted, removes everything
  9074. * from offset to the end of the array. If
  9075. * length is specified and is positive, then
  9076. * that many elements will be removed. If
  9077. * length is specified and is negative then
  9078. * the end of the removed portion will be that many elements from
  9079. * the end of the array. Tip: to remove everything from
  9080. * offset to the end of the array when
  9081. * replacement is also specified, use
  9082. * count($input) for
  9083. * length.
  9084. * </p>
  9085. * @param replacement mixed[optional] <p>
  9086. * If replacement array is specified, then the
  9087. * removed elements are replaced with elements from this array.
  9088. * </p>
  9089. * <p>
  9090. * If offset and length
  9091. * are such that nothing is removed, then the elements from the
  9092. * replacement array are inserted in the place
  9093. * specified by the offset. Note that keys in
  9094. * replacement array are not preserved.
  9095. * </p>
  9096. * <p>
  9097. * If replacement is just one element it is
  9098. * not necessary to put array()
  9099. * around it, unless the element is an array itself, an object or &null;.
  9100. * </p>
  9101. * @return array the array consisting of the extracted elements.
  9102. */
  9103. function array_splice (array &$input, $offset, $length = null, $replacement = null) {}
  9104. /**
  9105. * Extract a slice of the array
  9106. * @link http://www.php.net/manual/en/function.array-slice.php
  9107. * @param array array <p>
  9108. * The input array.
  9109. * </p>
  9110. * @param offset int <p>
  9111. * If offset is non-negative, the sequence will
  9112. * start at that offset in the array. If
  9113. * offset is negative, the sequence will
  9114. * start that far from the end of the array.
  9115. * </p>
  9116. * @param length int[optional] <p>
  9117. * If length is given and is positive, then
  9118. * the sequence will have up to that many elements in it. If the array
  9119. * is shorter than the length, then only the
  9120. * available array elements will be present. If
  9121. * length is given and is negative then the
  9122. * sequence will stop that many elements from the end of the
  9123. * array. If it is omitted, then the sequence will have everything
  9124. * from offset up until the end of the
  9125. * array.
  9126. * </p>
  9127. * @param preserve_keys bool[optional] <p>
  9128. * Note that array_slice will reorder and reset the
  9129. * numeric array indices by default. You can change this behaviour by setting
  9130. * preserve_keys to true.
  9131. * </p>
  9132. * @return array the slice.
  9133. */
  9134. function array_slice (array $array, $offset, $length = null, $preserve_keys = null) {}
  9135. /**
  9136. * Merge one or more arrays
  9137. * @link http://www.php.net/manual/en/function.array-merge.php
  9138. * @param array1 array <p>
  9139. * Initial array to merge.
  9140. * </p>
  9141. * @param _ array[optional]
  9142. * @return array the resulting array.
  9143. */
  9144. function array_merge (array $array1, array $_ = null) {}
  9145. /**
  9146. * Merge two or more arrays recursively
  9147. * @link http://www.php.net/manual/en/function.array-merge-recursive.php
  9148. * @param array1 array <p>
  9149. * Initial array to merge.
  9150. * </p>
  9151. * @param _ array[optional]
  9152. * @return array An array of values resulted from merging the arguments together.
  9153. */
  9154. function array_merge_recursive (array $array1, array $_ = null) {}
  9155. /**
  9156. * Replaces elements from passed arrays into the first array
  9157. * @link http://www.php.net/manual/en/function.array-replace.php
  9158. * @param array array <p>
  9159. * The array in which elements are replaced.
  9160. * </p>
  9161. * @param array1 array <p>
  9162. * The array from which elements will be extracted.
  9163. * </p>
  9164. * @param _ array[optional]
  9165. * @return array an array, or &null; if an error occurs.
  9166. */
  9167. function array_replace (array $array, array $array1, array $_ = null) {}
  9168. /**
  9169. * Replaces elements from passed arrays into the first array recursively
  9170. * @link http://www.php.net/manual/en/function.array-replace-recursive.php
  9171. * @param array array <p>
  9172. * The array in which elements are replaced.
  9173. * </p>
  9174. * @param array1 array <p>
  9175. * The array from which elements will be extracted.
  9176. * </p>
  9177. * @param _ array[optional]
  9178. * @return array an array, or &null; if an error occurs.
  9179. */
  9180. function array_replace_recursive (array $array, array $array1, array $_ = null) {}
  9181. /**
  9182. * Return all the keys or a subset of the keys of an array
  9183. * @link http://www.php.net/manual/en/function.array-keys.php
  9184. * @param input array <p>
  9185. * An array containing keys to return.
  9186. * </p>
  9187. * @param search_value mixed[optional] <p>
  9188. * If specified, then only keys containing these values are returned.
  9189. * </p>
  9190. * @param strict bool[optional] <p>
  9191. * Determines if strict comparison (===) should be used during the search.
  9192. * </p>
  9193. * @return array an array of all the keys in input.
  9194. */
  9195. function array_keys (array $input, $search_value = null, $strict = null) {}
  9196. /**
  9197. * Return all the values of an array
  9198. * @link http://www.php.net/manual/en/function.array-values.php
  9199. * @param input array <p>
  9200. * The array.
  9201. * </p>
  9202. * @return array an indexed array of values.
  9203. */
  9204. function array_values (array $input) {}
  9205. /**
  9206. * Counts all the values of an array
  9207. * @link http://www.php.net/manual/en/function.array-count-values.php
  9208. * @param input array <p>
  9209. * The array of values to count
  9210. * </p>
  9211. * @return array an associative array of values from input as
  9212. * keys and their count as value.
  9213. */
  9214. function array_count_values (array $input) {}
  9215. /**
  9216. * Return an array with elements in reverse order
  9217. * @link http://www.php.net/manual/en/function.array-reverse.php
  9218. * @param array array <p>
  9219. * The input array.
  9220. * </p>
  9221. * @param preserve_keys bool[optional] <p>
  9222. * If set to true numeric keys are preserved.
  9223. * Non-numeric keys are not affected by this setting and will always be preserved.
  9224. * </p>
  9225. * @return array the reversed array.
  9226. */
  9227. function array_reverse (array $array, $preserve_keys = null) {}
  9228. /**
  9229. * Iteratively reduce the array to a single value using a callback function
  9230. * @link http://www.php.net/manual/en/function.array-reduce.php
  9231. * @param input array <p>
  9232. * The input array.
  9233. * </p>
  9234. * @param function callable <p>
  9235. * The callback function.
  9236. * </p>
  9237. * mixedcallback
  9238. * mixedresult
  9239. * mixeditem
  9240. * @param initial mixed[optional] <p>
  9241. * If the optional initial is available, it will
  9242. * be used at the beginning of the process, or as a final result in case
  9243. * the array is empty.
  9244. * </p>
  9245. * @return mixed the resulting value.
  9246. * </p>
  9247. * <p>
  9248. * If the array is empty and initial is not passed,
  9249. * array_reduce returns &null;.
  9250. */
  9251. function array_reduce (array $input, $function, $initial = null) {}
  9252. /**
  9253. * Pad array to the specified length with a value
  9254. * @link http://www.php.net/manual/en/function.array-pad.php
  9255. * @param input array <p>
  9256. * Initial array of values to pad.
  9257. * </p>
  9258. * @param pad_size int <p>
  9259. * New size of the array.
  9260. * </p>
  9261. * @param pad_value mixed <p>
  9262. * Value to pad if input is less than
  9263. * pad_size.
  9264. * </p>
  9265. * @return array a copy of the input padded to size specified
  9266. * by pad_size with value
  9267. * pad_value. If pad_size is
  9268. * positive then the array is padded on the right, if it's negative then
  9269. * on the left. If the absolute value of pad_size is less
  9270. * than or equal to the length of the input then no
  9271. * padding takes place.
  9272. */
  9273. function array_pad (array $input, $pad_size, $pad_value) {}
  9274. /**
  9275. * Exchanges all keys with their associated values in an array
  9276. * @link http://www.php.net/manual/en/function.array-flip.php
  9277. * @param trans array <p>
  9278. * An array of key/value pairs to be flipped.
  9279. * </p>
  9280. * @return array the flipped array on success and &null; on failure.
  9281. */
  9282. function array_flip (array $trans) {}
  9283. /**
  9284. * Changes all keys in an array
  9285. * @link http://www.php.net/manual/en/function.array-change-key-case.php
  9286. * @param input array <p>
  9287. * The array to work on
  9288. * </p>
  9289. * @param case int[optional] <p>
  9290. * Either CASE_UPPER or
  9291. * CASE_LOWER (default)
  9292. * </p>
  9293. * @return array an array with its keys lower or uppercased, or false if
  9294. * input is not an array.
  9295. */
  9296. function array_change_key_case (array $input, $case = null) {}
  9297. /**
  9298. * Pick one or more random entries out of an array
  9299. * @link http://www.php.net/manual/en/function.array-rand.php
  9300. * @param input array <p>
  9301. * The input array.
  9302. * </p>
  9303. * @param num_req int[optional] <p>
  9304. * Specifies how many entries you want to pick. Trying to pick more
  9305. * elements than there are in the array will result in an
  9306. * E_WARNING level error.
  9307. * </p>
  9308. * @return mixed If you are picking only one entry, array_rand
  9309. * returns the key for a random entry. Otherwise, it returns an array
  9310. * of keys for the random entries. This is done so that you can pick
  9311. * random keys as well as values out of the array.
  9312. */
  9313. function array_rand (array $input, $num_req = null) {}
  9314. /**
  9315. * Removes duplicate values from an array
  9316. * @link http://www.php.net/manual/en/function.array-unique.php
  9317. * @param array array <p>
  9318. * The input array.
  9319. * </p>
  9320. * @param sort_flags int[optional] <p>
  9321. * The optional second parameter sort_flags
  9322. * may be used to modify the sorting behavior using these values:
  9323. * </p>
  9324. * <p>
  9325. * Sorting type flags:
  9326. * SORT_REGULAR - compare items normally
  9327. * (don't change types)
  9328. * @return array the filtered array.
  9329. */
  9330. function array_unique (array $array, $sort_flags = null) {}
  9331. /**
  9332. * Computes the intersection of arrays
  9333. * @link http://www.php.net/manual/en/function.array-intersect.php
  9334. * @param array1 array <p>
  9335. * The array with master values to check.
  9336. * </p>
  9337. * @param array2 array <p>
  9338. * An array to compare values against.
  9339. * </p>
  9340. * @param _ array[optional]
  9341. * @return array an array containing all of the values in
  9342. * array1 whose values exist in all of the parameters.
  9343. */
  9344. function array_intersect (array $array1, array $array2, array $_ = null) {}
  9345. /**
  9346. * Computes the intersection of arrays using keys for comparison
  9347. * @link http://www.php.net/manual/en/function.array-intersect-key.php
  9348. * @param array1 array <p>
  9349. * The array with master keys to check.
  9350. * </p>
  9351. * @param array2 array <p>
  9352. * An array to compare keys against.
  9353. * </p>
  9354. * @param _ array[optional]
  9355. * @return array an associative array containing all the entries of
  9356. * array1 which have keys that are present in all
  9357. * arguments.
  9358. */
  9359. function array_intersect_key (array $array1, array $array2, array $_ = null) {}
  9360. /**
  9361. * Computes the intersection of arrays using a callback function on the keys for comparison
  9362. * @link http://www.php.net/manual/en/function.array-intersect-ukey.php
  9363. * @param array1 array <p>
  9364. * Initial array for comparison of the arrays.
  9365. * </p>
  9366. * @param array2 array <p>
  9367. * First array to compare keys against.
  9368. * </p>
  9369. * @param _ array[optional]
  9370. * @param key_compare_func callable <p>
  9371. * &return.callbacksort;
  9372. * </p>
  9373. * &callback.cmp;
  9374. * @return array the values of array1 whose keys exist
  9375. * in all the arguments.
  9376. */
  9377. function array_intersect_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9378. /**
  9379. * Computes the intersection of arrays, compares data by a callback function
  9380. * @link http://www.php.net/manual/en/function.array-uintersect.php
  9381. * @param array1 array <p>
  9382. * The first array.
  9383. * </p>
  9384. * @param array2 array <p>
  9385. * The second array.
  9386. * </p>
  9387. * @param _ array[optional]
  9388. * @param data_compare_func callable <p>
  9389. * &return.callbacksort;
  9390. * </p>
  9391. * &callback.cmp;
  9392. * @return array an array containing all the values of array1
  9393. * that are present in all the arguments.
  9394. */
  9395. function array_uintersect (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9396. /**
  9397. * Computes the intersection of arrays with additional index check
  9398. * @link http://www.php.net/manual/en/function.array-intersect-assoc.php
  9399. * @param array1 array <p>
  9400. * The array with master values to check.
  9401. * </p>
  9402. * @param array2 array <p>
  9403. * An array to compare values against.
  9404. * </p>
  9405. * @param _ array[optional]
  9406. * @return array an associative array containing all the values in
  9407. * array1 that are present in all of the arguments.
  9408. */
  9409. function array_intersect_assoc (array $array1, array $array2, array $_ = null) {}
  9410. /**
  9411. * Computes the intersection of arrays with additional index check, compares data by a callback function
  9412. * @link http://www.php.net/manual/en/function.array-uintersect-assoc.php
  9413. * @param array1 array <p>
  9414. * The first array.
  9415. * </p>
  9416. * @param array2 array <p>
  9417. * The second array.
  9418. * </p>
  9419. * @param _ array[optional]
  9420. * @param data_compare_func callable <p>
  9421. * &return.callbacksort;
  9422. * </p>
  9423. * &callback.cmp;
  9424. * @return array an array containing all the values of
  9425. * array1 that are present in all the arguments.
  9426. */
  9427. function array_uintersect_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9428. /**
  9429. * Computes the intersection of arrays with additional index check, compares indexes by a callback function
  9430. * @link http://www.php.net/manual/en/function.array-intersect-uassoc.php
  9431. * @param array1 array <p>
  9432. * Initial array for comparison of the arrays.
  9433. * </p>
  9434. * @param array2 array <p>
  9435. * First array to compare keys against.
  9436. * </p>
  9437. * @param _ array[optional]
  9438. * @param key_compare_func callable <p>
  9439. * &return.callbacksort;
  9440. * </p>
  9441. * &callback.cmp;
  9442. * @return array the values of array1 whose values exist
  9443. * in all of the arguments.
  9444. */
  9445. function array_intersect_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9446. /**
  9447. * Computes the intersection of arrays with additional index check, compares data and indexes by a callback functions
  9448. * @link http://www.php.net/manual/en/function.array-uintersect-uassoc.php
  9449. * @param array1 array <p>
  9450. * The first array.
  9451. * </p>
  9452. * @param array2 array <p>
  9453. * The second array.
  9454. * </p>
  9455. * @param _ array[optional]
  9456. * @param data_compare_func callable <p>
  9457. * &return.callbacksort;
  9458. * </p>
  9459. * &callback.cmp;
  9460. * @param key_compare_func callable <p>
  9461. * Key comparison callback function.
  9462. * </p>
  9463. * @return array an array containing all the values of
  9464. * array1 that are present in all the arguments.
  9465. */
  9466. function array_uintersect_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  9467. /**
  9468. * Computes the difference of arrays
  9469. * @link http://www.php.net/manual/en/function.array-diff.php
  9470. * @param array1 array <p>
  9471. * The array to compare from
  9472. * </p>
  9473. * @param array2 array <p>
  9474. * An array to compare against
  9475. * </p>
  9476. * @param _ array[optional]
  9477. * @return array an array containing all the entries from
  9478. * array1 that are not present in any of the other arrays.
  9479. */
  9480. function array_diff (array $array1, array $array2, array $_ = null) {}
  9481. /**
  9482. * Computes the difference of arrays using keys for comparison
  9483. * @link http://www.php.net/manual/en/function.array-diff-key.php
  9484. * @param array1 array <p>
  9485. * The array to compare from
  9486. * </p>
  9487. * @param array2 array <p>
  9488. * An array to compare against
  9489. * </p>
  9490. * @param _ array[optional]
  9491. * @return array an array containing all the entries from
  9492. * array1 whose keys are not present in any of the
  9493. * other arrays.
  9494. */
  9495. function array_diff_key (array $array1, array $array2, array $_ = null) {}
  9496. /**
  9497. * Computes the difference of arrays using a callback function on the keys for comparison
  9498. * @link http://www.php.net/manual/en/function.array-diff-ukey.php
  9499. * @param array1 array <p>
  9500. * The array to compare from
  9501. * </p>
  9502. * @param array2 array <p>
  9503. * An array to compare against
  9504. * </p>
  9505. * @param _ array[optional]
  9506. * @param key_compare_func callable <p>
  9507. * &return.callbacksort;
  9508. * </p>
  9509. * &callback.cmp;
  9510. * @return array an array containing all the entries from
  9511. * array1 that are not present in any of the other arrays.
  9512. */
  9513. function array_diff_ukey (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9514. /**
  9515. * Computes the difference of arrays by using a callback function for data comparison
  9516. * @link http://www.php.net/manual/en/function.array-udiff.php
  9517. * @param array1 array <p>
  9518. * The first array.
  9519. * </p>
  9520. * @param array2 array <p>
  9521. * The second array.
  9522. * </p>
  9523. * @param _ array[optional]
  9524. * @param data_compare_func callable <p>
  9525. * The callback comparison function.
  9526. * </p>
  9527. * <p>
  9528. * &return.callbacksort;
  9529. * </p>
  9530. * &callback.cmp;
  9531. * @return array an array containing all the values of array1
  9532. * that are not present in any of the other arguments.
  9533. */
  9534. function array_udiff (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9535. /**
  9536. * Computes the difference of arrays with additional index check
  9537. * @link http://www.php.net/manual/en/function.array-diff-assoc.php
  9538. * @param array1 array <p>
  9539. * The array to compare from
  9540. * </p>
  9541. * @param array2 array <p>
  9542. * An array to compare against
  9543. * </p>
  9544. * @param _ array[optional]
  9545. * @return array an array containing all the values from
  9546. * array1 that are not present in any of the other arrays.
  9547. */
  9548. function array_diff_assoc (array $array1, array $array2, array $_ = null) {}
  9549. /**
  9550. * Computes the difference of arrays with additional index check, compares data by a callback function
  9551. * @link http://www.php.net/manual/en/function.array-udiff-assoc.php
  9552. * @param array1 array <p>
  9553. * The first array.
  9554. * </p>
  9555. * @param array2 array <p>
  9556. * The second array.
  9557. * </p>
  9558. * @param _ array[optional]
  9559. * @param data_compare_func callable <p>
  9560. * &return.callbacksort;
  9561. * </p>
  9562. * &callback.cmp;
  9563. * @return array array_udiff_assoc returns an array
  9564. * containing all the values from array1
  9565. * that are not present in any of the other arguments.
  9566. * Note that the keys are used in the comparison unlike
  9567. * array_diff and array_udiff.
  9568. * The comparison of arrays' data is performed by using an user-supplied
  9569. * callback. In this aspect the behaviour is opposite to the behaviour of
  9570. * array_diff_assoc which uses internal function for
  9571. * comparison.
  9572. */
  9573. function array_udiff_assoc (array $array1, array $array2, array $_ = null, $data_compare_func) {}
  9574. /**
  9575. * Computes the difference of arrays with additional index check which is performed by a user supplied callback function
  9576. * @link http://www.php.net/manual/en/function.array-diff-uassoc.php
  9577. * @param array1 array <p>
  9578. * The array to compare from
  9579. * </p>
  9580. * @param array2 array <p>
  9581. * An array to compare against
  9582. * </p>
  9583. * @param _ array[optional]
  9584. * @param key_compare_func callable <p>
  9585. * &return.callbacksort;
  9586. * </p>
  9587. * &callback.cmp;
  9588. * @return array an array containing all the entries from
  9589. * array1 that are not present in any of the other arrays.
  9590. */
  9591. function array_diff_uassoc (array $array1, array $array2, array $_ = null, $key_compare_func) {}
  9592. /**
  9593. * Computes the difference of arrays with additional index check, compares data and indexes by a callback function
  9594. * @link http://www.php.net/manual/en/function.array-udiff-uassoc.php
  9595. * @param array1 array <p>
  9596. * The first array.
  9597. * </p>
  9598. * @param array2 array <p>
  9599. * The second array.
  9600. * </p>
  9601. * @param _ array[optional]
  9602. * @param data_compare_func callable <p>
  9603. * &return.callbacksort;
  9604. * </p>
  9605. * &callback.cmp;
  9606. * @param key_compare_func callable <p>
  9607. * The comparison of keys (indices) is done also by the callback function
  9608. * key_compare_func. This behaviour is unlike what
  9609. * array_udiff_assoc does, since the latter compares
  9610. * the indices by using an internal function.
  9611. * </p>
  9612. * @return array an array containing all the values from
  9613. * array1 that are not present in any of the other
  9614. * arguments.
  9615. */
  9616. function array_udiff_uassoc (array $array1, array $array2, array $_ = null, $data_compare_func, $key_compare_func) {}
  9617. /**
  9618. * Calculate the sum of values in an array
  9619. * @link http://www.php.net/manual/en/function.array-sum.php
  9620. * @param array array <p>
  9621. * The input array.
  9622. * </p>
  9623. * @return number the sum of values as an integer or float.
  9624. */
  9625. function array_sum (array $array) {}
  9626. /**
  9627. * Calculate the product of values in an array
  9628. * @link http://www.php.net/manual/en/function.array-product.php
  9629. * @param array array <p>
  9630. * The array.
  9631. * </p>
  9632. * @return number the product as an integer or float.
  9633. */
  9634. function array_product (array $array) {}
  9635. /**
  9636. * Filters elements of an array using a callback function
  9637. * @link http://www.php.net/manual/en/function.array-filter.php
  9638. * @param input array <p>
  9639. * The array to iterate over
  9640. * </p>
  9641. * @param callback callable[optional] <p>
  9642. * The callback function to use
  9643. * </p>
  9644. * <p>
  9645. * If no callback is supplied, all entries of
  9646. * input equal to false (see
  9647. * converting to
  9648. * boolean) will be removed.
  9649. * </p>
  9650. * @return array the filtered array.
  9651. */
  9652. function array_filter (array $input, $callback = null) {}
  9653. /**
  9654. * Applies the callback to the elements of the given arrays
  9655. * @link http://www.php.net/manual/en/function.array-map.php
  9656. * @param callback callable <p>
  9657. * Callback function to run for each element in each array.
  9658. * </p>
  9659. * @param arr1 array <p>
  9660. * An array to run through the callback function.
  9661. * </p>
  9662. * @param _ array[optional]
  9663. * @return array an array containing all the elements of arr1
  9664. * after applying the callback function to each one.
  9665. */
  9666. function array_map ($callback, array $arr1, array $_ = null) {}
  9667. /**
  9668. * Split an array into chunks
  9669. * @link http://www.php.net/manual/en/function.array-chunk.php
  9670. * @param input array <p>
  9671. * The array to work on
  9672. * </p>
  9673. * @param size int <p>
  9674. * The size of each chunk
  9675. * </p>
  9676. * @param preserve_keys bool[optional] <p>
  9677. * When set to true keys will be preserved.
  9678. * Default is false which will reindex the chunk numerically
  9679. * </p>
  9680. * @return array a multidimensional numerically indexed array, starting with zero,
  9681. * with each dimension containing size elements.
  9682. */
  9683. function array_chunk (array $input, $size, $preserve_keys = null) {}
  9684. /**
  9685. * Creates an array by using one array for keys and another for its values
  9686. * @link http://www.php.net/manual/en/function.array-combine.php
  9687. * @param keys array <p>
  9688. * Array of keys to be used. Illegal values for key will be
  9689. * converted to string.
  9690. * </p>
  9691. * @param values array <p>
  9692. * Array of values to be used
  9693. * </p>
  9694. * @return array the combined array, false if the number of elements
  9695. * for each array isn't equal.
  9696. */
  9697. function array_combine (array $keys, array $values) {}
  9698. /**
  9699. * Checks if the given key or index exists in the array
  9700. * @link http://www.php.net/manual/en/function.array-key-exists.php
  9701. * @param key mixed <p>
  9702. * Value to check.
  9703. * </p>
  9704. * @param search array <p>
  9705. * An array with keys to check.
  9706. * </p>
  9707. * @return bool Returns true on success or false on failure.
  9708. */
  9709. function array_key_exists ($key, array $search) {}
  9710. /**
  9711. * &Alias; <function>current</function>
  9712. * @link http://www.php.net/manual/en/function.pos.php
  9713. * @param arg
  9714. */
  9715. function pos (&$arg) {}
  9716. /**
  9717. * &Alias; <function>count</function>
  9718. * @link http://www.php.net/manual/en/function.sizeof.php
  9719. * @param var
  9720. * @param mode[optional]
  9721. */
  9722. function sizeof ($var, $mode) {}
  9723. /**
  9724. * @param key
  9725. * @param search
  9726. */
  9727. function key_exists ($key, $search) {}
  9728. /**
  9729. * Checks if assertion is &false;
  9730. * @link http://www.php.net/manual/en/function.assert.php
  9731. * @param assertion mixed <p>
  9732. * The assertion.
  9733. * </p>
  9734. * @return bool false if the assertion is false, true otherwise.
  9735. */
  9736. function assert ($assertion) {}
  9737. /**
  9738. * Set/get the various assert flags
  9739. * @link http://www.php.net/manual/en/function.assert-options.php
  9740. * @param what int <p>
  9741. * <table>
  9742. * Assert Options
  9743. * <tr valign="top">
  9744. * <td>Option</td>
  9745. * <td>INI Setting</td>
  9746. * <td>Default value</td>
  9747. * <td>Description</td>
  9748. * </tr>
  9749. * <tr valign="top">
  9750. * <td>ASSERT_ACTIVE</td>
  9751. * <td>assert.active</td>
  9752. * <td>1</td>
  9753. * <td>enable assert evaluation</td>
  9754. * </tr>
  9755. * <tr valign="top">
  9756. * <td>ASSERT_WARNING</td>
  9757. * <td>assert.warning</td>
  9758. * <td>1</td>
  9759. * <td>issue a PHP warning for each failed assertion</td>
  9760. * </tr>
  9761. * <tr valign="top">
  9762. * <td>ASSERT_BAIL</td>
  9763. * <td>assert.bail</td>
  9764. * <td>0</td>
  9765. * <td>terminate execution on failed assertions</td>
  9766. * </tr>
  9767. * <tr valign="top">
  9768. * <td>ASSERT_QUIET_EVAL</td>
  9769. * <td>assert.quiet_eval</td>
  9770. * <td>0</td>
  9771. * <td>
  9772. * disable error_reporting during assertion expression
  9773. * evaluation
  9774. * </td>
  9775. * </tr>
  9776. * <tr valign="top">
  9777. * <td>ASSERT_CALLBACK</td>
  9778. * <td>assert.callback</td>
  9779. * <td)<&null;)</td>
  9780. * <td>Callback to call on failed assertions</td>
  9781. * </tr>
  9782. * </table>
  9783. * </p>
  9784. * @param value mixed[optional] <p>
  9785. * An optional new value for the option.
  9786. * </p>
  9787. * @return mixed the original setting of any option or false on errors.
  9788. */
  9789. function assert_options ($what, $value = null) {}
  9790. /**
  9791. * Compares two "PHP-standardized" version number strings
  9792. * @link http://www.php.net/manual/en/function.version-compare.php
  9793. * @param version1 string <p>
  9794. * First version number.
  9795. * </p>
  9796. * @param version2 string <p>
  9797. * Second version number.
  9798. * </p>
  9799. * @param operator string[optional] <p>
  9800. * If you specify the third optional operator
  9801. * argument, you can test for a particular relationship. The
  9802. * possible operators are: &lt;,
  9803. * lt, &lt;=,
  9804. * le, &gt;,
  9805. * gt, &gt;=,
  9806. * ge, ==,
  9807. * =, eq,
  9808. * !=, &lt;&gt;,
  9809. * ne respectively.
  9810. * </p>
  9811. * <p>
  9812. * This parameter is case-sensitive, so values should be lowercase.
  9813. * </p>
  9814. * @return mixed By default, version_compare returns
  9815. * -1 if the first version is lower than the second,
  9816. * 0 if they are equal, and
  9817. * 1 if the second is lower.
  9818. * </p>
  9819. * <p>
  9820. * When using the optional operator argument, the
  9821. * function will return true if the relationship is the one specified
  9822. * by the operator, false otherwise.
  9823. */
  9824. function version_compare ($version1, $version2, $operator = null) {}
  9825. /**
  9826. * Convert a pathname and a project identifier to a System V IPC key
  9827. * @link http://www.php.net/manual/en/function.ftok.php
  9828. * @param pathname string <p>
  9829. * Path to an accessible file.
  9830. * </p>
  9831. * @param proj string <p>
  9832. * Project identifier. This must be a one character string.
  9833. * </p>
  9834. * @return int On success the return value will be the created key value, otherwise
  9835. * -1 is returned.
  9836. */
  9837. function ftok ($pathname, $proj) {}
  9838. /**
  9839. * Perform the rot13 transform on a string
  9840. * @link http://www.php.net/manual/en/function.str-rot13.php
  9841. * @param str string <p>
  9842. * The input string.
  9843. * </p>
  9844. * @return string the ROT13 version of the given string.
  9845. */
  9846. function str_rot13 ($str) {}
  9847. /**
  9848. * Retrieve list of registered filters
  9849. * @link http://www.php.net/manual/en/function.stream-get-filters.php
  9850. * @return array an indexed array containing the name of all stream filters
  9851. * available.
  9852. */
  9853. function stream_get_filters () {}
  9854. /**
  9855. * Register a user defined stream filter
  9856. * @link http://www.php.net/manual/en/function.stream-filter-register.php
  9857. * @param filtername string <p>
  9858. * The filter name to be registered.
  9859. * </p>
  9860. * @param classname string <p>
  9861. * To implement a filter, you need to define a class as an extension of
  9862. * php_user_filter with a number of member
  9863. * functions. When performing read/write operations on the stream
  9864. * to which your filter is attached, PHP will pass the data through your
  9865. * filter (and any other filters attached to that stream) so that the
  9866. * data may be modified as desired. You must implement the methods
  9867. * exactly as described in php_user_filter - doing
  9868. * otherwise will lead to undefined behaviour.
  9869. * </p>
  9870. * @return bool Returns true on success or false on failure.
  9871. * </p>
  9872. * <p>
  9873. * stream_filter_register will return false if the
  9874. * filtername is already defined.
  9875. */
  9876. function stream_filter_register ($filtername, $classname) {}
  9877. /**
  9878. * Return a bucket object from the brigade for operating on
  9879. * @link http://www.php.net/manual/en/function.stream-bucket-make-writeable.php
  9880. * @param brigade resource
  9881. * @return object
  9882. */
  9883. function stream_bucket_make_writeable ($brigade) {}
  9884. /**
  9885. * Prepend bucket to brigade
  9886. * @link http://www.php.net/manual/en/function.stream-bucket-prepend.php
  9887. * @param brigade resource <p>
  9888. * brigade is a resource pointing to a bucket brigade
  9889. * which contains one or more bucket objects.
  9890. * </p>
  9891. * @param bucket resource <p>
  9892. * A bucket object.
  9893. * </p>
  9894. * @return void
  9895. */
  9896. function stream_bucket_prepend ($brigade, $bucket) {}
  9897. /**
  9898. * Append bucket to brigade
  9899. * @link http://www.php.net/manual/en/function.stream-bucket-append.php
  9900. * @param brigade resource
  9901. * @param bucket resource
  9902. * @return void
  9903. */
  9904. function stream_bucket_append ($brigade, $bucket) {}
  9905. /**
  9906. * Create a new bucket for use on the current stream
  9907. * @link http://www.php.net/manual/en/function.stream-bucket-new.php
  9908. * @param stream resource
  9909. * @param buffer string
  9910. * @return object
  9911. */
  9912. function stream_bucket_new ($stream, $buffer) {}
  9913. /**
  9914. * Add URL rewriter values
  9915. * @link http://www.php.net/manual/en/function.output-add-rewrite-var.php
  9916. * @param name string <p>
  9917. * The variable name.
  9918. * </p>
  9919. * @param value string <p>
  9920. * The variable value.
  9921. * </p>
  9922. * @return bool Returns true on success or false on failure.
  9923. */
  9924. function output_add_rewrite_var ($name, $value) {}
  9925. /**
  9926. * Reset URL rewriter values
  9927. * @link http://www.php.net/manual/en/function.output-reset-rewrite-vars.php
  9928. * @return bool Returns true on success or false on failure.
  9929. */
  9930. function output_reset_rewrite_vars () {}
  9931. /**
  9932. * Returns directory path used for temporary files
  9933. * @link http://www.php.net/manual/en/function.sys-get-temp-dir.php
  9934. * @return string the path of the temporary directory.
  9935. */
  9936. function sys_get_temp_dir () {}
  9937. define ('CONNECTION_ABORTED', 1);
  9938. define ('CONNECTION_NORMAL', 0);
  9939. define ('CONNECTION_TIMEOUT', 2);
  9940. define ('INI_USER', 1);
  9941. define ('INI_PERDIR', 2);
  9942. define ('INI_SYSTEM', 4);
  9943. define ('INI_ALL', 7);
  9944. /**
  9945. * Normal INI scanner mode (since PHP 5.3).
  9946. * @link http://www.php.net/manual/en/filesystem.constants.php
  9947. */
  9948. define ('INI_SCANNER_NORMAL', 0);
  9949. /**
  9950. * Raw INI scanner mode (since PHP 5.3).
  9951. * @link http://www.php.net/manual/en/filesystem.constants.php
  9952. */
  9953. define ('INI_SCANNER_RAW', 1);
  9954. define ('PHP_URL_SCHEME', 0);
  9955. define ('PHP_URL_HOST', 1);
  9956. define ('PHP_URL_PORT', 2);
  9957. define ('PHP_URL_USER', 3);
  9958. define ('PHP_URL_PASS', 4);
  9959. define ('PHP_URL_PATH', 5);
  9960. define ('PHP_URL_QUERY', 6);
  9961. define ('PHP_URL_FRAGMENT', 7);
  9962. define ('PHP_QUERY_RFC1738', 1);
  9963. define ('PHP_QUERY_RFC3986', 2);
  9964. define ('M_E', 2.718281828459);
  9965. define ('M_LOG2E', 1.442695040889);
  9966. define ('M_LOG10E', 0.43429448190325);
  9967. define ('M_LN2', 0.69314718055995);
  9968. define ('M_LN10', 2.302585092994);
  9969. /**
  9970. * Round halves up
  9971. * @link http://www.php.net/manual/en/math.constants.php
  9972. */
  9973. define ('M_PI', 3.1415926535898);
  9974. define ('M_PI_2', 1.5707963267949);
  9975. define ('M_PI_4', 0.78539816339745);
  9976. define ('M_1_PI', 0.31830988618379);
  9977. define ('M_2_PI', 0.63661977236758);
  9978. define ('M_SQRTPI', 1.7724538509055);
  9979. define ('M_2_SQRTPI', 1.1283791670955);
  9980. define ('M_LNPI', 1.1447298858494);
  9981. define ('M_EULER', 0.57721566490153);
  9982. define ('M_SQRT2', 1.4142135623731);
  9983. define ('M_SQRT1_2', 0.70710678118655);
  9984. define ('M_SQRT3', 1.7320508075689);
  9985. define ('INF', INF);
  9986. define ('NAN', NAN);
  9987. define ('PHP_ROUND_HALF_UP', 1);
  9988. /**
  9989. * Round halves down
  9990. * @link http://www.php.net/manual/en/math.constants.php
  9991. */
  9992. define ('PHP_ROUND_HALF_DOWN', 2);
  9993. /**
  9994. * Round halves to even numbers
  9995. * @link http://www.php.net/manual/en/math.constants.php
  9996. */
  9997. define ('PHP_ROUND_HALF_EVEN', 3);
  9998. /**
  9999. * Round halves to odd numbers
  10000. * @link http://www.php.net/manual/en/math.constants.php
  10001. */
  10002. define ('PHP_ROUND_HALF_ODD', 4);
  10003. define ('INFO_GENERAL', 1);
  10004. /**
  10005. * PHP Credits. See also phpcredits.
  10006. * @link http://www.php.net/manual/en/info.constants.php
  10007. */
  10008. define ('INFO_CREDITS', 2);
  10009. /**
  10010. * Current Local and Master values for PHP directives. See
  10011. * also ini_get.
  10012. * @link http://www.php.net/manual/en/info.constants.php
  10013. */
  10014. define ('INFO_CONFIGURATION', 4);
  10015. /**
  10016. * Loaded modules and their respective settings.
  10017. * @link http://www.php.net/manual/en/info.constants.php
  10018. */
  10019. define ('INFO_MODULES', 8);
  10020. /**
  10021. * Environment Variable information that's also available in
  10022. * $_ENV.
  10023. * @link http://www.php.net/manual/en/info.constants.php
  10024. */
  10025. define ('INFO_ENVIRONMENT', 16);
  10026. /**
  10027. * Shows all
  10028. * predefined variables from EGPCS (Environment, GET,
  10029. * POST, Cookie, Server).
  10030. * @link http://www.php.net/manual/en/info.constants.php
  10031. */
  10032. define ('INFO_VARIABLES', 32);
  10033. /**
  10034. * PHP License information. See also the license faq.
  10035. * @link http://www.php.net/manual/en/info.constants.php
  10036. */
  10037. define ('INFO_LICENSE', 64);
  10038. /**
  10039. * Unused
  10040. * @link http://www.php.net/manual/en/info.constants.php
  10041. */
  10042. define ('INFO_ALL', 4294967295);
  10043. /**
  10044. * A list of the core developers
  10045. * @link http://www.php.net/manual/en/info.constants.php
  10046. */
  10047. define ('CREDITS_GROUP', 1);
  10048. /**
  10049. * General credits: Language design and concept, PHP
  10050. * authors and SAPI module.
  10051. * @link http://www.php.net/manual/en/info.constants.php
  10052. */
  10053. define ('CREDITS_GENERAL', 2);
  10054. /**
  10055. * A list of the server API modules for PHP, and their authors.
  10056. * @link http://www.php.net/manual/en/info.constants.php
  10057. */
  10058. define ('CREDITS_SAPI', 4);
  10059. /**
  10060. * A list of the extension modules for PHP, and their authors.
  10061. * @link http://www.php.net/manual/en/info.constants.php
  10062. */
  10063. define ('CREDITS_MODULES', 8);
  10064. /**
  10065. * The credits for the documentation team.
  10066. * @link http://www.php.net/manual/en/info.constants.php
  10067. */
  10068. define ('CREDITS_DOCS', 16);
  10069. /**
  10070. * Usually used in combination with the other flags. Indicates
  10071. * that a complete stand-alone HTML page needs to be
  10072. * printed including the information indicated by the other
  10073. * flags.
  10074. * @link http://www.php.net/manual/en/info.constants.php
  10075. */
  10076. define ('CREDITS_FULLPAGE', 32);
  10077. /**
  10078. * The credits for the quality assurance team.
  10079. * @link http://www.php.net/manual/en/info.constants.php
  10080. */
  10081. define ('CREDITS_QA', 64);
  10082. /**
  10083. * The configuration line, &php.ini; location, build date, Web
  10084. * Server, System and more.
  10085. * @link http://www.php.net/manual/en/info.constants.php
  10086. */
  10087. define ('CREDITS_ALL', 4294967295);
  10088. define ('HTML_SPECIALCHARS', 0);
  10089. define ('HTML_ENTITIES', 1);
  10090. define ('ENT_COMPAT', 2);
  10091. define ('ENT_QUOTES', 3);
  10092. define ('ENT_NOQUOTES', 0);
  10093. define ('ENT_IGNORE', 4);
  10094. define ('ENT_SUBSTITUTE', 8);
  10095. define ('ENT_DISALLOWED', 128);
  10096. define ('ENT_HTML401', 0);
  10097. define ('ENT_XML1', 16);
  10098. define ('ENT_XHTML', 32);
  10099. define ('ENT_HTML5', 48);
  10100. define ('STR_PAD_LEFT', 0);
  10101. define ('STR_PAD_RIGHT', 1);
  10102. define ('STR_PAD_BOTH', 2);
  10103. define ('PATHINFO_DIRNAME', 1);
  10104. define ('PATHINFO_BASENAME', 2);
  10105. define ('PATHINFO_EXTENSION', 4);
  10106. /**
  10107. * Since PHP 5.2.0.
  10108. * @link http://www.php.net/manual/en/filesystem.constants.php
  10109. */
  10110. define ('PATHINFO_FILENAME', 8);
  10111. define ('CHAR_MAX', 127);
  10112. define ('LC_CTYPE', 0);
  10113. define ('LC_NUMERIC', 1);
  10114. define ('LC_TIME', 2);
  10115. define ('LC_COLLATE', 3);
  10116. define ('LC_MONETARY', 4);
  10117. define ('LC_ALL', 6);
  10118. define ('LC_MESSAGES', 5);
  10119. define ('SEEK_SET', 0);
  10120. define ('SEEK_CUR', 1);
  10121. define ('SEEK_END', 2);
  10122. define ('LOCK_SH', 1);
  10123. define ('LOCK_EX', 2);
  10124. define ('LOCK_UN', 3);
  10125. define ('LOCK_NB', 4);
  10126. /**
  10127. * A connection with an external resource has been established.
  10128. * @link http://www.php.net/manual/en/stream.constants.php
  10129. */
  10130. define ('STREAM_NOTIFY_CONNECT', 2);
  10131. /**
  10132. * Additional authorization is required to access the specified resource.
  10133. * Typical issued with severity level of
  10134. * STREAM_NOTIFY_SEVERITY_ERR.
  10135. * @link http://www.php.net/manual/en/stream.constants.php
  10136. */
  10137. define ('STREAM_NOTIFY_AUTH_REQUIRED', 3);
  10138. /**
  10139. * Authorization has been completed (with or without success).
  10140. * @link http://www.php.net/manual/en/stream.constants.php
  10141. */
  10142. define ('STREAM_NOTIFY_AUTH_RESULT', 10);
  10143. /**
  10144. * The mime-type of resource has been identified,
  10145. * refer to message for a description of the
  10146. * discovered type.
  10147. * @link http://www.php.net/manual/en/stream.constants.php
  10148. */
  10149. define ('STREAM_NOTIFY_MIME_TYPE_IS', 4);
  10150. /**
  10151. * The size of the resource has been discovered.
  10152. * @link http://www.php.net/manual/en/stream.constants.php
  10153. */
  10154. define ('STREAM_NOTIFY_FILE_SIZE_IS', 5);
  10155. /**
  10156. * The external resource has redirected the stream to an alternate
  10157. * location. Refer to message.
  10158. * @link http://www.php.net/manual/en/stream.constants.php
  10159. */
  10160. define ('STREAM_NOTIFY_REDIRECTED', 6);
  10161. /**
  10162. * Indicates current progress of the stream transfer in
  10163. * bytes_transferred and possibly
  10164. * bytes_max as well.
  10165. * @link http://www.php.net/manual/en/stream.constants.php
  10166. */
  10167. define ('STREAM_NOTIFY_PROGRESS', 7);
  10168. /**
  10169. * A generic error occurred on the stream, consult
  10170. * message and message_code
  10171. * for details.
  10172. * @link http://www.php.net/manual/en/stream.constants.php
  10173. */
  10174. define ('STREAM_NOTIFY_FAILURE', 9);
  10175. /**
  10176. * There is no more data available on the stream.
  10177. * @link http://www.php.net/manual/en/stream.constants.php
  10178. */
  10179. define ('STREAM_NOTIFY_COMPLETED', 8);
  10180. /**
  10181. * A remote address required for this stream has been resolved, or the resolution
  10182. * failed. See severity for an indication of which happened.
  10183. * @link http://www.php.net/manual/en/stream.constants.php
  10184. */
  10185. define ('STREAM_NOTIFY_RESOLVE', 1);
  10186. /**
  10187. * Normal, non-error related, notification.
  10188. * @link http://www.php.net/manual/en/stream.constants.php
  10189. */
  10190. define ('STREAM_NOTIFY_SEVERITY_INFO', 0);
  10191. /**
  10192. * Non critical error condition. Processing may continue.
  10193. * @link http://www.php.net/manual/en/stream.constants.php
  10194. */
  10195. define ('STREAM_NOTIFY_SEVERITY_WARN', 1);
  10196. /**
  10197. * A critical error occurred. Processing cannot continue.
  10198. * @link http://www.php.net/manual/en/stream.constants.php
  10199. */
  10200. define ('STREAM_NOTIFY_SEVERITY_ERR', 2);
  10201. /**
  10202. * Used with stream_filter_append and
  10203. * stream_filter_prepend to indicate
  10204. * that the specified filter should only be applied when
  10205. * reading
  10206. * @link http://www.php.net/manual/en/stream.constants.php
  10207. */
  10208. define ('STREAM_FILTER_READ', 1);
  10209. /**
  10210. * Used with stream_filter_append and
  10211. * stream_filter_prepend to indicate
  10212. * that the specified filter should only be applied when
  10213. * writing
  10214. * @link http://www.php.net/manual/en/stream.constants.php
  10215. */
  10216. define ('STREAM_FILTER_WRITE', 2);
  10217. /**
  10218. * This constant is equivalent to
  10219. * STREAM_FILTER_READ | STREAM_FILTER_WRITE
  10220. * @link http://www.php.net/manual/en/stream.constants.php
  10221. */
  10222. define ('STREAM_FILTER_ALL', 3);
  10223. /**
  10224. * Client socket opened with stream_socket_client
  10225. * should remain persistent between page loads.
  10226. * @link http://www.php.net/manual/en/stream.constants.php
  10227. */
  10228. define ('STREAM_CLIENT_PERSISTENT', 1);
  10229. /**
  10230. * Open client socket asynchronously. This option must be used
  10231. * together with the STREAM_CLIENT_CONNECT flag.
  10232. * Used with stream_socket_client.
  10233. * @link http://www.php.net/manual/en/stream.constants.php
  10234. */
  10235. define ('STREAM_CLIENT_ASYNC_CONNECT', 2);
  10236. /**
  10237. * Open client socket connection. Client sockets should always
  10238. * include this flag. Used with stream_socket_client.
  10239. * @link http://www.php.net/manual/en/stream.constants.php
  10240. */
  10241. define ('STREAM_CLIENT_CONNECT', 4);
  10242. define ('STREAM_CRYPTO_METHOD_SSLv2_CLIENT', 0);
  10243. define ('STREAM_CRYPTO_METHOD_SSLv3_CLIENT', 1);
  10244. define ('STREAM_CRYPTO_METHOD_SSLv23_CLIENT', 2);
  10245. define ('STREAM_CRYPTO_METHOD_TLS_CLIENT', 3);
  10246. define ('STREAM_CRYPTO_METHOD_SSLv2_SERVER', 4);
  10247. define ('STREAM_CRYPTO_METHOD_SSLv3_SERVER', 5);
  10248. define ('STREAM_CRYPTO_METHOD_SSLv23_SERVER', 6);
  10249. define ('STREAM_CRYPTO_METHOD_TLS_SERVER', 7);
  10250. /**
  10251. * Used with stream_socket_shutdown to disable
  10252. * further receptions. Added in PHP 5.2.1.
  10253. * @link http://www.php.net/manual/en/stream.constants.php
  10254. */
  10255. define ('STREAM_SHUT_RD', 0);
  10256. /**
  10257. * Used with stream_socket_shutdown to disable
  10258. * further transmissions. Added in PHP 5.2.1.
  10259. * @link http://www.php.net/manual/en/stream.constants.php
  10260. */
  10261. define ('STREAM_SHUT_WR', 1);
  10262. /**
  10263. * Used with stream_socket_shutdown to disable
  10264. * further receptions and transmissions. Added in PHP 5.2.1.
  10265. * @link http://www.php.net/manual/en/stream.constants.php
  10266. */
  10267. define ('STREAM_SHUT_RDWR', 2);
  10268. /**
  10269. * Internet Protocol Version 4 (IPv4).
  10270. * @link http://www.php.net/manual/en/stream.constants.php
  10271. */
  10272. define ('STREAM_PF_INET', 2);
  10273. /**
  10274. * Internet Protocol Version 6 (IPv6).
  10275. * @link http://www.php.net/manual/en/stream.constants.php
  10276. */
  10277. define ('STREAM_PF_INET6', 10);
  10278. /**
  10279. * Unix system internal protocols.
  10280. * @link http://www.php.net/manual/en/stream.constants.php
  10281. */
  10282. define ('STREAM_PF_UNIX', 1);
  10283. /**
  10284. * Provides a IP socket.
  10285. * @link http://www.php.net/manual/en/stream.constants.php
  10286. */
  10287. define ('STREAM_IPPROTO_IP', 0);
  10288. /**
  10289. * Provides a TCP socket.
  10290. * @link http://www.php.net/manual/en/stream.constants.php
  10291. */
  10292. define ('STREAM_IPPROTO_TCP', 6);
  10293. /**
  10294. * Provides a UDP socket.
  10295. * @link http://www.php.net/manual/en/stream.constants.php
  10296. */
  10297. define ('STREAM_IPPROTO_UDP', 17);
  10298. /**
  10299. * Provides a ICMP socket.
  10300. * @link http://www.php.net/manual/en/stream.constants.php
  10301. */
  10302. define ('STREAM_IPPROTO_ICMP', 1);
  10303. /**
  10304. * Provides a RAW socket.
  10305. * @link http://www.php.net/manual/en/stream.constants.php
  10306. */
  10307. define ('STREAM_IPPROTO_RAW', 255);
  10308. /**
  10309. * Provides sequenced, two-way byte streams with a transmission mechanism
  10310. * for out-of-band data (TCP, for example).
  10311. * @link http://www.php.net/manual/en/stream.constants.php
  10312. */
  10313. define ('STREAM_SOCK_STREAM', 1);
  10314. /**
  10315. * Provides datagrams, which are connectionless messages (UDP, for
  10316. * example).
  10317. * @link http://www.php.net/manual/en/stream.constants.php
  10318. */
  10319. define ('STREAM_SOCK_DGRAM', 2);
  10320. /**
  10321. * Provides a raw socket, which provides access to internal network
  10322. * protocols and interfaces. Usually this type of socket is just available
  10323. * to the root user.
  10324. * @link http://www.php.net/manual/en/stream.constants.php
  10325. */
  10326. define ('STREAM_SOCK_RAW', 3);
  10327. /**
  10328. * Provides a sequenced packet stream socket.
  10329. * @link http://www.php.net/manual/en/stream.constants.php
  10330. */
  10331. define ('STREAM_SOCK_SEQPACKET', 5);
  10332. /**
  10333. * Provides a RDM (Reliably-delivered messages) socket.
  10334. * @link http://www.php.net/manual/en/stream.constants.php
  10335. */
  10336. define ('STREAM_SOCK_RDM', 4);
  10337. define ('STREAM_PEEK', 2);
  10338. define ('STREAM_OOB', 1);
  10339. /**
  10340. * Tells a stream created with stream_socket_server
  10341. * to bind to the specified target. Server sockets should always include this flag.
  10342. * @link http://www.php.net/manual/en/stream.constants.php
  10343. */
  10344. define ('STREAM_SERVER_BIND', 4);
  10345. /**
  10346. * Tells a stream created with stream_socket_server
  10347. * and bound using the STREAM_SERVER_BIND flag to start
  10348. * listening on the socket. Connection-orientated transports (such as TCP)
  10349. * must use this flag, otherwise the server socket will not be enabled.
  10350. * Using this flag for connect-less transports (such as UDP) is an error.
  10351. * @link http://www.php.net/manual/en/stream.constants.php
  10352. */
  10353. define ('STREAM_SERVER_LISTEN', 8);
  10354. /**
  10355. * Search for filename in
  10356. * include_path (since PHP 5).
  10357. * @link http://www.php.net/manual/en/filesystem.constants.php
  10358. */
  10359. define ('FILE_USE_INCLUDE_PATH', 1);
  10360. /**
  10361. * Strip EOL characters (since PHP 5).
  10362. * @link http://www.php.net/manual/en/filesystem.constants.php
  10363. */
  10364. define ('FILE_IGNORE_NEW_LINES', 2);
  10365. /**
  10366. * Skip empty lines (since PHP 5).
  10367. * @link http://www.php.net/manual/en/filesystem.constants.php
  10368. */
  10369. define ('FILE_SKIP_EMPTY_LINES', 4);
  10370. /**
  10371. * Append content to existing file.
  10372. * @link http://www.php.net/manual/en/filesystem.constants.php
  10373. */
  10374. define ('FILE_APPEND', 8);
  10375. define ('FILE_NO_DEFAULT_CONTEXT', 16);
  10376. /**
  10377. * <p>
  10378. * Text mode (since PHP 5.2.7).
  10379. * <p>
  10380. * This constant has no effect, and is only available for
  10381. * forward compatibility.
  10382. * </p>
  10383. * </p>
  10384. * @link http://www.php.net/manual/en/filesystem.constants.php
  10385. */
  10386. define ('FILE_TEXT', 0);
  10387. /**
  10388. * <p>
  10389. * Binary mode (since PHP 5.2.7).
  10390. * <p>
  10391. * This constant has no effect, and is only available for
  10392. * forward compatibility.
  10393. * </p>
  10394. * </p>
  10395. * @link http://www.php.net/manual/en/filesystem.constants.php
  10396. */
  10397. define ('FILE_BINARY', 0);
  10398. /**
  10399. * Disable backslash escaping.
  10400. * @link http://www.php.net/manual/en/filesystem.constants.php
  10401. */
  10402. define ('FNM_NOESCAPE', 2);
  10403. /**
  10404. * Slash in string only matches slash in the given pattern.
  10405. * @link http://www.php.net/manual/en/filesystem.constants.php
  10406. */
  10407. define ('FNM_PATHNAME', 1);
  10408. /**
  10409. * Leading period in string must be exactly matched by period in the given pattern.
  10410. * @link http://www.php.net/manual/en/filesystem.constants.php
  10411. */
  10412. define ('FNM_PERIOD', 4);
  10413. /**
  10414. * Caseless match. Part of the GNU extension.
  10415. * @link http://www.php.net/manual/en/filesystem.constants.php
  10416. */
  10417. define ('FNM_CASEFOLD', 16);
  10418. /**
  10419. * Return Code indicating that the
  10420. * userspace filter returned buckets in $out.
  10421. * @link http://www.php.net/manual/en/stream.constants.php
  10422. */
  10423. define ('PSFS_PASS_ON', 2);
  10424. /**
  10425. * Return Code indicating that the
  10426. * userspace filter did not return buckets in $out
  10427. * (i.e. No data available).
  10428. * @link http://www.php.net/manual/en/stream.constants.php
  10429. */
  10430. define ('PSFS_FEED_ME', 1);
  10431. /**
  10432. * Return Code indicating that the
  10433. * userspace filter encountered an unrecoverable error
  10434. * (i.e. Invalid data received).
  10435. * @link http://www.php.net/manual/en/stream.constants.php
  10436. */
  10437. define ('PSFS_ERR_FATAL', 0);
  10438. /**
  10439. * Regular read/write.
  10440. * @link http://www.php.net/manual/en/stream.constants.php
  10441. */
  10442. define ('PSFS_FLAG_NORMAL', 0);
  10443. /**
  10444. * An incremental flush.
  10445. * @link http://www.php.net/manual/en/stream.constants.php
  10446. */
  10447. define ('PSFS_FLAG_FLUSH_INC', 1);
  10448. /**
  10449. * Final flush prior to closing.
  10450. * @link http://www.php.net/manual/en/stream.constants.php
  10451. */
  10452. define ('PSFS_FLAG_FLUSH_CLOSE', 2);
  10453. define ('ABDAY_1', 131072);
  10454. define ('ABDAY_2', 131073);
  10455. define ('ABDAY_3', 131074);
  10456. define ('ABDAY_4', 131075);
  10457. define ('ABDAY_5', 131076);
  10458. define ('ABDAY_6', 131077);
  10459. define ('ABDAY_7', 131078);
  10460. define ('DAY_1', 131079);
  10461. define ('DAY_2', 131080);
  10462. define ('DAY_3', 131081);
  10463. define ('DAY_4', 131082);
  10464. define ('DAY_5', 131083);
  10465. define ('DAY_6', 131084);
  10466. define ('DAY_7', 131085);
  10467. define ('ABMON_1', 131086);
  10468. define ('ABMON_2', 131087);
  10469. define ('ABMON_3', 131088);
  10470. define ('ABMON_4', 131089);
  10471. define ('ABMON_5', 131090);
  10472. define ('ABMON_6', 131091);
  10473. define ('ABMON_7', 131092);
  10474. define ('ABMON_8', 131093);
  10475. define ('ABMON_9', 131094);
  10476. define ('ABMON_10', 131095);
  10477. define ('ABMON_11', 131096);
  10478. define ('ABMON_12', 131097);
  10479. define ('MON_1', 131098);
  10480. define ('MON_2', 131099);
  10481. define ('MON_3', 131100);
  10482. define ('MON_4', 131101);
  10483. define ('MON_5', 131102);
  10484. define ('MON_6', 131103);
  10485. define ('MON_7', 131104);
  10486. define ('MON_8', 131105);
  10487. define ('MON_9', 131106);
  10488. define ('MON_10', 131107);
  10489. define ('MON_11', 131108);
  10490. define ('MON_12', 131109);
  10491. define ('AM_STR', 131110);
  10492. define ('PM_STR', 131111);
  10493. define ('D_T_FMT', 131112);
  10494. define ('D_FMT', 131113);
  10495. define ('T_FMT', 131114);
  10496. define ('T_FMT_AMPM', 131115);
  10497. define ('ERA', 131116);
  10498. define ('ERA_D_T_FMT', 131120);
  10499. define ('ERA_D_FMT', 131118);
  10500. define ('ERA_T_FMT', 131121);
  10501. define ('ALT_DIGITS', 131119);
  10502. define ('CRNCYSTR', 262159);
  10503. define ('RADIXCHAR', 65536);
  10504. define ('THOUSEP', 65537);
  10505. define ('YESEXPR', 327680);
  10506. define ('NOEXPR', 327681);
  10507. define ('CODESET', 14);
  10508. define ('CRYPT_SALT_LENGTH', 37);
  10509. define ('CRYPT_STD_DES', 1);
  10510. define ('CRYPT_EXT_DES', 1);
  10511. define ('CRYPT_MD5', 1);
  10512. define ('CRYPT_BLOWFISH', 1);
  10513. define ('CRYPT_SHA256', 1);
  10514. define ('CRYPT_SHA512', 1);
  10515. define ('DIRECTORY_SEPARATOR', "/");
  10516. /**
  10517. * Available since PHP 4.3.0. Semicolon on Windows, colon otherwise.
  10518. * @link http://www.php.net/manual/en/dir.constants.php
  10519. */
  10520. define ('PATH_SEPARATOR', ":");
  10521. /**
  10522. * Available since PHP 5.4.0.
  10523. * @link http://www.php.net/manual/en/dir.constants.php
  10524. */
  10525. define ('SCANDIR_SORT_ASCENDING', 0);
  10526. /**
  10527. * Available since PHP 5.4.0.
  10528. * @link http://www.php.net/manual/en/dir.constants.php
  10529. */
  10530. define ('SCANDIR_SORT_DESCENDING', 1);
  10531. /**
  10532. * Available since PHP 5.4.0.
  10533. * @link http://www.php.net/manual/en/dir.constants.php
  10534. */
  10535. define ('SCANDIR_SORT_NONE', 2);
  10536. define ('GLOB_BRACE', 1024);
  10537. define ('GLOB_MARK', 2);
  10538. define ('GLOB_NOSORT', 4);
  10539. define ('GLOB_NOCHECK', 16);
  10540. define ('GLOB_NOESCAPE', 64);
  10541. define ('GLOB_ERR', 1);
  10542. define ('GLOB_ONLYDIR', 8192);
  10543. define ('GLOB_AVAILABLE_FLAGS', 9303);
  10544. /**
  10545. * system is unusable
  10546. * @link http://www.php.net/manual/en/network.constants.php
  10547. */
  10548. define ('LOG_EMERG', 0);
  10549. /**
  10550. * action must be taken immediately
  10551. * @link http://www.php.net/manual/en/network.constants.php
  10552. */
  10553. define ('LOG_ALERT', 1);
  10554. /**
  10555. * critical conditions
  10556. * @link http://www.php.net/manual/en/network.constants.php
  10557. */
  10558. define ('LOG_CRIT', 2);
  10559. /**
  10560. * error conditions
  10561. * @link http://www.php.net/manual/en/network.constants.php
  10562. */
  10563. define ('LOG_ERR', 3);
  10564. /**
  10565. * warning conditions
  10566. * @link http://www.php.net/manual/en/network.constants.php
  10567. */
  10568. define ('LOG_WARNING', 4);
  10569. /**
  10570. * normal, but significant, condition
  10571. * @link http://www.php.net/manual/en/network.constants.php
  10572. */
  10573. define ('LOG_NOTICE', 5);
  10574. /**
  10575. * informational message
  10576. * @link http://www.php.net/manual/en/network.constants.php
  10577. */
  10578. define ('LOG_INFO', 6);
  10579. /**
  10580. * debug-level message
  10581. * @link http://www.php.net/manual/en/network.constants.php
  10582. */
  10583. define ('LOG_DEBUG', 7);
  10584. /**
  10585. * kernel messages
  10586. * @link http://www.php.net/manual/en/network.constants.php
  10587. */
  10588. define ('LOG_KERN', 0);
  10589. /**
  10590. * generic user-level messages
  10591. * @link http://www.php.net/manual/en/network.constants.php
  10592. */
  10593. define ('LOG_USER', 8);
  10594. /**
  10595. * mail subsystem
  10596. * @link http://www.php.net/manual/en/network.constants.php
  10597. */
  10598. define ('LOG_MAIL', 16);
  10599. /**
  10600. * other system daemons
  10601. * @link http://www.php.net/manual/en/network.constants.php
  10602. */
  10603. define ('LOG_DAEMON', 24);
  10604. /**
  10605. * security/authorization messages (use LOG_AUTHPRIV instead
  10606. * in systems where that constant is defined)
  10607. * @link http://www.php.net/manual/en/network.constants.php
  10608. */
  10609. define ('LOG_AUTH', 32);
  10610. /**
  10611. * messages generated internally by syslogd
  10612. * @link http://www.php.net/manual/en/network.constants.php
  10613. */
  10614. define ('LOG_SYSLOG', 40);
  10615. /**
  10616. * line printer subsystem
  10617. * @link http://www.php.net/manual/en/network.constants.php
  10618. */
  10619. define ('LOG_LPR', 48);
  10620. /**
  10621. * USENET news subsystem
  10622. * @link http://www.php.net/manual/en/network.constants.php
  10623. */
  10624. define ('LOG_NEWS', 56);
  10625. /**
  10626. * UUCP subsystem
  10627. * @link http://www.php.net/manual/en/network.constants.php
  10628. */
  10629. define ('LOG_UUCP', 64);
  10630. /**
  10631. * clock daemon (cron and at)
  10632. * @link http://www.php.net/manual/en/network.constants.php
  10633. */
  10634. define ('LOG_CRON', 72);
  10635. /**
  10636. * security/authorization messages (private)
  10637. * @link http://www.php.net/manual/en/network.constants.php
  10638. */
  10639. define ('LOG_AUTHPRIV', 80);
  10640. define ('LOG_LOCAL0', 128);
  10641. define ('LOG_LOCAL1', 136);
  10642. define ('LOG_LOCAL2', 144);
  10643. define ('LOG_LOCAL3', 152);
  10644. define ('LOG_LOCAL4', 160);
  10645. define ('LOG_LOCAL5', 168);
  10646. define ('LOG_LOCAL6', 176);
  10647. define ('LOG_LOCAL7', 184);
  10648. /**
  10649. * include PID with each message
  10650. * @link http://www.php.net/manual/en/network.constants.php
  10651. */
  10652. define ('LOG_PID', 1);
  10653. /**
  10654. * if there is an error while sending data to the system logger,
  10655. * write directly to the system console
  10656. * @link http://www.php.net/manual/en/network.constants.php
  10657. */
  10658. define ('LOG_CONS', 2);
  10659. /**
  10660. * (default) delay opening the connection until the first
  10661. * message is logged
  10662. * @link http://www.php.net/manual/en/network.constants.php
  10663. */
  10664. define ('LOG_ODELAY', 4);
  10665. /**
  10666. * open the connection to the logger immediately
  10667. * @link http://www.php.net/manual/en/network.constants.php
  10668. */
  10669. define ('LOG_NDELAY', 8);
  10670. define ('LOG_NOWAIT', 16);
  10671. /**
  10672. * print log message also to standard error
  10673. * @link http://www.php.net/manual/en/network.constants.php
  10674. */
  10675. define ('LOG_PERROR', 32);
  10676. define ('EXTR_OVERWRITE', 0);
  10677. define ('EXTR_SKIP', 1);
  10678. define ('EXTR_PREFIX_SAME', 2);
  10679. define ('EXTR_PREFIX_ALL', 3);
  10680. define ('EXTR_PREFIX_INVALID', 4);
  10681. define ('EXTR_PREFIX_IF_EXISTS', 5);
  10682. define ('EXTR_IF_EXISTS', 6);
  10683. define ('EXTR_REFS', 256);
  10684. /**
  10685. * SORT_ASC is used with
  10686. * array_multisort to sort in ascending order.
  10687. * @link http://www.php.net/manual/en/array.constants.php
  10688. */
  10689. define ('SORT_ASC', 4);
  10690. /**
  10691. * SORT_DESC is used with
  10692. * array_multisort to sort in descending order.
  10693. * @link http://www.php.net/manual/en/array.constants.php
  10694. */
  10695. define ('SORT_DESC', 3);
  10696. /**
  10697. * SORT_REGULAR is used to compare items normally.
  10698. * @link http://www.php.net/manual/en/array.constants.php
  10699. */
  10700. define ('SORT_REGULAR', 0);
  10701. /**
  10702. * SORT_NUMERIC is used to compare items numerically.
  10703. * @link http://www.php.net/manual/en/array.constants.php
  10704. */
  10705. define ('SORT_NUMERIC', 1);
  10706. /**
  10707. * SORT_STRING is used to compare items as strings.
  10708. * @link http://www.php.net/manual/en/array.constants.php
  10709. */
  10710. define ('SORT_STRING', 2);
  10711. /**
  10712. * SORT_LOCALE_STRING is used to compare items as
  10713. * strings, based on the current locale. Added in PHP 4.4.0 and 5.0.2.
  10714. * @link http://www.php.net/manual/en/array.constants.php
  10715. */
  10716. define ('SORT_LOCALE_STRING', 5);
  10717. /**
  10718. * SORT_NATURAL is used to compare items as
  10719. * strings using "natural ordering" like natsort. Added in PHP 5.4.0.
  10720. * @link http://www.php.net/manual/en/array.constants.php
  10721. */
  10722. define ('SORT_NATURAL', 6);
  10723. /**
  10724. * SORT_FLAG_CASE can be combined
  10725. * (bitwise OR) with
  10726. * SORT_STRING or
  10727. * SORT_NATURAL to sort strings case-insensitively. Added in PHP 5.4.0.
  10728. * @link http://www.php.net/manual/en/array.constants.php
  10729. */
  10730. define ('SORT_FLAG_CASE', 8);
  10731. /**
  10732. * CASE_LOWER is used with
  10733. * array_change_key_case and is used to convert array
  10734. * keys to lower case. This is also the default case for
  10735. * array_change_key_case.
  10736. * @link http://www.php.net/manual/en/array.constants.php
  10737. */
  10738. define ('CASE_LOWER', 0);
  10739. /**
  10740. * CASE_UPPER is used with
  10741. * array_change_key_case and is used to convert array
  10742. * keys to upper case.
  10743. * @link http://www.php.net/manual/en/array.constants.php
  10744. */
  10745. define ('CASE_UPPER', 1);
  10746. define ('COUNT_NORMAL', 0);
  10747. define ('COUNT_RECURSIVE', 1);
  10748. define ('ASSERT_ACTIVE', 1);
  10749. define ('ASSERT_CALLBACK', 2);
  10750. define ('ASSERT_BAIL', 3);
  10751. define ('ASSERT_WARNING', 4);
  10752. define ('ASSERT_QUIET_EVAL', 5);
  10753. /**
  10754. * Flag indicating if the stream
  10755. * used the include path.
  10756. * @link http://www.php.net/manual/en/stream.constants.php
  10757. */
  10758. define ('STREAM_USE_PATH', 1);
  10759. define ('STREAM_IGNORE_URL', 2);
  10760. /**
  10761. * Flag indicating if the wrapper
  10762. * is responsible for raising errors using trigger_error
  10763. * during opening of the stream. If this flag is not set, you
  10764. * should not raise any errors.
  10765. * @link http://www.php.net/manual/en/stream.constants.php
  10766. */
  10767. define ('STREAM_REPORT_ERRORS', 8);
  10768. /**
  10769. * This flag is useful when your extension really must be able to randomly
  10770. * seek around in a stream. Some streams may not be seekable in their
  10771. * native form, so this flag asks the streams API to check to see if the
  10772. * stream does support seeking. If it does not, it will copy the stream
  10773. * into temporary storage (which may be a temporary file or a memory
  10774. * stream) which does support seeking.
  10775. * Please note that this flag is not useful when you want to seek the
  10776. * stream and write to it, because the stream you are accessing might
  10777. * not be bound to the actual resource you requested.
  10778. * If the requested resource is network based, this flag will cause the
  10779. * opener to block until the whole contents have been downloaded.
  10780. * @link http://www.php.net/manual/en/internals2.ze1.streams.constants.php
  10781. */
  10782. define ('STREAM_MUST_SEEK', 16);
  10783. define ('STREAM_URL_STAT_LINK', 1);
  10784. define ('STREAM_URL_STAT_QUIET', 2);
  10785. define ('STREAM_MKDIR_RECURSIVE', 1);
  10786. define ('STREAM_IS_URL', 1);
  10787. define ('STREAM_OPTION_BLOCKING', 1);
  10788. define ('STREAM_OPTION_READ_TIMEOUT', 4);
  10789. define ('STREAM_OPTION_READ_BUFFER', 2);
  10790. define ('STREAM_OPTION_WRITE_BUFFER', 3);
  10791. define ('STREAM_BUFFER_NONE', 0);
  10792. define ('STREAM_BUFFER_LINE', 1);
  10793. define ('STREAM_BUFFER_FULL', 2);
  10794. /**
  10795. * Stream casting, when stream_cast is called
  10796. * otherwise (see above).
  10797. * @link http://www.php.net/manual/en/stream.constants.php
  10798. */
  10799. define ('STREAM_CAST_AS_STREAM', 0);
  10800. /**
  10801. * Stream casting, for when stream_select is
  10802. * calling stream_cast.
  10803. * @link http://www.php.net/manual/en/stream.constants.php
  10804. */
  10805. define ('STREAM_CAST_FOR_SELECT', 3);
  10806. /**
  10807. * Used with stream_metadata, to specify touch call.
  10808. * @link http://www.php.net/manual/en/stream.constants.php
  10809. */
  10810. define ('STREAM_META_TOUCH', 1);
  10811. /**
  10812. * Used with stream_metadata, to specify chown call.
  10813. * @link http://www.php.net/manual/en/stream.constants.php
  10814. */
  10815. define ('STREAM_META_OWNER', 3);
  10816. /**
  10817. * Used with stream_metadata, to specify chown call.
  10818. * @link http://www.php.net/manual/en/stream.constants.php
  10819. */
  10820. define ('STREAM_META_OWNER_NAME', 2);
  10821. /**
  10822. * Used with stream_metadata, to specify chgrp call.
  10823. * @link http://www.php.net/manual/en/stream.constants.php
  10824. */
  10825. define ('STREAM_META_GROUP', 5);
  10826. /**
  10827. * Used with stream_metadata, to specify chgrp call.
  10828. * @link http://www.php.net/manual/en/stream.constants.php
  10829. */
  10830. define ('STREAM_META_GROUP_NAME', 4);
  10831. /**
  10832. * Used with stream_metadata, to specify chmod call.
  10833. * @link http://www.php.net/manual/en/stream.constants.php
  10834. */
  10835. define ('STREAM_META_ACCESS', 6);
  10836. /**
  10837. * Image type constant used by the
  10838. * image_type_to_mime_type and
  10839. * image_type_to_extension functions.
  10840. * @link http://www.php.net/manual/en/image.constants.php
  10841. */
  10842. define ('IMAGETYPE_GIF', 1);
  10843. /**
  10844. * Image type constant used by the
  10845. * image_type_to_mime_type and
  10846. * image_type_to_extension functions.
  10847. * @link http://www.php.net/manual/en/image.constants.php
  10848. */
  10849. define ('IMAGETYPE_JPEG', 2);
  10850. /**
  10851. * Image type constant used by the
  10852. * image_type_to_mime_type and
  10853. * image_type_to_extension functions.
  10854. * @link http://www.php.net/manual/en/image.constants.php
  10855. */
  10856. define ('IMAGETYPE_PNG', 3);
  10857. /**
  10858. * Image type constant used by the
  10859. * image_type_to_mime_type and
  10860. * image_type_to_extension functions.
  10861. * @link http://www.php.net/manual/en/image.constants.php
  10862. */
  10863. define ('IMAGETYPE_SWF', 4);
  10864. /**
  10865. * Image type constant used by the
  10866. * image_type_to_mime_type and
  10867. * image_type_to_extension functions.
  10868. * @link http://www.php.net/manual/en/image.constants.php
  10869. */
  10870. define ('IMAGETYPE_PSD', 5);
  10871. /**
  10872. * Image type constant used by the
  10873. * image_type_to_mime_type and
  10874. * image_type_to_extension functions.
  10875. * @link http://www.php.net/manual/en/image.constants.php
  10876. */
  10877. define ('IMAGETYPE_BMP', 6);
  10878. /**
  10879. * Image type constant used by the
  10880. * image_type_to_mime_type and
  10881. * image_type_to_extension functions.
  10882. * @link http://www.php.net/manual/en/image.constants.php
  10883. */
  10884. define ('IMAGETYPE_TIFF_II', 7);
  10885. /**
  10886. * Image type constant used by the
  10887. * image_type_to_mime_type and
  10888. * image_type_to_extension functions.
  10889. * @link http://www.php.net/manual/en/image.constants.php
  10890. */
  10891. define ('IMAGETYPE_TIFF_MM', 8);
  10892. /**
  10893. * Image type constant used by the
  10894. * image_type_to_mime_type and
  10895. * image_type_to_extension functions.
  10896. * @link http://www.php.net/manual/en/image.constants.php
  10897. */
  10898. define ('IMAGETYPE_JPC', 9);
  10899. /**
  10900. * Image type constant used by the
  10901. * image_type_to_mime_type and
  10902. * image_type_to_extension functions.
  10903. * @link http://www.php.net/manual/en/image.constants.php
  10904. */
  10905. define ('IMAGETYPE_JP2', 10);
  10906. /**
  10907. * Image type constant used by the
  10908. * image_type_to_mime_type and
  10909. * image_type_to_extension functions.
  10910. * @link http://www.php.net/manual/en/image.constants.php
  10911. */
  10912. define ('IMAGETYPE_JPX', 11);
  10913. /**
  10914. * Image type constant used by the
  10915. * image_type_to_mime_type and
  10916. * image_type_to_extension functions.
  10917. * @link http://www.php.net/manual/en/image.constants.php
  10918. */
  10919. define ('IMAGETYPE_JB2', 12);
  10920. /**
  10921. * Image type constant used by the
  10922. * image_type_to_mime_type and
  10923. * image_type_to_extension functions.
  10924. * @link http://www.php.net/manual/en/image.constants.php
  10925. */
  10926. define ('IMAGETYPE_SWC', 13);
  10927. /**
  10928. * Image type constant used by the
  10929. * image_type_to_mime_type and
  10930. * image_type_to_extension functions.
  10931. * @link http://www.php.net/manual/en/image.constants.php
  10932. */
  10933. define ('IMAGETYPE_IFF', 14);
  10934. /**
  10935. * Image type constant used by the
  10936. * image_type_to_mime_type and
  10937. * image_type_to_extension functions.
  10938. * @link http://www.php.net/manual/en/image.constants.php
  10939. */
  10940. define ('IMAGETYPE_WBMP', 15);
  10941. /**
  10942. * Image type constant used by the
  10943. * image_type_to_mime_type and
  10944. * image_type_to_extension functions.
  10945. * @link http://www.php.net/manual/en/image.constants.php
  10946. */
  10947. define ('IMAGETYPE_JPEG2000', 9);
  10948. /**
  10949. * Image type constant used by the
  10950. * image_type_to_mime_type and
  10951. * image_type_to_extension functions.
  10952. * @link http://www.php.net/manual/en/image.constants.php
  10953. */
  10954. define ('IMAGETYPE_XBM', 16);
  10955. /**
  10956. * Image type constant used by the
  10957. * image_type_to_mime_type and
  10958. * image_type_to_extension functions.
  10959. * (Available as of PHP 5.3.0)
  10960. * @link http://www.php.net/manual/en/image.constants.php
  10961. */
  10962. define ('IMAGETYPE_ICO', 17);
  10963. define ('IMAGETYPE_UNKNOWN', 0);
  10964. define ('IMAGETYPE_COUNT', 18);
  10965. /**
  10966. * IPv4 Address Resource
  10967. * @link http://www.php.net/manual/en/network.constants.php
  10968. */
  10969. define ('DNS_A', 1);
  10970. /**
  10971. * Authoritative Name Server Resource
  10972. * @link http://www.php.net/manual/en/network.constants.php
  10973. */
  10974. define ('DNS_NS', 2);
  10975. /**
  10976. * Alias (Canonical Name) Resource
  10977. * @link http://www.php.net/manual/en/network.constants.php
  10978. */
  10979. define ('DNS_CNAME', 16);
  10980. /**
  10981. * Start of Authority Resource
  10982. * @link http://www.php.net/manual/en/network.constants.php
  10983. */
  10984. define ('DNS_SOA', 32);
  10985. /**
  10986. * Pointer Resource
  10987. * @link http://www.php.net/manual/en/network.constants.php
  10988. */
  10989. define ('DNS_PTR', 2048);
  10990. /**
  10991. * Host Info Resource (See IANA's
  10992. * Operating System Names
  10993. * for the meaning of these values)
  10994. * @link http://www.php.net/manual/en/network.constants.php
  10995. */
  10996. define ('DNS_HINFO', 4096);
  10997. /**
  10998. * Mail Exchanger Resource
  10999. * @link http://www.php.net/manual/en/network.constants.php
  11000. */
  11001. define ('DNS_MX', 16384);
  11002. /**
  11003. * Text Resource
  11004. * @link http://www.php.net/manual/en/network.constants.php
  11005. */
  11006. define ('DNS_TXT', 32768);
  11007. define ('DNS_SRV', 33554432);
  11008. define ('DNS_NAPTR', 67108864);
  11009. /**
  11010. * IPv6 Address Resource
  11011. * @link http://www.php.net/manual/en/network.constants.php
  11012. */
  11013. define ('DNS_AAAA', 134217728);
  11014. define ('DNS_A6', 16777216);
  11015. /**
  11016. * Any Resource Record. On most systems
  11017. * this returns all resource records, however
  11018. * it should not be counted upon for critical
  11019. * uses. Try DNS_ALL instead.
  11020. * @link http://www.php.net/manual/en/network.constants.php
  11021. */
  11022. define ('DNS_ANY', 268435456);
  11023. /**
  11024. * Iteratively query the name server for
  11025. * each available record type.
  11026. * @link http://www.php.net/manual/en/network.constants.php
  11027. */
  11028. define ('DNS_ALL', 251713587);
  11029. // End of standard v.5.4.4-2
  11030. ?>