thecodingmachine / database.tdbm

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/Controllers/TdbmInstallController.php

Doc Comments +3 added lines, -2 removed lines

@@ -144,9 +144,7 @@ 
      *
      * @param string $daonamespace
      * @param string $beannamespace
-     * @param int    $keepSupport
      * @param int    $storeInUtc
-     * @param int    $castDatesToDateTime
      * @param string $selfedit
      *
      * @throws \Mouf\MoufException
@@ -183,6 +181,9 @@ 
 
     protected $errorMsg;
 
+    /**
+     * @param string $msg
+     */
     private function displayErrorMsg($msg)
     {
         $this->errorMsg = $msg;

src/Mouf/Database/TDBM/PageIterator.php

Doc Comments +4 added lines, -1 removed lines

@@ -60,6 +60,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/ResultIterator.php

Doc Comments +8 added lines

@@ -66,6 +66,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;
@@ -147,6 +154,7 @@ 
 
     /**
      * @param int $offset
+     * @param integer $limit
      *
      * @return PageIterator
      */

src/Mouf/Database/TDBM/TDBMService.php

Doc Comments +3 added lines, -3 removed lines

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

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

Doc Comments +10 added lines, -5 removed lines

@@ -43,7 +43,6 @@ 
     /**
      * Constructor.
      *
-     * @param Connection $dbConnection The connection to the database.
      */
     public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
     {
@@ -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)
     {
@@ -140,7 +142,7 @@ 
     /**
      * Returns the name of the base bean class from the table name.
      *
-     * @param $tableName
+     * @param string $tableName
      *
      * @return string
      */
@@ -152,7 +154,7 @@ 
     /**
      * Returns the name of the base DAO class from the table name.
      *
-     * @param $tableName
+     * @param string $tableName
      *
      * @return string
      */
@@ -223,9 +225,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)
     {
@@ -468,6 +471,8 @@ 
      * Generates the factory bean.
      *
      * @param Table[] $tableList
+     * @param string $daoFactoryClassName
+     * @param string $daoNamespace
      */
     private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
     {