phpMv / ubiquity

micro/cache/CacheManager.php

Doc Comments +32 added lines

@@ -57,6 +57,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function expired($key, $duration) {
 		return self::$cache->expired("controllers/" . $key, $duration) === true || \array_key_exists($key, self::$expiredRoutes);
 	}
@@ -69,6 +72,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $routePath
+	 */
 	public static function setExpired($routePath, $expired=true) {
 		$key=self::getRouteKey($routePath);
 		self::setKeyExpired($key, $expired);
@@ -88,6 +94,10 @@ 
 		return self::storeRouteResponse($key, $response);
 	}
 
+	/**
+	 * @param string $key
+	 * @param string $response
+	 */
 	private static function storeRouteResponse($key, $response) {
 		self::setKeyExpired($key, false);
 		self::$cache->store("controllers/" . $key, $response, false);
@@ -123,6 +133,9 @@ 
 		}
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function getModelCacheKey($classname){
 		return \str_replace("\\", DIRECTORY_SEPARATOR, $classname);
 	}
@@ -134,6 +147,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $classname
+	 */
 	private static function addControllerCache($classname) {
 		$parser=new ControllerParser();
 		try {
@@ -167,6 +183,9 @@ 
 		return [ "annotations" => $annotationCacheDir,"models" => $modelsCacheDir,"controllers" => $controllersCacheDir,"queries" => $queriesCacheDir ,"views"=>$viewsCacheDir];
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	private static function safeMkdir($dir) {
 		if (!is_dir($dir))
 			return mkdir($dir, 0777, true);
@@ -180,6 +199,10 @@ 
 		}
 	}
 
+	/**
+	 * @param string $type
+	 * @param string $typeRef
+	 */
 	private static function _clearCache($cacheDirectories,$type,$typeRef){
 		if ($type === "all" || $type === $typeRef)
 			FsUtils::deleteAllFilesFromFolder($cacheDirectories[$typeRef]);
@@ -216,6 +239,9 @@ 
 		return self::_getFiles($config, "controllers",$silent);
 	}
 
+	/**
+	 * @param string $type
+	 */
 	private static function _getFiles(&$config,$type,$silent=false){
 		$typeNS=$config["mvcNS"][$type];
 		$typeDir=ROOT . DS . str_replace("\\", DS, $typeNS);
@@ -280,6 +306,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $controllerClass
+	 */
 	public static function getRestResource($controllerClass){
 		$cache=self::getRestCache();
 		if(isset($cache[$controllerClass])){
@@ -288,6 +317,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $controllerClass
+	 */
 	public static function getRestCacheController($controllerClass){
 		$cache=self::getRestCache();
 		if(isset($cache[$controllerClass])){

micro/cache/parser/ControllerParser.php

Doc Comments +6 added lines

@@ -67,6 +67,9 @@ 
 		return "/".\implode("/", $pathParts);
 	}
 
+	/**
+	 * @param string $prefix
+	 */
 	private static function cleanpath($prefix, $path="") {
 		if (!StrUtils::endswith($prefix, "/"))
 			$prefix=$prefix . "/";
@@ -163,6 +166,9 @@ 
 		return [ "path" => $path,"parameters" => $parameters ];
 	}
 
+	/**
+	 * @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 ];

micro/controllers/rest/ApiTokens.php

Doc Comments +3 added lines, -3 removed lines

@@ -78,9 +78,9 @@
 	}
 
 	/**
-	 * @param string $name
-	 * @param number $length
-	 * @param number $duration
+	 * @param integer $length
+	 * @param integer $duration
+	 * @param string $folder
 	 * @return ApiTokens
 	 */
 	public static function getFromCache($folder,$key="_apiTokens",$length=78,$duration=3600){

micro/controllers/rest/RestController.php

Doc Comments +3 added lines

@@ -79,6 +79,9 @@
 		echo $this->responseFormatter->formatException($e);
 	}
 
+	/**
+	 * @param integer $value
+	 */
 	public function _setResponseCode($value){
 		\http_response_code($value);
 	}

micro/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])){

micro/utils/yuml/ClassesToYuml.php

Doc Comments -5 removed lines

@@ -22,11 +22,6 @@
 		$this->displayPropertiesTypes=$displayPropertiesTypes;
 	}
 	/**
-	 * @param boolean $displayProperties
-	 * @param boolean $displayAssociations
-	 * @param boolean $displayMethods
-	 * @param boolean $displayMethodsParams
-	 * @param boolean $displayPropertiesTypes
 	 * @return ClassParser[]|string[]
 	 */
 	public function parse(){

micro/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 micro\utils\yuml;
 
 use micro\orm\OrmUtils;
-use micro\orm\parser\Reflexion;
-use micro\utils\StrUtils;
 
 /**
  * @author jc