BxBaseServicePages Class Reference

Inheritance diagram for BxBaseServicePages:

Public Member Functions
	serviceGetPageByRequest ($sRequest, $sBlocks='', $sParams='')
	serviceGetPageContentByRequest ($sRequest, $sBlocks='', $sParams='')
	serviceGetPageByUri ($sURI)
	serviceGetPageBlockData ($iBlockId, $iContentId=0, $sContentModule='')
	serviceSetPageBlockData ($iBlockId, $iContentId=0, $sContentModule='')
	serviceGetUrlInfo ($sUrl)

Protected Member Functions
	_getByRequest ($sType, $sRequest, $sBlocks='', $sParams='')

Detailed Description

System service for pages functionality.

Constructor & Destructor Documentation

__construct()

BxBaseServicePages::__construct

(

)

Reimplemented from BxDol.

Member Function Documentation

serviceGetPageByRequest()

BxBaseServicePages::serviceGetPageByRequest	(		$sRequest,
			$sBlocks = '',
			$sParams = '' )

get_page_by_request

Hooks:

'system', 'get_page_api' - hook to override page peremeters, is used in API calls

• $unit_name - equals system
• $action - equals get_page_api
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • page - [object] an instance of page class,

    See also

    BxDolPage

  • blocks - [array] array with page blocks
  • data - [array] by ref, page peremeters array as key&value pairs, can be overridden in hook processing

HOOKS

'system', 'get_page_api' - hook to override page peremeters, is used in API calls

serviceGetPageByUri()

BxBaseServicePages::serviceGetPageByUri

(

$sURI

)

get_page_by_uri

serviceGetPageContentByRequest()

BxBaseServicePages::serviceGetPageContentByRequest	(		$sRequest,
			$sBlocks = '',
			$sParams = '' )

Hooks:

'system', 'get_page_api' - hook to override page peremeters, is used in API calls

• $unit_name - equals system
• $action - equals get_page_content_api
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • page - [object] an instance of page class,

    See also

    BxDolPage

  • blocks - [array] array with page blocks
  • data - [array] by ref, page peremeters array as key&value pairs, can be overridden in hook processing

HOOKS

hook-system-get_page_content_api

---

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

• template/scripts/BxBaseServicePages.php