Swift_Mime_Headers_UnstructuredHeader Class Reference

Inheritance diagram for Swift_Mime_Headers_UnstructuredHeader:

Public Member Functions
	__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 ()

Private Attributes
	$_value

Additional Inherited Members
Public Attributes inherited from Swift_Mime_Header
const	TYPE_TEXT = 2
const	TYPE_PARAMETERIZED = 6
const	TYPE_MAILBOX = 8
const	TYPE_DATE = 16
const	TYPE_ID = 32
const	TYPE_PATH = 64
Protected Member Functions inherited from Swift_Mime_Headers_AbstractHeader
	setFieldName ($name)
	createPhrase (Swift_Mime_Header $header, $string, $charset, Swift_Mime_HeaderEncoder $encoder=null, $shorten=false)
	encodeWords (Swift_Mime_Header $header, $input, $usedLength=-1)
	tokenNeedsEncoding ($token)
	getEncodableWordTokens ($string)
	getTokenAsEncodedWord ($token, $firstLineOffset=0)
	generateTokenLines ($token)
	setCachedValue ($value)
	getCachedValue ()
	clearCachedValueIf ($condition)
	toTokens ($string=null)

Detailed Description

A Simple MIME Header.

Author

Chris Corbyn

Definition at line 16 of file UnstructuredHeader.php.

Constructor & Destructor Documentation

__construct	(		$name,
		Swift_Mime_HeaderEncoder	$encoder,
		Swift_Mime_Grammar	$grammar
	)

Creates a new SimpleHeader with $name.

Parameters

string	$name
Swift_Mime_HeaderEncoder	$encoder
Swift_Mime_Grammar	$grammar

Definition at line 32 of file UnstructuredHeader.php.

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

Member Function Documentation

getFieldBody

(

)

Get the value of this header prepared for rendering.

Returns

string

Implements Swift_Mime_Header.

Definition at line 102 of file UnstructuredHeader.php.

References Swift_Mime_Headers_AbstractHeader\encodeWords(), Swift_Mime_Headers_AbstractHeader\getCachedValue(), and Swift_Mime_Headers_AbstractHeader\setCachedValue().

getFieldBodyModel

(

)

Get the model for the field body.

This method returns a string.

Returns

string

Implements Swift_Mime_Header.

Definition at line 71 of file UnstructuredHeader.php.

References getValue().

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 47 of file UnstructuredHeader.php.

getValue

(

)

Get the (unencoded) value of this header.

Returns

string

Definition at line 81 of file UnstructuredHeader.php.

References $_value.

Referenced by getFieldBodyModel().

setFieldBodyModel

(

$model

)

Set the model for the field body.

This method takes a string for the field value.

Parameters

string

$model

Implements Swift_Mime_Header.

Definition at line 59 of file UnstructuredHeader.php.

References setValue().

setValue

(

$value

)

Set the (unencoded) value of this header.

Parameters

string

$value

Definition at line 91 of file UnstructuredHeader.php.

References Swift_Mime_Headers_AbstractHeader\clearCachedValueIf().

Referenced by setFieldBodyModel().

Member Data Documentation

$_value

private

Definition at line 23 of file UnstructuredHeader.php.

Referenced by getValue().