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/glossary.lib.php

Doc Comments +6 added lines, -1 removed lines

@@ -86,7 +86,7 @@ 
      * This functions stores the glossary in the database
      *
      * @param array    Array of title + description (glossary_title => $title, glossary_comment => $comment)
-     * @return mixed   Term id on success, false on failure
+     * @return false|string   Term id on success, false on failure
      * @author Christian Fasanando <christian.fasanando@dokeos.com>
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
      * @version januari 2009, dokeos 1.8.6
@@ -443,6 +443,10 @@ 
      * @param integer Number of items to collect
      * @param string  Name of column on which to order
      * @param string  Whether to sort in ascending (ASC) or descending (DESC)
+     * @param integer $from
+     * @param integer $number_of_items
+     * @param integer $column
+     * @param string $direction
      * @return unknown
      *
      * @author Patrick Cool <patrick.cool@ugent.be>
@@ -520,6 +524,7 @@ 
      * @param integer $glossary_id
      * @param array   Parameters to use to affect links
      * @param array   The line of results from a query on the glossary table
+     * @param string $url_params
      * @return string HTML string for the action icons columns
      *
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium

Spacing +34 added lines, -34 removed lines

@@ -39,13 +39,13 @@ 
      * @param int $glossary_id
      * @return string The glossary description
      */
-    public static function get_glossary_term_by_glossary_id ($glossary_id)
+    public static function get_glossary_term_by_glossary_id($glossary_id)
     {
-        $glossary_table  = Database::get_course_table(TABLE_GLOSSARY);
+        $glossary_table = Database::get_course_table(TABLE_GLOSSARY);
         $course_id = api_get_course_int_id();
         $sql = "SELECT description FROM $glossary_table
                 WHERE c_id = $course_id  AND glossary_id =".intval($glossary_id);
-        $rs=Database::query($sql);
+        $rs = Database::query($sql);
         if (Database::num_rows($rs) > 0) {
             $row = Database::fetch_array($rs);
 
@@ -61,9 +61,9 @@ 
      * @param string The glossary term name
      * @return string The glossary description
      */
-    public static function get_glossary_term_by_glossary_name ($glossary_name)
+    public static function get_glossary_term_by_glossary_name($glossary_name)
     {
-        $glossary_table  = Database::get_course_table(TABLE_GLOSSARY);
+        $glossary_table = Database::get_course_table(TABLE_GLOSSARY);
         $session_id = api_get_session_id();
         $course_id = api_get_course_int_id();
         $sql_filter = api_get_session_condition($session_id);
@@ -163,7 +163,7 @@ 
         $course_id = api_get_course_int_id();
 
         // check if the glossary term already exists
-        if (GlossaryManager::glossary_exists($values['glossary_title'],$values['glossary_id'])) {
+        if (GlossaryManager::glossary_exists($values['glossary_title'], $values['glossary_id'])) {
             // display the feedback message
             if ($message)
                 Display::display_error_message(get_lang('GlossaryTermAlreadyExistsYouShouldEditIt'));
@@ -210,7 +210,7 @@ 
         $get_max = "SELECT MAX(display_order) FROM $t_glossary
                     WHERE c_id = $course_id ";
         $res_max = Database::query($get_max);
-        if (Database::num_rows($res_max)==0) {
+        if (Database::num_rows($res_max) == 0) {
             return 0;
         }
         $row = Database::fetch_array($res_max);
@@ -231,7 +231,7 @@ 
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
      * @version januari 2009, dokeos 1.8.6
      */
-    public static function glossary_exists($term, $not_id='')
+    public static function glossary_exists($term, $not_id = '')
     {
         // Database table definition
         $t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
@@ -241,7 +241,7 @@ 
                 WHERE
                     c_id = $course_id AND
                     name = '".Database::escape_string($term)."'";
-        if ($not_id<>'') {
+        if ($not_id <> '') {
             $sql .= " AND glossary_id <> '".intval($not_id)."'";
         }
         $result = Database::query($sql);
@@ -347,27 +347,27 @@ 
         // action links
         echo '<div class="actions">';
 
-        if (api_is_allowed_to_edit(null,true)) {
+        if (api_is_allowed_to_edit(null, true)) {
             echo '<a href="index.php?'.api_get_cidreq().'&action=addglossary&msg=add?'.api_get_cidreq().'">'.
-                Display::return_icon('new_glossary_term.png',get_lang('TermAddNew'),'', ICON_SIZE_MEDIUM).'</a>';
+                Display::return_icon('new_glossary_term.png', get_lang('TermAddNew'), '', ICON_SIZE_MEDIUM).'</a>';
         }
 
         echo '<a href="index.php?'.api_get_cidreq().'&action=export">'.
-            Display::return_icon('export_csv.png',get_lang('ExportGlossaryAsCSV'),'',ICON_SIZE_MEDIUM).'</a>';
-        if (api_is_allowed_to_edit(null,true)) {
+            Display::return_icon('export_csv.png', get_lang('ExportGlossaryAsCSV'), '', ICON_SIZE_MEDIUM).'</a>';
+        if (api_is_allowed_to_edit(null, true)) {
             echo '<a href="index.php?'.api_get_cidreq().'&action=import">'.
-                Display::return_icon('import_csv.png',get_lang('ImportGlossary'),'',ICON_SIZE_MEDIUM).'</a>';
+                Display::return_icon('import_csv.png', get_lang('ImportGlossary'), '', ICON_SIZE_MEDIUM).'</a>';
         }
 
         echo '<a href="index.php?'.api_get_cidreq().'&action=export_to_pdf">'.
-            Display::return_icon('pdf.png',get_lang('ExportToPDF'),'', ICON_SIZE_MEDIUM).'</a>';
+            Display::return_icon('pdf.png', get_lang('ExportToPDF'), '', ICON_SIZE_MEDIUM).'</a>';
 
-        if ((isset($_SESSION['glossary_view']) && $_SESSION['glossary_view'] == 'table') or (!isset($_SESSION['glossary_view']))){
+        if ((isset($_SESSION['glossary_view']) && $_SESSION['glossary_view'] == 'table') or (!isset($_SESSION['glossary_view']))) {
             echo '<a href="index.php?'.api_get_cidreq().'&action=changeview&view=list">'.
-                Display::return_icon('view_detailed.png',get_lang('ListView'),'',ICON_SIZE_MEDIUM).'</a>';
+                Display::return_icon('view_detailed.png', get_lang('ListView'), '', ICON_SIZE_MEDIUM).'</a>';
         } else {
             echo '<a href="index.php?'.api_get_cidreq().'&action=changeview&view=table">'.
-                Display::return_icon('view_text.png',get_lang('TableView'),'',ICON_SIZE_MEDIUM).'</a>';
+                Display::return_icon('view_text.png', get_lang('TableView'), '', ICON_SIZE_MEDIUM).'</a>';
         }
         echo '</div>';
         if (!$_SESSION['glossary_view'] || $_SESSION['glossary_view'] == 'table') {
@@ -380,9 +380,9 @@ 
             //$table->set_header(0, '', false);
             $table->set_header(0, get_lang('TermName'), true);
             $table->set_header(1, get_lang('TermDefinition'), true);
-            if (api_is_allowed_to_edit(null,true)) {
+            if (api_is_allowed_to_edit(null, true)) {
                 $table->set_header(2, get_lang('Actions'), false, 'width=90px', array('class' => 'td_actions'));
-                $table->set_column_filter(2, array('GlossaryManager','actions_filter'));
+                $table->set_column_filter(2, array('GlossaryManager', 'actions_filter'));
             }
             $table->display();
         }
@@ -399,11 +399,11 @@ 
      */
     public static function display_glossary_list()
     {
-        $glossary_data = self::get_glossary_data(0,1000,0,'ASC');
+        $glossary_data = self::get_glossary_data(0, 1000, 0, 'ASC');
         foreach ($glossary_data as $key => $glossary_item) {
             $actions = '';
-            if (api_is_allowed_to_edit(null,true)) {
-                $actions = '<div class="pull-right">'.self::actions_filter($glossary_item[2], '',$glossary_item).'</div>';
+            if (api_is_allowed_to_edit(null, true)) {
+                $actions = '<div class="pull-right">'.self::actions_filter($glossary_item[2], '', $glossary_item).'</div>';
             }
             echo Display::panel($glossary_item[1], $glossary_item[0].' '.$actions);
         }
@@ -418,7 +418,7 @@ 
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
      * @version januari 2009, dokeos 1.8.6
      */
-    public static  function get_number_glossary_terms($session_id=0)
+    public static  function get_number_glossary_terms($session_id = 0)
     {
         // Database table definition
         $t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
@@ -456,7 +456,7 @@ 
         $t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
         $t_item_propery = Database :: get_course_table(TABLE_ITEM_PROPERTY);
 
-        if (api_is_allowed_to_edit(null,true)) {
+        if (api_is_allowed_to_edit(null, true)) {
             $col2 = " glossary.glossary_id	as col2, ";
         } else {
             $col2 = " ";
@@ -471,8 +471,8 @@ 
             'glossary.session_id'
         );
         $column = intval($column);
-        if (!in_array($direction,array('DESC', 'ASC'))) {
-            $direction          = 'ASC';
+        if (!in_array($direction, array('DESC', 'ASC'))) {
+            $direction = 'ASC';
         }
         $from = intval($from);
         $number_of_items = intval($number_of_items);
@@ -497,15 +497,15 @@ 
         while ($data = Database::fetch_array($res)) {
             // Validation when belongs to a session
             $session_img = api_get_session_image($data['session_id'], $_user['status']);
-            $array[0] = $data[0] . $session_img;
+            $array[0] = $data[0].$session_img;
 
             if (!$_SESSION['glossary_view'] || $_SESSION['glossary_view'] == 'table') {
-                $array[1] = str_replace(array('<p>','</p>'),array('','<br />'),$data[1]);
+                $array[1] = str_replace(array('<p>', '</p>'), array('', '<br />'), $data[1]);
             } else {
                 $array[1] = $data[1];
             }
 
-            if (api_is_allowed_to_edit(null,true)) {
+            if (api_is_allowed_to_edit(null, true)) {
                 $array[2] = $data[2];
             }
             $return[] = $array;
@@ -528,14 +528,14 @@ 
     public static function actions_filter($glossary_id, $url_params, $row)
     {
         $glossary_id = $row[2];
-        $return = '<a href="'.api_get_self().'?action=edit_glossary&amp;glossary_id='.$glossary_id.'&'.api_get_cidreq().'&msg=edit">'.Display::return_icon('edit.png',get_lang('Edit'),'',22).'</a>';
+        $return = '<a href="'.api_get_self().'?action=edit_glossary&amp;glossary_id='.$glossary_id.'&'.api_get_cidreq().'&msg=edit">'.Display::return_icon('edit.png', get_lang('Edit'), '', 22).'</a>';
         $glossary_data = GlossaryManager::get_glossary_information($glossary_id);
 
         $glossary_term = $glossary_data['glossary_title'];
 
         if (api_is_allowed_to_edit(null, true)) {
             if ($glossary_data['session_id'] == api_get_session_id()) {
-                $return .= '<a href="'.api_get_self().'?action=delete_glossary&amp;glossary_id='.$glossary_id.'&'.api_get_cidreq().'" onclick="return confirmation(\''.$glossary_term.'\');">'.Display::return_icon('delete.png', get_lang('Delete'),'',22).'</a>';
+                $return .= '<a href="'.api_get_self().'?action=delete_glossary&amp;glossary_id='.$glossary_id.'&'.api_get_cidreq().'" onclick="return confirmation(\''.$glossary_term.'\');">'.Display::return_icon('delete.png', get_lang('Delete'), '', 22).'</a>';
             } else {
                 $return  = get_lang('EditionNotAvailableFromSession');
             }
@@ -556,7 +556,7 @@ 
     {
         return "<script type=\"text/javascript\">
 				function confirmation (name) {
-					if (confirm(\" ". get_lang("TermConfirmDelete") ." \"+ name + \" ?\"))
+					if (confirm(\" ". get_lang("TermConfirmDelete")." \"+ name + \" ?\"))
 						{return true;}
 					else
 						{return false;}
@@ -616,7 +616,7 @@ 
         $res = Database::query($sql);
         $found = false;
         while ($row = Database::fetch_array($res)) {
-            if ($found && empty($next_id))	{
+            if ($found && empty($next_id)) {
                 $next_id = $row['glossary_id'];
                 $next_display_order = $row['display_order'];
             }

Braces +15 added lines, -10 removed lines

@@ -108,8 +108,9 @@ 
         // check if the glossary term already exists
         if (GlossaryManager::glossary_exists($values['glossary_title'])) {
             // display the feedback message
-            if ($message)
-                Display::display_error_message(get_lang('GlossaryTermAlreadyExistsYouShouldEditIt'));
+            if ($message) {
+                            Display::display_error_message(get_lang('GlossaryTermAlreadyExistsYouShouldEditIt'));
+            }
             return false;
         } else {
 
@@ -165,8 +166,9 @@ 
         // check if the glossary term already exists
         if (GlossaryManager::glossary_exists($values['glossary_title'],$values['glossary_id'])) {
             // display the feedback message
-            if ($message)
-                Display::display_error_message(get_lang('GlossaryTermAlreadyExistsYouShouldEditIt'));
+            if ($message) {
+                            Display::display_error_message(get_lang('GlossaryTermAlreadyExistsYouShouldEditIt'));
+            }
             return false;
         } else {
             $sql = "UPDATE $t_glossary SET
@@ -188,8 +190,9 @@ 
                 api_get_user_id()
             );
             // display the feedback message
-            if ($message)
-                Display::display_confirmation_message(get_lang('TermUpdated'));
+            if ($message) {
+                            Display::display_confirmation_message(get_lang('TermUpdated'));
+            }
         }
 
         return true;
@@ -323,8 +326,9 @@ 
         // reorder the remaining terms
         GlossaryManager::reorder_glossary();
         $_SESSION['max_glossary_display'] = GlossaryManager::get_max_glossary_item();
-        if ($message)
-            Display::display_confirmation_message(get_lang('TermDeleted'));
+        if ($message) {
+                    Display::display_confirmation_message(get_lang('TermDeleted'));
+        }
         return true;
     }
 
@@ -633,8 +637,9 @@ 
                  WHERE c_id = $course_id  AND glossary_id = '".Database::escape_string($next_id)."'";
         Database::query($sql1);
         Database::query($sql2);
-        if ($message)
-            Display::display_confirmation_message(get_lang('TermMoved'));
+        if ($message) {
+                    Display::display_confirmation_message(get_lang('TermMoved'));
+        }
     }
 
     /**

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 +17 added lines, -17 removed lines

@@ -50,15 +50,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
@@ -115,7 +115,7 @@ 
         }
 
         $form->addElement('hidden', 'maxvalue', '100');
-		$form->addElement('hidden', 'minvalue', '0');
+        $form->addElement('hidden', 'minvalue', '0');
         $renderer = & $form->defaultRenderer();
 
         $component_array = array();
@@ -127,7 +127,7 @@ 
             $form->addElement('text', 'components['.$i.'][title]',      null);
             $form->addElement('hidden', 'components['.$i.'][id]',       null);
 
-             $template_percentage =
+                $template_percentage =
             '<div id=' . $i . ' style="display: '.(($i<=$nr_items)?'inline':'none').';" class="control-group">
                 <p>
                 <label class="control-label">{label}</label>
@@ -192,7 +192,7 @@ 
         // Setting the rules
         $form->addRule('name', get_lang('ThisFieldIsRequired'), 'required');
 
-		return $form;
+        return $form;
     }
 
     public function get_components($id)
@@ -206,8 +206,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();
@@ -218,7 +218,7 @@ 
         }
 
         //event_system(LOG_CAREER_CREATE, LOG_CAREER_ID, $id, api_get_utc_datetime(), api_get_user_id());
-   		return $id;
+            return $id;
     }
 
     /**
@@ -244,8 +244,8 @@ 
 
     public function delete($id)
     {
-	    parent::delete($id);
-	    //event_system(LOG_CAREER_DELETE, LOG_CAREER_ID, $id, api_get_utc_datetime(), api_get_user_id());
+        parent::delete($id);
+        //event_system(LOG_CAREER_DELETE, LOG_CAREER_ID, $id, api_get_utc_datetime(), api_get_user_id());
     }
 
     public function fill_grade_model_select_in_form(&$form, $name = 'gradebook_model_id', $default_value = null)
@@ -290,14 +290,14 @@ 
     public $table;
     public $columns = array('id', 'title', 'percentage', 'acronym', 'grade_model_id');
 
-	public function __construct()
+    public function __construct()
     {
         $this->table =  Database::get_main_table(TABLE_GRADE_MODEL_COMPONENTS);
-	}
+    }
 
     public function save($params, $show_query = false)
     {
-	    $id = parent::save($params, $show_query);
+        $id = parent::save($params, $show_query);
         return $id;
     }
 }

Spacing +13 added lines, -13 removed lines

@@ -15,7 +15,7 @@ 
      */
     public function __construct()
     {
-        $this->table =  Database::get_main_table(TABLE_GRADE_MODEL);
+        $this->table = Database::get_main_table(TABLE_GRADE_MODEL);
     }
 
     /**
@@ -54,8 +54,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');
 	}
@@ -110,7 +110,7 @@ 
 
         if ($action == 'edit') {
             if (!empty($components)) {
-                $nr_items = count($components) -1;
+                $nr_items = count($components) - 1;
             }
         }
 
@@ -123,12 +123,12 @@ 
         for ($i = 0; $i <= $max; $i++) {
             $counter = $i;
             $form->addElement('text', 'components['.$i.'][percentage]', null);
-            $form->addElement('text', 'components['.$i.'][acronym]',    null);
-            $form->addElement('text', 'components['.$i.'][title]',      null);
-            $form->addElement('hidden', 'components['.$i.'][id]',       null);
+            $form->addElement('text', 'components['.$i.'][acronym]', null);
+            $form->addElement('text', 'components['.$i.'][title]', null);
+            $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">
@@ -141,11 +141,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>';
 
@@ -292,7 +292,7 @@ 
 
 	public function __construct()
     {
-        $this->table =  Database::get_main_table(TABLE_GRADE_MODEL_COMPONENTS);
+        $this->table = Database::get_main_table(TABLE_GRADE_MODEL_COMPONENTS);
 	}
 
     public function save($params, $show_query = false)

main/inc/lib/group_portal_manager.lib.php

Doc Comments +10 added lines, -6 removed lines

@@ -21,7 +21,7 @@ 
      * @param	int		$visibility is active or not
      * @param   string  $picture
      *
-     * @return boolean if success
+     * @return string|false if success
      */
     public static function add($name, $description, $url, $visibility, $picture = '')
     {
@@ -57,7 +57,7 @@ 
      * @param int $visibility
      * @param string $picture_uri
      * @param bool $allowMemberGroupToLeave
-     * @return bool if success
+     * @return Statement|null if success
      */
     public static function update($group_id, $name, $description, $url, $visibility, $picture_uri, $allowMemberGroupToLeave = null)
     {
@@ -87,7 +87,7 @@ 
      * Deletes a group
      * @author Julio Montoya
      * @param int $id
-     * @return boolean true if success
+     * @return Statement|null true if success
      * */
     public static function delete($id)
     {
@@ -175,7 +175,7 @@ 
      * @param int $group_id
      * @param int $parent_group_id if 0, we delete the parent_group association
      * @param int $relation_type
-     * @return resource
+     * @return Statement|null
      **/
     public static function set_parent_group($group_id, $parent_group_id, $relation_type = 1)
     {
@@ -652,6 +652,7 @@ 
      * @author Julio Montoya
      * @param  int user_id
      * @param  int url_id
+     * @param integer $relation_type
      * @return boolean true if success
      **/
     public static function add_user_to_group($user_id, $group_id, $relation_type = GROUP_USER_PERMISSION_READER)
@@ -735,7 +736,7 @@ 
      * @author Julio Montoya
      * @param int $group_id
      * @param int $relation_type (optional)
-     * @return boolean true if success
+     * @return Statement|null true if success
      * */
     public static function delete_users($group_id, $relation_type = null)
     {
@@ -916,6 +917,7 @@ 
      * If an empty name is provided, then old user photos are deleted only, @see UserManager::delete_user_picture()
      * as the prefered way for deletion.
      * @param	string		$source_file The full system name of the image from which user photos will be created.
+     * @param integer $group_id
      * @return	string/bool	Returns the resulting file name of created images which usually should be stored in DB.
      * When deletion is recuested returns empty string. In case of internal error or negative validation returns FALSE.
      */
@@ -1074,7 +1076,9 @@ 
      *
      * @param  string file picture
      * @param  int size in pixels
-     * @return obj image object
+     * @param string|null $file
+     * @param integer $max_size_for_picture
+     * @return Image image object
      */
     public static function resize_picture($file, $max_size_for_picture)
     {

Indentation +14 added lines, -14 removed lines

@@ -1335,27 +1335,27 @@
     public static function get_groups_by_user_count($user_id = null, $relation_type = GROUP_USER_PERMISSION_READER, $with_image = false)
     {
         $table_group_rel_user	= Database::get_main_table(TABLE_MAIN_USER_REL_GROUP);
-		$tbl_group				= Database::get_main_table(TABLE_MAIN_GROUP);
-		$user_id = intval($user_id);
+        $tbl_group				= Database::get_main_table(TABLE_MAIN_GROUP);
+        $user_id = intval($user_id);
 
-		if ($relation_type == 0) {
-			$where_relation_condition = '';
-		} else {
-			$relation_type 			= intval($relation_type);
-			$where_relation_condition = "AND gu.relation_type = $relation_type ";
-		}
+        if ($relation_type == 0) {
+            $where_relation_condition = '';
+        } else {
+            $relation_type 			= intval($relation_type);
+            $where_relation_condition = "AND gu.relation_type = $relation_type ";
+        }
 
-		$sql = "SELECT count(g.id) as count
+        $sql = "SELECT count(g.id) as count
 				FROM $tbl_group g
 				INNER JOIN $table_group_rel_user gu
 				ON gu.group_id = g.id WHERE gu.user_id = $user_id $where_relation_condition ";
 
-		$result = Database::query($sql);
-		if (Database::num_rows($result) > 0) {
-			$row = Database::fetch_array($result, 'ASSOC');
+        $result = Database::query($sql);
+        if (Database::num_rows($result) > 0) {
+            $row = Database::fetch_array($result, 'ASSOC');
             return $row['count'];
-		}
-		return 0;
+        }
+        return 0;
     }
 
     /**

Spacing +5 added lines, -5 removed lines

@@ -331,7 +331,7 @@ 
             if ($i == $max_level) {
                 $select_part .= "rg$rg_number.group_id as id_$rg_number ";
             } else {
-                $select_part .="rg$rg_number.group_id as id_$rg_number, ";
+                $select_part .= "rg$rg_number.group_id as id_$rg_number, ";
             }
             if ($i == 1) {
                 $cond_part .= "FROM $t_rel_group rg0 LEFT JOIN $t_rel_group rg$i on rg$rg_number.group_id = rg$i.subgroup_id ";
@@ -1334,14 +1334,14 @@ 
      */
     public static function get_groups_by_user_count($user_id = null, $relation_type = GROUP_USER_PERMISSION_READER, $with_image = false)
     {
-        $table_group_rel_user	= Database::get_main_table(TABLE_MAIN_USER_REL_GROUP);
-		$tbl_group				= Database::get_main_table(TABLE_MAIN_GROUP);
+        $table_group_rel_user = Database::get_main_table(TABLE_MAIN_USER_REL_GROUP);
+		$tbl_group = Database::get_main_table(TABLE_MAIN_GROUP);
 		$user_id = intval($user_id);
 
 		if ($relation_type == 0) {
 			$where_relation_condition = '';
 		} else {
-			$relation_type 			= intval($relation_type);
+			$relation_type = intval($relation_type);
 			$where_relation_condition = "AND gu.relation_type = $relation_type ";
 		}
 
@@ -1394,7 +1394,7 @@ 
 
         // Picture
         $form->addElement('file', 'picture', get_lang('AddPicture'));
-        $allowed_picture_types = array ('jpg', 'jpeg', 'png', 'gif');
+        $allowed_picture_types = array('jpg', 'jpeg', 'png', 'gif');
         $form->addRule('picture', get_lang('OnlyImagesAllowed').' ('.implode(',', $allowed_picture_types).')', 'filetype', $allowed_picture_types);
 
         if (!empty($groupData)) {

Braces +6 added lines, -4 removed lines

@@ -563,8 +563,9 @@ 
                 $new_relation_type[] = "'$rel'";
             }
             $relation_type = implode(',', $new_relation_type);
-            if (!empty($relation_type))
-                $where_relation_condition = "AND gu.relation_type IN ($relation_type) ";
+            if (!empty($relation_type)) {
+                            $where_relation_condition = "AND gu.relation_type IN ($relation_type) ";
+            }
         }
 
         $sql = "SELECT
@@ -1086,8 +1087,9 @@ 
                 $thumbwidth = $max_size_for_picture;
             }
             $new_height = round(($thumbwidth / $picture_infos['width']) * $picture_infos['height']);
-            if ($new_height > $max_size_for_picture)
-                $new_height = $thumbwidth;
+            if ($new_height > $max_size_for_picture) {
+                            $new_height = $thumbwidth;
+            }
             $temp->resize($thumbwidth, $new_height, 0);
         }
 

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 +40 added lines, -40 removed lines

@@ -221,8 +221,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,
@@ -285,11 +285,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);
             }
@@ -320,9 +320,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,
@@ -366,7 +366,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;
@@ -391,14 +391,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);
+            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--;
                 }
             }
@@ -633,7 +633,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;
     }
@@ -662,13 +662,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;
         }
@@ -779,7 +779,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;
             }
@@ -947,7 +947,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
@@ -1186,17 +1186,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;
             }
         }
@@ -1235,9 +1235,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;
         }
@@ -1249,7 +1249,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'];
@@ -1444,7 +1444,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;
                 }
@@ -1555,7 +1555,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;
@@ -1620,8 +1620,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);
             }
         }
@@ -1637,7 +1637,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();
@@ -2183,7 +2183,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"],
@@ -2315,14 +2315,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').'">'.
@@ -2335,10 +2335,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;
             }
@@ -2710,7 +2710,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/image.lib.php

Doc Comments +19 added lines

@@ -52,6 +52,9 @@ 
         }
     }
     
+    /**
+     * @param string|null $cropParameters
+     */
     public function crop($cropParameters) {
         $image_size = $this->get_image_size($this->image_wrapper->path);
         $src_width = $image_size['width'];
@@ -66,6 +69,9 @@ 
         return $image;
     }
 
+    /**
+     * @param string $convert_file_to
+     */
     public function send_image(
         $file = '',
         $compress = -1,
@@ -147,6 +153,9 @@ 
     public $image;
     public $filter = Imagick::FILTER_LANCZOS;
 
+    /**
+     * @param string $path
+     */
     public function __construct($path)
     {
           parent::__construct($path);
@@ -194,6 +203,10 @@ 
 	}
 
 	//@todo implement border logic case for Imagick
+
+	/**
+	 * @param integer $border
+	 */
 	public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
 	    if (!$this->image_validated) return false;
@@ -275,6 +288,9 @@ 
 {
     public $bg;
 
+    /**
+     * @param string $path
+     */
     function __construct($path) {
         parent::__construct($path);
     }
@@ -332,6 +348,9 @@ 
     	}
     }
 
+    /**
+     * @param integer $border
+     */
     public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
         if (!$this->image_validated) return false;

Indentation +120 added lines, -120 removed lines

@@ -47,7 +47,7 @@ 
             if ($height >= $max_size_for_picture) {
                 // scale width
                 $new_width = round($width * ($max_size_for_picture / $height));
-                 $this->image_wrapper->resize($new_width, $max_size_for_picture, 0);
+                    $this->image_wrapper->resize($new_width, $max_size_for_picture, 0);
             }
         }
     }
@@ -149,7 +149,7 @@ 
 
     public function __construct($path)
     {
-          parent::__construct($path);
+            parent::__construct($path);
     }
 
     public function set_image_wrapper()
@@ -184,19 +184,19 @@ 
         }
     }
 
-	public function get_image_size()
+    public function get_image_size()
     {
-		$imagesize = array('width'=>0,'height'=>0);
-	    if ($this->image_validated) {
+        $imagesize = array('width'=>0,'height'=>0);
+        if ($this->image_validated) {
             $imagesize = $this->image->getImageGeometry();
-	    }
-	    return $imagesize;
-	}
+        }
+        return $imagesize;
+    }
 
-	//@todo implement border logic case for Imagick
-	public function resize($thumbw, $thumbh, $border, $specific_size = false)
+    //@todo implement border logic case for Imagick
+    public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
-	    if (!$this->image_validated) return false;
+        if (!$this->image_validated) return false;
 
         if ($specific_size) {
             $width = $thumbw;
@@ -206,10 +206,10 @@ 
             $width  = (int)($this->width * $scale);
             $height = (int)($this->height * $scale);
         }
-		$result = $this->image->resizeImage($width, $height, $this->filter, 1);
-		$this->width  = $thumbw;
-		$this->height = $thumbh;
-	}
+        $result = $this->image->resizeImage($width, $height, $this->filter, 1);
+        $this->width  = $thumbw;
+        $this->height = $thumbh;
+    }
     
     /**
      * @author José Loguercio <jose.loguercio@beeznest.com>
@@ -224,8 +224,8 @@ 
     public function crop($x, $y, $width, $height, $src_width, $src_height) {
         if (!$this->image_validated) return false;
         $this->image->cropimage($width, $height, $x, $y);
-		$this->width  = $width;
-		$this->height = $height;
+        $this->width  = $width;
+        $this->height = $height;
     }
 
     public function send_image($file = '', $compress = -1, $convert_file_to = null)
@@ -235,35 +235,35 @@ 
         if (!empty($convert_file_to) && in_array($convert_file_to, $this->allowed_extensions)) {
             $type = $convert_file_to;
         }
-		switch ($type) {
-		    case 'jpeg':
-			case 'jpg':
-				if (!$file) header("Content-type: image/jpeg");
-				break;
-			case 'png':
-				if (!$file) header("Content-type: image/png");
-				break;
-			case 'gif':
-				if (!$file) header("Content-type: image/gif");
-				break;
-		}
-		$result = false;
-		try {
-		    $result = $this->image->writeImage($file);
-		} catch(ImagickException $e) {
+        switch ($type) {
+            case 'jpeg':
+            case 'jpg':
+                if (!$file) header("Content-type: image/jpeg");
+                break;
+            case 'png':
+                if (!$file) header("Content-type: image/png");
+                break;
+            case 'gif':
+                if (!$file) header("Content-type: image/gif");
+                break;
+        }
+        $result = false;
+        try {
+            $result = $this->image->writeImage($file);
+        } catch(ImagickException $e) {
             if ($this->debug) error_log($e->getMessage());
         }
 
-		if (!$file) {
-		    echo $this->image;
-		    $this->image->clear();
+        if (!$file) {
+            echo $this->image;
+            $this->image->clear();
             $this->image->destroy();
-		} else {
-		    $this->image->clear();
+        } else {
+            $this->image->clear();
             $this->image->destroy();
-		    return $result;
-		}
-	}
+            return $result;
+        }
+    }
 
 }
 
@@ -285,21 +285,21 @@ 
         $this->fill_image_info();
 
         switch ($this->type) {
-        	case 0:
-        		$handler = false;
-        		break;
-		    case 1 :
+            case 0:
+                $handler = false;
+                break;
+            case 1 :
                 $handler = @imagecreatefromgif($this->path);
                 $this->type = 'gif';
                 break;
-		    case 2 :
+            case 2 :
                 $handler = @imagecreatefromjpeg($this->path);
                 $this->type = 'jpg';
                 break;
-		    case 3 :
-		        $handler = @imagecreatefrompng($this->path);
-		        $this->type = 'png';
-		        break;
+            case 3 :
+                $handler = @imagecreatefrompng($this->path);
+                $this->type = 'png';
+                break;
         }
         if ($handler) {
             $this->image_validated = true;
@@ -313,29 +313,29 @@ 
     {
         $return_array = array('width'=>0,'height'=>0);
         if ($this->image_validated) {
-	        $return_array = array('width'=>$this->width,'height'=>$this->height);
+            $return_array = array('width'=>$this->width,'height'=>$this->height);
         }
         return $return_array;
-	}
+    }
 
     public function fill_image_info()
     {
-    	if (file_exists($this->path)) {
-	        $image_info     = getimagesize($this->path);
-			$this->width    = $image_info[0];
-			$this->height   = $image_info[1];
-			$this->type     = $image_info[2];
-    	} else {
-    		$this->width    = 0;
-    		$this->height   = 0;
-    		$this->type     = 0;
-    	}
+        if (file_exists($this->path)) {
+            $image_info     = getimagesize($this->path);
+            $this->width    = $image_info[0];
+            $this->height   = $image_info[1];
+            $this->type     = $image_info[2];
+        } else {
+            $this->width    = 0;
+            $this->height   = 0;
+            $this->type     = 0;
+        }
     }
 
     public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
         if (!$this->image_validated) return false;
-		if ($border == 1) {
+        if ($border == 1) {
             if ($specific_size) {
                 $width = $thumbw;
                 $height = $thumbh;
@@ -344,17 +344,17 @@ 
                 $width = (int)($this->width * $scale);
                 $height = (int)($this->height * $scale);
             }
-			$deltaw = (int)(($thumbw - $width) / 2);
-			$deltah = (int)(($thumbh - $height) / 2);
-			$dst_img = @ImageCreateTrueColor($thumbw, $thumbh);
-            		@imagealphablending($dst_img, false);
-		        @imagesavealpha($dst_img, true);
-			if (!empty($this->color)) {
-				@imagefill($dst_img, 0, 0, $this->color);
-			}
-			$this->width = $thumbw;
-			$this->height = $thumbh;
-		} elseif ($border == 0) {
+            $deltaw = (int)(($thumbw - $width) / 2);
+            $deltah = (int)(($thumbh - $height) / 2);
+            $dst_img = @ImageCreateTrueColor($thumbw, $thumbh);
+                    @imagealphablending($dst_img, false);
+                @imagesavealpha($dst_img, true);
+            if (!empty($this->color)) {
+                @imagefill($dst_img, 0, 0, $this->color);
+            }
+            $this->width = $thumbw;
+            $this->height = $thumbh;
+        } elseif ($border == 0) {
             if ($specific_size) {
                 $width = $thumbw;
                 $height = $thumbh;
@@ -363,19 +363,19 @@ 
                 $width  = (int)($this->width * $scale);
                 $height = (int)($this->height * $scale);
             }
-			$deltaw = 0;
-			$deltah = 0;
-			$dst_img = @ImageCreateTrueColor($width, $height);
-            		@imagealphablending($dst_img, false);
-		        @imagesavealpha($dst_img, true);
-			$this->width = $width;
-			$this->height = $height;
-		}
-		$src_img = $this->bg;
-		@ImageCopyResampled($dst_img, $src_img, $deltaw, $deltah, 0, 0, $width, $height, ImageSX($src_img), ImageSY($src_img));
-		$this->bg = $dst_img;
-		@imagedestroy($src_img);
-	}
+            $deltaw = 0;
+            $deltah = 0;
+            $dst_img = @ImageCreateTrueColor($width, $height);
+                    @imagealphablending($dst_img, false);
+                @imagesavealpha($dst_img, true);
+            $this->width = $width;
+            $this->height = $height;
+        }
+        $src_img = $this->bg;
+        @ImageCopyResampled($dst_img, $src_img, $deltaw, $deltah, 0, 0, $width, $height, ImageSX($src_img), ImageSY($src_img));
+        $this->bg = $dst_img;
+        @imagedestroy($src_img);
+    }
     
     /**
      * @author José Loguercio <jose.loguercio@beeznest.com>
@@ -389,7 +389,7 @@ 
     public function crop($x, $y, $width, $height, $src_width, $src_height) {
         if (!$this->image_validated) return false;
         $this->width = $width;
-		$this->height = $height;
+        $this->height = $height;
         $src = null;
         $dest = @imagecreatetruecolor($width, $height);
         $type = $this->type;
@@ -400,56 +400,56 @@ 
                 @imagecopy($dest, $src, 0, 0, $x, $y, $src_width, $src_height);
                 @imagejpeg($dest, $this->path);
                 break;
-		    case 'png' :
+            case 'png' :
                 $src = @imagecreatefrompng($this->path);
                 @imagecopy($dest, $src, 0, 0, $x, $y, $src_width, $src_height);
                 @imagepng($dest, $this->path);
                 break;
-		    case 'gif' :
-		        $src = @imagecreatefromgif($this->path);
+            case 'gif' :
+                $src = @imagecreatefromgif($this->path);
                 @imagecopy($dest, $src, 0, 0, $x, $y, $src_width, $src_height);
                 @imagegif($dest, $this->path);
-		        break;
+                break;
             default: return 0;
         }
         @imagedestroy($dest);
         @imagedestroy($src);
     }
 
-	public function send_image($file = '', $compress = -1, $convert_file_to = null)
+    public function send_image($file = '', $compress = -1, $convert_file_to = null)
     {
-	    if (!$this->image_validated) return false;
+        if (!$this->image_validated) return false;
         $compress = (int)$compress;
         $type = $this->type;
         if (!empty($convert_file_to) && in_array($convert_file_to, $this->allowed_extensions)) {
             $type = $convert_file_to;
         }
-		switch ($type) {
-		    case 'jpeg':
-			case 'jpg':
-				if (!$file) header("Content-type: image/jpeg");
-				if ($compress == -1) $compress = 100;
-				return imagejpeg($this->bg, $file, $compress);
-				break;
-			case 'png':
-				if (!$file) header("Content-type: image/png");
-				if ($compress != -1) {
-					@imagetruecolortopalette($this->bg, true, $compress);
-				}
-				return imagepng($this->bg, $file, $compress);
-				break;
-			case 'gif':
-				if (!$file) header("Content-type: image/gif");
-				if ($compress != -1) {
-					@imagetruecolortopalette($this->bg, true, $compress);
-				}
-				return imagegif($this->bg, $file, $compress);
-				break;
-			default: return 0;
-		}
-		// TODO: Occupied memory is not released, because the following fragment of code is actually dead.
-		@imagedestroy($this->bg);
-	}
+        switch ($type) {
+            case 'jpeg':
+            case 'jpg':
+                if (!$file) header("Content-type: image/jpeg");
+                if ($compress == -1) $compress = 100;
+                return imagejpeg($this->bg, $file, $compress);
+                break;
+            case 'png':
+                if (!$file) header("Content-type: image/png");
+                if ($compress != -1) {
+                    @imagetruecolortopalette($this->bg, true, $compress);
+                }
+                return imagepng($this->bg, $file, $compress);
+                break;
+            case 'gif':
+                if (!$file) header("Content-type: image/gif");
+                if ($compress != -1) {
+                    @imagetruecolortopalette($this->bg, true, $compress);
+                }
+                return imagegif($this->bg, $file, $compress);
+                break;
+            default: return 0;
+        }
+        // TODO: Occupied memory is not released, because the following fragment of code is actually dead.
+        @imagedestroy($this->bg);
+    }
 
     /**
      * Convert image to black & white

Spacing +19 added lines, -19 removed lines

@@ -115,7 +115,7 @@ 
             return false;
         }
         $this->path = preg_match(VALID_WEB_PATH, $path) ? (api_is_internal_path($path) ? api_get_path(TO_SYS, $path) : $path) : $path;
-        $this->set_image_wrapper();  //Creates image obj
+        $this->set_image_wrapper(); //Creates image obj
     }
 
     abstract function set_image_wrapper();
@@ -157,7 +157,7 @@ 
         if ($this->debug) error_log('Image::set_image_wrapper loaded');
         try {
             if (file_exists($this->path)) {
-                $this->image     = new Imagick($this->path);
+                $this->image = new Imagick($this->path);
 
                 if ($this->image) {
                     $this->fill_image_info(); //Fills height, width and type
@@ -165,7 +165,7 @@ 
             } else {
                 if ($this->debug) error_log('Image::image does not exist');
             }
-        } catch(ImagickException $e) {
+        } catch (ImagickException $e) {
             if ($this->debug) error_log($e->getMessage());
         }
     }
@@ -186,7 +186,7 @@ 
 
 	public function get_image_size()
     {
-		$imagesize = array('width'=>0,'height'=>0);
+		$imagesize = array('width'=>0, 'height'=>0);
 	    if ($this->image_validated) {
             $imagesize = $this->image->getImageGeometry();
 	    }
@@ -203,8 +203,8 @@ 
             $height = $thumbh;
         } else {
             $scale  = ($this->width > 0 && $this->height > 0) ? min($thumbw / $this->width, $thumbh / $this->height) : 0;
-            $width  = (int)($this->width * $scale);
-            $height = (int)($this->height * $scale);
+            $width  = (int) ($this->width * $scale);
+            $height = (int) ($this->height * $scale);
         }
 		$result = $this->image->resizeImage($width, $height, $this->filter, 1);
 		$this->width  = $thumbw;
@@ -250,7 +250,7 @@ 
 		$result = false;
 		try {
 		    $result = $this->image->writeImage($file);
-		} catch(ImagickException $e) {
+		} catch (ImagickException $e) {
             if ($this->debug) error_log($e->getMessage());
         }
 
@@ -311,9 +311,9 @@ 
 
     public function get_image_size()
     {
-        $return_array = array('width'=>0,'height'=>0);
+        $return_array = array('width'=>0, 'height'=>0);
         if ($this->image_validated) {
-	        $return_array = array('width'=>$this->width,'height'=>$this->height);
+	        $return_array = array('width'=>$this->width, 'height'=>$this->height);
         }
         return $return_array;
 	}
@@ -321,7 +321,7 @@ 
     public function fill_image_info()
     {
     	if (file_exists($this->path)) {
-	        $image_info     = getimagesize($this->path);
+	        $image_info = getimagesize($this->path);
 			$this->width    = $image_info[0];
 			$this->height   = $image_info[1];
 			$this->type     = $image_info[2];
@@ -341,11 +341,11 @@ 
                 $height = $thumbh;
             } else {
                 $scale = min($thumbw / $this->width, $thumbh / $this->height);
-                $width = (int)($this->width * $scale);
-                $height = (int)($this->height * $scale);
+                $width = (int) ($this->width * $scale);
+                $height = (int) ($this->height * $scale);
             }
-			$deltaw = (int)(($thumbw - $width) / 2);
-			$deltah = (int)(($thumbh - $height) / 2);
+			$deltaw = (int) (($thumbw - $width) / 2);
+			$deltah = (int) (($thumbh - $height) / 2);
 			$dst_img = @ImageCreateTrueColor($thumbw, $thumbh);
             		@imagealphablending($dst_img, false);
 		        @imagesavealpha($dst_img, true);
@@ -360,8 +360,8 @@ 
                 $height = $thumbh;
             } else {
                 $scale = ($this->width > 0 && $this->height > 0) ? min($thumbw / $this->width, $thumbh / $this->height) : 0;
-                $width  = (int)($this->width * $scale);
-                $height = (int)($this->height * $scale);
+                $width  = (int) ($this->width * $scale);
+                $height = (int) ($this->height * $scale);
             }
 			$deltaw = 0;
 			$deltah = 0;
@@ -419,7 +419,7 @@ 
 	public function send_image($file = '', $compress = -1, $convert_file_to = null)
     {
 	    if (!$this->image_validated) return false;
-        $compress = (int)$compress;
+        $compress = (int) $compress;
         $type = $this->type;
         if (!empty($convert_file_to) && in_array($convert_file_to, $this->allowed_extensions)) {
             $type = $convert_file_to;
@@ -463,11 +463,11 @@ 
          * so that we can use black (0,0,0) as transparent, which is what
          * the image is filled with when created.
          */
-        $transparent = imagecolorallocate($dest_img, 0,0,0);
+        $transparent = imagecolorallocate($dest_img, 0, 0, 0);
         imagealphablending($dest_img, false);
         imagesavealpha($dest_img, true);
         imagecolortransparent($dest_img, $transparent);
-        imagecopy($dest_img, $this->bg, 0,0, 0, 0,imagesx($this->bg), imagesx($this->bg));
+        imagecopy($dest_img, $this->bg, 0, 0, 0, 0, imagesx($this->bg), imagesx($this->bg));
         imagefilter($dest_img, IMG_FILTER_GRAYSCALE);
         $this->bg = $dest_img;
 

Braces +57 added lines, -19 removed lines

@@ -154,7 +154,9 @@ 
 
     public function set_image_wrapper()
     {
-        if ($this->debug) error_log('Image::set_image_wrapper loaded');
+        if ($this->debug) {
+            error_log('Image::set_image_wrapper loaded');
+        }
         try {
             if (file_exists($this->path)) {
                 $this->image     = new Imagick($this->path);
@@ -163,10 +165,14 @@ 
                     $this->fill_image_info(); //Fills height, width and type
                 }
             } else {
-                if ($this->debug) error_log('Image::image does not exist');
+                if ($this->debug) {
+                    error_log('Image::image does not exist');
+                }
             }
         } catch(ImagickException $e) {
-            if ($this->debug) error_log($e->getMessage());
+            if ($this->debug) {
+                error_log($e->getMessage());
+            }
         }
     }
 
@@ -180,7 +186,9 @@ 
 
         if (in_array($this->type, $this->allowed_extensions)) {
             $this->image_validated = true;
-            if ($this->debug) error_log('image_validated true');
+            if ($this->debug) {
+                error_log('image_validated true');
+            }
         }
     }
 
@@ -196,7 +204,9 @@ 
 	//@todo implement border logic case for Imagick
 	public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
-	    if (!$this->image_validated) return false;
+	    if (!$this->image_validated) {
+	        return false;
+	    }
 
         if ($specific_size) {
             $width = $thumbw;
@@ -222,7 +232,9 @@ 
      */
     
     public function crop($x, $y, $width, $height, $src_width, $src_height) {
-        if (!$this->image_validated) return false;
+        if (!$this->image_validated) {
+            return false;
+        }
         $this->image->cropimage($width, $height, $x, $y);
 		$this->width  = $width;
 		$this->height = $height;
@@ -230,7 +242,9 @@ 
 
     public function send_image($file = '', $compress = -1, $convert_file_to = null)
     {
-        if (!$this->image_validated) return false;
+        if (!$this->image_validated) {
+            return false;
+        }
         $type = $this->type;
         if (!empty($convert_file_to) && in_array($convert_file_to, $this->allowed_extensions)) {
             $type = $convert_file_to;
@@ -238,20 +252,28 @@ 
 		switch ($type) {
 		    case 'jpeg':
 			case 'jpg':
-				if (!$file) header("Content-type: image/jpeg");
+				if (!$file) {
+				    header("Content-type: image/jpeg");
+				}
 				break;
 			case 'png':
-				if (!$file) header("Content-type: image/png");
+				if (!$file) {
+				    header("Content-type: image/png");
+				}
 				break;
 			case 'gif':
-				if (!$file) header("Content-type: image/gif");
+				if (!$file) {
+				    header("Content-type: image/gif");
+				}
 				break;
 		}
 		$result = false;
 		try {
 		    $result = $this->image->writeImage($file);
 		} catch(ImagickException $e) {
-            if ($this->debug) error_log($e->getMessage());
+            if ($this->debug) {
+                error_log($e->getMessage());
+            }
         }
 
 		if (!$file) {
@@ -334,7 +356,9 @@ 
 
     public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
-        if (!$this->image_validated) return false;
+        if (!$this->image_validated) {
+            return false;
+        }
 		if ($border == 1) {
             if ($specific_size) {
                 $width = $thumbw;
@@ -387,7 +411,9 @@ 
      * @param int $src_height the source height of the original image
      */
     public function crop($x, $y, $width, $height, $src_width, $src_height) {
-        if (!$this->image_validated) return false;
+        if (!$this->image_validated) {
+            return false;
+        }
         $this->width = $width;
 		$this->height = $height;
         $src = null;
@@ -418,7 +444,9 @@ 
 
 	public function send_image($file = '', $compress = -1, $convert_file_to = null)
     {
-	    if (!$this->image_validated) return false;
+	    if (!$this->image_validated) {
+	        return false;
+	    }
         $compress = (int)$compress;
         $type = $this->type;
         if (!empty($convert_file_to) && in_array($convert_file_to, $this->allowed_extensions)) {
@@ -427,19 +455,27 @@ 
 		switch ($type) {
 		    case 'jpeg':
 			case 'jpg':
-				if (!$file) header("Content-type: image/jpeg");
-				if ($compress == -1) $compress = 100;
+				if (!$file) {
+				    header("Content-type: image/jpeg");
+				}
+				if ($compress == -1) {
+				    $compress = 100;
+				}
 				return imagejpeg($this->bg, $file, $compress);
 				break;
 			case 'png':
-				if (!$file) header("Content-type: image/png");
+				if (!$file) {
+				    header("Content-type: image/png");
+				}
 				if ($compress != -1) {
 					@imagetruecolortopalette($this->bg, true, $compress);
 				}
 				return imagepng($this->bg, $file, $compress);
 				break;
 			case 'gif':
-				if (!$file) header("Content-type: image/gif");
+				if (!$file) {
+				    header("Content-type: image/gif");
+				}
 				if ($compress != -1) {
 					@imagetruecolortopalette($this->bg, true, $compress);
 				}
@@ -456,7 +492,9 @@ 
      */
     function convert2bw()
     {
-        if (!$this->image_validated) return false;
+        if (!$this->image_validated) {
+            return false;
+        }
 
         $dest_img = imagecreatetruecolor(imagesx($this->bg), imagesy($this->bg));
         /* copy ignore the transparent color

main/inc/lib/kses-0.2.2/kses_original.php

Doc Comments +9 added lines

@@ -408,6 +408,9 @@ 
 } # function kses_no_null
 
 
+/**
+ * @return string
+ */
 function kses_stripslashes($string)
 ###############################################################################
 # This function changes the character sequence  \"  to just  "
@@ -442,6 +445,9 @@ 
 } # function kses_array_lc
 
 
+/**
+ * @return string
+ */
 function kses_js_entities($string)
 ###############################################################################
 # This function removes the HTML JavaScript entities found in early versions of
@@ -506,6 +512,9 @@ 
 } # function kses_bad_protocol_once2
 
 
+/**
+ * @return string
+ */
 function kses_normalize_entities($string)
 ###############################################################################
 # This function normalizes HTML entities. It will convert "AT&T" to the correct

Indentation +166 added lines, -166 removed lines

@@ -31,8 +31,8 @@ 
 
 
 function kses($string, $allowed_html, $allowed_protocols =
-               array('http', 'https', 'ftp', 'news', 'nntp', 'telnet',
-                     'gopher', 'mailto'))
+                array('http', 'https', 'ftp', 'news', 'nntp', 'telnet',
+                        'gopher', 'mailto'))
 ###############################################################################
 # This function makes sure that only the allowed HTML element names, attribute
 # names and attribute values plus only sane HTML entities will occur in
@@ -40,12 +40,12 @@ 
 # call this function.
 ###############################################################################
 {
-  $string = kses_no_null($string);
-  $string = kses_js_entities($string);
-  $string = kses_normalize_entities($string);
-  $string = kses_hook($string);
-  $allowed_html_fixed = kses_array_lc($allowed_html);
-  return kses_split($string, $allowed_html_fixed, $allowed_protocols);
+    $string = kses_no_null($string);
+    $string = kses_js_entities($string);
+    $string = kses_normalize_entities($string);
+    $string = kses_hook($string);
+    $allowed_html_fixed = kses_array_lc($allowed_html);
+    return kses_split($string, $allowed_html_fixed, $allowed_protocols);
 } # function kses
 
 
@@ -54,7 +54,7 @@ 
 # You add any kses hooks here.
 ###############################################################################
 {
-  return $string;
+    return $string;
 } # function kses_hook
 
 
@@ -63,7 +63,7 @@ 
 # This function returns kses' version number.
 ###############################################################################
 {
-  return '0.2.2';
+    return '0.2.2';
 } # function kses_version
 
 
@@ -73,13 +73,13 @@ 
 # matches stray ">" characters.
 ###############################################################################
 {
-  return preg_replace('%(<'.   # EITHER: <
-                      '[^>]*'. # things that aren't >
-                      '(>|$)'. # > or end of string
-                      '|>)%e', # OR: just a >
-                      "kses_split2('\\1', \$allowed_html, ".
-                      '$allowed_protocols)',
-                      $string);
+    return preg_replace('%(<'.   # EITHER: <
+                        '[^>]*'. # things that aren't >
+                        '(>|$)'. # > or end of string
+                        '|>)%e', # OR: just a >
+                        "kses_split2('\\1', \$allowed_html, ".
+                        '$allowed_protocols)',
+                        $string);
 } # function kses_split
 
 
@@ -91,30 +91,30 @@ 
 # attribute list.
 ###############################################################################
 {
-  $string = kses_stripslashes($string);
+    $string = kses_stripslashes($string);
 
-  if (substr($string, 0, 1) != '<')
+    if (substr($string, 0, 1) != '<')
     return '&gt;';
     # It matched a ">" character
 
-  if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $string, $matches))
+    if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $string, $matches))
     return '';
     # It's seriously malformed
 
-  $slash = trim($matches[1]);
-  $elem = $matches[2];
-  $attrlist = $matches[3];
+    $slash = trim($matches[1]);
+    $elem = $matches[2];
+    $attrlist = $matches[3];
 
-  if (!@isset($allowed_html[strtolower($elem)]))
+    if (!@isset($allowed_html[strtolower($elem)]))
     return '';
     # They are using a not allowed HTML element
 
-  if ($slash != '')
+    if ($slash != '')
     return "<$slash$elem>";
-  # No attributes are allowed for closing elements
+    # No attributes are allowed for closing elements
 
-  return kses_attr("$slash$elem", $attrlist, $allowed_html,
-                   $allowed_protocols);
+    return kses_attr("$slash$elem", $attrlist, $allowed_html,
+                    $allowed_protocols);
 } # function kses_split2
 
 
@@ -130,56 +130,56 @@ 
 {
 # Is there a closing XHTML slash at the end of the attributes?
 
-  $xhtml_slash = '';
-  if (preg_match('%\s/\s*$%', $attr))
+    $xhtml_slash = '';
+    if (preg_match('%\s/\s*$%', $attr))
     $xhtml_slash = ' /';
 
 # Are any attributes allowed at all for this element?
 
-  if (@count($allowed_html[strtolower($element)]) == 0)
+    if (@count($allowed_html[strtolower($element)]) == 0)
     return "<$element$xhtml_slash>";
 
 # Split it
 
-  $attrarr = kses_hair($attr, $allowed_protocols);
+    $attrarr = kses_hair($attr, $allowed_protocols);
 
 # Go through $attrarr, and save the allowed attributes for this element
 # in $attr2
 
-  $attr2 = '';
+    $attr2 = '';
 
-  foreach ($attrarr as $arreach)
-  {
+    foreach ($attrarr as $arreach)
+    {
     if (!@isset($allowed_html[strtolower($element)]
                             [strtolower($arreach['name'])]))
-      continue; # the attribute is not allowed
+        continue; # the attribute is not allowed
 
     $current = $allowed_html[strtolower($element)]
                             [strtolower($arreach['name'])];
 
     if (!is_array($current))
-      $attr2 .= ' '.$arreach['whole'];
+        $attr2 .= ' '.$arreach['whole'];
     # there are no checks
 
     else
     {
     # there are some checks
-      $ok = true;
-      foreach ($current as $currkey => $currval)
+        $ok = true;
+        foreach ($current as $currkey => $currval)
         if (!kses_check_attr_val($arreach['value'], $arreach['vless'],
-                                 $currkey, $currval))
+                                    $currkey, $currval))
         { $ok = false; break; }
 
-      if ($ok)
+        if ($ok)
         $attr2 .= ' '.$arreach['whole']; # it passed them
     } # if !is_array($current)
-  } # foreach
+    } # foreach
 
 # Remove any "<" or ">" characters
 
-  $attr2 = preg_replace('/[<>]/', '', $attr2);
+    $attr2 = preg_replace('/[<>]/', '', $attr2);
 
-  return "<$element$attr2$xhtml_slash>";
+    return "<$element$attr2$xhtml_slash>";
 } # function kses_attr
 
 
@@ -193,96 +193,96 @@ 
 # from attribute values.
 ###############################################################################
 {
-  $attrarr = array();
-  $mode = 0;
-  $attrname = '';
+    $attrarr = array();
+    $mode = 0;
+    $attrname = '';
 
 # Loop through the whole attribute list
 
-  while (strlen($attr) != 0)
-  {
+    while (strlen($attr) != 0)
+    {
     $working = 0; # Was the last operation successful?
 
     switch ($mode)
     {
-      case 0: # attribute name, href for instance
+        case 0: # attribute name, href for instance
 
         if (preg_match('/^([-a-zA-Z]+)/', $attr, $match))
         {
-          $attrname = $match[1];
-          $working = $mode = 1;
-          $attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
+            $attrname = $match[1];
+            $working = $mode = 1;
+            $attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
         }
 
         break;
 
-      case 1: # equals sign or valueless ("selected")
+        case 1: # equals sign or valueless ("selected")
 
         if (preg_match('/^\s*=\s*/', $attr)) # equals sign
         {
-          $working = 1; $mode = 2;
-          $attr = preg_replace('/^\s*=\s*/', '', $attr);
-          break;
+            $working = 1; $mode = 2;
+            $attr = preg_replace('/^\s*=\s*/', '', $attr);
+            break;
         }
 
         if (preg_match('/^\s+/', $attr)) # valueless
         {
-          $working = 1; $mode = 0;
-          $attrarr[] = array
+            $working = 1; $mode = 0;
+            $attrarr[] = array
                         ('name'  => $attrname,
-                         'value' => '',
-                         'whole' => $attrname,
-                         'vless' => 'y');
-          $attr = preg_replace('/^\s+/', '', $attr);
+                            'value' => '',
+                            'whole' => $attrname,
+                            'vless' => 'y');
+            $attr = preg_replace('/^\s+/', '', $attr);
         }
 
         break;
 
-      case 2: # attribute value, a URL after href= for instance
+        case 2: # attribute value, a URL after href= for instance
 
         if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match))
-         # "value"
+            # "value"
         {
-          $thisval = kses_bad_protocol($match[1], $allowed_protocols);
+            $thisval = kses_bad_protocol($match[1], $allowed_protocols);
 
-          $attrarr[] = array
+            $attrarr[] = array
                         ('name'  => $attrname,
-                         'value' => $thisval,
-                         'whole' => "$attrname=\"$thisval\"",
-                         'vless' => 'n');
-          $working = 1; $mode = 0;
-          $attr = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
-          break;
+                            'value' => $thisval,
+                            'whole' => "$attrname=\"$thisval\"",
+                            'vless' => 'n');
+            $working = 1; $mode = 0;
+            $attr = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
+            break;
         }
 
         if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match))
-         # 'value'
+            # 'value'
         {
-          $thisval = kses_bad_protocol($match[1], $allowed_protocols);
+            $thisval = kses_bad_protocol($match[1], $allowed_protocols);
 
-          $attrarr[] = array
+            $attrarr[] = array
                         ('name'  => $attrname,
-                         'value' => $thisval,
-                         'whole' => "$attrname='$thisval'",
-                         'vless' => 'n');
-          $working = 1; $mode = 0;
-          $attr = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
-          break;
+                            'value' => $thisval,
+                            'whole' => "$attrname='$thisval'",
+                            'vless' => 'n');
+            $working = 1; $mode = 0;
+            $attr = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
+            break;
         }
 
         if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match))
-         # value
+            # value
         {
-          $thisval = kses_bad_protocol($match[1], $allowed_protocols);
+            $thisval = kses_bad_protocol($match[1], $allowed_protocols);
 
-          $attrarr[] = array
+            $attrarr[] = array
                         ('name'  => $attrname,
-                         'value' => $thisval,
-                         'whole' => "$attrname=\"$thisval\"",
-                         'vless' => 'n');
-                         # We add quotes to conform to W3C's HTML spec.
-          $working = 1; $mode = 0;
-          $attr = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
+                            'value' => $thisval,
+                            'whole' => "$attrname=\"$thisval\"",
+                            'vless' => 'n');
+                            # We add quotes to conform to W3C's HTML spec.
+            $working = 1; $mode = 0;
+            $attr = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
         }
 
         break;
@@ -290,21 +290,21 @@ 
 
     if ($working == 0) # not well formed, remove and try again
     {
-      $attr = kses_html_error($attr);
-      $mode = 0;
+        $attr = kses_html_error($attr);
+        $mode = 0;
     }
-  } # while
+    } # while
 
-  if ($mode == 1)
-  # special case, for when the attribute list ends with a valueless
-  # attribute like "selected"
+    if ($mode == 1)
+    # special case, for when the attribute list ends with a valueless
+    # attribute like "selected"
     $attrarr[] = array
-                  ('name'  => $attrname,
-                   'value' => '',
-                   'whole' => $attrname,
-                   'vless' => 'y');
+                    ('name'  => $attrname,
+                    'value' => '',
+                    'whole' => $attrname,
+                    'vless' => 'y');
 
-  return $attrarr;
+    return $attrarr;
 } # function kses_hair
 
 
@@ -315,10 +315,10 @@ 
 # with even more checks to come soon.
 ###############################################################################
 {
-  $ok = true;
+    $ok = true;
 
-  switch (strtolower($checkname))
-  {
+    switch (strtolower($checkname))
+    {
     case 'maxlen':
     # The maxlen check makes sure that the attribute value has a length not
     # greater than the given value. This can be used to avoid Buffer Overflows
@@ -326,7 +326,7 @@ 
 
       if (strlen($value) > $checkvalue)
         $ok = false;
-      break;
+        break;
 
     case 'minlen':
     # The minlen check makes sure that the attribute value has a length not
@@ -334,7 +334,7 @@ 
 
       if (strlen($value) < $checkvalue)
         $ok = false;
-      break;
+        break;
 
     case 'maxval':
     # The maxval check does two things: it checks that the attribute value is
@@ -345,9 +345,9 @@ 
 
       if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
         $ok = false;
-      if ($value > $checkvalue)
+        if ($value > $checkvalue)
         $ok = false;
-      break;
+        break;
 
     case 'minval':
     # The minval check checks that the attribute value is a positive integer,
@@ -355,9 +355,9 @@ 
 
       if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
         $ok = false;
-      if ($value < $checkvalue)
+        if ($value < $checkvalue)
         $ok = false;
-      break;
+        break;
 
     case 'valueless':
     # The valueless check checks if the attribute has a value
@@ -367,10 +367,10 @@ 
 
       if (strtolower($checkvalue) != $vless)
         $ok = false;
-      break;
-  } # switch
+        break;
+    } # switch
 
-  return $ok;
+    return $ok;
 } # function kses_check_attr_val
 
 
@@ -382,17 +382,17 @@ 
 # fooled by a string like "javascript:javascript:alert(57)".
 ###############################################################################
 {
-  $string = kses_no_null($string);
-  $string = preg_replace('/\xad+/', '', $string); # deals with Opera "feature"
-  $string2 = $string.'a';
+    $string = kses_no_null($string);
+    $string = preg_replace('/\xad+/', '', $string); # deals with Opera "feature"
+    $string2 = $string.'a';
 
-  while ($string != $string2)
-  {
+    while ($string != $string2)
+    {
     $string2 = $string;
     $string = kses_bad_protocol_once($string, $allowed_protocols);
-  } # while
+    } # while
 
-  return $string;
+    return $string;
 } # function kses_bad_protocol
 
 
@@ -401,10 +401,10 @@ 
 # This function removes any NULL characters in $string.
 ###############################################################################
 {
-  $string = preg_replace('/\0+/', '', $string);
-  $string = preg_replace('/(\\\\0)+/', '', $string);
+    $string = preg_replace('/\0+/', '', $string);
+    $string = preg_replace('/(\\\\0)+/', '', $string);
 
-  return $string;
+    return $string;
 } # function kses_no_null
 
 
@@ -415,7 +415,7 @@ 
 # preg_replace(//e) seems to require this.
 ###############################################################################
 {
-  return preg_replace('%\\\\"%', '"', $string);
+    return preg_replace('%\\\\"%', '"', $string);
 } # function kses_stripslashes
 
 
@@ -424,21 +424,21 @@ 
 # This function goes through an array, and changes the keys to all lower case.
 ###############################################################################
 {
-  $outarray = array();
+    $outarray = array();
 
-  foreach ($inarray as $inkey => $inval)
-  {
+    foreach ($inarray as $inkey => $inval)
+    {
     $outkey = strtolower($inkey);
     $outarray[$outkey] = array();
 
     foreach ($inval as $inkey2 => $inval2)
     {
-      $outkey2 = strtolower($inkey2);
-      $outarray[$outkey][$outkey2] = $inval2;
+        $outkey2 = strtolower($inkey2);
+        $outarray[$outkey][$outkey2] = $inval2;
     } # foreach $inval
-  } # foreach $inarray
+    } # foreach $inarray
 
-  return $outarray;
+    return $outarray;
 } # function kses_array_lc
 
 
@@ -448,7 +448,7 @@ 
 # Netscape 4.
 ###############################################################################
 {
-  return preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
+    return preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
 } # function kses_js_entities
 
 
@@ -459,7 +459,7 @@ 
 # quotes and apostrophes as well.
 ###############################################################################
 {
-  return preg_replace('/^("[^"]*("|$)|\'[^\']*(\'|$)|\S)*\s*/', '', $string);
+    return preg_replace('/^("[^"]*("|$)|\'[^\']*(\'|$)|\S)*\s*/', '', $string);
 } # function kses_html_error
 
 
@@ -469,12 +469,12 @@ 
 # handling whitespace and HTML entities.
 ###############################################################################
 {
-	$string2 = preg_split('/:|&#58;|&#x3a;/i', $string, 2);
-	if(isset($string2[1]) && !preg_match('%/\?%',$string2[0]))
-	{
-		$string = kses_bad_protocol_once2($string2[0],$allowed_protocols).trim($string2[1]);
-	}
-	return $string;
+    $string2 = preg_split('/:|&#58;|&#x3a;/i', $string, 2);
+    if(isset($string2[1]) && !preg_match('%/\?%',$string2[0]))
+    {
+        $string = kses_bad_protocol_once2($string2[0],$allowed_protocols).trim($string2[1]);
+    }
+    return $string;
 } # function kses_bad_protocol_once
 
 
@@ -484,24 +484,24 @@ 
 # list or not, and returns different data depending on the answer.
 ###############################################################################
 {
-  $string2 = kses_decode_entities($string);
-  $string2 = preg_replace('/\s/', '', $string2);
-  $string2 = kses_no_null($string2);
-  $string2 = preg_replace('/\xad+/', '', $string2);
-   # deals with Opera "feature"
-  $string2 = strtolower($string2);
-
-  $allowed = false;
-  foreach ($allowed_protocols as $one_protocol)
+    $string2 = kses_decode_entities($string);
+    $string2 = preg_replace('/\s/', '', $string2);
+    $string2 = kses_no_null($string2);
+    $string2 = preg_replace('/\xad+/', '', $string2);
+    # deals with Opera "feature"
+    $string2 = strtolower($string2);
+
+    $allowed = false;
+    foreach ($allowed_protocols as $one_protocol)
     if (strtolower($one_protocol) == $string2)
     {
-      $allowed = true;
-      break;
+        $allowed = true;
+        break;
     }
 
-  if ($allowed)
+    if ($allowed)
     return "$string2:";
-  else
+    else
     return '';
 } # function kses_bad_protocol_once2
 
@@ -514,18 +514,18 @@ 
 {
 # Disarm all entities by converting & to &amp;
 
-  $string = str_replace('&', '&amp;', $string);
+    $string = str_replace('&', '&amp;', $string);
 
 # Change back the allowed entities in our entity whitelist
 
-  $string = preg_replace('/&amp;([A-Za-z][A-Za-z0-9]{0,19});/',
-                         '&\\1;', $string);
-  $string = preg_replace('/&amp;#0*([0-9]{1,5});/e',
-                         'kses_normalize_entities2("\\1")', $string);
-  $string = preg_replace('/&amp;#([Xx])0*(([0-9A-Fa-f]{2}){1,2});/',
-                         '&#\\1\\2;', $string);
+    $string = preg_replace('/&amp;([A-Za-z][A-Za-z0-9]{0,19});/',
+                            '&\\1;', $string);
+    $string = preg_replace('/&amp;#0*([0-9]{1,5});/e',
+                            'kses_normalize_entities2("\\1")', $string);
+    $string = preg_replace('/&amp;#([Xx])0*(([0-9A-Fa-f]{2}){1,2});/',
+                            '&#\\1\\2;', $string);
 
-  return $string;
+    return $string;
 } # function kses_normalize_entities
 
 
@@ -535,7 +535,7 @@ 
 # and nothing more for &#number; entities.
 ###############################################################################
 {
-  return (($i > 65535) ? "&amp;#$i;" : "&#$i;");
+    return (($i > 65535) ? "&amp;#$i;" : "&#$i;");
 } # function kses_normalize_entities2
 
 
@@ -546,11 +546,11 @@ 
 # URL protocol whitelisting system anyway.
 ###############################################################################
 {
-  $string = preg_replace('/&#([0-9]+);/e', 'chr("\\1")', $string);
-  $string = preg_replace('/&#[Xx]([0-9A-Fa-f]+);/e', 'chr(hexdec("\\1"))',
-                         $string);
+    $string = preg_replace('/&#([0-9]+);/e', 'chr("\\1")', $string);
+    $string = preg_replace('/&#[Xx]([0-9A-Fa-f]+);/e', 'chr(hexdec("\\1"))',
+                            $string);
 
-  return $string;
+    return $string;
 } # function kses_decode_entities
 
 ?>

Spacing +10 added lines, -15 removed lines

@@ -73,9 +73,9 @@ 
 # matches stray ">" characters.
 ###############################################################################
 {
-  return preg_replace('%(<'.   # EITHER: <
-                      '[^>]*'. # things that aren't >
-                      '(>|$)'. # > or end of string
+  return preg_replace('%(<'.# EITHER: <
+                      '[^>]*'.# things that aren't >
+                      '(>|$)'.# > or end of string
                       '|>)%e', # OR: just a >
                       "kses_split2('\\1', \$allowed_html, ".
                       '$allowed_protocols)',
@@ -228,8 +228,7 @@ 
         if (preg_match('/^\s+/', $attr)) # valueless
         {
           $working = 1; $mode = 0;
-          $attrarr[] = array
-                        ('name'  => $attrname,
+          $attrarr[] = array('name'  => $attrname,
                          'value' => '',
                          'whole' => $attrname,
                          'vless' => 'y');
@@ -245,8 +244,7 @@ 
         {
           $thisval = kses_bad_protocol($match[1], $allowed_protocols);
 
-          $attrarr[] = array
-                        ('name'  => $attrname,
+          $attrarr[] = array('name'  => $attrname,
                          'value' => $thisval,
                          'whole' => "$attrname=\"$thisval\"",
                          'vless' => 'n');
@@ -260,8 +258,7 @@ 
         {
           $thisval = kses_bad_protocol($match[1], $allowed_protocols);
 
-          $attrarr[] = array
-                        ('name'  => $attrname,
+          $attrarr[] = array('name'  => $attrname,
                          'value' => $thisval,
                          'whole' => "$attrname='$thisval'",
                          'vless' => 'n');
@@ -275,8 +272,7 @@ 
         {
           $thisval = kses_bad_protocol($match[1], $allowed_protocols);
 
-          $attrarr[] = array
-                        ('name'  => $attrname,
+          $attrarr[] = array('name'  => $attrname,
                          'value' => $thisval,
                          'whole' => "$attrname=\"$thisval\"",
                          'vless' => 'n');
@@ -298,8 +294,7 @@ 
   if ($mode == 1)
   # special case, for when the attribute list ends with a valueless
   # attribute like "selected"
-    $attrarr[] = array
-                  ('name'  => $attrname,
+    $attrarr[] = array('name'  => $attrname,
                    'value' => '',
                    'whole' => $attrname,
                    'vless' => 'y');
@@ -470,9 +465,9 @@ 
 ###############################################################################
 {
 	$string2 = preg_split('/:|&#58;|&#x3a;/i', $string, 2);
-	if(isset($string2[1]) && !preg_match('%/\?%',$string2[0]))
+	if (isset($string2[1]) && !preg_match('%/\?%', $string2[0]))
 	{
-		$string = kses_bad_protocol_once2($string2[0],$allowed_protocols).trim($string2[1]);
+		$string = kses_bad_protocol_once2($string2[0], $allowed_protocols).trim($string2[1]);
 	}
 	return $string;
 } # function kses_bad_protocol_once

Braces +90 added lines, -56 removed lines

@@ -93,24 +93,28 @@ 
 {
   $string = kses_stripslashes($string);
 
-  if (substr($string, 0, 1) != '<')
-    return '&gt;';
+  if (substr($string, 0, 1) != '<') {
+      return '&gt;';
+  }
     # It matched a ">" character
 
-  if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $string, $matches))
-    return '';
+  if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $string, $matches)) {
+      return '';
+  }
     # It's seriously malformed
 
   $slash = trim($matches[1]);
   $elem = $matches[2];
   $attrlist = $matches[3];
 
-  if (!@isset($allowed_html[strtolower($elem)]))
-    return '';
+  if (!@isset($allowed_html[strtolower($elem)])) {
+      return '';
+  }
     # They are using a not allowed HTML element
 
-  if ($slash != '')
-    return "<$slash$elem>";
+  if ($slash != '') {
+      return "<$slash$elem>";
+  }
   # No attributes are allowed for closing elements
 
   return kses_attr("$slash$elem", $attrlist, $allowed_html,
@@ -131,13 +135,15 @@ 
 # Is there a closing XHTML slash at the end of the attributes?
 
   $xhtml_slash = '';
-  if (preg_match('%\s/\s*$%', $attr))
-    $xhtml_slash = ' /';
+  if (preg_match('%\s/\s*$%', $attr)) {
+      $xhtml_slash = ' /';
+  }
 
 # Are any attributes allowed at all for this element?
 
-  if (@count($allowed_html[strtolower($element)]) == 0)
-    return "<$element$xhtml_slash>";
+  if (@count($allowed_html[strtolower($element)]) == 0) {
+      return "<$element$xhtml_slash>";
+  }
 
 # Split it
 
@@ -151,27 +157,34 @@ 
   foreach ($attrarr as $arreach)
   {
     if (!@isset($allowed_html[strtolower($element)]
-                            [strtolower($arreach['name'])]))
-      continue; # the attribute is not allowed
+                            [strtolower($arreach['name'])])) {
+          continue;
+    }
+    # the attribute is not allowed
 
     $current = $allowed_html[strtolower($element)]
                             [strtolower($arreach['name'])];
 
-    if (!is_array($current))
-      $attr2 .= ' '.$arreach['whole'];
+    if (!is_array($current)) {
+          $attr2 .= ' '.$arreach['whole'];
+    }
     # there are no checks
 
     else
     {
     # there are some checks
       $ok = true;
-      foreach ($current as $currkey => $currval)
-        if (!kses_check_attr_val($arreach['value'], $arreach['vless'],
+      foreach ($current as $currkey => $currval) {
+              if (!kses_check_attr_val($arreach['value'], $arreach['vless'],
                                  $currkey, $currval))
-        { $ok = false; break; }
-
-      if ($ok)
-        $attr2 .= ' '.$arreach['whole']; # it passed them
+        { $ok = false;
+      }
+      break; }
+
+      if ($ok) {
+              $attr2 .= ' '.$arreach['whole'];
+      }
+      # it passed them
     } # if !is_array($current)
   } # foreach
 
@@ -218,16 +231,22 @@ 
 
       case 1: # equals sign or valueless ("selected")
 
-        if (preg_match('/^\s*=\s*/', $attr)) # equals sign
+        if (preg_match('/^\s*=\s*/', $attr)) {
+            # equals sign
         {
-          $working = 1; $mode = 2;
+          $working = 1;
+        }
+        $mode = 2;
           $attr = preg_replace('/^\s*=\s*/', '', $attr);
           break;
         }
 
-        if (preg_match('/^\s+/', $attr)) # valueless
+        if (preg_match('/^\s+/', $attr)) {
+            # valueless
         {
-          $working = 1; $mode = 0;
+          $working = 1;
+        }
+        $mode = 0;
           $attrarr[] = array
                         ('name'  => $attrname,
                          'value' => '',
@@ -240,10 +259,11 @@ 
 
       case 2: # attribute value, a URL after href= for instance
 
-        if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match))
-         # "value"
+        if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match)) {
+                 # "value"
         {
           $thisval = kses_bad_protocol($match[1], $allowed_protocols);
+        }
 
           $attrarr[] = array
                         ('name'  => $attrname,
@@ -255,10 +275,11 @@ 
           break;
         }
 
-        if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match))
-         # 'value'
+        if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match)) {
+                 # 'value'
         {
           $thisval = kses_bad_protocol($match[1], $allowed_protocols);
+        }
 
           $attrarr[] = array
                         ('name'  => $attrname,
@@ -270,10 +291,11 @@ 
           break;
         }
 
-        if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match))
-         # value
+        if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match)) {
+                 # value
         {
           $thisval = kses_bad_protocol($match[1], $allowed_protocols);
+        }
 
           $attrarr[] = array
                         ('name'  => $attrname,
@@ -288,21 +310,24 @@ 
         break;
     } # switch
 
-    if ($working == 0) # not well formed, remove and try again
+    if ($working == 0) {
+        # not well formed, remove and try again
     {
       $attr = kses_html_error($attr);
+    }
       $mode = 0;
     }
   } # while
 
-  if ($mode == 1)
-  # special case, for when the attribute list ends with a valueless
+  if ($mode == 1) {
+    # special case, for when the attribute list ends with a valueless
   # attribute like "selected"
     $attrarr[] = array
                   ('name'  => $attrname,
                    'value' => '',
                    'whole' => $attrname,
                    'vless' => 'y');
+  }
 
   return $attrarr;
 } # function kses_hair
@@ -324,16 +349,18 @@ 
     # greater than the given value. This can be used to avoid Buffer Overflows
     # in WWW clients and various Internet servers.
 
-      if (strlen($value) > $checkvalue)
-        $ok = false;
+      if (strlen($value) > $checkvalue) {
+              $ok = false;
+      }
       break;
 
     case 'minlen':
     # The minlen check makes sure that the attribute value has a length not
     # smaller than the given value.
 
-      if (strlen($value) < $checkvalue)
-        $ok = false;
+      if (strlen($value) < $checkvalue) {
+              $ok = false;
+      }
       break;
 
     case 'maxval':
@@ -343,20 +370,24 @@ 
     # value is not greater than the given value.
     # This check can be used to avoid Denial of Service attacks.
 
-      if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
-        $ok = false;
-      if ($value > $checkvalue)
-        $ok = false;
+      if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value)) {
+              $ok = false;
+      }
+      if ($value > $checkvalue) {
+              $ok = false;
+      }
       break;
 
     case 'minval':
     # The minval check checks that the attribute value is a positive integer,
     # and that it is not smaller than the given value.
 
-      if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
-        $ok = false;
-      if ($value < $checkvalue)
-        $ok = false;
+      if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value)) {
+              $ok = false;
+      }
+      if ($value < $checkvalue) {
+              $ok = false;
+      }
       break;
 
     case 'valueless':
@@ -365,8 +396,9 @@ 
     # is a "y" or a "Y", the attribute must not have a value.
     # If the given value is an "n" or an "N", the attribute must have one.
 
-      if (strtolower($checkvalue) != $vless)
-        $ok = false;
+      if (strtolower($checkvalue) != $vless) {
+              $ok = false;
+      }
       break;
   } # switch
 
@@ -492,18 +524,20 @@ 
   $string2 = strtolower($string2);
 
   $allowed = false;
-  foreach ($allowed_protocols as $one_protocol)
-    if (strtolower($one_protocol) == $string2)
+  foreach ($allowed_protocols as $one_protocol) {
+      if (strtolower($one_protocol) == $string2)
     {
       $allowed = true;
+  }
       break;
     }
 
-  if ($allowed)
-    return "$string2:";
-  else
-    return '';
-} # function kses_bad_protocol_once2
+  if ($allowed) {
+      return "$string2:";
+  } else {
+      return '';
+  }
+  } # function kses_bad_protocol_once2
 
 
 function kses_normalize_entities($string)