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

Versions Compared

Key

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

 

Description

Excerpt

This function updates a specified cPanel-supported language module.

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=update&lang=php-pear&mod=Config_Lite&quiet=1

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Update Config_Lite php-pear module.
$update_module = $cpanel->api2(
    'LangMods', 'update',
		array(
			'lang'			=> 'php-pear',
			'mod'			=> 'Config_Lite'
			'quiet'			=> '1'
	 )
  );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Update Config_Lite php-pear module.
my $update_module = $cpliveapi->api2(
    'LangMods', 'update',
		{
			'lang'			=> 'php-pear',
			'mod'			=> 'Config_Lite'
			'quiet'			=> '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 udpate lang=php-pear mod=Config_Lite quiet=1

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "cpanelresult":{  
      "apiversion":2,
      "func":"update",
      "data":[  
         {  
            "status":1,
            "result":"Downloaded pear/Config_Lite within preferred state \"stable\."
         }
      ],
      "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.


php
modstring

Required

The module to update.

Any language module.Config_Lite
quietBoolean

Required

Whether to return a result value.

  • 1 — Return output.
  • 0 — Do not return output.
1

 

Returns

ReturnTypeDescriptionPossible valuesExample
status Boolean

Whether the module updated.

  • 1 — Updated.
  • 0 — Did not update.
1
resultstring

Any relevant update information.

 

A string value.
Downloaded pear/Config_Lite within preferred state \"stable\.
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