AbstractDataTablesTwigExtension::__construct() - Code Metrics - Inspection of "Update CHANGELOG" - webeweb/jquery-datatables-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 207a43...23e505 )

by WEBEWEB

created 2019-03-29 16:21 UTC

AbstractDataTablesTwigExtension::__construct() A

↳ Parent: AbstractDataTablesTwigExtension

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

/*
 * This file is part of the jquery-datatables-bundle package.
 *
 * (c) 2018 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Bundle\JQuery\DataTablesBundle\Twig\Extension;

use Symfony\Component\Filesystem\Exception\FileNotFoundException;
use Twig\Environment;
use WBW\Bundle\CoreBundle\Service\TwigEnvironmentTrait;
use WBW\Bundle\CoreBundle\Twig\Extension\AbstractTwigExtension;
use WBW\Bundle\CoreBundle\Twig\Extension\RendererTwigExtension;
use WBW\Bundle\CoreBundle\Twig\Extension\RendererTwigExtensionTrait;
use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesColumnInterface;
use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesWrapperInterface;
use WBW\Bundle\JQuery\DataTablesBundle\Helper\DataTablesWrapperHelper;
use WBW\Library\Core\Argument\StringHelper;

/**
 * Abstract DataTables Twig extension.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\JQuery\DataTablesBundle\Twig\Extension
 * @abstract
 */
abstract class AbstractDataTablesTwigExtension extends AbstractTwigExtension {

    use RendererTwigExtensionTrait;
    use TwigEnvironmentTrait;

    /**
     * jQuery DataTables.
     *
     * @var string
     */
    const JQUERY_DATATABLES = <<< EOT
    $(document).ready(function () {
        var %var% = $("%selector%").DataTable(%options%);
    });
EOT;

    /**
     * jQuery DataTables.
     *
     * @var string
     */
    const JQUERY_DATATABLES_STANDALONE = <<< EOT
    $(document).ready(function () {
        $("%selector%").DataTable(%options%);
    });
EOT;

    /**
     * Constructor.
     *
     * @param Environment $twigEnvironment The Twig environment.
     * @param RendererTwigExtension $rendererTwigExtension The renderer Twig extension.
     */
    public function __construct(Environment $twigEnvironment, RendererTwigExtension $rendererTwigExtension) {
        parent::__construct($twigEnvironment);

        $this->setRendererTwigExtension($rendererTwigExtension);
    }

    /**
     * Encode the options.
     *
     * @param array $options The options.
     * @return string Returns the encoded options.
     */
    protected function encodeOptions(array $options) {
        if (0 === count($options)) {
            return "{}";
        }
        ksort($options);
        $output = json_encode($options, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
        return str_replace("\n", "\n        ", $output);
    }

    /**
     * Displays a jQuery DataTables.
     *
     * @param DataTablesWrapperInterface $dtWrapper The wrapper.
     * @param string $selector The selector.
     * @param string $language The language.
     * @return string Returns the jQuery DataTables.
     * @throws FileNotFoundException Throws a file not found exception if the language file does not exist.
     */
    protected function jQueryDataTables(DataTablesWrapperInterface $dtWrapper, $selector, $language) {

        $dtOptions = DataTablesWrapperHelper::getOptions($dtWrapper);

        $var     = DataTablesWrapperHelper::getName($dtWrapper);
        $options = $dtOptions;
        if (null !== $language) {
            $options["language"] = ["url" => DataTablesWrapperHelper::getLanguageURL($language)];
        }

        $searches = ["%var%", "%selector%", "%options%"];
        $replaces = [$var, null === $selector ? "#" . $var : $selector, $this->encodeOptions($options)];

        $javascript = StringHelper::replace(self::JQUERY_DATATABLES, $searches, $replaces);
        return $this->getRendererTwigExtension()->coreScriptFilter($javascript);
    }

    /**
     * Displays a jQuery DataTables "standalone".
     *
     * @param string $selector The selector.
     * @param string $language The language.
     * @param array $options The options.
     * @return string Returns the jQuery DataTables "Standalone".
     * @throws FileNotFoundException Throws a file not found exception if the language file does not exist.
     */
    protected function jQueryDataTablesStandalone($selector, $language, array $options) {

        if (null !== $language) {
            $options["language"] = ["url" => DataTablesWrapperHelper::getLanguageURL($language)];
        }

        $searches = ["%selector%", "%options%"];
        $replaces = [$selector, $this->encodeOptions($options)];

        $javascript = StringHelper::replace(self::JQUERY_DATATABLES_STANDALONE, $searches, $replaces);
        return $this->getRendererTwigExtension()->coreScriptFilter($javascript);
    }

    /**
     * Render a DataTables.
     *
     * @param DataTablesWrapperInterface $dtWrapper The wrapper.
     * @param string $class The class.
     * @param boolean $includeTHead Include thead ?
     * @param boolean $includeTFoot Include tfoot ?
     * @return string Returns the rendered DataTables.
     */
    protected function renderDataTables(DataTablesWrapperInterface $dtWrapper, $class, $includeTHead, $includeTFoot) {

        $attributes = [];

        $attributes["class"] = ["table", $class];
        $attributes["id"]    = DataTablesWrapperHelper::getName($dtWrapper);

        $thead = true === $includeTHead ? $this->renderDataTablesRow($dtWrapper, "thead") . "\n" : "";
        $tfoot = true === $includeTFoot ? $this->renderDataTablesRow($dtWrapper, "tfoot") . "\n" : "";

        $inner = "\n" . $thead . $tfoot;

        return static::coreHTMLElement("table", $inner, $attributes);
    }

    /**
     * Render a column.
     *
     * @param DataTablesColumnInterface $dtColumn The column.
     * @param bool $rowScope Row scope ?
     * @return string Returns the rendered column.
     */
    private function renderDataTablesColumn(DataTablesColumnInterface $dtColumn, $rowScope = false) {

        $attributes = [];

        $attributes["scope"] = true === $rowScope ? "row" : null;
        $attributes["class"] = $dtColumn->getClassname();
        $attributes["width"] = $dtColumn->getWidth();

        return static::coreHTMLElement("th", $dtColumn->getTitle(), $attributes);
    }

    /**
     * Render a row.
     *
     * @param DataTablesWrapperInterface $dtWrapper The wrapper.
     * @param string $wrapper The wrapper (thead or tfoot)
     * @return string Returns the rendered row.
     */
    private function renderDataTablesRow(DataTablesWrapperInterface $dtWrapper, $wrapper) {

        $innerHTML = "";

        $count = count($dtWrapper->getColumns());
        for ($i = 0; $i < $count; ++$i) {

            $dtColumn = array_values($dtWrapper->getColumns())[$i];

            $th = $this->renderDataTablesColumn($dtColumn, ("thead" === $wrapper && 0 === $i));
            if ("" === $th) {
                continue;
            }

            $innerHTML .= $th . "\n";
        }

        $tr = static::coreHTMLElement("tr", "\n" . $innerHTML);

        return static::coreHTMLElement($wrapper, "\n" . $tr . "\n");
    }
}


1			<?php
2
3			/*
4			* This file is part of the jquery-datatables-bundle package.
5			*
6			* (c) 2018 WEBEWEB
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace WBW\Bundle\JQuery\DataTablesBundle\Twig\Extension;
13
14			use Symfony\Component\Filesystem\Exception\FileNotFoundException;
15			use Twig\Environment;
16			use WBW\Bundle\CoreBundle\Service\TwigEnvironmentTrait;
17			use WBW\Bundle\CoreBundle\Twig\Extension\AbstractTwigExtension;
18			use WBW\Bundle\CoreBundle\Twig\Extension\RendererTwigExtension;
19			use WBW\Bundle\CoreBundle\Twig\Extension\RendererTwigExtensionTrait;
20			use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesColumnInterface;
21			use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesWrapperInterface;
22			use WBW\Bundle\JQuery\DataTablesBundle\Helper\DataTablesWrapperHelper;
23			use WBW\Library\Core\Argument\StringHelper;
24
25			/**
26			* Abstract DataTables Twig extension.
27			*
28			* @author webeweb <https://github.com/webeweb/>
29			* @package WBW\Bundle\JQuery\DataTablesBundle\Twig\Extension
30			* @abstract
31			*/
32			abstract class AbstractDataTablesTwigExtension extends AbstractTwigExtension {
33
34			use RendererTwigExtensionTrait;
35			use TwigEnvironmentTrait;
36
37			/**
38			* jQuery DataTables.
39			*
40			* @var string
41			*/
42			const JQUERY_DATATABLES = <<< EOT
43			$(document).ready(function () {
44			var %var% = $("%selector%").DataTable(%options%);
45			});
46			EOT;
47
48			/**
49			* jQuery DataTables.
50			*
51			* @var string
52			*/
53			const JQUERY_DATATABLES_STANDALONE = <<< EOT
54			$(document).ready(function () {
55			$("%selector%").DataTable(%options%);
56			});
57			EOT;
58
59			/**
60			* Constructor.
61			*
62			* @param Environment $twigEnvironment The Twig environment.
63			* @param RendererTwigExtension $rendererTwigExtension The renderer Twig extension.
64			*/
65			public function __construct(Environment $twigEnvironment, RendererTwigExtension $rendererTwigExtension) {
66			parent::__construct($twigEnvironment);
			0 ignored issues – show Compatibility introduced 2019-03-28 15:10 UTC by Report Bug Copy Issue Report `$twigEnvironment` of type `object<Twig\Environment>` is not a sub-type of `object<Twig_Environment>`. It seems like you assume a child class of the class `Twig\Environment` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
67			$this->setRendererTwigExtension($rendererTwigExtension);
68			}
69
70			/**
71			* Encode the options.
72			*
73			* @param array $options The options.
74			* @return string Returns the encoded options.
75			*/
76			protected function encodeOptions(array $options) {
77			if (0 === count($options)) {
78			return "{}";
79			}
80			ksort($options);
81			$output = json_encode($options, JSON_PRETTY_PRINT \| JSON_UNESCAPED_SLASHES);
82			return str_replace("\n", "\n ", $output);
83			}
84
85			/**
86			* Displays a jQuery DataTables.
87			*
88			* @param DataTablesWrapperInterface $dtWrapper The wrapper.
89			* @param string $selector The selector.
90			* @param string $language The language.
91			* @return string Returns the jQuery DataTables.
92			* @throws FileNotFoundException Throws a file not found exception if the language file does not exist.
93			*/
94			protected function jQueryDataTables(DataTablesWrapperInterface $dtWrapper, $selector, $language) {
95
96			$dtOptions = DataTablesWrapperHelper::getOptions($dtWrapper);
97
98			$var = DataTablesWrapperHelper::getName($dtWrapper);
99			$options = $dtOptions;
100			if (null !== $language) {
101			$options["language"] = ["url" => DataTablesWrapperHelper::getLanguageURL($language)];
102			}
103
104			$searches = ["%var%", "%selector%", "%options%"];
105			$replaces = [$var, null === $selector ? "#" . $var : $selector, $this->encodeOptions($options)];
106
107			$javascript = StringHelper::replace(self::JQUERY_DATATABLES, $searches, $replaces);
108			return $this->getRendererTwigExtension()->coreScriptFilter($javascript);
109			}
110
111			/**
112			* Displays a jQuery DataTables "standalone".
113			*
114			* @param string $selector The selector.
115			* @param string $language The language.
116			* @param array $options The options.
117			* @return string Returns the jQuery DataTables "Standalone".
118			* @throws FileNotFoundException Throws a file not found exception if the language file does not exist.
119			*/
120			protected function jQueryDataTablesStandalone($selector, $language, array $options) {
121
122			if (null !== $language) {
123			$options["language"] = ["url" => DataTablesWrapperHelper::getLanguageURL($language)];
124			}
125
126			$searches = ["%selector%", "%options%"];
127			$replaces = [$selector, $this->encodeOptions($options)];
128
129			$javascript = StringHelper::replace(self::JQUERY_DATATABLES_STANDALONE, $searches, $replaces);
130			return $this->getRendererTwigExtension()->coreScriptFilter($javascript);
131			}
132
133			/**
134			* Render a DataTables.
135			*
136			* @param DataTablesWrapperInterface $dtWrapper The wrapper.
137			* @param string $class The class.
138			* @param boolean $includeTHead Include thead ?
139			* @param boolean $includeTFoot Include tfoot ?
140			* @return string Returns the rendered DataTables.
141			*/
142			protected function renderDataTables(DataTablesWrapperInterface $dtWrapper, $class, $includeTHead, $includeTFoot) {
143
144			$attributes = [];
145
146			$attributes["class"] = ["table", $class];
147			$attributes["id"] = DataTablesWrapperHelper::getName($dtWrapper);
148
149			$thead = true === $includeTHead ? $this->renderDataTablesRow($dtWrapper, "thead") . "\n" : "";
150			$tfoot = true === $includeTFoot ? $this->renderDataTablesRow($dtWrapper, "tfoot") . "\n" : "";
151
152			$inner = "\n" . $thead . $tfoot;
153
154			return static::coreHTMLElement("table", $inner, $attributes);
155			}
156
157			/**
158			* Render a column.
159			*
160			* @param DataTablesColumnInterface $dtColumn The column.
161			* @param bool $rowScope Row scope ?
162			* @return string Returns the rendered column.
163			*/
164			private function renderDataTablesColumn(DataTablesColumnInterface $dtColumn, $rowScope = false) {
165
166			$attributes = [];
167
168			$attributes["scope"] = true === $rowScope ? "row" : null;
169			$attributes["class"] = $dtColumn->getClassname();
170			$attributes["width"] = $dtColumn->getWidth();
171
172			return static::coreHTMLElement("th", $dtColumn->getTitle(), $attributes);
173			}
174
175			/**
176			* Render a row.
177			*
178			* @param DataTablesWrapperInterface $dtWrapper The wrapper.
179			* @param string $wrapper The wrapper (thead or tfoot)
180			* @return string Returns the rendered row.
181			*/
182			private function renderDataTablesRow(DataTablesWrapperInterface $dtWrapper, $wrapper) {
183
184			$innerHTML = "";
185
186			$count = count($dtWrapper->getColumns());
187			for ($i = 0; $i < $count; ++$i) {
188
189			$dtColumn = array_values($dtWrapper->getColumns())[$i];
190
191			$th = $this->renderDataTablesColumn($dtColumn, ("thead" === $wrapper && 0 === $i));
192			if ("" === $th) {
193			continue;
194			}
195
196			$innerHTML .= $th . "\n";
197			}
198
199			$tr = static::coreHTMLElement("tr", "\n" . $innerHTML);
200
201			return static::coreHTMLElement($wrapper, "\n" . $tr . "\n");
202			}
203			}
204

webeweb / jquery-datatables-bundle

Push — master ( 207a43...23e505 )

AbstractDataTablesTwigExtension::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like