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

Class: Swift_Mime_Grammar

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

Class Overview


Defines the grammar to use for validation, implements the RFC 2822 (and friends) ABNF grammar definitions.


Author(s):

  • Fabien Potencier
  • Chris Corbyn

Methods



Class Details

[line 17]
Defines the grammar to use for validation, implements the RFC 2822 (and friends) ABNF grammar definitions.



Tags:

author:  Fabien Potencier
author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 36]

Swift_Mime_Grammar __construct( )

Initialize some RFC 2822 (and friends) ABNF grammar definitions.



Tags:

access:  public


[ Top ]

method escapeSpecials [line 168]

string escapeSpecials( string $token, [string[] $include = array()], [string[] $exclude = array()])

Escape special characters in a string (convert to quoted-pairs).



Tags:

access:  public


Parameters:

string   $token  
string[]   $include   additional chars to escape
string[]   $exclude   chars from escaping

[ Top ]

method getDefinition [line 128]

string getDefinition( string $name)

Get the grammar defined for $name token.



Tags:

access:  public


Parameters:

string   $name   exactly as written in the RFC

[ Top ]

method getGrammarDefinitions [line 144]

array getGrammarDefinitions( )

Returns the tokens defined in RFC 2822 (and some related RFCs).



Tags:

access:  public


[ Top ]

method getSpecials [line 154]

array getSpecials( )

Returns the current special characters used in the syntax which need to be escaped.



Tags:

access:  public


[ Top ]

method init [line 46]

void init( )



Tags:

access:  protected


[ Top ]

method __wakeup [line 41]

void __wakeup( )



Tags:

access:  public


[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:49:24 +0000 by phpDocumentor 1.4.3