laravel-6 support
This commit is contained in:
RafficMohammed
315
vendor/davejamesmiller/laravel-breadcrumbs/src/BreadcrumbsManager.php
vendored
Normal file
315
vendor/davejamesmiller/laravel-breadcrumbs/src/BreadcrumbsManager.php
vendored
Normal file
@@ -0,0 +1,315 @@
|
||||
<?php
|
||||
|
||||
namespace DaveJamesMiller\Breadcrumbs;
|
||||
|
||||
use DaveJamesMiller\Breadcrumbs\Exceptions\DuplicateBreadcrumbException;
|
||||
use DaveJamesMiller\Breadcrumbs\Exceptions\InvalidBreadcrumbException;
|
||||
use DaveJamesMiller\Breadcrumbs\Exceptions\UnnamedRouteException;
|
||||
use DaveJamesMiller\Breadcrumbs\Exceptions\ViewNotSetException;
|
||||
use Illuminate\Contracts\View\Factory as ViewFactory;
|
||||
use Illuminate\Routing\Router;
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\HtmlString;
|
||||
use Illuminate\Support\Traits\Macroable;
|
||||
|
||||
/**
|
||||
* The main Breadcrumbs singleton class, responsible for registering, generating and rendering breadcrumbs.
|
||||
*/
|
||||
class BreadcrumbsManager
|
||||
{
|
||||
use Macroable;
|
||||
|
||||
/**
|
||||
* @var BreadcrumbsGenerator
|
||||
*/
|
||||
protected $generator;
|
||||
|
||||
/**
|
||||
* @var Router
|
||||
*/
|
||||
protected $router;
|
||||
|
||||
/**
|
||||
* @var ViewFactory
|
||||
*/
|
||||
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(BreadcrumbsGenerator $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 \DaveJamesMiller\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 breadcrumb-generating callback for a page.
|
||||
*
|
||||
* For backwards-compatibility with v5.0.0 and below.
|
||||
*
|
||||
* @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 \DaveJamesMiller\Breadcrumbs\Exceptions\DuplicateBreadcrumbException If the given name has already been
|
||||
* used.
|
||||
* @see self::for()
|
||||
*/
|
||||
public function register(string $name, callable $callback): void
|
||||
{
|
||||
$this->for($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 \DaveJamesMiller\Breadcrumbs\Exceptions\UnnamedRouteException if no name is given and the current route
|
||||
* doesn't have an associated name.
|
||||
* @throws \DaveJamesMiller\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\Support\HtmlString The generated HTML.
|
||||
* @throws \DaveJamesMiller\Breadcrumbs\Exceptions\InvalidBreadcrumbException if the name is (or any ancestor names are) not registered.
|
||||
* @throws \DaveJamesMiller\Breadcrumbs\Exceptions\UnnamedRouteException if no name is given and the current route doesn't have an associated name.
|
||||
* @throws \DaveJamesMiller\Breadcrumbs\Exceptions\ViewNotSetException if no view has been set.
|
||||
*/
|
||||
public function view(string $view, string $name = null, ...$params): HtmlString
|
||||
{
|
||||
$breadcrumbs = $this->generate($name, ...$params);
|
||||
|
||||
// TODO: After dropping support for Laravel 5.8 and below, change this to return the view directly
|
||||
// https://github.com/laravel/framework/pull/29600
|
||||
$html = $this->viewFactory->make($view, compact('breadcrumbs'))->render();
|
||||
|
||||
return new HtmlString($html);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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\Support\HtmlString The generated HTML.
|
||||
* @throws \DaveJamesMiller\Breadcrumbs\Exceptions\InvalidBreadcrumbException if the name is (or any ancestor names are) not registered.
|
||||
* @throws \DaveJamesMiller\Breadcrumbs\Exceptions\UnnamedRouteException if no name is given and the current route doesn't have an associated name.
|
||||
* @throws \DaveJamesMiller\Breadcrumbs\Exceptions\ViewNotSetException if no view has been set.
|
||||
*/
|
||||
public function render(string $name = null, ...$params): HtmlString
|
||||
{
|
||||
$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.
|
||||
*
|
||||
* Optionally pass a
|
||||
*
|
||||
* @return \stdClass|null The breadcrumb for the current page.
|
||||
* @throws \DaveJamesMiller\Breadcrumbs\Exceptions\UnnamedRouteException if the current route doesn't have an associated name.
|
||||
* @throws \DaveJamesMiller\Breadcrumbs\Exceptions\InvalidBreadcrumbException if the name is (or any ancestor names are) not registered.
|
||||
*/
|
||||
public function current(): ?\stdClass
|
||||
{
|
||||
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 \DaveJamesMiller\Breadcrumbs\Exceptions\UnnamedRouteException if the current route doesn't have an associated name.
|
||||
*/
|
||||
protected function getCurrentRoute()
|
||||
{
|
||||
// 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($route->parameters());
|
||||
|
||||
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;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user