AbstractTransformer::defineIncludes() - Code Metrics - Inspection of "move normalizing transform includes to transformer" - flipbox/transform - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 8de61d...0af939 )

by Nate

created 2018-06-12 01:16 UTC

AbstractTransformer::defineIncludes() A

↳ Parent: AbstractTransformer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

/**
 * @author    Flipbox Factory
 * @copyright Copyright (c) 2017, Flipbox Digital
 * @link      https://github.com/flipbox/transform/releases/latest
 * @license   https://github.com/flipbox/transform/blob/master/LICENSE
 */

namespace Flipbox\Transform\Transformers;

use Flipbox\Transform\Helpers\ObjectHelper;
use Flipbox\Transform\Helpers\TransformerHelper;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
abstract class AbstractTransformer implements TransformerInterface
{
    /**
     * The normalized includes
     *
     * @var null|array
     */
    private $includes;

    /**
     * @param array $config
     */
    public function __construct(array $config = [])
    {
        ObjectHelper::configure($this, $config);
    }

    /**
     * @return array
     */
    protected function defineIncludes(): array
    {
        return [];
    }

    /**
     * Returns an array of normalized includes.  It is recommend
     * @return array
     */
    public function getIncludes(): array
    {
        if ($this->includes === null) {
            $this->includes = TransformerHelper::normalizeIncludes(
                $this->defineIncludes()
            );
        }

        return $this->includes;
    }

    /**
     * @param mixed $data
     * @param TransformerInterface|callable $transformer
     * @return Item
     */
    protected function item($data, $transformer): Item
    {
        return new Item(['data' => $data, 'transformer' => $transformer]);
    }

    /**
     * @param mixed $data
     * @param TransformerInterface|callable $transformer
     * @return Collection
     */
    protected function collection($data, $transformer): Collection
    {
        return new Collection(['data' => $data, 'transformer' => $transformer]);
    }
}


1			<?php
2
3			/**
4			* @author Flipbox Factory
5			* @copyright Copyright (c) 2017, Flipbox Digital
6			* @link https://github.com/flipbox/transform/releases/latest
7			* @license https://github.com/flipbox/transform/blob/master/LICENSE
8			*/
9
10			namespace Flipbox\Transform\Transformers;
11
12			use Flipbox\Transform\Helpers\ObjectHelper;
13			use Flipbox\Transform\Helpers\TransformerHelper;
14
15			/**
16			* @author Flipbox Factory <[email protected]>
17			* @since 1.0.0
18			*/
19			abstract class AbstractTransformer implements TransformerInterface
20			{
21			/**
22			* The normalized includes
23			*
24			* @var null\|array
25			*/
26			private $includes;
27
28			/**
29			* @param array $config
30			*/
31			public function __construct(array $config = [])
32			{
33			ObjectHelper::configure($this, $config);
34			}
35
36			/**
37			* @return array
38			*/
39			protected function defineIncludes(): array
40			{
41			return [];
42			}
43
44			/**
45			* Returns an array of normalized includes. It is recommend
46			* @return array
47			*/
48			public function getIncludes(): array
49			{
50			if ($this->includes === null) {
51			$this->includes = TransformerHelper::normalizeIncludes(
52			$this->defineIncludes()
53			);
54			}
55
56			return $this->includes;
57			}
58
59			/**
60			* @param mixed $data
61			* @param TransformerInterface\|callable $transformer
62			* @return Item
63			*/
64			protected function item($data, $transformer): Item
65			{
66			return new Item(['data' => $data, 'transformer' => $transformer]);
67			}
68
69			/**
70			* @param mixed $data
71			* @param TransformerInterface\|callable $transformer
72			* @return Collection
73			*/
74			protected function collection($data, $transformer): Collection
75			{
76			return new Collection(['data' => $data, 'transformer' => $transformer]);
77			}
78			}
79

flipbox / transform

Push — develop ( 8de61d...0af939 )

AbstractTransformer::defineIncludes() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like