Класс Site

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

Открытые статические члены
static	ping (int $id, bool $deleted=false)
static	getPublicUrl ($id, bool $full=true, bool $hostInclude=true, bool $previewForNotActive=false)
static	getPreview (int $siteId)
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)
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 строка 10

Методы

addFolder()

static 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 строка 1151

addLandingToMenu()

static 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 строка 1547

changeCode()

static changeCode ( int $id, string $code )

static

Change code for the site.

Аргументы

int	$id	Site id.
string	$code	Code.

Возвращает

void

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

changeType()

static changeType ( int $id, string $type )

static

Change type for the site.

Аргументы

int	$id	Site id.
string	$type	Type.

Возвращает

void

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

clearPing()

static clearPing ( int $id )

staticprotected

Removes sites id that was pinged.

Аргументы

int

$id

Site id.

Возвращает

void

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

copy()

static copy ( $siteId )

static

Copy site without site's pages.

Аргументы

int

$siteId

Site id.

Возвращает

\Bitrix\Main\Result

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

copyFolders()

static 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 строка 1073

delete()

static delete ( $id, $pagesDelete = false )

static

Delete site by id.

Аргументы

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

Возвращает

\Bitrix\Main\Result

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

fullExport()

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

static

Get full data for site with pages.

Аргументы

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

Возвращает

array

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

getAdditionalFields()

static getAdditionalFields ( $id )

static

Get additional fields of Landing.

Аргументы

int

$id

Landing id.

Возвращает

array Array of Field.

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

getDefaultType()

static getDefaultType ( )

static

Get default site type.

Возвращает

string

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

getFolder()

static 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 строка 1408

getFolders()

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

static

Returns folder's list of site.

Аргументы

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

Возвращает

array

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

getHooks()

static getHooks ( $id )

static

Get hooks of Site.

Аргументы

int

$id

Site id.

Возвращает

array Array of Hook.

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

getPreview()

static getPreview ( int $siteId )

static

Get preview picture of the site's main page.

Аргументы

int

$siteId

Site id.

Возвращает

string

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

getPublicHash()

static 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 строка 937

getPublicUrl()

static 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 строка 77

getSiteIdByTemplate()

static getSiteIdByTemplate ( string $tplCode )

static

Returns site id by template code.

Аргументы

string

$tplCode

Template code.

Возвращает

int|null

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

getTypes()

static getTypes ( )

static

Get existed site types.

Возвращает

array

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

getVersion()

static getVersion ( $siteId )

static

Get version of site for updater

Аргументы

$siteId

Возвращает

int

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

markDelete()

static markDelete ( $id )

static

Mark site as deleted.

Аргументы

int

$id

Site id.

Возвращает

\Bitrix\Main\Result

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

markFolderDelete()

static markFolderDelete ( int $id )

static

Mark folder as deleted.

Аргументы

int

$id

Folder id.

Возвращает

\Bitrix\Main\Result

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

markFolderUnDelete()

static markFolderUnDelete ( int $id )

static

Mark folder as restored.

Аргументы

int

$id

Folder id.

Возвращает

\Bitrix\Main\Result

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

markUnDelete()

static markUnDelete ( $id )

static

Mark site as restored.

Аргументы

int

$id

Site id.

Возвращает

\Bitrix\Main\Result

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

moveFolder()

static 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 строка 1258

onBeforeMainSiteDelete()

static onBeforeMainSiteDelete ( $siteId )

static

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

Аргументы

string

$siteId

Main site id.

Возвращает

bool

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

onMainSiteDelete()

static onMainSiteDelete ( $siteId )

static

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

Аргументы

string

$siteId

Main site id.

Возвращает

void

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

ping()

static 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 строка 30

publication()

static publication ( int $id, bool $mark = true )

static

Makes site public.

Аргументы

int	$id	Site id.
bool	$mark	Mark.

Возвращает

\Bitrix\Main\Result

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

publicationFolder()

static 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 строка 1201

randomizeDomain()

static randomizeDomain ( int $siteId )

static

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

Аргументы

int

$siteId

Site id.

Возвращает

bool

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

saveAdditionalFields()

static saveAdditionalFields ( $id, array $data )

static

Save additional fields for Site.

Аргументы

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

Возвращает

void

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

switchDomain()

static 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 строка 1000

touch()

static touch ( int $id )

static

Change modified user and date for the site.

Аргументы

int

$id

Site id.

Возвращает

void

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

unpublic()

static unpublic ( int $id )

static

Marks site unpublic.

Аргументы

int

$id

Site id.

Возвращает

\Bitrix\Main\Result

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

updateFolder()

static 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 строка 1176

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

$internalClass

$internalClass = 'SiteTable'

static

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

$pings

$pings = []

staticprotected

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