thecodingmachine / database.tdbm

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

Doc Comments +3 added lines

@@ -170,6 +170,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/TDBMObject.php

Doc Comments +8 added lines, -1 removed lines

@@ -238,6 +238,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $var
+	 */
 	public function __get($var) {
 		$this->_dbLoadIfNotLoaded();
 
@@ -290,6 +293,10 @@ 
 		return isset($this->db_row[$var]);
 	}
 	
+	/**
+	 * @param string $var
+	 * @param string|null $value
+	 */
 	public function __set($var, $value) {
 		$this->_dbLoadIfNotLoaded();
 
@@ -642,7 +649,7 @@ 
 	/**
 	 * Returns the tables used in the filter in an array.
 	 *
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function getUsedTables() {
 		return array($this->db_table_name);

src/Mouf/Database/TDBM/TDBMObjectArrayCursorIterator.php

Doc Comments +1 added lines, -1 removed lines

@@ -166,7 +166,7 @@
 	}
 	/**
 	 * Returns the current result's _id
-	 * @return string The current result's _id as a string.
+	 * @return integer The current result's _id as a string.
 	 */
 	public function key()
 	{

src/Mouf/Database/TDBM/TDBMService.php

Doc Comments +7 added lines, -7 removed lines

@@ -711,10 +711,10 @@ 
 	
 	/**
 	 * Returns a generator for the database.
-	 * @param unknown $result
+	 * @param \PDOStatement $result
 	 * @param unknown $table_name
-	 * @param unknown $className
-	 * @param unknown $sql
+	 * @param string $className
+	 * @param string $sql
 	 */
 	private function getObjectsFromSQLGenerator($result, $table_name, $className, $sql) {
 		$keysStandardCased = array();
@@ -1100,7 +1100,7 @@ 
 	 * @param unknown_type $target_tables
 	 * @param unknown_type $path
 	 * @param unknown_type $queue
-	 * @return unknown
+	 * @return boolean
 	 */
 	private function find_paths_iter(&$target_tables, &$path, &$queue) {
 		// Get table to look at:
@@ -1569,7 +1569,7 @@ 
 	 * Takes in input a filter_bag (which can be about anything from a string to an array of TDBMObjects... see above from documentation),
 	 * and gives back a proper Filter object.
 	 *
-	 * @param unknown_type $filter_bag
+	 * @param unknown_type|null $filter_bag
 	 * @return FilterInterface
 	 */
 	public function buildFilterFromFilterBag($filter_bag) {
@@ -1634,7 +1634,7 @@ 
 	 * Takes in input an order_bag (which can be about anything from a string to an array of OrderByColumn objects... see above from documentation),
 	 * and gives back an array of OrderByColumn / OrderBySQLString objects.
 	 *
-	 * @param unknown_type $orderby_bag
+	 * @param unknown_type|null $orderby_bag
 	 * @return array
 	 */
 	public function buildOrderArrayFromOrderBag($orderby_bag) {
@@ -1851,7 +1851,7 @@ 
 	 * @param bool $support If the generated daos should keep support for old functions (eg : getUserList and getList)
 	 * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone.
 	 * @param bool $castDatesToDateTime
-	 * @return \string[] the list of tables
+	 * @return string[] the list of tables
 	 */
 	public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $support, $storeInUtc, $castDatesToDateTime) {
 		$tdbmDaoGenerator = new TDBMDaoGenerator($this->dbConnection);

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

Doc Comments +14 added lines, -7 removed lines

@@ -56,7 +56,7 @@ 
 	 * @param bool $support If the generated daos should keep support for old functions (eg : getUserList and getList)
 	 * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone.
 	 * @param bool $castDatesToDateTime Whether dates are converted to DateTimeImmutable or to timestamp
-	 * @return \string[] the list of tables
+	 * @return string[] the list of tables
 	 * @throws TDBMException
 	 */
 	public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $support, $storeInUtc, $castDatesToDateTime) {
@@ -84,7 +84,12 @@ 
 	/**
 	 * Generates in one method call the daos and the beans for one table.
 	 * 
-	 * @param $tableName
+	 * @param string $tableName
+	 * @param string $daonamespace
+	 * @param string $beannamespace
+	 * @param boolean $support
+	 * @param boolean $storeInUtc
+	 * @param boolean $castDatesToDateTime
 	 */
 	public function generateDaoAndBean($tableName, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $support, $storeInUtc, $castDatesToDateTime) {
 		$daoName = $this->getDaoNameFromTableName($tableName);
@@ -412,9 +417,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 $baseClassName
+	 * @param string $beanClassName
 	 */
 	public function generateDao($className, $baseClassName, $beanClassName, $tableName, ClassNameMapper $classNameMapper, $support) {
 		$info = $this->dbConnection->getTableInfo($tableName);
@@ -702,7 +708,9 @@ 
 	/**
 	 * Generates the factory bean.
 	 * 
-	 * @param $tableList
+	 * @param string[] $tableList
+	 * @param string $daoFactoryClassName
+	 * @param string $daoNamespace
 	 */
 	private function generateFactory($tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) {
 		// For each table, let's write a property.
@@ -774,7 +782,6 @@ 
 	 * Transforms the property name in a setter name.
 	 * For instance, phone => getPhone or name => getName
 	 *
-	 * @param string $methodName
 	 * @return string
 	 */
 	public static function getSetterNameForPropertyName($propertyName) {
@@ -854,7 +861,7 @@ 
 	 * Tries to put string to the singular form (if it is plural).
 	 * Obviously, this can't be perfect, be we do the best we can.
 	 * 
-	 * @param $str string
+	 * @param string $str string
 	 * @return string
 	 */
 	public static function toSingular($str) {
@@ -875,7 +882,7 @@ 
 	 * Put the first letter of the string in lower case.
 	 * Very useful to transform a class name into a variable name.
 	 * 
-	 * @param $str string
+	 * @param string $str string
 	 * @return string
 	 */
 	public static function toVariableName($str) {