Skip to content

vgrish/xblib

 
 

Repository files navigation

1. Назначение.
Библиотека xbLib представляет собой сборник часто используемых классов и алгоритмов.
Алгоритмы собраны в т.н. классы-библиотеки (clibrary) - классы, содержащие исключительно
статические методы. Это сделано по ряду соображений. Во-первых, это облегчает автозагрузку
библиотеки методов. Во-вторых, не требуется использование пространств имён, что улучшает
обратную совместимость библиотеки вплоть до версии 5.2.

Одним из ключевых моментов идеологии библиотеки является слабая связанность компонентов.
Практически ни один компонент не требует наличия другого. Это позволяет загружать компоненты
библиотеки в проект исключительно тогда, когда оные необходимы. Ещё одним из важнейших
принципов библиотеки является стандарт именования классов. Все компоненты в библиотеке
начинаются с префикса "xb". Имена компонентов пакетов продолжаются префиксом, зависящим
от названия пакета. Например, полный префикс пакета "node" будет таким - "xbNode".

Все компоненты снабжены внутренним документированием, схожим с phpDoc. В дальнейшем
планируется выпуск системы, разбирающей данный синтаксис.

2. Компоненты.

autoload.php - автозагрузчик-маршрутизатор библиотеки. Собственно именно его нужно
               подключать вместо как таковых файлов компонентов. Учитывает библиотечные
               пакеты. Перед подключением можно определить, если нужно, путь к Deploy-папке
               библиотеки в проекте (по умолчанию system/external/xblib). Если библиотека
               размещается в самом проекте, а не в репозитории, значением константы
               XBLIB_DEPLOY_ROOT должна быть пустая строка (константу определять в этом
               случае необходимо).

xbLib        - базовая библиотека алгоритмов. Также закладывает основу стандарта
               сопоставления MIME-типов в источниках данных. Содержит реализацию трёх
               deprecated функций для обратной совместимости.

xbClass      - базовый класс, реализующий аксессоры, систему событий, а также
               динамическое API.

xbMailer     - класс отправки сообщений по электронной почте.

xbSession    - класс для работы с пользовательскими сессиями. Реализует принцип защиты от
               CSRF-атак при помощи токенов.

xbLanguage   - класс для работы с языковыми ресурсами. Закладывает основы стандартизации
               для локализации проектов на уровне парсеров.

xbException  - расширенная реализация исключения. Позволяет сохранять дополнительные данные.

xbValidator  - коллекция простых валидаторов текстовых данных.

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

About

Библиотека часто испольуемых классов и алгоритмов

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%