Update BootstrapCollection for sf2.8|3.0

Author: sescandell

DependencyInjection/AdmingeneratorFormExtensionsExtension.php

@@ -38,24 +38,6 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('admingenerator.form.include_gmaps', $config['include_gmaps']);
 
         $this->loadUploadCollectionListener($config['upload_collection'], $container);
-        $this->loadBootstrapCollectionTypes($container);
-    }
-
-    private function loadBootstrapCollectionTypes(ContainerBuilder $container)
-    {
-        $serviceId = 'admingenerator.form.extensions.type.bootstrap_collection';
-
-        $bootstrapCollectionTypes = array('fieldset', 'table');
-
-        foreach ($bootstrapCollectionTypes as $type) {
-            $typeDef = new DefinitionDecorator($serviceId);
-            $typeDef
-                ->addArgument($type)
-                ->addTag('form.type', array('alias' => 's2a_collection_'.$type))
-            ;
-
-            $container->setDefinition($serviceId.'.'.$type, $typeDef);
-        }
     }
 
     /**

Form/EventListener/SingleUploadSubscriber.php

@@ -17,7 +17,10 @@ class SingleUploadSubscriber implements EventSubscriberInterface
      * @var array Single upload field configs
      */
     protected $configs = array();
-    
+
+    /**
+     * @var array
+     */
     protected $files = array();
 
     public static function getSubscribedEvents()
@@ -154,8 +157,12 @@ public function postSubmit(FormEvent $event)
 
     private function isFieldSingleUpload(ResolvedFormTypeInterface $formTypeInterface = null)
     {
-        if ($formTypeInterface == null) return false;
-        if ($formTypeInterface->getName() == 's2a_single_upload') return true;
+        if ($formTypeInterface == null) {
+            return false;
+        }
+        if (get_class($formTypeInterface->getInnerType()) == 'Admingen\FormExtensionsBundle\Form\Type\SingleUploadType') {
+            return true;
+        }
 
         return $this->isFieldSingleUpload($formTypeInterface->getParent());
     }

Form/EventListener/UploadCollectionSubscriber.php

@@ -30,7 +30,7 @@ class UploadCollectionSubscriber implements EventSubscriberInterface
     /**
      * @var boolean Primary Key field
      */
-    protected $primary_key;
+    protected $primaryKey;
 
     /**
      * @var boolean Is file nameable
@@ -40,7 +40,7 @@ class UploadCollectionSubscriber implements EventSubscriberInterface
     /**
      * @var string Nameable field name
      */
-    protected $nameable_field;
+    protected $nameableField;
 
     /**
      * Used to revert changes if form is not valid.
@@ -61,17 +61,17 @@ class UploadCollectionSubscriber implements EventSubscriberInterface
     /**
      * @var array Submitted primary keys
      */
-    protected $submitted_pk;
+    protected $submittedPk;
 
     /**
      * @var boolean
      */
-    protected $allow_add;
+    protected $allowAdd;
 
     /**
      * @var boolean
      */
-    protected $allow_delete;
+    protected $allowDelete;
 
     /**
      * @var FileStorageInterface
@@ -88,14 +88,14 @@ public function __construct($propertyName, array $options, FileStorageInterface
     {
         $this->propertyName     = $propertyName;
         $this->dataClass        = $options['options']['data_class'];
-        $this->primary_key      = $options['primary_key'];
+        $this->primaryKey      = $options['primary_key'];
         $this->nameable         = $options['nameable'];
-        $this->nameable_field   = $options['nameable_field'];
+        $this->nameableField   = $options['nameable_field'];
         $this->uploads          = array();
         $this->editable         = array();
-        $this->submitted_pk     = array();
-        $this->allow_add        = $options['allow_add'];
-        $this->allow_delete     = $options['allow_delete'];
+        $this->submittedPk     = array();
+        $this->allowAdd        = $options['allow_add'];
+        $this->allowDelete     = $options['allow_delete'];
         $this->storage          = $storage;
     }
 
@@ -110,7 +110,6 @@ public static function getSubscribedEvents()
 
     public function preSubmit(FormEvent $event)
     {
-        $form = $event->getForm();
         $data = $event->getData();
 
         $data = $data ?: array();
@@ -142,8 +141,8 @@ public function preSubmit(FormEvent $event)
 
         // save submitted primary keys for onSubmit event
         foreach ($data as $file) {
-            if (is_array($file) && array_key_exists($this->primary_key, $file)) {
-                $this->submitted_pk[] = $file[$this->primary_key];
+            if (is_array($file) && array_key_exists($this->primaryKey, $file)) {
+                $this->submittedPk[] = $file[$this->primaryKey];
             }
         }
 
@@ -159,17 +158,17 @@ public function onSubmit(FormEvent $event)
         $getter = 'get'.ucfirst($this->propertyName);
         $this->originalFiles = $data->$getter();
 
-        if ($this->allow_delete) {
+        if ($this->allowDelete) {
             // remove files not present in submitted pk
-            $pkGetter = 'get'.ucfirst($this->primary_key);
+            $pkGetter = 'get'.ucfirst($this->primaryKey);
             foreach ($data->$getter() as $file) {
-                if (!in_array($file->$pkGetter(), $this->submitted_pk)) {
+                if (!in_array($file->$pkGetter(), $this->submittedPk)) {
                     $data->$getter()->removeElement($file);
                 }
             }
         }
 
-        if ($this->allow_add) {
+        if ($this->allowAdd) {
             // create file entites for each file
             foreach ($this->uploads as $upload) {
                 if (!is_object($upload) && !is_null($this->storage)) {
@@ -196,8 +195,8 @@ public function onSubmit(FormEvent $event)
                 }
 
                 // if nameable field specified - set normalized name
-                if ($this->nameable && $this->nameable_field) {
-                    $setNameable = 'set'.ucfirst($this->nameable_field);
+                if ($this->nameable && $this->nameableField) {
+                    $setNameable = 'set'.ucfirst($this->nameableField);
 
                     // this value is unsafe
                     $name = $upload->getClientOriginalName();
@@ -235,70 +234,70 @@ public function postSubmit(FormEvent $event)
     private function normalizeUtf8String($s)
     {
         // save original string
-        $original_string = $s;
+        $originalString = $s;
 
         // Normalizer-class missing!
         if (!class_exists('\Normalizer')) {
             // remove all non-whitelisted characters
-            return  preg_replace( '@[^a-zA-Z0-9._\-\s ]@u' , "", $original_string );
+            return  preg_replace( '@[^a-zA-Z0-9._\-\s ]@u' , '', $originalString );
         }
 
         $normalizer = new \Normalizer();
 
         // maps German (umlauts) and other European characters onto two characters before just removing diacritics
-        $s = preg_replace('@\x{00c4}@u', "AE", $s);    // umlaut Ä => AE
-        $s = preg_replace('@\x{00d6}@u', "OE", $s);    // umlaut Ö => OE
-        $s = preg_replace('@\x{00dc}@u', "UE", $s);    // umlaut Ü => UE
-        $s = preg_replace('@\x{00e4}@u', "ae", $s);    // umlaut ä => ae
-        $s = preg_replace('@\x{00f6}@u', "oe", $s);    // umlaut ö => oe
-        $s = preg_replace('@\x{00fc}@u', "ue", $s);    // umlaut ü => ue
-        $s = preg_replace('@\x{00f1}@u', "ny", $s);    // ñ => ny
-        $s = preg_replace('@\x{00ff}@u', "yu", $s);    // ÿ => yu
+        $s = preg_replace('@\x{00c4}@u', 'AE', $s);    // umlaut Ä => AE
+        $s = preg_replace('@\x{00d6}@u', 'OE', $s);    // umlaut Ö => OE
+        $s = preg_replace('@\x{00dc}@u', 'UE', $s);    // umlaut Ü => UE
+        $s = preg_replace('@\x{00e4}@u', 'ae', $s);    // umlaut ä => ae
+        $s = preg_replace('@\x{00f6}@u', 'oe', $s);    // umlaut ö => oe
+        $s = preg_replace('@\x{00fc}@u', 'ue', $s);    // umlaut ü => ue
+        $s = preg_replace('@\x{00f1}@u', 'ny', $s);    // ñ => ny
+        $s = preg_replace('@\x{00ff}@u', 'yu', $s);    // ÿ => yu
 
         // maps special characters (characters with diacritics) on their base-character followed by the diacritical mark
         // exmaple:  Ú => U´,  á => a`
         $s = $normalizer->normalize($s, $normalizer::FORM_D);
 
         $s = preg_replace('@\pM@u', "", $s);    // removes diacritics
 
-        $s = preg_replace('@\x{00df}@u', "ss", $s);    // maps German ß onto ss
-        $s = preg_replace('@\x{00c6}@u', "AE", $s);    // Æ => AE
-        $s = preg_replace('@\x{00e6}@u', "ae", $s);    // æ => ae
-        $s = preg_replace('@\x{0132}@u', "IJ", $s);    // ? => IJ
-        $s = preg_replace('@\x{0133}@u', "ij", $s);    // ? => ij
-        $s = preg_replace('@\x{0152}@u', "OE", $s);    // Π=> OE
-        $s = preg_replace('@\x{0153}@u', "oe", $s);    // œ => oe
-
-        $s = preg_replace('@\x{00d0}@u', "D", $s);    // Ð => D
-        $s = preg_replace('@\x{0110}@u', "D", $s);    // Ð => D
-        $s = preg_replace('@\x{00f0}@u', "d", $s);    // ð => d
-        $s = preg_replace('@\x{0111}@u', "d", $s);    // d => d
-        $s = preg_replace('@\x{0126}@u', "H", $s);    // H => H
-        $s = preg_replace('@\x{0127}@u', "h", $s);    // h => h
-        $s = preg_replace('@\x{0131}@u', "i", $s);    // i => i
-        $s = preg_replace('@\x{0138}@u', "k", $s);    // ? => k
-        $s = preg_replace('@\x{013f}@u', "L", $s);    // ? => L
-        $s = preg_replace('@\x{0141}@u', "L", $s);    // L => L
-        $s = preg_replace('@\x{0140}@u', "l", $s);    // ? => l
-        $s = preg_replace('@\x{0142}@u', "l", $s);    // l => l
-        $s = preg_replace('@\x{014a}@u', "N", $s);    // ? => N
-        $s = preg_replace('@\x{0149}@u', "n", $s);    // ? => n
-        $s = preg_replace('@\x{014b}@u', "n", $s);    // ? => n
-        $s = preg_replace('@\x{00d8}@u', "O", $s);    // Ø => O
-        $s = preg_replace('@\x{00f8}@u', "o", $s);    // ø => o
-        $s = preg_replace('@\x{017f}@u', "s", $s);    // ? => s
-        $s = preg_replace('@\x{00de}@u', "T", $s);    // Þ => T
-        $s = preg_replace('@\x{0166}@u', "T", $s);    // T => T
-        $s = preg_replace('@\x{00fe}@u', "t", $s);    // þ => t
-        $s = preg_replace('@\x{0167}@u', "t", $s);    // t => t
+        $s = preg_replace('@\x{00df}@u', 'ss', $s);    // maps German ß onto ss
+        $s = preg_replace('@\x{00c6}@u', 'AE', $s);    // Æ => AE
+        $s = preg_replace('@\x{00e6}@u', 'ae', $s);    // æ => ae
+        $s = preg_replace('@\x{0132}@u', 'IJ', $s);    // ? => IJ
+        $s = preg_replace('@\x{0133}@u', 'ij', $s);    // ? => ij
+        $s = preg_replace('@\x{0152}@u', 'OE', $s);    // Π=> OE
+        $s = preg_replace('@\x{0153}@u', 'oe', $s);    // œ => oe
+
+        $s = preg_replace('@\x{00d0}@u', 'D', $s);    // Ð => D
+        $s = preg_replace('@\x{0110}@u', 'D', $s);    // Ð => D
+        $s = preg_replace('@\x{00f0}@u', 'd', $s);    // ð => d
+        $s = preg_replace('@\x{0111}@u', 'd', $s);    // d => d
+        $s = preg_replace('@\x{0126}@u', 'H', $s);    // H => H
+        $s = preg_replace('@\x{0127}@u', 'h', $s);    // h => h
+        $s = preg_replace('@\x{0131}@u', 'i', $s);    // i => i
+        $s = preg_replace('@\x{0138}@u', 'k', $s);    // ? => k
+        $s = preg_replace('@\x{013f}@u', 'L', $s);    // ? => L
+        $s = preg_replace('@\x{0141}@u', 'L', $s);    // L => L
+        $s = preg_replace('@\x{0140}@u', 'l', $s);    // ? => l
+        $s = preg_replace('@\x{0142}@u', 'l', $s);    // l => l
+        $s = preg_replace('@\x{014a}@u', 'N', $s);    // ? => N
+        $s = preg_replace('@\x{0149}@u', 'n', $s);    // ? => n
+        $s = preg_replace('@\x{014b}@u', 'n', $s);    // ? => n
+        $s = preg_replace('@\x{00d8}@u', 'O', $s);    // Ø => O
+        $s = preg_replace('@\x{00f8}@u', 'o', $s);    // ø => o
+        $s = preg_replace('@\x{017f}@u', 's', $s);    // ? => s
+        $s = preg_replace('@\x{00de}@u', 'T', $s);    // Þ => T
+        $s = preg_replace('@\x{0166}@u', 'T', $s);    // T => T
+        $s = preg_replace('@\x{00fe}@u', 't', $s);    // þ => t
+        $s = preg_replace('@\x{0167}@u', 't', $s);    // t => t
 
         // remove all non-ASCii characters
-        $s = preg_replace('@[^\0-\x80]@u', "", $s);
+        $s = preg_replace('@[^\0-\x80]@u', '', $s);
 
         // possible errors in UTF8-regular-expressions
         if (empty($s)) {
             // remove all non-whitelisted characters
-            return  preg_replace('@[^a-zA-Z0-9._\-\s ]@u' , "", $original_string);
+            return  preg_replace('@[^a-zA-Z0-9._\-\s ]@u' , '', $originalString);
         }
 
         // return normalized string

Form/Type/BootstrapCollectionType.php

@@ -13,16 +13,26 @@
  * See `Resources/doc/bootstrap-collection/overview.md` for documentation
  *
  * @author Piotr Gołębiewski <[email protected]>
+ * @author Stéphane Escandell <[email protected]>
  */
-class BootstrapCollectionType extends AbstractType
+abstract class BootstrapCollectionType extends AbstractType
 {
+    /**
+     * @var string
+     */
     private $widget;
 
+    /**
+     * @param string $widget Type of the form (used as a suffix fot he blocprefix)
+     */
     public function __construct($widget)
     {
         $this->widget = $widget;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
         $builder->addEventSubscriber(new ReorderCollectionSubscriber());
@@ -70,13 +80,13 @@ public function configureOptions(OptionsResolver $resolver)
      */
     public function getParent()
     {
-        return 'collection';
+        return 'Symfony\Component\Form\Extension\Core\Type\CollectionType';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getName()
+    public function getBlockPrefix()
     {
         return 's2a_collection_' . $this->widget;
     }

Form/Type/BootstrapFieldsetCollectionType.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Admingenerator\FormExtensionsBundle\Form\Type;
+
+/**
+ * See `Resources/doc/bootstrap-collection/overview.md` for documentation
+ *
+ * @author Stéphane Escandell <[email protected]>
+ */
+class BootstrapFieldsetCollectionType extends BootstrapCollectionType
+{
+    public function __construct()
+    {
+        parent::__construct('fieldset');
+    }
+}

Form/Type/BootstrapTableCollectionType.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Admingenerator\FormExtensionsBundle\Form\Type;
+
+/**
+ * See `Resources/doc/bootstrap-collection/overview.md` for documentation
+ *
+ * @author Stéphane Escandell <[email protected]>
+ */
+class BootstrapTableCollectionType extends BootstrapCollectionType
+{
+    public function __construct()
+    {
+        parent::__construct('table');
+    }
+}

Resources/config/services.xml

@@ -10,7 +10,13 @@
 
     <services>
         <!-- Form types -->
-        <service id="admingenerator.form.extensions.type.bootstrap_collection" class="Admingenerator\FormExtensionsBundle\Form\Type\BootstrapCollectionType" abstract="true" />
+        <service id="admingenerator.form.extensions.type.bootstrap_table_collection" class="Admingenerator\FormExtensionsBundle\Form\Type\BootstrapTableCollectionType">
+            <tag name="form.type" />
+        </service>
+
+        <service id="admingenerator.form.extensions.type.bootstrap_fieldset_collection" class="Admingenerator\FormExtensionsBundle\Form\Type\BootstrapFieldsetCollectionType">
+            <tag name="form.type" />
+        </service>
 
         <service id="admingenerator.form.extensions.type.bootstrap_money" class="Admingenerator\FormExtensionsBundle\Form\Type\MoneyType">
             <tag name="form.type" />

Resources/public/collection-upload/LICENSE renamed to Resources/public/upload-collection/LICENSE

@@ -62,7 +62,7 @@
         'bundles/admingeneratorformextensions/datetime-picker/js/bootstrap-datetimepicker.js'
         'bundles/admingeneratorformextensions/daterange-picker/js/daterangepicker.js'
         'bundles/admingeneratorformextensions/bootstrap-select/js/bootstrap-select.js'
-        'bundles/admingeneratorformextensions/collection-upload/js/collection-upload.js'
+        'bundles/admingeneratorformextensions/upload-collection/js/upload-collection.js'
         'bundles/admingeneratorformextensions/double-list/js/double-list.js'
         'bundles/admingeneratorformextensions/elastic/js/jquery.elastic.js'
         'bundles/admingeneratorformextensions/google-map/js/google-map.js'

Resources/public/collection-upload/LICENSE-NOTICE renamed to Resources/public/upload-collection/LICENSE-NOTICE

@@ -37,7 +37,7 @@
     <script type="text/javascript" src="{{ asset('bundles/admingeneratorformextensions/datetime-picker/js/bootstrap-datetimepicker.min.js') }}"></script>
     <script type="text/javascript" src="{{ asset('bundles/admingeneratorformextensions/daterange-picker/js/daterangepicker.min.js') }}"></script>
     <script type="text/javascript" src="{{ asset('bundles/admingeneratorformextensions/bootstrap-select/js/bootstrap-select.min.js') }}"></script>
-    <script type="text/javascript" src="{{ asset('bundles/admingeneratorformextensions/collection-upload/js/collection-upload.min.js') }}"></script>
+    <script type="text/javascript" src="{{ asset('bundles/admingeneratorformextensions/collection-upload/js/upload-collection.min.js') }}"></script>
     <script type="text/javascript" src="{{ asset('bundles/admingeneratorformextensions/double-list/js/double-list.min.js') }}"></script>
     <script type="text/javascript" src="{{ asset('bundles/admingeneratorformextensions/elastic/js/jquery.elastic.min.js') }}"></script>
     <script type="text/javascript" src="{{ asset('bundles/admingeneratorformextensions/google-map/js/google-map.min.js') }}"></script>

Resources/public/collection-upload/README.md renamed to Resources/public/upload-collection/README.md

@@ -7,7 +7,7 @@
         'bundles/admingeneratorformextensions/datetime-picker/css/customized.css'
         'bundles/admingeneratorformextensions/daterange-picker/css/daterangepicker-bs3.css'
         'bundles/admingeneratorformextensions/bootstrap-select/css/bootstrap-select.css'
-        'bundles/admingeneratorformextensions/collection-upload/css/collection-upload.css'
+        'bundles/admingeneratorformextensions/upload-collection/css/upload-collection.css'
         'bundles/admingeneratorformextensions/double-list/css/double-list.css'
         'bundles/admingeneratorformextensions/google-map/css/google-map.css'
         'bundles/admingeneratorformextensions/minicolors/css/jquery.minicolors.css'