add docblocks, closes #1653

Closes #1653

Merge request studip/studip!1064

app/controllers/admin/specification.php

@@ -47,7 +47,7 @@ class Admin_SpecificationController extends AuthenticatedController
     /**
      * Edit or create a rule
      *
-     * @param md5 $edit_id
+     * @param string $edit_id
      */
     public function edit_action($id = null)
     {
@@ -108,7 +108,7 @@ class Admin_SpecificationController extends AuthenticatedController
     /**
      * Delete a rule, using a modal dialog
      *
-     * @param md5 $rule_id
+     * @param string $rule_id
      */
     public function delete_action($rule_id)
     {

app/views/admin/additional/index.php

+<?php
+/**
+ * @var Course $course
+ * @var AuxLockRule[] $list
+ * @var int $count
+ * @var array $config
+ */
+?>
 <? if ($list): ?>
     <form class='default' method='post'>
         <fieldset>
@@ -34,5 +42,5 @@
         </footer>
     </form>
 <? else: ?>
-    <? _('Keine Zusatzangaben vorhanden') ?>
+    <?= _('Keine Zusatzangaben vorhanden') ?>
 <? endif; ?>

app/views/admin/api/config.php

-<? use Studip\Button, Studip\LinkButton; ?>
+<?php
+/**
+ * @var Admin_ApiController $controller
+ * @var array $config
+ */
+use Studip\Button, Studip\LinkButton;
+?>
 
 <form class="default" action="<?= $controller->url_for('admin/api/config') ?>" method="post">
     <fieldset>

app/views/admin/api/edit.php

-<? use Studip\Button, Studip\LinkButton; ?>
+<?php
+/**
+ * @var Admin_ApiController $controller
+ * @var RESTAPI\Consumer\Base $consumer
+ * @var array $types
+ */
+use Studip\Button, Studip\LinkButton;
+?>
 
 <? if ($consumer->id): ?>
     <h1>

app/views/admin/api/index.php

+<?php
+/**
+ * @var Admin_ApiController $controller
+ * @var RESTAPI\Consumer\Base[] $consumers
+ * @var array $types
+ */
+?>
 <? if (!empty($consumers)): ?>
 <form action="#" method="post" class="default">
 <table class="default">

app/views/admin/api/permissions.php

+<?php
+/**
+ * @var Admin_ApiController $controller
+ * @var RESTAPI\ConsumerPermissions $permissions
+ * @var string $consumer_id
+ * @var array $routes
+ * @var bool $global
+ */
+?>
 <form action="<?= $controller->url_for('admin/api/permissions', $consumer_id) ?>" method="post" class="default">
 <table class="default">
     <thead>

app/views/admin/autoinsert/_search.php

+<?php
+/**
+ * @var string $sem_select
+ * @var string $sem_search
+ */
+?>
 <fieldset>
     <legend>
         <?= _('Suche nach Veranstaltungen')?>

app/views/admin/autoinsert/_status.php

+<?php
+/**
+ * @var Admin_AutoinsertController $controller
+ * @var array $domains
+ * @var array $auto_sems
+ * @var string $status
+ */
+?>
 <td>
     <? foreach ($domains as $domain) : ?>
         <div>

app/views/admin/autoinsert/index.php

-<?
-# Lifter010: TODO
-use Studip\Button, Studip\LinkButton;
-
+<?php
+/**
+ * @var Admin_AutoinsertController $controller
+ * @var array $seminar_search
+ * @var array $userdomains
+ */
 ?>
 <? if (isset($flash['delete'])): ?>
     <?= (string)QuestionBox::create(

app/views/admin/autoinsert/manual.php

+<?php
+/**
+ * @var Admin_AutoinsertController $controller
+ * @var string $sem_search
+ * @var string $sem_select
+ * @var array $seminar_search
+ * @var array $filtertype
+ * @var string $sem_id
+ * @var array $available_filtertypes
+ * @var array $values
+ * @var array $filter
+ */
+?>
+
 <style type="text/css">
     .filter_selection select {
         width: 100%;
@@ -14,7 +28,7 @@
 </form>
 
 
-<? if ($seminar_search > 0 && $sem_search && $sem_select): ?>
+<? if ((is_array($seminar_search) && count($seminar_search) > 0) && $sem_search && $sem_select): ?>
     <form class="default" action="<?= $controller->manual() ?>" method="post">
         <?= CSRFProtection::tokenTag() ?>
         <input type="hidden" name="sem_search" value="<?= htmlReady($sem_search) ?>">

app/views/admin/banner/edit.php

-<? use Studip\Button, Studip\LinkButton; ?>
+<?php
+/**
+ * @var Admin_BannerController $controller
+ * @var Banner $banner
+ * @var array $target_types
+ * @var Course $seminar
+ * @var Institute $institut
+ * @var User $user
+ * @var array $priorities
+ * @var array $assigned
+ * @var array $rolesStats
+ * @var Role $roles
+ */
+?>
 <form action="<?= $controller->url_for('admin/banner/edit', $banner->id) ?>" method="post" enctype="multipart/form-data" class="default">
     <?= CSRFProtection::tokenTag() ?>
 
@@ -20,13 +33,13 @@
 
         <label>
             <?= _('Beschreibung:') ?>
-            <input type="text" id="description" name="description" value="<?= htmlReady($banner['description']) ?>" size="40" maxlen="254">
+            <input type="text" id="description" name="description" value="<?= htmlReady($banner['description']) ?>" size="40" maxlength="254">
         </label>
 
         <label>
             <?= _('Alternativtext:') ?>
 
-            <input type="text" id="alttext" name="alttext" value="<?= htmlReady($banner['alttext']) ?>" size="40" maxlen="254">
+            <input type="text" id="alttext" name="alttext" value="<?= htmlReady($banner['alttext']) ?>" size="40" maxlength="254">
         </label>
 
         <label>
@@ -147,4 +160,4 @@
             }).change();
         });
     </script>
-<? endif; ?>
\ No newline at end of file
+<? endif; ?>

app/views/admin/banner/index.php

+<?php
+/**
+ * @var Admin_BannerController $controller
+ * @var Banner[] $banners
+ */
+?>
 <? if (isset($flash['delete'])): ?>
     <?= QuestionBox::create(
         _('Wollen Sie das Banner wirklich löschen?'),
@@ -22,6 +28,10 @@
     </thead>
     <tbody>
     <? foreach ($banners as $banner): ?>
+        <?
+            $object_name_sem = get_object_name($banner->target, 'sem');
+            $object_name_inst = get_object_name($banner->target, 'inst');
+        ?>
         <tr id="banner-<?= htmlReady($banner->id) ?>">
             <td style="text-align: center;">
                 <?= $banner->toImg(['style' => 'max-width: 80px']) ?>
@@ -30,9 +40,9 @@
             <td><?= htmlReady($banner->target_type) ?></td>
             <td>
             <? if ($banner['target_type'] === 'seminar'): ?>
-                <?= mila(reset(get_object_name($banner->target, 'sem')), 30) ?>
+                <?= mila(reset($object_name_sem), 30) ?>
             <? elseif ($banner['target_type'] === 'inst') :?>
-                <?= mila(reset(get_object_name($banner->target, 'inst')), 30) ?>
+                <?= mila(reset($object_name_inst), 30) ?>
             <? else: ?>
                 <?= htmlReady($banner->target) ?>
             <? endif; ?>

app/views/admin/banner/info.php

+<?php
+/**
+ * @var Admin_BannerController $controller
+ * @var array $banner
+ * @var array $target_types
+ * @var array $priorities
+ * @var array $assigned
+ */
+?>
 <table class="default">
     <tbody>
         <tr>
@@ -14,7 +23,7 @@
             <td>
                 <input type="text" readonly
                        value="<?= htmlReady($banner['description']) ?>"
-                       size="40" maxlen="254">
+                       size="40" maxlength="254">
             </td>
         </tr>
         <tr>
@@ -22,7 +31,7 @@
             <td>
                 <input type="text" readonly
                        value="<?= htmlReady($banner['alttext']) ?>"
-                       size="40" maxlen="254">
+                       size="40" maxlength="254">
             </td>
         </tr>
         <tr>
@@ -42,7 +51,7 @@
             <td>
                 <input type="text" readonly
                        value="<?= htmlReady($banner['target']) ?>"
-                       size="40" maxlen="254" disabled>
+                       size="40" maxlength="254" disabled>
             </td>
         </tr>
         <tr>
@@ -86,4 +95,3 @@
         </tr>
     </tbody>
 </table>
-

app/views/admin/cache/_stats_entry.php

-<? if (is_array($entry)) : ?>
+<?php
+/**
+ * @var array $entry
+ */
+?><? if (is_array($entry)) : ?>
     <dl class="default">
         <? foreach ($entry as $index => $data) : ?>
             <dt><?= htmlReady($index) ?></dt>

app/views/admin/cache/settings.php

+<?php
+/**
+ * @var boolean $enabled
+ * @var array $types
+ * @var array $config
+ * @var string $cache
+ */
+?>
 <? if ($enabled) : ?>
     <div id="cache-admin-container">
         <cache-administration :cache-types='<?= htmlReady(json_encode($types)) ?>' current-cache="<?= htmlReady($cache) ?>"

app/views/admin/cache/stats.php

+<?php
+/**
+* @var array $stats
+ */
+?>
 <section class="contentbox">
     <header>
         <h1><?= _('Cache-Statistiken') ?></h1>

app/views/admin/configuration/configuration.php

+<?php
+/**
+ * @var string $needle
+ * @var array $sections
+ * @var array $open_section
+ * @var array $only_section
+ */
+?>
 <section class="contentbox">
     <header>
         <h1>

app/views/admin/configuration/edit_configuration.php

+<?php
+/**
+ * @var Admin_ConfigurationController $controller
+ * @var array $config
+ * @var array $allconfigs
+ */
+?>
 <form action="<?= $controller->link_for('admin/configuration/edit_configuration', ['field' => $config['field']]) ?>"
       method="post" data-dialog="size=auto" class="default">
     <?= CSRFProtection::tokenTag() ?>

app/views/admin/configuration/edit_range_config.php

+<?php
+/**
+ * @var Admin_ConfigurationController $controller
+ * @var string $range_type
+ * @var string $field
+ * @var User|Institute|Course $range
+ * @var array $config
+ */
+?>
 <form action="<?= $controller->link_for("admin/configuration/edit_{$range_type}_config", $range, compact('field')) ?>"
       method="post" data-dialo="size=auto" class="default">
     <?= CSRFProtection::tokenTag() ?>

app/views/admin/configuration/range_configuration.php

+<?php
+/**
+ * @var string $title
+ * @var array $configs
+ */
+?>
 <table class="default">
     <caption>
         <?= htmlReady($title) ?>