Class: FileLibrary

Source Location: /modules/share/components/FileLibrary.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --Component
         |
         --DataSet
            |
            --FileLibrary

Библитека изображений

Author(s):

dr.Pavka

Variables

$uploadsDir

Constants

UPLOADS_MAIN_DIR

Methods

Inherited Constants

Inherited Variables

Class: DataSet

DataSet::$data
DataSet::$dataDescription
DataSet::$js
DataSet::$pager
DataSet::$toolbar
DataSet::$type

Class: Component

Component::$action
Component::$actionParams
Component::$builder
Component::$config
Component::$doc
Component::$document
Component::$enabled
Component::$errors
Component::$module
Component::$name
Component::$params
Component::$properties
Component::$request
Component::$response
Component::$result
Component::$rights

Class: DBWorker

DBWorker::$dbh
DBWorker::$dbhInstance
DBWorker::$translations

Class: Object

Object::$executionTime
Object::$systemConfig
Object::$values

Inherited Methods

Class: DataSet

DataSet::__construct(): Конструктор класса
DataSet::addToolbar(): Устанавливает объекты тулбара
DataSet::addTranslation(): Добавляет переводы
DataSet::addWYSIWYGTranslations(): Добавляет переводы для тулбара WYSIWYG вызывается в потомках
DataSet::build(): Проверяет наличие пострителя передает ему данные и описание данны
DataSet::buildJS(): Строит описание JS объектов
DataSet::cleanup(): Чистка от лишних и вердоносных html тегов Вызывается в single режиме
DataSet::cleanupHTML(): Удаляет потенциально опасный и лишний HTML код
DataSet::createBuilder(): Создает построитель
DataSet::createData(): Загружает данные
DataSet::createDataDescription(): Создаем объект описания данных
DataSet::createPager(): Создает листалку
DataSet::createToolbar(): Создание панелей инструментов
DataSet::defineParams(): Добавлены: Параметр datasetAction Параметр recordsPerPage
DataSet::downloadFile(): Метод возвращает файл
DataSet::formatDate(): Метод используется для форматирования даты и времени в полях date и datetime Запрашивается через AJAX Получает данные из POST и возвращает строку даты
DataSet::getData(): Возвращает объект данных
DataSet::getDataDescription(): Возвращает описание данных
DataSet::getDataSetAction(): Возвращает адрес обработчика формы
DataSet::getTitle(): Возвращает название компонента
DataSet::getToolbar(): Возвращает набор тулбаров
DataSet::getType(): Возвращает тип компонента
DataSet::loadData(): Абстрактный метод загрузки данных
DataSet::loadDataDescription(): Абстрактный метод загрузки описания данных Используется для загрузки внешнего описания данных (не из конфигурации)
DataSet::prepare(): Подготовительные действия перед вызовом основного действия.
DataSet::setData(): Устанавливает данные
DataSet::setDataDescription(): Устанавливает описание данных
DataSet::setDataSetAction(): Устанавливает адрес обработчика формы
DataSet::setTitle(): Устанавливает название компонента
DataSet::setType(): Устанавливает тип компонента

Class: Component

Component::__construct(): Конструктор класса.
Component::build(): Строит результат работы компонента используя определённый построитель.
Component::defineParams(): Определяет допустимые параметры компонента и их значения по-умолчанию в виде массива array(paramName => defaultValue).
Component::determineAction(): Определяет текущее действие
Component::disable(): Отключает отображение компонента
Component::enable(): Включает отображение компонента
Component::enabled(): Возвращает активность компонента
Component::generateError(): Генерирует ошибку и добавляет её в список ошибок компонента.
Component::getAction(): Определяет имя текущего действия компонента.
Component::getActionParams(): Возвращает параметры действия.
Component::getBuilder(): Возвращает построитель компонента.
Component::getMethodRights(): Возвращает уровень прав пользователя, необходимых для запуска текущего действия компонента.
Component::getName(): Возвращает имя компонента.
Component::getParam(): Возвращает значение параметра компонента, или null, если такого параметра не существует.
Component::getProperty(): Возвращает значение свойства компонента.
Component::handleErrors(): Обрабатывает ошибки, произошедшие во время работы компонента.
Component::isActive(): Возвращает флаг активности компонента
Component::main(): Действие по-умолчанию.
Component::prepare(): Метод подготовки данных.
Component::removeProperty(): Удаляет свойство компонента.
Component::run(): Запускает компонент на исполнение.
Component::setBuilder(): Устанавливает построитель компонента.
Component::setParam(): Устанавливает значение параметра компонента, если такой существует.
Component::setProperty(): Устанавливает значение свойства компонента.

Class: DBWorker

DBWorker::__construct(): Конструктор класса.
DBWorker::dateToString(): Дата прописью Обертка над DBWorker::_dateToString
DBWorker::translate(): Нестатический метод-обёртка над DBWorker::_translate - для удобства использования внутри производных классов.
DBWorker::_dateToString(): Возвращает дату в виде строки прописью
DBWorker::_translate(): Возвращает перевод текстовой константы из таблицы переводов для указанного языка. Если язык явно не указан - используется текущий язык.

Class: Object

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

Class Details

[line 20]
Библитека изображений

Tags:

author:	dr.Pavka
final:

[ Top ]

Class Variables

$uploadsDir =

[line 33]

Uploads Directory

Tags:

access:

private

Type:

DirectoryObject

[ Top ]

Class Methods

constructor __construct [line 44]

FileLibrary __construct(
string
$name, string
$module, Document
$document, [
$params = null])

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

Tags:

access:

public

Overrides DataSet::__construct() (Конструктор класса)

Parameters:

string	$name
string	$module
Document	$document
array	$params

[ Top ]

method add [line 411]

void add(
)

Выводит форму создания файла

Tags:

access:

protected

[ Top ]

method addClass [line 146]

array addClass(

$row)

На основании значения константы набора типов формируется поле типа class

Tags:

access:

private

Parameters:

$row

[ Top ]

method addDir [line 229]

void addDir(
)

Метод выводит форму создания новой папки

Tags:

access:

protected

[ Top ]

method defineParams [line 67]

int defineParams(
)

Переопределен параметр active

Tags:

access:

protected

Overrides DataSet::defineParams() (Добавлены: Параметр datasetAction Параметр recordsPerPage)

[ Top ]

method delete [line 295]

void delete(
)

Удаление папки/файла

Tags:

access:

protected

[ Top ]

method getRawData [line 171]

void getRawData(
)

Выводит данные в JSON формате для AJAX

Tags:

access:

protected

[ Top ]

method loadData [line 111]

void loadData(
)

Метод загрузки данных

Tags:

access:

public

Overrides DataSet::loadData() (Абстрактный метод загрузки данных)

[ Top ]

method loadDataDescription [line 82]

DataDescription loadDataDescription(
)

Загружает описание данных из таблицы

Tags:

access:

protected

Overrides DataSet::loadDataDescription() (Абстрактный метод загрузки описания данных Используется для загрузки внешнего описания данных (не из конфигурации))

[ Top ]

method main [line 212]

type main(
)

Method Description

Tags:

access:

protected

Overrides Component::main() (Действие по-умолчанию.)

[ Top ]

method rename [line 495]

void rename(
)

Переименование файла/папки

Tags:

access:

protected

[ Top ]

method save [line 268]

void save(
)

Метод сохранения файла

Tags:

access:

protected

[ Top ]

method saveDir [line 241]

void saveDir(
)

Сохранение данных о папке

Tags:

access:

protected

[ Top ]

method saveZip [line 332]

void saveZip(
)

Распаковка залитого zip файла

Tags:

access:

protected

[ Top ]

method upload [line 435]

void upload(
)

Метод для заливки файла Вызывается в невидимом фрейме и должен отдать HTML страницу включающаю скрипт

Tags:

final:
access:	protected

[ Top ]

method uploadZip [line 422]

void uploadZip(
)

Выводи форму загрузки Zip файла содержащего набор файлов

Tags:

access:

protected

[ Top ]

Class Constants

UPLOADS_MAIN_DIR = 'uploads/public'

[line 25]

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

[ Top ]

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