Описание
[ Описание ]   [ Функции ]

Вспомогательные функции ядра системы

Файл содержит наиболее востребованные функции ядра системы. Нет смысла делать отдельный класс для реализации этих функций. Конструктор класса и обращение к методам через имя класса только снизит читабельность кода.

  • author: Казбек Елекоев <elekoev@binn.ru>
  • version: 4.0
  • copyright: Copyright (c) 2007, OOO "СИБИЭС Групп"
Функции
  [ Описание ]   [ Функции ]
sb_404 (строка 1689)

Выкидывает 404 ошибку и отображает нужную страницу

void sb_404 ()
sb_add_rights (строка 1674)

Добавляет стандартные описания прав для событий работы с разделами и элементами

void sb_add_rights ()
sb_array_stripslashes (строка 555)

Функция убирает лишние слэши (/) из всех значений массива

void sb_array_stripslashes ( &$array, array $array)
  • array $array: Массив, из значений которого надо убирать слэши
  • &$array
sb_array_swap (строка 1625)

Меняет местами два элемента ассоциативного массива

  • return: Массив, в котором элементы поменялись местами.
array sb_array_swap ( &$array, string $key1, string $key2, array $array)
  • array $array: Массив, элементы которого меняются местами.
  • string $key1: Ключ первого элемента.
  • string $key2: Ключ второго элемента.
  • &$array
sb_cmp_array (строка 1660)

Используется для сравнения элементов массива, вызывается функцией uasort

Ключ массивов, по которому производится сравнение, задается в глобальной переменной $GLOBALS['sb_cmp_sort_field'].

  • return: -1, если $ar1 < $ar2; 1, если $ar1 > $ar2; 0, если $ar1 = $ar2
int sb_cmp_array (array $ar1, array $ar2)
  • array $ar1: Элемент первого массива.
  • array $ar2: Элемент второго массива.
sb_date (строка 583)

Возвращает строку представления даты и времени согласно заданному формату

  • return: Строка представления даты и времени согласно заданному формату.
string sb_date (string $layout, [int $time = false], [int $time_zone = false], [bool $daylight_saving = ''])
  • string $layout: Формат вывода даты и времени.
  • int $time: Время (UNIX timestamp).
  • int $time_zone: Временная зона (от -12 до 13).
  • bool $daylight_saving: Учитывать переход на летнее время или нет.
sb_datetoint (строка 647)

Переводит строковое представление даты (d.m.Y H:i) в Unix Timestamp

  • return: Unix Timestamp
int sb_datetoint (string $date)
  • string $date: Строковое представление даты (d.m.Y H:i). Часть H:i может отсутствовать.
sb_htmlentities (строка 352)

Преобразует все символы строки в HTML-мнемоники

  • return: Преобразованная строка
string sb_htmlentities (string $str, [int $quote = ENT_QUOTES], [string $charset = ''])
  • string $str: Строка, символы которой будут преобразованы
  • int $quote: Будут ли преобразовываться одинарные и двойные кавычки. Возможные значения - ENT_QUOTES, ENT_NOQUOTES
  • string $charset: Кодировка строки
sb_htmlspecialchars (строка 391)

Преобразует специальные символы строки в HTML-мнемоники

  • return: Преобразованная строка
string sb_htmlspecialchars (string $str, [int $quote = ENT_QUOTES], [string $charset = ''])
  • string $str: Строка, символы которой будут преобразованы
  • int $quote: Будут ли преобразовываться одинарные и двойные кавычки. Возможные значения - ENT_QUOTES, ENT_NOQUOTES
  • string $charset: Кодировка строки
sb_html_entity_decode (строка 371)

Преобразует HTML-мнемоники в символы

  • return: Преобразованная строка
string sb_html_entity_decode (string $str, [int $quote = ENT_QUOTES], [ $charset = ''])
  • string $str: Строка, символы которой будут преобразованы
  • int $quote: Будут ли преобразовываться одинарные и двойные кавычки. Возможные значения - ENT_QUOTES, ENT_NOQUOTES
  • $charset
sb_inttoip (строка 408)

Переводит целое число в строку IP-адреса

  • return: IP-адрес
string sb_inttoip (int $i)
  • int $i: Целое число
sb_iptoint (строка 424)

Переводит строку IP-адреса в целое число

  • return: Целое число
int sb_iptoint (string $ip)
  • string $ip: Строка IP-адреса
sb_make_absolute_url (строка 524)

Формирование абсолютных адресов в тексте

Все относительные адреса в тегах a, img, area преобразуются в абсолютные адреса.

void sb_make_absolute_url ( &$text, string $text)
  • string $text: Ссылка на преобразуемый текст
  • &$text
sb_parse_date (строка 1734)

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

  • return: Строку со значением даты преобразованную в нужный формат
string sb_parse_date (int $time, str $templ, [str $lang = 'ru'])
  • int $time: Время timstamp
  • str $templ: Макет вывода даты
  • str $lang: Язык
sb_php_error_reporting (строка 541)

Функция записи ошибок PHP в системный журнал

Ошибки типа E_STRICT в журнал не записываются.

void sb_php_error_reporting (int $errorno, string $error, string $file, int $line)
  • int $errorno: Код ошибки
  • string $error: Описание ошибки
  • string $file: Файл, в котором произошла ошибка
  • int $line: Строка в файле
sb_replace_domain (строка 1321)

Заменяет имя домена на пустую строку в значениях массива

void sb_replace_domain ( &$array, array $array)
  • array $array: Массив, в котором производится замена.
  • &$array
sb_replace_php (строка 1346)

Вырезает из значений массива PHP-код

void sb_replace_php ( &$array, array $array)
  • array $array: Массив, в котором производится замена.
  • &$array
sb_resize_image (строка 677)

Уменьшает размер изображения

  • return: TRUE, если изображение сжато успешно, FALSE в ином случае.
bool sb_resize_image (string $src, string $dest, int $width, int $height, [int $quality = 80])
  • string $src: Путь и имя файла уменьшаемого изображения.
  • string $dest: Путь и имя файла, куда будет сохранено сжатое изображение.
  • int $width: Ширина генерируемого изображения.
  • int $height: Высота генерируемого изображения.
  • int $quality: Процент сжатия генерируемого изображения.
sb_setcookie (строка 483)

Устанавливает cookie

Если значение cookie равно '', то cookie удаляется.

void sb_setcookie (string $name, [mixed $value = ''], [int $expire = 0], [string $path = '/'])
  • string $name: Имя cookie
  • mixed $value: Значение cookie
  • int $expire: Время жизни cookie в секундах
  • string $path: Путь, для которого устанавливается cookie. / - на весь домен.
sb_short_text (строка 295)

Обрезает текст до заданной длины, добавляя ... в конце

Функция работает только с "чистым" текстом. HTML-текст может обрабатываться некорректно.

  • return: Обрезанный текст
string sb_short_text (string $str, string $num)
  • string $str: Текс, который будет обрезан
  • string $num: Максимальная длина текста
sb_show_message (строка 446)

Вывод сообщений внутри системы

Возможные типы сообщений:

  • information - информационное сообщение
  • warning - сообщение об ошибке
  • loading - сообщение о загрузке

  • return: Оформленное сообщение
string sb_show_message (string $str, [bool $static = false], [string $type = 'information'], [bool $return = false])
  • string $str: Строка с сообщением, может содержать HTML-теги
  • bool $static: Выводить статичное (true) или всплывающее (false) сообщение
  • string $type: Тип сообщения
  • bool $return: Выводить сообщение или вернуть в виде строки (true - вернуть в виде строки, false - вывести сообщение)
sb_stripos (строка 199)

Ищет позицию первого вхождения подстроки в строку (без учета регистра)

  • return: Позиция в строке.
int sb_stripos (string $haystack, string $needle, [int $offset = null], [string $charset = ''])
  • string $haystack: Строка, в которой производится поиск.
  • string $needle: Подстрока, которую мы ищем.
  • int $offset: Позиция в строке $haystack, начиная с которой необходимо производить поиск.
  • string $charset: Кодировка строки.
sb_strlen (строка 143)

Определяет кол-во символов в строке

Если доступна функция mb_strlen, то используем ее. Она корректно отрабатывает для большинства используемых кодировок. Если же эта функция недоступна, то используем strlen.

  • return: Кол-во символов в строке
int sb_strlen (string $str, [string $charset = ''])
  • string $str: Строка, кол-во символов которой мы пытаемся получить
  • string $charset: Кодировка строки
sb_strpos (строка 171)

Ищет позицию первого вхождения подстроки в строку

  • return: Позиция в строке.
int sb_strpos (string $haystack, string $needle, [int $offset = null], [string $charset = ''])
  • string $haystack: Строка, в которой производится поиск.
  • string $needle: Подстрока, которую мы ищем.
  • int $offset: Позиция в строке $haystack, начиная с которой необходимо производить поиск.
  • string $charset: Кодировка строки.
sb_strtolat (строка 333)

Перевод строки в латиницу

  • return: Преобразованная строка
string sb_strtolat (string $str, [string $charset = ''])
  • string $str: Преобразуемая строка
  • string $charset: Кодировка строки
sb_strtolower (строка 66)

Перевод строки в нижний регистр

Если доступна функция mb_strtolower, то используем ее. Она корректно отрабатывает для большинства используемых кодировок. Если же эта функция недоступна, то используем sb_str_replace и массивы $GLOBALS['sb_str_upper_interval'] и $GLOBALS['sb_str_lower_interval'].

string sb_strtolower (string $str, [string $charset = ''])
  • string $str: Строка, которую нужно преобразовать
  • string $charset: Кодировка строки
sb_strtoupper (строка 30)

Перевод строки в верхний регистр

Если доступна функция mb_strtoupper, то используем ее. Она корректно отрабатывает для большинства используемых кодировок. Если же эта функция недоступна, то используем sb_str_replace и массивы $GLOBALS['sb_str_upper_interval'] и $GLOBALS['sb_str_lower_interval'].

string sb_strtoupper (string $str, [string $charset = ''])
  • string $str: Строка, которую нужно преобразовать
  • string $charset: Кодировка строки
sb_str_replace (строка 100)

Замена всех вхождений подстроки в строке

Если кодировка строки UTF-8, то используем preg_replace c модификатором u. Иначе используется функция str_replace.

  • return: Преобразованная строка
string sb_str_replace (mixed $search, mixed $replace, string $str, [string $charset = ''], [bool $case = false])
  • mixed $search: Подстрока или массив подстрок, которые надо заменить
  • mixed $replace: Подстрока или массив подстрок, на которые надо заменить
  • string $str: Строка, в которой производится замена
  • string $charset: Кодировка строки
  • bool $case: Регистрозависимая замена (false) или нет (true)
sb_substr (строка 256)

Возвращает подстроку из строки

Если доступна функция mb_substr, то используем ее. Она корректно отрабатывает для большинства используемых кодировок. Если же эта функция недоступна, то используем substr.

  • return: Подстрока
string sb_substr (string $str, int $start, [int $length = null], [string $charset = ''])
  • string $str: Строка, подстроку которой пытаемся получить
  • int $start: Начальная позиция в строке
  • int $length: Кол-во символов
  • string $charset: Кодировка строки
sb_substr_count (строка 226)

Возвращает кол-во вхождений подстроки в строку

  • return: Кол-во вхождений подстроки в строку.
int sb_substr_count (string $haystack, string $needle, [string $charset = ''])
  • string $haystack: Строка, в которой производится поиск.
  • string $needle: Подстрока, которую мы ищем.
  • string $charset: Кодировка строки.
sb_unzip (строка 1213)

Разархивирует ZIP-архив в указанную папку

  • return: Массив файлов, извлеченных из архива (с путями) или FALSE, в случае возникновения ошибки.
mixed sb_unzip (string $file, string $path, [ $accept_types = array()])
  • string $file: Полный путь к ZIP-архиву.
  • string $path: Путь, куда будет разархивирован архив.
  • $accept_types
sb_watermark_image (строка 852)

Накладывает водяной знак в виде текста или картинки на изображение

  • return: TRUE, если водяной знак наложен успешно, FALSE в ином случае.
bool sb_watermark_image (string $src, string $dest, [set $position = 'BR'], [integer $opacity = '60'], [integer $margin = '10'], [string $watermark = ''], [string $copyright = ''], [string $color = '#000000'], [string $font = 'arial.ttf'], [ $size = 11], integer $font_size)
  • string $src: Путь и имя файла исходного изображения.
  • string $dest: Путь и имя файла, куда будет сохранено новое изображение.
  • set $position: Позиция водяного знака. Возможные значения:
    • TL - Верхний левый угол
    • TM - Сверху по центру
    • TR - Верхний правый угол
    • CL - По центру слева
    • C - По центру
    • CR - По центру справа
    • BL - Нижний левый угол
    • BM - Снизу по центру
    • BR - Нижний правый угол
    • RND - Случайным образом
  • integer $opacity: Процент прозрачности водяного знака.
  • integer $margin: Отступ для водяного знака.
  • string $watermark: Путь к файлу с водяным знаком.
  • string $copyright: Текст, накладываемый на изображение.
  • string $color: Цвет текста, накладываемого на изображение.
  • string $font: Шрифт для текста, накладываемого на изображение. Возможные значения:
    • arial.ttf - Arial
    • tahoma.ttf - Tahoma
    • times.ttf - Times New Roman
    • verdana.ttf - Verdana
  • integer $font_size: Размер шрифта в пикселах для текста, накладываемого на изображение.
  • $size
Техническая поддержка:
Сайт: http://www.sbuilder.ru/tec_support.php
E-mail: support@sbuilder.ru
Copyright © 2001-2008, ООО "СИБИЭС Групп"
Документация сгенерирована с использованием phpDocumentor