Unalign phpdocs (#5891)

redaxo · Feb 4, 2024 · bc00f63 · bc00f63
1 parent 5291460
commit bc00f63
Show file tree

Hide file tree

Showing 84 changed files with 548 additions and 548 deletions.
diff --git a/redaxo/src/addons/backup/lib/backup.php b/redaxo/src/addons/backup/lib/backup.php
@@ -253,7 +253,7 @@ public static function importFiles($filename)
      * Dieser wird in der Datei $filename gespeichert.
      *
      * @param string $filename
-     * @param string[]  $tables
+     * @param string[] $tables
      *
      * @return bool TRUE wenn ein Dump erstellt wurde, sonst FALSE
      */

diff --git a/redaxo/src/addons/cronjob/lib/form.php b/redaxo/src/addons/cronjob/lib/form.php
@@ -22,7 +22,7 @@ class rex_cronjob_form extends rex_form
      * @param string $fieldset
      * @param string $whereCondition
      * @param 'post'|'get' $method
-     * @param bool   $debug
+     * @param bool $debug
      * @param positive-int $db DB connection ID
      */
     public function __construct($tableName, $fieldset, $whereCondition, $method = 'post', $debug = false, $db = 1)

diff --git a/redaxo/src/addons/cronjob/lib/manager.php b/redaxo/src/addons/cronjob/lib/manager.php
@@ -121,7 +121,7 @@ public function tryExecute($cronjob, $name = '', $params = [], $log = true, $id
     }
 
     /**
-     * @param bool   $success
+     * @param bool $success
      * @param string $message
      * @return void
      */

diff --git a/redaxo/src/addons/install/lib/install.php b/redaxo/src/addons/install/lib/install.php
@@ -10,7 +10,7 @@ class rex_install
      * Installation and Activation needs to be triggered in a separate step.
      *
      * @param non-empty-string $addonKey e.g. "yform"
-     * @param string $version  e.g. "3.2.1"
+     * @param string $version e.g. "3.2.1"
      *
      * @throws rex_exception
      */
@@ -54,7 +54,7 @@ public function downloadAddon(string $addonKey, string $version): void
      * The AddOn is not required to be installed beforehand.
      *
      * @param non-empty-string $addonKey e.g. "yform"
-     * @param string $version  e.g. "3.2.1"
+     * @param string $version e.g. "3.2.1"
      *
      * @throws rex_exception
      */

diff --git a/redaxo/src/addons/install/lib/webservice.php b/redaxo/src/addons/install/lib/webservice.php
@@ -87,7 +87,7 @@ public static function getArchive($url)
     /**
      * POSTs the given data to the redaxo.org webservice.
      *
-     * @param string      $path
+     * @param string $path
      * @param string|null $archive Path to archive
      * @throws rex_functional_exception
      * @return void
@@ -240,7 +240,7 @@ private static function loadCache()
      * Writes the given data into the local cache.
      *
      * @param string $path
-     * @param array  $data
+     * @param array $data
      * @return void
      */
     private static function setCache($path, $data)

diff --git a/redaxo/src/addons/media_manager/lib/managed_media.php b/redaxo/src/addons/media_manager/lib/managed_media.php
@@ -519,7 +519,7 @@ private function prepareHeaders($src = null)
     }
 
     /**
-     * @param string $src             Source content
+     * @param string $src Source content
      * @param string $sourceCachePath
      * @param string $headerCachePath
      * @return void

diff --git a/redaxo/src/addons/media_manager/lib/media_manager.php b/redaxo/src/addons/media_manager/lib/media_manager.php
@@ -539,11 +539,11 @@ public static function getMediaType()
     }
 
     /**
-     * @param string           $type      Media type
-     * @param string|rex_media $file      Media file
-     * @param null|int         $timestamp Last change timestamp of given file, for cache buster parameter
-     *                                    (not nessary when the file is given by a `rex_media` object)
-     * @param bool             $escape
+     * @param string $type Media type
+     * @param string|rex_media $file Media file
+     * @param null|int $timestamp Last change timestamp of given file, for cache buster parameter
+     *                            (not nessary when the file is given by a `rex_media` object)
+     * @param bool $escape
      *
      * @return string
      */

diff --git a/redaxo/src/addons/mediapool/functions/function_rex_mediapool.php b/redaxo/src/addons/mediapool/functions/function_rex_mediapool.php
@@ -9,8 +9,8 @@
 /**
  * Erstellt einen Filename der eindeutig ist für den Medienpool.
  *
- * @param string $mediaName      Dateiname
- * @param bool   $doSubindexing
+ * @param string $mediaName Dateiname
+ * @param bool $doSubindexing
  *
  * @deprecated since 2.11, use `rex_mediapool::filename` instead
  */
@@ -24,11 +24,11 @@ function rex_mediapool_filename($mediaName, $doSubindexing = true): string
  * Dabei wird kontrolliert ob das File schon vorhanden ist und es
  * wird eventuell angepasst, weiterhin werden die Fileinformationen übergeben.
  *
- * @param array  $FILE
- * @param int    $rexFileCategory
- * @param array  $FILEINFOS
+ * @param array $FILE
+ * @param int $rexFileCategory
+ * @param array $FILEINFOS
  * @param string $userlogin
- * @param bool   $doSubindexing
+ * @param bool $doSubindexing
  *
  * @return array
  * @deprecated since 2.11, use `rex_media_service::addMedia` instead
@@ -74,8 +74,8 @@ function rex_mediapool_saveMedia($FILE, $rexFileCategory, $FILEINFOS, $userlogin
  * Dabei wird kontrolliert ob das File schon vorhanden ist und es
  * wird eventuell angepasst, weiterhin werden die Fileinformationen übergeben.
  *
- * @param array  $FILE
- * @param array  $FILEINFOS
+ * @param array $FILE
+ * @param array $FILEINFOS
  * @param string $userlogin
  *
  * @return array
@@ -106,10 +106,10 @@ function rex_mediapool_updateMedia($FILE, &$FILEINFOS, $userlogin = null)
  * Synchronisiert die Datei $physical_filename des Mediafolders in den
  * Medienpool.
  *
- * @param string      $physicalFilename
- * @param int         $categoryId
- * @param string      $title
- * @param null|int    $filesize
+ * @param string $physicalFilename
+ * @param int $categoryId
+ * @param string $title
+ * @param null|int $filesize
  * @param null|string $filetype
  * @param null|string $userlogin
  *
@@ -338,7 +338,7 @@ function rex_mediapool_isAllowedMediaType($filename, array $args = [])
 /**
  * Checks file against optional property `allowed_mime_types`.
  *
- * @param string      $path     Path to the physical file
+ * @param string $path Path to the physical file
  * @param null|string $filename Optional filename, will be used for extracting the file extension.
  *                              If not given, the extension is extracted from `$path`.
  *

diff --git a/redaxo/src/addons/mediapool/lib/mediapool.php b/redaxo/src/addons/mediapool/lib/mediapool.php
@@ -8,8 +8,8 @@ final class rex_mediapool
     /**
      * Erstellt einen Filename der eindeutig ist für den Medienpool.
      *
-     * @param string $mediaName      Dateiname
-     * @param bool   $doSubindexing
+     * @param string $mediaName Dateiname
+     * @param bool $doSubindexing
      */
     public static function filename(string $mediaName, $doSubindexing = true): string
     {
@@ -134,7 +134,7 @@ public static function isAllowedExtension(string $filename, array $args = []): b
     /**
      * Checks file against optional property `allowed_mime_types`.
      *
-     * @param string      $path     Path to the physical file
+     * @param string $path Path to the physical file
      * @param null|string $filename Optional filename, will be used for extracting the file extension.
      *                              If not given, the extension is extracted from `$path`.
      */

diff --git a/redaxo/src/addons/mediapool/lib/service_media_category.php b/redaxo/src/addons/mediapool/lib/service_media_category.php
@@ -6,7 +6,7 @@
 class rex_media_category_service
 {
     /**
-     * @param string                  $name   The name of the new category
+     * @param string $name The name of the new category
      * @param rex_media_category|null $parent The category in which the new category should be created, or null for a top/root level category
      *
      * @return string A success message
@@ -95,8 +95,8 @@ public static function categoryIsInUse($categoryId)
     }
 
     /**
-     * @param int   $categoryId The id of the category to edit
-     * @param array $data       The category data
+     * @param int $categoryId The id of the category to edit
+     * @param array $data The category data
      *
      * @return string A success message
      */

diff --git a/redaxo/src/addons/metainfo/lib/handler/handler.php b/redaxo/src/addons/metainfo/lib/handler/handler.php
@@ -11,7 +11,7 @@ abstract class rex_metainfo_handler
      * Erstellt den nötigen HTML Code um ein Formular zu erweitern.
      *
      * @param rex_sql $sqlFields rex_sql-objekt, dass die zu verarbeitenden Felder enthält
-     * @param array   $epParams  Array of all EP parameters
+     * @param array $epParams Array of all EP parameters
      *
      * @return string
      */
@@ -534,8 +534,8 @@ public function renderMetaFields(rex_sql $sqlFields, array $epParams)
     /**
      * Übernimmt die gePOSTeten werte in ein rex_sql-Objekt.
      *
-     * @param array   $params
-     * @param rex_sql $sqlSave   rex_sql-objekt, in das die aktuellen Werte gespeichert werden sollen
+     * @param array $params
+     * @param rex_sql $sqlSave rex_sql-objekt, in das die aktuellen Werte gespeichert werden sollen
      * @param rex_sql $sqlFields rex_sql-objekt, dass die zu verarbeitenden Felder enthält
      * @return void
      */
@@ -573,8 +573,8 @@ public static function fetchRequestValues(&$params, &$sqlSave, $sqlFields)
     /**
      * Retrieves the posted value for the given field and converts it into a saveable format.
      *
-     * @param string $fieldName       The name of the field
-     * @param int    $fieldType       One of the rex_metainfo_table_manager::FIELD_* constants
+     * @param string $fieldName The name of the field
+     * @param int $fieldType One of the rex_metainfo_table_manager::FIELD_* constants
      * @param string $fieldAttributes The attributes of the field
      *
      * @return string|int|null
@@ -634,7 +634,7 @@ public static function getSaveValue($fieldName, $fieldType, $fieldAttributes)
     /**
      * Ermittelt die metainfo felder mit dem Prefix $prefix limitiert auf die Kategorien $restrictions.
      *
-     * @param string $prefix          Feldprefix
+     * @param string $prefix Feldprefix
      * @param string $filterCondition SQL Where-Bedingung zum einschränken der Metafelder
      *
      * @return rex_sql Metainfofelder
@@ -666,7 +666,7 @@ protected static function getSqlFields($prefix, $filterCondition = '')
      * Erweitert das Meta-Formular um die neuen Meta-Felder.
      *
      * @param string $prefix Feldprefix
-     * @param array  $params EP Params
+     * @param array $params EP Params
      *
      * @return string
      */
@@ -719,12 +719,12 @@ abstract protected function buildFilterCondition(array $params);
     /**
      * Renders a field of the metaform. The rendered html will be returned.
      *
-     * @param string $field     The html-source of the field itself
-     * @param string $tag       The html-tag for the elements container, e.g. "p"
-     * @param string $tagAttr  Attributes for the elements container, e.g. " class='rex-widget'"
-     * @param string $id        The id of the field, used for current label or field-specific javascripts
-     * @param string $label     The textlabel of the field
-     * @param bool   $labelIt   True when an additional label needs to be rendered, otherweise False
+     * @param string $field The html-source of the field itself
+     * @param string $tag The html-tag for the elements container, e.g. "p"
+     * @param string $tagAttr Attributes for the elements container, e.g. " class='rex-widget'"
+     * @param string $id The id of the field, used for current label or field-specific javascripts
+     * @param string $label The textlabel of the field
+     * @param bool $labelIt True when an additional label needs to be rendered, otherweise False
      * @param string $inputType The input type, e.g. "checkbox", "radio",..
      *
      * @return string The rendered html

diff --git a/redaxo/src/addons/structure/functions/function_rex_url.php b/redaxo/src/addons/structure/functions/function_rex_url.php
@@ -10,9 +10,9 @@
  * Gibt eine Url zu einem Artikel zurück.
  *
  * @param int|string|null $id
- * @param int|string|null $clang     SprachId des Artikels
- * @param array           $params    Array von Parametern
- * @param string          $separator
+ * @param int|string|null $clang SprachId des Artikels
+ * @param array $params Array von Parametern
+ * @param string $separator
  *
  * @return string
  *
@@ -58,7 +58,7 @@ function rex_getUrl($id = null, $clang = null, array $params = [], $separator =
  * Leitet auf einen anderen Artikel weiter.
  *
  * @param null|int|string $articleId
- * @param null|int|string $clang      SprachId des Artikels
+ * @param null|int|string $clang SprachId des Artikels
  *
  * @throws InvalidArgumentException
  * @return never

diff --git a/redaxo/src/addons/structure/lib/article.php b/redaxo/src/addons/structure/lib/article.php
@@ -77,7 +77,7 @@ public static function getNotfoundArticle($clang = null)
      * Return a list of top-level articles.
      *
      * @param bool $ignoreOfflines
-     * @param int  $clang
+     * @param int $clang
      *
      * @return self[]
      */

diff --git a/redaxo/src/addons/structure/lib/cache_article.php b/redaxo/src/addons/structure/lib/cache_article.php
@@ -9,7 +9,7 @@ class rex_article_cache
      * Löscht die gecachten Dateien eines Artikels. Wenn keine clang angegeben, wird
      * der Artikel-Cache in allen Sprachen gelöscht.
      *
-     * @param int $id      ArtikelId des Artikels
+     * @param int $id ArtikelId des Artikels
      * @param int $clangId ClangId des Artikels
      *
      * @return bool True on success, False on errro
@@ -38,7 +38,7 @@ public static function delete($id, $clangId = null)
      * Löscht die gecachten Meta-Dateien eines Artikels. Wenn keine clang angegeben, wird
      * der Artikel in allen Sprachen gelöscht.
      *
-     * @param int $id      ArtikelId des Artikels
+     * @param int $id ArtikelId des Artikels
      * @param int $clangId ClangId des Artikels
      *
      * @return bool True on success, False on errro
@@ -69,7 +69,7 @@ public static function deleteMeta($id, $clangId = null)
      * Löscht die gecachten Content-Dateien eines Artikels. Wenn keine clang angegeben, wird
      * der Artikel in allen Sprachen gelöscht.
      *
-     * @param int $id      ArtikelId des Artikels
+     * @param int $id ArtikelId des Artikels
      * @param int $clangId ClangId des Artikels
      *
      * @return bool True on success, False on errro
@@ -123,7 +123,7 @@ public static function deleteLists($id)
      * Generiert den Artikel-Cache der Metainformationen.
      *
      * @param int $articleId Id des zu generierenden Artikels
-     * @param int $clangId    ClangId des Artikels
+     * @param int $clangId ClangId des Artikels
      *
      * @return bool|string TRUE bei Erfolg, FALSE wenn eine ungütlige article_id übergeben wird, sonst eine Fehlermeldung
      */

diff --git a/redaxo/src/addons/structure/lib/category.php b/redaxo/src/addons/structure/lib/category.php
@@ -31,7 +31,7 @@ public static function getCurrent($clang = null)
      * excempt from this list!
      *
      * @param bool $ignoreOfflines
-     * @param int  $clang
+     * @param int $clang
      *
      * @return self[]
      */

diff --git a/redaxo/src/addons/structure/lib/linkmap/renderer.php b/redaxo/src/addons/structure/lib/linkmap/renderer.php
@@ -39,8 +39,8 @@ public function getTree($categoryId)
     /**
      * Returns the markup of a tree structure, with $children as root categories and respecing $activeTreeIds as the active path.
      *
-     * @param rex_category[] $children      A array of rex_category objects representing the top level objects
-     * @param int[]          $activeTreeIds
+     * @param rex_category[] $children A array of rex_category objects representing the top level objects
+     * @param int[] $activeTreeIds
      *
      * @return string the rendered markup
      */

diff --git a/redaxo/src/addons/structure/lib/navigation.php b/redaxo/src/addons/structure/lib/navigation.php
@@ -80,9 +80,9 @@ public static function factory()
     /**
      * Generiert eine Navigation.
      *
-     * @param int  $categoryId     Id der Wurzelkategorie
-     * @param int  $depth           Anzahl der Ebenen die angezeigt werden sollen
-     * @param bool $open            True, wenn nur Elemente der aktiven Kategorie angezeigt werden sollen, sonst FALSE
+     * @param int $categoryId Id der Wurzelkategorie
+     * @param int $depth Anzahl der Ebenen die angezeigt werden sollen
+     * @param bool $open True, wenn nur Elemente der aktiven Kategorie angezeigt werden sollen, sonst FALSE
      * @param bool $ignoreOfflines FALSE, wenn offline Elemente angezeigt werden, sonst TRUE
      *
      * @return string
@@ -120,8 +120,8 @@ public function show($categoryId = 0, $depth = 3, $open = false, $ignoreOfflines
      * Generiert eine Breadcrumb-Navigation.
      *
      * @param string|false $startPageLabel Label der Startseite, falls FALSE keine Start-Page anzeigen
-     * @param bool   $includeCurrent True wenn der aktuelle Artikel enthalten sein soll, sonst FALSE
-     * @param int    $categoryId    Id der Wurzelkategorie
+     * @param bool $includeCurrent True wenn der aktuelle Artikel enthalten sein soll, sonst FALSE
+     * @param int $categoryId Id der Wurzelkategorie
      *
      * @return string
      */
@@ -225,10 +225,10 @@ public function setLinkClasses($classes)
     /**
      * Fügt einen Filter hinzu.
      *
-     * @param string     $metafield Datenbankfeld der Kategorie
-     * @param int|string $value    Wert für den Vergleich
-     * @param string     $type     art des Vergleichs =/</
-     * @param int|''     $depth    "" wenn auf allen Ebenen, wenn definiert, dann wird der Filter nur auf dieser Ebene angewendet
+     * @param string $metafield Datenbankfeld der Kategorie
+     * @param int|string $value Wert für den Vergleich
+     * @param string $type art des Vergleichs =/</
+     * @param int|'' $depth "" wenn auf allen Ebenen, wenn definiert, dann wird der Filter nur auf dieser Ebene angewendet
      * @return void
      */
     public function addFilter($metafield = 'id', $value = '1', $type = '=', $depth = '')
@@ -240,7 +240,7 @@ public function addFilter($metafield = 'id', $value = '1', $type = '=', $depth =
      * Fügt einen Callback hinzu.
      *
      * @param callable(rex_category,int,array<int|string, int|string|list<string>>,array<int|string, int|string|list<string>>,string):bool $callback z.B. myFunc oder myClass::myMethod
-     * @param int|''  $depth    "" wenn auf allen Ebenen, wenn definiert, dann wird der Filter nur auf dieser Ebene angewendet
+     * @param int|'' $depth "" wenn auf allen Ebenen, wenn definiert, dann wird der Filter nur auf dieser Ebene angewendet
      *
      * @return $this
      */