[SPIP] v3.2.1-->v3.2.3
[lhc/web/www.git] / www / plugins-dist / medias / lib / getid3 / write.vorbiscomment.php
index 971f91f..5f89868 100644 (file)
@@ -1,11 +1,12 @@
 <?php
+
 /////////////////////////////////////////////////////////////////
 /// getID3() by James Heinrich <info@getid3.org>               //
-//  available at http://getid3.sourceforge.net                 //
-//            or http://www.getid3.org                         //
-//          also https://github.com/JamesHeinrich/getID3       //
+//  available at https://github.com/JamesHeinrich/getID3       //
+//            or https://www.getid3.org                        //
+//            or http://getid3.sourceforge.net                 //
 /////////////////////////////////////////////////////////////////
-// See readme.txt for more details                             //
+//  see readme.txt for more details                            //
 /////////////////////////////////////////////////////////////////
 //                                                             //
 // write.vorbiscomment.php                                     //
 
 class getid3_write_vorbiscomment
 {
-
+       /**
+        * @var string
+        */
        public $filename;
+
+       /**
+        * @var array
+        */
        public $tag_data;
-       public $warnings = array(); // any non-critical errors will be stored here
-       public $errors   = array(); // any critical errors will be stored here
+
+       /**
+        * Any non-critical errors will be stored here.
+        *
+        * @var array
+        */
+       public $warnings = array();
+
+       /**
+        * Any critical errors will be stored here.
+        *
+        * @var array
+        */
+       public $errors   = array();
 
        public function __construct() {
-               return true;
        }
 
+       /**
+        * @return bool
+        */
        public function WriteVorbisComment() {
 
                if (preg_match('#(1|ON)#i', ini_get('safe_mode'))) {
@@ -36,7 +57,7 @@ class getid3_write_vorbiscomment
 
                // Create file with new comments
                $tempcommentsfilename = tempnam(GETID3_TEMP_DIR, 'getID3');
-               if (is_writable($tempcommentsfilename) && is_file($tempcommentsfilename) && ($fpcomments = fopen($tempcommentsfilename, 'wb'))) {
+               if (getID3::is_writable($tempcommentsfilename) && is_file($tempcommentsfilename) && ($fpcomments = fopen($tempcommentsfilename, 'wb'))) {
 
                        foreach ($this->tag_data as $key => $value) {
                                foreach ($value as $commentdata) {
@@ -100,11 +121,19 @@ class getid3_write_vorbiscomment
                return true;
        }
 
+       /**
+        * @return bool
+        */
        public function DeleteVorbisComment() {
                $this->tag_data = array(array());
                return $this->WriteVorbisComment();
        }
 
+       /**
+        * @param string $originalcommentname
+        *
+        * @return string
+        */
        public function CleanVorbisCommentName($originalcommentname) {
                // A case-insensitive field name that may consist of ASCII 0x20 through 0x7D, 0x3D ('=') excluded.
                // ASCII 0x41 through 0x5A inclusive (A-Z) is to be considered equivalent to ASCII 0x61 through