BxBaseModGeneralFormsEntryHelper Class Reference

Inheritance diagram for BxBaseModGeneralFormsEntryHelper:

Public Member Functions
	__construct ($oModule)
	setAjaxMode ($bAjaxMode)
	setValidMode ($bValidMode)
	setAbsoluteActionUrl ($bAbsoluteActionUrl)
	setContextId ($mixedContextId)
	setDynamicMode ($bDynamicMode)
	getObjectStorage ()
	getObjectFormAdd ($sDisplay=false)
	getObjectFormEdit ($sDisplay=false)
	getObjectFormView ($sDisplay=false)
	getObjectFormDelete ($sDisplay=false)
	viewDataEntry ($iContentId)
	addData ($iProfile, $aValues, $sDisplay=false)
	addDataForm ($sDisplay=false, $sCheckFunction=false)
	redirectAfterAdd ($aContentInfo, $sUrl='')
	editDataForm ($iContentId, $sDisplay=false, $sCheckFunction=false, $bErrorMsg=true)
	editData ($iContentId, $aValues, $sDisplay=false)
	deleteDataForm ($iContentId, $sDisplay=false, $sCheckFunction=false)
	deleteData ($iContentId, $aContentInfo=false, $oProfile=null, $oForm=null)
	viewDataForm ($iContentId, $sDisplay=false)
	onDataDeleteAfter ($iContentId, $aContentInfo, $oProfile)
	onDataEditBefore ($iContentId, $aContentInfo, &$aTrackTextFieldsChanges, &$oProfile, &$oForm)
	onDataEditAfter ($iContentId, $aContentInfo, $aTrackTextFieldsChanges, $oProfile, $oForm)
	onDataAddAfter ($iAccountId, $iContentId)

Protected Member Functions
	redirectAfterEdit ($aContentInfo, $sUrl='')
	redirectAfterDelete ($aContentInfo)
	_processPermissionsCheckForViewDataForm ($aContentInfo, $oProfile)
	prepareCustomRedirectUrl ($s, $aContentInfo)
	prepareResponse ($mixedResponse, $bAsJson=false, $sKey='msg', $aAdditional=array())
	prepareResponseAPI ($sType, $mixedData, $aParams=[])
	_setAbsoluteActionUrl ($sType, &$oForm)
	_getRedirectFromContext ($sAction, $aContentInfo)
Protected Member Functions inherited from BxDolProfileForms
	__construct ()
	_redirectAndExit ($sUrl, $isPermalink=true, $aMarkers=false)
	_replaceMarkers ($mixed, $aMarkers)

Protected Attributes
	$_oModule
	$_bIsApi
	$_bDynamicMode
	$_bAjaxMode
	$_bValidMode
	$_bAbsoluteActionUrl
	$_mixedContextId

Detailed Description

Entry forms helper functions

Member Function Documentation

deleteData()

BxBaseModGeneralFormsEntryHelper::deleteData	(		$iContentId,
			$aContentInfo = false,
			$oProfile = null,
			$oForm = null )

Delete data entry

Parameters

$iContentId	entry id
$oForm	optional content info array
$aContentInfo	optional content info array
$oProfile	optional content author profile

Returns

error string on error or empty string on success

Hooks:

'{module_name}', 'deleted' - hook after content was deleted

• $unit_name - module name
• $action - equals deleted
• $object_id - content id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • content - [array] by ref, content info array as key&value pairs, can be overridden in hook processing

HOOKS

'{module_name}', 'deleted' - hook after content was deleted

Reimplemented in BxBaseModProfileFormsEntryHelper, and BxCnvFormsEntryHelper.

editData()

BxBaseModGeneralFormsEntryHelper::editData	(		$iContentId,
			$aValues,
			$sDisplay = false )

Returns

empty string on success or error message string on error

redirectAfterAdd()

BxBaseModGeneralFormsEntryHelper::redirectAfterAdd	(		$aContentInfo,
			$sUrl = '' )

Hooks:

'{module_name}', 'redirect_after_add' - hook to override redirect URL which is used after content creation

• $unit_name - module name
• $action - equals redirect_after_add
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • ajax_mode - [boolean] dynamic loading is used or not
  • content - [array] content info array as key&value pairs
  • override_result - [string] by ref, redirect URL, can be overridden in hook processing

HOOKS

'{module_name}', 'redirect_after_add' - hook to override redirect URL which is used after content creation

redirectAfterDelete()

BxBaseModGeneralFormsEntryHelper::redirectAfterDelete ( $aContentInfo )

protected

Hooks:

'{module_name}', 'redirect_after_delete' - hook to override redirect URL which is used after content deletion

It's equivalent to '{module_name}', 'redirect_after_add' - hook to override redirect URL which is used after content creation except markers parameter was added to $extra_params. It allows to override an array of markers, which can be parsed in URL.

HOOKS

'{module_name}', 'redirect_after_delete' - hook to override redirect URL which is used after content deletion

redirectAfterEdit()

BxBaseModGeneralFormsEntryHelper::redirectAfterEdit ( $aContentInfo, $sUrl = '' )

protected

Hooks:

'{module_name}', 'redirect_after_edit' - hook to override redirect URL which is used after content changing

It's equivalent to '{module_name}', 'redirect_after_add' - hook to override redirect URL which is used after content creation except ajax_mode parameter in $extra_params is missing

HOOKS

'{module_name}', 'redirect_after_edit' - hook to override redirect URL which is used after content changing

Reimplemented in BxBaseModGroupsFormsEntryHelper.

Member Data Documentation

$_bAbsoluteActionUrl

BxBaseModGeneralFormsEntryHelper::$_bAbsoluteActionUrl

protected

Use absolute Action URL in generated form object. It's needed in Ajax Mode.

$_bAjaxMode

BxBaseModGeneralFormsEntryHelper::$_bAjaxMode

protected

'Ajax Mode' determines the format of response. If it's TRUE the response (a form or an error appeared during form creation) should be returned as text during initial loading, while all other responses appeared after form submit should be arrays, which are ready to path to echoJson.

$_bValidMode

BxBaseModGeneralFormsEntryHelper::$_bValidMode

protected

'Valid Mode' allows to create content even if some fields values didn't pass checking. It's needed when content was created with a service call. For example, automatic profile creation after join.

---

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

• modules/base/general/classes/BxBaseModGeneralFormsEntryHelper.php