Class: Image_Tools_Marquee

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

Class Overview

Image_Tools
   |
   --Image_Tools_Marquee

This class provide marquee extraction tool for manipulating 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 90]
This class provide marquee extraction tool for manipulating 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(
        'setRectangleMarquee' => array(
            'topLeftX'     => 'int',
            'topLeftY'     => 'int',
            'bottomRightX' => 'int',
            'bottomRightY' => 'int'
        ),'setSingleColMarquee'=>array('x'=>'int'),'setSingleRowMarquee'=>array('y'=>'int'))

[line 133]

Available methods for Image_Tool_Marquee (only public methods).

Access: protected

Type:	array
Overrides:	Array

[ Top ]

$availableOptions = array(
        'image'     => 'mixed',
        'sample'    => 'mixed',
        'x'         => 'int',
        'y'         => 'int'
    )

[line 120]

Available options for Image_Tools_Marquee.

Access: protected

Type:	array
Overrides:	Array

[ Top ]

$options = array(
        'image'     => null,   // Destination image.
        'sample'    => null,   // Sample image.
        'x'         => 0,      // X position.
        'y'         => 0       // Y position.
    )

[line 107]

Marquee options:

x int X position, this sets X position where marquee will be placed. y int Y position, this sets Y position where marquee will be placed. </pre>

Access: protected

Type:	array
Overrides:	Array

[ Top ]

$version = '1.0'

[line 154]

Image_Tools_Marquee API version.

Access: protected

Type:	string
Overrides:	Array

[ Top ]

Method Detail

preRender [line 182]

bool|PEAR_Error preRender(
)

Function which called before render.

Return: TRUE on success or PEAR_Error on failure.
See: Image_Tools::createImage()
Access: protected

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

[ Top ]

render [line 282]

bool|PEAR_Error render(
)

Draw extraction result to resource.

Return: TRUE on success or PEAR_Error on failure.
See: Image_Tools_Marquee::_extractRectangle(), Image_Tools_Marquee::_extractSingleCol(), Image_Tools_Marquee::_extractSingleRow()
Access: public

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

[ Top ]

setRectangleMarquee [line 214]

bool setRectangleMarquee(
int
$topLeftX, int
$topLeftY, int
$bottomRightX, int
$bottomRightY)

Set marquee using rectangle.

Return: Always TRUE.
See: _setMarquee()
Access: public

Parameters:

int	`$topLeftX`	—	Top left x coordinate.
int	`$topLeftY`	—	Top left y coordinate.
int	`$bottomRightX`	—	Bottom right x coordinate.
int	`$bottomRightY`	—	Bottom right y coordinate.

[ Top ]

setSingleColumnMarquee [line 246]

bool setSingleColumnMarquee(
int
$x)

Set marquee using single column marquee.

Return: Always TRUE.
See: _setMarquee()
Access: public

Parameters:

int $x — X coordinate.

[ Top ]

setSingleRowMarquee [line 264]

bool setSingleRowMarquee(
int
$y)

Set marquee using single row marquee.

Return: Always TRUE.
See: Image_Tools_Marquee::_setMarquee()
Access: public

Parameters:

int $y — Y coordinate.

[ Top ]

Class: Image_Tools_Marquee

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: Image_Tools

Inherited Methods

Class: Image_Tools

Class Details

Class Variables

$availableMethods = array( 'setRectangleMarquee' => array( 'topLeftX' => 'int', 'topLeftY' => 'int', 'bottomRightX' => 'int', 'bottomRightY' => 'int' ),'setSingleColMarquee'=>array('x'=>'int'),'setSingleRowMarquee'=>array('y'=>'int'))

$availableOptions = array( 'image' => 'mixed', 'sample' => 'mixed', 'x' => 'int', 'y' => 'int' )

$options = array( 'image' => null, // Destination image. 'sample' => null, // Sample image. 'x' => 0, // X position. 'y' => 0 // Y position. )

$version = '1.0'

Method Detail

preRender [line 182]

render [line 282]

setRectangleMarquee [line 214]

Parameters:

setSingleColumnMarquee [line 246]

Parameters:

setSingleRowMarquee [line 264]

Parameters:

$availableMethods = array(
'setRectangleMarquee' => array(
'topLeftX' => 'int',
'topLeftY' => 'int',
'bottomRightX' => 'int',
'bottomRightY' => 'int'
),'setSingleColMarquee'=>array('x'=>'int'),'setSingleRowMarquee'=>array('y'=>'int'))

$availableOptions = array(
'image' => 'mixed',
'sample' => 'mixed',
'x' => 'int',
'y' => 'int'
)

$options = array(
'image' => null, // Destination image.
'sample' => null, // Sample image.
'x' => 0, // X position.
'y' => 0 // Y position.
)