PHP Class Gush\ThirdParty\Bitbucket\BitBucketClient

Author: Sebastiaan Stok ([email protected])

Mostra file Open project: gushphp/gush Class Usage Examples

Protected Properties

Property	Type	Description
$errorListener	Gush\ThirdParty\Bitbucket\Listener\ErrorListener
$httpClient	Bitbucket\API\Http\Client	The Buzz instance used to communicate with Gitlab.
$options	array
$resultPager	Gush\ThirdParty\Bitbucket\ResultPager
$resultPagerListener	Gush\ThirdParty\Bitbucket\Listener\ResultPagerListener

Public Methods

Method	Description
__construct ( array $options = [], Bitbucket\API\Http\Client $httpClient = null )
apiCommits ( )
apiIssues ( )
apiPullRequests ( )
apiRepositories ( )
apiRepository ( )
apiUser ( )
authenticate ( array $credentials, null \| string $authMethod = self::AUTH_HTTP_PASSWORD )	Authenticates a user.
disableErrorListener ( $permanent = false )
enableListener ( )
getHttpClient ( ) : Bitbucket\API\Http\Client
getOptions ( ) : array
getResultPager ( ) : Gush\ThirdParty\Bitbucket\ResultPager

Method Details

__construct() public method

public __construct ( array $options = [], Bitbucket\API\Http\Client $httpClient = null )
$options	array
$httpClient	Bitbucket\API\Http\Client

apiCommits() public method

public apiCommits ( )

apiIssues() public method

public apiIssues ( )

apiPullRequests() public method

public apiPullRequests ( )

apiRepositories() public method

public apiRepositories ( )

apiRepository() public method

public apiRepository ( )

apiUser() public method

public apiUser ( )

authenticate() public method

Authenticates a user.

public authenticate ( array $credentials, null \| string $authMethod = self::AUTH_HTTP_PASSWORD )
$credentials	array	BitBucket authentication credentials
$authMethod	null \| string	One of the AUTH_* class constants

disableErrorListener() public method

public disableErrorListener ( $permanent = false )

enableListener() public method

public enableListener ( )

getHttpClient() public method

public getHttpClient ( ) : Bitbucket\API\Http\Client
return	Bitbucket\API\Http\Client

getOptions() public method

public getOptions ( ) : array
return	array

getResultPager() public method

public getResultPager ( ) : Gush\ThirdParty\Bitbucket\ResultPager
return	Gush\ThirdParty\Bitbucket\ResultPager

Property Details

$errorListener protected_oe property

protected ErrorListener,Gush\ThirdParty\Bitbucket\Listener $errorListener
return	Gush\ThirdParty\Bitbucket\Listener\ErrorListener

$httpClient protected_oe property

The Buzz instance used to communicate with Gitlab.

protected Client,Bitbucket\API\Http $httpClient
return	Bitbucket\API\Http\Client

$options protected_oe property

protected array $options
return	array

$resultPager protected_oe property

protected ResultPager,Gush\ThirdParty\Bitbucket $resultPager
return	Gush\ThirdParty\Bitbucket\ResultPager

$resultPagerListener protected_oe property

protected ResultPagerListener,Gush\ThirdParty\Bitbucket\Listener $resultPagerListener
return	Gush\ThirdParty\Bitbucket\Listener\ResultPagerListener