sidus/file-upload-bundle

Allow to upload files directly in Doctrine entities, based on oneup/uploader-bundle and jQuery-file-upload

Sidus/FileUploadBundle

This bundle allows you to define Doctrine entities linked to a virtual filesystem entry through the Flysystem storage layer., _(*1)

This means that when uploading a file, it will automatically create a corresponding entity in your database matching your resource type., _(*2)

WARNING: These entities are meant to be associated to other Doctrine entities, not really managed by themselves: If you want to add a title and a description to a file, create a different entity and create an association to the resource., _(*3)

The upload part is handled by the Oneup Uploader Bundle with very little magic added to it., _(*4)

This documentation is a work in progress, the bundle is working as is but might require more configuration than what is explained here., _(*5)

Installation

You will need to include jQuery in your project on your own., _(*6)

$ composer require sidus/file-upload-bundle

Update your Kernel:, _(*7)

<?php

class AppKernel
{
    /**
     * {@inheritdoc}
     */
    public function registerBundles()
    {
        $bundles = [
            // ...
            new Oneup\UploaderBundle\OneupUploaderBundle(),
            new Oneup\FlysystemBundle\OneupFlysystemBundle(),
            new Sidus\FileUploadBundle\SidusFileUploadBundle(),
            // ...
        ];
        // ...
    }
}

Note: The order is very important because we override some parameters frop Oneup., _(*8)

Additional configuration in your composer.json to expose the jquery-fileupload vendor in public directory of this bundle., _(*9)

{
    "scripts": {
        "symfony-scripts": [
            // Append this before the clear-cache script
            "Sidus\\FileUploadBundle\\Composer\\ScriptHandler::symlinkJQueryFileUpload"
        ]
    }
}

Configuration example for OneUploader using Flysystem with local filesystem., _(*10)

Note that in order for Sidus/FileUpload to work, the keys for the OneUploader, Flysystem and Sidus must match., _(*11)

# one uploader
oneup_uploader:
    mappings:
        document:
            frontend: blueimp
            storage:
                type: flysystem
                filesystem: oneup_flysystem.document_filesystem
            max_size: 64000000

oneup_flysystem:
    adapters:
        my_adapter:
            local:
                directory: '%kernel.root_dir%/../var/data/resources'
    filesystems:
        document:
            adapter: my_adapter

Note the reference in Oneup Uploader to the Flysystem filesystem :, _(*12)

document -> oneup_flysystem.document_filesystem, _(*13)

Now define your uploadable entities, being careful with the configuration keys, _(*14)

sidus_file_upload:
    configurations:
        document: # This key will be the entrypoint to any fileupload form widget
            entity: MyNamespace\AssetBundle\Entity\Document
            filesystem: document # Optional, defaults to configuration key
            uploader: document # Optional, defaults to configuration key

Add the upload routes to your routing:, _(*15)

sidus_file_upload:
    resource: "@SidusFileUploadBundle/Resources/config/routing.yml"

Minimum requirements for your entity, _(*16)

<?php

namespace MyNamespace\AssetBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Sidus\FileUploadBundle\Entity\Resource;

/**
 * @ORM\Entity(repositoryClass="Sidus\FileUploadBundle\Entity\ResourceRepository")
 */
class Document extends Resource
{
    /**
     * @return string
     */
    public static function getType()
    {
        return 'document'; // Must match your mapping key
    }
}

Load the necessary CSS and JS in your layout (there are many way to do this), _(*17)

'bundles/sidusfileupload/css/fileupload.css'

'bundles/sidusfileupload/vendor/jquery-file-upload/js/jquery.fileupload.js'
'bundles/sidusfileupload/vendor/jquery-file-upload/js/jquery.fileupload-jquery-ui.js'
'bundles/sidusfileupload/vendor/jquery-file-upload/js/jquery.iframe-transport.js'
'bundles/sidusfileupload/js/jquery.fileupload.sidus.js'

To load the widget on document initialization (not exactly the proper way to do it...), _(*18)

$(document).find('.fileupload-widget').each(function () {
    $(this).sidusFileUpload();
});

When creating a form, you can simply use the "sidus_resource" type to declare the field as an upload. You will only require to set the "resource_type" options corresponding to the entity you want to use., _(*19)

Serializer

If you want the Symfony serializer support, you also need to require this:, _(*20)

$ composer require sidus/base-serializer-bundle

You need to enable these bundles in your kernel:, _(*21)

<?php

class AppKernel
{
    /**
     * {@inheritdoc}
     */
    public function registerBundles()
    {
        $bundles = [
            // ...
            new Sidus\BaseBundle\SidusBaseBundle(),
            new Sidus\BaseSerializerBundle\SidusBaseSerializerBundle(),
            // Then the one documented in the install process
            new Oneup\UploaderBundle\OneupUploaderBundle(),
            new Oneup\FlysystemBundle\OneupFlysystemBundle(),
            new Sidus\FileUploadBundle\SidusFileUploadBundle(),
            // ...
        ];
        // ...
    }
}

And last, you need to enable serializer support in the configuration:, _(*22)

sidus_file_upload:
    enable_serializer: true