linea21-externals
[ class tree: linea21-externals ] [ index: linea21-externals ] [ all elements ]

Class: awImage

Source Location: /class/system/artichow/php5/Image.class.php

Class Overview


An image for a graph


Variables

Constants

Methods


Child classes:

A graph
AntiSpam String printed on the images are case insensitive.
awFileImage
Load an image from a file

Class Details

[line 91]
An image for a graph



[ Top ]


Class Variables

$antiAliasing =  FALSE

[line 112]

Use anti-aliasing ?



Tags:

access:  protected

Type:   bool


[ Top ]

$background =

[line 126]

Image background color



Tags:

access:  protected

Type:   Color


[ Top ]

$border =

[line 161]

Image border



Tags:

access:  public

Type:   Border


[ Top ]

$driver =

[line 140]

A Driver object



Tags:

access:  protected

Type:   Driver


[ Top ]

$driverString =

[line 147]

Driver string



Tags:

access:  protected

Type:   string


[ Top ]

$format =  awImage::PNG

[line 119]

Image format



Tags:

access:  protected

Type:   int


[ Top ]

$height =

[line 105]

Graph height



Tags:

access:  public

Type:   int


[ Top ]

$resource =

[line 133]

GD resource



Tags:

access:  protected

Type:   resource


[ Top ]

$shadow =

[line 154]

Shadow



Tags:

access:  public

Type:   Shadow


[ Top ]

$width =

[line 98]

Graph width



Tags:

access:  public

Type:   int


[ Top ]



Class Methods


static method drawError [line 489]

static void drawError( $message)



Tags:

access:  public


Parameters:

   $message  

[ Top ]

static method drawErrorFile [line 579]

static void drawErrorFile( $error)



Tags:

access:  public


Parameters:

   $error  

[ Top ]

constructor __construct [line 187]

awImage __construct( )

Build the image



Tags:

access:  public


Overridden in child classes as:

awFileImage::__construct()
Build a new awimage

[ Top ]

method create [line 338]

void create( )

Create a new awimage



Tags:

access:  public


[ Top ]

method drawComponent [line 385]

void drawComponent( $component)

Draw a component on the image



Tags:

var:  A component
access:  public


Parameters:

awComponent   $component  

[ Top ]

method drawShadow [line 432]

void drawShadow( )



Tags:

access:  protected


[ Top ]

method get [line 457]

void get( )

Return the image content as binary data



Tags:

access:  public


[ Top ]

method getAntiAliasing [line 293]

bool getAntiAliasing( )

Return the antialiasing setting



Tags:

access:  public


[ Top ]

method getBackground [line 275]

mixed getBackground( )

Return image background, whether a Color or a Gradient



Tags:

access:  public


[ Top ]

method getDriver [line 204]

Driver getDriver( [int $w = 1], [int $h = 1], [float $x = 0.5], [float $y = 0.5])

Get driver of the image



Tags:

access:  public


Parameters:

int   $w   Driver width (from 0 to 1) (default to 1)
int   $h   Driver height (from 0 to 1) (default to 1)
float   $x   Position on X axis of the center of the driver (default to 0.5)
float   $y   Position on Y axis of the center of the driver (default to 0.5)

[ Top ]

method getFormat [line 313]

unknown getFormat( )

Returns the image format as an integer



Tags:

access:  public


[ Top ]

method getFormatString [line 322]

string getFormatString( )

Returns the image format as a string



Tags:

access:  public


[ Top ]

method selectDriver [line 356]

mixed selectDriver( string $driver)

Select the correct driver



Tags:

access:  protected


Parameters:

string   $driver   The desired driver

[ Top ]

method send [line 449]

void send( )

Send the image into a file or to the user browser



Tags:

access:  public


[ Top ]

method sendHeaders [line 465]

void sendHeaders( )

Send the correct HTTP header according to the image type



Tags:

access:  public


[ Top ]

method setAntiAliasing [line 284]

void setAntiAliasing( $bool)

Turn antialiasing on or off



Tags:

access:  public


Parameters:

   $bool  

[ Top ]

method setBackground [line 244]

void setBackground( mixed $background)

Change image background



Tags:

access:  public


Parameters:

mixed   $background  

[ Top ]

method setBackgroundColor [line 257]

void setBackgroundColor( awColor $color)

Change image background color



Tags:

access:  public


Parameters:

awColor   $color  

[ Top ]

method setBackgroundGradient [line 266]

void setBackgroundGradient( awGradient $gradient)

Change image background gradient



Tags:

access:  public


Parameters:

awGradient   $gradient  

[ Top ]

method setDriver [line 216]

void setDriver( string $driverString)

Sets the driver that will be used to draw the graph



Tags:

access:  public


Parameters:

string   $driverString  

[ Top ]

method setFormat [line 302]

void setFormat( $format)

Change image format



Tags:

var:  New image format
access:  public


Parameters:

   $format  

[ Top ]

method setSize [line 228]

void setSize( $width, $height)

Change the image size



Tags:

var:  Image width
access:  public


Parameters:

   $width  
   $height  

[ Top ]


Class Constants

GIF =  IMG_GIF

[line 182]

Use GIF for image


[ Top ]

JPEG =  IMG_JPG

[line 168]

Use JPEG for image


[ Top ]

PNG =  IMG_PNG

[line 175]

Use PNG for image


[ Top ]



Documentation generated on Thu, 03 May 2012 15:05:07 +0200 by phpDocumentor 1.4.1