Child pages
  • cPanel API 1 Functions - LeechProtect::setup

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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


Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)None.
  • cPanel API 2 LeechProtect::setup
    Excerpt Include
    DD:cPanel API 2 Functions - LeechProtect::setupDD:
    cPanel API 2 Functions - LeechProtect::setup
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


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

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

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



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username LeechProtect setup public_html uri uri

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (HTML)
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.