PHPackages                             peterson/ultimate-uploader - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Image & Media](/categories/media)
4. /
5. peterson/ultimate-uploader

ActiveLibrary[Image & Media](/categories/media)

peterson/ultimate-uploader
==========================

PHP Library for Uploading all file types

2.2.3(2y ago)09MITPHPPHP >=5.3.3

Since Aug 23Pushed 2y ago1 watchersCompare

[ Source](https://github.com/tamedevelopers/ultimate-uploader)[ Packagist](https://packagist.org/packages/peterson/ultimate-uploader)[ RSS](/packages/peterson-ultimate-uploader/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)DependenciesVersions (4)Used By (0)

Ultimate Image Uploader - UIU
=============================

[](#ultimate-image-uploader---uiu)

### @author Fredrick Peterson (Tame Developers)

[](#author-fredrick-peterson-tame-developers)

PHP Ultimate Image Uploader Library

```
|--------------------------------------------------------------------------
|This Library uses Image Compressor by can Bachors
|https://github.com/bachors/PHP-Image-Compressor-Class

```

[Github Link to Bachors Plugin](https://github.com/bachors/PHP-Image-Compressor-Class)

- [Requirements](#requirements)
- [Installation](#installation)
- [Instantiate](#instantiate)
- [Set Directory Path](#set-directory-path)
- [Set Url Path](#set-url-path)
- [Usage](#usage)
    - [Error Code](#error-code)
    - [INPUT HTML STRUCTURE](#input-html-structure)
    - [Use case defined](#use-case-defined)
    - [First](#first)
    - [Get](#get)
    - [DIMENSION PARAM SIZE](#dimension-param-size)
    - [Get Image Width And Height](#get-image-width-and-height)
    - [Image AutoResize](#image-autoresize)
    - [Image WaterMark](#image-watermark)
    - [FOLDER Create](#folder-create)
    - [MIME TYPE](#mime-type)
    - [FINAL UPLOADED DATA](#final-upload-data)
- [Useful links](#useful-links)

Requirements
------------

[](#requirements)

- `>= php5.3.3+`

Installation
------------

[](#installation)

Prior to installing `ultimate-uploader` get the [Composer](https://getcomposer.org) dependency manager for PHP because it'll simplify installation.

**Step 1** — update your `composer.json`:

```
"require": {
    "peterson/ultimate-uploader": "^2.2.3"
}
```

**Or composer install**:

```
composer require peterson/ultimate-uploader

```

**Step 2** — run [Composer](https://getcomposer.org):

```
composer update

```

Instantiate
-----------

[](#instantiate)

**Step 1** — Composer `Instantiate class using`:

```
require_once __DIR__ . '/vendor/autoload.php';

$upload = new ultimateUploader\ultimateUploader();

or
require_once __DIR__ . '/vendor/autoload.php';

use \ultimateUploader\ultimateUploader;

$upload = new ultimateUploader();

```

**Step 2** — PHP Direct `Instantiate class using`:

```
include_once "pat_to/ultimateUploader.php";

$upload = new ultimateUploader\ultimateUploader();

```

```
You can download and entire repo and copy the src file alone to directory of your project.
- src/ultimateUploader.php

```

Set Directory Path
------------------

[](#set-directory-path)

**Step 1**:

```
$upload = new ultimateUploader\ultimateUploader();
$upload->setDir('path-to-dir'):

```

**Step 2** :

```
$upload = new ultimateUploader\ultimateUploader();
$upload->setDirectory('path-to-dir'):

```

Set Url Path
------------

[](#set-url-path)

**Step 1**:

```
$upload = new ultimateUploader\ultimateUploader();
$upload->setUrl('path-to-url'):

```

**Step 2**:

```
$upload = new ultimateUploader\ultimateUploader();
$upload->setURL('path-to-url'):

```

Error Code
----------

[](#error-code)

```
|--------------------------------------------------------------------------
| ALL Error Code
| Some error can be skipped, depending on what you need

-> ERROR_400 - no file upload
-> ERROR_401 - select file to upload
-> ERROR_402 - File upload size is bigger than allowed size limit
-> ERROR_403 - Maximum file allowed exceeded
-> ERROR_404 - Uploaded file format not allowed
-> ERROR_404 - Image size allowed error
-> ERROR_500 - Input file `name[]` must be passed as an array
| *************************************

```

**All Error code** — response property (public) `->allError`:

```
$upload = new ultimateUploader\ultimateUploader();
echo $upload->allError;

```

**By default class has three (3) params on call (Instantiating)**

```
-> errorDisallowed -- index array [], all error code to ignore
-> base_dir -- Path to base dir (NULL on default)
-> base_url -- Path to base storage url (NULL on default)

$upload = new ultimateUploader\ultimateUploader([400, 401], 'path_to_dir', 'localhost/path_to_storage/folder');

- By default the error disallow array is empty
- By default the base dir, get path to your document root base directory
- By default the base url, get path to your base domain url/link

```

**We have seven (7) parameter when calling the run Method from the class**

```
-> fileUpload -- HTML input file name
-> folder_create -- Folder structure to use (Refer to Folder Create section for more detail)
-> upload_dir -- Directory to upload to (Do not pass in full path to folder)
-> type -- Mime Type to allow (Refer to MIME Types section for more detail)
-> size -- Maximum file size to allow (use any value of choice without conversion) i.e 2mb
-> limit_max -- Maximum upload limits
-> dimension_size -- For image dimension sizes (espects associative array). Please refer to DIMENSION PARAM ERROR

```

INPUT HTML STRUCTURE
--------------------

[](#input-html-structure)

```

```

Use case defined
----------------

[](#use-case-defined)

```
** -> We used Object Method Chaining **
** -> $upload->run()->error()->success(); **
** -> a new callable function is espected to be passed to "error Method and success Method" **
** -> pass any param `name` of choice on error and success function call **

```

- Plain Default setup

```
$upload = new ultimateUploader\ultimateUploader();
$upload->run('avatar', 'default', 'upload/avatar', 'images', '1.5mb', 1, ['height' => 500, 'width' => '300'])
    ->error(function($error){

		//you now have access to all public methods & properties using the $error var

    })->success(function($success){
		//you now have access to all public methods & properties using the $success var
    });

```

- Example 1

```
	//instantiate class
    $upload = new ultimateUploader\ultimateUploader();

$upload->run('avatar', 'year', 'upload/avatar', 'images', '1.5mb', 1)
    ->error(function($response){

        //error message
        echo $response->data['message'];
    })->success(function($response){

		On Successful uploads --- ERROR_200

        //run auto resize
        $response->imageAutoResize(200, 100, false);

        //run watermark
        $response->waterMark('watermark.png', '50', '100', false); //Add watermark automatically

        //run compression
        $response->compress(true); //will replace original to compressred -v

        //->data properties contains all uploaded info
        $response->data;
    });

```

- Example 2

```
	//instantiate class
    $upload = new ultimateUploader\ultimateUploader([400]);

    $upload->run('avatar', 'month', 'upload', 'images', '2.5mb', 2)
        ->error(function($response){

            //you can customize each error text message
            if($response->data['status'] == 401){
                echo "Custom message - Please select a file to upload";
                return; //return key is used to stop further code exec on this function block only
            }

            //error message
            echo $response->data['message'];
        })->success(function($response){

            //proccess further code blocks
			$response->data;

        });

```

- Example 3

```
	//instantiate class
    $upload = new ultimateUploader\ultimateUploader([400]);

$upload->run('avatar', 'default', 'upload/avatar', 'images', '1.5mb', 1, ['height' => 500, 'width' => '300'])
    ->error(function($response){

		//you can customize each error text message
		if($response->data['status'] == 401){
			echo "Custom message - Please select a file to upload";
		}
		elseif($response->data['status'] == 405){
			echo "CUSTOM MSG - {$response->data['message']}";
			return;
		}

		//error message
		echo $response->data['message'];
    })->success(function($response){

		//proccess further code blocks
		$response->data;

    });

```

### FIRST

[](#first)

```
$upload = new ultimateUploader\ultimateUploader();

->success(function($response){

    $response->first();
    This will get all first uploaded data
    returns as an array
});

```

### GET

[](#get)

```
$upload = new ultimateUploader\ultimateUploader();

->success(function($response){

    $response->get();
    This will get all uploaded data
    returns as an array
});

```

### DIMENSION PARAM SIZE

[](#dimension-param-size)

```
Dimension size error check on $upload->run();

->  Takes an associative array --- ['width' => 500, 'height' => 700, 'same' => false]
->  By default same is set to `false` if not set.

$upload->run(['width' => 500, 'height' => 700])

['same' => false] => "Will only check if height or weight is greater or equal to allowed dimension set"
['same' => true] => "Will only check if height or weight is equal to allowed dimension set"

```

### Get Image Width And Height

[](#get-image-width-and-height)

```
Must be called before the  ->run Method for this to work
Useful for a single file upload like Cover Image or any other single upload

--- Takes just one param (HTML input file name)

//get file data
$width = $upload->getImageAttribute('path_to_img_file);

var_dump($width);

--- returns an assoc array

[
  ["height"]=> int(4209)
  ["width"]=> int(3368)
]

```

### Image AutoResize

[](#image-autoresize)

```
By default Image Autoresize is set to -> false
You need to set to -> true in other to enable the method

-- Autoresize takes the lowest length value between Width & Height to crop/resize image

$upload->imageAutoResize(200, 100, false);

```

### Image WaterMark

[](#image-watermark)

```
By default Watermark is set to -> false
You need to set to -> true in other to enable the method

-- Watermark takes first param as path to image
i.e 'assets/image/watermark.png'

-- Second param is margin_right
-- third param if margin_bottom

$upload->waterMark('watermark.png', '50', '100', true);

```

### Image Compress

[](#image-compress)

```
By default Compressor is set to -> false
You need to set to -> true in other to enable the method

Best practice for compressing is to make this the last callback method after the rest
->imageAutoResize
->waterMark
->compress

$upload->compress(true);

```

### FOLDER Create

[](#folder-create)

```
By default Folder structure parameter is set to -> 'default'
-- Do not worry as folder do not need to exists before it can be created.
-- All uploaded files return all dataset of all uploads

-> 'default' Upload directory name/filename.jpg
-> 'year' Upload directory name/2022/filename.jpg
-> 'month' Upload directory name/2022/10/filename.jpg
-> 'day' Upload directory name/2022/10/28/filename.jpg

```

1. Default
    - Year
        - Month
            - Day

```
To use, pass in any of the below;
'default' | 'year' | 'month' | 'day' to the run method when calling

$upload->run('avatar', 'year', 'upload/avatar', 'images', '1.5mb', 1);

```

### MIME TYPE

[](#mime-type)

```
'video'         =>  ['.mp4', '.mpeg', '.mov', '.avi', '.wmv'],
'audio'         =>  ['.mp3', '.wav'],
'files'         =>  ['.docx', '.pdf', '.txt'],
'images'        =>  ['.jpg', '.jpeg', '.png'],
'general_file'  =>  ['.docx', '.pdf', '.txt', '.zip', '.rar', '.xlsx', '.xls'],
'general_image' =>  ['.jpg', '.jpeg', '.png', '.webp'],
'general_media' =>  ['.mp3', '.wav', '.mp4', '.mpeg', '.mov', '.avi', '.wmv']

Pass in any of this into the Type parameter section when calling the ->run Method

```

- video
- audio
- files
- general\_file
- images
- general\_image
- general\_media

### FINAL UPLOADED DATA

[](#final-uploaded-data)

```
Array
(
	[status] => 200
	[message] => avatar Uploaded successfully
	[file] => Array
	(
	    [image] => Array
		(
		    [0] => path_to_uploaded_file.jpeg
		)

	    [new_image] => Array
		(
		    [0] => 164471880099d95c853c830f6.jpeg
		)

	    [folder] => Array
		(
		    [0] => upload/164471880099d95c853c830f6.jpeg
		)

	    [folder_real_path] => Array
		(
		    [0] => C:/xampp/htdocs/ultimateUploader-main/upload/164471880099d95c853c830f6.jpeg
		)

	    [folder_url] => Array
		(
		    [0] => http://localhost/ultimateUploader-main/upload/164471880099d95c853c830f6.jpeg
		)
	)
	[ext] => Array
	(
	    [0] => jpeg
	)
)

```

### Example Image

[](#example-image)

[![Sample Image With Watermark](https://raw.githubusercontent.com/tamedevelopers/ultimateUploader/master/164471880099d95c853c830f6.jpeg)](https://raw.githubusercontent.com/tamedevelopers/ultimateUploader/master/164471880099d95c853c830f6.jpeg)

### Example Image Original

[](#example-image-original)

```
Image size of 2.2mb

```

[![Sample Original Image](https://raw.githubusercontent.com/tamedevelopers/ultimateUploader/master/collins-lesulie-0VEDrQXxrQo-unsplash.jpg)](https://raw.githubusercontent.com/tamedevelopers/ultimateUploader/master/collins-lesulie-0VEDrQXxrQo-unsplash.jpg)

### Example Image Original - Compressed -v

[](#example-image-original---compressed--v)

```
Image compressed to 988kb
Watermarked and retain its original quality

```

[![Sample Original Compressed Image With Watermark](https://raw.githubusercontent.com/tamedevelopers/ultimateUploader/master/1644769592c599cf33805896d.jpg)](https://raw.githubusercontent.com/tamedevelopers/ultimateUploader/master/1644769592c599cf33805896d.jpg)

### Useful links

[](#useful-links)

- If you love this PHP Library, you can [Buy Tame Developers a coffee](https://www.buymeacoffee.com/tamedevelopers)
- Link to Youtube Video Tutorial on usage will be available soon

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

3

Last Release

995d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d363c130739125512fda1ddbac6287f43d4eac8bd96808d44cdd525737c16486?d=identicon)[tamedevelopers](/maintainers/tamedevelopers)

---

Tags

imageuploaderimage-uploaderphp image uploaderultimate uploaderphp image uploader libraryPhp image uploader githubpeterson image uploader

### Embed Badge

![Health badge](/badges/peterson-ultimate-uploader/health.svg)

```
[![Health](https://phpackages.com/badges/peterson-ultimate-uploader/health.svg)](https://phpackages.com/packages/peterson-ultimate-uploader)
```

###  Alternatives

[intervention/image

PHP Image Processing

14.3k194.3M2.2k](/packages/intervention-image)[league/glide

Wonderfully easy on-demand image manipulation library with an HTTP based API.

2.6k51.2M116](/packages/league-glide)[liip/imagine-bundle

This bundle provides an image manipulation abstraction toolkit for Symfony-based projects.

1.7k38.3M217](/packages/liip-imagine-bundle)[spatie/image

Manipulate images with an expressive API

1.4k54.4M138](/packages/spatie-image)[intervention/image-laravel

Laravel Integration of Intervention Image

1496.5M102](/packages/intervention-image-laravel)[intervention/gif

PHP GIF Encoder/Decoder

5520.3M9](/packages/intervention-gif)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)