Better admin layout with name and description of rules

gouarfig · Jan 28, 2019 · d46fe30 · d46fe30
1 parent 4b4c2fe
commit d46fe30
Show file tree

Hide file tree

Showing 30 changed files with 149 additions and 18 deletions.
diff --git a/acp/board_notices_module.php b/acp/board_notices_module.php
@@ -11,6 +11,8 @@
 
 namespace fq\boardnotices\acp;
 
+use \fq\boardnotices\service\constants;
+
 class board_notices_module
 {
 
@@ -336,14 +338,17 @@ public function displayNoticeForm($action, $data, $error = '')
 		$all_rules = $this->getAllRules();
 		foreach ($all_rules as $rule_name => $rule_descriptions)
 		{
+			$rule_explain = '';
 			if (is_array($rule_descriptions))
 			{
-				$rule_description = $rule_descriptions['display_name'];
+				$rule_description = $rule_descriptions[constants::$RULE_DISPLAY_NAME];
+				$rule_explain = $rule_descriptions[constants::$RULE_DISPLAY_EXPLAIN];
 			}
 			else
 			{
 				$rule_description = $rule_descriptions;
 			}
+
 			$rule_type = $this->rules_manager->getRuleType($rule_name);
 			$rule_selected = isset($data['notice_rule_conditions'][$rule_name])
 						? $data['notice_rule_conditions'][$rule_name]
@@ -366,6 +371,7 @@ public function displayNoticeForm($action, $data, $error = '')
 				'NOTICE_RULE_CHECKED' => isset($data['notice_rule_checked'][$rule_name]) ? true : false,
 				'RULE_NAME' => $rule_name,
 				'RULE_DESCRIPTION' => $rule_description,
+				'RULE_EXPLAIN' => $rule_explain,
 				'RULE_UNIT' => (is_array($rule_descriptions)) ? $rule_descriptions['display_unit'] : '',
 				// 'RULE_CONDITIONS' => $this->getDisplayConditions(
 				// 		$rule_type,

diff --git a/adm/style/board_notices_edit.html b/adm/style/board_notices_edit.html
@@ -106,7 +106,7 @@ <h1>{{ lang('ACP_BOARD_NOTICE_RULES') }}</h1>
 		{# <tr data-id="{{ rule.RULE_NAME }}" class="{% if rule.NOTICE_RULE_CHECKED %}active-rule{% else %}inactive-rule{% endif %}">
 			<td class="boardnotice-checkbox">
 				<input type="hidden" name="notice_rule_id[{{ rule.RULE_NAME }}]" value="{{ rule.NOTICE_RULE_ID }}" />
-				<input type="checkbox" name="notice_rule_checked[{{ rule.RULE_NAME }}]" data-rule="checkbox" data-id="{{ rule.RULE_NAME }}" value="1"<!-- IF rule.NOTICE_RULE_CHECKED --> checked<!-- ENDIF -->/>
+				<input type="checkbox" name="notice_rule_checked[{{ rule.RULE_NAME }}]" data-rule="checkbox" data-id="{{ rule.RULE_NAME }}" value="1"{% if rule.NOTICE_RULE_CHECKED %} checked{% endif %}/>
 			</td>
 			<td class="boardnotice-description">
 				<strong>{{ rule.RULE_DESCRIPTION }}</strong>
@@ -117,10 +117,13 @@ <h1>{{ lang('ACP_BOARD_NOTICE_RULES') }}</h1>
 		<tr data-id="{{ rule.RULE_NAME }}" class="{% if rule.NOTICE_RULE_CHECKED %}active-rule{% else %}inactive-rule{% endif %}">
 			<td class="boardnotice-checkbox">
 				<input type="hidden" name="notice_rule_id[{{ rule.RULE_NAME }}]" value="{{ rule.NOTICE_RULE_ID }}" />
-				<input type="checkbox" name="notice_rule_checked[{{ rule.RULE_NAME }}]" data-rule="checkbox" data-id="{{ rule.RULE_NAME }}" value="1"<!-- IF rule.NOTICE_RULE_CHECKED --> checked<!-- ENDIF -->/>
+				<input type="checkbox" name="notice_rule_checked[{{ rule.RULE_NAME }}]" id="checkbox_{{ rule.RULE_NAME }}" data-rule="checkbox" data-id="{{ rule.RULE_NAME }}" value="1"{% if rule.NOTICE_RULE_CHECKED %} checked{% endif %}/>
 			</td>
 			<td class="boardnotice-description">
 				<strong>{{ rule.RULE_DESCRIPTION }}</strong>
+				{% if rule.RULE_EXPLAIN %}
+					<br />{{ rule.RULE_EXPLAIN }}
+				{% endif %}
 			</td>
 			<td class="boardnotice-conditions">
 				{% if rule.RULE_TYPE == 'yesno' %}

diff --git a/domain/rules.php b/domain/rules.php
@@ -231,23 +231,26 @@ private function getRulesClassesList($folder)
 	private function getRuleDisplayValues($rule_name)
 	{
 		$displayName = $this->rules[$rule_name]->getDisplayName();
+		$displayExplain = $this->rules[$rule_name]->getDisplayExplain();
 		$displayUnit = $this->rules[$rule_name]->getDisplayUnit();
 
-		if (empty($displayUnit))
+		if (empty($displayExplain) && empty($displayUnit))
 		{
 			return $displayName;
 		}
 		else
 		{
 			if (is_array($displayName))
 			{
+				$displayName[constants::$RULE_DISPLAY_EXPLAIN] = $displayExplain;
 				$displayName[constants::$RULE_DISPLAY_UNIT] = $displayUnit;
 				return $displayName;
 			}
 			else
 			{
 				return array(
 					constants::$RULE_DISPLAY_NAME => $displayName,
+					constants::$RULE_DISPLAY_EXPLAIN => $displayExplain,
 					constants::$RULE_DISPLAY_UNIT => $displayUnit
 				);
 			}

diff --git a/language/en/boardnotices_acp.php b/language/en/boardnotices_acp.php
@@ -105,14 +105,17 @@
 	'RULE_ANNIVERSARY'						=> "On user's registration anniversary",
 	'RULE_BIRTHDAY'							=> "On user's birthday",
 	'RULE_DATE'								=> "The date is",
-	'RULE_HAS_NEVER_POSTED'					=> "User has never posted (takes into account posts waiting for approval)",
-	'RULE_HAS_NEVER_POSTED_IN_FORUM'		=> "User has never posted in any of these forums (including posts waiting for approval)",
+	'RULE_HAS_NEVER_POSTED'					=> "User has never posted",
+	'RULE_HAS_NEVER_POSTED_EXPLAIN'			=> "(takes into account posts waiting for approval)",
+	'RULE_HAS_NEVER_POSTED_IN_FORUM'		=> "User has never posted in any of these forums",
+	'RULE_HAS_NEVER_POSTED_FORUM_EXPLAIN'	=> "(including posts waiting for approval)",
 	'RULE_HAS_NOT_POSTED_FOR_1'				=> "User has not posted for ",
 	'RULE_HAS_NOT_POSTED_FOR_2'				=> " day(s) or more (but has posted previously)",
 	'RULE_HAS_POSTED_EXACTLY'				=> "Number of visible posts equals",
 	'RULE_HAS_POSTED_LESS'					=> "Number of visible posts equals or less than",
 	'RULE_HAS_POSTED_MORE'					=> "Number of visible posts equals or more than",
-	'RULE_HAS_POSTED_IN_FORUM'				=> "User has posted in at least one of these forums (<strong>not</strong> including posts waiting for approval)",
+	'RULE_HAS_POSTED_IN_FORUM'				=> "User has posted in at least one of these forums",
+	'RULE_HAS_POSTED_IN_FORUM_EXPLAIN'		=> "(<strong>not</strong> including posts waiting for approval)",
 	'RULE_HAS_NOT_VISITED_FOR_1'			=> "User has not visited any of these selected forums ",
 	'RULE_HAS_NOT_VISITED_FOR_2'			=> " for at least ",
 	'RULE_IN_DEFAULT_USERGROUP'				=> "Default user group is",

diff --git a/language/et/boardnotices_acp.php b/language/et/boardnotices_acp.php
@@ -106,14 +106,17 @@
 	'RULE_ANNIVERSARY'						=> "Kasutajate registreerimise kuupäev",
 	'RULE_BIRTHDAY'							=> "Kasutajate sünnipäevad",
 	'RULE_DATE'								=> "Kuupäev on",
-	'RULE_HAS_NEVER_POSTED'					=> "Kasutaja ei ole kunagi postitanud (võtab arvesse ka heakskiitu ootavaid postitusi)",
-	'RULE_HAS_NEVER_POSTED_IN_FORUM'		=> "Kasutaja ei ole kunagi ühelegi nendest foorumitest postitanud (kaasa arvatud heakskiitu ootavad postitused)",
+	'RULE_HAS_NEVER_POSTED'					=> "Kasutaja ei ole kunagi postitanud",
+	'RULE_HAS_NEVER_POSTED_EXPLAIN'			=> "(võtab arvesse ka heakskiitu ootavaid postitusi)",
+	'RULE_HAS_NEVER_POSTED_IN_FORUM'		=> "Kasutaja ei ole kunagi ühelegi nendest foorumitest postitanud",
+	'RULE_HAS_NEVER_POSTED_FORUM_EXPLAIN'	=> "(kaasa arvatud heakskiitu ootavad postitused)",
 	'RULE_HAS_NOT_POSTED_FOR_1'				=> "Kasutaja ei ole postitanud ",
 	'RULE_HAS_NOT_POSTED_FOR_2'				=> " päev(ad) või rohkem (kuid on varem postitanud)",
 	'RULE_HAS_POSTED_EXACTLY'				=> "Nähtavate number postituses on võrdne",
 	'RULE_HAS_POSTED_LESS'					=> "Nähtavate numberi arv on võrdne või väiksem kui",
 	'RULE_HAS_POSTED_MORE'					=> "Nähtavate numberi arv on võrdne või suurem kui",
-	'RULE_HAS_POSTED_IN_FORUM'				=> "Kasutaja on postitanud vähemalt ühes nendest foorumitest, (<strong>ei arvestata sisse</strong> kinnitusi ootavad postitused)",
+	'RULE_HAS_POSTED_IN_FORUM'				=> "Kasutaja on postitanud vähemalt ühes nendest foorumitest,",
+	'RULE_HAS_POSTED_IN_FORUM_EXPLAIN'		=> "(<strong>ei arvestata sisse</strong> kinnitusi ootavad postitused)",
 	'RULE_HAS_NOT_VISITED_FOR_1'			=> "Kasutaja ei ole ühtegi nendest valitud foorumitest külastanud ",
 	'RULE_HAS_NOT_VISITED_FOR_2'			=> " vähemalt ",
 	'RULE_IN_DEFAULT_USERGROUP'				=> "Vaikimisi kasutajagrupp on",

diff --git a/rules/anniversary.php b/rules/anniversary.php
@@ -62,6 +62,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_ANNIVERSARY');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/birthday.php b/rules/birthday.php
@@ -65,6 +65,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_BIRTHDAY');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/date.php b/rules/date.php
@@ -30,6 +30,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_DATE');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/has_never_posted.php b/rules/has_never_posted.php
@@ -33,6 +33,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_HAS_NEVER_POSTED');
 	}
 
+	public function getDisplayExplain()
+	{
+		return $this->user->lang('RULE_HAS_NEVER_POSTED_EXPLAIN');
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/has_never_posted_in_forum.php b/rules/has_never_posted_in_forum.php
@@ -33,6 +33,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_HAS_NEVER_POSTED_IN_FORUM');
 	}
 
+	public function getDisplayExplain()
+	{
+		return $this->user->lang('RULE_HAS_NEVER_POSTED_FORUM_EXPLAIN');
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/has_not_posted_for.php b/rules/has_not_posted_for.php
@@ -30,6 +30,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_HAS_NOT_POSTED_FOR_1');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return $this->user->lang('RULE_HAS_NOT_POSTED_FOR_2');
@@ -69,10 +74,10 @@ public function isTrue($conditions)
 	public function getAvailableVars()
 	{
 		return array(
-			'DAYS_NO_POSTS',
-			'WEEKS_NO_POSTS',
-			'MONTHS_NO_POSTS',
-			'YEARS_NO_POSTS',
+			'DAYS_NO_POST',
+			'WEEKS_NO_POST',
+			'MONTHS_NO_POST',
+			'YEARS_NO_POST',
 		);
 	}
 
@@ -94,10 +99,10 @@ public function getTemplateVars()
 		}
 
 		return array(
-			'DAYS_NO_POSTS' => $daysNoPosts,
-			'WEEKS_NO_POSTS' => $weeksNoPosts,
-			'MONTHS_NO_POSTS' => $monthsNoPosts,
-			'YEARS_NO_POSTS' => $yearsNoPosts,
+			'DAYS_NO_POST' => $daysNoPosts,
+			'WEEKS_NO_POST' => $weeksNoPosts,
+			'MONTHS_NO_POST' => $monthsNoPosts,
+			'YEARS_NO_POST' => $yearsNoPosts,
 		);
 	}
 

diff --git a/rules/has_not_visited_for.php b/rules/has_not_visited_for.php
@@ -36,6 +36,11 @@ public function getDisplayName()
 		);
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return $this->user->lang('RULE_DAY(S)');

diff --git a/rules/has_posted_exactly.php b/rules/has_posted_exactly.php
@@ -30,6 +30,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_HAS_POSTED_EXACTLY');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/has_posted_in_forum.php b/rules/has_posted_in_forum.php
@@ -33,6 +33,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_HAS_POSTED_IN_FORUM');
 	}
 
+	public function getDisplayExplain()
+	{
+		return $this->user->lang('RULE_HAS_POSTED_IN_FORUM_EXPLAIN');
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/has_posted_less.php b/rules/has_posted_less.php
@@ -30,6 +30,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_HAS_POSTED_LESS');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/has_posted_more.php b/rules/has_posted_more.php
@@ -30,6 +30,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_HAS_POSTED_MORE');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/in_default_usergroup.php b/rules/in_default_usergroup.php
@@ -33,6 +33,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_IN_DEFAULT_USERGROUP');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/in_forum.php b/rules/in_forum.php
@@ -33,6 +33,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_IN_FORUM');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/in_usergroup.php b/rules/in_usergroup.php
@@ -33,6 +33,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_IN_USERGROUP');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/language.php b/rules/language.php
@@ -33,6 +33,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_LANGUAGE');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/logged_in.php b/rules/logged_in.php
@@ -30,6 +30,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_LOGGED_IN');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return $this->user->lang('NO_GUEST_OR_BOT');

diff --git a/rules/not_in_usergroup.php b/rules/not_in_usergroup.php
@@ -33,6 +33,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_NOT_IN_USERGROUP');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/on_board_index.php b/rules/on_board_index.php
@@ -33,6 +33,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_ON_BOARD_INDEX');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/rank.php b/rules/rank.php
@@ -70,6 +70,11 @@ public function getDisplayName()
 		return $this->user->lang('RULE_RANK');
 	}
 
+	public function getDisplayExplain()
+	{
+		return '';
+	}
+
 	public function getDisplayUnit()
 	{
 		return '';

diff --git a/rules/rule_interface.php b/rules/rule_interface.php
@@ -13,6 +13,7 @@
 
 interface rule_interface {
 	public function getDisplayName();
+	public function getDisplayExplain();
 	public function getDisplayUnit();
 	public function getType();
 	public function getDefault();