phpMv / ubiquity

Ubiquity/controllers/rest/RestServer.php

Doc Comments +5 added lines

@@ -74,6 +74,11 @@
 		}
 	}
 
+	/**
+	 * @param string $header
+	 *
+	 * @return string
+	 */
 	public function _getHeader($header){
 		$headers=getallheaders();
 		if(isset($headers[$header])){

Ubiquity/utils/yuml/ClassToYuml.php

Doc Comments +3 added lines

@@ -122,6 +122,9 @@
 		return $this->_getYumlRelationsType($this->oneToManys,"1-0..*");
 	}
 
+	/**
+	 * @param string $branche
+	 */
 	protected function _getYumlRelationsType($relations,$branche){
 		$myClass=$this->getShortClassName($this->class);
 		$yumlRelations=[];

Unused Use Statements -2 removed lines

@@ -3,8 +3,6 @@
 namespace Ubiquity\utils\yuml;
 
 use Ubiquity\orm\OrmUtils;
-use Ubiquity\orm\parser\Reflexion;
-use Ubiquity\utils\StrUtils;
 
 /**
  * @author jc

Ubiquity/cache/parser/ControllerParser.php

Doc Comments +10 added lines

@@ -73,6 +73,9 @@ 
 		return "/" . \implode("/", $pathParts);
 	}
 
+	/**
+	 * @param string $prefix
+	 */
 	private static function cleanpath($prefix, $path="") {
 		if (!StrUtils::endswith($prefix, "/"))
 			$prefix=$prefix . "/";
@@ -154,6 +157,10 @@ 
 		return [ "path" => $path,"parameters" => $parameters ];
 	}
 
+	/**
+	 * @param integer $index
+	 * @param string $paramMatch
+	 */
 	private static function scanParam(&$parameters, &$hasOptional, $matches, $index, $paramMatch, $find, &$path) {
 		if (isset($matches[1][$index])) {
 			if ($matches[1][$index] === "...") {
@@ -173,6 +180,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $path
+	 */
 	private static function createRouteMethod(&$result, $controllerClass, $path, $httpMethods, $method, $parameters, $name, $cache, $duration) {
 		foreach ( $httpMethods as $httpMethod ) {
 			$result[$path][$httpMethod]=[ "controller" => $controllerClass,"action" => $method,"parameters" => $parameters,"name" => $name,"cache" => $cache,"duration" => $duration ];

Ubiquity/controllers/Startup.php

Doc Comments +3 added lines

@@ -144,6 +144,9 @@
 		self::$config=$config;
 	}
 
+	/**
+	 * @param string[] $needs
+	 */
 	private static function needsKeyInConfigArray(&$result, $array, $needs) {
 		foreach ( $needs as $need ) {
 			if (!isset($array[$need]) || StrUtils::isNull($array[$need])) {

Ubiquity/orm/creator/yuml/YumlParser.php

Doc Comments +3 added lines

@@ -55,6 +55,9 @@
 		}
 	}
 
+	/**
+	 * @param string $propertiesString
+	 */
 	private function parseProperties($propertiesString,$table){
 		$properties=\explode(";", $propertiesString);
 		foreach ($properties as $property){

Ubiquity/orm/DAO.php

Doc Comments +12 added lines, -1 removed lines

@@ -106,6 +106,10 @@ 
 		return $ret;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $part
+	 */
 	private static function setToMember($member, $instance, $value, $class, $part) {
 		$accessor="set" . ucfirst($member);
 		if (method_exists($instance, $accessor)) {
@@ -157,6 +161,10 @@ 
 		}
 	}
 
+	/**
+	 * @param string $class
+	 * @param ManyToManyParser $parser
+	 */
 	private static function getManyToManyFromArray(&$ret, $instance, $array, $class, $parser) {
 		$continue=true;
 		$accessorToMember="get" . ucfirst($parser->getInversedBy());
@@ -229,6 +237,9 @@ 
 		return $objects;
 	}
 
+	/**
+	 * @param \Closure $affectsCallback
+	 */
 	private static function _affectsObjectsFromArray($queries,$objects,$affectsCallback,$useCache=NULL){
 		foreach ($queries as $key=>$conditions){
 			list($class,$member,$fkField)=\explode("|", $key);
@@ -328,7 +339,7 @@ 
 	 * Returns the number of objects of $className from the database respecting the condition possibly passed as parameter
 	 * @param string $className complete classname of the model to load
 	 * @param string $condition Part following the WHERE of an SQL statement
-	 * @return int count of objects
+	 * @return string count of objects
 	 */
 	public static function count($className, $condition='') {
 		$tableName=OrmUtils::getTableName($className);

Ubiquity/controllers/Router.php

Doc Comments +15 added lines

@@ -15,6 +15,9 @@ 
 class Router {
 	private static $routes;
 
+	/**
+	 * @return string
+	 */
 	public static function slashPath($path){
 		if(StrUtils::startswith($path,"/")===false)
 			$path="/" . $path;
@@ -123,6 +126,9 @@ 
 		return RequestUtils::getUrl(self::getRouteByName($name,$parameters,false));
 	}
 
+	/**
+	 * @return string
+	 */
 	protected static function _getURL($routePath,$params){
 		$result= \preg_replace_callback('~\((.*?)\)~', function($matches) use (&$params) {
 			return array_shift($params);
@@ -133,6 +139,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected static function checkRouteName($routeDetails,$name){
 		if(!isset($routeDetails["name"])){
 			foreach ($routeDetails as $methodRouteDetail){
@@ -143,6 +152,9 @@ 
 		return isset($routeDetails["name"]) && $routeDetails["name"] == $name;
 	}
 
+	/**
+	 * @param string[] $params
+	 */
 	public static function getRouteUrlParts($routeArray, $params, $cached=false, $duration=NULL,$cachedResponse=true) {
 		$params=\array_slice($params, 1);
 		$ctrl=str_replace("\\\\", "\\", $routeArray["details"]["controller"]);
@@ -201,6 +213,9 @@ 
 		self::addRouteToRoutes(self::$routes, $path, $controller, $action, $methods, $name, $cache, $duration);
 	}
 
+	/**
+	 * @param integer $duration
+	 */
 	public static function addRouteToRoutes(&$routesArray, $path, $controller, $action="index", $methods=null, $name="", $cache=false, $duration=null) {
 		$result=[ ];
 		if(\class_exists($controller)){