LivePHP Documentation

LivePHP 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 allows your script to make API1 and API2 calls to the local machine via the socket.

/usr/local/cpanel/php/cpanel.php is an out-of-the-box PHP class that provides common elements for this integration . API calls are executed by the system's user and may fail if asked to perform a task for which the user has insufficient permissions. The same rules apply to this method as when using API tags or API calls made via our XML API

To begin, you must ensure that you meet the following 3 criteria:

1. You must include /usr/local/cpanel/php/cpanel.php and instantiate the CPANEL object.
2. Your PHP scripts' file names must end in either .livephp or .live.php
3. You must place your PHP script in /usr/local/cpanel/base/frontend/$THEME You may also use a symlink.
   • Note: You will need to replace $THEME in the example above with your theme. (e.g. x3 in most cases)

The CPANEL PHP Class

Class Description

This class provides an interface to the local system's cPanel binary. It allows you to make API calls and use cPanel tags as described in Developer Resources. Your can make both API1 and API2 calls using this class.

• Version: 0.1 — You can find this class at /usr/local/cpanel/php/cpanel.php
• Copyright: cPanel, Inc.
• License: Modified BSD
• Note: This class depends on /usr/local/cpanel/php/xml.php.

Class Variable Summary

Public Variables

• n/a

Private Methods

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

Note: You may pass $TODO private variables here.

Class Method Summary

Public Methods

• void CPANEL ()
• array api ( string $reqtype, string $version, string $module, string $func, array $args)
• array api1 (string $module, string $func, array $args)
• array api2 (string $module, string $func, array $args)
• boolean cpanelfeature (string $expression)
• boolean cpanelif (string $expression)
• boolean cpanellangprint (string $textkey)
• boolean cpanelprint (string $expression)
• void end ()
• array exec (string $code)
• array fetch (string $code)

Private Methods

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

Class Method Details

  CPANEL =(line 36)

  api =(line 99)

Parameters:

• $reqtype (string) — The type of request. This value is usually exec.
• $version (integer) — The API version. This value is either 1 or 2.
• $module (string) — The name of the module you wish to use.
• $func (string) — The name of the function you wish to use.
• $args (array) — Any arguments you wish to pass to the API function. API 1 arguments are in ordered array keys. API 2 arguments are passed as literal array keys.

  api1 =(line 75)

Parameters:

• $module (string) — The module's namespace. (e.g. SSL)
• $func (string) — The function you wish to call. (e.g. gencrt)
• $args (array) — The arguments you wish to pass to the function. Keys must be ordered when using an API 1 function. (e.g. array(0=>'funcArg1', 1=>'funcArg2'))

  api2 =(line 79)

Parameters:

• $module (string) — The module's namespace. (e.g. SSL)
• $func (string) — The function you wish to call. (e.g. gencrt)
• $args (array) — The arguments you wish to pass to the function.
  • Note: Array keys must be literal.

  cpanelfeature =(line 87)

Parameters:

• $expression (string) — A logic expression. For more information visit our documentation here.

  cpanelif =(line 83)

Parameters:

• $expression (string) — A logic expression. For more information visit our documentation here.

  cpanellangprint =(line 95)

Parameters:

• $textkey (string) — A reference to a locale (language).

  cpanelprint =(line 91)

Parameters:

• $expression (string) — A logic expression. For more information visit our documentation here.

  end =(line 121)

  exec =(line 59)

Parameters:

• $code (string) — A cPanel tag that contains an API, ExpVar, or a Dynamic UI construct.

  fetch =(line 52)

Parameters:

• $code (string) — A cPanel tag that contains an API, ExpVar, or a Dynamic UI construct.