Abstract Class Asido_Driver

Description

Asido abstract driver

  • abstract:

Located in /class.driver.php (line 19)


	
			
Direct descendents
Class Description
 class Asido_Driver_GD Asido GD(GD2) driver
 class Asido_Driver_Imagick_Ext Asido "Imagick" driver (as extension)
 class Asido_Driver_Magick_Wand Asido "Magick Wand" driver
Abstract class Asido_Driver_Shell Common file for all "shell" based solutions
Variable Summary
 array $__mime
Method Summary
 boolean convert (Asido_TMP &$tmp, string $mime_type)
 boolean copy (Asido_Tmp &$tmp, string $applied_image, integer $x, integer $y)
 boolean crop (Asido_TMP &$tmp, integer $x, integer $y, integer $width, integer $height)
 boolean flip (Asido_TMP &$tmp)
 boolean flop (Asido_TMP &$tmp)
 boolean frame (Asido_Tmp &$tmp, integer $width, integer $height, [Asido_Color $color = null])
 array get_supported_types (mixed $mode)
 boolean grayscale (Asido_TMP &$tmp)
 boolean is_compatible ()
 boolean prepare (Asido_Image &$image)
 boolean resize (Asido_TMP &$tmp, integer $width, integer $height, mixed $mode)
 boolean rotate (Asido_TMP &$tmp, float $angle, [Asido_Color $color = null])
 boolean save (Asido_Image &$image)
 boolean supported (string $mime_type, mixed $mode)
 boolean watermark (Asido_TMP &$tmp, string $watermark_image, mixed $position, mixed $scalable, float $scalable_factor)
 Asido_TMP __canvas (integer $width, integer $height, Asido_Color $color)
 boolean __copy (Asido_TMP &$tmp_target, Asido_TMP &$tmp_source, integer $destination_x, integer $destination_y)
 boolean __crop (Asido_TMP &$tmp, integer $x, integer $y, integer $width, integer $height)
 boolean __destroy_source (Asido_TMP &$tmp)
 boolean __destroy_target (Asido_TMP &$tmp)
 boolean __flip (Asido_TMP &$tmp)
 boolean __flop (mixed &$tmp, Asido_Image &$image)
 boolean __grayscale (Asido_TMP &$tmp)
 boolean __open (Asido_TMP &$tmp)
 boolean __resize (Asido_TMP &$tmp, integer $width, integer $height)
 boolean __rotate (Asido_TMP &$tmp, float $angle, Asido_Color $color)
 string __tmpfile ()
 Asido_TMP __tmpimage (mixed &$handler, [string $filename = null])
 boolean __write (Asido_Image &$image)
Variables
array $__mime = array(

// support reading
//
'read' => array(
),// support writing
//
'write'=>array(),)
(line 28)

Maps to supported mime types

  • access: protected

Redefined in descendants as:
Methods
convert (line 168)

Convert an image from one file-type to another

  • access: public
boolean convert (Asido_TMP &$tmp, string $mime_type)
copy (line 487)

Resize an image by "framing" it with the provided width and height

  • access: public
boolean copy (Asido_Tmp &$tmp, string $applied_image, integer $x, integer $y)
  • Asido_Tmp &$tmp
  • string $applied_image: filepath to the image that is going to be copied
  • integer $x
  • integer $y
crop (line 533)

Crop the image

  • access: public
boolean crop (Asido_TMP &$tmp, integer $x, integer $y, integer $width, integer $height)
  • Asido_TMP &$tmp
  • integer $x
  • integer $y
  • integer $width
  • integer $height
flip (line 544)

Vertically mirror (flip) the image

  • access: public
boolean flip (Asido_TMP &$tmp)
flop (line 555)

Horizontally mirror (flop) the image

  • access: public
boolean flop (Asido_TMP &$tmp)
frame (line 415)

Resize an image by "framing" it with the provided width and height

  • access: public
boolean frame (Asido_Tmp &$tmp, integer $width, integer $height, [Asido_Color $color = null])
  • Asido_Tmp &$tmp
  • integer $width
  • integer $height
  • Asido_Color $color
get_supported_types (line 744)

Get supported mime-types

  • access: public
array get_supported_types (mixed $mode)
  • mixed $mode
grayscale (line 380)

Make the image greyscale

  • access: public
boolean grayscale (Asido_TMP &$tmp)
is_compatible (line 50)

Checks whether the environment is compatible with this driver

  • abstract:
  • access: public
boolean is_compatible ()

Redefined in descendants as:
prepare (line 568)

Prepare an image for processing it

  • access: public
boolean prepare (Asido_Image &$image)
resize (line 69)

Resize an image

  • access: public
boolean resize (Asido_TMP &$tmp, integer $width, integer $height, mixed $mode)
  • Asido_TMP &$tmp
  • integer $width
  • integer $height
  • mixed $mode
rotate (line 393)

Rotate the image clockwise

  • access: public
boolean rotate (Asido_TMP &$tmp, float $angle, [Asido_Color $color = null])
save (line 596)

Save an image after being processed

  • access: public
boolean save (Asido_Image &$image)
supported (line 780)

Returnes whether an image format is supported or not

  • access: public
boolean supported (string $mime_type, mixed $mode)
  • string $mime_type
  • mixed $mode
watermark (line 200)

Watermark an image

  • access: public
boolean watermark (Asido_TMP &$tmp, string $watermark_image, mixed $position, mixed $scalable, float $scalable_factor)
  • Asido_TMP &$tmp
  • string $watermark_image
  • mixed $position
  • mixed $scalable
  • float $scalable_factor
__canvas (line 679)

Get canvas

  • abstract:
  • access: protected
Asido_TMP __canvas (integer $width, integer $height, Asido_Color $color)

Redefined in descendants as:
__copy (line 613)

Copy one image to another

  • abstract:
  • access: protected
boolean __copy (Asido_TMP &$tmp_target, Asido_TMP &$tmp_source, integer $destination_x, integer $destination_y)
  • Asido_TMP &$tmp_target
  • Asido_TMP &$tmp_source
  • integer $destination_x
  • integer $destination_y

Redefined in descendants as:
__crop (line 698)

Crop the image

  • abstract:
  • access: protected
boolean __crop (Asido_TMP &$tmp, integer $x, integer $y, integer $width, integer $height)
  • Asido_TMP &$tmp
  • integer $x
  • integer $y
  • integer $width
  • integer $height

Redefined in descendants as:
__destroy_source (line 858)

Destroy the source for the provided temporary object

  • abstract:
  • access: protected
boolean __destroy_source (Asido_TMP &$tmp)

Redefined in descendants as:
__destroy_target (line 873)

Destroy the target for the provided temporary object

  • abstract:
  • access: protected
boolean __destroy_target (Asido_TMP &$tmp)

Redefined in descendants as:
__flip (line 713)

Vertically mirror (flip) the image

  • abstract:
  • access: protected
boolean __flip (Asido_TMP &$tmp)

Redefined in descendants as:
__flop (line 728)

Horizontally mirror (flop) the image

  • abstract:
  • access: protected
boolean __flop (mixed &$tmp, Asido_Image &$image)

Redefined in descendants as:
__grayscale (line 645)

Make the image greyscale

  • abstract:
  • access: protected
boolean __grayscale (Asido_TMP &$tmp)

Redefined in descendants as:
__open (line 797)

Open the source and target image for processing it

  • abstract:
  • access: protected
boolean __open (Asido_TMP &$tmp)

Redefined in descendants as:
__resize (line 630)

Do the actual resize of an image

  • abstract:
  • access: protected
boolean __resize (Asido_TMP &$tmp, integer $width, integer $height)
  • Asido_TMP &$tmp
  • integer $width
  • integer $height

Redefined in descendants as:
__rotate (line 662)

Rotate the image clockwise

  • abstract:
  • access: protected
boolean __rotate (Asido_TMP &$tmp, float $angle, Asido_Color $color)

Redefined in descendants as:
__tmpfile (line 826)

Return a name for a temporary file

  • access: protected
string __tmpfile ()
__tmpimage (line 841)

Generate a temporary object for the provided argument

  • abstract:
  • access: protected
Asido_TMP __tmpimage (mixed &$handler, [string $filename = null])
  • mixed &$handler
  • string $filename: the filename will be automatically generated on the fly, but if you want you can use the filename provided by this argument

Redefined in descendants as:
__write (line 812)

Write the image after being processed

  • abstract:
  • access: protected
boolean __write (Asido_Image &$image)

Redefined in descendants as:

Documentation generated on Mon, 09 Apr 2007 23:57:07 +0300 by phpDocumentor 1.3.0RC4