Doc update: switch from array() to []

FriendsOfSymfony · May 13, 2024 · 069e672 · 069e672
1 parent 9d4cd4f
commit 069e672
Show file tree

Hide file tree

Showing 19 changed files with 99 additions and 99 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -20,12 +20,12 @@ Here, an example where we customize the `CKEditor config`_::
 
     use FOS\CKEditorBundle\Form\Type\CKEditorType;
 
-    $builder->add('field', CKEditorType::class, array(
-        'config' => array(
+    $builder->add('field', CKEditorType::class, [
+        'config' => [
             'uiColor' => '#ffffff',
             //...
-        ),
-    ));
+        ],
+    ]);
 
 Installation
 ------------

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -32,10 +32,10 @@ If you're using Symfony < 4.0, update your ``app/AppKernel.php``:
     {
         public function registerBundles()
         {
-            $bundles = array(
+            $bundles = [
                 new FOS\CKEditorBundle\FOSCKEditorBundle(),
                 // ...
-            );
+            ];
 
             // ...
         }

diff --git a/docs/usage/autoinline.rst b/docs/usage/autoinline.rst
@@ -16,7 +16,7 @@ Or you can disable it for a specific widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array('auto_inline' => false));
+    $builder->add('field', 'ckeditor', ['auto_inline' => false]);
 
 .. note::
 

diff --git a/docs/usage/config.rst b/docs/usage/config.rst
@@ -42,9 +42,9 @@ When you have defined a config, you can use it with the ``config_name`` option:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
+    $builder->add('field', 'ckeditor', [
         'config_name' => 'my_config',
-    ));
+    ]);
 
 Override a configuration
 ------------------------
@@ -54,10 +54,10 @@ If you want to override some parts of the defined config, you can still use the
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
+    $builder->add('field', 'ckeditor', [
         'config_name' => 'my_config',
-        'config'      => array('uiColor' => '#ffffff'),
-    ));
+        'config'      => ['uiColor' => '#ffffff'],
+    ]);
 
 Define default configuration
 ----------------------------

diff --git a/docs/usage/file-browse-upload.rst b/docs/usage/file-browse-upload.rst
@@ -45,12 +45,12 @@ Or you can configure it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
-        'filebrowsers' => array(
+    $builder->add('field', 'ckeditor', [
+        'filebrowsers' => [
             'VideoUpload',
             'VideoBrowse',
-        ),
-    ));
+        ],
+    ]);
 
 Routing Options
 ---------------
@@ -88,13 +88,13 @@ Or you can configure it your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
-        'config' => array(
+    $builder->add('field', 'ckeditor', [
+        'config' => [
             'filebrowserBrowseRoute'           => 'my_route',
-            'filebrowserBrowseRouteParameters' => array('slug' => 'my-slug'),
+            'filebrowserBrowseRouteParameters' => ['slug' => 'my-slug'],
             'filebrowserBrowseRouteType'       => UrlGeneratorInterface::ABSOLUTE_URL,
-        ),
-    ));
+        ],
+    ]);
 
 Dynamic Routing
 ~~~~~~~~~~~~~~~
@@ -108,17 +108,17 @@ but much more powerful closure and so make it aware of your dependencies:
     // A blog post...
     $post = $manager->find($id);
 
-    $builder->add('field', 'ckeditor', array(
-        'config' => array(
+    $builder->add('field', 'ckeditor', [
+        'config' => [
             'filebrowserBrowseHandler' => function (RouterInterface $router) use ($post) {
                 return $router->generate(
                     'my_route',
-                    array('slug' => $post->getSlug()),
+                    ['slug' => $post->getSlug()],
                     UrlGeneratorInterface::ABSOLUTE_URL
                 );
             },
-        ),
-    ));
+        ],
+    ]);
 
 Integration with Other Projects
 -------------------------------

diff --git a/docs/usage/inline.rst b/docs/usage/inline.rst
@@ -15,7 +15,7 @@ Or you can configure it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array('inline' => true));
+    $builder->add('field', 'ckeditor', ['inline' => true]);
 
 .. _`Classic Editing`: http://docs.ckeditor.com/#!/guide/dev_framed
 .. _`Inline Editing`: http://docs.ckeditor.com/#!/guide/dev_inline
diff --git a/docs/usage/jquery.rst b/docs/usage/jquery.rst
@@ -23,7 +23,7 @@ Or you can do it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array('jquery' => true));
+    $builder->add('field', 'ckeditor', ['jquery' => true]);
 
 Use your Adapter
 ----------------
@@ -42,7 +42,7 @@ Or you can configure it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array('jquery_path' => 'your/own/jquery.js'));
+    $builder->add('field', 'ckeditor', ['jquery_path' => 'your/own/jquery.js']);
 
 .. note::
 

diff --git a/docs/usage/json-builder.rst b/docs/usage/json-builder.rst
@@ -34,13 +34,13 @@ pass your values as first argument:
 
 .. code-block:: php
 
-    $builder->setValues(array('foo' => array('bar')));
+    $builder->setValues(['foo' => ['bar']]);
 
 Additionally, this method takes as second argument a path prefix (`PropertyAccess Component`_)
 which allows you to append your values where you want in the builder graph.
 So, the next sample is basically the equivalent of the precedent::
 
-    $builder->setValues(array('bar'), '[foo]');
+    $builder->setValues(['bar'], '[foo]');
 
 Append one value
 ~~~~~~~~~~~~~~~~
@@ -94,16 +94,16 @@ Example
     // {"0":"foo","1":bar}
     echo $builder
         ->setJsonEncodeOptions(JSON_FORCE_OBJECT)
-        ->setValues(array('foo'))
+        ->setValues(['foo'])
         ->setValue('[1]', 'bar', false)
         ->build();
 
     // {"foo":["bar"],"baz":bat}
     echo $builder
         ->reset()
-        ->setValues(array('foo' => array('bar')))
+        ->setValues(['foo' => ['bar']])
         ->setValue('[baz]', 'bat', false)
         ->build();
 
 .. _`PHP documentation for json_decode()`: http://php.net/manual/en/function.json-encode.php
-.. _`PropertyAccess Component`: http://symfony.com/doc/current/components/property_access/index.html
+.. _`PropertyAccess Component`: http://symfony.com/doc/current/components/property_access/index.html
diff --git a/docs/usage/language.rst b/docs/usage/language.rst
@@ -29,6 +29,6 @@ Or you can do it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array('config' => array(
+    $builder->add('field', 'ckeditor', ['config' => [
         'language' => 'fr',
-    )));
+    ]]);
diff --git a/docs/usage/loading.rst b/docs/usage/loading.rst
@@ -23,7 +23,7 @@ Or you can disable it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array('autoload' => false));
+    $builder->add('field', 'ckeditor', ['autoload' => false]);
 
 .. note::
 
@@ -54,10 +54,10 @@ Or you can configure it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
+    $builder->add('field', 'ckeditor', [
         'autoload' => false,
         'async'    => true,
-    ));
+    ]);
 
 Then, install the third party bundles as explained in its
 `documentation <https://github.com/egeloen/IvoryFormExtraBundle/blob/master/Resources/doc/installation.md>`_.

diff --git a/docs/usage/plugin.rst b/docs/usage/plugin.rst
@@ -37,17 +37,17 @@ Or you can do it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
-        'config' => array(
+    $builder->add('field', 'ckeditor', [
+        'config' => [
             'extraPlugins' => 'wordcount',
-        ),
-        'plugins' => array(
-            'wordcount' => array(
+        ],
+        'plugins' => [
+            'wordcount' => [
                 'path'     => '/bundles/mybundle/wordcount/', // with trailing slash
                 'filename' => 'plugin.js',
-            ),
-        ),
-    ));
+            ],
+        ],
+    ]);
 
 Plugin dependency
 -----------------

diff --git a/docs/usage/require-js.rst b/docs/usage/require-js.rst
@@ -41,4 +41,4 @@ Or you can configure it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array('require_js' => true));
+    $builder->add('field', 'ckeditor', ['require_js' => true]);
diff --git a/docs/usage/skin.rst b/docs/usage/skin.rst
@@ -29,9 +29,9 @@ Or you can do it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
-        'config' => array('skin' => 'skin_name,/bundles/mybundle/skins/skin_name/'),
-    ));
+    $builder->add('field', 'ckeditor', [
+        'config' => ['skin' => 'skin_name,/bundles/mybundle/skins/skin_name/'],
+    ]);
 
 .. note::
 

diff --git a/docs/usage/style.rst b/docs/usage/style.rst
@@ -22,16 +22,16 @@ Or you can define them in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
-        'config' => array(
+    $builder->add('field', 'ckeditor', [
+        'config' => [
             'stylesSet' => 'my_styles',
-        ),
-        'styles' => array(
-            'my_styles' => array(
-                array('name' => 'Blue Title', 'element' => 'h2', 'styles' => array('color' => 'Blue')),
-                array('name' => 'CSS Style', 'element' => 'span', 'attributes' => array('class' => 'my_style')),
-                array('name' => 'Multiple Element Style', 'element' => array('h2', 'span'), 'attributes' => array('class' => 'my_class')),
-                array('name' => 'Widget Style', 'type' => 'widget' , 'widget' => 'my_widget', 'attributes' => array('class' => 'my_widget_style')),
-            ),
-        ),
-    ));
+        ],
+        'styles' => [
+            'my_styles' => [
+                ['name' => 'Blue Title', 'element' => 'h2', 'styles' => ['color' => 'Blue']],
+                ['name' => 'CSS Style', 'element' => 'span', 'attributes' => ['class' => 'my_style']],
+                ['name' => 'Multiple Element Style', 'element' => ['h2', 'span'], 'attributes' => ['class' => 'my_class']],
+                ['name' => 'Widget Style', 'type' => 'widget' , 'widget' => 'my_widget', 'attributes' => ['class' => 'my_widget_style']],
+            ],
+        ],
+    ]);
diff --git a/docs/usage/template.rst b/docs/usage/template.rst
@@ -21,11 +21,11 @@ Or you can define it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
-        'config' => array(
+    $builder->add('field', 'ckeditor', [
+        'config' => [
             'extraPlugins' => 'templates',
-        ),
-    ));
+        ],
+    ]);
 
 Configure your templates
 ------------------------
@@ -53,26 +53,26 @@ Or you can define them in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
-        'config' => array(
+    $builder->add('field', 'ckeditor', [
+        'config' => [
             'extraPlugins' => 'templates',
             'templates'    => 'my_template',
-        ),
-        'templates' => array(
-            'my_template' => array(
+        ],
+        'templates' => [
+            'my_template' => [
                 'imagesPath' => '/bundles/mybundle/templates/images',
-                'templates'  => array(
-                    array(
+                'templates'  => [
+                    [
                         'title'       => 'My Template',
                         'image'       => 'images.jpg',
                         'description' => 'My awesome template',
                         'html'        => '<p>Crazy template :)</p>',
-                    ),
+                    ],
                     // ...
-                ),
-            ),
-        ),
-    ));
+                ],
+            ],
+        ],
+    ]);
 
 Use a dedicated template
 ------------------------
@@ -107,24 +107,24 @@ Or you can define them in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array(
-        'config' => array(
+    $builder->add('field', 'ckeditor', [
+        'config' => [
             'extraPlugins' => 'templates',
             'templates'    => 'my_template',
-        ),
-        'templates' => array(
-            'my_template' => array(
+        ],
+        'templates' => [
+            'my_template' => [
                 'imagesPath' => '/bundles/mybundle/templates/images',
-                'templates'  => array(
-                    array(
+                'templates'  => [
+                    [
                         'title'               => 'My Template',
                         'image'               => 'images.jpg',
                         'description'         => 'My awesome template',
                         'template'            => 'AppBundle:CKEditor:template.html.twig',
-                        'template_parameters' => array('foo' => 'bar'),
-                    ),
+                        'template_parameters' => ['foo' => 'bar'],
+                    ],
                     // ...
-                ),
-            ),
-        ),
-    ));
+                ],
+            ],
+        ],
+    ]);
diff --git a/docs/usage/textarea-fallback.rst b/docs/usage/textarea-fallback.rst
@@ -16,4 +16,4 @@ Or you can disable it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array('enable' => false));
+    $builder->add('field', 'ckeditor', ['enable' => false]);
diff --git a/docs/usage/textarea-sync.rst b/docs/usage/textarea-sync.rst
@@ -17,4 +17,4 @@ Or you can do it in your widget:
 
 .. code-block:: php
 
-    $builder->add('field', 'ckeditor', array('input_sync' => true));
+    $builder->add('field', 'ckeditor', ['input_sync' => true]);