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

Description

This function scales a specified image.

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 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$image_scale = $cpanel->api1('ImageManager','scale',array('images','image.jpg','none','200','300','0')); // 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 $image_scale = $cpliveapi->api1('ImageManager','scale',['images','image.jpg','none','200','300','0'] ] ); # 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="ImageManager::scale($FORM('dir','file','oldimage','width','height','keepold'))">
 Command Line
cpapi1 --user=username ImageManager scale images image.jpg none 200 300 0


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/cpapi1

 Output (plaintext)
Converting /home/user/test1.jpg to /home/user/test1. gif...........Done

Parameters

ParameterTypeDescriptionPossible ValuesExample
dirstring

Required

The directory that contains the file to scale.

A valid path to a directory , relative to the account's home directory .
images
filestring

Required

The name of the file to scale.

A valid filename.image.jpg
oldimagestringThe name of the old file.A valid filename.none
widthinteger

Required

The format to which to convert the images.

The width of the file, in pixels.200
heightinteger

Required

The format to which to convert the images,

The height of the file, in pixels.300
keepoldBooleanWhether to copy the original image file to the name in the oldimage parameter's value.
  • 1 — Copy the original image.
  • 0 — Delete the old file.
0

Returns

This function returns a confirmation message.