Swift_Mime_Headers_IdentificationHeader Class Reference

Inheritance diagram for Swift_Mime_Headers_IdentificationHeader:

Public Member Functions
	__construct ($name)
	getFieldBody ()
	getFieldBodyModel ()
	getFieldType ()
	getId ()
	getIds ()
	setFieldBodyModel ($model)
	setId ($id)
	setIds (array $ids)
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 ()

Private Attributes
	$_ids = array()

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
Protected Member Functions inherited from Swift_Mime_Headers_AbstractHeader
	clearCachedValueIf ($condition)
	createPhrase (Swift_Mime_Header $header, $string, $charset, Swift_Mime_HeaderEncoder $encoder=null, $shorten=false)
	encodeWords (Swift_Mime_Header $header, $input, $usedLength=-1)
	escapeSpecials ($token, $include=array(), $exclude=array())
	generateTokenLines ($token)
	getCachedValue ()
	getEncodableWordTokens ($string)
	getGrammar ($name)
	getTokenAsEncodedWord ($token, $firstLineOffset=0)
	initializeGrammar ()
	setCachedValue ($value)
	setFieldName ($name)
	tokenNeedsEncoding ($token)
	toTokens ($string=null)

Detailed Description

Definition at line 20 of file IdentificationHeader.php.

Constructor & Destructor Documentation

Swift_Mime_Headers_IdentificationHeader::__construct

(

$name

)

Creates a new IdentificationHeader with the given $name and $id.

Parameters

string

$name

Definition at line 36 of file IdentificationHeader.php.

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

Here is the call graph for this function:

Member Function Documentation

Swift_Mime_Headers_IdentificationHeader::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).

Returns

string

See Also

toString()

Exceptions

Swift_RfcComplianceException

Implements Swift_Mime_Header.

Definition at line 145 of file IdentificationHeader.php.

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

Here is the call graph for this function:

Swift_Mime_Headers_IdentificationHeader::getFieldBodyModel

(

)

Get the model for the field body. This method returns an array of IDs

Returns

array

Implements Swift_Mime_Header.

Definition at line 69 of file IdentificationHeader.php.

References getIds().

Here is the call graph for this function:

Swift_Mime_Headers_IdentificationHeader::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 48 of file IdentificationHeader.php.

Swift_Mime_Headers_IdentificationHeader::getId

(

)

Get the ID used in the value of this Header. If multiple IDs are set only the first is returned.

Returns

string

Definition at line 89 of file IdentificationHeader.php.

Swift_Mime_Headers_IdentificationHeader::getIds

(

)

Get the list of IDs used in this Header.

Returns

string[]

Definition at line 132 of file IdentificationHeader.php.

References $_ids.

Referenced by getFieldBodyModel().

Here is the caller graph for this function:

Swift_Mime_Headers_IdentificationHeader::setFieldBodyModel

(

$model

)

Set the model for the field body. This method takes a string ID, or an array of IDs

Parameters

mixed

$model

Exceptions

Swift_RfcComplianceException

Implements Swift_Mime_Header.

Definition at line 59 of file IdentificationHeader.php.

References setId().

Here is the call graph for this function:

Swift_Mime_Headers_IdentificationHeader::setId

(

$id

)

Set the ID used in the value of this header.

Parameters

string

$id

Exceptions

Swift_RfcComplianceException

Definition at line 79 of file IdentificationHeader.php.

References $id, and setIds().

Referenced by setFieldBodyModel().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_Headers_IdentificationHeader::setIds

(

array

$ids

)

Set a collection of IDs to use in the value of this Header.

Parameters

string[]

$ids

Exceptions

Swift_RfcComplianceException

Definition at line 102 of file IdentificationHeader.php.

References $id, Swift_Mime_Headers_AbstractHeader\clearCachedValueIf(), and Swift_Mime_Headers_AbstractHeader\getGrammar().

Referenced by setId().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Swift_Mime_Headers_IdentificationHeader::$_ids = array()

private

Definition at line 30 of file IdentificationHeader.php.

Referenced by getIds().

---

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/IdentificationHeader.php