Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс 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 ()
 
 exist ()
 
 isActive ()
 
 getId ()
 
 getXmlId ()
 
 getTitle ()
 
 getCode ()
 
 getMeta ()
 
 canEdit ()
 
 canPublication ()
 
 canDelete ()
 
 getFolderId ()
 
 getSiteId ()
 
 getSiteTitle ()
 
 getDomainId ()
 
 getSmnSiteId ()
 
 getBlocks ()
 
 getBlockById ($id)
 
 addBlockToCollection (\Bitrix\Landing\Block $block)
 
 getError ()
 
 getErrorMain ()
 
 touch ()
 
 updateVersion ()
 
 publication ($blockId=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 ($id, $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 ($id, $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)
 
 transferBlock ($id, $lid)
 
 sortBlock (int $id, string $action)
 
 activateBlock ($id, $action)
 
 changeParentOfBlock ($block, $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
 
 $tplId = 0
 
 $tplType = 'landing'
 
 $active = false
 
 $error = null
 
 $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 $siteCode = ''
 

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

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

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

◆ __construct()

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

Constructor.

Аргументы
int$idLanding id.
array$paramsSome params.

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

Методы

◆ activateBlock()

activateBlock ( $id,
$action )
protected

Show/hide the block on the landing.

Аргументы
int$idBlock id.
string$actionCode: up or down.
Возвращает
boolean

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

◆ addBlock()

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

Add new block to the landing.

Аргументы
string$codeCode of block.
array$dataData array of block.
bool$saveInLastUsedSave this block as last used for current user.
Возвращает
int|false Id of new block or false on failure.

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

◆ addBlockToCollection()

addBlockToCollection ( \Bitrix\Landing\Block $block)

Add new Block to the current landing.

Аргументы
\Bitrix\Landing\Block$blockNew block instance.
Возвращает
void

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

◆ applyTemplate()

applyTemplate ( $content = null)
protected

Apply template for this landing.

Аргументы
string$contentLanding content.
Возвращает
string

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

◆ canDelete()

canDelete ( )

Can current user delete this landing.

Возвращает
bool

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

◆ canEdit()

canEdit ( )

Can current user edit this landing.

Возвращает
bool

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

◆ canPublication()

canPublication ( )

Can current user publication this landing.

Возвращает
bool

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

◆ changeParentOfBlock()

changeParentOfBlock ( $block,
$params )
protected

Copy/move other block to this landing.

Аргументы
int$blockBlock id.
array$paramsParams array.
Возвращает
int New Block id.

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

◆ checkDeleted()

static checkDeleted ( )
static

Check delete pages or not.

Возвращает
bool

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

◆ clearFolderIndex()

clearFolderIndex ( )

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

Возвращает
void

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

◆ copy()

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

Copy current landing.

Аргументы
int | null$toSiteIdSite id (if you want copy in another site).
int | null$toFolderIdFolder id (if you want copy in some folder).
bool$withoutBlocksCopy only pages, without blocks.
bool$skipSystemIf true, don't copy system flag.
Возвращает
int|null New landing id.

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

◆ copyAllBlocks()

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

Copy all blocks from another landing to this.

Аргументы
int$lidLanding id.
boolean$replaceLinksReplace links to the old blocks.
array&$referencesArray that will contain references between old and new IDs.
Возвращает
void

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

◆ copyBlock()

copyBlock ( $id,
$afterId )

Copy other block to this landing.

Аргументы
int$idBlock id (from another landing).
int$afterIdPut after this block id (in this landing).
Возвращает
int New Block id.

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

◆ createInstance()

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

Create current instance.

Аргументы
int$idLanding id.
array$paramsAdditional params.
Возвращает
Landing

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

◆ delete()

static delete ( $id,
bool $forceDeleted = false )
static

Delete landing by id and its blocks.

Аргументы
int$idLanding id.
bool$forceDeletedForce delete throw an errors.
Возвращает
\Bitrix\Main\Result

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

◆ deleteBlock()

deleteBlock ( $id)

Delete one block from current landing.

Аргументы
int$idBlock id.
Возвращает
boolean

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

◆ disableCheckDeleted()

static disableCheckDeleted ( )
static

Disable check delete.

Возвращает
void

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

◆ disableCheckUniqueAddress()

static disableCheckUniqueAddress ( )
static

Disable checking unique address.

Возвращает
void

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

◆ disableUpdate()

static disableUpdate ( )
static

Disable update.

Возвращает
void

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

◆ downBlock()

downBlock ( int $id)

Sort down the block on the landing.

Аргументы
int$idBlock id.
Возвращает
boolean

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

◆ enableCheckDeleted()

static enableCheckDeleted ( )
static

Enable check delete.

Возвращает
void

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

◆ enableCheckUniqueAddress()

static enableCheckUniqueAddress ( )
static

Enable checking unique address

Возвращает
void

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

◆ enableUpdate()

static enableUpdate ( )
static

Enable update.

Возвращает
void

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

◆ execHooks()

execHooks ( )
protected

Exec hooks for landing (site and landing).

Возвращает
void

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

◆ exist()

exist ( )

Exist or not landing in current instance.

Возвращает
boolean

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

◆ fakePublication()

fakePublication ( )

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

Возвращает
boolean

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

◆ favoriteBlock()

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

Saves the block in favorites.

Аргументы
int$idBlock id.
array$metaMeta info.
Возвращает
int|null New block id.

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

◆ getAdditionalFields()

static getAdditionalFields ( $id)
static

Get additional fields of Landing.

Аргументы
int$idLanding id.
Возвращает
array Array of Field.

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

◆ getAdditionalFieldsAsArray()

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

Returns additional fields of Landing as array.

Аргументы
int$landingIdLanding id.
bool$skipEmptySkip emty values.
Возвращает
array Array of Field.

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

◆ getAreas()

getAreas ( )

Get included areas of this page.

Возвращает
array

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

◆ getBlockById()

getBlockById ( $id)

Get the block by id of current landing.

Аргументы
int$idBlock id.
Возвращает
Block

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

◆ getBlocks()

getBlocks ( )

Get all blocks of current landing.

Возвращает
Block[]

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

◆ getCode()

getCode ( )

Returns code of current landing.

Возвращает
string

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

◆ getDomainId()

getDomainId ( )

Gets domain id of landing site.

Возвращает
int

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

◆ getDynamicElementId()

static getDynamicElementId ( )
static

Get dynamic element id.

Возвращает
int

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

◆ getDynamicFilter()

static getDynamicFilter ( )
static

Get dynamic filter.

Возвращает
array

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

◆ getEditMode()

static getEditMode ( )
static

Get state of edit mode.

Возвращает
boolean

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

◆ getError()

getError ( )

Get error collection

Возвращает
\Bitrix\Landing\Error

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

◆ getErrorMain()

getErrorMain ( )

Returns Error instance as Main\Error instance.

Возвращает
\Bitrix\Main\Error|null

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

◆ getFolderId()

getFolderId ( )

Gets folder id of current landing.

Возвращает
int

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

◆ getHooks()

static getHooks ( $id)
static

Get hooks of Landing.

Аргументы
int$idLanding id.
Возвращает
array Array of Hook.

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

◆ getId()

getId ( )

Get id of current landing.

Возвращает
int

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

◆ getMeta()

getMeta ( )

Get metadata of current landing.

Возвращает
array

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

◆ getPreview()

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

Get preview picture of the landing.

Аргументы
int | null$idLanding id (if null, gets for $this->id).
bool$skipCloudSkip getting picture from cloud.
string | null$publicUrlFull public url of site (you may set this param for optimisation).
Возвращает
string|null

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

◆ getPreviewMode()

static getPreviewMode ( )
static

Get state of preview mode.

Возвращает
boolean

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

◆ getPublicUrl()

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

Get full pubic URL for this landing.

Аргументы
int | array$idLanding id (id array), optional.
boolean$absoluteFull url.
bool$createPubPathCreate pub path (checking and create).
array&$fullUrlReturns full url of landings.
Возвращает
string|array

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

◆ getSiteId()

getSiteId ( )

Get site id of current landing.

Возвращает
int

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

◆ getSiteTitle()

getSiteTitle ( )

Get site title of current landing.

Возвращает
string

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

◆ getSiteType()

static getSiteType ( )
static

Get site id of current landing.

Возвращает
int

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

◆ getSmnSiteId()

getSmnSiteId ( )

Get site id of main, if exist.

Возвращает
string|null

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

◆ getTitle()

getTitle ( )

Get title of current landing.

Возвращает
int

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

◆ getVariables()

static getVariables ( )
static

Get external variables of Landing.

Возвращает
array

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

◆ getXmlId()

getXmlId ( )

Get xml id of current landing.

Возвращает
int

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

◆ hideBlock()

hideBlock ( $id)

Dectivate the block on the landing.

Аргументы
int$idBlock id.
Возвращает
boolean

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

◆ isActive()

isActive ( )

Active or not the landing.

Возвращает
boolean

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

◆ isCheckUniqueAddress()

static isCheckUniqueAddress ( )
static

Checking or not unique address.

Возвращает
bool

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

◆ isDynamicDetailPage()

static isDynamicDetailPage ( )
static

Return true, if current page is dynamic detail page.

Возвращает
bool

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

◆ markDelete()

static markDelete ( int $id)
static

Mark landing as deleted.

Аргументы
int$idLanding id.
Возвращает
\Bitrix\Main\Result

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

◆ markDeletedBlock()

markDeletedBlock ( $id,
$mark )

Mark delete or not the block.

Аргументы
int$idBlock id.
boolean$markMark.
Возвращает
boolean

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

◆ markUnDelete()

static markUnDelete ( $id)
static

Mark entity as restored.

Аргументы
int$idEntity id.
Возвращает
\Bitrix\Main\Result

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

◆ move()

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

Move current page to site/folder.

Аргументы
int | null$toSiteIdDestination site id (if you want copy in another site).
int | null$toFolderIdDestination folder id.
Возвращает
bool

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

◆ moveBlock()

moveBlock ( $id,
$afterId )

Move other block to this landing.

Аргументы
int$idBlock id (from another landing).
int$afterIdPut after this block id (in this landing).
Возвращает
int New Block id.

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

◆ parseLocalUrl()

parseLocalUrl ( string $content)
protected

Parse between-landings url in landing content.

Аргументы
string$contentLanding content.
Возвращает
string

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

◆ ping()

static ping ( $id,
$deleted = false )
static

Return true if landing exists and available.

Аргументы
int$idLanding id.
bool$deletedAnd from recycle bin.
Возвращает
bool

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

◆ prepareHook()

prepareHook ( $hook)
protected

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

◆ publication()

publication ( $blockId = null)

Publication current landing.

Аргументы
int | int[] | null$blockIdPublication only this block(s).
Возвращает
boolean

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

◆ resolveIdByPublicUrl()

static resolveIdByPublicUrl ( string $landingUrl,
int $siteId )
static

Returns landing id resolves by landing public url.

Аргументы
string$landingUrlLanding public url.
int$siteIdLanding's site id.
Возвращает
int|null

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

◆ resortBlocks()

resortBlocks ( )

Resort current blocks.

Возвращает
void

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

◆ saveAdditionalFields()

static saveAdditionalFields ( $id,
array $data )
static

Save additional fields for Landing.

Аргументы
int$idLanding id.
array$dataData array.
Возвращает
void

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

◆ setDynamicParams()

static setDynamicParams ( $filterId,
$elementId )
static

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

Аргументы
int$filterIdId of filter.
int$elementIdId of dynamic element id.
Возвращает
void

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

◆ setEditMode()

static setEditMode ( $mode = true)
static

Set work mode to edit.

Аргументы
boolean$modeEdit mode.
Возвращает
void

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

◆ setMetaData()

setMetaData ( array $metaData)

Can refresh value of modifiable meta data

Аргументы
array$metaData
Возвращает
void

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

◆ setPreviewMode()

static setPreviewMode ( $mode = true)
static

Set work mode to preview.

Аргументы
boolean$modePreview mode.
Возвращает
void

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

◆ setVariables()

static setVariables ( array $vars)
static

Set external variables of Landing.

Аргументы
array$varsAdditional vars.
Возвращает
void

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

◆ showBlock()

showBlock ( $id)

Activate the block on the landing.

Аргументы
int$idBlock id.
Возвращает
boolean

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

◆ sortBlock()

sortBlock ( int $id,
string $action )
protected

Sort the block on the landing.

Аргументы
int$idBlock id.
string$actionCode: up or down.
Возвращает
boolean

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

◆ touch()

touch ( )

Change modified user and date for current landing.

Возвращает
void

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

◆ transferBlock()

transferBlock ( $id,
$lid )
protected

Transfer one block to another landing.

Аргументы
int$idBlock id.
int$lidLanding id.
Возвращает
boolean

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

◆ unFavoriteBlock()

unFavoriteBlock ( int $blockId)

Removes the block from favorites.

Аргументы
int$blockIdBlock id.
Возвращает
bool

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

◆ unpublic()

unpublic ( )

Cancel publication of landing.

Возвращает
boolean

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

◆ upBlock()

upBlock ( int $id)

Sort up the block on the landing.

Аргументы
int$idBlock id.
Возвращает
boolean

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

◆ update()

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

Update the landing.

Аргументы
int$idLanding id.
array$fieldsFields.
Возвращает
\Bitrix\Main\Result

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

◆ updateVersion()

updateVersion ( )

If current version is not actual, making update.

Возвращает
void

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

◆ view()

view ( array $params = array())

View landing in public or edit mode.

Аргументы
array$paramsSome additional params.
Возвращает
void

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

Данные класса

◆ $active

$active = false
protected

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

◆ $blocks

$blocks = array()
protected

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

◆ $checkDelete

$checkDelete = true
staticprotected

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

◆ $checkPermissions

$checkPermissions = true
protected

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

◆ $checkUniqueAddress

$checkUniqueAddress = true
staticprotected

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

◆ $code

$code = ''
protected

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

◆ $disableLinkPreview

$disableLinkPreview = false
protected

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

◆ $domainId

$domainId = 0
protected

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

◆ $dynamicElementId

$dynamicElementId = 0
staticprotected

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

◆ $dynamicFilterId

$dynamicFilterId = 0
staticprotected

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

◆ $editMode

$editMode = false
staticprotected

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

◆ $enabledUpdate

$enabledUpdate = true
staticprotected

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

◆ $error

$error = null
protected

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

◆ $folderId

$folderId = 0
protected

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

◆ $id

$id = 0
protected

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

◆ $internalClass

$internalClass = 'LandingTable'
static

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

◆ $mainInstance

$mainInstance = true
protected

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

◆ $metaData

$metaData = array()
protected

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

◆ $previewMode

$previewMode = false
staticprotected

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

◆ $rights

$rights = []
protected

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

◆ $siteCode

$siteCode = ''
staticprotected

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

◆ $siteId

$siteId = 0
protected

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

◆ $siteRow

$siteRow = []
protected

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

◆ $siteTitle

$siteTitle = ''
protected

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

◆ $title

$title = ''
protected

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

◆ $tplId

$tplId = 0
protected

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

◆ $tplType

$tplType = 'landing'
protected

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

◆ $variables

$variables = array()
staticprotected

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

◆ $version

$version = 1
protected

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

◆ $xmlId

$xmlId = ''
protected

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

◆ 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 строка 20

◆ META_KEYS_MODIFIABLE

const META_KEYS_MODIFIABLE
protected
Инициализатор
= [
'DATE_MODIFY', 'DATE_PUBLIC', 'ACTIVE', 'PUBLIC'
]

Meta keys, than can be changed

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