Structure, which uses other structures to handle all its actions. More...

Inheritance diagram for KWebStructure_Foreign:

Public Member Functions
	__construct ($id, $object)
	getCollection (array $options=array())
	buildStructureMenu (Menu_Item $menu, $which, array $options=array())
	Builds menus for this structure.
	handleObjectAction ($object, $action, $data, $confirmed, array $options=array())
	Handles actions on a single object.
	handleStructureAction ($action, $data, $confirmed, array $options=array())
	Handles actions on this structure.
Data Fields
	$collection

Detailed Description

Structure, which uses other structures to handle all its actions.

Allows to set the $collection to return later in getCollection.

Constructor & Destructor Documentation

KWebStructure_Foreign::__construct	(	$	id,
		$	object
	)

Reimplemented from KWebStructure.

KWebStructure_Foreign::buildStructureMenu	(	Menu_Item $	menu,
		$	which,
		array $	options = `array()`
	)

Builds menus for this structure.

Parameters:

$menu	Menu_Item to add into.
$which	There are several menus the structure can plug into, see KWebStructure::MENU_* For MENU_STRUCTURES it's this structure's own menu item, for the rest, they're global menus.

Returns:: Menu_Item Returns $menu that was passed, or entirely new object to replace it.

KWebStructure_Foreign::getCollection ( array $ options = array() )

KWebStructure_Foreign::handleObjectAction	(	$	object,
		$	action,
		$	data,
		$	confirmed,
		array $	options = `array()`
	)

Handles actions on a single object.

Typically called during processing handleStructureAction, and not by itself

Parameters:

$action	- action id
$data	- array with action data. Action dependent. See KWebStructure::DATA_*
$confirmed	- if FALSE, the action should return array(KWebStructure::RESULT_CONFIRM => Menu_Item()) with items to confirm. if TRUE, the actions should be handled.
$options	- general options for action handling and/or specific action (see KWebStructure::OPT_*)

Reimplemented from KWebStructure.

KWebStructure_Foreign::handleStructureAction	(	$	action,
		$	data,
		$	confirmed,
		array $	options = `array()`
	)

Handles actions on this structure.

Parameters:

$action	- action id
$data	- array with action data, like list of id's, etc. Action dependent. See KWebStructure::DATA_*
$confirmed	- if false, the action should return array(KWebStructure::RESULT_CONFIRM => Menu_Item()) with items to confirm. if true, the actions should be handled.
$options	- general options for action handling and/or specific action (see KWebStructure::OPT_*)

Reimplemented from KWebStructure.

KWebStructure_Foreign::$collection

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