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

Description

This function lists a language module system's available modules.


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=LangMods&cpanel_jsonapi_func=list_available&lang=php-pear&skip=3&want=6


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 available php-pear modules on example.com.
$get_phppear_modules = $cpliveapi->api2(
    'LangMods', 'list_available',
		array(
		'lang'			=> 'php-pear',
		'skip'			=> '3',
		'want'			=> '6',
	 )
  );


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 available php-pear modules on example.com.
my $get_phppear_modules = $cpanel->api2(
    'LangMods', 'list_available',
	{
		'lang'		=> 'php-pear',
		'skip'		=> '3',
		'want'		=> '6',
	 } 
 );


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 LangMods list_available lang=php-pear skip=3 want=6


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": "list_available",
    "data": [
      {
        "info": "Your configuration's swiss-army knife.",
        "docurl": "http://pear.php.net/package/Config/docs",
        "latest": "1.10.12",
        "installed": null,
        "module": "Config",
        "stable": "1.10.12"
      },
      {
        "info": "a lightweight and fast Config class for ini style text configuration files.",
        "docurl": "http://pear.php.net/package/Config_Lite/docs",
        "latest": "0.2.1",
        "installed": null,
        "module": "Config_Lite",
        "stable": "0.2.1"
      },
      {
        "info": "This Class allows you to easily use ANSI console colors in your application.",
        "docurl": "http://pear.php.net/package/Console_Color/docs",
        "latest": "1.0.3",
        "installed": null,
        "module": "Console_Color",
        "stable": "1.0.3"
      },
      {
        "info": "This Class allows you to easily use ANSI console colors in your application.",
        "docurl": "http://pear.php.net/package/Console_Color2/docs",
        "latest": "0.1.2",
        "installed": null,
        "module": "Console_Color2",
        "stable": "0.1.2"
      },
      {
        "info": "A full featured command line options and arguments parser",
        "docurl": "http://pear.php.net/package/Console_CommandLine/docs",
        "latest": "1.2.0",
        "installed": null,
        "module": "Console_CommandLine",
        "stable": "1.2.0"
      },
      {
        "info": "A command-line arguments parser",
        "docurl": "http://pear.php.net/package/Console_Getargs/docs",
        "latest": "1.3.5",
        "installed": null,
        "module": "Console_Getargs",
        "stable": "1.3.5"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "LangMods"
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
langstring

Required

The scripting language's short name.

An available scripting language's short name.

Note:

For a list of possible values, read our LangMods::langlist documentation.

perl
skipinteger

The number of responses to skip at the beginning of the function's output.

Use this parameter with the want parameter to paginate the function's output.

This value defaults to 0.

A positive integer.3
wantinteger

The number of responses to return in the function's output.

This value defaults to 100.

A positive integer.6

 

Returns

ReturnTypeDescriptionPossible valuesExample
infostringAny relevant information about the module..A string value.
Your configuration's swiss-army knife.
docurlstringThe system's homepage.A URL.
http://pear.php.net/package/Config/docs
lateststringThe module's latest version.A module version number.1.3.7
installedstringThe module's installed version.
  • A module version number.
  • null — The module is not installed.
1.3.3
modulestringThe module's name.A module name.
Config
stable string

The module's stable version.

A module version number.1.3.5
reasonstring

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.
resultBoolean

Whether the function succeeded.

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