Dev: PHPDoc fixes for Psalm and plugin dev

LimeSurvey · Apr 17, 2018 · ec5ae2b · ec5ae2b
1 parent efcd266
commit ec5ae2b
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/application/helpers/common_helper.php b/application/helpers/common_helper.php
@@ -20,7 +20,7 @@
  * @param string $sToTranslate
  * @param string $sEscapeMode Valid values are html (this is the default, js and unescaped)
  * @param string $sLanguage
- * @return mixed|string
+ * @return string
  */
 function gT($sToTranslate, $sEscapeMode = 'html', $sLanguage = null)
 {
@@ -31,6 +31,7 @@ function gT($sToTranslate, $sEscapeMode = 'html', $sLanguage = null)
  * Translation helper function which outputs right away.
  * @param string $sToTranslate
  * @param string $sEscapeMode
+ * @return void
  */
 function eT($sToTranslate, $sEscapeMode = 'html')
 {

diff --git a/application/libraries/PluginManager/PluginBase.php b/application/libraries/PluginManager/PluginBase.php
@@ -241,7 +241,8 @@ protected function registerSetting($name, $options = array('type' => 'string'))
 
     /**
      *
-     * @param type $settings
+     * @param array<string, mixed> $settings
+     * @return void
      */
     public function saveSettings($settings)
     {

diff --git a/application/libraries/PluginManager/PluginEvent.php b/application/libraries/PluginManager/PluginEvent.php
@@ -198,7 +198,7 @@ public function append($key, array $value)
     /**
      * Set content for $plugin, replacing any preexisting content
      * 
-     * @param string $plugin The plugin setting the context or a string name
+     * @param string|PluginBase $plugin The plugin setting the context or a string name
      * @param string $content
      * @param string $cssClass
      * @param string $id

diff --git a/application/libraries/PluginManager/iPlugin.php b/application/libraries/PluginManager/iPlugin.php
@@ -56,7 +56,7 @@ public function getStore();
      * 
      * Assumes an array with valid key/value pairs is passed.
      * 
-     * @param array $aSettings An array with key/value pairs for all plugin settings
+     * @param array<string, mixed> $aSettings An array with key/value pairs for all plugin settings
      */
     public function saveSettings($aSettings);