DbRow - Code Metrics - Inspection of "Organize generated Daos and beans" - thecodingmachine/database.tdbm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 4.0 (#55)

by Huberty

created 2016-02-15 12:32 UTC

DbRow B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	401
Duplicated Lines	7.23 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	14
Bugs	1	Features	0

Metric	Value
wmc	39
c	14
b	1
f	0
lcom	1
cbo	7
dl	29
loc	401
rs	8.2857

17 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	29	5
A	_attach()	0	9	2
A	_setStatus()	0	4	1
A	_dbLoadIfNotLoaded()	0	22	3
B	get()	0	40	4
A	set()	21	22	3
A	setRef()	8	9	3
B	getRef()	0	23	4
A	_getDbTableName()	0	4	1
A	_getStatus()	0	4	1
A	__clone()	0	18	3
A	_getDbRow()	0	20	3
A	_getReferences()	0	4	1
A	_getPrimaryKeys()	0	4	1
A	_setPrimaryKeys()	0	7	2
A	getTDBMObject()	0	4	1
A	setTDBMObject()	0	4	1

How to fix Duplicated Code

<?php

namespace Mouf\Database\TDBM;

/*
 Copyright (C) 2006-2016 David Négrier - THE CODING MACHINE

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

/**
 * Instances of this class represent a row in a database.
 *
 * @author David Negrier
 */
class DbRow
{
    /**
     * The service this object is bound to.
     *
     * @var TDBMService
     */
    protected $tdbmService;

    /**
     * The object containing this db row.
     *
     * @var AbstractTDBMObject
     */
    private $object;

    /**
     * The name of the table the object if issued from.
     *
     * @var string
     */
    private $dbTableName;

    /**
     * The array of columns returned from database.
     *
     * @var array
     */
    private $dbRow = array();

    /**
     * @var AbstractTDBMObject[]
     */
    private $references = array();

    /**
     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
     *
     * @var string
     */
    private $status;

    /**
     * The values of the primary key.
     * This is set when the object is in "loaded" state.
     *
     * @var array An array of column => value
     */
    private $primaryKeys;

    /**
     * You should never call the constructor directly. Instead, you should use the
     * TDBMService class that will create TDBMObjects for you.
     *
     * Used with id!=false when we want to retrieve an existing object
     * and id==false if we want a new object
     *
     * @param AbstractTDBMObject $object      The object containing this db row.
     * @param string             $table_name
     * @param array              $primaryKeys
     * @param TDBMService        $tdbmService
     *
     * @throws TDBMException
     * @throws TDBMInvalidOperationException
     */
    public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array())
    {
        $this->object = $object;
        $this->dbTableName = $table_name;

        $this->status = TDBMObjectStateEnum::STATE_DETACHED;

        if ($tdbmService === null) {
            if (!empty($primaryKeys)) {
                throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.');
            }
        } else {
            $this->tdbmService = $tdbmService;

            if (!empty($primaryKeys)) {
                $this->_setPrimaryKeys($primaryKeys);
                if (!empty($dbRow)) {
                    $this->dbRow = $dbRow;
                    $this->status = TDBMObjectStateEnum::STATE_LOADED;
                } else {
                    $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
                }
                $tdbmService->_addToCache($this);
            } else {
                $this->status = TDBMObjectStateEnum::STATE_NEW;
                $this->tdbmService->_addToToSaveObjectList($this);
            }
        }
    }

    public function _attach(TDBMService $tdbmService)
    {
        if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
            throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
        }
        $this->tdbmService = $tdbmService;
        $this->status = TDBMObjectStateEnum::STATE_NEW;
        $this->tdbmService->_addToToSaveObjectList($this);
    }

    /**
     * Sets the state of the TDBM Object
     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
     *
     * @param string $state
     */
    public function _setStatus($state)
    {
        $this->status = $state;
    }

    /**
     * This is an internal method. You should not call this method yourself. The TDBM library will do it for you.
     * If the object is in state 'not loaded', this method performs a query in database to load the object.
     *
     * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified
     * cannot be found).
     */
    public function _dbLoadIfNotLoaded()
    {
        if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) {
            $connection = $this->tdbmService->getConnection();

            /// buildFilterFromFilterBag($filter_bag)

            list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys);

            $sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where;
function findUser(Doctrine\DBAL\Connection $con, $email) {
    // Unsafe
    $con->executeQuery("SELECT * FROM users WHERE email = '".$email."'");

    // Safe
    $con->executeQuery(
        "SELECT * FROM users WHERE email = :email",
        array('email' => $email)
    );
}
            $result = $connection->executeQuery($sql, $parameters);

            if ($result->rowCount() === 0) {
                throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\".");
            }

            $this->dbRow = $result->fetch(\PDO::FETCH_ASSOC);

            $result->closeCursor();

            $this->status = TDBMObjectStateEnum::STATE_LOADED;
        }
    }

    public function get($var)
    {
        $this->_dbLoadIfNotLoaded();

        // Let's first check if the key exist.
        if (!isset($this->dbRow[$var])) {
            /*
            // Unable to find column.... this is an error if the object has been retrieved from database.
            // If it's a new object, well, that may not be an error after all!
            // Let's check if the column does exist in the table
            $column_exist = $this->db_connection->checkColumnExist($this->dbTableName, $var);
            // If the column DOES exist, then the object is new, and therefore, we should
            // return null.
            if ($column_exist === true) {
                return null;
            }

            // Let's try to be accurate in error reporting. The checkColumnExist returns an array of closest matches.
            $result_array = $column_exist;

            if (count($result_array)==1)
            $str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant this column: '".$result_array[0]."'";
            else
            $str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant one of those columns: '".implode("', '",$result_array)."'";

            throw new TDBMException($str);*/
            return;
        }

        $value = $this->dbRow[$var];
        if ($value instanceof \DateTime) {
            if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only
                return \DateTimeImmutable::createFromMutable($value);
            } else {
                return new \DateTimeImmutable($value->format('c'));
            }
        }

        return $this->dbRow[$var];
    }

    /**
     * Returns true if a column is set, false otherwise.
     *
     * @param string $var
     *
     * @return bool
     */
    /*public function has($var) {

        $this->_dbLoadIfNotLoaded();

        return isset($this->dbRow[$var]);
    }*/

    public function set($var, $value)

    {
        $this->_dbLoadIfNotLoaded();

        /*
        // Ok, let's start by checking the column type
        $type = $this->db_connection->getColumnType($this->dbTableName, $var);

        // Throws an exception if the type is not ok.
        if (!$this->db_connection->checkType($value, $type)) {
            throw new TDBMException("Error! Invalid value passed for attribute '$var' of table '$this->dbTableName'. Passed '$value', but expecting '$type'");
        }
        */

        /*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))

            throw new TDBMException("Error! Changing primary key value is forbidden.");*/
        $this->dbRow[$var] = $value;
        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
            $this->tdbmService->_addToToSaveObjectList($this);
        }
    }

    /**
     * @param string             $foreignKeyName
     * @param AbstractTDBMObject $bean
     */
    public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)

    {
        $this->references[$foreignKeyName] = $bean;

        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
            $this->tdbmService->_addToToSaveObjectList($this);
        }
    }

    /**
     * @param string $foreignKeyName A unique name for this reference
     *
     * @return AbstractTDBMObject|null
     */
    public function getRef($foreignKeyName)
    {
        if (isset($this->references[$foreignKeyName])) {
            return $this->references[$foreignKeyName];
        } elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) {
            // If the object is new and has no property, then it has to be empty.
            return;
        } else {
            $this->_dbLoadIfNotLoaded();

            // Let's match the name of the columns to the primary key values
            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);

            $values = [];
            foreach ($fk->getLocalColumns() as $column) {
                $values[] = $this->dbRow[$column];
            }

            $filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);

            return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
        }
    }

    /**
     * Returns the name of the table this object comes from.
     *
     * @return string
     */
    public function _getDbTableName()
    {
        return $this->dbTableName;
    }

    /**
     * Method used internally by TDBM. You should not use it directly.
     * This method returns the status of the TDBMObject.
     * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
     *
     * @return string
     */
    public function _getStatus()
    {
        return $this->status;
    }

    /**
     * Override the native php clone function for TDBMObjects.
     */
    public function __clone()
    {
        // Let's load the row (before we lose the ID!)
        $this->_dbLoadIfNotLoaded();

        //Let's set the status to detached
        $this->status = TDBMObjectStateEnum::STATE_DETACHED;

        $this->primaryKeys = [];

        //Now unset the PK from the row
        if ($this->tdbmService) {
            $pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
            foreach ($pk_array as $pk) {
                $this->dbRow[$pk] = null;
            }
        }
    }

    /**
     * Returns raw database row.
     *
     * @return array
     */
    public function _getDbRow()
    {
        // Let's merge $dbRow and $references
        $dbRow = $this->dbRow;

        foreach ($this->references as $foreignKeyName => $reference) {
            // Let's match the name of the columns to the primary key values
            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
            $refDbRows = $reference->_getDbRows();
            $firstRefDbRow = reset($refDbRows);
            $pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
            $localColumns = $fk->getLocalColumns();

            for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
                $dbRow[$localColumns[$i]] = $pkValues[$i];
            }
        }

        return $dbRow;
    }

    /**
     * Returns references array.
     *
     * @return AbstractTDBMObject[]
     */
    public function _getReferences()
    {
        return $this->references;
    }

    /**
     * Returns the values of the primary key.
     * This is set when the object is in "loaded" state.
     *
     * @return array
     */
    public function _getPrimaryKeys()
    {
        return $this->primaryKeys;
    }

    /**
     * Sets the values of the primary key.
     * This is set when the object is in "loaded" state.
     *
     * @param array $primaryKeys
     */
    public function _setPrimaryKeys(array $primaryKeys)
    {
        $this->primaryKeys = $primaryKeys;
        foreach ($this->primaryKeys as $column => $value) {
            $this->dbRow[$column] = $value;
        }
    }

    /**
     * Returns the TDBMObject this bean is associated to.
     *
     * @return AbstractTDBMObject
     */
    public function getTDBMObject()
    {
        return $this->object;
    }

    /**
     * Sets the TDBMObject this bean is associated to.
     * Only used when cloning.
     *
     * @param AbstractTDBMObject $object
     */
    public function setTDBMObject(AbstractTDBMObject $object)
    {
        $this->object = $object;
    }
}


1		<?php
2
3		namespace Mouf\Database\TDBM;
4
5		/*
6		Copyright (C) 2006-2016 David Négrier - THE CODING MACHINE
7
8		This program is free software; you can redistribute it and/or modify
9		it under the terms of the GNU General Public License as published by
10		the Free Software Foundation; either version 2 of the License, or
11		(at your option) any later version.
12
13		This program is distributed in the hope that it will be useful,
14		but WITHOUT ANY WARRANTY; without even the implied warranty of
15		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		GNU General Public License for more details.
17
18		You should have received a copy of the GNU General Public License
19		along with this program; if not, write to the Free Software
20		Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21		*/
22
23		/**
24		* Instances of this class represent a row in a database.
25		*
26		* @author David Negrier
27		*/
28		class DbRow
29		{
30		/**
31		* The service this object is bound to.
32		*
33		* @var TDBMService
34		*/
35		protected $tdbmService;
36
37		/**
38		* The object containing this db row.
39		*
40		* @var AbstractTDBMObject
41		*/
42		private $object;
43
44		/**
45		* The name of the table the object if issued from.
46		*
47		* @var string
48		*/
49		private $dbTableName;
50
51		/**
52		* The array of columns returned from database.
53		*
54		* @var array
55		*/
56		private $dbRow = array();
57
58		/**
59		* @var AbstractTDBMObject[]
60		*/
61		private $references = array();
62
63		/**
64		* One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
65		* $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
66		* $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
67		* $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
68		*
69		* @var string
70		*/
71		private $status;
72
73		/**
74		* The values of the primary key.
75		* This is set when the object is in "loaded" state.
76		*
77		* @var array An array of column => value
78		*/
79		private $primaryKeys;
80
81		/**
82		* You should never call the constructor directly. Instead, you should use the
83		* TDBMService class that will create TDBMObjects for you.
84		*
85		* Used with id!=false when we want to retrieve an existing object
86		* and id==false if we want a new object
87		*
88		* @param AbstractTDBMObject $object The object containing this db row.
89		* @param string $table_name
90		* @param array $primaryKeys
91		* @param TDBMService $tdbmService
92		*
93		* @throws TDBMException
94		* @throws TDBMInvalidOperationException
95		*/
96		public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array())
97		{
98		$this->object = $object;
99		$this->dbTableName = $table_name;
100
101		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
102
103		if ($tdbmService === null) {
104		if (!empty($primaryKeys)) {
105		throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.');
106		}
107		} else {
108		$this->tdbmService = $tdbmService;
109
110		if (!empty($primaryKeys)) {
111		$this->_setPrimaryKeys($primaryKeys);
112		if (!empty($dbRow)) {
113		$this->dbRow = $dbRow;
114		$this->status = TDBMObjectStateEnum::STATE_LOADED;
115		} else {
116		$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
117		}
118		$tdbmService->_addToCache($this);
119		} else {
120		$this->status = TDBMObjectStateEnum::STATE_NEW;
121		$this->tdbmService->_addToToSaveObjectList($this);
122		}
123		}
124		}
125
126		public function _attach(TDBMService $tdbmService)
127		{
128		if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
129		throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
130		}
131		$this->tdbmService = $tdbmService;
132		$this->status = TDBMObjectStateEnum::STATE_NEW;
133		$this->tdbmService->_addToToSaveObjectList($this);
134		}
135
136		/**
137		* Sets the state of the TDBM Object
138		* One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
139		* $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
140		* $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
141		* $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
142		*
143		* @param string $state
144		*/
145		public function _setStatus($state)
146		{
147		$this->status = $state;
148		}
149
150		/**
151		* This is an internal method. You should not call this method yourself. The TDBM library will do it for you.
152		* If the object is in state 'not loaded', this method performs a query in database to load the object.
153		*
154		* A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified
155		* cannot be found).
156		*/
157		public function _dbLoadIfNotLoaded()
158		{
159		if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) {
160		$connection = $this->tdbmService->getConnection();
161
162		/// buildFilterFromFilterBag($filter_bag)
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-05 16:07 UTC by Report Bug Copy Issue Report `50%` 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...
163		list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys);
164
165		$sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where;
		0 ignored issues – show Security introduced 2016-02-05 16:07 UTC by Report Bug Copy Issue Report `'SELECT * FROM ' . $conn... ' WHERE ' . $sql_where` is used as a query on line 166. If `$sql_where` can contain user-input, it is usually preferable to use a parameter placeholder like `:paramName` and pass the dynamic input as second argument `array('param' => $sql_where)`. Instead of embedding dynamic parameters in SQL, Doctrine also allows you to pass them separately and insert a placeholder instead: function findUser(Doctrine\DBAL\Connection $con, $email) { // Unsafe $con->executeQuery("SELECT * FROM users WHERE email = '".$email."'"); // Safe $con->executeQuery( "SELECT * FROM users WHERE email = :email", array('email' => $email) ); } Loading history...
166		$result = $connection->executeQuery($sql, $parameters);
167
168		if ($result->rowCount() === 0) {
169		throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\".");
170		}
171
172		$this->dbRow = $result->fetch(\PDO::FETCH_ASSOC);
173
174		$result->closeCursor();
175
176		$this->status = TDBMObjectStateEnum::STATE_LOADED;
177		}
178		}
179
180		public function get($var)
181		{
182		$this->_dbLoadIfNotLoaded();
183
184		// Let's first check if the key exist.
185		if (!isset($this->dbRow[$var])) {
186		/*
187		// Unable to find column.... this is an error if the object has been retrieved from database.
188		// If it's a new object, well, that may not be an error after all!
189		// Let's check if the column does exist in the table
190		$column_exist = $this->db_connection->checkColumnExist($this->dbTableName, $var);
191		// If the column DOES exist, then the object is new, and therefore, we should
192		// return null.
193		if ($column_exist === true) {
194		return null;
195		}
196
197		// Let's try to be accurate in error reporting. The checkColumnExist returns an array of closest matches.
198		$result_array = $column_exist;
199
200		if (count($result_array)==1)
201		$str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant this column: '".$result_array[0]."'";
202		else
203		$str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant one of those columns: '".implode("', '",$result_array)."'";
204
205		throw new TDBMException($str);*/
206		return;
207		}
208
209		$value = $this->dbRow[$var];
210		if ($value instanceof \DateTime) {
211		if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only
212		return \DateTimeImmutable::createFromMutable($value);
213		} else {
214		return new \DateTimeImmutable($value->format('c'));
215		}
216		}
217
218		return $this->dbRow[$var];
219		}
220
221		/**
222		* Returns true if a column is set, false otherwise.
223		*
224		* @param string $var
225		*
226		* @return bool
227		*/
228		/*public function has($var) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-05 16:07 UTC by Report Bug Copy Issue Report `67%` 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...
229		$this->_dbLoadIfNotLoaded();
230
231		return isset($this->dbRow[$var]);
232		}*/
233
234	View Code Duplication	public function set($var, $value)
		0 ignored issues – show Duplication introduced 2015-12-06 08:27 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...
235		{
236		$this->_dbLoadIfNotLoaded();
237
238		/*
239		// Ok, let's start by checking the column type
240		$type = $this->db_connection->getColumnType($this->dbTableName, $var);
241
242		// Throws an exception if the type is not ok.
243		if (!$this->db_connection->checkType($value, $type)) {
244		throw new TDBMException("Error! Invalid value passed for attribute '$var' of table '$this->dbTableName'. Passed '$value', but expecting '$type'");
245		}
246		*/
247
248		/*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-05 16:07 UTC by Report Bug Copy Issue Report `66%` 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...
249		throw new TDBMException("Error! Changing primary key value is forbidden.");*/
250		$this->dbRow[$var] = $value;
251		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
252		$this->status = TDBMObjectStateEnum::STATE_DIRTY;
253		$this->tdbmService->_addToToSaveObjectList($this);
254		}
255		}
256
257		/**
258		* @param string $foreignKeyName
259		* @param AbstractTDBMObject $bean
260		*/
261	View Code Duplication	public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)
		0 ignored issues – show Duplication introduced 2015-12-06 08:27 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...
262		{
263		$this->references[$foreignKeyName] = $bean;
264
265		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
266		$this->status = TDBMObjectStateEnum::STATE_DIRTY;
267		$this->tdbmService->_addToToSaveObjectList($this);
268		}
269		}
270
271		/**
272		* @param string $foreignKeyName A unique name for this reference
273		*
274		* @return AbstractTDBMObject\|null
275		*/
276		public function getRef($foreignKeyName)
277		{
278		if (isset($this->references[$foreignKeyName])) {
279		return $this->references[$foreignKeyName];
280		} elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) {
281		// If the object is new and has no property, then it has to be empty.
282		return;
283		} else {
284		$this->_dbLoadIfNotLoaded();
285
286		// Let's match the name of the columns to the primary key values
287		$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
288
289		$values = [];
290		foreach ($fk->getLocalColumns() as $column) {
291		$values[] = $this->dbRow[$column];
292		}
293
294		$filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
295
296		return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
297		}
298		}
299
300		/**
301		* Returns the name of the table this object comes from.
302		*
303		* @return string
304		*/
305		public function _getDbTableName()
306		{
307		return $this->dbTableName;
308		}
309
310		/**
311		* Method used internally by TDBM. You should not use it directly.
312		* This method returns the status of the TDBMObject.
313		* This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
314		* $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
315		* $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
316		* $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
317		*
318		* @return string
319		*/
320		public function _getStatus()
321		{
322		return $this->status;
323		}
324
325		/**
326		* Override the native php clone function for TDBMObjects.
327		*/
328		public function __clone()
329		{
330		// Let's load the row (before we lose the ID!)
331		$this->_dbLoadIfNotLoaded();
332
333		//Let's set the status to detached
334		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
335
336		$this->primaryKeys = [];
337
338		//Now unset the PK from the row
339		if ($this->tdbmService) {
340		$pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
341		foreach ($pk_array as $pk) {
342		$this->dbRow[$pk] = null;
343		}
344		}
345		}
346
347		/**
348		* Returns raw database row.
349		*
350		* @return array
351		*/
352		public function _getDbRow()
353		{
354		// Let's merge $dbRow and $references
355		$dbRow = $this->dbRow;
356
357		foreach ($this->references as $foreignKeyName => $reference) {
358		// Let's match the name of the columns to the primary key values
359		$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
360		$refDbRows = $reference->_getDbRows();
361		$firstRefDbRow = reset($refDbRows);
362		$pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
363		$localColumns = $fk->getLocalColumns();
364
365		for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
366		$dbRow[$localColumns[$i]] = $pkValues[$i];
367		}
368		}
369
370		return $dbRow;
371		}
372
373		/**
374		* Returns references array.
375		*
376		* @return AbstractTDBMObject[]
377		*/
378		public function _getReferences()
379		{
380		return $this->references;
381		}
382
383		/**
384		* Returns the values of the primary key.
385		* This is set when the object is in "loaded" state.
386		*
387		* @return array
388		*/
389		public function _getPrimaryKeys()
390		{
391		return $this->primaryKeys;
392		}
393
394		/**
395		* Sets the values of the primary key.
396		* This is set when the object is in "loaded" state.
397		*
398		* @param array $primaryKeys
399		*/
400		public function _setPrimaryKeys(array $primaryKeys)
401		{
402		$this->primaryKeys = $primaryKeys;
403		foreach ($this->primaryKeys as $column => $value) {
404		$this->dbRow[$column] = $value;
405		}
406		}
407
408		/**
409		* Returns the TDBMObject this bean is associated to.
410		*
411		* @return AbstractTDBMObject
412		*/
413		public function getTDBMObject()
414		{
415		return $this->object;
416		}
417
418		/**
419		* Sets the TDBMObject this bean is associated to.
420		* Only used when cloning.
421		*
422		* @param AbstractTDBMObject $object
423		*/
424		public function setTDBMObject(AbstractTDBMObject $object)
425		{
426		$this->object = $object;
427		}
428		}
429

thecodingmachine / database.tdbm

Pull Request — 4.0 (#55)

DbRow B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like