chamilo / chamilo-lms

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)
     {

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) {

Indentation +13 added lines, -13 removed lines

@@ -401,19 +401,19 @@
 
     public function format_yes_no_optional($value)
     {
-    	$return = '';
-    	switch($value) {
-     		case 0:
-     			$return = get_lang('No');
-     			break;
-     		case 1:
-     			$return = get_lang('Yes');
-     			break;
-			case 2:
-				$return = get_lang('Optional');
-				break;
-    	}
-    	return $return;
+        $return = '';
+        switch($value) {
+                case 0:
+                 $return = get_lang('No');
+                    break;
+                case 1:
+                 $return = get_lang('Yes');
+                    break;
+            case 2:
+                $return = get_lang('Optional');
+                break;
+        }
+        return $return;
 
     }
 

main/inc/lib/display.lib.php

Doc Comments +26 added lines, -15 removed lines

@@ -32,7 +32,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function toolList()
     {
@@ -290,7 +290,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show.
      * i.e: $visibility_options= array(true, false) we will only show the first column
      * 				Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -331,7 +330,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show. i.e:
      *  $visibility_options= array(true, false) we will only show the first column
      * 	Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -388,10 +386,11 @@ 
      * 					'per_page' = number of items to show per page
      * 					'page_nr' = The page to display
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $column_show Array of binaries 1= show columns 0. hide a column
+     * @param integer[] $column_show Array of binaries 1= show columns 0. hide a column
      * @param array $column_order An array of integers that let us decide how the columns are going to be sort.
      * 						      i.e:  $column_order=array('1''4','3','4'); The 2nd column will be order like the 4th column
      * @param array $form_actions Set optional forms actions
+     * @param string $table_name
      *
      * @author Julio Montoya
      */
@@ -444,7 +443,7 @@ 
      * @param bool	$filter (true) or not (false)
      * @param bool $returnValue
      *
-     * @return void
+     * @return string|null
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
@@ -474,7 +473,7 @@ 
     /**
      * Displays an confirmation message. Use this if something has been done successfully
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_confirmation_message ($message, $filter = true, $returnValue = false)
     {
@@ -491,7 +490,7 @@ 
      * @param string $message - include any additional html
      *                          tags if you need them
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_error_message ($message, $filter = true, $returnValue = false)
     {
@@ -681,6 +680,7 @@ 
      * @param string   The alt text (probably a language variable)
      * @param array    additional attributes (for instance height, width, onclick, ...)
      * @param integer  The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
+     * @param string $image
      * @return void
     */
     public static function display_icon(
@@ -881,6 +881,7 @@ 
     /**
      * Displays an HTML input tag
      *
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -897,8 +898,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -913,6 +914,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -983,6 +985,8 @@ 
      * @param   array   content that will be showed
      * @param   string  the id of the container of the tab in the example "tabs"
      * @param   array   attributes for the ul
+     * @param string[] $header_list
+     * @param string[] $content_list
      *
      */
     public static function tabs($header_list, $content_list, $id = 'tabs', $attributes = array(), $ul_attributes = array())
@@ -1029,7 +1033,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1067,6 +1071,7 @@ 
      * As you can see both function use the same "my_grid_name" this is very important otherwise nothing will work
      *
      * @param   string  the div id, this value must be the same with the first parameter of Display::grid_js()
+     * @param string $div_id
      * @return  string  html
      *
      */
@@ -1622,6 +1627,8 @@ 
      * @param  string  url that will be added (for jquery see hot_courses.tpl)
 	 * @param	string	point info array see function CourseManager::get_course_ranking()
 	 * @param	bool	add a div wrapper
+	 * @param string $id
+	 * @param string $url
 	 * @todo	use     templates
      **/
     public static function return_rating_system($id, $url, $point_info = array(), $add_div_wrapper = true)
@@ -1717,6 +1724,9 @@ 
         return '<'.$size.'>'.Security::remove_XSS($title).'</'.$size.'>';
     }
 
+    /**
+     * @param string $title
+     */
     public static function page_subheader2($title, $second_title = null)
     {
         return self::page_header($title, $second_title, 'h4');
@@ -1947,6 +1957,7 @@ 
 
     /**
      * @todo use twig
+     * @param string $title
      */
     public static function group_button($title, $elements)
     {
@@ -2164,9 +2175,9 @@ 
 
     /**
      * @param int $id
-     * @param array $content
+     * @param string[] $content
      * @param int $col
-     * @param bool|true $right
+     * @param boolean $right
      * @return string
      */
     public static function toolbarAction($id, $content = array(), $col = 2, $right = true)
@@ -2248,10 +2259,10 @@ 
     /**
      * @param string $title
      * @param string $content
-     * @param null $id
+     * @param string $id
      * @param array $params
-     * @param null $idAccordion
-     * @param null $idCollapse
+     * @param string $idAccordion
+     * @param string $idCollapse
      * @param bool|true $open
      * @param bool|false $fullClickable
      * @return null|string

Indentation +69 added lines, -69 removed lines

@@ -49,12 +49,12 @@ 
         );
     }
 
-     /**
-     * Displays the page header
-     * @param string The name of the page (will be showed in the page title)
-     * @param string Optional help file name
-     * @param string $page_header
-     */
+        /**
+         * Displays the page header
+         * @param string The name of the page (will be showed in the page title)
+         * @param string Optional help file name
+         * @param string $page_header
+         */
     public static function display_header($tool_name ='', $help = null, $page_header = null)
     {
         $origin = api_get_origin();
@@ -448,7 +448,7 @@ 
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
-    	$message = self::return_message($message, 'normal', $filter);
+        $message = self::return_message($message, 'normal', $filter);
         if ($returnValue) {
             return $message;
         } else {
@@ -524,22 +524,22 @@ 
     public static function return_message($message, $type = 'normal', $filter = true)
     {
         if ($filter) {
-        	$message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
+            $message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
         }
 
         $class = "";
         switch($type) {
             case 'warning':
                $class .= 'alert alert-warning';
-               break;
+                break;
             case 'error':
                $class .= 'alert alert-danger';
-               break;
+                break;
             case 'confirmation':
             case 'confirm':
             case 'success':
                 $class .= 'alert alert-success';
-               break;
+                break;
             case 'normal':
             default:
                 $class .= 'alert alert-info';
@@ -682,7 +682,7 @@ 
      * @param array    additional attributes (for instance height, width, onclick, ...)
      * @param integer  The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
      * @return void
-    */
+     */
     public static function display_icon(
         $image,
         $alt_text = '',
@@ -705,7 +705,7 @@ 
      * @author Julio Montoya 2010 Function improved, adding image constants
      * @author Yannick Warnier 2011 Added size handler
      * @version Feb 2011
-    */
+     */
     public static function return_icon(
         $image,
         $alt_text = '',
@@ -884,14 +884,14 @@ 
      */
     public static function input($type, $name, $value, $attributes = array())
     {
-         if (isset($type)) {
-             $attributes['type']= $type;
-         }
-         if (isset($name)) {
-             $attributes['name']= $name;
-         }
-         if (isset($value)) {
-             $attributes['value']= $value;
+            if (isset($type)) {
+                $attributes['type']= $type;
+            }
+            if (isset($name)) {
+                $attributes['name']= $name;
+            }
+            if (isset($value)) {
+                $attributes['value']= $value;
         }
         return self::tag('input', '', $attributes);
     }
@@ -904,10 +904,10 @@ 
      */
     public static function button($name, $value, $attributes = array())
     {
-    	if (!empty($name)) {
+        if (!empty($name)) {
             $attributes['name'] = $name;
-    	}
-    	return self::tag('button', $value, $attributes);
+        }
+        return self::tag('button', $value, $attributes);
     }
 
     /**
@@ -974,7 +974,7 @@ 
      * in the $htmlHeadXtra variable before the display_header
      * Add this script
      * @example
-             * <script>
+     * <script>
                     $(function() {
                         $( "#tabs" ).tabs();
                     });
@@ -1035,20 +1035,20 @@ 
      */
     public static function tabsOnlyLink($headers, $selected = null)
     {
-         $id = uniqid();
-         $i = 1;
-         $lis = null;
-         foreach ($headers as $item) {
+            $id = uniqid();
+            $i = 1;
+            $lis = null;
+            foreach ($headers as $item) {
             $class = null;
             if ($i == $selected) {
                 $class = 'active';
             }
-             $item = self::tag(
-                 'a',
-                 $item['content'],
-                 array('id' => $id.'-'.$i, 'href' => $item['url'])
-             );
-             $lis .= self::tag('li', $item, array('class' => $class));
+                $item = self::tag(
+                    'a',
+                    $item['content'],
+                    array('id' => $id.'-'.$i, 'href' => $item['url'])
+                );
+                $lis .= self::tag('li', $item, array('class' => $class));
             $i++;
         }
         return self::tag('ul', $lis, array('class' => 'nav nav-tabs tabs-margin'));
@@ -1260,8 +1260,8 @@ 
      */
     public static function table($headers, $rows, $attributes = array())
     {
-    	if (empty($attributes)) {
-    		$attributes['class'] = 'data_table';
+        if (empty($attributes)) {
+            $attributes['class'] = 'data_table';
         }
         $table = new HTML_Table($attributes);
         $row = 0;
@@ -1269,17 +1269,17 @@ 
 
         // Course headers
         if (!empty($headers)) {
-	        foreach ($headers as $item) {
-	            $table->setHeaderContents($row, $column, $item);
-	            $column++;
-	        }
-	        $row = 1;
-	        $column = 0;
+            foreach ($headers as $item) {
+                $table->setHeaderContents($row, $column, $item);
+                $column++;
+            }
+            $row = 1;
+            $column = 0;
         }
 
         if (!empty($rows)) {
-	        foreach($rows as $content) {
-	            $table->setCellContents($row, $column, $content);
+            foreach($rows as $content) {
+                $table->setCellContents($row, $column, $content);
                 $row++;
             }
         }
@@ -1385,7 +1385,7 @@ 
                         //$item_property['tool'] != TOOL_DROPBOX &&
                         $item_property['tool'] != TOOL_NOTEBOOK &&
                         $item_property['tool'] != TOOL_CHAT)
-                   )
+                    )
                 )
                 // Take only what's visible or "invisible but where the user is a teacher" or where the visibility is unset.
                 && ($item_property['visibility'] == '1'
@@ -1401,7 +1401,7 @@ 
                         ($item_property['to_user_id'] != $user_id) &&
                         (!isset($item_property['to_group_id']) || !in_array($item_property['to_group_id'], $group_ids)))
                 ) {
-                   continue;
+                    continue;
                 }
 
                 // If it's a survey, make sure the user's invited. Otherwise drop it.
@@ -1620,21 +1620,21 @@ 
      *
      * @param  string  id of the rating ul element
      * @param  string  url that will be added (for jquery see hot_courses.tpl)
-	 * @param	string	point info array see function CourseManager::get_course_ranking()
-	 * @param	bool	add a div wrapper
-	 * @todo	use     templates
+     * @param	string	point info array see function CourseManager::get_course_ranking()
+     * @param	bool	add a div wrapper
+     * @todo	use     templates
      **/
     public static function return_rating_system($id, $url, $point_info = array(), $add_div_wrapper = true)
     {
-		$number_of_users_who_voted = isset($point_info['users_who_voted']) ? $point_info['users_who_voted'] : null;
-		$percentage = isset($point_info['point_average']) ? $point_info['point_average'] : 0;
+        $number_of_users_who_voted = isset($point_info['users_who_voted']) ? $point_info['users_who_voted'] : null;
+        $percentage = isset($point_info['point_average']) ? $point_info['point_average'] : 0;
 
-		if (!empty($percentage)) {
+        if (!empty($percentage)) {
             $percentage = $percentage*125/100;
         }
-		$accesses =  isset($point_info['accesses']) ? $point_info['accesses'] : 0;
+        $accesses =  isset($point_info['accesses']) ? $point_info['accesses'] : 0;
 
-		$star_label = sprintf(get_lang('XStarsOutOf5'), $point_info['point_average_star']);
+        $star_label = sprintf(get_lang('XStarsOutOf5'), $point_info['point_average_star']);
 
         $html = '<ul id="'.$id.'" class="star-rating">
 					<li class="current-rating" style="width:'.$percentage.'px;"></li>
@@ -1645,26 +1645,26 @@ 
 					<li><a href="javascript:void(0);" data-link="'.$url.'&amp;star=5" title="'.$star_label.'" class="five-stars">5</a></li>
 				</ul>';
 
-		$labels = array();
+        $labels = array();
 
-		$labels[]= $number_of_users_who_voted == 1 ? $number_of_users_who_voted.' '.get_lang('Vote') : $number_of_users_who_voted.' '.get_lang('Votes');
-		$labels[]= $accesses == 1 ? $accesses.' '.get_lang('Visit') : $accesses.' '.get_lang('Visits');
-		if (!empty($number_of_users_who_voted)) {
-			$labels[]= get_lang('Average').' '.$point_info['point_average_star'].'/5';
-		}
+        $labels[]= $number_of_users_who_voted == 1 ? $number_of_users_who_voted.' '.get_lang('Vote') : $number_of_users_who_voted.' '.get_lang('Votes');
+        $labels[]= $accesses == 1 ? $accesses.' '.get_lang('Visit') : $accesses.' '.get_lang('Visits');
+        if (!empty($number_of_users_who_voted)) {
+            $labels[]= get_lang('Average').' '.$point_info['point_average_star'].'/5';
+        }
 
-		$labels[]= $point_info['user_vote']  ? get_lang('YourVote').' ['.$point_info['user_vote'].']' : get_lang('YourVote'). ' [?] ';
+        $labels[]= $point_info['user_vote']  ? get_lang('YourVote').' ['.$point_info['user_vote'].']' : get_lang('YourVote'). ' [?] ';
 
-		if (!$add_div_wrapper && api_is_anonymous()) {
-			$labels[]= Display::tag('span', get_lang('LoginToVote'), array('class' => 'error'));
-		}
+        if (!$add_div_wrapper && api_is_anonymous()) {
+            $labels[]= Display::tag('span', get_lang('LoginToVote'), array('class' => 'error'));
+        }
 
         $html .= Display::div(implode(' | ', $labels) , array('id' =>  'vote_label_'.$id, 'class' => 'vote_label_info'));
         $html .= ' '.Display::span(' ', array('id' =>  'vote_label2_'.$id));
 
         if ($add_div_wrapper) {
-			$html = Display::div($html, array('id' => 'rating_wrapper_'.$id));
-		}
+            $html = Display::div($html, array('id' => 'rating_wrapper_'.$id));
+        }
 
         return $html;
     }
@@ -1702,8 +1702,8 @@ 
         return self::page_header($title, $second_title);
     }
 
-     public static function page_subheader_and_translate($title, $second_title = null)
-     {
+        public static function page_subheader_and_translate($title, $second_title = null)
+        {
         $title = get_lang($title);
         return self::page_subheader($title, $second_title);
     }

main/inc/lib/exercise.lib.php

Doc Comments +9 added lines, -6 removed lines

@@ -1255,6 +1255,7 @@ 
 
     /**
      * Validates the time control key
+     * @param integer $exercise_id
      */
     public static function exercise_time_control_is_valid(
         $exercise_id,
@@ -1388,7 +1389,7 @@ 
      * @param int $in_direction
      * @param string $in_hotpot_path
      * @param bool $in_get_count
-     * @param null $where_condition
+     * @param string $where_condition
      * @return array|int
      */
     public static function get_exam_results_hotpotatoes_data(
@@ -2179,7 +2180,7 @@ 
     /**
      * Return true if pass_pourcentage activated (we use the pass pourcentage feature
      * return false if pass_percentage = 0 (we don't use the pass pourcentage feature
-     * @param $in_pass_pourcentage
+     * @param string $in_pass_pourcentage
      * @return boolean
      * In this version, pass_percentage and show_success_message are disabled if
      * pass_percentage is set to 0
@@ -2192,7 +2193,7 @@ 
     /**
      * Converts a numeric value in a percentage example 0.66666 to 66.67 %
      * @param $value
-     * @return float Converted number
+     * @return string Converted number
      */
     public static function convert_to_percentage($value)
     {
@@ -2208,7 +2209,7 @@ 
      * @param   float $score
      * @param   float $weight
      * @deprecated seem not to be used
-     * @return  float   the score rounded converted to the new range
+     * @return  string|null   the score rounded converted to the new range
      */
     public static function convert_score($score, $weight)
     {
@@ -2759,6 +2760,7 @@ 
      * @param    int        exercise id
      * @param    int    $courseId
      * @param    int        session id
+     * @param integer $user_count
      * @return    float    Best average score
      */
     public static function get_best_average_score_by_exercise(
@@ -3198,8 +3200,9 @@ 
     }
 
     /**
-     * @param array $answer
+     * @param string|null $answer
      * @param string $user_answer
+     * @param string|null $current_answer
      * @return array
      */
     public static function check_fill_in_blanks($answer, $user_answer, $current_answer)
@@ -3805,7 +3808,7 @@ 
 
     /**
      * @param int $countLetter
-     * @return mixed
+     * @return string
      */
     public static function detectInputAppropriateClass($countLetter)
     {

main/inc/lib/export.lib.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
      * @param string Name of common tag to place each line in
      * @param string Name of the root element. A root element should always be given.
      * @param string Encoding in which the data is provided
-     * @return void  Prompts the user for a file download
+     * @return boolean  Prompts the user for a file download
      */
     public static function export_complex_table_xml(
         $data,
@@ -283,7 +283,7 @@ 
      * @param string $name
      * @param string $format
      *
-     * @return bool
+     * @return false|null
      */
     public static function htmlToOdt($html, $name, $format = 'odt')
     {

Indentation +11 added lines, -11 removed lines

@@ -56,7 +56,7 @@ 
 
         DocumentManager::file_send_for_download($filePath, true, $filename.'.csv');
         exit;
-	}
+    }
 
     /**
      * Export tabular data to XLS-file
@@ -79,7 +79,7 @@ 
 
         DocumentManager::file_send_for_download($filePath, true, $filename.'.xlsx');
         exit;
-	}
+    }
 
     /**
      * Export tabular data to XLS-file (as html table)
@@ -112,13 +112,13 @@ 
     }
 
     /**
-    * Export tabular data to XML-file
-    * @param array  Simple array of data to put in XML
-    * @param string Name of file to be given to the user
-    * @param string Name of common tag to place each line in
-    * @param string Name of the root element. A root element should always be given.
-    * @param string Encoding in which the data is provided
-    */
+     * Export tabular data to XML-file
+     * @param array  Simple array of data to put in XML
+     * @param string Name of file to be given to the user
+     * @param string Name of common tag to place each line in
+     * @param string Name of the root element. A root element should always be given.
+     * @param string Encoding in which the data is provided
+     */
     public static function arrayToXml(
         $data,
         $filename = 'export',
@@ -148,7 +148,7 @@ 
         fclose($handle);
         DocumentManager :: file_send_for_download($file, true, $filename.'.xml');
         exit;
-	}
+    }
 
     /**
      * Export hierarchical tabular data to XML-file
@@ -197,7 +197,7 @@ 
         foreach ($data as $row) {
             $string .= "\n".str_repeat("\t",$level).'<'.$row['name'].'>';
             if (is_array($row['value'])) {
-            	$string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n";
+                $string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n";
                 $string .= str_repeat("\t",$level).'</'.$row['name'].'>';
             } else {
                 $string .= $row['value'];

main/inc/lib/extra_field.lib.php

Doc Comments +8 added lines, -9 removed lines

@@ -123,7 +123,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getValidExtraFieldTypes()
     {
@@ -199,7 +199,7 @@ 
 
     /**
      * @param array $conditions
-     * @param null  $order_field_options_by
+     * @param string  $order_field_options_by
      *
      * @return array
      */
@@ -237,7 +237,7 @@ 
     /**
      * @param string $variable
      *
-     * @return array|bool
+     * @return integer
      */
     public function get_handler_field_info_by_field_variable($variable)
     {
@@ -319,7 +319,7 @@ 
     /**
      * @param string $handler
      *
-     * @return array
+     * @return string[]
      */
     public static function get_extra_fields_by_handler($handler)
     {
@@ -496,7 +496,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_field_types()
     {
@@ -506,7 +506,7 @@ 
     /**
      * @param int $id
      *
-     * @return null
+     * @return string|null
      */
     public function get_field_type_by_id($id)
     {
@@ -691,7 +691,6 @@ 
      * @param FormValidator $form
      * @param array $extraData
      * @param bool $admin_permissions
-     * @param int $user_id
      * @param array $extra
      * @param int $itemId
      * @param array $exclude variables of extra field to exclude
@@ -1592,7 +1591,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getJqgridColumnNames()
     {
@@ -1832,7 +1831,7 @@ 
     }
 
     /**
-     * @param array $columns
+     * @param string[] $columns
      * @param array  $column_model
      * @param array  $extraFields
      * @return array

Indentation +3 added lines, -3 removed lines

@@ -19,7 +19,7 @@ 
         'changeable',
         'filter',
         'extra_field_type',
-         /* Enable this when field_loggeable is introduced as a table field (2.0)
+            /* Enable this when field_loggeable is introduced as a table field (2.0)
         'field_loggeable',
          */
         'created_at'
@@ -523,7 +523,7 @@ 
      * France:Paris;Bretagne;Marseilles;Lyon|Belgique:Bruxelles;Namur;Liège;Bruges|Peru:Lima;Piura;
      * into
      * array(
- *      'France' =>
+     *      'France' =>
      *      array('Paris', 'Bregtane', 'Marseilles'),
      *  'Belgique' =>
      *      array('Namur', 'Liège')
@@ -1184,7 +1184,7 @@ 
 
                         if ($this->type == 'user') {
 
-                           /* //the magic should be here
+                            /* //the magic should be here
                             $user_tags = UserManager::get_user_tags($user_id, $field_details[0]);
 
                             $tag_list = '';

main/inc/lib/extra_field_value.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -43,7 +43,7 @@ 
     }
 
     /**
-     * @return ExtraField
+     * @return string
      */
     public function getExtraField()
     {
@@ -72,7 +72,7 @@ 
      * This function is used with $extraField->addElements()
      * @param array $params array for the insertion into the *_field_values table
      *
-     * @return mixed false on empty params, void otherwise
+     * @return false|null false on empty params, void otherwise
      * @assert (array()) === false
      */
     public function saveFieldValues($params)
@@ -500,7 +500,7 @@ 
      * @param int $item_id Item ID (It could be a session_id, course_id or user_id)
      * @param int $field_id Field ID (the ID from the *_field table)
      * @param bool $transform Whether to transform the result to a human readable strings
-     * @return mixed A structured array with the field_id and field_value, or false on error
+     * @return string A structured array with the field_id and field_value, or false on error
      * @assert (-1,-1) === false
      */
     public function get_values_by_handler_and_field_id($item_id, $field_id, $transform = false)
@@ -593,7 +593,7 @@ 
      * @param int $item_id Item ID from the original table
      * @param string $field_variable The name of the field we are looking for
      * @param bool $transform
-     * @param bool $allVisibility
+     * @param bool $visibility
      *
      * @return mixed Array of results, or false on error or not found
      * @assert (-1,'') === false

Indentation +5 added lines, -6 removed lines

@@ -720,11 +720,11 @@ 
         return false;
     }
 
-     /**
-     * @param int $itemId
-     * @param int $fieldId
-     * @return array
-     */
+        /**
+         * @param int $itemId
+         * @param int $fieldId
+         * @return array
+         */
     public function getAllValuesByItemAndField($itemId, $fieldId)
     {
         $fieldId = intval($fieldId);
@@ -847,7 +847,6 @@ 
     /**
      * Deletes all values from an item
      * @param int $itemId (session id, course id, etc)
-
      * @assert (-1,-1) == null
      */
     public function deleteValuesByItem($itemId)

main/inc/lib/fileManage.lib.php

Doc Comments +7 added lines, -6 removed lines

@@ -13,6 +13,8 @@ 
  * @param  - action (string) - action type require : 'delete' or 'update'
  * @param  - old_path (string) - old path info stored to change
  * @param  - new_path (string) - new path info to substitute
+ * @param string $action
+ * @param string $old_path
  * @desc Update the file or directory path in the document db document table
  *
  */
@@ -76,8 +78,8 @@ 
  * Deletes a file or a directory
  *
  * @author - Hugues Peeters
- * @param  $file (String) - the path of file or directory to delete
- * @return boolean - true if the delete succeed, false otherwise.
+ * @param  string $file (String) - the path of file or directory to delete
+ * @return boolean|null - true if the delete succeed, false otherwise.
  * @see    - delete() uses check_name_exist() and removeDir() functions
  */
 function my_delete($file)
@@ -162,9 +164,9 @@ 
  * Renames a file or a directory
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
- * @param  - $file_path (string) - complete path of the file or the directory
- * @param  - $new_file_name (string) - new name for the file or the directory
- * @return - boolean - true if succeed
+ * @param  string $file_path (string) - complete path of the file or the directory
+ * @param  string $new_file_name (string) - new name for the file or the directory
+ * @return string boolean - true if succeed
  *         - boolean - false otherwise
  * @see    - rename() uses the check_name_exist() and php2phps() functions
  */
@@ -327,7 +329,6 @@ 
  * Calculation size of a directory
  *
  * @returns integer size
- * @param 	string	$path path to size
  * @param 	boolean $recursive if true , include subdir in total
  */
 function dirsize($root, $recursive = true) {

Indentation +231 added lines, -232 removed lines

@@ -170,37 +170,37 @@ 
  */
 function my_rename($file_path, $new_file_name) {
 
-	$save_dir = getcwd();
-	$path = dirname($file_path);
-	$old_file_name = basename($file_path);
-	$new_file_name = api_replace_dangerous_char($new_file_name);
-
-	// If no extension, take the old one
-	if ((strpos($new_file_name, '.') === false) && ($dotpos = strrpos($old_file_name, '.'))) {
-		$new_file_name .= substr($old_file_name, $dotpos);
-	}
-
-	// Note: still possible: 'xx.yy' -rename-> '.yy' -rename-> 'zz'
-	// This is useful for folder names, where otherwise '.' would be sticky
-
-	// Extension PHP is not allowed, change to PHPS
-	$new_file_name = php2phps($new_file_name);
-
-	if ($new_file_name == $old_file_name) {
-		return $old_file_name;
-	}
-
-	if (strtolower($new_file_name) != strtolower($old_file_name) && check_name_exist($path.'/'.$new_file_name)) {
-		return false;
-	}
-	// On a Windows server, it would be better not to do the above check
-	// because it succeeds for some new names resembling the old name.
-	// But on Unix/Linux the check must be done because rename overwrites.
-
-	chdir($path);
-	$res = rename($old_file_name, $new_file_name) ? $new_file_name : false;
-	chdir($save_dir);
-	return $res;
+    $save_dir = getcwd();
+    $path = dirname($file_path);
+    $old_file_name = basename($file_path);
+    $new_file_name = api_replace_dangerous_char($new_file_name);
+
+    // If no extension, take the old one
+    if ((strpos($new_file_name, '.') === false) && ($dotpos = strrpos($old_file_name, '.'))) {
+        $new_file_name .= substr($old_file_name, $dotpos);
+    }
+
+    // Note: still possible: 'xx.yy' -rename-> '.yy' -rename-> 'zz'
+    // This is useful for folder names, where otherwise '.' would be sticky
+
+    // Extension PHP is not allowed, change to PHPS
+    $new_file_name = php2phps($new_file_name);
+
+    if ($new_file_name == $old_file_name) {
+        return $old_file_name;
+    }
+
+    if (strtolower($new_file_name) != strtolower($old_file_name) && check_name_exist($path.'/'.$new_file_name)) {
+        return false;
+    }
+    // On a Windows server, it would be better not to do the above check
+    // because it succeeds for some new names resembling the old name.
+    // But on Unix/Linux the check must be done because rename overwrites.
+
+    chdir($path);
+    $res = rename($old_file_name, $new_file_name) ? $new_file_name : false;
+    chdir($save_dir);
+    return $res;
 }
 
 /**
@@ -217,38 +217,38 @@ 
  */
 function move($source, $target, $forceMove = false, $moveContent = false)
 {
-	if (check_name_exist($source)) {
-		$file_name = basename($source);
+    if (check_name_exist($source)) {
+        $file_name = basename($source);
         $isWindowsOS = api_is_windows_os();
         $canExec = function_exists('exec');
 
-		/* File case */
-		if (is_file($source)) {
-			if ($forceMove && !$isWindowsOS && $canExec) {
-				exec('mv ' . $source . ' ' . $target . '/' . $file_name);
-			} else {
-				copy($source, $target . '/' . $file_name);
-				unlink($source);
-			}
-			return true;
-		} elseif (is_dir($source)) {
-			/* Directory */
-			if ($forceMove && !$isWindowsOS && $canExec) {
-				if ($moveContent) {
-					$base = basename($source);
-					exec('mv '.$source.'/* '.$target.$base.'/');
-					exec('rm -rf '.$source);
-				} else {
-					exec('mv $source $target');
-				}
-			} else {
-				copyDirTo($source, $target);
-			}
-			return true;
-		}
-	} else {
-		return false;
-	}
+        /* File case */
+        if (is_file($source)) {
+            if ($forceMove && !$isWindowsOS && $canExec) {
+                exec('mv ' . $source . ' ' . $target . '/' . $file_name);
+            } else {
+                copy($source, $target . '/' . $file_name);
+                unlink($source);
+            }
+            return true;
+        } elseif (is_dir($source)) {
+            /* Directory */
+            if ($forceMove && !$isWindowsOS && $canExec) {
+                if ($moveContent) {
+                    $base = basename($source);
+                    exec('mv '.$source.'/* '.$target.$base.'/');
+                    exec('rm -rf '.$source);
+                } else {
+                    exec('mv $source $target');
+                }
+            } else {
+                copyDirTo($source, $target);
+            }
+            return true;
+        }
+    } else {
+        return false;
+    }
 }
 
 /**
@@ -261,54 +261,54 @@ 
  */
 function copyDirTo($orig_dir_path, $destination, $move = true)
 {
-	if ($orig_dir_path == $destination) {
-		return false;
-	}
+    if ($orig_dir_path == $destination) {
+        return false;
+    }
 
-	$save_dir = getcwd();
-	// Extract directory name - create it at destination - update destination trail
-	$dir_name = basename($orig_dir_path);
+    $save_dir = getcwd();
+    // Extract directory name - create it at destination - update destination trail
+    $dir_name = basename($orig_dir_path);
     $dir_to_copy = array();
-	if (is_dir($orig_dir_path)) {
-		if (!is_dir($destination.'/'.$dir_name)) {
-			mkdir(
-				$destination.'/'.$dir_name,
-				api_get_permissions_for_new_directories()
-			);
-		}
-		$destination_trail = $destination.'/'.$dir_name;
-		if (is_dir($destination)) {
-			chdir($orig_dir_path) ;
-			$handle = opendir($orig_dir_path);
-
-			while ($element = readdir($handle)) {
-				if ($element == '.' || $element == '..') {
-					continue; // Skip the current and parent directories
-				} elseif (is_file($element)) {
-					copy($element, $destination_trail.'/'.$element);
-
-					if ($move) {
-						unlink($element) ;
-					}
-				} elseif (is_dir($element)) {
-					$dir_to_copy[] = $orig_dir_path.'/'.$element;
-				}
-			}
-
-			closedir($handle) ;
-
-			if (sizeof($dir_to_copy) > 0) {
-				foreach ($dir_to_copy as $this_dir) {
-					copyDirTo($this_dir, $destination_trail, $move); // Recursivity
-				}
-			}
-
-			if ($move) {
-				rmdir($orig_dir_path) ;
-			}
-			chdir($save_dir);
-		}
-	}
+    if (is_dir($orig_dir_path)) {
+        if (!is_dir($destination.'/'.$dir_name)) {
+            mkdir(
+                $destination.'/'.$dir_name,
+                api_get_permissions_for_new_directories()
+            );
+        }
+        $destination_trail = $destination.'/'.$dir_name;
+        if (is_dir($destination)) {
+            chdir($orig_dir_path) ;
+            $handle = opendir($orig_dir_path);
+
+            while ($element = readdir($handle)) {
+                if ($element == '.' || $element == '..') {
+                    continue; // Skip the current and parent directories
+                } elseif (is_file($element)) {
+                    copy($element, $destination_trail.'/'.$element);
+
+                    if ($move) {
+                        unlink($element) ;
+                    }
+                } elseif (is_dir($element)) {
+                    $dir_to_copy[] = $orig_dir_path.'/'.$element;
+                }
+            }
+
+            closedir($handle) ;
+
+            if (sizeof($dir_to_copy) > 0) {
+                foreach ($dir_to_copy as $this_dir) {
+                    copyDirTo($this_dir, $destination_trail, $move); // Recursivity
+                }
+            }
+
+            if ($move) {
+                rmdir($orig_dir_path) ;
+            }
+            chdir($save_dir);
+        }
+    }
 }
 
 
@@ -319,8 +319,8 @@ 
  * @param 	string	$filename 		filename
  */
 function getextension($filename) {
-	$bouts = explode('.', $filename);
-	return array(array_pop($bouts), implode('.', $bouts));
+    $bouts = explode('.', $filename);
+    return array(array_pop($bouts), implode('.', $bouts));
 }
 
 /**
@@ -331,19 +331,19 @@ 
  * @param 	boolean $recursive if true , include subdir in total
  */
 function dirsize($root, $recursive = true) {
-	$dir = @opendir($root);
-	$size = 0;
-	while ($file = @readdir($dir)) {
-		if (!in_array($file, array('.', '..'))) {
-			if (is_dir($root.'/'.$file)) {
-				$size += $recursive ? dirsize($root.'/'.$file) : 0;
-			} else {
-				$size += @filesize($root.'/'.$file);
-			}
-		}
-	}
-	@closedir($dir);
-	return $size;
+    $dir = @opendir($root);
+    $size = 0;
+    while ($file = @readdir($dir)) {
+        if (!in_array($file, array('.', '..'))) {
+            if (is_dir($root.'/'.$file)) {
+                $size += $recursive ? dirsize($root.'/'.$file) : 0;
+            } else {
+                $size += @filesize($root.'/'.$file);
+            }
+        }
+    }
+    @closedir($dir);
+    return $size;
 }
 
 /*	CLASS FileManager */
@@ -362,7 +362,7 @@ 
 */
 class FileManager
 {
-	/**
+    /**
 		Returns a list of all directories, except the base dir,
 		of the current course. This function uses recursion.
 
@@ -370,131 +370,130 @@ 
 
 		@author Roan Embrechts
 		@version 1.0.1
-	*/
-	function list_all_directories($path)
+     */
+    function list_all_directories($path)
     {
-		$result_array = array();
-		if (is_dir($path)) {
-			$save_dir = getcwd();
-			chdir($path);
-			$handle = opendir($path);
-			while ($element = readdir($handle)) {
-				if ($element == '.' || $element == '..') continue;
+        $result_array = array();
+        if (is_dir($path)) {
+            $save_dir = getcwd();
+            chdir($path);
+            $handle = opendir($path);
+            while ($element = readdir($handle)) {
+                if ($element == '.' || $element == '..') continue;
                 // Skip the current and parent directories
-				if (is_dir($element)) {
-					$dir_array[] = $path.'/'.$element;
-				}
-			}
-			closedir($handle);
-			// Recursive operation if subdirectories exist
-			$dir_number = sizeof($dir_array);
-			if ($dir_number > 0) {
-				for ($i = 0 ; $i < $dir_number ; $i++) {
-					$sub_dir_array = FileManager::list_all_directories($dir_array[$i]); // Function recursivity
-					if (is_array($dir_array) && is_array($sub_dir_array)) {
-						$dir_array  =  array_merge($dir_array, $sub_dir_array); // Data merge
-					}
-				}
-			}
-			$result_array  =  $dir_array;
-			chdir($save_dir) ;
-		}
-		return $result_array ;
-	}
-
-	/**
+                if (is_dir($element)) {
+                    $dir_array[] = $path.'/'.$element;
+                }
+            }
+            closedir($handle);
+            // Recursive operation if subdirectories exist
+            $dir_number = sizeof($dir_array);
+            if ($dir_number > 0) {
+                for ($i = 0 ; $i < $dir_number ; $i++) {
+                    $sub_dir_array = FileManager::list_all_directories($dir_array[$i]); // Function recursivity
+                    if (is_array($dir_array) && is_array($sub_dir_array)) {
+                        $dir_array  =  array_merge($dir_array, $sub_dir_array); // Data merge
+                    }
+                }
+            }
+            $result_array  =  $dir_array;
+            chdir($save_dir) ;
+        }
+        return $result_array ;
+    }
+
+    /**
 		This function receives a list of directories.
 		It returns a list of all files in these directories
 
 		@author Roan Embrechts
 		@version 1.0
-	*/
-	function list_all_files($dir_array)
+     */
+    function list_all_files($dir_array)
     {
-		$element_array = array();
-		if (is_dir($dir_array)) {
-
-			$save_dir = getcwd();
-			foreach ($dir_array as $directory) {
-				chdir($directory);
-				$handle = opendir($directory);
-			   	while ($element = readdir($handle)) {
-					if ($element == '.' || $element == '..' || $element == '.htaccess') continue;
+        $element_array = array();
+        if (is_dir($dir_array)) {
+
+            $save_dir = getcwd();
+            foreach ($dir_array as $directory) {
+                chdir($directory);
+                $handle = opendir($directory);
+                    while ($element = readdir($handle)) {
+                    if ($element == '.' || $element == '..' || $element == '.htaccess') continue;
                     // Skip the current and parent directories
-					if (!is_dir($element)) {
-						$element_array[] = $directory.'/'.$element;
-					}
-				}
-				closedir($handle);
-				chdir('..');
-				chdir($save_dir);
-			}
-		}
-
-		return $element_array;
-	}
-
-	/**
+                    if (!is_dir($element)) {
+                        $element_array[] = $directory.'/'.$element;
+                    }
+                }
+                closedir($handle);
+                chdir('..');
+                chdir($save_dir);
+            }
+        }
+
+        return $element_array;
+    }
+
+    /**
 		Loads contents of file $filename into memory and returns them as a string.
 		Function kept for compatibility with older PHP versions.
 		Function is binary safe (is needed on Windows)
-	*/
-	function compat_load_file($file_name)
+     */
+    function compat_load_file($file_name)
     {
-		$buffer = '';
-		if (file_exists($file_name)) {
-			$fp = fopen($file_name, 'rb');
-			$buffer = fread ($fp, filesize($file_name));
-			fclose ($fp);
-		}
-		return $buffer;
-	}
-
-	/**
-	 * Adds file/folder to document table in database
-	 * improvement from set_default_settings (see below):
-	 * take all info from function parameters
-	 * no global variables needed
-	 *
-	 * NOTE $glued_table should already have backticks around it
-	 * (get it from the database library, and it is done automatically)
-	 *
-	 * @param	path, filename, filetype,
-				$glued_table, default_visibility
+        $buffer = '';
+        if (file_exists($file_name)) {
+            $fp = fopen($file_name, 'rb');
+            $buffer = fread ($fp, filesize($file_name));
+            fclose ($fp);
+        }
+        return $buffer;
+    }
 
-	 * action:	Adds an entry to the document table with the default settings.
-	 * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
-	 * @author	Roan Embrechts
-	 * @version 1.2
-	 */
-	function set_default_settings($upload_path, $filename, $filetype = 'file', $glued_table, $default_visibility = 'v')
+    /**
+     * Adds file/folder to document table in database
+     * improvement from set_default_settings (see below):
+     * take all info from function parameters
+     * no global variables needed
+     *
+     * NOTE $glued_table should already have backticks around it
+     * (get it from the database library, and it is done automatically)
+     *
+     * @param	path, filename, filetype,
+				$glued_table, default_visibility
+     * action:	Adds an entry to the document table with the default settings.
+     * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
+     * @author	Roan Embrechts
+     * @version 1.2
+     */
+    function set_default_settings($upload_path, $filename, $filetype = 'file', $glued_table, $default_visibility = 'v')
     {
-		if (!$default_visibility) $default_visibility = 'v';
-
-		// Make sure path is not wrongly formed
-		$upload_path = !empty($upload_path) ? "/$upload_path" : '';
-
-		$endchar = substr($filename, strlen($filename) - 1, 1);
-		if ($endchar == "\\" || $endchar == '/') {
-			$filename = substr($filename, 0, strlen($filename) - 1);
-		}
-
-		$full_file_name = $upload_path.'/'.$filename;
-		$full_file_name = str_replace("//", '/', $full_file_name);
-
-		$sql_query = "SELECT count(*) as number_existing FROM $glued_table WHERE path='$full_file_name'";
-		$sql_result = Database::query($sql_query);
-		$result = Database::fetch_array($sql_result);
-		// Determine which query to execute
-		if ($result['number_existing'] > 0) {
-			// Entry exists, update
-			$query = "UPDATE $glued_table SET path='$full_file_name',visibility='$default_visibility', filetype='$filetype'
+        if (!$default_visibility) $default_visibility = 'v';
+
+        // Make sure path is not wrongly formed
+        $upload_path = !empty($upload_path) ? "/$upload_path" : '';
+
+        $endchar = substr($filename, strlen($filename) - 1, 1);
+        if ($endchar == "\\" || $endchar == '/') {
+            $filename = substr($filename, 0, strlen($filename) - 1);
+        }
+
+        $full_file_name = $upload_path.'/'.$filename;
+        $full_file_name = str_replace("//", '/', $full_file_name);
+
+        $sql_query = "SELECT count(*) as number_existing FROM $glued_table WHERE path='$full_file_name'";
+        $sql_result = Database::query($sql_query);
+        $result = Database::fetch_array($sql_result);
+        // Determine which query to execute
+        if ($result['number_existing'] > 0) {
+            // Entry exists, update
+            $query = "UPDATE $glued_table SET path='$full_file_name',visibility='$default_visibility', filetype='$filetype'
 			          WHERE path='$full_file_name'";
-		} else {
-			// No entry exists, create new one
-			$query = "INSERT INTO $glued_table (path,visibility,filetype)
+        } else {
+            // No entry exists, create new one
+            $query = "INSERT INTO $glued_table (path,visibility,filetype)
 			          VALUES ('$full_file_name','$default_visibility','$filetype')";
-		}
-		Database::query($query);
-	}
+        }
+        Database::query($query);
+    }
 }

main/inc/lib/fileUpload.lib.php

Doc Comments +10 added lines, -6 removed lines

@@ -17,6 +17,7 @@ 
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  - file_name (string) name of a file
+ * @param string $file_name
  * @return - the filenam phps'ized
  */
 function php2phps($file_name) {
@@ -73,7 +74,7 @@ 
  * Returns the name without extension, used for the title
  *
  * @param string $name
- * @return name without the extension
+ * @return string without the extension
  */
 function get_document_title($name) {
     // If they upload .htaccess...
@@ -86,7 +87,7 @@ 
  * This function checks if the upload succeeded
  *
  * @param array $uploaded_file ($_FILES)
- * @return true if upload succeeded
+ * @return boolean if upload succeeded
  */
 function process_uploaded_file($uploaded_file, $show_output = true)
 {
@@ -698,6 +699,8 @@ 
  * @param  - dir (string) - Path of the directory
  *           whe the file should be added
  * @param  - max_dir_space (int) - maximum size of the diretory in byte
+ * @param string $dir
+ * @param integer $max_dir_space
  * @return - boolean true if there is enough space,
  *				boolean false otherwise
  *
@@ -1022,7 +1025,7 @@ 
  * @param array  $courseInfo
  * @param array  $userInfo
  * @param array  $uploaded_file - follows the $_FILES Structure
- * @param string $upload_path   - destination of the upload.
+ * @param string $uploadPath   - destination of the upload.
  *                               This path is to append to $base_work_dir
  * @param string $base_work_dir  - base working directory of the module
  * @param int    $maxFilledSpace  - amount of bytes to not exceed in the base
@@ -1201,7 +1204,7 @@ 
  * @param bool $save_visibility
  * @param int $group_id
  * @param int $session_id Session ID, if any
- * @return int id if inserted document
+ * @return string|false id if inserted document
  */
 function add_document(
     $_course,
@@ -1337,7 +1340,7 @@ 
  *
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path+filename eg: /main/document/document.php
- * @return	The directory depth
+ * @return	integer directory depth
  */
 function get_levels($filename) {
     $levels = explode('/', $filename);
@@ -1354,6 +1357,7 @@ 
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path,filename
  * action:	Adds an entry to the document table with the default settings.
+ * @param string $upload_path
  */
 function set_default_settings($upload_path, $filename, $filetype = 'file')
 {
@@ -1778,6 +1782,7 @@ 
 
 @author Roan Embrechts
 @version 0.6
+ * @param string $buffer
  */
 function api_replace_links_in_string($upload_path, $buffer) {
     // Search for hyperlinks
@@ -2013,7 +2018,6 @@ 
  * @param int $groupId
  * @param bool $output
  * @param array $parent
- * @param string $uploadPath
  *
  */
 function add_all_documents_in_folder_to_database(

Indentation +1 added lines, -1 removed lines

@@ -2110,7 +2110,7 @@
                         $newFolderData = DocumentManager::get_document_data_by_id($documentId, $courseInfo, false, $sessionId);
                     }
                 } else {
-                   $newFolderData = create_unexisting_directory(
+                    $newFolderData = create_unexisting_directory(
                         $courseInfo,
                         $userId,
                         $sessionId,