|
| 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) |
|
См. определение в файле landing.php строка 15
◆ __construct()
__construct |
( |
|
$id, |
|
|
|
$params = array() |
|
) |
| |
|
protected |
Constructor.
- Аргументы
-
int | $id | Landing id. |
array | $params | Some params. |
См. определение в файле landing.php строка 202
◆ 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 строка 2444
◆ 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 строка 2127
◆ addBlockToCollection()
Add new Block to the current landing.
- Аргументы
-
\Bitrix\Landing\Block | $block | New 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 | $siteId | Site id. |
string | $code | Template code. |
array | $fields | Landing fields. |
- Возвращает
- \Bitrix\Main\Entity\AddResult
См. определение в файле landing.php строка 3087
◆ applyTemplate()
applyTemplate |
( |
|
$content = null | ) |
|
|
protected |
Apply template for this landing.
- Аргументы
-
string | $content | Landing content. |
- Возвращает
- string
См. определение в файле landing.php строка 1313
◆ canDelete()
Can current user delete this landing.
- Возвращает
- bool
См. определение в файле landing.php строка 1802
◆ canEdit()
Can current user edit this landing.
- Возвращает
- bool
См. определение в файле landing.php строка 1776
◆ canPublication()
Can current user publication this landing.
- Возвращает
- bool
См. определение в файле landing.php строка 1789
◆ changeParentOfBlock()
changeParentOfBlock |
( |
|
$block, |
|
|
|
$params |
|
) |
| |
|
protected |
Copy/move other block to this landing.
- Аргументы
-
int | $block | Block id. |
array | $params | Params array. |
- Возвращает
- int New Block id.
См. определение в файле landing.php строка 2569
◆ checkDeleted()
Check delete pages or not.
- Возвращает
- bool
См. определение в файле landing.php строка 433
◆ 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 | $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 строка 2936
◆ 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 строка 2712
◆ copyBlock()
copyBlock |
( |
|
$id, |
|
|
|
$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 New Block id.
См. определение в файле landing.php строка 2689
◆ createInstance()
static createInstance |
( |
|
$id, |
|
|
array |
$params = array() |
|
) |
| |
|
static |
Create current instance.
- Аргументы
-
int | $id | Landing id. |
array | $params | Additional params. |
- Возвращает
- Landing
См. определение в файле landing.php строка 507
◆ delete()
static 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 строка 613
◆ deleteBlock()
Delete one block from current landing.
- Аргументы
-
- Возвращает
- 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()
Disable update.
- Возвращает
- void
См. определение в файле landing.php строка 460
◆ downBlock()
Sort down the block on the landing.
- Аргументы
-
- Возвращает
- 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()
Enable update.
- Возвращает
- void
См. определение в файле landing.php строка 469
◆ execHooks()
Exec hooks for landing (site and landing).
- Возвращает
- void
См. определение в файле landing.php строка 1677
◆ exist()
Exist or not landing in current instance.
- Возвращает
- boolean
См. определение в файле landing.php строка 1713
◆ 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 | $id | Block id. |
array | $meta | Meta info. |
- Возвращает
- int|null New block id.
См. определение в файле landing.php строка 2495
◆ getAdditionalFields()
static getAdditionalFields |
( |
|
$id | ) |
|
|
static |
Get additional fields of Landing.
- Аргументы
-
- Возвращает
- array Array of Field.
См. определение в файле landing.php строка 702
◆ getAdditionalFieldsAsArray()
static 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 строка 721
◆ getAreas()
Get included areas of this page.
- Возвращает
- array
См. определение в файле landing.php строка 1296
◆ getBlockById()
Get the block by id of current landing.
- Аргументы
-
- Возвращает
- Block
См. определение в файле landing.php строка 1895
◆ getBlocks()
Get all blocks of current landing.
- Возвращает
- Block[]
См. определение в файле landing.php строка 1885
◆ getCode()
Returns code of current landing.
- Возвращает
- string
См. определение в файле landing.php строка 1758
◆ 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()
Get state of edit mode.
- Возвращает
- boolean
См. определение в файле landing.php строка 405
◆ getError()
Get error collection
- Возвращает
- \Bitrix\Landing\Error
См. определение в файле landing.php строка 1920
◆ getErrorMain()
Returns Error instance as Main\Error instance.
- Возвращает
- \Bitrix\Main\Error|null
См. определение в файле landing.php строка 1929
◆ getFolderId()
Gets folder id of current landing.
- Возвращает
- int
См. определение в файле landing.php строка 1815
◆ getHooks()
Get hooks of Landing.
- Аргументы
-
- Возвращает
- array Array of Hook.
См. определение в файле landing.php строка 687
◆ getId()
Get id of current landing.
- Возвращает
- int
См. определение в файле landing.php строка 1731
◆ 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 | $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 строка 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 | $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 строка 884
◆ getSiteId()
Get site id of current landing.
- Возвращает
- int
См. определение в файле landing.php строка 1824
◆ getSiteTitle()
Get site title of current landing.
- Возвращает
- string
См. определение в файле landing.php строка 1833
◆ getSiteType()
Get site id of current landing.
- Возвращает
- int
См. определение в файле landing.php строка 1851
◆ getSmnSiteId()
Get site id of main, if exist.
- Возвращает
- string|null
См. определение в файле landing.php строка 1860
◆ getTitle()
Get title of current landing.
- Возвращает
- int
См. определение в файле landing.php строка 1749
◆ getVariables()
Get external variables of Landing.
- Возвращает
- array
См. определение в файле landing.php строка 778
◆ getXmlId()
Get xml id of current landing.
- Возвращает
- int
См. определение в файле landing.php строка 1740
◆ hideBlock()
Dectivate the block on the landing.
- Аргументы
-
- Возвращает
- boolean
См. определение в файле landing.php строка 2484
◆ 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.
- Аргументы
-
- Возвращает
- \Bitrix\Main\Result
См. определение в файле landing.php строка 517
◆ markDeletedBlock()
markDeletedBlock |
( |
|
$id, |
|
|
|
$mark |
|
) |
| |
Mark delete or not the block.
- Аргументы
-
int | $id | Block id. |
boolean | $mark | Mark. |
- Возвращает
- boolean
См. определение в файле landing.php строка 2204
◆ markUnDelete()
static markUnDelete |
( |
|
$id | ) |
|
|
static |
Mark entity as restored.
- Аргументы
-
- Возвращает
- \Bitrix\Main\Result
См. определение в файле landing.php строка 577
◆ 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 строка 2875
◆ moveBlock()
moveBlock |
( |
|
$id, |
|
|
|
$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 New Block id.
См. определение в файле landing.php строка 3046
◆ parseLocalUrl()
parseLocalUrl |
( |
string |
$content | ) |
|
|
protected |
Parse between-landings url in landing content.
- Аргументы
-
string | $content | Landing content. |
- Возвращает
- string
См. определение в файле landing.php строка 1401
◆ ping()
static 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 строка 359
◆ publication()
publication |
( |
|
$blockId = null | ) |
|
Publication current landing.
- Аргументы
-
int | int[] | null | $blockId | Publication 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 | $landingUrl | Landing public url. |
int | $siteId | Landing's site id. |
- Возвращает
- int|null
См. определение в файле landing.php строка 1063
◆ resortBlocks()
Resort current blocks.
- Возвращает
- void
См. определение в файле landing.php строка 2309
◆ saveAdditionalFields()
static saveAdditionalFields |
( |
|
$id, |
|
|
array |
$data |
|
) |
| |
|
static |
Save additional fields for Landing.
- Аргументы
-
int | $id | Landing id. |
array | $data | Data array. |
- Возвращает
- void
См. определение в файле landing.php строка 755
◆ setDynamicParams()
static 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 строка 789
◆ setEditMode()
static setEditMode |
( |
|
$mode = true | ) |
|
|
static |
Set work mode to edit.
- Аргументы
-
- Возвращает
- void
См. определение в файле landing.php строка 396
◆ setPreviewMode()
static setPreviewMode |
( |
|
$mode = true | ) |
|
|
static |
Set work mode to preview.
- Аргументы
-
boolean | $mode | Preview mode. |
- Возвращает
- void
См. определение в файле landing.php строка 415
◆ setVariables()
static setVariables |
( |
array |
$vars | ) |
|
|
static |
Set external variables of Landing.
- Аргументы
-
array | $vars | Additional vars. |
- Возвращает
- void
См. определение в файле landing.php строка 766
◆ showBlock()
Activate the block on the landing.
- Аргументы
-
- Возвращает
- boolean
См. определение в файле landing.php строка 2474
◆ 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 строка 2333
◆ 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 | $id | Block id. |
int | $lid | Landing id. |
- Возвращает
- boolean
См. определение в файле landing.php строка 2282
◆ unFavoriteBlock()
unFavoriteBlock |
( |
int |
$blockId | ) |
|
Removes the block from favorites.
- Аргументы
-
- Возвращает
- bool
См. определение в файле landing.php строка 2528
◆ unpublic()
Cancel publication of landing.
- Возвращает
- boolean
См. определение в файле landing.php строка 2087
◆ upBlock()
Sort up the block on the landing.
- Аргументы
-
- Возвращает
- boolean
См. определение в файле landing.php строка 2393
◆ update()
static update |
( |
|
$id, |
|
|
|
$fields = array() |
|
) |
| |
|
static |
Update the landing.
- Аргументы
-
int | $id | Landing id. |
array | $fields | Fields. |
- Возвращает
- \Bitrix\Main\Result
См. определение в файле landing.php строка 3068
◆ 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 | $params | Some additional params. |
- Возвращает
- void
См. определение в файле landing.php строка 1092
◆ $active
◆ $blocks
◆ $checkDelete
◆ $checkPermissions
◆ $checkUniqueAddress
$checkUniqueAddress = true |
|
staticprotected |
◆ $code
◆ $disableLinkPreview
$disableLinkPreview = false |
|
protected |
◆ $domainId
◆ $dynamicElementId
◆ $dynamicFilterId
◆ $editMode
◆ $enabledUpdate
◆ $error
◆ $folderId
◆ $id
◆ $internalClass
◆ $mainInstance
◆ $metaData
◆ $previewMode
◆ $rights
◆ $siteCode
◆ $siteId
◆ $siteRow
◆ $siteTitle
◆ $title
◆ $tplId
◆ $tplType
◆ $variables
◆ $version
◆ $xmlId