Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Service

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

static isRegistered ()
 
static getAuth (string $engineCode)
 
static getClientList ($engineCode=false)
 
static clearLocalAuth ()
 
static clearClientsCache ($engine=null, $clientId=null)
 
static clearAuth ($engineCode, $localOnly=false)
 
static clearAuthForClient ($client, $localOnly=false)
 
static getEngine ()
 
static register ()
 
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 строка 32

Методы

◆ changeRegisteredDomain()

static changeRegisteredDomain ( array $domains = [])
static

If site change domain - need update engine

Аргументы
array$domains
Исключения

Exception

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

◆ clearAuth()

static clearAuth ( $engineCode,
$localOnly = false )
static
Аргументы
string$engineCodeProvider code.
bool$localOnlyDo not delete client in seoproxy service.
Возвращает
void @use \Bitrix\Seo\Service::clearAuthForClient(...)
Исключения
SystemException

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

◆ clearAuthForClient()

static clearAuthForClient ( $client,
$localOnly = false )
static

Remove auth for a client

Аргументы
array$clientClient data.
bool$localOnlyOnly clear cache.
Возвращает
void
Исключения
SystemException

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

◆ clearClientsCache()

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

Clear clients list cache

Аргументы
string | null$engineEngine code.
int | null$clientIdProxy client id.
Возвращает
void
Исключения
SystemException

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

◆ clearLocalAuth()

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

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

◆ getAuth()

static getAuth ( string $engineCode)
static

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

Аргументы
string$engineCodeProvider code.
Возвращает
boolean|array

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

◆ getAuthorizeData()

static getAuthorizeData ( $engine,
$clientType = false )
static
Аргументы
string$engineProvider code.
bool$clientTypeClient type.
Возвращает
array
Исключения

Bitrix\Main\LoaderException

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

◆ getAuthorizeLink()

static getAuthorizeLink ( )
static
Возвращает
string

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

◆ getClientList()

static getClientList ( $engineCode = false)
static

Get clients list

Аргументы
string | bool$engineCodeProvider code.
Возвращает
array
Исключения
SystemException

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

◆ getEngine()

static getEngine ( )
static
Возвращает
\Bitrix\Seo\Engine\Bitrix

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

◆ getLicense()

static getLicense ( )
staticprotected
Возвращает
string

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

◆ getRedirectUri()

static getRedirectUri ( )
staticprotected
Возвращает
string

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

◆ isRegistered()

static isRegistered ( )
static

CAn connect to seoproxy?

Возвращает
bool

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

◆ register()

static register ( )
static
Возвращает
void
Исключения
SystemException

Bitrix\Main\ArgumentException

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

◆ setAccessSettings()

static setAccessSettings ( array $accessParams)
staticprotected

Set access settings

Аргументы
array$accessParamsAccess params.
Возвращает
void
Исключения
SystemException

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

◆ unregister()

static unregister ( )
static
Возвращает
void
Исключения
SystemException

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

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

◆ $auth

$auth = null
staticprotected

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

◆ $clientList

$clientList = null
staticprotected

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

◆ $engine

$engine = null
staticprotected

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

◆ AUTHORIZE

const AUTHORIZE = "/register/"

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

◆ CLIENT_LIST_CACHE_ID

const CLIENT_LIST_CACHE_ID = 'seo|client_list|2'

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

◆ CLIENT_LIST_CACHE_TLL

const CLIENT_LIST_CACHE_TLL = 86400

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

◆ CLIENT_TYPE_COMPATIBLE

const CLIENT_TYPE_COMPATIBLE = 'C'

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

◆ CLIENT_TYPE_MULTIPLE

const CLIENT_TYPE_MULTIPLE = 'M'

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

◆ CLIENT_TYPE_SINGLE

const CLIENT_TYPE_SINGLE = 'S'

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

◆ REDIRECT_URI

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

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

◆ REGISTER

const REGISTER = "/oauth/register/"

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

◆ SERVICE_AUTH_CACHE_ID

const SERVICE_AUTH_CACHE_ID = 'seo|service_auth'

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

◆ SERVICE_AUTH_CACHE_ID_ERROR

const SERVICE_AUTH_CACHE_ID_ERROR = 'seo|service_auth_error'

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

◆ SERVICE_AUTH_CACHE_TLL

const SERVICE_AUTH_CACHE_TLL = 86400

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

◆ SERVICE_AUTH_CACHE_TLL_ERROR

const SERVICE_AUTH_CACHE_TLL_ERROR = 3600

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

◆ SERVICE_URL

const SERVICE_URL = SEO_SERVICE_URL

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