Block::__toString() - Code Metrics - Inspection of "Merge branch 'release2.12.1'" - RicLeP/laravel-storyblok - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 664f9d...666c7a )

by Richard

created 2022-05-16 08:27 UTC

Block::__toString() A

↳ Parent: Block

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php


namespace Riclep\Storyblok;

use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use Illuminate\View\View;
use Riclep\Storyblok\Exceptions\UnableToRenderException;
use Riclep\Storyblok\Fields\Asset;
use Riclep\Storyblok\Fields\Image;
use Riclep\Storyblok\Fields\MultiAsset;
use Riclep\Storyblok\Fields\RichText;
use Riclep\Storyblok\Fields\Table;
use Riclep\Storyblok\Traits\CssClasses;
use Riclep\Storyblok\Traits\HasChildClasses;
use Riclep\Storyblok\Traits\HasMeta;
use Storyblok\ApiException;

class Block implements \IteratorAggregate, \JsonSerializable
{
	use CssClasses;
	use HasChildClasses;
	use HasMeta;

	/**
	 * @var bool resolve UUID relations automatically
	 */
	public $_autoResolveRelations = false;

	/**
	 * @var array list of field names containing relations to resolve
	 */
	public $_resolveRelations = [];

	/**
	 * @var bool Remove unresolved relations such as those that 404
	 */
	public $_filterRelations = true;

	/**
	 * @var array the path of nested components
	 */
	public $_componentPath = [];

	/**
	 * @var array the path of nested components
	 */
	protected $_casts = [];

	/**
	 * @var Collection all the fields for the Block
	 */
	private $_fields;

	/**
	 * @var Page|Block reference to the parent Block or Page
	 */
	private $_parent;

	/**
	 * Takes the Block’s content and a reference to the parent
	 * @param $content
	 * @param $parent
	 */
	public function __construct($content, $parent = null)
	{
		$this->_parent = $parent;
		$this->preprocess($content);

		if ($parent) {
			$this->_componentPath = array_merge($parent->_componentPath, [Str::lower($this->meta()['component'])]);
		}

		$this->processFields();

		// run automatic traits - methods matching initTraitClassName()
		foreach (class_uses_recursive($this) as $trait) {
			if (method_exists($this, $method = 'init' . class_basename($trait))) {
				$this->{$method}();
			}
		}
	}

	/**
	 * Returns the containing every field of content
	 *
	 * @return Collection
	 */
	public function content() {
		return $this->_fields;
	}

	/**
	 * Checks if the fields contain the specified key
	 *
	 * @param $key
	 * @return bool
	 */
	public function has($key) {
		return $this->_fields->has($key);
	}

	/**
	 * Returns the parent Block
	 *
	 * @return Block
	 */
	public function parent() {
		return $this->_parent;
	}

	/**
	 * Returns the page this Block belongs to
	 *
	 * @return Block
	 */
	public function page() {
		if ($this->parent() instanceof Page) {

			return $this->parent();
		}

		return $this->parent()->page();
	}

	/**
	 * Returns the first matching view, passing it the Block and optional data
	 *
	 * @param array $with
	 * @return View
	 * @throws UnableToRenderException
	 */
	public function render($with = []) {
		try {
			return view()->first($this->views(), array_merge(['block' => $this], $with));
		} catch (\Exception $exception) {
			throw new UnableToRenderException('None of the views in the given array exist.', $this);
		}
	}

	/**
	 * Pass an array of views rendering the first match, passing it the Block and optional data
	 *
	 * @param array|string $views
	 * @param array $with
	 * @return View
	 * @throws UnableToRenderException
	 */
	public function renderUsing($views, $with = []) {
		try {
			return view()->first(Arr::wrap($views), array_merge(['block' => $this], $with));
		} catch (\Exception $exception) {
			throw new UnableToRenderException('None of the views in the given array exist.', $this);
		}
	}

	/**
	 * Returns an array of possible views for the current Block based on
	 * it’s $componentPath match the component prefixed by each of it’s
	 * ancestors in turn, starting with the closest, for example:
	 *
	 * $componentPath = ['page', 'parent', 'child', 'this_block'];
	 *
	 * Becomes a list of possible views like so:
	 * ['child.this_block', 'parent.this_block', 'page.this_block'];
	 *
	 * Override this method with your custom implementation for
	 * ultimate control
	 *
	 * @return array
	 */
	public function views() {
		$compontentPath = $this->_componentPath;
		array_pop($compontentPath);

		$views = array_map(function($path) {
			return config('storyblok.view_path') . 'blocks.' . $path . '.' . $this->component();
		}, $compontentPath);

		$views = array_reverse($views);

		$views[] = config('storyblok.view_path') . 'blocks.' . $this->component();

		return $views;
	}

	/**
	 * Returns a component X generations previous
	 *
	 * @param $generation int
	 * @return mixed
	 */
	public function ancestorComponentName($generation)
	{
		return $this->_componentPath[count($this->_componentPath) - ($generation + 1)];
	}

	/**
	 * Checks if the current component is a child of another
	 *
	 * @param $parent string
	 * @return bool
	 */
	public function isChildOf($parent)
	{
		return $this->_componentPath[count($this->_componentPath) - 2] === $parent;
	}

	/**
	 * Checks if the component is an ancestor of another
	 *
	 * @param $parent string
	 * @return bool
	 */
	public function isAncestorOf($parent)
	{
		return in_array($parent, $this->parent()->_componentPath);
	}

	/**
	 * Returns the current Block’s component name from Storyblok
	 *
	 * @return string
	 */
	public function component() {
		return $this->_meta['component'];
	}


	/**
	 * Returns the HTML comment required for making this Block clickable in
	 * Storyblok’s visual editor. Don’t forget to set comments to true in
	 * your Vue.js app configuration.
	 *
	 * @return string
	 */
	public function editorLink() {
		if (array_key_exists('_editable', $this->_meta) && config('storyblok.edit_mode')) {
			return $this->_meta['_editable'];
		}

		return '';
	}


	/**
	 * Magic accessor to pull content from the _fields collection. Works just like
	 * Laravel’s model accessors. Matches public methods with the follow naming
	 * convention getSomeFieldAttribute() - called via $block->some_field
	 *
	 * @param $key
	 * @return null|string
	 */
	public function __get($key) {
		$accessor = 'get' . Str::studly($key) . 'Attribute';

		if (method_exists($this, $accessor)) {
			return $this->$accessor();
		}

		if ($this->has($key)) {
			return $this->_fields[$key];
		}

		return null;
	}

	/**
	 * Casts the Block as a string - json serializes the $_fields Collection
	 *
	 * @return string
	 */
	public function __toString() {
		return (string) $this->jsonSerialize();
	}

	/**
	 * Loops over every field to get the ball rolling
	 */
	private function processFields() {
		$this->_fields->transform(function ($field, $key) {
			return $this->getFieldType($field, $key);
		});
	}

	/**
	 * Converts fields into Field Classes based on various properties of their content
	 *
	 * @param $field
	 * @param $key
	 * @return array|Collection|mixed|Asset|Image|MultiAsset|RichText|Table
	 * @throws \Storyblok\ApiException
	 */
	private function getFieldType($field, $key) {
		return (new FieldFactory())->build($this, $field, $key);
	}

	/**
	 * Storyblok returns fields and other meta content at the same level so
	 * let’s do a little tidying up first
	 *
	 * @param $content
	 */
	private function preprocess($content) {
		$this->_fields = collect(array_diff_key($content, array_flip(['_editable', '_uid', 'component'])));

		// remove non-content keys
		$this->_meta = array_intersect_key($content, array_flip(['_editable', '_uid', 'component']));
	}

	/**
	 * Casting Block to JSON
	 *
	 * @return Collection|mixed
	 */
	public function jsonSerialize(): mixed
	{
		return $this->content();
	}

	/**
	 * Let’s up loop over the fields in Blade without needing to
	 * delve deep into the content collection
	 *
	 * @return \Traversable
	 */
	public function getIterator(): \Traversable {
		return $this->_fields;
	}

	public function getRelation(RequestStory $request, $relation) {
		try {
			$response = $request->get($relation);

			$class = $this->getChildClassName('Block', $response['content']['component']);
			$relationClass = new $class($response['content'], $this);

			$relationClass->addMeta([
				'name' => $response['name'],
				'published_at' => $response['published_at'],
				'full_slug' => $response['full_slug'],
			]);

			return $relationClass;
		} catch (ApiException $e) {
			return null;
		}
	}

	public function getCasts() {
		return $this->_casts;
	}
}


1			<?php
2
3
4			namespace Riclep\Storyblok;
5
6			use Illuminate\Support\Arr;
7			use Illuminate\Support\Collection;
8			use Illuminate\Support\Str;
9			use Illuminate\View\View;
10			use Riclep\Storyblok\Exceptions\UnableToRenderException;
11			use Riclep\Storyblok\Fields\Asset;
12			use Riclep\Storyblok\Fields\Image;
13			use Riclep\Storyblok\Fields\MultiAsset;
14			use Riclep\Storyblok\Fields\RichText;
15			use Riclep\Storyblok\Fields\Table;
16			use Riclep\Storyblok\Traits\CssClasses;
17			use Riclep\Storyblok\Traits\HasChildClasses;
18			use Riclep\Storyblok\Traits\HasMeta;
19			use Storyblok\ApiException;
20
21			class Block implements \IteratorAggregate, \JsonSerializable
22			{
23			use CssClasses;
24			use HasChildClasses;
25			use HasMeta;
26
27			/**
28			* @var bool resolve UUID relations automatically
29			*/
30			public $_autoResolveRelations = false;
31
32			/**
33			* @var array list of field names containing relations to resolve
34			*/
35			public $_resolveRelations = [];
36
37			/**
38			* @var bool Remove unresolved relations such as those that 404
39			*/
40			public $_filterRelations = true;
41
42			/**
43			* @var array the path of nested components
44			*/
45			public $_componentPath = [];
46
47			/**
48			* @var array the path of nested components
49			*/
50			protected $_casts = [];
51
52			/**
53			* @var Collection all the fields for the Block
54			*/
55			private $_fields;
56
57			/**
58			* @var Page\|Block reference to the parent Block or Page
59			*/
60			private $_parent;
61
62			/**
63			* Takes the Block’s content and a reference to the parent
64			* @param $content
65			* @param $parent
66			*/
67			public function __construct($content, $parent = null)
68			{
69			$this->_parent = $parent;
70			$this->preprocess($content);
71
72			if ($parent) {
73			$this->_componentPath = array_merge($parent->_componentPath, [Str::lower($this->meta()['component'])]);
74			}
75
76			$this->processFields();
77
78			// run automatic traits - methods matching initTraitClassName()
79			foreach (class_uses_recursive($this) as $trait) {
80			if (method_exists($this, $method = 'init' . class_basename($trait))) {
81			$this->{$method}();
82			}
83			}
84			}
85
86			/**
87			* Returns the containing every field of content
88			*
89			* @return Collection
90			*/
91			public function content() {
92			return $this->_fields;
93			}
94
95			/**
96			* Checks if the fields contain the specified key
97			*
98			* @param $key
99			* @return bool
100			*/
101			public function has($key) {
102			return $this->_fields->has($key);
103			}
104
105			/**
106			* Returns the parent Block
107			*
108			* @return Block
109			*/
110			public function parent() {
111			return $this->_parent;
112			}
113
114			/**
115			* Returns the page this Block belongs to
116			*
117			* @return Block
118			*/
119			public function page() {
120			if ($this->parent() instanceof Page) {
			0 ignored issues – show introduced 2020-07-28 13:29 UTC by Report Bug Copy Issue Report `$this->parent()` is never a sub-type of `Riclep\Storyblok\Page`. Loading history...
121			return $this->parent();
122			}
123
124			return $this->parent()->page();
125			}
126
127			/**
128			* Returns the first matching view, passing it the Block and optional data
129			*
130			* @param array $with
131			* @return View
132			* @throws UnableToRenderException
133			*/
134			public function render($with = []) {
135			try {
136			return view()->first($this->views(), array_merge(['block' => $this], $with));
137			} catch (\Exception $exception) {
138			throw new UnableToRenderException('None of the views in the given array exist.', $this);
139			}
140			}
141
142			/**
143			* Pass an array of views rendering the first match, passing it the Block and optional data
144			*
145			* @param array\|string $views
146			* @param array $with
147			* @return View
148			* @throws UnableToRenderException
149			*/
150			public function renderUsing($views, $with = []) {
151			try {
152			return view()->first(Arr::wrap($views), array_merge(['block' => $this], $with));
153			} catch (\Exception $exception) {
154			throw new UnableToRenderException('None of the views in the given array exist.', $this);
155			}
156			}
157
158			/**
159			* Returns an array of possible views for the current Block based on
160			* it’s $componentPath match the component prefixed by each of it’s
161			* ancestors in turn, starting with the closest, for example:
162			*
163			* $componentPath = ['page', 'parent', 'child', 'this_block'];
164			*
165			* Becomes a list of possible views like so:
166			* ['child.this_block', 'parent.this_block', 'page.this_block'];
167			*
168			* Override this method with your custom implementation for
169			* ultimate control
170			*
171			* @return array
172			*/
173			public function views() {
174			$compontentPath = $this->_componentPath;
175			array_pop($compontentPath);
176
177			$views = array_map(function($path) {
178			return config('storyblok.view_path') . 'blocks.' . $path . '.' . $this->component();
179			}, $compontentPath);
180
181			$views = array_reverse($views);
182
183			$views[] = config('storyblok.view_path') . 'blocks.' . $this->component();
184
185			return $views;
186			}
187
188			/**
189			* Returns a component X generations previous
190			*
191			* @param $generation int
192			* @return mixed
193			*/
194			public function ancestorComponentName($generation)
195			{
196			return $this->_componentPath[count($this->_componentPath) - ($generation + 1)];
197			}
198
199			/**
200			* Checks if the current component is a child of another
201			*
202			* @param $parent string
203			* @return bool
204			*/
205			public function isChildOf($parent)
206			{
207			return $this->_componentPath[count($this->_componentPath) - 2] === $parent;
208			}
209
210			/**
211			* Checks if the component is an ancestor of another
212			*
213			* @param $parent string
214			* @return bool
215			*/
216			public function isAncestorOf($parent)
217			{
218			return in_array($parent, $this->parent()->_componentPath);
219			}
220
221			/**
222			* Returns the current Block’s component name from Storyblok
223			*
224			* @return string
225			*/
226			public function component() {
227			return $this->_meta['component'];
228			}
229
230
231			/**
232			* Returns the HTML comment required for making this Block clickable in
233			* Storyblok’s visual editor. Don’t forget to set comments to true in
234			* your Vue.js app configuration.
235			*
236			* @return string
237			*/
238			public function editorLink() {
239			if (array_key_exists('_editable', $this->_meta) && config('storyblok.edit_mode')) {
240			return $this->_meta['_editable'];
241			}
242
243			return '';
244			}
245
246
247			/**
248			* Magic accessor to pull content from the _fields collection. Works just like
249			* Laravel’s model accessors. Matches public methods with the follow naming
250			* convention getSomeFieldAttribute() - called via $block->some_field
251			*
252			* @param $key
253			* @return null\|string
254			*/
255			public function __get($key) {
256			$accessor = 'get' . Str::studly($key) . 'Attribute';
257
258			if (method_exists($this, $accessor)) {
259			return $this->$accessor();
260			}
261
262			if ($this->has($key)) {
263			return $this->_fields[$key];
264			}
265
266			return null;
267			}
268
269			/**
270			* Casts the Block as a string - json serializes the $_fields Collection
271			*
272			* @return string
273			*/
274			public function __toString() {
275			return (string) $this->jsonSerialize();
276			}
277
278			/**
279			* Loops over every field to get the ball rolling
280			*/
281			private function processFields() {
282			$this->_fields->transform(function ($field, $key) {
283			return $this->getFieldType($field, $key);
284			});
285			}
286
287			/**
288			* Converts fields into Field Classes based on various properties of their content
289			*
290			* @param $field
291			* @param $key
292			* @return array\|Collection\|mixed\|Asset\|Image\|MultiAsset\|RichText\|Table
293			* @throws \Storyblok\ApiException
294			*/
295			private function getFieldType($field, $key) {
296			return (new FieldFactory())->build($this, $field, $key);
297			}
298
299			/**
300			* Storyblok returns fields and other meta content at the same level so
301			* let’s do a little tidying up first
302			*
303			* @param $content
304			*/
305			private function preprocess($content) {
306			$this->_fields = collect(array_diff_key($content, array_flip(['_editable', '_uid', 'component'])));
307
308			// remove non-content keys
309			$this->_meta = array_intersect_key($content, array_flip(['_editable', '_uid', 'component']));
310			}
311
312			/**
313			* Casting Block to JSON
314			*
315			* @return Collection\|mixed
316			*/
317			public function jsonSerialize(): mixed
318			{
319			return $this->content();
320			}
321
322			/**
323			* Let’s up loop over the fields in Blade without needing to
324			* delve deep into the content collection
325			*
326			* @return \Traversable
327			*/
328			public function getIterator(): \Traversable {
329			return $this->_fields;
330			}
331
332			public function getRelation(RequestStory $request, $relation) {
333			try {
334			$response = $request->get($relation);
335
336			$class = $this->getChildClassName('Block', $response['content']['component']);
337			$relationClass = new $class($response['content'], $this);
338
339			$relationClass->addMeta([
340			'name' => $response['name'],
341			'published_at' => $response['published_at'],
342			'full_slug' => $response['full_slug'],
343			]);
344
345			return $relationClass;
346			} catch (ApiException $e) {
347			return null;
348			}
349			}
350
351			public function getCasts() {
352			return $this->_casts;
353			}
354			}
355

RicLeP / laravel-storyblok

Push — master ( 664f9d...666c7a )

Block::__toString() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like