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

Versions Compared

Key

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

Description

Excerpt
This function returns the HTML to display a file type's icon.
Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

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.
$display_icon = $cpanel->api1('Fileman', 'fileimg', array('public_html', 'myfile.gif', '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 $display_icon = $cpliveapi->api1('Fileman', 'fileimg' ['public_html', 'myfile.gif', '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="Fileman::fileimg ( $FORM('dir','file','new'))">



Expand
titleCommand Line


Code Block
cpapi1 --user=username Fileman fileimg public_html myfile.gif 1

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (HTML)


Code Block
languagexml
linenumberstrue
<html>
 <img src="images/gnome-image-jpeg.gif" border="0" />
 </html>




Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The file's directory.

Any valid directory name.public_html
filestring

Required

The file.

Any valid filenamemyfile.tar
write_stdinBoolean

Required

Whether to replace the default HTML editor template strings with the values in the HTML editor's configuration hash.

  • 0 — Display the file's icon based on its file extension type.
  • 1 — Display the file's icon based on its MIME type.
1

 Returns

This function returns HTML to display the image.