KWebEdit Class Reference

Public Member Functions
	getLastUrl ($default=null)
	Returns "last" url - the one where the action was started.
	redirectToLastUrl ($defaultUrl=false)
	Redirects to url passed in last_url parameter.
	getTopEditObject ($returnObject=true)
	Returns an object, which is in context of the current edit.
	setTopEditObject ($object, $force=false)
	getCurrentStructure ()
	Returns currently used KWebStructure object.
	getCurrentStructureId ()
	setCurrentStructure ($id, KWebStructure_Interface $structure)
	getPostedObjectsData ($reference=false, $request=null)
	Returns all object's posted data (KWEObj[...] as objectId => data All data are referenced directly from KWebRequest.
&	getPostedObjectData ($objectId, $objectHint, $reference=false, $request=null)
	Returns object's posted data.
	getPostedForms ()
	registerForm (KWebAttribute_Table_Form $form)
	unregisterForm (KWebAttribute_Table_Form $form)
	getForms ()
	setPostFailed ()
	isPostFailed ()
	getSelectedObjects ()
Static Public Member Functions
static	instance ($create=true)
Data Fields
const	PARAM_OBJECT = 'KWEObj'
const	PARAM_OPTIONS = 'KWEOpts'
const	PARAM_SELECTED = 'KWESelected'
const	PARAM_DATA_POSTED = '_post'
	True, when object is posted (selected)
const	PARAM_DATA_HINT = '_hint'
	Object hint for matching posted data to forms.
const	PARAM_DATA_ATTR_POSTED = '_posting'
	List of posted attributes (for translations)
const	PARAM_ACTION = 'action'
const	PARAM_AFTER_ACTION = 'after_action'
const	PARAM_LASTURL = 'last_url'
const	PARAM_TRANSLATE = 'translate'
const	PARAM_STRUCTURE = 'structure'
const	PARAM_NEWDRAFT = 'newdraft'
const	PARAM_TYPE = 'type'
const	PARAM_CURRENT = 'current'
	$posted = array()
	$postFailed = false
	$newPost = 0
	$finishAttributes = array()
	$listedItems = array()
Static Public Attributes
static	$inst = null
Protected Member Functions
	__construct ()
Protected Attributes
	$topEditObject = null
	$forceTopEditObject = false
	$forms = array()
	$structure = false
	$structureId = false

---

Constructor & Destructor Documentation

KWebEdit::__construct

(

)

[protected]

---

Member Function Documentation

KWebEdit::getCurrentStructure

(

)

Returns currently used KWebStructure object.

Only one object should be used per request

Returns:

KWebStructure

KWebEdit::getCurrentStructureId

(

)

KWebEdit::getForms

(

)

KWebEdit::getLastUrl

(

$

default = null

)

Returns "last" url - the one where the action was started.

KWebEdit::getPostedForms

(

)

& KWebEdit::getPostedObjectData	(	$	objectId,
		$	objectHint,
		$	reference = false,
		$	request = null
	)

Returns object's posted data.

Parameters:

$objectId	- id of the object
$objectHint	- if the id can not be found (or is FALSE), the PARAM_DATA_HINT will be searched for

KWebEdit::getPostedObjectsData	(	$	reference = false,
		$	request = null
	)

Returns all object's posted data (KWEObj[...] as objectId => data All data are referenced directly from KWebRequest.

Changes in this table will be reflected in KWebRequest!

KWebEdit::getSelectedObjects

(

)

KWebEdit::getTopEditObject

(

$

returnObject = true

)

Returns an object, which is in context of the current edit.

If it was a draft, and was removed, the original item will jump in context. It it was not a draft, the parent item will be used instead...

Returns:

KWebObject

static KWebEdit::instance

(

$

create = true

)

[static]

Returns:

KWebEdit

KWebEdit::isPostFailed

(

)

KWebEdit::redirectToLastUrl

(

$

defaultUrl = false

)

Redirects to url passed in last_url parameter.

KWebEdit::registerForm

(

KWebAttribute_Table_Form $

form

)

KWebEdit::setCurrentStructure	(	$	id,
		KWebStructure_Interface $	structure
	)

KWebEdit::setPostFailed

(

)

KWebEdit::setTopEditObject	(	$	object,
		$	force = false
	)

Parameters:

$force

if TRUE, this object will be used regardless of it's state

KWebEdit::unregisterForm

(

KWebAttribute_Table_Form $

form

)

---

Field Documentation

KWebEdit::$finishAttributes = array()

KWebEdit::$forceTopEditObject = false [protected]

KWebEdit::$forms = array() [protected]

KWebEdit::$inst = null [static]

KWebEdit::$listedItems = array()

KWebEdit::$newPost = 0

KWebEdit::$posted = array()

KWebEdit::$postFailed = false

KWebEdit::$structure = false [protected]

KWebEdit::$structureId = false [protected]

KWebEdit::$topEditObject = null [protected]

const KWebEdit::PARAM_ACTION = 'action'

const KWebEdit::PARAM_AFTER_ACTION = 'after_action'

const KWebEdit::PARAM_CURRENT = 'current'

const KWebEdit::PARAM_DATA_ATTR_POSTED = '_posting'

List of posted attributes (for translations)

const KWebEdit::PARAM_DATA_HINT = '_hint'

Object hint for matching posted data to forms.

const KWebEdit::PARAM_DATA_POSTED = '_post'

True, when object is posted (selected)

const KWebEdit::PARAM_LASTURL = 'last_url'

const KWebEdit::PARAM_NEWDRAFT = 'newdraft'

const KWebEdit::PARAM_OBJECT = 'KWEObj'

const KWebEdit::PARAM_OPTIONS = 'KWEOpts'

const KWebEdit::PARAM_SELECTED = 'KWESelected'

const KWebEdit::PARAM_STRUCTURE = 'structure'

const KWebEdit::PARAM_TRANSLATE = 'translate'

const KWebEdit::PARAM_TYPE = 'type'

---

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

• include/KWeb/Edit.php