Issues in Article.php - Fixed 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

includes/View/Article.php (3 issues)

Labels

Severity

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\View;

use Redaxscript\Admin;
use Redaxscript\Config;
use Redaxscript\Content;
use Redaxscript\Html;
use Redaxscript\Language;
use Redaxscript\Model;
use Redaxscript\Module;
use Redaxscript\Registry;
use Redaxscript\Request;
use Redaxscript\Template;
use Redaxscript\Validator;
use function array_replace_recursive;

/**
 * children class to create the article
 *
 * @since 4.0.0
 *
 * @package Redaxscript
 * @category View
 * @author Henry Ruhs
 */

class Article extends ViewAbstract
{
	/**
	 * instance of the request class
	 *
	 * @var Request
	 */

	protected $_request;

	/**
	 * instance of the config class
	 *
	 * @var Config
	 */

	protected $_config;

	/**
	 * options of the article
	 *
	 * @var array
	 */

	protected $_optionArray =
	[
		'tag' =>
		[
			'title' => 'h2',
			'box' => 'div'
		],
		'className' =>
		[
			'title' => 'rs-title-content',
			'box' => 'rs-box-content'
		],
		'orderColumn' => 'rank',
		'partial' =>
		[
			'error' => 'error.phtml'
		]
	];

	/**
	 * constructor of the class
	 *
	 * @since 4.0.0
	 *
	 * @param Registry $registry instance of the registry class
	 * @param Request $request instance of the request class
	 * @param Language $language instance of the language class
	 * @param Config $config instance of the config class
	 */

	public function __construct(Registry $registry, Request $request, Language $language, Config $config)
	{
		parent::__construct($registry, $language);
		$this->_request = $request;
		$this->_config = $config;
	}

	/**
	 * stringify the article
	 *
	 * @since 4.0.0
	 *
	 * @return string
	 */

	public function __toString() : string
	{
		return $this->render();
	}

	/**
	 * init the class
	 *
	 * @since 4.0.0
	 *
	 * @param array $optionArray options of the article
	 */

	public function init(array $optionArray = []) : void
	{
		$this->_optionArray = array_replace_recursive($this->_optionArray, $optionArray);
	}

	/**
	 * render the view
	 *
	 * @since 4.0.0
	 *
	 * @param int $categoryId identifier of the category
	 * @param int $articleId identifier of the article
	 *
	 * @return string
	 */

	public function render(int $categoryId = null, int $articleId = null) : string
	{
		if ($this->_registry->get('articleReplace'))
		{
			return Module\Hook::trigger('articleReplace');
		}
		$output = Module\Hook::trigger('articleStart');
		$outputFragment = null;
		$accessValidator = new Validator\Access();
		$settingModel = new Model\Setting();
		$articleModel = new Model\Article();
		$articles = null;
		$contentParser = new Content\Parser($this->_registry, $this->_request, $this->_language, $this->_config);
		$byline = new Helper\Byline($this->_registry, $this->_language);
		$byline->init();
		$adminDock = new Admin\View\Helper\Dock($this->_registry, $this->_language);
		$adminDock->init();
		$language = $this->_registry->get('language');
		$loggedIn = $this->_registry->get('loggedIn');
		$token = $this->_registry->get('token');
		$firstParameter = $this->_registry->get('firstParameter');
		$lastSubParameter = $this->_registry->get('lastSubParameter');
		$lastTable = $this->_registry->get('lastTable');
		$parameterRoute = $this->_registry->get('parameterRoute');
		$myGroups = $this->_registry->get('myGroups');

		/* html element */

		$element = new Html\Element();
		$titleElement = $element
			->copy()
			->init($this->_optionArray['tag']['title'],
			[
				'class' => $this->_optionArray['className']['title']
			]);
		$linkElement = $element->copy()->init('a');
		$boxElement = $element
			->copy()
			->init($this->_optionArray['tag']['box'],
			[
				'class' => $this->_optionArray['className']['box']
			]);

		/* query articles */

		if (!$firstParameter && $settingModel->get('homepage'))
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
		{
			$articles = $articleModel->getByIdAndLanguageAndOrder($settingModel->get('homepage'), $language, $this->_optionArray['orderColumn']);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		}
		else if ($categoryId)
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
		{
			if ($settingModel->get('pagination'))
			{
				$articles = $articleModel->getByCategoryAndLanguageAndOrderAndStep($categoryId, $language, $this->_optionArray['orderColumn'], $lastSubParameter - 1);
			}
			else
			{
				$articles = $articleModel->getByCategoryAndLanguageAndOrder($categoryId, $language, $this->_optionArray['orderColumn']);
			}
		}
		else if ($articleId)
		{
			$articles = $articleModel->getByIdAndLanguageAndOrder($articleId, $language, $this->_optionArray['orderColumn']);
		}

		/* process articles */

		foreach ($articles as $value)
		{
			if ($accessValidator->validate($value->access, $myGroups))
			{
				$outputFragment .= Module\Hook::trigger('articleFragmentStart', (array)$value);
				if ($value->headline)
				{
					$outputFragment .= $titleElement
						->attr('id', 'article-' . $value->alias)
						->html($lastTable === 'categories' ? $linkElement
							->attr('href', $parameterRoute . $articleModel->getRouteById($value->id))
							->text($value->title) : $value->title
						);
				}
				$contentParser->process($value->text);
				$outputFragment .= $boxElement->html($contentParser->getOutput()) . $byline->render($value->date, $value->author) . Module\Hook::trigger('articleFragmentEnd', (array)$value);

				/* admin dock */

				if ($loggedIn === $token && $firstParameter !== 'logout')
				{
					$outputFragment .= $adminDock->render('articles', $value->id);
				}
			}
		}

		/* collect output */

		$output .= $outputFragment ? : Template\Tag::partial($this->_registry->get('template') . '/' . $this->_optionArray['partial']['error']);
		$output .= Module\Hook::trigger('articleEnd');
		return $output;
	}
}


1			<?php
2			namespace Redaxscript\View;
3
4			use Redaxscript\Admin;
5			use Redaxscript\Config;
6			use Redaxscript\Content;
7			use Redaxscript\Html;
8			use Redaxscript\Language;
9			use Redaxscript\Model;
10			use Redaxscript\Module;
11			use Redaxscript\Registry;
12			use Redaxscript\Request;
13			use Redaxscript\Template;
14			use Redaxscript\Validator;
15			use function array_replace_recursive;
16
17			/**
18			* children class to create the article
19			*
20			* @since 4.0.0
21			*
22			* @package Redaxscript
23			* @category View
24			* @author Henry Ruhs
25			*/
26
27			class Article extends ViewAbstract
28			{
29			/**
30			* instance of the request class
31			*
32			* @var Request
33			*/
34
35			protected $_request;
36
37			/**
38			* instance of the config class
39			*
40			* @var Config
41			*/
42
43			protected $_config;
44
45			/**
46			* options of the article
47			*
48			* @var array
49			*/
50
51			protected $_optionArray =
52			[
53			'tag' =>
54			[
55			'title' => 'h2',
56			'box' => 'div'
57			],
58			'className' =>
59			[
60			'title' => 'rs-title-content',
61			'box' => 'rs-box-content'
62			],
63			'orderColumn' => 'rank',
64			'partial' =>
65			[
66			'error' => 'error.phtml'
67			]
68			];
69
70			/**
71			* constructor of the class
72			*
73			* @since 4.0.0
74			*
75			* @param Registry $registry instance of the registry class
76			* @param Request $request instance of the request class
77			* @param Language $language instance of the language class
78			* @param Config $config instance of the config class
79			*/
80
81			public function __construct(Registry $registry, Request $request, Language $language, Config $config)
82			{
83			parent::__construct($registry, $language);
84			$this->_request = $request;
85			$this->_config = $config;
86			}
87
88			/**
89			* stringify the article
90			*
91			* @since 4.0.0
92			*
93			* @return string
94			*/
95
96			public function __toString() : string
97			{
98			return $this->render();
99			}
100
101			/**
102			* init the class
103			*
104			* @since 4.0.0
105			*
106			* @param array $optionArray options of the article
107			*/
108
109			public function init(array $optionArray = []) : void
110			{
111			$this->_optionArray = array_replace_recursive($this->_optionArray, $optionArray);
112			}
113
114			/**
115			* render the view
116			*
117			* @since 4.0.0
118			*
119			* @param int $categoryId identifier of the category
120			* @param int $articleId identifier of the article
121			*
122			* @return string
123			*/
124
125			public function render(int $categoryId = null, int $articleId = null) : string
126			{
127			if ($this->_registry->get('articleReplace'))
128			{
129			return Module\Hook::trigger('articleReplace');
130			}
131			$output = Module\Hook::trigger('articleStart');
132			$outputFragment = null;
133			$accessValidator = new Validator\Access();
134			$settingModel = new Model\Setting();
135			$articleModel = new Model\Article();
136			$articles = null;
137			$contentParser = new Content\Parser($this->_registry, $this->_request, $this->_language, $this->_config);
138			$byline = new Helper\Byline($this->_registry, $this->_language);
139			$byline->init();
140			$adminDock = new Admin\View\Helper\Dock($this->_registry, $this->_language);
141			$adminDock->init();
142			$language = $this->_registry->get('language');
143			$loggedIn = $this->_registry->get('loggedIn');
144			$token = $this->_registry->get('token');
145			$firstParameter = $this->_registry->get('firstParameter');
146			$lastSubParameter = $this->_registry->get('lastSubParameter');
147			$lastTable = $this->_registry->get('lastTable');
148			$parameterRoute = $this->_registry->get('parameterRoute');
149			$myGroups = $this->_registry->get('myGroups');
150
151			/* html element */
152
153			$element = new Html\Element();
154			$titleElement = $element
155			->copy()
156			->init($this->_optionArray['tag']['title'],
157			[
158			'class' => $this->_optionArray['className']['title']
159			]);
160			$linkElement = $element->copy()->init('a');
161			$boxElement = $element
162			->copy()
163			->init($this->_optionArray['tag']['box'],
164			[
165			'class' => $this->_optionArray['className']['box']
166			]);
167
168			/* query articles */
169
170			if (!$firstParameter && $settingModel->get('homepage'))
			0 ignored issues – show Bug Best Practice introduced 2019-04-22 21:27 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$settingModel->get('homepage')` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
171			{
172			$articles = $articleModel->getByIdAndLanguageAndOrder($settingModel->get('homepage'), $language, $this->_optionArray['orderColumn']);
			0 ignored issues – show Bug introduced 2019-01-26 22:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$language` defined by `$this->_registry->get('language')` on line `142` can also be of type `array`; however, `Redaxscript\Model\Conten...IdAndLanguageAndOrder()` does only seem to accept `null\|string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
173			}
174			else if ($categoryId)
			0 ignored issues – show Bug Best Practice introduced 2019-01-26 22:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$categoryId` of type `null\|integer` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
175			{
176			if ($settingModel->get('pagination'))
177			{
178			$articles = $articleModel->getByCategoryAndLanguageAndOrderAndStep($categoryId, $language, $this->_optionArray['orderColumn'], $lastSubParameter - 1);
179			}
180			else
181			{
182			$articles = $articleModel->getByCategoryAndLanguageAndOrder($categoryId, $language, $this->_optionArray['orderColumn']);
183			}
184			}
185			else if ($articleId)
186			{
187			$articles = $articleModel->getByIdAndLanguageAndOrder($articleId, $language, $this->_optionArray['orderColumn']);
188			}
189
190			/* process articles */
191
192			foreach ($articles as $value)
193			{
194			if ($accessValidator->validate($value->access, $myGroups))
195			{
196			$outputFragment .= Module\Hook::trigger('articleFragmentStart', (array)$value);
197			if ($value->headline)
198			{
199			$outputFragment .= $titleElement
200			->attr('id', 'article-' . $value->alias)
201			->html($lastTable === 'categories' ? $linkElement
202			->attr('href', $parameterRoute . $articleModel->getRouteById($value->id))
203			->text($value->title) : $value->title
204			);
205			}
206			$contentParser->process($value->text);
207			$outputFragment .= $boxElement->html($contentParser->getOutput()) . $byline->render($value->date, $value->author) . Module\Hook::trigger('articleFragmentEnd', (array)$value);
208
209			/* admin dock */
210
211			if ($loggedIn === $token && $firstParameter !== 'logout')
212			{
213			$outputFragment .= $adminDock->render('articles', $value->id);
214			}
215			}
216			}
217
218			/* collect output */
219
220			$output .= $outputFragment ? : Template\Tag::partial($this->_registry->get('template') . '/' . $this->_optionArray['partial']['error']);
221			$output .= Module\Hook::trigger('articleEnd');
222			return $output;
223			}
224			}
225

redaxscript / redaxscript

Push — master ( 0ea243...da58d4 )

includes/View/Article.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like