nepda/youtrack-client

A PHP YouTrack client library

Monday, May 14, 2018
by nepda
Repository
6 Watchers
22 Stars
74,082 Installations

PHP
0 Dependents
0 Suggesters
36 Forks
0 Open issues
51 Versions
48 % Grown

The README.md

YouTrack Client PHP Library

Attention! This library is based on the now-deprecated REST API for YouTrack. jetBrains has release a new version of their REST API. May be I'll create a new version of this library for the new API., _(*1)

, _(*2)

The bugtracker YouTrack provides a REST-API. Because a lot of web applications are written in PHP I decided to write a client library for it. To make it easier for developers to write connectors to YouTrack., _(*3)

The initial development was sponsored by Telematika GmbH. The current development is made by nepda., _(*4)

The source of this library is released under the BSD license (see LICENSE for details)., _(*5)

Requirements

PHP >= 5.4 (Tested with >= 5.6, Travis runs tests with ~~5.4, 5.5~~, 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4)
curl
simplexml
json
YouTrack 3.0+ with REST-API enabled (currently, the production system runs with YouTrack 2019.1)

Changelog

Please look into CHANGELOG for a list of the past releases., _(*6)

Usage

With permanent token

Please look into the YouTrack documentation on how to create such a permanent token., _(*7)

<?php
require_once("YouTrack/Connection.php");
$youtrack = new \YouTrack\Connection("http://example.com", "perm:*****", null);
$issue = $youtrack->getIssue("TEST-1");
// ...

The $password parameter has to be null for permanent token login. This feature is dirty and will be fixed in version 2.*., _(*8)

<?php
require_once("YouTrack/Connection.php");
$youtrack = new \YouTrack\Connection("http://example.com", "login", "password");
$issue = $youtrack->getIssue("TEST-1");
// ...

See ./examples folder for more usage examples., _(*9)

Usage with ZF2 ZendSkeletonApplication

In your /init_autoloader.php, _(*10)

<?php
// ... snip
if ($zf2Path) {
    if (isset($loader)) {
        $loader->add('Zend', $zf2Path);
    } else {
        include $zf2Path . '/Zend/Loader/AutoloaderFactory.php';
        Zend\Loader\AutoloaderFactory::factory(array(
            'Zend\Loader\StandardAutoloader' => array(
                'autoregister_zf' => true,
                'namespaces' => [                            // add this
                    'YouTrack' => 'vendor/YouTrack'          // ...
                ],                                           // ...
            )
        ));
    }
}
// ... snip

From now on you can use YouTrack-Client-PHP-Library from any file in you ZF2-App., _(*11)

<?php
// ...
// example
use YouTrack\Connection as YouTrackConnection;

class ExampleController extends AbstractActionController
{

    public function anyAction()
    {
        $youtrack = new YouTrackConnection("http://example.com", "login", "password");
        $issue = $youtrack->getIssue("TEST-1");
        // ...
    }
}

Standalone setup with composer

Run the following commands to install composer and youtrack-client., _(*12)

mkdir my-youtrack-project
cd my-youtrack-project

php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php -r "if (hash_file('SHA384', 'composer-setup.php') === '55d6ead61b29c7bdee5cccfb50076874187bd9f21f65d8991d46ec5cc90518f447387fb9f76ebae1fbbacf329e583e30') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
php composer-setup.php
php -r "unlink('composer-setup.php');"

php composer.phar require nepda/youtrack-client

(Please checkout the latest composer setup on their page), _(*13)

Create a ./my-youtrack-project/client.php file with content:, _(*14)

<?php
define('YOUTRACK_URL', 'https://*your-url*.myjetbrains.com/youtrack');
define('YOUTRACK_USERNAME', '***');
define('YOUTRACK_PASSWORD', '***');
require_once 'vendor/autoload.php';
try {
    $youtrack = new YouTrack\Connection(
        YOUTRACK_URL,
        YOUTRACK_USERNAME . 'invalid',
        YOUTRACK_PASSWORD
    );
    echo 'Login correct.' . PHP_EOL;

    $issue = $youtrack->getIssue('TEST-123');
    // Now you can work with the issue or other $youtrack methods
} catch (\YouTrack\IncorrectLoginException $e) {
    echo 'Incorrect login or password.' . PHP_EOL;
}

$issue = $youtrack->getIssue('TEST-123');
// Now you can work with the issue or other $youtrack methods

} catch (\YouTrack\IncorrectLoginException $e) { echo 'Incorrect login or password.' . PHP_EOL; }, _(*15)


With this simple setup you're ready to go.

## Tests

The testsuite depends on PHPUnit. You can install it with `composer.phar`:

```sh
curl -sS https://getcomposer.org/installer | php --
php composer.phar install

The unit tests are incomplete but you can run them using phpunit like this:, _(*16)

./vendor/bin/phpunit ./test

Contributors

(and more: https://github.com/nepda/youtrack-client/network/members), _(*17)

The Versions

14/05 2018

dev-master

9999999-dev

A PHP YouTrack client library

library youtrack-client

A PHP YouTrack client library

nepda/youtrack-client

The README.md

YouTrack Client PHP Library

Requirements

Changelog

Usage

With permanent token

With deprecated username/password login

Usage with ZF2 ZendSkeletonApplication

Standalone setup with composer

Contributors

The Versions

dev-master

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

v1.7.9

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

v1.7.8

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

1.0-rc2

1.0

1.0-rc1

1.0-rc3

1.0-rc4

1.0-rc5

1.0-rc6

1.0-rc7

v1.7.7

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

v1.7.6

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

v1.7.5

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

dev-scrutinizer-patch-1

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

v1.7.4

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

v1.7.3

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

v1.7.2

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

v1.7.1

The Requires

The Development Requires

by Nepomuk Fraedrich

by Sergey Susikov

v1.7.0

The Requires

The Development Requires