Class: Image_Tools_Border

Source Location: /Image_Tools-1.0.0RC1/Image/Tools/Border.php

Class Overview

Image_Tools
   |
   --Image_Tools_Border

This class provide border creation on an image.

Author(s):

Firman Wandayandi <firman at php.net>

Version:

Release: 1.0.0RC1

Copyright:

Variables

Methods

Inherited Variables

Class: Image_Tools

Image_Tools::$apiVersion
Image_Tools::$resultImage

Inherited Methods

Class: Image_Tools

Image_Tools::Image_Tools(): Constructor
Image_Tools::availableMethods(): Get available methods
Image_Tools::availableOptions(): Get all available options of the subclass
Image_Tools::createImage(): Create a GD image resource from given input.
Image_Tools::createImageFromFile(): Create a GD image resource from file (JPEG, PNG, WBMP and XBM support).
Image_Tools::createImageFromString(): Create a GD image resource from a string data.
Image_Tools::display(): Display rendered image (send it to browser).
Image_Tools::factory(): Create a new instance of an image tool
Image_Tools::get(): Get the value of the option
Image_Tools::getAPIVersion(): Get the API version of the common base
Image_Tools::getResultImage(): Get rendered image.
Image_Tools::getVersion(): Get the subclass version.
Image_Tools::isGDImageResource(): Find the whether a value is the GD image resource or not.
Image_Tools::isValidOption(): Has the option a valid value? Determines, if the value given is valid for the option.
Image_Tools::postRender(): Function which called after render.
Image_Tools::preRender(): Function which called before render.
Image_Tools::render(): Render the result of a tool to the given image
Image_Tools::save(): Save rendered image to a file.
Image_Tools::set(): Set the option(s)
Image_Tools::supportsMethod(): Get the method parameters
Image_Tools::supportsOption(): Find out the whether a subclass supports the option

Class Details

[line 58]
This class provide border creation on an image.

Author: Firman Wandayandi <firman@php.net>
Version: Release: 1.0.0RC1
Copyright: Copyright (c) 2005-2006 Firman Wandayandi <firman@php.net>
License: BSD License

[ Top ]

Class Variables

$availableMethods = array(
        'rounded' => array(
            'radius'        => 'integer',
            'background'    => 'mixed',
            'antiAlias'     => 'integer'
        ),'bevel'=>array('size'=>'integer','highlight'=>'mixed','shadow'=>'mixed'),'line'=>array('width'=>'integer','color'=>'mixed','offset'=>'integer','background'=>'mixed'))

[line 98]

Available methods for Image_Tool_Border (only public methods).

Access: protected

Type:	array
Overrides:	Array

[ Top ]

$availableOptions = array(
        'image'  => 'mixed',
        'style'  => 'string',
        'params' => 'array'
    )

[line 86]

Available options for Image_Tools_Border.

Access: protected

Type:	array
Overrides:	Array

[ Top ]

$options = array(
        'image'  => null,
        'style'  => 'rounded',
        'params' => array())

[line 74]

Border options:

style string Border style params array Parameters </pre>

Access: protected

Type:	array
Overrides:	Array

[ Top ]

$version = '1.0'

[line 123]

Image_Tools_Border API version.

Access: protected

Type:	string
Overrides:	Array

[ Top ]

Method Detail

preRender [line 149]

bool|PEAR_Error preRender(
)

Function which called before render.

Return: TRUE on success or PEAR_Error on failure.
Access: protected

Overrides Image_Tools::preRender() (Function which called before render.)

[ Top ]

render [line 328]

TRUE|PEAR_Error render(
)

This method is useless, use directly call for specific border style method.

Access: protected

Overrides Image_Tools::render() (Render the result of a tool to the given image)

[ Top ]

Class: Image_Tools_Border

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: Image_Tools

Inherited Methods

Class: Image_Tools

Class Details

Class Variables

$availableMethods = array( 'rounded' => array( 'radius' => 'integer', 'background' => 'mixed', 'antiAlias' => 'integer' ),'bevel'=>array('size'=>'integer','highlight'=>'mixed','shadow'=>'mixed'),'line'=>array('width'=>'integer','color'=>'mixed','offset'=>'integer','background'=>'mixed'))

$availableOptions = array( 'image' => 'mixed', 'style' => 'string', 'params' => 'array' )

$options = array( 'image' => null, 'style' => 'rounded', 'params' => array())

$version = '1.0'

Method Detail

preRender [line 149]

render [line 328]

$availableMethods = array(
'rounded' => array(
'radius' => 'integer',
'background' => 'mixed',
'antiAlias' => 'integer'
),'bevel'=>array('size'=>'integer','highlight'=>'mixed','shadow'=>'mixed'),'line'=>array('width'=>'integer','color'=>'mixed','offset'=>'integer','background'=>'mixed'))

$availableOptions = array(
'image' => 'mixed',
'style' => 'string',
'params' => 'array'
)

$options = array(
'image' => null,
'style' => 'rounded',
'params' => array())