Child pages
  • cPanel API 2 Functions - Locale::numf
Skip to end of metadata
Go to start of metadata


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


Note:

 For more information, read our Calls from the WHM API documentation.

 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',
	) 
 );


Note:

For more information, read our Guide to the LiveAPI System.

 

 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',
	} 
 );


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warnings:

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

 Command Line
cpapi2 --user=username Locale numf number=1000.234 max_decimal_places=3


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "numf",
    "data": [
      {
        "numf": "1,234"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Locale"
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible value 
numberinteger

Required

The number to display in the locale's style.

Any numeric value.1000.234
max_decimal_placesinteger

The number of decimal places to display.

This parameter defaults to 6.

Any integer value.3

 

Returns

ReturnTypeDescriptionPossible valuesExample
numfinteger

The number, formatted in the user's locale's style.

Any numeric value.1,234
reasonstring

A reason for failure.

Note:

This function only returns a reasonvalue if there was an error. 

A string that describes the error.This is an error message.
resultBoolean

Whether the function succeeded.

 

  • 1 — The function succeeded.
  • 0 — The function failed.
1