Use a class constant for index only value of -1

Signed-off-by: Matt Friedman <[email protected]>
phpbb-extensions · Jun 26, 2024 · 4564be4 · 4564be4
1 parent d8b55cf
commit 4564be4
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 10 deletions.
diff --git a/adm/style/settings_list.html b/adm/style/settings_list.html
@@ -45,7 +45,7 @@ <h1>{{ lang('BOARD_ANNOUNCEMENTS_SETTINGS') }}</h1>
 				{% if ba.LOCATIONS is empty %}
 					{{ lang('BOARD_ANNOUNCEMENTS_EVERYWHERE') }}
 				{% else %}
-					{% set has_index = -1 in ba.LOCATIONS %}
+					{% set has_index = constant('\\phpbb\\boardannouncements\\ext::INDEX_ONLY') in ba.LOCATIONS %}
 					{% set has_forums = ba.LOCATIONS|filter(v => v > 0)|length > 0 %}
 					{% if has_index and has_forums %}
 						{{ lang('BOARD_ANNOUNCEMENTS_INDEX_PAGE') }}, {{ lang('BOARD_ANNOUNCEMENTS_FORUMS') }}

diff --git a/controller/acp_controller.php b/controller/acp_controller.php
@@ -450,7 +450,7 @@ protected function log_change($msg, $params)
 	/**
 	 * Get an array of available locations for the announcement
 	 *
-	 * @param string $selected
+	 * @param string $locations
 	 * @return array
 	 */
 	protected function get_location_options($locations)
@@ -459,8 +459,13 @@ protected function get_location_options($locations)
 
 		$forum_list = make_forum_select($selected, false, false, false, false, false, true);
 
-		// Add the index page
-		$forum_list[0] = array_merge(['padding' => '', 'selected' => in_array(-1, $selected)], ['forum_id' => -1, 'forum_name' => $this->language->lang('BOARD_ANNOUNCEMENTS_INDEX_PAGE')]);
+		// Add the index page to the list
+		$forum_list[0] = [
+			'padding'    => '',
+			'selected'   => in_array(ext::INDEX_ONLY, $selected),
+			'forum_id'   => ext::INDEX_ONLY,
+			'forum_name' => $this->language->lang('BOARD_ANNOUNCEMENTS_INDEX_PAGE')
+		];
 
 		ksort($forum_list);
 

diff --git a/event/listener.php b/event/listener.php
@@ -10,6 +10,7 @@
 
 namespace phpbb\boardannouncements\event;
 
+use phpbb\boardannouncements\ext;
 use phpbb\boardannouncements\manager\manager;
 use phpbb\config\config;
 use phpbb\controller\helper;
@@ -109,7 +110,7 @@ public function display_board_announcements()
 		$board_announcements_data = array_filter($board_announcements_data, function ($data) {
 			$locations = json_decode($data['announcement_locations'], true);
 			$is_index = $this->user->page['page_name'] === "index.$this->php_ext";
-			$current_page = $is_index ? -1 : $this->request->variable('f', 0);
+			$current_page = $is_index ? ext::INDEX_ONLY : $this->request->variable('f', 0);
 
 			// Check if announcement has locations specified, and user is at that location
 			if (!empty($locations) && !in_array($current_page, $locations))

diff --git a/ext.php b/ext.php
@@ -15,6 +15,7 @@
  */
 class ext extends \phpbb\extension\base
 {
+	public const INDEX_ONLY = -1;
 	public const ALL = 0;
 	public const MEMBERS = 1;
 	public const GUESTS = 2;

diff --git a/language/en/boardannouncements_acp.php b/language/en/boardannouncements_acp.php
@@ -78,7 +78,7 @@
 	'BOARD_ANNOUNCEMENTS_TH_EXPIRED'		=> 'Expired',
 
 	'BOARD_ANNOUNCEMENTS_EVERYWHERE'		=> 'Everywhere',
-	'BOARD_ANNOUNCEMENTS_INDEX_PAGE'		=> 'Index Page',
+	'BOARD_ANNOUNCEMENTS_INDEX_PAGE'		=> 'Board Index',
 	'BOARD_ANNOUNCEMENTS_FORUMS'			=> 'Selected Forums',
 
 	'BOARD_ANNOUNCEMENTS_EMPTY'				=> 'There are no board announcements to display',

diff --git a/migrations/v10x/m13_locations_data.php b/migrations/v10x/m13_locations_data.php
@@ -10,6 +10,7 @@
 
 namespace phpbb\boardannouncements\migrations\v10x;
 
+use phpbb\boardannouncements\ext;
 use phpbb\boardannouncements\manager\nestedset;
 
 /**
@@ -69,7 +70,7 @@ public function copy_locations()
 		while ($row = $this->db->sql_fetchrow($result))
 		{
 			$this->get_nestedset()->update_item($row['announcement_id'], [
-				'announcement_locations' => ($row['announcement_indexonly'] ? json_encode([-1]) : '')
+				'announcement_locations' => ($row['announcement_indexonly'] ? json_encode([ext::INDEX_ONLY]) : '')
 			]);
 		}
 

diff --git a/tests/functional/announcement_test.php b/tests/functional/announcement_test.php
@@ -10,6 +10,8 @@
 
 namespace phpbb\boardannouncements\tests\functional;
 
+use phpbb\boardannouncements\ext;
+
 /**
  * @group functional
  */
@@ -66,7 +68,7 @@ public function test_set_acp_settings()
 			'board_announcements_enabled'		=> true,
 			'board_announcements_users'			=> 0,
 			'board_announcements_dismiss'		=> true,
-			'board_announcements_locations'		=> [-1],
+			'board_announcements_locations'		=> [ext::INDEX_ONLY],
 			'board_announcements_bgcolor'		=> 'ff0000',
 			'board_announcements_description'	=> 'Test announcement',
 			'board_announcements_text'			=> 'This is a board announcement test.',
@@ -196,7 +198,7 @@ public function test_locations()
 
 		// show index only
 		$index_id = $this->create_announcement([
-			'board_announcements_locations'		=> [-1],
+			'board_announcements_locations'		=> [ext::INDEX_ONLY],
 			'board_announcements_description'	=> 'Board index announcement',
 			'board_announcements_text'			=> 'Board index announcement',
 		]);
@@ -210,7 +212,7 @@ public function test_locations()
 
 		// show in forum 2 and index
 		$index_forum_id = $this->create_announcement([
-			'board_announcements_locations'		=> [-1,2],
+			'board_announcements_locations'		=> [ext::INDEX_ONLY, 2],
 			'board_announcements_description'	=> 'Forum and Index announcement',
 			'board_announcements_text'			=> 'Forum and Index announcement',
 		]);