From c973715bc4a2fdfae39fb209e2107bca485cb2e1 Mon Sep 17 00:00:00 2001 From: Ralf Becker Date: Fri, 9 Mar 2007 11:39:47 +0000 Subject: [PATCH] phpDoc compatible headers --- calendar/inc/class.bocal.inc.php | 27 ++++++----------- calendar/inc/class.bocalendar.inc.php | 27 ++++++----------- calendar/inc/class.bocalupdate.inc.php | 27 ++++++----------- calendar/inc/class.socal.inc.php | 27 ++++++----------- calendar/inc/class.uical.inc.php | 42 +++++++++++--------------- calendar/inc/class.uiforms.inc.php | 27 ++++++----------- 6 files changed, 68 insertions(+), 109 deletions(-) diff --git a/calendar/inc/class.bocal.inc.php b/calendar/inc/class.bocal.inc.php index a834a94d52..515ecf3412 100644 --- a/calendar/inc/class.bocal.inc.php +++ b/calendar/inc/class.bocal.inc.php @@ -1,16 +1,14 @@ * -* -------------------------------------------- * -* This program is free software; you can redistribute it and/or modify it * -* under the terms of the GNU General Public License as published by the * -* Free Software Foundation; either version 2 of the License, or (at your * -* option) any later version. * -\**************************************************************************/ - -/* $Id$ */ +/** + * eGroupWare - Calendar's buisness-object - access only + * + * @link http://www.egroupware.org + * @package calendar + * @author Ralf Becker + * @copyright (c) 2004-7 by RalfBecker-At-outdoor-training.de + * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License + * @version $Id$ + */ require_once(EGW_INCLUDE_ROOT.'/calendar/inc/class.socal.inc.php'); @@ -40,11 +38,6 @@ define('WEEK_s',7*DAY_s); * Nor does it store the state of any UI-elements (eg. cat-id selectbox). All this is the task of the UI class(es) !!! * * All permanent debug messages of the calendar-code should done via the debug-message method of this class !!! - * - * @package calendar - * @author Ralf Becker - * @copyright (c) 2004/5 by RalfBecker-At-outdoor-training.de - * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License */ class bocal diff --git a/calendar/inc/class.bocalendar.inc.php b/calendar/inc/class.bocalendar.inc.php index 94ce3db411..588faf625c 100755 --- a/calendar/inc/class.bocalendar.inc.php +++ b/calendar/inc/class.bocalendar.inc.php @@ -1,16 +1,14 @@ * -* -------------------------------------------- * -* This program is free software; you can redistribute it and/or modify it * -* under the terms of the GNU General Public License as published by the * -* Free Software Foundation; either version 2 of the License, or (at your * -* option) any later version. * -\**************************************************************************/ - -/* $Id$ */ +/** + * eGroupWare - Calendar's XMLRPC or SOAP access + * + * @link http://www.egroupware.org + * @package calendar + * @author Ralf Becker + * @copyright (c) 2005-7 by RalfBecker-At-outdoor-training.de + * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License + * @version $Id$ + */ require_once(EGW_INCLUDE_ROOT.'/calendar/inc/class.bocalupdate.inc.php'); @@ -19,13 +17,8 @@ require_once(EGW_INCLUDE_ROOT.'/calendar/inc/class.bocalupdate.inc.php'); * * eGW's xmlrpc interface is documented at http://egroupware.org/wiki/xmlrpc * - * @package calendar - * @author Ralf Becker - * @copyright (c) 2005 by RalfBecker-At-outdoor-training.de - * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License * @link http://egroupware.org/wiki/xmlrpc */ - class bocalendar { var $xmlrpc_date_format = 'Y-m-d\\TH:i:s'; diff --git a/calendar/inc/class.bocalupdate.inc.php b/calendar/inc/class.bocalupdate.inc.php index 50fb4fa187..6e18223a6a 100644 --- a/calendar/inc/class.bocalupdate.inc.php +++ b/calendar/inc/class.bocalupdate.inc.php @@ -1,16 +1,14 @@ * -* -------------------------------------------- * -* This program is free software; you can redistribute it and/or modify it * -* under the terms of the GNU General Public License as published by the * -* Free Software Foundation; either version 2 of the License, or (at your * -* option) any later version. * -\**************************************************************************/ - -/* $Id$ */ +/** + * eGroupWare - Calendar's buisness-object - access + update + * + * @link http://www.egroupware.org + * @package calendar + * @author Ralf Becker + * @copyright (c) 2005-7 by RalfBecker-At-outdoor-training.de + * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License + * @version $Id$ + */ require_once(EGW_INCLUDE_ROOT.'/calendar/inc/class.bocal.inc.php'); @@ -39,11 +37,6 @@ define('MSG_DISINVITE',7); * Nor does it store the state of any UI-elements (eg. cat-id selectbox). All this is the task of the UI class(es) !!! * * All permanent debug messages of the calendar-code should done via the debug-message method of the bocal class !!! - * - * @package calendar - * @author Ralf Becker - * @copyright (c) 2005 by RalfBecker-At-outdoor-training.de - * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License */ class bocalupdate extends bocal diff --git a/calendar/inc/class.socal.inc.php b/calendar/inc/class.socal.inc.php index 5bb7df1ef4..2cc1bdb608 100644 --- a/calendar/inc/class.socal.inc.php +++ b/calendar/inc/class.socal.inc.php @@ -1,16 +1,14 @@ * -* -------------------------------------------- * -* This program is free software; you can redistribute it and/or modify it * -* under the terms of the GNU General Public License as published by the * -* Free Software Foundation; either version 2 of the License, or (at your * -* option) any later version. * -\**************************************************************************/ - -/* $Id$ */ +/** + * eGroupWare - Calendar's storage-object + * + * @link http://www.egroupware.org + * @package calendar + * @author Ralf Becker + * @copyright (c) 2005-7 by RalfBecker-At-outdoor-training.de + * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License + * @version $Id$ + */ /** * some necessary defines used by the calendar @@ -59,11 +57,6 @@ define('ACCEPTED',3); * UI only operates in user-time, so there have to be no conversation at all !!! * BO's functions take and return user-time only (!), they convert internaly everything to servertime, because * SO operates only on server-time - * - * @package calendar - * @author Ralf Becker - * @copyright (c) 2005 by RalfBecker-At-outdoor-training.de - * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License */ class socal { diff --git a/calendar/inc/class.uical.inc.php b/calendar/inc/class.uical.inc.php index 90de99f7b7..d2c965624b 100644 --- a/calendar/inc/class.uical.inc.php +++ b/calendar/inc/class.uical.inc.php @@ -1,16 +1,14 @@ * -* -------------------------------------------- * -* This program is free software; you can redistribute it and/or modify it * -* under the terms of the GNU General Public License as published by the * -* Free Software Foundation; either version 2 of the License, or (at your * -* option) any later version. * -\**************************************************************************/ - -/* $Id$ */ +/** + * eGroupWare - Calendar's shared base-class of all UI classes + * + * @link http://www.egroupware.org + * @package calendar + * @author Ralf Becker + * @copyright (c) 2004-7 by RalfBecker-At-outdoor-training.de + * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License + * @version $Id$ + */ /** * Shared base-class of all calendar UserInterface classes @@ -23,11 +21,6 @@ * SO operates only on server-time * * All permanent debug messages of the calendar-code should done via the debug-message method of the bocal class !!! - * - * @package calendar - * @author Ralf Becker - * @copyright (c) 2004/5 by RalfBecker-At-outdoor-training.de - * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License */ class uical { @@ -277,6 +270,7 @@ class uical 'sortby' => 'category', 'planner_days'=> 0, // full month 'view' => $this->bo->cal_prefs['defaultcalendar'], + 'listview_days'=> '', // no range ) as $state => $default) { if (isset($set_states[$state])) @@ -370,7 +364,7 @@ class uical } $this->view_menuaction = $this->view == 'listview' ? 'calendar.uilist.listview' : 'calendar.uiviews.'.$this->view; - if ($this->debug > 0 || $this->debug == 'menage_states') $this->bo->debug_message('uical::manage_states(%1) session was %2, states now %3',True,$set_states,$states_session,$states); + if ($this->debug > 0 || $this->debug == 'manage_states') $this->bo->debug_message('uical::manage_states(%1) session was %2, states now %3',True,$set_states,$states_session,$states); // save the states in the session $GLOBALS['egw']->session->appsession('session_data','calendar',$states); } @@ -617,19 +611,19 @@ class uical 'week' => 'calendar.uiviews.week', 'month' => 'calendar.uiviews.month') as $view => $menuaction) { - if ($this->view == 'planner') + if ($this->view == 'planner' || $this->view == 'listview') { switch($view) { - case 'day': $link_vars['planner_days'] = 1; break; - case 'week': $link_vars['planner_days'] = $this->cal_prefs['days_in_weekview'] == 5 ? 5 : 7; break; - case 'month': $link_vars['planner_days'] = 0; break; + case 'day': $link_vars[$this->view.'_days'] = $this->view == 'planner' ? 1 : ''; break; + case 'week': $link_vars[$this->view.'_days'] = $this->cal_prefs['days_in_weekview'] == 5 ? 5 : 7; break; + case 'month': $link_vars[$this->view.'_days'] = 0; break; } $link_vars['menuaction'] = $this->view_menuaction; // stay in the planner } - elseif ($this->view == 'listview' || $view == 'day' && $this->view == 'day4') + elseif ($view == 'day' && $this->view == 'day4') { - $link_vars['menuaction'] = $this->view_menuaction; // stay in the listview + $link_vars['menuaction'] = $this->view_menuaction; // stay in the day-view } else { diff --git a/calendar/inc/class.uiforms.inc.php b/calendar/inc/class.uiforms.inc.php index 0282f3fefc..eed350dea2 100644 --- a/calendar/inc/class.uiforms.inc.php +++ b/calendar/inc/class.uiforms.inc.php @@ -1,16 +1,14 @@ * -* -------------------------------------------- * -* This program is free software; you can redistribute it and/or modify it * -* under the terms of the GNU General Public License as published by the * -* Free Software Foundation; either version 2 of the License, or (at your * -* option) any later version. * -\**************************************************************************/ - -/* $Id$ */ +/** + * eGroupWare - Calendar's forms of the UserInterface + * + * @link http://www.egroupware.org + * @package calendar + * @author Ralf Becker + * @copyright (c) 2004-7 by RalfBecker-At-outdoor-training.de + * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License + * @version $Id$ + */ include_once(EGW_INCLUDE_ROOT . '/calendar/inc/class.uical.inc.php'); @@ -25,11 +23,6 @@ include_once(EGW_INCLUDE_ROOT . '/calendar/inc/class.uical.inc.php'); * The state of the UI elements is managed in the uical class, which all UI classes extend. * * All permanent debug messages of the calendar-code should done via the debug-message method of the bocal class !!! - * - * @package calendar - * @author Ralf Becker - * @copyright (c) 2004/5 by RalfBecker-At-outdoor-training.de - * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License */ class uiforms extends uical {