lib/Catalyst/Plugin/Authentication/User.pm

   1 #!/usr/bin/perl
   2
   3 package Catalyst::Plugin::Authentication::User;
   4
   5 use strict;
   6 use warnings;
   7
   8 sub id { die "virtual" }
   9
  10 sub store { die "virtual" }
  11
  12 sub supports { die "virtual" }
  13
  14 __PACKAGE__;
  15
  16 __END__
  17
  18 =pod
  19
  20 =head1 NAME
  21
  22 Catalyst::Plugin::Authentication::User - Base class for user objects.
  23
  24 =head1 SYNOPSIS
  25
  26         package MyStore::User;
  27         use base qw/Catalyst::Plugin::Authentication::User/;
  28
  29 =head1 DESCRIPTION
  30
  31 This is the base class for authenticated
  32
  33 =head1 METHODS
  34
  35 =over 4
  36
  37 =item id
  38
  39 A unique ID by which a user can be retrieved from the store.
  40
  41 =item store
  42
  43 Should return a class name that can be used to refetch the user using it's
  44 ID.
  45
  46 =item supports
  47
  48 An introspection method used to determine what features a user object has, to support credential and authorization plugins.
  49
  50 =item
  51
  52 =back
  53
  54 =cut
  55
  56