v0.14.0

- Changed move generate_datetime_str() to helper controller
- Improved, Data types added to variables in php code
- Changed php min version to 7.4

Author: IMC-GER

imcger/currenttime/acp/acp_info.php

@@ -12,7 +12,7 @@
 
 class acp_info {
 
-	public function module()
+	public function module(): array
 	{
 		return [
 			'filename'	=> '\imcger\currenttime\acp\acp_module',
@@ -21,12 +21,12 @@ public function module()
 				'settings' => [
 					'title'	=> 'ACP_CT_SETTINGS',
 					'auth'	=> 'ext_imcger/currenttime && acl_a_board',
-					'cat'	=> ['ACP_CT_MODULE_WORLDCLOCK',],
+					'cat'	=> ['ACP_CT_MODULE_WORLDCLOCK', ],
 				],
 				'worldclock_settings' => [
 					'title'	=> 'ACP_CTWC_WORLDCL_SETTINGS',
 					'auth'	=> 'ext_imcger/currenttime && acl_a_board',
-					'cat'	=> ['ACP_CT_MODULE_WORLDCLOCK',],
+					'cat'	=> ['ACP_CT_MODULE_WORLDCLOCK', ],
 				],
 			],
 		];

imcger/currenttime/acp/acp_module.php

@@ -22,7 +22,7 @@ class acp_module
 	public $page_title;
 
 	/** UCP module */
-	public function main($id, $mode)
+	public function main(string $id, string $mode): void
 	{
 		global $phpbb_container;
 

imcger/currenttime/composer.json

@@ -2,9 +2,9 @@
 	"name": "imcger/currenttime",
 	"type": "phpbb-extension",
 	"description": "Refreshes the display of the current time on the index page. Show users local time and world clock.",
-	"homepage": "",
-	"version": "0.13.0",
-	"time": "2025-05-06",
+	"homepage": "https://github.com/IMC-GER/phpBB-Current-Time",
+	"version": "0.14.0",
+	"time": "2025-06-05",
 	"license": "GPL-2.0-only",
 	"authors": [
         {
@@ -14,7 +14,7 @@
 		}
 	],
 	"require": {
-		"php": ">=7.1.3"
+		"php": ">=7.4"
 	},
 	"extra": {
 		"display-name": "Current Time / World Clock",

imcger/currenttime/config/services.yml

@@ -41,7 +41,7 @@ services:
             - '@config'
             - '@template'
             - '@language'
-            - '%imcger.currenttime.table.ctwc_data%'
+            - '@imcger.currenttime.ctwc_helper'
         tags:
             - { name: event.listener }
 
@@ -59,6 +59,7 @@ services:
     imcger.currenttime.ucp.listener:
         class: 'imcger\currenttime\event\ucp_listener'
         arguments:
+            - '@auth'
             - '@config'
             - '@template'
             - '@user'

imcger/currenttime/controller/ctwc_controller.php

@@ -12,41 +12,18 @@
 
 class ctwc_controller
 {
-	/** @var \phpbb\db\driver\driver_interface */
-	protected $db;
-
-	/** @var \phpbb\request\request */
-	protected $request;
-
-	/** @var \phpbb\user */
-	protected $user;
-
-	/** @var \phpbb\template\template */
-	protected $template;
-
-	/** @var \phpbb\language\language */
-	protected $language;
-
-	/** @var \imcger\currenttime\controller\ctwc_helper */
-	protected $ctwc_helper;
-
-	/** @var \phpbb\extension\manager */
-	protected $ext_manager;
-
-	/** @var string Table name */
-	protected $ctwc_data_table;
-
-	/** @var string phpBB root path	*/
-	protected $phpbb_root_path;
-
-	/** @var string PHP extension */
-	protected $phpEx;
-
-	/** @var string Custom form action */
-	protected $u_action;
-
-	/** @var string source modul */
-	protected $modul;
+	protected object $db;
+	protected object $request;
+	protected object $user;
+	protected object $template;
+	protected object $language;
+	protected object $ctwc_helper;
+	protected object $ext_manager;
+	protected string $ctwc_data_table;
+	protected string $phpbb_root_path;
+	protected string $phpEx;
+	protected string $u_action;
+	protected string $modul;
 
 	/**
 	 * Constructor
@@ -81,7 +58,7 @@ public function __construct
 	/**
 	 * Display the options a user can configure for this extension
 	 */
-	public function display_options($modul)
+	public function display_options(string $modul): void
 	{
 		$this->modul = $modul;
 
@@ -169,7 +146,7 @@ public function display_options($modul)
 	/**
 	 * Set template variables
 	 */
-	protected function set_template_vars(?array $user_setting = null)
+	protected function set_template_vars(?array $user_setting = null): void
 	{
 		if (!isset($user_setting) && $this->modul == 'acp')
 		{
@@ -221,7 +198,7 @@ protected function set_template_vars(?array $user_setting = null)
 	/**
 	 * The selected action (ACP & UCP section).
 	 */
-	public function set_page_url($action)
+	public function set_page_url(string $action): void
 	{
 		$this->u_action = $action;
 	}

imcger/currenttime/controller/ctwc_general_settings.php

@@ -12,26 +12,13 @@
 
 class ctwc_general_settings
 {
-	/** @var \phpbb\config\config */
-	protected $config;
-
-	/** @var \phpbb\request\request */
-	protected $request;
-
-	/** @var \phpbb\user */
-	protected $user;
-
-	/** @var \phpbb\template\template */
-	protected $template;
-
-	/** @var \phpbb\language\language */
-	protected $language;
-
-	/** @var \phpbb\extension\manager */
-	protected $ext_manager;
-
-	/** @var string Custom form action */
-	protected $u_action;
+	protected object $config;
+	protected object $request;
+	protected object $user;
+	protected object $template;
+	protected object $language;
+	protected object $ext_manager;
+	protected string $u_action;
 
 	/**
 	 * Constructor
@@ -57,7 +44,7 @@ public function __construct
 	/**
 	 * Display the options a user can configure for this extension
 	 */
-	public function general_settings()
+	public function general_settings(): void
 	{
 		$this->language->add_lang(['ucp', ]);
 
@@ -85,7 +72,7 @@ public function general_settings()
 	/**
 	 * Set template variables
 	 */
-	protected function set_template_vars()
+	protected function set_template_vars(): void
 	{
 		$metadata_manager = $this->ext_manager->create_extension_metadata_manager('imcger/currenttime');
 
@@ -103,7 +90,7 @@ protected function set_template_vars()
 	/**
 	 * The selected action (ACP & UCP section).
 	 */
-	public function set_page_url($action)
+	public function set_page_url(string $action): void
 	{
 		$this->u_action = $action;
 	}

imcger/currenttime/controller/ctwc_helper.php

@@ -12,14 +12,9 @@
 
 class ctwc_helper
 {
-	/** @var \phpbb\user */
-	protected $user;
-
-	/** @var \phpbb\template\template */
-	protected $template;
-
-	/** @var \phpbb\language\language */
-	protected $language;
+	protected object $user;
+	protected object $template;
+	protected object $language;
 
 	/**
 	 * Constructor
@@ -39,7 +34,7 @@ public function __construct
 	/**
 	 * Options to pick a timezone and date/time
 	 */
-	public function timezone_select($prefix = '', $default = '')
+	public function timezone_select(string $prefix = '', string $default = ''): void
 	{
 		$default_offset = '';
 
@@ -110,6 +105,9 @@ public function timezone_select($prefix = '', $default = '')
 
 	/*
 	 * Creates an array of variables for the SelectBox macro
+	 *
+	 * The variable $cfg_value is a union type array|string
+	 * Not specified for reasons of compatibility with php 7
 	 */
 	public function select_struct($cfg_value, array $options): array
 	{
@@ -135,7 +133,7 @@ public function select_struct($cfg_value, array $options): array
 	/*
 	 * Creates an array of dateformat options for the SelectBox macro
 	 */
-	public function set_select_template_vars($date_format, $template_var)
+	public function set_select_template_vars(string $date_format, string $template_var): void
 	{
 		$this->language->add_lang(['info_acp_ctwc', ], 'imcger/currenttime');
 
@@ -154,4 +152,59 @@ public function set_select_template_vars($date_format, $template_var)
 			$template_var => $this->select_struct($date_format, $dateformat_options),
 		]);
 	}
+
+	/*
+	 * Changes the placeholder in the date/time string for the JavaScript clock class
+	 */
+	public function generate_datetime_str(string $replacement, string $format): string
+	{
+		$pattern = [
+			'/(?<!\\\\)g/',   // hour in 12-hour format; without leading zero				 1 to 12
+			'/(?<!\\\\)G/',   // hour in 24-hour format; without leading zero				 0 to 23
+			'/(?<!\\\\)h/',   // hour in 12-hour format; with leading zero					01 to 12
+			'/(?<!\\\\)H/',   // hour in 24-hour format; with leading zero					00 to 23
+			'/(?<!\\\\)i/',   // minutes; with leading zero									00 to 59
+			'/(?<!\\\\)s/',   // seconds; with leading zero									00 to 59
+			'/(?<!\\\\)a/',   // Lowercase Ante meridiem and Post meridiem					am or pm
+			'/(?<!\\\\)A/',   // Uppercase Ante meridiem and Post meridiem					AM or PM
+			'/(?<!\\\\)y/',   // A two digit representation of a year
+			'/(?<!\\\\)Y/',   // A full numeric representation of a year
+			'/(?<!\\\\)n/',   // Numeric representation of a month, without leading zeros	 1 through 12
+			'/(?<!\\\\)m/',   // Numeric representation of a month, with leading zeros		01 through 12
+			'/(?<!\\\\)M/',   // A short textual representation of a month, three letters	Jan through Dec
+			'/(?<!\\\\)jS/',  // Day of the month with suffix and without leading zeros 	1st to 31st
+			'/(?<!\\\\)j/',   // Day of the month without leading zeros 					1 to 31
+			'/(?<!\\\\)d/',   // Day of the month, 2 digits with leading zeros 				01 to 31
+			'/(?<!\\\\)D/',   // A textual representation of a day, three letters			Mon through Sun
+			'/(?<!\\\\)z1/',  // The day of the year (starting from 1) 						1 through 366
+			'/(?<!\\\\)z/',   // The day of the year (starting from 0) 						0 through 365
+			'/(?<!\\\\)W0S/', // Week number of year, weeks starting on Sunday				1st to 53rd
+			'/(?<!\\\\)W7S/', // Weeks starting on Sunday, weeks count from 1st Januar		1st to 54rd
+							  // with suffix
+			'/(?<!\\\\)WS/',  // ISO 8601 week number of year, weeks starting on Monday		1st to 53rd
+			'/(?<!\\\\)W0/',  // Week number of year, weeks starting on Sunday				1 to 53
+			'/(?<!\\\\)W7/',  // Weeks starting on Sunday, weeks count from 1st Januar		1 to 54
+			'/(?<!\\\\)W/',   // ISO 8601 week number of year, weeks starting on Monday		1 to 53
+			'/(?<!\\\\)l/',   // A full textual representation of the day of the week 		Sunday through Saturday
+			'/(?<!\\\\)F/',   // A full textual representation of a month					January through December
+			'/(?<!\\\\)O/',   // Difference to Greenwich time (GMT) without colon 			Example: +0200
+			'/(?<!\\\\)P/',   // Difference to Greenwich time (GMT) with colon 				Example: +02:00
+		];
+
+		$ct_replacement = [
+			'{\g}', '{\G}', '{\h}', '{\H}', '{\i}', '{\s}', '{\a}', '{\A}', '{\y}', '{\Y}', '{\n}',
+			'{\m}', '{\M}', '{\j\S}', '{\j}', '{\d}', '{\D}', '{\z1}', '{\z}', '{\W0\S}', '{\W7\S}', '{\W\S}',
+			'{\W0}', '{\W7}', '{\W}', '{\l}', '{\F}', '{\O}', '{\P}',
+		];
+
+		$wc_replacement = [
+			'{g}', '{G}', '{h}', '{H}', '{i}', '{s}', '{a}', '{A}', '{y}', '{Y}', '{n}',
+			'{m}', '{M}', '{jS}', '{j}', '{d}', '{D}', '{z1}', '{z}', '{W0S}', '{W7S}', '{WS}',
+			'{W0}', '{W7}', '{W}', '{l}', '{F}', '{O}', '{P}',
+		];
+
+		$replacement = $replacement == 'ct' ? $ct_replacement : $wc_replacement;
+
+		return preg_replace($pattern, $replacement, $format);
+	}
 }

imcger/currenttime/event/acp_listener.php

@@ -17,21 +17,11 @@
  */
 class acp_listener implements EventSubscriberInterface
 {
-	/** @var \phpbb\user */
-	protected $user;
-
-	/** @var config */
-	protected $config;
-
-	/** @var \phpbb\template\template */
-	protected $template;
-
-	/** @var \phpbb\request\request */
-	protected $request;
-
-	/** @var \imcger\currenttime\controller\ctwc_helper */
-	protected $ctwc_helper;
-
+	protected object $user;
+	protected object $config;
+	protected object $template;
+	protected object $request;
+	protected object $ctwc_helper;
 
 	/**
 	 * Constructor
@@ -55,7 +45,7 @@ public function __construct
 	/**
 	 * Get subscribed events
 	 */
-	public static function getSubscribedEvents()
+	public static function getSubscribedEvents(): array
 	{
 		return [
 			'core.acp_users_prefs_modify_data'			=> 'acp_users_prefs_modify_data',
@@ -67,7 +57,7 @@ public static function getSubscribedEvents()
 	/**
 	 * Modify users preferences data
 	 */
-	public function acp_users_prefs_modify_data($event)
+	public function acp_users_prefs_modify_data(object $event): void
 	{
 		$user_setting = json_decode($event['user_row']['user_imcger_ct_data'], true);
 		$currtime_format = !!$event['user_row']['user_ctwc_currtime_format'] ? $event['user_row']['user_ctwc_currtime_format'] : $this->user->date_format;
@@ -92,7 +82,7 @@ public function acp_users_prefs_modify_data($event)
 	/**
 	 * Modify SQL query before users preferences are updated
 	 */
-	public function acp_users_prefs_modify_sql($event)
+	public function acp_users_prefs_modify_sql(object $event): void
 	{
 		$user_setting = [];
 
@@ -119,7 +109,7 @@ public function acp_users_prefs_modify_sql($event)
 	/**
 	 * Modify users preferences data before assigning it to the template
 	 */
-	public function acp_users_prefs_modify_template_data($event)
+	public function acp_users_prefs_modify_template_data(object $event): void
 	{
 		$user_auth	= new \phpbb\auth\auth();
 		$userdata	= $user_auth->obtain_user_data($event['user_row']['user_id']);