Mapper::addFieldMap() - Code Metrics - Inspection of "2.1.0" - byjg/micro-orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

by Joao

created 2017-12-04 23:46 UTC

Mapper::addFieldMap() A

↳ Parent: Mapper

Complexity

Conditions	3
Paths	4

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	3

Importance

Changes

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

<?php
/**
 * Created by PhpStorm.
 * User: jg
 * Date: 21/06/16
 * Time: 13:55
 */

namespace ByJG\MicroOrm;

class Mapper
{

    const FIELDMAP_FIELD = 'fieldname';
    const FIELDMAP_UPDATEMASK = 'updatemask';
    const FIELDMAP_SELECTMASK = 'selectmask';

    private $entity;
    private $table;
    private $primaryKey;
    private $keygenFunction = null;
    private $fieldMap = [];
    private $fieldAlias = [];
    private $preserveCasename = false;

    /**
     * Mapper constructor.
     *
     * @param string $entity
     * @param string $table
     * @param string $primaryKey
     * @param \Closure $keygenFunction
     * @param bool $preserveCasename
     * @throws \Exception
     */
    public function __construct(
        $entity,
        $table,
        $primaryKey,
        \Closure $keygenFunction = null,
        $preserveCasename = false
    ) {
        if (!class_exists($entity)) {
            throw new \Exception("Entity '$entity' does not exists");
        }
        $this->entity = $entity;
        $this->table = $table;
        $this->preserveCasename = $preserveCasename;
        $this->primaryKey = $this->prepareField($primaryKey);
        $this->keygenFunction = $keygenFunction;
    }

    public function prepareField($field)
    {
        if (!$this->preserveCasename) {
            if (!is_array($field)) {
                return strtolower($field);
            }

            $result = [];
            foreach ($field as $key => $value) {
                $result[strtolower($key)] = $value;
            }
            return $result;
        }

        return $field;
    }

    /**
     * @param string $property
     * @param string $fieldName
     * @param \Closure|null|bool $updateMask
     * @param \Closure $selectMask
     * @return $this
     */
    public function addFieldMap($property, $fieldName, \Closure $updateMask = null, \Closure $selectMask = null)
    {
        if (empty($selectMask)) {
            $selectMask = Mapper::defaultClosure();
        }

        if (empty($updateMask)) {
            $updateMask = Mapper::defaultClosure();
        }

        $this->fieldMap[$this->prepareField($property)] = [
            self::FIELDMAP_FIELD => $this->prepareField($fieldName),
            self::FIELDMAP_UPDATEMASK => $updateMask,
            self::FIELDMAP_SELECTMASK => $selectMask
        ];

        return $this;
    }

    /**
     * @param $fieldName
     * @param $alias
     */
    public function addFieldAlias($fieldName, $alias)
    {
        $this->fieldAlias[$this->prepareField($fieldName)] = $this->prepareField($alias);
    }

    /**
     * @return string
     */
    public function getEntity()
    {
        $class = $this->entity;
        return new $class();
    }

    /**
     * @return string
     */
    public function getTable()
    {
        return $this->table;
    }

    /**
     * @return string
     */
    public function getPrimaryKey()
    {
        return $this->primaryKey;
    }

    /**
     * @return bool
     */
    public function isPreserveCasename()
    {
        return $this->preserveCasename;
    }

    /**
     * @param string|null $property
     * @param string|null $key
     * @return array
     */
    public function getFieldMap($property = null, $key = null)
    {
        if (empty($property)) {
            return $this->fieldMap;
        }

        $property = $this->prepareField($property);

        if (!isset($this->fieldMap[$property])) {
            return null;
        }

        $fieldMap = $this->fieldMap[$property];

        if (empty($key)) {
            return $fieldMap;
        }

        return $fieldMap[$key];
    }

    public function getFieldAlias($fieldName = null)
    {
        if (empty($fieldName)) {
            return $this->fieldAlias;
        }
        
        if (!isset($this->fieldAlias[$fieldName])) {
            return null;
        }

        return $this->fieldAlias[$fieldName];
    }

    /**
     * @return mixed|null
     */
    public function generateKey()
    {
        if (empty($this->keygenFunction)) {
            return null;
        }

        $func = $this->keygenFunction;

        return $func();
    }

    public static function defaultClosure()
    {
        return function ($value) {
            return $value;
        };
    }

    public static function doNotUpdateClosure()
    {
        return function () {
            return false;
        };
    }
}


1		<?php
2		/**
3		* Created by PhpStorm.
4		* User: jg
5		* Date: 21/06/16
6		* Time: 13:55
7		*/
8
9		namespace ByJG\MicroOrm;
10
11		class Mapper
12		{
13
14		const FIELDMAP_FIELD = 'fieldname';
15		const FIELDMAP_UPDATEMASK = 'updatemask';
16		const FIELDMAP_SELECTMASK = 'selectmask';
17
18		private $entity;
19		private $table;
20		private $primaryKey;
21		private $keygenFunction = null;
22		private $fieldMap = [];
23		private $fieldAlias = [];
24		private $preserveCasename = false;
25
26		/**
27		* Mapper constructor.
28		*
29		* @param string $entity
30		* @param string $table
31		* @param string $primaryKey
32		* @param \Closure $keygenFunction
33		* @param bool $preserveCasename
34		* @throws \Exception
35		*/
36	21	public function __construct(
37		$entity,
38		$table,
39		$primaryKey,
40		\Closure $keygenFunction = null,
41		$preserveCasename = false
42		) {
43	21	if (!class_exists($entity)) {
44		throw new \Exception("Entity '$entity' does not exists");
45		}
46	21	$this->entity = $entity;
47	21	$this->table = $table;
48	21	$this->preserveCasename = $preserveCasename;
49	21	$this->primaryKey = $this->prepareField($primaryKey);
50	21	$this->keygenFunction = $keygenFunction;
51	21	}
52
53	21	public function prepareField($field)
54		{
55	21	if (!$this->preserveCasename) {
56	21	if (!is_array($field)) {
57	21	return strtolower($field);
58		}
59
60	8	$result = [];
61	8	foreach ($field as $key => $value) {
62	8	$result[strtolower($key)] = $value;
63	8	}
64	8	return $result;
65		}
66
67		return $field;
68		}
69
70		/**
71		* @param string $property
72		* @param string $fieldName
73		* @param \Closure\|null\|bool $updateMask
74		* @param \Closure $selectMask
75		* @return $this
76		*/
77	21	public function addFieldMap($property, $fieldName, \Closure $updateMask = null, \Closure $selectMask = null)
78		{
79	21	if (empty($selectMask)) {
80	21	$selectMask = Mapper::defaultClosure();
81	21	}
82
83	21	if (empty($updateMask)) {
84	21	$updateMask = Mapper::defaultClosure();
85	21	}
86
87	21	$this->fieldMap[$this->prepareField($property)] = [
88	21	self::FIELDMAP_FIELD => $this->prepareField($fieldName),
89	21	self::FIELDMAP_UPDATEMASK => $updateMask,
90	21	self::FIELDMAP_SELECTMASK => $selectMask
91	21	];
92
93	21	return $this;
94		}
95
96		/**
97		* @param $fieldName
98		* @param $alias
99		*/
100	4	public function addFieldAlias($fieldName, $alias)
101		{
102	4	$this->fieldAlias[$this->prepareField($fieldName)] = $this->prepareField($alias);
103	4	}
104
105		/**
106		* @return string
107		*/
108	21	public function getEntity()
109		{
110	21	$class = $this->entity;
111	21	return new $class();
112		}
113
114		/**
115		* @return string
116		*/
117	20	public function getTable()
118		{
119	20	return $this->table;
120		}
121
122		/**
123		* @return string
124		*/
125	14	public function getPrimaryKey()
126		{
127	14	return $this->primaryKey;
128		}
129
130		/**
131		* @return bool
132		*/
133		public function isPreserveCasename()
134		{
135		return $this->preserveCasename;
136		}
137
138		/**
139		* @param string\|null $property
140		* @param string\|null $key
141		* @return array
142		*/
143	21	public function getFieldMap($property = null, $key = null)
144		{
145	21	if (empty($property)) {
146	21	return $this->fieldMap;
147		}
148
149	1	$property = $this->prepareField($property);
150
151	1	if (!isset($this->fieldMap[$property])) {
152	1	return null;
153		}
154
155	1	$fieldMap = $this->fieldMap[$property];
156
157	1	if (empty($key)) {
158		return $fieldMap;
159		}
160
161	1	return $fieldMap[$key];
162		}
163
164	21	public function getFieldAlias($fieldName = null)
165		{
166	21	if (empty($fieldName)) {
167	21	return $this->fieldAlias;
168		}
169
170	1	if (!isset($this->fieldAlias[$fieldName])) {
171	1	return null;
172		}
173
174	1	return $this->fieldAlias[$fieldName];
175		}
176
177		/**
178		* @return mixed\|null
179		*/
180	5	public function generateKey()
181		{
182	5	if (empty($this->keygenFunction)) {
183	4	return null;
184		}
185
186	1	$func = $this->keygenFunction;
187
188	1	return $func();
189		}
190
191	21	public static function defaultClosure()
192		{
193		return function ($value) {
194	9	return $value;
195	21	};
196		}
197
198		public static function doNotUpdateClosure()
199		{
200	2	return function () {
201	2	return false;
202	2	};
203		}
204		}
205

byjg / micro-orm

Pull Request — master (#4)

Mapper::addFieldMap() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like