phpMv / ubiquity

micro/addendum/annotations.php

Doc Comments +30 added lines

@@ -46,6 +46,9 @@ 
 			unset(self::$creationStack[$class]);
 		}
 
+		/**
+		 * @param boolean $target
+		 */
 		private function checkTargetConstraints($target) {
 			$reflection = new ReflectionAnnotatedClass($this);
 			if($reflection->hasAnnotation('Target')) {
@@ -75,6 +78,9 @@ 
 			}
 		}
 
+		/**
+		 * @param boolean $target
+		 */
 		protected function checkConstraints($target) {}
 	}
 
@@ -180,6 +186,9 @@ 
 			$this->annotations = $this->createAnnotationBuilder()->build($this);
 		}
 
+		/**
+		 * @param string $class
+		 */
 		public function hasAnnotation($class) {
 			return $this->annotations->hasAnnotation($class);
 		}
@@ -200,6 +209,9 @@ 
 			return $this->createReflectionAnnotatedMethod(parent::getConstructor());
 		}
 
+		/**
+		 * @param string $name
+		 */
 		public function getMethod($name) {
 			return $this->createReflectionAnnotatedMethod(parent::getMethod($name));
 		}
@@ -212,6 +224,9 @@ 
 			return $result;
 		}
 
+		/**
+		 * @param string $name
+		 */
 		public function getProperty($name) {
 			return $this->createReflectionAnnotatedProperty(parent::getProperty($name));
 		}
@@ -249,6 +264,9 @@ 
 			return ($method !== null) ? new ReflectionAnnotatedMethod($this->getName(), $method->getName()) : null;
 		}
 
+		/**
+		 * @param ReflectionProperty $property
+		 */
 		private function createReflectionAnnotatedProperty($property) {
 			return ($property !== null) ? new ReflectionAnnotatedProperty($this->getName(), $property->getName()) : null;
 		}
@@ -257,15 +275,24 @@ 
 	class ReflectionAnnotatedMethod extends ReflectionMethod {
 		private $annotations;
 
+		/**
+		 * @param string $class
+		 */
 		public function __construct($class, $name) {
 			parent::__construct($class, $name);
 			$this->annotations = $this->createAnnotationBuilder()->build($this);
 		}
 
+		/**
+		 * @param string $class
+		 */
 		public function hasAnnotation($class) {
 			return $this->annotations->hasAnnotation($class);
 		}
 
+		/**
+		 * @param string $annotation
+		 */
 		public function getAnnotation($annotation) {
 			return $this->annotations->getAnnotation($annotation);
 		}
@@ -296,6 +323,9 @@ 
 			$this->annotations = $this->createAnnotationBuilder()->build($this);
 		}
 
+		/**
+		 * @param string $class
+		 */
 		public function hasAnnotation($class) {
 			return $this->annotations->hasAnnotation($class);
 		}

micro/addendum/annotations/annotation_parser.php

Doc Comments +12 added lines

@@ -28,6 +28,9 @@ 
 			$this->matchers[] = $matcher;
 		}
 
+		/**
+		 * @param string $string
+		 */
 		public function matches($string, &$value) {
 			if(!$this->wasConstructed) {
 				$this->build();
@@ -97,6 +100,9 @@ 
 			$this->regex = $regex;
 		}
 
+		/**
+		 * @param string $string
+		 */
 		public function matches($string, &$value) {
 			if(preg_match("/^{$this->regex}/", $string, $matches)) {
 				$value = $this->process($matches);
@@ -106,6 +112,9 @@ 
 			return false;
 		}
 
+		/**
+		 * @param string[] $matches
+		 */
 		protected function process($matches) {
 			return $matches[0];
 		}
@@ -146,6 +155,9 @@ 
 	class ConstantMatcher extends RegexMatcher {
 		private $constant;
 
+		/**
+		 * @param string $regex
+		 */
 		public function __construct($regex, $constant) {
 			parent::__construct($regex);
 			$this->constant = $constant;

micro/addendum/annotations/doc_comment.php

Doc Comments +12 added lines

@@ -22,12 +22,18 @@ 
 			}
 		}
 
+		/**
+		 * @param ReflectionClass $reflection
+		 */
 		public function forClass($reflection) {
 			$this->process($reflection->getFileName());
 			$name = $reflection->getName();
 			return isset(self::$classes[$name]) ? self::$classes[$name] : false;
 		}
 
+		/**
+		 * @param ReflectionMethod $reflection
+		 */
 		public function forMethod($reflection) {
 			$this->process($reflection->getDeclaringClass()->getFileName());
 			$class = $reflection->getDeclaringClass()->getName();
@@ -35,6 +41,9 @@ 
 			return isset(self::$methods[$class][$method]) ? self::$methods[$class][$method] : false;
 		}
 
+		/**
+		 * @param ReflectionProperty $reflection
+		 */
 		public function forProperty($reflection) {
 			$this->process($reflection->getDeclaringClass()->getFileName());
 			$class = $reflection->getDeclaringClass()->getName();
@@ -110,6 +119,9 @@ 
 			}
 		}
 
+		/**
+		 * @param integer $max
+		 */
 		private function getString($tokens, &$i, $max) {
 			do {
 				$token = $tokens[$i];

micro/addendum/annotations/tests/annotation_parser_test.php

Doc Comments +3 added lines

@@ -347,6 +347,9 @@
 			$this->assertNotIdentical($value, false);
 		}
 		
+		/**
+		 * @param string $string
+		 */
 		private function assertMatcherResult($matcher, $string, $expected) {
 			$this->assertNotIdentical($matcher->matches($string, $value), false);
 			$this->assertIdentical($value, $expected);

micro/js/Jquery.php

Doc Comments +23 added lines, -7 removed lines

@@ -33,6 +33,7 @@ 
 
 	/**
 	 * Ajoute $code à la liste des codes à exécuter
+	 * @param string $code
 	 */
 	private static function addToCodes($code){
 		$codeObject=new JsCode($code);
@@ -40,11 +41,17 @@ 
 		return $codeObject;
 	}
 
+	/**
+	 * @param string $code
+	 */
 	private static function addScript($code){
 		$code="$( document ).ready(function() {\n".$code."}\n);";
 		return preg_filter("/(\<script[^>]*?\>)?(.*)(\<\/script\>)?/si", "<script>$2 </script>\n", $code,1);
 	}
 
+	/**
+	 * @param string $url
+	 */
 	protected static function _getAjaxUrl($url,$attr){
 		$url=self::_correctAjaxUrl($url);
 		$retour="url='".$url."';\n";
@@ -84,6 +91,9 @@ 
 	}
 	/**
 	 * Associe du code javascript à exécuter sur l'évènement $event d'un élément DOM $element
+	 * @param string $element
+	 * @param string $event
+	 * @param string $jsCode
 	 */
 	public static function bindToElement($element,$event,$jsCode,$parameters=array()){
 		$preventDefault=JArray::getDefaultValue($parameters, "preventDefault", true);
@@ -114,7 +124,7 @@ 
 	 * @param String $script
 	 * @param String $event
 	 * @param String $element
-	 * @return mixed
+	 * @return JsCode
 	 */
 	public static function executeOn($element,$event,$script,$parameters=array("preventDefault"=>false,"stopPropagation"=>false)){
 		return self::bindToElement($element, $event, $script,$parameters);
@@ -123,7 +133,7 @@ 
 	/**
 	 * Exécute le script passé en paramètre
 	 * @param String $script
-	 * @return mixed
+	 * @return JsCode
 	 */
 	public static function execute($script){
 		return self::addToCodes($script);
@@ -251,6 +261,9 @@ 
 		return self::addToCodes(self::_setVal($element, $value,$jsCallback));
 	}
 
+	/**
+	 * @param string $element
+	 */
 	public static function _setHtml($element,$html="",$jsCallback=""){
 		return "$(".self::_prep_element($element).").html('".$html."');\n".$jsCallback;
 	}
@@ -264,6 +277,10 @@ 
 		return self::addToCodes(self::_setHtml($element, $html,$jsCallback));
 	}
 
+	/**
+	 * @param string $element
+	 * @param string $attr
+	 */
 	private static function _setAttr($element,$attr,$value="",$jsCallback=""){
 		return "$('".$element."').attr('".$attr."',".$value.");\n".$jsCallback;
 	}
@@ -283,7 +300,7 @@ 
 	 * @param string $element
 	 * @param string $someThing
 	 * @param string $param
-	 * @return mixed
+	 * @return string
 	 */
 	public static function _doJquery($element,$someThing,$param="",$jsCallback=""){
 		return "$(".self::_prep_element($element).").".$someThing."(".self::_prep_value($param).");\n".$jsCallback;
@@ -294,7 +311,7 @@ 
 	 * @param string $element
 	 * @param string $someThing
 	 * @param string $param
-	 * @return mixed
+	 * @return JsCode
 	 */
 	public static function doJquery($element,$someThing,$param="",$jsCallback=""){
 		return self::addToCodes(self::_doJquery($element, $someThing,$param,$jsCallback));
@@ -347,7 +364,7 @@ 
 	 * @param string $elementToModify
 	 * @param string $value
 	 * @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL)
-	 * @return mixed
+	 * @return JsCode
 	 */
 	public static function setOn($event,$element,$elementToModify,$value="",$parameters=array("preventDefault"=>false,"stopPropagation"=>false)){
 		$jsCallback=JArray::getDefaultValue($parameters, "jsCallback", null);
@@ -360,8 +377,7 @@ 
 	 * @param string $element
 	 * @param string $elementToModify
 	 * @param string $value
- 	 * @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL)
-	 * @return mixed
+	 * @return JsCode
 	 */
 	public static function setHtmlOn($event,$element,$elementToModify,$value="",$jsCallback=""){
 		return self::bindToElement($element, $event,self::_setHtml($elementToModify, $value,$jsCallback));

micro/orm/DAO.php

Doc Comments +4 added lines, -1 removed lines

@@ -47,6 +47,9 @@ 
 		self::$objects[self::getInstanceIdInObjects($instance)]=$instance;
 	}
 
+	/**
+	 * @param string $className
+	 */
 	private static function getInstanceInObjects($className,$keyValue){
 		$objects=self::getObjects();
 		$condition=self::getCondition($keyValue);
@@ -131,7 +134,7 @@ 
 	/**
 	 * @param object $instance
 	 * @param ManyToManyParser $parser
-	 * @return PDOStatement
+	 * @return \PDOStatement
 	 */
 	private static function getSQLForJoinTable($instance,ManyToManyParser $parser){
 		$accessor="get".ucfirst($parser->getPk());

micro/orm/Reflexion.php

Doc Comments +6 added lines

@@ -51,6 +51,9 @@ 
 		return $ret;
 	}
 
+	/**
+	 * @param string $annotation
+	 */
 	public static function getAnnotationClass($class,$annotation){
 		$rac=new \ReflectionAnnotatedClass($class);
 		$annot=$rac->getAnnotation($annotation);
@@ -64,6 +67,9 @@ 
 		return $annot;
 	}
 
+	/**
+	 * @param string $annotation
+	 */
 	public static function getMembersWithAnnotation($class,$annotation){
 		$props=Reflexion::getProperties(new $class());
 		$ret=array();

micro/utils/StrUtils.php

Doc Comments +7 added lines

@@ -8,10 +8,17 @@
  * @package utils
  */
 class StrUtils {
+
+	/**
+	 * @param string $needle
+	 */
 	public static function startswith($hay, $needle) {
 		return substr($hay, 0, strlen($needle)) === $needle;
 	}
 
+	/**
+	 * @param string $needle
+	 */
 	public static function endswith($hay, $needle) {
 		return substr($hay, -strlen($needle)) === $needle;
 	}

tools/Micro.php

Doc Comments +29 added lines

@@ -10,6 +10,9 @@ 
 	private static $indexContent="\n\t\$this->loadView('index.html');\n";
 	private static $mainViewTemplate="index.html";
 
+	/**
+	 * @param string $url
+	 */
 	public static function downloadZip($url,$zipFile="tmp/tmp.zip"){
 		$f = file_put_contents($zipFile, fopen($url, 'r'), LOCK_EX);
 	if(FALSE === $f)
@@ -25,6 +28,9 @@ 
 		self::writeFile("composer.json", $composer);
 	}
 
+	/**
+	 * @param string $zipFile
+	 */
 	public static function unzip($zipFile,$extractPath="."){
 		$zip = new \ZipArchive();
 		if (! $zip) {
@@ -39,6 +45,10 @@ 
 		$zip->close();
 	}
 
+	/**
+	 * @param string $source
+	 * @param string $dest
+	 */
 	public static function xcopy($source, $dest, $permissions = 0755)
 	{
 		// Check for symlinks
@@ -73,6 +83,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	public static function delTree($dir) {
 		$files = array_diff(scandir($dir), array('.','..'));
 		foreach ($files as $file) {
@@ -92,17 +105,27 @@ 
 			return file_put_contents($filename,$data);
 	}
 
+	/**
+	 * @param string|false $subject
+	 */
 	public static function replaceAll($array,$subject){
 		array_walk($array, function(&$item){if(is_array($item)) $item=implode("\n", $item);});
 		return str_replace(array_keys($array), array_values($array), $subject);
 	}
 
+	/**
+	 * @param string $source
+	 */
 	public static function openReplaceWrite($source,$destination,$keyAndValues){
 		$str=self::openFile($source);
 		$str=self::replaceAll($keyAndValues,$str);
 		return self::writeFile($destination,$str);
 	}
 
+	/**
+	 * @param string $option
+	 * @param string $longOption
+	 */
 	private static function getOption($options,$option,$longOption,$default=NULL){
 		if(array_key_exists($option, $options)){
 			$option=$options[$option];
@@ -247,6 +270,9 @@ 
 		echo $output."\n";
 	}
 
+	/**
+	 * @param string $indexContent
+	 */
 	public static function createController($controllerName,$indexContent=null,$force=false){
 		$controllerName=ucfirst($controllerName);
 		self::safeMkdir("app/controllers");
@@ -266,6 +292,9 @@ 
 			return mkdir($dir,0777,true);
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	private static function setDir($dir=null){
 		if(file_exists($dir) && is_dir($dir)){
 			$microDir=$dir.DIRECTORY_SEPARATOR.".micro";