recommerce/asset

This package is abandoned and no longer maintained. No replacement package was suggested.

There is no license information available for the latest version (5.1.0) of this package.

5.1.0 2018-07-23 12:33 UTC

Requires

• aws/aws-sdk-php: ^3.0
• zendframework/zend-servicemanager: ^3.0

Requires (Dev)

• behat/behat: 2.5.*
• codeclimate/php-test-reporter: dev-master
• halleck45/phpmetrics: ^1.1
• humbug/humbug: ~1.0@dev
• pdepend/pdepend: ^2.0
• phing/phing: ^2.10
• phpmd/phpmd: ^2.2
• phpunit/phpunit: ^5.7
• sebastian/phpcpd: ^2.0
• squizlabs/php_codesniffer: ^2.3

Unknown License

README

Recommerce asset

This library provides an interface and some implementation to handle files on assets.

Current implementations are :

• AWS S3 : Amazon S3 service (using AWS S3 SDK library) ;
• FileSystem : Use your local file system as asset ;
• FTP : FTP server (not SFTP).

Installation with composer

composer require recommerce/asset:^3.0
composer update

Usage examples

AWS S3 client creation

Direct config

    use Recommerce\Asset\Adapter\Factory\S3ClientFactory;
    use Recommerce\Asset\AssetFactory;

    $config = [
        'factory' => S3ClientFactory::class,
        'params' => [
            'key'    => 'YOUR_S3_KEY',
            'secret' => 'YOUR_S3_SECRET',
            'region' => 'YOUR_AWS_REGION',
            'bucket' => 'YOUR_S3_BUCKET_NAME'
        ]
    ];

    $assetClient = (new AssetFactory())->createServiceFromConfig($config);

Service manager

    use Recommerce\Asset\Adapter\Factory\S3ClientFactory;
    use Recommerce\Asset\AssetFactory;
    use Zend\ServiceManager\Config;
    use Zend\ServiceManager\ServiceManager;

    $config = [
        'asset' => [
            'factory' => S3ClientFactory::class,
            'params' => [
                'key'    => 'YOUR_S3_KEY',
                'secret' => 'YOUR_S3_SECRET',
                'region' => 'YOUR_AWS_REGION',
                'bucket' => 'YOUR_S3_BUCKET_NAME'
            ]
        ],
        'service_manager' => [
            'factories' => [
                'recommerce.asset.asset-client' => AssetFactory::class
            ]
        ]
    ];

    $serviceManager = new ServiceManager(new Config($config['service_manager']));
    $serviceManager->setService('Config', $config);

    $assetClient = $serviceManager->get('recommerce.asset.asset-client');

Optionnal arguments

    use Recommerce\Asset\Adapter\Factory\S3ClientFactory;
    use Recommerce\Asset\AssetFactory;

    $config = [
        'factory' => S3ClientFactory::class,
        'params' => [
            'key'    => 'YOUR_S3_KEY',
            'secret' => 'YOUR_S3_SECRET',
            'region' => 'YOUR_AWS_REGION',
            'bucket' => 'YOUR_S3_BUCKET_NAME',
            'tmpDir' => 'YOUR_LOCAL_TMP_DIR',
            'rootUrl' => 'BASE_URI_TO_S3_REPO'
            'isPrivate' => true|false
        ]
    ];

    $assetClient = (new AssetFactory())->createServiceFromConfig($config);

Optional arguments added below allow :

• 'tmpDir' : (default to /tmp) Specify absolute path to local temporary directory
• 'rootUrl' : Root URL to the S3 bucket, useful when generating full URL from a filename $assetClient->getUrl('relative_path/to/file');
• 'isPrivate' : Whether files created throught this S3Client instance will have private or public read access

Filesystem client creation

Direct config

    use Recommerce\Asset\AssetFactory;
    use Recommerce\Asset\Adapter\Factory\FileSystemClientFactory;

    $config = [
        'factory' => FileSystemClientFactory::class,
        'params' => [
            'repository' => 'YOUR_LOCAL_ASSET_REPOSITORY'
        ]
    ];

    $assetClient = (new AssetFactory())->createServiceFromConfig($config);

FTP client creation

Direct config

    use Recommerce\Asset\AssetFactory;
    use Recommerce\Asset\Adapter\Factory\FtpClientFactory;

    $config = [
        'factory' => FtpClientFactory::class,
        'params' => [
            'hostname' => 'YOUR_HOST',
            'username' => 'YOUR_USERNAME',
            'password' => 'YOUR_PASSWORD',
            'port' => 'YOUR_PORT' // 21 by default,
        ]
    ];

    $assetClient = (new AssetFactory())->createServiceFromConfig($config);

Basics

// Get asset file on local file system
$assetClient->get('path/to/remote_file.png', '/tmp/my_local_file.png');

// Put local file on asset
$assetClient->put('/tmp/my_local_file.png', 'path/to/remote_file.png');

// Check file existence on asset
$assetClient->exists('path/to/remote_file.png');

// Remove asset file
$assetClient->remove('path/to/remote_file.png');