Header
in package
MIME part header class
Tags
Table of Contents
- $indent : string
- Header wrap indent
- $name : string
- Header name
- $parameters : array<string|int, mixed>
- Header parameters
- $value : string|array<string|int, mixed>
- Header value
- $wrap : int
- Header wrap
- __construct() : mixed
- Constructor
- __toString() : string
- Render the header string
- addParameter() : Header
- Set a header parameter
- addParameters() : Header
- Add the header parameters
- getIndent() : string
- Get the header wrap indent
- getName() : string
- Get the header name
- getParameter() : string
- Get a header parameter
- getParameters() : array<string|int, mixed>
- Get the header parameters
- getParametersAsString() : string
- Get the header parameters as string
- getValue() : string|array<string|int, mixed>
- Get the header value
- getWrap() : int
- Get the header wrap
- hasIndent() : bool
- Has header wrap indent
- hasParameter() : bool
- Has a header parameter
- hasParameters() : bool
- Has header parameters
- hasWrap() : bool
- Has header wrap
- isAttachment() : bool
- Is the header for an attachment
- parse() : Header
- Parse header
- parseParameter() : array<string|int, mixed>
- Render the header string
- render() : string
- Render the header string
- setIndent() : Header
- Set the header wrap indent
- setName() : Header
- Set the header name
- setValue() : Header
- Set the header value
- setWrap() : Header
- Set the header wrap
Properties
$indent
Header wrap indent
protected
string
$indent
= "\t"
$name
Header name
protected
string
$name
= null
$parameters
Header parameters
protected
array<string|int, mixed>
$parameters
= []
$value
Header value
protected
string|array<string|int, mixed>
$value
= null
$wrap
Header wrap
protected
int
$wrap
= 0
Methods
__construct()
Constructor
public
__construct([string $name = null ][, string $value = null ][, array<string|int, mixed> $parameters = [] ]) : mixed
Instantiate the header object
Parameters
- $name : string = null
- $value : string = null
- $parameters : array<string|int, mixed> = []
Return values
mixed —__toString()
Render the header string
public
__toString() : string
Return values
string —addParameter()
Set a header parameter
public
addParameter(string $name, string $value) : Header
Parameters
- $name : string
- $value : string
Return values
Header —addParameters()
Add the header parameters
public
addParameters(array<string|int, mixed> $parameters) : Header
Parameters
- $parameters : array<string|int, mixed>
Return values
Header —getIndent()
Get the header wrap indent
public
getIndent() : string
Return values
string —getName()
Get the header name
public
getName() : string
Return values
string —getParameter()
Get a header parameter
public
getParameter(string $name) : string
Parameters
- $name : string
Return values
string —getParameters()
Get the header parameters
public
getParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getParametersAsString()
Get the header parameters as string
public
getParametersAsString() : string
Return values
string —getValue()
Get the header value
public
getValue() : string|array<string|int, mixed>
Return values
string|array<string|int, mixed> —getWrap()
Get the header wrap
public
getWrap() : int
Return values
int —hasIndent()
Has header wrap indent
public
hasIndent() : bool
Return values
bool —hasParameter()
Has a header parameter
public
hasParameter(string $name) : bool
Parameters
- $name : string
Return values
bool —hasParameters()
Has header parameters
public
hasParameters() : bool
Return values
bool —hasWrap()
Has header wrap
public
hasWrap() : bool
Return values
bool —isAttachment()
Is the header for an attachment
public
isAttachment() : bool
Return values
bool —parse()
Parse header
public
static parse(string $header) : Header
Parameters
- $header : string
Return values
Header —parseParameter()
Render the header string
public
static parseParameter(string $parameter) : array<string|int, mixed>
Parameters
- $parameter : string
Return values
array<string|int, mixed> —render()
Render the header string
public
render() : string
Return values
string —setIndent()
Set the header wrap indent
public
setIndent(string $indent) : Header
Parameters
- $indent : string
Return values
Header —setName()
Set the header name
public
setName(string $name) : Header
Parameters
- $name : string
Return values
Header —setValue()
Set the header value
public
setValue(string $value) : Header
Parameters
- $value : string
Return values
Header —setWrap()
Set the header wrap
public
setWrap(int $wrap) : Header
Parameters
- $wrap : int