Swift_Mime_MimePart Class Reference

Inheritance diagram for Swift_Mime_MimePart:

Public Member Functions
	__construct (Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, $charset=null)
	charsetChanged ($charset)
	getCharset ()
	getDelSp ()
	getFormat ()
	getNestingLevel ()
	setBody ($body, $contentType=null, $charset=null)
	setCharset ($charset)
	setDelSp ($delsp=true)
	setFormat ($format)
Public Member Functions inherited from Swift_Mime_SimpleMimeEntity
	__construct (Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache)
	__destruct ()
	__toString ()
	charsetChanged ($charset)
	encoderChanged (Swift_Mime_ContentEncoder $encoder)
	generateId ()
	getBody ()
	getBoundary ()
	getChildren ()
	getContentType ()
	getDescription ()
	getEncoder ()
	getHeaders ()
	getId ()
	getMaxLineLength ()
	getNestingLevel ()
	setBody ($body, $contentType=null)
	setBoundary ($boundary)
	setChildren (array $children, $compoundLevel=null)
	setContentType ($type)
	setDescription ($description)
	setEncoder (Swift_Mime_ContentEncoder $encoder)
	setId ($id)
	setMaxLineLength ($length)
	toByteStream (Swift_InputByteStream $is)
	toString ()
Public Member Functions inherited from Swift_Mime_MimeEntity
	setChildren (array $children)

Protected Member Functions
	_fixHeaders ()
	_setNestingLevel ($level)
Protected Member Functions inherited from Swift_Mime_SimpleMimeEntity
	_clearCache ()
	_fixHeaders ()
	_getCache ()
	_getHeaderFieldModel ($field)
	_getHeaderParameter ($field, $parameter)
	_getIdField ()
	_setHeaderFieldModel ($field, $model)
	_setHeaderParameter ($field, $parameter, $value)
	getRandomId ()

Protected Attributes
	$_userCharset
	$_userDelSp
	$_userFormat
Protected Attributes inherited from Swift_Mime_SimpleMimeEntity
	$_userContentType

Private Attributes
	$_nestingLevel = self::LEVEL_ALTERNATIVE

Additional Inherited Members
Public Attributes inherited from Swift_Mime_MimeEntity
const	LEVEL_ALTERNATIVE = 4096
const	LEVEL_MIXED = 256
const	LEVEL_RELATED = 65536
const	LEVEL_TOP = 16

Detailed Description

Definition at line 23 of file MimePart.php.

Constructor & Destructor Documentation

Swift_Mime_MimePart::__construct	(	Swift_Mime_HeaderSet	$headers,
		Swift_Mime_ContentEncoder	$encoder,
		Swift_KeyCache	$cache,
			$charset = null
	)

Create a new MimePart with $headers, $encoder and $cache.

Parameters

Swift_Mime_HeaderSet	$headers
Swift_Mime_ContentEncoder	$encoder
Swift_KeyCache	$cache
string	$charset

Definition at line 46 of file MimePart.php.

References __construct(), setCharset(), and Swift_Mime_SimpleMimeEntity\setContentType().

Here is the call graph for this function:

Member Function Documentation

Swift_Mime_MimePart::_fixHeaders ( )

protected

Fix the content-type and encoding of this entity

Definition at line 173 of file MimePart.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderParameter(), Swift_Mime_SimpleMimeEntity\getChildren(), setCharset(), setDelSp(), and setFormat().

Here is the call graph for this function:

Swift_Mime_MimePart::_setNestingLevel (   $level )

protected

Set the nesting level of this entity

Definition at line 191 of file MimePart.php.

Swift_Mime_MimePart::charsetChanged

(

$charset

)

Receive notification that the charset has changed on this document, or a parent document.

Parameters

string

$charset

Implements Swift_Mime_CharsetObserver.

Definition at line 165 of file MimePart.php.

References setCharset().

Here is the call graph for this function:

Swift_Mime_MimePart::getCharset

(

)

Get the character set of this entity.

Returns

string

Definition at line 80 of file MimePart.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderParameter().

Here is the call graph for this function:

Swift_Mime_MimePart::getDelSp

(

)

Test if delsp is being used for this entity.

Returns

boolean

Definition at line 129 of file MimePart.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderParameter().

Here is the call graph for this function:

Swift_Mime_MimePart::getFormat

(

)

Get the format of this entity (i.e. flowed or fixed).

Returns

string

Definition at line 107 of file MimePart.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderParameter().

Here is the call graph for this function:

Swift_Mime_MimePart::getNestingLevel

(

)

Get the nesting level of this entity.

Returns

int

See Also

LEVEL_TOP, LEVEL_ALTERNATIVE, LEVEL_MIXED, LEVEL_RELATED

Implements Swift_Mime_MimeEntity.

Definition at line 154 of file MimePart.php.

References $_nestingLevel.

Swift_Mime_MimePart::setBody	(		$body,
			$contentType = null,
			$charset = null
	)

Set the body of this entity, either as a string, or as an instance of Swift_OutputByteStream.

Parameters

mixed	$body
string	$contentType	optional
string	$charset	optional

Definition at line 65 of file MimePart.php.

References setCharset().

Referenced by Swift_MimePart\__construct(), and Swift_Message\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_MimePart::setCharset

(

$charset

)

Set the character set of this entity.

Parameters

string

$charset

Definition at line 90 of file MimePart.php.

References Swift_Mime_SimpleMimeEntity\_clearCache(), and Swift_Mime_SimpleMimeEntity\_setHeaderParameter().

Referenced by Swift_MimePart\__construct(), Swift_Message\__construct(), __construct(), _fixHeaders(), charsetChanged(), and setBody().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_MimePart::setDelSp

(

$delsp = true

)

Turn delsp on or off for this entity.

Parameters

boolean

$delsp

Definition at line 141 of file MimePart.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderParameter().

Referenced by _fixHeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_MimePart::setFormat

(

$format

)

Set the format of this entity (flowed or fixed).

Parameters

string

$format

Definition at line 117 of file MimePart.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderParameter().

Referenced by _fixHeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Swift_Mime_MimePart::$_nestingLevel = self::LEVEL_ALTERNATIVE

private

The nesting level of this MimePart

Definition at line 36 of file MimePart.php.

Referenced by getNestingLevel().

Swift_Mime_MimePart::$_userCharset

protected

The charset last specified by the user

Definition at line 30 of file MimePart.php.

Swift_Mime_MimePart::$_userDelSp

protected

The delsp parameter last specified by the user

Definition at line 33 of file MimePart.php.

Swift_Mime_MimePart::$_userFormat

protected

The format parameter last specified by the user

Definition at line 27 of file MimePart.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/MimePart.php