Deploy docs from fb8e2cf

Tom Udding: Merge pull request GEWIS#1829 from GEWIS/feature/pull-request-template Add template for pull requests Co-authored-by: tomudding <[email protected]>
tomudding · May 12, 2024 · a79f674 · a79f674
1 parent 33f54c2
commit a79f674
Show file tree

Hide file tree

Showing 35 changed files with 4,782 additions and 956 deletions.
diff --git a/classes/Activity-Command-DeleteOldSignups.html b/classes/Activity-Command-DeleteOldSignups.html
diff --git a/classes/Activity-Command-Factory-DeleteOldSignupsFactory.html b/classes/Activity-Command-Factory-DeleteOldSignupsFactory.html
diff --git a/classes/Activity-Mapper-Signup.html b/classes/Activity-Mapper-Signup.html
@@ -411,7 +411,7 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Mapper/Signup.php"><a href="files/module-activity-src-mapper-signup.html"><abbr title="module/Activity/src/Mapper/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">17</span>
+    <span class="phpdocumentor-element-found-in__line">20</span>
 
     </aside>
 
@@ -486,6 +486,13 @@ <h4 id="toc-methods">
                                 &nbsp;: int    </span>
 </dt>
 
+            <dt class="phpdocumentor-table-of-contents__entry -method -public">
+    <a href="classes/Activity-Mapper-Signup.html#method_deleteSignupsForActivitiesOlderThan5Years">deleteSignupsForActivitiesOlderThan5Years()</a>
+    <span>
+                                &nbsp;: void    </span>
+</dt>
+<dd>Delete all sign-ups for activities that ended 5 years ago.</dd>
+
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/Application-Mapper-BaseMapper.html#method_detach">detach()</a>
     <span>
@@ -769,6 +776,38 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
 
             </section>
 
+</article>
+                    <article
+        class="phpdocumentor-element
+            -method
+            -public
+                                                        "
+>
+    <h4 class="phpdocumentor-element__name" id="method_deleteSignupsForActivitiesOlderThan5Years">
+        deleteSignupsForActivitiesOlderThan5Years()
+        <a href="classes/Activity-Mapper-Signup.html#method_deleteSignupsForActivitiesOlderThan5Years" class="headerlink"><i class="fas fa-link"></i></a>
+
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Mapper/Signup.php"><a href="files/module-activity-src-mapper-signup.html"><abbr title="module/Activity/src/Mapper/Signup.php">Signup.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">86</span>
+
+    </aside>
+
+        <p class="phpdocumentor-summary">Delete all sign-ups for activities that ended 5 years ago.</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility">public</span>
+                    <span class="phpdocumentor-signature__name">deleteSignupsForActivitiesOlderThan5Years</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
+
+    <div class="phpdocumentor-label-line">
+        </div>
+
+
+
+
+
 </article>
                     <article
         class="phpdocumentor-element
@@ -1050,7 +1089,7 @@ <h4 class="phpdocumentor-element__name" id="method_findSignupsByMember">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Mapper/Signup.php"><a href="files/module-activity-src-mapper-signup.html"><abbr title="module/Activity/src/Mapper/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">71</span>
+    <span class="phpdocumentor-element-found-in__line">74</span>
 
     </aside>
 
@@ -1222,7 +1261,7 @@ <h4 class="phpdocumentor-element__name" id="method_getExternalSignUp">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Mapper/Signup.php"><a href="files/module-activity-src-mapper-signup.html"><abbr title="module/Activity/src/Mapper/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">50</span>
+    <span class="phpdocumentor-element-found-in__line">53</span>
 
     </aside>
 
@@ -1267,7 +1306,7 @@ <h4 class="phpdocumentor-element__name" id="method_getNumberOfSignedUpMembers">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Mapper/Signup.php"><a href="files/module-activity-src-mapper-signup.html"><abbr title="module/Activity/src/Mapper/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">55</span>
+    <span class="phpdocumentor-element-found-in__line">58</span>
 
     </aside>
 
@@ -1312,7 +1351,7 @@ <h4 class="phpdocumentor-element__name" id="method_getSignUp">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Mapper/Signup.php"><a href="files/module-activity-src-mapper-signup.html"><abbr title="module/Activity/src/Mapper/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">32</span>
+    <span class="phpdocumentor-element-found-in__line">35</span>
 
     </aside>
 
@@ -1365,7 +1404,7 @@ <h4 class="phpdocumentor-element__name" id="method_isSignedUp">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Mapper/Signup.php"><a href="files/module-activity-src-mapper-signup.html"><abbr title="module/Activity/src/Mapper/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">22</span>
+    <span class="phpdocumentor-element-found-in__line">25</span>
 
     </aside>
 
@@ -1850,7 +1889,7 @@ <h4 class="phpdocumentor-element__name" id="method_getRepositoryName">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Mapper/Signup.php"><a href="files/module-activity-src-mapper-signup.html"><abbr title="module/Activity/src/Mapper/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">80</span>
+    <span class="phpdocumentor-element-found-in__line">98</span>
 
     </aside>
 
@@ -1997,6 +2036,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
                 <ul class="phpdocumentor-list -clean">
                                             <li><a href="classes/Application-Mapper-BaseMapper.html#method___construct">__construct()</a></li>
                                             <li><a href="classes/Application-Mapper-BaseMapper.html#method_count">count()</a></li>
+                                            <li><a href="classes/Activity-Mapper-Signup.html#method_deleteSignupsForActivitiesOlderThan5Years">deleteSignupsForActivitiesOlderThan5Years()</a></li>
                                             <li><a href="classes/Application-Mapper-BaseMapper.html#method_detach">detach()</a></li>
                                             <li><a href="classes/Application-Mapper-BaseMapper.html#method_find">find()</a></li>
                                             <li><a href="classes/Application-Mapper-BaseMapper.html#method_findAll">findAll()</a></li>

diff --git a/classes/Activity-Module.html b/classes/Activity-Module.html
@@ -407,7 +407,7 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Module.php"><a href="files/module-activity-src-module.html"><abbr title="module/Activity/src/Module.php">Module.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">39</span>
+    <span class="phpdocumentor-element-found-in__line">41</span>
 
     </aside>
 
@@ -481,7 +481,7 @@ <h4 class="phpdocumentor-element__name" id="method_getConfig">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Module.php"><a href="files/module-activity-src-module.html"><abbr title="module/Activity/src/Module.php">Module.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">46</span>
+    <span class="phpdocumentor-element-found-in__line">48</span>
 
     </aside>
 
@@ -521,7 +521,7 @@ <h4 class="phpdocumentor-element__name" id="method_getServiceConfig">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Module.php"><a href="files/module-activity-src-module.html"><abbr title="module/Activity/src/Module.php">Module.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">56</span>
+    <span class="phpdocumentor-element-found-in__line">58</span>
 
     </aside>
 

diff --git a/classes/Activity-Service-Signup.html b/classes/Activity-Service-Signup.html
@@ -495,6 +495,13 @@ <h4 id="toc-methods">
 </dt>
 <dd>Sign an external user up for an activity, which the current user may admin.</dd>
 
+            <dt class="phpdocumentor-table-of-contents__entry -method -public">
+    <a href="classes/Activity-Service-Signup.html#method_deleteOldSignups">deleteOldSignups()</a>
+    <span>
+                                &nbsp;: void    </span>
+</dt>
+<dd>Delete all sign-ups for activities that are older than 5 years.</dd>
+
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/Activity-Service-Signup.html#method_editSignUp">editSignUp()</a>
     <span>
@@ -1013,6 +1020,41 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
         <span class="phpdocumentor-signature__response_type"><a href="classes/Activity-Model-ExternalSignup.html"><abbr title="\Activity\Model\ExternalSignup">ExternalSignup</abbr></a></span>
             </section>
 
+</article>
+                    <article
+        class="phpdocumentor-element
+            -method
+            -public
+                                                        "
+>
+    <h4 class="phpdocumentor-element__name" id="method_deleteOldSignups">
+        deleteOldSignups()
+        <a href="classes/Activity-Service-Signup.html#method_deleteOldSignups" class="headerlink"><i class="fas fa-link"></i></a>
+
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Service/Signup.php"><a href="files/module-activity-src-service-signup.html"><abbr title="module/Activity/src/Service/Signup.php">Signup.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">365</span>
+
+    </aside>
+
+        <p class="phpdocumentor-summary">Delete all sign-ups for activities that are older than 5 years.</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility">public</span>
+                    <span class="phpdocumentor-signature__name">deleteOldSignups</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
+
+    <div class="phpdocumentor-label-line">
+        </div>
+        <section class="phpdocumentor-description"><p>We can automatically DELETE all sign-ups at once instead of retrieving them and iterating over them before using
+<code class="prettyprint">$this-&gt;removeSignup()</code> to remove them.</p>
+</section>
+
+
+
+
+
 </article>
                     <article
         class="phpdocumentor-element
@@ -1499,7 +1541,7 @@ <h4 class="phpdocumentor-element__name" id="method_isAllowedToExternalSubscribe"
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Service/Signup.php"><a href="files/module-activity-src-service-signup.html"><abbr title="module/Activity/src/Service/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">379</span>
+    <span class="phpdocumentor-element-found-in__line">390</span>
 
     </aside>
 
@@ -1535,7 +1577,7 @@ <h4 class="phpdocumentor-element__name" id="method_isAllowedToInternalSubscribe"
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Service/Signup.php"><a href="files/module-activity-src-service-signup.html"><abbr title="module/Activity/src/Service/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">389</span>
+    <span class="phpdocumentor-element-found-in__line">400</span>
 
     </aside>
 
@@ -1570,7 +1612,7 @@ <h4 class="phpdocumentor-element__name" id="method_isAllowedToSubscribe">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Service/Signup.php"><a href="files/module-activity-src-service-signup.html"><abbr title="module/Activity/src/Service/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">371</span>
+    <span class="phpdocumentor-element-found-in__line">382</span>
 
     </aside>
 
@@ -1606,7 +1648,7 @@ <h4 class="phpdocumentor-element__name" id="method_isAllowedToViewSubscriptions"
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Service/Signup.php"><a href="files/module-activity-src-service-signup.html"><abbr title="module/Activity/src/Service/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">384</span>
+    <span class="phpdocumentor-element-found-in__line">395</span>
 
     </aside>
 
@@ -1641,7 +1683,7 @@ <h4 class="phpdocumentor-element__name" id="method_isInSubscriptionWindow">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Activity/src/Service/Signup.php"><a href="files/module-activity-src-service-signup.html"><abbr title="module/Activity/src/Service/Signup.php">Signup.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">359</span>
+    <span class="phpdocumentor-element-found-in__line">370</span>
 
     </aside>
 
@@ -2251,6 +2293,7 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
                 <ul class="phpdocumentor-list -clean">
                                             <li><a href="classes/Activity-Service-Signup.html#method___construct">__construct()</a></li>
                                             <li><a href="classes/Activity-Service-Signup.html#method_adminSignUp">adminSignUp()</a></li>
+                                            <li><a href="classes/Activity-Service-Signup.html#method_deleteOldSignups">deleteOldSignups()</a></li>
                                             <li><a href="classes/Activity-Service-Signup.html#method_editSignUp">editSignUp()</a></li>
                                             <li><a href="classes/Activity-Service-Signup.html#method_externalSignOff">externalSignOff()</a></li>
                                             <li><a href="classes/Activity-Service-Signup.html#method_externalSignUp">externalSignUp()</a></li>

diff --git a/classes/Application-View-Helper-LocaliseText.html b/classes/Application-View-Helper-LocaliseText.html
@@ -446,9 +446,9 @@ <h4 id="toc-methods">
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/Application-View-Helper-LocaliseText.html#method___invoke">__invoke()</a>
     <span>
-                                &nbsp;: string|null    </span>
+                                &nbsp;: string    </span>
 </dt>
-<dd>Determines the correct value for an element.</dd>
+<dd>Returns the localised value of an element.</dd>
 
     </dl>
 
@@ -479,15 +479,15 @@ <h4 class="phpdocumentor-element__name" id="method___invoke">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="module/Application/src/View/Helper/LocaliseText.php"><a href="files/module-application-src-view-helper-localisetext.html"><abbr title="module/Application/src/View/Helper/LocaliseText.php">LocaliseText.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">17</span>
+    <span class="phpdocumentor-element-found-in__line">15</span>
 
     </aside>
 
-        <p class="phpdocumentor-summary">Determines the correct value for an element.</p>
+        <p class="phpdocumentor-summary">Returns the localised value of an element.</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
-                    <span class="phpdocumentor-signature__name">__invoke</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Application-Model-LocalisedText.html"><abbr title="\Application\Model\LocalisedText">LocalisedText</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$localisedText</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
+                    <span class="phpdocumentor-signature__name">__invoke</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Application-Model-LocalisedText.html"><abbr title="\Application\Model\LocalisedText">LocalisedText</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$localisedText</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
 
     <div class="phpdocumentor-label-line">
         </div>
@@ -507,11 +507,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
 
             <section>
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
-        <span class="phpdocumentor-signature__response_type">string|null</span>
-                    &mdash;
-                <section class="phpdocumentor-description"><p>The localised value of <code class="prettyprint">$localisedText</code> or null if no translation exists.</p>
-</section>
-
+        <span class="phpdocumentor-signature__response_type">string</span>
             </section>
 
 </article>