From a7d2447b396b6a3aeeef84b09aa6fa277d836332 Mon Sep 17 00:00:00 2001
From: David Siegfried <david.siegfried@uni-vechta.de>
Date: Sat, 11 Mar 2023 12:48:59 +0000
Subject: add php-doc, closes #1808

Closes #1808

Merge request studip/studip!1188
---
 app/views/admission/courseset/_institute_choose.php         |  9 +++++++++
 app/views/admission/courseset/applications_list.php         | 10 +++++++++-
 app/views/admission/courseset/configure.php                 | 13 +++++++++++++
 app/views/admission/courseset/configure_courses.php         | 10 ++++++++++
 app/views/admission/courseset/delete.php                    |  6 ++++++
 app/views/admission/courseset/factored_users.php            |  5 +++++
 app/views/admission/courseset/index.php                     |  6 +++++-
 app/views/admission/courseset/instcourses.php               |  5 +++++
 app/views/admission/courseset/institutes.php                |  7 +++++++
 app/views/admission/institute-select.php                    |  6 ++++++
 .../admission/restricted_courses/_institute_choose.php      |  8 ++++++++
 app/views/admission/restricted_courses/index.php            |  5 +++++
 app/views/admission/rule/configure.php                      |  6 ++++++
 app/views/admission/rule/save.php                           |  6 ++++++
 app/views/admission/rule/select_type.php                    |  7 +++++++
 app/views/admission/rule/validate.php                       |  5 ++++-
 app/views/admission/ruleadministration/compatibility.php    |  6 ++++++
 app/views/admission/ruleadministration/index.php            |  6 ++++++
 app/views/admission/user_list/configure.php                 |  7 +++++++
 app/views/admission/user_list/delete.php                    |  6 ++++++
 app/views/admission/user_list/index.php                     |  4 ++++
 21 files changed, 140 insertions(+), 3 deletions(-)

diff --git a/app/views/admission/courseset/_institute_choose.php b/app/views/admission/courseset/_institute_choose.php
index 7fcc8da..48af5f8 100644
--- a/app/views/admission/courseset/_institute_choose.php
+++ b/app/views/admission/courseset/_institute_choose.php
@@ -1,3 +1,12 @@
+<?php
+/**
+ * @var array $myInstitutes
+ * @var string $current_institut_id
+ * @var string $set_name_prefix
+ * @var array $ruleTypes
+ * @var string $current_semester_id
+ */
+?>
 <form action="?" method="post" name="institute_choose" class="default">
     <?= CSRFProtection::tokenTag() ?>
 
diff --git a/app/views/admission/courseset/applications_list.php b/app/views/admission/courseset/applications_list.php
index 6eba77a..8b70e80 100644
--- a/app/views/admission/courseset/applications_list.php
+++ b/app/views/admission/courseset/applications_list.php
@@ -1,3 +1,11 @@
+<?php
+/**
+ * @var array $captions
+ * @var array $data
+ * @var Admission_CoursesetController $controller
+ * @var string $set_id
+ */
+?>
 <table class="default">
     <thead>
         <tr>
@@ -18,4 +26,4 @@
 </table>
 <div data-dialog-button>
 <?= Studip\LinkButton::create(_("Download"), $controller->url_for('admission/courseset/applications_list/' . $set_id .'/csv')) ?>
-</div>
\ No newline at end of file
+</div>
diff --git a/app/views/admission/courseset/configure.php b/app/views/admission/courseset/configure.php
index cb0f81a..d1d31e2 100644
--- a/app/views/admission/courseset/configure.php
+++ b/app/views/admission/courseset/configure.php
@@ -1,4 +1,17 @@
 <?php
+/**
+ * @var CourseSet $courseset
+ * @var array $flash
+ * @var Admission_CoursesetController|Course_AdmissionController $controller
+ * @var bool $instant_course_set_view
+ * @var array $myInstitutes
+ * @var array $selectedInstitutes
+ * @var QuickSearch $instSearch
+ * @var string $instTpl
+ * @var string $coursesTpl
+ * @var string $selectedSemester
+ * @var AdmissionUserList[] $myUserlists
+ */
 use Studip\Button, Studip\LinkButton;
 
 Helpbar::get()->addPlainText(_('Regeln'), _('Hier können Sie die Regeln, Eigenschaften und Zuordnungen des Anmeldesets bearbeiten.'));
diff --git a/app/views/admission/courseset/configure_courses.php b/app/views/admission/courseset/configure_courses.php
index e80e621..88a092e 100644
--- a/app/views/admission/courseset/configure_courses.php
+++ b/app/views/admission/courseset/configure_courses.php
@@ -1,3 +1,13 @@
+<?php
+/**
+ * @var Admission_CoursesetController $controller
+ * @var string $set_id
+ * @var bool $participant_restriction
+ * @var Course[] $courses
+ * @var int $count_distinct_members
+ * @var int $count_multi_members
+ */
+?>
 <form name="configure_courses" action="<?= $controller->url_for('admission/courseset/configure_courses/' . $set_id) ?>" method="post">
     <table class="default">
         <thead>
diff --git a/app/views/admission/courseset/delete.php b/app/views/admission/courseset/delete.php
index 26cb7aa..89fd91e 100644
--- a/app/views/admission/courseset/delete.php
+++ b/app/views/admission/courseset/delete.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @var CourseSet $courseset
+ * @var Admission_CoursesetController $controller
+ */
+?>
 <?= (string) QuestionBox::create(
     sprintf(_('Sind Sie sicher, dass das Anmeldeset "%s" ' .
         'gelöscht werden soll? Damit werden alle Regeln zur Anmeldung zu den ' .
diff --git a/app/views/admission/courseset/factored_users.php b/app/views/admission/courseset/factored_users.php
index a46760e..eeb9feb 100644
--- a/app/views/admission/courseset/factored_users.php
+++ b/app/views/admission/courseset/factored_users.php
@@ -1,3 +1,8 @@
+<?php
+/**
+ * @var array $users
+ */
+?>
 <table class="default">
     <thead>
         <tr>
diff --git a/app/views/admission/courseset/index.php b/app/views/admission/courseset/index.php
index 555e18f..40f4171 100644
--- a/app/views/admission/courseset/index.php
+++ b/app/views/admission/courseset/index.php
@@ -1,5 +1,9 @@
 <?php
-
+/**
+ * @var CourseSet[] $coursesets
+ * @var Admission_CoursesetController $controller
+ * @var string $course_set_details
+ */
 Helpbar::get()->addPlainText(_('Info'),_("Anmeldesets legen fest, wer sich zu den zugeordneten Veranstaltungen anmelden darf."));
 Helpbar::get()->addPlainText(_('Info'),_("Hier sehen Sie alle Anmeldesets, auf die Sie Zugriff haben."));
 
diff --git a/app/views/admission/courseset/instcourses.php b/app/views/admission/courseset/instcourses.php
index 447a55e..330aee3 100644
--- a/app/views/admission/courseset/instcourses.php
+++ b/app/views/admission/courseset/instcourses.php
@@ -1,3 +1,8 @@
+<?php
+/**
+ * @var array $selectedCourses
+ */
+?>
 <table id="courselist" class="default">
     <thead>
         <colgroup>
diff --git a/app/views/admission/courseset/institutes.php b/app/views/admission/courseset/institutes.php
index c22f21f..30b78c3 100644
--- a/app/views/admission/courseset/institutes.php
+++ b/app/views/admission/courseset/institutes.php
@@ -1,3 +1,10 @@
+<?php
+/**
+ * @var Admission_CoursesetController $controller
+ * @var string $instSearch
+ * @var array $selectedInstitutes
+ */
+?>
 <?= Icon::create('arr_2down', Icon::ROLE_SORT)->asImg([
     'title'   => _('Einrichtung hinzufügen'),
     'onclick' => "STUDIP.Admission.updateInstitutes($('input[name=\"institute_id\"]').val(), '" . $controller->url_for('admission/courseset/institutes', !empty($courseset) ? $courseset->getId() : '') . "', '" . $controller->url_for('admission/courseset/instcourses', !empty($courseset) ? $courseset->getId() : '') . "', 'add')",
diff --git a/app/views/admission/institute-select.php b/app/views/admission/institute-select.php
index e9b9ed6..7453b5e 100644
--- a/app/views/admission/institute-select.php
+++ b/app/views/admission/institute-select.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @var array $institutes
+ * @var string $current_institut_id
+ */
+?>
 <? reset($institutes); ?>
 <label>
     <?=_("Einrichtung:")?>
diff --git a/app/views/admission/restricted_courses/_institute_choose.php b/app/views/admission/restricted_courses/_institute_choose.php
index d6bb8ba..8cec08c 100644
--- a/app/views/admission/restricted_courses/_institute_choose.php
+++ b/app/views/admission/restricted_courses/_institute_choose.php
@@ -1,3 +1,11 @@
+<?php
+/**
+ * @var array $my_inst
+ * @var string $current_institut_id
+ * @var string $sem_name_prefix
+ * @var string $current_semester_id
+ */
+?>
 <form action="?" method="post" name="institute_choose" class="default">
     <?= CSRFProtection::tokenTag() ?>
     <fieldset>
diff --git a/app/views/admission/restricted_courses/index.php b/app/views/admission/restricted_courses/index.php
index f506b9b..a7b1819 100644
--- a/app/views/admission/restricted_courses/index.php
+++ b/app/views/admission/restricted_courses/index.php
@@ -1,3 +1,8 @@
+<?php
+/**
+ * @var array $courses
+ */
+?>
 <?= $this->render_partial('admission/restricted_courses/_institute_choose.php')?>
 <br>
 <? if (count($courses)) : ?>
diff --git a/app/views/admission/rule/configure.php b/app/views/admission/rule/configure.php
index 028b455..b00c27b 100644
--- a/app/views/admission/rule/configure.php
+++ b/app/views/admission/rule/configure.php
@@ -1,5 +1,11 @@
 <?php
 use Studip\Button, Studip\LinkButton;
+
+/**
+ * @var Admission_CoursesetController $controller
+ * @var AdmissionRule $class
+ * @var string $ruleTemplate
+ */
 ?>
 <div id="errormessage"></div>
 <form action="<?= $controller->url_for('admission/rule/save', get_class($rule), $rule->getId()) ?>"
diff --git a/app/views/admission/rule/save.php b/app/views/admission/rule/save.php
index 3611fbc..b8ecdc7 100644
--- a/app/views/admission/rule/save.php
+++ b/app/views/admission/rule/save.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @var AdmissionRule $rule
+ * @var Admission_CoursesetController $controller
+ */
+?>
 <div class="hover_box admissionrule" id="rule_<?= $rule->getId() ?>">
     <div id="rule_data_<?= $rule->getId() ?>" class="col-3" style="margin-top: unset">
         <?= $rule->toString() ?>
diff --git a/app/views/admission/rule/select_type.php b/app/views/admission/rule/select_type.php
index 4bd75e3..6ac53f5 100644
--- a/app/views/admission/rule/select_type.php
+++ b/app/views/admission/rule/select_type.php
@@ -1,3 +1,10 @@
+<?php
+/**
+ * @var AdmissionRule[] $ruleTypes
+ * @var CourseSet $courseset
+ * @var Admission_CoursesetController $controller
+ */
+?>
 <form name="select_rule_type" class="default" action="<?= $controller->url_for('admission/rule/configure') ?>" method="post">
     <fieldset>
         <legend><?= _('Anmelderegel konfigurieren') ?></legend>
diff --git a/app/views/admission/rule/validate.php b/app/views/admission/rule/validate.php
index 58ac715..4311d8d 100644
--- a/app/views/admission/rule/validate.php
+++ b/app/views/admission/rule/validate.php
@@ -1,5 +1,8 @@
 <?php
+/**
+ * @var array $errors
+ */
 if ($errors) {
     echo MessageBox::error(_('Fehler:'), $errors);
 }
-?>
\ No newline at end of file
+?>
diff --git a/app/views/admission/ruleadministration/compatibility.php b/app/views/admission/ruleadministration/compatibility.php
index d272bd0..f953157 100644
--- a/app/views/admission/ruleadministration/compatibility.php
+++ b/app/views/admission/ruleadministration/compatibility.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @var Admission_RuleadministrationController $controller
+ * @var AdmissionRule[] $ruletypes
+ */
+?>
 <form class="default" action="<?= $controller->url_for('admission/ruleadministration/save_compat') ?>" method="post">
     <?= CSRFProtection::tokenTag() ?>
     <table class="default">
diff --git a/app/views/admission/ruleadministration/index.php b/app/views/admission/ruleadministration/index.php
index ca829a8..ef3fa1b 100644
--- a/app/views/admission/ruleadministration/index.php
+++ b/app/views/admission/ruleadministration/index.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @var Admission_RuleadministrationController $controller
+ * @var AdmissionRule[] $ruleTypes
+ */
+?>
 <? if ($ruleTypes) : ?>
     <table class="default" id="admissionrules">
         <caption><?= _('Installierte Anmelderegeln:') ?></caption>
diff --git a/app/views/admission/user_list/configure.php b/app/views/admission/user_list/configure.php
index 9338f45..32e1f42 100644
--- a/app/views/admission/user_list/configure.php
+++ b/app/views/admission/user_list/configure.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * @var Admission_UserListController $controller
+ * @var string $userlist_id
+ * @var AdmissionUserList $userlist
+ * @var string $userSearch
+ * @var array $users
+ */
 use Studip\Button, Studip\LinkButton;
 
 Helpbar::get()->addPlainText(_('Info'), "Personenlisten dienen dazu, um Sonderfälle erfassen zu ".
diff --git a/app/views/admission/user_list/delete.php b/app/views/admission/user_list/delete.php
index 383ceda..b921e9e 100644
--- a/app/views/admission/user_list/delete.php
+++ b/app/views/admission/user_list/delete.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @var AdmissionUserList $userlist
+ * @var Admission_UserListController $controller
+ */
+?>
 <?= QuestionBox::create(
     sprintf(
         _('Soll die Nutzerliste %s wirklich gelöscht werden?'),
diff --git a/app/views/admission/user_list/index.php b/app/views/admission/user_list/index.php
index 30e3f7a..e47a1bc 100644
--- a/app/views/admission/user_list/index.php
+++ b/app/views/admission/user_list/index.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @var AdmissionUserList[] $userlists
+ * @var Admission_UserListController $controller
+ */
 Helpbar::get()->addPlainText(_('Info'),"Personenlisten erfassen eine Menge von Personen, die ".
                                        "mit modifizierten Chancen in die Platzverteilung bei ".
                                        "Anmeldeverfahren eingehen. Dies können z.B. ".
-- 
cgit v1.0