urvin/gokaru-php-client

A Gokaru storage & thumbnail server PHP client

1.0.3 2021-11-10 10:37 UTC

Requires

• php: ^7.4 || ^8.0
• guzzlehttp/guzzle: ^7.0
• lastguest/murmurhash: ^2.1

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• Yuriy Gorbachev

• thumbnail
• gokaru

README

PHP API client for Gokaru storage & image thumbnail server.

Requirements

• PHP >= 7.4

Usage

// According to your Gokaru configuration, create a MurMur or Md5 signature generator
$generator = new \Urvin\Gokaru\Signature\MurMurGenerator('gokaru_secret_passphrase'); 

// Create a client instance with gokaru secured url
$gokaru = new \Urvin\Gokaru\Client('http://localhost:8101/', $generator);

// Upload your first image
$gokaru->upload(
    '~/my_first_image.png',
    \Urvin\Gokaru\SourceType::SOURCE_TYPE_IMAGE,
    'tryout',          // choose any category you want
    'first_image'      // choose any file code you want 
);

// Or a file
$gokaru->upload(
    '~/my_secret_data.pdf',
    \Urvin\Gokaru\SourceType::SOURCE_TYPE_FILE,
    'x-files',
    'secret_data.pdf' 
);

// You can specify different public urls for different file types
$gokaru->setUrlPublic(
    \Urvin\Gokaru\SourceType::SOURCE_TYPE_IMAGE,
    'https://site.com/pictures'
);
$gokaru->setUrlPublic(
    \Urvin\Gokaru\SourceType::SOURCE_TYPE_FILE,
    'https://site.com/documents'
);

// Create a thumbnail url for your image
$builder = $gokaru->thumbnail()
    ->width(200)
    ->height(200)
    ->cast(\Urvin\Gokaru\Cast::RESIZE_PRECISE)
    ->cast(\Urvin\Gokaru\Cast::TRIM)
    ->cast(\Urvin\Gokaru\Cast::EXTENT)
    ->category('tryout')
    ->filename('first_image')
    ->extension('jpg');
$url = (string)$builder;

// When a moment comes, delete source and all thumbnails from server
$gokaru->delete(
    \Urvin\Gokaru\SourceType::SOURCE_TYPE_IMAGE,
    'tryout',
    'first_image'
);

Author

Yuriy Gorbachev [e-mail]