Class ID3_Frame_GEOB

Description
Description | Vars | Methods (details) Constants

Implements interfaces:

In the General encapsulated object frame any type of file can be encapsulated.

Located in /ID3/Frame/GEOB.php (line 55) 

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_GEOB
Method Summary
Description | Constants Vars | Methods (details)
ID3_Frame_GEOB __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string getDescription ()
integer getEncoding ()
string getFilename ()
string getMimeType ()
string getObjectData ()
void setDescription (string $description, [integer $encoding = false])
void setEncoding (integer $encoding)
void setFilename ( $filename, [integer $encoding = false], string $description)
void setMimeType (string $mimeType)
void setObjectData (string $objectData)
string __toString ()
Variables
Description | Vars (details) Constants | Methods (details)

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader
Methods
Description | Vars Constants Methods (details)
Constructor __construct (line 79)

Constructs the class with given parameters and parses object related data.

  • access: public
ID3_Frame_GEOB __construct ([Reader $reader = null], [ &$options = array()], Array $options)
  • Reader $reader: The reader object.
  • Array $options: The options array.
  • &$options
Redefinition of:
ID3_Frame::__construct()
Constructs the class with given parameters and reads object related data from the ID3v2 tag.
getDescription (line 167)

Returns the file description.

  • access: public
string getDescription ()
getEncoding (line 117)

Returns the text encoding.

  • access: public
integer getEncoding ()
Implementation of:
ID3_Encoding::getEncoding()
Returns the text encoding.
getFilename (line 146)

Returns the file name.

  • access: public
string getFilename ()
getMimeType (line 132)

Returns the MIME type. The MIME type is always encoded with ISO-8859-1.

  • access: public
string getMimeType ()
getObjectData (line 188)

Returns the embedded object binary data.

  • access: public
string getObjectData ()
setDescription (line 176)

Sets the file description text using given encoding. The description encoding must be that of the file name.

  • access: public
void setDescription (string $description, [integer $encoding = false])
  • string $description: The file description text.
  • integer $encoding: The text encoding.
setEncoding (line 125)

Sets the text encoding.

void setEncoding (integer $encoding)
  • integer $encoding: The text encoding.
Implementation of:
ID3_Encoding::setEncoding()
Sets the text encoding.
setFilename (line 155)

Sets the file name using given encoding. The file name encoding must be that of the description text.

  • access: public
void setFilename ( $filename, [integer $encoding = false], string $description)
  • string $description: The file description text.
  • integer $encoding: The text encoding.
  • $filename
setMimeType (line 139)

Sets the MIME type. The MIME type is always ISO-8859-1 encoded.

  • access: public
void setMimeType (string $mimeType)
  • string $mimeType: The MIME type.
setObjectData (line 195)

Sets the embedded object binary data.

  • access: public
void setObjectData (string $objectData)
  • string $objectData: The object data.
__toString (line 205)

Returns the frame raw data.

  • access: public
string __toString ()
Redefinition of:
ID3_Frame::__toString()
Returns the frame raw data.

Inherited Methods

Inherited From ID3_Frame

ID3_Frame::__construct()
ID3_Frame::getFlags()
ID3_Frame::getIdentifier()
ID3_Frame::getSize()
ID3_Frame::hasFlag()
ID3_Frame::setData()
ID3_Frame::setFlags()
ID3_Frame::setIdentifier()
ID3_Frame::__toString()

Inherited From ID3_Object

ID3_Object::__construct()
ID3_Object::decodeSynchsafe32()
ID3_Object::decodeUnsynchronisation()
ID3_Object::encodeSynchsafe32()
ID3_Object::encodeUnsynchronisation()
ID3_Object::explodeString8()
ID3_Object::explodeString16()
ID3_Object::getOption()
ID3_Object::getOptions()
ID3_Object::setOption()
ID3_Object::setOptions()
ID3_Object::__get()
ID3_Object::__set()
Class Constants
Description | Constants (details) Vars | Methods (details)

Inherited Constants

Inherited from ID3_Frame

ID3_Frame::COMPRESSION
 ID3_Frame::DATA_LENGTH_INDICATOR
 ID3_Frame::DISCARD_ON_FILECHANGE
 ID3_Frame::DISCARD_ON_TAGCHANGE
 ID3_Frame::ENCRYPTION
 ID3_Frame::GROUPING_IDENTITY
 ID3_Frame::READ_ONLY
 ID3_Frame::UNSYNCHRONISATION

Documentation generated on Fri, 05 Sep 2008 20:18:44 +0300 by phpDocumentor 1.4.1