• 홈
• Bitrix24
• Bitrix24

PHP 클래스 Bitrix24\Bitrix24

파일 보기 프로젝트 열기: mesilov/bitrix24-php-sdk 1 사용 예제들

보호된 프로퍼티들

프로퍼티	타입	설명
$accessToken		access token
$applicationId		application id
$applicationScope		scope
$applicationSecret		application secret
$customCurlOptions		custom options for cURL
$domain		domain
$isSaveRawResponse		if true raw response from bitrix24 will be available from method getRawResponse, this is debug mode
$log		PSR-3 compatible logger, use only from wrappers methods log*
$memberId		portal GUID
$methodParameters
$rawRequest		raw request, contain all cURL options array and API query
$rawResponse		raw response from bitrix24
$redirectUri		redirect URI from application settings
$refreshToken		refresh token
$requestInfo		request info data structure акщь curl_getinfo function
$retriesToConnectCount		CURL request count retries
$retriesToConnectTimeout		retries to connect timeout in microseconds

공개 메소드들

메소드	설명
__construct ( boolean $isSaveRawResponse = false, Psr\Log\LoggerInterface $obLogger = null ) : Bitrix24	Create a object to work with Bitrix24 REST API service
call ( string $methodName, array $additionalParameters = [] ) : array	Execute Bitrix24 REST API method
getAccessToken ( ) : string | null	Get access token
getApplicationId ( ) : string	Get application id
getApplicationScope ( ) : string	Get application scope
getApplicationSecret ( ) : string	Get application secret
getAvailableMethods ( array $applicationScope = [], boolean $isFull = false ) : array	Get list of all methods available for current application
getDomain ( ) : string | null	Get domain
getFirstAccessToken ( $code ) : array	Authorize and get first access token
getMemberId ( ) : string | null	Get memeber ID
getMethodParameters ( ) : array | null	Return additional parameters of last api-call. Data available after you try to call method call
getNewAccessToken ( ) : array	Get new access token
getRawRequest ( ) : array | null	Return raw request, contain all cURL options array and API query. Data available after you try to call method call numbers of array keys is const of cURL module. Example: CURLOPT_RETURNTRANSFER = 19913
getRawResponse ( ) : string | null	Get raw response from Bitrix24 before json_decode call, method available only in debug mode.
getRedirectUri ( ) : string | null	Get redirect URI
getRefreshToken ( ) : string	Get refresh token
getRequestInfo ( ) : array | null	Return result from function curl_getinfo. Data available after you try to call method call
getRetriesToConnectCount ( ) : integer	get CURL request count retries
getRetriesToConnectTimeout ( ) : mixed	get retries to connect timeout in microseconds
getScope ( boolean $isFull = false ) : array	get list of scope for current application from bitrix24 api
getSecuritySignSalt ( ) : integer	Get a random string to sign protected api-call. Use salt for argument "state" in secure api-call random string is a result of mt_rand function
isAccessTokenExpire ( ) : boolean	Check is access token expire, call list of all available api-methods from B24 portal with current access token if we have an error code expired_token then return true else return false
setAccessToken ( string $accessToken ) : true	Set access token
setApplicationId ( string $applicationId ) : true;	Set application id
setApplicationScope ( array $applicationScope ) : boolean	Set application scope
setApplicationSecret ( string $applicationSecret ) : true;	Set application secret
setCustomCurlOptions ( array $options ) : boolean	Set custom cURL options, overriding default ones
setDomain ( $domain ) : true;	Set domain
setMemberId ( string $memberId ) : true	Set member ID — portal GUID
setRedirectUri ( string $redirectUri ) : true;	Set redirect URI
setRefreshToken ( $refreshToken ) : true;	Set refresh token
setRetriesToConnectCount ( $retriesCnt = 1 ) : boolean	set CURL request count retries
setRetriesToConnectTimeout ( integer $microseconds = 1000000 ) : boolean	set retries to connect timeout in microseconds

보호된 메소드들

메소드	설명
executeRequest ( string $url, array $additionalParameters = [] ) : array	Execute a request API to Bitrix24 using cURL
getErrorContext ( ) : array	get error context
handleBitrix24APILevelErrors ( $arRequestResult, $methodName, array $additionalParameters = [] ) : null	Handling bitrix24 api-level errors

메소드 상세

프로퍼티 상세