dosamigos\exportable\ExportableButton

Complexity

Total Complexity

6

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	6	1
A	run()	0	10	2
A	initDropdownItems()	0	17	2
A	registerClientScript()	0	13	1

<?php

/*
 * This file is part of the 2amigos/yii2-exportable-widget project.
 * (c) 2amigOS! <http://2amigos.us/>
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace dosamigos\exportable;

use dosamigos\exportable\bundles\ExportableAsset;
use dosamigos\exportable\helpers\TypeHelper;
use Yii;
use yii\bootstrap\ButtonDropdown;

class ExportableButton extends ButtonDropdown
{
    /**
     * @var string the action to submit to download exported data
     */
    public $url;
    /**
     * @var string the button label
     */
    public $label = 'Export';
    /**
     * @var array the export types available. You can modify the list to display only certain types. For example,
     *
     * ```
     * 'types' => [ 'xml' => 'As XML']
     * ```
     *
     * Will display only XML as the unique type of exportation. Defaults to all possible options available.
     *
     * The items are a key => label structure. The types (keys) will be used as a post value that will define the type
     * that needs to be exported whether by the ExportableAction or the ExportableBehavior when used with our
     * GridView Library.
     *
     * @see https://github.com/2amigos/yii2-grid-view-library
     */
    public $types = [
        TypeHelper::CSV => 'CSV <span class="label label-default">.csv</span>',
        TypeHelper::XLSX => 'Excel 2007+ <span class="label label-default">.xlsx</span>',
        TypeHelper::ODS => 'Open Document Spreadsheet <span class="label label-default">.ods</span>',
        TypeHelper::JSON => 'JSON <span class="label label-default">.json</span>',
        TypeHelper::XML => 'XML <span class="label label-default">.xml</span>',
        TypeHelper::TXT => 'Text <span class="label label-default">.txt</span>',
        TypeHelper::HTML => 'HTML  <span class="label label-default">.html</span>'
    ];

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        $this->encodeLabel = false;
        $this->initDropdownItems();
    }

    /**
     * @inheritdoc
     */
    public function run()
    {
        $this->registerClientScript();

        if (empty($this->url)) {
            $this->url = Yii::$app->request->getUrl();
        }

        return parent::run();
    }

    /**
     * Initializes the dropdown items
     */
    public function initDropdownItems()
    {
        $id = $this->options['id'];

        foreach ($this->types as $type => $label) {
            $this->dropdown['items'][] = [
                'label' => $label,
                'url' => '#',
                'linkOptions' => [
                    'id' => $id . $type . 'exportable',
                    'data-type' => $type,
                    'class' => 'btn-da-exportable'
                ]
            ];
        }
        $this->dropdown['encodeLabels'] = false;
    }

    /**
     * Registers client script for the plugin
     */
    protected function registerClientScript()
    {
        $id = $this->options['id'];
        $hash = hash('crc32', $id);
        $url = $this->url;
        $view = $this->getView();

        ExportableAsset::register($view);

        $js = "dosamigos.exportable.registerHandler('.btn-da-exportable', '{$url}', '{$hash}');";

        $view->registerJs($js);
    }
}