1C-Bitrix 25.700.0
Загрузка...
Поиск...
Не найдено
Класс Client

Открытые члены

 __construct ()
 getByOgrn ($ogrn, $showTerminated=false)
 getByInn ($inn, $showTerminated=false)
 searchOrganizationByName ($name, $limit, $offset=0)
 searchIpByName ($name, $secondName, $lastName, $limit, $offset=0)
 uaGetByEdrpou ($edrpou)
 uaGetUoById ($id)
 uaGetFoById ($id)
 uaSearchUoByName ($name, $limit, $offset=0)
 uaSearchFoByName ($name, $limit, $offset=0)
 uaSearchByName ($name, $limit, $offset=0)
 getByBic ($bic)
 isServiceOnline ()
 clearAccessSettings ()
 getErrors ()

Поля данных

const SERVICE_HOST = 'https://properties.bitrix24.tech'
const REST_URI = '/rest/'
const REGISTER_URI = '/oauth/register/'
const SCOPE = 'ps'
const SERVICE_ACCESS_OPTION = 'properties_service_access'
const METHOD_COMMON_GET_BY_INN = 'ps.common.getByInn'
const METHOD_COMMON_GET_BY_OGRN = 'ps.common.getByOgrn'
const METHOD_ORGANIZATION_SEARCH_BY_NAME = 'ps.organization.searchByName'
const METHOD_IP_SEARCH_BY_NAME = 'ps.ip.searchByName'
const METHOD_UA_GET_BY_EDRPOU = 'ps.ua.getByEdrpou'
const METHOD_UA_GET_UO_BY_ID = 'ps.ua.getUoById'
const METHOD_UA_GET_FO_BY_ID = 'ps.ua.getFoById'
const METHOD_UA_SEARCH_UO_BY_NAME = 'ps.ua.searchUoByName'
const METHOD_UA_SEARCH_FO_BY_NAME = 'ps.ua.searchFoByName'
const METHOD_UA_SEARCH_BY_NAME = 'ps.ua.searchByName'
const METHOD_IS_SERVICE_ONLINE = 'ps.common.isOnline'
const METHOD_COMMON_GET_BY_BIC = 'ps.bic.getByBic'
const ERROR_WRONG_INPUT = 1
const ERROR_WRONG_LICENSE = 2
const ERROR_SERVICE_UNAVAILABLE = 3
const ERROR_NOTHING_FOUND = 4

Защищенные члены

 call ($methodName, $additionalParams=null, $licenseCheck=false, $clearAccessSettings=false)
 prepareAnswer ($result)
 register ()
 getAccessSettings ()

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

static setAccessSettings (array $params)
static getRedirectUri ()
static getLicenseHash ()

Защищенные данные

 $httpTimeout = 5
 $accessSettings = null
 $errorCollection

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

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

Конструктор(ы)

◆ __construct()

__construct ( )

Constructor of the client of the properties service.

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

Методы

◆ call()

call ( $methodName,
$additionalParams = null,
$licenseCheck = false,
$clearAccessSettings = false )
protected

Performs call to the REST method and returns decoded results of the call.

Аргументы
string$methodNameName of the REST method.
array$additionalParamsParameters, that should be passed to the method.
bool$licenseCheckShould client send license key as a parameter of the http request.
bool$clearAccessSettingsShould client clear authorization before performing http request.
Возвращает
array|false

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

◆ clearAccessSettings()

clearAccessSettings ( )

Drops current stored access credentials.

Возвращает
void

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

◆ getAccessSettings()

getAccessSettings ( )
protected

Reads and returns access credentials.

Возвращает
array|false Access credentials or false in case of errors.

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

◆ getByBic()

getByBic ( $bic)

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

◆ getByInn()

getByInn ( $inn,
$showTerminated = false )

Returns properties of the organization or individual businessman by its INN code.

Аргументы
string$innINN code of the organization or individual businessman.
Возвращает
array|false

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

◆ getByOgrn()

getByOgrn ( $ogrn,
$showTerminated = false )

Returns properties of the organization or individual businessman by its OGRN code.

Аргументы
string$ogrnOGRN code of the organization or individual businessman.
Возвращает
array|false

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

◆ getErrors()

getErrors ( )

Returns array of errors.

Возвращает
Error[] Errors.

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

◆ getLicenseHash()

getLicenseHash ( )
staticprotected

Returns md5 hash of the license key.

Возвращает
string md5 hash of the license key.

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

◆ getRedirectUri()

getRedirectUri ( )
staticprotected

Internal method for usage in registration process.

Возвращает
string URL of the host.

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

◆ isServiceOnline()

isServiceOnline ( )

Checks service's availability.

Возвращает
bool Returns true if service is ready and false otherwise.

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

◆ prepareAnswer()

prepareAnswer ( $result)
protected

Decodes answer of the method.

Аргументы
string$resultJson-encoded answer.
Возвращает
array|bool|mixed|string Decoded answer.

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

◆ register()

register ( )
protected

Registers client on the properties service.

Возвращает
array|false Access credentials if registration was successful or false otherwise.

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

◆ searchIpByName()

searchIpByName ( $name,
$secondName,
$lastName,
$limit,
$offset = 0 )

Performs search of individual businessmen by name and returns array of found businessmen.

Аргументы
string$nameFirst name (full or partial).
string$secondNameSecond name (full or partial).
string$lastNameLast name (full or partial).
int$limitMaximum size of returning array.
int$offsetOffset of the returning array.
Возвращает
array|false Array of found businessmen or false in case of error.

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

◆ searchOrganizationByName()

searchOrganizationByName ( $name,
$limit,
$offset = 0 )

Performs search of organizations by name and returns array of found organizations.

Аргументы
string$namePart of the organization's name.
int$limitMaximum size of returning array.
int$offsetOffset of the returning array.
Возвращает
array|false Array of found organizations or false in case of error.

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

◆ setAccessSettings()

setAccessSettings ( array $params)
staticprotected

Stores access credentials.

Аргументы
array$paramsAccess credentials.
Возвращает
void

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

◆ uaGetByEdrpou()

uaGetByEdrpou ( $edrpou)

Returns properties of the ukrainian organization by its EDRPOU code.

Аргументы
string$edrpouEDRPOU code of the organization.
Возвращает
array|false

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

◆ uaGetFoById()

uaGetFoById ( $id)

Performs search of ukrainian individual businessmen by identifier and returns its properties.

Аргументы
int$ididenrifier of the individual.
Возвращает
array|false Properties of found individual or false in case of error.

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

◆ uaGetUoById()

uaGetUoById ( $id)

Performs search of ukrainian organization by identifier and returns its properties.

Аргументы
int$ididenrifier of the organization.
Возвращает
array|false Properties of found organization or false in case of error.

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

◆ uaSearchByName()

uaSearchByName ( $name,
$limit,
$offset = 0 )

Performs search of ukrainian organizations and individuals by name and returns array of found organizations and individuals.

Аргументы
string$namePart of the name.
int$limitMaximum size of returning array.
int$offsetOffset of the returning array.
Возвращает
array|false Array of found organizations and individuals or false in case of error.

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

◆ uaSearchFoByName()

uaSearchFoByName ( $name,
$limit,
$offset = 0 )

Performs search of ukrainian individual businessmen by name and returns array of found individuals.

Аргументы
string$namePart of the individual's name.
int$limitMaximum size of returning array.
int$offsetOffset of the returning array.
Возвращает
array|false Array of found individuals or false in case of error.

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

◆ uaSearchUoByName()

uaSearchUoByName ( $name,
$limit,
$offset = 0 )

Performs search of ukrainian organizations by name and returns array of found organizations.

Аргументы
string$namePart of the organization's name.
int$limitMaximum size of returning array.
int$offsetOffset of the returning array.
Возвращает
array|false Array of found organizations or false in case of error.

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

Поля

◆ $accessSettings

$accessSettings = null
protected

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

◆ $errorCollection

$errorCollection
protected

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

◆ $httpTimeout

$httpTimeout = 5
protected

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

◆ ERROR_NOTHING_FOUND

const ERROR_NOTHING_FOUND = 4

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

◆ ERROR_SERVICE_UNAVAILABLE

const ERROR_SERVICE_UNAVAILABLE = 3

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

◆ ERROR_WRONG_INPUT

const ERROR_WRONG_INPUT = 1

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

◆ ERROR_WRONG_LICENSE

const ERROR_WRONG_LICENSE = 2

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

◆ METHOD_COMMON_GET_BY_BIC

const METHOD_COMMON_GET_BY_BIC = 'ps.bic.getByBic'

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

◆ METHOD_COMMON_GET_BY_INN

const METHOD_COMMON_GET_BY_INN = 'ps.common.getByInn'

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

◆ METHOD_COMMON_GET_BY_OGRN

const METHOD_COMMON_GET_BY_OGRN = 'ps.common.getByOgrn'

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

◆ METHOD_IP_SEARCH_BY_NAME

const METHOD_IP_SEARCH_BY_NAME = 'ps.ip.searchByName'

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

◆ METHOD_IS_SERVICE_ONLINE

const METHOD_IS_SERVICE_ONLINE = 'ps.common.isOnline'

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

◆ METHOD_ORGANIZATION_SEARCH_BY_NAME

const METHOD_ORGANIZATION_SEARCH_BY_NAME = 'ps.organization.searchByName'

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

◆ METHOD_UA_GET_BY_EDRPOU

const METHOD_UA_GET_BY_EDRPOU = 'ps.ua.getByEdrpou'

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

◆ METHOD_UA_GET_FO_BY_ID

const METHOD_UA_GET_FO_BY_ID = 'ps.ua.getFoById'

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

◆ METHOD_UA_GET_UO_BY_ID

const METHOD_UA_GET_UO_BY_ID = 'ps.ua.getUoById'

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

◆ METHOD_UA_SEARCH_BY_NAME

const METHOD_UA_SEARCH_BY_NAME = 'ps.ua.searchByName'

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

◆ METHOD_UA_SEARCH_FO_BY_NAME

const METHOD_UA_SEARCH_FO_BY_NAME = 'ps.ua.searchFoByName'

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

◆ METHOD_UA_SEARCH_UO_BY_NAME

const METHOD_UA_SEARCH_UO_BY_NAME = 'ps.ua.searchUoByName'

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

◆ REGISTER_URI

const REGISTER_URI = '/oauth/register/'

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

◆ REST_URI

const REST_URI = '/rest/'

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

◆ SCOPE

const SCOPE = 'ps'

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

◆ SERVICE_ACCESS_OPTION

const SERVICE_ACCESS_OPTION = 'properties_service_access'

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

◆ SERVICE_HOST

const SERVICE_HOST = 'https://properties.bitrix24.tech'

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


Объявления и описания членов класса находятся в файле:
  • C:/bitrix/modules/socialservices/lib/properties/client.php