Docs For Class AObject

Description

class AObject - The base class for all objects with signal/slot functionality

The AObject class is the base class for all widgets, and any other objects with signal/slot functionality. If you want to create your own object that will emit signals, it must extend AObject, or one of its subclasses.

author: Jordan Wambaugh <jordan@wambaugh.org>
abstract:
usedby: AValidator

Located in /lib/AObject.php (line 27)

Direct descendents

Class	Description
ALayout	ALayout
ATimer	Alia Javascript timer
AValidator	Provides easy validation of html forms and other data.
AWidget	AWidget - The base class for all wi

Variable Summary

AConnection $__connections

mixed $__objectID

array $__signalDefinitions

Method Summary

AObject __construct ()

void addConnection (AConnection $connection)

void clearConnections ()

null defineSignal (string $name, [int $parameterCount = 0])

null emit (string $signalName, [array $args = array()])

void getObjectID ()

bool hasConnection ( $signal, string $signalName)

void setObjectID ( $id)

bool __hasSignalDefinition (string $name)

Variables

AConnection $__connections = array() (line 44)

An array containing all connections to this object

access: private

mixed $__objectID (line 50)

The unique ID of the object. This value is assigned by AObjectRegistry

access: private

array $__signalDefinitions = array() (line 37)

an array containing all signal deffinitions

access: private

Methods

Constructor __construct (line 55)

access: public

AObject __construct ()

Redefined in descendants as:

addConnection (line 124)

Adds a slot connection

access: public

void addConnection (AConnection $connection)

AConnection $connection: The connection to add

clearConnections (line 162)

access: public

void clearConnections ()

defineSignal (line 84)

Defines a signal that other objects my connect slots to.

author: Jordan Wambaugh <jordan@wambaugh.org>
access: public

null defineSignal (string $name, [int $parameterCount = 0])

string $name: name
int $parameterCount: parameterCount

emit (line 98)

emit() - Emits a signal from this object to all connected slots

author: Jordan Wambaugh <jordan@wambaugh.org>
access: public

null emit (string $signalName, [array $args = array()])

string $signalName: The name of the signal to emit
array $args: the arguments to send with the signal

getObjectID (line 65)

access: public

void getObjectID ()

hasConnection (line 139)

Returns true if there is a connection to a signal specified by $signalName

return: True if there is a connection to the signal $signal
access: public

bool hasConnection ( $signal, string $signalName)

string $signalName: The name of the signal to search for
$signal

setObjectID (line 72)

access: public

void setObjectID ( $id)

$id

Redefined in descendants as:

__hasSignalDefinition (line 153)

return: True if the signal is defined in the object
access: private

bool __hasSignalDefinition (string $name)

string $name