MailinglistHeader Class Reference

class MailinglistHeader More...

Public Member Functions
	__construct ($str)
	__construct() More...
	get_atom ()
	get_atom() More...
	get_dot_atom ()
	get_dot_atom() More...
	get_token ()
	get_token() More...
	get_value ()
	get_value() More...
	skip_ws ()
	Skip White Space. More...
	skip_cws ()
	Skip Comments or whitespace. More...
	skip_comment ()
	Skip Comment. More...
	get_char ()
	get_char() More...
	push_back ($char)
	push_back() More...

Private Member Functions
	get_chunk ($chars)
	get_chunk() More...

Private Attributes
	$header
	The header being processed. More...

Detailed Description

class MailinglistHeader

a helper class for parsing EMail Headers

todo update nameing conventions.

Definition at line 113 of file MailinglistMessage.class.php.

Constructor & Destructor Documentation

__construct

(

$str

)

__construct()

Parameters

$str	String with value of header to process

Definition at line 121 of file MailinglistMessage.class.php.

                             {
    $this->header = $str;
  }

Member Function Documentation

get_atom

(

)

get_atom()

Get an atom.

Definition at line 130 of file MailinglistMessage.class.php.

References get_chunk(), mailinglist_message_rfc2047(), and skip_ws().

Referenced by get_dot_atom().

                      {
    static $atext = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!#$%&'*+-/=?^_`{}|~";
    $this->skip_ws();
    $str = $this->get_chunk($atext);
    $str = mailinglist_message_rfc2047($str);
    return $str;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

get_char

(

)

get_char()

Get a character from the header being processed

Definition at line 244 of file MailinglistMessage.class.php.

Referenced by get_chunk(), get_dot_atom(), get_value(), skip_comment(), and skip_cws().

                      {
    if (!empty($this->header)) {
      $char = $this->header[0];
      $this->header = substr($this->header, 1);
      return $char;
    }
    else {
      return FALSE;
    }
  }

Here is the caller graph for this function:

get_chunk (   $chars )

private

get_chunk()

get a chunck of characters belonging to a class

Definition at line 189 of file MailinglistMessage.class.php.

References get_char().

Referenced by get_atom(), and get_token().

                                     {
    $token = "";
    while (!empty($this->header) && strpos($chars, $this->header[0]) !== FALSE) {
      $token .= $this->get_char();
    }
    return $token;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

get_dot_atom

(

)

get_dot_atom()

get a dotted atom.

Definition at line 143 of file MailinglistMessage.class.php.

References get_atom(), and get_char().

                          {
    $atom = $this->get_atom();
    while ($this->header[0] == '.') {
      $atom += $this->get_char();
      $atom += $this->get_atom();
    }
    return $atom;
  }

Here is the call graph for this function:

get_token

(

)

get_token()

Definition at line 156 of file MailinglistMessage.class.php.

References get_chunk(), and skip_ws().

Referenced by get_value().

                       {
    static $ttext = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!#$%&'*+-^_`{}|~.";
    $this->skip_ws();
    return $this->get_chunk($ttext);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

get_value

(

)

get_value()

Get a value ( token / qstring )

Definition at line 166 of file MailinglistMessage.class.php.

References get_char(), get_token(), and skip_ws().

                       {
    $this->skip_ws();
    if ($this->header[0] == '"') {
      $token = "";
      $this->get_char();
      while (($char = $this->get_char()) != '"' && $char !== FALSE) {
        if ($char == '\\') {
          $char = $this->get_char();
        }
        $token .= $char;
      }
      return $token;
    }
    else{
      return $this->get_token();
    }
  }

Here is the call graph for this function:

push_back

(

$char

)

push_back()

push a character/string back into header

Definition at line 259 of file MailinglistMessage.class.php.

References $header.

                            {
    $this->header = $char . $this->header;
  }

skip_comment

(

)

Skip Comment.

Assumes the leading ( has already been removed by production calling us.

Production Name: comment

Definition at line 228 of file MailinglistMessage.class.php.

References get_char().

Referenced by skip_cws().

                          {
    while (($char = $this->get_char()) != ')') {
      if ($char == '\\') {
        $this->get_char();  // Quoted char, so ignore the next
      }
      elseif ($char == '(') {
        $this->skip_comment();  // Nested comment
      }
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

skip_cws

(

)

Skip Comments or whitespace.

Production name: CFWS

Definition at line 212 of file MailinglistMessage.class.php.

References get_char(), and skip_comment().

                      {
    while (ctype_space($char = $this->header[0]) || $char == '(') {
      $this->get_char();
      if ($char == '(') {
        $this->skip_comment();
      }
    }
  }

Here is the call graph for this function:

skip_ws

(

)

Skip White Space.

Production Name: FWS, *WSP

Definition at line 201 of file MailinglistMessage.class.php.

Referenced by get_atom(), get_token(), and get_value().

                     {
    while (ctype_space($this->header[0])) {
      $this->header = substr($this->header, 1);
    }
  }

Here is the caller graph for this function:

Field Documentation

$header

private

The header being processed.

Definition at line 114 of file MailinglistMessage.class.php.

Referenced by push_back().

---

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

• mailinglist/plugins/mailinglist/retrieve/MailinglistMessage.class.php