Introduction

The LiveAPI PHP class is a PHP environment you can utilize within cPanel. This PHP environment provides PHP scripts with a local socket to the cPanel binary, cpsrvd.

This method prevents you from having to:

• Embed cPanel tags.
• Use cpphp or phpcp tags.
• Make remote API calls via XML or JSON APIs, as these calls require greater network overhead.

API calls are executed by the system's user and will fail if the user has insufficient permissions. The same rules apply to LiveAPI as apply to API tags or API calls made through the XML or JSON APIs.

To begin, you must ensure that your application meets the following 3 criteria:

1. You must include usr/local/cpanel/php/cpanel.php and instantiate the CPANEL object.

1. You must place your PHP script in /usr/local/cpanel/base/frontend/$THEME. Symlinks are permitted.
   • Note: You will need to replace $THEME in the example above with the name of your theme (e.g., x3 in most cases).

Synopsis

<-- SyntaxHighlightingPlugin -->

require_once "/usr/local/cpanel/php/cpanel.php";
$cpanel = new CPANEL();
$live_api_result_array = $cpanel->api2( $module, $function, array( 'key1' => 'value1', 'key2' => 'value2') );

<-- end SyntaxHighlightingPlugin -->

• Version: 2.1 — You can find this class at /usr/local/cpanel/php/cpanel.php

• Note: Old versions of this class, as well as versions of cPanel prior to 11.28, depend on /usr/local/cpanel/php/xml.php for backward compatibility.

• There are two environment variables that can affect the behavior of this class at object instantiation:
  • LIVEPHP_DEBUG_LEVEL — Enable or disable debugging (can be overridden by accessor methods set_debug()).
  • LIVEPHP_DEBUG_LOG — The absolute path and filename for a debug log. By default, a random log will be created in user's home directory (e.g., ~/.cpanel/livephp.log.$rand ) .

• N/A

• Private variables are not itemized here. See cpanel.php

• object __construct ()
• array api ( string $reqtype, string $version, string $module, string $func, mixed $args)

• boolean cpanelfeature (string $feature)
• boolean cpanelif (string $code)
• string cpanellangprint (string $key)
• string cpanelprint (string $var)

• array exec (string $code[, boolean $skip_return])
• array fetch (string $var)
• integer get_debug_level ()
• string get_debug_log ()
• mixed get_result ()
• void set_debug (integer $debug_level)

__construct()

api()

• $module (string) — The API 1 or API 2 module to execute.
• $func (string) — The API 1 or API 2 function to execute.
• $args (mixed) — Any arguments you wish to pass to the API function. API 1 arguments must be in an ordered array, while API 2 arguments are an associative array; string for non exec $reqtypes.

api1()

• $module (string) — The module's namespace (e.g., SSL).
• $func (string) — The function you wish to call (e.g., showcrt).
• $args (array) — The arguments you wish to pass to the function (e.g., array(0=>'foo.tld', 1=>0) ).
  • Note: Arguments should be passed in an ordinal array (e.g., array(0=>'funcArg1', 1=>'funcArg2')).

api2()

• $module (string) — The module's namespace (e.g., SSL).
• $func (string) — The function you wish to call (e.g., listsslitems).
• $args (array) — The arguments you wish to pass to the function (e.g., array('domains'=>'foo.tld|bar.tld', 'items'=>'key|crt') ).
  • Note: Arguments should be passed in an associative array.

cpanelfeature()

• $feature (string) — A feature name or logical expression related to a cPanel feature. For more information, visit our documentation about using cPanel feature tags.

cpanelif()

• $code (string) — A cPvar or logical test condition. For more information, please visit our documentation about conditionals.

cpanellangprint()

• $key (string) — A language key.

cpanelprint()

• $var (string) — An expression that may contain a ExpVar or text. For more information, please visit our ExpVar reference document.

end()

exec()

• $skip_return (boolean) — (optional) If set to true, this method will return nothing.

fetch()

• $var (string) — An expression that may contain an ExpVar or text. For more information, please visit our ExpVar reference document.

get_debug_log()

get_debug_level()

set_debug()

Parameters:

• $debug_level (integer) — Desired debug level.
  • 0 — disable logging. 0 is the default value.
  • 1 — Write socket transactions to the log file.

get_result()

Licensing Information