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

Inheritance diagram for getID3_cached_dbm:

Collaboration diagram for getID3_cached_dbm:

Public Member Functions
	__construct ($cache_type, $dbm_filename, $lock_filename)

	__destruct ()

	clear_cache ()

	analyze ($filename)

Public Member Functions inherited from getID3
	__construct ()

	version ()

	fread_buffer_size ()

	setOption ($optArray)

	openfile ($filename, $filesize=null)

	analyze ($filename, $filesize=null, $original_filename='')

	error ($message)

	warning ($message)

	GetFileFormatArray ()

	GetFileFormat (&$filedata, $filename='')

	CharConvert (&$array, $encoding)

	HandleAllTags ()

	getHashdata ($algorithm)

	ChannelsBitratePlaytimeCalculations ()

	CalculateCompressionRatioVideo ()

	CalculateCompressionRatioAudio ()

	CalculateReplayGain ()

	ProcessAudioStreams ()

	getid3_tempnam ()

	include_module ($name)

Additional Inherited Members
Data Fields inherited from getID3
	$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 = GETID3_TEMP_DIR

	$memory_limit = 0

const	VERSION = '1.9.14-201703261440'

const	FREAD_BUFFER_SIZE = 32768

const	ATTACHMENTS_NONE = false

const	ATTACHMENTS_INLINE = true

Protected Attributes inherited from getID3
	$startup_error = ''

	$startup_warning = ''

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

Definition at line 73 of file extension.cache.dbm.php.

Constructor & Destructor Documentation

◆ __construct()

getID3_cached_dbm::__construct	(	$cache_type,
		$dbm_filename,
		$lock_filename
	)

Definition at line 77 of file extension.cache.dbm.php.

References clear_cache(), and getID3\VERSION.

                                                                                 {
 
                 // Check for dba extension
                 if (!extension_loaded('dba')) {
                         throw new Exception('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 Exception('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 Exception('failed to create lock file: '.$lock_filename);
                         }
                 }
 
                 // Open lock file for writing
                 if (!is_writeable($lock_filename)) {
                         throw new Exception('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 Exception('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 Exception('failed to create dbm file: '.$dbm_filename);
                         }
 
                         // Insert getID3 version number
                         dba_insert(getID3::VERSION, getID3::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(getID3::VERSION, $this->dba) != getID3::VERSION) {
                         $this->clear_cache();
                 }
 
                 parent::__construct();
         }

Here is the call graph for this function:

◆ __destruct()

getID3_cached_dbm::__destruct ( )

Definition at line 145 of file extension.cache.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_cached_dbm::analyze ( $filename )

Definition at line 182 of file extension.cache.dbm.php.

References getID3\$filename, $key, 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_cached_dbm::clear_cache ( )

Definition at line 160 of file extension.cache.dbm.php.

References getID3\VERSION.

Referenced by __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 Exception('failed to clear cache/recreate dbm file: '.$this->dbm_filename);
                 }
 
                 // Insert getID3 version number
                 dba_insert(getID3::VERSION, getID3::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/james-heinrich/getid3/getid3/extension.cache.dbm.php

Public Member Functions

Additional Inherited Members

Detailed Description

cache_type cache_options

cache_type cache_options

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ analyze()

◆ clear_cache()