Description

This function queries values that the system in a directory's .leechprotect configuration file.


Examples




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$configure_leech = $cpanel->api1('LeechProtect','setup', array('public_html','uri','uri') ); // Call the function.

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $configure_leech = $cpliveapi->api1('LeechProtect','setup', ['public_html','uri','uri']); # Call the function.

 


<cpanel Module="LeechProtect::setup ( $FORM('dir','item','type'))">




cpapi1 --user=username LeechProtect setup public_html uri uri


This function returns output that varies dramatically based on the input parameters that you use.



Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The file's directory.

A valid directory path, relative to the user's home directory.public_html
item string

Required

The item to query in the configuration file.

 

  • email
  • kill
  • numhits
  • uri
uri
type string

Required

The function's output format.

  • html — Return HTML-encoded output.
  • uri — Return URI-encoded output.
  • check — Return checked if the value exists.
  • checkbox — Return checked if the value exists.
uri

Returns

This function's output varies, based on the type parameter's value.