TCOM
extends TextFrame
in package
TCOM frame - Composer.
The 'Composer' frame is intended for the name of the composer.
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructs the TCOM frame with given parameters.
- getComposer() : string
- Returns the composer.
- getEncoding() : int
- Returns the text encoding.
- getText() : string
- Returns the text content.
- parse() : self
- Parses the frame data.
- setComposer() : self
- Sets the composer.
- 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 TCOM frame with given parameters.
public
__construct([string $composer = '' ][, int $encoding = Encoding::UTF8 ]) : mixed
Parameters
- $composer : string = ''
- $encoding : int = Encoding::UTF8
getComposer()
Returns the composer.
public
getComposer() : string
Return values
stringgetEncoding()
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
selfsetComposer()
Sets the composer.
public
setComposer(string $composer) : self
Parameters
- $composer : 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