DbRow::_getDbRow() - Code Metrics - Inspection of "fixing cascade bugs on saving a bean with null FKs" - thecodingmachine/database.tdbm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 4.0 (#74)

by Kevin

created 2016-03-23 09:22 UTC

DbRow::_getDbRow() B

↳ Parent: DbRow

Complexity

Conditions	5
Paths	4

Size

Total Lines	26
Code Lines	15

Duplication

Lines	6
Ratio	23.08 %

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
c	5
b	0
f	0
dl	6
loc	26
rs	8.439
cc	5
eloc	15
nc	4
nop	0

<?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 \"\".");
            }

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

            $this->dbRow = [];
            $types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName);

            foreach ($row as $key => $value) {
                $this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform());
            }

            $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 (array_key_exists($foreignKeyName, $this->references)) {
            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) {
                $val = $this->dbRow[$column];
                if ($val === null) {
                    return;
                }
                $values[] = $val;
            }

            $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);
            $localColumns = $fk->getLocalColumns();

            if ($reference !== null) {
                $refDbRows = $reference->_getDbRows();
                $firstRefDbRow = reset($refDbRows);
                $pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
                for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {

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

                    $dbRow[$localColumns[$i]] = null;
                }
            }
        }

        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		$row = $result->fetch(\PDO::FETCH_ASSOC);
173
174		$this->dbRow = [];
175		$types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName);
176
177		foreach ($row as $key => $value) {
178		$this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform());
179		}
180
181		$result->closeCursor();
182
183		$this->status = TDBMObjectStateEnum::STATE_LOADED;
184		}
185		}
186
187		public function get($var)
188		{
189		$this->_dbLoadIfNotLoaded();
190
191		// Let's first check if the key exist.
192		if (!isset($this->dbRow[$var])) {
193		/*
194		// Unable to find column.... this is an error if the object has been retrieved from database.
195		// If it's a new object, well, that may not be an error after all!
196		// Let's check if the column does exist in the table
197		$column_exist = $this->db_connection->checkColumnExist($this->dbTableName, $var);
198		// If the column DOES exist, then the object is new, and therefore, we should
199		// return null.
200		if ($column_exist === true) {
201		return null;
202		}
203
204		// Let's try to be accurate in error reporting. The checkColumnExist returns an array of closest matches.
205		$result_array = $column_exist;
206
207		if (count($result_array)==1)
208		$str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant this column: '".$result_array[0]."'";
209		else
210		$str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant one of those columns: '".implode("', '",$result_array)."'";
211
212		throw new TDBMException($str);*/
213		return;
214		}
215
216		$value = $this->dbRow[$var];
217		if ($value instanceof \DateTime) {
218		if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only
219		return \DateTimeImmutable::createFromMutable($value);
220		} else {
221		return new \DateTimeImmutable($value->format('c'));
222		}
223		}
224
225		return $this->dbRow[$var];
226		}
227
228		/**
229		* Returns true if a column is set, false otherwise.
230		*
231		* @param string $var
232		*
233		* @return bool
234		*/
235		/*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...
236		$this->_dbLoadIfNotLoaded();
237
238		return isset($this->dbRow[$var]);
239		}*/
240
241	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...
242		{
243		$this->_dbLoadIfNotLoaded();
244
245		/*
246		// Ok, let's start by checking the column type
247		$type = $this->db_connection->getColumnType($this->dbTableName, $var);
248
249		// Throws an exception if the type is not ok.
250		if (!$this->db_connection->checkType($value, $type)) {
251		throw new TDBMException("Error! Invalid value passed for attribute '$var' of table '$this->dbTableName'. Passed '$value', but expecting '$type'");
252		}
253		*/
254
255		/*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...
256		throw new TDBMException("Error! Changing primary key value is forbidden.");*/
257		$this->dbRow[$var] = $value;
258		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
259		$this->status = TDBMObjectStateEnum::STATE_DIRTY;
260		$this->tdbmService->_addToToSaveObjectList($this);
261		}
262		}
263
264		/**
265		* @param string $foreignKeyName
266		* @param AbstractTDBMObject $bean
267		*/
268	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...
269		{
270		$this->references[$foreignKeyName] = $bean;
271
272		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
273		$this->status = TDBMObjectStateEnum::STATE_DIRTY;
274		$this->tdbmService->_addToToSaveObjectList($this);
275		}
276		}
277
278		/**
279		* @param string $foreignKeyName A unique name for this reference
280		*
281		* @return AbstractTDBMObject\|null
282		*/
283		public function getRef($foreignKeyName)
284		{
285		if (array_key_exists($foreignKeyName, $this->references)) {
286		return $this->references[$foreignKeyName];
287		} elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) {
288		// If the object is new and has no property, then it has to be empty.
289		return;
290		} else {
291		$this->_dbLoadIfNotLoaded();
292
293		// Let's match the name of the columns to the primary key values
294		$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
295
296		$values = [];
297		foreach ($fk->getLocalColumns() as $column) {
298		$val = $this->dbRow[$column];
299		if ($val === null) {
300		return;
301		}
302		$values[] = $val;
303		}
304
305		$filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
306
307		return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
308		}
309		}
310
311		/**
312		* Returns the name of the table this object comes from.
313		*
314		* @return string
315		*/
316		public function _getDbTableName()
317		{
318		return $this->dbTableName;
319		}
320
321		/**
322		* Method used internally by TDBM. You should not use it directly.
323		* This method returns the status of the TDBMObject.
324		* This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
325		* $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
326		* $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
327		* $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
328		*
329		* @return string
330		*/
331		public function _getStatus()
332		{
333		return $this->status;
334		}
335
336		/**
337		* Override the native php clone function for TDBMObjects.
338		*/
339		public function __clone()
340		{
341		// Let's load the row (before we lose the ID!)
342		$this->_dbLoadIfNotLoaded();
343
344		//Let's set the status to detached
345		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
346
347		$this->primaryKeys = [];
348
349		//Now unset the PK from the row
350		if ($this->tdbmService) {
351		$pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
352		foreach ($pk_array as $pk) {
353		$this->dbRow[$pk] = null;
354		}
355		}
356		}
357
358		/**
359		* Returns raw database row.
360		*
361		* @return array
362		*/
363		public function _getDbRow()
364		{
365		// Let's merge $dbRow and $references
366		$dbRow = $this->dbRow;
367
368		foreach ($this->references as $foreignKeyName => $reference) {
369		// Let's match the name of the columns to the primary key values
370		$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
371		$localColumns = $fk->getLocalColumns();
372
373		if ($reference !== null) {
374		$refDbRows = $reference->_getDbRows();
375		$firstRefDbRow = reset($refDbRows);
376		$pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
377	View Code Duplication	for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
		0 ignored issues – show Duplication introduced 2016-03-23 09:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
378		$dbRow[$localColumns[$i]] = $pkValues[$i];
379		}
380		} else {
381	View Code Duplication	for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
		0 ignored issues – show Duplication introduced 2016-03-23 09:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
382		$dbRow[$localColumns[$i]] = null;
383		}
384		}
385		}
386
387		return $dbRow;
388		}
389
390		/**
391		* Returns references array.
392		*
393		* @return AbstractTDBMObject[]
394		*/
395		public function _getReferences()
396		{
397		return $this->references;
398		}
399
400		/**
401		* Returns the values of the primary key.
402		* This is set when the object is in "loaded" state.
403		*
404		* @return array
405		*/
406		public function _getPrimaryKeys()
407		{
408		return $this->primaryKeys;
409		}
410
411		/**
412		* Sets the values of the primary key.
413		* This is set when the object is in "loaded" state.
414		*
415		* @param array $primaryKeys
416		*/
417		public function _setPrimaryKeys(array $primaryKeys)
418		{
419		$this->primaryKeys = $primaryKeys;
420		foreach ($this->primaryKeys as $column => $value) {
421		$this->dbRow[$column] = $value;
422		}
423		}
424
425		/**
426		* Returns the TDBMObject this bean is associated to.
427		*
428		* @return AbstractTDBMObject
429		*/
430		public function getTDBMObject()
431		{
432		return $this->object;
433		}
434
435		/**
436		* Sets the TDBMObject this bean is associated to.
437		* Only used when cloning.
438		*
439		* @param AbstractTDBMObject $object
440		*/
441		public function setTDBMObject(AbstractTDBMObject $object)
442		{
443		$this->object = $object;
444		}
445		}
446

thecodingmachine / database.tdbm

Pull Request — 4.0 (#74)

DbRow::_getDbRow() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like