Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codeat3/foaas-client
A PHP Client for FOAAS Service
https://github.com/codeat3/foaas-client
client foaas php
Last synced: about 2 months ago
JSON representation
A PHP Client for FOAAS Service
- Host: GitHub
- URL: https://github.com/codeat3/foaas-client
- Owner: codeat3
- License: mit
- Created: 2019-07-12T13:07:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-31T12:13:15.000Z (almost 5 years ago)
- Last Synced: 2024-05-03T04:00:07.139Z (9 months ago)
- Topics: client, foaas, php
- Language: PHP
- Size: 57.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Very short description of the package
[](https://packagist.org/packages/codeat3/foaas-client)
[](https://travis-ci.org/codeat3/foaas-client)
[](https://scrutinizer-ci.com/g/codeat3/foaas-client)
[](https://packagist.org/packages/codeat3/foaas-client)
A PHP Client of [FOAAS](https://foaas.com/)
## Installation
You can install the package via composer:
```bash
composer require codeat3/foaas-client
```
## Usage
Basic usage of the client
``` php
use Codeat3\FoaasClient\FoaasClient;
$foaasClient = new FoaasClient([
'decency' => 'low', // possible decency filter options are 'low', 'medium', 'high', 'extreme' - default is no filter
]);
echo $foaasClient->what('John')->get();
// Output
What the f*ck‽ - John
```
Using format to get the response as per your need
```php
use Codeat3\FoaasClient\FoaasClient;
$foaasClient = new FoaasClient([
'decency' => 'low',
'responseAs' => 'array', // possible response formats are 'text' (default), 'html', 'xml', 'json', 'array'
]);
print_r($foaasClient->what('John')->get());
// Output
Array
(
[message] => What the f*ck‽
[subtitle] => - John
)
```
Also few helpers are provided for the type of output expected
```php
$foaasClient = new FoaasClient([
'decency' => 'low',
]);
echo $foaasClient->what('John')->getAsText(); // What the f*ck‽ - John
echo $foaasClient->what('John')->getAsXml(); // What the f*ck‽ - John
echo $foaasClient->what('John')->getAsHtml(); // FOAAS - What the f*ck‽ - John ...
echo $foaasClient->what('John')->getAsJson(); // {"message":"What the f*ck‽","subtitle":"- John"}
print_r($foaasClient->what('John')->getAsArray());
/*
Array
(
[message] => What the f*ck‽
[subtitle] => - John
)
*/
```
##### Custom Responses
You can implement the custom responses and pass it in customer as per your need
```php
// Implementation
class ObjectResponse implements FoaasResponse
{
protected $acceptHeader = 'application/json';
public function getHeaders():string
{
return $this->acceptHeader;
}
public function response(string $response, FoaasFilter $filter)
{
$response = $filter->filter($response);
return json_decode($response);
}
}
// Use
$foaasClient = new FoaasClient([
'decency' => 'low',
'responseAs' => 'object',
'responseFormats' => [
'object' => ObjectResponse::class,
]
]);
var_dump($foaasClient->what('John')->get());
/*
class stdClass#27 (2) {
public $message =>
string(16) "What the f*ck‽"
public $subtitle =>
string(6) "- John"
}
*/
```
### Testing
``` bash
composer test
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Swapnil Sarwe](https://github.com/codeat3)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## PHP Package Boilerplate
This package was generated using the [PHP Package Boilerplate](https://laravelpackageboilerplate.com).