ViewReferenceXmlCacheRepository::getReferenceByUrl() - Code Metrics - Inspection of "Manage views references tree" - Victoire/victoire - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#290)

by Leny

created 2015-12-01 20:14 UTC

getReferenceByUrl() B

↳ Parent: ViewReferenceXmlCacheRepository

Complexity

Conditions	3
Paths	4

Size

Total Lines	28
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	28
rs	8.8571
cc	3
eloc	15
nc	4
nop	2

<?php

namespace Victoire\Bundle\ViewReferenceBundle\Cache\Xml;

use Gedmo\Uploadable\Mapping\Driver\Xml;
use Victoire\Bundle\ViewReferenceBundle\Builder\Chain\ViewReferenceTransformerChain;
use Victoire\Bundle\ViewReferenceBundle\Helper\ViewReferenceHelper;
use Victoire\Bundle\ViewReferenceBundle\Transformer\XmlToBusinessPageReferenceTransformer;
use Victoire\Bundle\ViewReferenceBundle\Transformer\XmlToViewReferenceTransformer;
use Victoire\Bundle\ViewReferenceBundle\ViewReference\ViewReference;

/**
 * ref: victoire_view_reference.cache.repository.
 */
class ViewReferenceXmlCacheRepository
{
    protected $driver;
    protected $viewReferenceTransformerChain;

    /**
     * @param ViewReferenceXmlCacheDriver   $driver
     * @param ViewReferenceTransformerChain $viewReferenceTransformerChain
     */
    public function __construct(ViewReferenceXmlCacheDriver $driver, ViewReferenceTransformerChain $viewReferenceTransformerChain)
    {
        $this->driver = $driver;
        $this->viewReferenceTransformerChain = $viewReferenceTransformerChain;
    }

    /**
     * @param $url
     * @param $locale
     *
     * @return ViewReference
     */
    public function getReferenceByUrl($url, $locale)
    {

        //Every page is the children of someone and the mother of every page is the homepage (empty slug)
        $xpath = sprintf('//viewReference[@slug="" and @locale="%s"]', $locale);

        $urlParts = explode('/', $url);
        if ($url) {
            //add every hierarchy item in the xpath var
            $xpath .= sprintf(
                '/children/viewReference[@slug="%s"]',
                implode('"]/children/viewReference[@slug="', $urlParts)
            );
        }

        if ($xmlReference = $this->driver->readCache()->xpath($xpath)) {
            $attr = $xmlReference[0]->attributes();
            $transformer = $this->viewReferenceTransformerChain->getViewReferenceTransformer(
                (string) $attr['viewNamespace'], 'xml'
            );

            $viewReference = $transformer->transform($xmlReference[0]);
        } else {
            $viewReference = null;
        }

        return $viewReference;
    }

    /**
     * Return the first viewReference according to the parameters.
     *
     * @param $parameters
     *
     * @return ViewReference|null
     */
    public function getOneReferenceByParameters($parameters, $transform = true)
    {
        $viewReferences = $this->getReferencesByParameters($parameters, $transform);
        if (count($viewReferences)) {
            return $viewReferences[0];
        }
    }

    /**
     * @param array $parameters
     *
     * @return ViewReference[]
     */
    public function getReferencesByParameters($parameters, $transform = true)
    {
        $viewsReferences = [];
        $arguments = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if ($xmlReferences = $this->driver->readCache()->xpath(ViewReferenceHelper::buildXpath($parameters))) {
            foreach ($xmlReferences as $xmlReference) {
                if ($transform === true) {
                    if (isset($xmlReference['entityId'])) {
                        $viewRefTransformer = new XMLToBusinessPageReferenceTransformer();
                    } else {
                        $viewRefTransformer = new XMLToViewReferenceTransformer();
                    }
                    $viewReference = $viewRefTransformer->transform($xmlReference);
                }
                $viewsReferences[] = $viewReference;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            }
        }

        return $viewsReferences;
    }

    /**
     * get the content of the view cache file.
     *
     * @param \SimpleXMLElement $node
     * @param int               $depth
     *
     * @return \array[]
     */
    public function getChoices(\SimpleXMLElement $node = null, $depth = 0)
    {
        $viewsReferences = [];

        $prefixFn = function ($depth, $char0 = '└', $char = '─') {
            $prefix = $char0;
            for ($i = 0; $i <= $depth; $i++) {
                $prefix .= $char;
            }

            return $prefix;
        };

        if (null === $node) {
            $node = $this->driver->readCache();
        }

        foreach ($node->children() as $child) {
            $viewReferenceTransformer = self::findTransformerFromXmlElement($child);
            $viewReference = $viewReferenceTransformer->transform($child);
            if ($viewReference->getName() != '') {
                $prefix = '';
                if ($depth > 0) {
                    $prefix = $prefixFn($depth).' ';
                }
                $viewsReferences[$viewReference->getId()] = $prefix.$viewReference->getName();
            }

            $viewsReferences = array_merge($viewsReferences, $this->getChoices($child, $depth + 1));
        }

        return $viewsReferences;
    }

    /**
     * @param \SimpleXMLElement $xmlElement
     */
    public static function findTransformerFromXmlElement($xmlElement)
    {
        if (isset($xmlElement['entityId'])) {
            $viewRefTransformer = new XMLToBusinessPageReferenceTransformer();
        } else {
            $viewRefTransformer = new XMLToViewReferenceTransformer();
        }

        return $viewRefTransformer;
    }
}


1			<?php
2
3			namespace Victoire\Bundle\ViewReferenceBundle\Cache\Xml;
4
5			use Gedmo\Uploadable\Mapping\Driver\Xml;
6			use Victoire\Bundle\ViewReferenceBundle\Builder\Chain\ViewReferenceTransformerChain;
7			use Victoire\Bundle\ViewReferenceBundle\Helper\ViewReferenceHelper;
8			use Victoire\Bundle\ViewReferenceBundle\Transformer\XmlToBusinessPageReferenceTransformer;
9			use Victoire\Bundle\ViewReferenceBundle\Transformer\XmlToViewReferenceTransformer;
10			use Victoire\Bundle\ViewReferenceBundle\ViewReference\ViewReference;
11
12			/**
13			* ref: victoire_view_reference.cache.repository.
14			*/
15			class ViewReferenceXmlCacheRepository
16			{
17			protected $driver;
18			protected $viewReferenceTransformerChain;
19
20			/**
21			* @param ViewReferenceXmlCacheDriver $driver
22			* @param ViewReferenceTransformerChain $viewReferenceTransformerChain
23			*/
24			public function __construct(ViewReferenceXmlCacheDriver $driver, ViewReferenceTransformerChain $viewReferenceTransformerChain)
25			{
26			$this->driver = $driver;
27			$this->viewReferenceTransformerChain = $viewReferenceTransformerChain;
28			}
29
30			/**
31			* @param $url
32			* @param $locale
33			*
34			* @return ViewReference
35			*/
36			public function getReferenceByUrl($url, $locale)
37			{
38
39			//Every page is the children of someone and the mother of every page is the homepage (empty slug)
40			$xpath = sprintf('//viewReference[@slug="" and @locale="%s"]', $locale);
41
42			$urlParts = explode('/', $url);
43			if ($url) {
44			//add every hierarchy item in the xpath var
45			$xpath .= sprintf(
46			'/children/viewReference[@slug="%s"]',
47			implode('"]/children/viewReference[@slug="', $urlParts)
48			);
49			}
50
51			if ($xmlReference = $this->driver->readCache()->xpath($xpath)) {
52			$attr = $xmlReference[0]->attributes();
53			$transformer = $this->viewReferenceTransformerChain->getViewReferenceTransformer(
54			(string) $attr['viewNamespace'], 'xml'
55			);
56
57			$viewReference = $transformer->transform($xmlReference[0]);
58			} else {
59			$viewReference = null;
60			}
61
62			return $viewReference;
63			}
64
65			/**
66			* Return the first viewReference according to the parameters.
67			*
68			* @param $parameters
69			*
70			* @return ViewReference\|null
71			*/
72			public function getOneReferenceByParameters($parameters, $transform = true)
73			{
74			$viewReferences = $this->getReferencesByParameters($parameters, $transform);
75			if (count($viewReferences)) {
76			return $viewReferences[0];
77			}
78			}
79
80			/**
81			* @param array $parameters
82			*
83			* @return ViewReference[]
84			*/
85			public function getReferencesByParameters($parameters, $transform = true)
86			{
87			$viewsReferences = [];
88			$arguments = [];
			0 ignored issues – show Unused Code introduced 2015-12-01 09:43 UTC by Report Bug Copy Issue Report `$arguments` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
89
90			if ($xmlReferences = $this->driver->readCache()->xpath(ViewReferenceHelper::buildXpath($parameters))) {
91			foreach ($xmlReferences as $xmlReference) {
92			if ($transform === true) {
93			if (isset($xmlReference['entityId'])) {
94			$viewRefTransformer = new XMLToBusinessPageReferenceTransformer();
95			} else {
96			$viewRefTransformer = new XMLToViewReferenceTransformer();
97			}
98			$viewReference = $viewRefTransformer->transform($xmlReference);
99			}
100			$viewsReferences[] = $viewReference;
			0 ignored issues – show Bug introduced 2015-12-01 09:43 UTC by Report Bug Copy Issue Report The variable `$viewReference` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
101			}
102			}
103
104			return $viewsReferences;
105			}
106
107			/**
108			* get the content of the view cache file.
109			*
110			* @param \SimpleXMLElement $node
111			* @param int $depth
112			*
113			* @return \array[]
114			*/
115			public function getChoices(\SimpleXMLElement $node = null, $depth = 0)
116			{
117			$viewsReferences = [];
118
119			$prefixFn = function ($depth, $char0 = '└', $char = '─') {
120			$prefix = $char0;
121			for ($i = 0; $i <= $depth; $i++) {
122			$prefix .= $char;
123			}
124
125			return $prefix;
126			};
127
128			if (null === $node) {
129			$node = $this->driver->readCache();
130			}
131
132			foreach ($node->children() as $child) {
133			$viewReferenceTransformer = self::findTransformerFromXmlElement($child);
134			$viewReference = $viewReferenceTransformer->transform($child);
135			if ($viewReference->getName() != '') {
136			$prefix = '';
137			if ($depth > 0) {
138			$prefix = $prefixFn($depth).' ';
139			}
140			$viewsReferences[$viewReference->getId()] = $prefix.$viewReference->getName();
141			}
142
143			$viewsReferences = array_merge($viewsReferences, $this->getChoices($child, $depth + 1));
144			}
145
146			return $viewsReferences;
147			}
148
149			/**
150			* @param \SimpleXMLElement $xmlElement
151			*/
152			public static function findTransformerFromXmlElement($xmlElement)
153			{
154			if (isset($xmlElement['entityId'])) {
155			$viewRefTransformer = new XMLToBusinessPageReferenceTransformer();
156			} else {
157			$viewRefTransformer = new XMLToViewReferenceTransformer();
158			}
159
160			return $viewRefTransformer;
161			}
162			}
163

Victoire / victoire

Pull Request — master (#290)

getReferenceByUrl() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like