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

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

 __construct ()
 
 getAllowExt ()
 
 noWriteRights ($right)
 
 getRootSections ($only_themes=false)
 
 getAllowEditExtensions ()
 
 getDefaultPath ()
 
 extractPath ($path)
 
 getFileList ($path, array $allow_extension=null, $only_themes=false)
 
 getTplInfo ($filename)
 
 saveFile ($fullpath, $content, $overwrite=false)
 
 downloadFile ($path)
 
 getFileContent ($path)
 
 checkFileName ($filename, $filterExtension=false)
 
 rename ($path, $new_name)
 
 delete ($path)
 
 makeDir ($path, $new_folder)
 
 getPathFromSession ()
 
 savePathInSession ($path)
 
 parseStartTpl ($start_tpl)
 
 uploadFile ($path, $file_arr)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

Поля данных

const PATH_SESSION_VAR = 'TMANAGER_PATH'
 
const ERROR_FILE_ALREADY_EXISTS = 1
 
 $theme_list
 
 $allow_ext = ['css', 'tpl', 'js', 'jpg', 'gif', 'png', 'fla', 'flv', 'svg', 'htm', 'html', 'ttf', 'odt', 'woff']
 
 $allow_edit_ext = ['css', 'tpl', 'js']
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 

Защищенные члены

 getThemeList ()
 

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

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

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

__construct ( )

Методы

checkFileName (   $filename,
  $filterExtension = false 
)

Возвращает true, если имя файла или папки соответствует требованиям системы, иначе false Добавляет в список ошибок - ошибку несоответствия имени файла

Аргументы
string$filename
boolean$filterExtension- проверять расширение
Возвращает
boolean
delete (   $path)

Удаляет файл или папку

Аргументы
string$path- специальный путь к файлу или папке
Возвращает
boolean
downloadFile (   $path)
extractPath (   $path)

Возвращает массив с подробной информацией о пути $path В массиве содержится: тип корневого элемента, имя корневого элемента, относительный путь от корневого элемента, базовый путь для корневого элмента

Аргументы
string$path
Возвращает
array
getAllowEditExtensions ( )
getAllowExt ( )

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

Возвращает
array
getDefaultPath ( )
getFileContent (   $path)

Возвращает содержимое файла

Аргументы
string$path- специальный путь к файлу
Возвращает
string
getFileList (   $path,
array  $allow_extension = null,
  $only_themes = false 
)

Возвращает список файлов по специално заданному пути.

Аргументы
string$path- путь к каталогу в формате: (theme|module):ИМЯ ТЕМЫ | МОДУЛЯ / [относительлный путь/]
array$allow_extension- массив с расширениями файлов, которые должны выводиться. Если null - то используется $this->allow_ext
Возвращает
array
getPathFromSession ( )
getRootSections (   $only_themes = false)

Возвращает корневые элементы, в которых возможно изменение шаблонов или ресурсов

Возвращает
array
getThemeList ( )
protected
getTplInfo (   $filename)

Возвращает первый Smarty комментарий у шаблона или false - если шаблон не найден Считаем, что в первом комментарии содержится краткая (до 255 символов) информация о шаблоне

Аргументы
string$filename
Возвращает
string | false
makeDir (   $path,
  $new_folder 
)

Создает папку

Аргументы
string$path- специальный путь к файлу или папке
string$new_folder- новое имя папки
noWriteRights (   $right)

Возвращает true, если у текущего пользователя нет прав на запись. Текст ошибки можно получить через getErrors

Аргументы
string$right- Проверяемое право
Возвращает
bool
parseStartTpl (   $start_tpl)

Парсит путь к начальному шаблону и возвращает отдельно путь и имя файла

Аргументы
string$start_tpl
Возвращает
array | bool(false) - false в случае если $start_tpl некорректный
rename (   $path,
  $new_name 
)

Переименовывает файл или папку

Аргументы
string$path- специальный путь к файлу или папке
string$new_name- новое имя файла, папки
Возвращает
boolean
saveFile (   $fullpath,
  $content,
  $overwrite = false 
)
savePathInSession (   $path)
uploadFile (   $path,
  $file_arr 
)

Помещает загруженный файл в директорию $path. Для выполнения необходимы права на запись у модуля. Проверяет соответствие расширения файла допущеным

Аргументы
string$pathПапка для загрузки файла
array$file_arrМассив со сведениями о файле, полеченном из POST

Поля

$allow_edit_ext = ['css', 'tpl', 'js']
$allow_ext = ['css', 'tpl', 'js', 'jpg', 'gif', 'png', 'fla', 'flv', 'svg', 'htm', 'html', 'ttf', 'odt', 'woff']
$field_list
protected
$theme_list
const ERROR_FILE_ALREADY_EXISTS = 1
const PATH_SESSION_VAR = 'TMANAGER_PATH'