TextFrame
extends Frame
in package
Base class for ID3v2 text frames.
Text frames are the most common frame type in ID3v2 tags. They contain text information like title, artist, album, etc.
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructs the TextFrame class with given parameters.
- getEncoding() : int
- Returns the text encoding.
- getText() : string
- Returns the text content.
- parse() : self
- Parses the frame data.
- setEncoding() : self
- Sets the text encoding.
- setText() : self
- Sets the text content.
- toBytes() : string
- Converts the frame to binary data.
Properties
$encoding
protected
int
$encoding
= Encoding::UTF8
$frameId
protected
string
$frameId
Hooks
protected
string
get
$text
protected
string
$text
= ''
Methods
__construct()
Constructs the TextFrame class with given parameters.
public
__construct(string $frameId[, string $text = '' ][, int $encoding = Encoding::UTF8 ]) : mixed
Parameters
- $frameId : string
- $text : string = ''
- $encoding : int = Encoding::UTF8
getEncoding()
Returns the text encoding.
public
getEncoding() : int
Return values
intgetText()
Returns the text content.
public
getText() : string
Return values
stringparse()
Parses the frame data.
public
parse(string $frameData) : self
Parameters
- $frameData : string
Return values
selfsetEncoding()
Sets the text encoding.
public
setEncoding(int $encoding) : self
Parameters
- $encoding : int
Return values
selfsetText()
Sets the text content.
public
setText(string $text) : self
Parameters
- $text : string
Return values
selftoBytes()
Converts the frame to binary data.
public
toBytes() : string