personal_vircal_ardb Class Reference

Inheritance diagram for personal_vircal_ardb:

vircal_ardb Collaboration diagram for personal_vircal_ardb:

Collaboration graph
[legend]
List of all members.

Detailed Description

Singleton class that defines some Personal Virtual Calendars as array storage.

This class is probably just a temporary solution to store some fixed prefabbed virtual_calendar definition in a repository.

Calendars Provided

By this class the following personal calendars are currently provided:

Author:
jvl
Version:
0.9.37-a3 added a php4 compat fix in _cpw...
Date:
20060501
Since:
0.9.37-a2 added detection of http or https for list and a note

0.9.36-a1 first release adapted for NAPI-3.1

version 0.9.36 initialize resources with hndarg3 set (NAPI-3.1)


Public Member Functions

string listing (int $detail=1)
 Provide a html listing of all available personal calendars.
 personal_vircal_ardb (int $user_id=null)
 Constructor, overwrites superclass constructor A initialisation of all the $calendars member is done by calling the method rebuild_calendars().
int rebuild_calendars (int $user_id)
 Initialize the storage in $calendars according to user settings Create all the defined standard virtual calendars for the user in $user_id The calendars defined are:
  • /events.ics the events (appointments) from -1 month till +1 year
    • /week/events.ics the events from the current week
  • /tasks.ics
  • /default.ics combined info from /events.ics and /tasks.ics
  • /freebusy.ifb.


Public Attributes

VCalDefAR $_calendar_proto = array()
 Prototype of a calendar.ics: events and tasks calendar In this calendar a egw bocal is searched for events and an egw boinfolog resource is used for tasks Use rebuild_calendars() to initialize it.
VCalDefAR $_events_proto
 Prototype of a events calendar.
VCalDefAR $_freebusy_proto
 Prototype of a freebusy calendar.
VCalDefAR $_tasks_proto
 Prototype of a tasks calendar.
string $user_id
 The (numerical) egw user id to who these personal calendars belong This should be set by constructor.


Constructor & Destructor Documentation

personal_vircal_ardb::personal_vircal_ardb int $  user_id = null  ) 
 

Constructor, overwrites superclass constructor A initialisation of all the $calendars member is done by calling the method rebuild_calendars().

Parameters:
$user_id the user for which the virtual calendars are created


Member Function Documentation

string personal_vircal_ardb::listing int $  detail = 1  ) 
 

Provide a html listing of all available personal calendars.

Parameters:
$detail control in how much detail the listing provides: [0..1) => paths only, [1..2) => paths and description [100..) => dump
Returns:
a html page with a listing of the calendars and their description.

int personal_vircal_ardb::rebuild_calendars int $  user_id  ) 
 

Initialize the storage in $calendars according to user settings Create all the defined standard virtual calendars for the user in $user_id The calendars defined are:

  • /events.ics the events (appointments) from -1 month till +1 year
    • /week/events.ics the events from the current week
  • /tasks.ics
  • /default.ics combined info from /events.ics and /tasks.ics
  • /freebusy.ifb.

Parameters:
$user_id the user (as id) whose personal virtual calendars will are set up.
Returns:
the number of entries set in $calendars


Member Data Documentation

VCalDefAR personal_vircal_ardb::$_events_proto
 

Initial value:

 array('lpath' => '_s_calname',
               'version' => 'vc-1.0',
               'description' => 'a proto for a personal events calendar',
               'enabled' => 1,
               'auth'  => ':basic',
               'rscs'  =>
               array('calendar.bocalupdate' =>
                     array(
                           'hnd'   => 'egwical.bocalupdate_vevents',
                           'owner_id' => '_fn_cal_owner_id()',
                           'qmeth' => 'search',
                           'qarg' =>
                           array(
                                 'start' => '_fn_month_start()',
                                 'end'   => '_fn_month_end()',
                                 'enum_recuring' => false,
                                 'daywise'       => false,
                                 'users'         => '_fn_cal_owner_id()',
                                 'date_format'   => 'server'
                                 ),
                           'access' => 'RW'
                           )
                     )
               )
Prototype of a events calendar.

Note:
events are entries from egw calendar

VCalDefAR personal_vircal_ardb::$_freebusy_proto
 

Initial value:

 array('lpath' => '_s_calname',
               'version' => 'vc-1.0',
               'description' => 'a proto for a personal freebusy calendar',
               'enabled' => 1,
               'auth'  => ':basic',
               'rscs'  =>
               array('calendar.bocalupdate' =>
                     array(
                           'hnd'   => 'egwical.bocalupdate_vfreebusy',
                           'owner_id' => '_fn_cal_owner_id()',
                           'hndarg4' => array(
                                             'url'=> '_s_calname',
                                             'start' => '_fn_month_start()',
                                             'end'   => '_fn_month_end()'
                                             ),
                           'qmeth' => 'search',
                           'qarg' =>
                           array(
                                 'start' => '_fn_month_start()',
                                 'end'   => '_fn_month_end()',
                                 'enum_recuring' => true,
                                 'daywise'       => false,
                                 'users'         => '_fn_cal_owner_id()',
                                 'date_format'   => 'server'
                                 ),
                           'access' => 'R'
                           )
                     )
               )
Prototype of a freebusy calendar.

Note:
at the moment only freebusies from egw calendar are used

VCalDefAR personal_vircal_ardb::$_tasks_proto
 

Initial value:

  array('lpath' =>  '_s_calname',
               'version' => 'vc-1.0',
               'description' => 'a proto for a personal tasks calendar',
               'enabled' => 1,
               'auth'  => ':basic',
               'rscs'  =>
               array('infolog.boinfolog' =>
                     array(
                           'hnd'   => 'egwical.boinfolog_vtodos',
                           'owner_id' => '_fn_cal_owner_id()',
                           'qmeth' => 'search',
                           'qarg' =>
                           array(
                                 'col_filter' =>
                                 array('info_type' => 'task',
                                       'info_status' => '',
                                       'info_responsible' => '_fn_cal_owner_id()',
                                       'info_owner' => '',
                                       ),
                                 'filter' => 'own',
                                 'order' => 'id_parent',
                                 'subs' => true,
                                 'sort' => 'DESC'
                                 ),
                           'access' => 'RW'
                           )
                     )
                )
Prototype of a tasks calendar.

Note:
tasks are task entries from egw infolog


Generated on Thu Jun 8 22:17:13 2006 for IcalSrv-API by  doxygen 1.4.6