Changeset 1023 for trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Objects.pm

Timestamp:

05/29/12 10:25:51 (12 years ago)

Author:

nanardon

Message:

• complete POD

This patch a basic documentation to all functions.
It also add two test to ensure all POD syntax are correct and coverage is full.

File:

• trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Objects.pm (modified) (13 diffs)

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

@@ -22 +22 @@
 
 =head1 FUNCTIONS
+
+=cut
+
+=head2 is_supported
+
+If exists, must return true or false if the object is supported or not
 
 =cut
@@ -136 +142 @@
 }
 
+=head2 attribute ($attribute)
+
+Return L<LATMOS::Accounts::Bases::Attributes> object for C<$attribute>
+
+=cut
+
 sub attribute {
     my ($self, $attribute) = @_;
@@ -141 +153 @@
     my $attrinfo;
     if (! ref $attribute) {
-        $attrinfo = $self->base->get_attr_schema(
-            $self->type, $attribute
-        ) or return;
+        $attrinfo = $self->_get_attr_schema(
+            $self->base)->{$attribute}
+        or return;
         $attrinfo->{name} = $attribute;
     } else {
@@ -211 +223 @@
     return ref $res ? @{ $res } : ($res);
 }
+
+=head2 get_state ($state)
+
+Return an on fly computed value
+
+=cut
 
 sub get_state {
@@ -241 +259 @@
 }
 
+=head2 queryformat ($fmt)
+
+Return formated string according C<$fmt>
+
+=cut
+
 sub queryformat {
     my ($self, $fmt) = @_;
@@ -263 +287 @@
 =cut
 
+=head2 check_allowed_values ($attr, $values)
+
+Check if value C<$values> is allowed for attributes C<$attr>
+
+=cut
+
 sub check_allowed_values {
     my ($self, $attr, $values) = @_;
     $self->base->check_allowed_values($self->type, $attr, $values);
 }
+
+=head2 attr_allow_values ($attr)
+
+Return allowed for attribute C<$attr>
+
+=cut
 
 sub attr_allow_values {
@@ -377 +413 @@
 }
 
+=head2 check_password ($password)
+
+Check given password is secure using L<Crypt::Cracklib>
+
+=cut
+
 sub check_password {
     my ( $self, $password ) = @_;
@@ -383 +425 @@
     return fascist_check($password, $dictionary);
 }
+
+=head2 search ($base, @filter)
+
+Search object matching C<@filter>
+
+=cut
 
 sub search {
@@ -444 +492 @@
 }
 
+=head2 attributes_summary ($base, $attribute)
+
+Return list of values existing in base for C<$attribute>
+
+=cut
 
 sub attributes_summary {
@@ -464 +517 @@
 }
 
+=head2 find_next_numeric_id ($base, $field, $min, $max)
+
+Find next free uniq id for attribute C<$field>
+
+=cut
+
 sub find_next_numeric_id {
     my ($class, $base, $field, $min, $max) = @_;
@@ -491 +550 @@
 }
 
+=head2 text_dump ($handle, $options, $base)
+
+Dump object into C<$handle>
+
+=cut
+
 sub text_dump {
     my ($self, $handle, $options, $base) = @_;
@@ -496 +561 @@
     return 1;
 }
+
+=head2 dump
+
+Return dump for tihs object
+
+=cut
 
 sub dump {
@@ -550 +621 @@
 __END__
 
-=head1 CANICALS FIELDS
-
-=head2 User class
-
-=head2 Group class
 
 =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.
+L<LATMOS::Accounts::Bases>
 
 =head1 AUTHOR