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

Class: Image_Tools_Thumbnail

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

Class Overview

Image_Tools
   |
   --Image_Tools_Thumbnail

This class provide thumbnail creating tool for manipulating an image


Author(s):

Version:

  • Release: 1.0.0RC1

Copyright:

  • Copyright (c) 2006-2008 Ildar N. Shaimordanov <ildar-sh@mail.ru>

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 82]
This class provide thumbnail creating tool for manipulating an image
  • Author: Ildar N. Shaimordanov <ildar-sh@mail.ru>
  • Version: Release: 1.0.0RC1
  • Copyright: Copyright (c) 2006-2008 Ildar N. Shaimordanov <ildar-sh@mail.ru>
  • Since: Class available since Release 0.4.0
  • License: BSD License


[ Top ]


Class Variables

$availableOptions = array(
        'image'   => 'mixed',
        'width'   => 'int',
        'height'  => 'int',
        'percent' => 'number',
        'method'  => 'int',
        'halign'  => 'int',
        'valign'  => 'int',
    )

[line 117]

Available options for Image_Tools_Thumbnail
  • Access: protected

Type:   array
Overrides:   Array


[ Top ]

$imageInfo =  null

[line 141]

Image info.
  • Access: protected

Type:   resource


[ Top ]

$options = array(
        'image'   => null,
        'width'   => 100,
        'height'  => 100,
        'percent' => 0,
        'method'  => IMAGE_TOOLS_THUMBNAIL_METHOD_SCALE_MAX,
        'halign'  => IMAGE_TOOLS_THUMBNAIL_ALIGN_CENTER,
        'valign'  => IMAGE_TOOLS_THUMBNAIL_ALIGN_CENTER,
    )

[line 101]

Thumbnail options:

 image   mixed  Destination image, a filename or an image string data or a GD image resource
 width   int    Width of thumbnail
 height  int    Height of thumbnail
 percent number Size of thumbnail per size of original image
 method  int    Method of thumbnail creating
 halign  int    Horizontal align
 valign  int    Vertical align

  • Access: protected

Type:   array
Overrides:   Array


[ Top ]

$version =  '1.0'

[line 133]

Image_Tools_Thumbnail API version.
  • Access: protected

Type:   string
Overrides:   Array


[ Top ]



Method Detail

postRender   [line 174]

bool|PEAR_Error postRender( )

Function which called after render.

Overrides Image_Tools::postRender() (Function which called after render.)
[ Top ]

preRender   [line 153]

bool|PEAR_Error preRender( )

Function which called before render.

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

render   [line 187]

bool|PEAR_Error render( )

Draw thumbnail result to resource.
  • Return: TRUE on success or PEAR_Error on failure.
  • Access: public

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


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