# epuzzle/magento2-module-file-uploader

> This module provides file upload functionality.

`composer require epuzzle/magento2-module-file-uploader`

Canonical URL: https://packagento.com/epuzzle/magento2-module-file-uploader

## At a glance

- **Vendor**: epuzzle (https://packagento.com/epuzzle.md)
- **Latest version**: 1.0.1 — released 2025-09-22
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/epuzzle/magento2-module-file-uploader and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require epuzzle/magento2-module-file-uploader:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

This module provides file upload functionality.

## README

Welcome to the File Uploader module!  
This module adds file upload functionality to Adobe Commerce / Magento 2.

## Builds Status

[![Magento 2.4.7 Actions Status](https://github.com/epuzzle/magento2-module-file-uploader/workflows/magento247/badge.svg)](https://github.com/epuzzle/magento2-module-file-uploader/actions)
[![Magento 2.4.8 Actions Status](https://github.com/epuzzle/magento2-module-file-uploader/workflows/magento248/badge.svg)](https://github.com/epuzzle/magento2-module-file-uploader/actions)

## Requirements

1. [Installed Magento 2 System](https://devdocs.magento.com/guides/v2.4/install-gde/bk-install-guide.html)
2. [Magento System Requirements](https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html)

## Supported Magento 2 versions

| **Version**                              | **Status** | **Notes** |
|------------------------------------------|------------|-----------|
| Magento Open Source/Adobe Commerce 2.3.* | ✗          |           |
| Magento Open Source 2.4.3                | ✗          |           |
| Adobe Commerce 2.4.4+                    | ✓          |           |
| Magento Open Source 2.4.4+               | ✓          |           |

## Documentation

* [Wiki](https://github.com/epuzzle/magento2-module-file-uploader/wiki)
* [Installation Guide](https://github.com/epuzzle/magento2-module-file-uploader/wiki/Installation-Guide)
* [User Guide](https://github.com/epuzzle/magento2-module-file-uploader/wiki/User-Guide)

## Postman API

Use the ready-to-run Postman collection to explore and test File Uploader API endpoints.

[<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/9225084-426b26e6-37b3-4779-aeed-fa87888221d2?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D9225084-426b26e6-37b3-4779-aeed-fa87888221d2%26entityType%3Dcollection%26workspaceId%3Ddbf5d198-105d-43d3-b911-f9fc763d1a07#?env%5BePuzzle%20Backend%20Localhost%5D=W3sia2V5IjoiYXBpVXJsIiwidmFsdWUiOiJodHRwczovL2VwdXp6bGUtYmFja2VuZC5sb2NhbC9yZXN0LyIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJzZWNyZXQiLCJkZXNjcmlwdGlvbiI6IiJ9LHsia2V5IjoiYXBpVG9rZW4iLCJ2YWx1ZSI6IjxKU09OX1dFQl9UT0tFTj4iLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0IiwiZGVzY3JpcHRpb24iOiIifV0=)

## License

Copyright (c) 2025 ePuzzle contributors.  
This module is [MIT licensed](./LICENSE).
Project coordinator: [support@epuzzle.org](mailto:support@epuzzle.org)

## Changelog

1.0.1
=============

* Important changes:
    * Changed ACL `anonymous` to `EPuzzle_FileUploader::upload_file` for upload endpoint
* New features:
    * Added unit tests
    * Added github actions

1.0.0
=============

* New features:
    * Upload files using several sources: $_FILES, external URL, system file
    * Storage for all uploaded files
    * Rest API to manage the list of files

## Recent Versions

| Version | Released |
|---|---|
| 1.0.1 | 2025-09-22 |
| 1.0.0 | 2025-09-04 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| epuzzle/magento2-module-base | ^1.0 |
| ext-fileinfo | * |
| magento/framework | * |

## Quality

Latest release (1.0.1) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 1 | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Pass | 0 |  |
| PHPMD | Warning | 4 | 4 rule violations (MissingImport:2, IfStatementAssignment:1, UnusedLocalVariable:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 1 | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["epuzzle/magento2-module-file-uploader"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

epuzzle is a Magento 2 vendor on Packagento. See https://packagento.com/epuzzle.md for their full catalogue.

