BxBaseModTextModule Class Reference

Inheritance diagram for BxBaseModTextModule:

Public Member Functions
	__construct (&$aModule)
	actionFileEmbedVideo ($iFileId)
	actionFileEmbedSound ($iFileId)
	serviceGetSafeServices ()
	serviceManageTools ($sType='common')
	serviceCategoriesMultiListContext ($iProfileId=0, $bDisplayEmptyCats=true)
	serviceMediaExif ($iMediaId=0)
	serviceGetThumb ($iContentId, $sTranscoder='')
	serviceGetMenuAddonManageTools ()
	serviceGetMenuAddonManageToolsProfileStats ($iProfileId=0)
	serviceBrowsePublic ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true)
	serviceBrowsePopular ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true)
	serviceBrowseTop ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true)
	serviceBrowseUpdated ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true)
	serviceBrowseAuthor ($iProfileId=0, $aParams=array())
	serviceEntityAuthor ($iContentId=0)
	serviceEntityBreadcrumb ($iContentId=0)
	serviceDeleteEntitiesByAuthor ($iProfileId)
	checkAllowedSetThumb ($iContentId=0)
	isAllowedApprove ($mixedContent, $isPerformAction=false)
	checkAllowedApprove ($mixedContent, $isPerformAction=false)
	deleteAttachLinks ($iId)
	deleteAttachLinksUnused ($iProfileId)
	onApprove ($mixedContent)
	alertAfterAdd ($aContentInfo)
	alertAfterEdit ($aContentInfo)
	getEntryImageData ($aContentInfo, $sField='FIELD_THUMB', $aTranscoders=array())
	decodeDataAPI ($aData, $aParams=[])
	serviceIsAllowedPostInContext ()
Public Member Functions inherited from BxBaseModGeneralModule
	isEntryActive ($aContentInfo)
	isEntryAuthor ($aContentInfo, $iProfileId=0)
	actionUpdateImage ($sFiledName, $iContentId, $sValue)
	actionUpdateImagePosition ($iContentId, $sFiledName, $sH, $sV)
	actionApprove ()
	serviceSetStatus ($iId, $sValue, $sStatus='')
	actionRss ()
	actionGetAttachLinkForm ()
	actionSubmitAttachLinkForm ()
	actionAddAttachLink ()
	actionDeleteAttachLink ()
	actionEmbedPoll ($iPollId=0)
	actionEmbedPolls ($iId=0)
	actionGetPoll ()
	actionDeletePoll ()
	actionGetPollForm ()
	actionSubmitPollForm ()
	serviceGetPollForm ()
	serviceSubmitPollForm ()
	serviceDeletePoll ($iId)
	getPollForm ($iParentCid=0)
	actionGetCreatePostForm ()
	actionGetNotes ()
	actionNested ()
	actionEmbed ($iContentId, $sUnitTemplate='', $sAddCode='')
	subactionDelete ()
	actionAjaxGetProfiles ()
	serviceGetProfiles ($sParams)
	actionGetBrowsingFilters ()
	actionApplyBrowsingFilters ()
	serviceIsActive ($iContentId)
	serviceIsAllowedAddContentToContext ($iContextPid)
	serviceIsBadgesAvaliable ()
	serviceModuleIcon ()
	serviceGetAuthor ($iContentId)
	serviceGetPrivacyView ($iContentId)
	serviceGetDateAdded ($iContentId)
	serviceGetDateChanged ($iContentId)
	serviceGetLinkAdd ()
	serviceGetLinkEdit ($iContentId)
	serviceGetLink ($iContentId)
	serviceGetTitle ($iContentId)
	serviceGetText ($iContentId)
	serviceGetLocation ($iContentId)
	serviceGetEmbed ($iContentId)
	serviceGetInfo ($iContentId, $bSearchableFieldsOnly=true)
	serviceGetInfoApi ($iContentId, $bExtendedUnits=false)
	serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')
	serviceGetView ($iContentId)
	serviceGetAll ($aParams=array())
	serviceGetAllByAuthor ($iProfileId)
	serviceGetSortableFieldsExtended ($aInputsAdd=array())
	serviceGetSearchableFieldsExtended ($aInputsAdd=array())
	serviceGetSearchResultExtended ($aParams, $iStart=0, $iPerPage=0, $bFilterMode=false)
	serviceGetSearchableFields ($aInputsAdd=array())
	serviceUpdateImage ($sFiledName, $iContentId, $sValue)
	serviceUpdateImagePosition ($iContentId, $sFiledName, $sH, $sV)
	serviceBrowse ($aParams=array())
	serviceBrowseWithCondition ($aParams=array())
	serviceBrowseFeatured ($sUnitView=false, $bEmptyMessage=false, $bAjaxPaginate=true)
	serviceBrowseFavorite ($iProfileId=0, $aParams=array())
	serviceBrowseFavoriteLists ($iProfileId=0, $aParams=array())
	serviceBrowseCategory ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true, $aParams=[])
	serviceBrowseMultiCategory ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true, $aParams=[])
	serviceFavoritesListActions ()
	serviceFavoritesListInfo ($aParams=array())
	serviceBrowseContext ($iProfileId=0, $aParams=array())
	_serviceBrowseWithParam ($sParamName, $sParamGet, $sParamVal, $aParams=array())
	getFormsHelper ()
	serviceFormsHelper ()
	serviceEntityAdd ($iProfile, $aValues, $sDisplay=false)
	serviceEntityAddForcedly ($iProfile, $aValues, $sDisplay=false)
	serviceRedirectAfterAdd ($aContentInfo)
	serviceGetObjectForm ($sType, $aParams=array())
	serviceEntityCreate ($sParams=false)
	serviceGetCreatePostForm ($aParams=[])
	serviceEntityEdit ($iContentId=0, $sDisplay=false)
	serviceEntityDelete ($iContentId=0)
	serviceEntityTextBlock ($iContentId=0)
	serviceEntityInfo ($iContentId=0, $sDisplay=false)
	serviceEntityInfoFull ($iContentId=0)
	serviceEntityInfoExtended ($iContentId=0)
	serviceEntityLocation ($iContentId=0)
	serviceEntityComments ($iContentId=0)
	serviceEntityAttachments ($iContentId=0)
	serviceEntityPolls ($iContentId=0)
	serviceDeleteEntity ($iContentId, $sFuncDelete='deleteData')
	serviceEditEntity ($iContentId, $aValues)
	serviceMyEntriesActions ($iProfileId=0)
	serviceEntityAllActions ($mixedContent=false, $aParams=array())
	serviceEntityActions ($iContentId=0)
	serviceEntityReports ($iContentId=0)
	serviceReportsCountByStatus ($iStatus)
	serviceEntitySocialSharing ($mixedContent=false, $aParams=array())
	serviceEntityContext ($iContentId=0)
	serviceGetLablesTree ()
	serviceGetLablesBreadcrumbs ()
	serviceBrowseByLabel ()
	serviceBrowseByCategories ($sUnitView, $bEmptyMessage, $bAjaxPaginate, $sMode, $iPerPage)
	serviceGetBlockPollAnswers ($iPollId, $bForceDisplay=false)
	serviceGetBlockPollResults ($iPollId)
	serviceGetNotificationsData ()
	serviceGetNotificationsPost ($aEvent)
	serviceGetNotificationsPostPendingApproval ($aEvent)
	serviceGetNotificationsPostApproved ($aEvent)
	serviceGetNotificationsPostPublishFailed ($aEvent)
	serviceGetNotificationsPostPublishSucceeded ($aEvent)
	serviceGetNotificationsComment ($aEvent)
	serviceGetNotificationsReply ($aEvent)
	serviceGetNotificationsVote ($aEvent)
	serviceGetNotificationsReaction ($aEvent)
	serviceGetNotificationsScoreUp ($aEvent)
	serviceGetNotificationsScoreDown ($aEvent)
	serviceGetReputationData ()
	serviceGetTimelineData ()
	serviceGetTimelinePost ($aEvent, $aBrowseParams=array())
	serviceGetTimelinePostAllowedView ($aEvent)
	serviceCheckAllowed ($sAction, $isPerformAction=false)
	serviceCheckAllowedWithContent ($sAction, $iContentId, $isPerformAction=false)
	serviceCheckAllowedWithContentForProfile ($sAction, $iContentId, $iProfileId, $isPerformAction=false)
	serviceCheckAllowedCommentsView ($iContentId, $sObjectComments)
	serviceCheckAllowedCommentsPost ($iContentId, $sObjectComments)
	serviceGetContentOwnerProfileId ($iContentId)
	serviceGetBadges ($iContentId, $bIsSingle=false, $bIsCompact=false)
	serviceCategoriesMultiList ($bAsArray=false)
	serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction=false, $iProfileId=false)
	checkAllowedBrowse ()
	checkAllowedView ($aDataEntry, $isPerformAction=false)
	checkAllowedViewForProfile ($aDataEntry, $iProfileId, $isPerformAction=false)
	checkAllowedAdd ($isPerformAction=false)
	checkAllowedEdit ($aDataEntry, $isPerformAction=false)
	checkAllowedDelete (&$aDataEntry, $isPerformAction=false)
	checkAllowedSetMembership (&$aDataEntry, $isPerformAction=false)
	checkAllowedEditAnyEntry ($isPerformAction=false)
	checkAllowedDeleteAnyEntry ($isPerformAction=false)
	checkAllowedEditAnyEntryForProfile ($isPerformAction=false, $iProfileId=false)
	checkAllowedDeleteAnyEntryForProfile ($isPerformAction=false, $iProfileId=false)
	checkAllowedCommentsView ($aContentInfo, $isPerformAction=false)
	checkAllowedCommentsPost ($aContentInfo, $isPerformAction=false)
	_serviceBrowse ($sMode, $aParams=false, $iDesignBox=BX_DB_PADDING_DEF, $bDisplayEmptyMsg=false, $bAjaxPaginate=true, $sClassSearchResult='SearchResult')
	isPollPerformed ($iObjectId, $iAuthorId=0, $iAuthorIp=0)
	getPollPerformedValue ($iObjectId, $iAuthorId=0)
	onPublished ($iContentId)
	onFailed ($iContentId)
	onUpdateImage ($iContentId, $sFiledName, $sFiledValue, $iProfileId=0)
	alertAfterApprove ($aContentInfo)
	processMetasAdd ($iContentId)
	processMetasEdit ($iContentId, $oForm)
	addAttachLink ($aValues, $sDisplay=false)
	getFormAttachLink ($iContentId=0)
	getEntryAllActions ($mixedContent=false, $aParams=[])
	getProfileId ()
	getProfileInfo ($iUserId=false)
	getObjectUser ($iUserId=false)
	getObjectFavorite ($sSystem='', $iId=0)
	getUserId ()
	getUserIp ()
	getUserInfo ($iUserId=0)
	getUserInfoWithBadges ($iUserId=0)
	isMenuItemVisible ($sObject, &$aItem, &$aContentInfo)
	_isModerator ($isPerformAction=false)
	_isModeratorForProfile ($isPerformAction=false, $iProfileId=false)
	_isAdministrator ($isPerformAction=false)
	_isAdministratorForProfile ($isPerformAction=false, $iProfileId=false)
	_prepareAuditParams ($aContentInfo, $bIsSaveData=true, $aOverrideAuditParams=array())
	_getFavoriteListUrl ($iListId, $iProfileId)
	getDataAPI ($aData, $aParams=[])
Public Member Functions inherited from BxDolModule
	__construct ($aModule)
	isEnabled ()
	getName ()
	isLogged ()
	getUserPassword ()
	serviceIsSafeService ($s)
	serviceIsPublicService ($s)
	serviceGetPublicServices ()
Public Member Functions inherited from iBxDolContentInfoService
	serviceGetAuthor ($iContentId)
	serviceGetDateAdded ($iContentId)
	serviceGetDateChanged ($iContentId)
	serviceGetLink ($iContentId)
	serviceGetTitle ($iContentId)
	serviceGetText ($iContentId)
	serviceGetThumb ($iContentId)
	serviceGetInfo ($iContentId, $bSearchableFieldsOnly=true)
	serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')
	serviceGetAll ($aParams=array())
	serviceGetSearchableFieldsExtended ($aInputsAdd=array())
	serviceGetSearchResultExtended ($aParams, $iStart=0, $iPerPage=0, $bFilterMode=false)

Protected Member Functions
	_alertParams ($aContentInfo)
	_alertParamsAdd ($aContentInfo)
	_alertParamsEdit ($aContentInfo)
	_getAlertParamTimelineGroup ($aContentInfo)
	_getImagesForTimelinePost ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getImagesForTimelinePostAttach ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getImagesForTimelinePostAttachInner ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getVideosForTimelinePostAttach ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getFilesForTimelinePostAttach ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getContentForTimelinePost ($aEvent, $aContentInfo, $aBrowseParams=array())
	_buildRssParams ($sMode, $aArgs)
Protected Member Functions inherited from BxBaseModGeneralModule
	_prepareBrowsingFiltersParamsGet ($mParams=false)
	_serviceGetNotificationsScore ($sType, $aEvent)
	_serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId)
	_serviceBrowseQuick ($aProfiles, $iStart=0, $iLimit=4, $aAdditionalParams=array())
	_addLink (&$oForm)
	_serviceEntityForm ($sFormMethod, $iContentId=0, $sDisplay=false, $sCheckFunction=false, $bErrorMsg=true)
	_serviceTemplateFunc ($sFunc, $iContentId, $sFuncGetContent='getContentInfoById')
	_serviceTemplateFuncEx ($sFunc, $iContentId, $aParams=array())
	_getApproveForm ($iContentId, $aContentInfo)
	_sendApproveMessage ($iContentId, $aContentInfo, &$oForm)
	_processModerationNotifications ($aContentInfo)
	_rss ($aArgs, $sClass='SearchResult')
	_getContent ($iContentId=0, $sFuncGetContent=true)
	_getVideosForTimelinePost ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getFilesForTimelinePost ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_entityComments ($sObject, $iId=0)
	_getFields ($iContentId)
	_getFieldValue ($sField, $iContentId)
	_getFieldValueThumb ($sField, $iContentId, $sTranscoder='')
	_prepareResponse ($aResponse, $bAsJson=false, $aAdditional=array())

Additional Inherited Members
Static Public Member Functions inherited from BxDolModule
static	getInstance ($sName)
static	getTitle ($sUri)
static	getTitleKey ($sUri)
Public Attributes inherited from BxDolModule
	$_aModule
	$_oDb
	$_oTemplate
	$_oConfig
Protected Attributes inherited from BxBaseModGeneralModule
	$_bIsApi
	$_iProfileId
	$_aSearchableNamesExcept
	$_aFormParams
	$_aBrowsingFiltersKeys

Detailed Description

Base module class for text based modules

Constructor & Destructor Documentation

__construct()

BxBaseModTextModule::__construct

(

&

$aModule

)

Reimplemented from BxBaseModGeneralModule.

Member Function Documentation

_alertParams()

BxBaseModTextModule::_alertParams ( $aContentInfo )

protected

Get array of params to be passed in Add/Edit Alert.

Reimplemented from BxBaseModGeneralModule.

_getContentForTimelinePost()

BxBaseModTextModule::_getContentForTimelinePost ( $aEvent, $aContentInfo, $aBrowseParams = array() )

protected

Reimplemented from BxBaseModGeneralModule.

_getFilesForTimelinePostAttach()

BxBaseModTextModule::_getFilesForTimelinePostAttach ( $aEvent, $aContentInfo, $sUrl, $aBrowseParams = array() )

protected

Reimplemented from BxBaseModGeneralModule.

_getImagesForTimelinePost()

BxBaseModTextModule::_getImagesForTimelinePost ( $aEvent, $aContentInfo, $sUrl, $aBrowseParams = array() )

protected

Reimplemented from BxBaseModGeneralModule.

_getImagesForTimelinePostAttach()

BxBaseModTextModule::_getImagesForTimelinePostAttach ( $aEvent, $aContentInfo, $sUrl, $aBrowseParams = array() )

protected

Reimplemented from BxBaseModGeneralModule.

_getVideosForTimelinePostAttach()

BxBaseModTextModule::_getVideosForTimelinePostAttach ( $aEvent, $aContentInfo, $sUrl, $aBrowseParams = array() )

protected

Reimplemented from BxBaseModGeneralModule.

alertAfterAdd()

BxBaseModTextModule::alertAfterAdd

(

$aContentInfo

)

Hooks:

'system', 'prepare_alert_params' - hook to override alert (hook) params

• $unit_name - equals system
• $action - equals prepare_alert_params
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • unit - [string] unit name
  • action - [string] by ref, action, can be overridden in hook processing
  • object_id - [int] by ref, object id, can be overridden in hook processing
  • sender_id - [int] by ref, action performer profile id, can be overridden in hook processing
  • extras - [array] by ref, extra params array as key&value pairs, can be overridden in hook processing

    HOOKS

    'system', 'prepare_alert_params' - hook to override alert (hook) params

Hooks:

'{module_name}', 'added' - hook after content was added (published)

• $unit_name - module name
• $action - equals added
• $object_id - content id
• $sender_id - content author profile id
• $extra_params - array of additional params with the following array keys:
  • status - [string] content status
  • status_admin - [string] content admin status
  • privacy_view - [int] or [string] privacy for view content action,

    See also

    BxDolPrivacy

  • cf - [int] content's audience filter value

    HOOKS

    '{module_name}', 'added' - hook after content was added (published)

Hooks:

'{module_name}', 'deferred' - hook after content was added with pending approval status

It's equivalent to '{module_name}', 'added' - hook after content was added (published)

HOOKS

'{module_name}', 'deferred' - hook after content was added with pending approval status

Reimplemented from BxBaseModGeneralModule.

alertAfterEdit()

BxBaseModTextModule::alertAfterEdit

(

$aContentInfo

)

Hooks:

'{module_name}', 'edited' - hook after content was changed

It's equivalent to '{module_name}', 'added' - hook after content was added (published)

HOOKS

'{module_name}', 'edited' - hook after content was changed

Reimplemented from BxBaseModGeneralModule.

checkAllowedApprove()

BxBaseModTextModule::checkAllowedApprove	(		$aDataEntry,
			$isPerformAction = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented from BxBaseModGeneralModule.

checkAllowedSetThumb()

BxBaseModTextModule::checkAllowedSetThumb

(

$iContentId = 0

)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented from BxBaseModGeneralModule.

Reimplemented in BxAlbumsModule, BxCnvModule, BxFilesModule, BxPhotosModule, BxShopifyModule, BxStoriesModule, and BxStrmModule.

decodeDataAPI()

BxBaseModTextModule::decodeDataAPI	(		$aData,
			$aParams = [] )

Reimplemented from BxBaseModGeneralModule.

getEntryImageData()

BxBaseModTextModule::getEntryImageData	(		$aContentInfo,
			$sField = 'FIELD_THUMB',
			$aTranscoders = array() )

Reimplemented from BxBaseModGeneralModule.

onApprove()

BxBaseModTextModule::onApprove

(

$mixedContent

)

Reimplemented from BxBaseModGeneralModule.

serviceBrowseAuthor()

BxBaseModTextModule::serviceBrowseAuthor	(		$iProfileId = 0,
			$aParams = array() )

browse_author

Reimplemented in BxForumModule, and BxPhotosModule.

serviceBrowsePopular()

BxBaseModTextModule::serviceBrowsePopular	(		$sUnitView = false,
			$bEmptyMessage = true,
			$bAjaxPaginate = true )

browse_popular

serviceBrowsePublic()

BxBaseModTextModule::serviceBrowsePublic	(		$sUnitView = false,
			$bEmptyMessage = true,
			$bAjaxPaginate = true )

browse_public

serviceBrowseTop()

BxBaseModTextModule::serviceBrowseTop	(		$sUnitView = false,
			$bEmptyMessage = true,
			$bAjaxPaginate = true )

browse_top

serviceBrowseUpdated()

BxBaseModTextModule::serviceBrowseUpdated	(		$sUnitView = false,
			$bEmptyMessage = true,
			$bAjaxPaginate = true )

browse_updated

serviceCategoriesMultiListContext()

BxBaseModTextModule::serviceCategoriesMultiListContext	(		$iProfileId = 0,
			$bDisplayEmptyCats = true )

categories_multi_list_context

serviceDeleteEntitiesByAuthor()

BxBaseModTextModule::serviceDeleteEntitiesByAuthor

(

$iProfileId

)

Delete all content by profile

Parameters

$iProfileId

profile id

Returns

number of deleted items

Reimplemented in BxCnvModule, and BxFilesModule.

serviceEntityAuthor()

BxBaseModTextModule::serviceEntityAuthor

(

$iContentId = 0

)

entity_author

Reimplemented in BxForumModule.

serviceEntityBreadcrumb()

BxBaseModTextModule::serviceEntityBreadcrumb

(

$iContentId = 0

)

entity_breadcrumb

serviceGetMenuAddonManageTools()

BxBaseModTextModule::serviceGetMenuAddonManageTools

(

)

Reimplemented from BxBaseModGeneralModule.

serviceGetMenuAddonManageToolsProfileStats()

BxBaseModTextModule::serviceGetMenuAddonManageToolsProfileStats

(

$iProfileId = 0

)

get_menu_addon_manage_tools_profile_stats

Reimplemented from BxBaseModGeneralModule.

serviceGetSafeServices()

BxBaseModTextModule::serviceGetSafeServices

(

)

Reimplemented from BxBaseModGeneralModule.

Reimplemented in BxForumModule, and BxPollsModule.

serviceManageTools()

BxBaseModTextModule::serviceManageTools

(

$sType = 'common'

)

Reimplemented from BxBaseModGeneralModule.

serviceMediaExif()

BxBaseModTextModule::serviceMediaExif

(

$iMediaId = 0

)

Display media EXIF information.

Parameters

$iMediaId

media ID, if it's omitted then it's taken from 'id' GET variable.

Returns

HTML string with EXIF info. On error empty string is returned.

---

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

• modules/base/text/classes/BxBaseModTextModule.php