Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   5388 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

Cookie(3)	      User Contributed Perl Documentation	     Cookie(3)

NAME
       Apache::Cookie - HTTP Cookies Class

SYNOPSIS
	   use Apache::Cookie ();
	   my $r = Apache->request;
	   my $cookie = Apache::Cookie->new($r, ...);

DESCRIPTION
       The Apache::Cookie module is a Perl interface to the cookie routines in
       libapreq.  The interface is based on Lincoln Stein's CGI::Cookie mod-
       ule.

METHODS
       Apache::Cookie does not export any symbols to the caller's namespace.
       Except for the request object passed to "Apache::Cookie::new", the OO
       interface is identical to CGI::Cookie.  Please consult the CGI::Cookie
       documentation for more details.

       new

	   Just like CGI::Cookie::new, but requires an Apache request object:

		   my $cookie = Apache::Cookie->new($r,
					-name	 =>  'foo',
					-value	 =>  'bar',
					-expires =>  '+3M',
					-domain	 =>  '.capricorn.com',
					-path	 =>  '/cgi-bin/database',
					-secure	 =>  1
				       );

	   bake

	   Put cookie in the oven to bake.  (Add a Set-Cookie header to the
	   outgoing headers table.)

	       $cookie->bake;

	   parse

	   This method parses the given string if present, otherwise, the
	   incoming Cookie header:

	       my $cookies = $cookie->parse; #hash ref

	       my %cookies = $cookie->parse;

	       my %cookies = $cookie->parse($cookie_string);

	   fetch

	   Fetch and parse the incoming Cookie header:

	       my $cookies = Apache::Cookie->fetch; #hash ref

	       my %cookies = Apache::Cookie->fetch;

	   as_string

	   Format the cookie object as a string:

	    #same as $cookie->bake
	    $r->err_headers_out->add("Set-Cookie" => $cookie->as_string);

	   name

	   Get or set the name of the cookie:

	    my $name = $cookie->name;

	    $cookie->name("Foo");

	   value

	   Get or set the values of the cookie:

	    my $value = $cookie->value;
	    my @values = $cookie->value;

	    $cookie->value("string");
	    $cookie->value(\@array);

	   domain

	   Get or set the domain for the cookie:

	    my $domain = $cookie->domain;
	    $cookie->domain(".cp.net");

	   path

	   Get or set the path for the cookie:

	    my $path = $cookie->path;
	    $cookie->path("/");

	   expires

	   Get or set the expire time for the cookie:

	    my $expires = $cookie->expires;
	    $cookie->expires("+3h");

	   secure

	   Get or set the secure flag for the cookie:

	    my $secure = $cookie->secure;
	    $cookie->secure(1);

CAVEATS
	   The underlying C code for the Apache::Cookie module presents some
	   unexpected results for Perl programmers when dealing with null
	   bytes ('\0's) inside cookies.  Native C commonly uses "null-termi-
	   nated strings" when storing scalar string values. This means that C
	   uses a '\0' byte to mark the end of the string(EOS). What this
	   means for Perl programmers is that if you wish to create a cookie
	   with a '\0' byte, the underlying C library will simply truncate the
	   value at the '\0' byte.  A cookie with the value '\0' will simi-
	   larly simply be ignored, as the C library will not detect any con-
	   tent whatsoever.  This problem is solved in the libapreq-2.0
	   library.

BUGS
       RFC 2964-5 are not fully implemented.
       "value" should also accept a hash ref as argument.

SEE ALSO
       Apache(3), Apache::Request(3), CGI::Cookie(3)

LICENSE
	  Copyright 2000-2004  The Apache Software Foundation

	  Licensed under the Apache License, Version 2.0 (the "License");
	  you may not use this file except in compliance with the License.
	  You may obtain a copy of the License at

	      http://www.apache.org/licenses/LICENSE-2.0

	  Unless required by applicable law or agreed to in writing, software
	  distributed under the License is distributed on an "AS IS" BASIS,
	  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	  See the License for the specific language governing permissions and
	  limitations under the License.

perl v5.8.8			  2004-11-26			     Cookie(3)

                             _         _         _ 
                            | |       | |       | |     
                            | |       | |       | |     
                         __ | | __ __ | | __ __ | | __  
                         \ \| |/ / \ \| |/ / \ \| |/ /  
                          \ \ / /   \ \ / /   \ \ / /   
                           \   /     \   /     \   /    
                            \_/       \_/       \_/ 

Vote for polarhome