Skip to content

Latest commit

 

History

History
90 lines (64 loc) · 2.87 KB

README.md

File metadata and controls

90 lines (64 loc) · 2.87 KB
Raw

cImgur

Simple image uploader to imgur.com packed in a PHP class

INTRODUCTION

cImgur (abbr: "c" for custom) is a customized imgur remote uploader in PHP using cURL and imgur API endpoints. Made for anonymous execution, single images only.


SETUP INFORMATION

Use your CLI and enter the following to clone:
git clone https://github.com/thielicious/cImgur.git


USAGE

Create an object :

$imgur = new cImgur("<CLIENT-ID>");
$imgur->setUploadSize(<UPLOAD MAX SIZE>);

After a form has been submitted, use this boilerplate:

try {
  $imgur->upload($_FILES["upload"]);
  $response = $imgur->data(cImgur::RETURN_OBJECT);
  echo $response->link;
} catch (Exception $e) {
  foreach ($imgur->getErrors() as $err) {
    echo $err;
  }
}

This example above spits out the direct link to the uploaded image at imgur.com. The entire data that is sent back after successful upload can be viewed here: https://apidocs.imgur.com/?version=latest#2078c7e0-c2b8-4bc8-a646-6e544b087d0f


METHODS

cImgur::__construct(string $clientID = NULL) (required)

  • (optional) defines the CLIENT-ID for authorization. If you don't have a Client-ID, then visit https://api.imgur.com/oauth2/addclient to register and copy the ID. You may leave this parameter blank and add later your ID with cImgur::clientID(string $clientID).

cImgur::setUploadSize(int $size) (required)

  • defines the maximum size of images.

cImgur::setImageSize(int $width, int $height) (optional)

  • use this method to implicitly set the image's height and width. This will check if the selected image meets the requirement.

cImgur::upload(array $file) (required)

  • this will upload the file, if $_FILES is set.

cImgur::data(const $return_type = NULL) (required)

  • (optional) this method returns the response data encoded in JSON once the upload process to imgur.com was successful.
    The following return types can be used:
    cImgur::RETURN_JSON (default)
    cImgur::RETURN_OBJECT (Std Class Object)
    cImgur::RETURN_ARRAY (Associative Array)

Use print_r() if you would like to view the whole response.

cImgur::getErrors() (optional)

  • through a try-catch block it might throw an exception when the upload has failed. You can check out the errors with this method, which returns an Array.

cImgur::debug() (optional)

  • if this method is in use, it will not upload the file but an array of information of the selected file will be displayed for debugging plus the data response from imgur if available.


🆕 A Demo has been added.


If you encounter any bugs, feel free to open up an issue, thank you.

thielicious.github.io