README

The library makes it easy to handle bitbucket webhooks.

Example

use Dbogdanoff\Bitbucket;

// Repository events (Push, Fork, Updated, Commit, ...) 
$repo = new Bitbucket\Repo();
$push = $repo->getPush(); // array
$fork = $repo->getFork(); // array
$branch = $repo->getBranch(); // string
$changes = $repo->getChanges(); // array — 'changes' from root or 'changes' key from 'push'
$authorNickName = $repo->getAuthorNickName(); // string

// Issue events (Created, Updated, Comment created)
$issue = new Bitbucket\Issue();
$issue = $issue->getIssue(); // array

// Pull request events (Created, Updated, Change, ...)
$pullRequest = new Bitbucket\PullRequest();
$title = $pullRequest->getTitle(); // string
$link = $pullRequest->getLink(); // string
$data = $pullRequest->getPullRequest(); // array
$author = $pullRequest->getAuthor(); // array
$authorNickName = $pullRequest->getAuthorNickName(); // string
$commentText = $pullRequest->getCommentText(); // string
$commentInlinePath = $pullRequest->getCommentInlinePath(); // string
$commentInlineNumber = $pullRequest->getCommentInlineNumber(); // string

// All objects extended from Bitbucket\Base()
$actor = $repo->getActor(); // array
$nickname = $repo->getNickName(); // string
$repository = $repo->getRepository(); // array
$projectName = $repo->getProjectName(); // string
$eventType = $repo->getEventKey(); // string — repo:push, repo:updated, pullrequest:created, ...
$rawData = $repo->getRawData(); // array — full data

Exceptions

// Bitbucket\Repo::__construct()
if (strpos($_SERVER['HTTP_X_EVENT_KEY'], 'repo:') === false) {
    throw new Exception('Invalid request type');
}

// Bitbucket\Issue::__construct()
if (strpos($_SERVER['HTTP_X_EVENT_KEY'], 'issue:') === false) {
    throw new Exception('Invalid request type');
}

// Bitbucket\PullRequest::__construct()
if (strpos($_SERVER['HTTP_X_EVENT_KEY'], 'pullrequest:') === false) {
    throw new Exception('Invalid request type');
}

Requirements

Bitbucket - Webhook requires the following:

PHP 7.0.0+

Installation

Bitbucket - Webhook is installed via Composer. To add a dependency to bitbucket-webhook in your project, either

Run the following to use the latest stable version

    composer require denx-b/bitbucket-webhook

or if you want the latest master version

    composer require denx-b/bitbucket-webhook:dev-master

You can of course also manually edit your composer.json file

{
    "require": {
       "denx-b/bitbucket-webhook": "0.*"
    }
}

denx-b / bitbucket-webhook

Maintainers

Details

README

Example

Exceptions

Requirements

Installation

Documentation

Manage webhooks

Events