Наверх

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

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

Пример:

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

Методы

void redirect ([string $url = ''], [integer $http_response_code = 302]) – Редирект.

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

Пример:

// редирект на страницу новостей
$this->diafan->redirect('news/');

// редирект на внешний сайт
$this->diafan->redirect('http://www.diafan.ru/');

// редирект в административной части
// на редактирование категорий новостей
$this->diafan->redirect('news/category/');

void redirect_js ([string $url = '']) – Редиректс помошью JavaScript.

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

Используется в тех случаях, когда на экран уже выведен контент. Тогда редирект с помощью функции redirect() не сработает.

Пример:

// редирект на главную страницу сайта
$this->diafan->redirect_js('');

mixed filter (mixed $array, [string $mask = 0], [string $name = ''], [mixed $default = '']) – Приводит значение переменной к типу, соответстветствующему маске.

  • mixed $array: исходное значение или массив с исходным значением
  • string $mask: тип преобразования: url – преобразует строку для использования ее в ссылке, sql – переменную можно вставлять непосредственно в SQL-запрос, int – оставляет только числа, float – дискретное число, string – удаляются HTML-теги, специальные символы преобразуются
  • string $name: имя переменной в массиве
  • mixed $default: значение по-умолчанию

Пример:

// получает числовое значение из переменной $_POST["number"]
$integer = $this->diafan->filter($_POST, 'int', "number");

// преобразует значение переменной $_GET["searchword"]
// для того, чтобы безопасно использовать его для составления ссылок
$search = $this->diafan->filter($_GET, 'url', "searchword");
$url = BASE_PATH.'search/?searchword='.$search;

// убираем HTML-теги и преобразуем спец.символы в переменной $anons
$anons = $this->diafan->filter($anons, 'string');

// преобразуем значение пременной $name для того,
// чтобы подставлить непосредственно в SQL-запрос
$user = DB::query_fetch_array("SELECT * FROM {users} WHERE name='".$this->diafan->filter($name, 'sql')."'");

mixed configmodules (string $name, [string $module_name = ''], [integer $site_id = false], [integer $lang_id = false], [boolean $value = false])

Возвращает значение переменной $name в конфигурации модуля $module_name для языковой версии $lang_id и страницы $site_id. Если задано значение $value, функция записывает новое значение.

.

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

Пример:

if($this->diafan->configmodules("cat", "shop"))
{
    echo
'В модуле «Магазин» подключены категории.'
}

string short_text (string $text, [integer $length = 80]) – Сокращает текст.

  • string $text: исходный текст
  • integer $length: количество символов для сокращения

Пример:

echo $this->diafan->short_text('<p>Не только стильный, но и достаточно удобный в эксплуатации. Возможна навеска дополнительного снаряжения снаружи. </p>');
// вернет:
// Не только стильный, но и достаточно удобный в эксплуатации. Возможна навеска дополнительного...

echo $this->diafan->short_text('<p>Не только стильный, но и достаточно удобный в эксплуатации. Возможна навеска дополнительного снаряжения снаружи. </p>', 400);
// вернет:
// Не только стильный, но и достаточно удобный в эксплуатации. Возможна навеска дополнительного снаряжения снаружи.

string prepare_xml (string $text) – Подготавливает текст для отображения в XML-файле.

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

Пример:

// обработаем название новости для корректного
// формирования RSS-ленты новостей
echo '<title>'.$this->diafan->prepare_xml($row['name']).'</title>';

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

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

Пример:

echo $this->diafan->convert(45980);
// вернет: 44.9 Kb

echo $this->diafan->convert(367800342);
// вернет: 350.76 Mb

string encrypt (string $text) – Кодирует пароль.

  • string $text: исходный пароль

Пример:

echo $this->diafan->encrypt('123');
// вернет: 944104956716c66f4c36a236ae349053

array get_children (integer $id, string $table, [boolean $trash = true]) – Выдает массив номеров детей.

  • integer $id: номер исходного элемента
  • string $table: таблица
  • boolean $trash: не учитывать элементы, удаленные в корзину

Пример:

// получаем ID всех вложенных пунктов меню для пункта меню ID=3,
// не удаленных в корзину
$children = $this->diafan->get_children(3, "menu", true);

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

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

Пример:

// получаем ID всех родителей для текущей страницы сата
$parents = $this->diafan->get_parents($this->diafan->_site->id, 'site');

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

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

Пример:

echo $this->diafan->translit('Рюкзак «Контур 50»');
// выведет: Ryukzak-Kontur-50

string formate_from_date (string $date) – Переводит дату из в формата гггг-мм-дд в формат дд.мм.гггг.

  • string $date: дата в формате гггг-мм-дд

Пример:

echo $this->diafan->formate_from_date('2014-05-13');
// выведет: 13.05.2014

string formate_from_datetime (string $date) – Переводит дату из в формата гггг-мм-дд чч:мм в формат дд.мм.гггг чч:мм.

  • string $date: дата в формате гггг-мм-дд чч:мм

Пример:

echo $this->diafan->formate_from_datetime('2014-05-13 18:30');
// выведет: 13.05.2014 18:30

string formate_in_date (string $date) – Переводит дату из в формата дд.мм.гггг в формат гггг-мм-дд.

  • string $date: дата в формате дд.мм.гггг

Пример:

echo $this->diafan->formate_in_date('13.05.2014');
// выведет: 2014-05-13

string formate_in_datetime (string $date) – Переводит дату из в формата дд.мм.гггг чч:мм в формат гггг-мм-дд чч:мм.

  • string $date: дата в формате дд.мм.гггг чч:мм

Пример:

echo $this->diafan->formate_in_datetime('13.05.2014 18:30');
// выведет: 2014-05-13 18:30

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

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

Пример:

echo $this->diafan->unixdate('13.05.2014 18:30');
// выведет: 1399991400

Ваши комментарии и дополнения

string short_text (string $text, [integer $length = 80]) – не просто сокращает текст, а еще автоматом длописывает в конец три точки: "..."
Зарегистрируйтесь или авторизируйтесь для того, чтобы оставить комментарий.