UNA
Loading...
Searching...
No Matches
BxBaseModGeneralFormsEntryHelper Class Reference
Inheritance diagram for BxBaseModGeneralFormsEntryHelper:
BxDolProfileForms BxDolFactory BxBaseModProfileFormsEntryHelper BxBaseModTextFormsEntryHelper BxBaseModGroupsFormsEntryHelper BxPersonsFormsEntryHelper BxAdsFormsEntryHelper BxAlbumsFormsEntryHelper BxBaseModFilesFormsEntryHelper BxClssFormsEntryHelper BxCnvFormsEntryHelper BxForumFormsEntryHelper BxGlsrFormsEntryHelper BxMarketFormsEntryHelper BxMassMailerFormsEntryHelper BxPollsFormsEntryHelper BxPostsFormsEntryHelper BxReviewsFormsEntryHelper BxShopifyFormsEntryHelper BxSnipcartFormsEntryHelper BxStrmFormsEntryHelper BxTasksFormsEntryHelper BxVideosFormsEntryHelper

Public Member Functions

 __construct ($oModule)
 
 setAjaxMode ($bAjaxMode)
 
 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)
 
 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())
 
 _setAbsoluteActionUrl ($sType, &$oForm)
 
- Protected Member Functions inherited from BxDolProfileForms
 __construct ()
 
 _redirectAndExit ($sUrl, $isPermalink=true, $aMarkers=false)
 
 _replaceMarkers ($mixed, $aMarkers)
 

Protected Attributes

 $_oModule
 
 $_bIsApi
 
 $_bDynamicMode
 
 $_bAjaxMode
 
 $_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
$iContentIdentry id
$oFormoptional content info array
$aContentInfooptional content info array
$oProfileoptional 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:

Reimplemented in BxBaseModProfileFormsEntryHelper, and BxCnvFormsEntryHelper.

◆ redirectAfterAdd()

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

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.


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