Mouf\Database\TDBM\InnerResultIterator

Complexity

Total Complexity

20

Size/Duplication

Total Lines	256
Duplicated Lines	5.08 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	13	13	1
A	executeQuery()	0	8	1
A	count()	0	7	2
A	current()	0	4	1
A	key()	0	4	1
B	next()	0	59	8
A	rewind()	0	6	1
A	valid()	0	4	1
A	offsetExists()	0	4	1
A	offsetGet()	0	4	1
A	offsetSet()	0	4	1
A	offsetUnset()	0	4	1

<?php
namespace Mouf\Database\TDBM;

use Doctrine\DBAL\Driver\Connection;
use Doctrine\DBAL\Statement;
use Mouf\Database\MagicQuery;

/*
 Copyright (C) 2006-2015 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
 */


/**
 * Iterator used to retrieve results.
 *
 */
class InnerResultIterator implements \Iterator, \Countable, \ArrayAccess {

	/**
	 *
	 * @var Statement
	 */
	protected $statement;
	
	protected $fetchStarted = false;
	private $objectStorage;
	private $className;

	private $tdbmService;
	private $magicSql;
	private $parameters;
	private $limit;
	private $offset;
	private $columnDescriptors;
	private $magicQuery;

	/**
	 * The key of the current retrieved object.
	 *
	 * @var int
	 */
	protected $key = -1;

	protected $current = null;

	private $databasePlatform;

	private $totalCount;

The property $totalCount is not used and could be removed.

	
	public function __construct($magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery)

This method seems to be duplicated in your project.

	{
		$this->magicSql = $magicSql;
		$this->objectStorage = $objectStorage;
		$this->className = $className;
		$this->tdbmService = $tdbmService;
		$this->parameters = $parameters;
		$this->limit = $limit;
		$this->offset = $offset;
		$this->columnDescriptors = $columnDescriptors;
		$this->magicQuery = $magicQuery;
		$this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
	}

	protected function executeQuery() {
		$sql = $this->magicQuery->build($this->magicSql, $this->parameters);
		$sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset);

		$this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters);

		$this->fetchStarted = true;
	}

	/**
	 * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings)
	 * @return int
	 */
	public function count()
	{
		if (!$this->fetchStarted) {
			$this->executeQuery();
		}
		return $this->statement->rowCount();
	}

	/**
	 * Fetches record at current cursor.
	 * @return AbstractTDBMObject|null
	 */
	public function current()
	{
		return $this->current;
	}

	/**
	 * Returns the current result's key
	 * @return int
	 */
	public function key()
	{
		return $this->key;
	}

	/**
	 * Advances the cursor to the next result.
	 * Casts the database result into one (or several) beans.
	 */
	public function next()
	{
		$row = $this->statement->fetch(\PDO::FETCH_NUM);
		if ($row) {

			// array<tablegroup, array<table, array<column, value>>>

37% of this comment could be valid code. Did you maybe forget this after debugging?

			$beansData = [];
			foreach ($row as $i => $value) {
				$columnDescriptor = $this->columnDescriptors[$i];
				// Let's cast the value according to its type
				$value = $columnDescriptor['type']->convertToPHPValue($value, $this->databasePlatform);

				$beansData[$columnDescriptor['tableGroup']][$columnDescriptor['table']][$columnDescriptor['column']] = $value;
			}

			$firstBean = true;
			foreach ($beansData as $beanData) {

				// Let's find the bean class name associated to the bean.

				list($actualClassName, $mainBeanTableName) = $this->tdbmService->_getClassNameFromBeanData($beanData);


				if ($this->className !== null) {
					$actualClassName = $this->className;
				}

				// Must we create the bean? Let's see in the cache if we have a mapping DbRow?
				// Let's get the first object mapping a row:
				// We do this loop only for the first table

				$primaryKeys = $this->tdbmService->_getPrimaryKeysFromObjectData($mainBeanTableName, $beanData[$mainBeanTableName]);
				$hash = $this->tdbmService->getObjectHash($primaryKeys);

				if ($this->objectStorage->has($mainBeanTableName, $hash)) {
					$dbRow = $this->objectStorage->get($mainBeanTableName, $hash);
					$bean = $dbRow->getTDBMObject();
				} else {
					// Let's construct the bean
					if (!isset($reflectionClassCache[$actualClassName])) {
						$reflectionClassCache[$actualClassName] = new \ReflectionClass($actualClassName);

$reflectionClassCache was never initialized. Although not strictly required by PHP, it is generally a good practice to add $reflectionClassCache = array(); before regardless.

					}
					// Let's bypass the constructor when creating the bean!
					$bean = $reflectionClassCache[$actualClassName]->newInstanceWithoutConstructor();

The variable $reflectionClassCache does not seem to be defined for all execution paths leading up to this point.

					$bean->_constructFromData($beanData, $this->tdbmService);
				}

				// The first bean is the one containing the main table.
				if ($firstBean) {
					$firstBean = false;
					$this->current = $bean;
				}
			}

			$this->key++;
		} else {
			$this->current = null;
		}
	}
	
	/**
	 * Moves the cursor to the beginning of the result set
	 */
	public function rewind()
	{
		$this->executeQuery();
		$this->key = -1;
		$this->next();
	}
	/**
	 * Checks if the cursor is reading a valid result.
	 *
	 * @return boolean
	 */
	public function valid()
	{
		return $this->current !== null;
	}

	/**
	 * Fetches all records (this could impact into your site performance) and rewinds the cursor
	 * @param boolean $asRecords Bind into record class?
	 * @return array[Record_PDO]|array[array] Array of records or arrays (depends on $asRecords)
	 */
	/*public function getAll($asRecords = true)

59% of this comment could be valid code. Did you maybe forget this after debugging?

	{
		$all = array();
		$this->rewind();
		foreach ($this->pdoStatement as $id => $doc) {
			if ($asRecords)
				$all[$id] = $this->cast($doc);
			else
				$all[$id] = $doc;
		}
		return $all;
	}*/
	/**
	 * @return PDOStatement
	 */
	/*public function getPDOStatement()

56% of this comment could be valid code. Did you maybe forget this after debugging?

	{
		return $this->pdoStatement;
	}*/

	/**
	 * Whether a offset exists
	 * @link http://php.net/manual/en/arrayaccess.offsetexists.php
	 * @param mixed $offset <p>
	 * An offset to check for.
	 * </p>
	 * @return boolean true on success or false on failure.
	 * </p>
	 * <p>
	 * The return value will be casted to boolean if non-boolean was returned.
	 * @since 5.0.0
	 */
	public function offsetExists($offset)
	{
		throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
	}

	/**
	 * Offset to retrieve
	 * @link http://php.net/manual/en/arrayaccess.offsetget.php
	 * @param mixed $offset <p>
	 * The offset to retrieve.
	 * </p>
	 * @return mixed Can return all value types.
	 * @since 5.0.0
	 */
	public function offsetGet($offset)
	{
		throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
	}

	/**
	 * Offset to set
	 * @link http://php.net/manual/en/arrayaccess.offsetset.php
	 * @param mixed $offset <p>
	 * The offset to assign the value to.
	 * </p>
	 * @param mixed $value <p>
	 * The value to set.
	 * </p>
	 * @return void
	 * @since 5.0.0
	 */
	public function offsetSet($offset, $value)
	{
		throw new TDBMInvalidOperationException('You can set values in a TDBM result set.');
	}

	/**
	 * Offset to unset
	 * @link http://php.net/manual/en/arrayaccess.offsetunset.php
	 * @param mixed $offset <p>
	 * The offset to unset.
	 * </p>
	 * @return void
	 * @since 5.0.0
	 */
	public function offsetUnset($offset)
	{
		throw new TDBMInvalidOperationException('You can unset values in a TDBM result set.');
	}
}