Builder::getType() - Code Metrics - Inspection of "Writing readme..." - Malezha/menu - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 39d639...38e886 )

by Oleg

created 2016-05-01 15:13 UTC

Builder::getType() A

↳ Parent: Builder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	2
Bugs	1	Features	0

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

<?php
namespace Malezha\Menu\Entity;

use Illuminate\Contracts\Container\Container;
use Illuminate\Contracts\View\Factory as ViewFactory;
use Malezha\Menu\Contracts\Attributes as AttributesContract;
use Malezha\Menu\Contracts\Builder as BuilderContract;
use Malezha\Menu\Contracts\Group as GroupContract;
use Malezha\Menu\Contracts\Item as ItemContract;
use Malezha\Menu\Contracts\Link as LinkContract;
use Malezha\Menu\Traits\HasAttributes;

/**
 * Class Builder
 * @package Malezha\Menu\Entity
 */
class Builder implements BuilderContract
{
    use HasAttributes;

    /**
     * @var Container
     */
    protected $container;

    /**
     * @var array
     */
    protected $items;

    /**
     * @var string
     */
    protected $name;

    /**
     * @var string
     */
    protected $type;

    /**
     * @var AttributesContract
     */
    protected $activeAttributes;

    /**
     * @var ViewFactory
     */
    protected $viewFactory;

    /**
     * @var array
     */
    protected $config;

    /**
     * @var string
     */
    protected $view = null;
    
    /**
     * Builder constructor.
     *
     * @param Container $container
     * @param string $name
     * @param AttributesContract $attributes
     * @param AttributesContract $activeAttributes
     * @param string $type
     * @param string $view
     */
    public function __construct(Container $container, $name, AttributesContract $attributes,
                                AttributesContract $activeAttributes, $type = self::UL, $view = null)
    {
        $this->container = $container;
        $this->name = $name;
        $this->type = $type;
        $this->attributes = $attributes;
        $this->items = [];
        $this->activeAttributes = $activeAttributes;
        $this->viewFactory = $this->container->make(ViewFactory::class);
        $this->config = $this->container->make('config')->get('menu');
        try {
            $this->setView($view);
        } catch (\Exception $e) {}

    }

    /**
     * Make sub menu
     *
     * @param string $name
     * @param \Closure $itemCallable
     * @param \Closure $menuCallable
     * @return mixed
     */
    public function group($name, \Closure $itemCallable, \Closure $menuCallable)
    {
        $item = $this->container->make(ItemContract::class, [
            'builder' => $this,
            'attributes' => $this->container->make(AttributesContract::class, ['attributes' => []]),
            'link' => $this->container->make(LinkContract::class, [
                'title' => $name,
                'attributes' => $this->container->make(AttributesContract::class, ['attributes' => []]),
            ]),
            'request' => $this->container->make('request'),
        ]);
        call_user_func($itemCallable, $item);

        $menu = $this->container->make(BuilderContract::class, [
            'container' => $this->container, 
            'name' => $name,
            'activeAttributes' => $this->activeAttributes(),
            'attributes' => $this->container->make(AttributesContract::class, ['attributes' => []]),
            'view' => $this->getView(),
        ]);
        call_user_func($menuCallable, $menu);

        $group = $this->container->make(GroupContract::class, [
            'menu' => $menu,
            'item' => $item,
        ]);
        $this->items[$name] = $group;

        return $group;
    }

    /**
     * Add new element
     *
     * @param string $name
     * @param string $title
     * @param string $url
     * @param array $attributes
     * @param array $linkAttributes
     * @param \Closure|null $callback
     * @return ItemContract
     */
    public function add($name, $title, $url, $attributes = [], $linkAttributes = [], $callback = null)
    {
        $link = $this->container->make(LinkContract::class, [
            'title' => $title,
            'url' => $url,
            'attributes' => $this->container->make(AttributesContract::class, ['attributes' => $linkAttributes]),
        ]);
        
        $item = $this->container->make(ItemContract::class, [
            'builder' => $this,
            'attributes' => $this->container->make(AttributesContract::class, ['attributes' => $attributes]),
            'link' => $link,
            'request' => $this->container->make('request'),
        ]);

        if (is_callable($callback)) {
            call_user_func($callback, $item);
        }

        $this->items[$name] = $item;

        return $item;
    }

    /**
     * Check exits by name
     *
     * @param string $name
     * @return bool
     */
    public function has($name)
    {
        return array_key_exists($name, $this->items);
    }

    /**
     * Get element or sub menu by name
     *
     * @param string $name
     * @param mixed|null $default
     * @return ItemContract|GroupContract|null
     */
    public function get($name, $default = null)
    {
        if ($this->has($name)) {
            return $this->items[$name];
        }
        return $default;
    }

    /**
     * Get all elements and sub menus
     *
     * @return array
     */
    public function all()
    {
        return $this->items;
    }

    /**
     * Delete element
     *
     * @param string $name
     */
    public function forget($name)
    {
        if ($this->has($name)) {
            unset($this->items[$name]);
        }
    }

    /**
     * Get menu type: UL or OL
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Set menu type. You can use constants at this interface
     *
     * @param string $type
     */
    public function setType($type)
    {
        $this->type = (string) $type;
    }

    /**
     * Render menu to html
     *
     * @param string|null $renderView
     * @return string
     */
    public function render($renderView = null)
    {
        $view = $this->getRenderView($renderView);

        $minify = $this->config['minify'];

        $rendered = $this->viewFactory->make($view, [
            'menu' => $this,
            'renderView' => $renderView,
        ])->render();
        
        if ($minify) {
            $rendered = $this->minifyHtmlOutput($rendered);
        }
        
        return $rendered;
    }

    /**
     * Get active attributes object.
     * If send \Closure option as parameter then returned callback result.
     *
     * @param \Closure|null $callback
     * @return AttributesContract|mixed
     */
    public function activeAttributes($callback = null)
    {
        if (is_callable($callback)) {
            return call_user_func($callback, $this->activeAttributes);
        }

        return $this->activeAttributes;
    }

    /**
     * Get render view
     *
     * @return string
     */
    public function getView()
    {
        return $this->view;
    }

    /**
     * Set render view
     *
     * @param string $view
     * @throws \Exception
     */
    public function setView($view)
    {
        if (!$this->viewFactory->exists($view)) {
            throw new \Exception('View not found');
        }
        
        $this->view = $view;
    }

    /**
     * Minify html
     *
     * @param string $html
     * @return string
     */
    protected function minifyHtmlOutput($html)
    {
        $search = array(
            '/\>[^\S]+/s', // strip whitespaces after tags, except space
            '/[^\S]+\</s', // strip whitespaces before tags, except space
            '/(\s)+/s'       // shorten multiple whitespace sequences
        );

        $replace = array(
            '>',
            '<',
            '\\1'
        );

        return preg_replace($search, $replace, $html);
    }

    /**
     * Get view for render
     * 
     * @param string $view
     * @return string
     */
    protected function getRenderView($view = null)
    {
        $renderView = $this->config['view'];
        
        if (!empty($this->view)) {
            $renderView = $this->view;
        }
        
        if (!empty($view) && $this->viewFactory->exists($view)) {
            $renderView = $view;
        }
        
        return $renderView;
    }
}

1		<?php
2		namespace Malezha\Menu\Entity;
3
4		use Illuminate\Contracts\Container\Container;
5		use Illuminate\Contracts\View\Factory as ViewFactory;
6		use Malezha\Menu\Contracts\Attributes as AttributesContract;
7		use Malezha\Menu\Contracts\Builder as BuilderContract;
8		use Malezha\Menu\Contracts\Group as GroupContract;
9		use Malezha\Menu\Contracts\Item as ItemContract;
10		use Malezha\Menu\Contracts\Link as LinkContract;
11		use Malezha\Menu\Traits\HasAttributes;
12
13		/**
14		* Class Builder
15		* @package Malezha\Menu\Entity
16		*/
17		class Builder implements BuilderContract
18		{
19		use HasAttributes;
20
21		/**
22		* @var Container
23		*/
24		protected $container;
25
26		/**
27		* @var array
28		*/
29		protected $items;
30
31		/**
32		* @var string
33		*/
34		protected $name;
35
36		/**
37		* @var string
38		*/
39		protected $type;
40
41		/**
42		* @var AttributesContract
43		*/
44		protected $activeAttributes;
45
46		/**
47		* @var ViewFactory
48		*/
49		protected $viewFactory;
50
51		/**
52		* @var array
53		*/
54		protected $config;
55
56		/**
57		* @var string
58		*/
59		protected $view = null;
60
61		/**
62		* Builder constructor.
63		*
64		* @param Container $container
65		* @param string $name
66		* @param AttributesContract $attributes
67		* @param AttributesContract $activeAttributes
68		* @param string $type
69		* @param string $view
70		*/
71	19	public function __construct(Container $container, $name, AttributesContract $attributes,
72		AttributesContract $activeAttributes, $type = self::UL, $view = null)
73		{
74	19	$this->container = $container;
75	19	$this->name = $name;
76	19	$this->type = $type;
77	19	$this->attributes = $attributes;
78	19	$this->items = [];
79	19	$this->activeAttributes = $activeAttributes;
80	19	$this->viewFactory = $this->container->make(ViewFactory::class);
81	19	$this->config = $this->container->make('config')->get('menu');
82		try {
83	19	$this->setView($view);
84	19	} catch (\Exception $e) {}
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-05-01 15:18 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
85	19	}
86
87		/**
88		* Make sub menu
89		*
90		* @param string $name
91		* @param \Closure $itemCallable
92		* @param \Closure $menuCallable
93		* @return mixed
94		*/
95	3	public function group($name, \Closure $itemCallable, \Closure $menuCallable)
96		{
97	3	$item = $this->container->make(ItemContract::class, [
98	3	'builder' => $this,
99	3	'attributes' => $this->container->make(AttributesContract::class, ['attributes' => []]),
100	3	'link' => $this->container->make(LinkContract::class, [
101	3	'title' => $name,
102	3	'attributes' => $this->container->make(AttributesContract::class, ['attributes' => []]),
103	3	]),
104	3	'request' => $this->container->make('request'),
105	3	]);
106	3	call_user_func($itemCallable, $item);
107
108	3	$menu = $this->container->make(BuilderContract::class, [
109	3	'container' => $this->container,
110	3	'name' => $name,
111	3	'activeAttributes' => $this->activeAttributes(),
112	3	'attributes' => $this->container->make(AttributesContract::class, ['attributes' => []]),
113	3	'view' => $this->getView(),
114	3	]);
115	3	call_user_func($menuCallable, $menu);
116
117	3	$group = $this->container->make(GroupContract::class, [
118	3	'menu' => $menu,
119	3	'item' => $item,
120	3	]);
121	3	$this->items[$name] = $group;
122
123	3	return $group;
124		}
125
126		/**
127		* Add new element
128		*
129		* @param string $name
130		* @param string $title
131		* @param string $url
132		* @param array $attributes
133		* @param array $linkAttributes
134		* @param \Closure\|null $callback
135		* @return ItemContract
136		*/
137	11	public function add($name, $title, $url, $attributes = [], $linkAttributes = [], $callback = null)
138		{
139	11	$link = $this->container->make(LinkContract::class, [
140	11	'title' => $title,
141	11	'url' => $url,
142	11	'attributes' => $this->container->make(AttributesContract::class, ['attributes' => $linkAttributes]),
143	11	]);
144
145	11	$item = $this->container->make(ItemContract::class, [
146	11	'builder' => $this,
147	11	'attributes' => $this->container->make(AttributesContract::class, ['attributes' => $attributes]),
148	11	'link' => $link,
149	11	'request' => $this->container->make('request'),
150	11	]);
151
152	11	if (is_callable($callback)) {
153	2	call_user_func($callback, $item);
154	2	}
155
156	11	$this->items[$name] = $item;
157
158	11	return $item;
159		}
160
161		/**
162		* Check exits by name
163		*
164		* @param string $name
165		* @return bool
166		*/
167	6	public function has($name)
168		{
169	6	return array_key_exists($name, $this->items);
170		}
171
172		/**
173		* Get element or sub menu by name
174		*
175		* @param string $name
176		* @param mixed\|null $default
177		* @return ItemContract\|GroupContract\|null
178		*/
179	3	public function get($name, $default = null)
180		{
181	3	if ($this->has($name)) {
182	3	return $this->items[$name];
183		}
184		return $default;
185		}
186
187		/**
188		* Get all elements and sub menus
189		*
190		* @return array
191		*/
192	5	public function all()
193		{
194	5	return $this->items;
195		}
196
197		/**
198		* Delete element
199		*
200		* @param string $name
201		*/
202	1	public function forget($name)
203		{
204	1	if ($this->has($name)) {
205	1	unset($this->items[$name]);
206	1	}
207	1	}
208
209		/**
210		* Get menu type: UL or OL
211		*
212		* @return string
213		*/
214	5	public function getType()
215		{
216	5	return $this->type;
217		}
218
219		/**
220		* Set menu type. You can use constants at this interface
221		*
222		* @param string $type
223		*/
224	1	public function setType($type)
225		{
226	1	$this->type = (string) $type;
227	1	}
228
229		/**
230		* Render menu to html
231		*
232		* @param string\|null $renderView
233		* @return string
234		*/
235	4	public function render($renderView = null)
236		{
237	4	$view = $this->getRenderView($renderView);
238
239	4	$minify = $this->config['minify'];
240
241	4	$rendered = $this->viewFactory->make($view, [
242	4	'menu' => $this,
243	4	'renderView' => $renderView,
244	4	])->render();
245
246	4	if ($minify) {
247	4	$rendered = $this->minifyHtmlOutput($rendered);
248	4	}
249
250	4	return $rendered;
251		}
252
253		/**
254		* Get active attributes object.
255		* If send \Closure option as parameter then returned callback result.
256		*
257		* @param \Closure\|null $callback
258		* @return AttributesContract\|mixed
259		*/
260	7	public function activeAttributes($callback = null)
261		{
262	7	if (is_callable($callback)) {
263	1	return call_user_func($callback, $this->activeAttributes);
264		}
265
266	7	return $this->activeAttributes;
267		}
268
269		/**
270		* Get render view
271		*
272		* @return string
273		*/
274	3	public function getView()
275		{
276	3	return $this->view;
277		}
278
279		/**
280		* Set render view
281		*
282		* @param string $view
283		* @throws \Exception
284		*/
285	19	public function setView($view)
286		{
287	19	if (!$this->viewFactory->exists($view)) {
288	19	throw new \Exception('View not found');
289		}
290
291	1	$this->view = $view;
292	1	}
293
294		/**
295		* Minify html
296		*
297		* @param string $html
298		* @return string
299		*/
300	4	protected function minifyHtmlOutput($html)
301		{
302		$search = array(
303	4	'/\>[^\S]+/s', // strip whitespaces after tags, except space
304	4	'/[^\S]+\</s', // strip whitespaces before tags, except space
305		'/(\s)+/s' // shorten multiple whitespace sequences
306	4	);
307
308		$replace = array(
309	4	'>',
310	4	'<',
311		'\\1'
312	4	);
313
314	4	return preg_replace($search, $replace, $html);
315		}
316
317		/**
318		* Get view for render
319		*
320		* @param string $view
321		* @return string
322		*/
323	4	protected function getRenderView($view = null)
324		{
325	4	$renderView = $this->config['view'];
326
327	4	if (!empty($this->view)) {
328	1	$renderView = $this->view;
329	1	}
330
331	4	if (!empty($view) && $this->viewFactory->exists($view)) {
332	1	$renderView = $view;
333	1	}
334
335	4	return $renderView;
336		}
337		}

Malezha / menu

Push — master ( 39d639...38e886 )

Builder::getType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like