cPanel API 2 Functions - Locale::numf - Knowledgebase

Description

This function retrieves a locale's number formatting method.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Locale&cpanel_jsonapi_func=numf&number=1000.234&max_decimal_places=3

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Retrieve number formatting of locale.
$get_number_format = $cpanel->api2(
    'Locale', 'numf',
        array(
        'number'                    => '1000.234',
        'max_decimal_places'        => '3',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Retrieve number formatting of locale.
my $get_locale_direction = $cpliveapi->api2(
    'Locale', 'numf',
        array{
        'number'                    => '1000.234',
        'max_decimal_places'        => '3',
    }
 );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Output (JSON)

{

"cpanelresult": {

"apiversion": 2,

"func": "numf",

"data": [

{

"numf": "1,234"

}

],

"event": {

"result": 1

},

"module": "Locale"

}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible value
number	integer	Required The number to display in the locale's style.	Any numeric value.	1000.234
max_decimal_places	integer	The number of decimal places to display. This parameter defaults to 6.	Any integer value.	3

Parameter

Type

Description

Possible value

number

integer

Required

The number to display in the locale's style.

Any numeric value.

1000.234

max_decimal_places

integer

The number of decimal places to display.

This parameter defaults to 6.

Any integer value.

Returns

Return	Type	Description	Possible values	Example
numf	integer	The number, formatted in the user's locale's style.	Any numeric value.	1,234
reason	string	A reason for failure. Note: This function only returns a reason value if there was an error.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories