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

Versions Compared

Key

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

Description

Excerpt

This function checks whether a directory contains a custom index page.

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.
$check_customindex = $cpanel->api1('Htaccess','getindex', array('directoryname','0') ); // 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 $check_customindex = $cpliveapi->api1('Htaccess','getindex', ['directoryname','0'] ); # 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::getindex( $FORM('dir','indextype') )">



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username Htaccess getindex directoryname 0

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
checked




Parameters

ParameterTypeDescriptionPossible valuesExample

dir

string

Required

The directory name.

A valid directory name.directoryname
indextypeinteger

Required

The type of indexing.

  • 0 — No indexing.
  • 1 — Standard indexing.
  • 2 — Fancy indexing.
0

Returns

This function will display checked if the directory uses the specified index type.