PHPackages                             cusodede/yii2-s3-module - 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. [File & Storage](/categories/file-storage)
4. /
5. cusodede/yii2-s3-module

ActiveYii2-module[File & Storage](/categories/file-storage)

cusodede/yii2-s3-module
=======================

S3 support module

1.1.0(9mo ago)21035[3 issues](https://github.com/cusodede/yii2-s3-module/issues)proprietaryPHPPHP >=8.1CI passing

Since Apr 1Pushed 9mo ago1 watchersCompare

[ Source](https://github.com/cusodede/yii2-s3-module)[ Packagist](https://packagist.org/packages/cusodede/yii2-s3-module)[ RSS](/packages/cusodede-yii2-s3-module/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (15)Versions (27)Used By (0)

yii2-s3-module
==============

[](#yii2-s3-module)

[![Build Status](https://github.com/cusodede/yii2-s3-module/actions/workflows/ci.yml/badge.svg)](https://github.com/cusodede/yii2-s3-module/actions)

S3 support module (file-manager and stuff).

Installation with Composer
==========================

[](#installation-with-composer)

Run

```
php composer.phar require cusodede/yii2-s3-module "^1.0.0"

```

or add

```
"cusodede/yii2-s3-module": "^1.0.0"

```

to the require section of your `composer.json` file.

Module migration
================

[](#module-migration)

Module needs to store file data in database tables, which will be created by

```
php yii migrate/up --migrationPath=@vendor/cusodede/yii2-s3-module/migrations

```

command. You can customize table names by define `tableName` and `tagsTableName` parameters in module configuration.

Configuration parameters
========================

[](#configuration-parameters)

See example config below:

```
return [
    // ...
    'modules' => [
        's3' => [
            'class' => cusodede\s3\S3Module::class,
            'defaultRoute' => 'index',
            'params' => [
                'connection' => [
                    'host' => 'minio_host',
                    'login' => 'minio_user',
                    'password' => 'minio_password',
                    'connect_timeout' => 10, /* http connection timeout */
                    'timeout' => 10, /* http timeout */
                    'cert_path' => null, /* path to ssl certificate, set null to disable */
                    'cert_password' => null /* certificate password, set null, if certificate has no password */
                ],
                'tableName' => 'sys_cloud_storage', /* the table with storage data info, see Module migration section */
                'tagsTableName' => 'sys_cloud_storage_tags', /* the table with local tags, see Module migration section */
                'viewPath' => '@vendor/cusodede/yii2-s3-module/src/views/index', /* path to view templates, if you want to customize them */
                'maxUploadFileSize' => null, /* a file size limit for uploaded file, set null to disable */
                'defaultBucket' => 'bucket', /* a name of bucket, used by default, if null, an alphabetically first bucket will be used */
                'mimeTypes' => [
                    'apk' => 'application/vnd.android.package-archive',
                ],/* mime types list (ext => mime), used for downloaded files mime substitution. Note: that list overrides a magic.mime file information. */
                'defaultMimeType' => 'application/octet-stream', /* mime type, that be used for any file, which extension aren't included in mimeTypes parameter or in magic.mime */
                'deleteTempFiles' => true /* delete php temp files after upload */
                'instance' => null, /* String: an additional instance name (useful for connection definition, if several connections are used. Null: disabled */
                'dateFormat' => 'Y-m-d H:i:s' /* timestamp date format for created_at field. Also can be set via closure like 'dateFormat' => function() => DateTimeImmutable::createFromFormat('Y-m-d H:i:s.uO', '2009-02-15') */
            ]
        ]
    ]
    // ...
]
```

How to handle multiple connections to different S3 servers?
===========================================================

[](#how-to-handle-multiple-connections-to-different-s3-servers)

It is possible to configure multiple named connections in `params.connection` section:

```
return [
    // ...
    'modules' => [
        's3' => [
            'class' => cusodede\s3\S3Module::class,
            'defaultRoute' => 'index',
            'params' => [
                'connection' => [
                    'FirstS3Connection' => [
                        'host' => 'minio_host_one',
                        'login' => 'minio_user',
                        'password' => 'minio_password',
                        'connect_timeout' => 10,
                        'timeout' => 10,
                        'cert_path' => null,
                        'cert_password' => null,
                        'defaultBucket' => 'first_host_bucket' /* note that you can set default bucket for each connection separately */
                    ],
                    'SecondS3Connection' => [
                        'host' => 'minio_host_two',
                        'login' => 'minio_user',
                        'password' => 'minio_password',
                        'connect_timeout' => 10,
                        'timeout' => 10,
                        'cert_path' => null,
                        'cert_password' => null,
                        'defaultBucket' => 'second_host_bucket'
                    ]
                ],
                'tableName' => 'sys_cloud_storage',
                'tagsTableName' => 'sys_cloud_storage_tags',
                'viewPath' => './src/views/index',
                'defaultBucket' => 'testbucket',
                'maxUploadFileSize' => null,
                'deleteTempFiles' => true,
            ]
        ]
    ]
    // ...
]
```

and use them like this:

```
S3Helper::FileToStorage($filePath, connection: 'FirstS3Connection');
```

or

```
$s3 = new S3(['connection' => 'SecondS3Connection']);
```

`connection` parameter can be skipped, even for multiple connections configurations. In that case first connection in list will be used.

How to handle stream uploads via multipart/form-data?
=====================================================

[](#how-to-handle-stream-uploads-via-multipartform-data)

At first, configure [MultipartFormDataParser](https://www.yiiframework.com/doc/api/2.0/yii-web-multipartformdataparser)as request parser for multipart/form-data:

```
return [
    'components' => [
        'request' => [
            'parsers' => [
                'multipart/form-data' => yii\web\MultipartFormDataParser::class
            ],
        ],
        // ...
    ],
    // ...
];
```

that's all. Now it is possible to do stream uploads via `PUT` method. You can use an any proper JS-based widget (like `limion/yii2-jquery-fileupload-widget`) to do this. See also views/index/put.php for example.

Local tagging
=============

[](#local-tagging)

It is possible to mark uploads with tags, what may be used for quick searches. Tags will be stored in the local table and also will be assigned to S3 object. But it works only to one side: tags from S3 objects will not be synchronized to local table. It is possible to sync local and remote tags, see `CloudStorage::syncTagsFromS3()` and `CloudStorage::syncTagsToS3()` methods.

Development and Testing
=======================

[](#development-and-testing)

Prerequisites
-------------

[](#prerequisites)

- Docker and Docker Compose
- PHP 8.1+ (for local development)

Running Tests
-------------

[](#running-tests)

This project supports testing with PHP 8.1 and PHP 8.4 using Docker containers.

### Docker Testing (Recommended)

[](#docker-testing-recommended)

The project uses a unified Docker environment for both development and testing. Services are started once and reused between test runs for maximum efficiency.

**Quick Start:**

```
# Start the development environment (PostgreSQL + MinIO + PHP containers)
make up

# Run all tests (PHP 8.1 and 8.4)
make test

# Stop the environment when done
make down
```

**Detailed Commands:**

```
# Environment management
make up            # Start all services
make down          # Stop all services
make restart       # Restart all services
make status        # Show container status

# Testing
make test          # Run tests on both PHP versions
make test81        # Run tests on PHP 8.1 only
make test84        # Run tests on PHP 8.4 only
make quick-test    # Quick tests (no composer install)

# Development
make shell81       # Access PHP 8.1 container shell
make shell84       # Access PHP 8.4 container shell
make composer-install  # Install dependencies in both containers

# Setup
make build         # Build Docker images
make rebuild       # Force rebuild (after Dockerfile changes)
```

### Windows Testing

[](#windows-testing)

Windows users can use the same `make` commands if they have Docker Desktop and Git Bash, or use Docker Compose directly:

```
# Start environment
docker compose up -d

# Run tests
docker compose exec php-8.1 vendor/bin/codecept run -v --debug
docker compose exec php-8.4 vendor/bin/codecept run -v --debug

# Stop environment
docker compose down
```

### Local Testing (Without Docker)

[](#local-testing-without-docker)

Requirements:

- PHP 8.1+
- PostgreSQL
- MinIO server

1. Copy and configure environment:

    ```
    cp tests/.env.example tests/.env
    # Edit tests/.env with your local database and MinIO settings
    ```
2. Install dependencies:

    ```
    composer install
    ```
3. Run tests:

    ```
    php vendor/bin/codecept run

    # Run specific test suites
    php vendor/bin/codecept run unit
    php vendor/bin/codecept run functional
    php vendor/bin/codecept run console
    ```

Test Environment
----------------

[](#test-environment)

### Continuous Integration

[](#continuous-integration)

Tests run automatically on GitHub Actions for PHP 8.1 and 8.4 with:

- **PostgreSQL 13.4** database service
- **MinIO** S3-compatible storage service
- All required PHP extensions (zip, pdo\_pgsql, sockets, bcmath, pcntl, intl, mbstring)

### Local Docker Testing

[](#local-docker-testing)

The Docker setup includes:

- **PHP 8.1/8.4 containers** with all required extensions
- **PostgreSQL** for database testing
- **MinIO** S3-compatible storage server

Test configuration is defined in:

- `codeception.yml` - Main test configuration
- `tests/*.suite.yml` - Test suite configurations
- `tests/.env` - Test environment variables
- `tests/.env.ci` - CI environment variables
- `docker-compose.yml` - Unified Docker environment
- `docker/` - PHP container definitions

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance38

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 79.7% of commits — single point of failure

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 ~51 days

Recently: every ~174 days

Total

25

Last Release

276d ago

PHP version history (2 changes)1.0.0PHP >=8.0

1.1.0PHP >=8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/76ddc43524bb32eb36568e25b6ae283bc25bb51a4572789997909092145af0f5?d=identicon)[pozitronik](/maintainers/pozitronik)

---

Top Contributors

[![pozitronik](https://avatars.githubusercontent.com/u/2357892?v=4)](https://github.com/pozitronik "pozitronik (196 commits)")[![s1lver](https://avatars.githubusercontent.com/u/4567634?v=4)](https://github.com/s1lver "s1lver (18 commits)")[![mvaload](https://avatars.githubusercontent.com/u/24808041?v=4)](https://github.com/mvaload "mvaload (16 commits)")[![antonshevelev](https://avatars.githubusercontent.com/u/10631259?v=4)](https://github.com/antonshevelev "antonshevelev (15 commits)")[![vabazarnov](https://avatars.githubusercontent.com/u/114988852?v=4)](https://github.com/vabazarnov "vabazarnov (1 commits)")

---

Tags

miniophps3yii2s3yii2modulecloud-storageminio

###  Code Quality

TestsCodeception

### Embed Badge

![Health badge](/badges/cusodede-yii2-s3-module/health.svg)

```
[![Health](https://phpackages.com/badges/cusodede-yii2-s3-module/health.svg)](https://phpackages.com/packages/cusodede-yii2-s3-module)
```

###  Alternatives

[fedemotta/yii2-aws-sdk

This extension provides the AWS SDK integration for the Yii2 framework

15430.4k2](/packages/fedemotta-yii2-aws-sdk)

PHPackages © 2026

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