Image_Tools
[ class tree: Image_Tools ] [ index: Image_Tools ] [ all elements ]

Class: Image_Tools_Mask

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

Class Overview

Image_Tools
   |
   --Image_Tools_Mask

This class provide masking tool for manipulating an image.


Author(s):

Version:

  • Release: 1.0.0RC1

Copyright:

  • Copyright (c) 2005-2008 Firman Wandayandi <firman@php.net>

Variables

Methods


Inherited Variables

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 59]
This class provide masking tool for manipulating an image.
  • Author: Firman Wandayandi <firman@php.net>
  • Version: Release: 1.0.0RC1
  • Copyright: Copyright (c) 2005-2008 Firman Wandayandi <firman@php.net>
  • License: BSD License


[ Top ]


Class Variables

$availableMethods = array()

[line 116]

There is no public methods in Image_Tool_Mask.
  • Access: protected

Type:   array
Overrides:   Array


[ Top ]

$availableOptions = array(
        'image'             => 'mixed',
        'mask'              => 'mixed',
        'sample'            => 'mixed',
        'mask_color'        => 'mixed',
        'unmask_color'      => 'mixed',
        'antialias'         => 'bool',
        'antialias_factor'  => 'int'
    )

[line 100]

Available options for Image_Tools_Mask.
  • Access: protected

Type:   array
Overrides:   Array


[ Top ]

$options = array(
        'image'             => null,   // Destination image.
        'mask'              => null,     // Mask image.
        'sample'            => null,     // Sample image.
        'mask_color'        => '000000', // Mask color.
        'unmask_color'      => 'ffffff', // Unmask color.
        'antialias'         => true,     // Antialias flag.
        'antialias_factor'  => 16        // Antialias factor.
    )

[line 84]

Mask options:

mask mixed Mask image, a filename or an image string data or a GD image resource. sample mixed Sample image, a filename or an image string data or a GD image resource. mask_color mixed Mask color, use string for hexa color format or array contains 3 indexes 0 for RGB format unmask_color mixed Mask color, use string for hexa color format or array contains 3 indexes 0 for RGB format antialias bool Flag whether attempt to draw antialias mask antialias_factor int Antialias factor, this setting for antialias mask </pre>

  • Access: protected

Type:   array
Overrides:   Array


[ Top ]

$version =  '1.0'

[line 124]

Image_Tools_Mask API version.
  • Access: protected

Type:   string
Overrides:   Array


[ Top ]



Method Detail

preRender   [line 152]

bool|PEAR_Error preRender( )

Function which called before render.

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


Documentation generated on Mon, 26 May 2008 06:30:11 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.