.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Lemonldap::NG::Common::Conf 3pm"
.TH Lemonldap::NG::Common::Conf 3pm "2023-05-13" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Lemonldap::NG::Common::Conf \- Perl extension written to manage Lemonldap::NG
Web\-SSO configuration.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\& use Lemonldap::NG::Common::Conf;
\& # Lemonldap::NG::Common::Conf reads loacl configuration from lemonldap\-ng.ini.
\& # Parameters can be overridden in a hash:
\& my $confAccess = new Lemonldap::NG::Common::Conf(
\& {
\& type=>\*(AqFile\*(Aq,
\& dirName=>"/tmp/",
\&
\& # To use local cache, set :
\& localStorage => "Cache::FileCache",
\& localStorageOptions = {
\& \*(Aqnamespace\*(Aq => \*(Aqlemonldap\-ng\-config\*(Aq,
\& \*(Aqdefault_expires_in\*(Aq => 600,
\& \*(Aqdirectory_umask\*(Aq => \*(Aq007\*(Aq,
\& \*(Aqcache_root\*(Aq => \*(Aq/tmp\*(Aq,
\& \*(Aqcache_depth\*(Aq => 5,
\& },
\& },
\& ) or die "Unable to build Lemonldap::NG::Common::Conf, see Apache logs";
\& # Next, get global configuration. Note that local parameters override global
\& # ones
\& my $config = $confAccess\->getConf();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Lemonldap::NG::Common::Conf is used by all Lemonldap::NG packages to access to
local/global configuration.
.SS "\s-1SUBROUTINES\s0"
.IX Subsection "SUBROUTINES"
.IP "\(bu" 4
\&\fBnew\fR (constructor)
.Sp
It can takes any Lemonldap::NG parameter to override configuration. The
\&'confFile' parameter can be used to override lemonldap\-ng.ini path.
Examples:
.RS 4
.IP "\(bu" 4
\&\fBSet another lemonldap\-ng.ini file\fR
\f(CW$confAccess\fR = new Lemonldap::NG::Common::Conf(
{ confFile => '/opt/lemonldap\-ng.ini' } );
=item * \fBOverride global storage\fR:
\f(CW$confAccess\fR = new Lemonldap::NG::Common::Conf(
{
type => 'File',
dirName => '/var/lib/lemonldap\-ng/conf',
});
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBgetConf\fR: returns a hash reference to the configuration. it takes
a hash reference as first argument containing 2 optional parameters:
.RS 4
.IP "\(bu" 4
\&\f(CW\*(C`cfgNum =\*(C'\fR \f(CW$number\fR>: the number of the configuration wanted. If this
argument is omitted, the last configuration is returned.
.IP "\(bu" 4
\&\f(CW\*(C`fields =\*(C'\fR [array of names]: the desired fields asked. By default,
getConf returns all (\f(CW\*(C`select * from lmConfig\*(C'\fR).
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBsaveConf\fR: stores the Lemonldap::NG configuration passed in argument
(hash reference). it returns the number of the new configuration.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "LemonLDAP::NG team " 4
.IX Item "LemonLDAP::NG team "
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use \s-1OW2\s0 system to report bug or ask for features:
.SH "DOWNLOAD"
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
See \s-1COPYING\s0 file for details.
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program. If not, see .