Viewing file:  Manager.php (10.28 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
namespace Diglactic\Breadcrumbs;
use Diglactic\Breadcrumbs\Exceptions\DuplicateBreadcrumbException;
use Diglactic\Breadcrumbs\Exceptions\InvalidBreadcrumbException;
use Diglactic\Breadcrumbs\Exceptions\UnnamedRouteException;
use Diglactic\Breadcrumbs\Exceptions\ViewNotSetException;
use Illuminate\Contracts\View\Factory as ViewFactory;
use Illuminate\Contracts\View\View;
use Illuminate\Routing\Router;
use Illuminate\Support\Collection;
use Illuminate\Support\Traits\Macroable;
/**
* The main Breadcrumbs singleton class, responsible for registering, generating and rendering breadcrumbs.
*/
class Manager
{
use Macroable;
/** @var Generator */
protected $generator;
/** @var \Illuminate\Routing\Router */
protected $router;
/** @var \Illuminate\Contracts\View\Factory */
protected $viewFactory;
/** @var array The registered breadcrumb-generating callbacks. */
protected $callbacks = [];
/** @var array Closures to call before generating breadcrumbs for the current page. */
protected $before = [];
/** @var array Closures to call after generating breadcrumbs for the current page. */
protected $after = [];
/** @var array|null The current route name and parameters. */
protected $route;
public function __construct(Generator $generator, Router $router, ViewFactory $viewFactory)
{
$this->generator = $generator;
$this->router = $router;
$this->viewFactory = $viewFactory;
}
/**
* Register a breadcrumb-generating callback for a page.
*
* @param string $name The name of the page.
* @param callable $callback The callback, which should accept a Generator instance as the first parameter and may
* accept additional parameters.
* @return void
* @throws \Diglactic\Breadcrumbs\Exceptions\DuplicateBreadcrumbException If the given name has already been used.
*/
public function for(string $name, callable $callback): void
{
if (isset($this->callbacks[$name])) {
throw new DuplicateBreadcrumbException($name);
}
$this->callbacks[$name] = $callback;
}
/**
* Register a closure to call before generating breadcrumbs for the current page.
*
* For example, this can be used to always prepend the homepage without needing to manually add it to each page.
*
* @param callable $callback The callback, which should accept a Generator instance as the first and only parameter.
* @return void
*/
public function before(callable $callback): void
{
$this->before[] = $callback;
}
/**
* Register a closure to call after generating breadcrumbs for the current page.
*
* For example, this can be used to append the current page number when using pagination.
*
* @param callable $callback The callback, which should accept a Generator instance as the first and only parameter.
* @return void
*/
public function after(callable $callback): void
{
$this->after[] = $callback;
}
/**
* Check if a breadcrumb with the given name exists.
*
* If no name is given, defaults to the current route name.
*
* @param string|null $name The page name.
* @return bool Whether there is a registered callback with that name.
*/
public function exists(?string $name = null): bool
{
if (is_null($name)) {
try {
[$name] = $this->getCurrentRoute();
} catch (UnnamedRouteException $e) {
return false;
}
}
return isset($this->callbacks[$name]);
}
/**
* Generate a set of breadcrumbs for a page.
*
* @param string|null $name The name of the current page.
* @param mixed ...$params The parameters to pass to the closure for the current page.
* @return \Illuminate\Support\Collection The generated breadcrumbs.
* @throws \Diglactic\Breadcrumbs\Exceptions\UnnamedRouteException if no name is given and the current route doesn't
* have an associated name.
* @throws \Diglactic\Breadcrumbs\Exceptions\InvalidBreadcrumbException if the name is (or any ancestor names are)
* not registered.
*/
public function generate(?string $name = null, ...$params): Collection
{
$origName = $name;
// Route-bound breadcrumbs
if ($name === null) {
try {
[$name, $params] = $this->getCurrentRoute();
} catch (UnnamedRouteException $e) {
if (config('breadcrumbs.unnamed-route-exception')) {
throw $e;
}
return new Collection;
}
}
// Generate breadcrumbs
try {
return $this->generator->generate($this->callbacks, $this->before, $this->after, $name, $params);
} catch (InvalidBreadcrumbException $e) {
if ($origName === null && config('breadcrumbs.missing-route-bound-breadcrumb-exception')) {
$e->setIsRouteBound();
throw $e;
}
if ($origName !== null && config('breadcrumbs.invalid-named-breadcrumb-exception')) {
throw $e;
}
return new Collection;
}
}
/**
* Render breadcrumbs for a page with the specified view.
*
* @param string $view The name of the view to render.
* @param string|null $name The name of the current page.
* @param mixed ...$params The parameters to pass to the closure for the current page.
* @return \Illuminate\View\View The generated HTML.
* @throws \Diglactic\Breadcrumbs\Exceptions\InvalidBreadcrumbException if the name is (or any ancestor names are)
* not registered.
* @throws \Diglactic\Breadcrumbs\Exceptions\UnnamedRouteException if no name is given and the current route doesn't
* have an associated name.
*/
public function view(string $view, ?string $name = null, ...$params): View
{
$breadcrumbs = $this->generate($name, ...$params);
return $this->viewFactory->make($view, compact('breadcrumbs'));
}
/**
* Render breadcrumbs for a page with the default view.
*
* @param string|null $name The name of the current page.
* @param mixed ...$params The parameters to pass to the closure for the current page.
* @return \Illuminate\Contracts\View\View The generated view.
* @throws \Diglactic\Breadcrumbs\Exceptions\InvalidBreadcrumbException if the name is (or any ancestor names are)
* not registered.
* @throws \Diglactic\Breadcrumbs\Exceptions\UnnamedRouteException if no name is given and the current route doesn't
* have an associated name.
* @throws \Diglactic\Breadcrumbs\Exceptions\ViewNotSetException if no view has been set.
*/
public function render(?string $name = null, ...$params): View
{
$view = config('breadcrumbs.view');
if (!$view) {
throw new ViewNotSetException('Breadcrumbs view not specified (check config/breadcrumbs.php)');
}
return $this->view($view, $name, ...$params);
}
/**
* Get the last breadcrumb for the current page.
*
* @return object|null The breadcrumb for the current page.
* @throws \Diglactic\Breadcrumbs\Exceptions\UnnamedRouteException if the current route doesn't have an associated
* name.
* @throws \Diglactic\Breadcrumbs\Exceptions\InvalidBreadcrumbException if the name is (or any ancestor names are)
* not registered.
*/
public function current(): ?object
{
return $this->generate()->where('current', '!==', false)->last();
}
/**
* Get the current route name and parameters.
*
* This may be the route set manually with the setCurrentRoute() method, but normally is the route retrieved from
* the Laravel Router.
*
* #### Example
* ```php
* [$name, $params] = $this->getCurrentRoute();
* ```
*
* @return array A two-element array consisting of the route name (string) and any parameters (array).
* @throws \Diglactic\Breadcrumbs\Exceptions\UnnamedRouteException if the current route doesn't have an associated
* name.
*/
protected function getCurrentRoute(): array
{
// Manually set route
if ($this->route) {
return $this->route;
}
// Determine the current route
$route = $this->router->current();
// No current route - must be the 404 page
if ($route === null) {
return ['errors.404', []];
}
// Convert route to name
$name = $route->getName();
if ($name === null) {
throw new UnnamedRouteException($route);
}
// Get the current route parameters
$params = array_values(array_map(function ($parameterName) use ($route) {
return $route->parameter($parameterName);
}, $route->parameterNames()));
return [$name, $params];
}
/**
* Set the current route name and parameters to use when calling render() or generate() with no parameters.
*
* @param string $name The name of the current page.
* @param mixed ...$params The parameters to pass to the closure for the current page.
* @return void
*/
public function setCurrentRoute(string $name, ...$params): void
{
$this->route = [$name, $params];
}
/**
* Clear the previously set route name and parameters to use when calling render() or generate() with no parameters.
*
* Next time it will revert to the default behaviour of using the current route from Laravel.
*
* @return void
*/
public function clearCurrentRoute(): void
{
$this->route = null;
}
}
|