Swift_Mime_Headers_DateHeader Class Reference

Inheritance diagram for Swift_Mime_Headers_DateHeader:

Public Member Functions
	__construct ($name, Swift_Mime_Grammar $grammar)
	getFieldType ()
	setFieldBodyModel ($model)
	getFieldBodyModel ()
	getTimestamp ()
	setTimestamp ($timestamp)
	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
	$_timestamp

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 Date MIME Header for Swift Mailer.

Author

Chris Corbyn

Definition at line 16 of file DateHeader.php.

Constructor & Destructor Documentation

__construct	(		$name,
		Swift_Mime_Grammar	$grammar
	)

Creates a new DateHeader with $name and $timestamp.

Example: <?php $header = new Swift_Mime_Headers_DateHeader('Date', time()); ?>

Parameters

string	$name	of Header
Swift_Mime_Grammar	$grammar

Definition at line 38 of file DateHeader.php.

References Swift_Mime_Headers_AbstractHeader\setFieldName().

Member Function Documentation

getFieldBody

(

)

Get the string value of the body in this Header.

This is not necessarily RFC 2822 compliant since folding white space will not be added at this stage (see toString() for that).

See Also

toString()

Returns

string

Implements Swift_Mime_Header.

Definition at line 115 of file DateHeader.php.

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

getFieldBodyModel

(

)

Get the model for the field body.

This method returns a UNIX timestamp.

Returns

mixed

Implements Swift_Mime_Header.

Definition at line 76 of file DateHeader.php.

References getTimestamp().

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 52 of file DateHeader.php.

getTimestamp

(

)

Get the UNIX timestamp of the Date in this Header.

Returns

int

Definition at line 86 of file DateHeader.php.

References $_timestamp.

Referenced by getFieldBodyModel().

setFieldBodyModel

(

$model

)

Set the model for the field body.

This method takes a UNIX timestamp.

Parameters

int

$model

Implements Swift_Mime_Header.

Definition at line 64 of file DateHeader.php.

References setTimestamp().

setTimestamp

(

$timestamp

)

Set the UNIX timestamp of the Date in this Header.

Parameters

int

$timestamp

Definition at line 96 of file DateHeader.php.

References Swift_Mime_Headers_AbstractHeader\clearCachedValueIf().

Referenced by setFieldBodyModel().

Member Data Documentation

$_timestamp

private

Definition at line 23 of file DateHeader.php.

Referenced by getTimestamp().