Класс навигации

Начиная с версии 5.4 в системе возможно использование класса навигации, методы которого повторяют уже имеющиеся функции.

Получить доступ к объекту:

<?php
    $nav = $nc_core->nav;
    // или
    $nav = nc_nav::get_instance();
?>

В настоящее время класс не имеет аналогов некоторым функциям, которые формируют: навигацию по сайтам (список сайтов), постраничную навигацию и навигацию по инфоблокам.

Дополнительные шаблоны

Класс навигации и его функции можно использовать в дополнительных шаблонах. Функционал работы с дополнительными шаблонами описан в соответствующем разделе.

Функции навигации

get_sub( $parent_id = 0 ) — формирование списка подкатегорий раздела

аналог nc_browse_sub()

Примеры использования:

<?php
    // корневые разделы
    $menu = $nav->get_sub();
    // подразделы раздела ID = 7
    $menu = $nav->get_sub(7);
    // Альтернативный способ
    $menu = $nav->sub(7)->get();
?>

Пример вывода меню:

<ul class='main-menu'>
    <? foreach ($nc_core->nav->get_sub() as $sd): ?>
        <? if ($sd->active): ?>
            <li><b><?= $sd->name ?></b></li>
        <? else: ?>
            <li><a href='<?= $sd->url ?>'><?= $sd->name ?></a></li>
        <? endif ?>
    <? endforeach ?>
</ul>

get_by_level( $level ),
get_current_level( $level ) — формирование списка подкатегорий раздела

аналог nc_browse_level()

<?php
    $menu = $nc_core->nav->get_by_level(0);
    $menu = $nc_core->nav->level(0)->get();
?>

Пример вывода меню первого уровня:

<ul class='sub-menu'>
    <? foreach ($nc_core->nav->get_by_level(1) as $sd): ?>
        <? if ($sd->active): ?>
            <li><b><?= $sd->name ?></b></li>
        <? else: ?>
            <li><a href='<?= $sd->url ?>'><?= $sd->name ?></a></li>
        <? endif ?>
    <? endforeach ?>
</ul>

get_path() — путь по сайту (хлебные крошки)

аналог nc_browse_path() и nc_browse_path_range()

Примеры использования:

<? foreach ($nc_core->nav->get_path() as $sd): ?>
    <? if ($sd->current): ?>
        <?=$sd->name ?>
    <? else: ?>
        <a href='<?=$sd->url ?>'><?=$sd->name ?></a> /
    <? endif ?>
<? endforeach ?>

Возвращает только часть пути (“хлебных крошек”). Аргументы работают точно так же как и php-функции array_slice

<?php
    // Вернет путь без первого элемента
    $nc_core->nav->get_path(1);
    // Вернет путь от корня сайта до 3 кровня вложенности максимум
    $nc_core->nav->get_path(0, 3);
    // Вернет весь путь но без последнего раздела
    $nc_core->nav->get_path(0, -1);
?>

В функциях и модификаторах возможно использование следующих значений:

• name — название раздела
• id — идентификатор раздела
• url — путь к разделу
• active, current — активный (текущий) раздел

Модификаторы

sub( $parent_id = 0 ) — указание номера раздела

$menu = $nav->sub(7)->get();

level($level) — указание номера уровня

$menu = $nc_core->nav->level(0)->get();

as_object() — вывод в виде объектов
 

as_array() — вывод в виде массива
 

ignore_check( $ignore = true ) — игнорирование вывода только включённых разделов, если $ignore_check равен 1, то выведутся все разделы

<?php
    $all_subs = $nav->ignore_check()->get_sub();
    // или
    $all_subs = $nav->ignore_check()->sub()->get();
?>

order_by( $field, $type = ‘asc’ ) — изменяет порядок сортировки возвращаемого результата.

<?php
    // Сортирует по названию раздела
    $nav->order_by('name')->get_sub();
    // В обратном порядке
    $nav->order_by('name', 'desc')->get_sub();
?>

Использование нескольких параметров сортировки

<?php
    $nav->order_by('Favorite')->order_by('name')->get_sub();
?>

where( $field, $operator = null, $value = null ),
or_where( $field, $operator = null, $value = null ) — выборка корневых разделов для которых поле menu имеет значение main

<?php
    $nav->where('menu', 'main')->order_by('name')->get_sub();
    // Вернет тот же результат
    $nav->where('menu', 'main')->order_by('name')->level(0)->get();
?>

Примеры работы модификатора where()

<?php
    // ... WHERE `menu` = 'main' ...
    $nav->where('menu', 'main');
    // ... WHERE `menu` != 'main' ...
    $nav->where('menu', '!=', 'main');
    // ... WHERE `menu` = 'main' AND `Checked` = 1 ...
    $nav->where('menu', 'main')->where('Checked', 1);
    // ... WHERE `menu` = 'main' OR `menu` = 'all' ...
    $nav->where('menu', 'main')->or_where('menu', 'all');
?>

where_in( $field, $values )
or_where_in( $field, $values ) — выборка конкретных разделов

<?php
    $nav->where_in('id', array(100, 101, 103))->order_by('name')->get();
?>

Примеры вывода меню с модификаторами:

Вывод меню в котором отображаются только разделы с id = 3 и 5

<ul class='main-menu'>
    <? foreach ($nc_core->nav->where_in("id", array(3,5))->get_sub() as $sd): ?>
        <? if ($sd->active): ?>
            <li><b><?= $sd->name ?></b></li>
        <? else: ?>
            <li><a href='<?= $sd->url ?>'><?= $sd->name ?></a></li>
        <? endif ?>
    <? endforeach ?>
</ul>

Вывод меню в котором отображаются все разделы, включая выключенные

<ul class='main-menu'>
    <? foreach ($nc_core->nav->ignore_check()->get_sub() as $sd): ?>
        <? if ($sd->active): ?>
            <li><b><?= $sd->name ?></b></li>
        <? else: ?>
            <li><a href='<?= $sd->url ?>'><?= $sd->name ?></a></li>
        <? endif ?>
    <? endforeach ?>
</ul>