PHP Class Fragen\GitHub_Updater\Bitbucket_API

Get remote data from a Bitbucket repo.
Author: Andy Fragen
Inheritance: extends API
Datei anzeigen Open project: afragen/github-updater

Public Methods

Method Description
__construct ( object $type ) Constructor.
ajax_maybe_authenticate_http ( $args, $url ) : mixed Add Basic Authentication $args to http_request_args filter hook for private Bitbucket repositories only during AJAX.
construct_download_link ( boolean $rollback = false, boolean $branch_switch = false ) : string Construct $this->type->download_link using Bitbucket API
get_language_pack ( array $headers ) : boolean Get/process Language Packs.
get_remote_branches ( ) : boolean Create array of branches and download links as array.
get_remote_changes ( $changes ) : boolean Read the remote CHANGES.md file
get_remote_info ( $file ) : boolean Read the remote file and parse headers.
get_remote_readme ( ) : boolean Read and parse remote readme.txt.
get_remote_tag ( ) : boolean Get the remote info to for tags.
get_repo_meta ( ) : boolean Read the repository meta from API
http_release_asset_auth ( $args, $url ) : mixed Removes Basic Authentication header for Bitbucket Release Assets.
load_hooks ( ) Load hooks for Bitbucket authentication headers.
maybe_authenticate_http ( $args, $url ) : mixed Add Basic Authentication $args to http_request_args filter hook for private Bitbucket repositories only.
remove_hooks ( ) Remove hooks for Bitbucket authentication headers.

Protected Methods

Method Description
add_endpoints ( $git, $endpoint ) Added due to abstract class designation, not used for Bitbucket.
parse_changelog_response ( object $response ) : array | object Parse API response and return array with changelog in base64.
parse_meta_response ( object $response ) : array Parse API response and return array of meta variables.
parse_tag_response ( object $response ) : array | object Parse API response call and return only array of tag numbers.

Method Details

__construct() public method

Constructor.
public __construct ( object $type )
$type object

add_endpoints() protected method

Added due to abstract class designation, not used for Bitbucket.
protected add_endpoints ( $git, $endpoint )
$git
$endpoint

ajax_maybe_authenticate_http() public method

Add Basic Authentication $args to http_request_args filter hook for private Bitbucket repositories only during AJAX.
public ajax_maybe_authenticate_http ( $args, $url ) : mixed
$args
$url
return mixed

get_language_pack() public method

Get/process Language Packs.
public get_language_pack ( array $headers ) : boolean
$headers array Array of headers of Language Pack.
return boolean When invalid response.

get_remote_branches() public method

Create array of branches and download links as array.
public get_remote_branches ( ) : boolean
return boolean

get_remote_changes() public method

Read the remote CHANGES.md file
public get_remote_changes ( $changes ) : boolean
$changes
return boolean

get_remote_info() public method

Read the remote file and parse headers.
public get_remote_info ( $file ) : boolean
$file
return boolean

get_remote_readme() public method

Read and parse remote readme.txt.
public get_remote_readme ( ) : boolean
return boolean

get_remote_tag() public method

Get the remote info to for tags.
public get_remote_tag ( ) : boolean
return boolean

get_repo_meta() public method

Read the repository meta from API
public get_repo_meta ( ) : boolean
return boolean

http_release_asset_auth() public method

Storage in AmazonS3 buckets, uses Query String Request Authentication Alternative.
See link: http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html#RESTAuthenticationQueryStringAuth
public http_release_asset_auth ( $args, $url ) : mixed
$args
$url
return mixed

load_hooks() public method

Load hooks for Bitbucket authentication headers.
public load_hooks ( )

maybe_authenticate_http() public method

Add Basic Authentication $args to http_request_args filter hook for private Bitbucket repositories only.
public maybe_authenticate_http ( $args, $url ) : mixed
$args
$url
return mixed $args

parse_changelog_response() protected method

Parse API response and return array with changelog in base64.
protected parse_changelog_response ( object $response ) : array | object
$response object Response from API call.
return array | object $arr Array of changes in base64, object if error.

parse_meta_response() protected method

Parse API response and return array of meta variables.
protected parse_meta_response ( object $response ) : array
$response object Response from API call.
return array $arr Array of meta variables.

parse_tag_response() protected method

Parse API response call and return only array of tag numbers.
protected parse_tag_response ( object $response ) : array | object
$response object Response from API call.
return array | object Array of tag numbers, object is error.

remove_hooks() public method

Remove hooks for Bitbucket authentication headers.
public remove_hooks ( )