PHP Class Bitrix24\Stub\Bitrix24

Inheritance: implements Bitrix24\Contracts\iBitrix24
Afficher le fichier Open project: mesilov/bitrix24-php-sdk

Méthodes publiques

Méthode Description
__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 ( ) : array 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 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 ( $microseconds = 1000000 ) : boolean set retries to connect timeout in microseconds

Method Details

__construct() public méthode

Create a object to work with Bitrix24 REST API service
public __construct ( boolean $isSaveRawResponse = false, Psr\Log\LoggerInterface $obLogger = null ) : Bitrix24
$isSaveRawResponse boolean - if true raw response from bitrix24 will be available from method getRawResponse, this is debug mode
$obLogger Psr\Log\LoggerInterface - instance of \Monolog\Logger
Résultat Bitrix24

call() public méthode

Execute Bitrix24 REST API method
public call ( string $methodName, array $additionalParameters = [] ) : array
$methodName string
$additionalParameters array
Résultat array

getAccessToken() public méthode

Get access token
public getAccessToken ( ) : string | null
Résultat string | null | null

getApplicationId() public méthode

Get application id
public getApplicationId ( ) : string
Résultat string

getApplicationScope() public méthode

Get application scope
public getApplicationScope ( ) : array
Résultat array

getApplicationSecret() public méthode

Get application secret
public getApplicationSecret ( ) : string
Résultat string

getAvailableMethods() public méthode

Get list of all methods available for current application
public getAvailableMethods ( array $applicationScope = [], boolean $isFull = false ) : array
$applicationScope array
$isFull boolean
Résultat array

getDomain() public méthode

Get domain
public getDomain ( ) : string | null
Résultat string | null | null

getFirstAccessToken() public méthode

Authorize and get first access token
public getFirstAccessToken ( $code ) : array
$code
Résultat array

getMemberId() public méthode

Get memeber ID
public getMemberId ( ) : string | null
Résultat string | null | null

getMethodParameters() public méthode

Return additional parameters of last api-call. Data available after you try to call method call
public getMethodParameters ( ) : array | null
Résultat array | null | null

getNewAccessToken() public méthode

Get new access token
public getNewAccessToken ( ) : array
Résultat array

getRawRequest() public méthode

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
public getRawRequest ( ) : array | null
Résultat array | null | null

getRawResponse() public méthode

To activate debug mode you must before set to true flag isSaveRawResponse in class construct
public getRawResponse ( ) : string
Résultat string

getRedirectUri() public méthode

Get redirect URI
public getRedirectUri ( ) : string | null
Résultat string | null | null

getRefreshToken() public méthode

Get refresh token
public getRefreshToken ( ) : string
Résultat string

getRequestInfo() public méthode

Return result from function curl_getinfo. Data available after you try to call method call
public getRequestInfo ( ) : array | null
Résultat array | null | null

getRetriesToConnectCount() public méthode

get CURL request count retries
public getRetriesToConnectCount ( ) : integer
Résultat integer

getRetriesToConnectTimeout() public méthode

get retries to connect timeout in microseconds
public getRetriesToConnectTimeout ( ) : mixed
Résultat mixed

getScope() public méthode

get list of scope for current application from bitrix24 api
public getScope ( boolean $isFull = false ) : array
$isFull boolean
Résultat array

getSecuritySignSalt() public méthode

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
public getSecuritySignSalt ( ) : integer
Résultat integer

isAccessTokenExpire() public méthode

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
public isAccessTokenExpire ( ) : boolean
Résultat boolean

setAccessToken() public méthode

Set access token
public setAccessToken ( string $accessToken ) : true
$accessToken string
Résultat true

setApplicationId() public méthode

Set application id
public setApplicationId ( string $applicationId ) : true
$applicationId string
Résultat true

setApplicationScope() public méthode

Set application scope
public setApplicationScope ( array $applicationScope ) : boolean
$applicationScope array
Résultat boolean

setApplicationSecret() public méthode

Set application secret
public setApplicationSecret ( string $applicationSecret ) : true;
$applicationSecret string
Résultat true;

setCustomCurlOptions() public méthode

Set custom cURL options, overriding default ones
See link: http://php.net/manual/en/function.curl-setopt.php
public setCustomCurlOptions ( array $options ) : boolean
$options array - array(CURLOPT_XXX => value1, CURLOPT_XXX2 => value2,...)
Résultat boolean

setDomain() public méthode

Set domain
public setDomain ( $domain ) : true
$domain
Résultat true

setMemberId() public méthode

Set member ID — portal GUID
public setMemberId ( string $memberId ) : true;
$memberId string
Résultat true;

setRedirectUri() public méthode

Set redirect URI
public setRedirectUri ( string $redirectUri ) : true;
$redirectUri string
Résultat true;

setRefreshToken() public méthode

Set refresh token
public setRefreshToken ( $refreshToken ) : true;
$refreshToken
Résultat true;

setRetriesToConnectCount() public méthode

set CURL request count retries
public setRetriesToConnectCount ( $retriesCnt = 1 ) : boolean
$retriesCnt
Résultat boolean

setRetriesToConnectTimeout() public méthode

set retries to connect timeout in microseconds
public setRetriesToConnectTimeout ( $microseconds = 1000000 ) : boolean
$microseconds
Résultat boolean