WebCalendar Function Documentation

List of Functions

• activate_urls
• activity_log
• background_css
• boss_must_approve_event
• boss_must_be_notified
• build_entry_popup
• calc_time_slot
• check_for_conflicts
• clean_html
• clean_int
• clean_whitespace
• clean_word
• daily_matrix
• date_selection
• date_to_str
• dbi_affected_rows
• dbi_close
• dbi_connect
• dbi_error
• dbi_fatal_error
• dbi_fetch_row
• dbi_free_result
• dbi_query
• decode_string
• die_miserable_death
• display_small_month
• display_time
• display_unapproved_events
• do_debug
• do_redirect
• encode_string
• etooltip
• etranslate
• event_get_external_users
• getGetValue
• getIntValue
• getPostValue
• getValue
• get_all_dates
• get_entries
• get_last_view
• get_monday_before
• get_my_users
• get_nonuser_cals
• get_pref_setting
• get_preferred_view
• get_repeating_entries
• get_site_extra_fields
• get_sunday_before
• html_for_add_icon
• html_for_event_day_at_a_glance
• html_for_event_week_at_a_glance
• html_to_8bits
• languageToAbbrev
• load_global_settings
• load_nonuser_preferences
• load_translation_text
• load_user_categories
• load_user_layers
• load_user_preferences
• month_name
• month_short_name
• nonuser_load_variables
• print_category_menu
• print_date_entries
• print_date_entries_timebar
• date_selection
• print_day_at_a_glance
• print_entry
• print_entry_timebar
• print_header
• print_header_timebar
• print_trailer
• query_events
• read_events
• read_repeated_events
• remember_this_view
• repeated_event_matches_date
• reset_language
• send_http_login
• send_no_cache_header
• send_to_preferred_view
• set_today
• site_extras_for_popup
• time_to_minutes
• times_overlap
• tooltip
• translate
• user_get_boss_list
• user_has_boss
• user_is_assistant
• user_is_nonuser_admin
• week_number
• weekday_name
• weekday_short_name

activate_urls

Look for URLs in the given text, and make them into links.

• $text - input text

The text altered to have HTML links for any web links (http or https)

functions.php, line 3275

activity_log

Add something to the activity log for an event. The information will be saved to the webcal_entry_log table.

• $event_id - event id
• $user - user doing this
• $user_cal - user whose calendar is affected
• $type - type of activity we are logging:
  • $LOG_CREATE
  • $LOG_APPROVE
  • $LOG_REJECT
  • $LOG_UPDATE
  • $LOG_DELETE
  • $LOG_NOTIFICATION
  • $LOG_REMINDER
• $text - text comment to add with activity log entry

The value used in the HTML form (or URL)

functions.php, line 771

background_css

Creates the CSS for using gradient.php, if the appropriate GD functions are available. A one-pixel wide image will be used for the background image.

Note The gd library module needs to be available to use gradient images. If it is not available, a single background color will be used instead.

• $color - base color
• $height - height of gradient image
• $percent - how many percent lighter the top color should be than the base color at the bottom of the image

The style sheet text to use

functions.php, line 4433

boss_must_approve_event

Check the boss user preferences to see if the boss must approve events added to their calendar.

• $assistant - assistant login
• $boss - boss login

true if the boss must approve new events

functions.php, line 3810

boss_must_be_notified

Check the boss user preferences to see if the boss wants to be notified via email on changes to their calendar.

• $assistant - assistant login
• $boss - boss login

true if the boss wants email notifications

functions.php, line 3794

build_entry_popup

Build the HTML for the event popup (but don't print it yet since we don't want this HTML to go inside the table for the month).

• $popupid - CSS id to use for event popup
• $user - user the event pertains to
• $description - event description
• $time - time of the event (already formatted in a display format)
• $site_extras - the HTML for any site_extras for this event

The HTML for the event popup

functions.php, line 1084

calc_time_slot

Calculate which row/slot this time represents. This is used in day and week views where hours of the time are separated into different cells in a table.

• $time - input time in YYYYMMDD format
• $round_down - should we change 1100 to 1059?
• $10AM - 100AM appointment just shows up in the 10AM slow and not in the 11AM slot also.)
  
  Note the global variable $TIME_SLOTS is used to determine how many time slots there are and how many minutes each is. This variable is defined user preferences (or defaulted to admin system settings).

The time slot index

functions.php, line 2655

check_for_conflicts

Check for conflicts. Find overlaps between an array of dates and the other dates in the database.
Limits on number of appointments: if enabled in System Settings ($LIMIT_APPTS global variable), too many appointments can also generate a scheduling conflict.

TODO Update this to handle exceptions to repeating events

• $date - is an array of dates in YYYYMMDD format that is checked for overlaps.
• $duration - event duration in minutes
• $hour - hour of event (0-23)
• $minute - minute of the event (0-59)
• $participants - an array of users whose calendars are to be checked
• $login - the current user name
• $id - current event id (this keeps overlaps from wrongly checking an event against itself)

Return empty string for no conflicts or return the HTML of the conflicts when one or more are found.

functions.php, line 2461

clean_html

Replace unsafe characters with HTML encoded equivalents

• $value - input text

the cleaned text

functions.php, line 4363

clean_int

Remove non-digits from the specified text

• $data - input text

the converted text

functions.php, line 4392

clean_whitespace

Remove whitespace from the specified text

• $data - input text

the converted text

functions.php, line 4404

clean_word

Remove non-word characters from the specified text

• $data - input text

the converted text

functions.php, line 4380

daily_matrix

Draws a daily outlook style availability grid showing events that are approved and awaiting approval.

• $date - the date to show the grid for
• $participants - which users should be included in the grid

Nothing

functions.php, line 4474

date_selection

Print out a date selection for use in a form.

• $prefix - prefix to use in front of form element names
• $date - currently selected date (in YYYYMMDD) format

The value used in the HTML form (or URL)

functions.php, line 1152

date_to_str

Convert a date in YYYYMMDD format into "Friday, December 31, 1999", "Friday, 12-31-1999" or whatever format the user prefers.

• $indate - date in YYYYMMDD format
• $format - format to use for date (default is "__month__ __dd__, __yyyy__")
• $show_weekday - should the day of week also be included (true/false)
• $short_months - should the abbreviated month names be used instead of the full month names
• $server_time - ???

The query result resource on queries (which can then be passed to the dbi_fetch_row function to obtain the results), or true/false on insert or delete queries.

functions.php, line 3430

dbi_affected_rows

Returns the number of rows affected by the last INSERT, UPDATE or DELETE.

Note Use the dbi_error function to get error information if the connection fails.

• $conn - The database connection
• $res - The database query resource returned from the dbi_query function.

The number or database rows affected.

php-dbi.php, line 358

dbi_close

Close a database connection. (Not necessary for any database that uses pooled connections such as MySQL, but a good programming practice.)

• $conn - The database connection

true on success, false on error

php-dbi.php, line 187

dbi_connect

Open up a database connection. Use a pooled connection if the db supports it and the db_persistent setting is enabled.

Notes

• The database type is determined by the global variable db_type
• For ODBC, $host is ignored, $database = DSN
• For Oracle, $database = tnsnames name
• Use the dbi_error function to get error information if the connection fails

• $host - Hostname of database server
• $login - Database login
• $password - Database login password
• $database - Name of database

The connection

php-dbi.php, line 66

dbi_error

Get the latest database error message.

• None

The text of the last database error. (The type of information varies depending on the which type of database is being used.)

php-dbi.php, line 428

dbi_fatal_error

Display a fatal database error and abort execution.

• $msg - The database error message
• $doExit - Abort execution (true/false)
• $showError - Show the details of the error (possibly including the SQL that caused the error)

Nothing

php-dbi.php, line 461

dbi_fetch_row

Retrieve a single row from the database and return it as an array.

Note we don't use the more useful xxx_fetch_array because not all databases support this function.

Note Use the dbi_error function to get error information if the connection fails.

• $res - The database query resource returned from the dbi_query function.

An array of database columns representing a single row in the query result or false on an error.

php-dbi.php, line 305

dbi_free_result

Free a result set.

• $res - The database query resource returned from the dbi_query function.

true on success

php-dbi.php, line 395

dbi_query

Execute a SQL query.

Note Use the dbi_error function to get error information if the connection fails.

• $sql - SQL of query to execute
• $fatalOnError - Abort execution if there is a database error
• $showError - Display error to use (including possibly the SQL) if there is a database error

The query result resource on queries (which can then be passed to the dbi_fetch_row function to obtain the results), or true/false on insert or delete queries.

php-dbi.php, line 230

decode_string

Extract a user's name from a session id. This prevents users from begin able to edit their cookies.txt file and set the username in plain text.

• $instr - a hex-encoded string. "Hello" would be "678ea786a5".

The decoded string

functions.php, line 3530

die_miserable_death

Print a fatal error message to the user along with a link to the Troubleshooting section of the WebCalendar System Administrator's Guide. Execution is aborted.

• $error - The error message to display

Nothing

config.php, line 39

display_small_month

Prints out a minicalendar for a month

• $thismonth - number of the month to print
• $thisyear - number of the year
• $showyear - boolean whether to show the year in the calendar's title
• $show_weeknums - boolean whether to show week numbers to the left of each row
• $minical_id - id attribute for the minical table
• $month_link - URL and query string for month link that should come before the date specification (i.e. month.php? or view_l.php?id=7&) [defaults to 'month.php?']

Nothing

functions.php, line 1195

display_time

Display a time in either 12 or 24 hour format. The global variable $TZ_OFFSET to adjust the time. Note that this is somewhat of a kludge for timezone support. If an event is set for 11PM server time and the user is 2 hours ahead, it will show up as 1AM, but the date will not be adjusted to the next day.

• $time - input time in HHMMSS format
• $ignore_offset - if true, then do not use the timezone offset (optional)

The query result resource on queries (which can then be passed to the dbi_fetch_row function to obtain the results), or true/false on insert or delete queries.

functions.php, line 3292

display_unapproved_events

Check for any unaproved events. If any are found, display a link to the unapproved events (where they can be approved). If the user is an admin user, also count up any public events. If the user is a nonuser admin, count up events on the nonuser calendar.

• $user - current user login

Nothing

functions.php, line 3222

do_debug

Log a debug message. Generally, we do not leave calls to this function in the code. It is used for debugging only.

• $msg - Text to be logged

Nothing

functions.php, line 410

do_redirect

Send a redirect to the specified page. The database connection is closed and execution terminates in this function.
Note: MS IIS/PWS has a bug in which it does not allow us to send a cookie and a redirect in the same HTTP header. When we detect that the web server is IIS, we accomplish the redirect using meta-refresh. See the following for more info on the IIS bug:

http://www.faqts.com/knowledge_base/view.phtml/aid/9316/fid/4

• $url - The page to redirect to. In theory, this should be an absolute URL, but all browsers accept relative URLs (like "month.php").

Nothing

functions.php, line 483

encode_string

Take an input string and encode it into a slightly encoded hexval that we can use as a session cookie.

• $instr - text to encode

the encoded text

functions.php, line 3564

etooltip

Translate text and remove and HTML from it. This is useful for tooltips, which barf on HTML.

Note The tooltip function will return the result rather than print the value.

• $str - the input text to translate and print

Nothing

translate.php, line 176

etranslate

Translate text and print it. This is just an abbreviation for: echo translate ( $str )

• $str - input text to translate and print

Nothing

translate.php, line 147

event_get_external_users

Get the list of external users for an event from the webcal_entry_ext_user table in an HTML format.

• $event_id - event id
• $use_mailto - when set to 1, email address will contain an href link with a mailto URL.

The list of external users for an event formatted in HTML.

functions.php, line 729

getGetValue

Get the value resulting from an HTTP GET method.
Note: The return value will be affected by the value of magic_quotes_gpc in the php.ini file. If you need to enforce a specific input format (such as numeric input), then use the getValue function.

• $name - Name used in the HTML form or found in the URL

The value used in the HTML form (or URL)

functions.php, line 190

getIntValue

Get an integer value resulting from an HTTP GET or HTTP POST method.
Note: The return value will be affected by the value of magic_quotes_gpc in the php.ini file.

• $name - Name used in the HTML form or found in the URL
• $fatal - Is it considered a fatal error requiring execution to stop if the value retrieved does not match the format regular expression?

The value used in the HTML form (or URL)

functions.php, line 257

getPostValue

Get the value resulting from an HTTP POST method.
Note: The return value will be affected by the value of magic_quotes_gpc in the php.ini file.

• $name - Name used in the HTML form

the value used in the HTML form

functions.php, line 168

getValue

Get the value resulting from either HTTP GET method or HTTP POST method.
Note: The return value will be affected by the value of magic_quotes_gpc in the php.ini file.
Note: If you need to get an integer value, you can use the getIntValue function.

• $name - Name used in the HTML form or found in the URL
• $format - A regular expression format that the input must match. If the input does not match, an empty string is returned and a warning is sent to the browser. If The $fatal parameter is true, then execution will also stop when the input does not match the format.
• $fatal - Is it considered a fatal error requiring execution to stop if the value retrieved does not match the format regular expression?

The value used in the HTML form (or URL)

functions.php, line 215

get_all_dates

Returns all the dates a specific event will fall on accounting for the repeating. Any event with no end will be assigned one.

• $date - initial date in raw format
• $rpt_type - repeating type as stored in the database
• $end - end date
• $days - days events occurs on (for weekly)
• $ex_dates - array of exception dates for this event in YYYYMMDD format
• $freq - frequency of repetition

An array of dates (in UNIX time format)

functions.php, line 1856

get_entries

Get all the events for a specific date from the array of pre-loaded events (which was loaded all at once to improve performance). The returned events will be sorted by time of day.

• $user - username
• $date - date to get events for in YYYYMMDD format
• $get_unapproved - load unapproved events (true/false)

An array of events

functions.php, line 1594

get_last_view

Get the last page stored using the remember_this_view function. Return empty string if we don't know.

• None

The URL of the last view or an empty string if it cannot be determined.

functions.php, line 586

get_monday_before

Get the Monday of the week that the specified date is in. (If the date specified is a Monday, then that date is returned.)

• $year - year in YYYY format
• $month - month (1-12)
• $day - day of the month

The date (in unix time format)

functions.php, line 2238

get_my_users

Get a list of users. If groups are enabled, this will restrict the list of users to only those users who are in the same group(s) as the user (unless the user is an admin user). We allow admin users to see all users because they can also edit someone else's events (so they may need access to users who are not in the same groups that they are in).

• None

An array of users, where each element in the array is an array with the following keys:

• cal_login
• cal_lastname
• cal_firstname
• cal_is_admin
• cal_is_admin
• cal_email
• cal_password
• cal_fullname

functions.php, line 826

get_nonuser_cals

Get a list of nonuser calendars and return info in an array.

• $user - (optional) login of admin of the nonuser calendars

An array of nonuser cals, where each is an array with the following fields:

• cal_login
• cal_lastname
• cal_firstname
• cal_admin
• cal_fullname

functions.php, line 4107

get_pref_setting

Get a preference setting for the specified user. If no value is found in the database, then the system default setting will be returned.

• $user - user login we are getting preference for
• $setting - the name of the setting

The value found in the webcal_user_pref table for the specified setting or the system default if no user settings was found.

functions.php, line 901

get_preferred_view

Get user's preferred view. The user's preferred view is stored in the $STARTVIEW global variable. This is loaded from the user preferences (or system settings if there are no user preferences.)

• $date - (optional) date to pass to preferred view in YYYYMMDD format
• $args - (optional) arguments to include in the URL (such as "user=joe")

Nothing

functions.php, line 425

get_repeating_entries

Get all the repeating events for the specified data and return them in an array (which is sorted by time of day).

Note The global variable $repeated_events needs to be set by calling the read_repeated_events function first.

• $user - username
• $date - date to get events for in YYYYMMDD format
• $get_unapproved - include unapproved events in results

The query result resource on queries (which can then be passed to the dbi_fetch_row function to obtain the results), or true/false on insert or delete queries.

functions.php, line 2039

get_site_extra_fields

Get any site-specific fields for an entry that are stored in the database in the webcal_site_extras table.

• $eventid - event id

Return an array of array with the keys as follows:

• cal_name
• cal_type
• cal_date
• cal_remind
• cal_data

functions.php, line 1475

get_sunday_before

Get the Sunday of the week that the specified date is in. (If the date specified is a Sunday, then that date is returned.)

• $year - year in YYYY format
• $month - month (1-12)
• $day - day of the month

The date (in unix time format)

functions.php, line 2221

html_for_add_icon

Generate the HTML for an icon to add a new event.

• None

The HTML for the add event icon

functions.php, line 2690

html_for_event_day_at_a_glance

Generate the HTML for an event to be viewed in the day-at-glance (day.php). The HTML will be stored in an array ($hour_arr) indexed on the event's starting hour.

• $id - event id
• $date - date of event in YYYYMMDD format
• $time - time of event in HHMM format
• $name - brief description of event
• $description - full description of event
• $status - status of event ('A', 'W')
• $pri - priority of event
• $access - access to event by others ('P', 'R')
• $duration - duration of event in minutes
• $event_owner - user who created event
• $event_category - category id for event

Nothing

functions.php, line 2871

html_for_event_week_at_a_glance

Generate the HTML for an event to be viewed in the week-at-glance (week.php). The HTML will be stored in an array (global variable $hour_arr) indexed on the event's starting hour.

• $id - event id
• $date - date of event in YYYYMMDD format
• $time - time of event in HHMM format
• $name - brief description of event
• $description - full description of event
• $status - status of event ('A', 'W')
• $pri - priority of event
• $access - access to event by others ('P', 'R')
• $duration - duration of event in minutes
• $event_owner - user who created event
• $event_category - category id for event

Nothing

functions.php, line 2722

html_to_8bits

Convert HTML entities in 8bit.

Note Only supported for PHP4 (not PHP3).

• $html - HTML text

The converted text

functions.php, line 3692

languageToAbbrev

Converts language names to their abbreviation

• $name - Name of the language (such as "French")

The abbreviation ("fr" for "French")

functions.php, line 4416

load_global_settings

Load default system settings (which can be updated via admin.php) System settings are stored in the webcal_config table.
Note: If the setting for "server_url" is not set, the value will be calculated and stored in the database.

• None

Nothing

functions.php, line 276

load_nonuser_preferences

Loads nonuser preferences from the webcal_user_pref table if on a nonuser admin page.

• $nonuser - login name for nonuser calendar

Nothing

functions.php, line 4218

load_translation_text

Load all the language translation into an array for quick lookup.

Note There is no need to call this manually. It will be invoked by the translate function the first time it is called.

• None

Nothing

translate.php, line 71

load_user_categories

Load current user's category info and stuff it into category global variable.

• $ex_global - Don't include global categories ('' or '1')

Nothing

functions.php, line 3624

load_user_layers

Load current user's layer info and stuff it into layer global variable. If the system setting $ALLOW_VIEW_OTHER is not set to 'Y', then we ignore all layer functionality. If $force is 0, we only load layers if the current user preferences have layers turned on.

• $user - User to load layers for
• $force - If set to 1, then load layers for this user even if user preferences have layers turned off.

Nothing

functions.php, line 963

load_user_preferences

Load the current user's preferences as global variables from the webcal_user_pref table. Also load the list of views for this user (not really a preference, but this is a convenient place to put this...)

Notes

• If the $ALLOW_COLOR_CUSTOMIZATION is set to 'N', then we ignore any color preferences.
• Other default values will also be set if the user has not saved a preference and no global value has been set by the administrator in the system settings.

• None

The value used in the HTML form (or URL)

functions.php, line 622

month_name

Return the full name of the specified month. Use the month_short_name function to get the abbreviated name of the month.

• $m - month (0-11)

The full name of the specified month

functions.php, line 3330

month_short_name

Return the abbreviated name of the specified month (such as "Jan"). Use the month_name function to get the full name of the month.

• $m - month (0-11)

The abbreviated name of the specified month (example: "Jan")

functions.php, line 3358

nonuser_load_variables

Loads nonuser variables (login, firstname, etc.) The following variables will be set:

• login
• firstname
• lastname
• fullname
• admin
• email

• $login - login name of nonuser calendar
• $prefix - prefix to use for variables that will be set. For example, if prefix is "temp", then the login will be stored in the $templogin global variable.

Nothing

functions.php, line 4149

print_category_menu

Print dropdown HTML for categories.

• $form - the page to submit data to (without .php)
• $date - date in YYYYMMDD format
• $cat_id - category id that should be pre-selected

Nothing

functions.php, line 3657

print_date_entries

Print all the calendar entries for the specified user for the specified date. If we are displaying data from someone other than the logged in user, then check the access permission of the entry.

• $date - date in YYYYMMDD format
• $user - username
• $is_ssi - is this being called from week_ssi.php? If so, then

Nothing

functions.php, line 2296

print_date_entries_timebar

Print all the entries in a time bar format for the specified user for the specified date. If we are displaying data from someone other than the logged in user, then check the access permission of the entry.

• $date - date in YYYYMMDD format
• $user - username
• $ssi - should we not include links to add new events?

Nothing

functions.php, line 3834

date_selection

Print out a date selection for use in a form.

• $prefix - prefix to use in front of form element names
• $date - currently selected date (in YYYYMMDD) format

The value used in the HTML form (or URL)

functions.php, line 1139

print_day_at_a_glance

Print all the calendar entries for the specified user for the specified date in day-at-a-glance format. If we are displaying data from someone other than the logged in user, then check the access permission of the entry.

• $date - date in YYYYMMDD format
• $user - username of calendar

Nothing

functions.php, line 3026

print_entry

Print the HTML for one day's events in the month view.

• $id - event id
• $date - date of event (relevant in repeating events) in YYYYMMDD format
• $time - time (in HHMMSS format)
• $duration - event duration (in minutes)
• $name - event name
• $description - long description of event
• $status - event status
• $pri - event priority
• $access - event access
• $event_owner - user associated with this event
• $event_cat - category of event for event_owner

Nothing

functions.php, line 1350

print_entry_timebar

Print the HTML for an events with a timebar.

• $id - event id
• $date - date of event in YYYYMMDD format
• $time - time of event in HHMM format
• $duration - duration of event in minutes
• $name - brief description of event
• $description - full description of event
• $status - status of event ('A', 'W')
• $pri - priority of event
• $access - access to event by others ('P', 'R')
• $event_owner - user who created event
• $event_category - category id for event

Nothing

functions.php, line 3914

print_header

Prints the HTML header and opening HTML body tag.

• $includes - an array of additional files to include referenced from the includes directory
• $HeadX - a variable containing any other data to be printed inside the head tag (meta, script, etc)
• $BodyX - a variable containing any other data to be printed inside the Body tag (onload for example)
• $disbleCustom - do not include custom header (useful for small popup windows, such as color selection)
• $disableStyle - do not include the standard css

Nothing

init.php, line 213

print_header_timebar

Print the header for the timebar.

• $start_hour - start hour
• $end_hour - end hour

Nothing

functions.php, line 4069

print_trailer

Print the common trailer.

• $include_nav_links - should the standard navigation links be included in the trailer (true/false).
• $closeDb - close the database connection (true/false)
• $disableCustom - disable the custom trailer the administrator has setup. (This is useful for small popup windows and pages being used in an iframe.)

Nothing

init.php, line 334

query_events

Read events visible to a user (including layers and possibly public access if enabled); Return results in an array sorted by time of day.

• $user - username
• $want_repeated - true to get repeating events; false to get
• $non - repeating.
• $date_filter - SQL phrase starting with AND, to be appended to the WHERE clause. May be empty string.
• $cat_id - category ID to filter on. May be empty.

An array of events

functions.php, line 1676

read_events

Read all the events for a user for the specified range of dates. This is only called once per page request to improve performance. All the events get loaded into the array $events sorted by time of day (not date).

• $user - username
• $startdate - start date range, inclusive (in YYYYMMDD format)
• $enddate - end date range, inclusive (in YYYYMMDD format)
• $cat_id - category ID to filter on

An array of events

functions.php, line 1512

read_repeated_events

Read all the repeated events for a user. This is only called once per page request to improve performance. All the events get loaded into the array $repeated_events sorted by time of day (not date). This will load all the repeated events into memory.

Notes

• To get which events repeat on a specific date, use the get_repeating_entries function.
• To get all the dates that one specific event repeats on, the get_all_dates function should be called.

• $user - username
• $cat_id - category ID to filter on (May be empty)
• $date - cutoff date for repeating event endtimes in YYYYMMDD format (may be empty)

An array of repeating events

functions.php, line 1828

remember_this_view

Generate a cookie that saves the last calendar view (month, week, day) based on the current $REQUEST_URI so we can return to this same page after a user edits/deletes/etc an event.

• None

Nothing

functions.php, line 567

repeated_event_matches_date

Returns a boolean stating whether or not the event passed in will fall on the date passed.

• $event - the event as an array
• $dateYmd - the date to check in YYYYMMDD format

true or false

functions.php, line 2073

reset_language

Unload translations so we can switch languages and translate into a different language).

• $new_language - new language file to load (just the base filename, no directory or file suffix. Example: "French")

Nothing

translate.php, line 48

send_http_login

Send an HTTP login request to the browser and stop execution.

• None

Nothing

functions.php, line 534

send_no_cache_header

Send header stuff that tells the browser not to cache this page. Different browser use different mechanisms for this, so a series of HTTP header directives are sent.

Note This function needs to be called before any HTML output is sent to the browser.

• None

Nothing

functions.php, line 606

send_to_preferred_view

Send a redirect to the user's preferred view. The user's preferred view is stored in the $STARTVIEW global variable. This is loaded from the user preferences (or system settings if there are no user preferences.)

• $date - (optional) date to pass to preferred view in YYYYMMDD format
• $args - (optional) arguments to include in the URL (such as "user=joe")

Nothing

functions.php, line 467

set_today

Determines what the day is after the $TZ_OFFSET and sets it globally. The following global variables will be set:

• $thisyear
• $thismonth
• $thisday
• $thisdate
• $today

• $date - the date in YYYYMMDD format

Nothing

functions.php, line 4246

site_extras_for_popup

Generate the HTML used in an event popup for the site_extras fields of an event.

• $id - event id

The HTML to be used within the event popup for any site_extra fields found for the specified event

functions.php, line 1011

time_to_minutes

Convert a time format HHMMSS (like 131000 for 1PM) into number of minutes past midnight.

• $time - input time in HHMMSS format

The number of minutes since midnight

functions.php, line 2639

times_overlap

Check to see if two events overlap.

• $time1 - time 1 in HHMMSS format
• $duration1 - duration 1 in minutes
• $time2 - time 2 in HHMMSS format
• $duration1 - duration 1 in minutes

true if the two times overlap, false if they do not

functions.php, line 2428

tooltip

Translate text and remove and HTML from it. This is useful for tooltips, which barf on HTML.

Note The etooltip function will print the result rather than return the value.

• $str - the input text to translate

The translated text with all HTML removed

translate.php, line 158

translate

Translate a string from the default English usage to some other language. The first time that this is called, the translation file will be loaded (with the load_translation_text function).

• $str - text to translate

The translated text, if available. If no translation is available, then the original untranslated text is returned.

translate.php, line 115

user_get_boss_list

Get a list of an assistant's boss from the webcal_asst table.

• $assistant - login of assistant

An array of bosses, where each boss is an array with the following fields:

• cal_login
• cal_fullname

functions.php, line 3714

user_has_boss

Check the webcal_asst table to see if the specified user login has any bosses associated with it.

• $assistant - login for user

true if the user is an assistant to one or more bosses

functions.php, line 3773

user_is_assistant

Return true if $user is $boss assistant by checking in the webcal_asst table.

• $assistant - login of potential assistant
• $boss - login of potential boss

true or false

functions.php, line 3748

user_is_nonuser_admin

Check the webcal_nonuser_cals table to determine if the user is the administrator for the nonuser calendar.

• $login - login of user that is the potential administrator
• $nonuser - login name for nonuser calendar

true if the user is the administrator for the nonuser calendar

functions.php, line 4195

week_number

Returns week number for specified date. depending from week numbering settings.

• $date - date in UNIX time format

The week number of the specified date

functions.php, line 2258

weekday_name

Return the full weekday name. Use the weekday_short_name function to get the abbreviated weekday name.

• $w - weekday (0=Sunday,...,6=Saturday)

the full weekday name ("Sunday")

functions.php, line 3386

weekday_short_name

Return the abbreviated weekday name. Use the weekday_name function to get the full weekday name.

• $w - weekday (0=Sunday,...,6=Saturday)

the abbreviated weekday name ("Sun")

functions.php, line 3408