[ Index ]

MailPress 544

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    

title

Body

[close]

/mp-includes/Swiftmailer/classes/Swift/Mime/Headers/ -> AbstractHeader.php (summary)

An abstract base MIME Header.

Author: Chris Corbyn
File Size: 503 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 26 functions

  __construct()
  setCharset()
  getCharset()
  setLanguage()
  getLanguage()
  setEncoder()
  getEncoder()
  setGrammar()
  getGrammar()
  getFieldName()
  setMaxLineLength()
  getMaxLineLength()
  toString()
  __toString()
  setFieldName()
  createPhrase()
  encodeWords()
  tokenNeedsEncoding()
  getEncodableWordTokens()
  getTokenAsEncodedWord()
  generateTokenLines()
  setCachedValue()
  getCachedValue()
  clearCachedValueIf()
  toTokens()
  _tokensToString()

Functions
Functions that are not part of a class:

__construct(Swift_Mime_Grammar $grammar)   X-Ref
Creates a new Header.

param: Swift_Mime_Grammar $grammar

setCharset($charset)   X-Ref
Set the character set used in this Header.

param: string $charset

getCharset()   X-Ref
Get the character set used in this Header.

return: string

setLanguage($lang)   X-Ref
Set the language used in this Header.

For example, for US English, 'en-us'.
This can be unspecified.

param: string $lang

getLanguage()   X-Ref
Get the language used in this Header.

return: string

setEncoder(Swift_Mime_HeaderEncoder $encoder)   X-Ref
Set the encoder used for encoding the header.

param: Swift_Mime_HeaderEncoder $encoder

getEncoder()   X-Ref
Get the encoder used for encoding this Header.

return: Swift_Mime_HeaderEncoder

setGrammar(Swift_Mime_Grammar $grammar)   X-Ref
Set the grammar used for the header.

param: Swift_Mime_Grammar $grammar

getGrammar()   X-Ref
Get the grammar used for this Header.

return: Swift_Mime_Grammar

getFieldName()   X-Ref
Get the name of this header (e.g. charset).

return: string

setMaxLineLength($lineLength)   X-Ref
Set the maximum length of lines in the header (excluding EOL).

param: int $lineLength

getMaxLineLength()   X-Ref
Get the maximum permitted length of lines in this Header.

return: int

toString()   X-Ref
Get this Header rendered as a RFC 2822 compliant string.

return: string

__toString()   X-Ref
Returns a string representation of this object.

return: string

setFieldName($name)   X-Ref
Set the name of this Header field.

param: string $name

createPhrase(Swift_Mime_Header $header, $string, $charset, Swift_Mime_HeaderEncoder $encoder = null, $shorten = false)   X-Ref
Produces a compliant, formatted RFC 2822 'phrase' based on the string given.

param: Swift_Mime_Header        $header
param: string                   $string  as displayed
param: string                   $charset of the text
param: Swift_Mime_HeaderEncoder $encoder
param: bool                     $shorten the first line to make remove for header name
return: string

encodeWords(Swift_Mime_Header $header, $input, $usedLength = -1)   X-Ref
Encode needed word tokens within a string of input.

param: Swift_Mime_Header $header
param: string            $input
param: string            $usedLength optional
return: string

tokenNeedsEncoding($token)   X-Ref
Test if a token needs to be encoded or not.

param: string $token
return: bool

getEncodableWordTokens($string)   X-Ref
Splits a string into tokens in blocks of words which can be encoded quickly.

param: string $string
return: string[]

getTokenAsEncodedWord($token, $firstLineOffset = 0)   X-Ref
Get a token as an encoded word for safe insertion into headers.

param: string $token           token to encode
param: int    $firstLineOffset optional
return: string

generateTokenLines($token)   X-Ref
Generates tokens from the given string which include CRLF as individual tokens.

param: string $token
return: string[]

setCachedValue($value)   X-Ref
Set a value into the cache.

param: string $value

getCachedValue()   X-Ref
Get the value in the cache.

return: string

clearCachedValueIf($condition)   X-Ref
Clear the cached value if $condition is met.

param: bool $condition

toTokens($string = null)   X-Ref
Generate a list of all tokens in the final header.

param: string $string The string to tokenize
return: array An array of tokens as strings

_tokensToString(array $tokens)   X-Ref
Takes an array of tokens which appear in the header and turns them into
an RFC 2822 compliant string, adding FWSP where needed.

param: string[] $tokens
return: string



Generated: Thu Apr 28 18:38:52 2016 Cross-referenced by PHPXref 0.7.1