chamilo / chamilo-lms

main/coursecopy/classes/CourseArchiver.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
 
     /**
      * @param array $file
-     * @return bool|string
+     * @return string|false
      */
     public static function import_uploaded_file($file)
     {

main/coursecopy/classes/DummyCourseCreator.class.php

Doc Comments +1 added lines

@@ -280,6 +280,7 @@
 	}
 	/**
 	 * Get dummy titles, descriptions and texts
+	 * @param string $type
 	 */
 	function get_dummy_content($type)
 	{

main/exercice/oral_expression.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
      * @param null $feedback_type
      * @param null $counter
      * @param null $score
-     * @return null|string
+     * @return string
      */
     function return_header($feedback_type = null, $counter = null, $score = null)
     {

main/gradebook/lib/be/learnpathlink.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 
 	/**
 	 * Get the progress of this learnpath. Only the last attempt are taken into account.
-	 * @param $stud_id student id (default: all students who have results - then the average is returned)
+	 * @param integer $stud_id student id (default: all students who have results - then the average is returned)
 	 * @return	array (score, max) if student is given
 	 * 			array (sum of scores, number of scores) otherwise
 	 * 			or null if no scores available

Braces +12 added lines, -8 removed lines

@@ -29,8 +29,9 @@ 
 	public function get_not_created_links()
 	{
 		return false;
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
+		if (empty($this->course_code)) {
+					die('Error in get_not_created_links() : course code not set');
+		}
 
 		$tbl_grade_links = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
 
@@ -57,8 +58,9 @@ 
 	 */
 	public function get_all_links()
 	{
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
+		if (empty($this->course_code)) {
+					die('Error in get_not_created_links() : course code not set');
+		}
 
 		$session_id = api_get_session_id();
 		if (empty($session_id)) {
@@ -111,8 +113,9 @@ 
                     lp_id = ".$this->get_ref_id()." AND
                     session_id = $session_id ";
 
-		if (isset($stud_id))
-			$sql .= ' AND user_id = '.intval($stud_id);
+		if (isset($stud_id)) {
+					$sql .= ' AND user_id = '.intval($stud_id);
+		}
 
 		// order by id, that way the student's first attempt is accessed first
 		$sql .= ' ORDER BY view_count DESC';
@@ -122,8 +125,9 @@ 
 		if (isset($stud_id)) {
 			if ($data = Database::fetch_array($scores)) {
 				return array ($data['progress'], 100);
-			} else
-				return null;
+			} else {
+							return null;
+			}
 		} else {
 			// all students -> get average
 			$students = array();  // user list, needed to make sure we only

main/gradebook/lib/fe/gradebooktable.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -32,6 +32,8 @@ 
      * @param array $evals
      * @param array $links
      * @param null $addparams
+     * @param boolean $showTeacherView
+     * @param integer $userId
      */
     public function __construct(
         $currentcat,
@@ -895,7 +897,7 @@ 
 
     /**
      * @param $item
-     * @return mixed
+     * @return string|null
      */
     private function build_course_code($item)
     {

Braces +3 added lines, -2 removed lines

@@ -256,10 +256,11 @@
         }
 
         // Categories.
-        if (!empty($data_array))
-        foreach ($data_array as $data) {
+        if (!empty($data_array)) {
+                foreach ($data_array as $data) {
             // list of items inside the gradebook (exercises, lps, forums, etc)
             $row  = array();
+        }
             /** @var AbstractLink $item */
             $item = $mainCategory = $data[0];
 

main/gradebook/lib/user_data_generator.class.php

Doc Comments +5 added lines, -4 removed lines

@@ -72,6 +72,7 @@ 
 
 	/**
 	 * Get actual array data
+	 * @param integer $count
 	 * @return array 2-dimensional array - each array contains the elements:
 	 * 0: eval/link object
 	 * 1: item name
@@ -285,7 +286,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_average_column($item, $ignore_score_color)
@@ -306,7 +307,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_result_column($item, $ignore_score_color)
@@ -323,7 +324,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +340,7 @@ 
 
 	/**
 	 * @param $coursecode
-	 * @return mixed
+	 * @return string
 	 */
 	private function get_course_name_from_code_cached($coursecode)
 	{

Braces +8 added lines, -6 removed lines

@@ -95,7 +95,7 @@ 
 		// sort users array
 		if ($sorting & self :: UDG_SORT_TYPE) {
 			usort($allitems, array('UserDataGenerator', 'sort_by_type'));
-		}elseif ($sorting & self :: UDG_SORT_NAME) {
+		} elseif ($sorting & self :: UDG_SORT_NAME) {
 			usort($allitems, array('UserDataGenerator', 'sort_by_name'));
 		} elseif ($sorting & self :: UDG_SORT_COURSE) {
 			usort($allitems, array('UserDataGenerator', 'sort_by_course'));
@@ -148,8 +148,9 @@ 
 			$row[] = $this->build_category_name($item);
 			$row[] = $this->build_average_column($item, $ignore_score_color);
 			$row[] = $this->build_result_column($item, $ignore_score_color);
-			if ($scoredisplay->is_custom())
-				$row[] = $this->build_mask_column($item, $ignore_score_color);
+			if ($scoredisplay->is_custom()) {
+							$row[] = $this->build_mask_column($item, $ignore_score_color);
+			}
 			$data[] = $row;
 		}
 		return $data;
@@ -362,13 +363,14 @@ 
 		if (isset ($this->categorycache)
 			&& isset ($this->categorycache[$category_id])) {
 			return $this->categorycache[$category_id];
-		}else {
+		} else {
 			$cat = Category::load($category_id);
 			if (isset($cat)){
 				$this->categorycache[$category_id] = $cat[0];
 				return $cat[0];
-			}else
-				return null;
+			} else {
+							return null;
+			}
 		}
 	}
 

main/inc/lib/AnnouncementManager.php

Doc Comments +9 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -40,7 +40,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -349,7 +349,7 @@ 
      * @param array	    uploaded file $_FILES
      * @param string    Comment describing the attachment
      * @param bool  $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -460,7 +460,7 @@ 
      * @param $to_users
      * @param array $file
      * @param string $file_comment
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -699,7 +699,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -719,6 +719,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1184,6 +1185,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1308,6 +1310,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

main/inc/lib/course_home.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -213,7 +213,7 @@ 
     /**
      * Displays the tools of a certain category.
      *
-     * @return void
+     * @return string
      * @param string $course_tool_category	contains the category of tools to display:
      * "Public", "PublicButHide", "courseAdmin", "claroAdmin"
      */
@@ -650,7 +650,7 @@ 
      * @param array $all_tools_list List of tools as returned by get_tools_category()
      * @param bool  $rows
      *
-     * @return void
+     * @return string
      */
     public static function show_tools_category($all_tools_list, $rows = false)
     {
@@ -1194,6 +1194,7 @@ 
 
     /**
      * Show a toolbar with shortcuts to the course tool
+     * @param integer $orientation
      */
     public static function show_navigation_tool_shortcuts($orientation = SHORTCUTS_HORIZONTAL)
     {

Braces +3 added lines, -3 removed lines

@@ -1200,9 +1200,9 @@
         $navigation_items = self::get_navigation_items(false);
         $html = '';
         if (!empty($navigation_items)) {
-            if ($orientation == SHORTCUTS_HORIZONTAL)
-                $style_id = "toolshortcuts_horizontal";
-            else {
+            if ($orientation == SHORTCUTS_HORIZONTAL) {
+                            $style_id = "toolshortcuts_horizontal";
+            } else {
                 $style_id = "toolshortcuts_vertical";
             }
             $html .= '<div id="'.$style_id.'">';

main/inc/lib/diagnoser.lib.php

Doc Comments +6 added lines

@@ -351,6 +351,12 @@
 
     /**
      * Additional functions needed for fast integration
+     * @param integer $status
+     * @param string $section
+     * @param string $title
+     * @param string $url
+     * @param string|null $formatter
+     * @param string $comment
      */
     public function build_setting($status, $section, $title, $url, $current_value, $expected_value, $formatter, $comment, $img_path = null) {
         switch ($status) {

Braces +13 added lines, -9 removed lines

@@ -158,8 +158,9 @@ 
         $array[] = $this->build_setting($status, '[INI]', 'display_errors', 'http://www.php.net/manual/en/ini.core.php#ini.display_errors', $setting, $req_setting, 'on_off', get_lang('DisplayErrorsInfo'));
 
         $setting = ini_get('default_charset');
-        if ($setting == '')
-            $setting = null;
+        if ($setting == '') {
+                    $setting = null;
+        }
         $req_setting = null;
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
         $array[] = $this->build_setting($status, '[INI]', 'default_charset', 'http://www.php.net/manual/en/ini.core.php#ini.default-charset', $setting, $req_setting, null, get_lang('DefaultCharsetInfo'));
@@ -177,22 +178,25 @@ 
         $setting = ini_get('memory_limit');
         $req_setting = '>= '.REQUIRED_MIN_MEMORY_LIMIT.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT)
-            $status = self :: STATUS_OK;
+        if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT) {
+                    $status = self :: STATUS_OK;
+        }
         $array[] = $this->build_setting($status, '[INI]', 'memory_limit', 'http://www.php.net/manual/en/ini.core.php#ini.memory-limit', $setting, $req_setting, null, get_lang('MemoryLimitInfo'));
 
         $setting = ini_get('post_max_size');
         $req_setting = '>= '.REQUIRED_MIN_POST_MAX_SIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE)
-            $status = self :: STATUS_OK;
+        if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE) {
+                    $status = self :: STATUS_OK;
+        }
         $array[] = $this->build_setting($status, '[INI]', 'post_max_size', 'http://www.php.net/manual/en/ini.core.php#ini.post-max-size', $setting, $req_setting, null, get_lang('PostMaxSizeInfo'));
 
         $setting = ini_get('upload_max_filesize');
         $req_setting = '>= '.REQUIRED_MIN_UPLOAD_MAX_FILESIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE)
-            $status = self :: STATUS_OK;
+        if ((float)$setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE) {
+                    $status = self :: STATUS_OK;
+        }
         $array[] = $this->build_setting($status, '[INI]', 'upload_max_filesize', 'http://www.php.net/manual/en/ini.core.php#ini.upload_max_filesize', $setting, $req_setting, null, get_lang('UploadMaxFilesizeInfo'));
 
         $setting = ini_get('variables_order');
@@ -205,7 +209,7 @@ 
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[SESSION]', 'session.gc_maxlifetime', 'http://www.php.net/manual/en/ini.core.php#session.gc-maxlifetime', $setting, $req_setting, null, get_lang('SessionGCMaxLifetimeInfo'));
 
-        if (api_check_browscap()){$setting = true;}else{$setting=false;}
+        if (api_check_browscap()){$setting = true;} else{$setting=false;}
         $req_setting = true;
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'browscap', 'http://www.php.net/manual/en/misc.configuration.php#ini.browscap', $setting, $req_setting, 'on_off', get_lang('BrowscapInfo'));