k0nias/fakturoid-api

Unoffical Fakturoid.cz PHP API wrapper

0.1.1 2019-04-05 07:56 UTC

Requires

• php: ^7.1
• ext-curl: *
• ext-json: *

Requires (Dev)

• consistence/coding-standard: ^3.8
• dealerdirect/phpcodesniffer-composer-installer: ^0.5.0
• infection/infection: ^0.12.2
• phpstan/phpstan-phpunit: ^0.11
• phpstan/phpstan-shim: ^0.11
• phpunit/phpunit: ^7.4
• slevomat/coding-standard: ~5.0
• squizlabs/php_codesniffer: ^3.3

MIT

• Vladimir Zapletal

• api
• fakturoid

README

Unofficial Fakturoid.cz API PHP wrapper. Official library and API documentation

Reasons to write another API wrapper

1. more strict data binding
2. PHP7 support
3. better test coverage

Installation

The recommended way to install this library is through Composer:

composer require k0nias/fakturoid-api:dev-master

Usage

    use K0nias\FakturoidApi\Api;
    use K0nias\FakturoidApi\Http\Request\GetInvoicesRequest;
    use K0nias\FakturoidApi\Model\Invoice\Filter\Parameters;
    use K0nias\FakturoidApi\Model\Invoice\Status;

    require_once __DIR__.'/vendor/autoload.php';
    
    $slug = 'test';
    $email = '[e-mail]';
    $apiToken = 'xxx';
    
    $api = new Api($slug, $email, $apiToken);
    
    $filterParameters = new Parameters();
    $filterParameters->status(Status::open())
                    ->page(2);
    
    // generic version of getting response for request
    // @var \K0nias\FakturoidApi\Http\Response\ResponseInterface $response
    $response = $api->process(new GetInvoicesRequest($filterParameters));
    
    // more specific version of getting response for request 
    // @var \K0nias\FakturoidApi\Http\Response\GetInvoicesResponse $response
    $response = (new GetInvoicesRequest($filterParameters))->send($api);

Tests

To run the test suite, you need Composer:

composer install
composer test