Function Module_calendar->view_calendar_view_week

Definitions

site/pages/modules/calendar.php

  • The calendar area view for viewing a single week.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$view_id string No No required parameter N/A N/A The week we are viewing
$day string No No required parameter N/A N/A The day (Y-m-d) we are viewing
$explode array No No required parameter N/A N/A List of components of our viewed ID
$member_id MEMBER No No required parameter N/A N/A The member ID we are viewing the calendar for
$filter ?array No No required parameter N/A N/A The type filter (null: no filter)

Returns

  • The UI
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * The calendar area view for viewing a single week.
 *
 * @param  string $view_id The week we are viewing
 * @param  string $day The day (Y-m-d) we are viewing
 * @param  array $explode List of components of our viewed ID
 * @param  MEMBER $member_id The member ID we are viewing the calendar for
 * @param  ?array $filter The type filter (null: no filter)
 * @return Tempcode The UI
 */
public function view_calendar_view_week(string $view_id, string $day, array $explode, int $member_id, ?array $filter) : object