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 +15 added lines, -15 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];
@@ -422,13 +422,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]);
 	}
 
 	/**
@@ -516,23 +516,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;
 	}
@@ -540,7 +540,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;
@@ -567,7 +567,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 +5 added lines, -5 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."\".");
 			}
@@ -326,7 +326,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;
@@ -358,7 +358,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/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/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/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;

src/views/installStep2.php

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
 <div class="control-group">
 	<label class="control-label">Store dates / timestamps in UTC:</label>
 	<div class="controls">
-		<input type="checkbox" name="storeInUtc" value="1" <?php echo $this->storeInUtc?'checked="checked"':"" ?>></input>
+		<input type="checkbox" name="storeInUtc" value="1" <?php echo $this->storeInUtc ? 'checked="checked"' : "" ?>></input>
 		<span class="help-block">Select this option if you want timestamps to be stored in UTC.
 		If your application supports several time zones, you should select this option to store all dates in
 		the same time zone.</span>

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

Spacing +2 added lines, -2 removed lines

@@ -62,7 +62,7 @@ 
     public function getUpperCamelCaseName() {
         // First, are there many column or only one?
         // If one column, we name the setter after it. Otherwise, we name the setter after the table name
-        if (count($this->foreignKey->getLocalColumns()) > 1) {
+        if (count($this->foreignKey->getLocalColumns())>1) {
             $name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName()));
             if ($this->alternativeName) {
                 $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns());
@@ -144,7 +144,7 @@ 
      * @param '.$referencedBeanName.' $object
      */
     public function '.$setterName.'('.$referencedBeanName.' $object = null) {
-        $this->setRef(' . var_export($this->foreignKey->getName(), true) . ', $object, '.var_export($tableName, true).');
+        $this->setRef(' . var_export($this->foreignKey->getName(), true).', $object, '.var_export($tableName, true).');
     }
 
 ';

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

Spacing +13 added lines, -13 removed lines

@@ -206,7 +206,7 @@ 
 
 }";
             $this->ensureDirectoryExist($possibleFileName);
-            file_put_contents($possibleFileName ,$str);
+            file_put_contents($possibleFileName, $str);
             @chmod($possibleFileName, 0664);
         }
     }
@@ -226,11 +226,11 @@ 
         foreach ($table->getColumns() as $column) {
             $comments = $column->getComment();
             $matches = array();
-            if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0){
+            if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) {
                 $defaultSort = $data['column_name'];
-                if (count($matches == 3)){
+                if (count($matches == 3)) {
                     $defaultSortDirection = $matches[2];
-                }else{
+                } else {
                     $defaultSortDirection = 'ASC';
                 }
             }
@@ -416,7 +416,7 @@ 
         $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
 
         $this->ensureDirectoryExist($possibleBaseFileName);
-        file_put_contents($possibleBaseFileName ,$str);
+        file_put_contents($possibleBaseFileName, $str);
         @chmod($possibleBaseFileName, 0664);
 
         $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace."\\".$className);
@@ -447,7 +447,7 @@ 
 }
 ";
             $this->ensureDirectoryExist($possibleFileName);
-            file_put_contents($possibleFileName ,$str);
+            file_put_contents($possibleFileName, $str);
             @chmod($possibleFileName, 0664);
         }
     }
@@ -523,7 +523,7 @@ 
         $possibleFileName = $this->rootPath.$possibleFileNames[0];
 
         $this->ensureDirectoryExist($possibleFileName);
-        file_put_contents($possibleFileName ,$str);
+        file_put_contents($possibleFileName, $str);
     }
 
     /**
@@ -534,7 +534,7 @@ 
      * @return string
      */
     public static function toCamelCase($str) {
-        $str = strtoupper(substr($str,0,1)).substr($str,1);
+        $str = strtoupper(substr($str, 0, 1)).substr($str, 1);
         while (true) {
             if (strpos($str, "_") === false && strpos($str, " ") === false) {
                 break;
@@ -544,9 +544,9 @@ 
             if ($pos === false) {
                 $pos = strpos($str, " ");
             }
-            $before = substr($str,0,$pos);
-            $after = substr($str,$pos+1);
-            $str = $before.strtoupper(substr($after,0,1)).substr($after,1);
+            $before = substr($str, 0, $pos);
+            $after = substr($str, $pos+1);
+            $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
         }
         return $str;
     }
@@ -627,7 +627,7 @@ 
             Type::GUID => 'string'
         ];
 
-        return isset($map[$type->getName()])?$map[$type->getName()]:$type->getName();
+        return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName();
     }
 
     /**
@@ -642,7 +642,7 @@ 
 
         foreach ($tables as $table) {
             $tableName = $table->getName();
-            $tableToBeanMap[$tableName] = $beanNamespace . "\\" . self::getBeanNameFromTableName($tableName);
+            $tableToBeanMap[$tableName] = $beanNamespace."\\".self::getBeanNameFromTableName($tableName);
         }
         return $tableToBeanMap;
     }

Doc Comments +10 added lines, -5 removed lines

@@ -47,7 +47,6 @@ 
     /**
      * Constructor.
      *
-     * @param Connection $dbConnection The connection to the database.
      */
     public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) {
         $this->schemaAnalyzer = $schemaAnalyzer;
@@ -100,6 +99,9 @@ 
      * Generates in one method call the daos and the beans for one table.
      * 
      * @param $tableName
+     * @param string $daonamespace
+     * @param string $beannamespace
+     * @param boolean $storeInUtc
      */
     public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) {
 		$tableName = $table->getName();
@@ -135,7 +137,7 @@ 
     /**
      * Returns the name of the base bean class from the table name.
      * 
-     * @param $tableName
+     * @param string $tableName
      * @return string
      */
     public static function getBaseBeanNameFromTableName($tableName) {
@@ -145,7 +147,7 @@ 
     /**
      * Returns the name of the base DAO class from the table name.
      *
-     * @param $tableName
+     * @param string $tableName
      * @return string
      */
     public static function getBaseDaoNameFromTableName($tableName) {
@@ -215,9 +217,10 @@ 
     /**
      * Writes the PHP bean DAO with simple functions to create/get/save objects.
      *
-     * @param string $fileName The file that will be written (without the directory)
      * @param string $className The name of the class
-     * @param string $tableName The name of the table
+     * @param string $table The name of the table
+     * @param string $baseClassName
+     * @param string $beanClassName
      */
     public function generateDao($className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) {
         $tableName = $table->getName();
@@ -461,6 +464,8 @@ 
      * Generates the factory bean.
      * 
      * @param Table[] $tableList
+     * @param string $daoFactoryClassName
+     * @param string $daoNamespace
      */
     private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) {
         // For each table, let's write a property.