MultilingualRoutePendingRegistration::data() - Code Metrics - Inspection of "Merge branch 'v2'" - chinleung/laravel-multilingual-routes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 07efb3...874ff6 )

by Chin

created 2020-07-14 18:56 UTC

MultilingualRoutePendingRegistration::data() A

↳ Parent: MultilingualRoutePendingRegistration

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	6
rs	10
c	0
b	0
f	0

<?php

namespace ChinLeung\MultilingualRoutes;

use Illuminate\Routing\RouteCollection;
use Illuminate\Support\Arr;

class MultilingualRoutePendingRegistration
{
    /**
     * The handle of the routes.
     *
     * @var mixed
     */
    protected $handle;

    /**
     * The translation key of the routes.
     *
     * @var string
     */
    protected $key;

    /**
     * The list of locales for the route.
     *
     * @var array
     */
    protected $locales = [];

    /**
     * The options of the routes.
     *
     * @var array
     */
    protected $options = [];

    /**
     * The resource's registration status.
     *
     * @var bool
     */
    protected $registered = false;

    /**
     * The resource registrar.
     *
     * @var \ChinLeung\MultilingualRoutes\MultilingualRegistrar
     */
    protected $registrar;

    /**
     * Constructor of the class.
     *
     * @param  \ChinLeung\MultilingualRoutes\MultilingualRegistrar  $registrar
     * @param  string  $key
     * @param  mixed  $handle
     * @param  array  $locales
     */
    public function __construct(MultilingualRegistrar $registrar, string $key, $handle, array $locales = [])
    {
        $this->key = $key;
        $this->registrar = $registrar;
        $this->handle = $handle;
        $this->locales = $locales;
    }

    /**
     * Register the resource route.
     *
     * @return \Illuminate\Routing\RouteCollection
     */
    public function register(): RouteCollection
    {
        $this->registered = true;

        return $this->registrar->register(
            $this->key,
            $this->handle,
            $this->options['locales'] ?? $this->locales,
            $this->options
        );
    }

    /**
     * Set the default view data of the route.
     *
     * @param  array  $data
     * @return self
     */
    public function data(array $data): self
    {
        $this->options['data'] = $data;

        return $this;
    }

    /**
     * Add one or many locale to the exception.
     *
     * @param  string|array  $locales
     * @return self
     */
    public function except($locales): self
    {
        $this->options['locales'] = array_diff(
            $this->locales,
            Arr::wrap($locales)
        );

        return $this;
    }

    /**
     * Set the name of the routes.
     *
     * @param  string  $name
     * @return self
     */
    public function name(string $name): self
    {
        $this->options['name'] = $name;

        return $this;
    }

    /**
     * Set the method of the routes.
     *
     * @param  string  $method
     * @return self
     */
    public function method(string $method): self
    {
        $this->options['method'] = $method;

        return $this;
    }

    /**
     * Set the name of each locale for the routes.
     *
     * @param  array  $names
     * @return self
     */
    public function names(array $names): self
    {
        $this->options['names'] = $names;

        return $this;
    }

    /**
     * Set the route for a list of locales only.
     *
     * @param  string|array  $locales
     * @return self
     */
    public function only($locales): self
    {
        $this->options['locales'] = array_intersect(
            $this->locales,
            Arr::wrap($locales)
        );

        return $this;
    }

    /**
     * Set a regular expression requirement on the route.
     *
     * @param  array|string  $name
     * @param  string|null  $expression
     * @return $this
     */
    public function where($name, $expression = null): self
    {
        if (! is_array(Arr::get($this->options, 'constraints'))) {
            Arr::set($this->options, 'constraints', []);
        }

        Arr::set($this->options, "constraints.$name", $expression);

        return $this;
    }

    /**
     * Set the view to render.
     *
     * @param  string  $view
     * @param  array  $data
     * @return self
     */
    public function view(string $view, array $data = []): self
    {
        $this->options['view'] = $view;

        if (filled($data)) {
            $this->options['data'] = $data;
        }

        return $this;
    }

    /**
     * Set default parameters values of the routes.
     *
     * @param  array  $defaults
     * @return self
     */
    public function defaults(array $defaults): self
    {
        $this->options['defaults'] = $defaults;

        return $this;
    }

    /**
     * Handle the object's destruction.
     *
     * @return void
     */
    public function __destruct()
    {
        if (! $this->registered) {
            $this->register();
        }
    }
}


1			<?php
2
3			namespace ChinLeung\MultilingualRoutes;
4
5			use Illuminate\Routing\RouteCollection;
6			use Illuminate\Support\Arr;
7
8			class MultilingualRoutePendingRegistration
9			{
10			/**
11			* The handle of the routes.
12			*
13			* @var mixed
14			*/
15			protected $handle;
16
17			/**
18			* The translation key of the routes.
19			*
20			* @var string
21			*/
22			protected $key;
23
24			/**
25			* The list of locales for the route.
26			*
27			* @var array
28			*/
29			protected $locales = [];
30
31			/**
32			* The options of the routes.
33			*
34			* @var array
35			*/
36			protected $options = [];
37
38			/**
39			* The resource's registration status.
40			*
41			* @var bool
42			*/
43			protected $registered = false;
44
45			/**
46			* The resource registrar.
47			*
48			* @var \ChinLeung\MultilingualRoutes\MultilingualRegistrar
49			*/
50			protected $registrar;
51
52			/**
53			* Constructor of the class.
54			*
55			* @param \ChinLeung\MultilingualRoutes\MultilingualRegistrar $registrar
56			* @param string $key
57			* @param mixed $handle
58			* @param array $locales
59			*/
60			public function __construct(MultilingualRegistrar $registrar, string $key, $handle, array $locales = [])
61			{
62			$this->key = $key;
63			$this->registrar = $registrar;
64			$this->handle = $handle;
65			$this->locales = $locales;
66			}
67
68			/**
69			* Register the resource route.
70			*
71			* @return \Illuminate\Routing\RouteCollection
72			*/
73			public function register(): RouteCollection
74			{
75			$this->registered = true;
76
77			return $this->registrar->register(
78			$this->key,
79			$this->handle,
80			$this->options['locales'] ?? $this->locales,
81			$this->options
82			);
83			}
84
85			/**
86			* Set the default view data of the route.
87			*
88			* @param array $data
89			* @return self
90			*/
91			public function data(array $data): self
92			{
93			$this->options['data'] = $data;
94
95			return $this;
96			}
97
98			/**
99			* Add one or many locale to the exception.
100			*
101			* @param string\|array $locales
102			* @return self
103			*/
104			public function except($locales): self
105			{
106			$this->options['locales'] = array_diff(
107			$this->locales,
108			Arr::wrap($locales)
109			);
110
111			return $this;
112			}
113
114			/**
115			* Set the name of the routes.
116			*
117			* @param string $name
118			* @return self
119			*/
120			public function name(string $name): self
121			{
122			$this->options['name'] = $name;
123
124			return $this;
125			}
126
127			/**
128			* Set the method of the routes.
129			*
130			* @param string $method
131			* @return self
132			*/
133			public function method(string $method): self
134			{
135			$this->options['method'] = $method;
136
137			return $this;
138			}
139
140			/**
141			* Set the name of each locale for the routes.
142			*
143			* @param array $names
144			* @return self
145			*/
146			public function names(array $names): self
147			{
148			$this->options['names'] = $names;
149
150			return $this;
151			}
152
153			/**
154			* Set the route for a list of locales only.
155			*
156			* @param string\|array $locales
157			* @return self
158			*/
159			public function only($locales): self
160			{
161			$this->options['locales'] = array_intersect(
162			$this->locales,
163			Arr::wrap($locales)
164			);
165
166			return $this;
167			}
168
169			/**
170			* Set a regular expression requirement on the route.
171			*
172			* @param array\|string $name
173			* @param string\|null $expression
174			* @return $this
175			*/
176			public function where($name, $expression = null): self
177			{
178			if (! is_array(Arr::get($this->options, 'constraints'))) {
179			Arr::set($this->options, 'constraints', []);
180			}
181
182			Arr::set($this->options, "constraints.$name", $expression);
183
184			return $this;
185			}
186
187			/**
188			* Set the view to render.
189			*
190			* @param string $view
191			* @param array $data
192			* @return self
193			*/
194			public function view(string $view, array $data = []): self
195			{
196			$this->options['view'] = $view;
197
198			if (filled($data)) {
199			$this->options['data'] = $data;
200			}
201
202			return $this;
203			}
204
205			/**
206			* Set default parameters values of the routes.
207			*
208			* @param array $defaults
209			* @return self
210			*/
211			public function defaults(array $defaults): self
212			{
213			$this->options['defaults'] = $defaults;
214
215			return $this;
216			}
217
218			/**
219			* Handle the object's destruction.
220			*
221			* @return void
222			*/
223			public function __destruct()
224			{
225			if (! $this->registered) {
226			$this->register();
227			}
228			}
229			}
230

chinleung / laravel-multilingual-routes

Push — master ( 07efb3...874ff6 )

MultilingualRoutePendingRegistration::data() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like