Bånder

COMM extends Frame
in package

COMM frame - Comments.

The 'Comments' frame is intended for any kind of full text information that does not fit in any other frame. It consists of a description and the actual text. There may be more than one comment frame in each tag, but only one with the same language and description.

Table of Contents

Properties

$description  : string
$encoding  : int
$frameId  : string
$language  : string
$text  : string

Methods

__construct()  : mixed
Constructs the COMM frame with given parameters.
getDescription()  : string
Returns the description.
getEncoding()  : int
Returns the text encoding.
getLanguage()  : string
Returns the language code.
getText()  : string
Returns the comment text.
parse()  : self
Parses the frame data.
setDescription()  : self
Sets the description.
setEncoding()  : self
Sets the text encoding.
setLanguage()  : self
Sets the language code.
setText()  : self
Sets the comment text.
toBytes()  : string
Converts the frame to binary data.

Properties

$description

protected string $description = ''

$encoding

protected int $encoding = Encoding::UTF8

$frameId

protected string $frameId
Hooks
protected string get

$language

protected string $language = 'eng'

$text

protected string $text = ''

Methods

__construct()

Constructs the COMM frame with given parameters.

public __construct([string $text = '' ][, string $description = '' ][, string $language = 'eng' ][, int $encoding = Encoding::UTF8 ]) : mixed
Parameters
$text : string = ''
$description : string = ''
$language : string = 'eng'
$encoding : int = Encoding::UTF8

getDescription()

Returns the description.

public getDescription() : string
Return values
string

getEncoding()

Returns the text encoding.

public getEncoding() : int
Return values
int

getLanguage()

Returns the language code.

public getLanguage() : string
Return values
string

getText()

Returns the comment text.

public getText() : string
Return values
string

parse()

Parses the frame data.

public parse(string $frameData) : self
Parameters
$frameData : string
Return values
self

setDescription()

Sets the description.

public setDescription(string $description) : self
Parameters
$description : string
Return values
self

setEncoding()

Sets the text encoding.

public setEncoding(int $encoding) : self
Parameters
$encoding : int
Return values
self

setLanguage()

Sets the language code.

public setLanguage(string $language) : self
Parameters
$language : string
Return values
self

setText()

Sets the comment text.

public setText(string $text) : self
Parameters
$text : string
Return values
self

toBytes()

Converts the frame to binary data.

public toBytes() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results