xref: /PHP-7.1/ext/intl/doc/common_api.php (revision 9762609c) 
1<?php
2
3/**
4 * Handling of errors occurred in static methods
5 * when there's no object to get error code/message from.
6 *
7 * Example #1:
8 * <code>
9 * $coll = collator_create( '<bad_param>' );
10 * if( !$coll )
11 *     handle_error( intl_get_error_code() );
12 * </code>
13 *
14 * Example #2:
15 * <code>
16 * if( Collator::getAvailableLocales() === false )
17 *     show_error( intl_get_error_message() );
18 * </code>
19 */
20
21/**
22 * Get the last error code.
23 *
24 * @return int     Error code returned by the last
25 *                 API function call.
26 */
27function intl_get_error_code() {}
28
29/**
30 * Get description of the last error.
31 *
32 * @return string  Description of an error occurred in the last
33 *                 API function call.
34 */
35function intl_get_error_message() {}
36
37/**
38 * Check whether the given error code indicates failure.
39 *
40 * @param  int  $code ICU error code.
41 *
42 * @return bool true if it the code indicates some failure,
43 *              and false in case of success or a warning.
44 */
45function intl_is_failure($code) {}
46
47/**
48 * Get symbolic name for a given error code.
49 *
50 * The returned string will be the same as the name of the error code constant.
51 *
52 * @param  int       $code  ICU error code.
53 *
54 * @return string    Error code name.
55 */
56function intl_error_name($code) {}
57