phpDocumentor epesi-utils
image
[ class tree: epesi-utils ] [ index: epesi-utils ] [ all elements ]

Class: Utils_ImageCommon

Source Location: /modules/Utils/Image/ImageCommon_0.php

Class Utils_ImageCommon

Class Overview

Utils_Image.

It automates creating properly scaled image thumbnails. Works with most popular image formats. Also adds a preloader for displayd images.

Located in /modules/Utils/Image/ImageCommon_0.php [line 16]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Utils_ImageCommon
Author(s): Information Tags:
Version:  1.0
Copyright:  Copyright © 2006, Telaxus LLC
License:  MIT

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From ModuleCommon

ModuleCommon::Instance()
Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()
ModulePrimitive::check_access()
Checks access to function which name is passed as first parameter.
ModulePrimitive::create_data_dir()
Creates default data directory for module. Typical usage: in module installation
ModulePrimitive::get_data_dir()
Returns path to the default data directory for module calling this method.
ModulePrimitive::get_module_dir()
Returns path to the module directory.
ModulePrimitive::get_type()
Returns name(type) of module that called this function.
ModulePrimitive::get_type_with_bt()
ModulePrimitive::remove_data_dir()
Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()
ModuleAcl::add_aco()
ModuleAcl::del_aco()
ModuleAcl::get_type()

[ Top ]
Method Summary
static void   create_thumb()   Creates thumb of loaded image.
static void   display_thumb()   This displays created thumb.
static void   get_thumb_html()   This returns HTML of created thumb.

[ Top ]
Methods
static method create_thumb  [line 25]

  static void create_thumb( string $img, [int $attr_x = null], [int $attr_y = null]  )

Creates thumb of loaded image.

Parameters:
string   $img:  path to image
int   $attr_x:  max size.
int   $attr_y:  max height. When specified, first parameter becomes responsible for max width.

API Tags:
Access:  public


[ Top ]
static method display_thumb  [line 142]

  static void display_thumb( $img, [ $attr_x = null], [ $attr_y = null]  )

This displays created thumb.

Parameters:
   $img: 
   $attr_x: 
   $attr_y: 

API Tags:
Access:  public


[ Top ]
static method get_thumb_html  [line 130]

  static void get_thumb_html( $img, [ $attr_x = null], [ $attr_y = null]  )

This returns HTML of created thumb.

Parameters:
   $img: 
   $attr_x: 
   $attr_y: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:42:32 -0500 by phpDocumentor 1.4.2