CalendarManager Class Reference

Static Public Member Functions
static	displayCalendar ($identifier, &$continue)
static	enumerateItems ($items)
static	enumerateContextHelpClasses ($classes)
static	getTabs ($key)
static	upgradeComponent ($version)
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...
static	registerTaxonomyClasses ($classes)
static	registerCommentAdapter ()
static	registerSerializationHandler ()
static	setDefaults ()
	params to setDefaultValue: component, name, value, field_type, annotation, category, options More...

Detailed Description

Definition at line 42 of file calendar_manager.inc.

Member Function Documentation

deleteUser()

static CalendarManager::deleteUser (   $user )

static

Respond to fired event DeleteUser.

Delete any records in this component that have dependencies on user object.

Parameters

obj

$user

- class SiteUser or custom user class

Definition at line 114 of file calendar_manager.inc.

     {
          $pk = $user->getPrimaryKey();
          $user_id = $user->$pk;
          
          trace("Component calendar is deleting objects dependent on user_id {$user_id}", 3);
     
          $calendar = new Calendar();
          $calendar->delete("WHERE owner_id={$user_id}");
          
          return $user;
     }

displayCalendar()

static CalendarManager::displayCalendar (   $identifier, &  $continue  )

static

Definition at line 44 of file calendar_manager.inc.

     {
          try
          {
               $calendar = Calendar::findByIdentifier($identifier);
               
               $page = ComponentPage::findByIdentifier("calendar_view", "WHERE enabled=1");
               $_GET["cal"] = $identifier;
          
               $pageView = new ComponentPageView($page, "{$page->template}.tpl");
          
               $page_role = $page->role;
               
               if (!checkRole($page->role))
               {
                    LoginManager::storeRedirectPage();
                    redirect("/login");
               }
               
               echo $pageView->drawView();
               
               $continue = false;
          }
          catch(DataNotFoundException $e)
          {
               
          }
          
          return $identifier;
     }

enumerateContextHelpClasses()

static CalendarManager::enumerateContextHelpClasses (   $classes )

static

Definition at line 83 of file calendar_manager.inc.

     {
          array_push($classes, "Event");
          
          return $classes;
     }

enumerateItems()

static CalendarManager::enumerateItems (   $items )

static

Definition at line 75 of file calendar_manager.inc.

     {
          $calendars = Query::create(Calendar, "ORDER BY name")->execute();
          
          $items["Calendars"] = $calendars;
          return $items;
     }

getTabs()

static CalendarManager::getTabs (   $key )

static

Definition at line 90 of file calendar_manager.inc.

     {
          $tabs = array( "Details"           =>   "/admin/calendar_form",
                    "Calendar"               =>   "/admin/calendar_view",
                    "Event List"        =>   "/admin/calendar_events"
          );
     
          $qs = ($key) ? "calendar_id=$key" : "";
          return new TabBar("tabs", $tabs, $qs);
     }

registerCommentAdapter()

static CalendarManager::registerCommentAdapter ( )

static

Definition at line 133 of file calendar_manager.inc.

     {
          CommentManager::registerAdapter("calendar", Event, EventCommentXref);
     }

registerSerializationHandler()

static CalendarManager::registerSerializationHandler ( )

static

Definition at line 138 of file calendar_manager.inc.

     {
          SerializationManager::registerHandler("calendar", "Calendars, Calendar Events and Event Types", 
                                                         new CompoundSerializationHandler("CalendarMap", 
                                                                 'Calendar', 'Event', 'EventCommentXref', 
                                                                 'EventSiteXref', 'EventType',
                                                                 'CalendarEventTypeXref'));
          SerializationManager::registerHandler("timezones", "Time Zones", new SimpleSerializationHandler('TimeZone'));
          return true;
     }

registerTaxonomyClasses()

static CalendarManager::registerTaxonomyClasses (   $classes )

static

Definition at line 127 of file calendar_manager.inc.

     {
          $classes[] = Event;
          return $classes;
     }

setDefaults()

static CalendarManager::setDefaults ( )

static

params to setDefaultValue: component, name, value, field_type, annotation, category, options

Definition at line 152 of file calendar_manager.inc.

     {
          Settings::setDefaultValue("calendar", "max_events_per_day", 5, Number, "For calendar monthly display; set to 0 if no maximum");
          // There does not seem to be any use in a "view_events" since this would be controlled by 
          // page role and menu role access to the calendar pages.
          Settings::setDefaultPermission("calendar", "edit_events", "Add or Edit Events", "admin");
          Settings::setDefaultValue("calendar", "allow_comments", false, Boolean, "Allow users to comment on events");
     }

upgradeComponent()

static CalendarManager::upgradeComponent (   $version )

static

Definition at line 101 of file calendar_manager.inc.

     {
          $mgr = new CalendarUpgradeManager();
          $mgr->upgrade($version);
     }    

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/calendar/calendar_manager.inc