Bitrix API

Syspage

Table of Contents

Methods

deleteForLanding()  : void
Delete all sys pages by id.
deleteForSite()  : void
Delete all sys pages by site id.
get()  : PublicActionResult
Get pages for site.
getSpecialPage()  : PublicActionResult
Get url of special page of site.
set()  : void
Set new system page for site.

Methods

deleteForLanding()

Delete all sys pages by id.

public static deleteForLanding(int $id) : void
Parameters
$id : int

Landing id.

deleteForSite()

Delete all sys pages by site id.

public static deleteForSite(int $id) : void
Parameters
$id : int

Site id.

get()

Get pages for site.

public static get(int $id[, bool $active = false ]) : PublicActionResult
Parameters
$id : int

Site id.

$active : bool = false

Only active items.

Return values
PublicActionResult

getSpecialPage()

Get url of special page of site.

public static getSpecialPage(int $siteId, string $type[, array<string|int, mixed> $additional = [] ]) : PublicActionResult
Parameters
$siteId : int

Site id.

$type : string

Type of special page.

$additional : array<string|int, mixed> = []

Additional params for uri.

Return values
PublicActionResult

set()

Set new system page for site.

public static set(int $id, string $type[, int $lid = false ]) : void
Parameters
$id : int

Site id.

$type : string

System page type.

$lid : int = false

Landing id (if not set, ref was deleted).


        
On this page

Search results