Class: Image_Tools_Thumbnail

Source Location: /Image_Tools-0.4.2/Image/Tools/Thumbnail.php

Class Overview

Image_Tools
   |
   --Image_Tools_Thumbnail

This class provide thumbnail creating tool for manipulating an image

Author(s):

Ildar N. Shaimordanov <ildar-sh at mail.ru>

Version:

Release: 0.4.2

Copyright:

Variables

Methods

render

Inherited Variables

Class: Image_Tools

Image_Tools::$apiVersion
Image_Tools::$availableMethods
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::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 81]
This class provide thumbnail creating tool for manipulating an image

Author: Ildar N. Shaimordanov <ildar-sh@mail.ru>
Version: Release: 0.4.2
Copyright: Copyright (c) 2006 Ildar N. Shaimordanov <ildar-sh@mail.ru>
License: BSD License

[ Top ]

Class Variables

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

[line 116]

Available options for Image_Tools_Thumbnail

Access: protected

Type:	array
Overrides:	Array

[ Top ]

$imageInfo = null

[line 140]

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 100]

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 = '0.1'

[line 132]

Image_Tools_Thumbnail API version.

Access: protected

Type:	string
Overrides:	Array

[ Top ]

Method Detail

render [line 151]

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 ]

Class: Image_Tools_Thumbnail

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: Image_Tools

Inherited Methods

Class: Image_Tools

Class Details

Class Variables

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

$imageInfo = null

$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, )

$version = '0.1'

Method Detail

render [line 151]

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

$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,
)