Официальный сайт TextCMS
TextCMS — все просто!





Рассказать



Модуль storage

» » Модуль storage

Функции

 storage_get_entries ($module)
 
 storage_get_dir ($module, $entry)
 
 storage_get_items ($module, $entry, $mask)
 
 storage_create_entry ($module, $entry)
 
 storage_show_entries ($module, $data, $actions)
 
 show_storage_items ($module, $entry, $mask)
 
 storage_delete_entry ($module, $entry)
 

Функции

show_storage_items ( $module,
 $entry,
 $mask 
)

Формирует HTML-код на основе указанного шаблона для каждого элемента в хранилище

Аргументы
string$moduleНазвание модуля
array$dataМассив данных, которые следует испольовать в шаблоне
array$actionsМассив действий, где ключи – названия действий (параметров a=действие), а значения – текстовые описания действий
Возвращает
HTML-код со списком хранилищ В данный момент не реализовано!
storage_create_entry ( $module,
 $entry 
)

Создание нового хранилища для указанного модуля

Аргументы
string$moduleИмя модуля, для которого создается хранилище
string$entryИдентификатор хранилища. Должен быть допустимым именем файла
Возвращает
integer Результат создания: 0 – хранилище создано -1 – недопустимый идентификатор хранилища -2 – хранилище уже существует -3 – не удалось создать хранилище по иным причинам
storage_delete_entry ( $module,
 $entry 
)

Удаление хранилища и всех содержащихся в нем данных

Аргументы
string$moduleИмя модуля, для которого создано хранилище
string$entryИдентификатор хранилища
Возвращает
boolean
storage_get_dir ( $module,
 $entry 
)

Получение каталога, в котором хранятся данные хранилища с именем $entry для модуля $module

Аргументы
$modulestring Имя модуля
$entrystring Идентификатор хранилища для модуля
Возвращает
string путь к каталогу, в котором хранятся данные для хранилища с указанным идентификатором
storage_get_entries ( $module)

Получение списка хранилищ для указанного модуля. Хранилище представляет собой каталог вида имя-модуля_идентификатор-хранилища (например, gallery_my), расположенный в каталоге данных сайта (files/siteN).

Аргументы
string$moduleИмя модуля, для которого нужно получить хранилища
Возвращает
array Список хранилищ в виде массива строк
storage_get_items ( $module,
 $entry,
 $mask 
)

Получение списка хранимых элементов из указанного хранилища.

Аргументы
string$moduleИмя модуля
string$entryИдентификатор хранилища для модуля
string$maskМаска, которой должны соответстовать файлы в хранилище. Должна быть регулярным выражением (проверяется с помощью preg_match)
Возвращает
array Массив с именами файлов в каталоге хранилища, соответствующих маске.
storage_show_entries ( $module,
 $data,
 $actions 
)

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

Аргументы
string$moduleНазвание модуля
array$dataМассив данных, которые следует испольовать в шаблоне
array$actionsМассив действий, где ключи – названия действий (параметров a=действие), а значения – текстовые описания действий
Возвращает
HTML-код со списком хранилищ В данный момент не реализовано!

» » Модуль storage