Skip Menu |
 

This queue is for tickets about the CGI-Session CPAN distribution.

Report information
The Basics
Id: 8566
Status: resolved
Priority: 0/
Queue: CGI-Session

People
Owner: Nobody in particular
Requestors: dsiegal [...] thecsl.org
Cc:
AdminCc:

Bug Information
Severity: Unimportant
Broken in: 3.95
Fixed in: (no value)



Subject: Suggested change in documentation.
Download (untitled) / with headers
text/plain 377b
I would just like to suggest that CGI::Session documentation for the param() method explain that $value can be an array or hash reference. I realize now that this information is in the tutorial. But since the module documentation appears to be the API specification, it is probably more important that it be mentioned there. (I know it would have saved me some time...) Thanks!
From: markstos [...] cpan.org
Download (untitled) / with headers
text/plain 514b
[guest - Mon Nov 22 17:11:26 2004]: Show quoted text
> I would just like to suggest that CGI::Session documentation for the > param() method explain that $value can be an array or hash > reference. I realize now that this information is in the tutorial. > But since the module documentation appears to be the API > specification, it is probably more important that it be mentioned > there. (I know it would have saved me some time...) > Thanks!
Attached is a patch against 4.00_08 which resolves this.
Download param.patch
text/x-diff 1k
Mon Jul 4 15:55:45 EST 2005 Mark Stosberg <mark@summersault.com> * document that param values may also be a hashref or arrayref There are already automated tests that confirm this. diff -rN -u old-cgi-session/lib/CGI/Session.pm new-cgi-session/lib/CGI/Session.pm --- old-cgi-session/lib/CGI/Session.pm 2005-07-04 15:56:51.000000000 -0500 +++ new-cgi-session/lib/CGI/Session.pm 2005-07-04 15:55:42.000000000 -0500 @@ -778,8 +778,12 @@ =item param(-name=E<gt>$name, -value=E<gt>$value) -Used in either of the above syntax assigns a new value to $name parameter, which can later be retrieved with previously introduced -param() syntax. Attempt setting parameter names that start with I<_SESSION_> will trigger warning and undef will be returned. +Used in either of the above syntax assigns a new value to $name parameter, +which can later be retrieved with previously introduced param() syntax. C<$value> +may be a scalar, arrayref or hashref. + +Attempts to set parameter names that start with I<_SESSION_> will trigger +a warning and undef will be returned. =item param_hashref()


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.