[ticket/17414] Replace confirm types with enum

PHPBB-17414

Author: marc1706

auth/provider/db.php

@@ -176,7 +176,7 @@ public function login($username, $password)
 		// Every auth module is able to define what to do by itself...
 		if ($show_captcha)
 		{
-			$captcha->init(\phpbb\captcha\plugins\plugin_interface::CONFIRM_LOGIN);
+			$captcha->init(\phpbb\captcha\plugins\confirm_type::LOGIN);
 			if ($captcha->validate() !== true)
 			{
 				return array(

captcha/plugins/confirm_type.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\captcha\plugins;
+
+/**
+ * Confirmation types for CAPTCHA plugins
+ */
+enum confirm_type: int {
+	case REGISTRATION = 1;
+	case LOGIN = 2;
+	case POST = 3;
+	case REPORT = 4;
+}

captcha/plugins/plugin_interface.php

@@ -15,14 +15,6 @@
 
 interface plugin_interface
 {
-	const CONFIRM_REGISTRATION = 1;
-	const CONFIRM_LOGIN = 2;
-
-	const CONFIRM_POST = 3;
-
-	const CONFIRM_REPORT = 4;
-
-
 	/**
 	 * Check if the plugin is available
 	 *
@@ -54,10 +46,10 @@ public function set_name(string $name): void;
 	/**
 	 * Display the captcha for the specified type
 	 *
-	 * @param int $type Type of captcha, should be one of the CONFIRMATION_* constants
+	 * @param confirm_type $type Type of captcha, should be one of the CONFIRMATION_* constants
 	 * @return void
 	 */
-	public function init(int $type): void;
+	public function init(confirm_type $type): void;
 
 	/**
 	 * Get hidden form fields for this captcha plugin

captcha/plugins/turnstile.php

@@ -121,7 +121,7 @@ public function set_name(string $name): void
 	/**
 	 * {@inheritDoc}
 	 */
-	public function init(int $type): void
+	public function init(confirm_type $type): void
 	{
 		$this->language->add_lang('captcha_turnstile');
 	}

report/controller/report.php

@@ -13,6 +13,7 @@
 
 namespace phpbb\report\controller;
 
+use phpbb\captcha\plugins\confirm_type;
 use phpbb\captcha\plugins\plugin_interface;
 use phpbb\exception\http_exception;
 use phpbb\report\report_handler_interface;
@@ -132,7 +133,7 @@ public function handle($id, $mode)
 		if ($this->config['enable_post_confirm'] && !$this->user->data['is_registered'])
 		{
 			$captcha = $this->captcha_factory->get_instance($this->config['captcha_plugin']);
-			$captcha->init(plugin_interface::CONFIRM_REPORT);
+			$captcha->init(confirm_type::REPORT);
 		}
 
 		//Has the report been cancelled?