chamilo / chamilo-lms

main/lp/aicc.class.php

Doc Comments +5 added lines, -3 removed lines

@@ -216,7 +216,7 @@ 
     /**
      * Import the aicc object (as a result from the parse_config_files function) into the database structure
      * @param	string	$course_code
-     * @return	bool	Returns -1 on error
+     * @return	false|null	Returns -1 on error
      */
     public function import_aicc($course_code)
     {
@@ -780,7 +780,8 @@ 
      * Static function to parse AICC ini files.
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param	string	File path
-     * @return	array	Structured array
+     * @param string $f
+     * @return	string	Structured array
      */
     function parse_ini_file_quotes_safe($f) {
         $null = '';
@@ -831,7 +832,7 @@ 
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param		string	INI File string
      * @param		array	List of names of sections that should be considered as containing only hard string data (no variables), provided in lower case
-     * @return	array	Structured array
+     * @return	string	Structured array
      */
     function parse_ini_string_quotes_safe($s, $pure_strings = array()) {
         $null = '';
@@ -894,6 +895,7 @@ 
      * @param	string	CSV delimiter
      * @param	string	CSV enclosure
      * @param	boolean	Might one field name happen more than once on the same line? (then split by comma in the values)
+     * @param string $f
      * @return array	Simple structured array
      */
     function parse_csv_file($f, $delim = ',', $enclosure = '"', $multiples = false) {

Indentation +7 added lines, -7 removed lines

@@ -320,12 +320,12 @@ 
         }
     }
 
-     /**
-     * Intermediate to import_package only to allow import from local zip files
-     * @param	string	Path to the zip file, from the dokeos sys root
-     * @param	string	Current path (optional)
-     * @return string	Absolute path to the AICC description files or empty string on error
-     */
+        /**
+         * Intermediate to import_package only to allow import from local zip files
+         * @param	string	Path to the zip file, from the dokeos sys root
+         * @param	string	Current path (optional)
+         * @return string	Absolute path to the AICC description files or empty string on error
+         */
     function import_local_package($file_path, $current_dir = '')
     {
         // TODO: Prepare info as given by the $_FILES[''] vector.
@@ -355,7 +355,7 @@ 
         $current_dir = api_replace_dangerous_char(trim($current_dir)); // Current dir we are in, inside scorm/
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Current_dir = '.$current_dir, 0); }
 
-         //$uploaded_filename = $_FILES['userFile']['name'];
+            //$uploaded_filename = $_FILES['userFile']['name'];
         // Get the name of the zip file without the extension.
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Received zip file name: '.$zip_file_path, 0); }
         $file_info = pathinfo($zip_file_name);

Spacing +27 added lines, -27 removed lines

@@ -12,7 +12,7 @@ 
 class aicc extends learnpath
 {
     public $config = array();
-    public $config_basename = '';	// The configuration files might be multiple and might have
+    public $config_basename = ''; // The configuration files might be multiple and might have
                                     // funny names. We need to keep the name of that file while we
                                     // install the content.
     public $config_files = array();
@@ -32,9 +32,9 @@ 
     public $cstlist = array();
     public $orelist = array();
 
-    public $subdir = '';	// Path between the scorm/ directory and the config files e.g. maritime_nav/maritime_nav. This is the path that will be used in the lp_path when importing a package.
-    public $zipname = '';	// Keeps the zipfile safe for the object's life so that we can use it if there is no title available.
-    public $lastzipnameindex = 0;	// Keeps an index of the number of uses of the zipname so far.
+    public $subdir = ''; // Path between the scorm/ directory and the config files e.g. maritime_nav/maritime_nav. This is the path that will be used in the lp_path when importing a package.
+    public $zipname = ''; // Keeps the zipfile safe for the object's life so that we can use it if there is no title available.
+    public $lastzipnameindex = 0; // Keeps an index of the number of uses of the zipname so far.
     public $config_encoding = 'ISO-8859-1';
     public $debug = 0;
 
@@ -132,7 +132,7 @@ 
             //echo '<pre>des:'.print_r($des_params, true).'</pre>';
             if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$des_file.' has been parsed', 0); }
             // Distribute des params into the aicc object.
-            foreach ($des_params as $des){
+            foreach ($des_params as $des) {
                 // One AU in AICC is equivalent to one SCO in SCORM (scormItem class).
                 $oDes = new aiccResource('config', $des);
                 $this->deslist[$oDes->identifier] = $oDes;
@@ -242,12 +242,12 @@ 
 
         $this->config_encoding = "ISO-8859-1"; // TODO: We may apply detection for this value, see the function api_detect_encoding().
 
-        $sql = "INSERT INTO $new_lp (c_id, lp_type, name, ref, description, path, force_commit, default_view_mod, default_encoding, js_lib, content_maker,display_order)" .
-                "VALUES " .
-                "($course_id, 3, '".$this->course_title."', '".$this->course_id."','".$this->course_description."'," .
-                "'".$this->subdir."', 0, 'embedded', '".$this->config_encoding."'," .
+        $sql = "INSERT INTO $new_lp (c_id, lp_type, name, ref, description, path, force_commit, default_view_mod, default_encoding, js_lib, content_maker,display_order)".
+                "VALUES ".
+                "($course_id, 3, '".$this->course_title."', '".$this->course_id."','".$this->course_description."',".
+                "'".$this->subdir."', 0, 'embedded', '".$this->config_encoding."',".
                 "'aicc_api.php','".$this->course_creator."',$dsp)";
-        if ($this->debug > 2) { error_log('New LP - In import_aicc(), inserting path: '. $sql, 0); }
+        if ($this->debug > 2) { error_log('New LP - In import_aicc(), inserting path: '.$sql, 0); }
         Database::query($sql);
         $lp_id = Database::insert_id();
 
@@ -276,7 +276,7 @@ 
 
         $previous = 0;
         foreach ($this->aulist as $identifier => $dummy) {
-            $oAu =& $this->aulist[$identifier];
+            $oAu = & $this->aulist[$identifier];
             //echo "Item ".$oAu->identifier;
             $field_add = '';
             $value_add = '';
@@ -294,12 +294,12 @@ 
             $parent = 0; // TODO: Deal with the parent.
             $previous = 0;
             $prereq = $oAu->prereq_string;
-            $sql_item = "INSERT INTO $new_lp_item (c_id, lp_id,item_type,ref,title, path,min_score,max_score, $field_add parent_item_id,previous_item_id,next_item_id, prerequisite,display_order,parameters) " .
-                    "VALUES " .
-                    "($course_id, $lp_id, 'au','".$oAu->identifier."','".$title."'," .
-                    "'$path',0,100, $value_add" .
-                    "$parent, $previous, 0, " .
-                    "'$prereq', 0,'".(!empty($oAu->parameters)?Database::escape_string($oAu->parameters):'')."'" .
+            $sql_item = "INSERT INTO $new_lp_item (c_id, lp_id,item_type,ref,title, path,min_score,max_score, $field_add parent_item_id,previous_item_id,next_item_id, prerequisite,display_order,parameters) ".
+                    "VALUES ".
+                    "($course_id, $lp_id, 'au','".$oAu->identifier."','".$title."',".
+                    "'$path',0,100, $value_add".
+                    "$parent, $previous, 0, ".
+                    "'$prereq', 0,'".(!empty($oAu->parameters) ? Database::escape_string($oAu->parameters) : '')."'".
                     ")";
             Database::query($sql_item);
             if ($this->debug > 1) { error_log('New LP - In aicc::import_aicc() - inserting item : '.$sql_item.' : ', 0); }
@@ -350,7 +350,7 @@ 
         $zip_file_name = $zip_file_info['name'];
 
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Zip file path = '.$zip_file_path.', zip file name = '.$zip_file_name, 0); }
-        $course_rel_dir  = api_get_course_path().'/scorm'; // Scorm dir web path starting from /courses
+        $course_rel_dir = api_get_course_path().'/scorm'; // Scorm dir web path starting from /courses
         $course_sys_dir = api_get_path(SYS_COURSE_PATH).$course_rel_dir; // The absolute system path of this course.
         $current_dir = api_replace_dangerous_char(trim($current_dir)); // Current dir we are in, inside scorm/
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Current_dir = '.$current_dir, 0); }
@@ -367,7 +367,7 @@ 
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Base file name is : '.$file_base_name, 0); }
         $new_dir = api_replace_dangerous_char(trim($file_base_name));
         $this->subdir = $new_dir;
-        if($this->debug > 0) { error_log('New LP - aicc::import_package() - Subdir is first set to : '.$this->subdir, 0); }
+        if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Subdir is first set to : '.$this->subdir, 0); }
 
         /*
         if (check_name_exist($course_sys_dir.$current_dir.'/'.$new_dir)) {
@@ -413,7 +413,7 @@ 
                         $subdir_isset = true;
                     } else {
                         if (!$subdir_isset) {
-                            if (preg_match('?^.*/aicc$?i',dirname($thisContent['filename']))) {
+                            if (preg_match('?^.*/aicc$?i', dirname($thisContent['filename']))) {
                                 //echo "Cutting subdir<br/>";
                                 $this->subdir .= '/'.substr(dirname($thisContent['filename']), 0, -5);
                             } else {
@@ -516,7 +516,7 @@ 
                         // TODO: RENAMING FILES CAN BE VERY DANGEROUS AICC-WISE, avoid that as much as possible!
                         //$safe_file = api_replace_dangerous_char($file, 'strict');
                         $find_str = array('\\', '.php', '.phtml');
-                        $repl_str = array('/',  '.txt', '.txt');
+                        $repl_str = array('/', '.txt', '.txt');
                         $safe_file = str_replace($find_str, $repl_str, $file);
 
                         if ($safe_file != $file) {
@@ -717,7 +717,7 @@ 
         if ($this->debug > 0) { error_log('In aicc::get_res_path('.$id.') method', 0); }
         $path = '';
         if (isset($this->resources[$id])) {
-            $oRes =& $this->resources[$id];
+            $oRes = & $this->resources[$id];
             $path = @$oRes->get_path();
         }
         return $path;
@@ -733,7 +733,7 @@ 
         if ($this->debug > 0) { error_log('In aicc::get_res_type('.$id.') method', 0); }
         $type = '';
         if (isset($this->resources[$id])) {
-            $oRes =& $this->resources[$id];
+            $oRes = & $this->resources[$id];
             $temptype = $oRes->get_scorm_type();
             if (!empty($temptype)) {
                 $type = $temptype;
@@ -746,7 +746,7 @@ 
      * Gets the default organisation's title
      * @return	string	The organization's title
      */
-    function get_title(){
+    function get_title() {
         if ($this->debug > 0) { error_log('In aicc::get_title() method', 0); }
         $title = '';
         if (isset($this->config['organizations']['default'])) {
@@ -907,7 +907,7 @@ 
             $chr = $data{$i};
             switch ($chr) {
                 case $enclosure:
-                    if ($enclosed && $data{$i+1} == $enclosure) {
+                    if ($enclosed && $data{$i + 1} == $enclosure) {
                         $fldval .= $chr;
                         ++$i; // Skip the next character.
                     } else
@@ -921,7 +921,7 @@ 
                         $fldval .= $chr;
                     break;
                 case "\r":
-                    if (!$enclosed&&$data{$i+1} == "\n")
+                    if (!$enclosed && $data{$i + 1} == "\n")
                         continue;
                 case "\n":
                     if (!$enclosed) {
@@ -932,7 +932,7 @@ 
                         $fldval .= $chr;
                     break;
                 case "\\r":
-                    if (!$enclosed&&$data{$i+1} == "\\n")
+                    if (!$enclosed && $data{$i + 1} == "\\n")
                         continue;
                 case "\\n":
                     if (!$enclosed) {

Braces +21 added lines, -13 removed lines

@@ -509,7 +509,9 @@ 
                     if ($file != '.' && $file != '..') {
                         $filetype = 'file';
 
-                        if (is_dir($course_sys_dir.$new_dir.$file)) $filetype = 'folder';
+                        if (is_dir($course_sys_dir.$new_dir.$file)) {
+                            $filetype = 'folder';
+                        }
 
                         // TODO: RENAMING FILES CAN BE VERY DANGEROUS AICC-WISE, avoid that as much as possible!
                         //$safe_file = api_replace_dangerous_char($file, 'strict');
@@ -908,37 +910,43 @@ 
                     if ($enclosed && $data{$i+1} == $enclosure) {
                         $fldval .= $chr;
                         ++$i; // Skip the next character.
-                    } else
-                        $enclosed = !$enclosed;
+                    } else {
+                                            $enclosed = !$enclosed;
+                    }
                     break;
                 case $delim:
                     if (!$enclosed) {
                         $ret_array[$linecount][$fldcount++] = $fldval;
                         $fldval = '';
-                    } else
-                        $fldval .= $chr;
+                    } else {
+                                            $fldval .= $chr;
+                    }
                     break;
                 case "\r":
-                    if (!$enclosed&&$data{$i+1} == "\n")
-                        continue;
+                    if (!$enclosed&&$data{$i+1} == "\n") {
+                                            continue;
+                    }
                 case "\n":
                     if (!$enclosed) {
                         $ret_array[$linecount++][$fldcount] = $fldval;
                         $fldcount = 0;
                         $fldval = '';
-                    } else
-                        $fldval .= $chr;
+                    } else {
+                                            $fldval .= $chr;
+                    }
                     break;
                 case "\\r":
-                    if (!$enclosed&&$data{$i+1} == "\\n")
-                        continue;
+                    if (!$enclosed&&$data{$i+1} == "\\n") {
+                                            continue;
+                    }
                 case "\\n":
                     if (!$enclosed) {
                         $ret_array[$linecount++][$fldcount] = $fldval;
                         $fldcount = 0;
                         $fldval = '';
-                    } else
-                        $fldval .= $chr;
+                    } else {
+                                            $fldval .= $chr;
+                    }
                     break;
                 default:
                     $fldval .= $chr;

main/lp/learnpathList.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * @param   int     $categoryId
      * @param bool $ignoreCategoryFilter
      *
-     * @return	void
+     * @return	false|null
      */
     public function __construct(
         $user_id,

Spacing +2 added lines, -2 removed lines

@@ -118,7 +118,7 @@ 
             // it prevents ' to be slashed and the input (done by learnpath.class.php::toggle_visibility())
             // is done using domesticate()
             $myname = domesticate($row->getName());
-            $mylink = 'lp/lp_controller.php?action=view&lp_id=' . $row->getIid() . '&id_session='.$session_id;
+            $mylink = 'lp/lp_controller.php?action=view&lp_id='.$row->getIid().'&id_session='.$session_id;
 
             $sql2 = "SELECT * FROM $tbl_tool
                      WHERE
@@ -219,7 +219,7 @@ 
 
         $lessons = array();
         while ($row = Database::fetch_array($result)) {
-            if (api_get_item_visibility($course, 'learnpath', $row['id'],  $session_id)) {
+            if (api_get_item_visibility($course, 'learnpath', $row['id'], $session_id)) {
                 $lessons[$row['id']] = $row;
             }
         }

main/lp/lp_ajax_save_item.php

Doc Comments +3 added lines, -3 removed lines

@@ -20,9 +20,9 @@
  * @param   int $user_id User ID
  * @param   int $view_id View ID
  * @param   int $item_id Item ID
- * @param   float  $score Current score
- * @param   float  $max Maximum score
- * @param   float  $min Minimum score
+ * @param   integer  $score Current score
+ * @param   integer  $max Maximum score
+ * @param   integer  $min Minimum score
  * @param   string  $status Lesson status
  * @param   int  $time Session time
  * @param   string  $suspend Suspend data

Indentation +1 added lines, -1 removed lines

@@ -458,7 +458,7 @@
     }
 
     if ($myLP->get_type() == 2) {
-         $return .= "update_stats();";
+            $return .= "update_stats();";
     }
 
     // To be sure progress is updated.

Spacing +3 added lines, -3 removed lines

@@ -163,7 +163,7 @@ 
         // Set status to completed for hotpotatoes if score > 80%.
         if ($my_type == 'hotpotatoes') {
             if ((empty($status) || $status == 'undefined' || $status == 'not attempted') && $max > 0) {
-                if (($score/$max) > 0.8) {
+                if (($score / $max) > 0.8) {
                     $myStatus = 'completed';
                     if ($debug > 1) {
                         error_log('Calling set_status('.$myStatus.') for hotpotatoes', 0);
@@ -174,7 +174,7 @@ 
                         error_log('Done calling set_status for hotpotatoes - now '.$myLPI->get_status(false), 0);
                     }
                 }
-            } elseif ($status == 'completed' && $max > 0 && ($score/$max) < 0.8) {
+            } elseif ($status == 'completed' && $max > 0 && ($score / $max) < 0.8) {
                 $myStatus = 'failed';
                 if ($debug > 1) {
                     error_log('Calling set_status('.$myStatus.') for hotpotatoes', 0);
@@ -367,7 +367,7 @@ 
             $myLPI->current_data = $suspend;
         }
 
-        if (isset($location) && $location != '' && $location!='undefined') {
+        if (isset($location) && $location != '' && $location != 'undefined') {
             $myLPI->set_lesson_location($location);
         }
 

main/lp/lp_ajax_start_timer.php

Doc Comments +1 added lines, -1 removed lines

@@ -9,7 +9,7 @@
 /**
  * Start a timer and hand it back to the JS by assigning the current time (of start) to
  * var asset_timer
- * @return string JavaScript time intializer
+ * @return integer JavaScript time intializer
  */
 function start_timer() {
     $time = time();

main/lp/lp_final_item.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
  * @param int $sessionId
  * @param string $downloadCertificateLink
  * @param string $badgeLink
- * @return mixed|string
+ * @return string
  */
 function generateLPFinalItemTemplate($lpItemId, $courseCode, $sessionId=0, $downloadCertificateLink='', $badgeLink='')
 {

Spacing +10 added lines, -10 removed lines

@@ -8,7 +8,7 @@ 
 // Initialize context
 $_in_course = true;
 
-require_once __DIR__ . '/../inc/global.inc.php';
+require_once __DIR__.'/../inc/global.inc.php';
 
 $current_course_tool = TOOL_GRADEBOOK;
 
@@ -170,19 +170,19 @@ 
                 <div class='row'>
                     <div class='col-md-2 col-xs-4'>
                         <div class='thumbnail'>
-                          <img class='skill-badge-img' src='" . $skill->getWebIconPath() . "' >
+                          <img class='skill-badge-img' src='" . $skill->getWebIconPath()."' >
                         </div>
                     </div>
                     <div class='col-md-8 col-xs-8'>
-                        <h5><b>" . $skill->getName() . "</b></h5>
-                        " . $skill->getDescription() . "
+                        <h5><b>" . $skill->getName()."</b></h5>
+                        " . $skill->getDescription()."
                     </div>
                     <div class='col-md-2 col-xs-12'>
-                        <h5><b>" . get_lang('ShareWithYourFriends') . "</b></h5>
-                        <a href='http://www.facebook.com/sharer.php?u=" . api_get_path(WEB_PATH) . "badge/" . $skill->getId() . "/user/" . $userId . "' target='_new'>
+                        <h5><b>" . get_lang('ShareWithYourFriends')."</b></h5>
+                        <a href='http://www.facebook.com/sharer.php?u=" . api_get_path(WEB_PATH)."badge/".$skill->getId()."/user/".$userId."' target='_new'>
                             <em class='fa fa-facebook-square fa-3x text-info' aria-hidden='true'></em>
                         </a>
-                        <a href='https://twitter.com/home?status=" . sprintf(get_lang('IHaveObtainedSkillXOnY'), '"' . $skill->getName() . '"', api_get_setting('siteName')) . ' - ' . api_get_path(WEB_PATH) . 'badge/' . $skill->getId() . '/user/' . $userId . "' target='_new'>
+                        <a href='https://twitter.com/home?status=" . sprintf(get_lang('IHaveObtainedSkillXOnY'), '"'.$skill->getName().'"', api_get_setting('siteName')).' - '.api_get_path(WEB_PATH).'badge/'.$skill->getId().'/user/'.$userId."' target='_new'>
                             <em class='fa fa-twitter-square fa-3x text-light' aria-hidden='true'></em>
                         </a>
                     </div>
@@ -192,7 +192,7 @@ 
         $badgeLink .= "
             <div class='panel panel-default'>
                 <div class='panel-body'>
-                    <h3 class='text-center'>" . get_lang('AdditionallyYouHaveObtainedTheFollowingSkills') . "</h3>
+                    <h3 class='text-center'>" . get_lang('AdditionallyYouHaveObtainedTheFollowingSkills')."</h3>
                     $skillList
                 </div>
             </div>
@@ -209,7 +209,7 @@ 
 function generateLPFinalItemTemplateCertificateLinks($certificate)
 {
     $downloadCertificateLink = Display::url(
-        Display::returnFontAwesomeIcon('file-pdf-o') . get_lang('DownloadCertificatePdf'),
+        Display::returnFontAwesomeIcon('file-pdf-o').get_lang('DownloadCertificatePdf'),
         $certificate['pdf_url'],
         ['class' => 'btn btn-default']
     );
@@ -217,7 +217,7 @@ 
     $downloadCertificateLink = "
         <div class='panel panel-default'>
             <div class='panel-body'>
-                <h3 class='text-center'>" . get_lang('NowDownloadYourCertificateClickHere') . "</h3>
+                <h3 class='text-center'>" . get_lang('NowDownloadYourCertificateClickHere')."</h3>
                 <div class='text-center'>$downloadCertificateLink $viewCertificateLink</div>
             </div>
         </div>

main/lp/openoffice_text.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -38,7 +38,7 @@ 
     /**
      * Gets html pages and compose them into a learning path
      * @param	array	The files that will compose the generated learning path. Unused so far.
-     * @return	boolean	False if file does not exit. Nothing otherwise.
+     * @return	false|null	False if file does not exit. Nothing otherwise.
      */
     public function make_lp($files = array())
     {
@@ -92,6 +92,7 @@ 
      * Manages chapter splitting
      * @param	string	Chapter header
      * @param	string	Content
+     * @param string $content
      * @return	void
      */
     function dealPerChapter($header, $content)
@@ -164,6 +165,7 @@ 
      * Manages page splitting
      * @param	string	Page header
      * @param	string	Page body
+     * @param string $body
      * @return	void
      */
     function dealPerPage($header, $body)

Spacing +9 added lines, -9 removed lines

@@ -126,7 +126,7 @@ 
             if (empty($matches[1][$i]))
                 continue;
 
-            $content = strstr($content,$matches[0][$i]);
+            $content = strstr($content, $matches[0][$i]);
             if ($i + 1 !== count($matches[0])) {
                 $chapter_content = substr($content, 0, strpos($content, $matches[0][$i + 1]));
             } else {
@@ -148,7 +148,7 @@ 
 
             $document_id = add_document($_course, $this->created_dir.'/'.$html_file, 'file', filesize($this->base_work_dir.$this->created_dir.'/'.$html_file), $html_file);
 
-            if ($document_id){
+            if ($document_id) {
 
                 // Put the document in item_property update.
                 api_item_property_update(
@@ -254,7 +254,7 @@ 
                         foreach ($specific_fields as $specific_field) {
                             if (isset($_REQUEST[$specific_field['code']])) {
                                 $sterms = trim($_REQUEST[$specific_field['code']]);
-                                $all_specific_terms .= ' '. $sterms;
+                                $all_specific_terms .= ' '.$sterms;
                                 if (!empty($sterms)) {
                                     $sterms = explode(',', $sterms);
                                     foreach ($sterms as $sterm) {
@@ -263,10 +263,10 @@ 
                                 }
                             }
                         }
-                        $page_content = $all_specific_terms .' '. $page_content;
+                        $page_content = $all_specific_terms.' '.$page_content;
                         $ic_slide->addValue('content', $page_content);
                         // Add a comment to say terms separated by commas.
-                        $courseid=api_get_course_id();
+                        $courseid = api_get_course_id();
                         $ic_slide->addCourseId($courseid);
                         $ic_slide->addToolId(TOOL_LEARNPATH);
                         $lp_id = $this->lp_id;
@@ -274,7 +274,7 @@ 
                             SE_COURSE_ID => $courseid,
                             SE_TOOL_ID => TOOL_LEARNPATH,
                             SE_DATA => array('lp_id' => $lp_id, 'lp_item'=> $previous, 'document_id' => $document_id),
-                            SE_USER => (int)api_get_user_id(),
+                            SE_USER => (int) api_get_user_id(),
                         );
                         $ic_slide->xapian_data = serialize($xapian_data);
                         $di->addChunk($ic_slide);
@@ -298,7 +298,7 @@ 
      * Returns additional Java command parameters
      * @return	string	The additional parameters to be used in the Java call
      */
-    function add_command_parameters(){
+    function add_command_parameters() {
         return ' -d woogie "'.$this->base_work_dir.'/'.$this->file_path.'"  "'.$this->base_work_dir.$this->created_dir.'/'.$this->file_name.'.html"';
     }
 
@@ -310,7 +310,7 @@ 
      */
     function format_page_content($header, $content) {
         // Limit the width of the doc.
-        list($max_width, $max_height) = explode('x',api_get_setting('service_ppt2lp','size'));
+        list($max_width, $max_height) = explode('x', api_get_setting('service_ppt2lp', 'size'));
 
         $content = preg_replace("|<body[^>]*>|i", "\\0\r\n<div style=\"width:".$max_width."\">", $content, -1, $count);
         if ($count < 1) {
@@ -343,7 +343,7 @@ 
                 }
 
             } elseif ($img_width > $max_width - 10) {
-                $picture_resized = str_ireplace('width='.$img_width, 'width="'.($max_width-10).'"', $images[0][$key]);
+                $picture_resized = str_ireplace('width='.$img_width, 'width="'.($max_width - 10).'"', $images[0][$key]);
                 $content = str_replace($images[0][$key], $picture_resized, $content);
             }
         }

Braces +3 added lines, -2 removed lines

@@ -119,8 +119,9 @@
 
         for ($i = 0; $i<count($matches[0]); $i++) {
 
-            if (empty($matches[1][$i]))
-                continue;
+            if (empty($matches[1][$i])) {
+                            continue;
+            }
 
             $content = api_strstr($content, $matches[0][$i]);
             if ($i + 1 !== count($matches[0])) {

main/lp/openoffice_text_document.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -38,7 +38,7 @@ 
     /**
      * Gets html pages and compose them into a learning path
      * @param	array	The files that will compose the generated learning path. Unused so far.
-     * @return	boolean	False if file does not exit. Nothing otherwise.
+     * @return	false|null	False if file does not exit. Nothing otherwise.
      */
     public function make_lp($files = array())
     {
@@ -92,6 +92,7 @@ 
      * Manages chapter splitting
      * @param	string	Chapter header
      * @param	string	Content
+     * @param string $content
      * @return	void
      */
     function dealPerChapter($header, $content)
@@ -164,6 +165,7 @@ 
      * Manages page splitting
      * @param	string	Page header
      * @param	string	Page body
+     * @param string $body
      * @return	void
      */
     function dealPerPage($header, $body)

Spacing +7 added lines, -7 removed lines

@@ -117,7 +117,7 @@ 
         $intro_content = api_substr($content, 0, api_strpos($content, $matches[0][0]));
         $items_to_create[get_lang('Introduction')] = $intro_content;
 
-        for ($i = 0; $i<count($matches[0]); $i++) {
+        for ($i = 0; $i < count($matches[0]); $i++) {
 
             if (empty($matches[1][$i]))
                 continue;
@@ -174,7 +174,7 @@ 
 
         $first_item = 0;
 
-        foreach($pages as $key => $page_content) {
+        foreach ($pages as $key => $page_content) {
             // For every pages, we create a new file.
 
             $key += 1;
@@ -213,7 +213,7 @@ 
                     foreach ($specific_fields as $specific_field) {
                         if (isset($_REQUEST[$specific_field['code']])) {
                             $sterms = trim($_REQUEST[$specific_field['code']]);
-                            $all_specific_terms .= ' '. $sterms;
+                            $all_specific_terms .= ' '.$sterms;
                             if (!empty($sterms)) {
                                 $sterms = explode(',', $sterms);
                                 foreach ($sterms as $sterm) {
@@ -222,7 +222,7 @@ 
                             }
                         }
                     }
-                    $page_content = $all_specific_terms .' '. $page_content;
+                    $page_content = $all_specific_terms.' '.$page_content;
                     $ic_slide->addValue('content', $page_content);
                     // Add a comment to say terms separated by commas.
                     $courseid = api_get_course_id();
@@ -233,7 +233,7 @@ 
                         SE_COURSE_ID => $courseid,
                         SE_TOOL_ID => TOOL_LEARNPATH,
                         SE_DATA => array('lp_id' => $lp_id, 'lp_item' => $previous, 'document_id' => $document_id),
-                        SE_USER => (int)api_get_user_id(),
+                        SE_USER => (int) api_get_user_id(),
                     );
                     $ic_slide->xapian_data = serialize($xapian_data);
                     $di->addChunk($ic_slide);
@@ -276,7 +276,7 @@ 
             $content = '<body><div style="width:'.$max_width.'">'.$content;
         }
 
-        $content = preg_replace('|</body>|i','</div>\\0', $content, -1, $count);
+        $content = preg_replace('|</body>|i', '</div>\\0', $content, -1, $count);
         if ($count < 1) {
             $content = $content.'</div></body>';
         }
@@ -304,7 +304,7 @@ 
                 }
 
             } elseif ($img_width > $max_width - 10) {
-                $picture_resized = str_ireplace('width='.$img_width, 'width="'.($max_width-10).'"', $images[0][$key]);
+                $picture_resized = str_ireplace('width='.$img_width, 'width="'.($max_width - 10).'"', $images[0][$key]);
                 $content = str_replace($images[0][$key], $picture_resized, $content);
             }
         }

Braces +3 added lines, -2 removed lines

@@ -119,8 +119,9 @@
 
         for ($i = 0; $i<count($matches[0]); $i++) {
 
-            if (empty($matches[1][$i]))
-                continue;
+            if (empty($matches[1][$i])) {
+                            continue;
+            }
 
             $content = api_strstr($content, $matches[0][$i]);
             if ($i + 1 !== count($matches[0])) {

main/lp/scorm.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -271,7 +271,7 @@ 
      * @param int $userMaxScore
      * @param int $sessionId
      *
-     * @return bool	Returns -1 on error
+     * @return boolean|null	Returns -1 on error
      */
     public function import_manifest($courseCode, $userMaxScore = 1, $sessionId = 0, $userId = 0)
     {
@@ -925,7 +925,7 @@ 
      * @param	string	course Code
      * @param string	LP ID (in database)
      * @param string	Manifest file path (optional if lp_id defined)
-     * @return	integer	New LP ID or false on failure
+     * @return	boolean	New LP ID or false on failure
      * TODO @TODO Implement imsmanifest_path parameter
      */
     public function reimport_manifest($courseCode, $lp_id = null, $imsmanifest_path = '')

Spacing +19 added lines, -19 removed lines

@@ -393,7 +393,7 @@ 
                 $path = '';
                 $type = 'dir';
                 if (isset($this->resources[$item['identifierref']])) {
-                    $oRes =& $this->resources[$item['identifierref']];
+                    $oRes = & $this->resources[$item['identifierref']];
                     $path = @$oRes->get_path();
                     if (!empty($path)) {
                         $temptype = $oRes->get_scorm_type();
@@ -444,7 +444,7 @@ 
                 $item['parameters'] = Database::escape_string($item['parameters']);
 
                 $sql = "INSERT INTO $new_lp_item (c_id, lp_id,item_type,ref,title, path,min_score,max_score, $field_add parent_item_id,previous_item_id,next_item_id, prerequisite,display_order,launch_data, parameters)
-                        VALUES ($courseId, $lp_id, '$type', '$identifier', '$title', '$path' , 0, $max_score, $value_add $parent, $previous, 0, '$prereq', ".$item['rel_order'] .", '".$item['datafromlms']."', '".$item['parameters']."' )";
+                        VALUES ($courseId, $lp_id, '$type', '$identifier', '$title', '$path' , 0, $max_score, $value_add $parent, $previous, 0, '$prereq', ".$item['rel_order'].", '".$item['datafromlms']."', '".$item['parameters']."' )";
 
                 Database::query($sql);
                 if ($this->debug > 1) { error_log('New LP - In import_manifest(), inserting item : '.$sql, 0); }
@@ -478,7 +478,7 @@ 
                     foreach ($specific_fields as $specific_field) {
                         if (isset($_REQUEST[$specific_field['code']])) {
                             $sterms = trim($_REQUEST[$specific_field['code']]);
-                            $all_specific_terms .= ' '. $sterms;
+                            $all_specific_terms .= ' '.$sterms;
                             if (!empty($sterms)) {
                                 $sterms = explode(',', $sterms);
                                 foreach ($sterms as $sterm) {
@@ -487,7 +487,7 @@ 
                             }
                         }
                     }
-                    $body_to_index = $all_specific_terms .' '. $title;
+                    $body_to_index = $all_specific_terms.' '.$title;
                     $ic_slide->addValue("content", $body_to_index);
                     // TODO: Add a comment to say terms separated by commas.
                     $courseid = api_get_course_id();
@@ -497,7 +497,7 @@ 
                         SE_COURSE_ID => $courseid,
                         SE_TOOL_ID => TOOL_LEARNPATH,
                         SE_DATA => array('lp_id' => $lp_id, 'lp_item'=> $previous, 'document_id' => ''), // TODO: Unify with other lp types.
-                        SE_USER => (int)api_get_user_id(),
+                        SE_USER => (int) api_get_user_id(),
                     );
                     $ic_slide->xapian_data = serialize($xapian_data);
                     $di->addChunk($ic_slide);
@@ -543,7 +543,7 @@ 
     public function import_package($zip_file_info, $current_dir = '', $courseInfo = array())
     {
         if ($this->debug > 0) {
-            error_log('In scorm::import_package('.print_r($zip_file_info,true).',"'.$current_dir.'") method', 0);
+            error_log('In scorm::import_package('.print_r($zip_file_info, true).',"'.$current_dir.'") method', 0);
         }
 
         $courseInfo = empty($courseInfo) ? api_get_course_info() : $courseInfo;
@@ -554,7 +554,7 @@ 
         $zip_file_name = $zip_file_info['name'];
 
         if ($this->debug > 1) {
-            error_log('New LP - import_package() - zip file path = ' . $zip_file_path . ', zip file name = ' . $zip_file_name, 0);
+            error_log('New LP - import_package() - zip file path = '.$zip_file_path.', zip file name = '.$zip_file_name, 0);
         }
 
         $course_rel_dir = api_get_course_path($courseInfo['code']).'/scorm'; // scorm dir web path starting from /courses
@@ -562,7 +562,7 @@ 
         $current_dir = api_replace_dangerous_char(trim($current_dir)); // Current dir we are in, inside scorm/
 
         if ($this->debug > 1) {
-            error_log( 'New LP - import_package() - current_dir = ' . $current_dir, 0);
+            error_log('New LP - import_package() - current_dir = '.$current_dir, 0);
         }
 
         // Get name of the zip file without the extension.
@@ -570,7 +570,7 @@ 
         $file_info = pathinfo($zip_file_name);
         $filename = $file_info['basename'];
         $extension = $file_info['extension'];
-        $file_base_name = str_replace('.'.$extension,'',$filename); // Filename without its extension.
+        $file_base_name = str_replace('.'.$extension, '', $filename); // Filename without its extension.
         $this->zipname = $file_base_name; // Save for later in case we don't have a title.
 
         if ($this->debug > 1) { error_log("New LP - base file name is : ".$file_base_name, 0); }
@@ -616,7 +616,7 @@ 
         $slash_count = substr_count($shortest_path, '/');
         foreach ($manifest_list as $manifest_path) {
             $tmp_slash_count = substr_count($manifest_path, '/');
-            if ($tmp_slash_count<$slash_count) {
+            if ($tmp_slash_count < $slash_count) {
                 $shortest_path = $manifest_path;
                 $slash_count = $tmp_slash_count;
             }
@@ -625,7 +625,7 @@ 
         $this->subdir .= '/'.dirname($shortest_path); // Do not concatenate because already done above.
         $manifest = $shortest_path;
         if ($this->debug > 1) { error_log('New LP - Package type is now '.$package_type, 0); }
-        if ($package_type== '') {
+        if ($package_type == '') {
             // && defined('CHECK_FOR_SCORM') && CHECK_FOR_SCORM)
             if ($this->debug > 1) { error_log('New LP - Package type is empty', 0); }
             return api_failure::set_failure('not_scorm_content');
@@ -641,8 +641,8 @@ 
             $new_dir = '/'.$new_dir;
         }
 
-        if ($new_dir[strlen($new_dir)-1] == '/') {
-            $new_dir = substr($new_dir,0,-1);
+        if ($new_dir[strlen($new_dir) - 1] == '/') {
+            $new_dir = substr($new_dir, 0, -1);
         }
 
         /* Uncompressing phase */
@@ -683,7 +683,7 @@ 
                     if ($file != '.' && $file != '..') {
                         $filetype = 'file';
 
-                        if (is_dir($course_sys_dir . $new_dir . $file)) {
+                        if (is_dir($course_sys_dir.$new_dir.$file)) {
                             $filetype = 'folder';
                         }
 
@@ -712,7 +712,7 @@ 
                                     }
                                 }
                             }
-                            @rename($course_sys_dir.$new_dir.$file,$course_sys_dir.$new_dir.$safe_file);
+                            @rename($course_sys_dir.$new_dir.$file, $course_sys_dir.$new_dir.$safe_file);
                             if ($this->debug >= 1) { error_log('New LP - Renaming '.$course_sys_dir.$new_dir.$file.' to '.$course_sys_dir.$new_dir.$safe_file, 0); }
                         }
                     }
@@ -901,7 +901,7 @@ 
         if ($this->debug > 0) { error_log('In scorm::get_res_path('.$id.') method', 0); }
         $path = '';
         if (isset($this->resources[$id])) {
-            $oRes =& $this->resources[$id];
+            $oRes = & $this->resources[$id];
             $path = @$oRes->get_path();
         }
         return $path;
@@ -917,7 +917,7 @@ 
         if ($this->debug > 0) { error_log('In scorm::get_res_type('.$id.') method', 0); }
         $type = '';
         if (isset($this->resources[$id])) {
-            $oRes =& $this->resources[$id];
+            $oRes = & $this->resources[$id];
             $temptype = $oRes->get_scorm_type();
             if (!empty($temptype)) {
                 $type = $temptype;
@@ -936,9 +936,9 @@ 
         $title = '';
         if (isset($this->manifest['organizations']['default'])) {
             $title = $this->organizations[$this->manifest['organizations']['default']]->get_name();
-        } elseif (count($this->organizations)==1) {
+        } elseif (count($this->organizations) == 1) {
             // This will only get one title but so we don't need to know the index.
-            foreach($this->organizations as $id => $value) {
+            foreach ($this->organizations as $id => $value) {
                 $title = $this->organizations[$id]->get_name();
                 break;
             }

main/lp/lp_move_item.php

Indentation +3 added lines, -3 removed lines

@@ -47,10 +47,10 @@
 " .
 "\n" .
 '$().ready(function() {'."\n" .
-  'if ($(\'#previous\')) {'."\n" .
+    'if ($(\'#previous\')) {'."\n" .
     'if(\'parent is\'+$(\'#idParent\').val()) {'.
-      'load_cbo($(\'#idParent\').val());'."\n" .
-  '}}'."\n" .
+        'load_cbo($(\'#idParent\').val());'."\n" .
+    '}}'."\n" .
 '});</script>'."\n" ;
 
 /* Constants and variables */

Spacing +9 added lines, -9 removed lines

@@ -21,7 +21,7 @@ 
 
 /* Header and action code */
 $htmlHeadXtra[] = '<script type="text/javascript">'.
-$_SESSION['oLP']->get_js_dropdown_array() .
+$_SESSION['oLP']->get_js_dropdown_array().
 "
     function load_cbo(id) {
         if (!id) {
@@ -45,13 +45,13 @@ 
         $('#previous').selectpicker('refresh');
     }
 " .
-"\n" .
-'$().ready(function() {'."\n" .
-  'if ($(\'#previous\')) {'."\n" .
+"\n".
+'$().ready(function() {'."\n".
+  'if ($(\'#previous\')) {'."\n".
     'if(\'parent is\'+$(\'#idParent\').val()) {'.
-      'load_cbo($(\'#idParent\').val());'."\n" .
-  '}}'."\n" .
-'});</script>'."\n" ;
+      'load_cbo($(\'#idParent\').val());'."\n".
+  '}}'."\n".
+'});</script>'."\n";
 
 /* Constants and variables */
 
@@ -90,11 +90,11 @@ 
 /* SHOWING THE ADMIN TOOLS */
 
 if (isset($_SESSION['gradebook'])) {
-    $gradebook=	$_SESSION['gradebook'];
+    $gradebook = $_SESSION['gradebook'];
 }
 
 if (!empty($gradebook) && $gradebook == 'view') {
-    $interbreadcrumb[] = array (
+    $interbreadcrumb[] = array(
         'url' => '../gradebook/'.$_SESSION['gradebook_dest'],
         'name' => get_lang('ToolGradebook')
     );