Inheritance diagram for BxAlbumsModule:

Public Member Functions
	__construct (&$aModule)

	serviceGetSafeServices ()

	actionEmbed ($iContentId, $sUnitTemplate='', $sAddCode='')

	actionEmbedMedia ($iContentId)

	serviceEntityAllActions ($mixedContent=false, $aParams=array())

	serviceEntityAddFiles ($iContentId=0)

	serviceDeleteFileAssociations ($iFileId)

	serviceMediaComments ($iMediaId=0)

	serviceMediaAuthor ($iMediaId=0)

	serviceMediaAllActions ($mixedContent=false, $aParams=array())

	serviceMediaActions ($iContentId=0)

	serviceMediaSocialSharing ($iMediaId=0)

	serviceMediaView ($iMediaId=0, $mixedContext=false, $aParams=array())

	checkAllowedSetThumb ($iContentId=0)

	serviceBrowseRecentMedia ($sUnitView=false, $bDisplayEmptyMsg=true, $bAjaxPaginate=true)

	serviceBrowseFeaturedMedia ($sUnitView=false, $bDisplayEmptyMsg=false, $bAjaxPaginate=true)

	serviceBrowsePopularMedia ($sUnitView=false, $bDisplayEmptyMsg=true, $bAjaxPaginate=true)

	serviceBrowseTopMedia ($sUnitView=false, $bDisplayEmptyMsg=true, $bAjaxPaginate=true)

	serviceBrowseFavoriteMedia ($iProfileId=0, $aParams=array())

	serviceGetTimelineData ()

	serviceGetTimelineMedia ($aEvent, $aBrowseParams=array())

	serviceGetNotificationsData ()

	serviceGetNotificationsMedia ($aEvent)

	serviceGetNotificationsCommentMedia ($aEvent)

	serviceGetNotificationsVoteMedia ($aEvent)

	serviceGetNotificationsScoreUpMedia ($aEvent)

	serviceGetNotificationsScoreDownMedia ($aEvent)

	actionEditMedia ($iMediaId)

	actionDeleteMedia ($iMediaId)

	actionMoveMedia ($iMediaId)

	actionGetSiblingMedia ($iMediaId, $mixedContext)

	actionRssMedia ()

	getMediaDuration ($aMediaInfo)

Public Member Functions inherited from BxBaseModTextModule
	actionEmbedPoll ($iPollId=0)

	actionEmbedPolls ($iId=0)

	actionGetPoll ()

	actionDeletePoll ()

	actionGetPollForm ()

	actionSubmitPollForm ()

	actionGetAttachLinkForm ()

	actionSubmitAttachLinkForm ()

	actionAddAttachLink ()

	actionDeleteAttachLink ()

	actionFileEmbedVideo ($iFileId)

	actionFileEmbedSound ($iFileId)

	serviceManageTools ($sType='common')

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

	serviceGetBlockPollAnswers ($iPollId, $bForceDisplay=false)

	serviceGetBlockPollResults ($iPollId)

	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)

	serviceEntityPolls ($iContentId=0)

	serviceEntityBreadcrumb ($iContentId=0)

	serviceDeleteEntitiesByAuthor ($iProfileId)

	isAllowedApprove ($mixedContent, $isPerformAction=false)

	checkAllowedApprove ($mixedContent, $isPerformAction=false)

	isPollPerformed ($iObjectId, $iAuthorId=0, $iAuthorIp=0)

	addAttachLink ($aValues, $sDisplay=false)

	deleteAttachLinks ($iId)

	deleteAttachLinksUnused ($iProfileId)

	getFormAttachLink ($iContentId=0)

	onApprove ($mixedContent)

	alertAfterAdd ($aContentInfo)

	alertAfterEdit ($aContentInfo)

	getPollForm ()

	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 ()

	actionGetCreatePostForm ()

	actionGetNotes ()

	actionNested ()

	subactionDelete ()

	actionAjaxGetProfiles ()

	serviceGetProfiles ($sParams)

	actionGetBrowsingFilters ()

	actionApplyBrowsingFilters ()

	serviceIsBadgesAvaliable ()

	serviceModuleIcon ()

	serviceGetAuthor ($iContentId)

	serviceGetPrivacyView ($iContentId)

	serviceGetDateAdded ($iContentId)

	serviceGetDateChanged ($iContentId)

	serviceGetLink ($iContentId)

	serviceGetTitle ($iContentId)

	serviceGetText ($iContentId)

	serviceGetLocation ($iContentId)

	serviceGetEmbed ($iContentId)

	serviceGetInfo ($iContentId, $bSearchableFieldsOnly=true)

	serviceGetInfoApi ($iContentId, $bExtendedUnits=false)

	serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')

	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=[])

	serviceFavoritesListActions ()

	serviceFavoritesListInfo ($aParams=array())

	serviceBrowseContext ($iProfileId=0, $aParams=array())

	_serviceBrowseWithParam ($sParamName, $sParamGet, $sParamVal, $aParams=array())

	serviceFormsHelper ()

	serviceEntityAdd ($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)

	serviceDeleteEntity ($iContentId, $sFuncDelete='deleteData')

	serviceMyEntriesActions ($iProfileId=0)

	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)

	serviceGetNotificationsPost ($aEvent)

	serviceGetNotificationsPostPendingApproval ($aEvent)

	serviceGetNotificationsPostApproved ($aEvent)

	serviceGetNotificationsPostPublishFailed ($aEvent)

	serviceGetNotificationsPostPublishSucceeded ($aEvent)

	serviceGetNotificationsComment ($aEvent)

	serviceGetNotificationsReply ($aEvent)

	serviceGetNotificationsVote ($aEvent)

	serviceGetNotificationsReaction ($aEvent)

	serviceGetNotificationsScoreUp ($aEvent)

	serviceGetNotificationsScoreDown ($aEvent)

	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 ($bDisplayEmptyCats=true)

	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')

	onPublished ($iContentId)

	onFailed ($iContentId)

	onUpdateImage ($iContentId, $sFiledName, $sFiledValue, $iProfileId=0)

	alertAfterApprove ($aContentInfo)

	processMetasAdd ($iContentId)

	processMetasEdit ($iContentId, $oForm)

	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
	_serviceGetNotificationsScoreMedia ($sType, $aEvent)

	_buildRssParams ($sMode, $aArgs)

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

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

	_getContentForTimelineMedia ($aEvent, $aContentInfo, $aBrowseParams=array())

	_getImagesForTimelineMedia ($aEvent, $aMediaInfo, $sUrl, $aBrowseParams=array())

Protected Member Functions inherited from BxBaseModTextModule
	_addLink (&$oForm)

	_alertParams ($aContentInfo)

	_alertParamsAdd ($aContentInfo)

	_alertParamsEdit ($aContentInfo)

	_getAlertParamTimelineGroup ($aContentInfo)

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

	_getImagesForTimelinePostAttachInner ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())

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

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

Protected Member Functions inherited from BxBaseModGeneralModule
	_prepareBrowsingFiltersParamsGet ($mParams=false)

	_serviceGetNotificationsScore ($sType, $aEvent)

	_serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId)

	_serviceBrowseQuick ($aProfiles, $iStart=0, $iLimit=4, $aAdditionalParams=array())

	_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())

Protected Attributes
	$_aContexts = array('popular', 'public', 'author')

Protected Attributes inherited from BxBaseModGeneralModule
	$_bIsApi

	$_iProfileId

	$_aSearchableNamesExcept

	$_aFormParams

	$_aBrowsingFiltersKeys

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

Detailed Description

Albums module

Constructor & Destructor Documentation

◆ __construct()

BxAlbumsModule::__construct ( & $aModule )

Reimplemented from BxBaseModTextModule.

Member Function Documentation

◆ _buildRssParams()

BxAlbumsModule::_buildRssParams	(		$sMode,
			$aArgs )

protected

Reimplemented from BxBaseModTextModule.

◆ _getImagesForTimelinePostAttach()

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

protected

Reimplemented from BxBaseModTextModule.

◆ _getVideosForTimelinePostAttach()

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

protected

Reimplemented from BxBaseModTextModule.

◆ actionEmbed()

BxAlbumsModule::actionEmbed	(	$iContentId,
		$sUnitTemplate = '',
		$sAddCode = '' )

Reimplemented from BxBaseModGeneralModule.

◆ checkAllowedSetThumb()

BxAlbumsModule::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 BxBaseModTextModule.

◆ serviceBrowseFavoriteMedia()

BxAlbumsModule::serviceBrowseFavoriteMedia	(		$iProfileId = 0,
			$aParams = array() )

browse_favorite_media

◆ serviceBrowseFeaturedMedia()

BxAlbumsModule::serviceBrowseFeaturedMedia	(	$sUnitView = false,
		$bDisplayEmptyMsg = false,
		$bAjaxPaginate = true )

browse_featured_media

◆ serviceBrowsePopularMedia()

BxAlbumsModule::serviceBrowsePopularMedia	(	$sUnitView = false,
		$bDisplayEmptyMsg = true,
		$bAjaxPaginate = true )

browse_popular_media

◆ serviceBrowseRecentMedia()

BxAlbumsModule::serviceBrowseRecentMedia	(	$sUnitView = false,
		$bDisplayEmptyMsg = true,
		$bAjaxPaginate = true )

browse_recent_media

◆ serviceBrowseTopMedia()

BxAlbumsModule::serviceBrowseTopMedia	(	$sUnitView = false,
		$bDisplayEmptyMsg = true,
		$bAjaxPaginate = true )

browse_top_media

◆ serviceDeleteFileAssociations()

BxAlbumsModule::serviceDeleteFileAssociations ( $iFileId )

Delete file and album association, also file views, votes, comments, meta data are also deleted

Parameters

$iFileId file ID

Returns: true on success of false on error

Hooks:

'bx_albums', 'media_deleted' - hook on new media deleted from album

$unit_name - equals bx_albums
$action - equals media_deleted
$object_id - album_id
$sender_id - author's profile_id
$extra_params - array of additional params with the following array keys:
- object_author_id - [int] confirmation type can be none/phone/email/email_and_phone/email_or_phone
- subobject_id - [int] id for added media
- media_id - [int] id for added media
- media_info - [array] media info
  HOOKS
  'bx_albums', 'media_deleted' - hook on new media deleted from album

◆ serviceEntityAddFiles()

BxAlbumsModule::serviceEntityAddFiles ( $iContentId = 0 )

entity_add_files

◆ serviceEntityAllActions()

BxAlbumsModule::serviceEntityAllActions	(		$mixedContent = false,
			$aParams = array() )

Entry actions and social sharing block

Reimplemented from BxBaseModGeneralModule.

◆ serviceGetNotificationsData()

BxAlbumsModule::serviceGetNotificationsData ( )

Data for Notifications module

Reimplemented from BxBaseModGeneralModule.

◆ serviceGetSafeServices()

BxAlbumsModule::serviceGetSafeServices ( )

Reimplemented from BxBaseModTextModule.

◆ serviceGetTimelineData()

BxAlbumsModule::serviceGetTimelineData ( )

Data for Timeline module

Reimplemented from BxBaseModGeneralModule.

◆ serviceMediaActions()

BxAlbumsModule::serviceMediaActions ( $iContentId = 0 )

Entry actions block

◆ serviceMediaAllActions()

BxAlbumsModule::serviceMediaAllActions	(		$mixedContent = false,
			$aParams = array() )

Entry actions and social sharing block

◆ serviceMediaAuthor()

BxAlbumsModule::serviceMediaAuthor ( $iMediaId = 0 )

Display media author block.

Parameters

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

Returns: HTML string with block content. On error false or empty string is returned.

◆ serviceMediaComments()

BxAlbumsModule::serviceMediaComments ( $iMediaId = 0 )

media_comments

◆ serviceMediaSocialSharing()

BxAlbumsModule::serviceMediaSocialSharing ( $iMediaId = 0 )

Display media social sharing buttons block.

Parameters

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

Returns: HTML string with block content. On error false or empty string is returned.

◆ serviceMediaView()

BxAlbumsModule::serviceMediaView	(	$iMediaId = 0,
		$mixedContext = false,
		$aParams = array() )

Display media preview block.

Parameters

$iMediaId	media ID, if it's omitted then it's taken from 'id' GET variable.
$mixedContext	current context to navigate to next and previous file, possible values: popular, public, author. If omitted then value from 'context' GTE variable is taken. Default context is 'album' - when nothin is specified.
$aParams	array of additional params.

Returns: HTML string with block content. On error false or empty string is returned.

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

modules/boonex/albums/classes/BxAlbumsModule.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _buildRssParams()

◆ _getImagesForTimelinePostAttach()

◆ _getVideosForTimelinePostAttach()

◆ actionEmbed()

◆ checkAllowedSetThumb()

◆ serviceBrowseFavoriteMedia()

◆ serviceBrowseFeaturedMedia()

◆ serviceBrowsePopularMedia()

◆ serviceBrowseRecentMedia()

◆ serviceBrowseTopMedia()

◆ serviceDeleteFileAssociations()

Hooks:

'bx_albums', 'media_deleted' - hook on new media deleted from album

◆ serviceEntityAddFiles()

◆ serviceEntityAllActions()

◆ serviceGetNotificationsData()

◆ serviceGetSafeServices()

◆ serviceGetTimelineData()

◆ serviceMediaActions()

◆ serviceMediaAllActions()

◆ serviceMediaAuthor()

◆ serviceMediaComments()

◆ serviceMediaSocialSharing()

◆ serviceMediaView()