NAME

EWS::dictCookies -- dictionary cookies class.


SYNOPSIS

 use EWS::dictCookies;

 $cookie = new EWS::dictCookies(-debug => 0, -io=>$baseIO);

 %cookies = $cookie->cookies;

 $cookie->setPhrase($phrase, $cookie->ExpirationDate(60 * 60 * 24 * 7));

 $cookie->setMatch($match, $cookie->ExpirationDate(60 * 60 * 24 * 365));

 $cookie->setDict($dict, $cookie->ExpirationDate(60 * 60 * 24 * 365));

 $cookie->setDictd($dictd, $cookie->ExpirationDate(60 * 60 * 24 * 365));

 undef $cookie;

DESCRIPTION

EWS::dictCookies is an object class derived from the EWS::cookies object class and provides additional methods specific to manipulating persistent cookies for the dictionary.pl cgi application.

The call to new returns a blessed reference to a new object of class dictCookies. This object allows access to all of the methods provided by EWS::cookies as well as the dictionary.pl-specific methods.

new

$cookies = new EWS::dictCookies(%parameters);

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      returns a blessed reference to a new dictCookies object.

    parameters are of the form:

      -arg => value

    acceptable values are:
      -debug => 1 = debug messages
      -io    => baseIO object
      -path  => default cookie path

phrase

Set phrase cookie, send to user-agent, and return result.

    Enter:
      $phrase = 'phrase' cookie value (undef = do not change anything).
      $expiration = valid formatted RFC2109 expiration date, in seconds.
    Exit:
      $phrase = current phrase value.

match

Set match cookie, send to user-agent, and return result.

    Enter:
      $match = 'match' cookie value.
      $expiration = valid formatted RFC2109 expiration date, in seconds.
    Exit:
      SendCookie result

dict

Set dictionary cookie, send to user-agent, and return result.

    Enter:
      $dict = 'dictionary' cookie value.
      $expiration = valid formatted RFC2109 expiration date, in seconds.
    Exit:
      SendCookie result

dictd

Set dictd server cookie, send to user-agent, and return result.

    Enter:
      $dictd = 'dictd server' cookie value.
      $expiration = valid formatted RFC2109 expiration date, in seconds.
    Exit:
      SendCookie result

UTILITY PUBLIC METHODS

Revision

The Revision method returns the revision number of dictCookies.pm:

      $cookie_revision = $cookie->Revision;

    Enter:
      none.
    Exit:
      current revision string.

Version

The Version method returns the version number of dictCookies.pm:

      $cookie_version = $cookie->Version;

    Enter:
      none.
    Exit:
      current version string.

PRIVATE METHODS

_set

Set cookie, send to user-agent, and return result.

    Enter:
      $name       = cookie name
      $value      = cookie value (undef = do not change anything).
      $expiration = valid formatted RFC2109 expiration date, in seconds.
    Exit:
      $value = current cookie value.

AUTHORS

Jay Wheeler (jaywheeler@geocities.com), EarthWalk Software.

http://www.geocities.com/jaywheeler.geo

COPYRIGHT

dictCookies.pm is copyright © 2002. EarthWalk Software.

This module is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This module is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this script; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA, or from the Free Software Foundation web page at

    http://www.fsf.org/licenses/lgpl.txt