Development Guides Home >> Guide to the LiveAPI System >> LiveAPI Methods
Guide to the LiveAPI System - The cpanelif() Method
The cpanelif() method is a wrapper for the cpanelif tag, which evaluates a cPanel variable or logic operator.
Example
LiveAPI PHP Class
// Check whether a mysql error message exists.
$cpanel->cpanelif ("$CPERROR{'mysql'}");LiveAPI Perl Module
# Check whether a mysql error message exists.
$cpliveapi->cpanelif("$CPERROR{'mysql'}");Parameters
| Parameter | Type | Description | Possible values | Example |
|---|---|---|---|---|
conditional |
string | A cPanel variable or logic operator. For a full list of cPanel variables and logic operators, read our Guide to cPanel Variables. |
|
$CPERROR{'mysql'} |
Returns
This method returns a Boolean value:
-
1— The cPanel variable or code evaluates to true. -
0— The cPanel variable or code evaluates to false.