Breadcrumbs::generateArray() - Code Metrics - Inspection of "Merge pull request #10 from ARCANEDEV/develop" - ARCANEDEV/Breadcrumbs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 97f723...527cf6 )

by ARCANEDEV

created 2017-09-01 17:51 UTC

Breadcrumbs::generateArray() A

↳ Parent: Breadcrumbs

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	2
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
ccs	4
cts	4
cp	1
crap	1

<?php namespace Arcanedev\Breadcrumbs;

use Arcanedev\Breadcrumbs\Contracts\Breadcrumbs as BreadcrumbsContract;
use Closure;
use Illuminate\Support\HtmlString;

/**
 * Class     Breadcrumbs
 *
 * @package  Arcanedev\Breadcrumbs
 * @author   ARCANEDEV <[email protected]>
 */
class Breadcrumbs implements BreadcrumbsContract
{
    /* -----------------------------------------------------------------
     |  Constants
     | -----------------------------------------------------------------
     */

    const DEFAULT_TEMPLATE = 'bootstrap-3';

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * Default template view.
     *
     * @var string
     */
    private $template;

    /**
     * Supported template views.
     *
     * @var array
     */
    protected $supported = [
        'bootstrap-3' => 'breadcrumbs::bootstrap-3',
    ];

    /** @var array */
    protected $callbacks = [];

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Create a Breadcrumbs instance.
     *
     * @param  array        $supported
     * @param  string|null  $template
     */
    public function __construct(array $supported, $template = null)
    {
        $this->setSupported($supported);
        $this->setTemplate(is_null($template) ? self::DEFAULT_TEMPLATE : $template);
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Set the supported template.
     *
     * @param  array  $supported
     *
     * @return self
     */
    public function setSupported(array $supported)
    {
        $this->supported = $supported;

        return $this;
    }

    /**
     * Set default template view.
     *
     * @param  string  $template
     *
     * @return self
     */
    public function setTemplate($template)
    {
        $this->checkTemplate($template);

        $this->template = $template;

        return $this;
    }

    /**
     * Get the template view.
     *
     * @return string
     */
    private function getView()
    {
        return $this->supported[$this->template];
    }

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

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

        $this->callbacks[$name] = $callback;

        return $this;
    }

    /**
     * Render breadcrumbs items.
     *
     * @param  string|null  $name
     * @param  array        $params
     *
     * @return \Illuminate\Support\HtmlString
     */
    public function render($name = null, ...$params)
    {
        return new HtmlString(
            view($this->getView(), [
                'breadcrumbs' => $this->generate($name, $params)
            ])->render()
        );
    }

    /**
     * Generate the breadcrumbs.
     *
     * @param  string  $name
     * @param  array   $params
     *
     * @return array
     */
    public function generate($name, ...$params)
    {
        return (new Builder($this->callbacks))
            ->call($name, $params)
            ->toArray();
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check Template.
     *
     * @param  string  $template
     *
     * @throws Exceptions\InvalidTemplateException
     * @throws Exceptions\InvalidTypeException
     */
    private function checkTemplate($template)
    {
        if ( ! is_string($template)) {
            $type = gettype($template);
            throw new Exceptions\InvalidTypeException(
                "The default template name must be a string, $type given."
            );
        }

        $template = strtolower(trim($template));

        if ( ! array_key_exists($template, $this->supported)) {
            throw new Exceptions\InvalidTemplateException(
                "The template [$template] is not supported."
            );
        }
    }

    /**
     * Check Name.
     *
     * @param  string  $name
     *
     * @throws Exceptions\InvalidTypeException
     */
    private function checkCallbackName(&$name)
    {
        if ( ! is_string($name)) {
            $type = gettype($name);

            throw new Exceptions\InvalidTypeException(
                "The callback name value must be a string, $type given."
            );
        }

        $name = strtolower(trim($name));
    }
}


1		<?php namespace Arcanedev\Breadcrumbs;
2
3		use Arcanedev\Breadcrumbs\Contracts\Breadcrumbs as BreadcrumbsContract;
4		use Closure;
5		use Illuminate\Support\HtmlString;
6
7		/**
8		* Class Breadcrumbs
9		*
10		* @package Arcanedev\Breadcrumbs
11		* @author ARCANEDEV <[email protected]>
12		*/
13		class Breadcrumbs implements BreadcrumbsContract
14		{
15		/* -----------------------------------------------------------------
16		\| Constants
17		\| -----------------------------------------------------------------
18		*/
19
20		const DEFAULT_TEMPLATE = 'bootstrap-3';
21
22		/* -----------------------------------------------------------------
23		\| Properties
24		\| -----------------------------------------------------------------
25		*/
26
27		/**
28		* Default template view.
29		*
30		* @var string
31		*/
32		private $template;
33
34		/**
35		* Supported template views.
36		*
37		* @var array
38		*/
39		protected $supported = [
40		'bootstrap-3' => 'breadcrumbs::bootstrap-3',
41		];
42
43		/** @var array */
44		protected $callbacks = [];
45
46		/* -----------------------------------------------------------------
47		\| Constructor
48		\| -----------------------------------------------------------------
49		*/
50
51		/**
52		* Create a Breadcrumbs instance.
53		*
54		* @param array $supported
55		* @param string\|null $template
56		*/
57	20	public function __construct(array $supported, $template = null)
58		{
59	20	$this->setSupported($supported);
60	20	$this->setTemplate(is_null($template) ? self::DEFAULT_TEMPLATE : $template);
61	20	}
62
63		/* -----------------------------------------------------------------
64		\| Getters & Setters
65		\| -----------------------------------------------------------------
66		*/
67
68		/**
69		* Set the supported template.
70		*
71		* @param array $supported
72		*
73		* @return self
74		*/
75	20	public function setSupported(array $supported)
76		{
77	20	$this->supported = $supported;
78
79	20	return $this;
80		}
81
82		/**
83		* Set default template view.
84		*
85		* @param string $template
86		*
87		* @return self
88		*/
89	20	public function setTemplate($template)
90		{
91	20	$this->checkTemplate($template);
92
93	20	$this->template = $template;
94
95	20	return $this;
96		}
97
98		/**
99		* Get the template view.
100		*
101		* @return string
102		*/
103	6	private function getView()
104		{
105	6	return $this->supported[$this->template];
106		}
107
108		/* -----------------------------------------------------------------
109		\| Main Methods
110		\| -----------------------------------------------------------------
111		*/
112
113		/**
114		* Register a breadcrumb domain.
115		*
116		* @param string $name
117		* @param \Closure $callback
118		*
119		* @return self
120		*/
121	20	public function register($name, Closure $callback)
122		{
123	20	$this->checkCallbackName($name);
124
125	20	$this->callbacks[$name] = $callback;
126
127	20	return $this;
128		}
129
130		/**
131		* Render breadcrumbs items.
132		*
133		* @param string\|null $name
134		* @param array $params
135		*
136		* @return \Illuminate\Support\HtmlString
137		*/
138	6	public function render($name = null, ...$params)
139		{
140	6	return new HtmlString(
141	6	view($this->getView(), [
142	6	'breadcrumbs' => $this->generate($name, $params)
143	6	])->render()
144		);
145		}
146
147		/**
148		* Generate the breadcrumbs.
149		*
150		* @param string $name
151		* @param array $params
152		*
153		* @return array
154		*/
155	10	public function generate($name, ...$params)
156		{
157	10	return (new Builder($this->callbacks))
158	10	->call($name, $params)
159	10	->toArray();
160		}
161
162		/* -----------------------------------------------------------------
163		\| Check Methods
164		\| -----------------------------------------------------------------
165		*/
166
167		/**
168		* Check Template.
169		*
170		* @param string $template
171		*
172		* @throws Exceptions\InvalidTemplateException
173		* @throws Exceptions\InvalidTypeException
174		*/
175	20	private function checkTemplate($template)
176		{
177	20	if ( ! is_string($template)) {
178	2	$type = gettype($template);
179	2	throw new Exceptions\InvalidTypeException(
180	2	"The default template name must be a string, $type given."
181		);
182		}
183
184	20	$template = strtolower(trim($template));
185
186	20	if ( ! array_key_exists($template, $this->supported)) {
187	2	throw new Exceptions\InvalidTemplateException(
188	2	"The template [$template] is not supported."
189		);
190		}
191	20	}
192
193		/**
194		* Check Name.
195		*
196		* @param string $name
197		*
198		* @throws Exceptions\InvalidTypeException
199		*/
200	20	private function checkCallbackName(&$name)
201		{
202	20	if ( ! is_string($name)) {
203	2	$type = gettype($name);
204
205	2	throw new Exceptions\InvalidTypeException(
206	2	"The callback name value must be a string, $type given."
207		);
208		}
209
210	20	$name = strtolower(trim($name));
211	20	}
212		}
213

ARCANEDEV / Breadcrumbs

Push — master ( 97f723...527cf6 )

Breadcrumbs::generateArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like