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:
Announces a new event to the framework.
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.
Override to provide custom configuration logic.
Called after constructor.
void
configure
()
Redefined in descendants as:
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.
Gets the full set of configuration parameters for the component.
array
getParameters
()
Gets the specified property.
This is just a shortcut for getAppManager()->getPropertyManager()->getProperty().
mixed
getProperty
(string $propertyName)
-
string
$propertyName: The name of the property to return.
Checks to see whether or not a configuration parameter is defined.
Same as isParameterDefined().
boolean
hasParameter
(string $name)
-
string
$name: The parameter name.
Checks to see whether or not a configuration parameter is defined.
Same as hasParameter().
boolean
isParameterDefined
(string $name)
-
string
$name: The parameter name.
void
setAppManager
(MachII_framework_AppManager $appManager)
Sets a configuration parameter.
void
setParameter
(string $name, mixed $value)
-
string
$name: The parameter name.
-
mixed
$value: The parameter value
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.
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.