[ Index ]
 

Code source de eGroupWare 1.2.106-2

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/calendar/inc/ -> class.uiviews.inc.php (sommaire)

(pas de description)

Poids: 1734 lignes (61 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 1 fichier
 calendar/inc/class.uical.inc.php

Définit 1 class

uiviews:: (30 méthodes):
  uiviews()
  index()
  home()
  planner()
  month()
  _week_align_month()
  day4()
  week()
  day()
  get_todos()
  time2pos()
  times2height()
  timeGridWidget()
  dayColWidget()
  _day_class_holiday()
  eventColWidget()
  eventWidget()
  add_nonempty()
  brighter()
  plannerWidget()
  _get_planner_users()
  _get_planner_cats()
  plannerMonthScale()
  plannerWeekScale()
  plannerDayScale()
  plannerHourScale()
  plannerRowWidget()
  eventRowWidget()
  _planner_pos()
  plannerEventWidget()


Classe: uiviews  - X-Ref

Class to generate the calendar views and the necesary widgets

uiviews($set_states=null)   X-Ref
Constructor

param: array $set_states=null to manualy set / change one of the states, default NULL = use $_REQUEST

index()   X-Ref
Show the last view or the default one, if no last


home()   X-Ref
Show the calendar on the home page

return: string with content

planner($home=false)   X-Ref
Displays the planner view

param: boolean $home=false if true return content suitable for home-page

month($weeks=0,$home=false)   X-Ref
Displays the monthview or a multiple week-view

param: int $weeks=0 number of weeks to show, if 0 (default) all weeks of one month are shows
param: boolean $home=false if true return content suitable for home-page

_week_align_month(&$first,&$last,$day=1)   X-Ref
get start and end of a month aligned to full weeks

param: int &$first timestamp 0h of first day of week containing the first of the current month
param: int &$last timestamp 23:59:59 of last day of week containg the last day of the current month
param: int $day=1 should the alignment be based on the 1. of the month or an other date, eg. the 15.

day4($home=false)   X-Ref
Four days view, everythings done by the week-view code ...

param: boolean $home=false if true return content suitable for home-page
return: string

week($days=0,$home=false)   X-Ref
Displays the weekview, with 5 or 7 days

param: int $days=0 number of days to show, if 0 (default) the value from the URL or the prefs is used
param: boolean $home=false if true return content suitable for home-page

day($home=false)   X-Ref
Displays the dayview

param: boolean $home=false if true return content suitable for home-page

get_todos(&$todo_label)   X-Ref
Query the open ToDo's via a hook from InfoLog or any other 'calendar_include_todos' provider

param: array/string $todo_label label for the todo-box or array with 2 values: the label and a boolean show_all
return: string/boolean html with a table of open todo's or false if no hook availible

time2pos($time)   X-Ref
Calculates the vertical position based on the time

workday start- and end-time, is taken into account, as well as timeGrids px_m - minutes per pixel param

param: int $time in minutes
return: float position in percent

times2height($start,$end,$minimum=0)   X-Ref
Calculates the height of a differenc between 2 times

workday start- and end-time, is taken into account, as well as timeGrids px_m - minutes per pixel param

param: int $start time in minutes
param: int $end time in minutes
param: int $minimum=0 minimum height
return: float height in percent

timeGridWidget($daysEvents,$granularity_m=30,$height=400,$indent='',$title='',$owner=0,$last=true)   X-Ref
Creates a grid with rows for the time, columns for (multiple) days containing events

Uses the dayColWidget to display each day.

param: $daysEvents array with subarrays of events for each day to show, day as YYYYMMDD as key
param: int $granularity_m=30 granularity in minutes of the rows
param: int $height=400 height of the widget
param: string $indent='' string for correct indention
param: string $title='' title of the time-grid
param: int/array $owner=0 owner of the calendar (default 0 = $this->owner) or array with owner for each column
param: boolean $last=true last timeGrid displayed, default true

dayColWidget($day_ymd,$events,$left,$width,$indent,$short_title=True,$on_off=False,$owner=0)   X-Ref
Creates (if necessary multiple) columns for the events of a day

Uses the eventColWidget to display each column.

param: string/int $day_ymd date as Ymd
param: array $events of events to show
param: int $left start of the widget
param: int $width width of the widget
param: string $indent string for correct indention
param: boolean/string $short_title=True should we add a label (weekday, day) with link to the day-view above each day or string with title
param: boolean $on_off=false start with row_on or row_off, default false=row_off
param: int $owner=0 if != 0 owner to add to the add-event link

_day_class_holiday($day_ymd,&$class,&$holidays,$only_weekend=false)   X-Ref
get the CSS class and holidays for a given day

param: string $day_ymd date
param: string &$class class to use
param: string &$holidays commaseparted holidays or empty if none
param: boolean $only_weekend=false show only the weekend in header-color, otherwise every second days is shown too

eventColWidget($events,$left,$width,$indent)   X-Ref
Creates colunm for non-overlaping (!) events

Uses the eventWidget to display each event.

param: array $events of events to show
param: int $left start of the widget
param: int $width width of the widget
param: string $indent string for correct indention

eventWidget($event,$width,$indent,$return_array=false,$block='event_widget')   X-Ref
Shows one event

The display of the event and it's tooltip is done via the event_widget.tpl template

param: $event array with the data of event to show
param: $width int width of the widget
param: string $indent string for correct indention
param: boolean $return_array=false should an array with keys(tooltip,popup,html) be returned or the complete widget as string
param: string $block='event_widget' template used the render the widget
return: string/array

add_nonempty($content,$label,$one_per_line=False)   X-Ref
Pas de description

brighter($rgb,$decr=64)   X-Ref
Calculates a brighter color for a given color

param: $rgb string color as #rrggbb value
param: $decr int value to add to each component, default 64
return: string the brighter color

plannerWidget($events,$start,$end,$by_cat=0,$indent='')   X-Ref
Creates a planner view: grid with columns for the time and rows for categories or users

Uses the plannerRowWidget to display rows

param: array $events events to show
param: mixed $start start-time of the grid
param: mixed $end end-time of the grid
param: boolean/int $by_cat rows by sub-categories of $by_cat (cat_id or 0 for upmost level) or by users (false)
param: string $indent='' string for correct indention
return: string with widget

_get_planner_users($enum_groups=true)   X-Ref
get all users to display in the planner_by_user

param: boolean $enum_groups=true should groups be returned as there members (eg. planner) or not (day & week)
return: array with uid => label pairs, first all users alphabetically sorted, then all resources

_get_planner_cats($cats,&$sort2label)   X-Ref
get all categories used as sort criteria for the planner by category

the returned cat is as direct sub-category of $this->cat_id or a main (level 1) category if !$this->cat_id

param: string $cats comma-delimited cat_id's or empty for no cat
param: array &$sort2label labels for the returned cats
return: array with cat_id's

plannerMonthScale($start,$days,$indent)   X-Ref
Creates month scale for the planner

param: int $start start-time (12h) of the scale
param: int $days number of days to display
param: string $indent='' string for correct indention
return: string with scale

plannerWeekScale($start,$days,$indent)   X-Ref
Creates a week scale for the planner

param: int $start start-time (12h) of the scale
param: int $days number of days to display
param: string $indent='' string for correct indention
return: string with scale

plannerDayScale($start,$days,$indent)   X-Ref
Creates day scale for the planner

param: int $start start-time (12h) of the scale
param: int $days number of days to display
param: string $indent='' string for correct indention
return: string with scale

plannerHourScale($start,$days,$indent)   X-Ref
Creates hour scale for the planner

param: int $start start-time (12h) of the scale
param: int $days number of days to display
param: string $indent='' string for correct indention
return: string with scale

plannerRowWidget($events,$start,$end,$header,$class,$indent='')   X-Ref
Creates a row for one user or category, with a header (user or category name) and (multiple) rows with non-overlapping events

Uses the eventRowWidget to display a row of non-overlapping events

param: array $events to show
param: int $start start-time of the row
param: int $end end-time of the row
param: string $header user or category name for the row-header
param: string $class additional css class for the row
param: string $indent='' string for correct indention
return: string with widget

eventRowWidget($events,$start,$end,$indent='')   X-Ref
Creates a row with non-overlapping events

Uses the plannerEventWidget to display the events

param: array $events non-overlapping events to show
param: int $start start-time of the row
param: int $end end-time of the row
param: string $indent='' string for correct indention
return: string with widget

_planner_pos($time,$start,$end)   X-Ref
Calculate a time-dependent position in the planner

We use a non-linear scale in the planner monthview, which shows the workday start or end
as start or end of the whole day. This improves the resolution a bit.

param: int $time
param: int $start start-time of the planner
param: int $end end-time of the planner
return: float percentage position between 0-100

plannerEventWidget($event,$start,$end,$indent='')   X-Ref
Displays one event for the planner, using the eventWidget of the other views

param: array $event
param: int $start start-time of the planner
param: int $end end-time of the planner
return: string with widget



Généré le : Sun Feb 25 17:20:01 2007 par Balluche grâce à PHPXref 0.7