XOOPS RMCommon Utilities  2.1.8.91RC
 All Classes Namespaces Files Functions Variables
Swift_Mime_Headers_PathHeader Class Reference
Inheritance diagram for Swift_Mime_Headers_PathHeader:
Inheritance graph

Public Member Functions

 __construct ($name)
 
 getAddress ()
 
 getFieldBody ()
 
 getFieldBodyModel ()
 
 getFieldType ()
 
 setAddress ($address)
 
 setFieldBodyModel ($model)
 
- 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

 $_address
 

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

Constructor & Destructor Documentation

Swift_Mime_Headers_PathHeader::__construct (   $name)

Creates a new PathHeader with the given $name.

Parameters
string$name

Definition at line 34 of file PathHeader.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_PathHeader::getAddress ( )

Get the address which is used in this Header (if any). Null is returned if no address is set.

Returns
string

Definition at line 102 of file PathHeader.php.

References $_address.

Referenced by getFieldBodyModel().

Here is the caller graph for this function:

Swift_Mime_Headers_PathHeader::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()

Implements Swift_Mime_Header.

Definition at line 114 of file PathHeader.php.

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

Here is the call graph for this function:

Swift_Mime_Headers_PathHeader::getFieldBodyModel ( )

Get the model for the field body. This method returns a string email address.

Returns
mixed

Implements Swift_Mime_Header.

Definition at line 67 of file PathHeader.php.

References getAddress().

Here is the call graph for this function:

Swift_Mime_Headers_PathHeader::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 46 of file PathHeader.php.

Swift_Mime_Headers_PathHeader::setAddress (   $address)

Set the Address which should appear in this Header.

Parameters
string$address
Exceptions
Swift_RfcComplianceException

Definition at line 77 of file PathHeader.php.

References elseif(), Swift_Mime_Headers_AbstractHeader\getGrammar(), and Swift_Mime_Headers_AbstractHeader\setCachedValue().

Referenced by setFieldBodyModel().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_Headers_PathHeader::setFieldBodyModel (   $model)

Set the model for the field body. This method takes a string for an address.

Parameters
string$model
Exceptions
Swift_RfcComplianceException

Implements Swift_Mime_Header.

Definition at line 57 of file PathHeader.php.

References setAddress().

Here is the call graph for this function:

Member Data Documentation

Swift_Mime_Headers_PathHeader::$_address
private

Definition at line 28 of file PathHeader.php.

Referenced by getAddress().


The documentation for this class was generated from the following file: