>>> Содержание <<<
Модуль unifunctions.php
Общее описание
Содержит общие служебные функции, используемые в большинстве модулей ядра.
Функции
string makeSalt(string $prefix = '')
Описание
Генерирует уникальную соль для пароля.
Принимаемые параметры
prefix - дополнительные префикс.
Возвращаемые значения
Строка длиной в 22 символа.
string makeIdent(string $prefix = '')
Описание
Генериует уникальный идентификатор.
Принимаемые параметры
prefix - дополнительные префикс.
Возвращаемые значения
Строка длиной 40 символов.
string passwHash(string $password, string $salt)
Описание
Шифрует пароль.
Принимаемые параметры
password - пароль, строка длиной от 8 до 50 символов.
salt - парольная соль, строка длиной 22 символа.
Возвращаемые значения
В случае удачи возвращает строку длиной 40 символов. Иначе возвращает FALSE.
bool pregDbName(string $dbname)
Описание
Проверяет имя базы данных на соответствие установленному шаблону.
Принимаемые параметры
dbname - имя базы данных, строка длиной от 1 до 64 символов. Допускаются цыфры, буквы английского алфавита верхнего и нижнего регистров, а также символ нижней черты.
bool pregPref(string $prefix)
Описание
Проверяет префикс таблицы на соответствие установленному шаблону.
Принимаемые параметры
prefix - префикс, строка длиной от 1 до 10 символов. Допускаются буквы английского алфавита верхнего и нижнего регистров, а также цифры.
Возвращаемые значения
В случае соответствия возвращает TRUE, иначе FALSE.
bool pregUName(string $username)
Описание
Проверяет имя пользователя на соответствие установленному шаблону.
Принимаемые параметры
username - имя пользователя, строка длиной от 3 до 20 символов. Допускаются буквы английского алфавита верхнего и нижнего регистров, а также цифры.
Возвращаемые значения
В случае соответствия возвращает TRUE, иначе FALSE.
bool pregGName(string $groupname)
Описание
Проверяет имя группы пользователей на соответствие установленному шаблону.
Принимаемые параметры
groupname - имя группы пользователей, строка длиной от 1 до 50 символов.
Возвращаемые значения
В случае соответствия возвращает TRUE, иначе FALSE.
bool pregPassw(string $password)
Описание
Проверяет пароль на соответствие установленному шаблону.
Принимаемые параметры
password - пароль, строка длиной от 8 до 50 символов. Допускаются буквы английского алфавита верхнего и нижнего регистров, а также цифры и дополнительные символы.
Возвращаемые значения
В случае соответствия возвращает TRUE, иначе FALSE.
bool pregIdent(string $ident)
Описание
Проверяет идентификатор на соответствие установленному шаблону.
Принимаемые параметры
ident - идентификатор, строка длиной в 40 символов. Допускаются буквы английского алфавита верхнего и нижнего регистров, а также цифры и дополнительные символы.
Возвращаемые значения
В случае соответствия возвращает TRUE, иначе FALSE.
bool pregMail(string $email)
Описание
Проверяет правильность формата адреса электронной почты.
Принимаемые параметры
email - адрес электронной почты.
Возвращаемые значения
В случае соответствия возвращает TRUE, иначе FALSE.
string openRead(string $path)
Описание
Читает содержимое заданного файла
Принимаемые значения
path - путь с локальному файлу.
Возвращаемые значения
В случае удачи возвращает содержимое файла, как стороку. Иначе возвращает FALSE.
DOMDocument xmlTransform(string $xml, string $xsl)
Описание
Производит трансформацию xml-документа по заданному xslt-стилю.
Принимаемые значения
xml - трансформируемый xml-документ.
xsl - xslt-стиль.
Возвращаемые значения
В случае удачи, возвращает объект DOMDocument, иначе FALSE.
int authUserId()
Описание
При наличии активной сессии возвращает идентификатор пользователя.
Возвращаемые значения
Идентификатор пользователя в виде целого числа. При отсутствии активной сессии FALSE.
string authUName()
Описание
При наличии активной сессии возвращает имя пользователя.
Возвращаемые значения
Имя пользователя в виде строки. При отсутствии активной сессии FALSE.
int authLimited()
Описание
При наличии активной сессии возвращает тип сессии. Сессия может быть ограниченной и неограниченной.
Возвращаемые значения
Тип сессии в виде целого числа. При отсутствии активной сессии FALSE.
string authLang()
Описание
При наличии активной сессии возвращает код языка, указанный в настройках пользователя.
Возвращаемые значения
Код языка, соответствующий шаблону [a-z]{2}-[A-Z]{2}. При отсутствии активной сессии FALSE.
string authLangDir()
Описание
При наличии активной сессии, возвращает направление вывода текста, указанное в настройках пользователя.
Возвращаемые значения
** **
**```bool compareVersions(string $version1, string $version2, string $operator = ">=")```**
**Описание**
Производит сравнение двух версий путем сравнения суммарных версий. Суммарная версия расчитывается по формуле *10000 * ```uv``` + 100 * ```mv``` + ```lv```*, где ```uv``` - верхняя/основная версия; ```mv``` - средняя/промежуточная версия; ```lv``` - нижняя/минорная версия. Например, для версии *2.8.5*, суммарная версия будет равна *10000 * 2 + 100 * 8 + 5 = 20805*.
**Принимаемые значения**
*```version1```* - первая сравниваемая версия. Соответствует шаблону *[0-9]{1,2}\.[0-9]{1,2}\.[0-9]{1,2}*.
*```version2```* - вторая сравниваемая версия. Соответствует шаблону *[0-9]{1,2}\.[0-9]{1,2}\.[0-9]{1,2}*.
*```operator```* - оператор сравнения. Допускаются следущие операторы: *>=*, *<=*, *==*, *>* и *<*.
**Возвращаемые значение**
Если сравнение подтверждается, то возвращает ```TRUE```, иначе возвращает ```FALSE```.
** **
**```int calcSumVersion(string $version)```**
**Описание**
Производит расчет суммарной версии плагина.
**Принимаемые значения**
*```version```* - версия плагина, соответствующая шаблону *[0-9]{1,2}\.[0-9]{1,2}\.[0-9]{1,2}*. Например, *2.8.5*.
**Возвращаемые значения**
Суммарная версия плагина, высчитанная по формуле *10000 * ```uv``` + 100 * ```mv``` + ```lv```*, где ```uv``` - верхняя/основная версия; ```mv``` - средняя/промежуточная версия; ```lv``` - нижняя/минорная версия. Например, для версии *2.8.5*, суммарная версия будет равна *10000 * 2 + 100 * 8 + 5 = 20805*.
** **
**```string genPassword(int $length = 8, bool $lower = TRUE, bool $upper = TRUE, bool $numbers = TRUE, bool $underline = TRUE, bool $minus = TRUE, bool $special = TRUE)```**
**Описание**
Генератор паролей.
**Принимаемые значения**
*```length```* - желаемая длина пароля. Минимальное значение - 8, максимальное - 50.
*```lower```* - флаг использования в пароле букв нижнего регистра. Если ```TRUE``` - использовать, если ```FALSE``` - не использовать.
*```upper```* - флаг использования в пароле букв верхнего регистра. Если ```TRUE``` - использовать, если ```FALSE``` - не использовать.
*```numbers```* - флаг использования в пароле цифр. Если ```TRUE``` - использовать, если ```FALSE``` - не использовать.
*```underline```* - флаг использования в пароле символа нижней черты. Если ```TRUE``` - использовать, если ```FALSE``` - не использовать.
*```minus```* - флаг использования в пароле минуса. Если ```TRUE``` - использовать, если ```FALSE``` - не использовать.
*```special```* - флаг использования в пароле специальных символов. Если ```TRUE``` - использовать, если ```FALSE``` - не использовать.
**Возвращаемые значения**
Сгенерированный пароль. При некорректрых параметрах возвращает ```FALSE```.
** **
**```string guid()```**
**Описание**
Генерирует глобально уникальный идентификатор.
**Возвращаемые значения**
Строка формата *XXXXXXXX-XXXX-4XXX-XXXX-XXXXXXXXXXXX*, где *X* - буква нижнего регистра английского алфавита от *A* до *E*, либо цифра от *0* до *9*.
** **
**```bool pregGuid(string $guid)```**
**Описание**
Приверяет формат строки глобально уникального идентификатора.
**Принимаемые параметры**
*```guid```* - строка формата *XXXXXXXX-XXXX-4XXX-XXXX-XXXXXXXXXXXX*, где *X* - буква нижнего регистра английского алфавита от *A* до *E*, либо цифра от *0* до *9*.
**[>>> Содержание <<<](ru.index)**
