Файл system/framework/functions.php

Глобальные функции. Подробнее...

Классы

Функции

Подробное описание

Глобальные функции.

Функции

addToList ( $  item,
$  value,
$  domain = '' 
)

Добавляет значение в указанный список.

Аргументы:
string $item Короткий или полный идентификатор списка (дополнения на базе плагинов: listdata, liststr, listnum и др.).
string $value Значение.
string $domain='' Идентификатор сайта, если не указано то текущий.
Возвращает:
boolean Успешность операции.

appendToFile ( $  file,
$  data 
)

Добавление данных в конец файла.

Аргументы:
string $file Файл.
string $data Дописываемые данные.
Возвращает:
mixed Количество записанных байт или false.

array_multisort_key ( $  array,
$  key,
$  type = SORT_ASC,
$  cmp_func = 'strcmp' 
)

Сортировка массива записей по ключу в записях.

Аргументы:
array $array Сортируемый массив записей.
string $key Ключ в записях по которому сортировать, либо массив ключей.
integer $type=SORT_ASC Способ сортировки.
string $cmp_func='strcmp' Функция для сравнения значений.
Возвращает:
array Отсортированный массив.

clearCacheImage ( $  name,
$  domain = '' 
)

Удаляет все закэшированные изображения для заданного.

Аргументы:
string $name Имя файла исходного избражения.
string $domain Идентификатор сайта, если не указано то текущий.

clearDir ( $  dirName  ) 

Удаление всего содержимого из каталога.

Аргументы:
string $dirName Удаляемый каталог.
Возвращает:
boolean Успешность операции.

copyDir ( $  dirIn,
$  dirTo,
$  replace = false,
$  newonly = false 
)

Копирование каталога со всем содержимым.

Аргументы:
string $dirIn Копируемый каталог.
string $dirTo Новый каталог.
boolean $replace Заменять существующие файлы.
boolean $newonly Заменять существующие файлы, только более новыми.
Возвращает:
boolean Успешность операции.

copyfile ( $  in,
$  to,
$  replace = false,
$  newonly = false 
)

Копирование файла.

Аргументы:
string $in Копируемый файл.
string $to Новый файл.
boolean $replace Заменить если файл уже существует.
boolean $newonly Заменить только если файл более старый.
Возвращает:
boolean Успешность операции.

createArchive ( $  file,
$  path 
)

Создает архив tar.gz и помещает в него содержмое указанного каталога или файла.

Аргументы:
string $file Имя файла архива (Обязательное расширение tar.gz).
string $path Файл или каталог который помещается в архив.
Возвращает:
boolean Успешность операции.

delDir ( $  dirName  ) 

Удаление каталога со всеми файлами.

Аргументы:
string $dirName Удаляемый каталог.
Возвращает:
boolean Успешность операции.

delfile ( $  file  ) 

Удаление файла.

Аргументы:
string $file Удаляемый файл.
Возвращает:
boolean Успешность операции.

delFilesByDir ( $  dirName,
$  files = array() 
)

Удаление всех файлов из каталога с сохранением структуры каталогов.

Аргументы:
string $dirName Каталог.
string $files=array() Список имен файлов, которые удалять. Если список пустой, то удаляются все.
Возвращает:
boolean Успешность операции.

DelRegFile ( $  id  ) 

Удаляет зарегистрированный файл.

Аргументы:
integer $id Числовой идентификатор файла который будет удален.

DelRegImage ( $  id  ) 

Удаляет зарегистрированное изображение.

Аргументы:
integer $id Числовой идентификатор изображения которое будет удалено.

DelRegSectionFiles ( $  idsec  ) 

Удаляет все зарегистрированные файлы принадлежащие разделу.

Аргументы:
integer $idsec Числовой идентификатор раздела.

DelRegSectionImages ( $  idsec  ) 

Удаляет все зарегистрированные изображения принадлежащие разделу.

Аргументы:
integer $idsec Числовой идентификатор раздела.

DelRegSectionItemFiles ( $  idsec,
$  iditem 
)

Удаляет все зарегистрированные файлы принадлежащие элементу раздела.

Аргументы:
integer $idsec Числовой идентификатор раздела.
integer $iditem Числовой идентификатор элемента.

DelRegSectionItemImages ( $  idsec,
$  iditem 
)

Удаляет все зарегистрированные изображения принадлежащие элементу раздела.

Аргументы:
integer $idsec Числовой идентификатор раздела.
integer $iditem Числовой идентификатор элемента.

escapeFileName ( $  name,
&$  ext = null 
)

Проверяет корректность расширения файла и преобразует имя файла в транслит.

Аргументы:
string $name Имя файла.
string &$ext Расширение полученного имени файла.
Возвращает:
string Полученное имя файла или false, если у файла некорректное расширение.

extractArchive ( $  file,
$  path 
)

Извлекает содержимое из архива tar.gz.

Аргументы:
string $file Имя файла архива.
string $path Каталог в который будет извлечено содержимое архива.

getAccess ( $  aname,
$  section = SECTION,
$  default = true 
)

Определяет возможность доступа.

Аргументы:
string $aname Операция для которой проверяется доступ.
string $section=SECTION Полный строкой идентификатор раздела, если не указано то текущий.
string $default=true Доступ по умолчанию (если не создано дополнение "Группы пользователей")
Возвращает:
boolean Возможность доступа.

getDomain ( $  item  ) 

Возвращает идентификатор сайта, которому принадлежит полный строковой идентификатор раздела/дополнения.

Аргументы:
string $item Строковой идентификатор раздела/дополнения.
Возвращает:
string Идентификатор сайта.

getFields ( $  item,
$  type = '',
$  get = '' 
)

Возвращает данные о дополнительных полях раздела или дополнения.

Аргументы:
string $item Полный строковой идентификатор раздела или дополнения.
string $type='' Тип полей для выборки.
string $get='' Какие данные извлекать, по умолчанию описание.
Возвращает:
array Асоциированный массив: Идентификатор поля => Описание.

getFilesByDir ( $  dirName  ) 

Удаление всех файлов из каталога.

Аргументы:
string $dirname Каталог.
Возвращает:
array Удаленные файлы.

getHostByDomain ( $  name  ) 

Возвращает домен сайта по его идентификатору.

Аргументы:
string $name Идентификатор сайта.
Возвращает:
string Домен.

getkeywords ( $  string,
$  wlen = 5,
$  wcount = 50 
)

Генерирует список наиболее часто встречающихся слов в тексте.

Аргументы:
string $string Исходный текст.
integer $wlen=5 Минимальная длина слова.
integer $wcount=50 Количество отбираемых слов.
Возвращает:
string Строка со словами.

getLang ( $  section  ) 

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

Аргументы:
string $section Строковой идентификатор раздела.
Возвращает:
string Идентификатор языковой версии.

getLists (  ) 

Возвращает данные обо всех существующих списках (дополнения на базе плагинов: listdata, liststr, listnum и др.

).

Возвращает:
array Ассоциированный массив: строковой идентификатор => название.

getMimeByExt ( $  ext  ) 

Возвращает mime тип файла по его расширению.

Аргументы:
string $ext Расширение файла.
Возвращает:
string Mime тип.

getMimeByFile ( $  filename  ) 

Возвращает mime тип по названию файла.

Аргументы:
string $ext Название файла.
Возвращает:
string Mime тип.

getModuleBySection ( $  section  ) 

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

Аргументы:
string $section Полный строковой идентификатор раздела.
Возвращает:
string Идентификатор модуля.

getName ( $  item  ) 

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

Аргументы:
string $item Полный строковой идентификатор раздела/дополнения.
Возвращает:
string Короткий строковой идентификатор.

getOption ( $  item,
$  var 
)

Возвращает значение опции.

Аргументы:
string $item Полный идентификатор раздела или дополнения, в котором находится опция.
string $var Идентификатор опции.
Возвращает:
mixed Значение опции.

getOptions ( $  item  ) 

Возвращает массив значений всех опций раздела или дополнения.

Аргументы:
string $item Полный идентификатор раздела или дополнения, в котором находится опция.
Возвращает:
array Асоциированный массив: идентификатор опции => значение.

getPluginByStructure ( $  structure  ) 

Возвращает идентификатор плагина, на базе которого создано дополнение.

Аргументы:
string $structure Полный строковой идентификатор дополнения.
Возвращает:
string Идентификатор плагина.

getregfilepath ( $  id  ) 

Возвращает путь к зарегистрированному файлу.

Аргументы:
string $id Числовой идентификатор зарегистрированного файла.
Возвращает:
string Путь к файлу.

getregimagepath ( $  id  ) 

Возвращает путь к зарегистрированному файлу.

Аргументы:
string $id Числовой идентификатор зарегистрированного файла.
Возвращает:
string Путь к файлу.

getSectionById ( $  id,
$  domain = '' 
)

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

Аргументы:
integer $id Числовой идентификатор раздела.
string $domain='' Идентификатор сайта, если не указано то текущий.
Возвращает:
string Полный строковой идентификатор раздела.

getSectionByModule ( $  module,
$  domain = '' 
)

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

Аргументы:
string $module Идентификатор модуля.
string $domain='' Идентификатор сайта, если не указано то текущий.
Возвращает:
string Полный строковой идентификатор раздела.

getSectionId ( $  section  ) 

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

Аргументы:
string $section Полный строковой идентификатор раздела.
Возвращает:
integer Числовой идентификатор раздела.

getSectionLink ( $  section  ) 

Возвращает ссылку на главную страницу раздела.

Аргументы:
string $section Полный строковой идентификатор раздела.
Возвращает:
string Ссылка на главную страницу раздела.

getSectionsByModule ( $  module,
$  domain = '' 
)

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

Аргументы:
string $module Идентификатор модуля.
string $domain='' Идентификатор сайта, если не указано то текущий.
Возвращает:
array Массив полных строковых идентификаторов разделов.

getStringId ( $  string,
$  latname,
$  table,
$  where = "" 
)

Возвращает уникальный строковой идентикатор для записи в таблице БД.

В таблице должно присутствовать поле latname в котором хранятся такие идентфикаторы для записей.

Аргументы:
string $string Название записи.
string $latname Заданный строковой идентфикатор.
string $table Таблица БД.
string $where Условие для SQL запроса.
Возвращает:
string Строка с размером в b,Kb,Mb.

getStructureById ( $  id,
$  domain = '' 
)

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

Аргументы:
integer $id Числовой идентификатор дополнения.
string $domain='' Идентификатор сайта, если не указано то текущий.
Возвращает:
string Полный строковой идентификатор дополнения.

getStructureByPlugin ( $  plugin,
$  domain = '' 
)

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

Аргументы:
string $plugin Идентификатор плагина.
string $domain='' Идентификатор сайта, если не указано то текущий.
Возвращает:
string Полный строковой идентификатор дополнения.

getStructureId ( $  structure  ) 

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

Аргументы:
string $structure Полный строковой идентификатор дополнения.
Возвращает:
integer Числовой идентификатор дополнения.

getStructuresByPlugin ( $  plugin,
$  domain = '' 
)

Возвращает массив полных строковых идентификаторов существующих дополнений на базе указанного плагина.

Аргументы:
string $plugin Идентификатор плагина.
string $domain='' Идентификатор сайта, если не указано то текущий.
Возвращает:
string Массив полных строковых идентификаторов дополнений.

getTextOption ( $  item,
$  var 
)

Возвращает альтернативное текстовое значение опции.

Кроме простого значения (до 255 символов), каждая опция может хранить и какой-то текст.

Аргументы:
string $item Полный идентификатор раздела или дополнения, в котором находится опция.
string $var Идентификатор опции.
Возвращает:
mixed Альтернативное текстовое значение опции.

getTreePath ( $  table,
$  id,
$  sep = ' » ' 
)

Возвращает полный путь элемента в дереве.

Аргументы:
string $table Таблица БД в которой хранится дерево элементов.
string $id Числовой идентификатор элемента.
string $sep='  ' Разделитель.
Возвращает:
string Полный путь элемента.

getXML ( $  data,
$  rootname = "" 
)

Формирует XML из массива с данными.

Аргументы:
array $data Массив с данными.
string $rootname Название корневого элемента.
Возвращает:
string Сформированный XML.

loadList ( $  item,
$  domain = '' 
)

Загружает и возвращает указанный список.

Аргументы:
string $item Короткий или полный идентификатор списка (дополнения на базе плагинов: listdata, liststr, listnum и др.).
string $domain='' Идентификатор сайта, если не указано то текущий.
Возвращает:
array Ассоциированный массив: числовой идентификатор => значение или массив.

loadXML ( $  source,
$  isfile = false 
)

Загружает XML данные в массив.

Аргументы:
string $source Текст XML или путь к файлу.
boolean $isfile Если в первом параметре указан файл, то должно принимать значение true.
Возвращает:
array Массив с данными или false.

mk_dir ( $  dirName  ) 

Создание каталога.

Аргументы:
string $dirName Имя каталога.
Возвращает:
boolean Успешность операции.

outArchive ( $  file,
$  path 
)

Создает архив tar.gz, помещает в него содержмое указанного каталога/файла и сразу отдает его клиенту.

Аргументы:
string $file Имя файла архива (Обязательное расширение tar.gz).
string $path Файл или каталог который помещается в архив.

outXML ( $  data,
$  rootname = "" 
)

Формирует XML из массива с данными и сразу отдает клиенту.

Аргументы:
array $data Массив с данными.
string $rootname Название корневого элемента.

parse_bbcode ( $  string  ) 

Переводит текст в BBCode в HTML форматирование.

Аргументы:
string $string Исходный текст.
Возвращает:
string Полученный HTML.

parseSection ( $  section  ) 

Разбирает на составляющие полный строковой идентификатор раздела.

Аргументы:
string $section Строковой идентификатор раздела.
Возвращает:
array Массив значений с ключами: domain - Идентификатор сайта. lang - Идентификатор языковой версии (если раздел общий, то текущей языковой версии). name - Короткий строковой идентификатор раздела (указываемый при создании).

parseStructure ( $  structure  ) 

Разбирает на составляющие полный строковой идентификатор дополнения.

Аргументы:
string $structure Строковой идентификатор дополнения.
Возвращает:
array Массив значений с ключами: domain - Идентификатор сайта. name - Короткий строковой идентификатор дополнения (указываемый при создании).

prepareValues ( $  item,
&$  data 
)

Дополняет данные в записи данными дополнительных полей.

Аргументы:
string $item Полный строковой идентификатор раздела или дополнения.
array &$data Запись в виде ассоциированного массива.

RegisterFile ( $  path,
$  caption,
$  id = 0,
$  iditem = 0,
$  sort = 0 
)

Регистрирует заданный файл.

Аргументы:
string $path Путь к файлу.
string $caption Описание файла.
integer $id=0 Числовой идентификатор файла который будет заменен.
integer $iditem=0 Идентификатор элемента раздела которому принадлежит файл.
integer $sort=0 Порядок среди других принадлежащих элементу.
Возвращает:
integer Числовой идентификатор с которым зарегистрирован файл.

RegisterImage ( $  path,
$  caption,
$  id = 0,
$  iditem = 0,
$  sort = 0,
$  resize = false,
$  x = 0,
$  y = 0 
)

Регистрирует заданное изображение.

Аргументы:
string $path Путь к файлу изображения.
string $caption Описание изображения.
integer $id=0 Числовой идентификатор изображения которое будет заменено.
integer $iditem=0 Идентификатор элемента раздела которому принадлежит изображение.
integer $sort=0 Порядок среди других принадлежащих элементу.
boolean $resize Масштабирование.
integer $x Масштабирование по ширине.
integer $y Масштабирование по высоте.
Возвращает:
integer Числовой идентификатор с которым зарегистрировано изображение.

RenameRegFile ( $  id,
$  caption 
)

Устанавливает новое описание для зарегистрированного файла.

Аргументы:
integer $id Числовой идентификатор файла.
string $caption Новое описание.

RenameRegImage ( $  id,
$  caption 
)

Устанавливает новое описание для зарегистрированного изображения.

Аргументы:
integer $id Числовой идентификатор изображения.
string $caption Новое описание.

replaceDir ( $  in,
$  to,
$  dir 
)

Замена строки в содержимом всех файлов каталога.

Аргументы:
string $in Заменяемая строка/фрагмент.
string $to Строка на которую заменяется искомая.
string $dir Каталог в файлах которого происходит поиск и замена.

replaceFile ( $  in,
$  to,
$  file 
)

Замена строки в содержимом файла.

Аргументы:
string $in Заменяемая строка/фрагмент.
string $to Строка на которую заменяется искомая.
string $file Файл в котором происходит поиск и замена.

setOption ( $  item,
$  var,
$  value 
)

Устанавливает значение опции.

Аргументы:
string $item Полный идентификатор раздела или дополнения, в котором находится опция.
string $var Идентификатор опции.
mixed $value Значение опции.

setTextOption ( $  item,
$  var,
$  value 
)

Устанавливает альтернативное текстовое значение опции.

Кроме простого значения (до 255 символов), каждая опция может хранить и какой-то текст.

Аргументы:
string $item Полный идентификатор раздела или дополнения, в котором находится опция.
string $var Идентификатор опции.
string Альтернативное текстовое значение опции.

sizestring ( $  size  ) 

Возвращает строку с размером в b,Kb,Mb по размеру в байтах.

Аргументы:
string $size Размер в байтах.
Возвращает:
string Строка с размером в b,Kb,Mb.

tojson ( $  data  ) 

Преобразует массив в JSON строку.

Аргументы:
array $data Массив данных.
Возвращает:
string Строка JSON.

translit ( $  string  ) 

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

Аргументы:
string $string Исходная строка.
Возвращает:
string Строка в транслитерации.

truncate ( $  string,
$  length = 80,
$  etc = '...',
$  break_words = false 
)

Удаляет теги и обрезает текст до указанной длины.

Аргументы:
string $string Исходный текст.
string $length=80 Длина до которой обрезать.
string $etc='...' Строка добавляется в конец обрезанного текста.
string $break_words=false Обрезать слова.
Возвращает:
string Обрезанный текст.

truncatewords ( $  string,
$  length = 30,
$  etc = '...' 
)

Удаляет теги и обрезает каждое слово до указанной длины.

Аргументы:
string $string Исходный текст.
string $length=30 Длина до которой обрезать слова.
string $etc='...' Строка добавляется в конец обрезанного слова.
Возвращает:
string Обработанный текст.

UploadFile ( $  name,
$  caption,
$  id = 0,
$  iditem = 0,
$  sort = 0 
)

Регистрирует загруженный файл.

Аргументы:
string $name Идентфикатор загружаемого файла (значение name в <input type="file" name="...">)
string $caption Описание файла.
integer $id=0 Числовой идентификатор файла который будет заменен.
integer $iditem=0 Идентификатор элемента раздела которому принадлежит файл.
integer $sort=0 Порядок среди других принадлежащих элементу.
Возвращает:
integer Числовой идентификатор с которым зарегистрирован файл.

UploadImage ( $  name,
$  caption,
$  id = 0,
$  iditem = 0,
$  sort = 0,
$  opt = "img" 
)

Регистрирует загруженное изображение.

Аргументы:
string $name Идентфикатор загружаемого файла (значение name в <input type="file" name="...">)
string $caption Описание изображения.
integer $id=0 Числовой идентификатор изображения которое будет заменено.
integer $iditem=0 Идентификатор элемента раздела которому принадлежит изображение.
integer $sort=0 Порядок среди других принадлежащих элементу.
string $opt='img' Префикс идентификаторов опций масштабирования при загрузке.
Возвращает:
integer Числовой идентификатор с которым зарегистрировано изображение.

UploadRegImage ( $  name,
$  caption,
$  id = 0,
$  iditem = 0,
$  sort = 0,
$  resize = false,
$  x = 0,
$  y = 0 
)

Регистрирует загруженное изображение.

Аргументы:
string $name Идентфикатор загружаемого файла (значение name в <input type="file" name="...">)
string $caption Описание изображения.
integer $id=0 Числовой идентификатор изображения которое будет заменено.
integer $iditem=0 Идентификатор элемента раздела которому принадлежит изображение.
integer $sort=0 Порядок среди других принадлежащих элементу.
boolean $resize Масштабирование.
integer $x Масштабирование по ширине.
integer $y Масштабирование по высоте.
Возвращает:
integer Числовой идентификатор с которым зарегистрировано изображение.