Hyde\Framework\Features\Navigation\NavItem

Complexity

Total Complexity

14

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Importance

Changes	59
Bugs	1	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getDestination()	0	3	1
A	isCurrent()	0	3	1
A	fromRoute()	0	7	1
A	getGroup()	0	3	1
A	getPriority()	0	3	1
A	__construct()	0	6	1
A	forLink()	0	3	1
A	getRouteGroup()	0	3	1
A	normalizeGroupKey()	0	3	2
A	__toString()	0	3	1
A	getLabel()	0	3	1
A	forRoute()	0	3	2

<?php

declare(strict_types=1);

namespace Hyde\Framework\Features\Navigation;

use Hyde\Hyde;
use Hyde\Support\Models\Route;
use Illuminate\Support\Str;
use Stringable;

/**
 * Abstraction for a navigation menu item. Used by the NavigationMenu and DocumentationSidebar classes.
 *
 * You have a few options to construct a navigation menu item:
 *   1. You can supply a Route directly and explicit properties to the constructor
 *   2. You can use NavItem::fromRoute() to use data from the route
 *   3. You can use NavItem::forLink() for an external or un-routed link
 */
class NavItem implements Stringable
{
    public readonly string $destination;
    public readonly string $label;
    public readonly int $priority;
    public readonly ?string $group;

    /**
     * Create a new navigation menu item.
     */
    public function __construct(Route|string $destination, string $label, int $priority = 500, ?string $group = null)
    {
        $this->destination = (string) $destination;

The property destination is declared read-only in Hyde\Framework\Features\Navigation\NavItem.

        $this->label = $label;

The property label is declared read-only in Hyde\Framework\Features\Navigation\NavItem.

        $this->priority = $priority;

The property priority is declared read-only in Hyde\Framework\Features\Navigation\NavItem.

        $this->group = $group;

The property group is declared read-only in Hyde\Framework\Features\Navigation\NavItem.

    }

    /**
     * Create a new navigation menu item from a route.
     */
    public static function fromRoute(Route $route, ?string $label = null, ?int $priority = null, ?string $group = null): static
    {
        return new static(
            $route->getLink(),
            $label ?? $route->getPage()->navigationMenuLabel(),
            $priority ?? $route->getPage()->navigationMenuPriority(),
            $group ?? static::getRouteGroup($route),
        );
    }

    /**
     * Create a new navigation menu item leading to an external URI.
     */
    public static function forLink(string $href, string $label, int $priority = 500): static
    {
        return new static($href, $label, $priority);
    }

    /**
     * Create a new navigation menu item leading to a Route model.
     *
     * @param  \Hyde\Support\Models\Route|string<\Hyde\Support\Models\RouteKey>  $route  Route model or route key
     * @param  int|null  $priority  Leave blank to use the priority of the route's corresponding page.
     * @param  string|null  $label  Leave blank to use the label of the route's corresponding page.
     * @param  string|null  $group  Leave blank to use the group of the route's corresponding page.
     */
    public static function forRoute(Route|string $route, ?string $label = null, ?int $priority = null, ?string $group = null): static
    {
        return static::fromRoute($route instanceof Route ? $route : \Hyde\Facades\Route::getOrFail($route), $label, $priority, $group);
    }

    /**
     * Resolve a link to the navigation item.
     */
    public function __toString(): string
    {
        return $this->destination;
    }

    /**
     * Get the destination link of the navigation item.
     *
     * If the navigation item is an external link, this will return the link as is,
     * if it's for a route, a resolved relative link will be returned.
     */
    public function getDestination(): string
    {
        return $this->destination;
    }

    /**
     * Get the label of the navigation item.
     */
    public function getLabel(): string
    {
        return $this->label;
    }

    /**
     * Get the priority to determine the order of the navigation item.
     */
    public function getPriority(): int
    {
        return $this->priority;
    }

    /**
     * Get the group identifier of the navigation item, if any.
     *
     * For sidebars this is the category key, for navigation menus this is the dropdown key.
     */
    public function getGroup(): ?string
    {
        return $this->group;
    }

    /**
     * Check if the NavItem instance is the current page.
     */
    public function isCurrent(): bool
    {
        return Hyde::currentRoute()->getLink() === $this->destination;
    }

    protected static function getRouteGroup(Route $route): ?string
    {
        return static::normalizeGroupKey(($route)->getPage()->data('navigation.group'));
    }

    protected static function normalizeGroupKey(?string $group): ?string
    {
        return $group ? Str::slug($group) : null;
    }
}