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

Inheritance diagram for getID3_cached_sqlite3:

Collaboration diagram for getID3_cached_sqlite3:

Public Member Functions
	__construct ($table='getid3_cache', $hide=false)
	__construct() More...

	__destruct ()
	close the database connection More...

	analyze ($filename, $filesize=null, $original_filename='')
	analyze file and cache them, if cached pull from the db More...

	get_cached_dir ($dir)
	get cached directory More...

	__get ($name)
	use the magical __get() for sql queries More...

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)

Private Member Functions
	clear_cache ()
	clear the cache private More...

	create_table ()
	create data base table this is almost the same as MySQL, with the exception of the dirname being added More...

Private Attributes
	$db

	$table
	table to use for caching More...

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 much faster

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/extension.cache.sqlite3.php'; // all parameters are optional, defaults are: $getID3 = new getID3_cached_sqlite3($table='getid3_cache', $hide=FALSE); $getID3->encoding = 'UTF-8'; $info1 = $getID3->analyze('file1.flac'); $info2 = $getID3->analyze('file2.wv');

Supported Cache Types (this extension)

SQL Databases:

cache_type cache_options

mysql host, database, username, password

sqlite3 table='getid3_cache', hide=false (PHP5)

*** database file will be stored in the same directory as this script, *** webserver must have write access to that directory! *** set $hide to TRUE to prefix db file with .ht to pervent access from web client *** this is a default setting in the Apache configuration:

The following lines prevent .htaccess and .htpasswd files from being viewed by Web clients.

<Files ~ "^\.ht"> Order allow,deny Deny from all Satisfy all </Files>

DBM-Style Databases: (use extension.cache.dbm)

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

IMHO this is still a bit slow, I'm using this with MP4/MOV/ M4v files there is a plan to add directory scanning and analyzing to make things work much faster

Definition at line 92 of file extension.cache.sqlite3.php.

Constructor & Destructor Documentation

◆ __construct()

getID3_cached_sqlite3::__construct	(	$table = `'getid3_cache'`,
		$hide = `false`
	)

__construct()

Parameters

string $table holds name of sqlite table

Returns: type

Definition at line 99 of file extension.cache.sqlite3.php.

References $db, $file, $result, $table, $version, clear_cache(), create_table(), and getID3\VERSION.

                                                                         {
                 $this->table = $table; // Set table
                 $file = dirname(__FILE__).'/'.basename(__FILE__, 'php').'sqlite';
                 if ($hide) {
                         $file = dirname(__FILE__).'/.ht.'.basename(__FILE__, 'php').'sqlite';
                 }
                 $this->db = new SQLite3($file);
                 $db = $this->db;
                 $this->create_table();   // Create cache table if not exists
                 $version = '';
                 $sql = $this->version_check;
                 $stmt = $db->prepare($sql);
                 $stmt->bindValue(':filename', getID3::VERSION, SQLITE3_TEXT);
                 $result = $stmt->execute();
                 list($version) = $result->fetchArray();
                 if ($version != getID3::VERSION) { // Check version number and clear cache if changed
                         $this->clear_cache();
                 }
                 return parent::__construct();
         }

Here is the call graph for this function:

◆ __destruct()

getID3_cached_sqlite3::__destruct ( )

close the database connection

Definition at line 123 of file extension.cache.sqlite3.php.

References $db.

                                      {
                 $db=$this->db;
                 $db->close();
         }

Member Function Documentation

◆ __get()

getID3_cached_sqlite3::__get ( $name )

use the magical __get() for sql queries

access as easy as $this->{case name}, returns NULL if query is not found

Definition at line 238 of file extension.cache.sqlite3.php.

References $name.

                                      {
                 switch($name) {
                         case 'version_check':
                                 return "SELECT val FROM $this->table WHERE filename = :filename AND filesize = '-1' AND filetime = '-1' AND analyzetime = '-1'";
                                 break;
                         case 'delete_cache':
                                 return "DELETE FROM $this->table";
                                 break;
                         case 'set_version':
                                 return "INSERT INTO $this->table (filename, dirname, filesize, filetime, analyzetime, val) VALUES (:filename, :dirname, -1, -1, -1, :val)";
                                 break;
                         case 'get_id3_data':
                                 return "SELECT val FROM $this->table WHERE filename = :filename AND filesize = :filesize AND filetime = :filetime";
                                 break;
                         case 'cache_file':
                                 return "INSERT INTO $this->table (filename, dirname, filesize, filetime, analyzetime, val) VALUES (:filename, :dirname, :filesize, :filetime, :atime, :val)";
                                 break;
                         case 'make_table':
                                 //return "CREATE TABLE IF NOT EXISTS $this->table (filename VARCHAR(255) NOT NULL DEFAULT '', dirname VARCHAR(255) NOT NULL DEFAULT '', filesize INT(11) NOT NULL DEFAULT '0', filetime INT(11) NOT NULL DEFAULT '0', analyzetime INT(11) NOT NULL DEFAULT '0', val text not null, PRIMARY KEY (filename, filesize, filetime))";
                                 return "CREATE TABLE IF NOT EXISTS $this->table (filename VARCHAR(255) DEFAULT '', dirname VARCHAR(255) DEFAULT '', filesize INT(11) DEFAULT '0', filetime INT(11) DEFAULT '0', analyzetime INT(11) DEFAULT '0', val text, PRIMARY KEY (filename, filesize, filetime))";
                                 break;
                         case 'get_cached_dir':
                                 return "SELECT val FROM $this->table WHERE dirname = :dirname";
                                 break;
                 }
                 return null;
         }

◆ analyze()

getID3_cached_sqlite3::analyze	(	$filename,
		$filesize = `null`,
		$original_filename = `''`
	)

analyze file and cache them, if cached pull from the db

Parameters

type $filename

Returns: boolean

Definition at line 162 of file extension.cache.sqlite3.php.

References $db, getID3\$filename, $res, $result, and time.

                                                                                   {
                 if (!file_exists($filename)) {
                         return false;
                 }
                 // items to track for caching
                 $filetime = filemtime($filename);
                 $filesize_real = filesize($filename);
                 // this will be saved for a quick directory lookup of analized files
                 // ... why do 50 seperate sql quries when you can do 1 for the same result
                 $dirname  = dirname($filename);
                 // Lookup file
                 $db = $this->db;
                 $sql = $this->get_id3_data;
                 $stmt = $db->prepare($sql);
                 $stmt->bindValue(':filename', $filename,      SQLITE3_TEXT);
                 $stmt->bindValue(':filesize', $filesize_real, SQLITE3_INTEGER);
                 $stmt->bindValue(':filetime', $filetime,      SQLITE3_INTEGER);
                 $res = $stmt->execute();
                 list($result) = $res->fetchArray();
                 if (count($result) > 0 ) {
                         return unserialize(base64_decode($result));
                 }
                 // if it hasn't been analyzed before, then do it now
                 $analysis = parent::analyze($filename, $filesize, $original_filename);
                 // Save result
                 $sql = $this->cache_file;
                 $stmt = $db->prepare($sql);
                 $stmt->bindValue(':filename', $filename,                           SQLITE3_TEXT);
                 $stmt->bindValue(':dirname',  $dirname,                            SQLITE3_TEXT);
                 $stmt->bindValue(':filesize', $filesize_real,                      SQLITE3_INTEGER);
                 $stmt->bindValue(':filetime', $filetime,                           SQLITE3_INTEGER);
                 $stmt->bindValue(':atime',    time(),                              SQLITE3_INTEGER);
                 $stmt->bindValue(':val',      base64_encode(serialize($analysis)), SQLITE3_TEXT);
                 $res = $stmt->execute();
                 return $analysis;
         }

◆ clear_cache()

getID3_cached_sqlite3::clear_cache ( )

private

clear the cache private

Returns: type

Definition at line 145 of file extension.cache.sqlite3.php.

References $db, and getID3\VERSION.

Referenced by __construct().

                                        {
                 $db = $this->db;
                 $sql = $this->delete_cache;
                 $db->exec($sql);
                 $sql = $this->set_version;
                 $stmt = $db->prepare($sql);
                 $stmt->bindValue(':filename', getID3::VERSION, SQLITE3_TEXT);
                 $stmt->bindValue(':dirname', getID3::VERSION, SQLITE3_TEXT);
                 $stmt->bindValue(':val', getID3::VERSION, SQLITE3_TEXT);
                 return $stmt->execute();
         }

Here is the caller graph for this function:

◆ create_table()

getID3_cached_sqlite3::create_table ( )

private

create data base table this is almost the same as MySQL, with the exception of the dirname being added

Returns: type

Definition at line 204 of file extension.cache.sqlite3.php.

References $db.

Referenced by __construct().

                                         {
                 $db = $this->db;
                 $sql = $this->make_table;
                 return $db->exec($sql);
         }

Here is the caller graph for this function:

◆ get_cached_dir()

getID3_cached_sqlite3::get_cached_dir ( $dir )

get cached directory

This function is not in the MySQL extention, it's ment to speed up requesting multiple files which is ideal for podcasting, playlists, etc.

public

Parameters

string $dir directory to search the cache database for

Returns: array return an array of matching id3 data

Definition at line 220 of file extension.cache.sqlite3.php.

References $db, $res, $row, $rows, and array.

                                              {
                 $db = $this->db;
                 $rows = array();
                 $sql = $this->get_cached_dir;
                 $stmt = $db->prepare($sql);
                 $stmt->bindValue(':dirname', $dir, SQLITE3_TEXT);
                 $res = $stmt->execute();
                 while ($row=$res->fetchArray()) {
                         $rows[] = unserialize(base64_decode($row));
                 }
                 return $rows;
         }

Field Documentation

◆ $db

getID3_cached_sqlite3::$db

private

Definition at line 132 of file extension.cache.sqlite3.php.

Referenced by __construct(), __destruct(), analyze(), clear_cache(), create_table(), and get_cached_dir().

◆ $table

string getID3_cached_sqlite3::$table

private

table to use for caching

Definition at line 138 of file extension.cache.sqlite3.php.

Referenced by __construct().

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

libs/composer/vendor/james-heinrich/getid3/getid3/extension.cache.sqlite3.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

cache_type cache_options

cache_type cache_options

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __get()

◆ analyze()

◆ clear_cache()

◆ create_table()

◆ get_cached_dir()

Field Documentation

◆ $db

◆ $table