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

Открытые статические члены
static	ping (int $id, bool $deleted=false)
static	getPublicUrl ($id, bool $full=true, bool $hostInclude=true, bool $previewForNotActive=false)
static	getPreview (int $siteId, bool $skipCloud=false)
static	getHooks ($id)
static	getVersion ($siteId)
static	getAdditionalFields ($id)
static	saveAdditionalFields ($id, array $data)
static	getTypes ()
static	getDefaultType ()
static	delete ($id, $pagesDelete=false)
static	markDelete ($id)
static	markUnDelete ($id)
static	copy ($siteId)
static	fullExport ($siteForExport, $params=array())
static	getPublicHash ($id, $domain=null)
static	switchDomain (int $siteId1, int $siteId2)
static	randomizeDomain (int $siteId)
static	copyFolders (int $fromSite, int $toSite, array &$folderMap=[])
static	addFolder (int $siteId, array $fields)
static	updateFolder (int $siteId, int $folderId, array $fields)
static	publicationFolder (int $folderId, bool $mark=true)
static	moveFolder (int $folderId, ?int $toFolderId, ?int $toSiteId=null)
static	getFolders (int $siteId, array $filter=[])
static	getFolder (int $folderId, string $accessLevel=Rights::ACCESS_TYPES['read'])
static	markFolderDelete (int $id)
static	markFolderUnDelete (int $id)
static	addLandingToMenu (int $siteId, array $data)
static	touch (int $id)
static	publication (int $id, bool $mark=true, ?Metrika\FieldsDto $metrikaFields=null)
static	unpublic (int $id)
static	getSiteIdByTemplate (string $tplCode)
static	onBeforeMainSiteDelete ($siteId)
static	onMainSiteDelete ($siteId)
static	changeType (int $id, string $type)
static	changeCode (int $id, string $code)
Открытые статические члены унаследованные от BaseTable
static	callback ($code, $callback)

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

Защищенные статические члены
static	clearPing (int $id)

Статические защищенные данные
static	$pings = []

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

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

Методы

◆ addFolder()

addFolder	(	int	$siteId,
		array	$fields )

static

Creates folder into the site.

Аргументы

int	$siteId	Site id.
array	$fields	Folder's fields.

Возвращает: \Bitrix\Main\Entity\AddResult

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

◆ addLandingToMenu()

addLandingToMenu	(	int	$siteId,
		array	$data )

static

Tries to add page to the all menu on the site. Detects blocks with menu-manifests only.

Аргументы

int	$siteId	Site id.
array	$data	Landing data ([ID, TITLE]).

Возвращает: void

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

◆ changeCode()

changeCode	(	int	$id,
		string	$code )

static

Change code for the site.

Аргументы

int	$id	Site id.
string	$code	Code.

Возвращает: void

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

◆ changeType()

changeType	(	int	$id,
		string	$type )

static

Change type for the site.

Аргументы

int	$id	Site id.
string	$type	Type.

Возвращает: void

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

◆ clearPing()

clearPing ( int $id )

staticprotected

Removes sites id that was pinged.

Аргументы

int $id Site id.

Возвращает: void

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

◆ copy()

copy ( $siteId )

static

Copy site without site's pages.

Аргументы

int $siteId Site id.

Возвращает: \Bitrix\Main\Result

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

◆ copyFolders()

copyFolders	(	int	$fromSite,
		int	$toSite,
		array &	$folderMap = [] )

static

Copies folders from one site to another without pages.

Аргументы

int	$fromSite	Source site id.
int	$toSite	Destination site id.
array	$folderMap	External references old<>new ids.

Возвращает: \Bitrix\Main\Result

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

◆ delete()

delete	(		$id,
			$pagesDelete = false )

static

Delete site by id.

Аргументы

int	$id	Site id.
bool	$pagesDelete	Delete all pages before.

Возвращает: \Bitrix\Main\Result

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

◆ fullExport()

fullExport	(		$siteForExport,
			$params = array() )

static

Get full data for site with pages.

Аргументы

int	$siteForExport	Site id.
array	$params	Some params.

Возвращает: array

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

◆ getAdditionalFields()

getAdditionalFields ( $id )

static

Get additional fields of Landing.

Аргументы

int $id Landing id.

Возвращает: array Array of Field.

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

◆ getDefaultType()

getDefaultType ( )

static

Get default site type.

Возвращает: string

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

◆ getFolder()

getFolder	(	int	$folderId,
		string	$accessLevel = Rights::ACCESS_TYPES['read'] )

static

Returns folder's info.

Аргументы

int	$folderId	Folder id.
string	$accessLevel	Access level to folder.

Возвращает: array|null

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

◆ getFolders()

getFolders	(	int	$siteId,
		array	$filter = [] )

static

Returns folder's list of site.

Аргументы

int	$siteId	Site id.
array	$filter	Folder's filter.

Возвращает: array

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

◆ getHooks()

getHooks ( $id )

static

Get hooks of Site.

Аргументы

int $id Site id.

Возвращает: array Array of Hook.

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

◆ getPreview()

getPreview	(	int	$siteId,
		bool	$skipCloud = false )

static

Get preview picture of the site's main page.

Аргументы

int	$siteId	Site id.
bool	$skipCloud	Skip getting picture from cloud.

Возвращает: string

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

◆ getPublicHash()

getPublicHash	(		$id,
			$domain = null )

static

Get md5 hash for site, using http host.

Аргументы

int	$id	Site id.
string	$domain	Domain name for this site.

Возвращает: string

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

◆ getPublicUrl()

getPublicUrl	(		$id,
		bool	$full = true,
		bool	$hostInclude = true,
		bool	$previewForNotActive = false )

static

Get public url for site.

Аргументы

int[] \| int	$id	Site id or array of ids.
boolean	$full	Return full site url with relative path.
boolean	$hostInclude	Include host name in full path.
boolean	$previewForNotActive	If true and site is not active, url will be with preview hash.

Возвращает: string|array

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

◆ getSiteIdByTemplate()

getSiteIdByTemplate ( string $tplCode )

static

Returns site id by template code.

Аргументы

string $tplCode Template code.

Возвращает: int|null

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

◆ getTypes()

getTypes ( )

static

Get existed site types.

Возвращает: array

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

◆ getVersion()

getVersion ( $siteId )

static

Get version of site for updater

Аргументы

$siteId

Возвращает: int

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

◆ markDelete()

markDelete ( $id )

static

Mark site as deleted.

Аргументы

int $id Site id.

Возвращает: \Bitrix\Main\Result

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

◆ markFolderDelete()

markFolderDelete ( int $id )

static

Mark folder as deleted.

Аргументы

int $id Folder id.

Возвращает: \Bitrix\Main\Result

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

◆ markFolderUnDelete()

markFolderUnDelete ( int $id )

static

Mark folder as restored.

Аргументы

int $id Folder id.

Возвращает: \Bitrix\Main\Result

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

◆ markUnDelete()

markUnDelete ( $id )

static

Mark site as restored.

Аргументы

int $id Site id.

Возвращает: \Bitrix\Main\Result

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

◆ moveFolder()

moveFolder	(	int	$folderId,
		?int	$toFolderId,
		?int	$toSiteId = null )

static

Moves folder.

Аргументы

int	$folderId	Current folder id.
int \| null	$toFolderId	Destination folder id (or null for root folder of current folder's site).
int \| null	$toSiteId	Destination site id (if different from current).

Возвращает: \Bitrix\Main\Result

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

◆ onBeforeMainSiteDelete()

onBeforeMainSiteDelete ( $siteId )

static

Event handler for check existing pages of main module's site.

Аргументы

string $siteId Main site id.

Возвращает: bool

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

◆ onMainSiteDelete()

onMainSiteDelete ( $siteId )

static

Event handler for delete pages of main module's site.

Аргументы

string $siteId Main site id.

Возвращает: void

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

◆ ping()

ping	(	int	$id,
		bool	$deleted = false )

static

Returns true if site exists and available.

Аргументы

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

Возвращает: bool

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

◆ publication()

publication	(	int	$id,
		bool	$mark = true,
		?Metrika\FieldsDto	$metrikaFields = null )

static

Makes site public.

Аргументы

int	$id	Site id.
bool	$mark	Mark.
Metrika\FieldsDto \| null	$metrikaFields	- params for analytic. If not set anything - analytic not sent

Возвращает: \Bitrix\Main\Result

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

◆ publicationFolder()

publicationFolder	(	int	$folderId,
		bool	$mark = true )

static

Public all folder's breadcrumb.

Аргументы

int	$folderId	Folder id.
bool	$mark	Publication / depublication.

Возвращает: \Bitrix\Main\Result

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

◆ randomizeDomain()

randomizeDomain ( int $siteId )

static

Sets new random domain to site. Actual for Bitrix24 only.

Аргументы

int $siteId Site id.

Возвращает: bool

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

◆ saveAdditionalFields()

saveAdditionalFields	(		$id,
		array	$data )

static

Save additional fields for Site.

Аргументы

int	$id	Site id.
array	$data	Data array.

Возвращает: void

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

◆ switchDomain()

switchDomain	(	int	$siteId1,
		int	$siteId2 )

static

Switch domains between two sites. Returns true on success.

Аргументы

int	$siteId1	First site id.
int	$siteId2	Second site id.

Возвращает: bool

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

◆ touch()

touch ( int $id )

static

Change modified user and date for the site.

Аргументы

int $id Site id.

Возвращает: void

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

◆ unpublic()

unpublic ( int $id )

static

Marks site unpublic.

Аргументы

int $id Site id.

Возвращает: \Bitrix\Main\Result

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

◆ updateFolder()

updateFolder	(	int	$siteId,
		int	$folderId,
		array	$fields )

static

Updates folder of the site.

Аргументы

int	$siteId	Site id.
int	$folderId	Folder id.
array	$fields	Folder's fields.

Возвращает: \Bitrix\Main\Entity\UpdateResult

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

Поля

◆ $internalClass

$internalClass = 'SiteTable'

static

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

◆ $pings

$pings = []

staticprotected

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

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

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

Открытые статические члены

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

Защищенные статические члены

Статические защищенные данные

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

Методы

◆ addFolder()

◆ addLandingToMenu()

◆ changeCode()

◆ changeType()

◆ clearPing()

◆ copy()

◆ copyFolders()

◆ delete()

◆ fullExport()

◆ getAdditionalFields()

◆ getDefaultType()

◆ getFolder()

◆ getFolders()

◆ getHooks()

◆ getPreview()

◆ getPublicHash()

◆ getPublicUrl()

◆ getSiteIdByTemplate()

◆ getTypes()

◆ getVersion()

◆ markDelete()

◆ markFolderDelete()

◆ markFolderUnDelete()

◆ markUnDelete()

◆ moveFolder()

◆ onBeforeMainSiteDelete()

◆ onMainSiteDelete()

◆ ping()

◆ publication()

◆ publicationFolder()

◆ randomizeDomain()

◆ saveAdditionalFields()

◆ switchDomain()

◆ touch()

◆ unpublic()

◆ updateFolder()

Поля

◆ $internalClass

◆ $pings