Issues in SitemapXml.php - All Issues - Inspection of "Develop (#598)" - redaxscript/redaxscript - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0ea243...da58d4 )

by Henry

created 2019-05-29 16:08 UTC

modules/SitemapXml/SitemapXml.php (3 issues)

Labels

Severity

Minor 3

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
namespace Redaxscript\Modules\SitemapXml;

use Redaxscript\Dater;
use Redaxscript\Db;
use Redaxscript\Header;
use Redaxscript\Model;
use Redaxscript\Module;
use XMLWriter;

/**
 * submit xml sitemap to search engines
 *
 * @since 2.2.0
 *
 * @package Redaxscript
 * @category Modules
 * @author Henry Ruhs
 */

class SitemapXml extends Module\Module
{
	/**
	 * array of the module
	 *
	 * @var array
	 */

	protected static $_moduleArray =
	[
		'name' => 'Sitemap XML',
		'alias' => 'SitemapXml',
		'author' => 'Redaxmedia',
		'description' => 'Submit XML sitemap to search engines',
		'version' => '4.0.0'
	];

	/**
	 * renderStart
	 *
	 * @since 2.2.0
	 */

	public function renderStart() : void
	{
		if ($this->_registry->get('firstParameter') === 'module' && $this->_registry->get('secondParameter') === 'sitemap-xml')
		{
			$this->_registry->set('renderBreak', true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			echo $this->render();
		}
	}

	/**
	 * render
	 *
	 * @since 2.5.0
	 *
	 * @return string
	 */

	public function render() : string
	{
		/* query categories */

		$categories = Db::forTablePrefix('categories')
			->whereNull('access')
			->where('status', 1)
			->orderByAsc('rank')
			->findMany();

		/* query articles */

		$articles = Db::forTablePrefix('articles')
			->whereNull('access')
			->where('status', 1)
			->orderByAsc('rank')
			->findMany();

		/* write xml */

		Header::contentType('application/xml');
		return $this->_writeXML($categories, $articles);
	}

	/**
	 * write xml
	 *
	 * @since 2.5.0
	 *
	 * @param object $categories
	 * @param object $articles
	 *
	 * @return string
	 */

	protected function _writeXML(object $categories = null, object $articles = null) : string
	{
		$writer = new XMLWriter();
		$categoryModel = new Model\Category();
		$articleModel = new Model\Article();
		$settingModel = new Model\Setting();
		$dater = new Dater();
		$root = $this->_registry->get('root');
		$parameterRoute = $this->_registry->get('parameterRoute');

		/* write xml */

		$writer->openMemory();
		$writer->setIndent(true);
		$writer->setIndentString('	');
		$writer->startDocument('1.0', $settingModel->get('charset'));
		$writer->startElement('urlset');
		$writer->writeAttribute('xmlns', 'http://www.sitemaps.org/schemas/sitemap/0.9');
		$writer->startElement('url');
		$writer->writeElement('loc', $root);
		$writer->endElement();

		/* process categories */

		foreach ($categories as $value)
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
		{
			$dater->init($value->date);
			$writer->startElement('url');
			$writer->writeElement('loc', $root . '/' . $parameterRoute . $categoryModel->getRouteById($value->id));
			$writer->writeElement('lastmod', $dater->getDateTime()->format('c'));
			$writer->endElement();
		}

		/* process articles */

		foreach ($articles as $value)
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
		{
			$dater->init($value->date);
			$writer->startElement('url');
			$writer->writeElement('loc', $root . '/' . $parameterRoute . $articleModel->getRouteById($value->id));
			$writer->writeElement('lastmod', $dater->getDateTime()->format('c'));
			$writer->endElement();
		}
		$writer->endElement();
		$writer->endDocument();
		return $writer->outputMemory(true);
	}
}


1			<?php
2			namespace Redaxscript\Modules\SitemapXml;
3
4			use Redaxscript\Dater;
5			use Redaxscript\Db;
6			use Redaxscript\Header;
7			use Redaxscript\Model;
8			use Redaxscript\Module;
9			use XMLWriter;
10
11			/**
12			* submit xml sitemap to search engines
13			*
14			* @since 2.2.0
15			*
16			* @package Redaxscript
17			* @category Modules
18			* @author Henry Ruhs
19			*/
20
21			class SitemapXml extends Module\Module
22			{
23			/**
24			* array of the module
25			*
26			* @var array
27			*/
28
29			protected static $_moduleArray =
30			[
31			'name' => 'Sitemap XML',
32			'alias' => 'SitemapXml',
33			'author' => 'Redaxmedia',
34			'description' => 'Submit XML sitemap to search engines',
35			'version' => '4.0.0'
36			];
37
38			/**
39			* renderStart
40			*
41			* @since 2.2.0
42			*/
43
44			public function renderStart() : void
45			{
46			if ($this->_registry->get('firstParameter') === 'module' && $this->_registry->get('secondParameter') === 'sitemap-xml')
47			{
48			$this->_registry->set('renderBreak', true);
			0 ignored issues – show Documentation introduced 2018-09-08 16:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this `true` is of type `boolean`, but the function expects a `string\|array\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
49			echo $this->render();
50			}
51			}
52
53			/**
54			* render
55			*
56			* @since 2.5.0
57			*
58			* @return string
59			*/
60
61			public function render() : string
62			{
63			/* query categories */
64
65			$categories = Db::forTablePrefix('categories')
66			->whereNull('access')
67			->where('status', 1)
68			->orderByAsc('rank')
69			->findMany();
70
71			/* query articles */
72
73			$articles = Db::forTablePrefix('articles')
74			->whereNull('access')
75			->where('status', 1)
76			->orderByAsc('rank')
77			->findMany();
78
79			/* write xml */
80
81			Header::contentType('application/xml');
82			return $this->_writeXML($categories, $articles);
83			}
84
85			/**
86			* write xml
87			*
88			* @since 2.5.0
89			*
90			* @param object $categories
91			* @param object $articles
92			*
93			* @return string
94			*/
95
96			protected function _writeXML(object $categories = null, object $articles = null) : string
97			{
98			$writer = new XMLWriter();
99			$categoryModel = new Model\Category();
100			$articleModel = new Model\Article();
101			$settingModel = new Model\Setting();
102			$dater = new Dater();
103			$root = $this->_registry->get('root');
104			$parameterRoute = $this->_registry->get('parameterRoute');
105
106			/* write xml */
107
108			$writer->openMemory();
109			$writer->setIndent(true);
110			$writer->setIndentString(' ');
111			$writer->startDocument('1.0', $settingModel->get('charset'));
112			$writer->startElement('urlset');
113			$writer->writeAttribute('xmlns', 'http://www.sitemaps.org/schemas/sitemap/0.9');
114			$writer->startElement('url');
115			$writer->writeElement('loc', $root);
116			$writer->endElement();
117
118			/* process categories */
119
120			foreach ($categories as $value)
			0 ignored issues – show Bug introduced 2018-09-10 21:53 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$categories` of type `null\|object<Redaxscript\...ules\SitemapXml\object>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
121			{
122			$dater->init($value->date);
123			$writer->startElement('url');
124			$writer->writeElement('loc', $root . '/' . $parameterRoute . $categoryModel->getRouteById($value->id));
125			$writer->writeElement('lastmod', $dater->getDateTime()->format('c'));
126			$writer->endElement();
127			}
128
129			/* process articles */
130
131			foreach ($articles as $value)
			0 ignored issues – show Bug introduced 2018-09-10 21:53 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$articles` of type `null\|object<Redaxscript\...ules\SitemapXml\object>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
132			{
133			$dater->init($value->date);
134			$writer->startElement('url');
135			$writer->writeElement('loc', $root . '/' . $parameterRoute . $articleModel->getRouteById($value->id));
136			$writer->writeElement('lastmod', $dater->getDateTime()->format('c'));
137			$writer->endElement();
138			}
139			$writer->endElement();
140			$writer->endDocument();
141			return $writer->outputMemory(true);
142			}
143			}
144

redaxscript / redaxscript

Push — master ( 0ea243...da58d4 )

modules/SitemapXml/SitemapXml.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like