chamilo / chamilo-lms

main/inc/lib/getid3/getid3.php

Doc Comments +22 added lines

@@ -456,6 +456,10 @@ 
 
 
     // Add warning(s) to $this->warnings[]
+
+    /**
+     * @param string $message
+     */
     public function warning($message) {
 
         if (is_array($message)) {
@@ -482,6 +486,11 @@ 
 
 
     // Convert string between charsets -- iconv() wrapper
+
+    /**
+     * @param string $out_charset
+     * @param string $string
+     */
     public function iconv($in_charset, $out_charset, $string, $drop01 = false) {
 
         if ($drop01 && ($string === "\x00" || $string === "\x01")) {
@@ -509,6 +518,9 @@ 
 
 
 
+    /**
+     * @param string $name
+     */
     public function include_module($name) {
 
         if (!file_exists($this->include_path.'module.'.$name.'.php')) {
@@ -1342,6 +1354,10 @@ 
 
 
     // Convert Big Endian byte string to int - max 32 bits
+
+    /**
+     * @param string $byte_word
+     */
     public static function BigEndian2Int($byte_word, $signed = false) {
 
         $int_value = 0;
@@ -1391,6 +1407,9 @@ 
 
 
 
+    /**
+     * @param string $byte_word
+     */
     public static function BigEndian2Float($byte_word) {
 
 		// ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic
@@ -1478,6 +1497,9 @@ 
 
 
 
+	/**
+	 * @param string $binary_numerator
+	 */
 	public static function DecimalBinary2Float($binary_numerator) {
 		$numerator   = bindec($binary_numerator);
 		$denominator = bindec('1'.str_repeat('0', strlen($binary_numerator)));

Indentation +165 added lines, -165 removed lines

@@ -300,7 +300,7 @@ 
         $class = new $class_name($this);
 
         try {
-             $this->option_analyze and $class->Analyze();
+                $this->option_analyze and $class->Analyze();
             }
         catch (getid3_exception $e) {
             throw $e;
@@ -383,7 +383,7 @@ 
             // CalculateReplayGain() {
             if (@$this->info['replay_gain']) {
                 if (!@$this->info['replay_gain']['reference_volume']) {
-                     $this->info['replay_gain']['reference_volume'] = 89;
+                        $this->info['replay_gain']['reference_volume'] = 89;
                 }
                 if (isset($this->info['replay_gain']['track']['adjustment'])) {
                     $this->info['replay_gain']['track']['volume'] = $this->info['replay_gain']['reference_volume'] - $this->info['replay_gain']['track']['adjustment'];
@@ -403,7 +403,7 @@ 
 
             // ProcessAudioStreams() {
             if (@!$this->info['audio']['streams'] && (@$this->info['audio']['bitrate'] || @$this->info['audio']['channels'] || @$this->info['audio']['sample_rate'])) {
-                  foreach ($this->info['audio'] as $key => $value) {
+                    foreach ($this->info['audio'] as $key => $value) {
                     if ($key != 'streams') {
                         $this->info['audio']['streams'][0][$key] = $value;
                     }
@@ -544,7 +544,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'ac3',
                             'mime_type' => 'audio/ac3',
-                          ),
+                            ),
 
                 // AAC  - audio       - Advanced Audio Coding (AAC) - ADIF format
                 'adif' => array (
@@ -553,7 +553,7 @@ 
                             'module'    => 'aac_adif',
                             'mime_type' => 'application/octet-stream',
                             'fail_ape'  => 'WARNING',
-                          ),
+                            ),
 
 
                 // AAC  - audio       - Advanced Audio Coding (AAC) - ADTS format (very similar to MP3)
@@ -563,7 +563,7 @@ 
                             'module'    => 'aac_adts',
                             'mime_type' => 'application/octet-stream',
                             'fail_ape'  => 'WARNING',
-                          ),
+                            ),
 
 
                 // AU   - audio       - NeXT/Sun AUdio (AU)
@@ -572,7 +572,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'au',
                             'mime_type' => 'audio/basic',
-                          ),
+                            ),
 
                 // AVR  - audio       - Audio Visual Research
                 'avr'  => array (
@@ -580,7 +580,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'avr',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // BONK - audio       - Bonk v0.9+
                 'bonk' => array (
@@ -588,15 +588,15 @@ 
                             'group'     => 'audio',
                             'module'    => 'bonk',
                             'mime_type' => 'audio/xmms-bonk',
-                          ),
+                            ),
 
                 // DTS  - audio       - Dolby Theatre System
-				'dts'  => array(
-							'pattern'   => '^\x7F\xFE\x80\x01',
-							'group'     => 'audio',
-							'module'    => 'dts',
-							'mime_type' => 'audio/dts',
-						),
+                'dts'  => array(
+                            'pattern'   => '^\x7F\xFE\x80\x01',
+                            'group'     => 'audio',
+                            'module'    => 'dts',
+                            'mime_type' => 'audio/dts',
+                        ),
 
                 // FLAC - audio       - Free Lossless Audio Codec
                 'flac' => array (
@@ -604,7 +604,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'xiph',
                             'mime_type' => 'audio/x-flac',
-                          ),
+                            ),
 
                 // LA   - audio       - Lossless Audio (LA)
                 'la'   => array (
@@ -612,7 +612,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'la',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // LPAC - audio       - Lossless Predictive Audio Compression (LPAC)
                 'lpac' => array (
@@ -620,7 +620,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'lpac',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // MIDI - audio       - MIDI (Musical Instrument Digital Interface)
                 'midi' => array (
@@ -628,7 +628,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'midi',
                             'mime_type' => 'audio/midi',
-                          ),
+                            ),
 
                 // MAC  - audio       - Monkey's Audio Compressor
                 'mac'  => array (
@@ -636,31 +636,31 @@ 
                             'group'     => 'audio',
                             'module'    => 'monkey',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // MOD  - audio       - MODule (assorted sub-formats)
                 'mod'  => array (
                             'pattern'   => '^.{1080}(M.K.|[5-9]CHN|[1-3][0-9]CH)',
                             'mime_type' => 'audio/mod',
-                          ),
+                            ),
 
                 // MOD  - audio       - MODule (Impulse Tracker)
                 'it'   => array (
                             'pattern'   => '^IMPM',
                             'mime_type' => 'audio/it',
-                          ),
+                            ),
 
                 // MOD  - audio       - MODule (eXtended Module, various sub-formats)
                 'xm'   => array (
                             'pattern'   => '^Extended Module',
                             'mime_type' => 'audio/xm',
-                          ),
+                            ),
 
                 // MOD  - audio       - MODule (ScreamTracker)
                 's3m'  => array (
                             'pattern'   => '^.{44}SCRM',
                             'mime_type' => 'audio/s3m',
-                          ),
+                            ),
 
                 // MPC  - audio       - Musepack / MPEGplus SV7+
                 'mpc'  => array (
@@ -668,7 +668,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'mpc',
                             'mime_type' => 'audio/x-musepack',
-                          ),
+                            ),
 
                 // MPC  - audio       - Musepack / MPEGplus SV4-6
                 'mpc_old' => array (
@@ -676,7 +676,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'mpc_old',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
 
                 // MP3  - audio       - MPEG-audio Layer 3 (very similar to AAC-ADTS)
@@ -685,7 +685,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'mp3',
                             'mime_type' => 'audio/mpeg',
-                          ),
+                            ),
 
                 // OFR  - audio       - OptimFROG
                 'ofr'  => array (
@@ -693,7 +693,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'optimfrog',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // RKAU - audio       - RKive AUdio compressor
                 'rkau' => array (
@@ -701,7 +701,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'rkau',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // SHN  - audio       - Shorten
                 'shn'  => array (
@@ -711,7 +711,7 @@ 
                             'mime_type' => 'audio/xmms-shn',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
                 // TTA  - audio       - TTA Lossless Audio Compressor (http://tta.corecodec.org)
                 'tta'  => array (
@@ -719,7 +719,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'tta',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // VOC  - audio       - Creative Voice (VOC)
                 'voc'  => array (
@@ -727,7 +727,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'voc',
                             'mime_type' => 'audio/voc',
-                          ),
+                            ),
 
                 // VQF  - audio       - transform-domain weighted interleave Vector Quantization Format (VQF)
                 'vqf'  => array (
@@ -735,7 +735,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'vqf',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // WV  - audio        - WavPack (v4.0+)
                 'vw'  => array(
@@ -743,7 +743,7 @@ 
                             'group'     => 'audio',
                             'module'    => 'wavpack',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
 
                 // Audio-Video formats
@@ -754,13 +754,13 @@ 
                             'group'     => 'audio-video',
                             'module'    => 'asf',
                             'mime_type' => 'video/x-ms-asf',
-                          ),
+                            ),
 
                 // BINK  - audio/video - Bink / Smacker
                 'bink' => array(
                             'pattern'   => '^(BIK|SMK)',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // FLV  - audio/video - FLash Video
                 'flv' => array(
@@ -768,13 +768,13 @@ 
                             'group'     => 'audio-video',
                             'module'    => 'flv',
                             'mime_type' => 'video/x-flv',
-                          ),
+                            ),
 
                 // MKAV - audio/video - Mastroka
                 'matroska' => array (
                             'pattern'   => '^\x1A\x45\xDF\xA3',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // MPEG - audio/video - MPEG (Moving Pictures Experts Group)
                 'mpeg' => array (
@@ -782,7 +782,7 @@ 
                             'group'     => 'audio-video',
                             'module'    => 'mpeg',
                             'mime_type' => 'video/mpeg',
-                          ),
+                            ),
 
                 // NSV  - audio/video - Nullsoft Streaming Video (NSV)
                 'nsv'  => array (
@@ -790,7 +790,7 @@ 
                             'group'     => 'audio-video',
                             'module'    => 'nsv',
                             'mime_type' => 'application/octet-stream',
-                          ),
+                            ),
 
                 // Ogg  - audio/video - Ogg (Ogg Vorbis, OggFLAC, Speex, Ogg Theora(*), Ogg Tarkin(*))
                 'ogg'  => array (
@@ -800,7 +800,7 @@ 
                             'mime_type' => 'application/ogg',
                             'fail_id3'  => 'WARNING',
                             'fail_ape'  => 'WARNING',
-                          ),
+                            ),
 
                 // QT   - audio/video - Quicktime
                 'quicktime' => array (
@@ -808,7 +808,7 @@ 
                             'group'     => 'audio-video',
                             'module'    => 'quicktime',
                             'mime_type' => 'video/quicktime',
-                          ),
+                            ),
 
                 // RIFF - audio/video - Resource Interchange File Format (RIFF) / WAV / AVI / CD-audio / SDSS = renamed variant used by SmartSound QuickTracks (www.smartsound.com) / FORM = Audio Interchange File Format (AIFF)
                 'riff' => array (
@@ -817,7 +817,7 @@ 
                             'module'    => 'riff',
                             'mime_type' => 'audio/x-wave',
                             'fail_ape'  => 'WARNING',
-                          ),
+                            ),
 
                 // Real - audio/video - RealAudio, RealVideo
                 'real' => array (
@@ -825,7 +825,7 @@ 
                             'group'     => 'audio-video',
                             'module'    => 'real',
                             'mime_type' => 'audio/x-realaudio',
-                          ),
+                            ),
 
                 // SWF - audio/video - ShockWave Flash
                 'swf' => array (
@@ -833,7 +833,7 @@ 
                             'group'     => 'audio-video',
                             'module'    => 'swf',
                             'mime_type' => 'application/x-shockwave-flash',
-                          ),
+                            ),
 
 
                 // Still-Image formats
@@ -846,7 +846,7 @@ 
                             'mime_type' => 'image/bmp',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
                 // GIF  - still image - Graphics Interchange Format
                 'gif'  => array (
@@ -856,7 +856,7 @@ 
                             'mime_type' => 'image/gif',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
                 // JPEG - still image - Joint Photographic Experts Group (JPEG)
                 'jpeg'  => array (
@@ -866,7 +866,7 @@ 
                             'mime_type' => 'image/jpeg',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
                 // PCD  - still image - Kodak Photo CD
                 'pcd'  => array (
@@ -876,7 +876,7 @@ 
                             'mime_type' => 'image/x-photo-cd',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
 
                 // PNG  - still image - Portable Network Graphics (PNG)
@@ -887,16 +887,16 @@ 
                             'mime_type' => 'image/png',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
 
                 // SVG  - still image - Scalable Vector Graphics (SVG)
-				'svg'  => array(
-							'pattern'   => '<!DOCTYPE svg PUBLIC ',
-							'mime_type' => 'image/svg+xml',
-							'fail_id3'  => 'ERROR',
-							'fail_ape'  => 'ERROR',
-						),
+                'svg'  => array(
+                            'pattern'   => '<!DOCTYPE svg PUBLIC ',
+                            'mime_type' => 'image/svg+xml',
+                            'fail_id3'  => 'ERROR',
+                            'fail_ape'  => 'ERROR',
+                        ),
 
 
                 // TIFF  - still image - Tagged Information File Format (TIFF)
@@ -907,7 +907,7 @@ 
                             'mime_type' => 'image/tiff',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
 
                 // Data formats
@@ -917,7 +917,7 @@ 
                             'mime_type' => 'application/octet-stream',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
                 // ISO  - data        - International Standards Organization (ISO) CD-ROM Image
                 'iso'  => array (
@@ -927,7 +927,7 @@ 
                             'mime_type' => 'application/octet-stream',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
                 // RAR  - data        - RAR compressed data
                 'rar'  => array(
@@ -935,7 +935,7 @@ 
                             'mime_type' => 'application/octet-stream',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
                 // SZIP - audio       - SZIP compressed data
                 'szip' => array (
@@ -945,7 +945,7 @@ 
                             'mime_type' => 'application/octet-stream',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
                 // TAR  - data        - TAR compressed data
                 'tar'  => array(
@@ -955,7 +955,7 @@ 
                             'mime_type' => 'application/x-tar',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
                 // GZIP  - data        - GZIP compressed data
                 'gz'  => array(
@@ -965,7 +965,7 @@ 
                             'mime_type' => 'application/x-gzip',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
 
                 // ZIP  - data        - ZIP compressed data
@@ -976,33 +976,33 @@ 
                             'mime_type' => 'application/zip',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
 
 
                 // PAR2 - data        - Parity Volume Set Specification 2.0
                 'par2' => array (
-                			'pattern'   => '^PAR2\x00PKT',
-							'mime_type' => 'application/octet-stream',
-							'fail_id3'  => 'ERROR',
-							'fail_ape'  => 'ERROR',
-						),
+                            'pattern'   => '^PAR2\x00PKT',
+                            'mime_type' => 'application/octet-stream',
+                            'fail_id3'  => 'ERROR',
+                            'fail_ape'  => 'ERROR',
+                        ),
 
 
-                 // PDF  - data       - Portable Document Format
-                 'pdf' => array(
+                    // PDF  - data       - Portable Document Format
+                    'pdf' => array(
                             'pattern'   => '^\x25PDF',
                             'mime_type' => 'application/pdf',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                           ),
+                            ),
 
-                 // DOC  - data       - Microsoft Word
-                 'msoffice' => array(
+                    // DOC  - data       - Microsoft Word
+                    'msoffice' => array(
                             'pattern'   => '^\xD0\xCF\x11\xE0', // D0CF11E == DOCFILE == Microsoft Office Document
                             'mime_type' => 'application/octet-stream',
                             'fail_id3'  => 'ERROR',
                             'fail_ape'  => 'ERROR',
-                          ),
+                            ),
             );
 
         return $format_info;
@@ -1393,99 +1393,99 @@ 
 
     public static function BigEndian2Float($byte_word) {
 
-		// ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic
-		// http://www.psc.edu/general/software/packages/ieee/ieee.html
-		// http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/ieee.html
+        // ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic
+        // http://www.psc.edu/general/software/packages/ieee/ieee.html
+        // http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/ieee.html
 
-		$bit_word = getid3_lib::BigEndian2Bin($byte_word);
-		if (!$bit_word) {
+        $bit_word = getid3_lib::BigEndian2Bin($byte_word);
+        if (!$bit_word) {
             return 0;
         }
-		$sign_bit = $bit_word{0};
-
-		switch (strlen($byte_word) * 8) {
-			case 32:
-				$exponent_bits = 8;
-				$fraction_bits = 23;
-				break;
-
-			case 64:
-				$exponent_bits = 11;
-				$fraction_bits = 52;
-				break;
-
-			case 80:
-				// 80-bit Apple SANE format
-				// http://www.mactech.com/articles/mactech/Vol.06/06.01/SANENormalized/
-				$exponent_string = substr($bit_word, 1, 15);
-				$is_normalized = intval($bit_word{16});
-				$fraction_string = substr($bit_word, 17, 63);
-				$exponent = pow(2, getid3_lib::Bin2Dec($exponent_string) - 16383);
-				$fraction = $is_normalized + getid3_lib::DecimalBinary2Float($fraction_string);
-				$float_value = $exponent * $fraction;
-				if ($sign_bit == '1') {
-					$float_value *= -1;
-				}
-				return $float_value;
-				break;
-
-			default:
-				return false;
-				break;
-		}
-		$exponent_string = substr($bit_word, 1, $exponent_bits);
-		$fraction_string = substr($bit_word, $exponent_bits + 1, $fraction_bits);
-		$exponent = bindec($exponent_string);
-		$fraction = bindec($fraction_string);
-
-		if (($exponent == (pow(2, $exponent_bits) - 1)) && ($fraction != 0)) {
-			// Not a Number
-			$float_value = false;
-		} elseif (($exponent == (pow(2, $exponent_bits) - 1)) && ($fraction == 0)) {
-			if ($sign_bit == '1') {
-				$float_value = '-infinity';
-			} else {
-				$float_value = '+infinity';
-			}
-		} elseif (($exponent == 0) && ($fraction == 0)) {
-			if ($sign_bit == '1') {
-				$float_value = -0;
-			} else {
-				$float_value = 0;
-			}
-			$float_value = ($sign_bit ? 0 : -0);
-		} elseif (($exponent == 0) && ($fraction != 0)) {
-			// These are 'unnormalized' values
-			$float_value = pow(2, (-1 * (pow(2, $exponent_bits - 1) - 2))) * getid3_lib::DecimalBinary2Float($fraction_string);
-			if ($sign_bit == '1') {
-				$float_value *= -1;
-			}
-		} elseif ($exponent != 0) {
-			$float_value = pow(2, ($exponent - (pow(2, $exponent_bits - 1) - 1))) * (1 + getid3_lib::DecimalBinary2Float($fraction_string));
-			if ($sign_bit == '1') {
-				$float_value *= -1;
-			}
-		}
-		return (float) $float_value;
-	}
-
-
-
-	public static function LittleEndian2Float($byte_word) {
-
-		return getid3_lib::BigEndian2Float(strrev($byte_word));
-	}
-
-
-
-	public static function DecimalBinary2Float($binary_numerator) {
-		$numerator   = bindec($binary_numerator);
-		$denominator = bindec('1'.str_repeat('0', strlen($binary_numerator)));
-		return ($numerator / $denominator);
-	}
-
-
-	public static function PrintHexBytes($string, $hex=true, $spaces=true, $html_safe=true) {
+        $sign_bit = $bit_word{0};
+
+        switch (strlen($byte_word) * 8) {
+            case 32:
+                $exponent_bits = 8;
+                $fraction_bits = 23;
+                break;
+
+            case 64:
+                $exponent_bits = 11;
+                $fraction_bits = 52;
+                break;
+
+            case 80:
+                // 80-bit Apple SANE format
+                // http://www.mactech.com/articles/mactech/Vol.06/06.01/SANENormalized/
+                $exponent_string = substr($bit_word, 1, 15);
+                $is_normalized = intval($bit_word{16});
+                $fraction_string = substr($bit_word, 17, 63);
+                $exponent = pow(2, getid3_lib::Bin2Dec($exponent_string) - 16383);
+                $fraction = $is_normalized + getid3_lib::DecimalBinary2Float($fraction_string);
+                $float_value = $exponent * $fraction;
+                if ($sign_bit == '1') {
+                    $float_value *= -1;
+                }
+                return $float_value;
+                break;
+
+            default:
+                return false;
+                break;
+        }
+        $exponent_string = substr($bit_word, 1, $exponent_bits);
+        $fraction_string = substr($bit_word, $exponent_bits + 1, $fraction_bits);
+        $exponent = bindec($exponent_string);
+        $fraction = bindec($fraction_string);
+
+        if (($exponent == (pow(2, $exponent_bits) - 1)) && ($fraction != 0)) {
+            // Not a Number
+            $float_value = false;
+        } elseif (($exponent == (pow(2, $exponent_bits) - 1)) && ($fraction == 0)) {
+            if ($sign_bit == '1') {
+                $float_value = '-infinity';
+            } else {
+                $float_value = '+infinity';
+            }
+        } elseif (($exponent == 0) && ($fraction == 0)) {
+            if ($sign_bit == '1') {
+                $float_value = -0;
+            } else {
+                $float_value = 0;
+            }
+            $float_value = ($sign_bit ? 0 : -0);
+        } elseif (($exponent == 0) && ($fraction != 0)) {
+            // These are 'unnormalized' values
+            $float_value = pow(2, (-1 * (pow(2, $exponent_bits - 1) - 2))) * getid3_lib::DecimalBinary2Float($fraction_string);
+            if ($sign_bit == '1') {
+                $float_value *= -1;
+            }
+        } elseif ($exponent != 0) {
+            $float_value = pow(2, ($exponent - (pow(2, $exponent_bits - 1) - 1))) * (1 + getid3_lib::DecimalBinary2Float($fraction_string));
+            if ($sign_bit == '1') {
+                $float_value *= -1;
+            }
+        }
+        return (float) $float_value;
+    }
+
+
+
+    public static function LittleEndian2Float($byte_word) {
+
+        return getid3_lib::BigEndian2Float(strrev($byte_word));
+    }
+
+
+
+    public static function DecimalBinary2Float($binary_numerator) {
+        $numerator   = bindec($binary_numerator);
+        $denominator = bindec('1'.str_repeat('0', strlen($binary_numerator)));
+        return ($numerator / $denominator);
+    }
+
+
+    public static function PrintHexBytes($string, $hex=true, $spaces=true, $html_safe=true) {
 
         $return_string = '';
         for ($i = 0; $i < strlen($string); $i++) {

Spacing +111 added lines, -111 removed lines

@@ -27,42 +27,42 @@ 
     //// Settings Section - do NOT modify this file - change setting after newing getid3!
 
     // Encoding
-    public $encoding                 = 'ISO-8859-1';      // CASE SENSITIVE! - i.e. (must be supported by iconv() - see http://www.gnu.org/software/libiconv/).  Examples:  ISO-8859-1  UTF-8  UTF-16  UTF-16BE.
-    public $encoding_id3v1           = 'ISO-8859-1';      // Override SPECIFICATION encoding for broken ID3v1 tags caused by bad tag programs. Examples: 'EUC-CN' for "Chinese MP3s" and 'CP1251' for "Cyrillic".
-    public $encoding_id3v2           = 'ISO-8859-1';      // Override ISO-8859-1 encoding for broken ID3v2 tags caused by BRAINDEAD tag programs that writes system codepage as 'ISO-8859-1' instead of UTF-8.
+    public $encoding                 = 'ISO-8859-1'; // CASE SENSITIVE! - i.e. (must be supported by iconv() - see http://www.gnu.org/software/libiconv/).  Examples:  ISO-8859-1  UTF-8  UTF-16  UTF-16BE.
+    public $encoding_id3v1           = 'ISO-8859-1'; // Override SPECIFICATION encoding for broken ID3v1 tags caused by bad tag programs. Examples: 'EUC-CN' for "Chinese MP3s" and 'CP1251' for "Cyrillic".
+    public $encoding_id3v2           = 'ISO-8859-1'; // Override ISO-8859-1 encoding for broken ID3v2 tags caused by BRAINDEAD tag programs that writes system codepage as 'ISO-8859-1' instead of UTF-8.
 
     // Tags - disable for speed
-    public $option_tag_id3v1         = false;              // Read and process ID3v1 tags.
-    public $option_tag_id3v2         = false;              // Read and process ID3v2 tags.
-    public $option_tag_lyrics3       = false;              // Read and process Lyrics3 tags.
-    public $option_tag_apetag        = false;              // Read and process APE tags.
+    public $option_tag_id3v1         = false; // Read and process ID3v1 tags.
+    public $option_tag_id3v2         = false; // Read and process ID3v2 tags.
+    public $option_tag_lyrics3       = false; // Read and process Lyrics3 tags.
+    public $option_tag_apetag        = false; // Read and process APE tags.
 
     // Misc calucations - disable for speed
-    public $option_analyze           = true;              // Analyze file - disable if you only need to detect file format.
-    public $option_accurate_results  = true;              // Disable to greatly speed up parsing of some file formats at the cost of accuracy.
-    public $option_tags_process      = true;              // Copy tags to root key 'tags' and 'comments' and encode to $this->encoding.
-    public $option_tags_images       = false;             // Scan tags for binary image data - ID3v2 and vorbiscomments only.
-    public $option_extra_info        = true;              // Calculate/return additional info such as bitrate, channelmode etc.
-    public $option_max_2gb_check     = false;             // Check whether file is larger than 2 Gb and thus not supported by PHP.
+    public $option_analyze           = true; // Analyze file - disable if you only need to detect file format.
+    public $option_accurate_results  = true; // Disable to greatly speed up parsing of some file formats at the cost of accuracy.
+    public $option_tags_process      = true; // Copy tags to root key 'tags' and 'comments' and encode to $this->encoding.
+    public $option_tags_images       = false; // Scan tags for binary image data - ID3v2 and vorbiscomments only.
+    public $option_extra_info        = true; // Calculate/return additional info such as bitrate, channelmode etc.
+    public $option_max_2gb_check     = false; // Check whether file is larger than 2 Gb and thus not supported by PHP.
 
     // Misc data hashes - slow - require hash module
-    public $option_md5_data          = false;             // Get MD5 sum of data part - slow.
-    public $option_md5_data_source   = false;             // Use MD5 of source file if available - only FLAC, MAC, OptimFROG and Wavpack4.
-    public $option_sha1_data         = false;             // Get SHA1 sum of data part - slow.
+    public $option_md5_data          = false; // Get MD5 sum of data part - slow.
+    public $option_md5_data_source   = false; // Use MD5 of source file if available - only FLAC, MAC, OptimFROG and Wavpack4.
+    public $option_sha1_data         = false; // Get SHA1 sum of data part - slow.
 
     // Public variables
-    public $filename;                                     // Filename of file being analysed.
-    public $fp;                                           // Filepointer to file being analysed.
-    public $info;                                         // Result array.
+    public $filename; // Filename of file being analysed.
+    public $fp; // Filepointer to file being analysed.
+    public $info; // Result array.
 
     // Protected variables
-    protected $include_path;                              // getid3 include path.
-    protected $warnings = array ();
+    protected $include_path; // getid3 include path.
+    protected $warnings = array();
     protected $iconv_present;
 
     // Class constants
     const VERSION           = '2.0.0b4';
-    const FREAD_BUFFER_SIZE = 16384;                      // Read buffer size in bytes.
+    const FREAD_BUFFER_SIZE = 16384; // Read buffer size in bytes.
     const ICONV_TEST_STRING = ' !"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~�������������������������������� �����������������������������������������������������������������������������������������������';
 
 
@@ -87,7 +87,7 @@ 
         }
 
         // Get include_path
-        $this->include_path = $include_path = dirname(__FILE__) . '/';
+        $this->include_path = $include_path = dirname(__FILE__).'/';
 
         // Check for presence of iconv() and make sure it works (simpel test only).
         if (function_exists('iconv') && @iconv('UTF-16LE', 'ISO-8859-1', @iconv('ISO-8859-1', 'UTF-16LE', getid3::ICONV_TEST_STRING)) == getid3::ICONV_TEST_STRING) {
@@ -123,7 +123,7 @@ 
 
 
         // Check safe_mode off
-        if ((bool)ini_get('safe_mode')) {
+        if ((bool) ini_get('safe_mode')) {
             $this->warning('Safe mode is on, shorten support disabled, md5data/sha1data for ogg vorbis disabled, ogg vorbis/flac tag writing disabled.');
         }
 
@@ -137,10 +137,10 @@ 
 
         // Init and save values
         $this->filename = $filename;
-        $this->warnings = array ();
+        $this->warnings = array();
 
         // Init result array and set parameters
-        $this->info = array ();
+        $this->info = array();
         $this->info['GETID3_VERSION'] = getid3::VERSION;
 
         // Remote files not supported
@@ -179,7 +179,7 @@ 
 
             fseek($this->fp, 0, SEEK_SET);
             $header = fread($this->fp, 10);
-            if (substr($header, 0, 3) == 'ID3'  &&  strlen($header) == 10) {
+            if (substr($header, 0, 3) == 'ID3' && strlen($header) == 10) {
                 $this->info['id3v2']['header']        = true;
                 $this->info['id3v2']['majorversion']  = ord($header{3});
                 $this->info['id3v2']['minorversion']  = ord($header{4});
@@ -189,13 +189,13 @@ 
 
 
         // Handle tags
-        foreach (array ("id3v2", "id3v1", "apetag", "lyrics3") as $tag_name) {
+        foreach (array("id3v2", "id3v1", "apetag", "lyrics3") as $tag_name) {
 
-            $option_tag = 'option_tag_' . $tag_name;
+            $option_tag = 'option_tag_'.$tag_name;
             if ($this->$option_tag) {
                 $this->include_module('tag.'.$tag_name);
                 try {
-                    $tag_class = 'getid3_' . $tag_name;
+                    $tag_class = 'getid3_'.$tag_name;
                     $tag = new $tag_class($this);
                     $tag->Analyze();
                 }
@@ -231,7 +231,7 @@ 
                     return $this->info;
                 }
 
-                $determined_format = $info;  // copy $info deleted by foreach()
+                $determined_format = $info; // copy $info deleted by foreach()
                 continue;
             }
         }
@@ -341,7 +341,7 @@ 
 
             // Set playtime string
             if (!empty($this->info['playtime_seconds']) && empty($this->info['playtime_string'])) {
-                $this->info['playtime_string'] =  floor(round($this->info['playtime_seconds']) / 60) . ':' . str_pad(floor(round($this->info['playtime_seconds']) % 60), 2, 0, STR_PAD_LEFT);;
+                $this->info['playtime_string'] = floor(round($this->info['playtime_seconds']) / 60).':'.str_pad(floor(round($this->info['playtime_seconds']) % 60), 2, 0, STR_PAD_LEFT); ;
             }
 
 
@@ -349,7 +349,7 @@ 
             if (@$this->info['video'] && @$this->info['video']['resolution_x'] && @$this->info['video']['resolution_y'] && @$this->info['video']['bits_per_sample']) {
 
                 // From static image formats
-                if (in_array($this->info['video']['dataformat'], array ('bmp', 'gif', 'jpeg', 'jpg', 'png', 'tiff'))) {
+                if (in_array($this->info['video']['dataformat'], array('bmp', 'gif', 'jpeg', 'jpg', 'png', 'tiff'))) {
                     $frame_rate         = 1;
                     $bitrate_compressed = $this->info['filesize'] * 8;
                 }
@@ -471,7 +471,7 @@ 
     //  Clear all warnings when cloning
     public function __clone() {
 
-        $this->warnings = array ();
+        $this->warnings = array();
 
         // Copy info array, otherwise it will be a reference.
         $temp = $this->info;
@@ -503,7 +503,7 @@ 
             return $result;
         }
 
-        $this->warning('iconv() was unable to convert the string: "' . $string . '" from ' . $in_charset . ' to ' . $out_charset);
+        $this->warning('iconv() was unable to convert the string: "'.$string.'" from '.$in_charset.' to '.$out_charset);
         return $string;
     }
 
@@ -534,12 +534,12 @@ 
     // Return array containing information about all supported formats
     public static function GetFileFormatArray() {
 
-        static $format_info = array (
+        static $format_info = array(
 
                 // Audio formats
 
                 // AC-3   - audio      - Dolby AC-3 / Dolby Digital
-                'ac3'  => array (
+                'ac3'  => array(
                             'pattern'   => '^\x0B\x77',
                             'group'     => 'audio',
                             'module'    => 'ac3',
@@ -547,7 +547,7 @@ 
                           ),
 
                 // AAC  - audio       - Advanced Audio Coding (AAC) - ADIF format
-                'adif' => array (
+                'adif' => array(
                             'pattern'   => '^ADIF',
                             'group'     => 'audio',
                             'module'    => 'aac_adif',
@@ -557,7 +557,7 @@ 
 
 
                 // AAC  - audio       - Advanced Audio Coding (AAC) - ADTS format (very similar to MP3)
-                'adts' => array (
+                'adts' => array(
                             'pattern'   => '^\xFF[\xF0-\xF1\xF8-\xF9]',
                             'group'     => 'audio',
                             'module'    => 'aac_adts',
@@ -567,7 +567,7 @@ 
 
 
                 // AU   - audio       - NeXT/Sun AUdio (AU)
-                'au'   => array (
+                'au'   => array(
                             'pattern'   => '^\.snd',
                             'group'     => 'audio',
                             'module'    => 'au',
@@ -575,7 +575,7 @@ 
                           ),
 
                 // AVR  - audio       - Audio Visual Research
-                'avr'  => array (
+                'avr'  => array(
                             'pattern'   => '^2BIT',
                             'group'     => 'audio',
                             'module'    => 'avr',
@@ -583,7 +583,7 @@ 
                           ),
 
                 // BONK - audio       - Bonk v0.9+
-                'bonk' => array (
+                'bonk' => array(
                             'pattern'   => '^\x00(BONK|INFO|META| ID3)',
                             'group'     => 'audio',
                             'module'    => 'bonk',
@@ -599,7 +599,7 @@ 
 						),
 
                 // FLAC - audio       - Free Lossless Audio Codec
-                'flac' => array (
+                'flac' => array(
                             'pattern'   => '^fLaC',
                             'group'     => 'audio',
                             'module'    => 'xiph',
@@ -607,7 +607,7 @@ 
                           ),
 
                 // LA   - audio       - Lossless Audio (LA)
-                'la'   => array (
+                'la'   => array(
                             'pattern'   => '^LA0[2-4]',
                             'group'     => 'audio',
                             'module'    => 'la',
@@ -615,7 +615,7 @@ 
                           ),
 
                 // LPAC - audio       - Lossless Predictive Audio Compression (LPAC)
-                'lpac' => array (
+                'lpac' => array(
                             'pattern'   => '^LPAC',
                             'group'     => 'audio',
                             'module'    => 'lpac',
@@ -623,7 +623,7 @@ 
                           ),
 
                 // MIDI - audio       - MIDI (Musical Instrument Digital Interface)
-                'midi' => array (
+                'midi' => array(
                             'pattern'   => '^MThd',
                             'group'     => 'audio',
                             'module'    => 'midi',
@@ -631,7 +631,7 @@ 
                           ),
 
                 // MAC  - audio       - Monkey's Audio Compressor
-                'mac'  => array (
+                'mac'  => array(
                             'pattern'   => '^MAC ',
                             'group'     => 'audio',
                             'module'    => 'monkey',
@@ -639,31 +639,31 @@ 
                           ),
 
                 // MOD  - audio       - MODule (assorted sub-formats)
-                'mod'  => array (
+                'mod'  => array(
                             'pattern'   => '^.{1080}(M.K.|[5-9]CHN|[1-3][0-9]CH)',
                             'mime_type' => 'audio/mod',
                           ),
 
                 // MOD  - audio       - MODule (Impulse Tracker)
-                'it'   => array (
+                'it'   => array(
                             'pattern'   => '^IMPM',
                             'mime_type' => 'audio/it',
                           ),
 
                 // MOD  - audio       - MODule (eXtended Module, various sub-formats)
-                'xm'   => array (
+                'xm'   => array(
                             'pattern'   => '^Extended Module',
                             'mime_type' => 'audio/xm',
                           ),
 
                 // MOD  - audio       - MODule (ScreamTracker)
-                's3m'  => array (
+                's3m'  => array(
                             'pattern'   => '^.{44}SCRM',
                             'mime_type' => 'audio/s3m',
                           ),
 
                 // MPC  - audio       - Musepack / MPEGplus SV7+
-                'mpc'  => array (
+                'mpc'  => array(
                             'pattern'   => '^(MP\+)',
                             'group'     => 'audio',
                             'module'    => 'mpc',
@@ -671,7 +671,7 @@ 
                           ),
 
                 // MPC  - audio       - Musepack / MPEGplus SV4-6
-                'mpc_old' => array (
+                'mpc_old' => array(
                             'pattern'   => '^([\x00\x01\x10\x11\x40\x41\x50\x51\x80\x81\x90\x91\xC0\xC1\xD0\xD1][\x20-37][\x00\x20\x40\x60\x80\xA0\xC0\xE0])',
                             'group'     => 'audio',
                             'module'    => 'mpc_old',
@@ -680,7 +680,7 @@ 
 
 
                 // MP3  - audio       - MPEG-audio Layer 3 (very similar to AAC-ADTS)
-                'mp3'  => array (
+                'mp3'  => array(
                             'pattern'   => '^\xFF[\xE2-\xE7\xF2-\xF7\xFA-\xFF][\x00-\xEB]',
                             'group'     => 'audio',
                             'module'    => 'mp3',
@@ -688,7 +688,7 @@ 
                           ),
 
                 // OFR  - audio       - OptimFROG
-                'ofr'  => array (
+                'ofr'  => array(
                             'pattern'   => '^(\*RIFF|OFR)',
                             'group'     => 'audio',
                             'module'    => 'optimfrog',
@@ -696,7 +696,7 @@ 
                           ),
 
                 // RKAU - audio       - RKive AUdio compressor
-                'rkau' => array (
+                'rkau' => array(
                             'pattern'   => '^RKA',
                             'group'     => 'audio',
                             'module'    => 'rkau',
@@ -704,7 +704,7 @@ 
                           ),
 
                 // SHN  - audio       - Shorten
-                'shn'  => array (
+                'shn'  => array(
                             'pattern'   => '^ajkg',
                             'group'     => 'audio',
                             'module'    => 'shorten',
@@ -714,15 +714,15 @@ 
                           ),
 
                 // TTA  - audio       - TTA Lossless Audio Compressor (http://tta.corecodec.org)
-                'tta'  => array (
-                            'pattern'   => '^TTA',  // could also be '^TTA(\x01|\x02|\x03|2|1)'
+                'tta'  => array(
+                            'pattern'   => '^TTA', // could also be '^TTA(\x01|\x02|\x03|2|1)'
                             'group'     => 'audio',
                             'module'    => 'tta',
                             'mime_type' => 'application/octet-stream',
                           ),
 
                 // VOC  - audio       - Creative Voice (VOC)
-                'voc'  => array (
+                'voc'  => array(
                             'pattern'   => '^Creative Voice File',
                             'group'     => 'audio',
                             'module'    => 'voc',
@@ -730,7 +730,7 @@ 
                           ),
 
                 // VQF  - audio       - transform-domain weighted interleave Vector Quantization Format (VQF)
-                'vqf'  => array (
+                'vqf'  => array(
                             'pattern'   => '^TWIN',
                             'group'     => 'audio',
                             'module'    => 'vqf',
@@ -749,7 +749,7 @@ 
                 // Audio-Video formats
 
                 // ASF  - audio/video - Advanced Streaming Format, Windows Media Video, Windows Media Audio
-                'asf'  => array (
+                'asf'  => array(
                             'pattern'   => '^\x30\x26\xB2\x75\x8E\x66\xCF\x11\xA6\xD9\x00\xAA\x00\x62\xCE\x6C',
                             'group'     => 'audio-video',
                             'module'    => 'asf',
@@ -771,13 +771,13 @@ 
                           ),
 
                 // MKAV - audio/video - Mastroka
-                'matroska' => array (
+                'matroska' => array(
                             'pattern'   => '^\x1A\x45\xDF\xA3',
                             'mime_type' => 'application/octet-stream',
                           ),
 
                 // MPEG - audio/video - MPEG (Moving Pictures Experts Group)
-                'mpeg' => array (
+                'mpeg' => array(
                             'pattern'   => '^\x00\x00\x01(\xBA|\xB3)',
                             'group'     => 'audio-video',
                             'module'    => 'mpeg',
@@ -785,7 +785,7 @@ 
                           ),
 
                 // NSV  - audio/video - Nullsoft Streaming Video (NSV)
-                'nsv'  => array (
+                'nsv'  => array(
                             'pattern'   => '^NSV[sf]',
                             'group'     => 'audio-video',
                             'module'    => 'nsv',
@@ -793,7 +793,7 @@ 
                           ),
 
                 // Ogg  - audio/video - Ogg (Ogg Vorbis, OggFLAC, Speex, Ogg Theora(*), Ogg Tarkin(*))
-                'ogg'  => array (
+                'ogg'  => array(
                             'pattern'   => '^OggS',
                             'group'     => 'audio',
                             'module'    => 'xiph',
@@ -803,7 +803,7 @@ 
                           ),
 
                 // QT   - audio/video - Quicktime
-                'quicktime' => array (
+                'quicktime' => array(
                             'pattern'   => '^.{4}(cmov|free|ftyp|mdat|moov|pnot|skip|wide)',
                             'group'     => 'audio-video',
                             'module'    => 'quicktime',
@@ -811,7 +811,7 @@ 
                           ),
 
                 // RIFF - audio/video - Resource Interchange File Format (RIFF) / WAV / AVI / CD-audio / SDSS = renamed variant used by SmartSound QuickTracks (www.smartsound.com) / FORM = Audio Interchange File Format (AIFF)
-                'riff' => array (
+                'riff' => array(
                             'pattern'   => '^(RIFF|SDSS|FORM)',
                             'group'     => 'audio-video',
                             'module'    => 'riff',
@@ -820,7 +820,7 @@ 
                           ),
 
                 // Real - audio/video - RealAudio, RealVideo
-                'real' => array (
+                'real' => array(
                             'pattern'   => '^(\.RMF|.ra)',
                             'group'     => 'audio-video',
                             'module'    => 'real',
@@ -828,7 +828,7 @@ 
                           ),
 
                 // SWF - audio/video - ShockWave Flash
-                'swf' => array (
+                'swf' => array(
                             'pattern'   => '^(F|C)WS',
                             'group'     => 'audio-video',
                             'module'    => 'swf',
@@ -839,7 +839,7 @@ 
                 // Still-Image formats
 
                 // BMP  - still image - Bitmap (Windows, OS/2; uncompressed, RLE8, RLE4)
-                'bmp'  => array (
+                'bmp'  => array(
                             'pattern'   => '^BM',
                             'group'     => 'graphic',
                             'module'    => 'bmp',
@@ -849,7 +849,7 @@ 
                           ),
 
                 // GIF  - still image - Graphics Interchange Format
-                'gif'  => array (
+                'gif'  => array(
                             'pattern'   => '^GIF',
                             'group'     => 'graphic',
                             'module'    => 'gif',
@@ -859,7 +859,7 @@ 
                           ),
 
                 // JPEG - still image - Joint Photographic Experts Group (JPEG)
-                'jpeg'  => array (
+                'jpeg'  => array(
                             'pattern'   => '^\xFF\xD8\xFF',
                             'group'     => 'graphic',
                             'module'    => 'jpeg',
@@ -869,7 +869,7 @@ 
                           ),
 
                 // PCD  - still image - Kodak Photo CD
-                'pcd'  => array (
+                'pcd'  => array(
                             'pattern'   => '^.{2048}PCD_IPI\x00',
                             'group'     => 'graphic',
                             'module'    => 'pcd',
@@ -880,7 +880,7 @@ 
 
 
                 // PNG  - still image - Portable Network Graphics (PNG)
-                'png'  => array (
+                'png'  => array(
                             'pattern'   => '^\x89\x50\x4E\x47\x0D\x0A\x1A\x0A',
                             'group'     => 'graphic',
                             'module'    => 'png',
@@ -900,7 +900,7 @@ 
 
 
                 // TIFF  - still image - Tagged Information File Format (TIFF)
-                'tiff' => array (
+                'tiff' => array(
                             'pattern'   => '^(II\x2A\x00|MM\x00\x2A)',
                             'group'     => 'graphic',
                             'module'    => 'tiff',
@@ -920,7 +920,7 @@ 
                           ),
 
                 // ISO  - data        - International Standards Organization (ISO) CD-ROM Image
-                'iso'  => array (
+                'iso'  => array(
                             'pattern'   => '^.{32769}CD001',
                             'group'     => 'misc',
                             'module'    => 'iso',
@@ -938,7 +938,7 @@ 
                           ),
 
                 // SZIP - audio       - SZIP compressed data
-                'szip' => array (
+                'szip' => array(
                             'pattern'   => '^SZ\x0A\x04',
                             'group'     => 'archive',
                             'module'    => 'szip',
@@ -969,7 +969,7 @@ 
 
 
                 // ZIP  - data        - ZIP compressed data
-                'zip'  => array (
+                'zip'  => array(
                             'pattern'   => '^PK\x03\x04',
                             'group'     => 'archive',
                             'module'    => 'zip',
@@ -980,7 +980,7 @@ 
 
 
                 // PAR2 - data        - Parity Volume Set Specification 2.0
-                'par2' => array (
+                'par2' => array(
                 			'pattern'   => '^PAR2\x00PKT',
 							'mime_type' => 'application/octet-stream',
 							'fail_id3'  => 'ERROR',
@@ -1039,22 +1039,22 @@ 
     protected function HandleAllTags() {
 
         // Key name => array (tag name, character encoding)
-        static $tags = array (
-            'asf'       => array ('asf',           'UTF-16LE'),
-            'midi'      => array ('midi',          'ISO-8859-1'),
-            'nsv'       => array ('nsv',           'ISO-8859-1'),
-            'ogg'       => array ('vorbiscomment', 'UTF-8'),
-            'png'       => array ('png',           'UTF-8'),
-            'tiff'      => array ('tiff',          'ISO-8859-1'),
-            'quicktime' => array ('quicktime',     'ISO-8859-1'),
-            'real'      => array ('real',          'ISO-8859-1'),
-            'vqf'       => array ('vqf',           'ISO-8859-1'),
-            'zip'       => array ('zip',           'ISO-8859-1'),
-            'riff'      => array ('riff',          'ISO-8859-1'),
-            'lyrics3'   => array ('lyrics3',       'ISO-8859-1'),
-            'id3v1'     => array ('id3v1',         ''),            // change below - cannot assign variable to static array
-            'id3v2'     => array ('id3v2',         'UTF-8'),       // module converts all frames to UTF-8
-            'ape'       => array ('ape',           'UTF-8')
+        static $tags = array(
+            'asf'       => array('asf', 'UTF-16LE'),
+            'midi'      => array('midi', 'ISO-8859-1'),
+            'nsv'       => array('nsv', 'ISO-8859-1'),
+            'ogg'       => array('vorbiscomment', 'UTF-8'),
+            'png'       => array('png', 'UTF-8'),
+            'tiff'      => array('tiff', 'ISO-8859-1'),
+            'quicktime' => array('quicktime', 'ISO-8859-1'),
+            'real'      => array('real', 'ISO-8859-1'),
+            'vqf'       => array('vqf', 'ISO-8859-1'),
+            'zip'       => array('zip', 'ISO-8859-1'),
+            'riff'      => array('riff', 'ISO-8859-1'),
+            'lyrics3'   => array('lyrics3', 'ISO-8859-1'),
+            'id3v1'     => array('id3v1', ''), // change below - cannot assign variable to static array
+            'id3v2'     => array('id3v2', 'UTF-8'), // module converts all frames to UTF-8
+            'ape'       => array('ape', 'UTF-8')
         );
         $tags['id3v1'][1] = $this->encoding_id3v1;
 
@@ -1063,7 +1063,7 @@ 
             list($tag_name, $encoding) = $tag_name_encoding_array;
 
             // Fill in default encoding type if not already present
-            @$this->info[$comment_name]  and  $this->info[$comment_name]['encoding'] = $encoding;
+            @$this->info[$comment_name] and $this->info[$comment_name]['encoding'] = $encoding;
 
             // Copy comments if key name set
             if (@$this->info[$comment_name]['comments']) {
@@ -1142,11 +1142,11 @@ 
 abstract class getid3_handler
 {
 
-    protected $getid3;                          // pointer
+    protected $getid3; // pointer
 
-    protected $data_string_flag = false;        // analyzing filepointer or string
-    protected $data_string;                     // string to analyze
-    protected $data_string_position = 0;        // seek position in string
+    protected $data_string_flag = false; // analyzing filepointer or string
+    protected $data_string; // string to analyze
+    protected $data_string_position = 0; // seek position in string
 
 
     public function __construct(getID3 $getid3) {
@@ -1247,20 +1247,20 @@ 
     public function __construct($filename) {
 
         if (!file_exists($filename)) {
-            throw new getid3_exception('File does not exist: "' . $filename . '"');
+            throw new getid3_exception('File does not exist: "'.$filename.'"');
         }
 
         if (!is_writeable($filename)) {
-            throw new getid3_exception('File is not writeable: "' . $filename . '"');
+            throw new getid3_exception('File is not writeable: "'.$filename.'"');
         }
 
         if (!is_writeable(dirname($filename))) {
-            throw new getid3_exception('Directory is not writeable: ' . dirname($filename) . ' (need to write lock file).');
+            throw new getid3_exception('Directory is not writeable: '.dirname($filename).' (need to write lock file).');
         }
 
         $this->user_abort = ignore_user_abort(true);
 
-        $this->fp_lock = fopen($filename . '.getid3.lock', 'w');
+        $this->fp_lock = fopen($filename.'.getid3.lock', 'w');
         flock($this->fp_lock, LOCK_EX);
 
         $this->filename = $filename;
@@ -1271,7 +1271,7 @@ 
 
         flock($this->fp_lock, LOCK_UN);
         fclose($this->fp_lock);
-        unlink($this->filename . '.getid3.lock');
+        unlink($this->filename.'.getid3.lock');
 
         ignore_user_abort($this->user_abort);
     }
@@ -1325,7 +1325,7 @@ 
 
 
     // Convert number to Little Endian byte string
-    public static function LittleEndian2String($number, $minbytes=1, $synchsafe=false) {
+    public static function LittleEndian2String($number, $minbytes = 1, $synchsafe = false) {
         $intstring = '';
         while ($number > 0) {
             if ($synchsafe) {
@@ -1485,7 +1485,7 @@ 
 	}
 
 
-	public static function PrintHexBytes($string, $hex=true, $spaces=true, $html_safe=true) {
+	public static function PrintHexBytes($string, $hex = true, $spaces = true, $html_safe = true) {
 
         $return_string = '';
         for ($i = 0; $i < strlen($string); $i++) {
@@ -1545,7 +1545,7 @@ 
 
     public static function NameLookup($name_code) {
 
-        static $lookup = array (
+        static $lookup = array(
             0 => 'not set',
             1 => 'Track Gain Adjustment',
             2 => 'Album Gain Adjustment'
@@ -1558,7 +1558,7 @@ 
 
     public static function OriginatorLookup($originator_code) {
 
-        static $lookup = array (
+        static $lookup = array(
             0 => 'unspecified',
             1 => 'pre-set by artist/producer/mastering engineer',
             2 => 'set by user',
@@ -1572,7 +1572,7 @@ 
 
     public static function AdjustmentLookup($raw_adjustment, $sign_bit) {
 
-        return (float)$raw_adjustment / 10 * ($sign_bit == 1 ? -1 : 1);
+        return (float) $raw_adjustment / 10 * ($sign_bit == 1 ? -1 : 1);
     }
 
 

Braces +8 added lines, -17 removed lines

@@ -198,8 +198,7 @@ 
                     $tag_class = 'getid3_' . $tag_name;
                     $tag = new $tag_class($this);
                     $tag->Analyze();
-                }
-                catch (getid3_exception $e) {
+                } catch (getid3_exception $e) {
                     throw $e;
                 }
             }
@@ -243,9 +242,7 @@ 
             // use assume format on these if format detection failed
             if (preg_match('/\.mp[123a]$/i', $filename)) {
                 $determined_format = $file_format_array['mp3'];
-            }
-
-            else {
+            } else {
                 fclose($this->fp);
                 throw new getid3_exception('Unable to determine file format');
             }
@@ -259,8 +256,7 @@ 
             if ($determined_format['fail_id3'] === 'ERROR') {
                 fclose($this->fp);
                 throw new getid3_exception('ID3 tags not allowed on this file type.');
-            }
-            elseif ($determined_format['fail_id3'] === 'WARNING') {
+            } elseif ($determined_format['fail_id3'] === 'WARNING') {
                 @$this->info['id3v1'] and $this->warning('ID3v1 tags not allowed on this file type.');
                 @$this->info['id3v2'] and $this->warning('ID3v2 tags not allowed on this file type.');
             }
@@ -301,11 +297,9 @@ 
 
         try {
              $this->option_analyze and $class->Analyze();
-            }
-        catch (getid3_exception $e) {
+            } catch (getid3_exception $e) {
             throw $e;
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             throw new getid3_exception('Corrupt file.');
         }
 
@@ -460,8 +454,7 @@ 
 
         if (is_array($message)) {
             $this->warnings = array_merge($this->warnings, $message);
-        }
-        else {
+        } else {
             $this->warnings[] = $message;
         }
     }
@@ -1101,8 +1094,7 @@ 
                             if (empty($this->info['comments'][$tag_name])) {
 
                                 // fall through and append value
-                            }
-                            elseif ($tag_type == 'id3v1') {
+                            } elseif ($tag_type == 'id3v1') {
 
                                 $new_value_length = strlen(trim($value));
                                 foreach ($this->info['comments'][$tag_name] as $existing_key => $existing_value) {
@@ -1112,8 +1104,7 @@ 
                                         break 2;
                                     }
                                 }
-                            }
-                            else {
+                            } else {
 
                                 $new_value_length = strlen(trim($value));
                                 foreach ($this->info['comments'][$tag_name] as $existing_key => $existing_value) {

main/inc/lib/getid3/module.audio-video.flv.php

Doc Comments +6 added lines

@@ -276,6 +276,9 @@ 
 	public $pos;
 
 
+	/**
+	 * @param string $bytes
+	 */
 	public function AMFStream($bytes) {
 
 		$this->bytes = $bytes;
@@ -389,6 +392,9 @@ 
 {
 	public $stream;
 
+	/**
+	 * @param AMFStream $stream
+	 */
 	public function __construct($stream) {
 
 		$this->stream = $stream;

Spacing +10 added lines, -10 removed lines

@@ -47,8 +47,8 @@ 
  */
 class getid3_flv extends getid3_handler {
 
-    const TAG_AUDIO    =  8;
-    const TAG_VIDEO    =  9;
+    const TAG_AUDIO    = 8;
+    const TAG_VIDEO    = 9;
     const TAG_META     = 18;
 
     const VIDEO_H263   = 2;
@@ -60,7 +60,7 @@ 
 	{
 	    $info = &$this->getid3->info;
 
-	    $info['flv'] = array ();
+	    $info['flv'] = array();
 	    $info_flv = &$info['flv'];
 
 		fseek($this->getid3->fp, $info['avdataoffset'], SEEK_SET);
@@ -69,7 +69,7 @@ 
 		$flv_header = fread($this->getid3->fp, 5);
 
 		$info['fileformat'] = 'flv';
-		$info_flv['header']['signature'] =                           substr($flv_header, 0, 3);
+		$info_flv['header']['signature'] = substr($flv_header, 0, 3);
 		$info_flv['header']['version']   = getid3_lib::BigEndian2Int(substr($flv_header, 3, 1));
 		$type_flags                      = getid3_lib::BigEndian2Int(substr($flv_header, 4, 1));
 
@@ -87,10 +87,10 @@ 
 
 			$this_tag_header = fread($this->getid3->fp, 16);
 
-			$previous_tag_length = getid3_lib::BigEndian2Int(substr($this_tag_header,  0, 4));
-			$tag_type            = getid3_lib::BigEndian2Int(substr($this_tag_header,  4, 1));
-			$data_length         = getid3_lib::BigEndian2Int(substr($this_tag_header,  5, 3));
-			$timestamp           = getid3_lib::BigEndian2Int(substr($this_tag_header,  8, 3));
+			$previous_tag_length = getid3_lib::BigEndian2Int(substr($this_tag_header, 0, 4));
+			$tag_type            = getid3_lib::BigEndian2Int(substr($this_tag_header, 4, 1));
+			$data_length         = getid3_lib::BigEndian2Int(substr($this_tag_header, 5, 3));
+			$timestamp           = getid3_lib::BigEndian2Int(substr($this_tag_header, 8, 3));
 			$last_header_byte    = getid3_lib::BigEndian2Int(substr($this_tag_header, 15, 1));
 			$next_offset         = ftell($this->getid3->fp) - 1 + $data_length;
 
@@ -98,7 +98,7 @@ 
 
 				case getid3_flv::TAG_AUDIO:
 					if (!isset($info_flv['audio']['audioFormat'])) {
-						$info_flv['audio']['audioFormat']     =  $last_header_byte & 0x07;
+						$info_flv['audio']['audioFormat']     = $last_header_byte & 0x07;
 						$info_flv['audio']['audioRate']       = ($last_header_byte & 0x30) / 0x10;
 						$info_flv['audio']['audioSampleSize'] = ($last_header_byte & 0x40) / 0x40;
 						$info_flv['audio']['audioType']       = ($last_header_byte & 0x80) / 0x80;
@@ -401,7 +401,7 @@ 
 
 		$type = $this->stream->readByte();
 
-		switch($type) {
+		switch ($type) {
 			// Double
 			case 0:
 				$value = $this->readDouble();

Indentation +401 added lines, -401 removed lines

@@ -56,522 +56,522 @@
     const VIDEO_VP6    = 4;
 
 
-	public function Analyze()
-	{
-	    $info = &$this->getid3->info;
-
-	    $info['flv'] = array ();
-	    $info_flv = &$info['flv'];
-
-		fseek($this->getid3->fp, $info['avdataoffset'], SEEK_SET);
-
-		$flv_data_length = $info['avdataend'] - $info['avdataoffset'];
-		$flv_header = fread($this->getid3->fp, 5);
-
-		$info['fileformat'] = 'flv';
-		$info_flv['header']['signature'] =                           substr($flv_header, 0, 3);
-		$info_flv['header']['version']   = getid3_lib::BigEndian2Int(substr($flv_header, 3, 1));
-		$type_flags                      = getid3_lib::BigEndian2Int(substr($flv_header, 4, 1));
-
-		$info_flv['header']['hasAudio'] = (bool) ($type_flags & 0x04);
-		$info_flv['header']['hasVideo'] = (bool) ($type_flags & 0x01);
-
-		$frame_size_data_length = getid3_lib::BigEndian2Int(fread($this->getid3->fp, 4));
-		$flv_header_frame_length = 9;
-		if ($frame_size_data_length > $flv_header_frame_length) {
-			fseek($this->getid3->fp, $frame_size_data_length - $flv_header_frame_length, SEEK_CUR);
-		}
-
-		$duration = 0;
-		while ((ftell($this->getid3->fp) + 1) < $info['avdataend']) {
-
-			$this_tag_header = fread($this->getid3->fp, 16);
-
-			$previous_tag_length = getid3_lib::BigEndian2Int(substr($this_tag_header,  0, 4));
-			$tag_type            = getid3_lib::BigEndian2Int(substr($this_tag_header,  4, 1));
-			$data_length         = getid3_lib::BigEndian2Int(substr($this_tag_header,  5, 3));
-			$timestamp           = getid3_lib::BigEndian2Int(substr($this_tag_header,  8, 3));
-			$last_header_byte    = getid3_lib::BigEndian2Int(substr($this_tag_header, 15, 1));
-			$next_offset         = ftell($this->getid3->fp) - 1 + $data_length;
-
-			switch ($tag_type) {
-
-				case getid3_flv::TAG_AUDIO:
-					if (!isset($info_flv['audio']['audioFormat'])) {
-						$info_flv['audio']['audioFormat']     =  $last_header_byte & 0x07;
-						$info_flv['audio']['audioRate']       = ($last_header_byte & 0x30) / 0x10;
-						$info_flv['audio']['audioSampleSize'] = ($last_header_byte & 0x40) / 0x40;
-						$info_flv['audio']['audioType']       = ($last_header_byte & 0x80) / 0x80;
-					}
-					break;
-
-
-				case getid3_flv::TAG_VIDEO:
-					if (!isset($info_flv['video']['videoCodec'])) {
-						$info_flv['video']['videoCodec'] = $last_header_byte & 0x07;
-
-						$flv_video_header = fread($this->getid3->fp, 11);
-
-						if ($info_flv['video']['videoCodec'] != getid3_flv::VIDEO_VP6) {
-
-							$picture_size_type = (getid3_lib::BigEndian2Int(substr($flv_video_header, 3, 2))) >> 7;
-							$picture_size_type = $picture_size_type & 0x0007;
-							$info_flv['header']['videoSizeType'] = $picture_size_type;
-
-							switch ($picture_size_type) {
-								case 0:
-									$picture_size_enc = getid3_lib::BigEndian2Int(substr($flv_video_header, 5, 2));
-									$picture_size_enc <<= 1;
-									$info['video']['resolution_x'] = ($picture_size_enc & 0xFF00) >> 8;
-									$picture_size_enc = getid3_lib::BigEndian2Int(substr($flv_video_header, 6, 2));
-									$picture_size_enc <<= 1;
-									$info['video']['resolution_y'] = ($picture_size_enc & 0xFF00) >> 8;
-									break;
-
-								case 1:
-									$picture_size_enc = getid3_lib::BigEndian2Int(substr($flv_video_header, 5, 4));
-									$picture_size_enc <<= 1;
-									$info['video']['resolution_x'] = ($picture_size_enc & 0xFFFF0000) >> 16;
-
-									$picture_size_enc = getid3_lib::BigEndian2Int(substr($flv_video_header, 7, 4));
-									$picture_size_enc <<= 1;
-									$info['video']['resolution_y'] = ($picture_size_enc & 0xFFFF0000) >> 16;
-									break;
-
-								case 2:
-									$info['video']['resolution_x'] = 352;
-									$info['video']['resolution_y'] = 288;
-									break;
-
-								case 3:
-									$info['video']['resolution_x'] = 176;
-									$info['video']['resolution_y'] = 144;
-									break;
-
-								case 4:
-									$info['video']['resolution_x'] = 128;
-									$info['video']['resolution_y'] = 96;
-									break;
-
-								case 5:
-									$info['video']['resolution_x'] = 320;
-									$info['video']['resolution_y'] = 240;
-									break;
-
-								case 6:
-									$info['video']['resolution_x'] = 160;
-									$info['video']['resolution_y'] = 120;
-									break;
-
-								default:
-									$info['video']['resolution_x'] = 0;
-									$info['video']['resolution_y'] = 0;
-									break;
-							}
-						}
-					}
-					break;
-
-
-				// Meta tag
-				case getid3_flv::TAG_META:
-
-					fseek($this->getid3->fp, -1, SEEK_CUR);
-					$reader = new AMFReader(new AMFStream(fread($this->getid3->fp, $data_length)));
-					$event_name = $reader->readData();
-					$info['meta'][$event_name] = $reader->readData();
-					unset($reader);
-
-					$info['video']['frame_rate']   = @$info['meta']['onMetaData']['framerate'];
-					$info['video']['resolution_x'] = @$info['meta']['onMetaData']['width'];
-					$info['video']['resolution_y'] = @$info['meta']['onMetaData']['height'];
-					break;
-
-				default:
-					// noop
-					break;
-			}
-
-			if ($timestamp > $duration) {
-				$duration = $timestamp;
-			}
-
-			fseek($this->getid3->fp, $next_offset, SEEK_SET);
-		}
-
-		if ($info['playtime_seconds'] = $duration / 1000) {
-		    $info['bitrate'] = ($info['avdataend'] - $info['avdataoffset']) / $info['playtime_seconds'];
-		}
-
-		if ($info_flv['header']['hasAudio']) {
-			$info['audio']['codec']           = $this->FLVaudioFormat($info_flv['audio']['audioFormat']);
-			$info['audio']['sample_rate']     = $this->FLVaudioRate($info_flv['audio']['audioRate']);
-			$info['audio']['bits_per_sample'] = $this->FLVaudioBitDepth($info_flv['audio']['audioSampleSize']);
-
-			$info['audio']['channels']   = $info_flv['audio']['audioType'] + 1; // 0=mono,1=stereo
-			$info['audio']['lossless']   = ($info_flv['audio']['audioFormat'] ? false : true); // 0=uncompressed
-			$info['audio']['dataformat'] = 'flv';
-		}
-		if (@$info_flv['header']['hasVideo']) {
-			$info['video']['codec']      = $this->FLVvideoCodec($info_flv['video']['videoCodec']);
-			$info['video']['dataformat'] = 'flv';
-			$info['video']['lossless']   = false;
-		}
-
-		return true;
-	}
-
-
-	public static function FLVaudioFormat($id) {
-
-		static $lookup = array(
-			0 => 'uncompressed',
-			1 => 'ADPCM',
-			2 => 'mp3',
-			5 => 'Nellymoser 8kHz mono',
-			6 => 'Nellymoser',
-		);
-		return (@$lookup[$id] ? @$lookup[$id] : false);
-	}
-
-
-	public static function FLVaudioRate($id) {
-
-		static $lookup = array(
-			0 =>  5500,
-			1 => 11025,
-			2 => 22050,
-			3 => 44100,
-		);
-		return (@$lookup[$id] ? @$lookup[$id] : false);
-	}
-
-
-	public static function FLVaudioBitDepth($id) {
-
-		static $lookup = array(
-			0 =>  8,
-			1 => 16,
-		);
-		return (@$lookup[$id] ? @$lookup[$id] : false);
-	}
-
-
-	public static function FLVvideoCodec($id) {
-
-		static $lookup = array(
-			getid3_flv::VIDEO_H263   => 'Sorenson H.263',
-			getid3_flv::VIDEO_SCREEN => 'Screen video',
-			getid3_flv::VIDEO_VP6    => 'On2 VP6',
-		);
-		return (@$lookup[$id] ? @$lookup[$id] : false);
-	}
+    public function Analyze()
+    {
+        $info = &$this->getid3->info;
+
+        $info['flv'] = array ();
+        $info_flv = &$info['flv'];
+
+        fseek($this->getid3->fp, $info['avdataoffset'], SEEK_SET);
+
+        $flv_data_length = $info['avdataend'] - $info['avdataoffset'];
+        $flv_header = fread($this->getid3->fp, 5);
+
+        $info['fileformat'] = 'flv';
+        $info_flv['header']['signature'] =                           substr($flv_header, 0, 3);
+        $info_flv['header']['version']   = getid3_lib::BigEndian2Int(substr($flv_header, 3, 1));
+        $type_flags                      = getid3_lib::BigEndian2Int(substr($flv_header, 4, 1));
+
+        $info_flv['header']['hasAudio'] = (bool) ($type_flags & 0x04);
+        $info_flv['header']['hasVideo'] = (bool) ($type_flags & 0x01);
+
+        $frame_size_data_length = getid3_lib::BigEndian2Int(fread($this->getid3->fp, 4));
+        $flv_header_frame_length = 9;
+        if ($frame_size_data_length > $flv_header_frame_length) {
+            fseek($this->getid3->fp, $frame_size_data_length - $flv_header_frame_length, SEEK_CUR);
+        }
+
+        $duration = 0;
+        while ((ftell($this->getid3->fp) + 1) < $info['avdataend']) {
+
+            $this_tag_header = fread($this->getid3->fp, 16);
+
+            $previous_tag_length = getid3_lib::BigEndian2Int(substr($this_tag_header,  0, 4));
+            $tag_type            = getid3_lib::BigEndian2Int(substr($this_tag_header,  4, 1));
+            $data_length         = getid3_lib::BigEndian2Int(substr($this_tag_header,  5, 3));
+            $timestamp           = getid3_lib::BigEndian2Int(substr($this_tag_header,  8, 3));
+            $last_header_byte    = getid3_lib::BigEndian2Int(substr($this_tag_header, 15, 1));
+            $next_offset         = ftell($this->getid3->fp) - 1 + $data_length;
+
+            switch ($tag_type) {
+
+                case getid3_flv::TAG_AUDIO:
+                    if (!isset($info_flv['audio']['audioFormat'])) {
+                        $info_flv['audio']['audioFormat']     =  $last_header_byte & 0x07;
+                        $info_flv['audio']['audioRate']       = ($last_header_byte & 0x30) / 0x10;
+                        $info_flv['audio']['audioSampleSize'] = ($last_header_byte & 0x40) / 0x40;
+                        $info_flv['audio']['audioType']       = ($last_header_byte & 0x80) / 0x80;
+                    }
+                    break;
+
+
+                case getid3_flv::TAG_VIDEO:
+                    if (!isset($info_flv['video']['videoCodec'])) {
+                        $info_flv['video']['videoCodec'] = $last_header_byte & 0x07;
+
+                        $flv_video_header = fread($this->getid3->fp, 11);
+
+                        if ($info_flv['video']['videoCodec'] != getid3_flv::VIDEO_VP6) {
+
+                            $picture_size_type = (getid3_lib::BigEndian2Int(substr($flv_video_header, 3, 2))) >> 7;
+                            $picture_size_type = $picture_size_type & 0x0007;
+                            $info_flv['header']['videoSizeType'] = $picture_size_type;
+
+                            switch ($picture_size_type) {
+                                case 0:
+                                    $picture_size_enc = getid3_lib::BigEndian2Int(substr($flv_video_header, 5, 2));
+                                    $picture_size_enc <<= 1;
+                                    $info['video']['resolution_x'] = ($picture_size_enc & 0xFF00) >> 8;
+                                    $picture_size_enc = getid3_lib::BigEndian2Int(substr($flv_video_header, 6, 2));
+                                    $picture_size_enc <<= 1;
+                                    $info['video']['resolution_y'] = ($picture_size_enc & 0xFF00) >> 8;
+                                    break;
+
+                                case 1:
+                                    $picture_size_enc = getid3_lib::BigEndian2Int(substr($flv_video_header, 5, 4));
+                                    $picture_size_enc <<= 1;
+                                    $info['video']['resolution_x'] = ($picture_size_enc & 0xFFFF0000) >> 16;
+
+                                    $picture_size_enc = getid3_lib::BigEndian2Int(substr($flv_video_header, 7, 4));
+                                    $picture_size_enc <<= 1;
+                                    $info['video']['resolution_y'] = ($picture_size_enc & 0xFFFF0000) >> 16;
+                                    break;
+
+                                case 2:
+                                    $info['video']['resolution_x'] = 352;
+                                    $info['video']['resolution_y'] = 288;
+                                    break;
+
+                                case 3:
+                                    $info['video']['resolution_x'] = 176;
+                                    $info['video']['resolution_y'] = 144;
+                                    break;
+
+                                case 4:
+                                    $info['video']['resolution_x'] = 128;
+                                    $info['video']['resolution_y'] = 96;
+                                    break;
+
+                                case 5:
+                                    $info['video']['resolution_x'] = 320;
+                                    $info['video']['resolution_y'] = 240;
+                                    break;
+
+                                case 6:
+                                    $info['video']['resolution_x'] = 160;
+                                    $info['video']['resolution_y'] = 120;
+                                    break;
+
+                                default:
+                                    $info['video']['resolution_x'] = 0;
+                                    $info['video']['resolution_y'] = 0;
+                                    break;
+                            }
+                        }
+                    }
+                    break;
+
+
+                // Meta tag
+                case getid3_flv::TAG_META:
+
+                    fseek($this->getid3->fp, -1, SEEK_CUR);
+                    $reader = new AMFReader(new AMFStream(fread($this->getid3->fp, $data_length)));
+                    $event_name = $reader->readData();
+                    $info['meta'][$event_name] = $reader->readData();
+                    unset($reader);
+
+                    $info['video']['frame_rate']   = @$info['meta']['onMetaData']['framerate'];
+                    $info['video']['resolution_x'] = @$info['meta']['onMetaData']['width'];
+                    $info['video']['resolution_y'] = @$info['meta']['onMetaData']['height'];
+                    break;
+
+                default:
+                    // noop
+                    break;
+            }
+
+            if ($timestamp > $duration) {
+                $duration = $timestamp;
+            }
+
+            fseek($this->getid3->fp, $next_offset, SEEK_SET);
+        }
+
+        if ($info['playtime_seconds'] = $duration / 1000) {
+            $info['bitrate'] = ($info['avdataend'] - $info['avdataoffset']) / $info['playtime_seconds'];
+        }
+
+        if ($info_flv['header']['hasAudio']) {
+            $info['audio']['codec']           = $this->FLVaudioFormat($info_flv['audio']['audioFormat']);
+            $info['audio']['sample_rate']     = $this->FLVaudioRate($info_flv['audio']['audioRate']);
+            $info['audio']['bits_per_sample'] = $this->FLVaudioBitDepth($info_flv['audio']['audioSampleSize']);
+
+            $info['audio']['channels']   = $info_flv['audio']['audioType'] + 1; // 0=mono,1=stereo
+            $info['audio']['lossless']   = ($info_flv['audio']['audioFormat'] ? false : true); // 0=uncompressed
+            $info['audio']['dataformat'] = 'flv';
+        }
+        if (@$info_flv['header']['hasVideo']) {
+            $info['video']['codec']      = $this->FLVvideoCodec($info_flv['video']['videoCodec']);
+            $info['video']['dataformat'] = 'flv';
+            $info['video']['lossless']   = false;
+        }
+
+        return true;
+    }
+
+
+    public static function FLVaudioFormat($id) {
+
+        static $lookup = array(
+            0 => 'uncompressed',
+            1 => 'ADPCM',
+            2 => 'mp3',
+            5 => 'Nellymoser 8kHz mono',
+            6 => 'Nellymoser',
+        );
+        return (@$lookup[$id] ? @$lookup[$id] : false);
+    }
+
+
+    public static function FLVaudioRate($id) {
+
+        static $lookup = array(
+            0 =>  5500,
+            1 => 11025,
+            2 => 22050,
+            3 => 44100,
+        );
+        return (@$lookup[$id] ? @$lookup[$id] : false);
+    }
+
+
+    public static function FLVaudioBitDepth($id) {
+
+        static $lookup = array(
+            0 =>  8,
+            1 => 16,
+        );
+        return (@$lookup[$id] ? @$lookup[$id] : false);
+    }
+
+
+    public static function FLVvideoCodec($id) {
+
+        static $lookup = array(
+            getid3_flv::VIDEO_H263   => 'Sorenson H.263',
+            getid3_flv::VIDEO_SCREEN => 'Screen video',
+            getid3_flv::VIDEO_VP6    => 'On2 VP6',
+        );
+        return (@$lookup[$id] ? @$lookup[$id] : false);
+    }
 }
 
 
 
 class AMFStream
 {
-	public $bytes;
-	public $pos;
+    public $bytes;
+    public $pos;
 
 
-	public function AMFStream($bytes) {
+    public function AMFStream($bytes) {
 
-		$this->bytes = $bytes;
-		$this->pos = 0;
-	}
+        $this->bytes = $bytes;
+        $this->pos = 0;
+    }
 
 
-	public function readByte() {
+    public function readByte() {
 
-		return getid3_lib::BigEndian2Int(substr($this->bytes, $this->pos++, 1));
-	}
+        return getid3_lib::BigEndian2Int(substr($this->bytes, $this->pos++, 1));
+    }
 
 
-	public function readInt() {
+    public function readInt() {
 
-		return ($this->readByte() << 8) + $this->readByte();
-	}
+        return ($this->readByte() << 8) + $this->readByte();
+    }
 
 
-	public function readLong() {
+    public function readLong() {
 
-		return ($this->readByte() << 24) + ($this->readByte() << 16) + ($this->readByte() << 8) + $this->readByte();
-	}
+        return ($this->readByte() << 24) + ($this->readByte() << 16) + ($this->readByte() << 8) + $this->readByte();
+    }
 
 
-	public function readDouble() {
+    public function readDouble() {
 
-		return getid3_lib::BigEndian2Float($this->read(8));
-	}
+        return getid3_lib::BigEndian2Float($this->read(8));
+    }
 
 
-	public function readUTF() {
+    public function readUTF() {
 
-		$length = $this->readInt();
-		return $this->read($length);
-	}
+        $length = $this->readInt();
+        return $this->read($length);
+    }
 
 
-	public function readLongUTF() {
+    public function readLongUTF() {
 
-		$length = $this->readLong();
-		return $this->read($length);
-	}
+        $length = $this->readLong();
+        return $this->read($length);
+    }
 
 
-	public function read($length) {
+    public function read($length) {
 
-		$val = substr($this->bytes, $this->pos, $length);
-		$this->pos += $length;
-		return $val;
-	}
+        $val = substr($this->bytes, $this->pos, $length);
+        $this->pos += $length;
+        return $val;
+    }
 
 
-	public function peekByte() {
+    public function peekByte() {
 
-		$pos = $this->pos;
-		$val = $this->readByte();
-		$this->pos = $pos;
-		return $val;
-	}
+        $pos = $this->pos;
+        $val = $this->readByte();
+        $this->pos = $pos;
+        return $val;
+    }
 
 
-	public function peekInt() {
+    public function peekInt() {
 
-		$pos = $this->pos;
-		$val = $this->readInt();
-		$this->pos = $pos;
-		return $val;
-	}
+        $pos = $this->pos;
+        $val = $this->readInt();
+        $this->pos = $pos;
+        return $val;
+    }
 
 
-	public function peekLong() {
+    public function peekLong() {
 
-		$pos = $this->pos;
-		$val = $this->readLong();
-		$this->pos = $pos;
-		return $val;
-	}
+        $pos = $this->pos;
+        $val = $this->readLong();
+        $this->pos = $pos;
+        return $val;
+    }
 
 
-	public function peekDouble() {
+    public function peekDouble() {
 
-		$pos = $this->pos;
-		$val = $this->readDouble();
-		$this->pos = $pos;
-		return $val;
-	}
+        $pos = $this->pos;
+        $val = $this->readDouble();
+        $this->pos = $pos;
+        return $val;
+    }
 
 
-	public function peekUTF() {
+    public function peekUTF() {
 
-		$pos = $this->pos;
-		$val = $this->readUTF();
-		$this->pos = $pos;
-		return $val;
-	}
+        $pos = $this->pos;
+        $val = $this->readUTF();
+        $this->pos = $pos;
+        return $val;
+    }
 
 
-	public function peekLongUTF() {
+    public function peekLongUTF() {
 
-		$pos = $this->pos;
-		$val = $this->readLongUTF();
-		$this->pos = $pos;
-		return $val;
-	}
+        $pos = $this->pos;
+        $val = $this->readLongUTF();
+        $this->pos = $pos;
+        return $val;
+    }
 }
 
 
 
 class AMFReader
 {
-	public $stream;
+    public $stream;
 
-	public function __construct($stream) {
+    public function __construct($stream) {
 
-		$this->stream = $stream;
-	}
+        $this->stream = $stream;
+    }
 
 
-	public function readData() {
+    public function readData() {
 
-		$value = null;
+        $value = null;
 
-		$type = $this->stream->readByte();
+        $type = $this->stream->readByte();
 
-		switch($type) {
-			// Double
-			case 0:
-				$value = $this->readDouble();
-			break;
+        switch($type) {
+            // Double
+            case 0:
+                $value = $this->readDouble();
+            break;
 
-			// Boolean
-			case 1:
-				$value = $this->readBoolean();
-				break;
+            // Boolean
+            case 1:
+                $value = $this->readBoolean();
+                break;
 
-			// String
-			case 2:
-				$value = $this->readString();
-				break;
+            // String
+            case 2:
+                $value = $this->readString();
+                break;
 
-			// Object
-			case 3:
-				$value = $this->readObject();
-				break;
+            // Object
+            case 3:
+                $value = $this->readObject();
+                break;
 
-			// null
-			case 6:
-				return null;
-				break;
+            // null
+            case 6:
+                return null;
+                break;
 
-			// Mixed array
-			case 8:
-				$value = $this->readMixedArray();
-				break;
+            // Mixed array
+            case 8:
+                $value = $this->readMixedArray();
+                break;
 
-			// Array
-			case 10:
-				$value = $this->readArray();
-				break;
+            // Array
+            case 10:
+                $value = $this->readArray();
+                break;
 
-			// Date
-			case 11:
-				$value = $this->readDate();
-				break;
+            // Date
+            case 11:
+                $value = $this->readDate();
+                break;
 
-			// Long string
-			case 13:
-				$value = $this->readLongString();
-				break;
+            // Long string
+            case 13:
+                $value = $this->readLongString();
+                break;
 
-			// XML (handled as string)
-			case 15:
-				$value = $this->readXML();
-				break;
+            // XML (handled as string)
+            case 15:
+                $value = $this->readXML();
+                break;
 
-			// Typed object (handled as object)
-			case 16:
-				$value = $this->readTypedObject();
-				break;
+            // Typed object (handled as object)
+            case 16:
+                $value = $this->readTypedObject();
+                break;
 
-			// Long string
-			default:
-				$value = '(unknown or unsupported data type)';
-			break;
-		}
+            // Long string
+            default:
+                $value = '(unknown or unsupported data type)';
+            break;
+        }
 
-		return $value;
-	}
+        return $value;
+    }
 
 
-	public function readDouble() {
+    public function readDouble() {
 
-		return $this->stream->readDouble();
-	}
+        return $this->stream->readDouble();
+    }
 
 
-	public function readBoolean() {
+    public function readBoolean() {
 
-		return $this->stream->readByte() == 1;
-	}
+        return $this->stream->readByte() == 1;
+    }
 
 
-	public function readString() {
+    public function readString() {
 
-		return $this->stream->readUTF();
-	}
+        return $this->stream->readUTF();
+    }
 
 
-	public function readObject() {
+    public function readObject() {
 
-		// Get highest numerical index - ignored
-		$highestIndex = $this->stream->readLong();
+        // Get highest numerical index - ignored
+        $highestIndex = $this->stream->readLong();
 
-		$data = array();
+        $data = array();
 
-		while ($key = $this->stream->readUTF()) {
-			// Mixed array record ends with empty string (0x00 0x00) and 0x09
-			if (($key == '') && ($this->stream->peekByte() == 0x09)) {
-				// Consume byte
-				$this->stream->readByte();
-				break;
-			}
+        while ($key = $this->stream->readUTF()) {
+            // Mixed array record ends with empty string (0x00 0x00) and 0x09
+            if (($key == '') && ($this->stream->peekByte() == 0x09)) {
+                // Consume byte
+                $this->stream->readByte();
+                break;
+            }
 
-			$data[$key] = $this->readData();
-		}
+            $data[$key] = $this->readData();
+        }
 
-		return $data;
-	}
+        return $data;
+    }
 
 
-	public function readMixedArray() {
+    public function readMixedArray() {
 
-		// Get highest numerical index - ignored
-		$highestIndex = $this->stream->readLong();
+        // Get highest numerical index - ignored
+        $highestIndex = $this->stream->readLong();
 
-		$data = array();
+        $data = array();
 
-		while ($key = $this->stream->readUTF()) {
-			// Mixed array record ends with empty string (0x00 0x00) and 0x09
-			if (($key == '') && ($this->stream->peekByte() == 0x09)) {
-				// Consume byte
-				$this->stream->readByte();
-				break;
-			}
+        while ($key = $this->stream->readUTF()) {
+            // Mixed array record ends with empty string (0x00 0x00) and 0x09
+            if (($key == '') && ($this->stream->peekByte() == 0x09)) {
+                // Consume byte
+                $this->stream->readByte();
+                break;
+            }
 
-			if (is_numeric($key)) {
-				$key = (float) $key;
-			}
+            if (is_numeric($key)) {
+                $key = (float) $key;
+            }
 
-			$data[$key] = $this->readData();
-		}
+            $data[$key] = $this->readData();
+        }
 
-		return $data;
-	}
+        return $data;
+    }
 
 
-	public function readArray() {
+    public function readArray() {
 
-		$length = $this->stream->readLong();
+        $length = $this->stream->readLong();
 
-		$data = array();
+        $data = array();
 
-		for ($i = 0; $i < count($length); $i++) {
-			$data[] = $this->readData();
-		}
+        for ($i = 0; $i < count($length); $i++) {
+            $data[] = $this->readData();
+        }
 
-		return $data;
-	}
+        return $data;
+    }
 
 
-	public function readDate() {
+    public function readDate() {
 
-		$timestamp = $this->stream->readDouble();
-		$timezone = $this->stream->readInt();
-		return $timestamp;
-	}
+        $timestamp = $this->stream->readDouble();
+        $timezone = $this->stream->readInt();
+        return $timestamp;
+    }
 
 
-	public function readLongString() {
+    public function readLongString() {
 
-		return $this->stream->readLongUTF();
-	}
+        return $this->stream->readLongUTF();
+    }
 
 
-	public function readXML() {
+    public function readXML() {
 
-		return $this->stream->readLongUTF();
-	}
+        return $this->stream->readLongUTF();
+    }
 
 
-	public function readTypedObject() {
+    public function readTypedObject() {
 
-		$className = $this->stream->readUTF();
-		return $this->readObject();
-	}
+        $className = $this->stream->readUTF();
+        return $this->readObject();
+    }
 }
 
 ?>

main/inc/lib/grade_model.lib.php

Doc Comments +3 added lines

@@ -248,6 +248,9 @@
 	    //event_system(LOG_CAREER_DELETE, LOG_CAREER_ID, $id, api_get_utc_datetime(), api_get_user_id());
     }
 
+    /**
+     * @param CatForm $form
+     */
     public function fill_grade_model_select_in_form(&$form, $name = 'gradebook_model_id', $default_value = null)
     {
         if (api_get_setting('gradebook_enable_grade_model') == 'false') {

Indentation +15 added lines, -15 removed lines

@@ -51,15 +51,15 @@ 
     /**
      * Displays the title + grid
      */
-	public function display()
+    public function display()
     {
-		// action links
-		echo '<div class="actions" style="margin-bottom:20px">';
+        // action links
+        echo '<div class="actions" style="margin-bottom:20px">';
         echo '<a href="grade_models.php">'.Display::return_icon('back.png',get_lang('Back'),'','32').'</a>';
-		echo '<a href="'.api_get_self().'?action=add">'.Display::return_icon('add.png',get_lang('Add'),'','32').'</a>';
-		echo '</div>';
+        echo '<a href="'.api_get_self().'?action=add">'.Display::return_icon('add.png',get_lang('Add'),'','32').'</a>';
+        echo '</div>';
         echo Display::grid_html('grade_model');
-	}
+    }
 
     /**
      * Returns a Form validator Obj
@@ -116,7 +116,7 @@ 
         }
 
         $form->addElement('hidden', 'maxvalue', '100');
-		$form->addElement('hidden', 'minvalue', '0');
+        $form->addElement('hidden', 'minvalue', '0');
         $renderer = & $form->defaultRenderer();
 
         $component_array = array();
@@ -193,7 +193,7 @@ 
         // Setting the rules
         $form->addRule('name', get_lang('ThisFieldIsRequired'), 'required');
 
-		return $form;
+        return $form;
     }
 
     /**
@@ -216,8 +216,8 @@ 
      */
     public function save($params, $show_query = false)
     {
-	    $id = parent::save($params, $show_query);
-	    if (!empty($id)) {
+        $id = parent::save($params, $show_query);
+        if (!empty($id)) {
             foreach ($params['components'] as $component) {
                 if (!empty($component['title']) && !empty($component['percentage']) && !empty($component['acronym'])) {
                     $obj = new GradeModelComponents();
@@ -228,7 +228,7 @@ 
         }
 
         //event_system(LOG_CAREER_CREATE, LOG_CAREER_ID, $id, api_get_utc_datetime(), api_get_user_id());
-   		return $id;
+            return $id;
     }
 
     /**
@@ -257,7 +257,7 @@ 
      */
     public function delete($id)
     {
-	    parent::delete($id);
+        parent::delete($id);
     }
 
     public function fill_grade_model_select_in_form(&$form, $name = 'gradebook_model_id', $default_value = null)
@@ -305,11 +305,11 @@ 
     /**
      * GradeModelComponents constructor.
      */
-	public function __construct()
+    public function __construct()
     {
         parent::__construct();
         $this->table = Database::get_main_table(TABLE_GRADE_MODEL_COMPONENTS);
-	}
+    }
 
     /**
      * @param array $params
@@ -318,7 +318,7 @@ 
      */
     public function save($params, $show_query = false)
     {
-	    $id = parent::save($params, $show_query);
+        $id = parent::save($params, $show_query);
         
         return $id;
     }

Spacing +9 added lines, -9 removed lines

@@ -16,7 +16,7 @@ 
     public function __construct()
     {
         parent::__construct();
-        $this->table =  Database::get_main_table(TABLE_GRADE_MODEL);
+        $this->table = Database::get_main_table(TABLE_GRADE_MODEL);
     }
 
     /**
@@ -55,8 +55,8 @@ 
     {
 		// action links
 		echo '<div class="actions" style="margin-bottom:20px">';
-        echo '<a href="grade_models.php">'.Display::return_icon('back.png',get_lang('Back'),'','32').'</a>';
-		echo '<a href="'.api_get_self().'?action=add">'.Display::return_icon('add.png',get_lang('Add'),'','32').'</a>';
+        echo '<a href="grade_models.php">'.Display::return_icon('back.png', get_lang('Back'), '', '32').'</a>';
+		echo '<a href="'.api_get_self().'?action=add">'.Display::return_icon('add.png', get_lang('Add'), '', '32').'</a>';
 		echo '</div>';
         echo Display::grid_html('grade_model');
 	}
@@ -111,7 +111,7 @@ 
 
         if ($action == 'edit') {
             if (!empty($components)) {
-                $nr_items = count($components) -1;
+                $nr_items = count($components) - 1;
             }
         }
 
@@ -129,7 +129,7 @@ 
             $form->addElement('hidden', 'components['.$i.'][id]', null);
 
             $template_percentage =
-            '<div id=' . $i . ' style="display: '.(($i<=$nr_items)?'inline':'none').';" class="control-group">
+            '<div id='.$i.' style="display: '.(($i <= $nr_items) ? 'inline' : 'none').';" class="control-group">
                 <p>
                 <label class="control-label">{label}</label>
                 <div class="controls">
@@ -142,11 +142,11 @@ 
 
             $template_title =
             '&nbsp{element} <!-- BEGIN error --> <span class="form_error">{error}</span><!-- END error -->
-             <a href="javascript:plusItem(' . ($counter+1) . ')">
-                <img style="display: '.(($counter>=$nr_items)?'inline':'none').';" id="plus-' . ($counter+1) . '" src="'.Display::return_icon('add.png').'" alt="'.get_lang('Add').'" title="'.get_lang('Add').'">
+             <a href="javascript:plusItem(' . ($counter + 1).')">
+                <img style="display: '.(($counter >= $nr_items) ? 'inline' : 'none').';" id="plus-'.($counter + 1).'" src="'.Display::return_icon('add.png').'" alt="'.get_lang('Add').'" title="'.get_lang('Add').'">
             </a>
-            <a href="javascript:minItem(' . ($counter) . ')">
-                <img style="display: '.(($counter>=$nr_items)?'inline':'none').';" id="min-' . $counter . '" src="'.Display::return_icon('delete.png').'" alt="'.get_lang('Delete').'" title="'.get_lang('Delete').'">
+            <a href="javascript:minItem(' . ($counter).')">
+                <img style="display: '.(($counter >= $nr_items) ? 'inline' : 'none').';" id="min-'.$counter.'" src="'.Display::return_icon('delete.png').'" alt="'.get_lang('Delete').'" title="'.get_lang('Delete').'">
             </a>
             </div></p></div>';
 

main/inc/lib/groupmanager.lib.php

Doc Comments +13 added lines, -10 removed lines

@@ -369,7 +369,7 @@ 
      * @author Christophe Gesche <christophe.gesche@claroline.net>
      * @author Hugues Peeters <hugues.peeters@claroline.net>
      * @author Bart Mollet
-     * @param  mixed  $groupIdList - group(s) to delete. It can be a single id
+     * @param  mixed  $group_ids - group(s) to delete. It can be a single id
      *                                (int) or a list of id (array).
      * @param string $course_code Default is current course
      * @return integer              - number of groups deleted.
@@ -573,7 +573,7 @@ 
      * @param bool      Whether self registration is allowed or not
      * @param bool      Whether self unregistration is allowed or not
      * @param int       $categoryId
-     * @return bool     TRUE if properties are successfully changed, false otherwise
+     * @return Statement|null     TRUE if properties are successfully changed, false otherwise
      */
     public static function set_group_properties(
         $group_id,
@@ -724,7 +724,7 @@ 
      * @param int $group_id The id of the group
      * @param string $course_code The course in which the group is (default =
      * current course)
-     * @return array The category
+     * @return integer The category
      */
     public static function get_category_from_group($group_id, $course_code = null)
     {
@@ -786,9 +786,9 @@ 
      * Create group category
      * @param string $title The title of the new category
      * @param string $description The description of the new category
-     * @param bool $self_registration_allowed
-     * @param bool $self_unregistration_allowed
-     * @param int $max_number_of_students
+     * @param integer $self_registration_allowed
+     * @param integer $self_unregistration_allowed
+     * @param int $maximum_number_of_students
      * @param int $groups_per_user
      */
     public static function create_category(
@@ -994,6 +994,8 @@ 
      * @param int $limit
      * @param bool $getCount
      * @param int $courseId
+     * @param string $column
+     * @param string $direction
      * @return array list of user id
      */
     public static function get_users(
@@ -1172,7 +1174,7 @@ 
      *         Hugues Peeters     <hugues.peeters@claroline.net> - original version
      * @author Roan Embrechts - virtual course support, code cleaning
      * @author Bart Mollet - code cleaning, use other GroupManager-functions
-     * @return void
+     * @return false|null
      */
     public static function fill_groups($group_ids)
     {
@@ -1625,7 +1627,7 @@ 
      * Unsubscribe user(s) from a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
      * @param int $group_id
-     * @return bool TRUE if successful
+     * @return boolean|null TRUE if successful
      */
     public static function unsubscribe_users($user_ids, $group_id)
     {
@@ -1644,7 +1646,7 @@ 
 
     /**
      * Unsubscribe all users from one or more groups
-     * @param mixed $group_id Can be an array with group-id's or a single group-id
+     * @param mixed $group_ids Can be an array with group-id's or a single group-id
      * @return bool TRUE if successful
      */
     public static function unsubscribe_all_users($group_ids)
@@ -1676,7 +1678,7 @@ 
 
     /**
      * Unsubscribe all tutors from one or more groups
-     * @param mixed $group_id Can be an array with group-id's or a single group-id
+     * @param mixed $group_ids Can be an array with group-id's or a single group-id
      * @see unsubscribe_all_users. This function is almost an exact copy of that function.
      * @return bool TRUE if successful
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1861,6 +1863,7 @@ 
      *
      * @param $user_array_in list of users (must be sorted).
      * @param string $compare_field, the field to be compared
+     * @param string $compare_field
      */
     public static function filter_duplicates($user_array_in, $compare_field)
     {

Spacing +39 added lines, -39 removed lines

@@ -211,8 +211,8 @@ 
             $sql = "UPDATE $table_group SET id = iid WHERE iid = $lastId";
             Database::query($sql);
 
-            $desired_dir_name= '/'.api_replace_dangerous_char($name).'_groupdocs';
-            $my_path = api_get_path(SYS_COURSE_PATH) . $currentCourseRepository . '/document';
+            $desired_dir_name = '/'.api_replace_dangerous_char($name).'_groupdocs';
+            $my_path = api_get_path(SYS_COURSE_PATH).$currentCourseRepository.'/document';
 
             $newFolderData = create_unexisting_directory(
                 $_course,
@@ -275,11 +275,11 @@ 
                 $values['default_view_type_group']['default_view_type'] = api_get_setting('default_forum_view');
                 $values['group_forum'] = $lastId;
                 if ($forumState == '1') {
-                    $values['public_private_group_forum_group']['public_private_group_forum']='public';
+                    $values['public_private_group_forum_group']['public_private_group_forum'] = 'public';
                 } elseif ($forumState == '2') {
-                    $values['public_private_group_forum_group']['public_private_group_forum']='private';
+                    $values['public_private_group_forum_group']['public_private_group_forum'] = 'private';
                 } elseif ($forumState == '0') {
-                    $values['public_private_group_forum_group']['public_private_group_forum']='unavailable';
+                    $values['public_private_group_forum_group']['public_private_group_forum'] = 'unavailable';
                 }
                 store_forum($values);
             }
@@ -310,9 +310,9 @@ 
             1
         );
         $users = self::get_users($group_id);
-        $group_ids = array ();
+        $group_ids = array();
 
-        for ($group_nr = 1; $group_nr <= $number_of_groups; $group_nr ++) {
+        for ($group_nr = 1; $group_nr <= $number_of_groups; $group_nr++) {
             $group_ids[] = self::create_group(
                 get_lang('Subgroup').' '.$group_nr,
                 $category_id,
@@ -356,7 +356,7 @@ 
                 0,
                 count($users_ids)
             );
-            self::subscribe_users($users_ids,$group_id);
+            self::subscribe_users($users_ids, $group_id);
             $group_ids[] = $group_id;
         }
         return $group_ids;
@@ -381,14 +381,14 @@ 
         $group_table = Database:: get_course_table(TABLE_GROUP);
         $forum_table = Database:: get_course_table(TABLE_FORUM);
 
-        $group_ids = is_array($group_ids) ? $group_ids : array ($group_ids);
-        $group_ids = array_map('intval',$group_ids);
+        $group_ids = is_array($group_ids) ? $group_ids : array($group_ids);
+        $group_ids = array_map('intval', $group_ids);
 
         if (api_is_course_coach()) {
             //a coach can only delete courses from his session
             for ($i = 0; $i < count($group_ids); $i++) {
-                if (!api_is_element_in_the_session(TOOL_GROUP,$group_ids[$i])) {
-                    array_splice($group_ids,$i,1);
+                if (!api_is_element_in_the_session(TOOL_GROUP, $group_ids[$i])) {
+                    array_splice($group_ids, $i, 1);
                     $i--;
                 }
             }
@@ -623,7 +623,7 @@ 
         } elseif ($forum_state === 0) {
             $sql2 .= " forum_group_public_private='unavailable' ";
         }
-        $sql2 .=" WHERE c_id = $course_id AND forum_of_group=".$group_id;
+        $sql2 .= " WHERE c_id = $course_id AND forum_of_group=".$group_id;
         Database::query($sql2);
         return $result;
     }
@@ -653,13 +653,13 @@ 
     public static function get_categories($course_code = null)
     {
         $course_info = api_get_course_info($course_code);
-        $course_id     = $course_info['real_id'];
+        $course_id = $course_info['real_id'];
         $table_group_cat = Database :: get_course_table(TABLE_GROUP_CATEGORY);
         $sql = "SELECT * FROM $table_group_cat
                 WHERE c_id = $course_id
                 ORDER BY display_order";
         $res = Database::query($sql);
-        $cats = array ();
+        $cats = array();
         while ($cat = Database::fetch_array($res)) {
             $cats[] = $cat;
         }
@@ -771,7 +771,7 @@ 
                 WHERE c_id = $course_id AND category_id='".$cat_id."'";
         $res = Database::query($sql);
         if (Database::num_rows($res) > 0) {
-            $groups_to_delete = array ();
+            $groups_to_delete = array();
             while ($group = Database::fetch_object($res)) {
                 $groups_to_delete[] = $group->id;
             }
@@ -939,7 +939,7 @@ 
      */
     public static function get_current_max_groups_per_user($category_id = null, $course_code = null)
     {
-        $course_info = api_get_course_info ($course_code);
+        $course_info = api_get_course_info($course_code);
         $group_table = Database :: get_course_table(TABLE_GROUP);
         $group_user_table = Database :: get_course_table(TABLE_GROUP_USER);
         $sql = 'SELECT COUNT(gu.group_id) AS current_max
@@ -1182,17 +1182,17 @@ 
     {
         $_course = api_get_course_info();
 
-        $group_ids = is_array($group_ids) ? $group_ids : array ($group_ids);
+        $group_ids = is_array($group_ids) ? $group_ids : array($group_ids);
         $group_ids = array_map('intval', $group_ids);
 
         if (api_is_course_coach()) {
-            for ($i=0 ; $i < count($group_ids) ; $i++) {
-                if (!api_is_element_in_the_session(TOOL_GROUP, $group_ids[$i])){
-                    array_splice($group_ids,$i,1);
+            for ($i = 0; $i < count($group_ids); $i++) {
+                if (!api_is_element_in_the_session(TOOL_GROUP, $group_ids[$i])) {
+                    array_splice($group_ids, $i, 1);
                     $i--;
                 }
             }
-            if (count($group_ids)==0) {
+            if (count($group_ids) == 0) {
                 return false;
             }
         }
@@ -1231,9 +1231,9 @@ 
          * Retrieve course users (reverse) ordered by the number
          * of group they are already enrolled
          */
-        for ($i = 0; $i < count($complete_user_list); $i ++) {
+        for ($i = 0; $i < count($complete_user_list); $i++) {
             //find # of groups the user is enrolled in
-            $number_of_groups = self :: user_in_number_of_groups($complete_user_list[$i]["user_id"], (isset($category['id'])?$category['id']:null));
+            $number_of_groups = self :: user_in_number_of_groups($complete_user_list[$i]["user_id"], (isset($category['id']) ? $category['id'] : null));
             //add # of groups to user list
             $complete_user_list[$i]['number_groups_left'] = $number_groups_per_user - $number_of_groups;
         }
@@ -1245,7 +1245,7 @@ 
 
         //now sort by # of group left
         $complete_user_list = TableSort :: sort_table($complete_user_list, 'number_groups_left', SORT_DESC);
-        $userToken = array ();
+        $userToken = array();
         foreach ($complete_user_list as $this_user) {
             if ($this_user['number_groups_left'] > 0) {
                 $userToken[$this_user['user_id']] = $this_user['number_groups_left'];
@@ -1440,7 +1440,7 @@ 
                 if ($category['groups_per_user'] == self::GROUP_PER_MEMBER_NO_LIMIT) {
                     $category['groups_per_user'] = self::INFINITE;
                 }
-                $result = self:: user_in_number_of_groups($user_id, $category['id'] ) < $category['groups_per_user'];
+                $result = self:: user_in_number_of_groups($user_id, $category['id']) < $category['groups_per_user'];
                 if ($result == false) {
                     return false;
                 }
@@ -1551,7 +1551,7 @@ 
                     tg.group_id='".$group_id."' AND
                     tg.user_id=u.user_id".$order_clause;
         $db_result = Database::query($sql);
-        $users = array ();
+        $users = array();
         while ($user = Database::fetch_object($db_result)) {
             if (!$id_only) {
                 $member['user_id'] = $user->user_id;
@@ -1616,8 +1616,8 @@ 
         foreach ($user_ids as $user_id) {
             $user_id = intval($user_id);
             if (self::can_user_subscribe($user_id, $group_id, false)) {
-                $sql = "INSERT INTO " . $table_group_tutor . " (c_id, user_id, group_id)
-                        VALUES ('$course_id', '" . $user_id . "', '" . $group_id . "')";
+                $sql = "INSERT INTO ".$table_group_tutor." (c_id, user_id, group_id)
+                        VALUES ('$course_id', '".$user_id."', '".$group_id."')";
                 $result &= Database::query($sql);
             }
         }
@@ -1633,7 +1633,7 @@ 
      */
     public static function unsubscribe_users($user_ids, $group_id)
     {
-        $user_ids = is_array($user_ids) ? $user_ids : array ($user_ids);
+        $user_ids = is_array($user_ids) ? $user_ids : array($user_ids);
         $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
         $group_id = intval($group_id);
         $course_id = api_get_course_int_id();
@@ -2179,7 +2179,7 @@ 
          * Retrieve course users (reverse) ordered by the number
          * of group they are already enrolled
          */
-        for ($i = 0; $i < count($complete_user_list); $i ++) {
+        for ($i = 0; $i < count($complete_user_list); $i++) {
             // find # of groups the user is enrolled in
             $number_of_groups = self:: user_in_number_of_groups(
                 $complete_user_list[$i]["user_id"],
@@ -2312,14 +2312,14 @@ 
                 !(api_is_course_coach() && intval($this_group['session_id']) != $session_id)
             ) {
                 $edit_actions = '<a href="'.$url.'settings.php?'.api_get_cidreq(true, false).'&gidReq='.$this_group['id'].'"  title="'.get_lang('Edit').'">'.
-                    Display::return_icon('edit.png', get_lang('EditGroup'),'',ICON_SIZE_SMALL).'</a>&nbsp;';
+                    Display::return_icon('edit.png', get_lang('EditGroup'), '', ICON_SIZE_SMALL).'</a>&nbsp;';
 
                 if ($this_group['status'] == 1) {
-                    $edit_actions .= '<a href="' . api_get_self() . '?' . api_get_cidreq(true,false) . '&category=' . $category_id . '&action=set_invisible&id=' . $this_group['id'] . '" title="' . get_lang('Hide') . '">' .
-                        Display::return_icon('visible.png', get_lang('Hide'), '', ICON_SIZE_SMALL) . '</a>&nbsp;';
+                    $edit_actions .= '<a href="'.api_get_self().'?'.api_get_cidreq(true, false).'&category='.$category_id.'&action=set_invisible&id='.$this_group['id'].'" title="'.get_lang('Hide').'">'.
+                        Display::return_icon('visible.png', get_lang('Hide'), '', ICON_SIZE_SMALL).'</a>&nbsp;';
                 } else {
-                    $edit_actions .= '<a href="' . api_get_self() . '?' . api_get_cidreq(true, false) . '&category=' . $category_id . '&action=set_visible&id=' . $this_group['id'] . '" title="' . get_lang('Show') . '">' .
-                        Display::return_icon('invisible.png', get_lang('Show'), '', ICON_SIZE_SMALL) . '</a>&nbsp;';
+                    $edit_actions .= '<a href="'.api_get_self().'?'.api_get_cidreq(true, false).'&category='.$category_id.'&action=set_visible&id='.$this_group['id'].'" title="'.get_lang('Show').'">'.
+                        Display::return_icon('invisible.png', get_lang('Show'), '', ICON_SIZE_SMALL).'</a>&nbsp;';
                 }
 
                 $edit_actions .= '<a href="'.$url.'member_settings.php?'.api_get_cidreq(true, false).'&gidReq='.$this_group['id'].'"  title="'.get_lang('GroupMembers').'">'.
@@ -2332,10 +2332,10 @@ 
                     Display::return_icon('clean.png',get_lang('EmptyGroup'),'',ICON_SIZE_SMALL).'</a>&nbsp;';*/
 
                 $edit_actions .= '<a href="'.api_get_self().'?'.api_get_cidreq(true, false).'&category='.$category_id.'&action=fill_one&id='.$this_group['id'].'" onclick="javascript: if(!confirm('."'".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES))."'".')) return false;" title="'.get_lang('FillGroup').'">'.
-                    Display::return_icon('fill.png',get_lang('FillGroup'),'',ICON_SIZE_SMALL).'</a>&nbsp;';
+                    Display::return_icon('fill.png', get_lang('FillGroup'), '', ICON_SIZE_SMALL).'</a>&nbsp;';
 
                 $edit_actions .= '<a href="'.api_get_self().'?'.api_get_cidreq(true, false).'&category='.$category_id.'&action=delete_one&id='.$this_group['id'].'" onclick="javascript: if(!confirm('."'".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES))."'".')) return false;" title="'.get_lang('Delete').'">'.
-                    Display::return_icon('delete.png', get_lang('Delete'),'',ICON_SIZE_SMALL).'</a>&nbsp;';
+                    Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).'</a>&nbsp;';
 
                 $row[] = $edit_actions;
             }
@@ -2707,7 +2707,7 @@ 
         $activeTutor = null;
         $activeMember = null;
 
-        switch($default) {
+        switch ($default) {
             case 'settings':
                 $activeSettings = 'active';
                 break;

main/inc/lib/hook/HookManagement.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
 
     /**
      * Return a list an associative array where keys are the active hook observer class name
-     * @param $eventName
+     * @param string $eventName
      *
      * @return array
      */

Spacing +14 added lines, -14 removed lines

@@ -145,10 +145,10 @@ 
     public function listHookObservers($eventName)
     {
         $array = array();
-        $joinTable = $this->tables[TABLE_HOOK_CALL] . ' hc' .
-            ' INNER JOIN ' . $this->tables[TABLE_HOOK_EVENT] . ' he' .
-            ' ON hc.hook_event_id = he.id ' .
-            ' INNER JOIN ' . $this->tables[TABLE_HOOK_OBSERVER] . ' ho ' .
+        $joinTable = $this->tables[TABLE_HOOK_CALL].' hc'.
+            ' INNER JOIN '.$this->tables[TABLE_HOOK_EVENT].' he'.
+            ' ON hc.hook_event_id = he.id '.
+            ' INNER JOIN '.$this->tables[TABLE_HOOK_OBSERVER].' ho '.
             ' ON hc.hook_observer_id = ho.id ';
         $columns = 'ho.class_name, ho.path, ho.plugin_name, hc.enabled';
         $where = array('where' => array('he.class_name = ? ' => $eventName, 'AND hc.enabled = ? ' => 1));
@@ -202,10 +202,10 @@ 
     public function listAllHookCalls()
     {
         $array = array();
-        $joinTable = $this->tables[TABLE_HOOK_CALL] . ' hc' .
-            ' INNER JOIN ' . $this->tables[TABLE_HOOK_EVENT] . ' he' .
-            ' ON hc.hook_event_id = he.id ' .
-            ' INNER JOIN ' . $this->tables[TABLE_HOOK_OBSERVER] . ' ho ' .
+        $joinTable = $this->tables[TABLE_HOOK_CALL].' hc'.
+            ' INNER JOIN '.$this->tables[TABLE_HOOK_EVENT].' he'.
+            ' ON hc.hook_event_id = he.id '.
+            ' INNER JOIN '.$this->tables[TABLE_HOOK_OBSERVER].' ho '.
             ' ON hc.hook_observer_id = ho.id ';
         $columns = 'he.class_name AS event_class_name, ho.class_name AS observer_class_name, hc.id AS id, hc.type AS type';
         $rows = Database::select($columns, $joinTable);
@@ -231,7 +231,7 @@ 
         if (isset($eventName) && !isset($this->hookEvents[$eventName])) {
             $attributes = array(
                 'class_name' => $eventName,
-                'description' => get_lang('HookDescription' . $eventName),
+                'description' => get_lang('HookDescription'.$eventName),
             );
             $id = Database::insert($this->tables[TABLE_HOOK_EVENT], $attributes);
             $this->hookEvents[$eventName] = $id;
@@ -240,7 +240,7 @@ 
         // Check if exists hook observer
         if (isset($observerClassName) &&
             !isset($this->hookObservers[$observerClassName])
-        ){
+        ) {
             $object = $observerClassName::create();
             $attributes = array(
                 'class_name' => $observerClassName,
@@ -338,10 +338,10 @@ 
         $eventName = Database::escape_string($eventName);
         $observerClassName($observerClassName);
         $type = Database::escape_string($type);
-        $joinTable = $this->tables[TABLE_HOOK_CALL] . ' hc' .
-            ' INNER JOIN ' . $this->tables[TABLE_HOOK_EVENT] . ' he' .
-            ' ON hc.hook_event_id = he.id ' .
-            ' INNER JOIN ' . $this->tables[TABLE_HOOK_OBSERVER] . ' ho ' .
+        $joinTable = $this->tables[TABLE_HOOK_CALL].' hc'.
+            ' INNER JOIN '.$this->tables[TABLE_HOOK_EVENT].' he'.
+            ' ON hc.hook_event_id = he.id '.
+            ' INNER JOIN '.$this->tables[TABLE_HOOK_OBSERVER].' ho '.
             ' ON hc.hook_observer_id = ho.id ';
         $row = Database::select(
             'id',

main/inc/lib/login.lib.php

Doc Comments +2 added lines, -1 removed lines

@@ -266,6 +266,7 @@ 
      * @global bool   $is_platformAdmin
      * @global bool   $is_allowedCreateCourse
      * @global object $_user
+     * @param boolean $reset
      */
     public static function init_user($user_id, $reset)
     {
@@ -355,7 +356,7 @@ 
      * @global type $is_allowed_in_course
      *
      * @param type $course_id
-     * @param type $reset
+     * @param boolean $reset
      */
     static function init_course($course_id, $reset)
     {

Indentation +6 added lines, -6 removed lines

@@ -852,14 +852,14 @@ 
             $email = false;
         }
 
-		if ($email) {
-			$condition = "LOWER(email) = '".Database::escape_string($username)."' ";
-		} else {
+        if ($email) {
+            $condition = "LOWER(email) = '".Database::escape_string($username)."' ";
+        } else {
             $condition = "LOWER(username) = '".Database::escape_string($username)."'";
         }
 
-		$tbl_user = Database :: get_main_table(TABLE_MAIN_USER);
-		$query = "SELECT 
+        $tbl_user = Database :: get_main_table(TABLE_MAIN_USER);
+        $query = "SELECT 
 		            user_id AS uid, 
 		            lastname AS lastName, 
 		            firstname AS firstName, 
@@ -874,7 +874,7 @@ 
                     auth_source
 				 FROM $tbl_user
 				 WHERE ( $condition AND active = 1) ";
-		$result = Database::query($query);
+        $result = Database::query($query);
         $num_rows = Database::num_rows($result);
         if ($result && $num_rows > 0) {
             return Database::fetch_assoc($result);

Spacing +38 added lines, -38 removed lines

@@ -37,24 +37,24 @@ 
             if ($by_username) {
                 $secret_word = self::get_secret_word($user['email']);
                 if ($reset) {
-                    $reset_link = $portal_url . "main/auth/lostPassword.php?reset=" . $secret_word . "&id=" . $user['uid'];
+                    $reset_link = $portal_url."main/auth/lostPassword.php?reset=".$secret_word."&id=".$user['uid'];
                 } else {
-                    $reset_link = get_lang('Pass') . " : $user[password]";
+                    $reset_link = get_lang('Pass')." : $user[password]";
                 }
-                $user_account_list = get_lang('YourRegistrationData') . " : \n" . get_lang('UserName') . ' : ' . $user['loginName'] . "\n" . get_lang('ResetLink') . ' : ' . $reset_link . '';
+                $user_account_list = get_lang('YourRegistrationData')." : \n".get_lang('UserName').' : '.$user['loginName']."\n".get_lang('ResetLink').' : '.$reset_link.'';
 
                 if ($user_account_list) {
-                    $user_account_list = "\n-----------------------------------------------\n" . $user_account_list;
+                    $user_account_list = "\n-----------------------------------------------\n".$user_account_list;
                 }
             } else {
                 foreach ($user as $this_user) {
                     $secret_word = self::get_secret_word($this_user['email']);
                     if ($reset) {
-                        $reset_link = $portal_url . "main/auth/lostPassword.php?reset=" . $secret_word . "&id=" . $this_user['uid'];
+                        $reset_link = $portal_url."main/auth/lostPassword.php?reset=".$secret_word."&id=".$this_user['uid'];
                     } else {
-                        $reset_link = get_lang('Pass') . " : $this_user[password]";
+                        $reset_link = get_lang('Pass')." : $this_user[password]";
                     }
-                    $user_account_list[] = get_lang('YourRegistrationData') . " : \n" . get_lang('UserName') . ' : ' . $this_user['loginName'] . "\n" . get_lang('ResetLink') . ' : ' . $reset_link . '';
+                    $user_account_list[] = get_lang('YourRegistrationData')." : \n".get_lang('UserName').' : '.$this_user['loginName']."\n".get_lang('ResetLink').' : '.$reset_link.'';
                 }
                 if ($user_account_list) {
                     $user_account_list = implode("\n-----------------------------------------------\n", $user_account_list);
@@ -64,8 +64,8 @@ 
             if (!$by_username) {
                 $user = $user[0];
             }
-            $reset_link = get_lang('Pass') . " : $user[password]";
-            $user_account_list = get_lang('YourRegistrationData') . " : \n" . get_lang('UserName') . ' : ' . $user['loginName'] . "\n" . $reset_link . '';
+            $reset_link = get_lang('Pass')." : $user[password]";
+            $user_account_list = get_lang('YourRegistrationData')." : \n".get_lang('UserName').' : '.$user['loginName']."\n".$reset_link.'';
         }
         return $user_account_list;
     }
@@ -78,7 +78,7 @@ 
      */
     public static function send_password_to_user($user, $by_username = false)
     {
-        $email_subject = "[" . api_get_setting('siteName') . "] " . get_lang('LoginRequest'); // SUBJECT
+        $email_subject = "[".api_get_setting('siteName')."] ".get_lang('LoginRequest'); // SUBJECT
 
         if ($by_username) { // Show only for lost password
             $user_account_list = self::get_user_account_list($user, false, $by_username); // BODY
@@ -97,7 +97,7 @@ 
             }
         }
 
-        $email_body = get_lang('YourAccountParam') . " " . $portal_url . "\n\n$user_account_list";
+        $email_body = get_lang('YourAccountParam')." ".$portal_url."\n\n$user_account_list";
         // SEND MESSAGE
         $sender_name = api_get_person_name(
             api_get_setting('administratorName'),
@@ -136,7 +136,7 @@ 
      */
     public static function handle_encrypted_password($user, $by_username = false)
     {
-        $email_subject = "[" . api_get_setting('siteName') . "] " . get_lang('LoginRequest'); // SUBJECT
+        $email_subject = "[".api_get_setting('siteName')."] ".get_lang('LoginRequest'); // SUBJECT
 
         if ($by_username) {
         // Show only for lost password
@@ -146,11 +146,11 @@ 
             $user_account_list = self::get_user_account_list($user, true); // BODY
             $email_to = $user[0]['email'];
         }
-        $email_body = get_lang('DearUser') . " :\n" . get_lang('password_request') . "\n";
-        $email_body .= $user_account_list . "\n-----------------------------------------------\n\n";
+        $email_body = get_lang('DearUser')." :\n".get_lang('password_request')."\n";
+        $email_body .= $user_account_list."\n-----------------------------------------------\n\n";
         $email_body .= get_lang('PasswordEncryptedForSecurity');
 
-        $email_body .= "\n\n" . get_lang('SignatureFormula') . ",\n" . api_get_setting('administratorName') . " " . api_get_setting('administratorSurname') . "\n" . get_lang('PlataformAdmin') . " - " . api_get_setting('siteName');
+        $email_body .= "\n\n".get_lang('SignatureFormula').",\n".api_get_setting('administratorName')." ".api_get_setting('administratorSurname')."\n".get_lang('PlataformAdmin')." - ".api_get_setting('siteName');
 
         $sender_name = api_get_person_name(
             api_get_setting('administratorName'),
@@ -251,7 +251,7 @@ 
                     password,
                     email,
                     auth_source
-                FROM " . $tbl_user . "
+                FROM " . $tbl_user."
                 WHERE user_id = $id";
         $result = Database::query($sql);
         $num_rows = Database::num_rows($result);
@@ -309,7 +309,7 @@ 
                         ON user.user_id = a.user_id
                         LEFT JOIN $track_e_login login
                         ON user.user_id  = login.login_user_id
-                        WHERE user.user_id = '" . $_user['user_id'] . "'
+                        WHERE user.user_id = '".$_user['user_id']."'
                         ORDER BY login.login_date DESC LIMIT 1";
 
                 $result = Database::query($sql);
@@ -339,7 +339,7 @@ 
                     Session::write('is_platformAdmin', $is_platformAdmin);
                     Session::write('is_allowedCreateCourse', $is_allowedCreateCourse);
                 } else {
-                    header('location:' . api_get_path(WEB_PATH));
+                    header('location:'.api_get_path(WEB_PATH));
                     //exit("WARNING UNDEFINED UID !! ");
                 }
             } else { // no uid => logout or Anonymous
@@ -387,9 +387,9 @@ 
         global $_course;
         global $_real_cid;
 
-        global $is_courseAdmin;  //course teacher
-        global $is_courseTutor;  //course teacher - some rights
-        global $is_courseCoach;  //course coach
+        global $is_courseAdmin; //course teacher
+        global $is_courseTutor; //course teacher - some rights
+        global $is_courseCoach; //course coach
         global $is_courseMember; //course student
         global $is_sessionAdmin;
         global $is_allowed_in_course;
@@ -446,7 +446,7 @@ 
 
                     if (!empty($_GET['id_session'])) {
                         $_SESSION['id_session'] = intval($_GET['id_session']);
-                        $sql = 'SELECT name FROM ' . $tbl_session . ' WHERE id="' . intval($_SESSION['id_session']) . '"';
+                        $sql = 'SELECT name FROM '.$tbl_session.' WHERE id="'.intval($_SESSION['id_session']).'"';
                         $rs = Database::query($sql);
                         list($_SESSION['session_name']) = Database::fetch_array($rs);
                     } else {
@@ -462,7 +462,7 @@ 
                     }
                 } else {
                     //exit("WARNING UNDEFINED CID !! ");
-                    header('location:' . api_get_path(WEB_PATH));
+                    header('location:'.api_get_path(WEB_PATH));
                 }
             } else {
                 Session::erase('_cid');
@@ -489,7 +489,7 @@ 
         } else {
             // Continue with the previous values
             if (empty($_SESSION['_course']) OR empty($_SESSION['_cid'])) { //no previous values...
-                $_cid = -1;        //set default values that will be caracteristic of being unset
+                $_cid = -1; //set default values that will be caracteristic of being unset
                 $_course = -1;
             } else {
                 $_cid = $_SESSION['_cid'];
@@ -499,7 +499,7 @@ 
                 // Moreover, if we want to track a course with another session it can be usefull
                 if (!empty($_GET['id_session'])) {
                     $tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
-                    $sql = 'SELECT name FROM ' . $tbl_session . ' WHERE id="' . intval($_SESSION['id_session']) . '"';
+                    $sql = 'SELECT name FROM '.$tbl_session.' WHERE id="'.intval($_SESSION['id_session']).'"';
                     $rs = Database::query($sql);
                     list($_SESSION['session_name']) = Database::fetch_array($rs);
                     $_SESSION['id_session'] = intval($_GET['id_session']);
@@ -539,9 +539,9 @@ 
                             //But only if the login date is < than now + max_life_time
                             $sql = "SELECT course_access_id FROM $course_tracking_table
                                     WHERE
-                                        user_id     = " . intval($_user ['user_id']) . " AND
+                                        user_id     = ".intval($_user ['user_id'])." AND
                                         c_id = '".api_get_course_int_id()."' AND
-                                        session_id  = " . api_get_session_id() . " AND
+                                        session_id  = " . api_get_session_id()." AND
                                         login_course_date > now() - INTERVAL $session_lifetime SECOND
                                     ORDER BY login_course_date DESC LIMIT 0,1";
                             $result = Database::query($sql);
@@ -551,11 +551,11 @@ 
                                 //We update the course tracking table
                                 $sql = "UPDATE $course_tracking_table
                                         SET logout_course_date = '$time', counter = counter+1
-                                        WHERE course_access_id = " . intval($i_course_access_id) . " AND session_id = " . api_get_session_id();
+                                        WHERE course_access_id = ".intval($i_course_access_id)." AND session_id = ".api_get_session_id();
                                 Database::query($sql);
                             } else {
-                                $sql = "INSERT INTO $course_tracking_table (c_id, user_id, login_course_date, logout_course_date, counter, session_id)" .
-                                        "VALUES('" . api_get_course_int_id() . "', '" . $_user['user_id'] . "', '$time', '$time', '1','" . api_get_session_id() . "')";
+                                $sql = "INSERT INTO $course_tracking_table (c_id, user_id, login_course_date, logout_course_date, counter, session_id)".
+                                        "VALUES('".api_get_course_int_id()."', '".$_user['user_id']."', '$time', '$time', '1','".api_get_session_id()."')";
                                 Database::query($sql);
                             }
                         }
@@ -583,7 +583,7 @@ 
                 $course_user_table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
                 $sql = "SELECT * FROM $course_user_table
                        WHERE
-                        user_id  = '" . $user_id . "' AND
+                        user_id  = '".$user_id."' AND
                         relation_type <> ".COURSE_RELATION_TYPE_RRHH." AND
                         course_code = '$course_id'";
                 $result = Database::query($sql);
@@ -605,8 +605,8 @@ 
                         );
 
                         if (!$user_is_subscribed) {
-                            $url = api_get_path(WEB_CODE_PATH) . 'course_info/legal.php?course_code=' . $_course['code'] . '&session_id=' . $session_id;
-                            header('Location: ' . $url);
+                            $url = api_get_path(WEB_CODE_PATH).'course_info/legal.php?course_code='.$_course['code'].'&session_id='.$session_id;
+                            header('Location: '.$url);
                             exit;
                         }
                     }
@@ -647,11 +647,11 @@ 
                         } else {
                             //Im a coach or a student?
                             $sql = "SELECT user_id, status
-                                    FROM " . $tbl_session_course_user . "
+                                    FROM " . $tbl_session_course_user."
                                     WHERE
                                         c_id = '$_cid' AND
-                                        user_id = '" . $user_id . "' AND
-                                        session_id = '" . $session_id . "'
+                                        user_id = '".$user_id."' AND
+                                        session_id = '" . $session_id."'
                                     LIMIT 1";
                             $result = Database::query($sql);
 
@@ -797,7 +797,7 @@ 
         if ($reset) { // session data refresh requested
             if ($group_id && $_cid && !empty($_course['real_id'])) { // have keys to search data
                 $group_table = Database::get_course_table(TABLE_GROUP);
-                $sql = "SELECT * FROM $group_table WHERE c_id = " . $_course['real_id'] . " AND id = '$group_id'";
+                $sql = "SELECT * FROM $group_table WHERE c_id = ".$_course['real_id']." AND id = '$group_id'";
                 $result = Database::query($sql);
                 if (Database::num_rows($result) > 0) { // This group has recorded status related to this course
                     $gpData = Database::fetch_array($result);
@@ -850,7 +850,7 @@ 
      */
     public static function get_user_accounts_by_username($username)
     {
-        if (strpos($username,'@')){
+        if (strpos($username, '@')) {
             $username = api_strtolower($username);
             $email = true;
         } else {

main/inc/lib/model.lib.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
 
     /**
      * Useful finder - experimental akelos like only use in notification.lib.php send function
+     * @param string $type
      */
     public function find($type, $options = null)
     {

main/inc/lib/myspace.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -634,7 +634,6 @@ 
      * @param   int $sessionId  The session ID
      * @param   int $courseId   The course ID
      * @param   int $exerciseId The quiz ID
-     * @param   int $answer Answer status (0 = incorrect, 1 = correct, 2 = both)
      * @return  string  HTML array of results formatted for gridJS
      * @author César Perales <cesar.perales@beeznest.com>, Beeznest Team
      */
@@ -1222,6 +1221,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_course_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1556,6 +1556,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_session_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1576,7 +1577,6 @@ 
     /**
      * Fills in session reporting data
      *
-     * @param integer $user_id the id of the user
      * @param array $url_params additonal url parameters
      * @param array $row the row information (the other columns)
      * @return string html code
@@ -2206,6 +2206,7 @@ 
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
      * @version Dokeos 1.8.6
      * @since October 2008
+     * @param integer $number_of_items
      */
     public static function get_user_data_tracking_overview($from, $number_of_items, $column, $direction)
     {
@@ -2308,7 +2309,6 @@ 
     /**
      * Checks if there are repeted users in a given array
      * @param  array $usernames list of the usernames in the uploaded file
-     * @param  array $user_array['username'] and $user_array['sufix'] where sufix is the number part in a login i.e -> jmontoya2
      * @return array with the $usernames array and the $user_array array
      * @author Julio Montoya Armas
      */

Braces +3 added lines, -1 removed lines

@@ -2097,7 +2097,9 @@
                 FROM $tbl_course course
                 WHERE course.code IN (".implode(',',$courses_code).")";
 
-        if (!in_array($direction, array('ASC','DESC'))) $direction = 'ASC';
+        if (!in_array($direction, array('ASC','DESC'))) {
+            $direction = 'ASC';
+        }
 
         $column = intval($column);
         $from = intval($from);

Spacing +168 added lines, -168 removed lines

@@ -134,7 +134,7 @@ 
         $session_id  = intval($session_id);
 
         $sql = 'SELECT login_course_date, logout_course_date
-                FROM ' . $tbl_track_course . '
+                FROM ' . $tbl_track_course.'
                 WHERE
                     user_id = '.$user_id.' AND
                     c_id = '.$courseId.' AND
@@ -173,7 +173,7 @@ 
         foreach ($course_list as $course_item) {
             $courseInfo = api_get_course_info($course_item['code']);
             $courseId = $courseInfo['real_id'];
-            $new_course_list[] =  '"'.$courseId.'"';
+            $new_course_list[] = '"'.$courseId.'"';
         }
         $course_list = implode(', ', $new_course_list);
 
@@ -181,7 +181,7 @@ 
             return false;
         }
         $sql = 'SELECT login_course_date, logout_course_date, c_id
-                FROM ' . $tbl_track_course . '
+                FROM ' . $tbl_track_course.'
                 WHERE
                     user_id = '.$user_id.' AND
                     c_id IN ('.$course_list.') AND
@@ -259,7 +259,7 @@ 
             // student score
             $avg_score = Tracking :: get_avg_student_score($user_id, $courseCode);
             if (is_numeric($avg_score)) {
-                $avg_score = round($avg_score,2);
+                $avg_score = round($avg_score, 2);
             } else {
                 $$avg_score = '-';
             }
@@ -295,7 +295,7 @@ 
 
         $t_head = '    <table style="width: 100%;border:0;padding:0;border-collapse:collapse;table-layout: fixed">';
         //$t_head .= '  <caption>'.get_lang('CourseInformation').'</caption>';
-        $t_head .=      '<tr>';
+        $t_head .= '<tr>';
         $t_head .= '        <th width="155px" style="border-left:0;border-bottom:0"><span>'.get_lang('Course').'</span></th>';
         $t_head .= '        <th style="padding:0;border-bottom:0"><span>'.cut(get_lang('AvgTimeSpentInTheCourse'), 6, true).'</span></th>';
         $t_head .= '        <th style="padding:0;border-bottom:0"><span>'.cut(get_lang('AvgStudentsProgress'), 6, true).'</span></th>';
@@ -313,7 +313,7 @@ 
 
         $addparams = array('view' => 'admin', 'display' => 'user');
 
-        $table = new SortableTable('tracking_user_overview', array('MySpace','get_number_of_users_tracking_overview'), array('MySpace','get_user_data_tracking_overview'), 0);
+        $table = new SortableTable('tracking_user_overview', array('MySpace', 'get_number_of_users_tracking_overview'), array('MySpace', 'get_user_data_tracking_overview'), 0);
         $table->additional_parameters = $addparams;
 
         $table->set_header(0, get_lang('OfficialCode'), true, array('style' => 'font-size:8pt'), array('style' => 'font-size:8pt'));
@@ -326,7 +326,7 @@ 
         }
         $table->set_header(3, get_lang('LoginName'), true, array('style' => 'font-size:8pt'), array('style' => 'font-size:8pt'));
         $table->set_header(4, $t_head, false, array('style' => 'width:90%;border:0;padding:0;font-size:7.5pt;'), array('style' => 'width:90%;padding:0;font-size:7.5pt;'));
-        $table->set_column_filter(4, array('MySpace','course_info_tracking_filter'));
+        $table->set_column_filter(4, array('MySpace', 'course_info_tracking_filter'));
         $table->display();
     }
 
@@ -371,7 +371,7 @@ 
         $table -> set_header(7, get_lang('Sessions'), false);
 
         if ($is_western_name_order) {
-            $csv_header[] = array (
+            $csv_header[] = array(
                 get_lang('FirstName', ''),
                 get_lang('LastName', ''),
                 get_lang('TimeSpentOnThePlatform', ''),
@@ -381,7 +381,7 @@ 
                 get_lang('NumberOfSessions', '')
             );
         } else {
-            $csv_header[] = array (
+            $csv_header[] = array(
                 get_lang('LastName', ''),
                 get_lang('FirstName', ''),
                 get_lang('TimeSpentOnThePlatform', ''),
@@ -523,9 +523,9 @@ 
 
         if ($tracking_column != 3) {
             if ($tracking_direction == 'DESC') {
-                usort($all_datas, array('MySpace','rsort_users'));
+                usort($all_datas, array('MySpace', 'rsort_users'));
             } else {
-                usort($all_datas, array('MySpace','sort_users'));
+                usort($all_datas, array('MySpace', 'sort_users'));
             }
         }
 
@@ -584,7 +584,7 @@ 
         /**
          * Column config
          */
-        $column_model   = array(
+        $column_model = array(
             array(
                 'name' => 'username',
                 'index' => 'username',
@@ -625,7 +625,7 @@ 
 
         $action_links = '';
         // jqgrid will use this URL to do the selects
-        $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_session_lp_progress&session_id=' . $sessionId . '&course_id=' . $courseId . '&date_to=' . $date_to . '&date_from=' . $date_from;
+        $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_session_lp_progress&session_id='.$sessionId.'&course_id='.$courseId.'&date_to='.$date_to.'&date_from='.$date_from;
 
         //Table Id
         $tableId = 'lpProgress';
@@ -647,11 +647,11 @@ 
             true
         );
 
-        $return = '<script>$(function() {'. $table .
+        $return = '<script>$(function() {'.$table.
             'jQuery("#'.$tableId.'").jqGrid("navGrid","#'.$tableId.'_pager",{view:false, edit:false, add:false, del:false, search:false, excel:true});
                 jQuery("#'.$tableId.'").jqGrid("navButtonAdd","#'.$tableId.'_pager",{
                        caption:"",
-                       title:"' . get_lang('ExportExcel') . '",
+                       title:"' . get_lang('ExportExcel').'",
                        onClickButton : function () {
                            jQuery("#'.$tableId.'").jqGrid("excelExport",{"url":"'.$url.'&export_format=xls"});
                        }
@@ -701,7 +701,7 @@ 
         /**
          * Column config
          */
-        $column_model   = array(
+        $column_model = array(
             array('name'=>'session', 'index'=>'session', 'align'=>'left', 'search' => 'true', 'wrap_cell' => "true"),
             array('name'=>'exercise_id', 'index'=>'exercise_id', 'align'=>'left', 'search' => 'true'),
             array('name'=>'quiz_title', 'index'=>'quiz_title', 'align'=>'left', 'search' => 'true'),
@@ -718,7 +718,7 @@ 
         //get dynamic column names
 
         // jqgrid will use this URL to do the selects
-        $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_exercise_progress&session_id=' . $sessionId . '&course_id=' . $courseId  . '&exercise_id=' . $exerciseId . '&date_to=' . $date_to . '&date_from=' . $date_from;
+        $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_exercise_progress&session_id='.$sessionId.'&course_id='.$courseId.'&exercise_id='.$exerciseId.'&date_to='.$date_to.'&date_from='.$date_from;
 
         // Autowidth
         $extra_params['autowidth'] = 'true';
@@ -729,11 +729,11 @@ 
         $tableId = 'exerciseProgressOverview';
         $table = Display::grid_js($tableId, $url, $columns, $column_model, $extra_params, array(), '', true);
 
-        $return = '<script>$(function() {'. $table .
+        $return = '<script>$(function() {'.$table.
             'jQuery("#'.$tableId.'").jqGrid("navGrid","#'.$tableId.'_pager",{view:false, edit:false, add:false, del:false, search:false, excel:true});
                 jQuery("#'.$tableId.'").jqGrid("navButtonAdd","#'.$tableId.'_pager",{
                        caption:"",
-                       title:"' . get_lang('ExportExcel') . '",
+                       title:"' . get_lang('ExportExcel').'",
                        onClickButton : function () {
                            jQuery("#'.$tableId.'").jqGrid("excelExport",{"url":"'.$url.'&export_format=xls"});
                        }
@@ -819,8 +819,8 @@ 
 
                     $column[] = $title;
                     $column_model[] = array(
-                        'name' => 'exer' . $i,
-                        'index' => 'exer' . $i,
+                        'name' => 'exer'.$i,
+                        'index' => 'exer'.$i,
                         'align' => 'center',
                         'search' => 'true',
                         'wrap_cell' => "true"
@@ -832,7 +832,7 @@ 
 
         //end get dynamic column names
         // jqgrid will use this URL to do the selects
-        $url = api_get_path(WEB_AJAX_PATH) . 'model.ajax.php?a=get_exercise_grade&session_id=' . $sessionId . '&course_id=' . $courseId;
+        $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_exercise_grade&session_id='.$sessionId.'&course_id='.$courseId;
 
         // Autowidth
         $extra_params['autowidth'] = 'true';
@@ -843,13 +843,13 @@ 
         $tableId = 'exerciseGradeOverview';
         $table = Display::grid_js($tableId, $url, $column, $column_model, $extra_params, array(), '', true);
 
-        $return = '<script>$(function() {' . $table .
-            'jQuery("#' . $tableId . '").jqGrid("navGrid","#' . $tableId . '_pager",{view:false, edit:false, add:false, del:false, search:false, excel:true});
-                jQuery("#' . $tableId . '").jqGrid("navButtonAdd","#' . $tableId . '_pager",{
+        $return = '<script>$(function() {'.$table.
+            'jQuery("#'.$tableId.'").jqGrid("navGrid","#'.$tableId.'_pager",{view:false, edit:false, add:false, del:false, search:false, excel:true});
+                jQuery("#' . $tableId.'").jqGrid("navButtonAdd","#'.$tableId.'_pager",{
                        caption:"",
-                       title:"' . get_lang('ExportExcel') . '",
+                       title:"' . get_lang('ExportExcel').'",
                        onClickButton : function () {
-                           jQuery("#' . $tableId . '").jqGrid("excelExport",{"url":"' . $url . '&export_format=xls"});
+                           jQuery("#' . $tableId.'").jqGrid("excelExport",{"url":"'.$url.'&export_format=xls"});
                        }
                 });
             });</script>';
@@ -882,10 +882,10 @@ 
         /**
          * Column config
          */
-        $column_model   = array(
-            array('name'=>'username',   'index'=>'username',    'align'=>'left', 'search' => 'true', 'wrap_cell' => "true"),
-            array('name'=>'firstname',  'index'=>'firstname',   'align'=>'left', 'search' => 'true'),
-            array('name'=>'lastname',   'index'=>'lastname',    'align'=>'left', 'search' => 'true'),
+        $column_model = array(
+            array('name'=>'username', 'index'=>'username', 'align'=>'left', 'search' => 'true', 'wrap_cell' => "true"),
+            array('name'=>'firstname', 'index'=>'firstname', 'align'=>'left', 'search' => 'true'),
+            array('name'=>'lastname', 'index'=>'lastname', 'align'=>'left', 'search' => 'true'),
         );
         //get dinamic column names
         foreach ($questions as $question_id => $question) {
@@ -901,7 +901,7 @@ 
         $action_links = '';
 
         // jqgrid will use this URL to do the selects
-        $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_survey_overview&session_id=' . $sessionId . '&course_id=' . $courseId . '&survey_id=' . $surveyId . '&date_to=' . $date_to . '&date_from=' . $date_from;
+        $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_survey_overview&session_id='.$sessionId.'&course_id='.$courseId.'&survey_id='.$surveyId.'&date_to='.$date_to.'&date_from='.$date_from;
 
         // Table Id
         $tableId = 'lpProgress';
@@ -923,11 +923,11 @@ 
             true
         );
 
-        $return = '<script>$(function() {'. $table .
+        $return = '<script>$(function() {'.$table.
             'jQuery("#'.$tableId.'").jqGrid("navGrid","#'.$tableId.'_pager",{view:false, edit:false, add:false, del:false, search:false, excel:true});
                 jQuery("#'.$tableId.'").jqGrid("navButtonAdd","#'.$tableId.'_pager",{
                        caption:"",
-                       title:"' . get_lang('ExportExcel') . '",
+                       title:"' . get_lang('ExportExcel').'",
                        onClickButton : function () {
                            jQuery("#'.$tableId.'").jqGrid("excelExport",{"url":"'.$url.'&export_format=xls"});
                        }
@@ -942,7 +942,7 @@ 
      * Display a sortable table that contains an overview off all the progress of the user in a session
      * @author César Perales <cesar.perales@beeznest.com>, Beeznest Team
      */
-    static function display_tracking_progress_overview($sessionId = 0, $courseId = 0,  $date_from, $date_to)
+    static function display_tracking_progress_overview($sessionId = 0, $courseId = 0, $date_from, $date_to)
     {
         //The order is important you need to check the the $column variable in the model.ajax.php file
         $columns = array(
@@ -992,55 +992,55 @@ 
         );
 
         //Column config
-        $column_model   = array(
-            array('name'=>'lastname',   'index'=>'lastname',     'align'=>'left'),
-            array('name'=>'firstname',  'index'=>'firstname',    'align'=>'left'),
-            array('name'=>'username',   'index'=>'username',     'align'=>'left'),
+        $column_model = array(
+            array('name'=>'lastname', 'index'=>'lastname', 'align'=>'left'),
+            array('name'=>'firstname', 'index'=>'firstname', 'align'=>'left'),
+            array('name'=>'username', 'index'=>'username', 'align'=>'left'),
             #array('name'=>'profile',   'index'=>'username',     'align'=>'left'),
-            array('name'=>'total',      'index'=>'total',        'align'=>'left'),
-            array('name'=>'courses',    'index'=>'courses',      'align'=>'left', 'sortable' => 'false'),
-            array('name'=>'lessons',    'index'=>'lessons',      'align'=>'left', 'sortable' => 'false'),
-            array('name'=>'exercises',  'index'=>'exercises',    'align'=>'left', 'sortable' => 'false'),
-            array('name'=>'forums',     'index'=>'forums',       'align'=>'left', 'sortable' => 'false'),
-            array('name'=>'homeworks',  'index'=>'homeworks',    'align'=>'left', 'sortable' => 'false'),
-            array('name'=>'wikis',      'index'=>'wikis',        'align'=>'left', 'sortable' => 'false'),
-            array('name'=>'surveys',    'index'=>'surveys',      'align'=>'left', 'sortable' => 'false'),
+            array('name'=>'total', 'index'=>'total', 'align'=>'left'),
+            array('name'=>'courses', 'index'=>'courses', 'align'=>'left', 'sortable' => 'false'),
+            array('name'=>'lessons', 'index'=>'lessons', 'align'=>'left', 'sortable' => 'false'),
+            array('name'=>'exercises', 'index'=>'exercises', 'align'=>'left', 'sortable' => 'false'),
+            array('name'=>'forums', 'index'=>'forums', 'align'=>'left', 'sortable' => 'false'),
+            array('name'=>'homeworks', 'index'=>'homeworks', 'align'=>'left', 'sortable' => 'false'),
+            array('name'=>'wikis', 'index'=>'wikis', 'align'=>'left', 'sortable' => 'false'),
+            array('name'=>'surveys', 'index'=>'surveys', 'align'=>'left', 'sortable' => 'false'),
             //Lessons
-            array('name'=>'lessons_total',    'index'=>'lessons_total',      'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'lessons_done',     'index'=>'lessons_done',       'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'lessons_left',     'index'=>'lessons_left',       'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'lessons_progress', 'index'=>'lessons_progress',   'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'lessons_total', 'index'=>'lessons_total', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'lessons_done', 'index'=>'lessons_done', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'lessons_left', 'index'=>'lessons_left', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'lessons_progress', 'index'=>'lessons_progress', 'align'=>'center', 'sortable' => 'false'),
             //Exercises
-            array('name'=>'exercises_total',    'index'=>'exercises_total',      'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'exercises_done',     'index'=>'exercises_done',       'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'exercises_left',     'index'=>'exercises_left',       'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'exercises_progress', 'index'=>'exercises_progress',   'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'exercises_total', 'index'=>'exercises_total', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'exercises_done', 'index'=>'exercises_done', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'exercises_left', 'index'=>'exercises_left', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'exercises_progress', 'index'=>'exercises_progress', 'align'=>'center', 'sortable' => 'false'),
             //Assignments
-            array('name'=>'forums_total',    'index'=>'forums_total',        'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'forums_done',     'index'=>'forums_done',         'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'forums_left',     'index'=>'forums_left',         'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'forums_progress', 'index'=>'forums_progress',     'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'forums_total', 'index'=>'forums_total', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'forums_done', 'index'=>'forums_done', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'forums_left', 'index'=>'forums_left', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'forums_progress', 'index'=>'forums_progress', 'align'=>'center', 'sortable' => 'false'),
             //Assignments
-            array('name'=>'assigments_total',    'index'=>'assigments_total',        'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'assigments_done',     'index'=>'assigments_done',         'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'assigments_left',     'index'=>'assigments_left',         'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'assigments_progress', 'index'=>'assigments_progress',     'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'assigments_total', 'index'=>'assigments_total', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'assigments_done', 'index'=>'assigments_done', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'assigments_left', 'index'=>'assigments_left', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'assigments_progress', 'index'=>'assigments_progress', 'align'=>'center', 'sortable' => 'false'),
             //Assignments
-            array('name'=>'wiki_total',         'index'=>'wiki_total',       'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'wiki_revisions',     'index'=>'wiki_revisions',   'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'wiki_read',          'index'=>'wiki_read',        'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'wiki_unread',        'index'=>'wiki_unread',      'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'wiki_progress',      'index'=>'wiki_progress',    'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'wiki_total', 'index'=>'wiki_total', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'wiki_revisions', 'index'=>'wiki_revisions', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'wiki_read', 'index'=>'wiki_read', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'wiki_unread', 'index'=>'wiki_unread', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'wiki_progress', 'index'=>'wiki_progress', 'align'=>'center', 'sortable' => 'false'),
             //Surveys
-            array('name'=>'surveys_total',    'index'=>'surveys_total',      'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'surveys_done',     'index'=>'surveys_done',       'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'surveys_left',     'index'=>'surveys_left',       'align'=>'center', 'sortable' => 'false'),
-            array('name'=>'surveys_progress', 'index'=>'surveys_progress',   'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'surveys_total', 'index'=>'surveys_total', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'surveys_done', 'index'=>'surveys_done', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'surveys_left', 'index'=>'surveys_left', 'align'=>'center', 'sortable' => 'false'),
+            array('name'=>'surveys_progress', 'index'=>'surveys_progress', 'align'=>'center', 'sortable' => 'false'),
         );
 
         $action_links = '';
         // jqgrid will use this URL to do the selects
-        $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_session_progress&session_id=' . $sessionId . '&course_id=' . $courseId . '&date_to=' . $date_to . '&date_from=' . $date_from;
+        $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_session_progress&session_id='.$sessionId.'&course_id='.$courseId.'&date_to='.$date_to.'&date_from='.$date_from;
 
         //Table Id
         $tableId = 'progressOverview';
@@ -1100,11 +1100,11 @@ 
             true
         );
 
-        $return = '<script>$(function() {'. $table .
+        $return = '<script>$(function() {'.$table.
             'jQuery("#'.$tableId.'").jqGrid("navGrid","#'.$tableId.'_pager",{view:false, edit:false, add:false, del:false, search:false, excel:true});
                 jQuery("#'.$tableId.'").jqGrid("navButtonAdd","#'.$tableId.'_pager",{
                        caption:"",
-                       title:"' . get_lang('ExportExcel') . '",
+                       title:"' . get_lang('ExportExcel').'",
                        onClickButton : function () {
                            jQuery("#'.$tableId.'").jqGrid("excelExport",{"url":"'.$url.'&export_format=xls"});
                        }
@@ -1164,7 +1164,7 @@ 
                 // adding the fields that are checked to the session
                 $message = '';
                 foreach ($values as $field_ids => $value) {
-                    if ($value == 1 && strstr($field_ids,'extra_export_field')) {
+                    if ($value == 1 && strstr($field_ids, 'extra_export_field')) {
                         $_SESSION['additional_export_fields'][] = str_replace('extra_export_field', '', $field_ids);
                     }
                 }
@@ -1179,7 +1179,7 @@ 
                 // Displaying a feedback message
                 if (!empty($_SESSION['additional_export_fields'])) {
                     Display::display_confirmation_message(get_lang('FollowingFieldsWillAlsoBeExported').': <br /><ul>'.$message.'</ul>', false);
-                } else  {
+                } else {
                     Display::display_confirmation_message(get_lang('NoAdditionalFieldsWillBeExported'), false);
                 }
             } else {
@@ -1207,7 +1207,7 @@ 
     {
         $t_head = '    <table style="width: 100%;border:0;padding:0;border-collapse:collapse;table-layout: fixed">';
         //$t_head .= '  <caption>'.get_lang('CourseInformation').'</caption>';
-        $t_head .=      '<tr>';
+        $t_head .= '<tr>';
         $t_head .= '        <th style="padding:0;border-bottom:0"><span>'.cut(get_lang('AvgTimeSpentInTheCourse'), 6, true).'</span></th>';
         $t_head .= '        <th style="padding:0;border-bottom:0"><span>'.cut(get_lang('AvgStudentsProgress'), 6, true).'</span></th>';
         $t_head .= '        <th style="padding:0;border-bottom:0"><span>'.cut(get_lang('AvgCourseScore'), 6, true).'</span></th>';
@@ -1224,13 +1224,13 @@ 
 
         $addparams = array('view' => 'admin', 'display' => 'courseoverview');
 
-        $table = new SortableTable('tracking_session_overview', array('MySpace', 'get_total_number_courses'), array('MySpace','get_course_data_tracking_overview'), 1);
+        $table = new SortableTable('tracking_session_overview', array('MySpace', 'get_total_number_courses'), array('MySpace', 'get_course_data_tracking_overview'), 1);
         $table->additional_parameters = $addparams;
 
         $table->set_header(0, '', false, null, array('style' => 'display: none'));
         $table->set_header(1, get_lang('Course'), true, array('style' => 'font-size:8pt'), array('style' => 'font-size:8pt'));
         $table->set_header(2, $t_head, false, array('style' => 'width:90%;border:0;padding:0;font-size:7.5pt;'), array('style' => 'width:90%;padding:0;font-size:7.5pt;'));
-        $table->set_column_filter(2, array('MySpace','course_tracking_filter'));
+        $table->set_column_filter(2, array('MySpace', 'course_tracking_filter'));
         $table->display();
     }
 
@@ -1266,7 +1266,7 @@ 
         $sql .= " ORDER BY col$column $direction ";
         $sql .= " LIMIT $from,$number_of_items";
         $result = Database::query($sql);
-        $return = array ();
+        $return = array();
         while ($course = Database::fetch_row($result)) {
             $return[] = $course;
         }
@@ -1319,18 +1319,18 @@ 
             $progress += $progress_tmp[0];
             $nb_progress_lp += $progress_tmp[1];
             $score_tmp = Tracking :: get_avg_student_score($row->user_id, $course_code, array(), null, true);
-            if(is_array($score_tmp)) {
+            if (is_array($score_tmp)) {
                 $score += $score_tmp[0];
                 $nb_score_lp += $score_tmp[1];
             }
             $nb_messages += Tracking::count_student_messages($row->user_id, $course_code);
             $nb_assignments += Tracking::count_student_assignments($row->user_id, $course_code);
             $last_login_date_tmp = Tracking :: get_last_connection_date_on_the_course($row->user_id, $courseInfo, null, false);
-            if($last_login_date_tmp != false && $last_login_date == false) { // TODO: To be cleaned
+            if ($last_login_date_tmp != false && $last_login_date == false) { // TODO: To be cleaned
                 $last_login_date = $last_login_date_tmp;
-            } else if($last_login_date_tmp != false && $last_login_date != false) { // TODO: Repeated previous condition. To be cleaned.
+            } else if ($last_login_date_tmp != false && $last_login_date != false) { // TODO: Repeated previous condition. To be cleaned.
                 // Find the max and assign it to first_login_date
-                if(strtotime($last_login_date_tmp) > strtotime($last_login_date)) {
+                if (strtotime($last_login_date_tmp) > strtotime($last_login_date)) {
                     $last_login_date = $last_login_date_tmp;
                 }
             }
@@ -1340,27 +1340,27 @@ 
             $total_score_possible += $exercise_results_tmp['score_possible'];
             $total_questions_answered += $exercise_results_tmp['questions_answered'];
         }
-        if($nb_progress_lp > 0) {
+        if ($nb_progress_lp > 0) {
             $avg_progress = round($progress / $nb_progress_lp, 2);
         } else {
             $avg_progress = 0;
         }
-        if($nb_score_lp > 0) {
+        if ($nb_score_lp > 0) {
             $avg_score = round($score / $nb_score_lp, 2);
         } else {
             $avg_score = '-';
         }
-        if($last_login_date) {
+        if ($last_login_date) {
             $last_login_date = api_convert_and_format_date($last_login_date, DATE_FORMAT_SHORT, date_default_timezone_get());
         } else {
             $last_login_date = '-';
         }
-        if($total_score_possible > 0) {
+        if ($total_score_possible > 0) {
             $total_score_percentage = round($total_score_obtained / $total_score_possible * 100, 2);
         } else {
             $total_score_percentage = 0;
         }
-        if($total_score_percentage > 0) {
+        if ($total_score_percentage > 0) {
             $total_score = $total_score_obtained.'/'.$total_score_possible.' ('.$total_score_percentage.' %)';
         } else {
             $total_score = '-';
@@ -1468,7 +1468,7 @@ 
                 $progress += $progress_tmp[0];
                 $nb_progress_lp += $progress_tmp[1];
                 $score_tmp = Tracking :: get_avg_student_score($row->user_id, $course_code, array(), null, true);
-                if(is_array($score_tmp)) {
+                if (is_array($score_tmp)) {
                     $score += $score_tmp[0];
                     $nb_score_lp += $score_tmp[1];
                 }
@@ -1476,11 +1476,11 @@ 
                 $nb_assignments += Tracking::count_student_assignments($row->user_id, $course_code);
 
                 $last_login_date_tmp = Tracking::get_last_connection_date_on_the_course($row->user_id, $courseInfo, null, false);
-                if($last_login_date_tmp != false && $last_login_date == false) { // TODO: To be cleaned.
+                if ($last_login_date_tmp != false && $last_login_date == false) { // TODO: To be cleaned.
                     $last_login_date = $last_login_date_tmp;
-                } else if($last_login_date_tmp != false && $last_login_date == false) { // TODO: Repeated previous condition. To be cleaned.
+                } else if ($last_login_date_tmp != false && $last_login_date == false) { // TODO: Repeated previous condition. To be cleaned.
                     // Find the max and assign it to first_login_date
-                    if(strtotime($last_login_date_tmp) > strtotime($last_login_date)) {
+                    if (strtotime($last_login_date_tmp) > strtotime($last_login_date)) {
                         $last_login_date = $last_login_date_tmp;
                     }
                 }
@@ -1490,22 +1490,22 @@ 
                 $total_score_possible += $exercise_results_tmp['score_possible'];
                 $total_questions_answered += $exercise_results_tmp['questions_answered'];
             }
-            if($nb_progress_lp > 0) {
+            if ($nb_progress_lp > 0) {
                 $avg_progress = round($progress / $nb_progress_lp, 2);
             } else {
                 $avg_progress = 0;
             }
-            if($nb_score_lp > 0) {
+            if ($nb_score_lp > 0) {
                 $avg_score = round($score / $nb_score_lp, 2);
             } else {
                 $avg_score = '-';
             }
-            if($last_login_date) {
+            if ($last_login_date) {
                 $last_login_date = api_convert_and_format_date($last_login_date, DATE_FORMAT_SHORT, date_default_timezone_get());
             } else {
                 $last_login_date = '-';
             }
-            if($total_score_possible > 0) {
+            if ($total_score_possible > 0) {
                 $total_score_percentage = round($total_score_obtained / $total_score_possible * 100, 2);
             } else {
                 $total_score_percentage = 0;
@@ -1541,7 +1541,7 @@ 
     {
         $t_head = '    <table style="width: 100%;border:0;padding:0;border-collapse:collapse;table-layout: fixed">';
         //$t_head .= '  <caption>'.get_lang('CourseInformation').'</caption>';
-        $t_head .=      '<tr>';
+        $t_head .= '<tr>';
         $t_head .= '        <th width="155px" style="border-left:0;border-bottom:0"><span>'.get_lang('Course').'</span></th>';
         $t_head .= '        <th style="padding:0;border-bottom:0"><span>'.cut(get_lang('AvgTimeSpentInTheCourse'), 6, true).'</span></th>';
         $t_head .= '        <th style="padding:0;border-bottom:0"><span>'.cut(get_lang('AvgStudentsProgress'), 6, true).'</span></th>';
@@ -1559,7 +1559,7 @@ 
 
         $addparams = array('view' => 'admin', 'display' => 'sessionoverview');
 
-        $table = new SortableTable('tracking_session_overview', array('MySpace','get_total_number_sessions'), array('MySpace','get_session_data_tracking_overview'), 1);
+        $table = new SortableTable('tracking_session_overview', array('MySpace', 'get_total_number_sessions'), array('MySpace', 'get_session_data_tracking_overview'), 1);
         $table->additional_parameters = $addparams;
 
         $table->set_header(0, '', false, null, array('style' => 'display: none'));
@@ -1598,7 +1598,7 @@ 
         $sql .= " ORDER BY col$column $direction ";
         $sql .= " LIMIT $from,$number_of_items";
         $result = Database::query($sql);
-        $return = array ();
+        $return = array();
         while ($session = Database::fetch_row($result)) {
             $return[] = $session;
         }
@@ -1687,10 +1687,10 @@ 
                 if ($last_login_date_tmp != false && $last_login_date == false) {
                     // TODO: To be cleaned.
                     $last_login_date = $last_login_date_tmp;
-                } else if($last_login_date_tmp != false && $last_login_date != false) {
+                } else if ($last_login_date_tmp != false && $last_login_date != false) {
                     // TODO: Repeated previous condition! To be cleaned.
                     // Find the max and assign it to first_login_date
-                    if(strtotime($last_login_date_tmp) > strtotime($last_login_date)) {
+                    if (strtotime($last_login_date_tmp) > strtotime($last_login_date)) {
                         $last_login_date = $last_login_date_tmp;
                     }
                 }
@@ -1700,27 +1700,27 @@ 
                 $total_score_possible += $exercise_results_tmp['score_possible'];
                 $total_questions_answered += $exercise_results_tmp['questions_answered'];
             }
-            if($nb_progress_lp > 0) {
+            if ($nb_progress_lp > 0) {
                 $avg_progress = round($progress / $nb_progress_lp, 2);
             } else {
                 $avg_progress = 0;
             }
-            if($nb_score_lp > 0) {
+            if ($nb_score_lp > 0) {
                 $avg_score = round($score / $nb_score_lp, 2);
             } else {
                 $avg_score = '-';
             }
-            if($last_login_date) {
+            if ($last_login_date) {
                 $last_login_date = api_convert_and_format_date($last_login_date, DATE_FORMAT_SHORT, date_default_timezone_get());
             } else {
                 $last_login_date = '-';
             }
-            if($total_score_possible > 0) {
+            if ($total_score_possible > 0) {
                 $total_score_percentage = round($total_score_obtained / $total_score_possible * 100, 2);
             } else {
                 $total_score_percentage = 0;
             }
-            if($total_score_percentage > 0) {
+            if ($total_score_percentage > 0) {
                 $total_score = $total_score_obtained.'/'.$total_score_possible.' ('.$total_score_percentage.' %)';
             } else {
                 $total_score = '-';
@@ -1831,7 +1831,7 @@ 
                 $total_score_obtained = 0;
                 $total_score_possible = 0;
                 $total_questions_answered = 0;
-                while($row_user = Database::fetch_object($result_users)) {
+                while ($row_user = Database::fetch_object($result_users)) {
                     // get time spent in the course and session
                     $time_spent += Tracking::get_time_spent_on_the_course($row_user->user_id, $courseId, $session_id);
                     $progress_tmp = Tracking::get_avg_student_progress($row_user->user_id, $row->code, array(), $session_id, true);
@@ -1860,11 +1860,11 @@ 
                         $session_id,
                         false
                     );
-                    if($last_login_date_tmp != false && $last_login_date == false) { // TODO: To be cleaned.
+                    if ($last_login_date_tmp != false && $last_login_date == false) { // TODO: To be cleaned.
                         $last_login_date = $last_login_date_tmp;
-                    } else if($last_login_date_tmp != false && $last_login_date == false) { // TODO: Repeated previous condition. To be cleaned.
+                    } else if ($last_login_date_tmp != false && $last_login_date == false) { // TODO: Repeated previous condition. To be cleaned.
                         // Find the max and assign it to first_login_date
-                        if(strtotime($last_login_date_tmp) > strtotime($last_login_date)) {
+                        if (strtotime($last_login_date_tmp) > strtotime($last_login_date)) {
                             $last_login_date = $last_login_date_tmp;
                         }
                     }
@@ -1874,27 +1874,27 @@ 
                     $total_score_possible += $exercise_results_tmp['score_possible'];
                     $total_questions_answered += $exercise_results_tmp['questions_answered'];
                 }
-                if($nb_progress_lp > 0) {
+                if ($nb_progress_lp > 0) {
                     $avg_progress = round($progress / $nb_progress_lp, 2);
                 } else {
                     $avg_progress = 0;
                 }
-                if($nb_score_lp > 0) {
+                if ($nb_score_lp > 0) {
                     $avg_score = round($score / $nb_score_lp, 2);
                 } else {
                     $avg_score = '-';
                 }
-                if($last_login_date) {
+                if ($last_login_date) {
                     $last_login_date = api_convert_and_format_date($last_login_date, DATE_FORMAT_SHORT, date_default_timezone_get());
                 } else {
                     $last_login_date = '-';
                 }
-                if($total_score_possible > 0) {
+                if ($total_score_possible > 0) {
                     $total_score_percentage = round($total_score_obtained / $total_score_possible * 100, 2);
                 } else {
                     $total_score_percentage = 0;
                 }
-                if($total_score_percentage > 0) {
+                if ($total_score_percentage > 0) {
                     $total_score = $total_score_obtained.'/'.$total_score_possible.' ('.$total_score_percentage.' %)';
                 } else {
                     $total_score = '-';
@@ -1944,7 +1944,7 @@ 
             FROM '.Database :: get_main_table(TABLE_STATISTIC_TRACK_E_EXERCISES)."
             WHERE c_id = ' . $courseId . '
             AND exe_user_id = '".intval($user_id)."'";
-        if($session_id !== false) {
+        if ($session_id !== false) {
             $sql .= " AND session_id = '".$session_id."' ";
         }
         $result = Database::query($sql);
@@ -1954,7 +1954,7 @@ 
         while ($row = Database::fetch_array($result)) {
             $score_obtained += $row['exe_result'];
             $score_possible += $row['exe_weighting'];
-            $questions_answered ++;
+            $questions_answered++;
         }
 
         if ($score_possible != 0) {
@@ -2075,9 +2075,9 @@ 
                     }
                 }
                 // time spent in the course
-                $csv_row[] = api_time_to_hms(Tracking::get_time_spent_on_the_course ($user[4], $courseId));
+                $csv_row[] = api_time_to_hms(Tracking::get_time_spent_on_the_course($user[4], $courseId));
                 // student progress in course
-                $csv_row[] = round(Tracking::get_avg_student_progress ($user[4], $row[0]), 2);
+                $csv_row[] = round(Tracking::get_avg_student_progress($user[4], $row[0]), 2);
                 // student score
                 $csv_row[] = round(Tracking::get_avg_student_score($user[4], $row[0]), 2);
                 // student tes score
@@ -2085,7 +2085,7 @@ 
                 // student messages
                 $csv_row[] = Tracking::count_student_messages($user[4], $row[0]);
                 // student assignments
-                $csv_row[] = Tracking::count_student_assignments ($user[4], $row[0]);
+                $csv_row[] = Tracking::count_student_assignments($user[4], $row[0]);
                 // student exercises results
                 $exercises_results = MySpace::exercises_results($user[4], $row[0]);
                 $csv_row[] = $exercises_results['score_obtained'];
@@ -2093,7 +2093,7 @@ 
                 $csv_row[] = $exercises_results['questions_answered'];
                 $csv_row[] = $exercises_results['percentage'];
                 // first connection
-                $csv_row[] = Tracking::get_first_connection_date_on_the_course ($user[4], $courseId);
+                $csv_row[] = Tracking::get_first_connection_date_on_the_course($user[4], $courseId);
                 // last connection
                 $csv_row[] = strip_tags(Tracking::get_last_connection_date_on_the_course($user[4], $courseInfo));
 
@@ -2127,9 +2127,9 @@ 
         // get all courses with limit
         $sql = "SELECT course.code as col1, course.title as col2
                 FROM $tbl_course course
-                WHERE course.code IN (".implode(',',$courses_code).")";
+                WHERE course.code IN (".implode(',', $courses_code).")";
 
-        if (!in_array($direction, array('ASC','DESC'))) $direction = 'ASC';
+        if (!in_array($direction, array('ASC', 'DESC'))) $direction = 'ASC';
 
         $column = intval($column);
         $from = intval($from);
@@ -2198,7 +2198,7 @@ 
             $table_row[] = $avg_assignments_in_course;
 
             //set the "from" value to know if I access the Reporting by the chamilo tab or the course link
-            $table_row[] = '<center><a href="../../tracking/courseLog.php?cidReq=' .$course_code.'&from=myspace&id_session='.$session_id.'">
+            $table_row[] = '<center><a href="../../tracking/courseLog.php?cidReq='.$course_code.'&from=myspace&id_session='.$session_id.'">
                              '.Display::return_icon('2rightarrow.png').'
                              </a>
                             </center>';
@@ -2207,7 +2207,7 @@ 
                 $nb_students_in_course,
                 $avg_time_spent_in_course,
                 is_null($avg_progress_in_course) ? null : $avg_progress_in_course.'%',
-                is_null($avg_score_in_course) ? null : is_numeric($avg_score_in_course) ? $avg_score_in_course.'%' : $avg_score_in_course ,
+                is_null($avg_score_in_course) ? null : is_numeric($avg_score_in_course) ? $avg_score_in_course.'%' : $avg_score_in_course,
                 is_null($avg_score_in_exercise) ? null : $avg_score_in_exercise.'%',
                 $avg_messages_in_course,
                 $avg_assignments_in_course,
@@ -2275,7 +2275,7 @@ 
         $sql .= " ORDER BY col$column $direction ";
         $sql .= " LIMIT $from,$number_of_items";
         $result = Database::query($sql);
-        $return = array ();
+        $return = array();
         while ($user = Database::fetch_row($result)) {
             $return[] = $user;
         }
@@ -2330,7 +2330,7 @@ 
                     $i++;
                 }
             }
-            $username_array = array('username' => $desired_username , 'sufix' => $sufix);
+            $username_array = array('username' => $desired_username, 'sufix' => $sufix);
             return $username_array;
         } else {
             $username_array = array('username' => $username, 'sufix' => '');
@@ -2605,7 +2605,7 @@ 
         foreach ($users as $index => $user) {
             $userid = $user['id'];
             $sql_insert = "INSERT IGNORE INTO $tbl_session_rel_user(session_id, user_id, registered_at)
-                           VALUES ('$id_session','$userid', '" . api_get_utc_datetime() . "')";
+                           VALUES ('$id_session','$userid', '".api_get_utc_datetime()."')";
             Database::query($sql_insert);
             $user['added_at_session'] = 1;
             $new_users[] = $user;
@@ -2639,10 +2639,10 @@ 
                 );
                 $userInfo = api_get_user_info($user['id']);
 
-                if (($user['added_at_platform'] == 1  && $user['added_at_session'] == 1) || $user['added_at_session'] == 1) {
+                if (($user['added_at_platform'] == 1 && $user['added_at_session'] == 1) || $user['added_at_session'] == 1) {
                     if ($user['added_at_platform'] == 1) {
                         $addedto = get_lang('UserCreatedPlatform');
-                    } else  {
+                    } else {
                         $addedto = '          ';
                     }
 
@@ -2705,7 +2705,7 @@ 
         global $current_tag;
         switch ($data) {
             case 'Contact' :
-                $user = array ();
+                $user = array();
                 break;
             default :
                 $current_tag = $data;
@@ -2752,9 +2752,9 @@ 
         global $current_value;
         global $user;
         global $users;
-        $users = array ();
+        $users = array();
         $parser = xml_parser_create('UTF-8');
-        xml_set_element_handler($parser, array('MySpace','element_start'), array('MySpace','element_end'));
+        xml_set_element_handler($parser, array('MySpace', 'element_start'), array('MySpace', 'element_end'));
         xml_set_character_data_handler($parser, "character_data");
         xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
         xml_parse($parser, api_utf8_encode_xml(file_get_contents($file)));
@@ -2800,7 +2800,7 @@ 
             get_lang('SearchCourse'),
             $courseList,
             [
-                'url' => api_get_path(WEB_AJAX_PATH) . 'course.ajax.php?' . http_build_query([
+                'url' => api_get_path(WEB_AJAX_PATH).'course.ajax.php?'.http_build_query([
                     'a' => 'search_course_by_session_all',
                     'session_id' => $sessionId
                 ])
@@ -2819,7 +2819,7 @@ 
                             course_id: $('#course_id').val() || 0
                         });
 
-                        return '" . api_get_path(WEB_AJAX_PATH) . "session.ajax.php?' + params;
+                        return '" . api_get_path(WEB_AJAX_PATH)."session.ajax.php?' + params;
                     }
                 "
             ]
@@ -2850,7 +2850,7 @@ 
                             course_id: $('#course_id').val()
                         });
 
-                        return '" . api_get_path(WEB_AJAX_PATH) . "course.ajax.php?' + params;
+                        return '" . api_get_path(WEB_AJAX_PATH)."course.ajax.php?' + params;
                     }
                 "
             ]
@@ -2876,8 +2876,8 @@ 
         if ($form->validate()) {
             $table = new SortableTable(
                 'tracking_access_overview',
-                ['MySpace','getNumberOfRrackingAccessOverview'],
-                ['MySpace','getUserDataAccessTrackingOverview'],
+                ['MySpace', 'getNumberOfRrackingAccessOverview'],
+                ['MySpace', 'getUserDataAccessTrackingOverview'],
                 0
             );
             $table->additional_parameters = $form->exportValues();
@@ -2938,7 +2938,7 @@ 
                     " : "
                         u.lastname AS col2,
                         u.firstname AS col3,
-                " ) . "
+                " )."
                 a.logout_course_date,
                 c.title,
                 c.code,
@@ -2949,7 +2949,7 @@ 
 
         if (isset($_GET['session_id']) && !empty($_GET['session_id'])) {
             $sessionId = intval($_GET['session_id']);
-            $sql .= " WHERE a.session_id = " . $sessionId;
+            $sql .= " WHERE a.session_id = ".$sessionId;
         }
 
         $sql .= " ORDER BY col$column $orderDirection ";
@@ -3010,14 +3010,14 @@ 
 function get_stats($user_id, $courseId, $start_date = null, $end_date = null)
 {
     // Database table definitions
-    $tbl_track_course   = Database :: get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
+    $tbl_track_course = Database :: get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
 
     $course_info = api_get_course_info_by_id($courseId);
     if (!empty($course_info)) {
         $strg_sd    = "";
         $strg_ed    = "";
-        if ($start_date != null && $end_date != null){
-            $end_date = add_day_to( $end_date );
+        if ($start_date != null && $end_date != null) {
+            $end_date = add_day_to($end_date);
             $strg_sd = "AND login_course_date BETWEEN '$start_date' AND '$end_date'";
             $strg_ed = "AND logout_course_date BETWEEN '$start_date' AND '$end_date'";
         }
@@ -3025,10 +3025,10 @@ 
                 SEC_TO_TIME(avg(time_to_sec(timediff(logout_course_date,login_course_date)))) as avrg,
                 SEC_TO_TIME(sum(time_to_sec(timediff(logout_course_date,login_course_date)))) as total,
                 count(user_id) as times
-                FROM ' . $tbl_track_course . '
+                FROM ' . $tbl_track_course.'
                 WHERE
-                    user_id = ' . intval($user_id) . ' AND
-                    c_id = ' . intval($courseId) . ' '.$strg_sd.' '.$strg_ed.' '.'
+                    user_id = ' . intval($user_id).' AND
+                    c_id = ' . intval($courseId).' '.$strg_sd.' '.$strg_ed.' '.'
                 ORDER BY login_course_date ASC';
 
         $rs = Database::query($sql);
@@ -3046,7 +3046,7 @@ 
 }
 
 function add_day_to($end_date) {
-    $foo_date = strtotime( $end_date );
+    $foo_date = strtotime($end_date);
     $foo_date = strtotime(" +1 day", $foo_date);
     $foo_date = date("Y-m-d", $foo_date);
     return $foo_date;
@@ -3106,7 +3106,7 @@ 
  * @version OCT-22- 2010
  * @return array
  */
-function convert_to_array($sql_result){
+function convert_to_array($sql_result) {
     $result_to_print = '<table>';
     foreach ($sql_result as $key => $data) {
         $result_to_print .= '<tr><td>'.date('d-m-Y (H:i:s)', $data['login']).'</td><td>'.api_time_to_hms($data['logout'] - $data['login']).'</tr></td>'."\n";
@@ -3125,7 +3125,7 @@ 
  * @version OCT-22- 2010
  * @return string
  */
-function convert_to_string($sql_result){
+function convert_to_string($sql_result) {
     $result_to_print = '<table>';
     if (!empty($sql_result)) {
         foreach ($sql_result as $key => $data) {
@@ -3150,18 +3150,18 @@ 
  */
 function grapher($sql_result, $start_date, $end_date, $type = "")
 {
-    if (empty($start_date)) { $start_date =""; }
-    if (empty($end_date)) { $end_date =""; }
-    if ($type == ""){ $type = 'day'; }
-    $main_year  = $main_month_year = $main_day = array();
+    if (empty($start_date)) { $start_date = ""; }
+    if (empty($end_date)) { $end_date = ""; }
+    if ($type == "") { $type = 'day'; }
+    $main_year = $main_month_year = $main_day = array();
     // get last 8 days/months
     $last_days      = 5;
     $last_months    = 3;
     for ($i = $last_days; $i >= 0; $i--) {
-        $main_day[date ('d-m-Y', mktime () - $i * 3600 * 24)] = 0;
+        $main_day[date('d-m-Y', mktime() - $i * 3600 * 24)] = 0;
     }
     for ($i = $last_months; $i >= 0; $i--) {
-        $main_month_year[date ('m-Y', mktime () - $i * 30 * 3600 * 24)] = 0;
+        $main_month_year[date('m-Y', mktime() - $i * 30 * 3600 * 24)] = 0;
     }
 
     $i = 0;
@@ -3197,7 +3197,7 @@ 
         /* Create and populate the pData object */
         $myData = new pData();
         $myData->addPoints($main_date, 'Serie1');
-        if (count($main_date)!= 1) {
+        if (count($main_date) != 1) {
             $myData->addPoints($labels, 'Labels');
             $myData->setSerieDescription('Labels', 'Months');
             $myData->setAbscissa('Labels');
@@ -3205,7 +3205,7 @@ 
         $myData->setSerieWeight('Serie1', 1);
         $myData->setSerieDescription('Serie1', get_lang('MyResults'));
         $myData->setAxisName(0, get_lang('Minutes'));
-        $myData->loadPalette(api_get_path(SYS_CODE_PATH) . 'palettes/pchart/default.color', true);
+        $myData->loadPalette(api_get_path(SYS_CODE_PATH).'palettes/pchart/default.color', true);
 
         // Cache definition
         $cachePath = api_get_path(SYS_ARCHIVE_PATH);
@@ -3214,9 +3214,9 @@ 
 
         if ($myCache->isInCache($chartHash)) {
             //if we already created the img
-            $imgPath = api_get_path(SYS_ARCHIVE_PATH) . $chartHash;
+            $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash;
             $myCache->saveFromCache($chartHash, $imgPath);
-            $imgPath = api_get_path(WEB_ARCHIVE_PATH) . $chartHash;
+            $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash;
         } else {
             /* Define width, height and angle */
             $mainWidth = 760;
@@ -3245,7 +3245,7 @@ 
             /* Set the default font */
             $myPicture->setFontProperties(
                 array(
-                    "FontName" => api_get_path(SYS_FONTS_PATH) . 'opensans/OpenSans-Regular.ttf',
+                    "FontName" => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf',
                     "FontSize" => 10)
             );
             /* Write the chart title */
@@ -3262,7 +3262,7 @@ 
             /* Set the default font */
             $myPicture->setFontProperties(
                 array(
-                    "FontName" => api_get_path(SYS_FONTS_PATH) . 'opensans/OpenSans-Regular.ttf',
+                    "FontName" => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf',
                     "FontSize" => 8
                 )
             );
@@ -3304,7 +3304,7 @@ 
             /* Draw the line chart */
             $myPicture->setFontProperties(
                 array(
-                    "FontName" => api_get_path(SYS_FONTS_PATH) . 'opensans/OpenSans-Regular.ttf',
+                    "FontName" => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf',
                     "FontSize" => 10
                 )
             );
@@ -3323,15 +3323,15 @@ 
 
             /* Write and save into cache */
             $myCache->writeToCache($chartHash, $myPicture);
-            $imgPath = api_get_path(SYS_ARCHIVE_PATH) . $chartHash;
+            $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash;
             $myCache->saveFromCache($chartHash, $imgPath);
-            $imgPath = api_get_path(WEB_ARCHIVE_PATH) . $chartHash;
+            $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash;
         }
-        $html = '<img src="' . $imgPath . '">';
+        $html = '<img src="'.$imgPath.'">';
 
         return $html;
     } else {
-        $foo_img = api_convert_encoding('<div id="messages" class="warning-message">'.get_lang('GraphicNotAvailable').'</div>','UTF-8');
+        $foo_img = api_convert_encoding('<div id="messages" class="warning-message">'.get_lang('GraphicNotAvailable').'</div>', 'UTF-8');
 
         return $foo_img;
     }

main/inc/lib/notification.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -219,7 +219,7 @@
      * @param array	    $user_list recipients: user list of ids
      * @param string	$title
      * @param string	$content
-     * @param array	    $sender_info
+     * @param array	    $senderInfo
      * result of api_get_user_info() or GroupPortalManager:get_group_data()
      */
     public function save_notification(

Spacing +3 added lines, -3 removed lines

@@ -355,7 +355,7 @@ 
                 $newMessageText = '';
                 $linkToNewMessage = Display::url(
                     get_lang('SeeMessage'),
-                    api_get_path(WEB_CODE_PATH) . 'messages/inbox.php'
+                    api_get_path(WEB_CODE_PATH).'messages/inbox.php'
                 );
                 break;
             case self::NOTIFICATION_TYPE_MESSAGE:
@@ -370,7 +370,7 @@ 
                 }
                 $linkToNewMessage = Display::url(
                     get_lang('SeeMessage'),
-                    api_get_path(WEB_CODE_PATH) . 'messages/inbox.php'
+                    api_get_path(WEB_CODE_PATH).'messages/inbox.php'
                 );
                 break;
             case self::NOTIFICATION_TYPE_INVITATION:
@@ -385,7 +385,7 @@ 
                 }
                 $linkToNewMessage = Display::url(
                     get_lang('SeeInvitation'),
-                    api_get_path(WEB_CODE_PATH) . 'social/invitations.php'
+                    api_get_path(WEB_CODE_PATH).'social/invitations.php'
                 );
                 break;
             case self::NOTIFICATION_TYPE_GROUP: