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);

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);

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);

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()
 	{

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);

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/Mouf/Database/TDBM/Utils/TDBMDaoGenerator.php

Doc Comments +11 added lines, -6 removed lines

@@ -46,7 +46,6 @@ 
     /**
      * Constructor.
      *
-     * @param Connection $dbConnection The connection to the database.
      */
     public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) {
         $this->schemaAnalyzer = $schemaAnalyzer;
@@ -99,6 +98,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();
@@ -134,7 +136,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) {
@@ -144,7 +146,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) {
@@ -156,7 +158,7 @@ 
      *
      * @param string $className The name of the class
      * @param string $baseClassName The name of the base class which will be extended (name only, no directory)
-     * @param string $tableName The name of the table
+     * @param string $table The name of the table
      * @param string $beannamespace The namespace of the bean
      * @param ClassNameMapper $classNameMapper
      * @throws TDBMException
@@ -214,9 +216,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();
@@ -458,6 +461,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.

Braces +1 added lines, -1 removed lines

@@ -230,7 +230,7 @@
                 $defaultSort = $data['column_name'];
                 if (count($matches == 3)){
                     $defaultSortDirection = $matches[2];
-                }else{
+                } else{
                     $defaultSortDirection = 'ASC';
                 }
             }

src/Mouf/Database/TDBM/TDBMService.php

Braces +8 added lines, -6 removed lines

@@ -441,10 +441,11 @@ 
 			/*$data =*/ $this->connection->getTableInfo($table_name);
 		} catch (TDBMException $exception) {
 			$probable_table_name = $this->connection->checkTableExist($table_name);
-			if ($probable_table_name == null)
-			throw new TDBMException("Error while calling TDBMObject::getNewObject(): The table named '$table_name' does not exist.");
-			else
-			throw new TDBMException("Error while calling TDBMObject::getNewObject(): The table named '$table_name' does not exist. Maybe you meant the table '$probable_table_name'.");
+			if ($probable_table_name == null) {
+						throw new TDBMException("Error while calling TDBMObject::getNewObject(): The table named '$table_name' does not exist.");
+			} else {
+						throw new TDBMException("Error while calling TDBMObject::getNewObject(): The table named '$table_name' does not exist. Maybe you meant the table '$probable_table_name'.");
+			}
 		}
 
 		if ($className === null) {
@@ -886,8 +887,9 @@ 
 		// Fourth, let's apply the same steps to the orderby_bag
 		// 4-1 orderby_bag should be an array, if it is a singleton, let's put it in an array.
 
-		if (!is_array($orderby_bag))
-		$orderby_bag = array($orderby_bag);
+		if (!is_array($orderby_bag)) {
+				$orderby_bag = array($orderby_bag);
+		}
 
 		// 4-2, let's take all the objects out of the orderby bag, and let's make objects from them
 		$orderby_bag2 = array();

Doc Comments +3 added lines, -3 removed lines

@@ -985,7 +985,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;
@@ -1621,7 +1621,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.
@@ -1778,7 +1778,7 @@ 
 	/**
 	 * @param $pivotTableName
 	 * @param AbstractTDBMObject $bean
-	 * @return AbstractTDBMObject[]
+	 * @return ResultIterator
 	 */
 	public function _getRelatedBeans($pivotTableName, AbstractTDBMObject $bean) {
 

src/Mouf/Database/TDBM/ResultIterator.php

Doc Comments +8 added lines

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