attachments::get_allowed_forums() - Code Metrics - Inspection of "Remove need to have another template instance" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — templating ( 0cf8c2 )

by Daniel

created 2020-10-23 23:53 UTC

attachments::get_allowed_forums() A

↳ Parent: attachments

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	9
rs	10
c	0
b	0
f	0

<?php

/**
 *
 * @package sitemaker
 * @copyright (c) 2013 Daniel A. (blitze)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace blitze\sitemaker\blocks;

use blitze\sitemaker\services\blocks\driver\block;

/**
 * Attachments Block
 */
class attachments extends block
{
	/** @var \phpbb\auth\auth */
	protected $auth;

	/** @var \phpbb\cache\service */
	protected $cache;

	/** @var \blitze\sitemaker\services\date_range */
	protected $date_range;

	/** @var \blitze\sitemaker\services\forum\data */
	protected $forum_data;

	/** @var \blitze\sitemaker\services\forum\options */
	protected $forum_options;

	/** @var string */
	protected $phpbb_root_path;

	/** @var string */
	protected $php_ext;

	/** @var array */
	private $settings = array();

	/**
	 * Constructor
	 *
	 * @param \phpbb\auth\auth							$auth				Permission object
	 * @param \phpbb\cache\service						$cache				Cache Service object
	 * @param \blitze\sitemaker\services\date_range		$date_range			Date Range Object
	 * @param \blitze\sitemaker\services\forum\data		$forum_data			Forum Data object
	 * @param \blitze\sitemaker\services\forum\options	$forum_options		Forum Options object
	 * @param string									$phpbb_root_path	Path to the phpbb includes directory.
	 * @param string									$php_ext			php file extension
	 */
	public function __construct(\phpbb\auth\auth $auth, \phpbb\cache\service $cache, \blitze\sitemaker\services\date_range $date_range, \blitze\sitemaker\services\forum\data $forum_data, \blitze\sitemaker\services\forum\options $forum_options, $phpbb_root_path, $php_ext)
	{
		$this->auth = $auth;
		$this->cache = $cache;
		$this->date_range = $date_range;
		$this->forum_data = $forum_data;
		$this->forum_options = $forum_options;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $php_ext;
	}

	/**
	 * @inheritdoc
	 */
	public function get_config(array $settings)
	{
		$forum_options = $this->forum_options->get_all();
		$topic_type_options = $this->forum_options->get_topic_types();
		$range_options = $this->get_range_options();
		$attach_type_options = array('' => 'ALL_TYPES', 'IMAGES' => 'IMAGES', 'ARCHIVES' => 'ARCHIVES');
		$id_type_options = array('topic' => 'TOPICS', 'post' => 'POSTS');

		return array(
			'legend1'			=> 'SETTINGS',
			'forum_ids'			=> array('lang' => 'SELECT_FORUMS', 'validate' => 'string', 'type' => 'multi_select', 'options' => $forum_options, 'default' => array(), 'explain' => false),
			'topic_type'		=> array('lang' => 'TOPIC_TYPE', 'validate' => 'string', 'type' => 'checkbox', 'options' => $topic_type_options, 'default' => array(), 'explain' => false),
			'first_only'		=> array('lang' => 'FIRST_POST_ONLY', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false, 'default' => false),
			'ids_type'			=> array('lang' => 'TOPIC_POST_IDS_TYPE', 'validate' => 'bool', 'type' => 'radio', 'options' => $id_type_options, 'explain' => false, 'default' => 'topic'),
			'ids'				=> array('lang' => 'TOPIC_POST_IDS', 'validate' => 'string', 'type' => 'textarea:3:40', 'maxlength' => 2, 'explain' => true, 'default' => ''),
			'date_range'		=> array('lang' => 'LIMIT_POST_TIME', 'validate' => 'string', 'type' => 'select', 'options' => $range_options, 'default' => '', 'explain' => false),
			'limit'				=> array('lang' => 'LIMIT', 'validate' => 'int:0', 'type' => 'number:0', 'maxlength' => 2, 'explain' => false, 'default' => 5),
			'ext_type'			=> array('lang' => 'EXTENSION_GROUP', 'validate' => 'string', 'type' => 'radio', 'options' => $attach_type_options, 'default' => '', 'explain' => false),
		);
	}

	/**
	 * {@inheritdoc}
	 */
	public function display(array $bdata, $edit_mode = false)
	{
		$this->settings = $bdata['settings'];

		$extensions = $this->cache->obtain_attach_extensions(0);
		$ext_groups = $this->get_extension_groups($extensions);

		$posts_data = $this->get_posts_data();
		$attachments = $this->forum_data->get_attachments(0, $ext_groups[$this->settings['ext_type']], $this->settings['limit'], false);

		return array(
			'title'	=> 'ATTACHMENTS',
			'data'	=> $this->get_attachments_data($attachments, $posts_data, $extensions),
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
		);
	}

	/**
	 * @param array $attachments_ary
	 * @param array $posts_data
	 * @param array $extensions
	 * @return []

	 */
	protected function get_attachments_data(array $attachments_ary, array $posts_data, array $extensions)
	{
		$message = '';
		$data = $update_count = [];

		foreach ($attachments_ary as $post_id => $attachments)
		{
			$topic_id = $attachments[0]['topic_id'];
			$post_row = $posts_data[$topic_id][$post_id];

			parse_attachments($post_row['forum_id'], $message, $attachments, $update_count, true);

			$attachment_row = [];
			foreach ($attachments as $i => $attachment)
			{
				$row = $attachments_ary[$post_id][$i];
				$topic_id = $row['topic_id'];
				$post_id = $row['post_msg_id'];

				$attachment_row[] = array(
					'DISPLAY_ATTACHMENT'	=> $attachment,
					'EXTENSION_GROUP'		=> $extensions[$row['extension']]['group_name'],
					'U_VIEWTOPIC'			=> append_sid("{$this->phpbb_root_path}viewtopic.{$this->php_ext}", "t=$topic_id&amp;p=$post_id") . '#p' . $post_id,
				);
			}

			$data[] = $attachment_row;
		}
	}

	/**
	 * @return array
	 */
	private function get_posts_data()
	{
		$topic_ids = $post_ids = array();
		${$this->settings['ids_type'] . '_ids'} = array_filter(explode(',', $this->settings['ids']));
		$range_info = $this->date_range->get($this->settings['date_range']);

		$sql_array = $this->forum_data->query(false)
			->fetch_forum($this->get_allowed_forums())
			->fetch_topic_type($this->settings['topic_type'])
			->fetch_topic($topic_ids)
			->fetch_date_range($range_info['start'], $range_info['stop'])
			->build(true, true, false)
			->get_sql_array();

		$sql_array['SELECT'] = '';
		$sql_array['WHERE'] .= ' AND p.topic_id = t.topic_id AND p.post_attachment <> 0' . (($this->settings['first_only']) ? ' AND p.post_id = t.topic_first_post_id' : '');

		return $this->forum_data->get_post_data(false, $post_ids, $this->settings['limit'], 0, $sql_array);
	}

	/**
	 * @param array $extensions
	 * @return array
	 */
	protected function get_extension_groups(array $extensions)
	{
		array_shift($extensions);

		$ext_groups = array('' => array());
		foreach ($extensions as $ext => $row)
		{
			$ext_groups[$row['group_name']][] = $ext;
		}

		return $ext_groups;
	}

	/**
	 * @return array
	 */
	private function get_allowed_forums()
	{
		$allowed_forums = array_keys($this->auth->acl_getf('f_download', true));
		if (sizeof($this->settings['forum_ids']))
		{
			$allowed_forums = array_intersect($this->settings['forum_ids'], $allowed_forums);
		}

		return array_map('intval', $allowed_forums);
	}

	/**
	 * @return array
	 */
	private function get_range_options()
	{
		return array(
			''      => 'ALL_TIME',
			'today' => 'TODAY',
			'week'  => 'THIS_WEEK',
			'month' => 'THIS_MONTH',
			'year'  => 'THIS_YEAR',
		);
	}

	/**
	 * {@inheritdoc}
	 */
	public function get_template()
	{
		return '@blitze_sitemaker/blocks/attachments.html';
	}
}


1			<?php
2
3			/**
4			*
5			* @package sitemaker
6			* @copyright (c) 2013 Daniel A. (blitze)
7			* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
8			*
9			*/
10
11			namespace blitze\sitemaker\blocks;
12
13			use blitze\sitemaker\services\blocks\driver\block;
14
15			/**
16			* Attachments Block
17			*/
18			class attachments extends block
19			{
20			/** @var \phpbb\auth\auth */
21			protected $auth;
22
23			/** @var \phpbb\cache\service */
24			protected $cache;
25
26			/** @var \blitze\sitemaker\services\date_range */
27			protected $date_range;
28
29			/** @var \blitze\sitemaker\services\forum\data */
30			protected $forum_data;
31
32			/** @var \blitze\sitemaker\services\forum\options */
33			protected $forum_options;
34
35			/** @var string */
36			protected $phpbb_root_path;
37
38			/** @var string */
39			protected $php_ext;
40
41			/** @var array */
42			private $settings = array();
43
44			/**
45			* Constructor
46			*
47			* @param \phpbb\auth\auth $auth Permission object
48			* @param \phpbb\cache\service $cache Cache Service object
49			* @param \blitze\sitemaker\services\date_range $date_range Date Range Object
50			* @param \blitze\sitemaker\services\forum\data $forum_data Forum Data object
51			* @param \blitze\sitemaker\services\forum\options $forum_options Forum Options object
52			* @param string $phpbb_root_path Path to the phpbb includes directory.
53			* @param string $php_ext php file extension
54			*/
55			public function __construct(\phpbb\auth\auth $auth, \phpbb\cache\service $cache, \blitze\sitemaker\services\date_range $date_range, \blitze\sitemaker\services\forum\data $forum_data, \blitze\sitemaker\services\forum\options $forum_options, $phpbb_root_path, $php_ext)
56			{
57			$this->auth = $auth;
58			$this->cache = $cache;
59			$this->date_range = $date_range;
60			$this->forum_data = $forum_data;
61			$this->forum_options = $forum_options;
62			$this->phpbb_root_path = $phpbb_root_path;
63			$this->php_ext = $php_ext;
64			}
65
66			/**
67			* @inheritdoc
68			*/
69			public function get_config(array $settings)
70			{
71			$forum_options = $this->forum_options->get_all();
72			$topic_type_options = $this->forum_options->get_topic_types();
73			$range_options = $this->get_range_options();
74			$attach_type_options = array('' => 'ALL_TYPES', 'IMAGES' => 'IMAGES', 'ARCHIVES' => 'ARCHIVES');
75			$id_type_options = array('topic' => 'TOPICS', 'post' => 'POSTS');
76
77			return array(
78			'legend1' => 'SETTINGS',
79			'forum_ids' => array('lang' => 'SELECT_FORUMS', 'validate' => 'string', 'type' => 'multi_select', 'options' => $forum_options, 'default' => array(), 'explain' => false),
80			'topic_type' => array('lang' => 'TOPIC_TYPE', 'validate' => 'string', 'type' => 'checkbox', 'options' => $topic_type_options, 'default' => array(), 'explain' => false),
81			'first_only' => array('lang' => 'FIRST_POST_ONLY', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false, 'default' => false),
82			'ids_type' => array('lang' => 'TOPIC_POST_IDS_TYPE', 'validate' => 'bool', 'type' => 'radio', 'options' => $id_type_options, 'explain' => false, 'default' => 'topic'),
83			'ids' => array('lang' => 'TOPIC_POST_IDS', 'validate' => 'string', 'type' => 'textarea:3:40', 'maxlength' => 2, 'explain' => true, 'default' => ''),
84			'date_range' => array('lang' => 'LIMIT_POST_TIME', 'validate' => 'string', 'type' => 'select', 'options' => $range_options, 'default' => '', 'explain' => false),
85			'limit' => array('lang' => 'LIMIT', 'validate' => 'int:0', 'type' => 'number:0', 'maxlength' => 2, 'explain' => false, 'default' => 5),
86			'ext_type' => array('lang' => 'EXTENSION_GROUP', 'validate' => 'string', 'type' => 'radio', 'options' => $attach_type_options, 'default' => '', 'explain' => false),
87			);
88			}
89
90			/**
91			* {@inheritdoc}
92			*/
93			public function display(array $bdata, $edit_mode = false)
94			{
95			$this->settings = $bdata['settings'];
96
97			$extensions = $this->cache->obtain_attach_extensions(0);
98			$ext_groups = $this->get_extension_groups($extensions);
99
100			$posts_data = $this->get_posts_data();
101			$attachments = $this->forum_data->get_attachments(0, $ext_groups[$this->settings['ext_type']], $this->settings['limit'], false);
102
103			return array(
104			'title' => 'ATTACHMENTS',
105			'data' => $this->get_attachments_data($attachments, $posts_data, $extensions),
			0 ignored issues – show Bug introduced 2020-10-24 00:14 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->get_attachments_d...osts_data, $extensions)` targeting `blitze\sitemaker\blocks\...:get_attachments_data()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
106			);
107			}
108
109			/**
110			* @param array $attachments_ary
111			* @param array $posts_data
112			* @param array $extensions
113			* @return []
			0 ignored issues – show Documentation Bug introduced 2020-10-24 00:14 UTC by Report Bug Copy Issue Report The doc comment `[]` at position `0` could not be parsed: Unknown type name '[' at position 0 in []. Loading history...
114			*/
115			protected function get_attachments_data(array $attachments_ary, array $posts_data, array $extensions)
116			{
117			$message = '';
118			$data = $update_count = [];
119
120			foreach ($attachments_ary as $post_id => $attachments)
121			{
122			$topic_id = $attachments[0]['topic_id'];
123			$post_row = $posts_data[$topic_id][$post_id];
124
125			parse_attachments($post_row['forum_id'], $message, $attachments, $update_count, true);
126
127			$attachment_row = [];
128			foreach ($attachments as $i => $attachment)
129			{
130			$row = $attachments_ary[$post_id][$i];
131			$topic_id = $row['topic_id'];
132			$post_id = $row['post_msg_id'];
133
134			$attachment_row[] = array(
135			'DISPLAY_ATTACHMENT' => $attachment,
136			'EXTENSION_GROUP' => $extensions[$row['extension']]['group_name'],
137			'U_VIEWTOPIC' => append_sid("{$this->phpbb_root_path}viewtopic.{$this->php_ext}", "t=$topic_id&p=$post_id") . '#p' . $post_id,
138			);
139			}
140
141			$data[] = $attachment_row;
142			}
143			}
144
145			/**
146			* @return array
147			*/
148			private function get_posts_data()
149			{
150			$topic_ids = $post_ids = array();
151			${$this->settings['ids_type'] . '_ids'} = array_filter(explode(',', $this->settings['ids']));
152			$range_info = $this->date_range->get($this->settings['date_range']);
153
154			$sql_array = $this->forum_data->query(false)
155			->fetch_forum($this->get_allowed_forums())
156			->fetch_topic_type($this->settings['topic_type'])
157			->fetch_topic($topic_ids)
158			->fetch_date_range($range_info['start'], $range_info['stop'])
159			->build(true, true, false)
160			->get_sql_array();
161
162			$sql_array['SELECT'] = '';
163			$sql_array['WHERE'] .= ' AND p.topic_id = t.topic_id AND p.post_attachment <> 0' . (($this->settings['first_only']) ? ' AND p.post_id = t.topic_first_post_id' : '');
164
165			return $this->forum_data->get_post_data(false, $post_ids, $this->settings['limit'], 0, $sql_array);
166			}
167
168			/**
169			* @param array $extensions
170			* @return array
171			*/
172			protected function get_extension_groups(array $extensions)
173			{
174			array_shift($extensions);
175
176			$ext_groups = array('' => array());
177			foreach ($extensions as $ext => $row)
178			{
179			$ext_groups[$row['group_name']][] = $ext;
180			}
181
182			return $ext_groups;
183			}
184
185			/**
186			* @return array
187			*/
188			private function get_allowed_forums()
189			{
190			$allowed_forums = array_keys($this->auth->acl_getf('f_download', true));
191			if (sizeof($this->settings['forum_ids']))
192			{
193			$allowed_forums = array_intersect($this->settings['forum_ids'], $allowed_forums);
194			}
195
196			return array_map('intval', $allowed_forums);
197			}
198
199			/**
200			* @return array
201			*/
202			private function get_range_options()
203			{
204			return array(
205			'' => 'ALL_TIME',
206			'today' => 'TODAY',
207			'week' => 'THIS_WEEK',
208			'month' => 'THIS_MONTH',
209			'year' => 'THIS_YEAR',
210			);
211			}
212
213			/**
214			* {@inheritdoc}
215			*/
216			public function get_template()
217			{
218			return '@blitze_sitemaker/blocks/attachments.html';
219			}
220			}
221

blitze / phpBB-ext-sitemaker

Push — templating ( 0cf8c2 )

attachments::get_allowed_forums() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like