thecodingmachine / database.tdbm

src/Mouf/Database/TDBM/AbstractTDBMObject.php

Doc Comments +1 added lines, -1 removed lines

@@ -515,7 +515,7 @@
 	/**
 	 * Returns the tables used in the filter in an array.
 	 *
-	 * @return array<string>
+	 * @return integer[]
 	 */
 	public function getUsedTables() {
 		return array_keys($this->dbRows);

Spacing +16 added lines, -16 removed lines

@@ -95,7 +95,7 @@ 
 	 * @throws TDBMException
 	 * @throws TDBMInvalidOperationException
 	 */
-	public function __construct($tableName=null, array $primaryKeys=array(), TDBMService $tdbmService=null) {
+	public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null) {
 		// FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation...
 		if (!empty($tableName)) {
 			$this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
@@ -199,7 +199,7 @@ 
 	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
 	 * @param string $state
 	 */
-	public function _setStatus($state){
+	public function _setStatus($state) {
 		$this->status = $state;
 
 		// TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself.
@@ -210,7 +210,7 @@ 
 
 	public function get($var, $tableName = null) {
 		if ($tableName === null) {
-			if (count($this->dbRows) > 1) {
+			if (count($this->dbRows)>1) {
 				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
 			} elseif (count($this->dbRows) === 1) {
 				$tableName = array_keys($this->dbRows)[0];
@@ -236,7 +236,7 @@ 
 	 */
 	public function has($var, $tableName = null) {
 		if ($tableName === null) {
-			if (count($this->dbRows) > 1) {
+			if (count($this->dbRows)>1) {
 				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
 			} elseif (count($this->dbRows) === 1) {
 				$tableName = array_keys($this->dbRows)[0];
@@ -256,7 +256,7 @@ 
 	
 	public function set($var, $value, $tableName = null) {
 		if ($tableName === null) {
-			if (count($this->dbRows) > 1) {
+			if (count($this->dbRows)>1) {
 				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
 			} elseif (count($this->dbRows) === 1) {
 				$tableName = array_keys($this->dbRows)[0];
@@ -281,7 +281,7 @@ 
 	 */
 	public function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null) {
 		if ($tableName === null) {
-			if (count($this->dbRows) > 1) {
+			if (count($this->dbRows)>1) {
 				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
 			} elseif (count($this->dbRows) === 1) {
 				$tableName = array_keys($this->dbRows)[0];
@@ -306,7 +306,7 @@ 
 	 */
 	public function getRef($foreignKeyName, $tableName = null) {
 		if ($tableName === null) {
-			if (count($this->dbRows) > 1) {
+			if (count($this->dbRows)>1) {
 				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
 			} elseif (count($this->dbRows) === 1) {
 				$tableName = array_keys($this->dbRows)[0];
@@ -421,13 +421,13 @@ 
 	 */
 	private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status) {
 		$storage = $this->getRelationshipStorage($pivotTableName);
-		$storage->attach($remoteBean, [ 'status' => $status, 'reverse' => false ]);
+		$storage->attach($remoteBean, ['status' => $status, 'reverse' => false]);
 		if ($this->status === TDBMObjectStateEnum::STATE_LOADED) {
 			$this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY);
 		}
 
 		$remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName);
-		$remoteStorage->attach($this, [ 'status' => $status, 'reverse' => true ]);
+		$remoteStorage->attach($this, ['status' => $status, 'reverse' => true]);
 	}
 
 	/**
@@ -496,7 +496,7 @@ 
 	 * Implement the unique JsonSerializable method
 	 * @return array
 	 */
-	public function jsonSerialize(){
+	public function jsonSerialize() {
 		// FIXME
 		$this->_dbLoadIfNotLoaded();
 		return $this->dbRow;
@@ -526,23 +526,23 @@ 
 	 *
 	 * @return string
 	 */
-	private function getPrimaryKeyWhereStatement () {
+	private function getPrimaryKeyWhereStatement() {
 		// Let's first get the primary keys
 		$pk_table = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
 		// Now for the object_id
 		$object_id = $this->TDBMObject_id;
 		// If there is only one primary key:
-		if (count($pk_table)==1) {
+		if (count($pk_table) == 1) {
 			$sql_where = $this->db_connection->escapeDBItem($this->dbTableName).'.'.$this->db_connection->escapeDBItem($pk_table[0])."=".$this->db_connection->quoteSmart($this->TDBMObject_id);
 		} else {
 			$ids = unserialize($object_id);
-			$i=0;
+			$i = 0;
 			$sql_where_array = array();
 			foreach ($pk_table as $pk) {
 				$sql_where_array[] = $this->db_connection->escapeDBItem($this->dbTableName).'.'.$this->db_connection->escapeDBItem($pk)."=".$this->db_connection->quoteSmart($ids[$i]);
 				$i++;
 			}
-			$sql_where = implode(" AND ",$sql_where_array);
+			$sql_where = implode(" AND ", $sql_where_array);
 		}
 		return $sql_where;
 	}
@@ -550,7 +550,7 @@ 
     /**
      * Override the native php clone function for TDBMObjects
      */
-    public function __clone(){
+    public function __clone() {
         $this->_dbLoadIfNotLoaded();
         //First lets set the status to new (to enter the save function)
         $this->status = TDBMObjectStateEnum::STATE_NEW;
@@ -577,7 +577,7 @@ 
 	private function registerTable($tableName) {
 		$dbRow = new DbRow($this, $tableName);
 
-		if (in_array($this->status, [ TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY ])) {
+		if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) {
 			// Let's get the primary key for the new table
 			$anotherDbRow = array_values($this->dbRows)[0];
 			/* @var $anotherDbRow DbRow */

src/Mouf/Database/TDBM/Controllers/TdbmInstallController.php

Doc Comments +3 added lines, -2 removed lines

@@ -138,9 +138,7 @@ 
 	 * @Action
 	 * @param string $daonamespace
 	 * @param string $beannamespace
-	 * @param int $keepSupport
 	 * @param int $storeInUtc
-	 * @param int $castDatesToDateTime
 	 * @param string $selfedit
 	 * @throws \Mouf\MoufException
 	 */
@@ -168,6 +166,9 @@ 
 	
 	protected $errorMsg;
 	
+	/**
+	 * @param string $msg
+	 */
 	private function displayErrorMsg($msg) {
 		$this->errorMsg = $msg;
 		$this->content->addFile(dirname(__FILE__)."/../../../../views/installError.php", $this);

Spacing +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
 	 * @param string $selfedit
 	 * @throws \Mouf\MoufException
 	 */
-    public function generate($daonamespace, $beannamespace, $storeInUtc = 0, $selfedit="false") {
+    public function generate($daonamespace, $beannamespace, $storeInUtc = 0, $selfedit = "false") {
 		$this->selfedit = $selfedit;
 		
 		if ($selfedit == "true") {

src/Mouf/Database/TDBM/DbRow.php

Doc Comments +1 added lines, -1 removed lines

@@ -328,7 +328,7 @@
 	/**
 	 * Returns the tables used in the filter in an array.
 	 *
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function getUsedTables() {
 		return array($this->dbTableName);

Spacing +6 added lines, -6 removed lines

@@ -94,7 +94,7 @@ 
 	 * @throws TDBMException
 	 * @throws TDBMInvalidOperationException
 	 */
-	public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys=array(), TDBMService $tdbmService=null, array $dbRow = array()) {
+	public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array()) {
 		$this->object = $object;
 		$this->dbTableName = $table_name;
 
@@ -141,7 +141,7 @@ 
 	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
 	 * @param string $state
 	 */
-	public function _setStatus($state){
+	public function _setStatus($state) {
 		$this->status = $state;
 	}
 
@@ -163,7 +163,7 @@ 
 			$sql = "SELECT * FROM ".$connection->quoteIdentifier($this->dbTableName)." WHERE ".$sql_where;
 			$result = $connection->executeQuery($sql, $parameters);
 
-			if ($result->rowCount()==0)
+			if ($result->rowCount() == 0)
 			{
 				throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" with ID \"".$this->TDBMObject_id."\".");
 			}
@@ -310,7 +310,7 @@ 
 	 * Implement the unique JsonSerializable method
 	 * @return array
 	 */
-	public function jsonSerialize(){
+	public function jsonSerialize() {
 		$this->_dbLoadIfNotLoaded();
 		return $this->dbRow;
 	}
@@ -337,7 +337,7 @@ 
     /**
      * Override the native php clone function for TDBMObjects
      */
-    public function __clone(){
+    public function __clone() {
         $this->_dbLoadIfNotLoaded();
         //First lets set the status to new (to enter the save function)
         $this->status = TDBMObjectStateEnum::STATE_NEW;
@@ -369,7 +369,7 @@ 
             $pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
             $localColumns = $fk->getLocalColumns();
 
-            for ($i=0, $count=count($localColumns); $i<$count; $i++) {
+            for ($i = 0, $count = count($localColumns); $i<$count; $i++) {
                 $dbRow[$localColumns[$i]] = $pkValues[$i];
             }
         }

src/Mouf/Database/TDBM/MapIterator.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
     protected $callable;
 
     /**
-     * @param $iterator Iterator|array
+     * @param InnerResultIterator $iterator Iterator|array
      * @param $callable callable This can have two parameters
      * @throws Exception
      */

src/Mouf/Database/TDBM/PageIterator.php

Doc Comments +4 added lines, -1 removed lines

@@ -63,6 +63,9 @@ 
 
 	private $innerResultIterator;
 
+	/**
+	 * @param integer $offset
+	 */
 	public function __construct(ResultIterator $parentResult, $magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode)
 	{
 		$this->parentResult = $parentResult;
@@ -108,7 +111,7 @@ 
 	}
 
 	/**
-	 * @return int
+	 * @return double
 	 */
 	public function getCurrentPage()
 	{

Spacing +1 added lines, -1 removed lines

@@ -112,7 +112,7 @@
 	 */
 	public function getCurrentPage()
 	{
-		return floor($this->offset / $this->limit) + 1;
+		return floor($this->offset/$this->limit)+1;
 	}
 
 	/**

src/Mouf/Database/TDBM/ResultIterator.php

Doc Comments +7 added lines

@@ -70,6 +70,12 @@ 
 
 	private $mode;
 	
+	/**
+	 * @param string $magicSql
+	 * @param string $magicSqlCount
+	 * @param WeakrefObjectStorage $objectStorage
+	 * @param string|null $className
+	 */
 	public function __construct($magicSql, $magicSqlCount, array $parameters, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode)
 	{
 		$this->magicSql = $magicSql;
@@ -166,6 +172,7 @@ 
 
 	/**
 	 * @param int $offset
+	 * @param integer $limit
 	 * @return PageIterator
 	 */
 	public function take($offset, $limit)

src/Mouf/Database/TDBM/TDBMObject.php

Doc Comments +7 added lines

@@ -35,6 +35,9 @@ 
 class TDBMObject extends AbstractTDBMObject implements \ArrayAccess, \Iterator
 {
 
+    /**
+     * @param string $var
+     */
     public function __get($var)
     {
         return $this->get($var);
@@ -51,6 +54,10 @@ 
         return $this->has($var);
     }
 
+    /**
+     * @param string $var
+     * @param string|null $value
+     */
     public function __set($var, $value)
     {
         $this->set($var, $value);

Spacing +1 added lines, -1 removed lines

@@ -108,7 +108,7 @@
     public function rewind()
     {
         $this->_dbLoadIfNotLoaded();
-        if (count($this->dbRow) > 0) {
+        if (count($this->dbRow)>0) {
             $this->_validIterator = true;
         } else {
             $this->_validIterator = false;

src/Mouf/Database/TDBM/TDBMService.php

Doc Comments +4 added lines, -5 removed lines

@@ -976,7 +976,7 @@ 
 	 * This is used internally by TDBM to add an object to the list of objects that have been
 	 * created/updated but not saved yet.
 	 *
-	 * @param AbstractTDBMObject $myObject
+	 * @param DbRow $myObject
 	 */
 	public function _addToToSaveObjectList(DbRow $myObject) {
 		$this->toSaveObjects[] = $myObject;
@@ -1531,10 +1531,9 @@ 
 	 * @param string|array|null $filter The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
 	 * @param array $parameters
 	 * @param string|null $orderString The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column)
-	 * @param integer $from The offset
-	 * @param integer $limit The maximum number of rows returned
 	 * @param array $additionalTablesFetch
 	 * @param string $className Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
+	 * @param integer $mode
 	 * @return ResultIterator An object representing an array of results.
 	 * @throws TDBMException
 	 */
@@ -1613,7 +1612,7 @@ 
 	}
 
 	/**
-	 * @param $table
+	 * @param string $table
 	 * @param array $primaryKeys
 	 * @param array $additionalTablesFetch
 	 * @param bool $lazy Whether to perform lazy loading on this object or not.
@@ -1770,7 +1769,7 @@ 
 	/**
 	 * @param $pivotTableName
 	 * @param AbstractTDBMObject $bean
-	 * @return AbstractTDBMObject[]
+	 * @return ResultIterator
 	 */
 	public function _getRelatedBeans($pivotTableName, AbstractTDBMObject $bean) {
 

Spacing +15 added lines, -15 removed lines

@@ -430,7 +430,7 @@ 
 	 * @param string $className Optional: The name of the class to instanciate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
 	 * @return TDBMObject
 	 */
-	public function getNewObject($table_name, $auto_assign_id=true, $className = null) {
+	public function getNewObject($table_name, $auto_assign_id = true, $className = null) {
 		if ($this->connection == null) {
 			throw new TDBMException("Error while calling TDBMObject::getNewObject(): No connection has been established on the database!");
 		}
@@ -464,8 +464,8 @@ 
 		$object = new $className($this, $table_name);
 
 		if ($auto_assign_id && !$this->isPrimaryKeyAutoIncrement($table_name)) {
-			$pk_table =  $this->getPrimaryKeyColumns($table_name);
-			if (count($pk_table)==1)
+			$pk_table = $this->getPrimaryKeyColumns($table_name);
+			if (count($pk_table) == 1)
 			{
 				$root_table = $this->connection->findRootSequenceTable($table_name);
 				$id = $this->connection->nextId($root_table);
@@ -475,7 +475,7 @@ 
 					$sql = "SELECT MAX(".$this->connection->escapeDBItem($pk_table[0]).") AS maxkey FROM ".$root_table;
 					$res = $this->connection->getAll($sql);
 					// NOTE: this will work only if the ID is an integer!
-					$newid = $res[0]['maxkey'] + 1;
+					$newid = $res[0]['maxkey']+1;
 					if ($newid>$id) {
 						$id = $newid;
 					}
@@ -892,9 +892,9 @@ 
 		// 4-2, let's take all the objects out of the orderby bag, and let's make objects from them
 		$orderby_bag2 = array();
 		foreach ($orderby_bag as $thing) {
-			if (is_a($thing,'Mouf\\Database\\TDBM\\Filters\\OrderBySQLString')) {
+			if (is_a($thing, 'Mouf\\Database\\TDBM\\Filters\\OrderBySQLString')) {
 				$orderby_bag2[] = $thing;
-			} elseif (is_a($thing,'Mouf\\Database\\TDBM\\Filters\\OrderByColumn')) {
+			} elseif (is_a($thing, 'Mouf\\Database\\TDBM\\Filters\\OrderByColumn')) {
 				$orderby_bag2[] = $thing;
 			} elseif (is_string($thing)) {
 				$orderby_bag2[] = new OrderBySQLString($thing);
@@ -1405,7 +1405,7 @@ 
 		$schemaAnalyzer = $this->schemaAnalyzer;
 
 		foreach ($tables as $currentTable) {
-			$allParents = [ $currentTable ];
+			$allParents = [$currentTable];
 			$currentFk = null;
 			while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
 				$currentTable = $currentFk->getForeignTableName();
@@ -1447,7 +1447,7 @@ 
 		// Let's scan the parent tables
 		$currentTable = $table;
 
-		$parentTables = [ ];
+		$parentTables = [];
 
 		// Get parent relationship
 		while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
@@ -1538,7 +1538,7 @@ 
 	 * @return ResultIterator An object representing an array of results.
 	 * @throws TDBMException
 	 */
-	public function findObjects($mainTable, $filter=null, array $parameters = array(), $orderString=null, array $additionalTablesFetch = array(), $mode = null, $className=null) {
+	public function findObjects($mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, $className = null) {
 		// $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
 		if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
 			throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
@@ -1607,7 +1607,7 @@ 
 			throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
 		}
 
-		$mode = $mode?:$this->mode;
+		$mode = $mode ?: $this->mode;
 
 		return new ResultIterator($sql, $countSql, $parameters, $columnDescList, $this->objectStorage, $className, $this, $this->magicQuery, $mode);
 	}
@@ -1621,7 +1621,7 @@ 
 	 * @return AbstractTDBMObject
 	 * @throws TDBMException
 	 */
-	public function findObjectByPk($table, array $primaryKeys, array $additionalTablesFetch = array(), $lazy = false, $className=null) {
+	public function findObjectByPk($table, array $primaryKeys, array $additionalTablesFetch = array(), $lazy = false, $className = null) {
 		$primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
 		$hash = $this->getObjectHash($primaryKeys);
 
@@ -1641,7 +1641,7 @@ 
 			// Only allowed if no inheritance.
 			if (count($tables) === 1) {
 				if ($className === null) {
-					$className = isset($this->tableToBeanMap[$table])?$this->tableToBeanMap[$table]:"Mouf\\Database\\TDBM\\TDBMObject";
+					$className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : "Mouf\\Database\\TDBM\\TDBMObject";
 				}
 
 				// Let's construct the bean
@@ -1670,11 +1670,11 @@ 
 	 * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters.
 	 * @throws TDBMException
 	 */
-	public function findObject($mainTable, $filterString=null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null) {
+	public function findObject($mainTable, $filterString = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null) {
 		$objects = $this->findObjects($mainTable, $filterString, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
 		$page = $objects->take(0, 2);
 		$count = $page->count();
-		if ($count > 1) {
+		if ($count>1) {
 			throw new DuplicateRowException("Error while querying an object for table '$mainTable': More than 1 row have been returned, but we should have received at most one.");
 		} elseif ($count === 0) {
 			return null;
@@ -1694,7 +1694,7 @@ 
 	 * @return AbstractTDBMObject The object we want
 	 * @throws TDBMException
 	 */
-	public function findObjectOrFail($mainTable, $filterString=null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null) {
+	public function findObjectOrFail($mainTable, $filterString = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null) {
 		$bean = $this->findObject($mainTable, $filterString, $parameters, $additionalTablesFetch, $className);
 		if ($bean === null) {
 			throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");

src/Mouf/Database/TDBM/Utils/ScalarBeanPropertyDescriptor.php

Doc Comments +1 added lines, -2 removed lines

@@ -27,8 +27,7 @@
     /**
      * Returns the foreignkey the column is part of, if any. null otherwise.
      *
-     * @param Column $column
-     * @return ForeignKeyConstraint|null
+     * @return boolean
      */
     public function getForeignKey() {
         return false;