Skip to content

Commit

Permalink
Merge pull request #7 from joshghent/main
Browse files Browse the repository at this point in the history 
Updated to return associative arrays
  • Loading branch information
@yongfook
yongfook authored Dec 17, 2021
2 parents 51395e5 + 9416997 commit ae84f6e
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 37 deletions.
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Find the full API documentation [here](https://developers.bannerbear.com/)

## Requirements

PHP 7 or Higher
PHP 7.4 or Higher

## Installation

Expand All @@ -26,6 +26,8 @@ require_once('vendor/autoload.php');

## Usage

> Please note that all methods return dictionaries/associative arrays. Responses can be found in the developer documentation [here](https://developers.bannerbear.com/).
### Authentication

Get the API key for your project in Bannerbear and then instantiate a new client.
Expand Down
72 changes: 36 additions & 36 deletions src/BannerbearClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@ public function factorySync()
return $client;
}

public function account(): string
public function account()
{
return $this->factory()->get('/account');
}

public function fonts(): string
public function fonts()
{
return $this->factory()->get('/fonts');
}
public function effects(): string
public function effects()
{
return $this->factory()->get('/effects');
}
Expand All @@ -52,12 +52,12 @@ public function effects(): string
// IMAGES
// =================================

public function get_image(string $uid): string
public function get_image(string $uid)
{
return $this->factory()->get('/images/' . $uid);
}

public function list_images(int $page = null, int $limit = null): string
public function list_images(int $page = null, int $limit = null)
{
$queryString = [];
if ($page) array_push($queryString, 'page=' . $page);
Expand All @@ -68,7 +68,7 @@ public function list_images(int $page = null, int $limit = null): string
/**
* @param array<string,mixed> $params
*/
public function create_image(string $uid, array $params, bool $synchronous = false): string
public function create_image(string $uid, array $params, bool $synchronous = false)
{
$params['template'] = $uid;
if ($synchronous) {
Expand All @@ -80,12 +80,12 @@ public function create_image(string $uid, array $params, bool $synchronous = fal
// =================================
// VIDEOS
// =================================
public function get_video(string $uid): string
public function get_video(string $uid)
{
return $this->factory()->get('/videos/' . $uid);
}

public function list_videos(int $page = null): string
public function list_videos(int $page = null)
{
$queryString = array();
if ($page) array_push($queryString, 'page=' . $page);
Expand All @@ -95,7 +95,7 @@ public function list_videos(int $page = null): string
/**
* @param array<string,mixed> $params
*/
public function create_video(string $uid, array $params): string
public function create_video(string $uid, array $params)
{
$params['video_template'] = $uid;
return $this->factory()->post('/videos', $params);
Expand All @@ -104,7 +104,7 @@ public function create_video(string $uid, array $params): string
/**
* @param array<string,mixed> $params
*/
public function update_video(string $uid, array $params): string
public function update_video(string $uid, array $params)
{
$params['uid'] = $uid;
return $this->factory()->patch('/videos', $params);
Expand All @@ -113,12 +113,12 @@ public function update_video(string $uid, array $params): string
// =================================
// COLLECTIONS
// =================================
public function get_collection(string $uid): string
public function get_collection(string $uid)
{
return $this->factory()->get('/collections/' . $uid);
}

public function list_collections(int $page = null): string
public function list_collections(int $page = null)
{
$queryString = [];
if ($page) array_push($queryString, 'page=' . $page);
Expand All @@ -128,7 +128,7 @@ public function list_collections(int $page = null): string
/**
* @param array<string,mixed> $params
*/
public function create_collection(string $uid, array $params, bool $synchronous = false): string
public function create_collection(string $uid, array $params, bool $synchronous = false)
{
$params['template_set'] = $uid;
if ($synchronous) {
Expand All @@ -140,12 +140,12 @@ public function create_collection(string $uid, array $params, bool $synchronous
// =================================
// SCREENSHOTS
// =================================
public function get_screenshot(string $uid): string
public function get_screenshot(string $uid)
{
return $this->factory()->get('/screenshots/' . $uid);
}

public function list_screenshots(int $page = null): string
public function list_screenshots(int $page = null)
{
$queryString = [];
if ($page) array_push($queryString, 'page=' . $page);
Expand All @@ -155,7 +155,7 @@ public function list_screenshots(int $page = null): string
/**
* @param array<string,mixed> $params
*/
public function create_screenshot(string $url, array $params, bool $synchronous = false): string
public function create_screenshot(string $url, array $params, bool $synchronous = false)
{
$params['url'] = $url;
if ($synchronous) {
Expand All @@ -167,12 +167,12 @@ public function create_screenshot(string $url, array $params, bool $synchronous
// =================================
// ANIMATED GIFS
// =================================
public function get_animated_gif(string $uid): string
public function get_animated_gif(string $uid)
{
return $this->factory()->get('/animated_gifs/' . $uid);
}

public function list_animated_gifs(int $page = null): string
public function list_animated_gifs(int $page = null)
{
$queryString = array();
if ($page) array_push($queryString, 'page=' . $page);
Expand All @@ -182,7 +182,7 @@ public function list_animated_gifs(int $page = null): string
/**
* @param array<string,mixed> $params
*/
public function create_animated_gif(string $uid, array $params): string
public function create_animated_gif(string $uid, array $params)
{
$params['template'] = $uid;
return $this->factory()->post('/animated_gifs', $params);
Expand All @@ -191,12 +191,12 @@ public function create_animated_gif(string $uid, array $params): string
// =================================
// MOVIES
// =================================
public function get_movie(string $uid): string
public function get_movie(string $uid)
{
return $this->factory()->get('/movies/' . $uid);
}

public function list_movies(int $page = null): string
public function list_movies(int $page = null)
{
$queryString = array();
if ($page) array_push($queryString, 'page=' . $page);
Expand All @@ -206,20 +206,20 @@ public function list_movies(int $page = null): string
/**
* @param array<string,mixed> $params
*/
public function create_movie(array $params): string
public function create_movie(array $params)
{
return $this->factory()->post('/movies', $params);
}

// =================================
// TEMPLATES
// =================================
public function get_template(string $uid): string
public function get_template(string $uid)
{
return $this->factory()->get('/templates/' . $uid);
}

public function list_templates(int $page = null, int $limit = null, string $tag = null, string $name = null): string
public function list_templates(int $page = null, int $limit = null, string $tag = null, string $name = null)
{
$queryString = array();
if ($page) array_push($queryString, 'page=' . $page);
Expand All @@ -232,20 +232,20 @@ public function list_templates(int $page = null, int $limit = null, string $tag
/**
* @param array<string,mixed> $params
*/
public function update_template(string $uid, array $params): string
public function update_template(string $uid, array $params)
{
return $this->factory()->patch('/templates/' . $uid, $params);
}

// =================================
// VIDEO TEMPLATES
// =================================
public function get_video_template(string $uid): string
public function get_video_template(string $uid)
{
return $this->factory()->get('/video_templates/' . $uid);
}

public function list_video_templates(int $page = null): string
public function list_video_templates(int $page = null)
{
$queryString = array();
if ($page) array_push($queryString, 'page=' . $page);
Expand All @@ -255,12 +255,12 @@ public function list_video_templates(int $page = null): string
// =================================
// TEMPLATE SETS
// =================================
public function get_template_set(string $uid): string
public function get_template_set(string $uid)
{
return $this->factory()->get('/template_sets/' . $uid);
}

public function list_template_sets(int $page = null): string
public function list_template_sets(int $page = null)
{
$queryString = array();
if ($page) array_push($queryString, 'page=' . $page);
Expand Down Expand Up @@ -312,12 +312,12 @@ public function __construct(string $url, array $headers = [])
return $this;
}

private function getUrl(string $url): string
private function getUrl(string $url)
{
return $this->url . $url;
}

public function get(string $url): string
public function get(string $url)
{
curl_setopt($this->client, CURLOPT_URL, $this->getUrl($url));

Expand All @@ -335,13 +335,13 @@ public function get(string $url): string
throw new \Exception('Bannerbear Error Status: ' . $status . '. Message: ' . $error_msg);
}

return $res;
return json_decode($res, true);
}

/**
* @param array<string,mixed> $params
*/
public function patch(string $url, array $params): string
public function patch(string $url, array $params)
{
curl_setopt($this->client, CURLOPT_URL, $this->getUrl($url));
curl_setopt($this->client, CURLOPT_CUSTOMREQUEST, 'PATCH');
Expand All @@ -361,13 +361,13 @@ public function patch(string $url, array $params): string
throw new \Exception('Bannerbear Error Status: ' . $status . '. Message: ' . $error_msg);
}

return $res;
return json_decode($res, true);
}

/**
* @param array<string,mixed> $params
*/
public function post(string $url, array $params): string
public function post(string $url, array $params)
{
curl_setopt($this->client, CURLOPT_URL, $this->getUrl($url));
curl_setopt($this->client, CURLOPT_POST, true);
Expand All @@ -387,6 +387,6 @@ public function post(string $url, array $params): string
throw new \Exception('Bannerbear Error Status: ' . $status . '. Message: ' . $error_msg);
}

return $res;
return json_decode($res, true);
}
}

0 comments on commit ae84f6e

Please sign in to comment.