phpMv / ubiquity

Ubiquity/db/Database.php

Doc Comments +11 added lines, -1 removed lines

@@ -36,6 +36,7 @@ 
 	 * @param string $password
 	 * @param array $options
 	 * @param boolean|string $cache
+	 * @param string $dbType
 	 */
 	public function __construct($dbType, $dbName, $serverName = "localhost", $port = "3306", $user = "root", $password = "", $options = [], $cache = false) {
 		$this->dbType = $dbType;
@@ -122,6 +123,9 @@ 
 		return $result;
 	}
 	
+	/**
+	 * @param string $sql
+	 */
 	public function prepareAndFetchAll($sql,$parameters=null){
 		$result=false;
 		$statement=$this->getStatement($sql);
@@ -144,6 +148,9 @@ 
 		return $result;
 	}
 	
+	/**
+	 * @param string $sql
+	 */
 	public function prepareAndFetchColumn($sql,$parameters=null,$column=null){
 		$statement=$this->getStatement($sql);
 		if($statement->execute ($parameters)){
@@ -209,7 +216,7 @@ 
 	/**
 	 * Returns the last insert id
 	 *
-	 * @return integer
+	 * @return string
 	 */
 	public function lastInserId() {
 		return $this->pdoObject->lastInsertId ();
@@ -234,6 +241,9 @@ 
 		return $this->query ( "SELECT COUNT(*) FROM " . $tableName . $condition )->fetchColumn ();
 	}
 	
+	/**
+	 * @param string $query
+	 */
 	public function queryColumn($query){
 		return $this->query ( $query )->fetchColumn ();
 	}

Ubiquity/orm/DAO.php

Doc Comments +20 added lines, -4 removed lines

@@ -31,7 +31,7 @@ 
 	 * Loads member associated with $instance by a ManyToOne relationship
 	 * @param object $instance
 	 * @param string $member
-	 * @param boolean|array $included if true, loads associate members with associations, if array, example : ["client.*","commands"]
+	 * @param boolean $included if true, loads associate members with associations, if array, example : ["client.*","commands"]
 	 * @param boolean $useCache
 	 */
 	public static function getManyToOne($instance, $member, $included=false,$useCache=NULL) {
@@ -115,6 +115,11 @@ 
 		return $ret;
 	}
 
+	/**
+	 * @param string $member
+	 * @param string $class
+	 * @param string $part
+	 */
 	private static function setToMember($member, $instance, $value, $class, $part) {
 		$accessor="set" . ucfirst($member);
 		if (method_exists($instance, $accessor)) {
@@ -167,6 +172,10 @@ 
 		}
 	}
 
+	/**
+	 * @param string $class
+	 * @param ManyToManyParser $parser
+	 */
 	private static function getManyToManyFromArray($instance, $array, $class, $parser) {
 		$ret=[];
 		$continue=true;
@@ -200,7 +209,7 @@ 
 	 * @param string $className class name of the model to load
 	 * @param string $condition Part following the WHERE of an SQL statement
 	 * @param boolean|array $included if true, loads associate members with associations, if array, example : ["client.*","commands"]
-	 * @param array|null $parameters
+	 * @param boolean $parameters
 	 * @param boolean $useCache use the active cache if true
 	 * @return array
 	 */
@@ -208,6 +217,10 @@ 
 		return self::_getAll($className, new ConditionParser($condition,null,$parameters),$included,$useCache);
 	}
 	
+	/**
+	 * @param string $className
+	 * @param boolean|null $useCache
+	 */
 	protected static function _getOne($className,ConditionParser $conditionParser,$included,$useCache){
 		$conditionParser->limitOne();
 		$retour=self::_getAll($className, $conditionParser, $included,$useCache);
@@ -257,6 +270,9 @@ 
 		return $objects;
 	}
 	
+	/**
+	 * @param string $condition
+	 */
 	public static function paginate($className,$page=1,$rowsPerPage=20,$condition=null,$included=true){
 		if(!isset($condition)){
 			$condition="1=1";
@@ -319,7 +335,7 @@ 
 	 * @param string $className complete classname of the model to load
 	 * @param string $condition Part following the WHERE of an SQL statement
 	 * @param array|null $parameters The query parameters
-	 * @return int count of objects
+	 * @return string|false count of objects
 	 */
 	public static function count($className, $condition='',$parameters=null) {
 		$tableName=OrmUtils::getTableName($className);
@@ -333,7 +349,7 @@ 
 	 * @param String $className complete classname of the model to load
 	 * @param Array|string $keyValues primary key values or condition
 	 * @param boolean|array $included if true, charges associate members with association
-	 * @param array|null $parameters the request parameters
+	 * @param boolean|null $parameters the request parameters
 	 * @param boolean $useCache use cache if true
 	 * @return object the instance loaded or null if not found
 	 */

Ubiquity/orm/traits/DAOUQueries.php

Doc Comments +13 added lines, -1 removed lines

@@ -13,9 +13,21 @@ 
 	
 	protected static $annotFieldsInRelations=[];
 	
+	/**
+	 * @param string $className
+	 * @param boolean $useCache
+	 */
 	abstract protected static function _getAll($className, ConditionParser $conditionParser, $included=true,$useCache=NULL);
+
+	/**
+	 * @param string $className
+	 * @param boolean|null $useCache
+	 */
 	abstract protected static function _getOne($className,ConditionParser $conditionParser,$included,$useCache);
 	
+	/**
+	 * @param string $className
+	 */
 	protected static function uParse($className,&$ucondition){
 		$expressions=self::uGetExpressions($ucondition);
 		$condition="";
@@ -62,7 +74,7 @@ 
 	/**
 	 * Returns an array of $className objects from the database
 	 * @param string $className class name of the model to load
-	 * @param string $condition UQL condition
+	 * @param string $ucondition UQL condition
 	 * @param boolean|array $included if true, loads associate members with associations, if array, example : ["client.*","commands"]
 	 * @param array|null $parameters the request parameters
 	 * @param boolean $useCache use the active cache if true