Версия: 6.x
burger close
Класс Uploader
Граф наследования:Uploader:
BaseModel

Подробное описание

Класс предназначен для загрузки одного файла в заданный каталог. Может формировать уникальное имя загружаемому файлу. Проверять файл по различным параметрам.

Открытые члены

 __construct ($allow_extensions=null, $upload_folder=null, $allow_mime=null)
 
 setUploadFolder ($folder)
 
 setRootFolder ($root_folder)
 
 setUploadFilename ($upload_filename)
 
 setAllowExtension ($extensions)
 
 setAllowMime ($allow_mime)
 
 setMaxSize ($max_size)
 
 setField ($field_name, $field_form)
 
 setRightChecker ($callback)
 
 checkRights ($post_file_arr)
 
 uploadFile ($post_file_arr)
 
 getAbsolutePath ()
 
 getFilename ()
 
 setFilename ($filename)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

Поля данных

 $field_form
 
 $root_folder
 
 $upload_folder
 
 $upload_filename
 
 $allow_extensions
 
 $callback_checker
 
 $allow_mime
 
 $max_size
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 

Защищенные данные

 $field_name
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 

Конструктор(ы)

__construct (   $allow_extensions = null,
  $upload_folder = null,
  $allow_mime = null 
)

Конструктор загрузчика файлов

Аргументы
array$allow_extensions- допустимые расширения, без точки
string$upload_folder- папка для загрузки относительно DOCUMENT_ROOT. по умолчанию - это ::$TMP_DIR
array$allow_mime- допустимые mime-типы файлов
Возвращает
Uploader

Методы

checkRights (   $post_file_arr)

Проверяет, возможно ли допустить загрузку файла

Аргументы
array$post_file_arr- массив входящего файла
Возвращает
false | string - False в случае, если ошибок нет, иначе текст ошибки
getAbsolutePath ( )

Возвращает полный путь к загруженному файлу

Возвращает
string
getFilename ( )

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

Возвращает
string
setAllowExtension (   $extensions)

Устанавливает допустимые расширения файлов для загрузки

Аргументы
array$extensions
Возвращает
Uploader
setAllowMime (   $allow_mime)

Устанавливает допустимые mime типы файлов

Аргументы
mixed$allow_mime
Возвращает
Uploader
setField (   $field_name,
  $field_form 
)

Устанавливает поля, которые будут фигурировать в ошибке

Аргументы
string$field_nameНазвание поля
string$field_formИдентификатор поля
Возвращает
Uploader
setFilename (   $filename)

Устанавливает имя загружаемого файла

Аргументы
string$filename
Возвращает
Uploader
setMaxSize (   $max_size)

Устанавливает максимально допустимый размер файла

Аргументы
integer$max_sizeразмер файла в байтах
Возвращает
Uploader
setRightChecker (   $callback)

Устанавливает callback, которые вызывается перед загрузкой файла Callback должен возвращать false - если загрузка может происходить, иначе текст ошибки.

Аргументы
callback$callback
Возвращает
Uploader
setRootFolder (   $root_folder)

Устанавливает абсолютный путь к корнвой папке

Аргументы
string$root_folder- абсолютный путь к корневой папке
Возвращает
Uploader
setUploadFilename (   $upload_filename)

Устанавливает имя файла, с которым необходимо загрузить файл.

Аргументы
mixed$upload_filename- Если задан null, то имя будет сгенерировано автоматически
Возвращает
Uploader
setUploadFolder (   $folder)

Устанавливает папку для загрузки файлов

Аргументы
string$folder- путь к папке, относительно корня, например /storage/tmp
Возвращает
Uploader
uploadFile (   $post_file_arr)

Загружает файл в заданную папку

Аргументы
array$post_file_arr
Возвращает
boolean(false)

Поля

$allow_extensions
$allow_mime
$callback_checker
$field_form
$field_name
protected
$max_size
$root_folder
$upload_filename
$upload_folder