From f349e998a05f6b8743f71fd8b864ab87328a0bda Mon Sep 17 00:00:00 2001 From: Xavier Guimard Date: Sun, 13 Oct 2013 06:44:56 +0000 Subject: [PATCH] Add POD --- .../lib/Lemonldap/NG/Portal/AuthWebID.pm | 84 +++++++++++++++++++ 1 file changed, 84 insertions(+) diff --git a/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/AuthWebID.pm b/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/AuthWebID.pm index 4a4cdef0d..2104c06fe 100644 --- a/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/AuthWebID.pm +++ b/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/AuthWebID.pm @@ -88,3 +88,87 @@ sub extractFormInfo { } 1; __END__ + +=head1 NAME + +=encoding utf8 + +Lemonldap::NG::Portal::AuthWebID - Perl extension for building Lemonldap::NG +compatible portals with WebID authentication. + +=head1 SYNOPSIS + + use Lemonldap::NG::Portal::SharedConf; + my $portal = new Lemonldap::NG::Portal::Simple( + configStorage => {...}, # See Lemonldap::NG::Portal + authentication => 'WebID', + ); + + if($portal->process()) { + # Write here the menu with CGI methods. This page is displayed ONLY IF + # the user was not redirected here. + print $portal->header('text/html; charset=utf8'); # DON'T FORGET THIS (see CGI(3)) + print "..."; + } + else { + # If the user enters here, IT MEANS THAT CAS REDIRECTION DOES NOT WORK + print $portal->header('text/html; charset=utf8'); # DON'T FORGET THIS (see CGI(3)) + print "

Unable to work

"; + print "This server isn't well configured. Contact your administrator."; + print ""; + } + +=head1 DESCRIPTION + +This library just overload few methods of Lemonldap::NG::Portal::Simple to use +WebID authentication mechanism. + +See L for usage and other methods. + +=head1 SEE ALSO + +L, L, +L, L +L + +=head1 AUTHOR + +=over + +=item Xavier Guimard, Ex.guimard@free.frE + +=back + +=head1 BUG REPORT + +Use OW2 system to report bug or ask for features: +L + +=head1 DOWNLOAD + +Lemonldap::NG is available at +L + +=head1 COPYRIGHT AND LICENSE + +=over + +=item Copyright (C) 2013 by Xavier Guimard, Ex.guimard@free.frE + +=back + +This library is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see L. + +=cut +