Description

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

Examples




$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.



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.


<cpanel Module="Fileman::fileimg ( $FORM('dir','file','new'))">




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



<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.