add docblocks, closes #1649

Closes #1649

Merge request studip/studip!1060

app/views/activityfeed/configuration.php

+<?php
+/**
+ * @var ActivityfeedController $controller
+ * @var array $modules
+ * @var array $context_translations
+ */
+?>
 <div id="activityEdit">
     <form id="configure_activity" action="<?= $controller->link_for('activityfeed/save') ?>" method="post" class="default" data-dialog>
         <h1><?= _("Anzuzeigende Bereiche:") ?></h1>

app/views/start/_widget.php

+<?php
+/**
+ * @var StartController $controller
+ * @var StudIPPlugin $widget
+ * @var string $admin_title
+ * @var string $content_for_layout
+ * @var Navigation[]|null $icons
+ * @var string|null $admin_url
+ */
+?>
 <div class="ui-widget_head widget-header" id="widget-<?= $widget->widget_id ?>">
     <span class="header-options">
         <? if (isset($icons)): ?>
@@ -18,16 +28,16 @@
 
         <? if (isset($admin_url)): ?>
             <a href="<?= URLHelper::getLink($admin_url) ?>">
-                <?= Icon::create('admin', 'clickable', ['title' => $admin_title])->asImg() ?>
+                <?= Icon::create('admin', Icon::ROLE_CLICKABLE, ['title' => htmlReady($admin_title)]) ?>
             </a>
         <? endif ?>
 
         <a href="<?= $controller->url_for('start/delete/' . $widget->widget_id) ?>">
-            <?= Icon::create('decline', 'clickable', ['title' => _('Entfernen')])->asImg() ?>
+            <?= Icon::create('decline', Icon::ROLE_CLICKABLE, ['title' => _('Entfernen')]) ?>
         </a>
     </span>
     <span id="widgetName<?= $widget->widget_id ?>" class="widget-title">
-        <?= htmlReady(isset($title) ? $title : $widget->getPluginName()) ?>
+        <?= htmlReady($title ?? $widget->getPluginName()) ?>
     </span>
 </div>
 <div id="wid<?=$widget->widget_id?>">

app/views/start/add.php

+<?php
+/**
+ * @var StartController $controller
+ * @var StudIPPlugin[] $widgets
+ */
+?>
 <form action="<?= $controller->url_for('start/add') ?>" method="post" class="default">
     <input type="hidden" name="studip_ticket" value="<?= get_ticket() ?>">
     <input type="hidden" name="position" value="0">

app/views/start/edit_defaults.php

+<?php
+/**
+ * @var array $initial_widgets
+ * @var StudIPPlugin[] $widgets
+ * @var bool $restricted
+ * @var string $permission
+ */
+?>
 <div class="edit-widgetcontainer">
     <div class="start-widgetcontainer">
         <ul class="portal-widget-list">
@@ -55,4 +63,4 @@
         STUDIP.startpage.init_edit('<?= $permission ?>');
     })
 }(jQuery));
-</script>
\ No newline at end of file
+</script>

app/views/start/edit_mail_address.php

+<?php
+/**
+ * @var StartController $controller
+ * @var string $email
+ * @var bool $restricted
+ */
+?>
 <form method="post" class="default" action="<?=$controller->url_for('start/change_mail_address')?>" data-dialog="size=auto">
     <?= CSRFProtection::tokenTag()?>
     <fieldset>

app/views/start/index.php

+<?php
+/**
+ * @var array $left
+ * @var array $right
+ */
+?>
 <h1 class="sr-only">
     <? if ($GLOBALS['perm']->have_perm('root')) :?>
         <?= _("Startseite für Root bei Stud.IP")?>

app/views/study_area/tree.php

+<?php
+/**
+ * @var StudipStudyArea $node
+ * @var string $open
+ * @var int $layer
+ * @var array $dont_open
+ * @var string $compulsory
+ */
+?>
 <li>
 <? if ($node->id !== 'root' && $node->required_children): ?>
     <input id='<?= htmlReady($node->id) ?>' type='checkbox' <?= $open && !in_array($layer, $dont_open) ? 'checked' : ''?>>
@@ -15,8 +24,8 @@
 <? if ($node->required_children): ?>
     <ul>
     <? foreach ($node->required_children as $child): ?>
-        <?= $this->render_partial('study_area/tree.php', ['node' => $child, 'open' => $open, 'layer' => $layer + 1]) ?>
+        <?= $this->render_partial('study_area/tree.php', ['node' => $child, 'open' => $open, 'layer' => ((int)$layer + 1)]) ?>
     <? endforeach; ?>
     </ul>
 <? endif; ?>
-</li>
\ No newline at end of file
+</li>

app/views/studygroup/browse.php

+<?php
+/**
+ * @var StudygroupController $controller
+ * @var int $anzahl
+ * @var string $sort_type
+ * @var string $sort_order
+ * @var string $q
+ * @var string $closed
+ * @var array $groups
+ * @var User $user
+ * @var int $entries_per_page
+ * @var int $page
+ * @var string $sort
+ */
+?>
+
 <?= $this->render_partial("course/studygroup/_feedback") ?>
 
 <?php
@@ -51,7 +67,7 @@ $headers = [
                             <?= htmlready($group['Name']) ?>
                             <?= $group['visible'] ? '' : "[" . _('versteckt') . "]" ?>
                             <? if ($group['admission_prelim'] == 1) { ?>
-                                <?= Icon::create('lock-locked', 'inactive', ['title' => _('Mitgliedschaft muss beantragt werden')]) ?>
+                                <?= Icon::create('lock-locked', Icon::ROLE_INACTIVE, ['title' => _('Mitgliedschaft muss beantragt werden')]) ?>
                             <? } ?>
                         </a>
                 </td>
@@ -74,7 +90,7 @@ $headers = [
                 </td>
                 <td align="center">
                     <? if ($is_member) : ?>
-                        <?= Icon::create('person', 'inactive', ['title' => _('Sie sind Mitglied in dieser Gruppe')])->asImg() ?>
+                        <?= Icon::create('person', Icon::ROLE_INACTIVE, ['title' => _('Sie sind Mitglied in dieser Gruppe')])->asImg() ?>
                     <? endif; ?>
                 </td>
             </tr>

app/views/terms/index.php

+<?php
+/**
+ * @var TermsController $controller
+ * @var string $return_to
+ * @var string $redirect_token
+ * @var string $denial_message
+ * @var string $compulsory
+ */
+?>
 <form action="<?= $controller->link_for('terms', compact('return_to', 'redirect_token')) ?>" method="post">
     <?= CSRFProtection::tokenTag()?>
     <? if ($denial_message): ?>

app/views/tfa/index.php

+<?php
+/**
+ * @var TFASecret $secret
+ * @var TfaController $controller
+ */
+?>
 <p>
     <?= _('Zwei-Faktor-Authentifizierung ist aktiviert') ?>:
     <?= $secret->type == 'app' ? _('Authenticator-App') : _('E-Mail') ?>

app/views/tfa/setup.php

+<?php
+/**
+ * @var TfaController $controller
+ */
+?>
 <form class="default" action="<?= $controller->create() ?>" method="post">
     <?= CSRFProtection::tokenTag() ?>
 

app/views/tour/admin_conflicts.php

-<? use Studip\LinkButton; ?>
+<?php
+/**
+ * @var TourController $controller
+ * @var array $conflicts
+ * @var array $diff_fields
+ * @var array $diff_step_fields
+ */
 
+use Studip\LinkButton;
+?>
 <h1><?= _('Versions-Konflikte der Touren') ?></h1>
 <form action="<?= $controller->url_for('tour/admin_conflicts') ?>" id="admin_tour_form" method="post">
     <?= CSRFProtection::tokenTag(); ?>

app/views/tour/admin_details.php

-<? use Studip\Button, Studip\LinkButton; ?>
+<?php
+/**
+ * @var string $delete_question
+ * @var TourController $controller
+ * @var HelpTour $tour
+ * @var HelpTourAudience $audience
+ * @var string $tour_startpage
+ * @var string $tour_id
+ */
+
+use Studip\Button, Studip\LinkButton;
+?>
+
 <?= $delete_question ?>
 
 <form class="default" action="<?= $controller->url_for('tour/save/' . $tour->tour_id) ?>" method="post">
@@ -182,7 +194,7 @@ if (count($tour->steps)) {
     $widget->addLink(
         _('Schritt hinzufügen'),
         $controller->url_for('tour/edit_step/' . $tour->tour_id . '/' . (count($tour->steps) + 1) . '/new'),
-        Icon::create('add', 'clickable'),
+        Icon::create('add'),
         ['data-dialog' => 'size=auto;reload-on-close']
     );
     $sidebar->addWidget($widget);

app/views/tour/admin_overview.php

-<? use Studip\Button, Studip\LinkButton; ?>
+<?php
+/**
+ * @var string $delete_question
+ * @var TourController $controller
+ * @var string $tour_searchterm
+ * @var string $filter_text
+ * @var HelpTour[] $tours
+ */
+
+use Studip\Button;
+?>
 <?= $delete_question ?>
 
 <form action="<?= $controller->url_for('tour/admin_overview') ?>" id="admin_tour_form" method="post" class="default">

app/views/tour/edit_step.php

-<? use Studip\Button, Studip\LinkButton; ?>
+<?php
+/**
+ * @var TourController $controller
+ * @var string $tour_id
+ * @var HelpTourStep $step
+ * @var string $mode
+ * @var string $force_route
+ * @var bool $via_ajax
+ */
+
+use Studip\Button, Studip\LinkButton;
+?>
 
 <div id="edit_tour_step" class="edit_tour_step">
-    <? if (Request::isXhr()) : ?>
-        <? foreach (PageLayout::getMessages() as $msg) : ?>
-            <?= $msg ?>
-        <? endforeach ?>
-    <? endif ?>
     <form id="edit_tour_form" class="default"
           action="<?= $controller->url_for('tour/edit_step/' . $tour_id . '/' . $step->step . '/save') ?>"
           method="post">
         <?= CSRFProtection::tokenTag(); ?>
         <fieldset>
             <input type="hidden" name="tour_step_nr" value="<?= $step->step ?>">
-            <input type="hidden" name="tour_step_editmode" value="<?= $mode ?>">
+            <input type="hidden" name="tour_step_editmode" value="<?= htmlReady($mode) ?>">
             <legend><?= sprintf(_('Schritt %s'), $step->step) ?></legend>
             <label>
                 <?= _('Titel') ?>

app/views/tour/import.php

-<? use Studip\Button, Studip\LinkButton; ?>
+<?php
+/**
+ * @var TourController $controller
+ * @var array $tourdata
+ * @var array $metadata
+ */
+?>
 <form class="default" enctype="multipart/form-data" action="<?= $controller->link_for('tour/import') ?>" method="post">
     <?= CSRFProtection::tokenTag(); ?>
 

app/views/web_migrate/index.php

+<?php
+/**
+ * @var Migration[] $migrations
+ * @var WebMigrateController $controller
+ * @var string $target
+ * @var string $branch
+ * @var Migrator $migrator
+ * @var int $offset
+ * @var array $backlinks
+ * @var array $descendants
+ */
+?>
 <? if (count($migrations) === 0): ?>
     <?= MessageBox::info(_('Ihr System befindet sich auf dem aktuellen Stand.'))->hideClose() ?>
 <? else: ?>

app/views/wiki/change_courseperms.php

+<?php
+/**
+ * @var WikiController $controller
+ * @var bool $restricted
+ * @var string $keyword
+ */
+?>
 <form action="<?= $controller->link_for('wiki/store_courseperms', compact('keyword')) ?>" method="post" class="default">
     <?= CSRFProtection::tokenTag() ?>
 

app/views/wiki/change_page_config.php

+<?php
+/**
+ * @var WikiController $controller
+ * @var WikiPageConfig $config
+ * @var array $validKeywords
+ * @var string $keyword
+ */
+?>
 <form action="<?= $controller->link_for('wiki/store_page_config', compact('keyword')) ?>" method="post" class="default" id="wiki-config">
     <?= CSRFProtection::tokenTag() ?>
 

app/views/wiki/create.php

+<?php
+/**
+ * @var string $keyword
+ * @var string[] $wiki_page_names
+ */
+?>
 <p>
     <?= _('Hier können Sie eine neue Wiki-Seite erstellen.') ?>
     <br />