Manager::read() - Code Metrics - Inspection of "Refactored first()" - samsonframework/orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 160359...d1ec24 )

by Vitaly

created 2015-11-30 17:13 UTC

Manager::read() A

↳ Parent: Manager

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * Created by PhpStorm.
 * User: VITALYIEGOROV
 * Date: 30.11.15
 * Time: 16:38
 */
namespace samsonframework\orm;

/**
 * Database entity manager.
 * @package samsonframework\orm
 */
class Manager extends Database implements ManagerInterface
{
    /** @var string Entity identifier */
    protected $entityName;

    /** @var string Entity primary field name */
    protected $primaryFieldName;

    /** @var array Collection of entity field names and their types */
    protected $attributes = array();

    /** @var \PDO Database driver */
    protected $driver;

    /**
     * Manager constructor.
     *
     * @param string $entityName Entity name
     * @param array $attributes Key-value collection with field name => type
     * @param \PDO $driver database low-level driver
     */
    public function __construct($entityName, $attributes, $driver)
    {
        $this->entityName = $entityName;
        $this->attributes = $attributes;
        $this->driver = $driver;
    }

    public function execute($sql)

    {
        $result = array();

        if (isset($this->driver)) {
            // Store timestamp
            $tsLast = microtime(true);

            try {
                // Perform database query
                $result = $this->driver->prepare($sql)->execute();
            } catch (\PDOException $e) {
                echo("\n" . $sql . '-' . $e->getMessage());
            }

            // Store queries count
            $this->count++;

            // Count elapsed time
            $this->elapsed += microtime(true) - $tsLast;
        }

        return $result;
    }

    /**
     * Get query for database entity to work with.
     *
     * @return QueryInterface Query for building database request
     */
    public function query()
    {
        return new Query($this->entityName, $this);
    }

    /**
     * Get new entity instance.
     *
     * @return RecordInterface New database manager entity instance
     */
    public function instance()
    {
        return new $this->entityName($this);
    }

    /**
     * Create new database entity record.
     * @param RecordInterface $entity Entity record for creation
     * @return RecordInterface Created database entity record with new primary identifier
     */
    public function create(RecordInterface $entity)
    {
        $fields = $this->getFields($entity);

        $this->execute('INSERT INTO `' . $this->entityName . '` (`'
            . implode('`,`', array_keys($fields)) . '`) VALUES (' . implode(',', $fields) . ')'
        );
    }

    /**
     * Read database entity records from QueryInterface.
     *
     * @param QueryInterface $query For retrieving records
     * @return RecordInterface[] Collection of read database entity records
     */
    public function read(QueryInterface $query)
    {
        // TODO: Implement read() method.
    }

    /**
     * Update database entity record.
     *
     * @param RecordInterface $entity Entity record for updating
     */
    public function update(RecordInterface $entity)
    {
        // Generate entity fields update command
        $fields = array();
        foreach ($this->getFields($entity) as $fieldName => $fieldValue) {
            $fields[] = '`'.$this->entityName.'`.`'.$fieldName.'` = "'.$fieldValue.'"';
        }

        $this->execute('UPDATE `' . $this->entityName . '` SET '
            . implode(',', $fields)
            . ' WHERE `' . $this->entityName . '`.`' . $this->primaryFieldName . '`="'
            . $this->quote($entity->id) . '"');
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
    }

    /**
     * Delete database record from database.
     *
     * @param RecordInterface $entity Entity record for removing
     */
    public function delete(RecordInterface $entity)
    {
        $this->execute('DELETE FROM `' . $this->entityName . '` WHERE '
            . $this->primaryFieldName . ' = "' . $this->quote($entity->id) . '"'
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        );
    }

    /**
     * Convert RecordInterface instance to collection of its field name => value.
     *
     * @param RecordInterface $object Database record instance to convert
     * @return array Collection of key => value with SQL fields statements
     */
    protected function &getFields(RecordInterface &$object = null)
    {
        $collection = array();
        foreach ($this->attributes as $attribute => $type) {
            if ($type == 'timestamp') {
                continue;
            } elseif ($this->primaryFieldName == $attribute) {
                continue;
            }

            $collection[$attribute] = $this->quote($object->$attribute);
        }

        return $collection;
    }

    /**
     * Quote variable for security reasons.
     *
     * @param string $value
     * @return string Quoted value
     */
    protected function quote($value)
    {
        return $this->driver->quote($value);
    }
}


1		<?php
2		/**
3		* Created by PhpStorm.
4		* User: VITALYIEGOROV
5		* Date: 30.11.15
6		* Time: 16:38
7		*/
8		namespace samsonframework\orm;
9
10		/**
11		* Database entity manager.
12		* @package samsonframework\orm
13		*/
14		class Manager extends Database implements ManagerInterface
15		{
16		/** @var string Entity identifier */
17		protected $entityName;
18
19		/** @var string Entity primary field name */
20		protected $primaryFieldName;
21
22		/** @var array Collection of entity field names and their types */
23		protected $attributes = array();
24
25		/** @var \PDO Database driver */
26		protected $driver;
27
28		/**
29		* Manager constructor.
30		*
31		* @param string $entityName Entity name
32		* @param array $attributes Key-value collection with field name => type
33		* @param \PDO $driver database low-level driver
34		*/
35		public function __construct($entityName, $attributes, $driver)
36		{
37		$this->entityName = $entityName;
38		$this->attributes = $attributes;
39		$this->driver = $driver;
40		}
41
42	View Code Duplication	public function execute($sql)
		0 ignored issues – show Duplication introduced 2015-11-30 17:16 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...
43		{
44		$result = array();
45
46		if (isset($this->driver)) {
47		// Store timestamp
48		$tsLast = microtime(true);
49
50		try {
51		// Perform database query
52		$result = $this->driver->prepare($sql)->execute();
53		} catch (\PDOException $e) {
54		echo("\n" . $sql . '-' . $e->getMessage());
55		}
56
57		// Store queries count
58		$this->count++;
59
60		// Count elapsed time
61		$this->elapsed += microtime(true) - $tsLast;
62		}
63
64		return $result;
65		}
66
67		/**
68		* Get query for database entity to work with.
69		*
70		* @return QueryInterface Query for building database request
71		*/
72		public function query()
73		{
74		return new Query($this->entityName, $this);
75		}
76
77		/**
78		* Get new entity instance.
79		*
80		* @return RecordInterface New database manager entity instance
81		*/
82		public function instance()
83		{
84		return new $this->entityName($this);
85		}
86
87		/**
88		* Create new database entity record.
89		* @param RecordInterface $entity Entity record for creation
90		* @return RecordInterface Created database entity record with new primary identifier
91		*/
92		public function create(RecordInterface $entity)
93		{
94		$fields = $this->getFields($entity);
95
96		$this->execute('INSERT INTO `' . $this->entityName . '` (`'
97		. implode('`,`', array_keys($fields)) . '`) VALUES (' . implode(',', $fields) . ')'
98		);
99		}
100
101		/**
102		* Read database entity records from QueryInterface.
103		*
104		* @param QueryInterface $query For retrieving records
105		* @return RecordInterface[] Collection of read database entity records
106		*/
107		public function read(QueryInterface $query)
108		{
109		// TODO: Implement read() method.
110		}
111
112		/**
113		* Update database entity record.
114		*
115		* @param RecordInterface $entity Entity record for updating
116		*/
117		public function update(RecordInterface $entity)
118		{
119		// Generate entity fields update command
120		$fields = array();
121		foreach ($this->getFields($entity) as $fieldName => $fieldValue) {
122		$fields[] = '`'.$this->entityName.'`.`'.$fieldName.'` = "'.$fieldValue.'"';
123		}
124
125		$this->execute('UPDATE `' . $this->entityName . '` SET '
126		. implode(',', $fields)
127		. ' WHERE `' . $this->entityName . '`.`' . $this->primaryFieldName . '`="'
128		. $this->quote($entity->id) . '"');
		0 ignored issues – show Bug introduced 2015-11-30 17:16 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `samsonframework\orm\RecordInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
129		}
130
131		/**
132		* Delete database record from database.
133		*
134		* @param RecordInterface $entity Entity record for removing
135		*/
136		public function delete(RecordInterface $entity)
137		{
138		$this->execute('DELETE FROM `' . $this->entityName . '` WHERE '
139		. $this->primaryFieldName . ' = "' . $this->quote($entity->id) . '"'
		0 ignored issues – show Bug introduced 2015-11-30 17:16 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `samsonframework\orm\RecordInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
140		);
141		}
142
143		/**
144		* Convert RecordInterface instance to collection of its field name => value.
145		*
146		* @param RecordInterface $object Database record instance to convert
147		* @return array Collection of key => value with SQL fields statements
148		*/
149		protected function &getFields(RecordInterface &$object = null)
150		{
151		$collection = array();
152		foreach ($this->attributes as $attribute => $type) {
153		if ($type == 'timestamp') {
154		continue;
155		} elseif ($this->primaryFieldName == $attribute) {
156		continue;
157		}
158
159		$collection[$attribute] = $this->quote($object->$attribute);
160		}
161
162		return $collection;
163		}
164
165		/**
166		* Quote variable for security reasons.
167		*
168		* @param string $value
169		* @return string Quoted value
170		*/
171		protected function quote($value)
172		{
173		return $this->driver->quote($value);
174		}
175		}
176

samsonframework / orm

Push — master ( 160359...d1ec24 )

Manager::read() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like