├── .github └── workflows │ └── ci.yml ├── .gitignore ├── LICENSE ├── README.md ├── composer.json ├── examples ├── aspect_ratios.php ├── base64.php ├── basic.php ├── custom_errors.php ├── data_url.php ├── dimensions.php ├── images.php ├── inline.php ├── multiple_files.php └── raw_input.php ├── phpunit.xml ├── src └── Uploader.php └── tests ├── CustomErrorsTest.php ├── FileExtensionTest.php ├── FileMimeTypeTest.php ├── FileNameTest.php ├── FilePathTest.php ├── FileSizeTest.php ├── ImageAspectRatiosTest.php ├── ImageDimensionsTest.php ├── MethodsTest.php ├── MustBeImageTest.php ├── UploadTest.php └── assets ├── foo.base64 ├── foo.jpg ├── foo.json ├── foo.png ├── ratio_16_9.png ├── ratio_3_2.png ├── ratio_4_3.png └── ratio_9_16.png /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Testing Uploader 2 | on: [push, pull_request] 3 | jobs: 4 | tests: 5 | strategy: 6 | matrix: 7 | php-versions: ['7.2', '7.4', '8.0'] 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Checkout 11 | uses: actions/checkout@v2 12 | - name: Setup PHP 13 | uses: shivammathur/setup-php@v2 14 | with: 15 | php-version: ${{ matrix.php-versions }} 16 | extensions: exif, fileinfo 17 | - name: Get composer cache directory 18 | id: composer-cache 19 | run: echo "::set-output name=dir::$(composer config cache-files-dir)" 20 | - name: Cache composer dependencies 21 | uses: actions/cache@v2 22 | with: 23 | path: ${{ steps.composer-cache.outputs.dir }} 24 | key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} 25 | restore-keys: ${{ runner.os }}-composer- 26 | - name: Install dependencies 27 | run: | 28 | composer install --no-progress --prefer-dist --optimize-autoloader 29 | - name: Test with phpunit 30 | run: vendor/bin/phpunit --coverage-text -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | /.idea 3 | /vendor 4 | /composer.lock 5 | /examples/upload 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ### Uploader 🚀 2 | Safe, simple and useful file upload class for PHP 5.4+ 3 | 4 | ### Installing 5 | ``` 6 | composer require iamdual/uploader "^0.2.0" 7 | ``` 8 | 9 | ### Examples 10 | Basic: 11 | ```php 12 | use iamdual\Uploader; 13 | 14 | if (isset($_FILES["file"])) { 15 | 16 | $upload = new Uploader($_FILES["file"]); 17 | $upload->allowed_extensions(array("png", "jpg", "jpeg", "gif")); 18 | $upload->max_size(5); // in MB 19 | $upload->path("upload/files"); 20 | $upload->name("foo"); 21 | 22 | if (! $upload->upload()) { 23 | echo "Upload error: " . $upload->get_error(); 24 | } else { 25 | echo "Upload successful!"; 26 | } 27 | } 28 | ``` 29 | 30 | Inline using: 31 | ```php 32 | use iamdual\Uploader; 33 | 34 | if (isset($_FILES["file"])) { 35 | $upload = (new Uploader($_FILES["file"]))->max_size(20)->path("upload/files")->encrypt_name(); 36 | 37 | if (! $upload->upload()) { 38 | echo "Upload error: " . $upload->get_error(); 39 | } else { 40 | echo "Upload successful!"; 41 | } 42 | } 43 | ``` 44 | 45 | More examples in the "[examples](/examples)" directory. 46 | 47 | ### Methods 48 | | Name | Description | 49 | |--------------------------------------------|--------------------------------------------------------------| 50 | | `allowed_extensions(array $extensions)` | Allowed file extensions (example: png, gif, jpg) | 51 | | `disallowed_extensions(array $extensions)` | Disallowed file extensions (example: html, php, dmg) | 52 | | `allowed_types(array $types)` | Allowed mime types (example: image/png, image/jpeg) | 53 | | `disallowed_types(array $types)` | Disallowed mime types | 54 | | `max_size(int $size)` | Maximum file size (as MB) | 55 | | `min_size(int $size)` | Minimum file size (as MB) | 56 | | `override()` | Override the file with the same name | 57 | | `path(string $path)` | Set the path where files will be uploaded | 58 | | `name(string $name)` | Rename the uploaded file (example: foo) | 59 | | `encrypt_name()` | Encrypt file name to hide the original name | 60 | | `must_be_image()` | Check the file is image | 61 | | `max_dimensions(int $width, int $height)` | Maximum image dimensions | 62 | | `min_dimensions(int $width, int $height)` | Minimum image dimensions | 63 | | `aspect_ratios(array $aspect_ratios)` | Image aspect ratios that has to be (example: 1:1, 4:3, 16:9) | 64 | | `error_messages(array $errors)` | Custom error messages | 65 | 66 | | Name | Description | Return | 67 | |------------------|--------------------------------------------------|---------| 68 | | `upload()` | Upload the file and return output of the check() | boolean | 69 | | `check()` | Check the file can be uploaded | boolean | 70 | | `get_name()` | Get the uploaded file name | string | 71 | | `get_path()` | Get the uploaded file name with full path | string | 72 | | `get_tmp_name()` | Get the temporary file path | string | 73 | | `get_size()` | Get the uploaded file size in bytes | string | 74 | | `get_type()` | Get the uploaded file mime type | string | 75 | | `get_data_url()` | Get the file as base64 encoded data URL | string | 76 | | `get_error()` | Get error message if an error occurred | string | 77 | 78 | ### Notes 79 | `exif` and `fileinfo` extensions must be enabled. 80 | 81 | ### Contributes 82 | Please send pull request or open an issue if you have the feature you want. 83 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "iamdual/uploader", 3 | "description": "Safe, simple and useful file upload class for PHP.", 4 | "homepage": "https://github.com/iamdual/uploader", 5 | "type": "library", 6 | "license": "Apache-2.0", 7 | "authors": [ 8 | { 9 | "name": "Ekin Karadeniz", 10 | "email": "iamdual@protonmail.com" 11 | } 12 | ], 13 | "require": { 14 | "php": ">=5.4.0" 15 | }, 16 | "autoload": { 17 | "psr-4": { 18 | "iamdual\\": "src/" 19 | } 20 | }, 21 | "require-dev": { 22 | "phpunit/phpunit": "^8" 23 | }, 24 | "scripts": { 25 | "test": "phpunit" 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /examples/aspect_ratios.php: -------------------------------------------------------------------------------- 1 | must_be_image(); 10 | $upload->aspect_ratios(array("16:9", "1:1")); 11 | $upload->max_size(5); // in MB 12 | $upload->path("upload/files"); 13 | 14 | if (!$upload->upload()) { 15 | echo "Upload error: " . $upload->get_error(); 16 | } else { 17 | echo "Upload successful!"; 18 | } 19 | 20 | } 21 | ?> 22 | 23 |
26 | -------------------------------------------------------------------------------- /examples/base64.php: -------------------------------------------------------------------------------- 1 | allowed_extensions(array("png", "jpg", "jpeg", "gif")); 10 | $upload->max_size(5); // in MB 11 | $upload->path("upload/files"); 12 | $upload->name("unicorn"); 13 | 14 | // While uploading file from base64 encoded file, you need to enable the "copy file" feature 15 | // by appending "true" to the upload() method. Otherwise file can not be uploaded! 16 | 17 | if (! $upload->upload(true)) { 18 | echo "Upload error: " . $upload->get_error(); 19 | } else { 20 | echo "Upload successful: " . $upload->get_name(); 21 | } 22 | 23 | } 24 | ?> 25 | 26 | 29 | -------------------------------------------------------------------------------- /examples/basic.php: -------------------------------------------------------------------------------- 1 | allowed_extensions(array("png", "jpg", "jpeg", "gif")); 10 | $upload->allowed_types(array("image/png", "image/jpeg", "image/gif")); // not recommended 11 | $upload->max_size(5); // in MB 12 | $upload->min_size(0); // in MB 13 | $upload->path("upload/files"); 14 | $upload->encrypt_name(); 15 | 16 | if (!$upload->upload()) { 17 | echo "Upload error: " . $upload->get_error(); 18 | } else { 19 | echo "Upload successful: " . $upload->get_name(); 20 | } 21 | 22 | } 23 | ?> 24 | 25 | 28 | -------------------------------------------------------------------------------- /examples/custom_errors.php: -------------------------------------------------------------------------------- 1 | error_messages(array( 10 | $upload::ERR_LONG_SIZE => "Fil3 siz3 is t00 l0ng!", 11 | $upload::ERR_INVALID_EXT => "Inv4lid 3xt3nsi0n!", 12 | )); 13 | $upload->max_size(0.2); // in MB 14 | $upload->allowed_extensions(array("baz")); 15 | $upload->path("upload/files"); 16 | 17 | if (!$upload->upload()) { 18 | echo "Upload error: " . $upload->get_error(); 19 | } else { 20 | echo "Upload successful!"; 21 | } 22 | 23 | } 24 | ?> 25 | 26 | 29 | -------------------------------------------------------------------------------- /examples/data_url.php: -------------------------------------------------------------------------------- 1 | allowed_extensions(array("png", "jpg", "jpeg", "gif")); 10 | $upload->max_size(5); // in MB 11 | 12 | if (!$upload->check()) { 13 | echo "An error occurred: " . $upload->get_error(); 14 | } else { 15 | echo 'Base64 encoded data URL: