cantico / absences

programs/utilit/exportbalance.php

Doc Comments +5 added lines, -1 removed lines

@@ -284,6 +284,7 @@ 
 	 * Complete current row with right value
 	 * @param absences_Right $right
 	 * @param array &$currentRow
+	 * @param double $remain_line
 	 */
 	private function setRightColumn(absences_Right $right, Array &$currentRow, Array $remain, $remain_line)
 	{
@@ -350,7 +351,7 @@ 
 	
 	
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	private function getHeader($year = '', $organization = '')
 	{
@@ -447,6 +448,9 @@ 
 	
 	
 	
+	/**
+	 * @param string[] $header
+	 */
 	private function echoCsv($header)
 	{
 	    global $babDB;

programs/vacuser.php

Doc Comments +13 added lines

@@ -1764,6 +1764,10 @@ 
 	
 	
 	
+	/**
+	 * @param string $old_date_begin
+	 * @param string $old_date_end
+	 */
 	private static function getPeriodSpanOnEdit($old_date_begin, $old_date_end, BAB_DateTime $date_begin, BAB_DateTime $date_end)
 	{
 	    $old_date_begin_obj = BAB_DateTime::fromIsoDateTime($old_date_begin);
@@ -1790,6 +1794,8 @@ 
 	 * @param int $id_request
 	 * @param BAB_DateTime | null $old_date_begin_obj
 	 * @param BAB_DateTime | null $old_date_end_obj
+	 * @param null|BAB_DateTime $old_date_begin_obj
+	 * @param null|BAB_DateTime $old_date_end_obj
 	 */
 	private static function saveInCalendar($id_request, $id, $old_date_begin_obj, $old_date_end_obj)
 	{
@@ -2009,6 +2015,10 @@ 
 	}	
 	
 	
+	/**
+	 * @param absences_Entry $entry
+	 * @param boolean $modify
+	 */
 	protected static function addNoApprovalMovment($entry, $modify)
 	{
 	    if ($modify)
@@ -2754,6 +2764,9 @@ 
 
 
 
+/**
+ * @param integer $row
+ */
 function absences_personalRights_addRightInTable(Widget_TableView $table, $row, absences_Right $right, absences_AgentRight $agentRight)
 {
     $W = bab_Widgets();

programs/portletbackend.class.php

Doc Comments +1 added lines

@@ -581,6 +581,7 @@
 	}
 	
 	/**
+	 * @param integer $id_user
 	 * @return string|false
 	 */
 	private function getPhoto($id_user)

programs/utilit/agent_right.class.php

Doc Comments +6 added lines, -1 removed lines

@@ -315,6 +315,9 @@ 
 	
 	
 	
+	/**
+	 * @param integer $exists
+	 */
 	public function saveHistory($exists, $quantity)
 	{
 	    global $babDB;
@@ -763,6 +766,7 @@ 
 	 * Get consumed confirmed quantity
 	 * should work if user not associated to right
 	 * param string $date
+	 * @param string $date
 	 * @return float	in days or in hours
 	 */
 	public function getConfirmedQuantity($date = null)
@@ -1347,6 +1351,7 @@ 
 	 *
 	 * @param string $message	generated message
 	 * @param string $comment	Author comment
+	 * @param integer $id_author
 	 */
 	public function addMovement($message, $comment = '', $id_author = null)
 	{
@@ -2139,7 +2144,7 @@ 
 	/**
 	 * 
 	 *
-	 * @return mixed
+	 * @return absences_AgentRight|null
 	 */
 	public function next()
 	{

programs/utilit/dynamic_right.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -121,7 +121,7 @@
 	/**
 	 *
 	 * @param absences_Entry $entry
-	 * @return absences_EntryElem
+	 * @return absences_DynamicRight
 	 */
 	public function setEntry(absences_Entry $entry)
 	{

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)
 	{
 		global $babDB;
@@ -123,6 +126,9 @@ 
 {
 	private $res;
 
+	/**
+	 * @param string $msg
+	 */
 	public function __construct(Array $row, $msg)
 	{
 		global $babDB;
@@ -410,6 +416,9 @@ 
 	public $display_pagination = false;
 
 
+	/**
+	 * @param integer $max
+	 */
 	protected function paginate($total, $max)
 	{
 		$this->t_first_page = absences_translate('First page');
@@ -591,6 +600,9 @@ 
 	public $ide = null;
 
 
+	/**
+	 * @param boolean $display_username
+	 */
 	public function __construct($id_user, $display_username)
 	{
 		require_once dirname(__FILE__).'/request.class.php';
@@ -1250,6 +1262,9 @@ 
 		}
 			
 			
+		/**
+		 * @param string $name
+		 */
 		private function createQuantityProperty($right, $name)
 		{
 				
@@ -1307,6 +1322,9 @@ 
 }
 
 
+/**
+ * @param integer $id_approb
+ */
 function absences_getWfName($id_approb)
 {
 	require_once $GLOBALS['babInstallPath'].'utilit/wfincl.php';
@@ -1487,7 +1505,7 @@ 
  * return null : retour a la liste des agents
  * 
  * 
- * @return bool | null
+ * @return null|boolean | null
  */
 function absences_updateVacationPersonnel($id_user)
 {
@@ -1552,6 +1570,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)
 	{
 		global $babDB;
@@ -2214,6 +2238,7 @@ 
 
 /**
  * Clear calendar data for user
+ * @param integer $id_user
  */
 function absences_clearUserCalendar($id_user = NULL) {
 	if (NULL === $id_user) {
@@ -2230,6 +2255,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) {
 
@@ -2427,6 +2455,9 @@ 
 
 
 
+/**
+ * @param string $query
+ */
 function absences_group_insert($query, $exec = false) {
 	static $values = array();
 	if ($query) {
@@ -2562,6 +2593,9 @@ 
 	return bab_longDate($timestamp, true);
 }
 
+/**
+ * @param null|integer $timestamp
+ */
 function absences_shortDate($timestamp) {
 	if (empty($timestamp)) {
 		return '';
@@ -2573,6 +2607,9 @@ 
 
 class absences_RequestDelete
 {
+    /**
+     * @param integer $folder
+     */
     public static function direct(absences_Request $request, $folder)
     {
         if ($folder)
@@ -2603,6 +2640,9 @@ 
         return $allDeleted;
     }
     
+    /**
+     * @param integer $folder
+     */
     public static function withApproval(absences_Request $request, $folder)
     {
         if ($folder)
@@ -2637,7 +2677,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)
 {
@@ -3186,6 +3226,9 @@ 
 	}
 
 
+	/**
+	 * @param string $name
+	 */
 	public function param($name, $default = '')
 	{
 		if (isset($_REQUEST[$name]))

programs/utilit/entry.class.php

Doc Comments +5 added lines, -3 removed lines

@@ -499,7 +499,7 @@ 
 	 * Save entry to database
 	 * without validity checking
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function save()
 	{
@@ -865,7 +865,7 @@ 
 	/**
 	 * Add quantity to startdate only on working periods
 	 *
-	 * @param BAB_DateTime $startdate
+	 * @param BAB_DateTime $startDate
 	 * @param float $quantity  days
 	 *
 	 * @return BAB_DateTime
@@ -1975,6 +1975,8 @@ 
 
 
 	/**
+	 * @param integer $rfrom
+	 * @param integer $ide
 	 * @return string
 	 */
 	public function getEditUrl($rfrom, $ide = null)
@@ -2503,7 +2505,7 @@ 
     }
     
     /**
-     * @return array
+     * @return string[]
      */
     protected function getWhere()
     {

programs/utilit/exportentry.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -519,7 +519,7 @@
     
 
     /**
-     * @return absences_Agent[]
+     * @return absences_AgentIterator
      */
     private function getUsersWithoutRequests()
     {