small refactoring

Author: mickgeek

ActionBarAsset.php

@@ -6,7 +6,7 @@
 /**
  * ActionBarAsset represents a collection of asset files, such as CSS, JS, images.
  *
- * @author Oleg Belostotskiy <olgblst@gmail.com>
+ * @author Oleg Belostotsky <olegbelostotsky@gmail.com>
  */
 class ActionBarAsset extends AssetBundle
 {

CHANGELOG.md

@@ -1,4 +1,4 @@
-Action Bar Changelog
+ActionBar Changelog
 ====================
 
 Version 1.0.0 July 15, 2014
@@ -10,8 +10,3 @@ Version 1.1.0 December 09, 2016
 ---------------------------
 
   - Request parameter "ids" change support
-
-Version 1.1.1 March 10, 2017
----------------------------
-
-  - Added CSRF notice in documentaion

DOCUMENTATION.md

@@ -1,4 +1,4 @@
-Action Bar Documentation
+ActionBar Documentation
 =======================
 
 The widget allows you to use the following properties and methods.
@@ -12,11 +12,11 @@ Widget Class
 
   - `options`: *array*, the HTML attributes for the widget container tag. See [renderTagAttributes()] for details on how attributes are being rendered.
 
-  - `renderContainer`: *boolean*, whether the action bar content should be included in a div container.
+  - `renderContainer`: *boolean*, whether the widget content should be included in a div container.
 
   - `containerOptions`: *array*, the HTML attributes for the content container tag. This is only used when `renderContainer` is true. See [renderTagAttributes()] for details on how attributes are being rendered.
 
-  - `templates`: *array*, templates used to render action bar elements, in addition, may be specified the array keys with the HTML attributes for the container tag. Tokens enclosed within curly brackets are treated as controller action IDs (also called *element names* in the context of action column). They will be replaced by the corresponding element rendering values specified in `elements`. For example, the token `{bulk-actions}` will be replaced by the result of the value `elements['bulk-actions']`. If a value cannot be found, the token will be replaced with an empty string. See [renderTagAttributes()] for details on how attributes are being rendered.
+  - `templates`: *array*, templates used to render widget elements, in addition, may be specified the array keys with the HTML attributes for the container tag. Tokens enclosed within curly brackets are treated as controller action IDs (also called *element names* in the context of action column). They will be replaced by the corresponding element rendering values specified in `elements`. For example, the token `{bulk-actions}` will be replaced by the result of the value `elements['bulk-actions']`. If a value cannot be found, the token will be replaced with an empty string. See [renderTagAttributes()] for details on how attributes are being rendered.
 
   - `elements`: *array*, elements rendering values. The array keys are the element names (without curly brackets), and the values are the corresponding element rendering values.
 
@@ -27,8 +27,8 @@ Widget Class
   - `bulkActionsItems`: *array*, the option data items for the Bulk Actions. See [dropDownList()] for details on how this is to be rendered.
 
   - `bulkActionsOptions`: *array*, the Bulk Actions options in terms of name-value pairs. The following attributes for the select option tag are specially handled:
-    - url: string, used to send the array with the selected rows (based on the AJAX request) to the clienton the specified URL.
-    - data-confirm: string, displays a confirm box before deleting selected items.
+    - `url`: string, used to send the array with the selected rows (based on the AJAX request) to the clienton the specified URL.
+    - `data-confirm`: string, displays a confirm box before deleting selected items.
 
   See [dropDownList()] for details on how this is to be rendered.
 

DeleteMultipleAction.php

@@ -10,7 +10,7 @@
 /**
  * DeleteMultipleAction deletes the selected rows of the GridView.
  *
- * @author Oleg Belostotskiy <olgblst@gmail.com>
+ * @author Oleg Belostotsky <olegbelostotsky@gmail.com>
  */
 class DeleteMultipleAction extends Action
 {

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014, Oleg Belostotskiy  
+Copyright © 2014, Oleg Belostotsky
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,55 +1,19 @@
-Action Bar
-==========
+ActionBar
+=========
 
-Action Bar is a Yii 2 widget that render the drop-down list for manipulation selected GridView items and control buttons. The widget permits you to fully customize elements.
+ActionBar is a Yii 2 widget that render the drop-down list for manipulation selected the GridView items and control buttons. The widget permits you to fully customize elements.
 
 ![Screenshot](https://cloud.githubusercontent.com/assets/8091481/3558541/f447ff48-093c-11e4-91ad-b784c929ed32.png)
 
 Installation
 ------------
 
-You can install the widget in two ways, using [Composer] or by downloading an archive file.
+You can install the widget using [Composer]. Just run the following command under your application folder:
 
-### Installing via Composer
-
-Run the following commands under your application folder:
-
-```
-php composer.phar require --prefer-dist "mickgeek/yii2-actionbar *"
 ```
-
-> Note: You can just do `composer update --prefer-dist` if pre-adding the following to `require` section of your `composer.json`:
->
->     "mickgeek/yii2-actionbar": "*"
->
-
-### Installing from an Archive File
-
-Download [the archive file], unpack it to `path/to/app/vendor/mickgeek` folder and modify the main configuration file like this:
-
-```php
-$vendorDir = dirname(__DIR__) . '/vendor';
-
-return [
-    'vendorPath' => $vendorDir,
-    'extensions' => array_merge(
-        require($vendorDir . '/yiisoft/extensions.php'),
-        [
-            'mickgeek/yii2-actionbar' => [
-                'name' => 'mickgeek/yii2-actionbar',
-                'version' => '9999999-dev',
-                'alias' => [
-                    '@mickgeek/actionbar' => $vendorDir . '/mickgeek/yii2-actionbar',
-                ],
-            ],
-        ]
-    ),
-    ...
-];
+php composer.phar require --prefer-dist mickgeek/yii2-actionbar
 ```
 
-where `$vendorDir` is the path to the directory that stores vendor files.
-
 Usage
 -----
 
@@ -79,9 +43,6 @@ public function actions()
 
 > Tip: For information about properties and methods of the widget, see the bundled `DOCUMENTATION.md`.
 
-### CSRF validation
-For enable CSRF validation make sure you have ```<?= Html::csrfMetaTags() ?>``` in main layout.
-
 Examples
 --------
 
@@ -202,4 +163,3 @@ License
 This extension is released under the BSD 3-Clause License. See the bundled `LICENSE.md` for details.
 
 [Composer]:https://getcomposer.org
-[the archive file]:https://github.com/mickgeek/yii2-actionbar/archive/master.zip

Widget.php

@@ -10,7 +10,7 @@
 /**
  * \mickgeek\actionbar\Widget renders the drop-down list to manipulation selected GridView items and control buttons.
  *
- * @author Oleg Belostotskiy <olgblst@gmail.com>
+ * @author Oleg Belostotsky <olegbelostotsky@gmail.com>
  */
 class Widget extends \yii\base\Widget
 {
@@ -29,7 +29,7 @@ class Widget extends \yii\base\Widget
      */
     public $options = ['class' => 'widget-action-bar'];
     /**
-     * @var boolean whether the action bar content should be included in a div container.
+     * @var boolean whether the widget content should be included in a div container.
      */
     public $renderContainer = true;
     /**
@@ -38,7 +38,7 @@ class Widget extends \yii\base\Widget
      */
     public $containerOptions = ['class' => 'row'];
     /**
-     * @var array templates used to render action bar elements, in addition, may be specified the array keys with
+     * @var array templates used to render widget elements, in addition, may be specified the array keys with
      * the HTML attributes for the container tag. Tokens enclosed within curly brackets are treated as
      * controller action IDs (also called *element names* in the context of action column). They will be replaced
      * by the corresponding element rendering values specified in [[elements]]. For example,
@@ -73,9 +73,9 @@ class Widget extends \yii\base\Widget
      * @var array the Bulk Actions options in terms of name-value pairs. The following attributes
      * for the select option tag are specially handled:
      *
-     * - url: string, used to send the array with the selected rows (based on the AJAX request) to the client
+     * - `url`: string, used to send the array with the selected rows (based on the AJAX request) to the client
      *   on the specified URL.
-     * - data-confirm: string, displays a confirm box before deleting selected items.
+     * - `data-confirm`: string, displays a confirm box before deleting selected items.
      *
      * @see \yii\helpers\Html::dropDownList() for details on how this is to be rendered.
      */

composer.json

@@ -1,15 +1,14 @@
 {
     "name": "mickgeek/yii2-actionbar",
     "type": "yii2-extension",
-    "description": "Customizable bar with the drop-down list for manipulation selected GridView items and control buttons.",
-    "keywords": ["yii2", "extension", "widget", "grid", "dropdown", "bulk actions"],
+    "description": "A control bar with bulk actions for the GridView widget.",
+    "keywords": ["yii2", "extension", "widget", "grid", "bulk actions"],
     "homepage": "https://github.com/mickgeek/yii2-actionbar",
-    "license": "BSD 3-Clause",
+    "license": "BSD-3-Clause",
     "authors": [
         {
-            "name": "Oleg Belostotskiy",
-            "email": "[email protected]",
-            "homepage": "http://mickgeek.com",
+            "name": "Oleg Belostotsky",
+            "email": "[email protected]",
             "role": "Developer"
         }
     ],