PjaxExtension::getBase() - Code Metrics - Strontium-90/StrontiumPjaxBundle - Measure and Improve Code Quality continuously with Scrutinizer

PjaxExtension::getBase() A
last analyzed 2016-07-28 11:18 UTC

↳ Parent: PjaxExtension

Complexity

Conditions	4
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	12
rs	9.2
cc	4
eloc	7
nc	2
nop	1

<?php
namespace Strontium\PjaxBundle\Twig;

use Strontium\PjaxBundle\Helper\PjaxHelperInterface;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

class PjaxExtension extends \Twig_Extension
{

    /**
     * @var PjaxHelperInterface
     */
    protected $pjax;

    /**
     * @var array
     */
    protected $sections = [];

    /**
     * @var RequestStack
     */
    protected $requestStack;

    /**
     * @param PjaxHelperInterface $pjax
     * @param RequestStack        $requestStack
     */
    public function __construct(PjaxHelperInterface $pjax, RequestStack $requestStack)
    {
        $this->pjax = $pjax;
        $this->requestStack = $requestStack;
    }

    /**
     * {@inheritDoc}
     */
    public function getFunctions()
    {
        return array(
            new \Twig_SimpleFunction('is_pjax', [$this, 'isPjax'], ['is_safe' => ['html']]),
            new \Twig_SimpleFunction('pjax_attr', [$this, 'generatePjaxAttributes'], ['is_safe' => ['html']]),
            new \Twig_SimpleFunction('pjax_version', [$this, 'pjaxVersion'], ['is_safe' => ['html']]),
            new \Twig_SimpleFunction('pjax_target', [$this, 'getPjaxTarget'], ['is_safe' => ['html']]),
            new \Twig_SimpleFunction('pjax_layout', [$this, 'getLayout'], ['is_safe' => ['html']]),
            new \Twig_SimpleFunction('pjax_base', [$this, 'getBase'], ['is_safe' => ['html']]),
        );
    }

    /**
     * {@inheritDoc}
     */
    public function getFilters()
    {
        return array(
            new \Twig_SimpleFilter('to_attr', [$this, 'toAttributes'], ['is_safe' => ['html']]),
        );
    }

    /**
     * @return string
     */
    public function getLayout($section = 'default', $layout = null)
    {
        $sectionConfig = $this->getSectionConfig($section);
        $request = $this->requestStack->getCurrentRequest();

        if (null !== $layout) {
            return $sectionConfig['layouts'][$layout];
        }
        if ($this->pjax->isPjaxRequest($request)) {
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $target = $this->pjax->getTarget($request);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            if (isset($sectionConfig['layouts'][$target])) {
                return $sectionConfig['layouts'][$target];
            } else {
                return $sectionConfig['layouts'][$sectionConfig['default_layout']];
            }
        }

        return $sectionConfig['layouts'][$sectionConfig['default_layout']];
    }

    /**
     * @param string $section
     *
     * @return string
     */
    public function getBase($section = 'default')
    {
        $sectionConfig = $this->getSectionConfig($section);
        $request = $this->requestStack->getCurrentRequest();
        if ((null !== $request && $this->pjax->isPjaxRequest($request))
            || null !== $this->requestStack->getParentRequest()
        ) {
            return $sectionConfig['pjax_template'];
        }

        return $sectionConfig['base_template'];
    }

    /**
     * @param array $sections
     *
     * @return $this
     */
    public function setSections(array $sections)
    {
        $this->sections = $sections;

        return $this;
    }

    /**
     * @param Request $request
     *
     * @return string|null
     */
    public function pjaxVersion(Request $request)
    {
        $version = $this->pjax->generateVersion($request);

        return $version ? sprintf('<meta http-equiv="x-pjax-version" content="%s"/>', $version) : null;
    }

    /**
     * Convert array to html attributes
     *
     * @param array $attributes
     *
     * @return string
     */
    public function toAttributes(array $attributes = array())
    {
        $htmlAttr = [];

        foreach ($attributes as $key => $value) {
            if (is_bool($value)) {
                $value = $value ? 'true' : 'false';
            }
            $htmlAttr[] = sprintf(' %s="%s"', $key, $value);
        }

        if (!count($htmlAttr)) {
            return '';
        }

        return implode('', $htmlAttr);
    }

    /**
     * Has Request been made by PJAX?
     *
     * @param Request $request
     *
     * @return bool
     */
    public function isPjax(Request $request)
    {
        return $this->pjax->isPjaxRequest($request);
    }

    /**
     * @param Request $request
     *
     * @return string
     */
    public function getPjaxTarget(Request $request)
    {
        return $this->pjax->getTarget($request);
    }

    /**
     * Generate PJAX attributes
     *
     * @param string $target         data-pjax-container="$target" where content will load
     * @param string $redirectTarget data-pjax-redirect-target="$redirectTarget" where content will load after redirect
     *
     * @return array
     */
    public function generatePjaxAttributes($target = null, $redirectTarget = null)
    {
        $attributes = [];
        if (null !== $target) {
            $attributes['data-pjax'] = (string)$target;
        }
        if (null !== $redirectTarget) {
            $attributes['data-pjax-redirect-target'] = (string)$redirectTarget;
        }

        return $attributes;
    }

    /**
     * {@inheritDoc}
     */
    public function getName()
    {
        return 'pjax_extension';
    }

    /**
     * @param string $section
     *
     * @return array
     */
    protected function getSectionConfig($section)
    {
        if (!isset($this->sections[$section])) {
            throw new InvalidConfigurationException(sprintf('Section "%s" does not configured', $section));
        }
        $sectionConfig = $this->sections[$section];

        return $sectionConfig;
    }
}


1			<?php
2			namespace Strontium\PjaxBundle\Twig;
3
4			use Strontium\PjaxBundle\Helper\PjaxHelperInterface;
5			use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
6			use Symfony\Component\HttpFoundation\Request;
7			use Symfony\Component\HttpFoundation\RequestStack;
8
9			class PjaxExtension extends \Twig_Extension
10			{
11
12			/**
13			* @var PjaxHelperInterface
14			*/
15			protected $pjax;
16
17			/**
18			* @var array
19			*/
20			protected $sections = [];
21
22			/**
23			* @var RequestStack
24			*/
25			protected $requestStack;
26
27			/**
28			* @param PjaxHelperInterface $pjax
29			* @param RequestStack $requestStack
30			*/
31			public function __construct(PjaxHelperInterface $pjax, RequestStack $requestStack)
32			{
33			$this->pjax = $pjax;
34			$this->requestStack = $requestStack;
35			}
36
37			/**
38			* {@inheritDoc}
39			*/
40			public function getFunctions()
41			{
42			return array(
43			new \Twig_SimpleFunction('is_pjax', [$this, 'isPjax'], ['is_safe' => ['html']]),
44			new \Twig_SimpleFunction('pjax_attr', [$this, 'generatePjaxAttributes'], ['is_safe' => ['html']]),
45			new \Twig_SimpleFunction('pjax_version', [$this, 'pjaxVersion'], ['is_safe' => ['html']]),
46			new \Twig_SimpleFunction('pjax_target', [$this, 'getPjaxTarget'], ['is_safe' => ['html']]),
47			new \Twig_SimpleFunction('pjax_layout', [$this, 'getLayout'], ['is_safe' => ['html']]),
48			new \Twig_SimpleFunction('pjax_base', [$this, 'getBase'], ['is_safe' => ['html']]),
49			);
50			}
51
52			/**
53			* {@inheritDoc}
54			*/
55			public function getFilters()
56			{
57			return array(
58			new \Twig_SimpleFilter('to_attr', [$this, 'toAttributes'], ['is_safe' => ['html']]),
59			);
60			}
61
62			/**
63			* @return string
64			*/
65			public function getLayout($section = 'default', $layout = null)
66			{
67			$sectionConfig = $this->getSectionConfig($section);
68			$request = $this->requestStack->getCurrentRequest();
69
70			if (null !== $layout) {
71			return $sectionConfig['layouts'][$layout];
72			}
73			if ($this->pjax->isPjaxRequest($request)) {
			0 ignored issues – show Bug introduced 2016-07-08 10:43 UTC by Report Bug Copy Issue Report It seems like `$request` defined by `$this->requestStack->getCurrentRequest()` on line `68` can be `null`; however, `Strontium\PjaxBundle\Hel...erface::isPjaxRequest()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
74			$target = $this->pjax->getTarget($request);
			0 ignored issues – show Bug introduced 2016-07-08 10:43 UTC by Report Bug Copy Issue Report It seems like `$request` defined by `$this->requestStack->getCurrentRequest()` on line `68` can be `null`; however, `Strontium\PjaxBundle\Hel...rInterface::getTarget()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
75			if (isset($sectionConfig['layouts'][$target])) {
76			return $sectionConfig['layouts'][$target];
77			} else {
78			return $sectionConfig['layouts'][$sectionConfig['default_layout']];
79			}
80			}
81
82			return $sectionConfig['layouts'][$sectionConfig['default_layout']];
83			}
84
85			/**
86			* @param string $section
87			*
88			* @return string
89			*/
90			public function getBase($section = 'default')
91			{
92			$sectionConfig = $this->getSectionConfig($section);
93			$request = $this->requestStack->getCurrentRequest();
94			if ((null !== $request && $this->pjax->isPjaxRequest($request))
95			\|\| null !== $this->requestStack->getParentRequest()
96			) {
97			return $sectionConfig['pjax_template'];
98			}
99
100			return $sectionConfig['base_template'];
101			}
102
103			/**
104			* @param array $sections
105			*
106			* @return $this
107			*/
108			public function setSections(array $sections)
109			{
110			$this->sections = $sections;
111
112			return $this;
113			}
114
115			/**
116			* @param Request $request
117			*
118			* @return string\|null
119			*/
120			public function pjaxVersion(Request $request)
121			{
122			$version = $this->pjax->generateVersion($request);
123
124			return $version ? sprintf('<meta http-equiv="x-pjax-version" content="%s"/>', $version) : null;
125			}
126
127			/**
128			* Convert array to html attributes
129			*
130			* @param array $attributes
131			*
132			* @return string
133			*/
134			public function toAttributes(array $attributes = array())
135			{
136			$htmlAttr = [];
137
138			foreach ($attributes as $key => $value) {
139			if (is_bool($value)) {
140			$value = $value ? 'true' : 'false';
141			}
142			$htmlAttr[] = sprintf(' %s="%s"', $key, $value);
143			}
144
145			if (!count($htmlAttr)) {
146			return '';
147			}
148
149			return implode('', $htmlAttr);
150			}
151
152			/**
153			* Has Request been made by PJAX?
154			*
155			* @param Request $request
156			*
157			* @return bool
158			*/
159			public function isPjax(Request $request)
160			{
161			return $this->pjax->isPjaxRequest($request);
162			}
163
164			/**
165			* @param Request $request
166			*
167			* @return string
168			*/
169			public function getPjaxTarget(Request $request)
170			{
171			return $this->pjax->getTarget($request);
172			}
173
174			/**
175			* Generate PJAX attributes
176			*
177			* @param string $target data-pjax-container="$target" where content will load
178			* @param string $redirectTarget data-pjax-redirect-target="$redirectTarget" where content will load after redirect
179			*
180			* @return array
181			*/
182			public function generatePjaxAttributes($target = null, $redirectTarget = null)
183			{
184			$attributes = [];
185			if (null !== $target) {
186			$attributes['data-pjax'] = (string)$target;
187			}
188			if (null !== $redirectTarget) {
189			$attributes['data-pjax-redirect-target'] = (string)$redirectTarget;
190			}
191
192			return $attributes;
193			}
194
195			/**
196			* {@inheritDoc}
197			*/
198			public function getName()
199			{
200			return 'pjax_extension';
201			}
202
203			/**
204			* @param string $section
205			*
206			* @return array
207			*/
208			protected function getSectionConfig($section)
209			{
210			if (!isset($this->sections[$section])) {
211			throw new InvalidConfigurationException(sprintf('Section "%s" does not configured', $section));
212			}
213			$sectionConfig = $this->sections[$section];
214
215			return $sectionConfig;
216			}
217			}
218

Strontium-90 / StrontiumPjaxBundle

GitHub Access Token became invalid

PjaxExtension::getBase() A last analyzed 2016-07-28 11:18 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PjaxExtension::getBase() A
last analyzed 2016-07-28 11:18 UTC