Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/worksome/sdk-php
An object-oriented PHP wrapper for the Worksome API
https://github.com/worksome/sdk-php
api client graphql php worksome wrapper
Last synced: about 2 months ago
JSON representation
An object-oriented PHP wrapper for the Worksome API
- Host: GitHub
- URL: https://github.com/worksome/sdk-php
- Owner: worksome
- License: mit
- Created: 2022-09-28T15:48:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T10:56:26.000Z (10 months ago)
- Last Synced: 2024-05-03T04:02:25.219Z (9 months ago)
- Topics: api, client, graphql, php, worksome, wrapper
- Language: PHP
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Worksome PHP SDK
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-github-actions]][link-github-actions]
[![Static Analysis Status][ico-static-analysis]][link-static-analysis]
[![Total Downloads][ico-downloads]][link-downloads]
An object-oriented PHP wrapper for the Worksome API
## Requirements
- PHP >= 8.2
- A [PSR-17 implementation](https://packagist.org/providers/psr/http-factory-implementation)
- A [PSR-18 implementation](https://packagist.org/providers/psr/http-client-implementation)
## Install
Via Composer
```shell
composer require worksome/sdk guzzlehttp/guzzle:^7.5 http-interop/http-factory-guzzle:^1.2
```
We are decoupled from any HTTP messaging client with help by [HTTPlug](https://httplug.io).
## Usage
#### Basic usage
```php
// Include the Composer autoloader
require_once __DIR__ . '/vendor/autoload.php';
$client = new \Worksome\Sdk\Client();
$repositories = $client->graph()->execute(<<>>);
```
#### Authentication
The Worksome SDK supports authenticating through an API token.
```php
$client = new \Worksome\Sdk\Client();
$client->authenticate($apiToken);
```
#### Using a different HTTP client
Thanks to [HTTPlug](https://httplug.io), we support the use of many HTTP clients. For example, to use the Symfony HTTP
Client, first install the client and PSR-7 implementation.
```shell
composer require worksome/sdk symfony/http-client nyholm/psr7
```
Next, set up the Worksome client with this HTTP client:
```php
$client = \Worksome\SDK\Client::createWithHttpClient(
new \Symfony\Component\HttpClient\HttplugClient()
);
```
Alternatively, you can inject an HTTP client through the `Client` constructor.
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
```shell
composer test
```
To update the test snapshots, set the `WORKSOME_LOCAL_API_URL` and `WORKSOME_LOCAL_API_TOKEN` environment variables, and
then run `composer update:snapshots`.
## Credits
- [Owen Voke][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/worksome/sdk.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-github-actions]: https://img.shields.io/github/actions/workflow/status/worksome/sdk-php/tests.yml?branch=main&label=tests&style=flat-square
[ico-static-analysis]: https://img.shields.io/github/actions/workflow/status/worksome/sdk-php/static.yml?branch=main&label=static%20analysis&style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/worksome/sdk.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/worksome/sdk
[link-github-actions]: https://github.com/worksome/sdk-php/actions
[link-static-analysis]: https://github.com/worksome/sdk-php/actions?query=workflow%3AStatic%20Analysis
[link-downloads]: https://packagist.org/packages/worksome/sdk
[link-author]: https://github.com/owenvoke
[link-contributors]: ../../contributors