cal-item-procs.tcl

Publicity: Public Only All

cal-item-procs.tcl

Utility functions for Calendar Applications

Location:

packages/calendar/tcl/cal-item-procs.tcl
Created:

Jan 11, 2001
Authors:

Dirk Gomez <openacs@dirkgomez.de>
Gary Jin <gjin@arsdigita.com>
Ben Adida <ben@openforce.net>
CVS Identification:

$Id: cal-item-procs.tcl,v 1.35.2.9 2023/02/24 12:53:08 antoniop Exp $

Procedures in this file

calendar::item::add_recurrence (public)
calendar::item::all_day_event (private)
calendar::item::assign_permission (public, deprecated)
calendar::item::dates_valid_p (private)
calendar::item::delete (public)
calendar::item::delete_recurrence (public)
calendar::item::edit (public)
calendar::item::edit_recurrence (public)
calendar::item::get (public)
calendar::item::new (public)
calendar_item_add_recurrence (public, deprecated)

Detailed information

calendar::item::add_recurrence (public)

 calendar::item::add_recurrence -cal_item_id cal_item_id \
    -interval_type interval_type -every_n every_n \
    [ -days_of_week days_of_week ] [ -recur_until recur_until ]

Adds a recurrence for a calendar item

Switches:

-cal_item_id (required)
-interval_type (required)
-every_n (required)
-days_of_week (optional)
-recur_until (optional)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
cal_item_edit_recurrence, cal_item_add_delete

calendar::item::all_day_event (private)

 calendar::item::all_day_event start_date_ansi end_date_ansi

Determine, if an event is an all day event depending on the ansi start and end dates (e.g. "2018-03-22 00:00:00" and "2018-03-23 00:00:00"). The event is a full_day event, when both start_date and end_date do not specify a time, which in the datamodel means both dates are set at midnight.

Parameters:

start_date_ansi (required)

end_date_ansi (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
No testcase defined.

calendar::item::assign_permission (public, deprecated)

 calendar::item::assign_permission cal_item_id party_id permission \
    [ revoke ]

Deprecated. Invoking this procedure generates a warning.

update the permission of the specific cal_item if revoke is set to revoke, then we revoke all permissions DEPRECATED: this api is in fact a trivial wrapper for the permission api.

Parameters:

cal_item_id (required)

party_id (required)

permission (required)

revoke (optional)

See Also:

permission::grant
permission::revoke

Partial Call Graph (max 5 caller/called nodes):

Testcases:
No testcase defined.

calendar::item::dates_valid_p (private)

 calendar::item::dates_valid_p -start_date start_date \
    -end_date end_date

A sanity check that the start time is before the end time.

Switches:

-start_date (required)
-end_date (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
cal_item_start_end_date_validation

calendar::item::delete (public)

 calendar::item::delete -cal_item_id cal_item_id

Delete the calendar item

Switches:

-cal_item_id (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
cal_item_add_delete

calendar::item::delete_recurrence (public)

 calendar::item::delete_recurrence -recurrence_id recurrence_id

delete a recurrence

Switches:

-recurrence_id (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
cal_item_edit_recurrence

calendar::item::edit (public)

 calendar::item::edit -cal_item_id cal_item_id -start_date start_date \
    -end_date end_date -name name -description description \
    [ -item_type_id item_type_id ] [ -edit_all_p edit_all_p ] \
    [ -edit_past_events_p edit_past_events_p ] \
    [ -calendar_id calendar_id ] [ -location location ] \
    [ -related_link_url related_link_url ] \
    [ -related_link_text related_link_text ] \
    [ -redirect_to_rel_link_p redirect_to_rel_link_p ] \
    [ -cal_uid cal_uid ] [ -ical_vars ical_vars ]

Edit the item

Switches:

-cal_item_id (required)
-start_date (required)
-end_date (required)
-name (required)
-description (required)
-item_type_id (optional)
-edit_all_p (optional, defaults to "0")
-edit_past_events_p (optional, defaults to "1")
-calendar_id (optional)
-location (optional)
-related_link_url (optional)
-related_link_text (optional)
-redirect_to_rel_link_p (optional)
-cal_uid (optional)
-ical_vars (optional)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
cal_item_edit_recurrence

calendar::item::edit_recurrence (public)

 calendar::item::edit_recurrence -event_id event_id \
    -start_date start_date -end_date end_date -name name \
    -description description [ -item_type_id item_type_id ] \
    [ -calendar_id calendar_id ] \
    [ -edit_past_events_p edit_past_events_p ]

edit a recurrence

Switches:

-event_id (required)
-start_date (required)
-end_date (required)
-name (required)
-description (required)
-item_type_id (optional)
-calendar_id (optional)
-edit_past_events_p (optional, defaults to "t")

Partial Call Graph (max 5 caller/called nodes):

Testcases:
cal_item_edit_recurrence

calendar::item::get (public)

 calendar::item::get -cal_item_id cal_item_id [ -array array ] \
    [ -normalize_time_to_utc normalize_time_to_utc ]

Get the data for a calendar item

Switches:

-cal_item_id (required)
-array (optional)
-normalize_time_to_utc (optional, defaults to "0")

Partial Call Graph (max 5 caller/called nodes):

Testcases:
cal_item_edit_recurrence, cal_item_add_delete

calendar::item::new (public)

 calendar::item::new -start_date start_date -end_date end_date \
    -name name -description description [ -calendar_id calendar_id ] \
    [ -item_type_id item_type_id ] [ -package_id package_id ] \
    [ -location location ] [ -related_link_url related_link_url ] \
    [ -related_link_text related_link_text ] \
    [ -redirect_to_rel_link_p redirect_to_rel_link_p ] \
    [ -cal_uid cal_uid ] [ -ical_vars ical_vars ]

Insert a new calendar item into the database

Switches:

-start_date (required)
-end_date (required)
-name (required)
-description (required)
-calendar_id (optional)
-item_type_id (optional)
-package_id (optional)
-location (optional)
-related_link_url (optional)
-related_link_text (optional)
-redirect_to_rel_link_p (optional)
-cal_uid (optional)
-ical_vars (optional)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
a_foreign_calendar_user, cal_item_edit_recurrence, cal_item_add_delete

calendar_item_add_recurrence (public, deprecated)

 calendar_item_add_recurrence -cal_item_id cal_item_id \
    -interval_type interval_type -every_n every_n \
    [ -days_of_week days_of_week ] [ -recur_until recur_until ]

Deprecated. Invoking this procedure generates a warning.

Adds a recurrence for a calendar item

Switches:

-cal_item_id (required)
-interval_type (required)
-every_n (required)
-days_of_week (optional)
-recur_until (optional)

See Also:

calendar::item::add_recurrence

Partial Call Graph (max 5 caller/called nodes):

Testcases:
No testcase defined.

[ show source ]