object_list Class Reference

defines container widgets and widget list objects More...

Public Member Functions
	__construct ($pollID, $parentID)
	sets the internal variables
	offsetSet ($offset, $object)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
	rewind ()
	current ()
	key ()
	next ()
	valid ()
	count ()
	get_by_ID ($ID)
	gets a element by it's ID
	delete_by_ID ($id)
	deletes an objetc by it's ID
	move ($index1, $index2)
	moves a widget from one index to another

Data Fields
	$parentID
	ID of the parent widget used to initialize new widgets.
	$pollID
	ID of the poll the widget belongs to used to initialize new widgets.

Private Attributes
	$object_list = array()
	internal list of the objects
	$position = 0
	position of the Iterator

Detailed Description

defines container widgets and widget list objects

Author

Johannes ter Haak

widget_list and object_list of widgets. Can be used like an array

Definition at line 10 of file container.class.php.

Constructor & Destructor Documentation

__construct	(		$pollID,
			$parentID
	)

sets the internal variables

Parameters

$pollID	Id of the poll the widgets belong to
$parentID	ID of the parent widget

Definition at line 22 of file container.class.php.

Member Function Documentation

count

(

)

Definition at line 138 of file container.class.php.

current

(

)

Definition at line 119 of file container.class.php.

delete_by_ID

(

$id

)

deletes an objetc by it's ID

Parameters

int

$id

ID of the objet we want to delete

Definition at line 163 of file container.class.php.

get_by_ID

(

$ID

)

gets a element by it's ID

Parameters

int

$ID

ID of the objet we want to get

Returns

widget

Definition at line 151 of file container.class.php.

key

(

)

Definition at line 123 of file container.class.php.

move	(		$index1,
			$index2
	)

moves a widget from one index to another

Parameters

int	$index1	index to move from
int	$index2	index to move to

Returns

bool true on success else false

Definition at line 188 of file container.class.php.

next

(

)

Definition at line 127 of file container.class.php.

offsetExists

(

$offset

)

Definition at line 80 of file container.class.php.

offsetGet

(

$offset

)

Definition at line 104 of file container.class.php.

offsetSet	(		$offset,
			$object
	)

Definition at line 32 of file container.class.php.

offsetUnset

(

$offset

)

Definition at line 84 of file container.class.php.

rewind

(

)

Definition at line 115 of file container.class.php.

valid

(

)

Definition at line 131 of file container.class.php.

Field Documentation

$object_list = array()

private

internal list of the objects

Definition at line 11 of file container.class.php.

$parentID

ID of the parent widget used to initialize new widgets.

Definition at line 14 of file container.class.php.

$pollID

ID of the poll the widget belongs to used to initialize new widgets.

Definition at line 15 of file container.class.php.

$position = 0

private

position of the Iterator

Definition at line 12 of file container.class.php.

---

The documentation for this class was generated from the following file:

• demo/inc/container.class.php