XmlRenderer::createField() - Code Metrics - Inspection of "Merge branch 'release/1.97.9'" - netz98/n98-magerun - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bd5921...d9293e )

by Christian

created 2016-01-05 12:43 UTC

XmlRenderer::createField() A

↳ Parent: XmlRenderer

Complexity

Conditions	4
Paths	4

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

<?php
/*
 * @author Tom Klingenberg <[email protected]>
 */

namespace N98\Util\Console\Helper\Table\Renderer;

use DOMDocument;
use DOMElement;
use DOMException;
use RuntimeException;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class XmlRenderer
 *
 * @package N98\Util\Console\Helper\Table\Renderer
 */
class XmlRenderer implements RendererInterface
{
    const NAME_ROOT = 'table';
    const NAME_ROW  = 'row';

    private $headers;

    /**
     * {@inheritdoc}
     */
    public function render(OutputInterface $output, array $rows)
    {
        $dom = new DOMDocument('1.0', 'UTF-8');
        $dom->formatOutput = true;

        $rows && $this->setHeadersFrom($rows);


        $table = $dom->createElement(self::NAME_ROOT);

        /** @var DOMElement $table */
        $table = $dom->appendChild($table);

        $this->appendHeaders($table, $this->headers);
        $this->appendRows($table, $rows);

        /** @var $output \Symfony\Component\Console\Output\StreamOutput */
        $output->write($dom->saveXML(), false, $output::OUTPUT_RAW);
    }

    private function appendRows(DOMElement $parent, array $rows)
    {
        $doc = $parent->ownerDocument;

        if (!$rows) {

            $parent->appendChild($doc->createComment('intentionally left blank, the table is empty'));

            return;
        }

        foreach ($rows as $fields) {
            /** @var DOMElement $row */
            $row = $parent->appendChild($doc->createElement(self::NAME_ROW));
            $this->appendRowFields($row, $fields);
        }
    }

    /**
     * @param DOMElement $row
     * @param array      $fields
     */
    private function appendRowFields(DOMElement $row, array $fields)
    {
        $index = 0;
        foreach ($fields as $key => $value) {
            $header  = $this->getHeader($index++, $key);
            $element = $this->createField($row->ownerDocument, $header, $value);
            $row->appendChild($element);
        }
    }

    /**
     * @param DOMElement $parent
     * @param array      $headers
     */
    private function appendHeaders(DOMElement $parent, array $headers = null)
    {
        if (!$headers) {
            return;
        }

        $doc = $parent->ownerDocument;

        $parent = $parent->appendChild($doc->createElement('headers'));

        foreach ($headers as $header) {
            $parent->appendChild($doc->createElement('header', $header));
        }
    }

    /**
     * create a DOMElement containing the data
     *
     * @param DOMDocument $doc
     * @param string      $key
     * @param string      $value
     *
     * @return DOMElement
     */
    private function createField(DOMDocument $doc, $key, $value)
    {
        $name = $this->getName($key);

        $base64 = !preg_match('//u', $value) || preg_match('/[\x0-\x8\xB-\xC\xE-\x1F]/', $value);

        $node = $doc->createElement($name, $base64 ? base64_encode($value) : $value);

        if ($base64) {
            $node->setAttribute('encoding', 'base64');
        }

        return $node;
    }

    /**
     * @param string $string
     *
     * @return string valid XML element name
     *
     * @throws DOMException if no valid XML Name can be generated
     * @throws RuntimeException if character encoding is not US-ASCII or UTF-8
     */
    private function getName($string)
    {
        $name = preg_replace("/[^a-z0-9]/ui", '_', $string);
        if (null === $name) {
            throw new RuntimeException(
                sprintf('Encoding error, only US-ASCII and UTF-8 supported, can not process %s', var_export($string, true))

            );
        }

        try {
            new DOMElement("$name");
        } catch (DOMException $e) {
            throw new DOMException(sprintf('Invalid name %s', var_export($name, true)));
        }

        return $name;
    }

    /**
     * @param int   $index zero-based
     * @param mixed $default
     *
     * @return string
     */
    private function getHeader($index, $default = null)
    {
        if (!isset($this->headers[$index])) {
            return $default;
        }

        return $this->headers[$index];
    }

    /**
     * @param array $rows
     *
     * @return void
     */
    private function setHeadersFrom(array $rows)
    {
        $first = reset($rows);

        if (is_array($first)) {
            $this->headers = array_keys($first);
        }
    }
}


1			<?php
2			/*
3			* @author Tom Klingenberg <[email protected]>
4			*/
5
6			namespace N98\Util\Console\Helper\Table\Renderer;
7
8			use DOMDocument;
9			use DOMElement;
10			use DOMException;
11			use RuntimeException;
12			use Symfony\Component\Console\Output\OutputInterface;
13
14			/**
15			* Class XmlRenderer
16			*
17			* @package N98\Util\Console\Helper\Table\Renderer
18			*/
19			class XmlRenderer implements RendererInterface
20			{
21			const NAME_ROOT = 'table';
22			const NAME_ROW = 'row';
23
24			private $headers;
25
26			/**
27			* {@inheritdoc}
28			*/
29			public function render(OutputInterface $output, array $rows)
30			{
31			$dom = new DOMDocument('1.0', 'UTF-8');
32			$dom->formatOutput = true;
33
34			$rows && $this->setHeadersFrom($rows);
			0 ignored issues – show Bug Best Practice introduced 2016-01-01 09:21 UTC by Report Bug Copy Issue Report The expression `$rows` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
35
36			$table = $dom->createElement(self::NAME_ROOT);
37
38			/** @var DOMElement $table */
39			$table = $dom->appendChild($table);
40
41			$this->appendHeaders($table, $this->headers);
42			$this->appendRows($table, $rows);
43
44			/** @var $output \Symfony\Component\Console\Output\StreamOutput */
45			$output->write($dom->saveXML(), false, $output::OUTPUT_RAW);
46			}
47
48			private function appendRows(DOMElement $parent, array $rows)
49			{
50			$doc = $parent->ownerDocument;
51
52			if (!$rows) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-01 09:21 UTC by Report Bug Copy Issue Report The expression `$rows` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
53			$parent->appendChild($doc->createComment('intentionally left blank, the table is empty'));
54
55			return;
56			}
57
58			foreach ($rows as $fields) {
59			/** @var DOMElement $row */
60			$row = $parent->appendChild($doc->createElement(self::NAME_ROW));
61			$this->appendRowFields($row, $fields);
62			}
63			}
64
65			/**
66			* @param DOMElement $row
67			* @param array $fields
68			*/
69			private function appendRowFields(DOMElement $row, array $fields)
70			{
71			$index = 0;
72			foreach ($fields as $key => $value) {
73			$header = $this->getHeader($index++, $key);
74			$element = $this->createField($row->ownerDocument, $header, $value);
75			$row->appendChild($element);
76			}
77			}
78
79			/**
80			* @param DOMElement $parent
81			* @param array $headers
82			*/
83			private function appendHeaders(DOMElement $parent, array $headers = null)
84			{
85			if (!$headers) {
86			return;
87			}
88
89			$doc = $parent->ownerDocument;
90
91			$parent = $parent->appendChild($doc->createElement('headers'));
92
93			foreach ($headers as $header) {
94			$parent->appendChild($doc->createElement('header', $header));
95			}
96			}
97
98			/**
99			* create a DOMElement containing the data
100			*
101			* @param DOMDocument $doc
102			* @param string $key
103			* @param string $value
104			*
105			* @return DOMElement
106			*/
107			private function createField(DOMDocument $doc, $key, $value)
108			{
109			$name = $this->getName($key);
110
111			$base64 = !preg_match('//u', $value) \|\| preg_match('/[\x0-\x8\xB-\xC\xE-\x1F]/', $value);
112
113			$node = $doc->createElement($name, $base64 ? base64_encode($value) : $value);
114
115			if ($base64) {
116			$node->setAttribute('encoding', 'base64');
117			}
118
119			return $node;
120			}
121
122			/**
123			* @param string $string
124			*
125			* @return string valid XML element name
126			*
127			* @throws DOMException if no valid XML Name can be generated
128			* @throws RuntimeException if character encoding is not US-ASCII or UTF-8
129			*/
130			private function getName($string)
131			{
132			$name = preg_replace("/[^a-z0-9]/ui", '_', $string);
133			if (null === $name) {
134			throw new RuntimeException(
135			sprintf('Encoding error, only US-ASCII and UTF-8 supported, can not process %s', var_export($string, true))
			0 ignored issues – show Coding Style introduced 2016-01-01 09:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 123 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
136			);
137			}
138
139			try {
140			new DOMElement("$name");
141			} catch (DOMException $e) {
142			throw new DOMException(sprintf('Invalid name %s', var_export($name, true)));
143			}
144
145			return $name;
146			}
147
148			/**
149			* @param int $index zero-based
150			* @param mixed $default
151			*
152			* @return string
153			*/
154			private function getHeader($index, $default = null)
155			{
156			if (!isset($this->headers[$index])) {
157			return $default;
158			}
159
160			return $this->headers[$index];
161			}
162
163			/**
164			* @param array $rows
165			*
166			* @return void
167			*/
168			private function setHeadersFrom(array $rows)
169			{
170			$first = reset($rows);
171
172			if (is_array($first)) {
173			$this->headers = array_keys($first);
174			}
175			}
176			}
177

netz98 / n98-magerun

Push — master ( bd5921...d9293e )

XmlRenderer::createField() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like