Swift_Mime_Headers_ParameterizedHeader Class Reference

Inheritance diagram for Swift_Mime_Headers_ParameterizedHeader:

Public Member Functions
	__construct ($name, Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $paramEncoder=null, Swift_Mime_Grammar $grammar)
	getFieldType ()
	setCharset ($charset)
	setParameter ($parameter, $value)
	getParameter ($parameter)
	setParameters (array $parameters)
	getParameters ()
	getFieldBody ()
Public Member Functions inherited from Swift_Mime_Headers_UnstructuredHeader
	__construct ($name, Swift_Mime_HeaderEncoder $encoder, Swift_Mime_Grammar $grammar)
	getFieldType ()
	setFieldBodyModel ($model)
	getFieldBodyModel ()
	getValue ()
	setValue ($value)
	getFieldBody ()
Public Member Functions inherited from Swift_Mime_Headers_AbstractHeader
	__construct (Swift_Mime_Grammar $grammar)
	setCharset ($charset)
	getCharset ()
	setLanguage ($lang)
	getLanguage ()
	setEncoder (Swift_Mime_HeaderEncoder $encoder)
	getEncoder ()
	setGrammar (Swift_Mime_Grammar $grammar)
	getGrammar ()
	getFieldName ()
	setMaxLineLength ($lineLength)
	getMaxLineLength ()
	toString ()
	__toString ()

Public Attributes
const	TOKEN_REGEX = '(?:[\x21\x23-\x27\x2A\x2B\x2D\x2E\x30-\x39\x41-\x5A\x5E-\x7E]+)'

Protected Member Functions
	toTokens ($string=null)

Private Member Functions
	_createParameter ($name, $value)
	_getEndOfParameterValue ($value, $encoded=false, $firstLine=false)

Private Attributes
	$_paramEncoder
	$_params = array()

Detailed Description

An abstract base MIME Header.

Author

Chris Corbyn

Definition at line 16 of file Headers/ParameterizedHeader.php.

Constructor & Destructor Documentation

__construct	(		$name,
		Swift_Mime_HeaderEncoder	$encoder,
		Swift_Encoder	$paramEncoder = null,
		Swift_Mime_Grammar	$grammar
	)

Creates a new ParameterizedHeader with $name.

Parameters

string	$name
Swift_Mime_HeaderEncoder	$encoder
Swift_Encoder	$paramEncoder,optional
Swift_Mime_Grammar	$grammar

Definition at line 47 of file Headers/ParameterizedHeader.php.

Member Function Documentation

_createParameter (   $name,   $value  )

private

Render a RFC 2047 compliant header parameter from the $name and $value.

Parameters

string	$name
string	$value

Returns

string

Definition at line 181 of file Headers/ParameterizedHeader.php.

References $encoded, _getEndOfParameterValue(), Swift_Mime_Headers_AbstractHeader\getCharset(), Swift_Mime_Headers_AbstractHeader\getGrammar(), Swift_Mime_Headers_AbstractHeader\getLanguage(), Swift_Mime_Headers_AbstractHeader\getMaxLineLength(), and Swift_Mime_Headers_AbstractHeader\getTokenAsEncodedWord().

Referenced by toTokens().

_getEndOfParameterValue (   $value,   $encoded = false,   $firstLine = false  )

private

Returns the parameter value from the "=" and beyond.

Parameters

string	$value	to append
bool	$encoded
bool	$firstLine

Returns

string

Definition at line 244 of file Headers/ParameterizedHeader.php.

References $encoded, and Swift_Mime_Headers_AbstractHeader\getLanguage().

Referenced by _createParameter().

getFieldBody

(

)

Get the value of this header prepared for rendering.

Returns

string

Implements Swift_Mime_Header.

Definition at line 132 of file Headers/ParameterizedHeader.php.

getFieldType

(

)

Get the type of Header that this instance represents.

See Also

TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX

TYPE_DATE, TYPE_ID, TYPE_PATH

Returns

int

Implements Swift_Mime_Header.

Definition at line 61 of file Headers/ParameterizedHeader.php.

getParameter

(

$parameter

)

Get the value of $parameter.

Parameters

string

$parameter

Returns

string

Implements Swift_Mime_ParameterizedHeader.

Definition at line 97 of file Headers/ParameterizedHeader.php.

References getParameters().

getParameters

(

)

Returns an associative array of parameter names mapped to values.

Returns

string[]

Definition at line 122 of file Headers/ParameterizedHeader.php.

References $_params.

Referenced by getParameter(), and setParameter().

setCharset

(

$charset

)

Set the character set used in this Header.

Parameters

string

$charset

Implements Swift_Mime_Header.

Definition at line 71 of file Headers/ParameterizedHeader.php.

setParameter	(		$parameter,
			$value
	)

Set the value of $parameter.

Parameters

string	$parameter
string	$value

Implements Swift_Mime_ParameterizedHeader.

Definition at line 85 of file Headers/ParameterizedHeader.php.

References getParameters(), and setParameters().

setParameters

(

array

$parameters

)

Set an associative array of parameter names mapped to values.

Parameters

string[]

$parameters

Definition at line 111 of file Headers/ParameterizedHeader.php.

References Swift_Mime_Headers_AbstractHeader\clearCachedValueIf().

Referenced by setParameter().

toTokens (   $string = null )

protected

Generate a list of all tokens in the final header.

This doesn't need to be overridden in theory, but it is for implementation reasons to prevent potential breakage of attributes.

Parameters

string

$string

The string to tokenize

Returns

array An array of tokens as strings

Definition at line 155 of file Headers/ParameterizedHeader.php.

References _createParameter(), and Swift_Mime_Headers_AbstractHeader\generateTokenLines().

Member Data Documentation

$_paramEncoder

private

Definition at line 30 of file Headers/ParameterizedHeader.php.

$_params = array()

private

Definition at line 37 of file Headers/ParameterizedHeader.php.

Referenced by getParameters().

const TOKEN_REGEX = '(?:[\x21\x23-\x27\x2A\x2B\x2D\x2E\x30-\x39\x41-\x5A\x5E-\x7E]+)'

Definition at line 23 of file Headers/ParameterizedHeader.php.