phpMv / ubiquity

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;
 	}