it-blaster/attach-file-bundle

Symfony2 bundle. The ability to attach files to the form.

v1.0.1 2016-02-01 09:38 UTC

This package is not auto-updated.

Last update: 2022-05-28 04:26:37 UTC


README

Build Status Scrutinizer Code Quality

Вспомогательный бандл для работы с файлами на сайте. Есть возмжность прикреплять несколько файлов к одной сущности. Есть поддержка языковых версий.

Installation

Добавьте ItBlasterAttachFileBundle в composer.json:

{
    "require": {
        "it-blaster/attach-file-bundle": "dev-master"
	},
}

Теперь запустите композер, чтобы скачать бандл командой:

$ php composer.phar update it-blaster/attach-file-bundle

Композер установит бандл в папку проекта vendor/it-blaster/attach-file-bundle.

Далее подключите бандл в ядре AppKernel.php:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new ItBlaster\AttachFileBundle\ItBlasterAttachFileBundle(),
    );
}

В app/config/config.yml необходимо указать путь до класса бихейвора it_blaster_file и подключить шаблон виджета attach_file:

 propel:
     ...
     behaviors:
         ...
         it_blaster_file: ItBlaster\AttachFileBundle\Behavior\AttachFileBehavior

twig:
    form:
        resources:
            - 'ItBlasterAttachFileBundle:Form:attach_file_widget.html.twig'

assetic:
    bundles:
        - 'ItBlasterAttachFileBundle'

В файл app/config/routing.yml необходимо подключить роутинг-файл бандла:

attach_file:
    resource: '@ItBlasterAttachFileBundle/Resources/config/routing.yml'

Usage

В файле schema.yml подключите бихейвор it_blaster_file

    <table name="example">
        <column name="id"           type="integer"  required="true" primaryKey="true" autoIncrement="true" />
        <column name="title"        type="varchar"  required="true" primaryString="true" />
        <column name="image"        type="integer" />

        <behavior name="it_blaster_file" >
            <parameter name="file_columns" value="image" />
        </behavior>
    </table>

В параметре file_columns необходимо указать имя поля изображения. В данном примере этим полем является поле image. Если к сущности необходимо прекреплять несколько файлов, названия полей в параметре file_columns нужно указать через запятую, например:

    <table name="example">
        <column name="id"           type="integer"  required="true" primaryKey="true" autoIncrement="true" />
        <column name="title"        type="varchar"  required="true" primaryString="true" />
        <column name="logo"         type="integer" />
        <column name="sheet"        type="integer" />

        <behavior name="it_blaster_file" >
            <parameter name="file_columns" value="logo, sheet" />
        </behavior>
    </table>

Поля файлов должны иметь тип integer

Далее в описании формы редактирования необходимо подключить поле прикрепления файла:

    $formMapper
        ->add('image_file', 'attach_file', array(
            'label'     => 'Изображение',
            'required'  => false,
            'constraints' => [
                new Image([
                    'mimeTypes' => [
                        'image/gif',
                        'image/jpeg',
                        'image/pjpeg',
                        'image/png'
                    ]
                ])
            ]

        ));

Обратите внимание, что поле называется не image, а image_file. Это поле image_file и соответствующие методы get и set создал бихейвор AttachFileBehavior, они используются исключительно для формы редактирования.

Use i18n

Если вы используете языковые версии на сайте на основе propel-бихейвора i18n и к каждому переводу необходимо прикреплять файл, то вам необходимо в основной таблице (document) указать параметр i18n, где будет имя поля файла, и в соответствующей таблице с переводами (document_i18n) укзать параметр file_columns, в котором будет то же самое значение поля файла. Пример:

    <table name="document" description="Документ">
        <column name="id"           type="integer"  required="true" primaryKey="true" autoIncrement="true" />
        <column name="file_title"   type="varchar"  required="true" primaryString="true" />
        <column name="active"       type="boolean"  defaultValue="true" />
        <column name="download"     type="integer"/>

        <behavior name="i18n">
            <parameter name="i18n_columns" value="file_title, active, download" />
        </behavior>

        <behavior name="it_blaster_i18n">
            <parameter name="primary_string" value="file_title" />
        </behavior>

        <behavior name="it_blaster_file" >
            <parameter name="i18n" value="download" />
        </behavior>
    </table>

    <table name="document_i18n">
        <behavior name="it_blaster_file" >
            <parameter name="file_columns" value="download" />
        </behavior>
    </table>

Далее подключаем виджет attach_file в админ-форме:

        $formMapper
            ->add('DocumentI18ns', new TranslationCollectionType(), [
                'label'     => false,
                'required'  => false,
                'type'      => new TranslationType(),
                'languages' => $this->getConfigurationPool()->getContainer()->getParameter('locales'),
                'options'   => [
                    'label'      => false,
                    'data_class' => 'Artsofte\MainBundle\Model\DocumentI18n',
                    'columns'    => [
                        'active' => [
                            'label' => "Опубликовать",
                            'type'  => 'checkbox',
                        ],
                        'file_title' => [
                            'label' => "Имя файла",
                            'type'  => 'text',
                            'required'  => true,
                        ],
                        'download_file' => array(
                            'type'      => 'attach_file',
                            'label'     => 'Выберите файл',
                            'maxSize'   => '20M',
                            'options' => [
                                'sonata_help' => 'Допустимые типы файлов: pdf, doc, docx, zip, jpg, gif, png',
                                'constraints' => [
                                    new \Symfony\Component\Validator\Constraints\File([
                                        'mimeTypes' => [
                                            'application/pdf',
                                            'application/msword',
                                            'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
                                            'application/vnd.oasis.opendocument.text',
                                            'application/zip',
                                            'image/gif',
                                            'image/jpeg',
                                            'image/pjpeg',
                                            'image/png'
                                        ]
                                    ])
                                ]
                            ]
                        ),
                    ]
                ]
            ])
        ;

Credits

It-Blaster it-blaster@yandex.ru