Bitrix API

Service extends Service

Class Service

Table of Contents

Constants

GROUP  = 'webmaster'
METHOD_PREFIX  = 'webmaster'
TYPE_FACEBOOK  = 'facebook'
TYPE_GOOGLE  = 'google'
TYPE_MYCOM  = 'mycom'
TYPE_VKONTAKTE  = 'vkontakte'
TYPE_YANDEX  = 'yandex'

Methods

addSite()  : array<string|int, mixed>|array<string|int, true>
Add site to webmaster
canUseAsInternal()  : bool
check if service can use as internal
canUseMultipleClients()  : bool
Can use multiple clients
getAccount()  : Account
getAudience()  : Audience
getAuthAdapter()  : AuthAdapter
Get auth adapter.
getClientId()  : string
Get client id
getEngineCode()  : string
getInstance()  : static
Get instance.
getMethodPrefix()  : string
get seoproxy method prefix
getSites()  : array<string|int, mixed>
Get list of added sites with statuses
getTypeByEngine()  : string|null
get type by engineCode
getTypes()  : array<string|int, mixed>
Get type list.
getVerifyToken()  : array<string|int, mixed>|array<string|int, string>
Get token-string for naming verify file
setClientId()  : void
Set client id.
verifySite()  : array<string|int, mixed>|array<string|int, string>|array<string|int, true>
Pass site to verify

Constants

GROUP

public mixed GROUP = 'webmaster'

METHOD_PREFIX

public mixed METHOD_PREFIX = 'webmaster'

TYPE_FACEBOOK

public mixed TYPE_FACEBOOK = 'facebook'

TYPE_GOOGLE

public mixed TYPE_GOOGLE = 'google'

TYPE_MYCOM

public mixed TYPE_MYCOM = 'mycom'

TYPE_VKONTAKTE

public mixed TYPE_VKONTAKTE = 'vkontakte'

TYPE_YANDEX

public mixed TYPE_YANDEX = 'yandex'

Methods

addSite()

Add site to webmaster

public static addSite(string $domain[, string $dir = '/' ]) : array<string|int, mixed>|array<string|int, true>
Parameters
$domain : string
  • site domain
$dir : string = '/'
  • subdir
Tags
throws
SystemException
Return values
array<string|int, mixed>|array<string|int, true>

canUseAsInternal()

check if service can use as internal

public static canUseAsInternal() : bool
Tags
inheritDoc
Return values
bool

canUseMultipleClients()

Can use multiple clients

public static canUseMultipleClients() : bool
Return values
bool

getAccount()

public static getAccount(string $type) : Account
Parameters
$type : string

Engine type.

Return values
Account

getAudience()

public static getAudience(string $type) : Audience
Parameters
$type : string

Engine type.

Return values
Audience

getAuthAdapter()

Get auth adapter.

public static getAuthAdapter(string $type) : AuthAdapter
Parameters
$type : string

Type.

Return values
AuthAdapter

getClientId()

Get client id

public getClientId() : string
Return values
string

getEngineCode()

public static getEngineCode(string $type) : string
Parameters
$type : string

Engine type.

Return values
string

getInstance()

Get instance.

public static getInstance() : static
Return values
static

getMethodPrefix()

get seoproxy method prefix

public static getMethodPrefix() : string
Tags
inheritDoc
Return values
string

getSites()

Get list of added sites with statuses

public static getSites() : array<string|int, mixed>
Tags
throws
SystemException
Return values
array<string|int, mixed>

getTypeByEngine()

get type by engineCode

public static getTypeByEngine(string $engineCode) : string|null
Parameters
$engineCode : string
Tags
inheritDoc
Return values
string|null

getTypes()

Get type list.

public static getTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getVerifyToken()

Get token-string for naming verify file

public static getVerifyToken(string $domain[, string $dir = '/' ]) : array<string|int, mixed>|array<string|int, string>
Parameters
$domain : string
  • site domain
$dir : string = '/'
  • subdir
Tags
throws
ArgumentException
throws
SystemException
Return values
array<string|int, mixed>|array<string|int, string>

setClientId()

Set client id.

public setClientId(string $clientId) : void
Parameters
$clientId : string

Client id.

verifySite()

Pass site to verify

public static verifySite(string $domain[, string $dir = '/' ]) : array<string|int, mixed>|array<string|int, string>|array<string|int, true>
Parameters
$domain : string
  • site domain
$dir : string = '/'
  • subdir
Tags
throws
ArgumentException
throws
SystemException
Return values
array<string|int, mixed>|array<string|int, string>|array<string|int, true> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results