OpenFrame::WebApp::Segment::User::Session - abstract class for working with

OpenFrame-WebApp documentation Contained in the OpenFrame-WebApp distribution.

Index

Code Index:

NAME

Top

OpenFrame::WebApp::Segment::User::Session - abstract class for working with users stored in sessions.

SYNOPSIS

Top

  # abstract - cannot be used directly

  # set session key:
  $OpenFrame::WebApp::Segment::User::Session::USER_KEY = 'my_user';

DESCRIPTION

Top

This class contains tools for working with users stored in sessions.

Inherits from OpenFrame::WebApp::Segment::Session.

METHODS

Top

$bool = $obj->save_user_in_session()

saves user in the stored session, using $USER_KEY.

$user = $obj->get_user_from_session()

gets user from the stored session, using $USER_KEY.

AUTHOR

Top

Steve Purkis <spurkis@epn.nu>

COPYRIGHT

Top

Copyright (c) 2003 Steve Purkis. All rights reserved. Released under the same license as Perl itself.

SEE ALSO

Top

OpenFrame::WebApp::User, OpenFrame::WebApp::Segment::Session, OpenFrame::WebApp::Segment::User::SessionLoader, OpenFrame::WebApp::Segment::User::SaveInSession

OpenFrame-WebApp documentation Contained in the OpenFrame-WebApp distribution. 
package OpenFrame::WebApp::Segment::User::Session;

use strict;
use warnings::register;

use base qw( OpenFrame::WebApp::Segment::Session );

our $VERSION  = (split(/ /, '$Revision: 1.1 $'))[1];
our $USER_KEY = 'user';

sub save_user_in_session {
    my $self    = shift;
    my $user    = shift;
    my $session = $self->get_session_from_store || return;
    $session->set( $USER_KEY, $user );
    return 1;
}

sub get_user_from_session {
    my $self    = shift;
    my $session = $self->get_session_from_store || return;
    return $session->get( $USER_KEY );
}


1;

__END__