TypeParameter
in package
Class for working with MIME type parameters.
Table of Contents
Properties
Methods
- __construct() : mixed
- getComment() : string
- Gets the parameter comment.
- getName() : string
- Gets the parameter name.
- getValue() : string
- Gets the parameter value.
- hasComment() : bool
- Does this parameter have a comment?
- toString() : string
- Gets a string representation of this parameter.
Properties
$comment read-only
protected
string|null
$comment
= null
$name read-only
protected
string
$name
$value read-only
protected
string
$value
Methods
__construct()
public
__construct(string $name, string $value[, string|null $comment = null ]) : mixed
APIYes
Parameters
- $name : string
-
Parameter name.
- $value : string
-
Parameter value.
- $comment : string|null = null
-
Comment for this parameter.
getComment()
Gets the parameter comment.
public
getComment() : string
APIYes
Tags
Return values
stringgetName()
Gets the parameter name.
public
getName() : string
APIYes
Return values
stringgetValue()
Gets the parameter value.
public
getValue() : string
APIYes
Return values
stringhasComment()
Does this parameter have a comment?
public
hasComment() : bool
APIYes
Return values
booltoString()
Gets a string representation of this parameter.
public
toString([int $format = Type::FULL_TEXT ]) : string
APIYes
Parameters
- $format : int = Type::FULL_TEXT
-
The format of the output string.