Swift_Mime_Headers_IdentificationHeader Class Reference

TYPO3 7.6

Inheritance diagram for Swift_Mime_Headers_IdentificationHeader:

Public Member Functions
	__construct ($name, Swift_Mime_Grammar $grammar)

	getFieldType ()

	setFieldBodyModel ($model)

	getFieldBodyModel ()

	setId ($id)

	getId ()

	setIds (array $ids)

	getIds ()

	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 Member Functions
	_assertValidId ($id)

Private Attributes
	$_ids = array()

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

An ID MIME Header for something like Message-ID or Content-ID.

Author: Chris Corbyn

Definition at line 16 of file IdentificationHeader.php.

Constructor & Destructor Documentation

__construct	(		$name,
		Swift_Mime_Grammar	$grammar
	)

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

Parameters

string	$name
Swift_Mime_Grammar	$grammar

Definition at line 33 of file IdentificationHeader.php.

References Swift_Mime_Headers_AbstractHeader\setFieldName().

Member Function Documentation

_assertValidId ( $id )

private

Throws an Exception if the id passed does not comply with RFC 2822.

Parameters

string $id

Exceptions

Swift_RfcComplianceException

Definition at line 168 of file IdentificationHeader.php.

References Swift_Mime_Headers_AbstractHeader\getGrammar().

Referenced by setIds().

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 {

See Also: toString()} for that).; toString()

Exceptions

Swift_RfcComplianceException

Returns: string

Implements Swift_Mime_Header.

Definition at line 146 of file IdentificationHeader.php.

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

getFieldBodyModel ( )

Get the model for the field body.

This method returns an array of IDs

Returns: array

Implements Swift_Mime_Header.

Definition at line 73 of file IdentificationHeader.php.

References getIds().

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

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 97 of file IdentificationHeader.php.

getIds ( )

Get the list of IDs used in this Header.

Returns: string[]

Definition at line 129 of file IdentificationHeader.php.

References $_ids.

Referenced by getFieldBodyModel().

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 61 of file IdentificationHeader.php.

References setId().

setId ( $id )

Set the ID used in the value of this header.

Parameters

string | array $id

Exceptions

Swift_RfcComplianceException

Definition at line 85 of file IdentificationHeader.php.

References setIds().

Referenced by setFieldBodyModel().

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 111 of file IdentificationHeader.php.

References _assertValidId(), and Swift_Mime_Headers_AbstractHeader\clearCachedValueIf().

Referenced by setId().

Member Data Documentation

$_ids = array()

private

Definition at line 25 of file IdentificationHeader.php.

Referenced by getIds().