FieldFactory::getInstance() - Code Metrics - Inspection of "new FieldFactory::getInstance method, to create fi..." - oscarotero/simple-crud - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 92b405...edee30 )

by Oscar

created 2016-08-27 10:51 UTC

FieldFactory::getInstance() A

↳ Parent: FieldFactory

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	12
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	12
loc	12
rs	9.4285
cc	3
eloc	6
nc	3
nop	3

<?php

namespace SimpleCrud;

/**
 * Class to create instances of fields.
 */
class FieldFactory implements FieldFactoryInterface
{
    protected $namespaces = ['SimpleCrud\\Fields\\'];
    protected $defaultType = 'Field';

    protected $nameMap = [
        'id' => 'Integer',
        'active' => 'Boolean',
        'pubdate' => 'Datetime',
        'file' => 'File',
    ];

    protected $regexMap = [
        //relation fields (post_id)
        '/_id$/' => 'Integer',

        //flags (isActive, inHome)

        '/^(is|has)[A-Z]/' => 'Boolean',

        //time related (createdAt, publishedAt)
        '/[a-z]At$/' => 'Datetime',

        //time related (createdAt, publishedAt)
        '/[a-z]File$/' => 'File',
    ];

    protected $typeMap = [
        'bigint' => 'Integer',
        'boolean' => 'Boolean',
        'date' => 'Date',
        'datetime' => 'Datetime',
        'float' => 'Decimal',
        'mediumint' => 'Integer',
        'set' => 'Set',
        'smallint' => 'Integer',
        'tinyint' => 'Integer',
        'year' => 'Integer',
    ];

    /**
     * Set the namespace for the fields classes.
     *
     * @param string $namespace
     *
     * @return self
     */
    public function addNamespace($namespace)
    {
        array_unshift($this->namespaces, $namespace);

        return $this;
    }

    /**
     * Map names with field types.
     *
     * @param array $map
     *
     * @return self
     */
    public function mapNames(array $map)
    {
        $this->nameMap = $map + $this->nameMap;

        return $this;
    }

    /**
     * Map names with field types using regexp.
     *
     * @param array $map
     *
     * @return self
     */
    public function mapRegex(array $map)
    {
        $this->regexMap = $map + $this->regexMap;

        return $this;
    }

    /**
     * Map db field types with classes.
     *
     * @param array $map
     *
     * @return self
     */
    public function mapTypes(array $map)
    {
        $this->mapTypes = $map + $this->mapTypes;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    /**
     * @see FieldFactoryInterface
     *
     * {@inheritdoc}
     */
    public function get(Table $table, $name)
    {
        $scheme = $table->getScheme()['fields'];

        if (!isset($scheme[$name])) {
            throw new SimpleCrudException("The field '{$name}' does not exist in the table {$table->name}");
        }


        $className = $this->getClassName($name, $scheme[$name]['type']) ?: $this->defaultType;

        return $this->getInstance($table, $className, $name);
    }

    /**
     * @see FieldFactoryInterface
     *
     * {@inheritdoc}
     */
    public function getInstance(Table $table, $className, $name)

    {
        foreach ($this->namespaces as $namespace) {
            $class = $namespace.$className;

            if (class_exists($class)) {
                return new $class($table, $name);
            }
        }

        throw new SimpleCrudException("No field class found for '{$className}'");
    }

    /**
     * Get the field class name.
     *
     * @param string $name
     * @param string $type
     *
     * @return string|null
     */
    protected function getClassName($name, $type)
    {
        if (isset($this->nameMap[$name])) {
            return $this->nameMap[$name];
        }

        foreach ($this->regexMap as $regex => $class) {
            if (preg_match($regex, $name)) {
                return $class;
            }
        }

        if (isset($this->typeMap[$type])) {
            return $this->typeMap[$type];
        }
    }
}


1		<?php
2
3		namespace SimpleCrud;
4
5		/**
6		* Class to create instances of fields.
7		*/
8		class FieldFactory implements FieldFactoryInterface
9		{
10		protected $namespaces = ['SimpleCrud\\Fields\\'];
11		protected $defaultType = 'Field';
12
13		protected $nameMap = [
14		'id' => 'Integer',
15		'active' => 'Boolean',
16		'pubdate' => 'Datetime',
17		'file' => 'File',
18		];
19
20		protected $regexMap = [
21		//relation fields (post_id)
22		'/_id$/' => 'Integer',
23
24		//flags (isActive, inHome)
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-17 00:40 UTC by Report Bug Copy Issue Report `38%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
25		'/^(is\|has)[A-Z]/' => 'Boolean',
26
27		//time related (createdAt, publishedAt)
28		'/[a-z]At$/' => 'Datetime',
29
30		//time related (createdAt, publishedAt)
31		'/[a-z]File$/' => 'File',
32		];
33
34		protected $typeMap = [
35		'bigint' => 'Integer',
36		'boolean' => 'Boolean',
37		'date' => 'Date',
38		'datetime' => 'Datetime',
39		'float' => 'Decimal',
40		'mediumint' => 'Integer',
41		'set' => 'Set',
42		'smallint' => 'Integer',
43		'tinyint' => 'Integer',
44		'year' => 'Integer',
45		];
46
47		/**
48		* Set the namespace for the fields classes.
49		*
50		* @param string $namespace
51		*
52		* @return self
53		*/
54		public function addNamespace($namespace)
55		{
56		array_unshift($this->namespaces, $namespace);
57
58		return $this;
59		}
60
61		/**
62		* Map names with field types.
63		*
64		* @param array $map
65		*
66		* @return self
67		*/
68		public function mapNames(array $map)
69		{
70		$this->nameMap = $map + $this->nameMap;
71
72		return $this;
73		}
74
75		/**
76		* Map names with field types using regexp.
77		*
78		* @param array $map
79		*
80		* @return self
81		*/
82		public function mapRegex(array $map)
83		{
84		$this->regexMap = $map + $this->regexMap;
85
86		return $this;
87		}
88
89		/**
90		* Map db field types with classes.
91		*
92		* @param array $map
93		*
94		* @return self
95		*/
96		public function mapTypes(array $map)
97		{
98		$this->mapTypes = $map + $this->mapTypes;
		0 ignored issues – show Bug introduced 2016-02-17 00:40 UTC by Report Bug Copy Issue Report The property `mapTypes` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
99
100		return $this;
101		}
102
103		/**
104		* @see FieldFactoryInterface
105		*
106		* {@inheritdoc}
107		*/
108		public function get(Table $table, $name)
109		{
110		$scheme = $table->getScheme()['fields'];
111
112		if (!isset($scheme[$name])) {
113		throw new SimpleCrudException("The field '{$name}' does not exist in the table {$table->name}");
114		}
115
116
117		$className = $this->getClassName($name, $scheme[$name]['type']) ?: $this->defaultType;
118
119		return $this->getInstance($table, $className, $name);
120		}
121
122		/**
123		* @see FieldFactoryInterface
124		*
125		* {@inheritdoc}
126		*/
127	View Code Duplication	public function getInstance(Table $table, $className, $name)
		0 ignored issues – show Duplication introduced 2016-08-27 10:54 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
128		{
129		foreach ($this->namespaces as $namespace) {
130		$class = $namespace.$className;
131
132		if (class_exists($class)) {
133		return new $class($table, $name);
134		}
135		}
136
137		throw new SimpleCrudException("No field class found for '{$className}'");
138		}
139
140		/**
141		* Get the field class name.
142		*
143		* @param string $name
144		* @param string $type
145		*
146		* @return string\|null
147		*/
148		protected function getClassName($name, $type)
149		{
150		if (isset($this->nameMap[$name])) {
151		return $this->nameMap[$name];
152		}
153
154		foreach ($this->regexMap as $regex => $class) {
155		if (preg_match($regex, $name)) {
156		return $class;
157		}
158		}
159
160		if (isset($this->typeMap[$type])) {
161		return $this->typeMap[$type];
162		}
163		}
164		}
165

oscarotero / simple-crud

Push — master ( 92b405...edee30 )

FieldFactory::getInstance() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like