summaryrefslogtreecommitdiffstats
path: root/lib/class/vainfo.class.php
diff options
context:
space:
mode:
authormomo-i <webmaster@momo-i.org>2011-02-03 11:56:48 +0900
committermomo-i <webmaster@momo-i.org>2011-02-03 11:56:48 +0900
commit7ef24e84c6986a07be5144df4b67186f78f99d61 (patch)
tree04e158de0d5c4b990829dffe11554aded39de00c /lib/class/vainfo.class.php
parenta5dc82f7d305087fae7a584185916a8b548887ec (diff)
downloadampache-7ef24e84c6986a07be5144df4b67186f78f99d61.tar.gz
ampache-7ef24e84c6986a07be5144df4b67186f78f99d61.tar.bz2
ampache-7ef24e84c6986a07be5144df4b67186f78f99d61.zip
Updated a few informations of function.
Diffstat (limited to 'lib/class/vainfo.class.php')
-rw-r--r--lib/class/vainfo.class.php100
1 files changed, 93 insertions, 7 deletions
diff --git a/lib/class/vainfo.class.php b/lib/class/vainfo.class.php
index 20bb1471..bd3b6d31 100644
--- a/lib/class/vainfo.class.php
+++ b/lib/class/vainfo.class.php
@@ -48,31 +48,117 @@
*/
class vainfo {
- /* Default Encoding */
+ // {{{ property
+
+ /**
+ * Default encoding
+ *
+ * @var string
+ */
public $encoding = '';
+
+ /**
+ * Default id3v1 encoding
+ *
+ * @var string
+ */
public $encoding_id3v1 = 'ISO-8859-1';
/* Loaded Variables */
+ /**
+ * Filename
+ *
+ * @var string
+ */
public $filename = '';
+
+ /**
+ * Media type
+ *
+ * @var string
+ */
public $type = '';
+
+ /**
+ * Media tags
+ *
+ * @var array
+ */
public $tags = array();
/* Internal Information */
- public $_raw = array();
- public $_getID3 = '';
- public $_iconv = false;
- public $_file_encoding = '';
- public $_file_pattern = '';
- public $_dir_pattern = '';
+ /**
+ * GetID3 analyzed data.
+ *
+ * @var array
+ */
+ protected $_raw = array();
+
+ /**
+ * GetID3 object
+ *
+ * @var object
+ */
+ protected $_getID3 = '';
+
+ /**
+ * Iconv use flag
+ *
+ * @var boolean
+ */
+ protected $_iconv = false;
+
+ /**
+ * File encoding charset
+ *
+ * @var string
+ */
+ protected $_file_encoding = '';
+
+ /**
+ * File pattern
+ *
+ * @var string
+ */
+ protected $_file_pattern = '';
+
+ /**
+ * Directory pattern
+ *
+ * @var string
+ */
+ protected $_dir_pattern = '';
/* Internal Private */
+ /**
+ * Pathinfo results array
+ *
+ * @var array
+ */
private $_pathinfo;
+
+ /**
+ * Tag broken flag. If tag is broken, return true.
+ *
+ * @var boolean
+ */
private $_broken = false;
+ // }}}
+
/**
* Constructor
+ *
* This function just sets up the class, it doesn't
* actually pull the information
+ *
+ * @param string $file filename
+ * @param string $encoding Default encode character set
+ * @param string $encoding_id3v1 Default id3v1 encode character set
+ * @param string $encoding_iv3v2 Default id3v2 encode character set
+ * @param string $dir_pattern Directory pattern
+ * @param string $file_pattern File pattern
+ * @return mixed If can't analyze file, return false. default return: void
*/
public function __construct($file, $encoding = null, $encoding_id3v1 = null, $encoding_id3v2 = null, $dir_pattern, $file_pattern) {