PageRenderTime 41ms CodeModel.GetById 10ms RepoModel.GetById 0ms app.codeStats 0ms

/stubs/standard_4.php

http://github.com/nnmatveev/php-stubs
PHP | 1082 lines | 54 code | 52 blank | 976 comment | 0 complexity | 9c880018d0f0b28c9bb74ddfe71f1c9e MD5 | raw file
  1. <?php
  2. /**
  3. * (PHP 5 &gt;= 5.2.0)<br/>
  4. * Get the last occurred error
  5. * @link http://php.net/manual/en/function.error-get-last.php
  6. * @return array an associative array describing the last error with keys "type",
  7. * "message", "file" and "line". Returns &null; if there hasn't been an error
  8. * yet.
  9. */
  10. function error_get_last () {}
  11. /**
  12. * (PHP 4, PHP 5)<br/>
  13. * Call a user function given by the first parameter
  14. * @link http://php.net/manual/en/function.call-user-func.php
  15. * @param callback $function <p>
  16. * The function to be called. Class methods may also be invoked
  17. * statically using this function by passing
  18. * array($classname, $methodname) to this parameter.
  19. * Additionally class methods of an object instance may be called by passing
  20. * array($objectinstance, $methodname) to this parameter.
  21. * </p>
  22. * @param mixed $parameter [optional] <p>
  23. * Zero or more parameters to be passed to the function.
  24. * </p>
  25. * <p>
  26. * Note that the parameters for call_user_func are
  27. * not passed by reference.
  28. * call_user_func example and references
  29. * ]]>
  30. * &example.outputs;
  31. * </p>
  32. * @param mixed $_ [optional]
  33. * @return mixed the function result, or false on error.
  34. */
  35. function call_user_func ($function, $parameter = null, $_ = null) {}
  36. /**
  37. * (PHP 4 &gt;= 4.0.4, PHP 5)<br/>
  38. * Call a user function given with an array of parameters
  39. * @link http://php.net/manual/en/function.call-user-func-array.php
  40. * @param callback $function <p>
  41. * The function to be called.
  42. * </p>
  43. * @param array $param_arr <p>
  44. * The parameters to be passed to the function, as an indexed array.
  45. * </p>
  46. * @return mixed the function result, or false on error.
  47. */
  48. function call_user_func_array ($function, array $param_arr) {}
  49. /**
  50. * (PHP 4, PHP 5)<br/>
  51. * Call a user method on an specific object
  52. * @link http://php.net/manual/en/function.call-user-method.php
  53. * @deprecated since 5.3.0, use call_user_func() instead
  54. * @param string $method_name
  55. * @param object $obj
  56. * @param mixed $parameter [optional]
  57. * @param mixed $_ [optional]
  58. * @return mixed
  59. */
  60. function call_user_method ($method_name, &$obj, $parameter = null, $_ = null) {}
  61. /**
  62. * (PHP 4 &gt;= 4.0.5, PHP 5)<br/>
  63. * Call a user method given with an array of parameters
  64. * @link http://php.net/manual/en/function.call-user-method-array.php
  65. * @deprecated since 5.3.0, use call_user_func_array() instead
  66. * @param string $method_name
  67. * @param object $obj
  68. * @param array $params
  69. * @return mixed
  70. */
  71. function call_user_method_array ($method_name, &$obj, array $params) {}
  72. /**
  73. * (PHP 5 &gt;= 5.3.0)<br/>
  74. * Call a static method
  75. * @link http://php.net/manual/en/function.forward-static-call.php
  76. * @param callback $function <p>
  77. * The function or method to be called. This parameter may be an array,
  78. * with the name of the class, and the method, or a string, with a function
  79. * name.
  80. * </p>
  81. * @param mixed $parameter [optional] <p>
  82. * Zero or more parameters to be passed to the function.
  83. * </p>
  84. * @param mixed $_ [optional]
  85. * @return mixed the function result, or false on error.
  86. */
  87. function forward_static_call ($function, $parameter = null, $_ = null) {}
  88. /**
  89. * (PHP 5 &gt;= 5.3.0)<br/>
  90. * Call a static method and pass the arguments as array
  91. * @link http://php.net/manual/en/function.forward-static-call-array.php
  92. * @param callback $function <p>
  93. * The function or method to be called. This parameter may be an &array;,
  94. * with the name of the class, and the method, or a &string;, with a function
  95. * name.
  96. * </p>
  97. * @param array $parameters [optional]
  98. * @return mixed the function result, or false on error.
  99. */
  100. function forward_static_call_array ($function, array $parameters = null) {}
  101. /**
  102. * (PHP 4, PHP 5)<br/>
  103. * Generates a storable representation of a value
  104. * @link http://php.net/manual/en/function.serialize.php
  105. * @param mixed $value <p>
  106. * The value to be serialized. serialize
  107. * handles all types, except the resource-type.
  108. * You can even serialize arrays that contain
  109. * references to itself. Circular references inside the array/object you
  110. * are serializing will also be stored. Any other
  111. * reference will be lost.
  112. * </p>
  113. * <p>
  114. * When serializing objects, PHP will attempt to call the member function
  115. * __sleep prior to serialization.
  116. * This is to allow the object to do any last minute clean-up, etc. prior
  117. * to being serialized. Likewise, when the object is restored using
  118. * unserialize the __wakeup member function is called.
  119. * </p>
  120. * <p>
  121. * Object's private members have the class name prepended to the member
  122. * name; protected members have a '*' prepended to the member name.
  123. * These prepended values have null bytes on either side.
  124. * </p>
  125. * @return string a string containing a byte-stream representation of
  126. * value that can be stored anywhere.
  127. */
  128. function serialize ($value) {}
  129. /**
  130. * (PHP 4, PHP 5)<br/>
  131. * Creates a PHP value from a stored representation
  132. * @link http://php.net/manual/en/function.unserialize.php
  133. * @param string $str <p>
  134. * The serialized string.
  135. * </p>
  136. * <p>
  137. * If the variable being unserialized is an object, after successfully
  138. * reconstructing the object PHP will automatically attempt to call the
  139. * __wakeup member function (if it exists).
  140. * </p>
  141. * <p>
  142. * unserialize_callback_func directive
  143. * <p>
  144. * It's possible to set a callback-function which will be called,
  145. * if an undefined class should be instantiated during unserializing.
  146. * (to prevent getting an incomplete object "__PHP_Incomplete_Class".)
  147. * Use your &php.ini;, ini_set or &htaccess;
  148. * to define 'unserialize_callback_func'. Everytime an undefined class
  149. * should be instantiated, it'll be called. To disable this feature just
  150. * empty this setting.
  151. * </p>
  152. * </p>
  153. * @return mixed The converted value is returned, and can be a boolean,
  154. * integer, float, string,
  155. * array or object.
  156. * </p>
  157. * <p>
  158. * In case the passed string is not unserializeable, false is returned and
  159. * E_NOTICE is issued.
  160. */
  161. function unserialize ($str) {}
  162. /**
  163. * (PHP 4, PHP 5)<br/>
  164. * Dumps information about a variable
  165. * @link http://php.net/manual/en/function.var-dump.php
  166. * @param mixed $expression <p>
  167. * The variable you want to export.
  168. * </p>
  169. * @param mixed $expression [optional]
  170. * @return void
  171. */
  172. function var_dump ($expression, $expression = null) {}
  173. /**
  174. * (PHP 4 &gt;= 4.2.0, PHP 5)<br/>
  175. * Outputs or returns a parsable string representation of a variable
  176. * @link http://php.net/manual/en/function.var-export.php
  177. * @param mixed $expression <p>
  178. * The variable you want to export.
  179. * </p>
  180. * @param bool $return [optional] <p>
  181. * If used and set to true, var_export will return
  182. * the variable representation instead of outputing it.
  183. * </p>
  184. * &note.uses-ob;
  185. * @return mixed the variable representation when the return
  186. * parameter is used and evaluates to true. Otherwise, this function will
  187. * return &null;.
  188. */
  189. function var_export ($expression, $return = null) {}
  190. /**
  191. * (PHP 4 &gt;= 4.2.0, PHP 5)<br/>
  192. * Dumps a string representation of an internal zend value to output
  193. * @link http://php.net/manual/en/function.debug-zval-dump.php
  194. * @param mixed $variable <p>
  195. * The variable being evaluated.
  196. * </p>
  197. * @return void
  198. */
  199. function debug_zval_dump ($variable) {}
  200. /**
  201. * (PHP 4, PHP 5)<br/>
  202. * Prints human-readable information about a variable
  203. * @link http://php.net/manual/en/function.print-r.php
  204. * @param mixed $expression <p>
  205. * The expression to be printed.
  206. * </p>
  207. * @param bool $return [optional] <p>
  208. * If you would like to capture the output of print_r,
  209. * use the return parameter. If this parameter is set
  210. * to true, print_r will return its output, instead of
  211. * printing it (which it does by default).
  212. * </p>
  213. * @return mixed If given a string, integer or float,
  214. * the value itself will be printed. If given an array, values
  215. * will be presented in a format that shows keys and elements. Similar
  216. * notation is used for objects.
  217. */
  218. function print_r ($expression, $return = null) {}
  219. /**
  220. * (PHP 4 &gt;= 4.3.2, PHP 5)<br/>
  221. * Returns the amount of memory allocated to PHP
  222. * @link http://php.net/manual/en/function.memory-get-usage.php
  223. * @param bool $real_usage [optional] <p>
  224. * Set this to true to get the real size of memory allocated from
  225. * system. If not set or false only the memory used by
  226. * emalloc() is reported.
  227. * </p>
  228. * @return int the memory amount in bytes.
  229. */
  230. function memory_get_usage ($real_usage = null) {}
  231. /**
  232. * (PHP 5 &gt;= 5.2.0)<br/>
  233. * Returns the peak of memory allocated by PHP
  234. * @link http://php.net/manual/en/function.memory-get-peak-usage.php
  235. * @param bool $real_usage [optional] <p>
  236. * Set this to true to get the real size of memory allocated from
  237. * system. If not set or false only the memory used by
  238. * emalloc() is reported.
  239. * </p>
  240. * @return int the memory peak in bytes.
  241. */
  242. function memory_get_peak_usage ($real_usage = null) {}
  243. /**
  244. * (PHP 4, PHP 5)<br/>
  245. * Register a function for execution on shutdown
  246. * @link http://php.net/manual/en/function.register-shutdown-function.php
  247. * @param callback $function <p>
  248. * The shutdown function to register.
  249. * </p>
  250. * <p>
  251. * The shutdown functions are called as the part of the request so that
  252. * it's possible to send the output from them. There is currently no way
  253. * to process the data with output buffering functions in the shutdown
  254. * function.
  255. * </p>
  256. * <p>
  257. * Shutdown functions are called after closing all opened output buffers
  258. * thus, for example, its output will not be compressed if zlib.output_compression is
  259. * enabled.
  260. * </p>
  261. * @param mixed $parameter [optional] <p>
  262. * It is possible to pass parameters to the shutdown function by passing
  263. * additional parameters.
  264. * </p>
  265. * @param mixed $_ [optional]
  266. * @return void
  267. */
  268. function register_shutdown_function ($function, $parameter = null, $_ = null) {}
  269. /**
  270. * (PHP 4 &gt;= 4.0.3, PHP 5)<br/>
  271. * Register a function for execution on each tick
  272. * @link http://php.net/manual/en/function.register-tick-function.php
  273. * @param callback $function <p>
  274. * The function name as a string, or an array consisting of an object and
  275. * a method.
  276. * </p>
  277. * @param mixed $arg [optional] <p>
  278. * </p>
  279. * @param mixed $_ [optional]
  280. * @return bool Returns true on success or false on failure.
  281. */
  282. function register_tick_function ($function, $arg = null, $_ = null) {}
  283. /**
  284. * (PHP 4 &gt;= 4.0.3, PHP 5)<br/>
  285. * De-register a function for execution on each tick
  286. * @link http://php.net/manual/en/function.unregister-tick-function.php
  287. * @param string $function_name <p>
  288. * The function name, as a string.
  289. * </p>
  290. * @return void
  291. */
  292. function unregister_tick_function ($function_name) {}
  293. /**
  294. * (PHP 4, PHP 5)<br/>
  295. * Syntax highlighting of a file
  296. * @link http://php.net/manual/en/function.highlight-file.php
  297. * @param string $filename <p>
  298. * Path to the PHP file to be highlighted.
  299. * </p>
  300. * @param bool $return [optional] <p>
  301. * Set this parameter to true to make this function return the
  302. * highlighted code.
  303. * </p>
  304. * @return mixed If return is set to true, returns the highlighted
  305. * code as a string instead of printing it out. Otherwise, it will return
  306. * true on success, false on failure.
  307. */
  308. function highlight_file ($filename, $return = null) {}
  309. /**
  310. * (PHP 4, PHP 5)<br/>
  311. * &Alias; <function>highlight_file</function>
  312. * @link http://php.net/manual/en/function.show-source.php
  313. * @param $file_name
  314. * @param $return [optional]
  315. */
  316. function show_source ($file_name, $return) {}
  317. /**
  318. * (PHP 4, PHP 5)<br/>
  319. * Syntax highlighting of a string
  320. * @link http://php.net/manual/en/function.highlight-string.php
  321. * @param string $str <p>
  322. * The PHP code to be highlighted. This should include the opening tag.
  323. * </p>
  324. * @param bool $return [optional] <p>
  325. * Set this parameter to true to make this function return the
  326. * highlighted code.
  327. * </p>
  328. * @return mixed If return is set to true, returns the highlighted
  329. * code as a string instead of printing it out. Otherwise, it will return
  330. * true on success, false on failure.
  331. */
  332. function highlight_string ($str, $return = null) {}
  333. /**
  334. * (PHP 5)<br/>
  335. * Return source with stripped comments and whitespace
  336. * @link http://php.net/manual/en/function.php-strip-whitespace.php
  337. * @param string $filename <p>
  338. * Path to the PHP file.
  339. * </p>
  340. * @return string The stripped source code will be returned on success, or an empty string
  341. * on failure.
  342. * </p>
  343. * <p>
  344. * This function works as described as of PHP 5.0.1. Before this it would
  345. * only return an empty string. For more information on this bug and its
  346. * prior behavior, see bug report
  347. * #29606.
  348. */
  349. function php_strip_whitespace ($filename) {}
  350. /**
  351. * (PHP 4, PHP 5)<br/>
  352. * Gets the value of a configuration option
  353. * @link http://php.net/manual/en/function.ini-get.php
  354. * @param string $varname <p>
  355. * The configuration option name.
  356. * </p>
  357. * @return string the value of the configuration option as a string on success, or
  358. * an empty string on failure or for null values.
  359. */
  360. function ini_get ($varname) {}
  361. /**
  362. * (PHP 4 &gt;= 4.2.0, PHP 5)<br/>
  363. * Gets all configuration options
  364. * @link http://php.net/manual/en/function.ini-get-all.php
  365. * @param string $extension [optional] <p>
  366. * An optional extension name. If set, the function return only options
  367. * specific for that extension.
  368. * </p>
  369. * @param bool $details [optional] <p>
  370. * Retrieve details settings or only the current value for each setting.
  371. * Default is true (retrieve details).
  372. * </p>
  373. * @return array an associative array with directive name as the array key.
  374. * </p>
  375. * <p>
  376. * When details is true (default) the array will
  377. * contain global_value (set in
  378. * &php.ini;), local_value (perhaps set with
  379. * ini_set or &htaccess;), and
  380. * access (the access level).
  381. * </p>
  382. * <p>
  383. * When details is false the value will be the
  384. * current value of the option.
  385. * </p>
  386. * <p>
  387. * See the manual section
  388. * for information on what access levels mean.
  389. * </p>
  390. * <p>
  391. * It's possible for a directive to have multiple access levels, which is
  392. * why access shows the appropriate bitmask values.
  393. */
  394. function ini_get_all ($extension = null, $details = null) {}
  395. /**
  396. * (PHP 4, PHP 5)<br/>
  397. * Sets the value of a configuration option
  398. * @link http://php.net/manual/en/function.ini-set.php
  399. * @param string $varname <p>
  400. * </p>
  401. * <p>
  402. * Not all the available options can be changed using
  403. * ini_set. There is a list of all available options
  404. * in the appendix.
  405. * </p>
  406. * @param string $newvalue <p>
  407. * The new value for the option.
  408. * </p>
  409. * @return string the old value on success, false on failure.
  410. */
  411. function ini_set ($varname, $newvalue) {}
  412. /**
  413. * (PHP 4, PHP 5)<br/>
  414. * &Alias; <function>ini_set</function>
  415. * @link http://php.net/manual/en/function.ini-alter.php
  416. * @param $varname
  417. * @param $newvalue
  418. */
  419. function ini_alter ($varname, $newvalue) {}
  420. /**
  421. * (PHP 4, PHP 5)<br/>
  422. * Restores the value of a configuration option
  423. * @link http://php.net/manual/en/function.ini-restore.php
  424. * @param string $varname <p>
  425. * The configuration option name.
  426. * </p>
  427. * @return void
  428. */
  429. function ini_restore ($varname) {}
  430. /**
  431. * (PHP 4 &gt;= 4.3.0, PHP 5)<br/>
  432. * Gets the current include_path configuration option
  433. * @link http://php.net/manual/en/function.get-include-path.php
  434. * @return string the path, as a string.
  435. */
  436. function get_include_path () {}
  437. /**
  438. * (PHP 4 &gt;= 4.3.0, PHP 5)<br/>
  439. * Sets the include_path configuration option
  440. * @link http://php.net/manual/en/function.set-include-path.php
  441. * @param string $new_include_path <p>
  442. * The new value for the include_path
  443. * </p>
  444. * @return string the old include_path on
  445. * success&return.falseforfailure;.
  446. */
  447. function set_include_path ($new_include_path) {}
  448. /**
  449. * (PHP 4 &gt;= 4.3.0, PHP 5)<br/>
  450. * Restores the value of the include_path configuration option
  451. * @link http://php.net/manual/en/function.restore-include-path.php
  452. * @return void
  453. */
  454. function restore_include_path () {}
  455. /**
  456. * (PHP 4, PHP 5)<br/>
  457. * Send a cookie
  458. * @link http://php.net/manual/en/function.setcookie.php
  459. * @param string $name <p>
  460. * The name of the cookie.
  461. * </p>
  462. * @param string $value [optional] <p>
  463. * The value of the cookie. This value is stored on the clients
  464. * computer; do not store sensitive information.
  465. * Assuming the name is 'cookiename', this
  466. * value is retrieved through $_COOKIE['cookiename']
  467. * </p>
  468. * @param int $expire [optional] <p>
  469. * The time the cookie expires. This is a Unix timestamp so is
  470. * in number of seconds since the epoch. In other words, you'll
  471. * most likely set this with the time function
  472. * plus the number of seconds before you want it to expire. Or
  473. * you might use mktime.
  474. * time()+60*60*24*30 will set the cookie to
  475. * expire in 30 days. If set to 0, or omitted, the cookie will expire at
  476. * the end of the session (when the browser closes).
  477. * </p>
  478. * <p>
  479. * <p>
  480. * You may notice the expire parameter takes on a
  481. * Unix timestamp, as opposed to the date format Wdy, DD-Mon-YYYY
  482. * HH:MM:SS GMT, this is because PHP does this conversion
  483. * internally.
  484. * </p>
  485. * <p>
  486. * expire is compared to the client's time which can
  487. * differ from server's time.
  488. * </p>
  489. * </p>
  490. * @param string $path [optional] <p>
  491. * The path on the server in which the cookie will be available on.
  492. * If set to '/', the cookie will be available
  493. * within the entire domain. If set to
  494. * '/foo/', the cookie will only be available
  495. * within the /foo/ directory and all
  496. * sub-directories such as /foo/bar/ of
  497. * domain. The default value is the
  498. * current directory that the cookie is being set in.
  499. * </p>
  500. * @param string $domain [optional] <p>
  501. * The domain that the cookie is available.
  502. * To make the cookie available on all subdomains of example.com
  503. * then you'd set it to '.example.com'. The
  504. * . is not required but makes it compatible
  505. * with more browsers. Setting it to www.example.com
  506. * will make the cookie only available in the www
  507. * subdomain. Refer to tail matching in the
  508. * spec for details.
  509. * </p>
  510. * @param bool $secure [optional] <p>
  511. * Indicates that the cookie should only be transmitted over a
  512. * secure HTTPS connection from the client. When set to true, the
  513. * cookie will only be set if a secure connection exists.
  514. * On the server-side, it's on the programmer to send this
  515. * kind of cookie only on secure connection (e.g. with respect to
  516. * $_SERVER["HTTPS"]).
  517. * </p>
  518. * @param bool $httponly [optional] <p>
  519. * When true the cookie will be made accessible only through the HTTP
  520. * protocol. This means that the cookie won't be accessible by
  521. * scripting languages, such as JavaScript. This setting can effectively
  522. * help to reduce identity theft through XSS attacks (although it is
  523. * not supported by all browsers). Added in PHP 5.2.0.
  524. * true or false
  525. * </p>
  526. * @return bool If output exists prior to calling this function,
  527. * setcookie will fail and return false. If
  528. * setcookie successfully runs, it will return true.
  529. * This does not indicate whether the user accepted the cookie.
  530. */
  531. function setcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  532. /**
  533. * (PHP 5)<br/>
  534. * Send a cookie without urlencoding the cookie value
  535. * @link http://php.net/manual/en/function.setrawcookie.php
  536. * @param string $name
  537. * @param string $value [optional]
  538. * @param int $expire [optional]
  539. * @param string $path [optional]
  540. * @param string $domain [optional]
  541. * @param bool $secure [optional]
  542. * @param bool $httponly [optional]
  543. * @return bool Returns true on success or false on failure.
  544. */
  545. function setrawcookie ($name, $value = null, $expire = null, $path = null, $domain = null, $secure = null, $httponly = null) {}
  546. /**
  547. * (PHP 4, PHP 5)<br/>
  548. * Send a raw HTTP header
  549. * @link http://php.net/manual/en/function.header.php
  550. * @param string $string <p>
  551. * The header string.
  552. * </p>
  553. * <p>
  554. * There are two special-case header calls. The first is a header
  555. * that starts with the string "HTTP/" (case is not
  556. * significant), which will be used to figure out the HTTP status
  557. * code to send. For example, if you have configured Apache to
  558. * use a PHP script to handle requests for missing files (using
  559. * the ErrorDocument directive), you may want to
  560. * make sure that your script generates the proper status code.
  561. * </p>
  562. * <p>
  563. * ]]>
  564. * </p>
  565. * <p>
  566. * The second special case is the "Location:" header. Not only does
  567. * it send this header back to the browser, but it also returns a
  568. * REDIRECT (302) status code to the browser
  569. * unless the 201 or
  570. * a 3xx status code has already been set.
  571. * </p>
  572. * <p>
  573. * ]]>
  574. * </p>
  575. * @param bool $replace [optional] <p>
  576. * The optional replace parameter indicates
  577. * whether the header should replace a previous similar header, or
  578. * add a second header of the same type. By default it will replace,
  579. * but if you pass in false as the second argument you can force
  580. * multiple headers of the same type. For example:
  581. * </p>
  582. * <p>
  583. * ]]>
  584. * </p>
  585. * @param int $http_response_code [optional] <p>
  586. * Forces the HTTP response code to the specified value.
  587. * </p>
  588. * @return void
  589. */
  590. function header ($string, $replace = null, $http_response_code = null) {}
  591. /**
  592. * (PHP 5 &gt;= 5.3.0)<br/>
  593. * Remove previously set headers
  594. * @link http://php.net/manual/en/function.header-remove.php
  595. * @param string $name [optional] <p>
  596. * The header name to be removed.
  597. * </p>
  598. * This parameter is case-insensitive.
  599. * @return void
  600. */
  601. function header_remove ($name = null) {}
  602. /**
  603. * (PHP 4, PHP 5)<br/>
  604. * Checks if or where headers have been sent
  605. * @link http://php.net/manual/en/function.headers-sent.php
  606. * @param string $file [optional] <p>
  607. * If the optional file and
  608. * line parameters are set,
  609. * headers_sent will put the PHP source file name
  610. * and line number where output started in the file
  611. * and line variables.
  612. * </p>
  613. * @param int $line [optional] <p>
  614. * The line number where the output started.
  615. * </p>
  616. * @return bool headers_sent will return false if no HTTP headers
  617. * have already been sent or true otherwise.
  618. */
  619. function headers_sent (&$file = null, &$line = null) {}
  620. /**
  621. * (PHP 5)<br/>
  622. * Returns a list of response headers sent (or ready to send)
  623. * @link http://php.net/manual/en/function.headers-list.php
  624. * @return array a numerically indexed array of headers.
  625. */
  626. function headers_list () {}
  627. /**
  628. * (PHP 4, PHP 5)<br/>
  629. * Check whether client disconnected
  630. * @link http://php.net/manual/en/function.connection-aborted.php
  631. * @return int 1 if client disconnected, 0 otherwise.
  632. */
  633. function connection_aborted () {}
  634. /**
  635. * (PHP 4, PHP 5)<br/>
  636. * Returns connection status bitfield
  637. * @link http://php.net/manual/en/function.connection-status.php
  638. * @return int the connection status bitfield, which can be used against the
  639. * CONNECTION_XXX constants to determine the connection
  640. * status.
  641. */
  642. function connection_status () {}
  643. /**
  644. * (PHP 4, PHP 5)<br/>
  645. * Set whether a client disconnect should abort script execution
  646. * @link http://php.net/manual/en/function.ignore-user-abort.php
  647. * @param string $value [optional] <p>
  648. * If set, this function will set the ignore_user_abort ini setting
  649. * to the given value. If not, this function will
  650. * only return the previous setting without changing it.
  651. * </p>
  652. * @return int the previous setting, as an integer.
  653. */
  654. function ignore_user_abort ($value = null) {}
  655. /**
  656. * (PHP 4, PHP 5)<br/>
  657. * Parse a configuration file
  658. * @link http://php.net/manual/en/function.parse-ini-file.php
  659. * @param string $filename <p>
  660. * The filename of the ini file being parsed.
  661. * </p>
  662. * @param bool $process_sections [optional] <p>
  663. * By setting the process_sections
  664. * parameter to true, you get a multidimensional array, with
  665. * the section names and settings included. The default
  666. * for process_sections is false
  667. * </p>
  668. * @param int $scanner_mode [optional] <p>
  669. * Can either be INI_SCANNER_NORMAL (default) or
  670. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  671. * is supplied, then option values will not be parsed.
  672. * </p>
  673. * @return array The settings are returned as an associative array on success,
  674. * and false on failure.
  675. */
  676. function parse_ini_file ($filename, $process_sections = null, $scanner_mode = null) {}
  677. /**
  678. * (PHP 5 &gt;= 5.3.0)<br/>
  679. * Parse a configuration string
  680. * @link http://php.net/manual/en/function.parse-ini-string.php
  681. * @param string $ini <p>
  682. * The contents of the ini file being parsed.
  683. * </p>
  684. * @param bool $process_sections [optional] <p>
  685. * By setting the process_sections
  686. * parameter to true, you get a multidimensional array, with
  687. * the section names and settings included. The default
  688. * for process_sections is false
  689. * </p>
  690. * @param int $scanner_mode [optional] <p>
  691. * Can either be INI_SCANNER_NORMAL (default) or
  692. * INI_SCANNER_RAW. If INI_SCANNER_RAW
  693. * is supplied, then option values will not be parsed.
  694. * </p>
  695. * @return array The settings are returned as an associative array on success,
  696. * and false on failure.
  697. */
  698. function parse_ini_string ($ini, $process_sections = null, $scanner_mode = null) {}
  699. /**
  700. * (PHP 4 &gt;= 4.0.3, PHP 5)<br/>
  701. * Tells whether the file was uploaded via HTTP POST
  702. * @link http://php.net/manual/en/function.is-uploaded-file.php
  703. * @param string $filename <p>
  704. * The filename being checked.
  705. * </p>
  706. * @return bool Returns true on success or false on failure.
  707. */
  708. function is_uploaded_file ($filename) {}
  709. /**
  710. * (PHP 4 &gt;= 4.0.3, PHP 5)<br/>
  711. * Moves an uploaded file to a new location
  712. * @link http://php.net/manual/en/function.move-uploaded-file.php
  713. * @param string $filename <p>
  714. * The filename of the uploaded file.
  715. * </p>
  716. * @param string $destination <p>
  717. * The destination of the moved file.
  718. * </p>
  719. * @return bool If filename is not a valid upload file,
  720. * then no action will occur, and
  721. * move_uploaded_file will return
  722. * false.
  723. * </p>
  724. * <p>
  725. * If filename is a valid upload file, but
  726. * cannot be moved for some reason, no action will occur, and
  727. * move_uploaded_file will return
  728. * false. Additionally, a warning will be issued.
  729. */
  730. function move_uploaded_file ($filename, $destination) {}
  731. /**
  732. * (PHP 4, PHP 5)<br/>
  733. * Get the Internet host name corresponding to a given IP address
  734. * @link http://php.net/manual/en/function.gethostbyaddr.php
  735. * @param string $ip_address <p>
  736. * The host IP address.
  737. * </p>
  738. * @return string the host name or the unmodified ip_address
  739. * on failure.
  740. */
  741. function gethostbyaddr ($ip_address) {}
  742. /**
  743. * (PHP 4, PHP 5)<br/>
  744. * Get the IPv4 address corresponding to a given Internet host name
  745. * @link http://php.net/manual/en/function.gethostbyname.php
  746. * @param string $hostname <p>
  747. * The host name.
  748. * </p>
  749. * @return string the IPv4 address or a string containing the unmodified
  750. * hostname on failure.
  751. */
  752. function gethostbyname ($hostname) {}
  753. /**
  754. * (PHP 4, PHP 5)<br/>
  755. * Get a list of IPv4 addresses corresponding to a given Internet host
  756. name
  757. * @link http://php.net/manual/en/function.gethostbynamel.php
  758. * @param string $hostname <p>
  759. * The host name.
  760. * </p>
  761. * @return array an array of IPv4 addresses or false if
  762. * hostname could not be resolved.
  763. */
  764. function gethostbynamel ($hostname) {}
  765. /**
  766. * (PHP &gt;= 5.3.0)<br/>
  767. * Gets the host name
  768. * @link http://php.net/manual/en/function.gethostname.php
  769. * @return string a string with the hostname on success, otherwise false is
  770. * returned.
  771. */
  772. function gethostname () {}
  773. /**
  774. * (PHP 5)<br/>
  775. * &Alias; <function>checkdnsrr</function>
  776. * @link http://php.net/manual/en/function.dns-check-record.php
  777. * @param $host
  778. * @param $type [optional]
  779. */
  780. function dns_check_record ($host, $type) {}
  781. /**
  782. * (PHP 4, PHP 5)<br/>
  783. * Check DNS records corresponding to a given Internet host name or IP address
  784. * @link http://php.net/manual/en/function.checkdnsrr.php
  785. * @param string $host <p>
  786. * host may either be the IP address in
  787. * dotted-quad notation or the host name.
  788. * </p>
  789. * @param string $type [optional] <p>
  790. * type may be any one of: A, MX, NS, SOA,
  791. * PTR, CNAME, AAAA, A6, SRV, NAPTR, TXT or ANY.
  792. * </p>
  793. * @return bool true if any records are found; returns false if no records
  794. * were found or if an error occurred.
  795. */
  796. function checkdnsrr ($host, $type = null) {}
  797. /**
  798. * (PHP 5)<br/>
  799. * &Alias; <function>getmxrr</function>
  800. * @link http://php.net/manual/en/function.dns-get-mx.php
  801. * @param $hostname
  802. * @param $mxhosts
  803. * @param $weight [optional]
  804. */
  805. function dns_get_mx ($hostname, &$mxhosts, &$weight) {}
  806. /**
  807. * (PHP 4, PHP 5)<br/>
  808. * Get MX records corresponding to a given Internet host name
  809. * @link http://php.net/manual/en/function.getmxrr.php
  810. * @param string $hostname <p>
  811. * The Internet host name.
  812. * </p>
  813. * @param array $mxhosts <p>
  814. * A list of the MX records found is placed into the array
  815. * mxhosts.
  816. * </p>
  817. * @param array $weight [optional] <p>
  818. * If the weight array is given, it will be filled
  819. * with the weight information gathered.
  820. * </p>
  821. * @return bool true if any records are found; returns false if no records
  822. * were found or if an error occurred.
  823. */
  824. function getmxrr ($hostname, array &$mxhosts, array &$weight = null) {}
  825. /**
  826. * (PHP 5)<br/>
  827. * Fetch DNS Resource Records associated with a hostname
  828. * @link http://php.net/manual/en/function.dns-get-record.php
  829. * @param string $hostname <p>
  830. * hostname should be a valid DNS hostname such
  831. * as "www.example.com". Reverse lookups can be generated
  832. * using in-addr.arpa notation, but
  833. * gethostbyaddr is more suitable for
  834. * the majority of reverse lookups.
  835. * </p>
  836. * <p>
  837. * Per DNS standards, email addresses are given in user.host format (for
  838. * example: hostmaster.example.com as opposed to hostmaster@example.com),
  839. * be sure to check this value and modify if necessary before using it
  840. * with a functions such as mail.
  841. * </p>
  842. * @param int $type [optional] <p>
  843. * By default, dns_get_record will search for any
  844. * resource records associated with hostname.
  845. * To limit the query, specify the optional type
  846. * parameter. May be any one of the following:
  847. * DNS_A, DNS_CNAME,
  848. * DNS_HINFO, DNS_MX,
  849. * DNS_NS, DNS_PTR,
  850. * DNS_SOA, DNS_TXT,
  851. * DNS_AAAA, DNS_SRV,
  852. * DNS_NAPTR, DNS_A6,
  853. * DNS_ALL or DNS_ANY.
  854. * </p>
  855. * <p>
  856. * Because of eccentricities in the performance of libresolv
  857. * between platforms, DNS_ANY will not
  858. * always return every record, the slower DNS_ALL
  859. * will collect all records more reliably.
  860. * </p>
  861. * @param array $authns [optional] <p>
  862. * Passed by reference and, if given, will be populated with Resource
  863. * Records for the Authoritative Name Servers.
  864. * </p>
  865. * @param array $addtl [optional] <p>
  866. * Passed by reference and, if given, will be populated with any
  867. * Additional Records.
  868. * </p>
  869. * @return array This function returns an array of associative arrays. Each associative array contains
  870. * at minimum the following keys:
  871. * <table>
  872. * Basic DNS attributes
  873. * <tr valign="top">
  874. * <td>Attribute</td>
  875. * <td>Meaning</td>
  876. * </tr>
  877. * <tr valign="top">
  878. * <td>host</td>
  879. * <td>
  880. * The record in the DNS namespace to which the rest of the associated data refers.
  881. * </td>
  882. * </tr>
  883. * <tr valign="top">
  884. * <td>class</td>
  885. * <td>
  886. * dns_get_record only returns Internet class records and as
  887. * such this parameter will always return IN.
  888. * </td>
  889. * </tr>
  890. * <tr valign="top">
  891. * <td>type</td>
  892. * <td>
  893. * String containing the record type. Additional attributes will also be contained
  894. * in the resulting array dependant on the value of type. See table below.
  895. * </td>
  896. * </tr>
  897. * <tr valign="top">
  898. * <td>ttl</td>
  899. * <td>
  900. * "Time To Live" remaining for this record. This will not equal
  901. * the record's original ttl, but will rather equal the original ttl minus whatever
  902. * length of time has passed since the authoritative name server was queried.
  903. * </td>
  904. * </tr>
  905. * </table>
  906. * </p>
  907. * <p>
  908. * <table>
  909. * Other keys in associative arrays dependant on 'type'
  910. * <tr valign="top">
  911. * <td>Type</td>
  912. * <td>Extra Columns</td>
  913. * </tr>
  914. * <tr valign="top">
  915. * <td>A</td>
  916. * <td>
  917. * ip: An IPv4 addresses in dotted decimal notation.
  918. * </td>
  919. * </tr>
  920. * <tr valign="top">
  921. * <td>MX</td>
  922. * <td>
  923. * pri: Priority of mail exchanger.
  924. * Lower numbers indicate greater priority.
  925. * target: FQDN of the mail exchanger.
  926. * See also dns_get_mx.
  927. * </td>
  928. * </tr>
  929. * <tr valign="top">
  930. * <td>CNAME</td>
  931. * <td>
  932. * target: FQDN of location in DNS namespace to which
  933. * the record is aliased.
  934. * </td>
  935. * </tr>
  936. * <tr valign="top">
  937. * <td>NS</td>
  938. * <td>
  939. * target: FQDN of the name server which is authoritative
  940. * for this hostname.
  941. * </td>
  942. * </tr>
  943. * <tr valign="top">
  944. * <td>PTR</td>
  945. * <td>
  946. * target: Location within the DNS namespace to which
  947. * this record points.
  948. * </td>
  949. * </tr>
  950. * <tr valign="top">
  951. * <td>TXT</td>
  952. * <td>
  953. * txt: Arbitrary string data associated with this record.
  954. * </td>
  955. * </tr>
  956. * <tr valign="top">
  957. * <td>HINFO</td>
  958. * <td>
  959. * cpu: IANA number designating the CPU of the machine
  960. * referenced by this record.
  961. * os: IANA number designating the Operating System on
  962. * the machine referenced by this record.
  963. * See IANA's Operating System
  964. * Names for the meaning of these values.
  965. * </td>
  966. * </tr>
  967. * <tr valign="top">
  968. * <td>SOA</td>
  969. * <td>
  970. * mname: FQDN of the machine from which the resource
  971. * records originated.
  972. * rname: Email address of the administrative contain
  973. * for this domain.
  974. * serial: Serial # of this revision of the requested
  975. * domain.
  976. * refresh: Refresh interval (seconds) secondary name
  977. * servers should use when updating remote copies of this domain.
  978. * retry: Length of time (seconds) to wait after a
  979. * failed refresh before making a second attempt.
  980. * expire: Maximum length of time (seconds) a secondary
  981. * DNS server should retain remote copies of the zone data without a
  982. * successful refresh before discarding.
  983. * minimum-ttl: Minimum length of time (seconds) a
  984. * client can continue to use a DNS resolution before it should request
  985. * a new resolution from the server. Can be overridden by individual
  986. * resource records.
  987. * </td>
  988. * </tr>
  989. * <tr valign="top">
  990. * <td>AAAA</td>
  991. * <td>
  992. * ipv6: IPv6 address
  993. * </td>
  994. * </tr>
  995. * <tr valign="top">
  996. * <td>A6(PHP &gt;= 5.1.0)</td>
  997. * <td>
  998. * masklen: Length (in bits) to inherit from the target
  999. * specified by chain.
  1000. * ipv6: Address for this specific record to merge with
  1001. * chain.
  1002. * chain: Parent record to merge with
  1003. * ipv6 data.
  1004. * </td>
  1005. * </tr>
  1006. * <tr valign="top">
  1007. * <td>SRV</td>
  1008. * <td>
  1009. * pri: (Priority) lowest priorities should be used first.
  1010. * weight: Ranking to weight which of commonly prioritized
  1011. * targets should be chosen at random.
  1012. * target and port: hostname and port
  1013. * where the requested service can be found.
  1014. * For additional information see: RFC 2782
  1015. * </td>
  1016. * </tr>
  1017. * <tr valign="top">
  1018. * <td>NAPTR</td>
  1019. * <td>
  1020. * order and pref: Equivalent to
  1021. * pri and weight above.
  1022. * flags, services, regex,
  1023. * and replacement: Parameters as defined by
  1024. * RFC 2915.
  1025. * </td>
  1026. * </tr>
  1027. * </table>
  1028. */
  1029. function dns_get_record ($hostname, $type = null, array &$authns = null, array &$addtl = null) {}
  1030. ?>