Browse Source

Minor - format code.

Julio Montoya 10 years ago
parent
commit
fdb4d716f3
2 changed files with 129 additions and 131 deletions
  1. 34 38
      main/inc/lib/database.lib.php
  2. 95 93
      main/newscorm/scormItem.class.php

+ 34 - 38
main/inc/lib/database.lib.php

@@ -1,6 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
 /**
+ * Constants definition
+ */
+require_once 'database.constants.inc.php';
+
+/**
+ * Class Database
  *  This is the main database library for Chamilo.
  *  Include/require it in your code to use its functionality.
  *  Because this library contains all the basic database calls, it could be
@@ -13,20 +19,10 @@
  *
  *  @package chamilo.library
  */
-/**
- * Constants definition
- */
-require_once 'database.constants.inc.php';
-
-/**
- * Database class definition
- * @package chamilo.database
- */
 class Database
 {
     /* Variable use only in the installation process to log errors. See the Database::query function */
     static $log_queries = false;
-
     /*
         Accessor methods
         Usually, you won't need these directly but instead
@@ -158,7 +154,6 @@ class Database
     }
 
     /**
-
      * A more generic method than the older get_course_xxx_table methods,
      * This one can return the correct complete name of any course table of
      * which you pass the short name as a parameter.
@@ -169,7 +164,8 @@ class Database
      * @param string $database_name, optional, name of the course database
      * - if you don't specify this, you work on the current course.
      */
-    public static function get_course_table($short_table_name, $extra = null) {
+    public static function get_course_table($short_table_name, $extra = null)
+    {
         //forces fatal errors so we can debug more easily
         if (!empty($extra)) {
             var_dump($extra);
@@ -218,7 +214,7 @@ class Database
     */
 
     /**
-     *  @return a list (array) of all courses.
+     *  @return array a list (array) of all courses.
      *  @todo shouldn't this be in the course.lib.php script?
      */
     public static function get_course_list()
@@ -1183,13 +1179,12 @@ class Database
         return null;
     }
 
-    /*
-        New useful DB functions
-    */
-
     /**
-     * Experimental useful database insert
-     * @todo lot of stuff to do here
+     * Database insert
+     * @param string $table_name
+     * @param array $attributes
+     * @param bool $show_query
+     * @return bool|int
      */
     public static function insert($table_name, $attributes, $show_query = false)
     {
@@ -1363,7 +1358,7 @@ class Database
      */
     public static function parse_where_conditions($conditions)
     {
-        return self::parse_conditions(array('where'=>$conditions));
+        return self::parse_conditions(array('where' => $conditions));
     }
 
     /**
@@ -1381,25 +1376,28 @@ class Database
         return $affected_rows;
     }
 
-
     /**
-     * Experimental useful database update
-     * @param   string  table name use Database::get_main_table
-     * @param   array   array with values to updates, keys are the fields in the database: Example: $params['name'] = 'Julio'; $params['lastname'] = 'Montoya';
-     * @param   array   where conditions i.e array('id = ?' =>'4')
-     * @todo lot of stuff to do here
+     * @param string $table_name use Database::get_main_table
+     * @param array $attributes Values to updates
+     * Example: $params['name'] = 'Julio'; $params['lastname'] = 'Montoya';
+     * @param array $where_conditions where conditions i.e array('id = ?' =>'4')
+     * @param bool $show_query
+     * @return bool|int
      */
-    public static function update($table_name, $attributes, $where_conditions = array(), $show_query = false) {
-
+    public static function update(
+        $table_name,
+        $attributes,
+        $where_conditions = array(),
+        $show_query = false
+    ) {
         if (!empty($table_name) && !empty($attributes)) {
             $update_sql = '';
             //Cleaning attributes
             $count = 1;
             foreach ($attributes as $key=>$value) {
-
-                if (!is_array($value))
-
-                $value = self::escape_string($value);
+                if (!is_array($value)) {
+                    $value = self::escape_string($value);
+                }
                 $update_sql .= "$key = '$value' ";
                 if ($count < count($attributes)) {
                     $update_sql.=', ';
@@ -1410,8 +1408,10 @@ class Database
                 //Parsing and cleaning the where conditions
                 $where_return = self::parse_where_conditions($where_conditions);
                 $sql    = "UPDATE $table_name SET $update_sql $where_return ";
-                if ($show_query) { var_dump($sql); }
-                $result = self::query($sql);
+                if ($show_query) {
+                    var_dump($sql);
+                }
+                self::query($sql);
                 $affected_rows = self::affected_rows();
                 return $affected_rows;
             }
@@ -1419,10 +1419,6 @@ class Database
         return false;
     }
 
-     /*
-        DEPRECATED METHODS
-    */
-
     /**
      * @deprecated Use api_get_language_isocode($language) instead.
      */

+ 95 - 93
main/newscorm/scormItem.class.php

@@ -1,17 +1,17 @@
 <?php
 /* For licensing terms, see /license.txt */
 
+require_once 'learnpathItem.class.php';
+
 /**
+ * Class scormItem
+ * This class handles the <item> elements from an imsmanifest file.
  * Container for the scormItem class that deals with <item> elements in an imsmanifest file
  * @package	chamilo.learnpath.scorm
  * @author	Yannick Warnier	<ywarnier@beeznest.org>
  */
-
-/**
- * This class handles the <item> elements from an imsmanifest file.
- */
-require_once 'learnpathItem.class.php';
-class scormItem extends learnpathItem {
+class scormItem extends learnpathItem
+{
     public $identifier = '';
     public $identifierref = '';
     public $isvisible = '';
@@ -32,117 +32,117 @@ class scormItem extends learnpathItem {
     /**
      * Class constructor. Depending of the type of construction called ('db' or 'manifest'), will create a scormItem
      * object from database records or from the DOM element given as parameter
-     * @param	string	Type of construction needed ('db' or 'manifest', default = 'manifest')
-     * @param	mixed	Depending on the type given, DB id for the lp_item or reference to the DOM element
+     * @param	string	$type Type of construction needed ('db' or 'manifest', default = 'manifest')
+     * @param	mixed	$element Depending on the type given, DB id for the lp_item or reference to the DOM element
+     * @param int $course_id
      */
-    public function __construct($type = 'manifest', &$element, $course_id = '') {
+    public function __construct($type = 'manifest', &$element, $course_id = '')
+    {
         if (isset($element)) {
-
             // Parsing using PHP5 DOMXML methods.
-
             switch ($type) {
                 case 'db':
-                    parent::__construct($element,api_get_user_id(), $course_id);
+                    parent::__construct($element, api_get_user_id(), $course_id);
                     $this->scorm_contact = false;
                     // TODO: Implement this way of metadata object creation.
                     return false;
                 case 'manifest': // Do the same as the default.
                 default:
-                     //if ($first_item->type == XML_ELEMENT_NODE) this is already check prior to the call to this function.
-                     $children = $element->childNodes;
+                    //if ($first_item->type == XML_ELEMENT_NODE) this is already check prior to the call to this function.
+                    $children = $element->childNodes;
                     foreach ($children as $child) {
-                         switch ($child->nodeType) {
-                             case XML_ELEMENT_NODE:
+                        switch ($child->nodeType) {
+                            case XML_ELEMENT_NODE:
                                 switch ($child->tagName) {
-                                     case 'title':
-                                         $tmp_children = $child->childNodes;
-                                         if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
-                                             $this->title = $child->firstChild->nodeValue;
-                                         }
-                                         break;
-                                     case 'max_score':
-                                         if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
-                                             $this->max_score = $child->firstChild->nodeValue;
-                                         }
-                                         break;
-                                     case 'maxtimeallowed':
-                                     case 'adlcp:maxtimeallowed':
-                                         $tmp_children = $child->childNodes;
-                                         if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
-                                             $this->max_time_allowed = $child->firstChild->nodeValue;
-                                         }
-                                         break;
+                                    case 'title':
+                                        $tmp_children = $child->childNodes;
+                                        if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
+                                            $this->title = $child->firstChild->nodeValue;
+                                        }
+                                        break;
+                                    case 'max_score':
+                                        if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
+                                            $this->max_score = $child->firstChild->nodeValue;
+                                        }
+                                        break;
+                                    case 'maxtimeallowed':
+                                    case 'adlcp:maxtimeallowed':
+                                        $tmp_children = $child->childNodes;
+                                        if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
+                                            $this->max_time_allowed = $child->firstChild->nodeValue;
+                                        }
+                                        break;
                                     case 'prerequisites':
                                     case 'adlcp:prerequisites':
-                                         $tmp_children = $child->childNodes;
-                                         if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
-                                             $this->prereq_string = $child->firstChild->nodeValue;
-                                         }
-                                         break;
+                                        $tmp_children = $child->childNodes;
+                                        if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
+                                            $this->prereq_string = $child->firstChild->nodeValue;
+                                        }
+                                        break;
                                     case 'timelimitaction':
                                     case 'adlcp:timelimitaction':
-                                         $tmp_children = $child->childNodes;
-                                         if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
-                                             $this->timelimitaction = $child->firstChild->nodeValue;
-                                         }
-                                         break;
+                                        $tmp_children = $child->childNodes;
+                                        if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
+                                            $this->timelimitaction = $child->firstChild->nodeValue;
+                                        }
+                                        break;
                                     case 'datafromlms':
                                     case 'adlcp:datafromlms':
                                     case 'adlcp:launchdata': //in some cases (Wouters)
-                                         $tmp_children = $child->childNodes;
-                                         if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
-                                             $this->datafromlms = $child->firstChild->nodeValue;
-                                         }
-                                         break;
+                                        $tmp_children = $child->childNodes;
+                                        if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
+                                            $this->datafromlms = $child->firstChild->nodeValue;
+                                        }
+                                        break;
                                     case 'masteryscore':
                                     case 'adlcp:masteryscore':
-                                         $tmp_children = $child->childNodes;
-                                         if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
-                                             $this->mastery_score = $child->firstChild->nodeValue;
-                                         }
-                                         break;
-                                     case 'item':
-                                         $oItem = new scormItem('manifest',$child);
-                                         if ($oItem->identifier != '') {
-                                             $this->sub_items[$oItem->identifier] = $oItem;
-                                         }
+                                        $tmp_children = $child->childNodes;
+                                        if ($tmp_children->length == 1 && $child->firstChild->nodeValue != '') {
+                                            $this->mastery_score = $child->firstChild->nodeValue;
+                                        }
+                                        break;
+                                    case 'item':
+                                        $oItem = new scormItem('manifest',$child);
+                                        if ($oItem->identifier != '') {
+                                            $this->sub_items[$oItem->identifier] = $oItem;
+                                        }
                                         break;
-                                     case 'metadata':
-                                         $this->metadata = new scormMetadata('manifest', $child);
-                                         break;
-                                 }
-                                 break;
-                             case XML_TEXT_NODE:
-                                 // This case is actually treated by looking into ELEMENT_NODEs above.
-                                 break;
-                         }
-                     }
-                     if ($element->hasAttributes()) {
-                         $attributes = $element->attributes;
-                         //$keep_href = '';
-                         foreach ($attributes as $attrib) {
-                             switch($attrib->name){
-                                 case 'identifier':
-                                     $this->identifier = $attrib->value;
-                                     break;
-                                 case 'identifierref':
-                                     $this->identifierref = $attrib->value;
-                                     break;
-                                 case 'isvisible':
-                                     $this->isvisible = $attrib->value;
-                                     break;
-                                 case 'parameters':
-                                     $this->parameters = $attrib->value;
-                                     break;
-                             }
-                         }
-                     }
+                                    case 'metadata':
+                                        $this->metadata = new scormMetadata('manifest', $child);
+                                        break;
+                                }
+                                break;
+                            case XML_TEXT_NODE:
+                                // This case is actually treated by looking into ELEMENT_NODEs above.
+                                break;
+                        }
+                    }
+                    if ($element->hasAttributes()) {
+                        $attributes = $element->attributes;
+                        //$keep_href = '';
+                        foreach ($attributes as $attrib) {
+                            switch($attrib->name){
+                                case 'identifier':
+                                    $this->identifier = $attrib->value;
+                                    break;
+                                case 'identifierref':
+                                    $this->identifierref = $attrib->value;
+                                    break;
+                                case 'isvisible':
+                                    $this->isvisible = $attrib->value;
+                                    break;
+                                case 'parameters':
+                                    $this->parameters = $attrib->value;
+                                    break;
+                            }
+                        }
+                    }
+
                     return true;
             }
-
             // End parsing using PHP5 DOMXML methods.
-
         }
+
         return false;
     }
 
@@ -153,7 +153,8 @@ class scormItem extends learnpathItem {
      * @param	integer	Optional relative order of the item at this level
      * @param	integer	Optional level. If not given, assumes it's level 0
      */
-    public function get_flat_list(&$list, &$abs_order, $rel_order = 1, $level = 0) {
+    public function get_flat_list(&$list, &$abs_order, $rel_order = 1, $level = 0)
+    {
         $list[] = array(
             'abs_order' => $abs_order,
             'datafromlms' => $this->datafromlms,
@@ -184,7 +185,8 @@ class scormItem extends learnpathItem {
      * Save function. Uses the parent save function and adds a layer for SCORM.
      * @param	boolean	Save from URL params (1) or from object attributes (0)
      */
-    public function save($from_outside = true, $prereqs_complete = false) {
+    public function save($from_outside = true, $prereqs_complete = false)
+    {
         parent::save($from_outside, $prereqs_complete);
         // Under certain conditions, the scorm_contact should not be set, because no scorm signal was sent.
         $this->scorm_contact = true;