Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function generates HTML for a button that enables or disables BoxTrapper.

Unable to render {include} The included page could not be found.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$boxtrapper_button = $cpanel->api1('BoxTrapper', 'statusbutton'); // Call the function.

Unable to render {include} The included page could not be found.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $boxtrapper_button = $cpliveapi->api1('BoxTrapper', 'statusbutton'); # Call the function.

Unable to render {include} The included page could not be found.

 

 cPanel Tag System (deprecated)

Unable to render {include} The included page could not be found.

<cpanel Module="BoxTrapper::statusbutton()">
 Command Line
cpapi1 --user=username BoxTrapper statusbutton

Unable to render {include} The included page could not be found.

 Output (HTML)
<input type="hidden" name="action" value="Disable">
<input type="submit" class="input-button" name="submitaction" value="Disable">

   

Parameters

This function does not accept parameters.

Returns

This function returns HTML to generate a button that changes the status of BoxTrapper for the account.

  • If BoxTrapper is currently enabled for the account, the function generates a button that disables BoxTrapper.
  • If BoxTrapper is currently disabled for the account, the function generates a button that enables BoxTrapper.

Note:

This function does not generate all of the necessary form elements to allow the button to function. It only generates the HTML for the button itself.