app-verk/google-cloud-storage-media-bundle

AppVerk media bundle uploading into Google Cloud Storage

v1.1.0 2022-01-23 10:02 UTC

This package is auto-updated.

Last update: 2022-09-11 07:22:37 UTC


README

Symfony Media Bundle. The bundle allow in easy way upload files. The bundle required to working dropzone.js script.

Configure

Require the bundle with composer:

$ composer require app-verk/google-cloud-storage-media-bundle

Enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new AppVerk\GoogleCloudStorageMediaBundle\GoogleCloudStorageMediaBundle(),
        // ...
    );
}

Create your Media class:

<?php

namespace AppBundle\Entity;

use AppVerk\GoogleCloudStorageMediaBundle\Entity\Media as BaseMedia;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity()
 */
class Media extends BaseMedia
{

}

Add to config.yml:

twig:
    form:
        resources:
            - 'GoogleCloudStorageMediaBundle:form:fields.html.twig'
            
google_cloud_storage_media:
    namer: "AppVerk\\GoogleCloudStorageMediaBundle\\Namer\\DefaultNamer"
    filesystem: "default.storage"
    filesystem_url_retriever: 'AppVerk\GoogleCloudStorageMediaBundle\Flysystem\Retriever\LocalObjectUrlRetriever'
    entities:
        media_class: AppBundle\Entity\Media
    gcs:
        project_id: 123
        bucket_id: my_bucket
        key_file_path: "default"
    allowed_mime_types: ["image/jpeg", "image/jpg", "image/png", "image/gif", "application/pdf"]

Add to routing.yml:

media:
    resource: '@GoogleCloudStorageMediaBundle/Controller/'
    type: annotation

Add these libs into your admin panel:

<!--css -->
<link rel="stylesheet" href="{{ asset('bundles/media/css/dropzone.min.css') }}" />

<!-- js -->
<script src="{{ asset('bundles/media/js/dropzone.min.js') }}"></script>

Update your database schema:

$ php app/console doctrine:schema:update --force

Media Form Type

<?php

use Symfony\Component\Form\AbstractType;
use AppVerk\GoogleCloudStorageMediaBundle\Form\Type\MediaType;
use Symfony\Component\Form\FormBuilderInterface;

class Post extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $formMapper
            ->add('image', MediaType::class)
        ;
    }
}

Twig helper

Render a media:

<img src="{{ post.media|media }}" />

Group of validation

Bundle allow to validation every single used MediaType in different way. For example you want to allow only PDF files:

You need to add group into config.yml:

media:
    entities:
        media_class: AppBundle\Entity\Media
    allowed_mime_types: ["image/png", "image/gif"]
    max_file_size: 15000000
    groups:
        lorem:
            allowed_mime_types: ["application/pdf"]
            max_file_size: 560000

Set group in MediaType:

$formMapper->add('image', MediaType::class, [
    'group' => 'lorem'
]);

Using new StorageService and flysystem layer

In order to use the new AppVerk\GoogleCloudStorageMediaBundle\Service\v2\StorageService you have to:

Configure flysystem correctly (example):

config/packages/flysystem.yaml

flysystem:
    storages:
        default.storage:
            adapter: 'gcloud'
            public: true
            options:
                client: 'gcloud_client_service'
                bucket: 'some-bucket-name'

config/services/storage.yaml

parameters:

services:
    _defaults:
        autowire: true
        autoconfigure: true

    gcloud_client_service:
        class: Google\Cloud\Storage\StorageClient
        arguments:
            - projectId: '%google_cloud_storage_media.gcs.project_id%'
              keyFilePath: '%google_cloud_storage_media.gcs.key_file_path%'

Then, configure media bundle accordingly config/packages/google_cloud_storage_media.yaml

google_cloud_storage_media:
    ...
    gcs:
        project_id: your-project-id
        bucket_id: your-bucket-id
        key_file_path: path-to-keyfile
    namer: "AppVerk\\GoogleCloudStorageMediaBundle\\Namer\\NamerInterface" # default
    filesystem: "default.storage" # use your storage name from flysystem here
    filesystem_url_retriever: 'AppVerk\GoogleCloudStorageMediaBundle\Flysystem\Retriever\GoogleObjectUrlRetriever' # configure url retriever for proper path storing

License

The bundle is released under the MIT License.