Child pages
  • cPanel API 1 Functions - Fileman::getfile

Versions Compared

Key

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

Description

Excerpt

This function prints the contents of a file to the web browser.


Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledFileStorageRole
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.
$print_file_contents = $cpanel->api1('Fileman', 'getfile', array('public_html','myfile.txt')); // 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 $print_file_contents = $cpliveapi->api1('Fileman', 'getfile' ['public_html', 'myfile.txt']); # 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="Fileman::getfile ( $FORM('dir','file'))">



Expand
titleCommand Line


Code Block
cpapi1 --user=username Fileman getfile public_html myfile.txt

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput


Code Block
These are the contents of the file.




Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

The file's directory.

This value defaults to the user's /home directory.

Any valid directory, relative to the cPanel account's /home directory.public_html
filestring

Required

The file to display.

Any valid file name.myfile.txt

Returns

This function returns the file's contents.