Class XFImage

Description

XFImage abstracts php image function to draw bitmap and vector based

Located in /lb_private/class.image.php (line 26)


	
			
Class Constant Summary
Variable Summary
Method Summary
static true queue (string $a, array $b)
true arc (integer $id, integer $x1, integer $y1, integer $w, integer $h, integer $start, integer $end, string $color)
true background (integer $id, string $color)
true border (integer $id, string $color)
true color (integer $id, integer $chr,  $chg, integer $chb, double $cha, string $name)
integer create (integer $size_x, integer $size_y, [string $option = ''])
boolean enabled ()
true filledarc (integer $id, integer $x1, integer $y1, integer $w, integer $h, integer $start, integer $end, string $color)
true filledrectangle (integer $id, integer $x1, integer $y1, integer $x2, integer $y2, string $color)
true line (integer $id, integer $x1, integer $y1, integer $x2, integer $y2, string $color)
resource output (integer $id, string $format)
true rectangle (integer $id, integer $x1, integer $y1, integer $x2, integer $y2, string $color)
true render (string $mode)
true reset_filter ()
true string (integer $id, integer $size, integer $x1, integer $y1, string $msg, string $color)
string svg_skeleton ()
true use_filter (integer $filter, [string $data = ''])
Variables
static array $work_queue = array() (line 46)
  • var: queue of render jobs
  • access: protected
array $color_bitmap = array() (line 62)
  • var: resource handlers for colors in bitmap images
  • access: protected
array $color_vector = array() (line 66)
  • var: resource handlers for colors in vector images
  • access: protected
array $filter = array('id'=>0,'data'=>'') (line 70)
  • var: handle filters
  • access: protected
array $handler_bitmap = array() (line 50)
  • var: resource handlers for bitmap images
  • access: protected
array $handler_meta = array() (line 58)
  • var: meta data for images
  • access: protected
array $handler_vector = array() (line 54)
  • var: resource handlers for vector images
  • access: protected
Methods
static method queue (line 304)

add a job to work queue

  • since: 1.0.0
  • access: protected
static true queue (string $a, array $b)
  • string $a: job name and image identifier, separated by :
  • array $b: job arguments
arc (line 212)

paint an unfilled arc

  • since: 1.0.0
  • access: public
true arc (integer $id, integer $x1, integer $y1, integer $w, integer $h, integer $start, integer $end, string $color)
  • integer $id: image id from XFImage::create()
  • integer $x1: x coordinate
  • integer $y1: y coordinate
  • integer $w: width in pixels
  • integer $h: height in pixels
  • integer $start: start angle
  • integer $end: end angle
  • string $color: name of color
background (line 137)

set background color

  • since: 1.0.0
  • access: public
true background (integer $id, string $color)
  • integer $id: image id from XFImage::create()
  • string $color: name of color
border (line 149)

paint a border with one pixel at the edge

  • since: 1.0.0
  • access: public
true border (integer $id, string $color)
  • integer $id: image id from XFImage::create()
  • string $color: name of color
color (line 117)

set a color. channels can be in hexadecimal '0x00-0xff' or integer '0-255'

  • since: 1.0.0
  • access: public
true color (integer $id, integer $chr,  $chg, integer $chb, double $cha, string $name)
  • integer $id: image id from XFImage::create()
  • integer $chr: green channel
  • integer $chb: blue channel
  • double $cha: alpha channel
  • string $name: name of color for referencing
  • $chg
create (line 94)

create an image. returns the id for all later operations.

  • since: 1.0.0
  • access: public
integer create (integer $size_x, integer $size_y, [string $option = ''])
  • integer $size_x: width in pixels
  • integer $size_y: height in pixels
  • string $option: enable smoother lines with 'antialias=yes'
enabled (line 77)

enable the image processor

  • since: 1.0.0
  • access: public
boolean enabled ()
filledarc (line 229)

paint a filled arc

  • since: 1.0.0
  • access: public
true filledarc (integer $id, integer $x1, integer $y1, integer $w, integer $h, integer $start, integer $end, string $color)
  • integer $id: image id from XFImage::create()
  • integer $x1: x coordinate
  • integer $y1: y coordinate
  • integer $w: width in pixels
  • integer $h: height in pixels
  • integer $start: start angle
  • integer $end: end angle
  • string $color: name of color
filledrectangle (line 195)

paint a filled rectangle

  • since: 1.0.0
  • access: public
true filledrectangle (integer $id, integer $x1, integer $y1, integer $x2, integer $y2, string $color)
  • integer $id: image id from XFImage::create()
  • integer $x1: left-top x coordinate
  • integer $y1: left-top y coordinate
  • integer $x2: right-bottom x coordinate
  • integer $y2: right-bottom y coordinate
  • string $color: name of color
line (line 165)

paint a line

  • since: 1.0.0
  • access: public
true line (integer $id, integer $x1, integer $y1, integer $x2, integer $y2, string $color)
  • integer $id: image id from XFImage::create()
  • integer $x1: left-top x coordinate
  • integer $y1: left-top y coordinate
  • integer $x2: right-bottom x coordinate
  • integer $y2: right-bottom y coordiate
  • string $color: name of color
output (line 275)

output the rendered image

  • since: 1.0.0
  • access: public
resource output (integer $id, string $format)
  • integer $id: image id from XFCreate::image()
  • string $format: use 'png' or 'svg'
rectangle (line 180)

paint an unfilled rectangle

  • since: 1.0.0
  • access: public
true rectangle (integer $id, integer $x1, integer $y1, integer $x2, integer $y2, string $color)
  • integer $id: image id from XFImage::create()
  • integer $x1: left-top x coordinate
  • integer $y1: left-top y coordinate
  • integer $x2: right-bottom x coordinate
  • integer $y2: right-bottom y coordinate
  • string $color: name of color
render (line 316)

execute jobs from work queue and render the image

  • since: 1.0.0
  • access: protected
true render (string $mode)
  • string $mode: render 'bitmap' image or 'vector' type, 'purge' cleans queue
reset_filter (line 264)

remove a filter from using

  • since: 1.0.0
  • access: public
true reset_filter ()
string (line 244)

paint a string

  • since: 1.0.0
  • access: public
true string (integer $id, integer $size, integer $x1, integer $y1, string $msg, string $color)
  • integer $id: image id from XFImage::create()
  • integer $size: letter size (1-5)
  • integer $x1: x coordinate
  • integer $y1: y coordinate
  • string $msg: text message
  • string $color: name of color
svg_skeleton (line 434)

frame for svg files

  • since: 1.0.0
  • access: protected
string svg_skeleton ()
use_filter (line 255)

apply a filter for next operations

  • since: 1.0.0
  • access: public
true use_filter (integer $filter, [string $data = ''])
  • integer $filter: filter id
  • string $data: options
Class Constants
FILTER_GRADIENT = 0x04 (line 42)
  • var: filter flag: draw a background gradient on filledrectangle() [vector only]
FILTER_LINE_STRONG = 0x02 (line 38)
  • var: filter flag: draw stronger lines used in line()
FILTER_NONE = 0x00 (line 30)
  • var: filter flag: no filter
FILTER_SMOOTH_EDGE = 0x01 (line 34)
  • var: filter flag: smooth edges used on filledrectangle() [vector only]

Documentation generated on Sat, 20 Jun 2009 12:43:17 +0200 by phpDocumentor 1.4.1