GetId3\Extension\Cache\Dbm Class Reference

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

Inheritance diagram for GetId3\Extension\Cache\Dbm:

Collaboration diagram for GetId3\Extension\Cache\Dbm:

Public Member Functions
	__construct ($cache_type, $dbm_filename, $lock_filename)
	public: constructor - see top of this file for cache type and cache_options More...
	__destruct ()
	clear_cache ()
	clear cache More...
	analyze ($filename)
	analyze file More...
Public Member Functions inherited from GetId3\GetId3Core
	__construct ()
	public: constructor More...
	version ()
	fread_buffer_size ()
	setOption ($optArray)
	public: setOption More...
	openfile ($filename)
	analyze ($filename)
	public: analyze file More...
	GetFileFormatArray ()
	array $format_info More...
	GetFileFormat (&$filedata, $filename='')
	CharConvert (&$array, $encoding)
	HandleAllTags ()
	array $tags More...
	getHashdata ($algorithm)
	ChannelsBitratePlaytimeCalculations ()
	CalculateCompressionRatioVideo ()
	CalculateCompressionRatioAudio ()
	CalculateReplayGain ()
	ProcessAudioStreams ()
	GetId3_tempnam ()

Additional Inherited Members
Static Public Member Functions inherited from GetId3\GetId3Core
static	getHelperAppsDir ()
static	getTempDir ()
static	environmentIsWindows ()
static	getIncludePath ()
Data Fields inherited from GetId3\GetId3Core
	$encoding = 'UTF-8'
	$encoding_id3v1 = 'ISO-8859-1'
	$option_tag_id3v1 = true
	$option_tag_id3v2 = true
	$option_tag_lyrics3 = true
	$option_tag_apetag = true
	$option_tags_process = true
	$option_tags_html = true
	$option_extra_info = true
	$option_save_attachments = true
	$option_md5_data = false
	$option_md5_data_source = false
	$option_sha1_data = false
	$option_max_2gb_check = null
	$option_fread_buffer_size = 32768
	$filename
	$fp
	$info
	$tempdir
const	VERSION = '1.9.4-20120530'
const	FREAD_BUFFER_SIZE = 32768
const	ATTACHMENTS_NONE = false
const	ATTACHMENTS_INLINE = true
Protected Member Functions inherited from GetId3\GetId3Core
	setHelperAppsDir ()
Protected Attributes inherited from GetId3\GetId3Core
	$startup_error = ''
	$startup_warning = ''
	$memory_limit = 0
Static Protected Attributes inherited from GetId3\GetId3Core
static	$TempDir
static	$IncludePath
static	$EnvironmentIsWindows
static	$HelperAppsDir

Detailed Description

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

This is a caching extension for GetId3(). It works the exact same way as the GetId3 class, but return cached information very fast

Example:

Normal GetId3 usage (example):

require_once 'getid3/getid3.php'; $getID3 = new GetId3; $getID3->encoding = 'UTF-8'; $info1 = $getID3->analyze('file1.flac'); $info2 = $getID3->analyze('file2.wv');

GetId3_cached usage:

require_once 'getid3/getid3.php'; require_once 'getid3/getid3/extension.cache.dbm.php'; $getID3 = new GetId3_cached('db3', '/tmp/getid3_cache.dbm', '/tmp/getid3_cache.lock'); $getID3->encoding = 'UTF-8'; $info1 = $getID3->analyze('file1.flac'); $info2 = $getID3->analyze('file2.wv');

Supported Cache Types

SQL Databases: (use extension.cache.mysql)

cache_type cache_options

mysql host, database, username, password

DBM-Style Databases: (this extension)

cache_type cache_options

gdbm dbm_filename, lock_filename ndbm dbm_filename, lock_filename db2 dbm_filename, lock_filename db3 dbm_filename, lock_filename db4 dbm_filename, lock_filename (PHP5 required)

PHP must have write access to both dbm_filename and lock_filename.

Recommended Cache Types

Infrequent updates, many reads any DBM Frequent updates mysql

Author

James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g

Allan Hansen <ahØartemis*dk> http://www.getid3.org

Definition at line 83 of file Dbm.php.

Constructor & Destructor Documentation

__construct()

GetId3\Extension\Cache\Dbm::__construct	(		$cache_type,
			$dbm_filename,
			$lock_filename
	)

public: constructor - see top of this file for cache type and cache_options

Parameters

type	$cache_type
type	$dbm_filename
type	$lock_filename

Exceptions

Exception

Definition at line 94 of file Dbm.php.

References array, GetId3\Extension\Cache\Dbm\clear_cache(), and GetId3\GetId3Core\VERSION.

    {
        // Check for dba extension
        if (!extension_loaded('dba')) {
            throw new DefaultException('PHP is not compiled with dba support, required to use DBM style cache.');
        }

        // Check for specific dba driver
        if (!function_exists('dba_handlers') || !in_array($cache_type, dba_handlers())) {
            throw new DefaultException('PHP is not compiled --with '.$cache_type.' support, required to use DBM style cache.');
        }

        // Create lock file if needed
        if (!file_exists($lock_filename)) {
            if (!touch($lock_filename)) {
                throw new DefaultException('failed to create lock file: '.$lock_filename);
            }
        }

        // Open lock file for writing
        if (!is_writeable($lock_filename)) {
            throw new DefaultException('lock file: '.$lock_filename.' is not writable');
        }
        $this->lock = fopen($lock_filename, 'w');

        // Acquire exclusive write lock to lock file
        flock($this->lock, LOCK_EX);

        // Create dbm-file if needed
        if (!file_exists($dbm_filename)) {
            if (!touch($dbm_filename)) {
                throw new DefaultException('failed to create dbm file: '.$dbm_filename);
            }
        }

        // Try to open dbm file for writing
        $this->dba = dba_open($dbm_filename, 'w', $cache_type);
        if (!$this->dba) {

            // Failed - create new dbm file
            $this->dba = dba_open($dbm_filename, 'n', $cache_type);

            if (!$this->dba) {
                throw new DefaultException('failed to create dbm file: '.$dbm_filename);
            }

            // Insert GetId3 version number
            dba_insert(GetId3Core::VERSION, GetId3Core::VERSION, $this->dba);
        }

        // Init misc values
        $this->cache_type   = $cache_type;
        $this->dbm_filename = $dbm_filename;

        // Register destructor
        register_shutdown_function(array($this, '__destruct'));

        // Check version number and clear cache if changed
        if (dba_fetch(GetId3Core::VERSION, $this->dba) != GetId3Core::VERSION) {
            $this->clear_cache();
        }

        parent::__construct();
    }

Here is the call graph for this function:

__destruct()

GetId3\Extension\Cache\Dbm::__destruct

(

)

Definition at line 162 of file Dbm.php.

    {
        // Close dbm file
        dba_close($this->dba);

        // Release exclusive lock
        flock($this->lock, LOCK_UN);

        // Close lock file
        fclose($this->lock);
    }

Member Function Documentation

analyze()

GetId3\Extension\Cache\Dbm::analyze

(

$filename

)

analyze file

Parameters

type

$filename

Returns

type

Definition at line 204 of file Dbm.php.

References GetId3\GetId3Core\$filename, and $result.

    {
        if (file_exists($filename)) {

            // Calc key     filename::mod_time::size    - should be unique
            $key = $filename.'::'.filemtime($filename).'::'.filesize($filename);

            // Loopup key
            $result = dba_fetch($key, $this->dba);

            // Hit
            if ($result !== false) {
                return unserialize($result);
            }
        }

        // Miss
        $result = parent::analyze($filename);

        // Save result
        if (file_exists($filename)) {
            dba_insert($key, serialize($result), $this->dba);
        }

        return $result;
    }

clear_cache()

GetId3\Extension\Cache\Dbm::clear_cache

(

)

clear cache

Exceptions

Exception

Definition at line 179 of file Dbm.php.

References array, and GetId3\GetId3Core\VERSION.

Referenced by GetId3\Extension\Cache\Dbm\__construct().

    {
        // Close dbm file
        dba_close($this->dba);

        // Create new dbm file
        $this->dba = dba_open($this->dbm_filename, 'n', $this->cache_type);

        if (!$this->dba) {
            throw new DefaultException('failed to clear cache/recreate dbm file: '.$this->dbm_filename);
        }

        // Insert GetId3 version number
        dba_insert(GetId3Core::VERSION, GetId3Core::VERSION, $this->dba);

        // Re-register shutdown function
        register_shutdown_function(array($this, '__destruct'));
    }

Here is the caller graph for this function:

---

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

• libs/composer/vendor/phansys/getid3/GetId3/Extension/Cache/Dbm.php