Changeset 3 for LATMOS-Accounts/lib/LATMOS/Accounts/Bases.pm

Timestamp:

02/26/09 05:52:34 (15 years ago)

Author:

nanardon

Message:

• basics doc and functions

File:

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

LATMOS-Accounts/lib/LATMOS/Accounts/Bases.pm

@@ -6 +6 @@
 use LATMOS::Accounts::Bases::Objects;
 
-our $VERSION = (q$Rev$ =~ /$Rev: (\d+) /)[0];
+our $VERSION = (q$Rev$ =~ /^Rev: (\d+) /)[0];
+
+=head1 NAME
+
+LATMOS::Accounts::Bases - Base class for account data bases
+
+=head1 SYNOPSIS
+
+  use LATMOS::Accounts::Bases;
+  my $base = LATMOS::Accounts::Bases->new('type', %options);
+  ...
+
+=head1 DESCRIPTION
+
+This module provide basic functions for various account base
+
+=head1 FUNTIONS
+
+=cut
+
+=head2 new($type, %options)
+
+Return, if success, a new data base account object, $type is
+account base type, %options to setup the base.
+
+=cut
 
 sub new {
@@ -17 +42 @@
 }
 
+=head2 get_object($type, $id)
+
+Return an object of $type (typically user or group) having identifier
+$id.
+
+=cut
+
 sub get_object {
     my ($self, $otype, $id) = @_;
@@ -23 +55 @@
 }
 
+=head2 is_transactionnal
 
-# Preloaded methods go here.
+Return True is the database support commit and rollback
+
+=cut
+
+sub is_transactionnal {
+    my ($self) = @_;
+    return($self->can('_rollback') && $self->can('_commit'));
+}
+
+=head2 commit
+
+Save change into the database if change are not done immediately.
+This should always be called as you don't know when change are applied.
+
+Return always true if database does not support any transaction.
+
+The driver should provides a _commit functions to save data.
+
+=cut
+
+sub commit {
+    my ($self) = @_;
+    return $self->can('_commit') ? $self->_commit : 1;
+}
+
+=head2 rollback
+
+If database support transaction, rollback changes. Return false
+if database does not support.
+
+If supported, driver should provides a _rollback functions
+
+=cut
+
+sub rollback {
+    my ($self) = @_;
+    return $self->can('_rollback') ? $self->_commit : 0;
+}
 
 1;
+
 __END__
-# Below is stub documentation for your module. You'd better edit it!
-
-=head1 NAME
-
-LATMOS::Accounts::Bases - Perl extension for blah blah blah
-
-=head1 SYNOPSIS
-
-  use LATMOS::Accounts::Bases;
-  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@localdomainE<gt>
+Thauvin Olivier, E<lt>olivier.thauvin.ipsl.fr.thauvin@latmos.ipsl.fr<gt>
 
 =head1 COPYRIGHT AND LICENSE
@@ -76 +114 @@
 at your option, any later version of Perl 5 you may have available.
 
-
 =cut