Класс Landing

Граф наследования:Landing:

Открытые члены
	setMetaData (array $metaData)
	getPreview (?int $id=null, bool $skipCloud=false, ?string $publicUrl=null)
	getPublicUrl ($id=false, $absolute=true, $createPubPath=false, &$fullUrl=[])
	view (array $params=array())
	getAreas ()
	getTplId ()
	exist ()
	isActive ()
	getId ()
	getXmlId ()
	getTitle ()
	getCode ()
	getMeta ()
	canEdit ()
	canPublication ()
	canDelete ()
	getFolderId ()
	getSiteId ()
	getSiteTitle ()
	getDomainId ()
	getSpecialType ()
	getSmnSiteId ()
	getBlocks ()
	getBlockById ($id)
	addBlockToCollection (\Bitrix\Landing\Block $block)
	getError ()
	getErrorMain ()
	touch ()
	updateVersion ()
	publication ($blockId=null, ?Metrika\FieldsDto $metrikaFields=null)
	fakePublication ()
	unpublic ()
	addBlock (string $code, array $data=array(), bool $saveInLastUsed=false)
	deleteBlock ($id)
	markDeletedBlock ($id, $mark)
	resortBlocks ()
	upBlock (int $id)
	downBlock (int $id)
	showBlock ($id)
	hideBlock ($id)
	favoriteBlock (int $id, array $meta=[])
	unFavoriteBlock (int $blockId)
	copyBlock (int $id, int $afterId)
	copyAllBlocks ($lid, $replaceLinks=true, array &$references=[])
	clearFolderIndex ()
	move (?int $toSiteId=null, ?int $toFolderId=null)
	copy (?int $toSiteId=null, ?int $toFolderId=null, bool $withoutBlocks=false, bool $skipSystem=false)
	moveBlock (int $id, int $afterId)

Открытые статические члены
static	ping ($id, $deleted=false)
static	setEditMode ($mode=true)
static	getEditMode ()
static	setPreviewMode ($mode=true)
static	getPreviewMode ()
static	checkDeleted ()
static	disableCheckDeleted ()
static	enableCheckDeleted ()
static	disableUpdate ()
static	enableUpdate ()
static	isCheckUniqueAddress ()
static	disableCheckUniqueAddress ()
static	enableCheckUniqueAddress ()
static	createInstance ($id, array $params=array())
static	markDelete (int $id)
static	markUnDelete ($id)
static	delete ($id, bool $forceDeleted=false)
static	getHooks ($id)
static	getAdditionalFields ($id)
static	getAdditionalFieldsAsArray (int $landingId, bool $skipEmpty=true)
static	saveAdditionalFields ($id, array $data)
static	setVariables (array $vars)
static	getVariables ()
static	setDynamicParams ($filterId, $elementId)
static	getDynamicFilter ()
static	getDynamicElementId ()
static	isDynamicDetailPage ()
static	resolveIdByPublicUrl (string $landingUrl, int $siteId)
static	getSiteType ()
static	update ($id, $fields=array())
Открытые статические члены унаследованные от BaseTable
static	callback ($code, $callback)

Статические открытые данные
static	$internalClass = 'LandingTable'
Статические открытые данные унаследованные от BaseTable
static	$internalClass = null

Защищенные члены
	__construct ($id, $params=array())
	applyTemplate ($content=null)
	parseLocalUrl (string $content)
	execHooks ()
	prepareHook ($hook)
	parametrizeMetrikaByBlock (Metrika\Metrika $metrika, Block $block)
	transferBlock ($id, $lid)
	sortBlock (int $id, string $action)
	activateBlock ($id, $action)
	changeParentOfBlock (int $block, array $params)

Защищенные данные
const	META_KEYS
const	META_KEYS_MODIFIABLE
	$mainInstance = true
	$metaData = array()
	$blocks = array()
	$id = 0
	$title = ''
	$code = ''
	$xmlId = ''
	$siteRow = []
	$siteId = 0
	$siteTitle = ''
	$domainId = 0
	$folderId = 0
int	$tplId = 0
	$tplType = 'landing'
	$active = false
Error	$error
	$rights = []
	$checkPermissions = true
	$version = 1
	$disableLinkPreview = false

Статические защищенные данные
static	$enabledUpdate = true
static	$checkUniqueAddress = true
static	$checkDelete = true
static	$editMode = false
static	$previewMode = false
static	$variables = array()
static	$dynamicFilterId = 0
static	$dynamicElementId = 0
static string	$siteType = ''

Подробное описание

См. определение в файле landing.php строка 21

Конструктор(ы)

__construct()

__construct ( $id, $params = array() )

protected

Constructor.

Аргументы

int	$id	Landing id.
array	$params	Some params.

См. определение в файле landing.php строка 225

Методы

activateBlock()

activateBlock ( $id, $action )

protected

Show/hide the block on the landing.

Аргументы

int	$id	Block id.
string	$action	Code: up or down.

Возвращает

boolean

См. определение в файле landing.php строка 2707

addBlock()

addBlock	(	string	$code,
		array	$data = array(),
		bool	$saveInLastUsed = false )

Add new block to the landing.

Аргументы

string	$code	Code of block.
array	$data	Data array of block.
bool	$saveInLastUsed	Save this block as last used for current user.

Возвращает

int|false Id of new block or false on failure.

См. определение в файле landing.php строка 2282

addBlockToCollection()

addBlockToCollection

(

\Bitrix\Landing\Block

$block

)

Add new Block to the current landing.

Аргументы

\Bitrix\Landing\Block

$block

New block instance.

Возвращает

void

См. определение в файле landing.php строка 2022

applyTemplate()

applyTemplate ( $content = null )

protected

Apply template for this landing.

Аргументы

string

$content

Landing content.

Возвращает

string

См. определение в файле landing.php строка 1358

canDelete()

canDelete

(

)

Can current user delete this landing.

Возвращает

bool

См. определение в файле landing.php строка 1900

canEdit()

canEdit

(

)

Can current user edit this landing.

Возвращает

bool

См. определение в файле landing.php строка 1872

canPublication()

canPublication

(

)

Can current user publication this landing.

Возвращает

bool

См. определение в файле landing.php строка 1886

changeParentOfBlock()

changeParentOfBlock ( int $block, array $params )

protected

Copy/move other block to this landing.

Аргументы

int	$block	Block id.
array	$params	Params array.

Возвращает

int|null New Block id.

См. определение в файле landing.php строка 2837

checkDeleted()

checkDeleted ( )

static

Check delete pages or not.

Возвращает

bool

См. определение в файле landing.php строка 464

clearFolderIndex()

clearFolderIndex

(

)

If current landing is index page of folder, clear folder's index.

Возвращает

void

См. определение в файле landing.php строка 3049

copy()

copy	(	?int	$toSiteId = null,
		?int	$toFolderId = null,
		bool	$withoutBlocks = false,
		bool	$skipSystem = false )

Copy current landing.

Аргументы

int | null	$toSiteId	Site id (if you want copy in another site).
int | null	$toFolderId	Folder id (if you want copy in some folder).
bool	$withoutBlocks	Copy only pages, without blocks.
bool	$skipSystem	If true, don't copy system flag.

Возвращает

int|null New landing id.

См. определение в файле landing.php строка 3211

copyAllBlocks()

copyAllBlocks	(		$lid,
			$replaceLinks = true,
		array &	$references = [] )

Copy all blocks from another landing to this.

Аргументы

int	$lid	Landing id.
boolean	$replaceLinks	Replace links to the old blocks.
array	&$references	Array that will contain references between old and new IDs.

Возвращает

void

См. определение в файле landing.php строка 2985

copyBlock()

copyBlock	(	int	$id,
		int	$afterId )

Copy other block to this landing.

Аргументы

int	$id	Block id (from another landing).
int	$afterId	Put after this block id (in this landing).

Возвращает

int|null New Block id.

См. определение в файле landing.php строка 2961

createInstance()

createInstance ( $id, array $params = array() )

static

Create current instance.

Аргументы

int	$id	Landing id.
array	$params	Additional params.

Возвращает

Landing

См. определение в файле landing.php строка 538

delete()

delete ( $id, bool $forceDeleted = false )

static

Delete landing by id and its blocks.

Аргументы

int	$id	Landing id.
bool	$forceDeleted	Force delete throw an errors.

Возвращает

\Bitrix\Main\Result

См. определение в файле landing.php строка 646

deleteBlock()

deleteBlock

(

$id

)

Delete one block from current landing.

Аргументы

int

$id

Block id.

Возвращает

boolean

См. определение в файле landing.php строка 2354

disableCheckDeleted()

disableCheckDeleted ( )

static

Disable check delete.

Возвращает

void

См. определение в файле landing.php строка 473

disableCheckUniqueAddress()

disableCheckUniqueAddress ( )

static

Disable checking unique address.

Возвращает

void

См. определение в файле landing.php строка 518

disableUpdate()

disableUpdate ( )

static

Disable update.

Возвращает

void

См. определение в файле landing.php строка 491

downBlock()

downBlock

(

int

$id

)

Sort down the block on the landing.

Аргументы

int

$id

Block id.

Возвращает

boolean

См. определение в файле landing.php строка 2681

enableCheckDeleted()

enableCheckDeleted ( )

static

Enable check delete.

Возвращает

void

См. определение в файле landing.php строка 482

enableCheckUniqueAddress()

enableCheckUniqueAddress ( )

static

Enable checking unique address

Возвращает

void

См. определение в файле landing.php строка 527

enableUpdate()

enableUpdate ( )

static

Enable update.

Возвращает

void

См. определение в файле landing.php строка 500

execHooks()

execHooks ( )

protected

Exec hooks for landing (site and landing).

Возвращает

void

См. определение в файле landing.php строка 1762

exist()

exist

(

)

Exist or not landing in current instance.

Возвращает

boolean

См. определение в файле landing.php строка 1809

fakePublication()

fakePublication

(

)

Fake current landing (for testing potential publication and resolves the errors).

Возвращает

boolean

См. определение в файле landing.php строка 2226

favoriteBlock()

favoriteBlock	(	int	$id,
		array	$meta = [] )

Saves the block in favorites.

Аргументы

int	$id	Block id.
array	$meta	Meta info.

Возвращает

int|null New block id.

См. определение в файле landing.php строка 2760

getAdditionalFields()

getAdditionalFields ( $id )

static

Get additional fields of Landing.

Аргументы

int

$id

Landing id.

Возвращает

array Array of Field.

См. определение в файле landing.php строка 737

getAdditionalFieldsAsArray()

getAdditionalFieldsAsArray ( int $landingId, bool $skipEmpty = true )

static

Returns additional fields of Landing as array.

Аргументы

int	$landingId	Landing id.
bool	$skipEmpty	Skip emty values.

Возвращает

array Array of Field.

См. определение в файле landing.php строка 756

getAreas()

getAreas

(

)

Get included areas of this page.

Возвращает

array

См. определение в файле landing.php строка 1341

getBlockById()

getBlockById

(

$id

)

Get the block by id of current landing.

Аргументы

int

$id

Block id.

Возвращает

Block

См. определение в файле landing.php строка 2007

getBlocks()

getBlocks

(

)

Get all blocks of current landing.

Возвращает

Block[]

См. определение в файле landing.php строка 1997

getCode()

getCode

(

)

Returns code of current landing.

Возвращает

string

См. определение в файле landing.php строка 1854

getDomainId()

getDomainId

(

)

Gets domain id of landing site.

Возвращает

int

См. определение в файле landing.php строка 1941

getDynamicElementId()

getDynamicElementId ( )

static

Get dynamic element id.

Возвращает

int

См. определение в файле landing.php строка 851

getDynamicFilter()

getDynamicFilter ( )

static

Get dynamic filter.

Возвращает

array

См. определение в файле landing.php строка 834

getEditMode()

getEditMode ( )

static

Get state of edit mode.

Возвращает

boolean

См. определение в файле landing.php строка 436

getError()

getError

(

)

Get error collection

Возвращает

\Bitrix\Landing\Error

См. определение в файле landing.php строка 2034

getErrorMain()

getErrorMain

(

)

Returns Error instance as Main\Error instance.

Возвращает

\Bitrix\Main\Error|null

См. определение в файле landing.php строка 2043

getFolderId()

getFolderId

(

)

Gets folder id of current landing.

Возвращает

int

См. определение в файле landing.php строка 1914

getHooks()

getHooks ( $id )

static

Get hooks of Landing.

Аргументы

int

$id

Landing id.

Возвращает

array Array of Hook.

См. определение в файле landing.php строка 722

getId()

getId

(

)

Get id of current landing.

Возвращает

int

См. определение в файле landing.php строка 1827

getMeta()

getMeta

(

)

Get metadata of current landing.

Возвращает

array

См. определение в файле landing.php строка 1863

getPreview()

getPreview	(	?int	$id = null,
		bool	$skipCloud = false,
		?string	$publicUrl = null )

Get preview picture of the landing.

Аргументы

int | null	$id	Landing id (if null, gets for $this->id).
bool	$skipCloud	Skip getting picture from cloud.
string | null	$publicUrl	Full public url of site (you may set this param for optimisation).

Возвращает

string|null

См. определение в файле landing.php строка 872

getPreviewMode()

getPreviewMode ( )

static

Get state of preview mode.

Возвращает

boolean

См. определение в файле landing.php строка 455

getPublicUrl()

getPublicUrl	(		$id = false,
			$absolute = true,
			$createPubPath = false,
		&	$fullUrl = [] )

Get full pubic URL for this landing.

Аргументы

int | array	$id	Landing id (id array), optional.
boolean	$absolute	Full url.
bool	$createPubPath	Create pub path (checking and create).
array	&$fullUrl	Returns full url of landings.

Возвращает

string|array

См. определение в файле landing.php строка 922

getSiteId()

getSiteId

(

)

Get site id of current landing.

Возвращает

int

См. определение в файле landing.php строка 1923

getSiteTitle()

getSiteTitle

(

)

Get site title of current landing.

Возвращает

string

См. определение в файле landing.php строка 1932

getSiteType()

getSiteType ( )

static

Get site type of current landing.

Возвращает

string

См. определение в файле landing.php строка 1950

getSmnSiteId()

getSmnSiteId

(

)

Get site id of main, if exist.

Возвращает

string|null

См. определение в файле landing.php строка 1972

getSpecialType()

getSpecialType

(

)

См. определение в файле landing.php строка 1955

getTitle()

getTitle

(

)

Get title of current landing.

Возвращает

int

См. определение в файле landing.php строка 1845

getTplId()

getTplId

(

)

Get current template ID

Возвращает

int

См. определение в файле landing.php строка 1445

getVariables()

getVariables ( )

static

Get external variables of Landing.

Возвращает

array

См. определение в файле landing.php строка 813

getXmlId()

getXmlId

(

)

Get xml id of current landing.

Возвращает

int

См. определение в файле landing.php строка 1836

hideBlock()

hideBlock

(

$id

)

Dectivate the block on the landing.

Аргументы

int

$id

Block id.

Возвращает

boolean

См. определение в файле landing.php строка 2749

isActive()

isActive

(

)

Active or not the landing.

Возвращает

boolean

См. определение в файле landing.php строка 1818

isCheckUniqueAddress()

isCheckUniqueAddress ( )

static

Checking or not unique address.

Возвращает

bool

См. определение в файле landing.php строка 509

isDynamicDetailPage()

isDynamicDetailPage ( )

static

Return true, if current page is dynamic detail page.

Возвращает

bool

См. определение в файле landing.php строка 860

markDelete()

markDelete ( int $id )

static

Mark landing as deleted.

Аргументы

int

$id

Landing id.

Возвращает

\Bitrix\Main\Result

См. определение в файле landing.php строка 548

markDeletedBlock()

markDeletedBlock	(		$id,
			$mark )

Mark delete or not the block.

Аргументы

int	$id	Block id.
boolean	$mark	Mark.

Возвращает

boolean

См. определение в файле landing.php строка 2388

markUnDelete()

markUnDelete ( $id )

static

Mark entity as restored.

Аргументы

int

$id

Entity id.

Возвращает

\Bitrix\Main\Result

См. определение в файле landing.php строка 609

move()

move	(	?int	$toSiteId = null,
		?int	$toFolderId = null )

Move current page to site/folder.

Аргументы

int | null	$toSiteId	Destination site id (if you want copy in another site).
int | null	$toFolderId	Destination folder id.

Возвращает

bool

См. определение в файле landing.php строка 3148

moveBlock()

moveBlock	(	int	$id,
		int	$afterId )

Move other block to this landing.

Аргументы

int	$id	Block id (from another landing).
int	$afterId	Put after this block id (in this landing).

Возвращает

int|null New Block id.

См. определение в файле landing.php строка 3320

parametrizeMetrikaByBlock()

parametrizeMetrikaByBlock ( Metrika\Metrika $metrika, Block $block )

protected

См. определение в файле landing.php строка 2498

parseLocalUrl()

parseLocalUrl ( string $content )

protected

Parse between-landings url in landing content.

Аргументы

string

$content

Landing content.

Возвращает

string

См. определение в файле landing.php строка 1455

ping()

ping ( $id, $deleted = false )

static

Return true if landing exists and available.

Аргументы

int	$id	Landing id.
bool	$deleted	And from recycle bin.

Возвращает

bool

См. определение в файле landing.php строка 390

prepareHook()

prepareHook ( $hook )

protected

См. определение в файле landing.php строка 1795

publication()

publication	(		$blockId = null,
		?Metrika\FieldsDto	$metrikaFields = null )

Publication current landing.

Аргументы

null	$blockId	Publication only this block(s).
Metrika\FieldsDto | null	$metrikaFields	- params for analytic. If not set anything - analytic not sent

Возвращает

boolean

См. определение в файле landing.php строка 2178

resolveIdByPublicUrl()

resolveIdByPublicUrl ( string $landingUrl, int $siteId )

static

Returns landing id resolves by landing public url.

Аргументы

string	$landingUrl	Landing public url.
int	$siteId	Landing's site id.

Возвращает

int|null

См. определение в файле landing.php строка 1107

resortBlocks()

resortBlocks

(

)

Resort current blocks.

Возвращает

void

См. определение в файле landing.php строка 2571

saveAdditionalFields()

saveAdditionalFields ( $id, array $data )

static

Save additional fields for Landing.

Аргументы

int	$id	Landing id.
array	$data	Data array.

Возвращает

void

См. определение в файле landing.php строка 790

setDynamicParams()

setDynamicParams ( $filterId, $elementId )

static

Set dynamic params (filter id and dynamic element id).

Аргументы

int	$filterId	Id of filter.
int	$elementId	Id of dynamic element id.

Возвращает

void

См. определение в файле landing.php строка 824

setEditMode()

setEditMode ( $mode = true )

static

Set work mode to edit.

Аргументы

boolean

$mode

Edit mode.

Возвращает

void

См. определение в файле landing.php строка 427

setMetaData()

setMetaData

(

array

$metaData

)

Can refresh value of modifiable meta data

Аргументы

array

$metaData

Возвращает

void

См. определение в файле landing.php строка 373

setPreviewMode()

setPreviewMode ( $mode = true )

static

Set work mode to preview.

Аргументы

boolean

$mode

Preview mode.

Возвращает

void

См. определение в файле landing.php строка 446

setVariables()

setVariables ( array $vars )

static

Set external variables of Landing.

Аргументы

array

$vars

Additional vars.

Возвращает

void

См. определение в файле landing.php строка 801

showBlock()

showBlock

(

$id

)

Activate the block on the landing.

Аргументы

int

$id

Block id.

Возвращает

boolean

См. определение в файле landing.php строка 2739

sortBlock()

sortBlock ( int $id, string $action )

protected

Sort the block on the landing.

Аргументы

int	$id	Block id.
string	$action	Code: up or down.

Возвращает

boolean

См. определение в файле landing.php строка 2596

touch()

touch

(

)

Change modified user and date for current landing.

Возвращает

void

См. определение в файле landing.php строка 2062

transferBlock()

transferBlock ( $id, $lid )

protected

Transfer one block to another landing.

Аргументы

int	$id	Block id.
int	$lid	Landing id.

Возвращает

boolean

См. определение в файле landing.php строка 2542

unFavoriteBlock()

unFavoriteBlock

(

int

$blockId

)

Removes the block from favorites.

Аргументы

int

$blockId

Block id.

Возвращает

bool

См. определение в файле landing.php строка 2793

unpublic()

unpublic

(

)

Cancel publication of landing.

Возвращает

boolean

См. определение в файле landing.php строка 2240

upBlock()

upBlock

(

int

$id

)

Sort up the block on the landing.

Аргументы

int

$id

Block id.

Возвращает

boolean

См. определение в файле landing.php строка 2656

update()

update ( $id, $fields = array() )

static

Update the landing.

Аргументы

int	$id	Landing id.
array	$fields	Fields.

Возвращает

\Bitrix\Main\Result

См. определение в файле landing.php строка 3343

updateVersion()

updateVersion

(

)

If current version is not actual, making update.

Возвращает

void

См. определение в файле landing.php строка 2083

view()

view

(

array

$params = array()

)

View landing in public or edit mode.

Аргументы

array

$params

Some additional params.

Возвращает

void

См. определение в файле landing.php строка 1137

Поля

$active

$active = false

protected

См. определение в файле landing.php строка 188

$blocks

$blocks = array()

protected

См. определение в файле landing.php строка 116

$checkDelete

$checkDelete = true

staticprotected

См. определение в файле landing.php строка 62

$checkPermissions

$checkPermissions = true

protected

См. определение в файле landing.php строка 206

$checkUniqueAddress

$checkUniqueAddress = true

staticprotected

См. определение в файле landing.php строка 56

$code

$code = ''

protected

См. определение в файле landing.php строка 134

$disableLinkPreview

$disableLinkPreview = false

protected

См. определение в файле landing.php строка 218

$domainId

$domainId = 0

protected

См. определение в файле landing.php строка 164

$dynamicElementId

$dynamicElementId = 0

staticprotected

См. определение в файле landing.php строка 92

$dynamicFilterId

$dynamicFilterId = 0

staticprotected

См. определение в файле landing.php строка 86

$editMode

$editMode = false

staticprotected

См. определение в файле landing.php строка 68

$enabledUpdate

$enabledUpdate = true

staticprotected

См. определение в файле landing.php строка 50

$error

Error $error

protected

См. определение в файле landing.php строка 194

$folderId

$folderId = 0

protected

См. определение в файле landing.php строка 170

$id

$id = 0

protected

См. определение в файле landing.php строка 122

$internalClass

$internalClass = 'LandingTable'

static

См. определение в файле landing.php строка 44

$mainInstance

$mainInstance = true

protected

См. определение в файле landing.php строка 104

$metaData

$metaData = array()

protected

См. определение в файле landing.php строка 110

$previewMode

$previewMode = false

staticprotected

См. определение в файле landing.php строка 74

$rights

$rights = []

protected

См. определение в файле landing.php строка 200

$siteId

$siteId = 0

protected

См. определение в файле landing.php строка 152

$siteRow

$siteRow = []

protected

См. определение в файле landing.php строка 146

$siteTitle

$siteTitle = ''

protected

См. определение в файле landing.php строка 158

$siteType

string $siteType = ''

staticprotected

См. определение в файле landing.php строка 98

$title

$title = ''

protected

См. определение в файле landing.php строка 128

$tplId

int $tplId = 0

protected

См. определение в файле landing.php строка 176

$tplType

$tplType = 'landing'

protected

См. определение в файле landing.php строка 182

$variables

$variables = array()

staticprotected

См. определение в файле landing.php строка 80

$version

$version = 1

protected

См. определение в файле landing.php строка 212

$xmlId

$xmlId = ''

protected

См. определение в файле landing.php строка 140

META_KEYS

const META_KEYS

protected

Инициализатор

= [
        'CREATED_BY_ID', 'MODIFIED_BY_ID', 'DATE_CREATE',
        'DATE_MODIFY', 'DATE_PUBLIC', 'INITIATOR_APP_CODE', 'VIEWS', 'TPL_CODE',
        'ACTIVE', 'PUBLIC', 'SITE_CODE', 'SITE_SPECIAL', 'RULE',
        'SITE_VERSION', 'SITE_LANG', 'SITE_TPL_CODE',
    ]

Keys for get meta data from landing data

См. определение в файле landing.php строка 26

META_KEYS_MODIFIABLE

const META_KEYS_MODIFIABLE

protected

Инициализатор

= [
        'DATE_MODIFY', 'DATE_PUBLIC', 'ACTIVE', 'PUBLIC',
    ]

Meta keys, than can be changed

См. определение в файле landing.php строка 36

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/landing/lib/landing.php