Arcanedev\Breadcrumbs\Contracts\Breadcrumbs

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	setSupported()	0	1	?
	setTemplate()	0	1	?
	register()	0	1	?
	render()	0	1	?
	generate()	0	1	?

<?php

declare(strict_types=1);

namespace Arcanedev\Breadcrumbs\Contracts;

use Closure;

/**
 * Interface  Breadcrumbs
 *
 * @author    ARCANEDEV <arcanedev.maroc@gmail.com>
 */
interface Breadcrumbs
{
    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Set the supported template.
     *
     * @param  array  $supported
     *
     * @return self
     */
    public function setSupported(array $supported);

    /**
     * Set default template view.
     *
     * @param  string  $template
     *
     * @return self
     */
    public function setTemplate($template);

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Register a breadcrumb domain.
     *
     * @param  string    $name
     * @param  \Closure  $callback
     *
     * @return self
     */
    public function register($name, Closure $callback);

    /**
     * Render breadcrumbs items.
     *
     * @param  string|null  $name
     * @param  array        $params
     *
     * @return \Illuminate\Support\HtmlString
     */
    public function render($name = null, ...$params);

    /**
     * Generate the breadcrumbs.
     *
     * @param  string  $name
     * @param  array   $params
     *
     * @return array
     */
    public function generate($name, ...$params);
}