Открытые статические члены
static	isRegistered ()
static	getAuth (string $engineCode)
static	getClientList ($engineCode=false, string $type=null)
static	clearLocalAuth ()
static	clearClientsCache ($engine=null, $clientId=null)
static	clearAuth ($engineCode, $localOnly=false)
static	clearAuthForClient ($client, $localOnly=false)
static	getEngine (?Request $request=null)
static	register (string $serviceUrl='')
static	unregister ()
static	getAuthorizeLink ()
static	getAuthorizeData ($engine, $clientType=false)
static	changeRegisteredDomain (array $domains=[])

Поля данных
const	SERVICE_URL = SEO_SERVICE_URL
const	REGISTER = "/oauth/register/"
const	AUTHORIZE = "/register/"
const	REDIRECT_URI = "/bitrix/tools/seo_client.php"
const	SERVICE_AUTH_CACHE_TLL = 86400
const	SERVICE_AUTH_CACHE_TLL_ERROR = 3600
const	SERVICE_AUTH_CACHE_ID = 'seo\|service_auth'
const	SERVICE_AUTH_CACHE_ID_ERROR = 'seo\|service_auth_error'
const	CLIENT_LIST_CACHE_TLL = 86400
const	CLIENT_LIST_CACHE_ID = 'seo\|client_list\|2'
const	CLIENT_TYPE_SINGLE = 'S'
const	CLIENT_TYPE_MULTIPLE = 'M'
const	CLIENT_TYPE_COMPATIBLE = 'C'

Защищенные статические члены
static	setAccessSettings (array $accessParams)
static	getRedirectUri ()
static	getLicense ()

Статические защищенные данные
static	$engine = null
static	$auth = null
static	$clientList = null

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

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

Методы

◆ changeRegisteredDomain()

changeRegisteredDomain ( array $domains = [] )

static

If site change domain - need update engine

Аргументы

array $domains

Исключения

Exception

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

◆ clearAuth()

clearAuth	(		$engineCode,
			$localOnly = false )

static

Аргументы

string	$engineCode	Provider code.
bool	$localOnly	Do not delete client in seoproxy service.

Возвращает: void @use \Bitrix\Seo\Service::clearAuthForClient(...)

Исключения

SystemException

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

◆ clearAuthForClient()

clearAuthForClient	(		$client,
			$localOnly = false )

static

Remove auth for a client

Аргументы

array	$client	Client data.
bool	$localOnly	Only clear cache.

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

Исключения

SystemException

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

◆ clearClientsCache()

clearClientsCache	(		$engine = null,
			$clientId = null )

static

Clear clients list cache

Аргументы

string \| null	$engine	Engine code.
int \| null	$clientId	Proxy client id.

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

Исключения

SystemException

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

◆ clearLocalAuth()

clearLocalAuth ( )

static

Возвращает: void @use \Bitrix\Seo\Service::clearClientsCache()

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

◆ getAuth()

getAuth ( string $engineCode )

static

Get client info @use \Bitrix\Seo\Service::getClientList(...)

Аргументы

string $engineCode Provider code.

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

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

◆ getAuthorizeData()

getAuthorizeData	(		$engine,
			$clientType = false )

static

Аргументы

string	$engine	Provider code.
bool	$clientType	Client type.

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

Исключения

Bitrix\Main\LoaderException

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

◆ getAuthorizeLink()

getAuthorizeLink ( )

static

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

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

◆ getClientList()

getClientList	(		$engineCode = false,
		string	$type = null )

static

Get clients list

Аргументы

string | bool $engineCode Provider code.

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

Исключения

SystemException

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

◆ getEngine()

getEngine ( ?Request $request = null )

static

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

Исключения

LoaderException

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

◆ getLicense()

getLicense ( )

staticprotected

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

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

◆ getRedirectUri()

getRedirectUri ( )

staticprotected

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

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

◆ isRegistered()

isRegistered ( )

static

CAn connect to seoproxy?

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

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

◆ register()

register ( string $serviceUrl = '' )

static

Try to register at external seoproxy service

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

Исключения

SystemException

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

◆ setAccessSettings()

setAccessSettings ( array $accessParams )

staticprotected

Set access settings

Аргументы

array $accessParams Access params.

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

Исключения

SystemException

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

◆ unregister()

unregister ( )

static

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

Исключения

SystemException

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

Поля

◆ $auth

$auth = null

staticprotected

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

◆ $clientList

$clientList = null

staticprotected

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

◆ $engine

$engine = null

staticprotected

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

◆ AUTHORIZE

const AUTHORIZE = "/register/"

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

◆ CLIENT_LIST_CACHE_ID

const CLIENT_LIST_CACHE_ID = 'seo|client_list|2'

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

◆ CLIENT_LIST_CACHE_TLL

const CLIENT_LIST_CACHE_TLL = 86400

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

◆ CLIENT_TYPE_COMPATIBLE

const CLIENT_TYPE_COMPATIBLE = 'C'

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

◆ CLIENT_TYPE_MULTIPLE

const CLIENT_TYPE_MULTIPLE = 'M'

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

◆ CLIENT_TYPE_SINGLE

const CLIENT_TYPE_SINGLE = 'S'

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

◆ REDIRECT_URI

const REDIRECT_URI = "/bitrix/tools/seo_client.php"

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

◆ REGISTER

const REGISTER = "/oauth/register/"

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

◆ SERVICE_AUTH_CACHE_ID

const SERVICE_AUTH_CACHE_ID = 'seo|service_auth'

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

◆ SERVICE_AUTH_CACHE_ID_ERROR

const SERVICE_AUTH_CACHE_ID_ERROR = 'seo|service_auth_error'

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

◆ SERVICE_AUTH_CACHE_TLL

const SERVICE_AUTH_CACHE_TLL = 86400

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

◆ SERVICE_AUTH_CACHE_TLL_ERROR

const SERVICE_AUTH_CACHE_TLL_ERROR = 3600

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

◆ SERVICE_URL

const SERVICE_URL = SEO_SERVICE_URL

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

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

C:/bitrix/modules/seo/lib/service.php

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

Поля данных

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

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

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

Методы

◆ changeRegisteredDomain()

◆ clearAuth()

◆ clearAuthForClient()

◆ clearClientsCache()

◆ clearLocalAuth()

◆ getAuth()

◆ getAuthorizeData()

◆ getAuthorizeLink()

◆ getClientList()

◆ getEngine()

◆ getLicense()

◆ getRedirectUri()

◆ isRegistered()

◆ register()

◆ setAccessSettings()

◆ unregister()

Поля

◆ $auth

◆ $clientList

◆ $engine

◆ AUTHORIZE

◆ CLIENT_LIST_CACHE_ID

◆ CLIENT_LIST_CACHE_TLL

◆ CLIENT_TYPE_COMPATIBLE

◆ CLIENT_TYPE_MULTIPLE

◆ CLIENT_TYPE_SINGLE

◆ REDIRECT_URI

◆ REGISTER

◆ SERVICE_AUTH_CACHE_ID

◆ SERVICE_AUTH_CACHE_ID_ERROR

◆ SERVICE_AUTH_CACHE_TLL

◆ SERVICE_AUTH_CACHE_TLL_ERROR

◆ SERVICE_URL