Commit f96f94ba authored by Xavier Guimard's avatar Xavier Guimard

Portal POD update

parent 9cdefde0
package Lemonldap::NG::Portal;
print STDERR "See Lemonldap::NG::Portal(3) to know which Lemonldap::NG::Portal::* module to use.";
our $VERSION = "0.5";
our $VERSION = "0.51";
1;
......@@ -16,11 +16,14 @@ system.
=head1 SYNOPSIS
use Lemonldap::NG::Portal::SharedConf::DBI;
my $portal = new Lemonldap::NG::Portal::SharedConf::DBI (
dbiChain => "dbi:mysql:database=lmSessions;host=1.2.3.4",
dbiUser => "lemon",
dbiPassword => "pass",
use Lemonldap::NG::Portal::SharedConf;
my $portal = new Lemonldap::NG::Portal::SharedConf (
configStorage => {
type => 'DBI',
dbiChain => "dbi:mysql:database=lmSessions;host=1.2.3.4",
dbiUser => "lemon",
dbiPassword => "pass",
},
);
......@@ -261,17 +264,13 @@ scheme to use X509 authentication,
=item * L<Lemonldap::NG::Portal::SharedConf>: this module provide the ability
to read portal configuration from a central database. It inherits from
L<Lemonldap::NG::Portal::Simple>,
=item * L<Lemonldap::NG::Portal::SharedConf::DBI>: this module inherits from
L<Lemonldap::NG::Portal::SharedConf> and read portal configuration from a
central database using DBI.
L<Lemonldap::NG::Portal::Simple>. It's the more used module.
=back
=head1 SEE ALSO
L<Lemonldap::NG::Portal::SharedConf::DBI>,
L<Lemonldap::NG::Portal::SharedConf>,
L<Lemonldap::NG::Handler>, L<Lemonldap::NG::Manager>
=head1 AUTHOR
......
......@@ -3,7 +3,7 @@ package Lemonldap::NG::Portal::AuthSSL;
use strict;
use Lemonldap::NG::Portal::Simple;
our $VERSION = '0.02';
our $VERSION = '0.03';
# Authentication is made here before searching the LDAP Directory
our $OVERRIDE = {
......
......@@ -8,7 +8,7 @@ use Lemonldap::NG::Manager::Conf;
*EXPORT_TAGS = *Lemonldap::NG::Portal::Simple::EXPORT_TAGS;
*EXPORT = *Lemonldap::NG::Portal::Simple::EXPORT;
our $VERSION = "0.3";
our $VERSION = "0.31";
our @ISA = qw(Lemonldap::NG::Portal::Simple);
sub getConf {
......@@ -60,7 +60,7 @@ sub setGroups {
# MUST BE WRITTEN and contain
# my $self = shift;
# $self->SUPER::new(@_);
# See Lemonldap::NG::Portal::SharedConf::DBI for example
# See Lemonldap::NG::Portal::SharedConf for example
#
# return true or false
#}
......@@ -137,13 +137,16 @@ compatible portals using a central configuration database.
=head1 SYNOPSIS
use Lemonldap::NG::Portal::SharedConf::DBI;
my $portal = new Lemonldap::NG::Portal::SharedConf::DBI(
dbiChain => "dbi:mysql:...",
dbiUser => "lemonldap",
dbiPassword => "password",
dbiTable => "lmConfig",
);
use Lemonldap::NG::Portal::SharedConf;
my $portal = new Lemonldap::NG::Portal::SharedConf( {
configStorage => {
type => 'DBI',
dbiChain => "dbi:mysql:...",
dbiUser => "lemonldap",
dbiPassword => "password",
dbiTable => "lmConfig",
},
} );
if($portal->process()) {
# Write here the menu with CGI methods. This page is displayed ONLY IF
......@@ -176,7 +179,7 @@ Lemonldap::NG::Portal::SharedConf is the base module for building Lemonldap::NG
compatible portals using a central database configuration. You have to use by
inheritance.
See L<Lemonldap::NG::Portal::SharedConf::DBI> for a complete example.
See L<Lemonldap::NG::Portal::SharedConf> for a complete example.
=head1 METHODS
......@@ -204,7 +207,7 @@ Same as L<Lemonldap::NG::Portal::Simple>.
=head1 SEE ALSO
L<Lemonldap::NG::Portal>, L<Lemonldap::NG::Portal::SharedConf::DBI>,
L<Lemonldap::NG::Portal>, L<Lemonldap::NG::Portal::SharedConf>,
L<Lemonldap::NG::Handler>, L<Lemonldap::NG::Manager>
=head1 AUTHOR
......
......@@ -12,18 +12,18 @@ use MIME::Base64;
*EXPORT_TAGS = *Lemonldap::NG::Portal::SharedConf::EXPORT_TAGS;
*EXPORT = *Lemonldap::NG::Portal::SharedConf::EXPORT;
our $VERSION = '0.3';
our $VERSION = '0.31';
our @ISA = qw(Lemonldap::NG::Portal::SharedConf);
sub getConf {
my($self, $args) = @_;
$self->{configStorage} = {
type => "DBI",
dbiChain => $self->{dbiChain},
dbiUser => $self->{dbiUser},
dbiPassword => $self->{dbiPassword},
dbiTable => $self->{dbiTable},
type => "DBI",
dbiChain => $self->{dbiChain},
dbiUser => $self->{dbiUser},
dbiPassword => $self->{dbiPassword},
dbiTable => $self->{dbiTable},
};
$self->SUPER::getConf(@_);
}
......@@ -33,18 +33,20 @@ __END__
=head1 NAME
Lemonldap::NG::Portal::SharedConf::DBI - Module for building Lemonldap::NG
compatible portals using a central configuration database using L<DBI>.
Lemonldap::NG::Portal::SharedConf::DBI - This module is deprecated. See
L<Lemonldap::NG::Portal::SharedConf>.
=head1 SYNOPSIS
use Lemonldap::NG::Portal::SharedConf::DBI;
my $portal = new Lemonldap::NG::Portal::SharedConf::DBI(
dbiChain => "dbi:mysql:database=lemonldap;host=127.0.0.1",
dbiUser => "lemonldap",
dbiPassword => "password",
dbiTable => "lmConfig",
);
use Lemonldap::NG::Portal::SharedConf;
my $portal = new Lemonldap::NG::Portal::SharedConf( {
configStorage => {
dbiChain => "dbi:mysql:database=lemonldap;host=127.0.0.1",
dbiUser => "lemonldap",
dbiPassword => "password",
dbiTable => "lmConfig",
},
} );
if($portal->process()) {
# Write here the menu with CGI methods. This page is displayed ONLY IF
......@@ -73,39 +75,13 @@ compatible portals using a central configuration database using L<DBI>.
=head1 DESCRIPTION
Lemonldap::NG::Portal::SharedConf::DBI is an implementation of
L<Lemonldap::NG::Portal::SharedConf> system.
=head1 METHODS
Same as L<Lemonldap::NG::Portal::SharedConf>.
=head2 Arguments
Lemonldap::NG::Portal::SharedConf::DBI introduces 4 new arguments to the
constructor C<new()>:
=over
=item * B<dbiChain>: the string to use to connect to the database. Ex:
"dbi:mysql:database:lmSessions:host:127.0.0.1",
=item * B<dbiUser>: the name of the user to use to connect to the database if
needed,
=item * B<dbiPassword>: the password to use to connect to the database if needed,
=item * B<dbiTable>: the table where to find configuration (default: C<lmConfig>).
=back
=head1 EXPORT
Same as L<Lemonldap::NG::Portal::SharedConf>.
Lemonldap::NG::Portal::SharedConf::DBI is written for compatibility with old
versions of Lemonldap::NG. See now L<Lemonldap::NG::Portal::SharedConf>.
=head1 SEE ALSO
L<Lemonldap::NG::Portal>, L<Lemonldap::NG::Handler>, L<Lemonldap::NG::Manager>
L<Lemonldap::NG::Portal::SharedConf>, L<Lemonldap::NG::Portal>,
L<Lemonldap::NG::Handler>, L<Lemonldap::NG::Manager>
=head1 AUTHOR
......
......@@ -10,7 +10,7 @@ use warnings;
use MIME::Base64;
use CGI;
our $VERSION = '0.4';
our $VERSION = '0.41';
our @ISA = qw(CGI Exporter);
......@@ -395,7 +395,7 @@ Lemonldap::NG::Portal::Simple is the base module for building Lemonldap::NG
compatible portals. You can use it either by inheritance or by writing
anonymous methods like in the example above.
See L<Lemonldap::NG::Portal::SharedConf::DBI> for a complete example of use of
See L<Lemonldap::NG::Portal::SharedConf> for a complete example of use of
Lemonldap::Portal::* libraries.
=head1 METHODS
......@@ -576,7 +576,7 @@ find the user distinguished name (dn) was refused by the server
=head1 SEE ALSO
L<Lemonldap::NG::Handler>, L<Lemonldap::NG::Portal::SharedConf::DBI>, L<CGI>
L<Lemonldap::NG::Handler>, L<Lemonldap::NG::Portal::SharedConf>, L<CGI>
=head1 AUTHOR
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment