[Vtigercrm-commits] [vtiger-commits] r6899 - /vtigercrm/trunk/modules/Calendar/calendarLayout.php

vtigercrm-commits at vtiger.fosslabs.com vtigercrm-commits at vtiger.fosslabs.com
Mon Jun 5 09:49:15 EDT 2006


Author: saraj
Date: Mon Jun  5 07:49:11 2006
New Revision: 6899

Log:
API docs updated

Modified:
    vtigercrm/trunk/modules/Calendar/calendarLayout.php

Modified: vtigercrm/trunk/modules/Calendar/calendarLayout.php
==============================================================================
--- vtigercrm/trunk/modules/Calendar/calendarLayout.php (original)
+++ vtigercrm/trunk/modules/Calendar/calendarLayout.php Mon Jun  5 07:49:11 2006
@@ -13,8 +13,9 @@
 require_once('include/utils/CommonUtils.php');
 require_once('modules/Calendar/CalendarCommon.php');
 
-/** To construct calendar subtabs
-  * @param $param_arr -- The calendar object:: Type class Calendar
+/**
+  * To construct calendar subtabs
+  * @param $param_arr -- The calendar array :: Type Array
  */
 function calendar_layout(& $param_arr)
 {
@@ -69,8 +70,9 @@
 	
 }
 
-/** To construct small calendar 
-  * @param $cal -- The calendar object:: Type class Calendar
+/**
+  * To construct small(mini) calendar 
+  * @param $cal -- The calendar array:: Type Array
  */
 function get_mini_calendar(& $cal)
 {
@@ -139,9 +141,10 @@
 	
 }
 
-/*To construct calendar headertabs
- * @param $header -- The calendar object:: Type class Calendar
-*/
+/**
+  * To construct calendar headertabs
+  * @param $header -- The calendar array :: Type Array
+  */
 function get_cal_header_tab(& $header)
 {
 	global $mod_strings;
@@ -192,9 +195,10 @@
 	echo $tabhtml;
 }
 
-/*To display events/todos detail in calendar header
- *@param $cal_arr -- The calendar array:: Type Array 
-*/
+/**
+  * To display events/todos detail in calendar header
+  * @param $cal_arr -- The calendar array:: Type Array 
+  */
 function get_cal_header_data(& $cal_arr)
 {
 	global $mod_strings;
@@ -225,9 +229,10 @@
 		</table>";
 	echo $headerdata;	
 }
-/*To get View Combo box
- *@param $cal -- The calendar array:: Type Array
-*/
+/**
+  * To get View Combo box
+  * @param $cal -- The calendar array:: Type Array
+  */
 function getEventViewOption(& $cal)
 {
 	global $mod_strings;
@@ -238,9 +243,10 @@
 	return $view;
 }
 
-/*link to previous day/week/month/year view
- *@param $cal -- The calendar array:: Type Array
-*/
+/**
+  * link to previous day/week/month/year view
+  * @param $cal -- The calendar array:: Type Array
+  */
 function get_previous_cal(& $cal)
 {
         global $mod_strings;
@@ -248,9 +254,10 @@
 	return $link;
 }
 
-/*link to next day/week/month view
- *@param $cal -- The calendar array:: Type Array
-*/
+/**
+  * link to next day/week/month view
+  * @param $cal -- The calendar array:: Type Array
+  */
 function get_next_cal(& $cal)
 {
         global $mod_strings;
@@ -259,9 +266,10 @@
 
 }
 
-/*To display date info in calendar header
- *@param $cal -- The calendar array:: Type Array
-*/
+/**
+  * To display date info in calendar header
+  * @param $cal -- The calendar array:: Type Array
+  */
 function display_date($view,$date_time)
 {
 	if ($view == 'day')
@@ -298,9 +306,10 @@
         }
 
 }
-/*To get css class name for date
- *@param $slice_date -- The calendar date:: Type string
- *return css class name :: Type string 
+/**
+  * To get css class name for date
+  * @param $slice_date -- The calendar date:: Type string
+  * @returns css class name :: Type string 
 */
 function dateCheck($slice_date)
 {
@@ -315,10 +324,11 @@
 	}
 }
 
-/*To get day/week/month events Hourview
- @param $view -- The calendar array :: Type Array
- @param $type -- The type(to differntiate hourview and listview) :: Type string
-*/
+/**
+  * To get day/week/month events Hourview
+  * @param $view -- The calendar array :: Type Array
+  * @param $type -- The type(to differntiate hourview and listview) :: Type string
+  */
 function getHourView(& $view,$type = 'default' )
 {
 	if($view['view'] == 'day')
@@ -343,10 +353,11 @@
 	}
 }
 
-/*To get day/week/month events listview
- @param $cal -- The calendar array :: Type Array
- @param $mode -- The mode(to differntiate hourview and listview) :: Type string
-*/
+/**
+  * To get day/week/month events listview
+  * @param $cal -- The calendar array :: Type Array
+  * @param $mode -- The mode(to differntiate hourview and listview) :: Type string
+  */
 function getEventListView(& $cal,$mode='')
 {
 	if($cal['calendar']->view == 'day')
@@ -399,11 +410,12 @@
 	
 }
 
-/*To get day/week/month todos listview
- *@param $cal -- The calendar array :: Type Array
- *@param $check -- The check :: Type string
- *return todolist string or todo listview html depends on $check value
-*/
+/**
+  * To get day/week/month todos listview
+  * @param $cal -- The calendar array :: Type Array
+  * @param $check -- The check :: Type string
+  * @returns todolist string or todo listview html depends on $check value
+  */
 function getTodosListView($cal, $check='')
 {
 	if($cal['calendar']->view == 'day')
@@ -455,10 +467,11 @@
         }
 }
 
-/*To get calendar layout for dayview
- *@param $cal -- The calendar array :: Type Array
- *@param $type -- The type :: Type string
-*/
+/**
+  * To get calendar layout for dayview
+  * @param $cal -- The calendar array :: Type Array
+  * @param $type -- The type :: Type string
+  */
 function getDayViewLayout(& $cal,$type)
 {
 	global $current_user,$app_strings;
@@ -533,10 +546,11 @@
 	echo $dayview_layout;		
 }
 
-/*To get calendar layout for week view
- *@param $cal -- The calendar array :: Type Array
- *@param $type  -- The type :: Type string
-*/
+/**
+  * To get calendar layout for week view
+  * @param $cal -- The calendar array :: Type Array
+  * @param $type  -- The type :: Type string
+  */
 function getWeekViewLayout(& $cal,$type)
 {
 	global $current_user,$app_strings;
@@ -635,10 +649,11 @@
 		
 }
 	
-/*To get calendar layout for month view
- *@param $cal -- The calendar array :: Type Array
- *@param $type  -- The type :: Type string
-*/
+/**
+  * To get calendar layout for month view
+  * @param $cal -- The calendar array :: Type Array
+  * @param $type  -- The type :: Type string
+  */
 function getMonthViewLayout(& $cal,$type)
 {
 	global $current_user,$app_strings;
@@ -709,10 +724,11 @@
 		
 }
 
-/*To get calendar layout for year view
- *@param $cal -- The calendar array :: Type Array
- *@param $type  -- The type :: Type string
-*/
+/** 
+  * To get calendar layout for year view
+  * @param $cal -- The calendar array :: Type Array
+  * @param $type  -- The type :: Type string
+  */
 function getYearViewLayout(& $cal,$type)
 {
 	global $mod_strings;
@@ -817,11 +833,12 @@
 	
 }
 
-/*To display events in day view
- *@param $cal -- The calendar array :: Type Array
- *@param $slice  -- The slice(date and time) :: Type string
- *returns event in html div format
-*/
+/**
+  * To display events in day view
+  * @param $cal -- The calendar array :: Type Array
+  * @param $slice  -- The slice(date and time) :: Type string
+  * @returns $eventlayer(html div) -- Type string
+  */
 function getdayEventLayer(& $cal,$slice)
 {
 	global $mod_strings;
@@ -870,10 +887,11 @@
 	}
 }
 
-/*To display events in week view
- *@param $cal -- The calendar array :: Type Array
- *@param $slice  -- The slice(date) :: Type string
- *returns event in html div format
+/**
+  * To display events in week view
+  * @param $cal -- The calendar array :: Type Array
+  * @param $slice  -- The slice(date) :: Type string
+  * @returns $eventlayer(html div) -- Type string
 */
 function getweekEventLayer(& $cal,$slice)
 {
@@ -907,11 +925,12 @@
 			
 }
 
-/*To display events in month view
- *@param $cal -- The calendar array :: Type Array
- *@param $slice  -- The slice(date) :: Type string
- *returns event in html div format
-*/
+/**
+  * To display events in month view
+  * @param $cal -- The calendar array :: Type Array
+  * @param $slice  -- The slice(date) :: Type string
+  * @returns $eventlayer(html div) -- Type string
+  */
 function getmonthEventLayer(& $cal,$slice)
 {
 	global $mod_strings;
@@ -963,13 +982,14 @@
 
 }
 
-/*To get events list scheduled between specified dates
- *@param $calendar -- The calendar array :: Type Array
- *@param $start_date -- the start date :: Type string
- *@param $end_date -- the end date :: Type string
- *@param $info -- the info :: Type string
- *returns $Entries :: Type Array
-*/
+/**
+  * To get events list scheduled between specified dates
+  * @param $calendar -- The calendar array :: Type Array
+  * @param $start_date -- the start date :: Type string
+  * @param $end_date -- the end date :: Type string
+  * @param $info -- the info :: Type string
+  * @returns $Entries :: Type Array
+  */
 function getEventList(& $calendar,$start_date,$end_date,$info='')
 {
 	$Entries = Array();
@@ -1048,13 +1068,14 @@
 }
 
 
-/*To get todos list scheduled between specified dates
- *@param $calendar -- The calendar array :: Type Array
- *@param $start_date -- the start date :: Type string
- *@param $end_date -- the end date :: Type string
- *@param $info -- the info :: Type string
- *returns $Entries :: Type Array
-*/
+/**
+  * To get todos list scheduled between specified dates
+  * @param $calendar -- The calendar array :: Type Array
+  * @param $start_date -- the start date :: Type string
+  * @param $end_date -- the end date :: Type string
+  * @param $info -- the info :: Type string
+  * returns $Entries :: Type Array
+  */
 function getTodoList(& $calendar,$start_date,$end_date,$info='')
 {
         $Entries = Array();
@@ -1110,11 +1131,12 @@
 	return $Entries;
 }
 
-/*To get number of events and todos
- *@param $cal -- The calendar array :: Type Array
- *@param $mode  -- The mode :: Type string
- *return number of events and todos in Array format
-*/
+/**
+  * To get number of events and todos
+  * @param $cal -- The calendar array :: Type Array
+  * @param $mode  -- The mode :: Type string
+  * @returns $event_todo_info(number of events and todos) -- Type Array 
+  */
 function getEventTodoInfo(& $cal, $mode)
 {
 	global $mod_strings;
@@ -1133,10 +1155,11 @@
 	return $event_todo_info;
 }
 
-/*To construct event listview
- *@param $entry_list -- The event entries array :: Type Array
- *constructs event listview in HTML format
-*/
+/**
+  * To construct event listview
+  * @param $entry_list -- The event entries array :: Type Array
+  * constructs event listview in HTML format
+  */
 function constructEventListView($entry_list)
 {
 	global $mod_strings;
@@ -1188,11 +1211,12 @@
 	echo $list_view;
 }
 
-/*To construct todo listview
- *@param $todo_list -- The todo entries array :: Type Array
- *@param $cal -- The calendar array :: Type Array
- *constructs todo listview in HTML format
-*/
+/**
+  * To construct todo listview
+  * @param $todo_list -- The todo entries array :: Type Array
+  * @param $cal -- The calendar array :: Type Array
+  * constructs todo listview in HTML format
+  */
 function constructTodoListView($todo_list,$cal)
 {
 	global $mod_strings;





More information about the vtigercrm-commits mailing list