KWebStructure_Item Class Reference

Inheritance diagram for KWebStructure_Item:

Public Member Functions
	__construct ($id, KWebItem $object, $adapter=null)
	getStructureObject ()
	buildStructureMenu (Menu_Item $menu, $which, array $options=array())
	Builds menus for this structure.
	buildStructureMenu_addTypes (Menu_Item $menu)
	buildStructureMenu_editActions (Menu_Item $menu, $action, array $options)
	buildStructureMenu_afterAction (Menu_Item $menu, $action, array $options)
	handleStructureAction ($action, $data, $confirmed, array $options=array())
	Handles actions on this structure.
	handleObjectAction ($object, $action, $data, $confirmed, array $options=array())
	Handles actions on a single object.
	handleObjectAction_remove (KWebObject $object, array $data, $confirmed, array $options)
	handleObjectAction_publish (KWebObject $object, array $data, $confirmed, array $options)
	handleObjectAction_pending (KWebObject $object, array $data, $confirmed, array $options)
	handleObjectAction_draft (KWebObject $object, array $data, $confirmed, array $options)
	handleObjectAction_makeStoreable (KWebObject $object, array $data, $confirmed, array $options)
	handleObjectAction_addlink (KWebObject $object, array $data, $confirmed, array $options)
	handleObjectAction_move (KWebObject $object, array $data, $confirmed, array $options)
	handleObjectAction_copy (KWebObject $object, array $data, $confirmed, array $options)
	handleStructureAction_add (array $data, $confirmed, array $options)
Data Fields
	$defaultAttrId = ATTR_ALL

---

Constructor & Destructor Documentation

KWebStructure_Item::__construct	(	$	id,
		KWebItem $	object,
		$	adapter = null
	)

---

Member Function Documentation

KWebStructure_Item::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.

Implements KWebStructure_Interface.

KWebStructure_Item::buildStructureMenu_addTypes

(

Menu_Item $

menu

)

KWebStructure_Item::buildStructureMenu_afterAction	(	Menu_Item $	menu,
		$	action,
		array $	options
	)

KWebStructure_Item::buildStructureMenu_editActions	(	Menu_Item $	menu,
		$	action,
		array $	options
	)

KWebStructure_Item::getStructureObject

(

)

Returns:

KWebItem

Reimplemented from KWebStructure.

KWebStructure_Item::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_Item::handleObjectAction_addlink	(	KWebObject $	object,
		array $	data,
		$	confirmed,
		array $	options
	)

KWebStructure_Item::handleObjectAction_copy	(	KWebObject $	object,
		array $	data,
		$	confirmed,
		array $	options
	)

KWebStructure_Item::handleObjectAction_draft	(	KWebObject $	object,
		array $	data,
		$	confirmed,
		array $	options
	)

KWebStructure_Item::handleObjectAction_makeStoreable	(	KWebObject $	object,
		array $	data,
		$	confirmed,
		array $	options
	)

KWebStructure_Item::handleObjectAction_move	(	KWebObject $	object,
		array $	data,
		$	confirmed,
		array $	options
	)

KWebStructure_Item::handleObjectAction_pending	(	KWebObject $	object,
		array $	data,
		$	confirmed,
		array $	options
	)

KWebStructure_Item::handleObjectAction_publish	(	KWebObject $	object,
		array $	data,
		$	confirmed,
		array $	options
	)

KWebStructure_Item::handleObjectAction_remove	(	KWebObject $	object,
		array $	data,
		$	confirmed,
		array $	options
	)

KWebStructure_Item::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_Item::handleStructureAction_add	(	array $	data,
		$	confirmed,
		array $	options
	)

---

Field Documentation

KWebStructure_Item::$defaultAttrId = ATTR_ALL

---

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

• include/KWebStructure/Item.php