Merge pull request #315 from VSEphpbb/lang-iso

Convert language from using ID nums to ISO names

Author: iMattPro

acp/boardrules_module.php

@@ -26,15 +26,15 @@ public function main($id, $mode)
 		/** @var \phpbb\request\request $request */
 		$request = $phpbb_container->get('request');
 
+		/** @var \phpbb\boardrules\controller\admin_controller $admin_controller */
+		$admin_controller = $phpbb_container->get('phpbb.boardrules.admin.controller');
+
 		// Add the board rules ACP lang file
 		$lang->add_lang('boardrules_acp', 'phpbb/boardrules');
 
-		// Get an instance of the admin controller
-		$admin_controller = $phpbb_container->get('phpbb.boardrules.admin.controller');
-
 		// Requests
 		$action = $request->variable('action', '');
-		$language = $request->variable('language', 0);
+		$language = $request->variable('language', '');
 		$parent_id = $request->variable('parent_id', 0);
 		$rule_id = $request->variable('rule_id', 0);
 

adm/style/boardrules_manage.html

@@ -111,7 +111,7 @@ <h1>{L_ACP_BOARDRULES_MANAGE}</h1>
 					<dd>
 						<select name="language" id="language">
 							<!-- BEGIN options -->
-								<option value="{options.LANG_ID}"<!-- IF options.S_LANG_DEFAULT --> selected="selected"<!-- ENDIF -->>{options.LANG_LOCAL_NAME}</option>
+								<option value="{options.LANG_ISO}"<!-- IF options.S_LANG_DEFAULT --> selected="selected"<!-- ENDIF -->>{options.LANG_LOCAL_NAME}</option>
 							<!-- END options -->
 						</select>
 						<input type="submit" value="{L_GO}" class="button2">

composer.json

@@ -3,7 +3,7 @@
 	"type": "phpbb-extension",
 	"description": "An extension which allows you to create a set of rules for your phpBB forum",
 	"homepage": "https://www.phpbb.com",
-	"version": "2.0.1-dev",
+	"version": "2.1.0-dev",
 	"keywords": ["phpbb", "extension", "rules"],
 	"license": "GPL-2.0",
 	"authors": [

controller/admin_controller.php

@@ -181,7 +181,7 @@ protected function set_options()
 	public function display_language_selection()
 	{
 		// Check if there are any available languages
-		$sql = 'SELECT lang_id, lang_iso, lang_local_name
+		$sql = 'SELECT lang_iso, lang_local_name
 			FROM ' . LANG_TABLE . '
 			ORDER BY lang_english_name';
 		$result = $this->db->sql_query($sql);
@@ -196,7 +196,7 @@ public function display_language_selection()
 				$this->template->assign_block_vars('options', array(
 					'S_LANG_DEFAULT'	=> $row['lang_iso'] == $this->config['default_lang'],
 
-					'LANG_ID'			=> $row['lang_id'],
+					'LANG_ISO'			=> $row['lang_iso'],
 					'LANG_LOCAL_NAME'	=> $row['lang_local_name'],
 				));
 			}
@@ -208,20 +208,20 @@ public function display_language_selection()
 		{
 			// If there is only one available language its index is 0
 			// and that language is the default board language.
-			// We do not need any loops here to get its id.
-			$this->display_rules($rows[0]['lang_id']);
+			// We do not need any loops here to get its iso code.
+			$this->display_rules($rows[0]['lang_iso']);
 		}
 	}
 
 	/**
 	* Display the rules
 	*
-	* @param int $language Language selection identifier; default: 0
+	* @param string $language Language selection iso
 	* @param int $parent_id Category to display rules from; default: 0
 	* @return void
 	* @access public
 	*/
-	public function display_rules($language = 0, $parent_id = 0)
+	public function display_rules($language, $parent_id = 0)
 	{
 		// Grab all the rules in the current user's language
 		$entities = $this->rule_operator->get_rules($language, $parent_id);
@@ -282,12 +282,12 @@ public function display_rules($language = 0, $parent_id = 0)
 	/**
 	* Add a rule
 	*
-	* @param int $language Language selection identifier; default: 0
+	* @param string $language Language selection iso
 	* @param int $parent_id Category to display rules from; default: 0
 	* @return void
 	* @access public
 	*/
-	public function add_rule($language = 0, $parent_id = 0)
+	public function add_rule($language, $parent_id = 0)
 	{
 		// Add form key
 		add_form_key('add_edit_rule');

controller/admin_interface.php

@@ -39,22 +39,22 @@ public function display_language_selection();
 	/**
 	* Display the rules
 	*
-	* @param int $language Language selection identifier; default: 0
+	* @param string $language Language selection iso
 	* @param int $parent_id Category to display rules from; default: 0
 	* @return void
 	* @access public
 	*/
-	public function display_rules($language = 0, $parent_id = 0);
+	public function display_rules($language, $parent_id = 0);
 
 	/**
 	* Add a rule
 	*
-	* @param int $language Language selection identifier; default: 0
+	* @param string $language Language selection iso
 	* @param int $parent_id Category to display rules from; default: 0
 	* @return void
 	* @access public
 	*/
-	public function add_rule($language = 0, $parent_id = 0);
+	public function add_rule($language, $parent_id = 0);
 
 	/**
 	* Edit a rule

controller/main_controller.php

@@ -87,7 +87,7 @@ public function display()
 		$rule_counter = 'a'; // Alpha counter used for rules
 
 		// Grab all the rules in the current user's language
-		$entities = $this->rule_operator->get_rules($this->user->get_iso_lang_id());
+		$entities = $this->rule_operator->get_rules($this->lang->get_used_language());
 
 		/* @var $entity \phpbb\boardrules\entity\rule */
 		foreach ($entities as $entity)

entity/rule.php

@@ -105,7 +105,7 @@ public function import($data)
 		$fields = array(
 			// column							=> data type (see settype())
 			'rule_id'							=> 'integer',
-			'rule_language'						=> 'integer',
+			'rule_language'						=> 'string',
 			'rule_left_id'						=> 'integer',
 			'rule_right_id'						=> 'integer',
 			'rule_parent_id'					=> 'integer',
@@ -149,9 +149,9 @@ public function import($data)
 		// Some fields must be unsigned (>= 0)
 		$validate_unsigned = array(
 			'rule_id',
-			'rule_language',
 			'rule_left_id',
 			'rule_right_id',
+			'rule_parent_id',
 			'rule_message_bbcode_options',
 		);
 
@@ -172,12 +172,12 @@ public function import($data)
 	*
 	* Will throw an exception if the rule was already inserted (call save() instead)
 	*
-	* @param int $language The language identifier
+	* @param string $language The language iso
 	* @return rule_interface $this object for chaining calls; load()->set()->save()
 	* @access public
 	* @throws \phpbb\boardrules\exception\out_of_bounds
 	*/
-	public function insert($language = 0)
+	public function insert($language)
 	{
 		if (!empty($this->data['rule_id']))
 		{
@@ -501,7 +501,7 @@ public function set_anchor($anchor)
 				FROM ' . $this->boardrules_table . "
 				WHERE rule_anchor = '" . $this->db->sql_escape($anchor) . "'
 					AND rule_id <> " . $this->get_id() .
-					($this->get_language() ? ' AND rule_language = ' . $this->get_language() : '');
+					($this->get_language() ? " AND rule_language = '" . $this->get_language() . "'" : '');
 			$result = $this->db->sql_query_limit($sql, 1);
 			$row = $this->db->sql_fetchrow($result);
 			$this->db->sql_freeresult($result);
@@ -519,28 +519,45 @@ public function set_anchor($anchor)
 	}
 
 	/**
-	* Get the language identifier
+	* Get the language iso
 	*
-	* @return int language identifier
+	* @return string language iso
 	* @access public
 	*/
 	public function get_language()
 	{
-		return isset($this->data['rule_language']) ? (int) $this->data['rule_language'] : 0;
+		return isset($this->data['rule_language']) ? $this->data['rule_language'] : '';
 	}
 
 	/**
-	 * Set the language identifier
+	 * Set the language iso
 	 *
-	 * @param int $language language identifier
+	 * @param string $language language iso
 	 * @return rule_interface $this object for chaining calls; load()->set()->save()
 	 * @access public
+	 * @throws \phpbb\boardrules\exception\unexpected_value
 	 */
 	public function set_language($language)
 	{
 		if (!isset($this->data['rule_language']))
 		{
-			$this->data['rule_language'] = (int) $language;
+			// Validate the requested language ISO is installed
+			if ($language !== '')
+			{
+				$sql = 'SELECT lang_id
+					FROM ' . LANG_TABLE . "
+					WHERE lang_iso = '" . $this->db->sql_escape($language) . "'";
+				$result = $this->db->sql_query($sql);
+				$lang_id = $this->db->sql_fetchfield('lang_id');
+				$this->db->sql_freeresult($result);
+
+				if (!$lang_id)
+				{
+					throw new \phpbb\boardrules\exception\unexpected_value(array('rule_language', 'WRONG_DATA_LANG', 'UNEXPECTED_VALUE'));
+				}
+			}
+
+			$this->data['rule_language'] = $language;
 		}
 
 		return $this;

entity/rule_interface.php

@@ -46,12 +46,12 @@ public function import($data);
 	*
 	* Will throw an exception if the rule was already inserted (call save() instead)
 	*
-	* @param int $language The language identifier
+	* @param string $language The language iso
 	* @return rule_interface $this object for chaining calls; load()->set()->save()
 	* @access public
 	* @throws \phpbb\boardrules\exception\out_of_bounds
 	*/
-	public function insert($language = 0);
+	public function insert($language);
 
 	/**
 	* Save the current settings to the database
@@ -208,17 +208,17 @@ public function get_anchor();
 	public function set_anchor($anchor);
 
 	/**
-	* Get the language identifier
+	* Get the language iso
 	*
-	* @return int language identifier
+	* @return string language iso
 	* @access public
 	*/
 	public function get_language();
 
 	/**
-	 * Set the language identifier
+	 * Set the language iso
 	 *
-	 * @param int $language language identifier
+	 * @param string $language language iso
 	 * @return rule_interface $this object for chaining calls; load()->set()->save()
 	 * @access public
 	 */

language/ar/exceptions.php

@@ -56,4 +56,7 @@
 	'EXCEPTION_NOT_UNIQUE'			=> 'البيانات المُدخلة موجودة مُسبقاً.',
 	'EXCEPTION_UNEXPECTED_VALUE'	=> 'هناك خطأ في البيانات المُدخلة في الحقل `%1$s`. السبب : %2$s',
 	'EXCEPTION_ILLEGAL_CHARACTERS'	=> 'البيانات التي أدخلتها تحتوي على حروف غير مقبولة.',
+
+	// Translators: do not change this
+	'EXCEPTION_WRONG_DATA_LANG'		=> $lang['WRONG_DATA_LANG'],
 ));

language/bg/exceptions.php

@@ -55,4 +55,7 @@
 	'EXCEPTION_NOT_UNIQUE'			=> 'Въведеното не съответства.',
 	'EXCEPTION_UNEXPECTED_VALUE'	=> 'Полето `%1$s` получава неочаквани данни. Причина: %2$s',
 	'EXCEPTION_ILLEGAL_CHARACTERS'	=> 'Въведенот съдържа непозволени знаци.',
+
+	// Translators: do not change this
+	'EXCEPTION_WRONG_DATA_LANG'		=> $lang['WRONG_DATA_LANG'],
 ));