PHPackages cmsx/navigator - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. cmsx/navigator ActiveLibrary[Utility & Helpers](/categories/utility) cmsx/navigator ============== CMSx Navigator Component 036PHP Since Jul 28Pushed 11y ago1 watchersCompare [ Source](https://github.com/cmsx/Navigator)[ Packagist](https://packagist.org/packages/cmsx/navigator)[ RSS](/packages/cmsx-navigator/feed)WikiDiscussions master Synced 3d ago READMEChangelogDependenciesVersions (1)Used By (0) Navigator ========= [](#navigator) Компонент позволяет автоматизировать или упростить работу с пагинацией, сортировкой и фильтрацией списка элементов. Работа начинается с инициализации объекта Navigator с передачей в него объектов Request и URL. `$navi = new Navigator($request, $url);` Пагинация --------- [](#пагинация) Объект Navigator предоставляет набор методов, для получения первой, последней, следующей, предыдущей страниц, а также быстрой генерации объектов URL для них. ``` $navi->getPage(); // получение номера текущей страницы $navi->getFirstPage(); // номер первой страницы $navi->getLastPage(); // номер последней страницы $navi->getNextPage(); // следующая страница от текущей $navi->getPrevPage(); // предыдущая страница от текущей ``` По аналогии, для всех методов есть возможность получить готовый объект URL: ``` $navi->getPageUrl(42); // URL с номером страницы 42 $navi->getFirstPageUrl(); // URL с первой страницей ... ``` Функционал постраничности требует, чтобы у Navigator было известно общее количество элементов в выборке и указано количество элементов на странице. ``` $navi->setOnpage(10); // Указываем количество элементов на странице $navi->setTotal(42); // Указываем количество элементов в выборке echo $navi->getTotalPages(); // Результат - количество страниц: 5 ``` Сортировка ---------- [](#сортировка) Navigator позволяет задать допустимые варианты сортировки, а также сформировать ссылки на прямую и обратную сортировку. ``` $navi = new Navigator($request, new URL('hello')); $navi->addOrderBy('id'); // Именование и в БД, и в URL совпадает $navi->addOrderBy('total', 'Количество', 'count(*)'); // В URL будет параметр вида orderby:total, в SQL `count(*)` ``` После добавления можно получить полный список вариантов сортировки, или отдельные пункты, для формирования списков опций или ссылок в интерфейсе. Каждый вариант сортировки - это объект OrderBy: ``` $o = $navi->getOrderByOption('total'); // Получили объект $o->asUrlParameter(); // Значение для подстановки в URL: total - сортировка по-возрастанию $o->asUrlParameter(false); // _total - сортировка по убыванию $o->asSQL(); // SQL выражение для сортировки, в данном случае count(*) ASC $o->asUrl(); // Объект URL ``` Если в адресе содержится параметр сортировки, например `.../orderby:_total/`, можно получить текущий порядок для сортировки: ``` $navi->getOrderBy(); ``` Если адрес не содержит выбора для сортировки, метод вернет `false` или способ сортировки по-умолчанию, если он был указан с помощью метода `$navi->setDefaultOrderBy()`. Выборка элементов, подсчет количества записей --------------------------------------------- [](#выборка-элементов-подсчет-количества-записей) Navigator может сразу обрабатывать данные о сортировке, фильтрах и пагинации, применять их и получать кол-во элементов в выборке, автоматически расчитывать количество страниц и выдавать соответствующие этим настройкам объекты. Если не требуется сложная логика фильтрации, можно воспользоваться настройками, или отнаследоваться от класса и переопределить соответствующие методы. ``` $navi->setClass('MyItem'); // Указываем, что используем модель MyItem $navi->getTotal(); // Получение общего количества элементов в выборке $navi->setOnpage(10); // Указываем количество элементов на странице $navi->getItems(); // Получаем нужный набор элементов, с учетом сортировки и текущей страницы ``` Для расширения возможностей можно переопределить, какие функции будут вызываться для подсчета количества и получения элементов (по-умолчанию это будут `MyItem::Count()` и `MyItem::Find()`): ``` $navi->setFuncCount('CountSome'); // Для вызова MyItem::CountSome() $navi->setFuncFind('FindSome'); // Для вызова MyItem::FindSome() ``` По-умолчанию в эти методы будут передаваться аргументы, в соответствии с сигнатурами базового класса Item. Если требуется вызов методов с другим набором аргументов, то можно переопределить методы `countTotal()` и `getItems()` при наследовании. Фильтрация ---------- [](#фильтрация) Механизм фильтрации работает с помощью назначения фильтров - объектов Filter. Базово предусмотрено три фильтра - Equal, Between и Like, выполняющие фильтрацию по прямому соответствию, выборке диапазона и условию LIKE. При необходимости реализации более сложной логики можно добавлять произвольные фильтры с использованием анонимных функций или создавать свои фильтры наследуясь от класса Filter. Рассмотрим на примере: ``` $navi->addFilterEqual('one', 'is_numeric'); // Валидация может выполняться с помощью callable-выражений $navi->addFilterEqual('two', '/^[a-z]+$/'); // Валидация может выполняться регулярными выражениями $navi->addFilterBetween('date'); // На свой страх и риск можно обойтись и без валидации $navi->addFilter( 'some', null, function(Navigator $navi, Filter $filter) { if ($val = $filter->getCleanValue()) { $navi->addCondition('... some complicated expression ...'); } } ); // Произвольный фильтр ``` После формирования набора правил, фильтр можно использовать для автоматической обработки запросов и получения "чистых данных": ``` // .../one:42/ echo $navi->getFilter('one')->getCleanValue(); // Результат: 42 // .../one:two/ echo $navi->getFilter('one')->getCleanValue(); // Результат: false ``` Либо можно получать уже сформированный набор условий Where для SQL запросов с помощью метода `processFilters()`. Callback, указываемый в фильтре, позволяет автоматизировать создание условий для выборки. В функцию передаются как аргументы объекты Navigator и Filter. После проверки и обработки данных, Callback-функция должна подготовить условие Where и передать его в Navigator с помощью метода `addCondition()`. Таким образом, в результате работы всех фильтров, получается готовый набор условий, который можно использовать вручную или автоматически в методах `getItems()` и `countTotal()`. Если требуется, можно указать постоянное условие не зависящее от фильтров, с помощью `addDefaultCondition()`. Изначально предусмотренные фильтры Equal, Between и Like являются наиболее часто используемыми вариантами: - **Equal:** прямое соответствие field = value - **Between:** значение должно быть в диапазоне field >= column\_from и field <= column\_to - **Like:** генерирует условие \[column\] LIKE ("\[value\]%") Для вышеописанного набора правил, URL и результат будет следующим: ``` URL: /hello/one:1/two:three/date_from:01.01.2014/date_to:31.12.2014/ Результат: array('one' => 1, 'two' => 'three', '`date` >= "01.01.2014"', '`date` 'me')); $navi->addFilterEqual('one'); $navi->addFilterEqual('two'); $navi->setPage(42); echo $navi->getUrlClean()->toString(); // /hello/one:1/two:2/page:42/ ``` Генерация элементов интерфейса ------------------------------ [](#генерация-элементов-интерфейса) Для сортировки и фильтрации, кроме возможности просто получить объект URL, также предусмотрены методы для формирования HTML элементов интерфейса. Фильтры будут рендериться с текущими значениями фильтров и сортировки, с учетом валидности этих данных. Для генерации SELECT с выбором сортировки есть методы: ``` $navi->getOrderByAsSelectOptions(); // Генерация списка тегов $navi->getOrderByAsSelect(); // Генерация тега с полным списком опций ``` Для фильтров предусмотрена возможность сгенерировать поле ввода INPUT, а также SELECT или набор OPTIONS, если у него указаны опции выбора `$f->setOptions(array(...))`: ``` $f = $navi->getFilter('one'); // Получаем объект Filter $f->asInput(); // Генерация тега $f->asSelectOptions(); // Генерация списка тегов $f->asSelect(); // Генерация тега с полным списком опций ``` ### Health Score 20 — LowBetter than 14% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity7 Limited adoption so far Community7 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/0996651ed5f0150fc9f6ae57e76078fb630be10ed03f68897ede162d59d7990c?d=identicon)[cmsx](/maintainers/cmsx) --- Top Contributors [![cmsx](https://avatars.githubusercontent.com/u/2027189?v=4)](https://github.com/cmsx "cmsx (34 commits)") ### Embed Badge ![Health badge](/badges/cmsx-navigator/health.svg) ``` [![Health](https://phpackages.com/badges/cmsx-navigator/health.svg)](https://phpackages.com/packages/cmsx-navigator) ``` ### Alternatives [eden/core Eden Core component full of secret sauce 14415.0k34](/packages/eden-core) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)