Description

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

Examples 




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



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

 


<cpanel Module="BoxTrapper::statusbutton()">




cpapi1 --user=username BoxTrapper statusbutton



<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.

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.