phpDoc compatible headers

This commit is contained in:
Ralf Becker 2007-03-09 11:39:47 +00:00
parent bf6d5edba2
commit c973715bc4
6 changed files with 68 additions and 109 deletions

View File

@ -1,16 +1,14 @@
<?php <?php
/**************************************************************************\ /**
* eGroupWare - Calendar's buisness-object - access only * * eGroupWare - Calendar's buisness-object - access only
* http://www.egroupware.org * *
* Written and (c) 2004/5 by Ralf Becker <RalfBecker@outdoor-training.de> * * @link http://www.egroupware.org
* -------------------------------------------- * * @package calendar
* This program is free software; you can redistribute it and/or modify it * * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* under the terms of the GNU General Public License as published by the * * @copyright (c) 2004-7 by RalfBecker-At-outdoor-training.de
* Free Software Foundation; either version 2 of the License, or (at your * * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* option) any later version. * * @version $Id$
\**************************************************************************/ */
/* $Id$ */
require_once(EGW_INCLUDE_ROOT.'/calendar/inc/class.socal.inc.php'); 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) !!! * 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 !!! * All permanent debug messages of the calendar-code should done via the debug-message method of this class !!!
*
* @package calendar
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @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 class bocal

View File

@ -1,16 +1,14 @@
<?php <?php
/**************************************************************************\ /**
* eGroupWare - XMLRPC or SOAP access to the Calendar * * eGroupWare - Calendar's XMLRPC or SOAP access
* http://www.egroupware.org * *
* Written and (c) 2005 by Ralf Becker <RalfBecker@outdoor-training.de> * * @link http://www.egroupware.org
* -------------------------------------------- * * @package calendar
* This program is free software; you can redistribute it and/or modify it * * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* under the terms of the GNU General Public License as published by the * * @copyright (c) 2005-7 by RalfBecker-At-outdoor-training.de
* Free Software Foundation; either version 2 of the License, or (at your * * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* option) any later version. * * @version $Id$
\**************************************************************************/ */
/* $Id$ */
require_once(EGW_INCLUDE_ROOT.'/calendar/inc/class.bocalupdate.inc.php'); 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 * eGW's xmlrpc interface is documented at http://egroupware.org/wiki/xmlrpc
* *
* @package calendar
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @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 * @link http://egroupware.org/wiki/xmlrpc
*/ */
class bocalendar class bocalendar
{ {
var $xmlrpc_date_format = 'Y-m-d\\TH:i:s'; var $xmlrpc_date_format = 'Y-m-d\\TH:i:s';

View File

@ -1,16 +1,14 @@
<?php <?php
/**************************************************************************\ /**
* eGroupWare - Calendar's buisness-object: access + update * * eGroupWare - Calendar's buisness-object - access + update
* http://www.egroupware.org * *
* Written and (c) 2005 by Ralf Becker <RalfBecker@outdoor-training.de> * * @link http://www.egroupware.org
* -------------------------------------------- * * @package calendar
* This program is free software; you can redistribute it and/or modify it * * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* under the terms of the GNU General Public License as published by the * * @copyright (c) 2005-7 by RalfBecker-At-outdoor-training.de
* Free Software Foundation; either version 2 of the License, or (at your * * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* option) any later version. * * @version $Id$
\**************************************************************************/ */
/* $Id$ */
require_once(EGW_INCLUDE_ROOT.'/calendar/inc/class.bocal.inc.php'); 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) !!! * 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 !!! * All permanent debug messages of the calendar-code should done via the debug-message method of the bocal class !!!
*
* @package calendar
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @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 class bocalupdate extends bocal

View File

@ -1,16 +1,14 @@
<?php <?php
/**************************************************************************\ /**
* eGroupWare - Calendar's storage-object * * eGroupWare - Calendar's storage-object
* http://www.egroupware.org * *
* Written and (c) 2005 by Ralf Becker <RalfBecker@outdoor-training.de> * * @link http://www.egroupware.org
* -------------------------------------------- * * @package calendar
* This program is free software; you can redistribute it and/or modify it * * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* under the terms of the GNU General Public License as published by the * * @copyright (c) 2005-7 by RalfBecker-At-outdoor-training.de
* Free Software Foundation; either version 2 of the License, or (at your * * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* option) any later version. * * @version $Id$
\**************************************************************************/ */
/* $Id$ */
/** /**
* some necessary defines used by the calendar * 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 !!! * 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 * BO's functions take and return user-time only (!), they convert internaly everything to servertime, because
* SO operates only on server-time * SO operates only on server-time
*
* @package calendar
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @copyright (c) 2005 by RalfBecker-At-outdoor-training.de
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
*/ */
class socal class socal
{ {

View File

@ -1,16 +1,14 @@
<?php <?php
/**************************************************************************\ /**
* eGroupWare - Calendar - shared base-class of all calendar UI classes * * eGroupWare - Calendar's shared base-class of all UI classes
* http://www.egroupware.org * *
* Written and (c) 2004/5 by Ralf Becker <RalfBecker@outdoor-training.de> * * @link http://www.egroupware.org
* -------------------------------------------- * * @package calendar
* This program is free software; you can redistribute it and/or modify it * * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* under the terms of the GNU General Public License as published by the * * @copyright (c) 2004-7 by RalfBecker-At-outdoor-training.de
* Free Software Foundation; either version 2 of the License, or (at your * * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* option) any later version. * * @version $Id$
\**************************************************************************/ */
/* $Id$ */
/** /**
* Shared base-class of all calendar UserInterface classes * Shared base-class of all calendar UserInterface classes
@ -23,11 +21,6 @@
* SO operates only on server-time * 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 !!! * All permanent debug messages of the calendar-code should done via the debug-message method of the bocal class !!!
*
* @package calendar
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @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 class uical
{ {
@ -277,6 +270,7 @@ class uical
'sortby' => 'category', 'sortby' => 'category',
'planner_days'=> 0, // full month 'planner_days'=> 0, // full month
'view' => $this->bo->cal_prefs['defaultcalendar'], 'view' => $this->bo->cal_prefs['defaultcalendar'],
'listview_days'=> '', // no range
) as $state => $default) ) as $state => $default)
{ {
if (isset($set_states[$state])) if (isset($set_states[$state]))
@ -370,7 +364,7 @@ class uical
} }
$this->view_menuaction = $this->view == 'listview' ? 'calendar.uilist.listview' : 'calendar.uiviews.'.$this->view; $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 // save the states in the session
$GLOBALS['egw']->session->appsession('session_data','calendar',$states); $GLOBALS['egw']->session->appsession('session_data','calendar',$states);
} }
@ -617,19 +611,19 @@ class uical
'week' => 'calendar.uiviews.week', 'week' => 'calendar.uiviews.week',
'month' => 'calendar.uiviews.month') as $view => $menuaction) 'month' => 'calendar.uiviews.month') as $view => $menuaction)
{ {
if ($this->view == 'planner') if ($this->view == 'planner' || $this->view == 'listview')
{ {
switch($view) switch($view)
{ {
case 'day': $link_vars['planner_days'] = 1; break; case 'day': $link_vars[$this->view.'_days'] = $this->view == 'planner' ? 1 : ''; break;
case 'week': $link_vars['planner_days'] = $this->cal_prefs['days_in_weekview'] == 5 ? 5 : 7; break; case 'week': $link_vars[$this->view.'_days'] = $this->cal_prefs['days_in_weekview'] == 5 ? 5 : 7; break;
case 'month': $link_vars['planner_days'] = 0; break; case 'month': $link_vars[$this->view.'_days'] = 0; break;
} }
$link_vars['menuaction'] = $this->view_menuaction; // stay in the planner $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 else
{ {

View File

@ -1,16 +1,14 @@
<?php <?php
/**************************************************************************\ /**
* eGroupWare - Calendar - forms of the UserInterface * * eGroupWare - Calendar's forms of the UserInterface
* http://www.egroupware.org * *
* Written and (c) 2004/5 by Ralf Becker <RalfBecker@outdoor-training.de> * * @link http://www.egroupware.org
* -------------------------------------------- * * @package calendar
* This program is free software; you can redistribute it and/or modify it * * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* under the terms of the GNU General Public License as published by the * * @copyright (c) 2004-7 by RalfBecker-At-outdoor-training.de
* Free Software Foundation; either version 2 of the License, or (at your * * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* option) any later version. * * @version $Id$
\**************************************************************************/ */
/* $Id$ */
include_once(EGW_INCLUDE_ROOT . '/calendar/inc/class.uical.inc.php'); 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. * 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 !!! * All permanent debug messages of the calendar-code should done via the debug-message method of the bocal class !!!
*
* @package calendar
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @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 class uiforms extends uical
{ {