CalendarHelper Class Reference

Public Member Functions
	CalendarHelper ()
	getHandler ($event)
	If the event DataItem class is Event and the instance has a composite class, then find the handler that renders that composite class. More...
	addHandler ($class, $handler)

Static Public Member Functions
static	eventFilterSetup ()
static	createCalendarFacet ()

Public Attributes
	$handlerMap = array()

Detailed Description

Definition at line 8 of file calendar_helper.inc.

Member Function Documentation

addHandler()

CalendarHelper::addHandler	(		$class,
			$handler
	)

Parameters

String	$class	composite event class or data item class name
obj	$handler	instance of a class inherits from either StandardEventHandler or EventHandler

Definition at line 67 of file calendar_helper.inc.

     {
          $this->handlerMap[$class] = $handler;
     }    

CalendarHelper()

CalendarHelper::CalendarHelper

(

)

Definition at line 12 of file calendar_helper.inc.

     {
          ComponentManager::fireEvent("RegisterCalendarEventHandlers", $this);
     }

createCalendarFacet()

static CalendarHelper::createCalendarFacet ( )

static

Definition at line 97 of file calendar_helper.inc.

     {
          $facet = new MultiSelectFacetFilter("calendar_id", array(Calendar     =>   "{name}"));
     
          $facet->dropdownMaxWidth = "160px";
          $facet->width = "200px";
          $facet->height = "240px";
     
          return $facet;
     }    

eventFilterSetup()

static CalendarHelper::eventFilterSetup ( )

static

Definition at line 72 of file calendar_helper.inc.

     {
          $event = new Event();
          $event->fromGET();
          
          $event->filter = new InclusionFilter("calendar_id", "start_date", "end_date");
          
          $filterForm = new FilterForm($event, "GET");
          $filterForm->hide("end_date");
          
          $calendars = Query::create(Calendar, "ORDER BY name")->execute();
          if(count($calendars) > 0)
          {
               $calendarSelect = new FilterFieldRenderer($filterForm, "calendar_id", "Calendar", FilterFieldRenderer::formatOptions($calendars, "{name}"));
          }
          else
          {
               $filterForm->hide("calendar_id");
          }
          $dateRangeRenderer = new DateRangeFilterRenderer($filterForm, "start_date", "start_date", "year");
          $dateRangeRenderer->dateRangeLabel = "Event Date";
               
          return $filterForm;
     }

getHandler()

CalendarHelper::getHandler

(

$event

)

If the event DataItem class is Event and the instance has a composite class, then find the handler that renders that composite class.

e.g., CompositeProgramEvent could be rendered by ProgramEventhandler

If the event class is not Event, then the map should link the data item class to the handler e.g., MyEventClass rendered by MyEventHandler

Parameters

obj

$event

class Event or any obj that can be rendered on the calendar

Returns

obj handler instance of StandardEventHandler or class inheriting from it or class EventHandler

Definition at line 31 of file calendar_helper.inc.

     {
          $pk = $event->getPrimaryKey();
          if(!$event->$pk && count($this->handlerMap))
          {
               $handler_class = array_shift(array_values($this->handlerMap));
               return new $handler_class;
          }
          
          if(get_class($event) == "Event" && $event->composite_class)
          {
               $event_class = $event->composite_class;
          }
          else
          {
               $event_class = get_class($event);
          }
     
          if(array_key_exists($event_class, $this->handlerMap))
          {
               $handler = $this->handlerMap[$event_class];
          }
          else
          {
               $handler = new StandardEventHandler();
          }
          
          return $handler;
     }

Member Data Documentation

$handlerMap

CalendarHelper::$handlerMap = array()

Definition at line 10 of file calendar_helper.inc.

---

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

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