cantico / absences

programs/utilit/vacincl.php

Doc Comments +45 added lines, -2 removed lines

@@ -55,6 +55,9 @@ 
 
 class absences_notifyOnRequestChangeCls
 {
+	/**
+	 * @param string $msg
+	 */
 	function __construct(absences_Entry $entry, $msg)
 	{
 		$this->message = $msg;
@@ -122,6 +125,9 @@ 
 {
 	private $res;
 
+	/**
+	 * @param string $msg
+	 */
 	public function __construct(Array $row, $msg)
 	{
 		global $babDB;
@@ -409,6 +415,9 @@ 
 	public $display_pagination = false;
 
 
+	/**
+	 * @param integer $max
+	 */
 	protected function paginate($total, $max)
 	{
 		$this->t_first_page = absences_translate('First page');
@@ -590,6 +599,9 @@ 
 	public $ide = null;
 
 
+	/**
+	 * @param boolean $display_username
+	 */
 	public function __construct($id_user, $display_username)
 	{
 		require_once dirname(__FILE__).'/request.class.php';
@@ -1270,6 +1282,9 @@ 
 		}
 			
 			
+		/**
+		 * @param string $name
+		 */
 		private function createQuantityProperty($right, $name)
 		{
 				
@@ -1327,6 +1342,9 @@ 
 }
 
 
+/**
+ * @param integer $id_approb
+ */
 function absences_getWfName($id_approb)
 {
 	require_once $GLOBALS['babInstallPath'].'utilit/wfincl.php';
@@ -1508,7 +1526,7 @@ 
  * return null : retour a la liste des agents
  * 
  * 
- * @return bool | null
+ * @return null|boolean | null
  */
 function absences_updateVacationPersonnel($id_user)
 {
@@ -1573,6 +1591,12 @@ 
 class absences_notifyOnVacationChangeCls
 {
 
+	/**
+	 * @param integer $quantity
+	 * @param string $date_begin
+	 * @param string $date_end
+	 * @param string $msg
+	 */
 	public function __construct($quantity, $date_begin,  $date_end, $msg)
 	{
 		$this->message = $msg;
@@ -2232,6 +2256,7 @@ 
 
 /**
  * Clear calendar data for user
+ * @param integer $id_user
  */
 function absences_clearUserCalendar($id_user = NULL) {
 	if (NULL === $id_user) {
@@ -2248,6 +2273,9 @@ 
 
 /**
  * si type2 est prioritaire, return true
+ * @param string $type1
+ * @param string $type2
+ * @param boolean $vacation_is_free
  */
 function absences_compare($type1, $type2, $vacation_is_free) {
 
@@ -2444,6 +2472,9 @@ 
 
 
 
+/**
+ * @param string $query
+ */
 function absences_group_insert($query, $exec = false) {
 	static $values = array();
 	if ($query) {
@@ -2579,6 +2610,9 @@ 
 	return bab_longDate($timestamp, true);
 }
 
+/**
+ * @param null|integer $timestamp
+ */
 function absences_shortDate($timestamp) {
 	if (empty($timestamp)) {
 		return '';
@@ -2590,6 +2624,9 @@ 
 
 class absences_RequestDelete
 {
+    /**
+     * @param integer $folder
+     */
     public static function direct(absences_Request $request, $folder)
     {
         if ($folder)
@@ -2620,6 +2657,9 @@ 
         return $allDeleted;
     }
     
+    /**
+     * @param integer $folder
+     */
     public static function withApproval(absences_Request $request, $folder)
     {
         if ($folder)
@@ -2654,7 +2694,7 @@ 
  * @param int $id_request
  * @param int $folder
  * @param int $rfrom            1 if the delete request is created by a manager from back office (need to be secured)
- * @return bool
+ * @return boolean|null
  */
 function absences_delete_request($id_request, $folder = 0, $rfrom = 0)
 {
@@ -3202,6 +3242,9 @@ 
 	}
 
 
+	/**
+	 * @param string $name
+	 */
 	public function param($name, $default = '')
 	{
 		if (isset($_REQUEST[$name]))