Docs For Class sbUploader

Описание

Класс, отвечающий за загрузку файлов из HTML-формы.

author: Казбек Елекоев <elekoev@binn.ru>
version: 4.0
copyright: Copyright (c) 2007, OOO "СИБИЭС Групп"

Располагается в /lib/sbUploader.inc.php (строка 19)

Переменные (список)

array $mFile

Методы (список)

bool copy (string $dir_name, [string $file_name = ''], [int $overwrite_mode = 1])

string getError ()

void init ()

bool move (string $dir_name, [string $file_name = ''], [int $overwrite_mode = 1])

void setMaxFileSize (int $size)

void setMaxImageSize (int $width, int $height)

bool upload ([string $file_field_name = ''], [array $accept_types = array()])

Переменные

array $mFile = false (строка 26)

Массив, содержащий информацию о загружаемом файле

access: public

Методы

copy (строка 277)

Копирует загруженный файл в указанное место

return: TRUE, если файл был скопирован успешно, FALSE в ином случае.
access: public

bool copy (string $dir_name, [string $file_name = ''], [int $overwrite_mode = 1])

string $dir_name: Директория, в которую будет скопирован файл.
string $file_name: Имя файла, под которым будет сохранен загруженный файл.
int $overwrite_mode: Режим перезаписи (1 - перезаписывать, 2 - сгенерировать новое имя, 3 - выдать ошибку).

getError (строка 83)

Возвращает текст ошибки или пустую строку, если ошибок не было

return: Текст ошибки.
access: public

string getError ()

init (строка 91)

Обнуляет текст ошибки для нового файла

access: public

void init ()

move (строка 175)

Перемещает загруженный файл в указанное место

return: TRUE, если файл был перемещен успешно, FALSE в ином случае.
access: public

bool move (string $dir_name, [string $file_name = ''], [int $overwrite_mode = 1])

string $dir_name: Директория, в которую будет перемещен файл.
string $file_name: Имя файла, под которым будет сохранен загруженный файл.
int $overwrite_mode: Режим перезаписи (1 - перезаписывать, 2 - сгенерировать новое имя, 3 - выдать ошибку).

setMaxFileSize (строка 61)

Устанавливает максимально разрешенный размер файла (0 - без ограничений)

access: public

void setMaxFileSize (int $size)

int $size: Максимально разрешенный размер файла.

setMaxImageSize (строка 72)

Устанавливает максимально разрешенные ширину и высоту картинки (в случае загрузки графических файлов)

access: public

void setMaxImageSize (int $width, int $height)

int $width: Максимально разрешенная ширина картинки.
int $height: Максимально разрешенная высота картинки.

upload (строка 108)

Инициализирует переменную mFile информацией о загружаемом файле

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

return: TRUE, если все проверки прошли успешно и ошибок нет, FALSE в ином случае (текст ошибки можно получить с помощью метода getError).
access: public

bool upload ([string $file_field_name = ''], [array $accept_types = array()])

string $file_field_name: Имя поля в форме (параметр name) для файла.
array $accept_types: Массив разрешенных для закачки расширений файлов.