Bitrix API

Site

Table of Contents

Methods

add()  : PublicActionResult
Create new site.
addFolder()  : PublicActionResult
Creates folder into the site.
bindingToGroup()  : PublicActionResult
Binds site with specific socialnetwork group.
bindingToMenu()  : PublicActionResult
Binds site with specific menu.
delete()  : PublicActionResult
Delete site.
fullExport()  : PublicActionResult
Full export of the site.
getAdditionalFields()  : PublicActionResult
Get additional fields of site.
getFolders()  : PublicActionResult
Returns folder's list of site.
getGroupBindings()  : PublicActionResult
Returns exists bindings.
getList()  : PublicActionResult
Get available sites.
getMenuBindings()  : PublicActionResult
Returns exists bindings.
getPreview()  : PublicActionResult
Returns site's preview (index page's preview).
getPublicUrl()  : PublicActionResult
Gets public url of site (or sites).
getRights()  : PublicActionResult
Get rights about site.
markDelete()  : PublicActionResult
Mark site as deleted.
markFolderDelete()  : PublicActionResult
Mark folder as deleted.
markFolderUnDelete()  : PublicActionResult
Mark folder as undeleted.
markUnDelete()  : PublicActionResult
Mark site as undeleted.
moveFolder()  : PublicActionResult
Move folder.
publication()  : PublicActionResult
Makes site public.
publicationFolder()  : PublicActionResult
Public all folder's breadcrumb.
setRights()  : PublicActionResult
Set rights for site.
setScope()  : PublicActionResult
Sets scope for work with module.
unbindingFromGroup()  : PublicActionResult
Unbinds site with specific socialnetwork group.
unbindingFromMenu()  : PublicActionResult
Unbinds site with specific menu.
unpublic()  : PublicActionResult
Marks site unpublic.
unPublicFolder()  : PublicActionResult
Unpublic all folder's breadcrumb.
update()  : PublicActionResult
Update site.
updateFolder()  : PublicActionResult
Updates folder into the site.
uploadFile()  : PublicActionResult
Upload file by url or from FILE.

Methods

add()

Create new site.

public static add(array<string|int, mixed> $fields) : PublicActionResult
Parameters
$fields : array<string|int, mixed>

Site data.

Return values
PublicActionResult

addFolder()

Creates folder into the site.

public static addFolder(int $siteId, array<string|int, mixed> $fields) : PublicActionResult
Parameters
$siteId : int

Site id.

$fields : array<string|int, mixed>

Folder's fields.

Return values
PublicActionResult

bindingToGroup()

Binds site with specific socialnetwork group.

public static bindingToGroup(int $id, int $groupId) : PublicActionResult
Parameters
$id : int

Site id.

$groupId : int

Group id.

Return values
PublicActionResult

bindingToMenu()

Binds site with specific menu.

public static bindingToMenu(int $id, string $menuCode) : PublicActionResult
Parameters
$id : int

Site id.

$menuCode : string

Menu code.

Return values
PublicActionResult

delete()

Delete site.

public static delete(int $id) : PublicActionResult
Parameters
$id : int

Site id.

Return values
PublicActionResult

fullExport()

Full export of the site.

public static fullExport(int $id[, array<string|int, mixed> $params = array() ]) : PublicActionResult
Parameters
$id : int

Site id.

$params : array<string|int, mixed> = array()

Params array.

Return values
PublicActionResult

getAdditionalFields()

Get additional fields of site.

public static getAdditionalFields(int $id) : PublicActionResult
Parameters
$id : int

Id of site.

Return values
PublicActionResult

getFolders()

Returns folder's list of site.

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

Site id.

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

Folder's filter.

Return values
PublicActionResult

getGroupBindings()

Returns exists bindings.

public static getGroupBindings([int|null $groupId = null ]) : PublicActionResult
Parameters
$groupId : int|null = null

Group id (only for this group).

Return values
PublicActionResult

getList()

Get available sites.

public static getList([array<string|int, mixed> $params = [] ][, string $initiator = null ]) : PublicActionResult
Parameters
$params : array<string|int, mixed> = []

Params ORM array.

$initiator : string = null

Initiator code.

Return values
PublicActionResult

getMenuBindings()

Returns exists bindings.

public static getMenuBindings([string|null $menuCode = null ]) : PublicActionResult
Parameters
$menuCode : string|null = null

Menu code (only for this menu).

Return values
PublicActionResult

getPreview()

Returns site's preview (index page's preview).

public static getPreview(int $id) : PublicActionResult
Parameters
$id : int

Site id.

Return values
PublicActionResult

getPublicUrl()

Gets public url of site (or sites).

public static getPublicUrl(array<string|int, int> $id) : PublicActionResult
Parameters
$id : array<string|int, int>

Site id or array of ids.

Return values
PublicActionResult

getRights()

Get rights about site.

public static getRights(int $id) : PublicActionResult
Parameters
$id : int

Site id.

Return values
PublicActionResult

markDelete()

Mark site as deleted.

public static markDelete(int $id[, bool $mark = true ]) : PublicActionResult
Parameters
$id : int

Site id.

$mark : bool = true

Mark.

Return values
PublicActionResult

markFolderDelete()

Mark folder as deleted.

public static markFolderDelete(int $id[, bool $mark = true ]) : PublicActionResult
Parameters
$id : int

Folder id.

$mark : bool = true

Mark.

Return values
PublicActionResult

markFolderUnDelete()

Mark folder as undeleted.

public static markFolderUnDelete(int $id) : PublicActionResult
Parameters
$id : int

Folder id.

Return values
PublicActionResult

markUnDelete()

Mark site as undeleted.

public static markUnDelete(int $id) : PublicActionResult
Parameters
$id : int

Site id.

Return values
PublicActionResult

moveFolder()

Move folder.

public static moveFolder(int $folderId, int|null $toFolderId[, int|null $toSiteId = null ]) : PublicActionResult
Parameters
$folderId : int

Current folder id.

$toFolderId : int|null

Destination folder id (or null for root folder of current folder's site).

$toSiteId : int|null = null

Destination site id (if different from current).

Return values
PublicActionResult

publication()

Makes site public.

public static publication(int $id[, bool $mark = true ]) : PublicActionResult
Parameters
$id : int

Site id.

$mark : bool = true

Mark.

Return values
PublicActionResult

publicationFolder()

Public all folder's breadcrumb.

public static publicationFolder(int $folderId[, bool $mark = true ]) : PublicActionResult
Parameters
$folderId : int

Folder id.

$mark : bool = true

Publication / depublication.

Return values
PublicActionResult

setRights()

Set rights for site.

public static setRights(int $id[, array<string|int, mixed> $rights = [] ]) : PublicActionResult
Parameters
$id : int

Site id.

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

Array of rights for site.

Return values
PublicActionResult

setScope()

Sets scope for work with module.

public static setScope(string $type) : PublicActionResult
Parameters
$type : string

Scope code.

Return values
PublicActionResult

unbindingFromGroup()

Unbinds site with specific socialnetwork group.

public static unbindingFromGroup(int $id, int $groupId) : PublicActionResult
Parameters
$id : int

Site id.

$groupId : int

Group id.

Return values
PublicActionResult

unbindingFromMenu()

Unbinds site with specific menu.

public static unbindingFromMenu(int $id, string $menuCode) : PublicActionResult
Parameters
$id : int

Site id.

$menuCode : string

Menu code.

Return values
PublicActionResult

unpublic()

Marks site unpublic.

public static unpublic(int $id) : PublicActionResult
Parameters
$id : int

Site id.

Return values
PublicActionResult

unPublicFolder()

Unpublic all folder's breadcrumb.

public static unPublicFolder(int $folderId) : PublicActionResult
Parameters
$folderId : int

Folder id.

Return values
PublicActionResult

update()

Update site.

public static update(int $id, array<string|int, mixed> $fields) : PublicActionResult
Parameters
$id : int

Site id.

$fields : array<string|int, mixed>

Site new data.

Return values
PublicActionResult

updateFolder()

Updates folder into the site.

public static updateFolder(int $siteId, int $folderId, array<string|int, mixed> $fields) : PublicActionResult
Parameters
$siteId : int

Site id.

$folderId : int

Folder id.

$fields : array<string|int, mixed>

Folder's fields.

Return values
PublicActionResult

uploadFile()

Upload file by url or from FILE.

public static uploadFile(int $id, string $picture[, string $ext = false ][, array<string|int, mixed> $params = [] ][, bool $temp = false ]) : PublicActionResult
Parameters
$id : int

Site id.

$picture : string

File url / file array.

$ext : string = false

File extension.

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

Some file params.

$temp : bool = false

This is temporary file.

Return values
PublicActionResult 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results