Merge pull request #901 from michaelkubina/add_show_empty_years

[FEATURE] Add an option to list empty years in calender plugin
kitodo · Feb 6, 2023 · 8dacea6 · 8dacea6
2 parents 4005317 + 5d02bf0
commit 8dacea6
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 5 deletions.
diff --git a/Classes/Controller/CalendarController.php b/Classes/Controller/CalendarController.php
@@ -281,6 +281,25 @@ public function yearsAction()
  'title' => $year['title']
  ];
  }
+ // create an array that includes years without issues
+ if (!empty($this->settings['showEmptyYears'])) {
+ $yearFilled = [];
+ $min = $yearArray[0]['title'];
+ // round the starting decade down to zero for equal rows
+ $min = substr_replace($min, "0", -1);
+ $max = $yearArray[count($yearArray) - 1]['title'];
+ // if we have an actual documentId it should be used, otherwise leave empty
+ for ($i = 0; $i < $max - $min + 1; $i++) {
+ $key = array_search($min + $i, array_column($yearArray, 'title'));
+ if (is_int($key)) {
+ $yearFilled[] = $yearArray[$key];
+ } else {
+ $yearFilled[] = ['title' => $min+$i, 'documentId' => ''];
+ }
+ }
+ $yearArray = $yearFilled;
+ }
+
  $this->view->assign('yearName', $yearArray);
  }
 

diff --git a/Configuration/Flexforms/Calendar.xml b/Configuration/Flexforms/Calendar.xml
@@ -60,6 +60,16 @@
  </config>
  </TCEforms>
  </settings.initialDocument>
+ <settings.showEmptyYears>
+ <TCEforms>
+ <exclude>1</exclude>
+ <label>LLL:EXT:dlf/Resources/Private/Language/locallang_be.xlf:plugins.calendar.flexform.showEmptyYears</label>
+ <config>
+ <type>check</type>
+ <default>0</default>
+ </config>
+ </TCEforms>
+ </settings.showEmptyYears>
  <settings.showEmptyMonths>
  <TCEforms>
  <exclude>1</exclude>

diff --git a/Documentation/Plugins/Index.rst b/Documentation/Plugins/Index.rst
@@ -219,6 +219,13 @@ now.
  :ref:`t3tsref:data-type-integer`
  :Default:
 
+ - :Property:
+ showEmptyYears
+ :Data Type:
+ :ref:`t3tsref:data-type-boolean`
+ :Default:
+ 0
+
  - :Property:
  showEmptyMonths
  :Data Type:

diff --git a/Resources/Private/Language/de.locallang_be.xlf b/Resources/Private/Language/de.locallang_be.xlf
@@ -121,6 +121,10 @@
  <source><![CDATA[Initial document to show (e.g. of type "newspaper" or "ephemera")]]></source>
  <target><![CDATA[Anfangsdokument (z.B. vom Typ "newspaper" oder "ephemera)]]></target>
  </trans-unit>
+ <trans-unit id="plugins.calendar.flexform.showEmptyYears" approved="yes">
+ <source><![CDATA[Show years without issues in calendar?]]></source>
+ <target><![CDATA[Zeige Jahre ohne Ausgaben im Kalender?]]></target>
+ </trans-unit>
  <trans-unit id="plugins.calendar.flexform.showEmptyMonths" approved="yes">
  <source><![CDATA[Show months without issues in calendar?]]></source>
  <target><![CDATA[Zeige Monate ohne Ausgaben im Kalender?]]></target>

diff --git a/Resources/Private/Language/locallang_be.xlf b/Resources/Private/Language/locallang_be.xlf
@@ -56,6 +56,9 @@
  <trans-unit id="plugins.calendar.flexform.initialDocument">
  <source><![CDATA[Initial document to show (e.g. of type "newspaper" or "ephemera")]]></source>
  </trans-unit>
+ <trans-unit id="plugins.calendar.flexform.showEmptyYears">
+ <source><![CDATA[Show years without issues in calendar?]]></source>
+ </trans-unit>
  <trans-unit id="plugins.calendar.flexform.showEmptyMonths">
  <source><![CDATA[Show months without issues in calendar?]]></source>
  </trans-unit>

diff --git a/Resources/Private/Templates/Calendar/Years.html b/Resources/Private/Templates/Calendar/Years.html
@@ -26,11 +26,20 @@
  <div class="year-view">
  <ul>
  <f:for each="{yearName}" as="yearEntry">
- <li class="year">
- <f:link.page additionalParams="{'tx_dlf[id]': yearEntry.documentId}">
- {yearEntry.title}
- </f:link.page>
- </li>
+ <f:if condition="{yearEntry.documentId}">
+ <f:then>
+ <li class="year">
+ <f:link.page additionalParams="{'tx_dlf[id]': yearEntry.documentId}">
+ {yearEntry.title}
+ </f:link.page>
+ </li>
+ </f:then>
+ <f:else>
+ <li class="year-empty">
+ <p>{yearEntry.title}</p>
+ </li>
+ </f:else>
+ </f:if>
  </f:for>
  </ul>
  </div>