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

Class: Image

Source Location: /modules/image/components/Image.class.php

Class Overview

Object
   |
   --Image

Класс для работы с изображениями.


Author(s):

  • 1m.dm

Variables

Constants

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 19]
Класс для работы с изображениями.



Tags:

author:   1m.dm


[ Top ]


Class Variables

$extensions = array(
    'png'  => self::TYPE_PNG,
    'gif'  => self::TYPE_GIF,
    'jpg'  => self::TYPE_JPEG,
    'jpe'  => self::TYPE_JPEG,
    'jpeg' => self::TYPE_JPEG
    )

[line 56]

Сопоставление расширений файлов типам.



Tags:

access:   private

Type:   array


[ Top ]

$height =

[line 88]

Высота изображения.



Tags:

access:   private

Type:   int


[ Top ]

$image =

[line 72]

Изображение.



Tags:

access:   private

Type:   resource


[ Top ]

$type =

[line 96]

Тип изображения (см. выше список типов).



Tags:

access:   private

Type:   int


[ Top ]

$width =

[line 80]

Ширина изображения.



Tags:

access:   private

Type:   int


[ Top ]



Class Methods


constructor __construct [line 106]

void __construct( )

Конструктор класса.



Tags:

access:   public


Overrides Object::__construct() (Пустой конструктор)

[ Top ]

destructor __destruct [line 422]

void __destruct( )



Tags:

access:   public


[ Top ]

method checkAvailableMemory [line 131]

void checkAvailableMemory( $width, $height)



Tags:

access:   private


Parameters:

   $width  
   $height  

[ Top ]

method convertSizeToBytes [line 151]

void convertSizeToBytes( $size)



Tags:

access:   private


Parameters:

   $size  

[ Top ]

method create [line 118]

void create( int $width, int $height)

Создание изображения заданной ширины и высоты.



Tags:

access:   public


Parameters:

int   $width   - ширина
int   $height   - высота

[ Top ]

method crop [line 305]

void crop( $newWidth, $newHeight)



Tags:

access:   private


Parameters:

   $newWidth  
   $newHeight  

[ Top ]

method getExtension [line 418]

string getExtension( string $filename)

Возвращает расширение файла.



Tags:

access:   private


Parameters:

string   $filename  

[ Top ]

method getHeight [line 174]

void getHeight( )



Tags:

access:   public


[ Top ]

method getWidth [line 170]

void getWidth( )



Tags:

access:   public


[ Top ]

method loadFromFile [line 189]

void loadFromFile( int $filename, [int $type = self::TYPE_UNKNOWN])

Загружает изображение из файла.

Если тип изображения явно не указан, метод попытается определить его самостоятельно, основываясь на расширении файла. В случае неудачи будет возбуждено исключение.




Tags:

access:   public


Parameters:

int   $filename   - имя файла
int   $type   - тип изображения

[ Top ]

method resize [line 284]

void resize( mixed $newWidth, mixed $newHeight, [ $crop = false])

Изменяет размер (разрешение) изображения.



Tags:

todo:   Если ширина ИЛИ высота равны null -- они вычисляются пропорционально.
access:   public


Parameters:

mixed   $newWidth   - новая ширина
mixed   $newHeight   - новая высота
   $crop  

[ Top ]

method resizeWithMargins [line 374]

void resizeWithMargins( $newWidth, $newHeight)



Tags:

access:   private


Parameters:

   $newWidth  
   $newHeight  

[ Top ]

method saveToFile [line 239]

void saveToFile( int $filename, [int $type = self::TYPE_UNKNOWN])

Сохраняет изображение в файл.

Если тип изображения явно не указан, метод попытается определить его самостоятельно, основываясь на расширении файла. В случае неудачи будет возбуждено исключение.




Tags:

access:   public


Parameters:

int   $filename   - имя файла
int   $type   - тип изображения

[ Top ]

method show [line 435]

void show( )

Выводит картинку



Tags:

access:   public


[ Top ]


Class Constants

DEFAULT_MEMORY_LIMIT =  16777216

[line 26]

Количество памяти по умолчанию(если cкомпилировано без memory-limit)

16M



[ Top ]

TYPE_GIF =  2

[line 42]

Graphics Interchange Format


[ Top ]

TYPE_JPEG =  3

[line 46]

Joint Photographic Experts Group


[ Top ]

TYPE_PNG =  1

[line 38]

Portable Network Graphics


[ Top ]

TYPE_UNKNOWN =  0

[line 34]

Неизвестный


[ Top ]


В создании документации нам помог: phpDocumentor