UNA
Service Calls

Service calls

Base General

Other

module_icon

bx_srv('bx_posts', 'module_icon', [...]);

Get module icon as CSS class name with FontAwesome icon name class and color class

See also
BxBaseModGeneralModule::serviceModuleIcon

Base General

Other

get_link

bx_srv('bx_posts', 'get_link', [...]);

Get URL for the specified content.

Parameters
$iContentIdcontent id
See also
BxBaseModGeneralModule::serviceGetLink

Base General

Browsing

get_search_result_unit

bx_srv('bx_posts', 'get_search_result_unit', [3,"unit_gallery.html"]);

Get browsing unit for the specified content

Parameters
$iContentIdcontent id
$sUnitTemplateunit template, such as: unit_full.html, unit_gallery.html, unit_live_search.html
See also
BxBaseModGeneralModule::serviceGetSearchResultUnit

Base General

Browsing

browse

bx_srv('bx_posts', 'browse', [...]);
{{~bx_posts:browse[{"mode":"author", "params":{"author":"10"}}]~}}

Universal browse method.

Parameters
$aParamscustom browse params, possible params are the following:
  • mode - browse mode, such as 'recent', 'featured', etc
  • params - custom params to browse method, for example 'unit_view' can be passed here
  • design_box - design box style,
See also
BxBaseFunctions::DesignBoxContent
  • empty_message - display or not "empty" message when there is no content
  • ajax_paginate - use AJAX paginate or not
BxBaseModGeneralModule::serviceBrowse

Base General

Browsing

browse_featured

bx_srv('bx_posts', 'browse_featured', [...]);

Display featured entries

Parameters
$sUnitViewbrowsing unity view, such as: full, extended, gallery, showcase
$bEmptyMessagedisplay or not "empty" message when there is no content
$bAjaxPaginateuse AJAX paginate or not
See also
BxBaseModGeneralModule::serviceBrowseFeatured

Base General

Browsing

browse_favorite

bx_srv('bx_posts', 'browse_favorite', [...]);

Display entries which were added to favorite list by some member

Parameters
$iProfileIdprofile ID
$aParamsadditional browse params, see BxBaseModGeneralModule::serviceBrowse
See also
BxBaseModGeneralModule::serviceBrowseFavorite BxBaseModGeneralModule::serviceBrowse

Base General

Browsing

browse_favorite_lists

bx_srv('bx_posts', 'browse_favorite_lists', [...]);

Display entries which were added to favorite lists grouped by lists by some member

Parameters
$iProfileIdprofile ID
$aParamsadditional browse params, see BxBaseModGeneralModule::serviceBrowse
See also
BxBaseModGeneralModule::serviceBrowseFavoriteLists BxBaseModGeneralModule::serviceBrowse

Base General

Browsing

browse_favorite_list_actions

bx_srv('bx_posts', 'browse_favorite_list_actions', [...]);

Display menu actions for favorite lists

See also
BxBaseModGeneralModule::serviceFavoritesListActions

Base General

Menu

favorites_list_info

bx_srv('bx_posts', 'favorites_list_info', [...]);

Favorites list info

Parameters
$aParamsarray with additional custom params which may overwrite some default values
See also
BxBaseModGeneralModule::serviceFavoritesListInfo

Base General

Forms

get_create_post_form

bx_srv('bx_posts', 'get_create_post_form');

Get content creation form

Parameters
$aParamsadditional parameters array: context_id, ajax_mode, absolute_action_url, displays
See also
BxBaseModGeneralModule::serviceGetCreatePostForm

Base General

Forms

entity_edit

bx_srv('bx_posts', 'entity_edit', [...]);

Get content edit form

Parameters
$iContentIdcontent ID
$sDisplayoptional form display name
See also
BxBaseModGeneralModule::serviceEntityEdit

Base General

Forms

entity_delete

bx_srv('bx_posts', 'entity_delete', [...]);

Get content delete form

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityDelete

Base General

Page Blocks

entity_text_block

bx_srv('bx_posts', 'entity_text_block', [...]);

Get content text/description

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityTextBlock

Base General

Page Blocks

entity_info

bx_srv('bx_posts', 'entity_info', [...]);

Get content info

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityInfo

Base General

Page Blocks

entity_info_full

bx_srv('bx_posts', 'entity_info_full', [...]);

Get full content info

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityInfoFull

Base General

Page Blocks

entity_info_extended

bx_srv('bx_posts', 'entity_info_extended', [...]);

Get extended content info

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityInfoExtended

Base General

Page Blocks

entity_location

bx_srv('bx_posts', 'entity_location', [...]);

Get content location

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityLocation

Base General

Page Blocks

entity_comments

bx_srv('bx_posts', 'entity_comments', [...]);

Get content comments

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityComments

Base General

Page Blocks

entity_attachments

bx_srv('bx_posts', 'entity_attachments', [...]);

Get content attachments

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityAttachments

Base General

Menu

my_entries_actions

bx_srv('bx_posts', 'my_entries_actions', [...]);

My entries actions menu

Parameters
$iProfileIdprofiles ID, if omitted it try to get it from 'profile_id' GET param
See also
BxBaseModGeneralModule::serviceMyEntriesActions

Base General

Menu

entity_all_actions

bx_srv('bx_posts', 'entity_all_actions', [...]);

Entry actions and social sharing actions

Parameters
$mixedContentcontent ID
$aParamsadditional params
See also
BxBaseModGeneralModule::serviceEntityAllActions

Base General

Menu

entity_actions

bx_srv('bx_posts', 'entity_actions', [...]);

Entry actions, without social sharing actions

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityActions

Base General

Page Blocks

entity_reports

bx_srv('bx_posts', 'entity_reports', [...]);

Get content reports

Parameters
$iContentIdcontent ID
See also
BxBaseModGeneralModule::serviceEntityReports

Base General

Page Blocks

reports_count_by_status

bx_srv('bx_posts', 'reports_count_by_status', [...]);

Get number of reports with specified status

Parameters
$iStatusstatus ID
See also
BxBaseModGeneralModule::serviceReportsCountByStatus

Base General

Menu

entity_social_sharing

bx_srv('bx_posts', 'entity_social_sharing', [...]);

Entry social sharing actions

Parameters
$mixedContentcontent ID or array with integer content ID and array with content info, or false
$aParamsarray with additional custom params which may overwrite some default values
See also
BxBaseModGeneralModule::serviceEntitySocialSharing

Base General

Page Blocks

categories_multi_list

bx_srv('bx_posts', 'categories_multi_list', [...]);

Display multi-categorories block with number of posts in each category

Parameters
$bDisplayEmptyCatsdisplay empty categories
See also
BxBaseModGeneralModule::serviceCategoriesMultiList

Base Notifications

Other

add_handlers

bx_srv('bx_notifications', 'add_handlers', [...]);

Register handlers for specified module.

Parameters
$sModuleUristring with module URI.
See also
BxBaseModNotificationsModule::serviceAddHandlers

Base Notifications

Other

delete_handlers

bx_srv('bx_notifications', 'delete_handlers', [...]);

Unregister handlers for specified module.

Parameters
$sModuleUristring with module URI.
See also
BxBaseModNotificationsModule::serviceDeleteHandlers

Base Notifications

Other

delete_module_events

bx_srv('bx_notifications', 'delete_module_events', [...]);

Delete all events for specified module.

Parameters
$sModuleUristring with module URI.
See also
BxBaseModNotificationsModule::serviceDeleteModuleEvents

Base Notifications

Other

get_actions_checklist

bx_srv('bx_notifications', 'get_actions_checklist', [...]);

Get available actions for module settings in Studio.

Returns
an array with available actions represented as key => value pairs.
See also
BxBaseModNotificationsModule::serviceGetActionsChecklist

Base Payment

Integration

get_cart_url

bx_srv('bx_payment', 'get_cart_url', [...], 'Cart');

Get shopping cart URL.

Parameters
$iVendor(optional) integer value with vendor ID.
Returns
string with shopping cart URL.
See also
BxBaseModPaymentCart::serviceGetCartUrl

Base Payment

Integration

get_add_to_cart_js

bx_srv('bx_payment', 'get_add_to_cart_js', [...], 'Cart');

Get JavaScript code to use in OnClick attributes.

Parameters
$iVendorinteger value with vendor ID.
$mixedModuleIdmixed value (ID, Name or URI) determining a module from which the action was initiated.
$iItemId$iItemId integer value with item ID.
$iItemCountinteger value with a number of items for purchasing.
$bNeedRedirect(optional) boolean value determining whether redirect is needed after add action or not.
$aCustom(optional) array with custom data to attach to an item added into a cart.
Returns
string with JavaScript code to use in OnClick attributes of HTML elements.
See also
BxBaseModPaymentCart::serviceGetAddToCartJs

Base Payment

Integration

get_add_to_cart_link

bx_srv('bx_payment', 'get_add_to_cart_link', [...], 'Cart');

Get HTML code for "Add to Cart" link.

Parameters
$iVendorIdinteger value with vendor ID.
$mixedModuleIdmixed value (ID, Name or URI) determining a module from which the action was initiated.
$iItemId$iItemId integer value with item ID.
$iItemCountinteger value with a number of items for purchasing.
$bNeedRedirect(optional) boolean value determining whether redirect is needed after add action or not.
$aCustom(optional) array with custom data to attach to an item added into a cart.
Returns
HTML string with link to display on the site.
See also
BxBaseModPaymentCart::serviceGetAddToCartLink

Base Payment

Integration

get_cart_item_descriptor

bx_srv('bx_payment', 'get_cart_item_descriptor', [...], 'Cart');

Get cart item descriptor: 1-2-3-1.

Parameters
$iVendorIdinteger value with vendor ID.
$iModuleIdinteger value with module ID determining a module from which the action was initiated.
$iItemId$iItemId integer value with item ID.
$iItemCountinteger value with a number of items for purchasing.
Returns
string with item descriptor.
See also
BxBaseModPaymentCart::serviceGetCartItemDescriptor

Base Payment

Integration

get_cart_items_count

bx_srv('bx_payment', 'get_cart_items_count', [...], 'Cart');

Get items count in member's shopping cart.

Parameters
$iUserId(optional) integer value with user ID. If empty value is provided then currently logged in user will be used.
Returns
integer value with items count.
See also
BxBaseModPaymentCart::serviceGetCartItemsCount

Base Payment

Integration

get_cart_items

bx_srv('bx_payment', 'get_cart_items', [...], 'Cart');

Get array with items shopping cart.

Parameters
$iSellerIdinteger value with seller ID.
$iModuleIdinteger value with module ID determining a module from which the action was initiated.
$iUserId(optional) integer value with user ID. If empty value is provided then currently logged in user will be used.
Returns
integer value with items count.
See also
BxBaseModPaymentCart::serviceGetCartItems

Base Payment

Integration

get_invoices_url

bx_srv('bx_payment', 'get_invoices_url', [...], 'Commissions');

Get invoices page URL.

Returns
string with invoices page URL.
See also
BxBaseModPaymentOrders::serviceGetOrdersUrl

Base Payment

Integration

get_invoices_count

bx_srv('bx_payment', 'get_invoices_count', [...], 'Commissions');

Get invoices count by type.

Parameters
$sTypestring value with type.
$iProfileId(optional) integer value with profile ID. If empty value is provided then currently logged in profile will be used.
Returns
integer value with invoices count.
See also
BxBaseModPaymentOrders::serviceGetOrdersCount

Base Payment

Integration

get_details_url

bx_srv('bx_payment', 'get_details_url', [...], 'Details');

Get payment providers' configuration settings page URL.

Returns
string with page URL.
See also
BxBaseModPaymentDetails::serviceGetDetailsUrl

Base Payment

Integration

update_dependent_modules

bx_srv('bx_payment', 'update_dependent_modules', [...]);

Get payments dependent modules and save them.

Parameters
$sModule(optional) string value with module name. All modules are used by default.
$bInstall(optional) boolean value determining whether the install or uninstall operation is performed.
See also
BxBaseModPaymentModule::serviceUpdateDependentModules

Base Payment

Other

generate_license

bx_srv('bx_payment', 'generate_license');

Generate license.

Returns
a string with license.
See also
BxBaseModPaymentModule::serviceGenerateLicense

Base Payment

Other

get_currency_info

bx_srv('bx_payment', 'get_currency_info', [...]);

Get default currency info (sign and code).

Returns
an array with currency info.
See also
BxBaseModPaymentModule::serviceGetCurrencyInfo

Base Payment

Other

get_option

bx_srv('bx_payment', 'get_option', [...]);

Get value of payment provider configuration option.

Parameters
$sOptionstring value with option name.
Returns
string with option value.
See also
BxBaseModPaymentModule::serviceGetOption

Base Payment

Other

get_provider

bx_srv('bx_payment', 'get_provider', [...]);

Get payment provider object by its name and vendor ID.

Parameters
$sProviderstring value with provider name.
$mixedVendorIdmixed value with vendor ID.
Returns
provider object, instance of BxBaseModPaymentProvider.
See also
BxBaseModPaymentModule::serviceGetProvider

Base Payment

Other

get_providers_cart

bx_srv('bx_payment', 'get_providers_cart', [...]);

Get list of available payment providers which can process single time payments via Shopping Cart.

Parameters
$iVendorIdinteger value with vendor ID.
Returns
an array with special format.
See also
BxBaseModPaymentModule::serviceGetProvidersCart

Base Payment

Integration

get_orders_url

bx_srv('bx_payment', 'get_orders_url', [...], 'Orders');

Get orders page URL.

Returns
string with orders page URL.
See also
BxBaseModPaymentOrders::serviceGetOrdersUrl

Base Payment

Integration

get_pending_orders_url

bx_srv('bx_payment', 'get_pending_orders_url', [...], 'Orders');

Get pending orders page URL.

Returns
string with pending orders page URL.
See also
BxBaseModPaymentOrders::serviceGetPendingOrdersUrl

Base Payment

Integration

get_orders_count

bx_srv('bx_payment', 'get_orders_count', [...], 'Orders');

Get processed orders count by type.

Parameters
$sTypestring value with type. For now 'new' type is available only.
$iProfileId(optional) integer value with profile ID. If empty value is provided then currently logged in profile will be used.
Returns
integer value with orders count.
See also
BxBaseModPaymentOrders::serviceGetOrdersCount

Base Payment

Integration

get_subscriptions_url

bx_srv('bx_payment', 'get_subscriptions_url', [...], 'Subscriptions');

Get subscriptions page URL.

Parameters
$iVendor(optional) integer value with vendor ID.
Returns
string with URL.
See also
BxBaseModPaymentSubscriptions::serviceGetSubscriptionsUrl

Base Payment

Integration

get_subscribe_url

bx_srv('bx_payment', 'get_subscribe_url', [...], 'Subscriptions');

Get action URL to initialize subscription.

Parameters
$iVendorinteger value with vendor ID.
$sVendorProviderstring value with a name of payment provider to be used for processing.
$mixedModuleIdmixed value (ID, Name or URI) determining a module from which the action was initiated.
$iItemIdinteger value with item ID.
$iItemCount(optional) integer value with a number of items for purchasing. It's equal to 1 in case of subscription.
Returns
string with URL.
See also
BxBaseModPaymentSubscriptions::serviceGetSubscribeUrl

Base Payment

Integration

get_subscribe_js

bx_srv('bx_payment', 'get_subscribe_js', [...], 'Subscriptions');

Get JavaScript code to use in OnClick attributes of HTML elements.

Parameters
$iVendorinteger value with vendor ID.
$sVendorProviderstring value with a name of payment provider to be used for processing.
$mixedModuleIdmixed value (ID, Name or URI) determining a module from which the action was initiated.
$iItemIdinteger value with item ID.
$iItemCount(optional) integer value with a number of items for purchasing. It's equal to 1 in case of subscription.
$sRedirect(optional) string value with redirect URL, if it's needed.
Returns
string with JavaScript code.
See also
BxBaseModPaymentSubscriptions::serviceGetSubscribeJs

Base Payment

Integration

get_subscribe_js

bx_srv('bx_payment', 'get_subscribe_js', [...], 'Subscriptions');

Get JavaScript code to use in OnClick attributes of HTML elements.

Parameters
$iVendorinteger value with vendor ID.
$sVendorProviderstring value with a name of payment provider to be used for processing.
$mixedModuleIdmixed value (ID, Name or URI) determining a module from which the action was initiated.
$iItemIdinteger value with item ID.
$iItemCount(optional) integer value with a number of items for purchasing. It's equal to 1 in case of subscription.
$sItemAddons(optional) string with attached addons.
$sRedirect(optional) string value with redirect URL, if it's needed.
Returns
string with JavaScript code.
See also
BxBaseModPaymentSubscriptions::serviceGetSubscribeJs

Base Payment

Integration

get_subscribe_link

bx_srv('bx_payment', 'get_subscribe_link', [...], 'Subscriptions');

Get "Subscribe" link including HTML tag and cart JavaScript code.

Parameters
$iVendorinteger value with vendor ID.
$sVendorProviderstring value with a name of payment provider to be used for processing.
$mixedModuleIdmixed value (ID, Name or URI) determining a module from which the action was initiated.
$iItemIdinteger value with item ID.
$iItemCount(optional) integer value with a number of items for purchasing. It's equal to 1 in case of subscription.
$sRedirect(optional) string value with redirect URL, if it's needed.
Returns
HTML string with link to display on the site.
See also
BxBaseModPaymentSubscriptions::serviceGetSubscribeLink

Base Profile

General

entity_calendar

bx_srv('bx_persons', 'entity_calendar', [...]);

Get calendar block

Parameters
$iContentIdcontent ID
See also
BxBaseModProfileModule::serviceEntityCalendar

Base Profile

General

profile_unit_safe

bx_srv('bx_persons', 'profile_unit_safe', [...]);

Get profile unit

Parameters
$iContentIdcontent ID
See also
BxBaseModProfileModule::serviceProfileUnitSafe

Base Profile

General

profile_url

bx_srv('bx_persons', 'profile_url', [...]);

Get profile URL

Parameters
$iContentIdcontent ID
See also
BxBaseModProfileModule::serviceProfileUrl

Base Profile

Forms

entity_create

bx_srv('bx_persons', 'entity_create', [...]);

Get profile creation form

Parameters
$sDisplayoptional form display name
See also
BxBaseModProfileModule::serviceEntityCreate

Base Profile

Browse

browse_recommended

bx_srv('bx_persons', 'browse_recommended', [...]);

Browse recommended profiles

Parameters
$sUnitViewoptional, unit view, for example - showcase
$bEmptyMessageoptional, display or not "empty" message when there is no content
$bAjaxPaginateoptional, use AJAX paginate or not
See also
BxBaseModProfileModule::serviceBrowseRecommended

Base Profile

Browse

browse_recent_profiles

bx_srv('bx_persons', 'browse_recent_profiles', [...]);

Browse recently joined profiles

Parameters
$bEmptyMessageoptional, display or not "empty" message when there is no content
$bAjaxPaginateoptional, use AJAX paginate or not
See also
BxBaseModProfileModule::serviceBrowseRecentProfiles

Base Profile

Browse

browse_active_profiles

bx_srv('bx_persons', 'browse_active_profiles', [...]);

Browse recently active profiles

Parameters
$bEmptyMessageoptional, display or not "empty" message when there is no content
$bAjaxPaginateoptional, use AJAX paginate or not
See also
BxBaseModProfileModule::serviceBrowseActiveProfiles

Base Profile

Browse

browse_familiar_profiles

bx_srv('bx_persons', 'browse_familiar_profiles', [...]);

Browse profiles you might be familiar with. By default using 'Profile Friends' connection.

Parameters
$bEmptyMessageoptional, display or not "empty" message when there is no content
$bAjaxPaginateoptional, use AJAX paginate or not
See also
BxBaseModProfileModule::serviceBrowseFamiliarProfiles

Base Profile

Browse

browse_top_profiles

bx_srv('bx_persons', 'browse_top_profiles', [...]);

Browse top profiles

Parameters
$bEmptyMessageoptional, display or not "empty" message when there is no content
$bAjaxPaginateoptional, use AJAX paginate or not
See also
BxBaseModProfileModule::serviceBrowseTopProfiles

Base Profile

Browse

browse_online_profiles

bx_srv('bx_persons', 'browse_online_profiles', [...]);

Browse online profiles

Parameters
$bEmptyMessageoptional, display or not "empty" message when there is no content
$bAjaxPaginateoptional, use AJAX paginate or not
See also
BxBaseModProfileModule::serviceBrowseOnlineProfiles

Base Profile

Browse

browse_by_acl

bx_srv('bx_persons', 'browse_by_acl', [...]);

Browse profiles by membership(ACL) level

Parameters
$mixedLevelIdmembership level, or array of membership levels
$iDesignBoxoptional, design box identifier
See also
BxBaseModProfileModule::serviceBrowseByAcl

Base Profile

Page Blocks

entity_cover

bx_srv('bx_persons', 'entity_cover', [...]);

Get cover

Parameters
$iContentIdcontent ID
See also
BxBaseModProfileModule::serviceEntityCover

Base Text

Page Blocks

categories_multi_list_context

bx_srv('bx_posts', 'categories_multi_list_context', [...]);

Display multi-categorories block with number of posts in each category for current context

Parameters
$bDisplayEmptyCatsdisplay empty categories
See also
BxBaseModGeneralModule::serviceCategoriesMultiListContext

Base Text

Polls Blocks

get_block_poll_answers

bx_srv('bx_posts', 'get_block_poll_answers', [...]);

Get block with poll answers

Parameters
$iPollIdpoll ID
See also
BxBaseModTextModule::serviceGetBlockPollAnswers

Base Text

Polls Blocks

get_block_poll_results

bx_srv('bx_posts', 'get_block_poll_results', [...]);

Get block with poll results

Parameters
$iPollIdpoll ID
See also
BxBaseModTextModule::serviceGetBlockPollResults

Base Text

Other

get_menu_addon_manage_tools_profile_stats

bx_srv('bx_posts', 'get_menu_addon_manage_tools_profile_stats', []);

Get number of posts for currently logged in user

See also
BxBaseModTextModule::serviceGetMenuAddonManageToolsProfileStats

Base Text

Browse

browse_public

bx_srv('bx_posts', 'browse_public', [...]);

Display public posts

Parameters
$sUnitViewunit view, such as: full, extended, gallery, showcase
$bEmptyMessagedisplay or not "empty" message when there is no content
$bAjaxPaginateuse AJAX paginate or not
See also
BxBaseModTextModule::serviceBrowsePublic

Base Text

Browse

browse_popular

bx_srv('bx_posts', 'browse_popular', [...]);

Display popular posts

Parameters
$sUnitViewunit view, such as: full, extended, gallery, showcase
$bEmptyMessagedisplay or not "empty" message when there is no content
$bAjaxPaginateuse AJAX paginate or not
See also
BxBaseModTextModule::serviceBrowsePopular

Base Text

Browse

browse_top

bx_srv('bx_posts', 'browse_top', [...]);

Display top posts

Parameters
$sUnitViewunit view, such as: full, extended, gallery, showcase
$bEmptyMessagedisplay or not "empty" message when there is no content
$bAjaxPaginateuse AJAX paginate or not
See also
BxBaseModTextModule::serviceBrowseTop

Base Text

Browse

browse_updated

bx_srv('bx_posts', 'browse_updated', [...]);

Display recently updated posts

Parameters
$sUnitViewunit view, such as: full, extended, gallery, showcase
$bEmptyMessagedisplay or not "empty" message when there is no content
$bAjaxPaginateuse AJAX paginate or not
See also
BxBaseModTextModule::serviceBrowseUpdated

Base Text

Browse

browse_author

bx_srv('bx_posts', 'browse_author', [...]);

Display posts of specified author

Parameters
$iProfileIdprofile ID
$aParamsadditional params, see BxBaseModGeneralModule::serviceBrowse
See also
BxBaseModTextModule::serviceBrowseAuthor

Base Text

Page Blocks

entity_author

bx_srv('bx_posts', 'entity_author', [...]);

Display author block for the specified post

Parameters
$iContentIdcontent ID
See also
BxBaseModTextModule::serviceEntityAuthor

Base Text

Page Blocks

entity_polls

bx_srv('bx_posts', 'entity_polls', [...]);

Display polls for the specified post

Parameters
$iContentIdcontent ID
See also
BxBaseModTextModule::serviceEntityPolls

Base Text

Page Blocks

entity_breadcrumb

bx_srv('bx_forum', 'entity_breadcrumb', [...]);

Display breadcrumb for the specified post

Parameters
$iContentIdcontent ID
See also
BxBaseModTextModule::serviceEntityBreadcrumb

Accounts

Other

get_menu_addon_manage_tools

bx_srv('bx_accounts', 'get_menu_addon_manage_tools', [...]);

Get number of 'unconfirmed' accounts for User End -> Dasboard page -> Manage block.

Returns
integer number of 'unconfirmed' accounts
See also
BxAccntModule::serviceGetMenuAddonManageTools

Paid Levels

Other

get_view_url

bx_srv('bx_acl', 'get_view_url', [...]);

Get page URL with membership levels list.

Returns
string with page URL.
See also
BxAclModule::serviceGetViewUrl

Paid Levels

Page Blocks

get_block_view

bx_srv('bx_acl', 'get_block_view', [...]);

Get page block with a list of available ACL levels to purchase or get for Free. List is represented as table.

Returns
HTML string with a list of ACL levels to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML. On error empty string is returned.
See also
BxAclModule::serviceGetBlockView

Paid Levels

Page Blocks

get_membership_actions

bx_srv('bx_acl', 'get_membership_actions', [...]);

Get page block with a list of current membership level's actions.

Returns
HTML string with a list of actions to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML. On error empty string is returned.
See also
BxAclModule::serviceGetMembershipActions

Paid Levels

Payments

get_payment_data

bx_srv('bx_acl', 'get_payment_data', [...]);

Get an array with module's description. Is needed for payments processing module.

Returns
an array with module's description.
See also
BxAclModule::serviceGetPaymentData

Paid Levels

Payments

get_cart_item

bx_srv('bx_acl', 'get_cart_item', [...]);

Get an array with level's description. Is used in Shopping Cart in payments processing module.

Parameters
$mixedItemIdlevel's ID or Unique Name.
Returns
an array with level's description. Empty array is returned if something is wrong.
See also
BxAclModule::serviceGetCartItem

Paid Levels

Payments

get_cart_items

bx_srv('bx_acl', 'get_cart_items', [...]);

Get an array with levels' descriptions by seller. Is used in Manual Order Processing in payments processing module.

Parameters
$iSellerIdseller ID.
Returns
an array with levels' descriptions. Empty array is returned if something is wrong or seller doesn't have any paid level.
See also
BxAclModule::serviceGetCartItems

Paid Levels

Payments

register_cart_item

bx_srv('bx_acl', 'register_cart_item', [...]);

Register a processed single time payment inside the Paid Levels module. Is called with payment processing module after the payment was registered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
an array with purchased prodict's description. Empty array is returned if something is wrong.
See also
BxAclModule::serviceRegisterCartItem

Paid Levels

Payments

register_subscription_item

bx_srv('bx_acl', 'register_subscription_item', [...]);

Register a processed subscription (recurring payment) inside the Paid Levels module. Is called with payment processing module after the subscription was registered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
an array with subscribed prodict's description. Empty array is returned if something is wrong.
See also
BxAclModule::serviceRegisterSubscriptionItem

Paid Levels

Payments

reregister_cart_item

bx_srv('bx_acl', 'reregister_cart_item', [...]);

Reregister a single time payment inside the Paid Levels module. Is called with payment processing module after the payment was reregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIdOldold item ID.
$iItemIdNewnew item ID.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with purchased prodict's description. Empty array is returned if something is wrong.
See also
BxAclModule::serviceReregisterCartItem

Paid Levels

Payments

reregister_subscription_item

bx_srv('bx_acl', 'reregister_subscription_item', [...]);

Reregister a subscription (recurring payment) inside the Paid Levels module. Is called with payment processing module after the subscription was reregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIdOldold item ID.
$iItemIdNewnew item ID.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with subscribed prodict's description. Empty array is returned if something is wrong.
See also
BxAclModule::serviceReregisterSubscriptionItem

Paid Levels

Payments

unregister_cart_item

bx_srv('bx_acl', 'unregister_cart_item', [...]);

Unregister an earlier processed single time payment inside the Paid Levels module. Is called with payment processing module after the payment was unregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
boolean value determining where the payment was unregistered or not.
See also
BxAclModule::serviceUnregisterCartItem

Paid Levels

Payments

unregister_subscription_item

bx_srv('bx_acl', 'unregister_subscription_item', [...]);

Unregister an earlier processed subscription (recurring payment) inside the Paid Levels module. Is called with payment processing module after the subscription was unregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
boolean value determining where the subscription was unregistered or not.
See also
BxAclModule::serviceUnregisterSubscriptionItem

Paid Levels

Payments

cancel_subscription_item

bx_srv('bx_acl', 'cancel_subscription_item', [...]);

Cancel an earlier processed subscription (recurring payment) inside the Paid Levels module. Is called with payment processing module after the subscription was canceled there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
boolean value determining where the subscription was canceled or not.
See also
BxAclModule::serviceCancelSubscriptionItem

Paid Levels

Other

get_prices

bx_srv('bx_acl', 'get_prices', [...]);

Get array of available price options for membership levels

Parameters
$iLevelIdmembership level id
$bFreeUnlimitedOnlyget unlimited free pricing options only
Returns
array of levels, or empty array of there are no any pricing options avaiulable
See also
BxAclModule::serviceGetPrices

Paid Levels

Other

get_products_names

bx_srv('bx_acl', 'get_products_names', [...]);

Get an array of products names.

Parameters
$iVendorIdreturn products of 1 vendor only
$iLimitlimit the result artay
Returns
an array of products names
See also
BxAclModule::serviceGetProductsNames

Ads

Page Blocks

entity_reviews

bx_srv('bx_ads', 'entity_reviews', [...]);

Get reviews for particular content

Parameters
$iContentIdcontent ID
See also
BxAdsModule::serviceEntityReviews

Ads

Page Blocks

entity_reviews_rating

bx_srv('bx_ads', 'entity_reviews_rating', [...]);

Get reviews rating for particular content

Parameters
$iContentIdcontent ID
See also
BxAdsModule::serviceEntityReviewsRating

Ads

Page Blocks

categories_list

bx_srv('bx_ads', 'categories_list', [...]);

Get reviews rating for particular content

Parameters
$aParamsadditional params array, such as 'show_empty'
See also
BxAdsModule::serviceCategoriesList

Ads

Browse

browse_category

bx_srv('bx_ads', 'browse_category', [...]);

Get reviews rating for particular content

Parameters
$iCategoryIdcategory ID
$aParamsadditional params array, such as empty_message, ajax_paginate, etc
See also
BxAdsModule::serviceBrowseCategory

Ads

Page Blocks

block_licenses

bx_srv('bx_ads', 'block_licenses', [...]);

Get page block with a list of licenses purchased by currently logged member.

Returns
an array describing a block to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxAdsModule::serviceBlockLicenses

Ads

Page Blocks

block_licenses_administration

bx_srv('bx_ads', 'block_licenses_administration', [...]);

Get page block with a list of all licenses. It's needed for moderators/administrators.

Returns
an array describing a block to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxAdsModule::serviceBlockLicensesAdministration

Ads

Page Blocks

block_licenses_note

bx_srv('bx_ads', 'block_licenses_note', [...]);

Get page block with a notice for licenses usage.

Returns
HTML string with block content to display on the site.
See also
BxAdsModule::serviceBlockLicensesNote

Ads

Payments

get_payment_data

bx_srv('bx_ads', 'get_payment_data', [...]);

Get an array with module's description. Is needed for payments processing module.

Returns
an array with module's description.
See also
BxAdsModule::serviceGetPaymentData

Ads

Payments

get_cart_item

bx_srv('bx_ads', 'get_cart_item', [...]);

Get an array with prodict's description. Is used in Shopping Cart in payments processing module.

Parameters
$mixedItemIdproduct's ID or Unique Name.
Returns
an array with prodict's description. Empty array is returned if something is wrong.
See also
BxAdsModule::serviceGetCartItem

Ads

Payments

get_cart_items

bx_srv('bx_ads', 'get_cart_items', [...]);

Get an array with prodicts' descriptions by seller. Is used in Manual Order Processing in payments processing module.

Parameters
$iSellerIdseller ID.
Returns
an array with prodicts' descriptions. Empty array is returned if something is wrong or seller doesn't have any products.
See also
BxAdsModule::serviceGetCartItems

Ads

Payments

authorize_cart_item

bx_srv('bx_ads', 'authorize_cart_item', [...]);

Authorize the order to process a single time payment inside the Ads module in future. Is called with payment processing module after the order was authorized there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with authorize prodict's description. Empty array is returned if something is wrong.
See also
BxAdsModule::serviceAuthorizeCartItem

Ads

Payments

register_cart_item

bx_srv('bx_ads', 'register_cart_item', [...]);

Register a processed single time payment inside the Ads module. Is called with payment processing module after the payment was registered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
an array with purchased prodict's description. Empty array is returned if something is wrong.
See also
BxAdsModule::serviceRegisterCartItem

Ads

Payments

authorize_subscription_item

bx_srv('bx_ads', 'authorize_subscription_item', [...]);

Authorize the order to process a subscription (recurring payment) inside the Ads module in future. Is called with payment processing module after the order for subscription was authorized there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with authorize prodict's description. Empty array is returned if something is wrong.
See also
BxAdsModule::serviceAuthorizeSubscriptionItem

Ads

Payments

register_subscription_item

bx_srv('bx_ads', 'register_subscription_item', [...]);

Register a processed subscription (recurring payment) inside the Ads module. Is called with payment processing module after the subscription was registered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
an array with subscribed prodict's description. Empty array is returned if something is wrong.
See also
BxAdsModule::serviceRegisterSubscriptionItem

Ads

Payments

reregister_cart_item

bx_srv('bx_ads', 'reregister_cart_item', [...]);

Reregister a single time payment inside the Ads module. Is called with payment processing module after the payment was reregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIdOldold item ID.
$iItemIdNewnew item ID.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with purchased prodict's description. Empty array is returned if something is wrong.
See also
BxAdsModule::serviceReregisterCartItem

Ads

Payments

reregister_subscription_item

bx_srv('bx_ads', 'reregister_subscription_item', [...]);

Reregister a subscription (recurring payment) inside the Ads module. Is called with payment processing module after the subscription was reregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIdOldold item ID.
$iItemIdNewnew item ID.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with subscribed prodict's description. Empty array is returned if something is wrong.
See also
BxAdsModule::serviceReregisterSubscriptionItem

Ads

Payments

unregister_cart_item

bx_srv('bx_ads', 'unregister_cart_item', [...]);

Unregister an earlier processed single time payment inside the Ads module. Is called with payment processing module after the payment was unregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
boolean value determining where the payment was unregistered or not.
See also
BxAdsModule::serviceUnregisterCartItem

Ads

Payments

unregister_subscription_item

bx_srv('bx_ads', 'unregister_subscription_item', [...]);

Unregister an earlier processed subscription (recurring payment) inside the Ads module. Is called with payment processing module after the subscription was unregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
boolean value determining where the subscription was unregistered or not.
See also
BxAdsModule::serviceUnregisterSubscriptionItem

Ads

Payments

cancel_subscription_item

bx_srv('bx_ads', 'cancel_subscription_item', [...]);

Cancel an earlier processed subscription (recurring payment) inside the Ads module. Is called with payment processing module after the subscription was canceled there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
boolean value determining where the subscription was canceled or not.
See also
BxAdsModule::serviceCancelSubscriptionItem

Albums

Forms

entity_add_files

bx_srv('bx_albums', 'entity_add_files', [...]);

Display form for adding media to the album.

Parameters
$iContentIdalbum content id where media will be added, if it's not provided then it's determined from 'id' GET variable
Returns
HTML string with form, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML. On error false or empty string is returned.
See also
BxAlbumsModule::serviceEntityAddFiles

Albums

Page Blocks

media_comments

bx_srv('bx_albums', 'media_comments', [...]);

Display media comments block.

Parameters
$iMediaIdmedia ID, if it's omitted then it's taken from 'id' GET variable.
Returns
HTML string with comments. On error false or empty string is returned.
See also
BxAlbumsModule::serviceMediaComments

Albums

Browse

browse_recent_media

bx_srv('bx_albums', 'browse_recent_media', [...]);

Display block for browsing recently uploaded media files.

Parameters
$sUnitViewunit view mode: gallery
$bDisplayEmptyMsgdisplay 'empty' message when nothing to browse, or return empty string.
$bAjaxPaginateuse AJAX or regular paginate.
Returns
HTML string with block content. On error false or empty string is returned.
See also
BxAlbumsModule::serviceBrowseRecentMedia

Albums

Browse

browse_featured_media

bx_srv('bx_albums', 'browse_featured_media', [...]);

Display featured media.

Parameters
$sUnitViewunit view mode: gallery
$bDisplayEmptyMsgdisplay 'empty' message when nothing to browse, or return empty string.
$bAjaxPaginateuse AJAX or regular paginate.
Returns
HTML string with block content. On error false or empty string is returned.
See also
BxAlbumsModule::serviceBrowseFeaturedMedia

Albums

Browse

browse_popular_media

bx_srv('bx_albums', 'browse_popular_media', [...]);

Display popular media.

Parameters
$sUnitViewunit view mode: gallery
$bDisplayEmptyMsgdisplay 'empty' message when nothing to browse, or return empty string.
$bAjaxPaginateuse AJAX or regular paginate.
Returns
HTML string with block content. On error false or empty string is returned.
See also
BxAlbumsModule::serviceBrowsePopularMedia

Albums

Browse

browse_top_media

bx_srv('bx_albums', 'browse_top_media', [...]);

Display top media.

Parameters
$sUnitViewunit view mode: gallery
$bDisplayEmptyMsgdisplay 'empty' message when nothing to browse, or return empty string.
$bAjaxPaginateuse AJAX or regular paginate.
Returns
HTML string with block content. On error false or empty string is returned.
See also
BxAlbumsModule::serviceBrowseTopMedia

Albums

Browse

browse_favorite_media

bx_srv('bx_albums', 'browse_favorite_media', [...]);

Display favorite media for particular profile.

Parameters
$iProfileIdprofile ID, if omitted then 'profile_id' GET variable is used
$aParamsadditional params for browsing such as 'unit_view'
See also
BxAlbumsModule::serviceBrowseFavoriteMedia

Service methods

Analytics

Other

Analytics

bx_srv('bx_analytics', 'get_canvas', [...]);

Get canvas

Returns
an html.
See also
BxAnalyticsModule::serviceGetCanvas

Analytics

Other

Analytics

bx_srv('bx_analytics', 'is_avaliable', [...]);

Check avalability for current profile

Returns
boolean.
See also
BxAnalyticsModule::serviceIsAvaliable

Analytics

Other

Analytics

bx_srv('bx_analytics', 'get_modules', [...]);

Get modules list

Returns
an html.
See also
BxAnalyticsModule::serviceGetModules

SERVICE METHODS

Anonymous Follow

Page Blocks

get_profile_fields

bx_srv('bx_anon_follow', 'get_profile_fields', [...]);

Get array with module filelds

Parameters
$aParamsan array with search params.
Returns
array with module filelds
See also
BxAnonFollowModule::GetProfileFields

Anonymous Follow

Page Blocks

check_is_subscribed

bx_srv('bx_anon_follow', 'check_is_subscribed', [...]);

Get subscribed connection for specified profile

Parameters
$aParamsan array with search params.
Returns
boolean connection for specified profile
See also
BxAnonFollowModule::CheckIsSubscribed

Anonymous Follow

Page Blocks

subscribed_me_table

bx_srv('bx_anon_follow', 'subscribed_me_table', [...]);

Get grid with subscribers list

Parameters
$aParamsan array with search params.
Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxAnonFollowModule::serviceSubscribedMeTable

Anonymous Follow

Page Blocks

subscriptions_table

bx_srv('bx_anon_follow', 'subscriptions_table', [...]);

Get grid with subscriptions list

Parameters
$aParamsan array with search params.
Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxAnonFollowModule::serviceSubscriptionsTable

Anonymous Follow

Page Blocks

include_js

bx_srv('bx_anon_follow', 'include_js', [...]);

Add js to injection in head

Parameters
$aParamsan array with search params.
Returns
void
See also
BxAnonFollowModule::serviceIncludeJs

Service methods

Attendant

Other

get_profile_modules

bx_srv('bx_attendant', 'get_profile_modules', [...]);

Get list of avaliable modules for on_profile_creation event

Returns
an array with avaliable modules.
See also
BxAttendantModule::serviceGetProfileModules

Attendant

Other

get_profile_modules

bx_srv('bx_attendant', 'get_options_redirect_after_show', [...]);

Get list avaliable redirct pages

Returns
an array with avaliable redirct pages.
See also
BxAttendantModule::serviceGetOptionsRedirectAfterShow

Attendant

Other

get_profile_modules

bx_srv('bx_attendant', 'get_popup_with_recommended_on_event_show', [...]);

Get list of events for on_profile_creation show

Returns
an array with avaliable events.
See also
BxAttendantModule::serviceGetPopupWithRecommendedOnEventShow

Attendant

Other

handle_action_view

bx_srv('bx_attendant', 'handle_action_view', [...]);

Get Include for injection

Returns
an include code
See also
BxAttendantModule::HandleActionView

Channels

Page Blocks

entity_breadcrumb

bx_srv('bx_channels', 'entity_breadcrumb', [...]);

Display channel breadcrumb

Parameters
$iContentIdchannel content ID
See also
BxCnlModule::serviceEntityBreadcrumb

Channels

Page Blocks

entity_parent

bx_srv('bx_channels', 'entity_parent', [...]);

Display block with parent channel

Parameters
$iContentIdchannel content ID
See also
BxCnlModule::serviceEntityParent

Channels

Page Blocks

entity_childs

bx_srv('bx_channels', 'entity_childs', [...]);

Display block with child channels

Parameters
$iContentIdchannel content ID
See also
BxCnlModule::serviceEntityChilds

Channels

Page Blocks

search_result_by_hashtag

bx_srv('bx_channels', 'search_result_by_hashtag', [...]);

Display search results by hashtag for particular channel

Parameters
$iContentIdchannel content ID
See also
BxCnlModule::serviceSearchResultByHashtag

Service methods

Charts

Other

Charts

bx_srv('bx_charts', 'get_profile_modules', [...]);

Get list of avaliable profile modules

Returns
an array with avaliable modules.
See also
BxChartsModule::serviceGetProfileModules

Charts

Other

get_text_modules

bx_srv('bx_charts', 'get_text_modules', [...]);

Get list of avaliable text modules

Returns
an array with avaliable modules.
See also
BxChartsModule::serviceGetTextModules

Charts

Other

Charts

bx_srv('bx_charts', 'get_modules', [...]);

Get list of avaliable modules

Returns
an array with avaliable modules.
See also
BxChartsModule::serviceGeModules

Charts

Other

Charts

bx_srv('bx_charts', 'get_growth_group_by', [...]);

Get list of avaliable grouping mode(day/week/month)

Returns
an array with avaliable grouping mode(day/week/month).
See also
BxChartsModule::serviceGetGrowthGroupBy

Charts

Other

get_text_modules

bx_srv('bx_charts', 'get_chart_top_contents_by_likes', [...]);

Get Chart Top Contents By Likes

Returns
an html for chart.
See also
BxChartsModule::serviceGetChartTopContentsByLikes

Charts

Other

get_text_modules

bx_srv('bx_charts', 'get_chart_most_active_profiles', [...]);

Get Chart Most Active Profiles

Returns
an html for chart.
See also
BxChartsModule::serviceGetChartMostActiveProfiles

Charts

Other

get_text_modules

bx_srv('bx_charts', 'get_chart_most_followed_profiles', [...]);

Get Chart Most Followed Profiles

Returns
an html for chart.
See also
BxChartsModule::serviceGetChartMostFollowedProfiles

Charts

Other

get_text_modules

bx_srv('bx_charts', 'get_chart_growth_by_modules', [...]);

Get Chart Growth By Modules

Returns
an html for chart.
See also
BxChartsModule::serviceGetChartGrowthByModules

Contact

Page Blocks

get_block_form

bx_srv('bx_contact', 'get_block_form');

Get page block with contact form.

Returns
an array describing a block to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxContactModule::serviceGetBlockForm

Contact

Other

get_contact_page_url

bx_srv('bx_contact', 'get_contact_page_url', [...]);

Get string with contact page URL. Is used in system and inter-modular integration.

Returns
string with contact page URL.
See also
BxContactModule::serviceGetContactPageUrl

Conversations

Page Blocks

conversations_in_folder

bx_srv('bx_convos', 'conversations_in_folder', [...]);

Display conversations in particulr folder for currently logged-in user

Parameters
$iFolderIdfolder ID
See also
BxCnvModule::serviceConversationsInFolder

Credits

Page Blocks

get_block_bundles

bx_srv('bx_credits', 'get_block_bundles');

Get page block with bundles

See also
BxCreditsModule::serviceGetBlockBundles

Credits

Page Blocks

get_block_orders_note

bx_srv('bx_credits', 'get_block_orders_note', [...]);

Get page block with a notice for orders usage.

Returns
HTML string with block content to display on the site.
See also
BxCreditsModule::serviceBlockLicensesNote

Credits

Page Blocks

get_block_orders

bx_srv('bx_credits', 'get_block_orders', [...]);

Get page block with a list of orders purchased by currently logged member.

Returns
an array describing a block to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxCreditsModule::serviceBlockLicenses

Credits

Page Blocks

get_block_history

bx_srv('bx_credits', 'get_block_history', [...]);

Get page block with a list of all changes with credits.

Returns
an array describing a block to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxCreditsModule::serviceGetBlockHistory

Credits

Payments

get_payment_data

bx_srv('bx_credits', 'get_payment_data', [...]);

Get an array with module's description. Is needed for payments processing module.

Returns
an array with module's description.
See also
BxCreditsModule::serviceGetPaymentData

Credits

Payments

get_cart_item

bx_srv('bx_credits', 'get_cart_item', [...]);

Get an array with prodict's description. Is used in Shopping Cart in payments processing module.

Parameters
$iItemIdproduct's ID.
Returns
an array with prodict's description. Empty array is returned if something is wrong.
See also
BxCreditsModule::serviceGetCartItem

Credits

Payments

get_cart_items

bx_srv('bx_credits', 'get_cart_items', [...]);

Get an array with prodicts' descriptions by seller. Is used in Manual Order Processing in payments processing module.

Parameters
$iSellerIdseller ID.
Returns
an array with prodicts' descriptions. Empty array is returned if something is wrong or seller doesn't have any products.
See also
BxCreditsModule::serviceGetCartItems

Credits

Payments

register_cart_item

bx_srv('bx_credits', 'register_cart_item', [...]);

Register a processed single time payment inside the Credits module. Is called with payment processing module after the payment was registered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
an array with purchased prodict's description. Empty array is returned if something is wrong.
See also
BxCreditsModule::serviceRegisterCartItem

Credits

Payments

register_subscription_item

bx_srv('bx_credits', 'register_subscription_item', [...]);

Register a processed subscription (recurring payment) inside the Credits module. Is called with payment processing module after the subscription was registered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
an array with subscribed prodict's description. Empty array is returned if something is wrong.
See also
BxCreditsModule::serviceRegisterSubscriptionItem

Credits

Payments

reregister_cart_item

bx_srv('bx_credits', 'reregister_cart_item', [...]);

Reregister a single time payment inside the Credits module. Is called with payment processing module after the payment was reregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIdOldold item ID.
$iItemIdNewnew item ID.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with purchased prodict's description. Empty array is returned if something is wrong.
See also
BxCreditsModule::serviceReregisterCartItem

Credits

Payments

reregister_subscription_item

bx_srv('bx_credits', 'reregister_subscription_item', [...]);

Reregister a subscription (recurring payment) inside the Credits module. Is called with payment processing module after the subscription was reregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIdOldold item ID.
$iItemIdNewnew item ID.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with subscribed prodict's description. Empty array is returned if something is wrong.
See also
BxCreditsModule::serviceReregisterSubscriptionItem

Credits

Payments

unregister_cart_item

bx_srv('bx_credits', 'unregister_cart_item', [...]);

Unregister an earlier processed single time payment inside the Credits module. Is called with payment processing module after the payment was unregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
boolean value determining where the payment was unregistered or not.
See also
BxCreditsModule::serviceUnregisterCartItem

Credits

Payments

unregister_subscription_item

bx_srv('bx_credits', 'unregister_subscription_item', [...]);

Unregister an earlier processed subscription (recurring payment) inside the Credits module. Is called with payment processing module after the subscription was unregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
boolean value determining where the subscription was unregistered or not.
See also
BxCreditsModule::serviceUnregisterSubscriptionItem

Credits

Payments

cancel_subscription_item

bx_srv('bx_credits', 'cancel_subscription_item', [...]);

Cancel an earlier processed subscription (recurring payment) inside the Credits module. Is called with payment processing module after the subscription was canceled there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
boolean value determining where the subscription was canceled or not.
See also
BxCreditsModule::serviceCancelSubscriptionItem

ElasticSearch

Other

is_configured

bx_srv('bx_elasticsearch', 'is_configured', [...]);

Checkes whether the module is correctly configured or not.

Returns
boolean value determining where the module is configured or not.
See also
BxElsModule::serviceIsConfigured

ElasticSearch

Search

search_simple

bx_srv('bx_elasticsearch', 'search_simple', [...]);

Perform a simple search by term. Index and Type to search in can be specified.

Parameters
$sTermstring value with keyword to search for.
$sType(optional) if type is specified then the search will be performed in this type only.
$sIndex(optional) if index is specified then the search will be performed in this index only.
Returns
an array with search results.
See also
BxElsModule::serviceSearchSimple

ElasticSearch

Search

search_extended

bx_srv('bx_elasticsearch', 'search_extended', [...]);

Perform an extended search by provided conditions. Index and Type to search in can be specified.

Parameters
$aConditionan array with conditions to construct search request from.
$aSelection(optional) an array with custom condition.
$sType(optional) if type is specified then the search will be performed in this type only.
$sIndex(optional) if index is specified then the search will be performed in this index only.
Returns
an array with search results.

Condition #1: keyword search $aCondition = array('val' => 'test');

Condition #2: featured='1' $aCondition = array('fld' => 'featured', 'val' => 0);

Condition #3: (title='test' OR text='test' OR (featured='1' AND allow_view_to='3')) $aCondition = array('grp' => true, 'opr' => 'OR', 'cnds' => array( array('fld' => 'title', 'val' => 'test'), array('fld' => 'text', 'val' => 'test'), array('grp' => true, 'opr' => 'AND', 'cnds' => array( array('fld' => 'featured', 'val' => 1), array('fld' => 'allow_view_to', 'val' => 3) )), array('simple_query_string' => array('query' => 'test')), ));

Condition #4: ((title='test' OR text='test') AND featured='1' AND allow_view_to='3') $aCondition = array('grp' => true, 'opr' => 'AND', 'cnds' => array( array('grp' => true, 'opr' => 'OR', 'cnds' => array( array('fld' => 'title', 'val' => 'test'), array('fld' => 'text', 'val' => 'test'), )), array('fld' => 'featured', 'val' => 0), array('fld' => 'allow_view_to', 'val' => 3) ));

See also
BxElsModule::serviceSearchExtended

ElasticSearch

Manage

get

bx_srv('bx_elasticsearch', 'get', [...]);

Get item's data by content ID and type.

Parameters
$iContentIdinteger value with content ID.
$sTypea string with content type.
$sIndex(optional) if index is specified then the item will be searched in this index only.
Returns
an array with item's data.
See also
BxElsModule::serviceGet

ElasticSearch

Manage

add

bx_srv('bx_elasticsearch', 'add', [...]);

Add item to store in Elasticsearch.

Parameters
$iContentIdinteger value with content ID.
$mixedContentInfomixed value with content info to store.
$sIndex(optional) if index is specified then the item will be stored in this index.
Returns
boolean value determining where the item was added or not.
See also
BxElsModule::serviceAdd

ElasticSearch

Manage

update

bx_srv('bx_elasticsearch', 'update', [...]);

Update item in Elasticsearch storage.

Parameters
$iContentIdinteger value with content ID.
$mixedContentInfomixed value with new content info.
$sIndex(optional) if index is specified then the item will be updated in this index.
Returns
boolean value determining where the item was updated or not.
See also
BxElsModule::serviceUpdate

ElasticSearch

Manage

delete

bx_srv('bx_elasticsearch', 'delete', [...]);

Delete item from Elasticsearch storage.

Parameters
$iContentIdinteger value with content ID.
$mixedContentInfomixed value with content info which is needed during deletion.
$sIndex(optional) if index is specified then the item will be deleted from this index.
Returns
boolean value determining where the item was deleted or not.
See also
BxElsModule::serviceDelete

ElasticSearch

Manage

index

bx_srv('bx_elasticsearch', 'delete', [...]);

Index data in Elasticsearch storage.

Parameters
$sIndexstring value with storage's index name which will be indexed.
$sType(optional) if type is specified then data in this type will be indexed only.
Returns
boolean value determining where the data was indexed or not.
See also
BxElsModule::serviceIndex

Events

Browse

browse_upcoming_profiles

bx_srv('bx_events', 'browse_upcoming_profiles', [...]);

Browse upcoming events

Parameters
$bDisplayEmptyMsgshow "empty" message or not if nothing found
$bAjaxPaginateuse AJAX paginate or not
See also
BxEventsModule::serviceBrowseUpcomingProfiles

Events

Browse

browse_upcoming_connected_profiles

bx_srv('bx_events', 'browse_upcoming_connected_profiles', [...]);

Browse upcoming connected (followed) events

Parameters
$bDisplayEmptyMsgshow "empty" message or not if nothing found
$bAjaxPaginateuse AJAX paginate or not
See also
BxEventsModule::serviceBrowseUpcomingConnectedProfiles

Events

Browse

browse_past_profiles

bx_srv('bx_events', 'browse_past_profiles', [...]);

Browse past events

Parameters
$bDisplayEmptyMsgshow "empty" message or not if nothing found
$bAjaxPaginateuse AJAX paginate or not
See also
BxEventsModule::serviceBrowsePastProfiles

Events

Browse

browse_past_profiles

bx_srv('bx_events', 'browse_past_profiles_by_params', [...]);

Browse past events

Parameters
$aParamsarray with all parameters
See also
BxEventsModule::serviceBrowsePastProfilesByParams

Events

Page Blocks

calendar

bx_srv('bx_events', 'calendar', [...]);

Shows event or events calendar

Parameters
$aDataadditional data to point which events to show, leave empty to show all events, specify event's ID in 'event' array key to show calendar for one event only, specify context's ID in 'context_id' array key to show calendar for one context events only. If only one event is specified then it will show calendar only if it's repeating event.
$sTemplatetemplate to use to show calendar, or leave empty for default template, possible options: calendar.html, calendar_compact.html
Returns
HTML string with calendar to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML. On error empty string is returned.
See also
BxEventsModule::serviceCalendar

Events

Other

process_reminders

bx_srv('bx_events', 'process_reminders');

Send remiders to event's participants.

It must be processed once every hour for the proper processing.

Returns
nothing
See also
BxEventsModule::serviceProcessReminders

Events

Internal

get_timeline_post

bx_srv('bx_events', 'get_timeline_post', [...]);

Get Timeline post. It's needed for Timeline module.

Parameters
$aEventtimeline event array from Timeline module
Returns
array in special format which is needed specifically for Timeline module to display the data.
See also
BxEventsModule::serviceGetTimelinePost

Discussions

Other

get_searchable_fields

bx_srv('bx_forum', 'get_searchable_fields', [...]);

Get searchable fields for Studio settings.

Returns
an array with key-value pairs to be used in settings dropdown field.
See also
BxForumModule::serviceGetSearchableFields

Service methods

Discussions

Other

get_info

bx_srv('bx_forum', 'get_info', [...]);

Get content info by content ID. Is used in "Content Info Objects" system.

Parameters
$iContentIdinteger value with content ID.
$bSearchableFieldsOnly(optional) boolean value determining all info or "searchable fields" only will be returned.
Returns
an array with content info. Empty array is returned if something is wrong.
See also
BxForumModule::serviceGetInfo

Discussions

Page Blocks

categories_list

bx_srv('bx_forum', 'categories_list', [...]);

Get reviews rating for particular content

Parameters
$aParamsadditional params array, such as 'show_empty'
See also
BxForumModule::serviceCategoriesList

Discussions

Page Blocks

browse_new

bx_srv('bx_forum', 'browse_new', [...]);

Get page block with a list of items ordered by newness and represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseNew

Discussions

Page Blocks

browse_latest

bx_srv('bx_forum', 'browse_latest', [...]);

Get page block with a list of items ordered by Recent Posts in them and represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
$bShowHeader(optional) boolean value determining whether a resulting table should have Header section or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseNew

Discussions

Page Blocks

browse_featured

bx_srv('bx_forum', 'browse_featured', [...]);

Get page block with a list of featured items represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
$bShowHeader(optional) boolean value determining whether a resulting table should have Header section or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseFeatured

Discussions

Page Blocks

browse_top

bx_srv('bx_forum', 'browse_top', [...]);

Get page block with a list of items ordered by a number of comments and represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseTop

Discussions

Page Blocks

browse_popular

bx_srv('bx_forum', 'browse_popular', [...]);

Get page block with a list of items ordered by a number of views and represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowsePopular

Discussions

Page Blocks

browse_updated

bx_srv('bx_forum', 'browse_updated', [...]);

Get page block with a list of updated items represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseUpdated

Discussions

Page Blocks

browse_partaken

bx_srv('bx_forum', 'browse_partaken', [...]);

Get page block with a list of partaken items represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowsePartaken

Discussions

Page Blocks

browse_index

bx_srv('bx_forum', 'browse_index', [...]);

Get page block for Site's Home page with a list of items ordered by newness and represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
$bShowHeader(optional) boolean value determining whether a resulting table should have Header section or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseIndex

Discussions

Page Blocks

browse_author

bx_srv('bx_forum', 'browse_author', [...]);

Get page block with a list of items filtered by Author and represented as table.

Parameters
$iProfileId(optional) integer value with author ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
$aParams(optional) an array of additional params. It's not used for now.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseAuthor

Discussions

Page Blocks

browse_favorite

bx_srv('bx_forum', 'browse_favorite', [...]);

Get page block with a list of favorited items by some profile and represented as table.

Parameters
$iProfileId(optional) integer value with profile ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
$aParams(optional) an array of additional params. It's not used for now.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseFavorite

Discussions

Page Blocks

browse_category

bx_srv('bx_forum', 'browse_category', [...]);

Get page block with a list of items filter by some category and represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseCategory

Discussions

Page Blocks

browse_keyword

bx_srv('bx_forum', 'browse_keyword', [...]);

Get page block with a list of items filter by some keyword and represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseKeyword

Discussions

Page Blocks

browse_search_results

bx_srv('bx_forum', 'browse_search_results', [...]);

Get page block with search results by Author(s), Category, Keyword represented as table.

Parameters
$sUnitView(optional) string with unit view type.
$bEmptyMessage(optional) boolean value determining whether an "Empty" message should be returned or not.
$bAjaxPaginate(optional) boolean value determining whether an Ajax based pagination should be used or not.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceBrowseSearchResults

Discussions

Other

get_discussions_num

bx_srv('bx_forum', 'get_discussions_num', [...]);

Get number of discussions for some profile.

Parameters
$iProfileId(optional) profile to get discussions for, if omitted then currently logged in profile is used.
Returns
integer value with a number of discussions.
See also
BxForumModule::serviceGetDiscussionsNum

Discussions

Other

get_unreplied_discussions_num

bx_srv('bx_forum', 'get_unreplied_discussions_num', [...]);

Get number of unreplied discussions for some profile.

Parameters
$iProfileId(optional) profile to get unreplied discussions for, if omitted then currently logged is profile is used.
Returns
integer value with a number of discussions.
See also
BxForumModule::serviceGetUnrepliedDiscussionsNum

Discussions

Other

trigger_comment_post

bx_srv('bx_forum', 'trigger_comment_post', [...]);

Update last comment time and author when new comment was added in the discussion.

Parameters
$iContentIdinteger value with content ID.
$iProfileIdinteger value with profile ID.
$iCommentIdinteger value with comment ID.
$iTimestamp(optional) date in UNIX Timestamp format, if omitted then current date is used.
$sCommentText(optional) string value with text of comment.
Returns
boolean value determining where the operation is successful or not.
See also
BxForumModule::serviceTriggerCommentPost

Discussions

Page Blocks

entity_author

bx_srv('bx_forum', 'entity_author', [...]);

Get page block with author.

Parameters
$iContentId(optional) content ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceEntityAuthor

Discussions

Page Blocks

entity_participants

bx_srv('bx_forum', 'entity_participants', [...]);

Get page block with discussion's collaborators.

Parameters
$iContentId(optional) content ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceEntityParticipants

Discussions

Page Blocks

search

bx_srv('bx_forum', 'search', [...]);

Get page block with search form.

Returns
HTML string with block content to display on the site or false if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxForumModule::serviceSearch

Glossary

Browse

browse_alphabetical

bx_srv('bx_glossary', 'browse_alphabetical', [...]);

Display terms by alphabetical index

Parameters
$sUnitViewunit view
$bDisplayEmptyMsgshow "empty" message or not if nothing found
$bAjaxPaginateuse AJAX paginate or not
See also
BxEventsModule::serviceBrowseAlphabetical

Invitations

Other

get_include

bx_srv('bx_invites', 'get_include', [...]);

Get all necessary CSS and JS files to include in a page.

Returns
string with all necessary CSS and JS files.
See also
BxInvModule::serviceGetInclude

Invitations

Page Blocks

get_block_invite

bx_srv('bx_invites', 'get_block_invite', [...]);

Get page block for member's Dashboard which displays invitations related info and action(s).

Returns
an array describing a block to display on the site or empty string if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxInvModule::serviceGetBlockInvite

Invitations

Page Blocks

get_block_form_invite

bx_srv('bx_invites', 'get_block_form_invite', [...]);

Get page block with invite form.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxInvModule::serviceGetBlockFormInvite

Invitations

Page Blocks

get_block_form_request

bx_srv('bx_invites', 'get_block_form_request', [...]);

Get page block with request invitation form.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxInvModule::serviceGetBlockFormRequest

Invitations

Page Blocks

get_block_manage_requests

bx_srv('bx_invites', 'get_block_manage_requests', [...]);

Get page block with manage invitation requests table.

Returns
HTML string with block content to display on the site or empty string if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxInvModule::serviceGetBlockManageRequests

Invitations

Page Blocks

get_block_manage_requests

bx_srv('bx_invites', 'get_block_manage_invites', [...]);

Get page block with manage invitations table.

Returns
HTML string with block content to display on the site or empty string if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxInvModule::serviceGetBlockManageInvites

Invitations

Other

get_menu_addon_requests

bx_srv('bx_invites', 'get_menu_addon_requests', [...]);

Get number or invitation requests.

Returns
integer value with number of invitation requests.
See also
BxInvModule::serviceGetMenuAddonRequests

Invitations

Other

account_add_form_check

bx_srv('bx_invites', 'account_add_form_check', [...]);

Perform neccessary checking on join form.

Returns
empty string - if join is allowed and should be processed as usual, non-empty string - if join form need to be replaced with this code.
See also
BxInvModule::serviceAccountAddFormCheck

MapShow

Other

bx_mapshow-get_map

bx_srv('bx_mapshow', 'get_map', [...]);

Get html for map

Returns
string - html for map .
See also
BxMapShowModule::serviceGetMap

Market

Other

get_searchable_fields

bx_srv('bx_market', 'get_searchable_fields', [...]);

Get a list of searchable fields. Is used in common search engine.

Returns
an array with a list of searchable fields.
See also
BxMarketModule::serviceGetSearchableFields

Market

Page Blocks

entity_create

bx_srv('bx_market', 'entity_create', [...]);

Get page block with product creation form or an error message if something wasn't configured correctly.

Parameters
$sDisplayform display name to use
Returns
HTML string with block content to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMarketModule::serviceEntityCreate

Market

Page Blocks

entity_download

bx_srv('bx_market', 'entity_download', [...]);

Get page block with a list of downloadable packages attached to the product. If something is wrong an error message is returned.

Parameters
$iContentId(optional) product's ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
an array describing a block to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMarketModule::serviceEntityDownload

Market

Page Blocks

entity_rating

bx_srv('bx_market', 'entity_rating', [...]);

Get page block with Stars based product's rating.

Parameters
$iContentId(optional) product's ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
HTML string with block content to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMarketModule::serviceEntityRating

Market

Page Blocks

entity_author_entities

bx_srv('bx_market', 'entity_author_entities', [...]);

Get page block with a list of other products of the same author.

Parameters
$iContentId(optional) product's ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
an array describing a block to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMarketModule::serviceEntityAuthorEntities

Market

Page Blocks

block_licenses

bx_srv('bx_market', 'block_licenses', [...]);

Get page block with a list of licenses purchased by currently logged member.

Returns
an array describing a block to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMarketModule::serviceBlockLicenses

Market

Page Blocks

block_licenses_administration

bx_srv('bx_market', 'block_licenses_administration', [...]);

Get page block with a list of all licenses. It's needed for moderators/administrators.

Returns
an array describing a block to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMarketModule::serviceBlockLicensesAdministration

Market

Page Blocks

block_licenses_note

bx_srv('bx_market', 'block_licenses_note', [...]);

Get page block with a notice for licenses usage.

Returns
HTML string with block content to display on the site.
See also
BxMarketModule::serviceBlockLicensesNote

Market

Licenses

get_unused_licenses_num

bx_srv('bx_market', 'get_unused_licenses_num', [...]);

Get number of unused licenses for some profile. It can be used in menus with "alert" counters.

Parameters
$iProfileIdprofile to get unused licenses for, if omitted then currently logged in profile is used
Returns
an integer value with a number of unused licenses.
See also
BxMarketModule::serviceGetUnusedLicensesNum

Market

Licenses

has_license

bx_srv('bx_market', 'has_license', [...]);

Check whether a profile has a license for specified product. Domain on which the license is used can be attached to checking.

Parameters
$iProfileIdprofile which ownership will be checked.
$iProductIdproduct which the license(s) will be searched for.
$sDomain(optional) domain name on which the license is used.
Returns
boolean value determining where the license is available or not.
See also
BxMarketModule::serviceHasLicense

Market

Licenses

get_license

bx_srv('bx_market', 'has_license', [...]);

Get a list of licenses which meet requirements provided in the input array.

Parameters
$aParamsarray of requirements which will be used for searching.
Returns
an array of licenses which meet requirements.
See also
BxMarketModule::serviceGetLicense

Market

Licenses

update_license

bx_srv('bx_market', 'update_license', [...]);

Update license(s) changing necessary fields. Updatable license(s) should meet requirements provided in the input array.

Parameters
$aSetan array of data to be saved
$aWherean array of requirements which will be used for searching.
Returns
an array of licenses which meet requirements.
See also
BxMarketModule::serviceUpdateLicense

Market

Browsing

get_entry_by

bx_srv('bx_market', 'get_entry_by', [...]);

Get entry (product) which meets requirements.

Parameters
$sTypestring with search type.
$mixedValuemixed value to be used for searching.
Returns
an array describing a product which meets requirements.
See also
BxMarketModule::serviceGetEntryBy

Market

Browsing

get_entries_by

bx_srv('bx_market', 'get_entries_by', [...]);

Get an array of entries (products) which meet requirements.

Parameters
$aParamsan array of requirements which will be used for searching.
Returns
an array of products which meets requirements.
See also
BxMarketModule::serviceGetEntriesBy

Market

Browsing

get_products_names

bx_srv('bx_market', 'get_products_names', [...]);

Get an array of products names.

Parameters
$iVendorIdreturn products of 1 vendor only
$iLimitlimit the result artay
Returns
an array of products names
See also
BxMarketModule::serviceGetProductsNames

Market

Entry

get_thumbnail

bx_srv('bx_market', 'get_thumbnail', [...]);

Get an array of image URLs for the product's thumbnail. Returned images have different dimensions ('small' and 'big').

Parameters
$iPhotoIdphoto ID which is attached to a product as thumbnail.
Returns
an array of image URLs.
See also
BxMarketModule::serviceGetThumbnail

Market

Entry

get_cover

bx_srv('bx_market', 'get_cover', [...]);

Get an array of image URLs for the product's cover. Returned images have different dimensions ('small', 'large' and 'big').

Parameters
$iPhotoIdphoto ID which is attached to a product as cover.
Returns
an array of image URLs.
See also
BxMarketModule::serviceGetCover

Market

Entry

get_file

bx_srv('bx_market', 'get_file', [...]);

Get an array with file's description.

Parameters
$iFileIdfile ID which is attached to a product as package (version, update, etc).
Returns
an array with file's description.
See also
BxMarketModule::serviceGetFile

Market

Entry

get_files

bx_srv('bx_market', 'get_files', [...]);

Get an array with files attached to the entry.

Parameters
$iEntryIdproduct ID.
$sTypefile type ('version', 'update')
Returns
an array with files.
See also
BxMarketModule::serviceGetFiles

Market

Entry

get_updates

bx_srv('bx_market', 'get_updates', [...]);

Get an array with update(s)' description(s).

Parameters
$iContentIdproduct's ID.
$sVersion(optional) if version is specified then it will be used for searching as 'Version From'.
Returns
an array with update(s)' description(s).
See also
BxMarketModule::serviceGetUpdates

Market

Entry

get_screenshots

bx_srv('bx_market', 'get_screenshots', [...]);

Get an array with screenshots' descriptions.

Parameters
$iItemIdproduct's ID.
Returns
an array with screenshots' descriptions.
See also
BxMarketModule::serviceGetScreenshots

Market

Payments

get_payment_data

bx_srv('bx_market', 'get_payment_data', [...]);

Get an array with module's description. Is needed for payments processing module.

Returns
an array with module's description.
See also
BxMarketModule::serviceGetPaymentData

Market

Payments

get_cart_item

bx_srv('bx_market', 'get_cart_item', [...]);

Get an array with prodict's description. Is used in Shopping Cart in payments processing module.

Parameters
$mixedItemIdproduct's ID or Unique Name.
Returns
an array with prodict's description. Empty array is returned if something is wrong.
See also
BxMarketModule::serviceGetCartItem

Market

Payments

get_cart_items

bx_srv('bx_market', 'get_cart_items', [...]);

Get an array with prodicts' descriptions by seller. Is used in Manual Order Processing in payments processing module.

Parameters
$iSellerIdseller ID.
Returns
an array with prodicts' descriptions. Empty array is returned if something is wrong or seller doesn't have any products.
See also
BxMarketModule::serviceGetCartItems

Market

Payments

register_cart_item

bx_srv('bx_market', 'register_cart_item', [...]);

Register a processed single time payment inside the Market module. Is called with payment processing module after the payment was registered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
an array with purchased prodict's description. Empty array is returned if something is wrong.
See also
BxMarketModule::serviceRegisterCartItem

Market

Payments

register_subscription_item

bx_srv('bx_market', 'register_subscription_item', [...]);

Register a processed subscription (recurring payment) inside the Market module. Is called with payment processing module after the subscription was registered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
an array with subscribed prodict's description. Empty array is returned if something is wrong.
See also
BxMarketModule::serviceRegisterSubscriptionItem

Market

Payments

reregister_cart_item

bx_srv('bx_market', 'reregister_cart_item', [...]);

Reregister a single time payment inside the Market module. Is called with payment processing module after the payment was reregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIdOldold item ID.
$iItemIdNewnew item ID.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with purchased prodict's description. Empty array is returned if something is wrong.
See also
BxMarketModule::serviceReregisterCartItem

Market

Payments

reregister_subscription_item

bx_srv('bx_market', 'reregister_subscription_item', [...]);

Reregister a subscription (recurring payment) inside the Market module. Is called with payment processing module after the subscription was reregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIdOldold item ID.
$iItemIdNewnew item ID.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
an array with subscribed prodict's description. Empty array is returned if something is wrong.
See also
BxMarketModule::serviceReregisterSubscriptionItem

Market

Payments

unregister_cart_item

bx_srv('bx_market', 'unregister_cart_item', [...]);

Unregister an earlier processed single time payment inside the Market module. Is called with payment processing module after the payment was unregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
boolean value determining where the payment was unregistered or not.
See also
BxMarketModule::serviceUnregisterCartItem

Market

Payments

unregister_subscription_item

bx_srv('bx_market', 'unregister_subscription_item', [...]);

Unregister an earlier processed subscription (recurring payment) inside the Market module. Is called with payment processing module after the subscription was unregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
boolean value determining where the subscription was unregistered or not.
See also
BxMarketModule::serviceUnregisterSubscriptionItem

Market

Payments

cancel_subscription_item

bx_srv('bx_market', 'cancel_subscription_item', [...]);

Cancel an earlier processed subscription (recurring payment) inside the Market module. Is called with payment processing module after the subscription was canceled there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
Returns
boolean value determining where the subscription was canceled or not.
See also
BxMarketModule::serviceCancelSubscriptionItem

Mass mailer

Page Blocks

campagn_subscribers

bx_srv('bx_massmailer', 'campagn_subscribers', [...]);

Get page block with the campagn's subscribers list

Parameters
$iContentIdcontent ID.
Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMassMailerModule::serviceCampagnSubscribers

Mass mailer

Page Blocks

campagn_info

bx_srv('bx_massmailer', 'campagn_info', [...]);

Get page block with the campagn info

Parameters
$iContentIdcontent ID.
Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMassMailerModule::serviceCampagnInfo

Mass mailer

Page Blocks

campagn_links

bx_srv('bx_massmailer', 'campagn_links', [...]);

Get page block with the campagn links list

Parameters
$iContentIdcontent ID
Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMassMailerModule::serviceCampagnLinks

Mass mailer

Page Blocks

total_subscribers

bx_srv('bx_massmailer', 'total_subscribers', [...]);

Get page block with subscribers charts

Parameters
$aParamsan array with search params.
Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMassMailerModule::serviceTotalSubscribers

Mass mailer

Page Blocks

entity_breadcrumb

bx_srv('bx_massmailer', 'entity_breadcrumb', [...]);

Get page block with page's breadcrumbs

Parameters
$iContentIdcontent ID
Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMassMailerModule::serviceEntityBreadcrumb

Mass mailer

Page Blocks

attributes

bx_srv('bx_massmailer', 'attributes', [...]);

Get page block with attributes list

Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxMassMailerModule::serviceAttributes

Invitations

Other

get_include

bx_srv('bx_notifications', 'get_include', [...]);

Get all necessary CSS and JS files to include in a page.

Returns
string with all necessary CSS and JS files.
See also
BxInvModule::serviceGetInclude

Invitations

Page Blocks

get_block_settings

bx_srv('bx_notifications', 'get_block_settings', [...]);

Get Settings block for a separate page.

Returns
a string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxNtfsModule::serviceGetBlockSettings

Invitations

Page Blocks

get_block_view

bx_srv('bx_notifications', 'get_block_view', [...]);

Get View block for a separate page. Will return a block with "Empty" message if nothing found.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxNtfsModule::serviceGetBlockView

Invitations

Browsing

get_event_by_id

bx_srv('bx_notifications', 'get_event_by_id', [...]);

Get event's data by event ID.

Returns
an array with event's data.
See also
BxNtfsModule::serviceGetEventById

Invitations

Other

get_notifications

bx_srv('bx_notifications', 'get_notifications', [...]);

Get notifications by params.

Returns
array with notifications.
See also
BxNtfsModule::serviceGetNotifications

Invitations

Other

get_unread_notifications

bx_srv('bx_notifications', 'get_unread_notifications', [...]);

Get unread notifications.

Returns
array with unread notifications.
See also
BxNtfsModule::serviceGetUnreadNotifications

Invitations

Other

get_unread_notifications_num

bx_srv('bx_notifications', 'get_unread_notifications_num', [...]);

Get number of unread notifications.

Returns
integer value with number of unread notifications.
See also
BxNtfsModule::serviceGetUnreadNotificationsNum

Invitations

Other

get_live_updates

bx_srv('bx_notifications', 'get_live_updates', [...]);

Get data for Live Updates system.

Returns
an array with special format.
See also
BxNtfsModule::serviceGetLiveUpdates

Payment

Page Blocks

get_block_carts

bx_srv('bx_payment', 'get_block_carts', [...], 'Cart');

Get page block with shopping carts by vendors.

Returns
an array describing a block to display on the site or an empty string if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentCart::serviceGetBlockCarts

Payment

Page Blocks

get_block_cart

bx_srv('bx_payment', 'get_block_cart', [...], 'Cart');

Get page block with content of selected shopping cart.

Returns
an array describing a block to display on the site or an empty string if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentCart::serviceGetBlockCart

Payment

Page Blocks

get_block_cart_history

bx_srv('bx_payment', 'get_block_cart_history', [...], 'Cart');

Get page block with shopping cart history.

Returns
an array describing a block to display on the site or an empty string if something is wrong. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentCart::serviceGetBlockCartHistory

Payment

Purchase Processing

add_to_cart

bx_srv('bx_payment', 'add_to_cart', [...], 'Cart');

Add an item described with method's params to shopping cart.

Parameters
$iSellerIdinteger value with seller ID.
$mixedModuleIdmixed value (ID, Name or URI) determining a module from which the action was initiated.
$iItemIdinteger value with item ID.
$iItemCountinteger value with a number of items for purchasing.
$aCustomarray with custom data.
Returns
an array with special format which describes the result of operation.
See also
BxPaymentCart::serviceAddToCart

Payment

Purchase Processing

delete_from_cart

bx_srv('bx_payment', 'delete_from_cart', [...], 'Cart');

Delete an item(s) from shopping cart.

Parameters
$iSellerIdinteger value with seller ID. The items owned by this seller will be removed only.
$iModuleId(optional) integer value with module ID. If specified, the items related to this module will be removed only.
$iItemId(optional) integer value with item ID. If specified, the item with this ID will be removed only.
Returns
an array with special format which describes the result of operation.
See also
BxPaymentCart::serviceDeleteFromCart

Payment

Page Blocks

get_block_invoices

bx_srv('bx_payment', 'get_block_invoices', [...], 'Details');

Get page block with a list of invoices.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentDetails::serviceGetBlockDetails

Payment

Page Blocks

get_block_details

bx_srv('bx_payment', 'get_block_details', [...], 'Details');

Get page block with payment providers' configuration settings represented as subforms.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentDetails::serviceGetBlockDetails

Payment

Page Blocks

get_block_join

bx_srv('bx_payment', 'get_block_join', [...], 'Join');

Get page block with join form to complete the payment. TODO: Should be tested when paid memberships with "Paid Before Join" or some similar feature will appear.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentJoin::serviceGetBlockJoin

Payment

Purchase Processing

get_modules_with_payments

bx_srv('bx_payment', 'get_modules_with_payments', []);

Get modules with payments functionality

Returns
array with modules names
See also
BxPaymentModule::serviceGetModulesWithPayments

Payment

Purchase Processing

is_credits_only

bx_srv('bx_payment', 'is_credits_only');

Check whether the 'Credits Only' mode is enabled or not.

Returns
boolean value determining the result of checking.
See also
BxPaymentModule::serviceIsCreditsOnly

Payment

Purchase Processing

is_accepting_payments

bx_srv('bx_payment', 'is_accepting_payments', [...]);

Check whether the specified vendor has a configured payment provider or not.

Parameters
$iVendorIdinteger value with vendor ID.
$sPaymentType(optional) string value with payment type. If specified then the vendor will be checked for having the payment provider of the requested type.
Returns
boolean value determining the result of checking.
See also
BxPaymentModule::serviceIsAcceptingPayments

Payment

Purchase Processing

is_provider_options

bx_srv('bx_payment', 'is_provider_options', [...]);

Check whether the specified vendor has configured the specified payment provider or not.

Parameters
$iVendorIdinteger value with vendor ID.
$sVendorProviderstring value with payment provider name.
$sPaymentType(optional) string value with payment type. If specified then the vendor will be checked for having the payment provider of the requested type.
Returns
boolean value determining the result of checking.
See also
BxPaymentModule::serviceIsProviderOptions

Payment

Purchase Processing

get_provider_options

bx_srv('bx_payment', 'get_provider_options', [...]);

Get configuration settings for the payment provider entered by the specified vendor.

Parameters
$iVendorIdinteger value with vendor ID.
$sVendorProviderstring value with payment provider name.
$sPaymentType(optional) string value with payment type. If specified then the vendor will be checked for having the payment provider of the requested type.
Returns
an array with special format describing the payment provider or false value if something is wrong.
See also
BxPaymentModule::serviceGetProviderOptions

Payment

Other

get_options_default_currency_code

bx_srv('bx_payment', 'get_options_default_currency_code', [...]);

Get an array with available currencies. Is used in forms.

Returns
an array with available currencies represented as key => value pairs.
See also
BxPaymentModule::serviceGetOptionsDefaultCurrencyCode

Payment

Other

get_options_site_admin

bx_srv('bx_payment', 'get_options_site_admin', [...]);

Get an array with profiles which can be used as 'Site Admin (Owner)'. 'Site Admin' is a person who will be displayed to buyers when something is selling on behalf of the site.

Returns
an array with profiles represented as key => value pairs.
See also
BxPaymentModule::serviceGetOptionsSiteAdmin

Payment

Purchase Processing

authorize_checkout

bx_srv('bx_payment', 'authorize_checkout', [...]);

Authorize order for future checkout.

Parameters
$sTypestring value with payment type (single or recurring).
$iSellerIdinteger value with seller ID.
$sProviderstring value with payment provider name.
$aItems(optional) an array with items to be purchased.
$sRedirect(optional) string value with redirect URL if it's needed.
Returns
the result depends on the payment provider which is used for processing or represented as string value with error message if something is wrong.
See also
BxPaymentModule::serviceAuthorizeCheckout

Payment

Purchase Processing

capture_authorized_checkout

bx_srv('bx_payment', 'capture_authorized_checkout', [...]);

Capture funds for previously authorized order.

Parameters
$sTypestring value with payment type (single or recurring).
$sOrderAuthstring value with order's authorization ID.
Returns
the result depends on the payment provider which is used for processing or represented as string value with error message if something is wrong.
See also
BxPaymentModule::serviceCaptureAuthorizedCheckout

Payment

Purchase Processing

initialize_checkout

bx_srv('bx_payment', 'initialize_checkout', [...]);

Initialize the checkout process.

Parameters
$sTypestring value with payment type (single or recurring).
$iSellerIdinteger value with seller ID.
$sProviderstring value with payment provider name.
$aItems(optional) an array with items to be purchased.
$sRedirect(optional) string value with redirect URL if it's needed.
$aCustom(optional) array with custom data to attach to a payment.
Returns
the result depends on the payment provider which is used for processing or represented as string value with error message if something is wrong.
See also
BxPaymentModule::serviceInitializeCheckout

Integration with itslef which is needed to pay an invoice.

Payment

Payments

get_payment_data

bx_srv('bx_payment', 'get_payment_data', [...]);

Get an array with module's description. Is needed for payments processing module.

Returns
an array with module's description.
See also
BxPaymentModule::serviceGetPaymentData

Payment

Payments

get_cart_item

bx_srv('bx_payment', 'get_cart_item', [...]);

Get an array with prodict's description. Is used in Shopping Cart in payments processing module.

Parameters
$mixedItemIdproduct's ID or Unique Name.
Returns
an array with prodict's description. Empty array is returned if something is wrong.
See also
BxPaymentModule::serviceGetCartItem

Payment

Payments

get_cart_items

bx_srv('bx_payment', 'get_cart_items', [...]);

Get an array with prodicts' descriptions by seller. Is used in Manual Order Processing in payments processing module.

Parameters
$iCommissionaireIdcommissionaire ID.
Returns
an array with prodicts' descriptions. Empty array is returned if something is wrong or seller doesn't have any products.
See also
BxPaymentModule::serviceGetCartItems

Payment

Payments

register_cart_item

bx_srv('bx_payment', 'register_cart_item', [...]);

Register a processed single time payment inside the Payment module. Is called with payment processing module after the payment was registered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
an array with purchased prodict's description. Empty array is returned if something is wrong.
See also
BxPaymentModule::serviceRegisterCartItem

Payment

Payments

unregister_cart_item

bx_srv('bx_payment', 'unregister_cart_item', [...]);

Unregister an earlier processed single time payment inside the Payment module. Is called with payment processing module after the payment was unregistered there.

Parameters
$iClientIdclient ID.
$iSellerIdseller ID
$iItemIditem ID.
$iItemCountthe number of purchased items.
$sOrderorder number received from payment provider (PayPal, Stripe, etc)
$sLicenselicense number genereted with payment processing module for internal usage
Returns
boolean value determining where the payment was unregistered or not.
See also
BxPaymentModule::serviceUnregisterCartItem

Payment

Page Blocks

get_block_orders

bx_srv('bx_payment', 'get_block_orders', [...], 'Orders');

Get page block with a list of orders represented as table.

Parameters
$sTypestring value with order type (processed or pending).
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentOrders::serviceGetBlockOrders

Payment

Other

get_orders_info

bx_srv('bx_payment', 'get_orders_info', [...], 'Orders');

Get transaction(s) which meets all requirements.

Parameters
$aConditionsan array of pears('key' => 'value'). Available keys are the following: a. license - internal license (string) b. client_id - client's ID (integer) c. seller_id - seller's ID (integer) d. module_id - modules's where the purchased product is located. (integer) e. item_id - item id in the database. (integer) f. date - the date when the payment was processed(UNIXTIME STAMP)
Returns
an array of transactions. Each transaction has full info(client ID, seller ID, external transaction ID, date and so on)
See also
BxPaymentOrders::serviceGetOrdersInfo

Payment

Other

get_pending_orders_info

bx_srv('bx_payment', 'get_pending_orders_info', [...], 'Orders');

Get pending transaction(s) which meets all requirements.

Parameters
$aConditionsan array of pears('key' => 'value'). The most useful keys are the following: a. client_id - client's ID (integer) b. seller_id - seller's ID (integer) c. type - transaction type: single or recurring (string) d. amount - transaction amount (float) e. order - order ID received from payment provider (string) f. provider - payment provider name (string) g. date - the date when the payment was established(UNIXTIME STAMP) h. processed - whether the payment was processed or not (integer, 0 or 1)
Returns
an array of pending transactions. Each transaction has full info(client ID, seller ID, type, date and so on)
See also
BxPaymentOrders::serviceGetPendingOrdersInfo

Payment

Page Blocks

get_block_list_my

bx_srv('bx_payment', 'get_block_list_my', [...], 'Subscriptions');

Get page block with a list of currently logged in member's subscriptions.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentSubscriptions::serviceGetBlockListMy

Payment

Page Blocks

get_block_list_all

bx_srv('bx_payment', 'get_block_list_all', [...], 'Subscriptions');

Get page block with a list of all subscriptions. It's available for authorized members only.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentSubscriptions::serviceGetBlockListAll

Payment

Page Blocks

get_block_history

bx_srv('bx_payment', 'get_block_history', [...], 'Subscriptions');

Get page block with a list of payments related to subscriptions of currently logged in member.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPaymentSubscriptions::serviceGetBlockHistory

Payment

Other

get_subscription_orders_info

bx_srv('bx_payment', 'get_subscription_orders_info', [...], 'Subscriptions');

Get subscription transaction(s) which meets all requirements.

Parameters
$aConditionsan array of pears('key' => 'value'). The most useful keys are the following: a. client_id - client's ID (integer) b. seller_id - seller's ID (integer) c. type - transaction type: single or recurring (string) d. amount - transaction amount (float) e. order - order ID received from payment provider (string) f. provider - payment provider name (string) g. date - the date when the payment was established(UNIXTIME STAMP) h. processed - whether the payment was processed or not (integer, 0 or 1)
Returns
an array of transactions. Each transaction has full info(client ID, seller ID, external transaction ID, date and so on)
See also
BxPaymentSubscriptions::serviceGetSubscriptionOrdersInfo

Payment

Other

get_subscriptions_info

bx_srv('bx_payment', 'get_subscriptions_info', [...], 'Subscriptions');

Get subscription(s) which meets all requirements.

Parameters
$aConditionsan array of pears('key' => 'value'). The most useful keys are the following: a. pending_id - pending transaction ID (integer) b. customer_id - customer ID from payment provider (string) c. subscription_id - subscription ID from payment provider (string) d. paid - flag determining whether the subscription paid or not (integer) e. date - the date when the subscription was established(UNIXTIME STAMP)
$bCheckInProviderboolean value determining whether the subscription should be checked in associated payment provider.
Returns
an array of subscriptions. Each subscription has full info(pending ID, customer ID, subscription ID and so on)
See also
BxPaymentSubscriptions::serviceGetSubscriptionsInfo

Payment

Purchase Processing

subscribe

bx_srv('bx_payment', 'subscribe', [...], 'Subscriptions');

Initialize subscription for specified item.

Parameters
$iSellerIdinteger value with seller ID.
$sSellerProviderstring value with a name of payment provider to be used for processing. Empty value means that payment provider selector should be shown.
$iModuleIdinteger value with module ID.
$iItemIdinteger value with item ID.
$iItemCountinteger value with a number of items for purchasing. It's equal to 1 in case of subscription.
$sRedirect(optional) string value with redirect URL, if it's needed.
Returns
an array with special format which describes the result of operation.
See also
BxPaymentSubscriptions::serviceSubscribe

Payment

Purchase Processing

subscribe_with_addons

bx_srv('bx_payment', 'subscribe_with_addons', [...], 'Subscriptions');

Initialize subscription for specified item.

Parameters
$iSellerIdinteger value with seller ID.
$sSellerProviderstring value with a name of payment provider to be used for processing. Empty value means that payment provider selector should be shown.
$iModuleIdinteger value with module ID.
$iItemIdinteger value with item ID.
$iItemCountinteger value with a number of items for purchasing. It's equal to 1 in case of subscription.
$sItemAddons(optional) string with attached addons.
$sRedirect(optional) string value with redirect URL, if it's needed.
Returns
an array with special format which describes the result of operation.
See also
BxPaymentSubscriptions::serviceSubscribeWithAddons

Payment

Purchase Processing

send_subscription_expiration_letters

bx_srv('bx_payment', 'send_subscription_expiration_letters', [...], 'Subscriptions');

Send subscription expiration letters.

Parameters
$iPendingIdinteger value with pending transaction ID.
$sOrderIdstring value with order ID.
See also
BxPaymentSubscriptions::serviceSendSubscriptionExpirationLetters

Persons

Other

bx_persons-get_search_options

bx_srv('bx_persons', 'get_search_options', [...]);

Get options for searchable fields

Returns
array - params or false.
See also
BxPersonsModule::serviceGetSearchOptions

Photos

Page Blocks

entity_photo_block

bx_srv('bx_photos', 'entity_photo_block', [...]);

Get page block with photo.

Parameters
$iContentId(optional) photo ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
HTML string with block content to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPhotosModule::serviceEntityPhotoBlock

Photos

Page Blocks

entity_photo_block

bx_srv('bx_photos', 'entity_photo_switcher_block', [...]);

Get page block with photo and Prev/Next controls.

Parameters
$iContentId(optional) photo ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
HTML string with block content to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPhotosModule::serviceEntityPhotoBlock

Photos

Page Blocks

entity_rating

bx_srv('bx_photos', 'entity_rating', [...]);

Get page block with Stars based photo's rating.

Parameters
$iContentId(optional) photo ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
HTML string with block content to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPhotosModule::serviceEntityRating

SERVICE METHODS

Polls

Page Blocks

get_results_search_extended

bx_srv('bx_polls', 'get_results_search_extended', [...]);

Get page block with the results of Extended Search.

Parameters
$aParamsan array with search params.
Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPollsModule::serviceGetResultsSearchExtended

Polls

Page Blocks

get_block_subentries

bx_srv('bx_polls', 'get_block_subentries', [...]);

Get page block with poll questions.

Parameters
$iContentId(optional) poll's ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
$bForceDisplay(optional) if true is passed then the block will be displayed as is (without checking whether user answered the poll or not).
Returns
HTML string with block content to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPollsModule::serviceGetBlockSubentries

Polls

Page Blocks

get_block_results

bx_srv('bx_polls', 'get_block_results', [...]);

Get page block with poll results.

Parameters
$iContentId(optional) poll's ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
HTML string with block content to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPollsModule::serviceGetBlockResults

Polls

Page Blocks

get_block_text_and_subentries

bx_srv('bx_polls', 'get_block_text_and_subentries', [...]);

Get page block with poll question and answers with possibility to switch to results.

Parameters
$iContentId(optional) poll's ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
$bForceDisplay(optional) if true is passed then the block will be displayed as is (without checking whether user answered the poll or not).
Returns
HTML string with block content to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxPollsModule::serviceGetBlockTextAndSubentries

Quote of the Day

Other

get_sources

bx_srv('bx_quoteofday', 'get_sources', [...]);

Get list of avaliable sources types for studio settings (rss feed or internal list)

Returns
an array with avaliable sources.
See also
BxQuoteOfDayModule::serviceGetSources

Quote of the Day

Other

selection_mode

bx_srv('bx_quoteofday', 'get_selection_mode', [...]);

Get list of avaliable selection mode(randome mode or ordered mode) for studio settings

Returns
an array with selection modes.
See also
BxQuoteOfDayModule::serviceGetSelectionMode

Quote of the Day

Other

get_menu_addon_manage_tools

bx_srv('bx_quoteofday', 'get_menu_addon_manage_tools', [...]);

Get count of hidden items in internal data for dashbord

Returns
digit - count of hidden item .
See also
BxQuoteOfDayModule::serviceGetMenuAddonManageTools

Quote of the Day

Other

bx_quoteofday-get_quote

bx_srv('bx_quoteofday', 'get_quote', [...]);

Get current Quote of the Day

Returns
string - current Quote of the Day from system cache .
See also
BxQuoteOfDayModule::serviceGetQuote

Quote of the Day

Other

bx_quoteofday-set_quotes_manage

bx_srv('bx_quoteofday', 'set_quotes_manage', [...]);

Return Grid from internal quotes management

Returns
string - code of grid quotes management.
See also
BxQuoteOfDayModule::serviceGetQuotesManage

Shopify

Integration

include

bx_srv('bx_shopify', 'include', [...]);

Get integration code with all necessary CSS and JS includes.

Returns
HTML sting with integration code to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxShopifyModule::serviceInclude

Shopify

Integration

include_css_js

bx_srv('bx_shopify', 'include_css_js', [...]);

Include all necessary CSS and JS files.

See also
BxShopifyModule::serviceIncludeCssJs

Shopify

Integration

include_code

bx_srv('bx_shopify', 'include_code', [...]);

Get integration code.

Returns
HTML sting with integration code to display on the site. Empty string is returned if there is no enough input data.
See also
BxShopifyModule::serviceIncludeCode

Shopify

Page Blocks

get_results_search_extended

bx_srv('bx_shopify', 'get_results_search_extended', [...]);

Get page block with the results of Extended Search.

Parameters
$aParamsan array with search params.
Returns
HTML string with block content to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxShopifyModule::serviceGetResultsSearchExtended

Shopify

Page Blocks

entity_create

bx_srv('bx_shopify', 'entity_create', [...]);

Get page block with product creation form or an error message if something wasn't configured correctly.

Parameters
$sDisplayform display name to use
Returns
HTML string with block content to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxShopifyModule::serviceEntityCreate

Shopify

Page Blocks

settings

bx_srv('bx_shopify', 'settings', [...]);

Get page block with configuration settings form.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxShopifyModule::serviceSettings

Snipcart

Other

get_searchable_fields

bx_srv('bx_snipcart', 'get_searchable_fields', [...]);

Get a list of searchable fields. Is used in common search engine.

Returns
an array with a list of searchable fields.
See also
BxSnipcartModule::serviceGetSearchableFields

Snipcart

Integration

include_css_js

bx_srv('bx_snipcart', 'include_css_js', [...]);

Get integration code with all necessary CSS and JS includes.

Returns
HTML sting with integration code to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML. Empty string is returned if there is no enough input data.
See also
BxSnipcartModule::serviceIncludeCssJs

Snipcart

Page Blocks

entity_create

bx_srv('bx_snipcart', 'entity_create', [...]);

Get page block with product creation form or an error message if something wasn't configured correctly.

Parameters
$sDisplayform display name to use
Returns
HTML string with block content to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxSnipcartModule::serviceEntityCreate

Snipcart

Page Blocks

settings

bx_srv('bx_snipcart', 'settings', [...]);

Get page block with configuration settings form.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxSnipcartModule::serviceSettings

Stripe Connect

Other

get_options_mode

bx_srv('bx_stripe_connect', 'get_options_mode', [...]);

Get an array with available modes. Is used in forms.

Returns
an array with available modes represented as key => value pairs.
See also
BxStripeConnectModule::serviceGetOptionsMode

Stripe Connect

Other

get_options_api_scope

bx_srv('bx_stripe_connect', 'get_options_api_scope', [...]);

Get an array with available API scopes. Is used in forms.

Returns
an array with available scopes represented as key => value pairs.
See also
BxStripeConnectModule::serviceGetOptionsApiScope

Stripe Connect

Other

get_options_pmode_single

bx_srv('bx_stripe_connect', 'get_options_pmode_single', [...]);

Get an array with available processing modes for single time payments. Is used in forms.

Returns
an array with available modes represented as key => value pairs.
See also
BxStripeConnectModule::serviceGetOptionsPmodeSingle

Stripe Connect

Other

get_options_pmode_recurring

bx_srv('bx_stripe_connect', 'get_options_pmode_recurring', [...]);

Get an array with available processing modes for recurring payments. Is used in forms. Note. Subscriptions (recurring payments) do not currently support the Platform mode.

Returns
an array with available modes represented as key => value pairs.
See also
BxStripeConnectModule::serviceGetOptionsPmodeRecurring

Stripe Connect

Page Blocks

get_block_connect

bx_srv('bx_stripe_connect', 'get_block_connect', [...]);

Get page block with necessary info and actions to connect/disconnect.

Returns
HTML string with block content to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxStripeConnectModule::serviceGetBlockConnect

Tasks

Page Blocks

calendar

bx_srv('bx_tasks', 'calendar', [...]);

Shows tasks calendar baced on die date

Parameters
$aDataadditional data to point which events to show, leave empty to show all events, specify event's ID in 'event' array key to show calendar for one event only, specify context's ID in 'context_id' array key to show calendar for one context events only. If only one event is specified then it will show calendar only if it's repeating event.
$sTemplatetemplate to use to show calendar, or leave empty for default template, possible options: calendar.html, calendar_compact.html
Returns
HTML string with calendar to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML. On error empty string is returned.
See also
BxTasksModule::serviceCalendar

Timeline

Other

get_hot_sources_checklist

bx_srv('bx_timeline', 'get_hot_sources_checklist', [...]);

Get a list of available sources for Hot feed. Is used in module settings in Studio.

Returns
an array with available sources represented as key => value pairs.
See also
BxTimelineModule::serviceGetHotSourcesChecklist

Timeline

Other

get_content_owner_profile_id

bx_srv('bx_timeline', 'get_content_owner_profile_id', [...]);

Get event's owner profile id.

Parameters
$mixedEventinteger value with event ID or an array with event info.
Returns
event's owner profile id.
See also
BxTimelineModule::serviceGetContentOwnerProfileId

Timeline

Other

get_create_post_form

bx_srv('bx_timeline', 'get_create_post_form', [...]);

Get form code for add content. Is needed for United Post Form.

Parameters
$aParamsoptional array with parameters(display name, etc)
Returns
form code or error
See also
BxTimelineModule::serviceGetCreatePostForm

Timeline

Other

get_object_form

bx_srv('bx_timeline', 'get_object_form', [...]);

Get form object for add, edit, view or delete the content.

Parameters
$sType'add' is supported only
$aParamsoptional array with parameters(display name, etc)
Returns
form object or false on error
See also
BxTimelineModule::serviceGetObjectForm

Timeline

get_timeline_post

See also
BxTimelineModule::serviceGetTimelinePost

Get Timeline post. It's needed for Timeline module.

Parameters
$aEventtimeline event array from Timeline module
Returns
array in special format which is needed specifically for Timeline module to display the data.

Timeline

get_timeline_post

See also
BxTimelineModule::serviceGetTimelinePostAllowedView

Check Timeline post's visibility. It's needed for Timeline module, when its events are accessed and checked from outside. For example, when they are referenced from Channels module.

Parameters
$aEventtimeline event array from Timeline module
Returns
mixed value: CHECK_ACTION_RESULT_ALLOWED or text of some error message.

Timeline

Other

get_author

bx_srv('bx_timeline', 'get_author', [...]);

Get author ID from content info by content ID. Is used in "Content Info Objects" system.

Parameters
$iContentIdinteger value with content ID.
Returns
integer value with author ID.
See also
BxTimelineModule::serviceGetAuthor

Timeline

Other

get_date_changed

bx_srv('bx_timeline', 'get_date_changed', [...]);

Get date when the content was changed last time. Is used in "Content Info Objects" system. Note. In case of Timeline event 0 is returned everytime.

Parameters
$iContentIdinteger value with content ID.
Returns
integer value with changing date.
See also
BxTimelineModule::serviceGetDateChanged

Timeline

Other

get_link

bx_srv('bx_timeline', 'get_link', [...]);

Get content view page link. Is used in "Content Info Objects" system.

Parameters
$iContentIdinteger value with content ID.
Returns
string value with view page link.
See also
BxTimelineModule::serviceGetLink

Timeline

Other

get_thumb

bx_srv('bx_timeline', 'get_thumb', [...]);

Get content thumbnail link. Is used in "Content Info Objects" system. Note. In case of Timeline event an empty string is returned everytime.

Parameters
$iContentIdinteger value with content ID.
$sTranscoder(optional) string value with transcoder name which should be applied to thumbnail image.
Returns
string value with thumbnail link.
See also
BxTimelineModule::serviceGetThumb

Timeline

Other

get_info

bx_srv('bx_timeline', 'get_info', [...]);

Get content info by content ID. Is used in "Content Info Objects" system.

Parameters
$iContentIdinteger value with content ID.
$bSearchableFieldsOnly(optional) boolean value determining all info or "searchable fields" only will be returned.
Returns
an array with content info. Empty array is returned if something is wrong.
See also
BxTimelineModule::serviceGetInfo

Timeline

Other

get_title

bx_srv('bx_timeline', 'get_title', [...]);

Get content title by content ID. Is used in "Content Info Objects" system.

Parameters
$iContentIdinteger value with content ID.
Returns
an array with content info. Empty array is returned if something is wrong.
See also
BxTimelineModule::serviceGetTitle

Timeline

Other

get_search_result_unit

bx_srv('bx_timeline', 'get_search_result_unit', [...]);

Get search result unit by content ID. Is used in "Content Info Objects" system.

Parameters
$iContentIdinteger value with content ID.
$sUnitTemplate(optional) string value with template name.
Returns
HTML string with search result unit. Empty string is returned if something is wrong.
See also
BxTimelineModule::serviceGetSearchResultUnit

Timeline

Page Blocks

get_block_post

bx_srv('bx_timeline', 'get_block_post', [...]);

Get Post block for a separate page.

Parameters
$iProfileId(optional) profile ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockPost

Timeline

Page Blocks

get_block_post_profile

bx_srv('bx_timeline', 'get_block_post_profile', [...]);

Get Post block for the Profile page.

Parameters
$sProfileModule(optional) string value with profile based module name. Persons module is used by default.
$iProfileContentId(optional) profile's content ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockPostProfile

Timeline

Page Blocks

get_block_post_home

bx_srv('bx_timeline', 'get_block_post_home', [...]);

Get Post block for site's Home page.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockPostHome

Timeline

Page Blocks

get_block_post_account

bx_srv('bx_timeline', 'get_block_post_account', [...]);

Get Post block for the Dashboard page.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockPostAccount

Timeline

Page Blocks

get_block_post_custom

bx_srv('bx_timeline', 'get_block_post_custom', [...]);

Get Post block for the Custom timeline.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockPostCustom

Timeline

Page Blocks

get_block_view

bx_srv('bx_timeline', 'get_block_view', [...]);

Get Timeline View block for a separate page.

Parameters
$iProfileId(optional) profile ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockView

Timeline

Page Blocks

get_block_view_outline

bx_srv('bx_timeline', 'get_block_view_outline', [...]);

Get Outline View block for a separate page.

Parameters
$iProfileId(optional) profile ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewOutline

Timeline

Page Blocks

get_block_view_profile

bx_srv('bx_timeline', 'get_block_view_profile', [...]);

Get Timeline View block for the Profile page.

Parameters
$sProfileModule(optional) string value with profile based module name. Persons module is used by default.
$iProfileContentId(optional) profile's content ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
$iStart(optional) integer value with a page number. Is used in pagination.
$iPerPage(optional) integer value with a number of items per page. Is used in pagination.
$sFilter(optional) string value with filter name.
$aModules(optional) an array of modules from which the events should be displayed. All available modules are used by default.
$iTimeline(optional) integer value determining whether the timeline should be displayed or not.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewProfile

Timeline

Page Blocks

get_block_view_profile_outline

bx_srv('bx_timeline', 'get_block_view_profile_outline', [...]);

Get Outline View block for the Profile page.

Parameters
$sProfileModule(optional) string value with profile based module name. Persons module is used by default.
$iProfileContentId(optional) profile's content ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
$iStart(optional) integer value with a page number. Is used in pagination.
$iPerPage(optional) integer value with a number of items per page. Is used in pagination.
$sFilter(optional) string value with filter name.
$aModules(optional) an array of modules from which the events should be displayed. All available modules are used by default.
$iTimeline(optional) integer value determining whether the timeline should be displayed or not.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewProfileOutline

Timeline

Page Blocks

get_block_view_home

bx_srv('bx_timeline', 'get_block_view_home', [...]);

Get Timeline View block for site's Home page.

Parameters
$iProfileId(optional) profile ID. 0 should be used here.
$iStart(optional) integer value with a page number. Is used in pagination.
$iPerPage(optional) integer value with a number of items per page. Is used in pagination.
$iTimeline(optional) integer value determining whether the timeline should be displayed or not.
$sFilter(optional) string value with filter name.
$aModules(optional) an array of modules from which the events should be displayed. All available modules are used by default.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewHome

Timeline

Page Blocks

get_block_view_home_outline

bx_srv('bx_timeline', 'get_block_view_home_outline', [...]);

Get Outline View block for site's Home page.

Parameters
$iProfileId(optional) profile ID. 0 should be used here.
$iStart(optional) integer value with a page number. Is used in pagination.
$iPerPage(optional) integer value with a number of items per page. Is used in pagination.
$iTimeline(optional) integer value determining whether the timeline should be displayed or not.
$sFilter(optional) string value with filter name.
$aModules(optional) an array of modules from which the events should be displayed. All available modules are used by default.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewHomeOutline

Timeline

Page Blocks

get_block_view_hot

bx_srv('bx_timeline', 'get_block_view_hot', [...]);

Get Timeline View block with Hot public events.

Parameters
$iProfileId(optional) profile ID. 0 should be used here.
$iStart(optional) integer value with a page number. Is used in pagination.
$iPerPage(optional) integer value with a number of items per page. Is used in pagination.
$iTimeline(optional) integer value determining whether the timeline should be displayed or not.
$sFilter(optional) string value with filter name.
$aModules(optional) an array of modules from which the events should be displayed. All available modules are used by default.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewHot

Timeline

Page Blocks

get_block_view_hot_outline

bx_srv('bx_timeline', 'get_block_view_hot_outline', [...]);

Get Outline View block with Hot public events.

Parameters
$iProfileId(optional) profile ID. 0 should be used here.
$iStart(optional) integer value with a page number. Is used in pagination.
$iPerPage(optional) integer value with a number of items per page. Is used in pagination.
$iTimeline(optional) integer value determining whether the timeline should be displayed or not.
$sFilter(optional) string value with filter name.
$aModules(optional) an array of modules from which the events should be displayed. All available modules are used by default.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewHotOutline

Timeline

Page Blocks

get_block_view_account

bx_srv('bx_timeline', 'get_block_view_account', [...]);

Get Timeline View block for the Dashboard page.

Parameters
$iProfileId(optional) profile ID. 0 should be used here.
$iStart(optional) integer value with a page number. Is used in pagination.
$iPerPage(optional) integer value with a number of items per page. Is used in pagination.
$iTimeline(optional) integer value determining whether the timeline should be displayed or not.
$sFilter(optional) string value with filter name.
$aModules(optional) an array of modules from which the events should be displayed. All available modules are used by default.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewAccount

Timeline

Page Blocks

get_block_view_account_outline

bx_srv('bx_timeline', 'get_block_view_account_outline', [...]);

Get Outline View block for the Dashboard page.

Parameters
$iProfileId(optional) profile ID. 0 should be used here.
$iStart(optional) integer value with a page number. Is used in pagination.
$iPerPage(optional) integer value with a number of items per page. Is used in pagination.
$iTimeline(optional) integer value determining whether the timeline should be displayed or not.
$sFilter(optional) string value with filter name.
$aModules(optional) an array of modules from which the events should be displayed. All available modules are used by default.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewAccountOutline

Timeline

Page Blocks

get_block_view_custom

bx_srv('bx_timeline', 'get_block_view_custom', [...]);

Get custom Timeline View block.

Parameters
$aParams(optional) an array with block parameneters.
Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockViewCustom

Timeline

Page Blocks

get_block_item

bx_srv('bx_timeline', 'get_block_item', [...]);

Get View Item block.

Returns
an array describing a block to display on the site. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetBlockItem

Timeline

Integration with Notifications

get_notifications_data

bx_srv('bx_timeline', 'get_notifications_data', [...]);

Data for Notifications module.

Returns
an array with special format.
See also
BxTimelineModule::serviceGetNotificationsData

Timeline

Integration with Notifications

get_notifications_repost

bx_srv('bx_timeline', 'get_notifications_repost', [...]);

Get data for Repost event to display in Notifications module.

Parameters
$aEventan array with event description.
Returns
an array with special format.
See also
BxTimelineModule::serviceGetNotificationsRepost

Timeline

Integration with Notifications

get_notifications_post

bx_srv('bx_timeline', 'get_notifications_post', [...]);

Get data for Post event to display in Notifications module.

Parameters
$aEventan array with event description.
Returns
an array with special format.
See also
BxTimelineModule::serviceGetNotificationsPost

Timeline

Integration with Notifications

get_notifications_comment

bx_srv('bx_timeline', 'get_notifications_comment', [...]);

Get data for Post Comment event to display in Notifications module.

Parameters
$aEventan array with event description.
Returns
an array with special format.
See also
BxTimelineModule::serviceGetNotificationsComment

Timeline

Integration with Notifications

get_notifications_reply

bx_srv('bx_timeline', 'get_notifications_reply', [...]);

Get data for Reply to Comment event to display in Notifications module.

Parameters
$aEventan array with event description.
Returns
an array with special format.
See also
BxTimelineModule::serviceGetNotificationsReply

Timeline

Integration with Notifications

get_notifications_vote

bx_srv('bx_timeline', 'get_notifications_vote', [...]);

Get data for Vote event to display in Notifications module.

Parameters
$aEventan array with event description.
Returns
an array with special format.
See also
BxTimelineModule::serviceGetNotificationsVote

Timeline

Integration with Notifications

get_notifications_score_up

bx_srv('bx_timeline', 'get_notifications_score_up', [...]);

Get data for Score Up Vote event to display in Notifications module.

Parameters
$aEventan array with event description.
Returns
an array with special format.
See also
BxTimelineModule::serviceGetNotificationsScoreUp

Timeline

Integration with Notifications

get_notifications_score_down

bx_srv('bx_timeline', 'get_notifications_score_down', [...]);

Get data for Score Down Vote event to display in Notifications module.

Parameters
$aEventan array with event description.
Returns
an array with special format.
See also
BxTimelineModule::serviceGetNotificationsScoreDown

Timeline

Repost

get_repost_element_block

bx_srv('bx_timeline', 'get_repost_element_block', [...]);

Get repost element for content based modules.

Parameters
$iOwnerIdinteger value with owner profile ID.
$sTypestring value with type (module name).
$sActionstring value with action (module action).
$iObjectIdinteger value with object ID to be reposted.
$aParams(optional) an array with additional params.
Returns
HTML string with repost element to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetRepostElementBlock

Timeline

Repost

get_repost_counter

bx_srv('bx_timeline', 'get_repost_counter', [...]);

Get repost counter.

Parameters
$sTypestring value with type (module name).
$sActionstring value with action (module action).
$iObjectIdinteger value with object ID to be reposted.
Returns
HTML string with repost counter to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetRepostCounter

Timeline

Repost

get_repost_js_script

bx_srv('bx_timeline', 'get_repost_js_script', [...]);

Get repost JavaScript code.

Returns
HTML string with JavaScript code to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxTimelineModule::serviceGetRepostJsScript

Timeline

Repost

get_repost_js_click

bx_srv('bx_timeline', 'get_repost_js_click', [...]);

Get repost JavaScript code for OnClick event.

Parameters
$iOwnerIdinteger value with owner profile ID.
$sTypestring value with type (module name).
$sActionstring value with action (module action).
$iObjectIdinteger value with object ID to be reposted.
Returns
HTML string with JavaScript code to display in OnClick events of HTML elements.
See also
BxTimelineModule::serviceGetRepostJsClick

Timeline

Repost

get_repost_with_js_click

bx_srv('bx_timeline', 'get_repost_with_js_click', [...]);

Get 'repost with' JavaScript code for OnClick event.

Parameters
$iReposterIdinteger value with reposter profile ID.
$sTypestring value with type (module name).
$sActionstring value with action (module action).
$iObjectIdinteger value with object ID to be reposted.
Returns
HTML string with JavaScript code to display in OnClick events of HTML elements.
See also
BxTimelineModule::serviceGetRepostWithJsClick

Timeline

Repost

get_repost_to_js_click

bx_srv('bx_timeline', 'get_repost_to_js_click', [...]);

Get 'repost to' JavaScript code for OnClick event.

Parameters
$iReposterIdinteger value with reposter profile ID.
$sTypestring value with type (module name).
$sActionstring value with action (module action).
$iObjectIdinteger value with object ID to be reposted.
Returns
HTML string with JavaScript code to display in OnClick events of HTML elements.
See also
BxTimelineModule::serviceGetRepostToJsClick

Timeline

Repost

Repost

bx_srv('bx_timeline', 'repost', [...]);

Perform repost action.

Parameters
$iAuthorIdinteger value with performer profile ID.
$iOwnerIdinteger value with repost event owner profile ID.
$sTypestring value with type (module name).
$sActionstring value with action (module action).
$iObjectIdinteger value with object ID to be reposted. $bForce boolean value force reposting without ACL check.
Returns
an array with error (code and message) or integer with newly created repost event ID.
See also
BxTimelineModule::serviceRepost

Timeline

Repost

repost_with

bx_srv('bx_timeline', 'repost_with', [...]);

Perform repost action passing additional data.

Parameters
$iAuthorIdinteger value with performer profile ID.
$iOwnerIdinteger value with repost event owner profile ID.
$sTypestring value with type (module name).
$sActionstring value with action (module action).
$iObjectIdinteger value with object ID to be reposted.
$mixedDataarray with some data to attach to repost event or false. $bForce boolean value force reposting without ACL check.
Returns
an array with error (code and message) or integer with newly created repost event ID.
See also
BxTimelineModule::serviceRepostWith

Timeline

Repost

repost_by_id

bx_srv('bx_timeline', 'repost_by_id', [...]);

Perform repost action by Timeline event ID.

Parameters
$iAuthorIdinteger value with performer profile ID.
$iOwnerIdinteger value with repost event owner profile ID.
$iEventIdinteger value with event ID which will be reposted. $bForce boolean value force reposting without ACL check.
Returns
an array with error (code and message) or integer with newly created repost event ID.
See also
BxTimelineModule::serviceRepostById

Timeline

Other

update

bx_srv('bx_timeline', 'update', [...]);

Update timeline event by ID.

Parameters
$iEventIdinteger value with event ID.
$aSetan array with key=>value pairs for fields which should be updated.
Returns
boolean value with the result of operation.
See also
BxTimelineModule::serviceUpdate

Timeline

Other

delete

bx_srv('bx_timeline', 'delete', [...]);

Delete timeline event by ID.

Parameters
$iIdinteger value with event ID.
Returns
boolean value with the result of operation.
See also
BxTimelineModule::serviceDelete

Timeline

Other

get_menu_item_addon_comment

bx_srv('bx_timeline', 'get_menu_item_addon_comment', [...]);

Get addon for Comment menu item. NOTE. The service isn't used for now because comment functionality in card was updated.

Parameters
$sSystemstring value with comments engine system.
$iObjectIdinteger value with object ID.
Returns
HTML string to display in menu item.
See also
BxTimelineModule::serviceGetMenuItemAddonComment

Timeline

Other

get_settings_checker_helper

bx_srv('bx_timeline', 'get_settings_checker_helper', [...]);

Get Checker Helper class name for Forms engine.

Returns
string with Checker Helper class name.
See also
BxTimelineModule::serviceGetSettingsCheckerHelper

Timeline

Other

get_options_videos_preload

bx_srv('bx_timeline', 'get_options_videos_preload', [...]);

Get an array with available options for 'Videos preload in Timeline' setting.

Returns
an array with available options represented as key => value pairs.
See also
BxTimelineModule::serviceGetOptionsVideosPreload

Timeline

Other

get_options_videos_autoplay

bx_srv('bx_timeline', 'get_options_videos_autoplay', [...]);

Get an array with available options for 'Videos autoplay in Timeline' setting.

Returns
an array with available options represented as key => value pairs.
See also
BxTimelineModule::serviceGetOptionsVideosAutoplay

Timeline

Other

get_options_attachments_layout

bx_srv('bx_timeline', 'get_options_attachments_layout', [...]);

Get an array with available options for 'Show attachments as' setting.

Returns
an array with available options represented as key => value pairs.
See also
BxTimelineModule::serviceGetOptionsAttachmentsLayout

Timeline

Other

get_live_update

bx_srv('bx_timeline', 'get_live_update', [...]);

Get an array with actual Live Update info. Only one live update notification for all new events.

Returns
an array with Live Update info.
See also
BxTimelineModule::serviceGetLiveUpdate

Timeline

Other

get_live_updates

bx_srv('bx_timeline', 'get_live_updates', [...]);

Get an array with actual Live Update info. Separate live update notification for each new Event. Note. This method isn't used for now.

See also
BxTimelineModule::serviceGetLiveUpdate method instead.

Note. This way to display live update notifications isn't used for now. See BxTimelineModule::serviceGetLiveUpdate method instead.

Returns
an array with Live Update info.
See also
BxTimelineModule::serviceGetLiveUpdates

Timeline

Other

get_menu_addon_manage_tools

bx_srv('bx_timeline', 'get_menu_addon_manage_tools', [...]);

Get number of 'hidden' events for User End -> Dasboard page -> Manage block.

Returns
integer number of 'hidden' events
See also
BxTimelineModule::serviceGetMenuAddonManageTools

Timeline

Other

get_menu_addon_profile_stats

bx_srv('bx_timeline', 'get_menu_addon_profile_stats', [...]);

Get number of 'muted' events for currently logged in user. User End -> Profile Stats.

Returns
integer number of 'muted' events
See also
BxTimelineModule::serviceGetMenuAddonProfileStats

Videos

Page Blocks

entity_video_block

bx_srv('bx_videos', 'entity_video_block', [...]);

Get page block with video player.

Parameters
$iContentId(optional) video ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
HTML string with block content to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxVideosModule::serviceEntityVideoBlock

Videos

Page Blocks

entity_rating

bx_srv('bx_videos', 'entity_rating', [...]);

Get page block with Stars based video's rating.

Parameters
$iContentId(optional) video ID. If empty value is provided, an attempt to get it from GET/POST arrays will be performed.
Returns
HTML string with block content to display on the site or false if there is no enough input data. All necessary CSS and JS files are automatically added to the HEAD section of the site HTML.
See also
BxVideosModule::serviceEntityRating

Wiki

Macros

contents

bx_srv('bx_wiki', 'contents');
{{~bx_wiki:contents~}}

Wiki contents - list of pages

Parameters
$sAllExceptSpecifiedoptional comma separated list of URIs of pages to filter out
$sOnlySpecifiedoptional comma separated list of URIs of pages to show only
See also
BxWikiModule::serviceContents

Wiki

Macros

missing_translations

bx_srv('bx_wiki', 'missing_translations');
{{~bx_wiki:missing_translations["ru"]~}}

Get list of blocks with missing translations

Parameters
$sLanglanguage to get missing translations for
See also
BxWikiModule::serviceMissingTranslations

Wiki

Macros

outdated_translations

bx_srv('bx_wiki', 'outdated_translations');
{{~bx_wiki:outdated_translations["ru"]~}}

Get list of blocks with outdated translations

Parameters
$sLanglanguage to get outdated translations for
See also
BxWikiModule::serviceOutdatedTranslations

System Services

Chart

get_chart_growth

bx_srv('system', 'get_chart_growth', [], 'TemplChartServices');
{{~system:get_chart_growth:TemplChartServices~}}

Get growth charts.

See also
BxBaseChartServices::serviceProfileMembership

System Services

Chart

get_chart_stats

bx_srv('system', 'get_chart_stats', [], 'TemplChartServices');
{{~system:get_chart_stats:TemplChartServices~}}

Get statistics chart.

See also
BxBaseChartServices::serviceGetChartStats

System Services

Payments

get_cart_items_count

bx_srv('system', 'get_cart_items_count', [], 'TemplPaymentsServices');
{{~system:get_cart_items_count:TemplPaymentsServices~}}

Get number of items in shopping cart for currently logged in profile.

See also
BxBasePaymentsServices::serviceGetChartStats

System Services

Payments

get_orders_count

bx_srv('system', 'get_orders_count', ["new"], 'TemplPaymentsServices');
{{~system:get_orders_count:TemplPaymentsServices["new"]~}}

Get number of order by type for currently logged in profile.

Parameters
$sTypetype, for example: new
See also
BxBasePaymentsServices::serviceGetOrdersCount

System Services

Payments

get_invoices_count

bx_srv('system', 'get_invoices_count', ["unpaid"], 'TemplPaymentsServices');
{{~system:get_invoices_count:TemplPaymentsServices["unpaid"]~}}

Get number of invoices by type for currently logged in profile.

Parameters
$sTypetype, for example: unpaid
See also
BxBasePaymentsServices::serviceGetInvoicesCount

System Services

Account

create_account_form

bx_srv('system', 'create_account_form', [], 'TemplServiceAccount');
{{~system:create_account_form:TemplServiceAccount[{"no_login_text":true, "no_auth_buttons":true}]~}}

Join form.

Parameters
$aParamsarray of additional params, such as:
  • no_login_text
  • no_auth_buttons
See also
BxBaseServiceAccount::serviceGetCreatePostForm

System Services

Account

forgot_password

bx_srv('system', 'forgot_password', [], 'TemplServiceAccount');
{{~system:forgot_password:TemplServiceAccount~}}

Display forgot password form, if reset password key is provided then reset password

See also
BxBaseServiceAccount::serviceForgotPassword

System Services

Account

switch_profile

bx_srv('system', 'switch_profile', [123], 'TemplServiceAccount');
{{~system:switch_profile:TemplServiceAccount:[123]~}}

Switch current user profile. User can switch between profiles if multiple profiles are created. Also it's possible to switch to Organization profile if user is admin of Organization, or other module which can actAsProfile. Admin can switch to any prifile by default

Parameters
$iSwitchToProfileIdprofile ID to switch to
Returns
true on success or error message otherwise, so make sue to make strict (===) comparision
See also
BxBaseServiceAccount::serviceSwitchProfile

System Services

Categories

categories_list

bx_srv('system', 'categories_list', ["bx_posts_cats", ["show_empty_categories" => true]], 'TemplServiceCategory');
{{~system:categories_list:TemplServiceCategory["bx_posts_cats", {"show_empty_categories":true}]~}}

Get categories list.

Parameters
$sObjectcategories object name
$aParamsadditional params:
  • show_empty
  • show_empty_categories
See also
BxBaseServiceCategory::serviceCategoriesList

System Services

Login

test

bx_srv('system', 'test', [3], 'TemplServiceLogin');
{{~system:test:TemplServiceLogin[3]~}}

Test method which returns provided number multiplied by 2

Parameters
$nnumber
See also
BxBaseServiceLogin::serviceTest

System Services

Login

member_auth_code

bx_srv('system', 'member_auth_code', [], 'TemplServiceLogin');
{{~system:member_auth_code:TemplServiceLogin~}}

Display external login buttons such as Facebook, Twitter, etc

Parameters
$aAuthTypesoptional list of external login buttons
See also
BxBaseServiceLogin::serviceMemberAuthCode

System Services

Login

login_form

bx_srv('system', 'login_form', ["no_auth_buttons"], 'TemplServiceLogin');
{{~system:login_form:TemplServiceLogin["no_auth_buttons"]~}}

Display login form

Parameters
$sParamsoptional string with additional params:
  • no_join_text
  • no_auth_buttons
  • ajax_form
$sForceRelocateoptional URL to redirect to after login
See also
BxBaseServiceLogin::serviceLoginForm

System Services

Metatags

keywords_cloud

bx_srv('system', 'keywords_cloud', ["bx_posts", "bx_posts"], 'TemplServiceMetatags');
{{~system:keywords_cloud:TemplServiceMetatags["bx_posts", "bx_posts"]~}}

Get keywords cloud.

Parameters
$sObjectmetatags object to get keywords cloud for
$mixedSectionsearch section to refer when keyword is clicked, set the same as $sObject to show content withing the module only, it can be one value or array of values, leave empty to show all possible content upon keyword click
$aParamsadditional params:
  • max_count: number of tags in keywords cloud, by default BX_METATAGS_KEYWORDS_IN_CLOUD
  • show_empty: show empty message or not when no data available
Returns
tags cloud HTML string
See also
BxBaseServiceMetatags::serviceKeywordsCloud

System Services

Profiles

profile_membership

bx_srv('system', 'profile_membership', [2], 'TemplServiceProfiles');
{{~system:profile_membership:TemplServiceProfiles[2]~}}

Get membership level for specified profile.

Parameters
$iProfileIdprofile ID
See also
BxBaseServiceProfiles::serviceProfileMembership

System Services

Profiles

profile_notifications

bx_srv('system', 'profile_notifications', [], 'TemplServiceProfiles');
{{~system:profile_notifications:TemplServiceProfiles~}}

Get number of unread notifications for logged in profile

See also
BxBaseServiceProfiles::serviceProfileNotifications

System Services

Profiles

get_count_online_profiles

bx_srv('system', 'get_count_online_profiles', [], 'TemplServiceProfiles');
{{~system:get_count_online_profiles:TemplServiceProfiles~}}

Get number of online profiles

See also
BxBaseServiceProfiles::serviceGetCountOnlineProfiles

System Services

General

module_check_for_update

bx_srv('system', 'module_check_for_update', ["bx_posts"]);
bx_srv('system', 'module_check_for_update', ["bx_posts"], 'TemplServices');
{{~system:module_check_for_update:TemplServices["bx_posts"]~}}

Checks whether an update is available for requested module or not.

Parameters
$mixedModule- module ID/name to check the updates for.
Returns
array with information about the update, false if nothing was found
See also
BxBaseServices::serviceModuleCheckForUpdate

System Services

General

module_update

bx_srv('system', 'module_update', ["bx_posts"]);
bx_srv('system', 'module_update', ["bx_posts"], 'TemplServices');
{{~system:module_update:TemplServices["bx_posts"]~}}

Download and install an update for requested module. The operation may be performed immediately or by Transient Cron task. The second way is more common.

Parameters
$mixedModule- module ID/name to check the updates for.
Returns
integer value determining the result of the operation. It can be one of the following values: BX_DOL_STUDIO_IU_RC_SUCCESS, BX_DOL_STUDIO_IU_RC_FAILED or BX_DOL_STUDIO_IU_RC_SCHEDULED.
See also
BxBaseServices::serviceModuleUpdate

System Services

General

module_delete

bx_srv('system', 'module_delete', ["bx_posts"]);
bx_srv('system', 'module_delete', ["bx_posts", true], 'TemplServices');
{{~system:module_delete:TemplServices["bx_posts"]~}}

Delete the requested module. By default only uninstalled module can be deleted. The operation may be performed immediately or by Transient Cron task. The second way is more common.

Parameters
$sModule- module name to delete.
$bForceUninstall- if 'true' is passed the module will be uninstalled before deletion.
Returns
integer value determining the result of the operation. It can be one of the following values: BX_DOL_STUDIO_IU_RC_SUCCESS, BX_DOL_STUDIO_IU_RC_FAILED or BX_DOL_STUDIO_IU_RC_SCHEDULED.
See also
BxBaseServices::serviceModuleDelete

System Services

General

module_install

bx_srv('system', 'module_install', ["bx_posts"]);
bx_srv('system', 'module_install', ["bx_posts", true], 'TemplServices');
{{~system:module_install:TemplServices["bx_posts"]~}}

Install the requested module. By default the module will be installed only.

Parameters
$sModule- module name to install.
$bForceEnable- if 'true' is passed the module will be automatically enabled after installation.
Returns
boolean value determining the result of the operation.
See also
BxBaseServices::serviceModuleInstall

System Services

General

module_uninstall

bx_srv('system', 'module_uninstall', ["bx_posts"]);
bx_srv('system', 'module_uninstall', ["bx_posts", true], 'TemplServices');
{{~system:module_uninstall:TemplServices["bx_posts"]~}}

Uninstall the requested module. By default only disabled module can be uninstalled.

Parameters
$mixedModule- module ID/name to uninstall.
$bForceDisable- if 'true' is passed the module will be automatically disabled before uninstallation.
Returns
boolean value determining the result of the operation.
See also
BxBaseServices::serviceModuleUninstall

System Services

General

module_enable

bx_srv('system', 'module_enable', ["bx_posts"]);
bx_srv('system', 'module_enable', ["bx_posts"], 'TemplServices');
{{~system:module_enable:TemplServices["bx_posts"]~}}

Enable the requested module.

Parameters
$mixedModule- module ID/name to enable.
Returns
boolean value determining the result of the operation.
See also
BxBaseServices::serviceModuleEnable

System Services

General

module_disable

bx_srv('system', 'module_disable', ["bx_posts"]);
bx_srv('system', 'module_disable', ["bx_posts"], 'TemplServices');
{{~system:module_disable:TemplServices["bx_posts"]~}}

Disable the requested module.

Parameters
$mixedModule- module ID/name to disable.
Returns
boolean value determining the result of the operation.
See also
BxBaseServices::serviceModuleDisable

System Services

General

is_module_installed

bx_srv('system', 'is_module_installed', ["bx_posts"]);
bx_srv('system', 'is_module_installed', ["bx_posts"], 'TemplServices');
{{~system:is_module_installed:TemplServices["bx_posts"]~}}

Checks whether the requested module is installed or not.

Parameters
$mixedModule- module ID/name to check.
Returns
boolean value determining the result of the operation.
See also
BxBaseServices::serviceIsModuleInstalled

System Services

General

is_module_enabled

bx_srv('system', 'is_module_enabled', ["bx_posts"]);
bx_srv('system', 'is_module_enabled', ["bx_posts"], 'TemplServices');
{{~system:is_module_enabled:TemplServices["bx_posts"]~}}

Checks whether the requested module is enabled or not.

Parameters
$mixedModule- module ID/name to check.
Returns
boolean value determining the result of the operation.
See also
BxBaseServices::serviceIsModuleEnabled

System Services

General

get_create_post_form

bx_srv('system', 'get_create_post_form', [false, "bx_posts"], 'TemplServices');
{{~system:get_create_post_form:TemplServices[false,"bx_posts"]~}}

Get United Create Post form.

Parameters
$mixedContextId- context which the post will be created in:
  • false = 'Public' post form;
  • 0 = 'Profile' post form, which allows to post in your own profile and connections;
  • n = 'Context' post form, which allows to post in context (3d party profile, group, event, etc).
$sDefault- tab selected by default.
$aCustom- an array with custom paramaters.
Returns
string with form content
See also
BxBaseServices::serviceGetCreatePostForm

System Services

General

get_site_submenu

bx_srv('system', 'get_site_submenu', [], 'TemplServices');
{{~system:get_site_submenu:TemplServices[]~}}

Get Site Submenu code.

See also
BxBaseServices::serviceGetSiteSubmenu

System Services

General

get_products_names

bx_srv('system', 'get_products_names', [], 'TemplServices');
@code http://example.com/m/oauth2/com/get_products_names?module=system&class=BaseServices
http://hihi.una.io/modules/?r=oauth2/com/get_products_names&module=system&class=BaseServices

Get an array of products names from all modules with payments functionality.

Parameters
$iVendorIdfilter products by vendor ID.
$iLimitlimit number of records from one module.
Returns
array of products where key id product name and value is module name
See also
BxBaseServices::serviceGetProductsNames

System Services

General

keyword_search

bx_srv('system', 'keyword_search', ["bx_posts", ["keyword" => "test"}], 'TemplServices');
{{~system:keyword_search:TemplServices["bx_posts", {"keyword":"test"}]~}}
{{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country", "keyword": "AU"}, "unit.html"]~}}
{{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country_state", "state":"NSW", "keyword": "AU"}, "unit.html"]~}}
{{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country_city", "state":"NSW", "city":"Manly", "keyword": "AU"}, "unit.html"]~}}
{{~system:keyword_search:TemplServices["bx_posts", {"meta_type": "mention", "keyword": 2}, "unit_gallery.html"]~}}
{{~system:keyword_search:TemplServices["bx_posts", {"cat": "bx_posts_cats", "keyword": 3}, "unit_gallery.html"]~}}

Search by keyword

Parameters
$sSection- search object to search in, usually module name, for example: bx_posts
$aCondition- condition for search, supported conditions:
  • search by keyword: ["keyword" => "test"]
  • search by country: ["meta_type" => "location_country", "keyword" => "AU"]
  • search by country and state: ["meta_type": "location_country_state", "state":"NSW", "keyword": "AU"]
  • search by country, state and city: ["meta_type": "location_country_city", "state":"NSW", "city":"Manly", "keyword": "AU"]
  • search for mentions: ["meta_type" => "mention", "keyword" => 2]
  • search in category: ["cat": "bx_posts_cats", "keyword": 3]
$sTemplate- template for displaying search results, for example: unit.html
$iStart- paginate, display records starting from this number
$iPerPage- paginate, display this number of records per page
$bLiveSearch- search results like in live search
See also
BxBaseServices::serviceKeywordSearch

System Services

General

keyword_search

bx_srv('system', 'search_keyword_form', 'TemplServices');

Block with Search by Keywords Form

See also
BxBaseServices::serviceSearchKeywordForm

System Services

General

keyword_search

bx_srv('system', 'search_keyword_result', 'TemplServices');

Block with Search by Keywords Results

See also
BxBaseServices::serviceSearchKeywordResult

System Services

General

cmts

bx_srv('system', 'cmts', ["sys_blocks", 1], 'TemplServices');
{{~system:cmts:TemplServices["sys_blocks", 1]~}}

Comments block

Parameters
$sObject- comments object name
$sId- content id assiciated tith the comments
See also
BxBaseServices::serviceCmts

System Services

Wiki

wiki_page

bx_srv('system', 'wiki_page', ["index"], 'TemplServiceWiki');
{{~system:wiki_page:TemplServiceWiki["index"]~}}

Display WIKI page.

Parameters
$sUricategories object name
See also
BxBaseServiceWiki::serviceWikiPage

System Services

Wiki

wiki_action

bx_srv('system', 'wiki_action', [...], 'TemplServiceWiki');

Perform WIKI action.

Parameters
$sWikiObjectUriwiki object URI
See also
BxBaseServiceWiki::serviceWikiAction

System Services

Wiki

wiki_controls

Get wiki block controls panel

See also
BxBaseServiceWiki::serviceWikiControls

System Services

Wiki

wiki_add_block

Get "add wiki block" panel

See also
BxBaseServiceWiki::serviceWikiAddBlock

System Services

Wiki

get_design_boxes

Get "design boxes" array

See also
BxBaseServiceWiki::serviceGetDesignBoxes

System Services

Wiki

pages_list

Get list of pages in current module

See also
BxBaseServiceWiki::servicePagesList

System Services

Wiki

page_contents

Get table of contents for current page, generated automatically from paragraphs headers

See also
BxBaseServiceWiki::servicePageContents