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

Class: FileUploader

Source Location: /framework/FileUploader.class.php

Class Overview

Object
   |
   --FileUploader

Загрузчик файлов на сервер.


Author(s):

  • 1m.dm

Variables

Methods


Child classes:

VideoUploader
Загрузчик и конвертер видео файлов в формат flv

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 22]
Загрузчик файлов на сервер.



Tags:

author:   1m.dm


[ Top ]


Class Variables

$ext =

[line 41]



Tags:

var:   расширение файла
access:   private

Type:   string


[ Top ]

$file = array()

[line 29]



Tags:

var:   описание загружаемого файла - $_FILE
see:   PHP manual, POST method uploads
access:   protected

Type:   array


[ Top ]

$FileObjectName =

[line 47]



Tags:

var:   имя, под которым загруженный файл сохранен на сервере
access:   protected

Type:   string


[ Top ]

$FileRealName =

[line 49]



Tags:

access:   protected

Type:   mixed


[ Top ]

$restrictions = array()

[line 35]



Tags:

var:   ограничения для загружаемого файла
access:   private

Type:   array


[ Top ]

$uploadsPath =  ''

[line 55]



Tags:

var:   путь к корневому каталогу загружаемых файлов
access:   private

Type:   string


[ Top ]

$validated =  false

[line 61]



Tags:

var:   флаг, указывающий была ли произведена валидация (проверяется методом upload)
access:   private

Type:   boolean


[ Top ]



Class Methods


constructor __construct [line 71]

void __construct( [ $restrictions = array()])

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



Tags:

access:   public


Overridden in child classes as:

VideoUploader::__construct()

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

Parameters:

Array   $restrictions  

[ Top ]

method cleanUp [line 234]

void cleanUp( )

Очищает состояние объекта для повторного использования.



Tags:

access:   public


[ Top ]

method generateFilename [line 192]

void generateFilename( $dir, $ext)



Tags:

access:   protected


Parameters:

   $dir  
   $ext  

[ Top ]

method getExtension [line 223]

string getExtension( )

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



Tags:

access:   public


[ Top ]

method getFileObjectName [line 209]

string getFileObjectName( )

Возвращает имя загруженного файла.



Tags:

access:   public


[ Top ]

method getFileRealName [line 213]

void getFileRealName( )



Tags:

access:   public


[ Top ]

method setFile [line 99]

void setFile( $file)

Устанавливает описание файла.



Tags:

access:   public


Parameters:

array   $file  

[ Top ]

method setRestrictions [line 88]

void setRestrictions( $restrictions)

Устанавливает ограничения которым должен соответствовать загружаемый

array( 'ext' => array('jpg', 'gif') )




Tags:

access:   public


Parameters:

array   $restrictions  

[ Top ]

method upload [line 145]

boolean upload( string $dir)

Фактическая загрузка файла в определенную директорию.



Tags:

access:   public


Overridden in child classes as:

VideoUploader::upload()

Parameters:

string   $dir   директория внутри корневого каталога загружаемых файлов

[ Top ]

method validate [line 114]

boolean validate( )

Валидация загружаемого файла.



Tags:

access:   public


[ Top ]

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