Child pages
  • cPanel API 1 Functions - Fileman::fileimg
Skip to end of metadata
Go to start of metadata

Description

This function returns the HTML to display a file type's icon.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Important:

In cPanel & WHM version 76, the FileStorage role affects this function.

Examples


 LiveAPI PHP Class
$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.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
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.


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Fileman::fileimg ( $FORM('dir','file','new'))">
 Command Line
cpapi1 --user=username Fileman fileimg public_html myfile.gif 1


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/api/cpapi1

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