Главная / Документация / Полное руководство / Разработчикам / Подключения (API) /

Общие функции

Общие функции принадлежат к абстрактному классу Core, который наследуются другими классами. Эти функции доступны через основной объект $diafan, создание которого инициирует генерирование страницы. В модулях фунции доступны для вызова через объект $this->diafan.

Пример:

$this->diafan->configmodules("list_img");

void redirect([string $url = ''], [integer $http_response_code = 302]) – редирект. Адрес для редиректа можно передавать как в абсолютном виде (http://www.site.ru/), так и в относительном (news/).

access: public
string $url: URL для редиректа
integer $http_response_code: статус-код

void redirect_js([string $url = '']) – редирект с помошью JavaScript. Используется в случае, если нельзя использовать редирект с помощью заголовков страниц.

access: public
string $url: URL для редиректа

integer unixdate(string $date) – возвращает дату, переданную в формате dd.mm.yyyy hh:ii в виде даты в формате UNIX.

access: public
string $date: дата в формате dd.mm.yyyy hh:ii

mixed get_param(array $array, string $name, [mixed $default = null], [integer $mask = 0]) – функция получает из массива переменную и приводя ее к типу в соответствии с маской (0 – вырезает все пробелы, 1 – вырезает тэги, 2 – оставляет только числа).

access: public
array $array: массив с переменной
string $name: имя переменной в массиве
mixed $default: значение по-умолчанию
integer $mask: тип преобразования

Пример:

$id = $this->diafan->get_param($_GET, 'cid', 0, 2);

mixed configmodules (string $name, [string $module_name = 'site'], [integer $site_id = 0], [integer $lang_id = 0]) – функция возвращает значение переменной $name в конфигурации модуля $module_name для языковой версии $lang_id и страницы $site_id.

access: public
string $name: имя переменной в конфигурации
string $module_name: название модуля
integer $site_id: раздел сайта
integer $lang_id: номер языковой версии

string path_module([integer $page_act = 0], [integer $parentid_act = 0], [integer $config_act = 0], [integer $cat_act = 0], [integer $catid_act = 0]) – возвращает url страницы с сохранением переменных page, parent, config, cat, catid. Можно отказаться от сохранения значений этих переменных в адресе, передав необязательные параметры.

access: public
integer $page_act: убрать из адреса текущей страницы переменную page
integer $parent_act: убрать из адреса текущей страницы переменную parent
integer $config_act: убрать из адреса текущей страницы переменную config
integer $cat_act: убрать из адреса текущей страницы переменную cat
integer $catid_act: убрать из адреса текущей страницы переменную catid

Пример:

$this->diafan->path_module(1, 0, 0, 0, 1);

выдаст адрес без сохранения переменной page (страница) и catid (раздел).

string short_text(string $text, [integer $count = 80]) – возвращает сокращенный текст.

access: public
string $text: текст
integer $count: количество символов для сокращения

string convert(integer $size) – конвертирует количество бит в байты, килобайты, мегабайты.

access: public
integer $size: размер в байтах

string search_theme(intger $id) – выводит название шаблона для страницы с номером id.

access: public
integer $size: размер в байтах

array get_children(integer $id, string $table) – выдает массив номеров детей.

access: public
integer $id: номер исходного элемента
string $table: таблица

array get_parents(integer $id, string $table) – выдает массив номеров родителей.

access: public
integer $id: номер исходного элемента
string $table: таблица

string code_password(string $value) – кодирует пароль.

access: public
string $value: исходный пароль

string translit(string $text) – переводит кириллицу в транслит для строки text.

access: public
string $text: исходный текст

string format_price(integer $price) – формтирует цену price в соответсвии с конфигурацией модуля «Магазин».

access: public
integer price: исходная цена

Не понятно? Уточните