NAME

       Apache::Session::Browseable - Add index and search methods to Apache::Session

SYNOPSIS

         use Apache::Session::Browseable::MySQL;

         my $args = {
              DataSource => 'dbi:mysql:sessions',
              UserName   => $db_user,
              Password   => $db_pass,
              LockDataSource => 'dbi:mysql:sessions',
              LockUserName   => $db_user,
              LockPassword   => $db_pass,

              # Choose your browseable fileds
              Index          => 'uid mail',
         };

         # Use it like Apache::Session
         my %session;
         tie %session, 'Apache::Session::Browseable::MySQL', $id, $args;
         $session{uid} = 'me';
         $session{mail} = 'me@me.com';
         $session{unindexedField} = 'zz';
         untie %session;

         # Apache::Session::Browseable add some global class methods
         #
         # 1) search on a field (indexed or not)
         # a. get full sessions
         my $hash = Apache::Session::Browseable::MySQL->searchOn( $args, 'uid', 'me' );
         foreach my $id (keys %$hash) {
           print $id . ":" . $hash->{$id}->{mail} . "\n";
         }
         # b. get only some fields
         my $hash = Apache::Session::Browseable::MySQL->searchOn( $args, 'uid', 'me', 'mail', 'uid' );
         foreach my $id (keys %$hash) {
           print $id . ":" . $hash->{$id}->{mail} . "\n";
           print "       " . $hash->{$id}->{uid} . "\n";
         }
         # c. search with a pattern
         my $hash = Apache::Session::Browseable::MySQL->searchOnExpr( $args, 'uid', 'm*' );
         ...

         # 2) Parse all sessions
         # a. get all sessions
         my $hash = Apache::Session::Browseable::MySQL->get_key_from_all_sessions($args);

         # b. get some fields from all sessions
         my $hash = Apache::Session::Browseable::MySQL->get_key_from_all_sessions($args, ['uid','mail'])

         # c. execute something with datas from each session :
         #    Example : get uid and mail if mail domain is
         my $hash = Apache::Session::Browseable::MySQL->get_key_from_all_sessions(
                     $args,
                     sub {
                        my ( $session, $id ) = @_;
                        if ( $session->{mail} =~ /mydomain.com$/ ) {
                            return { $session->{uid}, $session->{mail} };
                        }
                     }
         );
         foreach my $id (keys %$hash) {
           print $id . ":" . $hash->{$id}->{uid} . "=>" . $hash->{$id}->{mail} . "\n";
         }

DESCRIPTION

       Apache::Session::browseable provides some class methods to manipulate all sessions and add
       the capability to index some fields to make research faster.

SEE ALSO

       Apache::Session

AUTHOR

       Xavier Guimard, <x.guimard@free.fr>

COPYRIGHT AND LICENSE

       Copyright (C) 2009-2013 by Xavier Guimard
                     2013 by Clement Oudot

       This library is free software; you can redistribute it and/or modify it under the same
       terms as Perl itself, either Perl version 5.10.1 or, at your option, any later version of
       Perl 5 you may have available.