HTMLObject::ReadCookie(3)

NAME
HTMLObject::ReadCookie - Perl extension for HTMLObject.

SYNOPSIS
  use HTMLObject::ReadCookie;
  my $cookies = HTMLObject::ReadCookie->new;
  my %cookies = $cookies->getCookies;

  # print all cookies gathered.
  foreach my $cookie (keys %cookies)
  {
    print "Cookie = '$cookie' has value = '" . $cookies->cookies->{$cookie} . "'\n";
  }

  if (exists $cookies->cookies->{'cookie name'})
  {
    print "Cookie 'cookie name' exists!\n";
  }

DESCRIPTION
The ReadCookie module allows you to check for the existance of cookies that were set via the HTMLObject set_cookie method. You can retrieve the value(s) of any cookie you set and then proceed to work with them as necessary. This is much easier to work with than HTMLObject::GetCookie.

Exported FUNCTIONS
  obj new(void)
    Instantiates an instance of the ReadCookie object.

  scalar decode_string( string => '' )
    un-URI encodes the string and returns it.

  scalar decodeString( string => '' )
    un-URI encodes the string and returns it.

  hash GetCookies(cookies)
    Takes:      cookies - array of cookie names or Nothing.
    Returns:    hash of cookies found, empty if none found.

  hash getCookies(cookies)
    Takes:      cookies - array of cookie names or Nothing.
    Returns:    hash of cookies found, empty if none found.

  hash GetCompressedCookies(cname, names)
    This takes the compressed cookie name (cname), and optionally the names of
    specific cookies you want returned and uncompresses them, setting the
    values into %cookies.  Specific names of cookies are optional and if
    not specified all cookies found in the compressed cookie will be set.
    Takes -     cname - Name of the compressed cookie to be uncompressed.
                names - Optional array of names of cookies to be returned
                    from the compressed cookie if you don't want them all.
    Returns:    hash of cookies found, empty if none found.

  hash getCompressedCookies(cname, names)
    This takes the compressed cookie name (cname), and optionally the names of
    specific cookies you want returned and uncompresses them, setting the
    values into %cookies.  Specific names of cookies are optional and if
    not specified all cookies found in the compressed cookie will be set.
    Takes -     cname - Name of the compressed cookie to be uncompressed.
                names - Optional array of names of cookies to be returned
                    from the compressed cookie if you don't want them all.
    Returns:    hash of cookies found, empty if none found.

  The Global hash %Cookies is now %cookies.

AUTHOR
James A. Pattie, htmlobject@pcxperience.com

SEE ALSO
perl(1), HTMLObject::Base(3), HTMLObject::Normal(3), HTMLObject::FrameSet(3).