The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

RCLAMP / OpenFrame-3.05 / lib / OpenFrame / Cookies.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
—
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

              
package OpenFrame::Cookies;
use strict;
use warnings::register;
our $VERSION=3.05;
use OpenFrame::Cookie;
use OpenFrame::Object;
use base qw ( OpenFrame::Object );
sub init {
  my $self = shift;
  $self->cookies( {} );
}
sub cookies {
  my $self = shift;
  my $val  = shift;
  if (defined( $val )) {
    $self->{cookies} = $val;
    return $self;
  } else {
    return $self->{cookies};
  }
}
sub set {
  my $self = shift;
  my $key  = shift;
  my $val  = shift;
  if (defined($key) && !defined($val)) {
    ## chances are we have a Cookie object
    if ($key->isa('OpenFrame::Cookie')) {
      ## get the name out of the cookie, and we store it
      $self->cookies->{ $key->name } = $key;
    } else {
      $self->error("object $key is not an OpenFrame::Cookie");
      return undef;
    }
  } elsif (defined($key) && defined($val)) {
    ## right, we have a key value pair that we need to turn
    ## into an OpenFrame::Cookie object
    my $cookie = OpenFrame::Cookie->new();
    $cookie->name( $key );
    $cookie->value( [ $val ] );
    ## call this method again with the cookie as the parameter
    $self->set( $cookie );
  } else {
    $self->error("usage: ->set( <COOKIE || KEY, VALUE> )");
  }
}
sub get {
  my $self = shift;
  my $key  = shift;
  if (defined( $key )) {
    return $self->cookies->{ $key };
  } else {
    $self->error("no key specified");
  }
}
sub delete {
  my $self = shift;
  my $key  = shift;
  if (defined( $key )) {
    delete $self->{ cookies }->{ $key };
  } else {
    $self->error("no key specified");
  }
}
sub get_all {
  my $self = shift;
  return %{$self->cookies};
}
1;
__END__
=head1 NAME
OpenFrame::Cookies - An abstract cookie class
=head1 SYNOPSIS
  use OpenFrame;
  my $cookies = OpenFrame::Cookies->new();
  $cookies->set("animal" => "parrot");
  my $colour = $cookies->get("colour")->value;
  $cookies->delete("colour");
  my %cookies = $cookies->get_all();
=head1 DESCRIPTION
C<OpenFrame::Cookies> represents cookies inside OpenFrame. Cookies in
OpenFrame represent some kind of storage option on the requesting
side.
Cookies are a general mechanism which server side connections can use
to both store and retrieve information on the client side of the
connection. The addition of a simple, persistent, client-side state
significantly extends the capabilities of Web-based client/server
applications. C<OpenFrame::Cookies> is an abstract cookie class
for OpenFrame which can represent cookies no matter how they really
come to exist outside OpenFrame (such as CGI or Apache cookie
objects).
=head1 METHODS
=head2 new()
The new() method creates a new C<OpenFrame::Cookies>
object. These can hold multiple cookies (although they must have
unique names) inside the cookie tin.
  my $cookies = OpenFrame::Cookies->new();
=head2 set()
The set() method adds an entry:
  $cookies->set("animal" => "parrot");
=head2 get()
The get() method returns a cookie (a C<OpenFrame::Cookie> object)
given its name:
  my $colour = $cookies->get("colour")->value;
=head2 delete()
The delete() method removes a cookie element given its name:
  $cookies->delete("colour");
=head2 get_all()
The get_all() method returns a hash of all the cookies:
  my %cookies = $cookies->get_all();
=head1 AUTHOR
James Duncan <jduncan@fotango.com>,
Leon Brocard <leon@fotango.com>
=cut