GetId3\Write\Vorbiscomment Class Reference

GetId3() by James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g //. More...

Collaboration diagram for GetId3\Write\Vorbiscomment:

Public Member Functions
	__construct ()
	WriteVorbisComment ()
	DeleteVorbisComment ()
	CleanVorbisCommentName ($originalcommentname)

Data Fields
	$filename
	$tag_data
	$warnings = array()
	$errors = array()

Detailed Description

GetId3() by James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g //.

module for writing VorbisComment tags

Author

James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g http://www.getid3.org helperapps/vorbiscomment.exe

Definition at line 29 of file Vorbiscomment.php.

Constructor & Destructor Documentation

__construct()

GetId3\Write\Vorbiscomment::__construct

(

)

Returns

boolean

Definition at line 49 of file Vorbiscomment.php.

    {
        return true;
    }

Member Function Documentation

CleanVorbisCommentName()

GetId3\Write\Vorbiscomment::CleanVorbisCommentName

(

$originalcommentname

)

Parameters

type

$originalcommentname

Returns

type

Definition at line 150 of file Vorbiscomment.php.

    {
        // 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
        // 0x7A inclusive (a-z).
 
        // replace invalid chars with a space, return uppercase text
        // Thanks Chris Bolt <chris-getid3Øbolt*cx> for improving this function
        // note: *reg_replace() replaces nulls with empty string (not space)
        return strtoupper(preg_replace('#[^ -<>-}]#', ' ', str_replace("\x00", ' ', $originalcommentname)));
 
    }

Referenced by GetId3\Write\Vorbiscomment\WriteVorbisComment().

Here is the caller graph for this function:

DeleteVorbisComment()

GetId3\Write\Vorbiscomment::DeleteVorbisComment

(

)

Returns

type

Definition at line 138 of file Vorbiscomment.php.

    {
        $this->tag_data = array(array());
 
        return $this->WriteVorbisComment();
    }

References GetId3\Write\Vorbiscomment\WriteVorbisComment().

Here is the call graph for this function:

WriteVorbisComment()

GetId3\Write\Vorbiscomment::WriteVorbisComment

(

)

Returns

boolean

Definition at line 58 of file Vorbiscomment.php.

    {
        if (preg_match('#(1|ON)#i', ini_get('safe_mode'))) {
            $this->errors[] = 'PHP running in Safe Mode (backtick operator not available) - cannot call vorbiscomment, tags not written';
 
            return false;
        }
 
        // Create file with new comments
        $tempcommentsfilename = tempnam(GetId3Core::getTempDir(), 'getID3');
        if (is_writable($tempcommentsfilename) && is_file($tempcommentsfilename) && ($fpcomments = fopen($tempcommentsfilename, 'wb'))) {
 
            foreach ($this->tag_data as $key => $value) {
                foreach ($value as $commentdata) {
                    fwrite($fpcomments, $this->CleanVorbisCommentName($key).'='.$commentdata."\n");
                }
            }
            fclose($fpcomments);
 
        } else {
            $this->errors[] = 'failed to open temporary tags file "'.$tempcommentsfilename.'", tags not written';
 
            return false;
        }
 
        $oldignoreuserabort = ignore_user_abort(true);
        if (GetId3Core::environmentIsWindows()) {
 
            if (file_exists(GetId3Core::getHelperAppsDir().'vorbiscomment.exe')) {
                //$commandline = '"'.GetId3Core::getHelperAppsDir().'vorbiscomment.exe" -w --raw -c "'.$tempcommentsfilename.'" "'.str_replace('/', '\\', $this->filename).'"';
                //  vorbiscomment works fine if you copy-paste the above commandline into a command prompt,
                //  but refuses to work with `backtick` if there are "doublequotes" present around BOTH
                //  the metaflac pathname and the target filename. For whatever reason...??
                //  The solution is simply ensure that the metaflac pathname has no spaces,
                //  and therefore does not need to be quoted
 
                // On top of that, if error messages are not always captured properly under Windows
                // To at least see if there was a problem, compare file modification timestamps before and after writing
                clearstatcache();
                $timestampbeforewriting = filemtime($this->filename);
 
                $commandline = GetId3Core::getHelperAppsDir().'vorbiscomment.exe -w --raw -c "'.$tempcommentsfilename.'" "'.$this->filename.'" 2>&1';
                $VorbiscommentError = `$commandline`;
 
                if (empty($VorbiscommentError)) {
                    clearstatcache();
                    if ($timestampbeforewriting == filemtime($this->filename)) {
                        $VorbiscommentError = 'File modification timestamp has not changed - it looks like the tags were not written';
                    }
                }
            } else {
                $VorbiscommentError = 'vorbiscomment.exe not found in '.GetId3Core::getHelperAppsDir();
            }
 
        } else {
 
            $commandline = 'vorbiscomment -w --raw -c "'.$tempcommentsfilename.'" "'.$this->filename.'" 2>&1';
            $VorbiscommentError = `$commandline`;
 
        }
 
        // Remove temporary comments file
        unlink($tempcommentsfilename);
        ignore_user_abort($oldignoreuserabort);
 
        if (!empty($VorbiscommentError)) {
 
            $this->errors[] = 'system call to vorbiscomment failed with message: '."\n\n".$VorbiscommentError;
 
            return false;
 
        }
 
        return true;
    }

References GetId3\Write\Vorbiscomment\CleanVorbisCommentName(), GetId3\GetId3Core\environmentIsWindows(), GetId3\GetId3Core\getHelperAppsDir(), and GetId3\GetId3Core\getTempDir().

Referenced by GetId3\Write\Vorbiscomment\DeleteVorbisComment().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$errors

GetId3\Write\Vorbiscomment::$errors = array()

Definition at line 43 of file Vorbiscomment.php.

$filename

GetId3\Write\Vorbiscomment::$filename

Definition at line 32 of file Vorbiscomment.php.

$tag_data

GetId3\Write\Vorbiscomment::$tag_data

Definition at line 33 of file Vorbiscomment.php.

$warnings

GetId3\Write\Vorbiscomment::$warnings = array()

Definition at line 38 of file Vorbiscomment.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phansys/getid3/GetId3/Write/Vorbiscomment.php