Per project overruleable event processing engine
As these classes may need setting of values this subclass implements the checkRegistryRequestsAnswers() easy access to resources.
package | Gems |
---|---|
subpackage | Event |
copyright | Copyright (c) 2011 Erasmus MC |
license | New BSD License |
since | Class available since version 1.4 |
inherited_from | \Gems_Loader_TargetLoaderAbstract |
__construct(mixed $container, array $dirs)
mixed
A container acting as source for \MUtil_Registry_Source
array
The directories where to look for requested classes
__get($name)
addPrefixPath(string $prefix, $path, boolean $prepend = true
) : \Gems_Loader_LoaderAbstract
string
boolean
Put path at the beginning of the stack (has no effect when prefix / dir already set)
\Gems_Loader_LoaderAbstract
(continuation pattern)afterRegistry() : void
answerRegistryRequest(string $name, mixed $resource) : boolean
string
Name of resource to set
mixed
The resource.
boolean
True if $resource was OKcheckRegistryRequestsAnswers() : boolean
boolean
False if required values are missing.getRegistryRequests() : array
Returns those object variables defined by the subclass but not at the level of this definition.
Can be overruled.
array
of string nameslistRoundChangedEvents() : array
array
eventname => stringlistSurveyBeforeAnsweringEvents() : array
array
eventname => stringlistSurveyCompletionEvents() : array
array
eventname => stringlistSurveyDisplayEvents() : array
array
eventname => stringlistTrackCalculationEvents() : array
array
eventname => stringlistTrackCompletionEvents() : array
array
eventname => stringlistTrackFieldUpdateEvents() : array
array
eventname => stringloadRoundChangedEvent(string $eventName) : \Gems_Event_RoundChangedEventInterface
string
\Gems_Event_RoundChangedEventInterface
loadSurveyBeforeAnsweringEvent(string $eventName) : \Gems_Event_SurveyBeforeAnsweringEventInterface
string
\Gems_Event_SurveyBeforeAnsweringEventInterface
loadSurveyCompletionEvent(string $eventName) : \Gems_Event_SurveyCompletedEventInterface
string
\Gems_Event_SurveyCompletedEventInterface
loadSurveyDisplayEvent(string $eventName) : \Gems_Event_SurveyDisplayEventInterface
string
\Gems_Event_SurveyDisplayEventInterface
loadTrackCalculationEvent(string $eventName) : \Gems_Event_TrackCalculationEventInterface
string
\Gems_Event_TrackCalculationEventInterface
loadTrackCompletionEvent(string $eventName) : \Gems_Event_TrackCompletedEventInterface
string
\Gems_Event_TrackCompletedEventInterface
loadTrackFieldUpdateEvent(string $eventName) : \Gems_TrackFieldUpdateEventInterface
string
\Gems_TrackFieldUpdateEventInterface
_cascadedDirs(array $dirs, string $cascade, boolean $fullClassnameFallback = true
) : array
array
prefix => path
string
The sub directories to cascade to
boolean
Allows full class name specification instead of just plugin name part
array
prefix => path_getClass(string $name, string $className= null
, array $arguments= array()
) : mixed
string
The $name of the variable to store this object in.
string
Class name or null if the same as $name, prepending $this->_dirs.
array
Class initialization arguments.
mixed
Instance of $className_getEventClass(string $eventType) : string
_getEventDirs(string $eventType) : array
string
An event subdirectory (may contain multiple levels split by '/'
array
An array of type prefix => classname_listEvents(string $eventType) : \Gems_tracker_TrackerEventInterface
string
The type (i.e. lookup directory with an associated class) of the events to list
\Gems_tracker_TrackerEventInterface
or more specific a $eventClass type object_loadClass(string $name, boolean $create= false
, array $arguments= array()
) : mixed
_loadEvent(string $eventName, string $eventType) : \Gems_tracker_TrackerEventInterface
string
The class name of the individual event to load
string
The type (i.e. lookup directory with an associated class) of the event
\Gems_tracker_TrackerEventInterface
or more specific a $eventClass type objectfilterRequestNames(string $name) : boolean
Can be overriden.
string
boolean
$_dirs : array
The standard value is
But an alternative could be:
$_eventClasses : array
array(self::TRACK_CALCULATION_EVENT => 'Gems_Event_TrackCalculationEventInterface', self::TRACK_COMPLETION_EVENT => 'Gems_Event_TrackCompletedEventInterface', self::TRACK_FIELDUPDATE_EVENT => 'Gems_Event_TrackFieldUpdateEventInterface', self::ROUND_CHANGED_EVENT => 'Gems_Event_RoundChangedEventInterface', self::SURVEY_BEFORE_ANSWERING_EVENT => 'Gems_Event_SurveyBeforeAnsweringEventInterface', self::SURVEY_COMPLETION_EVENT => 'Gems_Event_SurveyCompletedEventInterface', self::SURVEY_DISPLAY_EVENT => 'Gems_Event_SurveyDisplayEventInterface')
$_loader : \MUtil_Loader_PluginLoader
$cascade : string
null
$util : \Gems_Util
ROUND_CHANGED_EVENT = 'Round/Changed'
SURVEY_BEFORE_ANSWERING_EVENT = 'Survey/BeforeAnswering'
SURVEY_COMPLETION_EVENT = 'Survey/Completed'
SURVEY_DISPLAY_EVENT = 'Survey/Display'
TRACK_CALCULATION_EVENT = 'Track/Calculate'
TRACK_COMPLETION_EVENT = 'Track/Completed'
TRACK_FIELDUPDATE_EVENT = 'Track/FieldUpdate'