Child pages
  • cPanel API 1 Functions - Htaccess::htdirls

Versions Compared

Key

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

Description

Excerpt

This function returns HTML to display an interface to modify the  dohtaccess.html file.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

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.
$set_index = $cpanel->api1('Htaccess','htdirls', array('directoryname','1') ); // 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 $set_index = $cpliveapi->api1('Htaccess','htdirls', ['directoryname','1'] ); # 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="Htaccess::htdirls( $FORM('dir','listtype') )">



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username Htaccess htdirls directoryname 1

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (HTML)


Code Block
linenumberstrue
<b><a href="/frontend/paper_lantern/test.html?dir=%2fhome%2fusername%2fpublic_html%2ftest"><img
 src="images/i-directory.gif" border="0"></a> <a href="/frontend/paper_lantern/test.html">/</a></b>
 <a href="/frontend/paper_lantern/test.html?dir=%2fhome%2fusername%2Fpublic_html%2f">public_html</a> / 
 <a href="dohtaccess.html?dir=%2fhome%2fusername%2Fpublic_html%2ftest%2f">test</a> / 
 <i>(Current Folder)</i>
 <br />
 <a href="/frontend/paper_lantern/test.html?dir=%2fhome%2fusername%2fpublic_html%2f"><img
 src="images/i-directory.gif" border="0"></a> <a href="/frontend/paper_lantern/test.html?dir=%2fhome%2fusername%2fpublic_html%2f"><b>Up One Level</b></a>




Parameters

ParameterTypeDescriptionPossible valuesExample

dir

string

Required

The directory to include in the listing.

A value directory name.directoryname
listtypeinteger

Required

The list type to use.

  • 1 — Print HTML that links to images/noindex.gif
  • 2 — Print HTML that links to images/leech.gif (for leech protection).
1

Returns

This function returns HTML with a summary of the changes.