Docs For Class ImageEditor

ImageEditor ImageEditor(
ImageManager
$manager)

Create a new ImageEditor instance. Editing requires a

tmp file, which is saved in the current directory where the image is edited. The tmp file is assigned by md5 hash of the user IP address. This hashed is used as an ID for cleaning up the tmp files. In addition, any tmp files older than the the specified period will be deleted.

Parameters:

ImageManager

$manager

the image manager, we need this for some file and path handling functions.

[ Top ]

void cleanUp(
string
$path, 
$file)

Delete any tmp image files.

Parameters:

string	$path	the full path where the clean should take place.
	$file

[ Top ]

string createUnique(
string
$file)

Create unique tmp image file name.

The filename is based on the tmp file prefix specified in config.inc.php plus the UID (basically a md5 of the remote IP) and some random 6 character string. This function also calls to clean up the tmp files.

Tags:

return:

a unique filename for that path NOTE: it only returns the filename, path no included.

Parameters:

string

$file

the fullpath to a file

[ Top ]

string getAction(
)

Get the action GET parameter

Tags:

return:

action parameter

[ Top ]

string getDefaultSaveFile(
)

Get the default save file name, used by editor.php.

Tags:

return:

a suggestive filename, this should be unique

[ Top ]

string getImageType(
string
$file)

Get the image type base on an image file.

Tags:

return:

of either 'gif', 'jpeg', 'png' or 'bmp' otherwise it will return null.

Parameters:

string

$file

the full path to the image file.

[ Top ]

string getSaveFileName(
string
$type)

Get the file name base on the save name and the save type.

Tags:

return:

the filename according to save type

Parameters:

string

$type

image type, 'jpeg', 'png', or 'gif'

[ Top ]

string getUniqueFilename(
string
$relative)

Get a unique filename. If the file exists, the filename base is appended with an increasing integer.

Tags:

return:

a unique filename in the current path

Parameters:

string

$relative

the relative filename to the base_dir

[ Top ]

int isFileSaved(
)

Did we save a file?

Tags:

return:

1 if the file was saved sucessfully,

no save operation, -1 file save error.

[ Top ]

int isGDEditable(
)

Check if the specified image can be edit by GD

mainly to check that GD can read and save GIFs

Tags:

return:

0 if it is not a GIF file, 1 is GIF is editable, -1 if not editable.

[ Top ]

int isGDGIFAble(
)

Check if GIF can be edit by GD.

Tags:

return:

0 if it is not using the GD library, 1 is GIF is editable, -1 if not editable.

[ Top ]

string makeRelative(
string
$pathA, string
$file)

Specifiy the original relative path, a new filename and return the new filename with relative path.

i.e. $pathA (-filename) + $file

Tags:

return:

relative path with the new filename

Parameters:

string	$pathA	the relative file
string	$file	the new filename

[ Top ]

array processAction(

$action, string
$relative, string
$fullpath, string
$action,)

Process the actions, crop, scale(resize), rotate, flip, and save.

When ever an action is performed, the result is save into a temporary image file, see createUnique on the filename specs. It does not return the saved file, alway returning the tmp file.

Tags:

return:

with image information

array('src'=>'url of the image', 'dimensions'=>'width="xx" height="yy"',
'file'=>'image file, relative', 'fullpath'=>'full path to the image');

Parameters:

string	$action,	should be 'crop', 'scale', 'rotate','flip', or 'save'
string	$relative	the relative image filename
string	$fullpath	the fullpath to the image file
	$action

[ Top ]

array processImage(

$uploadedRelative)

Process the image, if not action, just display the image.

Tags:

return:

with image information, empty array if not an image.

array('src'=>'url of the image', 'dimensions'=>'width="xx" height="yy"',
'file'=>'image file, relative', 'fullpath'=>'full path to the image');

Parameters:

$uploadedRelative

[ Top ]

string uniqueStr(
)

Generate a unique string based on md5(microtime()).

Well not so uniqe, as it is limited to 6 characters

Tags:

return:

unique string.

[ Top ]

Class: ImageEditor

Class Overview

Author(s):

Version:

Variables

Methods

Class Details

Tags:

Class Variables

$filesaved = 0

$lapse_time = 900

$manager =

$_uid =

Class Methods

constructor ImageEditor [line 48]

Parameters:

method cleanUp [line 481]

Parameters:

method createUnique [line 457]

Tags:

Parameters:

method getAction [line 428]

Tags:

method getDefaultSaveFile [line 359]

Tags:

method getImageType [line 519]

Tags:

Parameters:

method getSaveFileName [line 333]

Tags:

Parameters:

method getUniqueFilename [line 375]

Tags:

Parameters:

method isFileSaved [line 59]

Tags:

method isGDEditable [line 546]

Tags:

method isGDGIFAble [line 572]

Tags:

method makeRelative [line 414]

Tags:

Parameters:

method processAction [line 124]

Tags:

Parameters:

method processImage [line 70]

Tags:

Parameters:

method uniqueStr [line 441]

Tags: