CF - Class Overview
-------------------
This file describes the workings of the CF class.
For complete examples, refer to the docs/examples/ in the
package directory.

Instance Variables:
-------------------

  Name      Type    Description
  --------------------------------------------------------
  score     float   The spam score.
  error     array   Scanning errors, if any.
  log       array   Log of the scanning, contains detailed
                    info about the examination of the text
                    and email.

Instance Methods:
-----------------

  Contructor:
  -----------
    CF ( string text [, string email] )
  
    Description:
        Instantiates the object and scans text (and email if any).

    Example:
        $cf = new CF($text, $email);

  hasError:
  ---------
    bool hasError (void)

    Description:
        Returns true if any errors has been encountered while processing
        the text. Refer to the instance variable 'error' for error
        messages.
        These errors can be if an internal function has failed to execute
        or other internal workings of phpCF has failed in some way.

    Example:
        if ($cf->hasError()) {
            // Print last error message and exit.
            echo $cf->getLastError();
            exit;
        }

  printErrorList:
  ---------------
    void printError (void)

    Description:
        Prints out an incredibly beautiful HTML-list (using <ul> and <li>)
        of the errors encountered during processing (if any). For a raw array
        of error messages, please refer to the instance variable 'error'.

    Example:
        $cf->printError();

  isSpam:
  -------
    bool isSpam (void)

    Description:
        Compares the score with the threshold and returns true if the
        spam score is greater than the defined threshold.

    Example:
        if ($cf->isSpam()) {
            die("Don't spam me!");
        }

  printLog:
  ---------
    void printLog (void)

    Description:
        Prints a nicely formatted HTML list (using <ul> and <li>) of the
        log entries.

    Example:
        $cf->printLog();


  availableChecks:
  ----------------
    array availableChecks (void)

    Description:
        Returns an array of the available methods for checking content.

  availableEmailChecks:
  ---------------------
    array availableEmailChecks (void)

    Desciption:
        Returns an array of the available methods for checking email
        addresses.

  getThreshold:
  -------------
    float getThreshold (void)

    Desciption:
        Returns the currently configured spam threshold.