Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Mime_Headers_DateHeader

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mime/Headers/DateHeader.php

Class Overview

Swift_Mime_Headers_AbstractHeader
   |
   --Swift_Mime_Headers_DateHeader

A Date MIME Header for Swift Mailer.


Author(s):

  • Chris Corbyn

Methods


Inherited Methods

Class: Swift_Mime_Headers_AbstractHeader

Swift_Mime_Headers_AbstractHeader::__construct()
Creates a new Header.
Swift_Mime_Headers_AbstractHeader::clearCachedValueIf()
Clear the cached value if $condition is met.
Swift_Mime_Headers_AbstractHeader::createPhrase()
Produces a compliant, formatted RFC 2822 'phrase' based on the string given.
Swift_Mime_Headers_AbstractHeader::encodeWords()
Encode needed word tokens within a string of input.
Swift_Mime_Headers_AbstractHeader::generateTokenLines()
Generates tokens from the given string which include CRLF as individual tokens.
Swift_Mime_Headers_AbstractHeader::getCachedValue()
Get the value in the cache.
Swift_Mime_Headers_AbstractHeader::getCharset()
Get the character set used in this Header.
Swift_Mime_Headers_AbstractHeader::getEncodableWordTokens()
Splits a string into tokens in blocks of words which can be encoded quickly.
Swift_Mime_Headers_AbstractHeader::getEncoder()
Get the encoder used for encoding this Header.
Swift_Mime_Headers_AbstractHeader::getFieldName()
Get the name of this header (e.g. charset).
Swift_Mime_Headers_AbstractHeader::getGrammar()
Get the grammar used for this Header.
Swift_Mime_Headers_AbstractHeader::getLanguage()
Get the language used in this Header.
Swift_Mime_Headers_AbstractHeader::getMaxLineLength()
Get the maximum permitted length of lines in this Header.
Swift_Mime_Headers_AbstractHeader::getTokenAsEncodedWord()
Get a token as an encoded word for safe insertion into headers.
Swift_Mime_Headers_AbstractHeader::setCachedValue()
Set a value into the cache.
Swift_Mime_Headers_AbstractHeader::setCharset()
Set the character set used in this Header.
Swift_Mime_Headers_AbstractHeader::setEncoder()
Set the encoder used for encoding the header.
Swift_Mime_Headers_AbstractHeader::setFieldName()
Set the name of this Header field.
Swift_Mime_Headers_AbstractHeader::setGrammar()
Set the grammar used for the header.
Swift_Mime_Headers_AbstractHeader::setLanguage()
Set the language used in this Header.
Swift_Mime_Headers_AbstractHeader::setMaxLineLength()
Set the maximum length of lines in the header (excluding EOL).
Swift_Mime_Headers_AbstractHeader::tokenNeedsEncoding()
Test if a token needs to be encoded or not.
Swift_Mime_Headers_AbstractHeader::toString()
Get this Header rendered as a RFC 2822 compliant string.
Swift_Mime_Headers_AbstractHeader::toTokens()
Generate a list of all tokens in the final header.
Swift_Mime_Headers_AbstractHeader::__toString()
Returns a string representation of this object.

Class Details

[line 16]
A Date MIME Header for Swift Mailer.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 38]

Swift_Mime_Headers_DateHeader __construct( string $name, Swift_Mime_Grammar $grammar)

Creates a new DateHeader with $name and $timestamp.

Example:

  1.  <?php
  2.  $header new Swift_Mime_Headers_DateHeader('Date'time());
  3.  ?>




Tags:

access:  public


Overrides Swift_Mime_Headers_AbstractHeader::__construct() (Creates a new Header.)

Parameters:

string   $name   of Header
Swift_Mime_Grammar   $grammar  

[ Top ]

method getFieldBody [line 115]

string 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).




Tags:



[ Top ]

method getFieldBodyModel [line 76]

mixed getFieldBodyModel( )

Get the model for the field body.

This method returns a UNIX timestamp.




Tags:

access:  public


[ Top ]

method getFieldType [line 52]

int getFieldType( )

Get the type of Header that this instance represents.



Tags:

see:  TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
see:  TYPE_DATE, TYPE_ID, TYPE_PATH
access:  public


[ Top ]

method getTimestamp [line 86]

int getTimestamp( )

Get the UNIX timestamp of the Date in this Header.



Tags:

access:  public


[ Top ]

method setFieldBodyModel [line 64]

void setFieldBodyModel( int $model)

Set the model for the field body.

This method takes a UNIX timestamp.




Tags:

access:  public


Parameters:

int   $model  

[ Top ]

method setTimestamp [line 96]

void setTimestamp( int $timestamp)

Set the UNIX timestamp of the Date in this Header.



Tags:

access:  public


Parameters:

int   $timestamp  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:47:11 +0000 by phpDocumentor 1.4.3