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)
	getFieldBody ()
	getFieldType ()
	getParameter ($parameter)
	getParameters ()
	setCharset ($charset)
	setParameter ($parameter, $value)
	setParameters (array $parameters)
Public Member Functions inherited from Swift_Mime_Headers_UnstructuredHeader
	__construct ($name, Swift_Mime_HeaderEncoder $encoder)
	getFieldBody ()
	getFieldBodyModel ()
	getFieldType ()
	getValue ()
	setFieldBodyModel ($model)
	setValue ($value)
Public Member Functions inherited from Swift_Mime_Headers_AbstractHeader
	__toString ()
	getCharset ()
	getEncoder ()
	getFieldName ()
	getLanguage ()
	getMaxLineLength ()
	setCharset ($charset)
	setEncoder (Swift_Mime_HeaderEncoder $encoder)
	setLanguage ($lang)
	setMaxLineLength ($lineLength)
	toString ()

Protected Member Functions
	toTokens ($string=null)

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

Private Attributes
	$_paramEncoder
	$_params = array()
	$_tokenRe

Additional Inherited Members
Public Attributes inherited from Swift_Mime_Header
const	TYPE_DATE = 16
const	TYPE_ID = 32
const	TYPE_MAILBOX = 8
const	TYPE_PARAMETERIZED = 6
const	TYPE_PATH = 64
const	TYPE_TEXT = 2

Detailed Description

Definition at line 22 of file ParameterizedHeader.php.

Constructor & Destructor Documentation

Swift_Mime_Headers_ParameterizedHeader::__construct	(		$name,
		Swift_Mime_HeaderEncoder	$encoder,
		Swift_Encoder	$paramEncoder = null
	)

Creates a new ParameterizedHeader with $name.

Parameters

string	$name
Swift_Mime_HeaderEncoder	$encoder
Swift_Encoder	$paramEncoder,optional

Definition at line 54 of file ParameterizedHeader.php.

References Swift_Mime_Headers_AbstractHeader\initializeGrammar(), Swift_Mime_Headers_AbstractHeader\setEncoder(), and Swift_Mime_Headers_AbstractHeader\setFieldName().

Here is the call graph for this function:

Member Function Documentation

Swift_Mime_Headers_ParameterizedHeader::_createParameter (   $name,   $value  )

private

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

Parameters

string	$name
string	$value

Returns

string private

Definition at line 185 of file ParameterizedHeader.php.

References $i, _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 getFieldBody(), and toTokens().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

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

Parameters

string	$value	to append
boolean	$encoded
boolean	$firstLine

Returns

string private

Definition at line 255 of file ParameterizedHeader.php.

References Swift_Mime_Headers_AbstractHeader\getCharset(), and Swift_Mime_Headers_AbstractHeader\getLanguage().

Referenced by _createParameter().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_Headers_ParameterizedHeader::getFieldBody

(

)

Get the value of this header prepared for rendering.

Returns

string

Implements Swift_Mime_Header.

Definition at line 133 of file ParameterizedHeader.php.

References _createParameter().

Here is the call graph for this function:

Swift_Mime_Headers_ParameterizedHeader::getFieldType

(

)

Get the type of Header that this instance represents.

Returns

int

See Also

TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX

TYPE_DATE, TYPE_ID, TYPE_PATH

Implements Swift_Mime_Header.

Definition at line 70 of file ParameterizedHeader.php.

Swift_Mime_Headers_ParameterizedHeader::getParameter

(

$parameter

)

Get the value of $parameter.

Returns

string

Implements Swift_Mime_ParameterizedHeader.

Definition at line 102 of file ParameterizedHeader.php.

References getParameters().

Here is the call graph for this function:

Swift_Mime_Headers_ParameterizedHeader::getParameters

(

)

Returns an associative array of parameter names mapped to values.

Returns

string[]

Definition at line 124 of file ParameterizedHeader.php.

References $_params.

Referenced by getParameter(), and setParameter().

Here is the caller graph for this function:

Swift_Mime_Headers_ParameterizedHeader::setCharset

(

$charset

)

Set the character set used in this Header.

Parameters

string

$charset

Implements Swift_Mime_Header.

Definition at line 79 of file ParameterizedHeader.php.

Swift_Mime_Headers_ParameterizedHeader::setParameter	(		$parameter,
			$value
	)

Set the value of $parameter.

Parameters

string	$parameter
string	$value

Implements Swift_Mime_ParameterizedHeader.

Definition at line 93 of file ParameterizedHeader.php.

References getParameters(), and setParameters().

Here is the call graph for this function:

Swift_Mime_Headers_ParameterizedHeader::setParameters

(

array

$parameters

)

Set an associative array of parameter names mapped to values.

Parameters

string[]

Definition at line 114 of file ParameterizedHeader.php.

References Swift_Mime_Headers_AbstractHeader\clearCachedValueIf().

Referenced by setParameter().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_Headers_ParameterizedHeader::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.

Returns

string[] protected

Definition at line 156 of file ParameterizedHeader.php.

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

Here is the call graph for this function:

Member Data Documentation

Swift_Mime_Headers_ParameterizedHeader::$_paramEncoder

private

Definition at line 32 of file ParameterizedHeader.php.

Swift_Mime_Headers_ParameterizedHeader::$_params = array()

private

Definition at line 39 of file ParameterizedHeader.php.

Referenced by getParameters().

Swift_Mime_Headers_ParameterizedHeader::$_tokenRe

private

Definition at line 46 of file ParameterizedHeader.php.

---

The documentation for this class was generated from the following file:

• L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/swift/classes/Swift/Mime/Headers/ParameterizedHeader.php