Changeset 255

Timestamp:

06/22/09 03:19:38 (15 years ago)

Author:

nanardon

Message:

• update POD

File:

• LATMOS-Accounts/lib/LATMOS/Accounts.pm (modified) (8 diffs)

LATMOS-Accounts/lib/LATMOS/Accounts.pm

@@ -8 +8 @@
 use LATMOS::Accounts::Synchro;
 use LATMOS::Accounts::SynchAccess;
+use LATMOS::Accounts::Log;
 
 our $VERSION = (q$Rev$ =~ /^Rev: (\d+) /)[0];
+
+=head1 NAME
+
+LATMOS::Accounts - Core module for LATMOS account management tools
+
+=head1 DESCRITPTION
+
+=cut
+
+=head1 FUNCTION
+
+=head2 new($configfile)
+
+Instanciate a new LATMOS::Accounts object.
+
+$configfile if defined is the Config::IniFiles formatted file to use,
+default to F</etc/latmos-account.ini>.
+
+=cut
 
 sub new {
@@ -23 +43 @@
     bless($self, $class)
 }
+
+=head2 list_bases
+
+Return the base list found in config file
+
+=cut
+
+sub list_bases {
+    my ($self) = @_;
+    grep {
+        !m/^_.*_$/ &&
+        !m/^sync:/
+    } $self->Sections
+}
+
+=head2 base($basename)
+
+Return a L<LATMOS::Accounts::Base> object over base named $basename
+defined in the config file.
+
+The base is loaded by this function.
+
+=cut
 
 sub base {
@@ -30 +73 @@
     $self->load_base($section) ? $self->{_bases}{$section} : undef;
 }
+
+=head2 default_base_name
+
+Return the default base name according config file
+
+=cut
+
+sub default_base_name {
+    my ($self) = @_;
+    $self->val('_default_', 'base', ($self->list_bases)[0]);
+}
+
+=head2 default_base
+
+Return a L<LATMOS::Accounts::Base> object over the default base according
+configuration file.
+
+=cut
 
 sub default_base {
@@ -54 +115 @@
     );
     my $base = LATMOS::Accounts::Bases->new($type, %params, label => $section) or do {
-        warn "Cannot instanciate base $section ($type)";
+        la_log(LA_WARN, "Cannot instanciate base $section ($type)");
         return;
     };
@@ -61 +122 @@
 }
 
-sub default_base_name {
-    my ($self) = @_;
-    $self->val('_default_', 'base', ($self->list_bases)[0]);
-}
-
 sub default_synchro_name {
     my ($self) = @_;
     $self->val('_default_', 'sync');
-}
-
-sub list_bases {
-    my ($self) = @_;
-    grep {
-        !m/^_.*_$/ &&
-        !m/^sync:/
-    } $self->Sections
 }
 
@@ -88 +136 @@
     foreach ($self->list_bases) {
         $self->load_base($_) or do {
-            warn "Cannot load base $_\n";
+            la_log(LA_ERR, "Cannot load base $_");
             return 0;
         };
@@ -159 +207 @@
 
 __END__
-# Below is stub documentation for your module. You'd better edit it!
-
-=head1 NAME
-
-LATMOS::Accounts - Perl extension for blah blah blah
-
-=head1 SYNOPSIS
-
-  use LATMOS::Accounts;
-  blah blah blah
-
-=head1 DESCRIPTION
-
-Stub documentation for LATMOS::Accounts, created by h2xs. It looks like the
-author of the extension was negligent enough to leave the stub
-unedited.
-
-Blah blah blah.
-
-=head2 EXPORT
-
-None by default.
-
-
 
 =head1 SEE ALSO
 
-Mention other useful documentation such as the documentation of
-related modules or operating system documentation (such as man pages
-in UNIX), or any relevant external documentation such as RFCs or
-standards.
-
-If you have a mailing list set up for your module, mention it here.
-
-If you have a web site set up for your module, mention it here.
-
 =head1 AUTHOR
 
-Thauvin Olivier, E<lt>olivier.thauvin@latmosipsl.frE<gt>
+Thauvin Olivier, E<lt>olivier.thauvin@latmos.ipsl.frE<gt>
 
 =head1 COPYRIGHT AND LICENSE
@@ -207 +222 @@
 at your option, any later version of Perl 5 you may have available.
 
-
-=cut
+=cut