Child pages
  • cPanel API 2 Functions - LangMods::list_installed

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function lists a cPanel-supported scripting language's installed modules.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent


Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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_installed&lang=php-pear&sys=1

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Retrieve installed php-pear modules on example.com.
my $get_installed_modules = $cpliveapi->api2(
    'LangMods', 'list_installed',
		array(
		'lang'			=> 'php-pear',
		'sys'			=> '1',
	 )
  );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve installed php-pear modules on example.com.
$get_installed_modules = $cpanel->api2(
    'LangMods', 'list_installed',
	{
		'lang'		=> 'php-pear',
		'sys'		=> '1',
	 } 
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagetext
cpapi2 --user=username LangMods list_installed lang=php-pear sys=1

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "cpanelresult":{  
      "apiversion":2,
      "func":"list_installed",
      "data":[  
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/Archive_Tar/docs",
            "latest":"1.3.11",
            "installed":null,
            "module":"Archive_Tar",
            "stable":"1.3.11"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/Console_Getopt/docs",
            "latest":"1.3.1",
            "installed":null,
            "module":"Console_Getopt",
            "stable":"1.3.1"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/PEAR/docs",
            "latest":"1.9.5",
            "installed":null,
            "module":"PEAR",
            "stable":"1.9.5"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/Structures_Graph/docs",
            "latest":"1.0.4",
            "installed":null,
            "module":"Structures_Graph",
            "stable":"1.0.4"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/XML_RPC/docs",
            "latest":"1.5.5",
            "installed":null,
            "module":"XML_RPC",
            "stable":"1.5.5"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/XML_Util/docs",
            "latest":"1.2.3",
            "installed":null,
            "module":"XML_Util",
            "stable":"1.2.3"
         }
      ],
      "event":{  
         "result":1
      },
      "module":"LangMods"
   }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
langstring

Required

The scripting language's short name.

An available scripting language's short name.

Note
-titled
titleNote:

The LangMods::langlist function returns possible values.


perl
sysBoolean

Required

Whether to return the account's installed modules.

  • 1 — Return the account's installed modules.
  • 0 — Return the system's installed modules.
1

 

Returns

ReturnTypeDescriptionPossible valuesExample
infostringAny relevant information.A string value.
Stable
docurlstringThe system's homepage.A URL.
http://pear.php.net/package/Config/docs
lateststringThe module's latest version.A module version.1.2.3
installedstringThe module's installed version.
  • A version of the module.
  • null — The module is not installed.
1.2.3
modulestringThe module's name.A module name.
XML_Util
stable boolean

The module's stable version.

A module version.1.2.3
reasonstring

A reason for failure.

Note
titleNote:

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