Scrutinizer Auto-Fixes

This commit consists of patches automatically generated for this project on https://scrutinizer-ci.com

application/commands/InstallCommand.php

@@ -136,7 +136,7 @@ function _executeSQLFile($sFileName)
         /**
          * @param string $sProperty
          * @param string $connectionString
-         * @return null
+         * @return string|null
          */
         function getDBConnectionStringProperty($sProperty, $connectionString = null)
         {

application/controllers/SurveyController.php

@@ -97,7 +97,7 @@ public function actions()
     /**
      * Show a message and exit
      * @param string $sType : type of message
-     * @param string[] $aMessage :  array of message line to be shown
+     * @param string[] $aMessages :  array of message line to be shown
      * @param string[]|null : $aUrl : if url can/must be set
      * @param string[]|null $aErrors : array of errors to be shown
      * @return void

application/controllers/admin/SurveymenuController.php

@@ -4,7 +4,7 @@ class SurveymenuController extends Survey_Common_Action
 {
 
 	/**
-	 * @return array action filters
+	 * @return string[] action filters
 	 */
 	public function filters()
 	{
@@ -203,7 +203,6 @@ public function massDelete()
 	/**
 	 * Deletes a particular model.
 	 * If deletion is successful, the browser will be redirected to the 'admin' page.
-	 * @param integer $id the ID of the model to be deleted
 	 */
 	public function delete()
 	{

application/controllers/admin/SurveymenuEntryController.php

@@ -3,7 +3,7 @@
 class SurveymenuEntryController extends Survey_Common_Action
 {
 	/**
-	 * @return array action filters
+	 * @return string[] action filters
 	 */
 	public function filters()
 	{
@@ -270,7 +270,6 @@ public function massDelete()
 	/**
 	 * Deletes a particular model.
 	 * If deletion is successful, the browser will be redirected to the 'admin' page.
-	 * @param integer $id the ID of the model to be deleted
 	 */
 	public function delete()
 	{

application/controllers/admin/database.php

@@ -135,7 +135,7 @@ public function index($sa = null)
     * This is a convenience function to update/delete answer default values. If the given
     * $defaultvalue is empty then the entry is removed from table defaultvalues
     *
-    * @param mixed $qid   Question ID
+    * @param integer $qid   Question ID
     * @param integer $scale_id  Scale ID
     * @param string $specialtype  Special type (i.e. for  'Other')
     * @param mixed $language     Language (defaults are language specific)

application/controllers/admin/limereplacementfields.php

@@ -56,6 +56,7 @@ public function index()
     /**
      * @param integer $gid
      * @param integer $qid
+     * @param string $surveyformat
      * @return array
      */
     private function _getQuestionList($action, $gid, $qid, array $fieldmap, $questionType, $surveyformat)

application/controllers/admin/printablesurvey.php

@@ -1612,6 +1612,7 @@ function index($surveyid, $lang = null)
      *
      * How:
      * @param string $template
+     * @param TemplateConfiguration $oTemplate
      */
     private function _populate_template( $oTemplate, $template , $input  , $line = '')
     {

application/controllers/admin/templateoptions.php

@@ -19,6 +19,9 @@
 class templateoptions  extends Survey_Common_Action
 {
 
+    /**
+     * @param string $controller
+     */
     public function __construct($controller=null, $id=null)
     {
         parent::__construct($controller, $id);
@@ -93,7 +96,7 @@ public function update($id)
     /**
      * Updates a particular model.
      * If update is successful, the browser will be redirected to the 'view' page.
-     * @param integer $id the ID of the model to be updated
+     * @param integer $sid the ID of the model to be updated
      */
     public function updatesurvey($sid)
     {

application/core/LSYii_Application.php

@@ -193,7 +193,7 @@ public function loadConfig($file)
     * @access public
     * @param string $name
     * @param boolean|mixed $default Value to return when not found, default is false
-    * @return mixed
+    * @return string
     */
     public function getConfig($name, $default = false)
     {

application/core/LSYii_ClientScript.php

@@ -152,6 +152,7 @@ public function registerPackage($name)
     /**
      * Return a list of all the recursive dependencies of a packages
      * eg: If a package A depends on B, and B depends on C, getRecursiveDependencies('A') will return {B,C}
+     * @param string $sPackageName
      */
     public function getRecursiveDependencies($sPackageName)
     {

application/core/LSYii_Validators.php

@@ -80,7 +80,7 @@ protected function validateAttribute($object,$attribute)
      * Did we need to do if user don't use inline HTML editor ?
      *
      * @param string $value
-     * @return mixed|string
+     * @return string
      */
     public function fixCKeditor($value)
     {

application/core/LS_Twig_Extension.php

@@ -208,6 +208,9 @@ public static function renderCaptcha()
         ));
     }
 
+    /**
+     * @param string $sRessource
+     */
     public static function assetPublish($sRessource)
     {
         return App()->getAssetManager()->publish($sRessource);
@@ -233,6 +236,9 @@ public static function image($sImagePath, $alt='', $htmlOptions=array ( ) )
         return CHtml::image($sUrlImgAsset, $alt, $htmlOptions);
     }
 
+    /**
+     * @param string $sRessource
+     */
     public static function getTemplateForRessource($sRessource)
     {
         $oRTemplate = Template::model()->getInstance();
@@ -265,11 +271,17 @@ public static function getQuery($sName, $sDefaultValue=null)
         return Yii::app()->request->getQuery($sName, $sDefaultValue);
     }
 
+    /**
+     * @param string $name
+     */
     public static function unregisterPackage($name)
     {
         return Yii::app()->getClientScript()->unregisterPackage($name);
     }
 
+    /**
+     * @param string $name
+     */
     public static function unregisterScriptFile($name)
     {
         return Yii::app()->getClientScript()->unregisterScriptFile($name);

application/core/plugins/AuthLDAP/AuthLDAP.php

@@ -161,7 +161,7 @@ public function createNewUser()
      * Create a LDAP user
      *
      * @param string $new_user
-     * @return null|string New user ID
+     * @return null|integer New user ID
      */
     private function _createNewUser($new_user)
     {

application/helpers/admin/ajax_helper.php

@@ -82,6 +82,7 @@ public static function outputNotLoggedIn()
     }
 
     /**
+     * @param string $target
      * @return void
      */
     public static function outputHtml($html, $target)

application/helpers/common_helper.php

@@ -41,7 +41,7 @@ function eT($sToTranslate, $sEscapeMode = 'html', $sLanguage = NULL)
  * @param string $sTextToTranslate
  * @param integer $iCount
  * @param string $sEscapeMode
- * @return mixed|string
+ * @return string
  */
 function ngT($sTextToTranslate, $iCount, $sEscapeMode = 'html')
 {
@@ -1106,6 +1106,11 @@ function groupOrderThenQuestionOrder($a, $b)
 
 
 //FIXME insert UestionGroup model to here
+/**
+ * @param integer $sid
+ * @param integer $gid
+ * @param integer $shiftvalue
+ */
 function shiftOrderQuestions($sid,$gid,$shiftvalue) //Function shifts the sortorder for questions
 {
     $sid=sanitize_int($sid);
@@ -1125,6 +1130,8 @@ function fixSortOrderGroups($surveyid) //Function rewrites the sortorder for gro
 
 /**
  * @param integer $iSurveyID
+ * @param integer $qid
+ * @param integer $newgid
  */
 function fixMovedQuestionConditions($qid,$oldgid,$newgid, $iSurveyID=NULL) //Function rewrites the cfieldname for a question after group change
 {
@@ -2879,7 +2886,7 @@ function incompleteAnsFilterState()
 * isCaptchaEnabled($screen, $usecaptchamode)
 * @param string $screen - the screen name for which to test captcha activation
 *
-* @return boolean - returns true if captcha must be enabled
+* @return boolean|null - returns true if captcha must be enabled
 **/
 function isCaptchaEnabled($screen, $captchamode='')
 {
@@ -3097,7 +3104,7 @@ function reverseTranslateFieldNames($iOldSID,$iNewSID,$aGIDReplacements,$aQIDRep
 /**
  * put your comment there...
  *
- * @param mixed $id
+ * @param integer $id
  * @param string $type
  * @return bool
  */
@@ -4284,7 +4291,7 @@ function switchMSSQLIdentityInsert($table,$state)
  * Retrieves the last Insert ID realiable for cross-DB applications
  *
  * @param string $sTableName Needed for Postgres and MSSQL
- * @return mixed|string
+ * @return string
  */
 function getLastInsertID($sTableName)
 {
@@ -5137,7 +5144,7 @@ function aEncodingsArray()
 *
 * @param    string  $sString        string to ellipsize
 * @param    integer $iMaxLength       max length of string
-* @param    mixed   $fPosition       int (1|0) or float, .5, .2, etc for position to split
+* @param    integer   $fPosition       int (1|0) or float, .5, .2, etc for position to split
 * @param    string  $sEllipsis      ellipsis ; Default '...'
 * @return    string        ellipsized string
 */
@@ -5342,7 +5349,7 @@ function decodeTokenAttributes($oTokenAttributeData){
 
 /**
  * @param string $sSerial
- * @return mixed|null|string
+ * @return string|null
  */
 function getSerialClass($sSerial) {
     $aTypes = array('s' => 'string', 'a' => 'array', 'b' => 'bool', 'i' => 'int', 'd' => 'float', 'N;' => 'NULL');

application/helpers/database_helper.php

@@ -48,6 +48,9 @@ function dbExecuteAssoc($sql,$inputarr=false,$silent=true)
 }
 
 
+/**
+ * @param string $sql
+ */
 function dbQueryOrFalse($sql)
 {
     try {

application/helpers/expressions/em_core_helper.php

@@ -273,9 +273,9 @@ public function RDP_GetErrors()
 
     /**
      * Get informatin about type mismatch between arguments.
-     * @param array $arg1
-     * @param array $arg2
-     * @return array Like (boolean $bMismatchType, boolean $bBothNumeric, boolean $bBothString)
+     * @param Token $arg1
+     * @param Token $arg2
+     * @return boolean[] Like (boolean $bMismatchType, boolean $bBothNumeric, boolean $bBothString)
      */
     private function getMismatchInformation(array $arg1, array $arg2)
     {

application/helpers/frontend_helper.php

@@ -1430,6 +1430,7 @@ function resetAllSessionVariables($surveyid)
  * Set totalsteps in session
  * @param int $surveyid
  * @param array $thissurvey
+ * @param integer $totalquestions
  * @return void
  */
 function setTotalSteps($surveyid, array $thissurvey, $totalquestions)
@@ -1477,6 +1478,9 @@ function breakOutAndCrash($sTemplateViewPath, $totalquestions, $iTotalGroupsWith
     renderError($sTitle, $sMessage, $thissurvey, $sTemplateViewPath);
 }
 
+/**
+ * @param string $sTemplateViewPath
+ */
 function renderError($sTitle='', $sMessage, $thissurvey, $sTemplateViewPath )
 {
     // Template settings

application/helpers/qanda_helper.php

@@ -478,6 +478,9 @@ function validation_popup($ia, $notvalidated=null)
 }
 
 // TMSW Validation -> EM
+/**
+ * @param boolean $filenotvalidated
+ */
 function file_validation_popup($ia, $filenotvalidated = null)
 {
 

application/helpers/replacements_helper.php

@@ -21,7 +21,7 @@
 * @param string $line Text to search in
 * @param string[] $replacements Array of replacements:  Array( <stringtosearch>=><stringtoreplacewith>
 * @param mixed[] $redata : array of global var used in the function
-* @param void $debugSrc deprecated
+* @param string|null $debugSrc deprecated
 * @param boolean $anonymized Determines if token data is being used or just replaced with blanks
 * @param integer|null $questionNum - needed to support dynamic JavaScript-based tailoring within questions
 * @param void $registerdata - deprecated

application/helpers/update/updatedb_helper.php

@@ -1347,6 +1347,7 @@ function upgradeTokenTables181($sMySQLCollation)
 
 /**
 * @param string $sFieldType
+* @param string $sColumn
 */
 function alterColumn($sTable, $sColumn, $sFieldType, $bAllowNull=true, $sDefault='NULL') 
 {
@@ -1480,7 +1481,7 @@ function dropUniqueKeyMSSQL($sFieldName, $sTableName)
 /**
 * This function drops a secondary key of an MSSQL database field by using the field name and the table name
 * 
-* @param mixed $sFieldName
+* @param string $sFieldName
 * @param mixed $sTableName
 */
 function dropSecondaryKeyMSSQL($sFieldName, $sTableName)
@@ -1510,7 +1511,7 @@ function dropSecondaryKeyMSSQL($sFieldName, $sTableName)
 /**
 * Drops the primary key of a table
 * 
-* @param mixed $sTablename
+* @param string $sTablename
 */
 function dropPrimaryKey($sTablename)
 {

application/helpers/viewHelper.php

@@ -213,7 +213,7 @@ public static function putSeparator($sString,$separator){
      * @param boolean $bFlat : flattenText or not : completely flat (not like flattenText from common_helper)
      * @param integer $iAbbreviated : max string text (if true : allways flat), 0 or false : don't abbreviated
      * @param string $sEllipsis if abbreviated : the char to put at end (or middle)
-     * @param mixed $fPosition if abbreviated position to split (in % : 0 to 1)
+     * @param integer $fPosition if abbreviated position to split (in % : 0 to 1)
      *
      * @return string
      */

application/libraries/PluginManager/PluginManager.php

@@ -151,7 +151,6 @@ public function subscribe(iPlugin $plugin, $event, $function = null)
      * Unsubscribes a plugin from an event.
      * @param iPlugin $plugin Reference to the plugin being unsubscribed.
      * @param string $event Name of the event. Use '*', to unsubscribe all events for the plugin.
-     * @param string $function Optional function of the plugin that was registered.
      */
     public function unsubscribe(iPlugin $plugin, $event)
     {

application/libraries/admin/pdf.php

@@ -719,7 +719,7 @@ function addHeader($aPdfLanguageSettings, $sSiteName, $sDefaultHeaderString)
    *
    * Add GID text to PDF
    * @param $sGroupName - Group name
-   * @param $sGroupDescription - Group description
+   * @param string $sGroupDescription - Group description
    * @param $bAllowBreakPage - Allow break cell in two pages
    * @return unknown_type
    */

application/models/AdminTheme.php

@@ -276,7 +276,7 @@ public static function touchSubDirectories( $sPath )
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getOtherAssets()
     {

application/models/Participant.php

@@ -720,6 +720,7 @@ public function getParticipantsSharedCount($userid)
      * @param order
      * @param search
      * @param userid
+     * @param string $order
      * @return array
      */
     public function getParticipants($page, $limit,$attid, $order = null, $search = null, $userid = null)
@@ -2016,9 +2017,9 @@ public function copyToCentral($surveyid, $aAttributesToBeCreated, $aMapped, $ove
 
     /**
      * The purpose of this function is to check for duplicate in participants
-     * @param array $fields
+     * @param string $fields
      * @param string $output
-     * @return mixed
+     * @return string
      */
     public function checkforDuplicate($fields, $output="bool")
     {