Class: awGraph

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

Class Overview

awImage
   |
   --awGraph

A graph

Variables

Constants

Methods

Inherited Constants

Class: awImage

awImage::GIF
awImage::JPEG
awImage::PNG

Inherited Variables

Class: awImage

awImage::$antiAliasing
awImage::$background
awImage::$border
awImage::$driver
awImage::$driverString
awImage::$format
awImage::$height
awImage::$resource
awImage::$shadow
awImage::$width

Inherited Methods

Class: awImage

awImage::__construct(): Build the image
awImage::create(): Create a new awimage
awImage::drawComponent(): Draw a component on the image
awImage::drawError()
awImage::drawErrorFile()
awImage::drawShadow()
awImage::get(): Return the image content as binary data
awImage::getAntiAliasing(): Return the antialiasing setting
awImage::getBackground(): Return image background, whether a Color or a Gradient
awImage::getDriver(): Get driver of the image
awImage::getFormat(): Returns the image format as an integer
awImage::getFormatString(): Returns the image format as a string
awImage::selectDriver(): Select the correct driver
awImage::send(): Send the image into a file or to the user browser
awImage::sendHeaders(): Send the correct HTTP header according to the image type
awImage::setAntiAliasing(): Turn antialiasing on or off
awImage::setBackground(): Change image background
awImage::setBackgroundColor(): Change image background color
awImage::setBackgroundGradient(): Change image background gradient
awImage::setDriver(): Sets the driver that will be used to draw the graph
awImage::setFormat(): Change image format
awImage::setSize(): Change the image size

Class Details

[line 25]
A graph

[ Top ]

Class Variables

$labels = array()

[line 60]

Some labels to add to the component

Tags:

access:

protected

Type:

array

[ Top ]

$name =

[line 32]

Graph name

Tags:

access:

protected

Type:

string

[ Top ]

$timeout = 0

[line 39]

Cache timeout

Tags:

access:

protected

Type:

int

[ Top ]

$timing =

[line 46]

Graph timing ?

Tags:

access:

protected

Type:

bool

[ Top ]

$title =

[line 67]

Graph title

Tags:

access:

public

Type:

Label

[ Top ]

Class Methods

static method cleanCache [line 196]

static void cleanCache(
)

Clean cache

Tags:

access:

public

[ Top ]

static method deleteAllCache [line 177]

static void deleteAllCache(
)

Delete all graphs from the cache

Tags:

access:

public

[ Top ]

static method deleteFromCache [line 161]

static bool deleteFromCache(
string
$name)

Delete a graph from the cache

Tags:

return:	TRUE on success, FALSE on failure
access:	public

Parameters:

string

$name

Graph name

[ Top ]

constructor __construct [line 105]

awGraph __construct(
[int
$width = NULL], [int
$height = NULL], [string
$name = NULL], [int
$timeout = 0])

Construct a new graph

Tags:

access:

public

Overrides awImage::__construct() (Build the image)

Parameters:

int	$width	Graph width
int	$height	Graph height
string	$name	Graph name for the cache (must be unique). Let it null to not use the cache.
int	$timeout	Cache timeout (unix timestamp)

[ Top ]

method add [line 231]

void add(

$component)

Add a component to the graph

Tags:

access:

public

Parameters:

awComponent

$component

[ Top ]

method addAbsLabel [line 258]

void addAbsLabel(
awLabel
$label, awPoint
$point)

Add a label to the component with absolute position

Tags:

access:

public

Parameters:

awLabel	$label
awPoint	$point	Text position

[ Top ]

method addLabel [line 244]

void addLabel(
awLabel
$label, int
$x, int
$y)

Add a label to the component

Tags:

access:

public

Parameters:

awLabel	$label
int	$x	Position on X axis of the center of the text
int	$y	Position on Y axis of the center of the text

[ Top ]

method draw [line 271]

void draw(
[string
$mode = Graph::DRAW_DISPLAY])

Build the graph and draw component on it

Tags:

access:

public

Parameters:

string

$mode

Display mode (can be a file name)

[ Top ]

method setTiming [line 222]

void setTiming(
bool
$timing)

Enable/Disable Graph timing

Tags:

access:

public

Parameters:

bool

$timing

[ Top ]

Class Constants

DRAW_DISPLAY = 2

[line 95]

Drawing mode to display the graph

[ Top ]

DRAW_RETURN = 1

[line 88]

Drawing mode to return the graph

[ Top ]

Documentation generated on Thu, 03 May 2012 15:04:55 +0200 by phpDocumentor 1.4.1