Bitrix-D7 22.6
 
Загрузка...
Поиск...
Не найдено
Открытые члены | Открытые статические члены | Статические открытые данные | Защищенные члены | Защищенные данные | Статические защищенные данные | Полный список членов класса
Класс Landing
+ Граф наследования:Landing:

Открытые члены

 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())
 
static addByTemplate (int $siteId, string $code, array $fields=[])
 
- Открытые статические члены унаследованные от BaseTable
static callback ($code, $callback)
 

Статические открытые данные

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

Защищенные члены

 __construct ($id, $params=array())
 
 applyTemplate ($content=null)
 
 parseLocalUrl (string $content)
 
 execHooks ()
 
 transferBlock ($id, $lid)
 
 sortBlock (int $id, string $action)
 
 activateBlock ($id, $action)
 
 changeParentOfBlock ($block, $params)
 

Защищенные данные

 $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 строка 202

Методы

◆ activateBlock()

activateBlock (   $id,
  $action 
)
protected

Show/hide the block on the landing.

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

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

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

◆ addBlockToCollection()

addBlockToCollection ( \Bitrix\Landing\Block  $block)

Add new Block to the current landing.

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

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

◆ addByTemplate()

static addByTemplate ( int  $siteId,
string  $code,
array  $fields = [] 
)
static

Creates new page in the site by template.

Аргументы
int$siteIdSite id.
string$codeTemplate code.
array$fieldsLanding fields.
Возвращает
\Bitrix\Main\Entity\AddResult

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

◆ applyTemplate()

applyTemplate (   $content = null)
protected

Apply template for this landing.

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

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

◆ canDelete()

canDelete ( )

Can current user delete this landing.

Возвращает
bool

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

◆ canEdit()

canEdit ( )

Can current user edit this landing.

Возвращает
bool

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

◆ canPublication()

canPublication ( )

Can current user publication this landing.

Возвращает
bool

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

◆ changeParentOfBlock()

changeParentOfBlock (   $block,
  $params 
)
protected

Copy/move other block to this landing.

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

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

◆ checkDeleted()

static checkDeleted ( )
static

Check delete pages or not.

Возвращает
bool

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

◆ clearFolderIndex()

clearFolderIndex ( )

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

Возвращает
void

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

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

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

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

◆ createInstance()

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

Create current instance.

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

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

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

◆ deleteBlock()

deleteBlock (   $id)

Delete one block from current landing.

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

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

◆ disableCheckDeleted()

static disableCheckDeleted ( )
static

Disable check delete.

Возвращает
void

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

◆ disableCheckUniqueAddress()

static disableCheckUniqueAddress ( )
static

Disable checking unique address.

Возвращает
void

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

◆ disableUpdate()

static disableUpdate ( )
static

Disable update.

Возвращает
void

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

◆ downBlock()

downBlock ( int  $id)

Sort down the block on the landing.

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

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

◆ enableCheckDeleted()

static enableCheckDeleted ( )
static

Enable check delete.

Возвращает
void

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

◆ enableCheckUniqueAddress()

static enableCheckUniqueAddress ( )
static

Enable checking unique address

Возвращает
void

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

◆ enableUpdate()

static enableUpdate ( )
static

Enable update.

Возвращает
void

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

◆ execHooks()

execHooks ( )
protected

Exec hooks for landing (site and landing).

Возвращает
void

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

◆ exist()

exist ( )

Exist or not landing in current instance.

Возвращает
boolean

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

◆ fakePublication()

fakePublication ( )

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

Возвращает
boolean

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

◆ favoriteBlock()

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

Saves the block in favorites.

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

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

◆ getAdditionalFields()

static getAdditionalFields (   $id)
static

Get additional fields of Landing.

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

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

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

◆ getAreas()

getAreas ( )

Get included areas of this page.

Возвращает
array

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

◆ getBlockById()

getBlockById (   $id)

Get the block by id of current landing.

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

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

◆ getBlocks()

getBlocks ( )

Get all blocks of current landing.

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

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

◆ getCode()

getCode ( )

Returns code of current landing.

Возвращает
string

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

◆ getDomainId()

getDomainId ( )

Gets domain id of landing site.

Возвращает
int

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

◆ getDynamicElementId()

static getDynamicElementId ( )
static

Get dynamic element id.

Возвращает
int

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

◆ getDynamicFilter()

static getDynamicFilter ( )
static

Get dynamic filter.

Возвращает
array

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

◆ getEditMode()

static getEditMode ( )
static

Get state of edit mode.

Возвращает
boolean

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

◆ getError()

getError ( )

Get error collection

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

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

◆ getErrorMain()

getErrorMain ( )

Returns Error instance as Main\Error instance.

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

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

◆ getFolderId()

getFolderId ( )

Gets folder id of current landing.

Возвращает
int

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

◆ getHooks()

static getHooks (   $id)
static

Get hooks of Landing.

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

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

◆ getId()

getId ( )

Get id of current landing.

Возвращает
int

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

◆ getMeta()

getMeta ( )

Get metadata of current landing.

Возвращает
array

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

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

◆ getPreviewMode()

static getPreviewMode ( )
static

Get state of preview mode.

Возвращает
boolean

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

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

◆ getSiteId()

getSiteId ( )

Get site id of current landing.

Возвращает
int

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

◆ getSiteTitle()

getSiteTitle ( )

Get site title of current landing.

Возвращает
string

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

◆ getSiteType()

static getSiteType ( )
static

Get site id of current landing.

Возвращает
int

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

◆ getSmnSiteId()

getSmnSiteId ( )

Get site id of main, if exist.

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

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

◆ getTitle()

getTitle ( )

Get title of current landing.

Возвращает
int

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

◆ getVariables()

static getVariables ( )
static

Get external variables of Landing.

Возвращает
array

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

◆ getXmlId()

getXmlId ( )

Get xml id of current landing.

Возвращает
int

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

◆ hideBlock()

hideBlock (   $id)

Dectivate the block on the landing.

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

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

◆ isActive()

isActive ( )

Active or not the landing.

Возвращает
boolean

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

◆ isCheckUniqueAddress()

static isCheckUniqueAddress ( )
static

Checking or not unique address.

Возвращает
bool

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

◆ isDynamicDetailPage()

static isDynamicDetailPage ( )
static

Return true, if current page is dynamic detail page.

Возвращает
bool

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

◆ markDelete()

static markDelete ( int  $id)
static

Mark landing as deleted.

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

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

◆ markDeletedBlock()

markDeletedBlock (   $id,
  $mark 
)

Mark delete or not the block.

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

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

◆ markUnDelete()

static markUnDelete (   $id)
static

Mark entity as restored.

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

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

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

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

◆ parseLocalUrl()

parseLocalUrl ( string  $content)
protected

Parse between-landings url in landing content.

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

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

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

◆ publication()

publication (   $blockId = null)

Publication current landing.

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

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

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

◆ resortBlocks()

resortBlocks ( )

Resort current blocks.

Возвращает
void

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

◆ saveAdditionalFields()

static saveAdditionalFields (   $id,
array  $data 
)
static

Save additional fields for Landing.

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

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

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

◆ setEditMode()

static setEditMode (   $mode = true)
static

Set work mode to edit.

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

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

◆ setPreviewMode()

static setPreviewMode (   $mode = true)
static

Set work mode to preview.

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

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

◆ setVariables()

static setVariables ( array  $vars)
static

Set external variables of Landing.

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

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

◆ showBlock()

showBlock (   $id)

Activate the block on the landing.

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

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

◆ sortBlock()

sortBlock ( int  $id,
string  $action 
)
protected

Sort the block on the landing.

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

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

◆ touch()

touch ( )

Change modified user and date for current landing.

Возвращает
void

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

◆ transferBlock()

transferBlock (   $id,
  $lid 
)
protected

Transfer one block to another landing.

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

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

◆ unFavoriteBlock()

unFavoriteBlock ( int  $blockId)

Removes the block from favorites.

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

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

◆ unpublic()

unpublic ( )

Cancel publication of landing.

Возвращает
boolean

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

◆ upBlock()

upBlock ( int  $id)

Sort up the block on the landing.

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

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

◆ update()

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

Update the landing.

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

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

◆ updateVersion()

updateVersion ( )

If current version is not actual, making update.

Возвращает
void

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

◆ view()

view ( array  $params = array())

View landing in public or edit mode.

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

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

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

◆ $active

$active = false
protected

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

◆ $blocks

$blocks = array()
protected

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

◆ $checkDelete

$checkDelete = true
staticprotected

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

◆ $checkPermissions

$checkPermissions = true
protected

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

◆ $checkUniqueAddress

$checkUniqueAddress = true
staticprotected

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

◆ $code

$code = ''
protected

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

◆ $disableLinkPreview

$disableLinkPreview = false
protected

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

◆ $domainId

$domainId = 0
protected

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

◆ $dynamicElementId

$dynamicElementId = 0
staticprotected

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

◆ $dynamicFilterId

$dynamicFilterId = 0
staticprotected

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

◆ $editMode

$editMode = false
staticprotected

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

◆ $enabledUpdate

$enabledUpdate = true
staticprotected

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

◆ $error

$error = null
protected

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

◆ $folderId

$folderId = 0
protected

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

◆ $id

$id = 0
protected

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

◆ $internalClass

$internalClass = 'LandingTable'
static

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

◆ $mainInstance

$mainInstance = true
protected

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

◆ $metaData

$metaData = array()
protected

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

◆ $previewMode

$previewMode = false
staticprotected

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

◆ $rights

$rights = []
protected

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

◆ $siteCode

$siteCode = ''
staticprotected

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

◆ $siteId

$siteId = 0
protected

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

◆ $siteRow

$siteRow = []
protected

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

◆ $siteTitle

$siteTitle = ''
protected

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

◆ $title

$title = ''
protected

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

◆ $tplId

$tplId = 0
protected

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

◆ $tplType

$tplType = 'landing'
protected

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

◆ $variables

$variables = array()
staticprotected

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

◆ $version

$version = 1
protected

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

◆ $xmlId

$xmlId = ''
protected

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