Download the PHP package shardimage/shardimage-php without Composer
On this page you can find all versions of the php package shardimage/shardimage-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shardimage/shardimage-php
More information about shardimage/shardimage-php
Files in shardimage/shardimage-php
Package shardimage-php
Short Description shardimage-php package
License Apache-2.0
Informations about the package shardimage-php
Shardimage PHP package
Introduction
Official PHP package for using Shardimage application.
Installation
Install With Composer
or add
to your composer.json
file and run update.
Quick start
Simple examples to use the package. For more details, please read our official documentation >>>
Configuring the Client
Configure the Client with information from our website to make connection with the Shardimage API.
Getting access datas
Your apiKey
and apiSecret
is available on Shardimage api page.
Access token can be created through Shardimage API, it requires a configured client with apiKey
and apiSecret
.
Now we can configure an another Client for token image hosting:
Manage clouds with API
To upload and store images, cloud must to be created.
You can add features to your cloud to make it efficient and secure! To view the full list of our features, please check the documentation >>>
Notice: The deliverySecureUrl
settings will work only, if you set up the client with the security information: image secret hash or access token/acces token secret.
Send to the API to create it.
If you already have clouds, you can list them:
Manage images with API
To upload images to a cloud, or list from it, we need to use the ID of the cloud. The Shardimage PHP package is capable to upload images through single or multithreads, if you have big amount of pictures.
Single thread:
If everything goes alright, the $result
variable will contain shardimage\shardimagephp\models\image\Image
object with the uploaded image datas.
Multithread upload is very similar, we need to turn on the defer
option before the upload. Turning it off will send the collected datas.
Unwanted pictures can be deleted from the system with two methods. Simple delete will delete one image by it's public ID and the cloud ID.
Other way is to delete images by their tags. In this case every images with the given tags will be deleted from the target cloud.
Using UploadBuilder
Using the builder class can make uploading easier by giving a developer friendly usage to build up upload parameters.
Hosting images
Hosting the uploaded images with the packgate is basically generating their URL. Using the UrlService
class you can build up remote image URLs also to serve them through the Shardimage.
Practically, the Shardimage will store only the original uploaded image. Every modification, transformation, conversion will applied through URL rules or cloud settings. For further information, please check the documentation >>>
Example for generation URL for stored image:
Basic security hash will be added to the URL only if you set up the imageSecret
in your client config.
Changelog
All notable changes to this project will be documented in the CHANGELOG file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.