Bitrix API

Site24

Table of Contents

Methods

activateDomain()  : mixed
Activate domain by name.
addDomain()  : mixed
Add new domain.
addRandomDomain()  : mixed
Add domain with random name.
deleteDomain()  : mixed
Delete domain by name.
isDomainExists()  : mixed
Exist or not domain.
updateDomain()  : mixed
Update domain by name.

Methods

activateDomain()

Activate domain by name.

public static activateDomain(string $domain[, string $active = 'Y' ][, string $lang = '' ]) : mixed
Parameters
$domain : string

Domain name.

$active : string = 'Y'

Activate (Y) or deactivate (N).

$lang : string = ''

Lang code.

Tags
throws
SystemException

addDomain()

Add new domain.

public static addDomain(string $domain, string $url[, mixed $active = 'Y' ][, mixed $type = 'site' ][, string $lang = '' ]) : mixed
Parameters
$domain : string

Domain name.

$url : string

Local url of site.

$active : mixed = 'Y'
$type : mixed = 'site'
$lang : string = ''

Lang code.

Tags
throws
SystemException

addRandomDomain()

Add domain with random name.

public static addRandomDomain(string $url[, string $type = 'site' ][, string $lang = '' ]) : mixed
Parameters
$url : string

Local url of site.

$type : string = 'site'

Site type.

$lang : string = ''

Lang code.

Tags
throws
SystemException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException

deleteDomain()

Delete domain by name.

public static deleteDomain(string $domain) : mixed
Parameters
$domain : string

Domain name.

Tags
throws
SystemException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException

isDomainExists()

Exist or not domain.

public static isDomainExists(string $domain) : mixed

0 - domain name is available 1 - domain name is not available, but you are owner 2 - domain name is not available

Parameters
$domain : string

Domain name.

Tags
throws
SystemException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException

updateDomain()

Update domain by name.

public static updateDomain(string $domain, string $newName, string $url) : mixed
Parameters
$domain : string

Current domain name.

$newName : string

New domain name.

$url : string

Local url of site.

Tags
throws
SystemException

        
On this page

Search results