Class MachII_framework_BaseObject

Description

Mach-II Base Object

Located in /MachII/framework/BaseObject.php (line 11)


	
			
Direct descendents
Class Description
MachII_framework_Listener Listener.
MachII_framework_Plugin Plugin.
MachII_framework_EventFilter EventFilter class.
Method Summary
MachII_framework_BaseObject __construct (MachII_framework_AppManager $appManager, [array $parameters = array()])
void announceEvent (string $eventName, [string $eventArgs = array()])
void configure ()
mixed getParameter (string $name, [mixed|null $defaultValue = null])
array getParameters ()
mixed getProperty (string $propertyName)
boolean hasParameter (string $name)
boolean isParameterDefined (string $name)
void setAppManager (MachII_framework_AppManager $appManager)
void setParameter (string $name, mixed $value)
void setParameters (array $parameters)
void setProperty (string $propertyName, mixed $propertyValue)
Methods
Constructor __construct (line 30)

Constructor

MachII_framework_BaseObject __construct (MachII_framework_AppManager $appManager, [array $parameters = array()])
  • MachII_framework_AppManager $appManager: The framework instances' AppManager.
  • array $parameters: The initial set of configuration parameters.

Redefined in descendants as:
announceEvent (line 49)

Announces a new event to the framework.

  • throws: MachII_util_EventContextMissingException
void announceEvent (string $eventName, [string $eventArgs = array()])
  • string $eventName: The name of the event to announce.
  • string $eventArgs: A struct of arguments to set as the event's args.
configure (line 41)

Override to provide custom configuration logic.

Called after constructor.

void configure ()

Redefined in descendants as:
getAppManager (line 133)
MachII_framework_AppManager getAppManager ()
getParameter (line 75)

Gets a configuration parameter value, or a default value if not defined.

mixed getParameter (string $name, [mixed|null $defaultValue = null])
  • string $name: The parameter name.
  • mixed|null $defaultValue: The default value to return if the parameter is not defined. Defaults to NULL.
getParameters (line 117)

Gets the full set of configuration parameters for the component.

  • return: associative array
array getParameters ()
getProperty (line 145)

Gets the specified property.

This is just a shortcut for getAppManager()->getPropertyManager()->getProperty().

  • return: The value of a property.
mixed getProperty (string $propertyName)
  • string $propertyName: The name of the property to return.
hasParameter (line 99)

Checks to see whether or not a configuration parameter is defined.

Same as isParameterDefined().

boolean hasParameter (string $name)
  • string $name: The parameter name.
isParameterDefined (line 87)

Checks to see whether or not a configuration parameter is defined.

Same as hasParameter().

boolean isParameterDefined (string $name)
  • string $name: The parameter name.
setAppManager (line 125)
void setAppManager (MachII_framework_AppManager $appManager)
setParameter (line 63)

Sets a configuration parameter.

void setParameter (string $name, mixed $value)
  • string $name: The parameter name.
  • mixed $value: The parameter value
setParameters (line 108)

Sets the full set of configuration parameters for the component.

void setParameters (array $parameters)
  • array $parameters: associative array will be merged with any existing parameters.
setProperty (line 161)

Sets the specified property.

This is just a shortcut for getAppManager()->getPropertyManager()->setProperty().

void setProperty (string $propertyName, mixed $propertyValue)
  • string $propertyName: The name of the property to set.
  • mixed $propertyValue: The value to store in the property.

Documentation generated on Thu, 20 Jan 2005 10:47:26 -0800 by phpDocumentor 1.3.0RC3