X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FSession%2FState%2FCookie.pm;h=2e7a2a13eb52508133d875de96be9b84c71c0030;hb=50dacea227c6f6f2c2304af24784beeb857b8eb6;hp=369a215d4b004913d0788fcff3508194fc5a5b5c;hpb=d612a8fca19e9aa02a6dc6ada6fc82b7e09ff119;p=catagits%2FCatalyst-Plugin-Session-State-Cookie.git diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index 369a215..2e7a2a1 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -139,12 +139,9 @@ sub delete_session_id { $c->maybe::next::method($sid); } -__PACKAGE__ - +1; __END__ -=pod - =head1 NAME Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies. @@ -232,14 +229,14 @@ user's browser is shut down. If this attribute B the cookie will not have the secure flag. If this attribute B (or true for backward compatibility) - the cookie -send by the server to the client will got the secure flag that tells the browser -to send this cookies back to the server only via HTTPS. +sent by the server to the client will get the secure flag that tells the browser +to send this cookie back to the server only via HTTPS. -If this attribute B then the cookie will got the secure flag only if +If this attribute B then the cookie will get the secure flag only if the request that caused cookie generation was sent over https (this option is -not good if you are mixing https and http in you application). +not good if you are mixing https and http in your application). -Default vaule is 0. +Default value is 0. =item cookie_httponly @@ -253,10 +250,10 @@ a browser is not aware of HTTPOnly the flag will be ignored. Default value is 1. -Note1: Many peole are confused by the name "HTTPOnly" - it B +Note1: Many people are confused by the name "HTTPOnly" - it B that this cookie works only over HTTP and not over HTTPS. -Note2: This paramater requires Catalyst::Runtime 5.80005 otherwise is skipped. +Note2: This parameter requires Catalyst::Runtime 5.80005 otherwise is skipped. =item cookie_path @@ -266,20 +263,20 @@ The path of the request url where cookie should be baked. For example, you could stick this in MyApp.pm: - __PACKAGE__->config( 'Plugin::Session' => { - cookie_domain => '.mydomain.com', - }); + __PACKAGE__->config( 'Plugin::Session' => { + cookie_domain => '.mydomain.com', + }); =head1 CAVEATS Sessions have to be created before the first write to be saved. For example: - sub action : Local { - my ( $self, $c ) = @_; - $c->res->write("foo"); - $c->session( ... ); - ... - } + sub action : Local { + my ( $self, $c ) = @_; + $c->res->write("foo"); + $c->session( ... ); + ... + } Will cause a session ID to not be set, because by the time a session is actually created the headers have already been sent to the client. @@ -290,20 +287,26 @@ L, L. =head1 AUTHORS -Yuval Kogman Enothingmuch@woobling.orgE +Yuval Kogman =head1 CONTRIBUTORS This module is derived from L code, and has been heavily modified since. - Andrew Ford - Andy Grundman - Christian Hansen - Marcus Ramberg - Jonathan Rockway Ejrockway@cpan.orgE - Sebastian Riedel - Florian Ragwitz +Andrew Ford + +Andy Grundman + +Christian Hansen + +Marcus Ramberg + +Jonathan Rockway + +Sebastian Riedel + +Florian Ragwitz =head1 COPYRIGHT @@ -317,5 +320,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;