| Package: MachII.framework |
| The main framework manager. |
<!--- License: Copyright 2006 Mach-II Corporation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Copyright: Mach-II Corporation $Id: AppManager.cfc 4352 2006-08-29 20:35:15Z pfarrell $ Created version: 1.0.0 Updated version: 1.1.1 Notes: - Added request event name functionality. (pfarrell) ---> |
| Method Summary | |
|---|---|
| public void |
init()
Used by the framework for initialization. Do not override. |
| public void |
configure()
Calls configure() on each of the manager instances. |
| public EventContext |
createEventContext(string requestEventName)
Creates an EventContext instance. |
| public RequestHandler |
createRequestHandler()
Creates a RequestHandler instance. |
| public EventManager | getEventManager() |
| public FilterManager | getFilterManager() |
| public ListenerManager | getListenerManager() |
| public PluginManager | getPluginManager() |
| public PropertyManager | getPropertyManager() |
| public RequestHandler |
getRequestHandler([boolean createNew="false"])
Returns a new or cached instance of a RequestHandler. |
| public ViewManager | getViewManager() |
| public void | setEventManager(EventManager eventManager) |
| public void | setFilterManager(FilterManager filterManager) |
| public void | setListenerManager(ListenerManager listenerManager) |
| public void | setPluginManager(PluginManager pluginManager) |
| public void | setPropertyManager(PropertyManager propertyManager) |
| public void | setViewManager(ViewManager viewManager) |
| Method Detail |
|---|
| configure |
|---|
public void configure( )
Calls configure() on each of the manager instances.
Parameters:
Code:
<cffunction name="configure" access="public" returntype="void" hint="Calls configure() on each of the manager instances."> <cfset getPropertyManager().configure() /> <cfset getPluginManager().configure() /> <cfset getListenerManager().configure() /> <cfset getFilterManager().configure() /> <cfset getEventManager().configure() /> <cfset getViewManager().configure() /> </cffunction>
| createEventContext |
|---|
public EventContext createEventContext( string requestEventName )
Creates an EventContext instance.
Parameters:
| string requestEventName |
Code:
<cffunction name="createEventContext" access="public" returntype="MachII.framework.EventContext" output="false"
hint="Creates an EventContext instance.">
<cfargument name="requestEventName" type="string" required="true" />
<cfset var eventContext = CreateObject('component', 'MachII.framework.EventContext') />
<cfset eventContext.init(this, arguments.requestEventName) />
<cfreturn eventContext />
</cffunction>
| createRequestHandler |
|---|
public RequestHandler createRequestHandler( )
Creates a RequestHandler instance.
Parameters:
Code:
<cffunction name="createRequestHandler" access="public" returntype="MachII.framework.RequestHandler" output="false"
hint="Creates a RequestHandler instance.">
<cfset var requestHandler = CreateObject('component', 'MachII.framework.RequestHandler') />
<cfset requestHandler.init(this) />
<cfreturn requestHandler />
</cffunction>
| getEventManager |
|---|
public EventManager getEventManager( )
Parameters:
Code:
<cffunction name="getEventManager" access="public" returntype="MachII.framework.EventManager" output="false"> <cfreturn variables.eventManager /> </cffunction>
| getFilterManager |
|---|
public FilterManager getFilterManager( )
Parameters:
Code:
<cffunction name="getFilterManager" access="public" returntype="MachII.framework.FilterManager" output="false"> <cfreturn variables.filterManager /> </cffunction>
| getListenerManager |
|---|
public ListenerManager getListenerManager( )
Parameters:
Code:
<cffunction name="getListenerManager" access="public" returntype="MachII.framework.ListenerManager" output="false"> <cfreturn variables.listenerManager /> </cffunction>
| getPluginManager |
|---|
public PluginManager getPluginManager( )
Parameters:
Code:
<cffunction name="getPluginManager" access="public" returntype="MachII.framework.PluginManager" output="false"> <cfreturn variables.pluginManager /> </cffunction>
| getPropertyManager |
|---|
public PropertyManager getPropertyManager( )
Parameters:
Code:
<cffunction name="getPropertyManager" access="public" returntype="MachII.framework.PropertyManager" output="false"> <cfreturn variables.propertyManager /> </cffunction>
| getRequestHandler |
|---|
public RequestHandler getRequestHandler( [boolean createNew="false"] )
Returns a new or cached instance of a RequestHandler.
Parameters:
| [boolean createNew="false"] |
Code:
<cffunction name="getRequestHandler" access="public" returntype="MachII.framework.RequestHandler" output="false" hint="Returns a new or cached instance of a RequestHandler."> <cfargument name="createNew" type="boolean" required="false" default="false" hint="Pass true to return a new instance of a RequestHandler." /> <cfif arguments.createNew> <cfreturn createRequestHandler() /> <cfelse> <cfreturn variables.requestHandler /> </cfif> </cffunction>
| getViewManager |
|---|
public ViewManager getViewManager( )
Parameters:
Code:
<cffunction name="getViewManager" access="public" returntype="MachII.framework.ViewManager" output="false"> <cfreturn variables.viewManager /> </cffunction>
| init |
|---|
public void init( )
Used by the framework for initialization. Do not override.
Parameters:
Code:
<cffunction name="init" access="public" returntype="void" output="false"
hint="Used by the framework for initialization. Do not override.">
<cfset variables.requestHandler = CreateObject('component', 'MachII.framework.RequestHandler') />
<cfset variables.requestHandler.init(this) />
</cffunction>
| setEventManager |
|---|
public void setEventManager( EventManager eventManager )
Parameters:
| EventManager eventManager |
Code:
<cffunction name="setEventManager" access="public" returntype="void" output="false"> <cfargument name="eventManager" type="MachII.framework.EventManager" required="true" /> <cfset variables.eventManager = arguments.eventManager /> </cffunction>
| setFilterManager |
|---|
public void setFilterManager( FilterManager filterManager )
Parameters:
| FilterManager filterManager |
Code:
<cffunction name="setFilterManager" access="public" returntype="void" output="false"> <cfargument name="filterManager" type="MachII.framework.FilterManager" required="true" /> <cfset variables.filterManager = arguments.filterManager /> </cffunction>
| setListenerManager |
|---|
public void setListenerManager( ListenerManager listenerManager )
Parameters:
| ListenerManager listenerManager |
Code:
<cffunction name="setListenerManager" access="public" returntype="void" output="false"> <cfargument name="listenerManager" type="MachII.framework.ListenerManager" required="true" /> <cfset variables.listenerManager = arguments.listenerManager /> </cffunction>
| setPluginManager |
|---|
public void setPluginManager( PluginManager pluginManager )
Parameters:
| PluginManager pluginManager |
Code:
<cffunction name="setPluginManager" access="public" returntype="void" output="false"> <cfargument name="pluginManager" type="MachII.framework.PluginManager" required="true" /> <cfset variables.pluginManager = arguments.pluginManager /> </cffunction>
| setPropertyManager |
|---|
public void setPropertyManager( PropertyManager propertyManager )
Parameters:
| PropertyManager propertyManager |
Code:
<cffunction name="setPropertyManager" access="public" returntype="void" output="false"> <cfargument name="propertyManager" type="MachII.framework.PropertyManager" required="true" /> <cfset variables.propertyManager = arguments.propertyManager /> </cffunction>
| setViewManager |
|---|
public void setViewManager( ViewManager viewManager )
Parameters:
| ViewManager viewManager |
Code:
<cffunction name="setViewManager" access="public" returntype="void" output="false"> <cfargument name="viewManager" type="MachII.framework.ViewManager" required="true" /> <cfset variables.viewManager = arguments.viewManager /> </cffunction>