thecodingmachine / database.tdbm

src/Mouf/Database/TDBM/AmbiguityException.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/Controllers/TdbmInstallController.php

Doc Comments +4 added lines, -2 removed lines

@@ -136,8 +136,7 @@ 
 	 * This action generates the TDBM instance, then the DAOs and Beans. 
 	 * 
 	 * @Action
-	 * @param string $name
-	 * @param bool $selfedit
+	 * @param string|boolean $selfedit
 	 */
 	public function generate($sourcedirectory, $daonamespace, $beannamespace, $keepSupport = 0, $storeInUtc = 0, $selfedit="false") {
 		$this->selfedit = $selfedit;
@@ -163,6 +162,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/Filters/AndFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
 	 * Default constructor to build the filter.
 	 * All parameters are optional and can later be set using the setters.
 	 * 
-	 * @param array<FilterInterface> $filter
+	 * @param array<FilterInterface> $filters
 	 */
 	public function __construct($filters=null) {
 		$this->filters = $filters;

src/Mouf/Database/TDBM/Filters/BetweenFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
 	 * 
 	 * @param string $tableName
 	 * @param string $columnName
-	 * @param string $value
+	 * @param string $value1
 	 */
 	public function __construct($tableName=null, $columnName=null, $value1=null, $value2=null) {
 		$this->tableName = $tableName;

src/Mouf/Database/TDBM/Filters/OrderByColumn.php

Doc Comments -1 removed lines

@@ -84,7 +84,6 @@
 	 * 
 	 * @param string $tableName
 	 * @param string $columnName
-	 * @param string $value
 	 */
 	public function __construct($tableName=null, $columnName=null, $order=null) {
 		$this->tableName = $tableName;

src/Mouf/Database/TDBM/Filters/OrFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
 	 * Default constructor to build the filter.
 	 * All parameters are optional and can later be set using the setters.
 	 * 
-	 * @param array<FilterInterface> $filter
+	 * @param array<FilterInterface> $filters
 	 */
 	public function __construct($filters=null) {
 		$this->filters = $filters;

src/Mouf/Database/TDBM/TDBMObject.php

Doc Comments +9 added lines, -2 removed lines

@@ -145,7 +145,7 @@ 
 	 * false if an explicit call to save() is required.
 	 *
 	 * @param unknown_type $autoSave
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function setAutoSaveMode($autoSave) {
 		$this->db_autosave = $autoSave;
@@ -255,6 +255,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $var
+	 */
 	public function __get($var) {
 		$this->_dbLoadIfNotLoaded();
 
@@ -307,6 +310,10 @@ 
 		return isset($this->db_row[$var]);
 	}
 	
+	/**
+	 * @param string $var
+	 * @param string|null $value
+	 */
 	public function __set($var, $value) {
 		$this->_dbLoadIfNotLoaded();
 
@@ -525,7 +532,7 @@ 
 	 *
 	 * @param unknown_type $func_name
 	 * @param unknown_type $values
-	 * @return unknown
+	 * @return TDBMObjectArray
 	 */
 	public function __call($func_name, $values) {
 

src/Mouf/Database/TDBM/TDBMObjectArray.php

Doc Comments +6 added lines

@@ -84,6 +84,9 @@ 
 
 	}
 
+	/**
+	 * @param string $column
+	 */
 	private function getarray($column) {
 		$arr = array();
 		foreach ($this as $object) {
@@ -92,6 +95,9 @@ 
 		return $arr;
 	}
 
+	/**
+	 * @param string $column
+	 */
 	private function setarray($column, $value) {
 		foreach ($this as $object) {
 			$object->__set($column, $value);

src/Mouf/Database/TDBM/TDBMService.php

Doc Comments +7 added lines, -5 removed lines

@@ -962,7 +962,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:
@@ -1184,7 +1184,7 @@ 
 	 * @param unknown_type $table_name The name of the table queried
 	 * @param unknown_type $filter_bag The filter bag (see getObjects for complete description)
 	 * @param unknown_type $hint_path
-	 * @return integer
+	 * @return TDBMObjectArray
 	 */
 	public function getCount($table_name, $filter_bag=null, $hint_path=null) {
 		if ($this->dbConnection == null) {
@@ -1202,7 +1202,7 @@ 
 	 * @param integer $from The offset
 	 * @param integer $limit The maximum number of rows returned
 	 * @param unknown_type $hint_path Hints to get the path for the query (expert parameter, you should leave it to null).
-	 * @return string The SQL that would be executed.
+	 * @return TDBMObjectArray The SQL that would be executed.
 	 */
 	public function explainSQLGetObjects($table_name, $filter_bag=null, $orderby_bag=null, $from=null, $limit=null, $hint_path=null) 	{
 		if ($this->dbConnection == null) {
@@ -1461,7 +1461,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) {
@@ -1546,7 +1546,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) {
@@ -1661,6 +1661,8 @@ 
 	 * This function returns the HTML to draw a tree of DisplayNode.
 	 *
 	 * @param unknown_type $tree
+	 * @param integer $x
+	 * @param integer $y
 	 */
 	public function drawTree($tree, $x, $y, &$ret_width=0, &$ret_height=0) {