arkounay/image-bundle

Easier image upload form bundle with Doctrine

Not maintained. Use artgris/FileManagerBundle with artgris/MediaBundle instead.

Arkounay Image Bundle - Symfony Easier Doctrine image management

, _(*1)

Getting Started

• Download the files:, _(*2)

  composer require arkounay/image-bundle

• In AppKernel.php add the bundle:, _(*3)

  new Arkounay\ImageBundle\ArkounayImageBundle()

• Then, run the following command:, _(*4)

  php bin/console assets:install 

• In your twig template, you will then need to import the required assets:, _(*5)

  • CSS:, _(*6)

    <link rel="stylesheet" href="{{ asset('bundles/arkounayimage/arkounay_image_bundle.css') }}">

  • JS (requires jQuery, ninsuo/symfony-collection and optionally bootstrap, Font Awesome and jQuery UI):, _(*7)

    {# Import jQuery: #}
    <script src="https://code.jquery.com/jquery-3.1.1.min.js"></script>
    
    {# Then the default bundle's JavaScript: #}
    {% include '@ArkounayImage/assets/include_js.html.twig' %}

• In routing.yml, you will need to import the Ajax route:, _(*8)

   arkounay_image:
       resource: "@ArkounayImageBundle/Resources/config/routing.yml"

• In config.yml, add the following Doctrine types:, _(*9)

  doctrine:
      dbal:
          types:
              json_image: Arkounay\ImageBundle\Type\JsonImageType
              json_images: Arkounay\ImageBundle\Type\JsonImagesType

Usage

In an entity, you can now add the new json_image types:, _(*10)

/**
 * @var Image
 * @ORM\Column(type="json_image")
 */
private $image;

/**
 * @var ArrayCollection|Image[]
 * @ORM\Column(type="json_images")
 */
private $imageCollection;

public function __construct()
{
    $this->imageCollection = new ArrayCollection();
}

You can bound these fields to a form using its corresponding type:, _(*11)

use Arkounay\ImageBundle\Form\JsonImagesType;
use Arkounay\ImageBundle\Form\JsonImageType;

// ... 

$builder
    ->add('image', JsonImageType::class)
    ->add('imageCollection', JsonImagesType::class);

Options:

JsonImageType: - 'allow_alt' => true allows the user to specify an alt - 'path_readonly' => false prevents the user from manually changing the path (it only adds a "readonly" attribute to the corresponding HTML input), _(*12)

JsonsImageType:, _(*13)

Some ninsuo/symfony-collection's options are available directly: - 'min' => 0 - 'max' => 100 - 'init_with_n_elements' => 1 - 'add_at_the_end' => true, _(*14)

About the form HTML theme

Include bootstrap's theme, _(*15)

{% form_theme form ':admin/includes:bootstrap_3_layout.html.twig' %}

To override the widget theme, check Resources/views/forms/fields.html.twig., _(*16)

Other

• By default, only ROLE_ADMIN can upload images. You can specify roles in config.yml, ie:, _(*17)

  arkounay_image:
      roles: ['ROLE_SUPER_ADMIN']

• This bundle works with EasyAdminBundle, you can for example add multiple images by specifying the proper type:, _(*18)

  { property: 'imageCollection', type: 'Arkounay\ImageBundle\Form\JsonImagesType', type_options: {allow_add: true} }