From f267175c95da7e036e4b17dabee70b6bd80ac580 Mon Sep 17 00:00:00 2001
From: aB0t <robot@vdm.io>
Date: Thu, 10 Aug 2023 17:50:04 +0200
Subject: [PATCH] Release of v1.0.2

---
 README.md                                     |   4 +-
 .../en-GB/en-GB.mod_version_calendar_svg.ini  |  16 ++-
 .../en-GB.mod_version_calendar_svg.sys.ini    |  16 ++-
 mod_version_calendar_svg.xml                  |  32 ++++-
 tmpl/default.php                              | 122 +++++++++++++++---
 5 files changed, 169 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 80fe66b..545e3db 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Version Calendar in SVG (1.0.1)
+# Version Calendar in SVG (1.0.2)
 
 > The original source code was taken from the [PHP supported versions](https://github.com/php/web-php/blob/master/images/supported-versions.php).
 
@@ -8,6 +8,6 @@
 + *Author*: [Joomla! Project](mailto:admin@joomla.org)
 + *Name*: [Version Calendar svg](http://www.joomla.org)
 + *First Build*: 3rd September, 2022
-+ *Version*: 1.0.1
++ *Version*: 1.0.2
 + *Copyright*: (C) 2022 Open Source Matters, Inc.
 + *License*: GNU General Public License version 2 or later; see LICENSE.txt
\ No newline at end of file
diff --git a/language/en-GB/en-GB.mod_version_calendar_svg.ini b/language/en-GB/en-GB.mod_version_calendar_svg.ini
index 88698e1..636cee7 100644
--- a/language/en-GB/en-GB.mod_version_calendar_svg.ini
+++ b/language/en-GB/en-GB.mod_version_calendar_svg.ini
@@ -1,6 +1,14 @@
 MOD_VERSION_CALENDAR_SVG="Version Calendar Svg"
 MOD_VERSION_CALENDAR_SVG_DESCRIPTION="Version Calendar in SVG"
-MOD_VERSION_CALENDAR_SVG_XML_DESCRIPTION="<h1>Version Calendar Svg (v.1.0.1)</h1> <div style='clear: both;'></div><p>Version Calendar in SVG</p><p>Created by <a href='http://www.joomla.org' target='_blank'>Joomla! Project</a><br /><small>Development started 3rd September, 2022</small></p>"
+MOD_VERSION_CALENDAR_SVG_XML_DESCRIPTION="<h1>Version Calendar Svg (v.1.0.2)</h1> <div style='clear: both;'></div><p>Version Calendar in SVG</p><p>Created by <a href='http://www.joomla.org' target='_blank'>Joomla! Project</a><br /><small>Development started 3rd September, 2022</small></p>"
+MOD_VERSION_CALENDAR_SVG_PLANNED_RELEASE_SCHEDULE="Planned release schedule"
+MOD_VERSION_CALENDAR_SVG_FUTURE_RELEASES="Future Releases"
+MOD_VERSION_CALENDAR_SVG_STABLE_RELEASE_SCHEDULE_EXPECT_FULL_SUPPORT_AND_UPDATES="Stable release schedule - expect full support and updates"
+MOD_VERSION_CALENDAR_SVG_STABLE_RELEASE="Stable Release"
+MOD_VERSION_CALENDAR_SVG_SECURITY_SCHEDULE_EXPECT_ONLY_SECURITY_UPDATES="Security schedule - expect only security updates"
+MOD_VERSION_CALENDAR_SVG_SECURITY_RELEASE="Security Release"
+MOD_VERSION_CALENDAR_SVG_VERSION_END_OF_LIFE_SCHEDULE_EXPECT_NO_MORE_SUPPORT="Version End of Life schedule - expect no more support"
+MOD_VERSION_CALENDAR_SVG_VERSION_AT_END_OF_LIFE="Version at End of Life"
 MOD_VERSION_CALENDAR_SVG_DIMENTIONS="Dimentions"
 MOD_VERSION_CALENDAR_SVG_STYLES="Styles"
 MOD_VERSION_CALENDAR_SVG_DATES="Dates"
@@ -20,6 +28,12 @@ MOD_VERSION_CALENDAR_SVG_YEARS_LINE_COLOR_LABEL="Years Line Color"
 MOD_VERSION_CALENDAR_SVG_YEARS_TEXT_COLOR_LABEL="Years Text Color"
 MOD_VERSION_CALENDAR_SVG_TODAY_LINE_COLOR_LABEL="Today Line Color"
 MOD_VERSION_CALENDAR_SVG_TODAY_TEXT_COLOR_LABEL="Today Text Color"
+MOD_VERSION_CALENDAR_SVG_SHOW_LEGEND_LABEL="Show Legend"
+MOD_VERSION_CALENDAR_SVG_SHOW_LEGEND_DESCRIPTION="Allow the legend to be shown below the calendar."
+MOD_VERSION_CALENDAR_SVG_YES="Yes"
+MOD_VERSION_CALENDAR_SVG_NO="No"
+MOD_VERSION_CALENDAR_SVG_LEGEND_BACKGROUND_COLOR_LABEL="Legend Background Colour"
+MOD_VERSION_CALENDAR_SVG_LEGEND_TEXT_COLOR_LABEL="Legend Text Colour"
 MOD_VERSION_CALENDAR_SVG_MAX_YEARS_LABEL="Max Years"
 MOD_VERSION_CALENDAR_SVG_MIN_YEARS_LABEL="Min Years"
 MOD_VERSION_CALENDAR_SVG_DATES_LABEL="Dates"
diff --git a/language/en-GB/en-GB.mod_version_calendar_svg.sys.ini b/language/en-GB/en-GB.mod_version_calendar_svg.sys.ini
index 88698e1..636cee7 100644
--- a/language/en-GB/en-GB.mod_version_calendar_svg.sys.ini
+++ b/language/en-GB/en-GB.mod_version_calendar_svg.sys.ini
@@ -1,6 +1,14 @@
 MOD_VERSION_CALENDAR_SVG="Version Calendar Svg"
 MOD_VERSION_CALENDAR_SVG_DESCRIPTION="Version Calendar in SVG"
-MOD_VERSION_CALENDAR_SVG_XML_DESCRIPTION="<h1>Version Calendar Svg (v.1.0.1)</h1> <div style='clear: both;'></div><p>Version Calendar in SVG</p><p>Created by <a href='http://www.joomla.org' target='_blank'>Joomla! Project</a><br /><small>Development started 3rd September, 2022</small></p>"
+MOD_VERSION_CALENDAR_SVG_XML_DESCRIPTION="<h1>Version Calendar Svg (v.1.0.2)</h1> <div style='clear: both;'></div><p>Version Calendar in SVG</p><p>Created by <a href='http://www.joomla.org' target='_blank'>Joomla! Project</a><br /><small>Development started 3rd September, 2022</small></p>"
+MOD_VERSION_CALENDAR_SVG_PLANNED_RELEASE_SCHEDULE="Planned release schedule"
+MOD_VERSION_CALENDAR_SVG_FUTURE_RELEASES="Future Releases"
+MOD_VERSION_CALENDAR_SVG_STABLE_RELEASE_SCHEDULE_EXPECT_FULL_SUPPORT_AND_UPDATES="Stable release schedule - expect full support and updates"
+MOD_VERSION_CALENDAR_SVG_STABLE_RELEASE="Stable Release"
+MOD_VERSION_CALENDAR_SVG_SECURITY_SCHEDULE_EXPECT_ONLY_SECURITY_UPDATES="Security schedule - expect only security updates"
+MOD_VERSION_CALENDAR_SVG_SECURITY_RELEASE="Security Release"
+MOD_VERSION_CALENDAR_SVG_VERSION_END_OF_LIFE_SCHEDULE_EXPECT_NO_MORE_SUPPORT="Version End of Life schedule - expect no more support"
+MOD_VERSION_CALENDAR_SVG_VERSION_AT_END_OF_LIFE="Version at End of Life"
 MOD_VERSION_CALENDAR_SVG_DIMENTIONS="Dimentions"
 MOD_VERSION_CALENDAR_SVG_STYLES="Styles"
 MOD_VERSION_CALENDAR_SVG_DATES="Dates"
@@ -20,6 +28,12 @@ MOD_VERSION_CALENDAR_SVG_YEARS_LINE_COLOR_LABEL="Years Line Color"
 MOD_VERSION_CALENDAR_SVG_YEARS_TEXT_COLOR_LABEL="Years Text Color"
 MOD_VERSION_CALENDAR_SVG_TODAY_LINE_COLOR_LABEL="Today Line Color"
 MOD_VERSION_CALENDAR_SVG_TODAY_TEXT_COLOR_LABEL="Today Text Color"
+MOD_VERSION_CALENDAR_SVG_SHOW_LEGEND_LABEL="Show Legend"
+MOD_VERSION_CALENDAR_SVG_SHOW_LEGEND_DESCRIPTION="Allow the legend to be shown below the calendar."
+MOD_VERSION_CALENDAR_SVG_YES="Yes"
+MOD_VERSION_CALENDAR_SVG_NO="No"
+MOD_VERSION_CALENDAR_SVG_LEGEND_BACKGROUND_COLOR_LABEL="Legend Background Colour"
+MOD_VERSION_CALENDAR_SVG_LEGEND_TEXT_COLOR_LABEL="Legend Text Colour"
 MOD_VERSION_CALENDAR_SVG_MAX_YEARS_LABEL="Max Years"
 MOD_VERSION_CALENDAR_SVG_MIN_YEARS_LABEL="Min Years"
 MOD_VERSION_CALENDAR_SVG_DATES_LABEL="Dates"
diff --git a/mod_version_calendar_svg.xml b/mod_version_calendar_svg.xml
index 1c920ee..086354d 100644
--- a/mod_version_calendar_svg.xml
+++ b/mod_version_calendar_svg.xml
@@ -7,7 +7,7 @@
 	<authorUrl>http://www.joomla.org</authorUrl>
 	<copyright>(C) 2020 Open Source Matters, Inc.</copyright>
 	<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
-	<version>1.0.1</version>
+	<version>1.0.2</version>
 	<description>MOD_VERSION_CALENDAR_SVG_XML_DESCRIPTION</description>
 
 	<!-- Scripts to run on installation -->
@@ -204,6 +204,36 @@
 			label="MOD_VERSION_CALENDAR_SVG_TODAY_TEXT_COLOR_LABEL"
 			required="true"
 		/>
+		<!-- Show_legend Field. Type: Radio. (joomla) -->
+		<field
+			type="radio"
+			name="show_legend"
+			label="MOD_VERSION_CALENDAR_SVG_SHOW_LEGEND_LABEL"
+			description="MOD_VERSION_CALENDAR_SVG_SHOW_LEGEND_DESCRIPTION"
+			class="btn-group btn-group-yesno"
+			default="1">
+			<!-- Option Set. -->
+			<option value="1">
+				MOD_VERSION_CALENDAR_SVG_YES</option>
+			<option value="0">
+				MOD_VERSION_CALENDAR_SVG_NO</option>
+		</field>
+		<!-- Legend_background_color Field. Type: Color. (joomla) -->
+		<field
+			type="color"
+			name="legend_background_color"
+			default="#494444"
+			label="MOD_VERSION_CALENDAR_SVG_LEGEND_BACKGROUND_COLOR_LABEL"
+			showon="show_legend:1"
+		/>
+		<!-- Legend_text_color Field. Type: Color. (joomla) -->
+		<field
+			type="color"
+			name="legend_text_color"
+			default="#fbf3ef"
+			label="MOD_VERSION_CALENDAR_SVG_LEGEND_TEXT_COLOR_LABEL"
+			showon="show_legend:1"
+		/>
 	</fieldset>
 	<!-- default paths of dates fieldset points to the module -->
 	<fieldset name="dates" label="MOD_VERSION_CALENDAR_SVG_DATES"
diff --git a/tmpl/default.php b/tmpl/default.php
index 37f688a..fcc9249 100644
--- a/tmpl/default.php
+++ b/tmpl/default.php
@@ -21,61 +21,53 @@ defined('_JEXEC') or die('Restricted access');
 			font-family: "Source Sans Pro", Helvetica, Arial, sans-serif;
 			font-size: <?php echo (2 / 3) * $params->get('header_height', 24); ?>px;
 		}
-
 		g.future rect,
 		.branches rect.future {
 			fill: <?php echo $params->get('future_color', '#000'); ?>;
 		}
-
 		g.eol rect,
 		.branches rect.eol {
 			fill: <?php echo $params->get('end_of_life_color', '#f33'); ?>;
 		}
-
 		g.eol text {
 			fill: <?php echo $params->get('end_of_life_text_color', '#fff'); ?>;
 		}
-
 		g.security rect,
 		.branches rect.security {
 			fill: <?php echo $params->get('security_color', '#f93'); ?>;
 		}
-
 		g.stable rect,
 		.branches rect.stable {
 			fill: <?php echo $params->get('stable_color', '#9c9'); ?>;
 		}
-
 		.branch-labels text {
 		dominant-baseline: central;
 			text-anchor: middle;
 		}
-
 		.today line {
 			stroke: <?php echo $params->get('today_line_color', '#f33'); ?>;
 			stroke-dasharray: 7, 7;
 			stroke-width: 3px;
 		}
-
 		.today text {
 			fill: <?php echo $params->get('today_text_color', '#f33'); ?>;
 			text-anchor: middle;
 		}
-
 		.years line {
 			stroke: <?php echo $params->get('years_line_color', '#000'); ?>;
 		}
-
 		.years text {
 			fill: <?php echo $params->get('years_text_color', '#000'); ?>;
 			text-anchor: middle;
 		}
 	</style>
-
 	<!-- Branch labels -->
 	<g class="branch-labels">
+		<?php $active = []; ?>
 		<?php foreach ($branches as $branch): ?>
-			<g class="<?php echo $helper->state($branch); ?>">
+			<?php $state = $helper->state($branch); ?>
+			<?php $active[$state] = $state; ?>
+			<g class="<?php echo $state; ?>">
 				<rect x="0" y="<?php echo $branch->top; ?>" width="<?php echo 0.5 * $params->get('margin_left', 80); ?>"
 					height="<?php echo $params->get('branch_height', 30); ?>"/>
 				<text x="<?php echo 0.25 * $params->get('margin_left', 80); ?>" y="<?php echo $branch->top + (0.5 * $params->get('branch_height', 30)); ?>">
@@ -84,7 +76,6 @@ defined('_JEXEC') or die('Restricted access');
 			</g>
 		<?php endforeach; ?>
 	</g>
-
 	<!-- Branch blocks -->
 	<g class="branches">
 		<?php foreach ($branches as $branch): ?>
@@ -99,7 +90,6 @@ defined('_JEXEC') or die('Restricted access');
 				width="<?php echo $x_eol - $x_security; ?>" height="<?php echo $params->get('branch_height', 30); ?>"/>
 		<?php endforeach; ?>
 	</g>
-
 	<!-- Year lines -->
 	<g class="years">
 		<?php foreach ($helper->years() as $date): ?>
@@ -111,7 +101,6 @@ defined('_JEXEC') or die('Restricted access');
 			</text>
 		<?php endforeach; ?>
 	</g>
-
 	<!-- Today -->
 	<g class="today">
 		<?php
@@ -125,4 +114,105 @@ defined('_JEXEC') or die('Restricted access');
 			<?php echo 'Today: ' . $now->format('j M Y'); ?>
 		</text>
 	</g>
-</svg>
+</svg>
+<?php if ($params->get('show_legend', 0) == 1): ?>
+<style type="text/css">
+	/* Box Shadow */
+	.vdm-box-shadow-medium {
+		box-shadow: 0 10px 40px rgba(0, 0, 0, 0.15), 0 0.5rem 1.5rem rgba(0, 0, 0, 0.25);
+	}
+	/* Card Styles */
+	.vdm-card {
+		border-radius: 4px;
+		margin-top: 15px;
+	}
+	.vdm-card-legend {
+		background-color: <?php echo $params->get('legend_background_color', '#494444'); ?>;
+		color: <?php echo $params->get('legend_text_color', '#fbf3ef'); ?>;
+	}
+	.vdm-card-body {
+		padding: 4px;
+	}
+	/* Grid Styles */
+	.vdm-grid {
+		display: flex;
+		flex-wrap: wrap;
+	}
+	.vdm-grid-match > div {
+		padding: 5px;
+		min-height: 1px;
+		margin: 10px;
+	}
+	/* Flexbox Styles */
+	.vdm-flex {
+		display: flex;
+		align-items: center;
+		justify-content: space-between;
+	}
+	.vdm-flex-middle {
+		align-items: center;
+	}
+	/* Color Box Styles */
+	.vdm-color-box {
+		width: 20px;
+		height: 20px;
+		display: inline-block;
+		margin-right: 5px;
+	}
+	.vdm-future { background-color: <?php echo $params->get('future_color', '#000'); ?>; }
+	.vdm-stable { background-color: <?php echo $params->get('stable_color', '#9c9'); ?>; }
+	.vdm-security { background-color: <?php echo $params->get('security_color', '#f93'); ?>; }
+	.vdm-end-of-life { background-color: <?php echo $params->get('end_of_life_color', '#f33'); ?>; }
+	/* Media Query for smaller screens */
+	@media (max-width: 768px) {
+		.vdm-grid {
+			flex-direction: column;
+		}
+		.vdm-flex {
+			display: block;
+		}
+		.vdm-grid-match > div {
+			margin: 4px;
+			padding: 0;
+		}
+	}
+</style>
+<div class="vdm-box-shadow-medium">
+	<div class="vdm-card vdm-card-legend vdm-card-body">
+		<div class="vdm-grid-match vdm-grid">
+			<?php if (isset($active['future'])): ?>
+				<div class="vdm-flex vdm-flex-middle">
+					<span
+						class="vdm-color-box vdm-future hasTooltip"
+						title="<?php echo JText::_('MOD_VERSION_CALENDAR_SVG_PLANNED_RELEASE_SCHEDULE'); ?>"
+					></span><?php echo JText::_('MOD_VERSION_CALENDAR_SVG_FUTURE_RELEASES'); ?>
+				</div>
+			<?php endif; ?>
+			<?php if (isset($active['stable'])): ?>
+				<div class="vdm-flex vdm-flex-middle">
+					<span
+						class="vdm-color-box vdm-stable hasTooltip"
+						title="<?php echo JText::_('MOD_VERSION_CALENDAR_SVG_STABLE_RELEASE_SCHEDULE_EXPECT_FULL_SUPPORT_AND_UPDATES'); ?>"
+					></span><?php echo JText::_('MOD_VERSION_CALENDAR_SVG_STABLE_RELEASE'); ?>
+				</div>
+			<?php endif; ?>
+			<?php if (isset($active['security'])): ?>
+				<div class="vdm-flex vdm-flex-middle">
+					<span
+						class="vdm-color-box vdm-security hasTooltip"
+						title="<?php echo JText::_('MOD_VERSION_CALENDAR_SVG_SECURITY_SCHEDULE_EXPECT_ONLY_SECURITY_UPDATES'); ?>"
+					></span><?php echo JText::_('MOD_VERSION_CALENDAR_SVG_SECURITY_RELEASE'); ?>
+				</div>
+			<?php endif; ?>
+			<?php if (isset($active['eol'])): ?>
+				<div class="vdm-flex vdm-flex-middle">
+					<span
+						class="vdm-color-box vdm-end-of-life hasTooltip"
+						title="<?php echo JText::_('MOD_VERSION_CALENDAR_SVG_VERSION_END_OF_LIFE_SCHEDULE_EXPECT_NO_MORE_SUPPORT'); ?>"
+					></span><?php echo JText::_('MOD_VERSION_CALENDAR_SVG_VERSION_AT_END_OF_LIFE'); ?>
+				</div>
+			<?php endif; ?>
+		</div>
+	</div>
+</div>
+<?php endif; ?>