Changeset 2226 for trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Cli/Base.pm

Timestamp:

02/27/19 09:38:36 (5 years ago)

Author:

nanardon

Message:

More cli documentation in POD

File:

• trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Cli/Base.pm (modified) (4 diffs)

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Cli/Base.pm

@@ -35 +35 @@
 =head1 CLI FUNCTIONS
 
+=head2 GLOBAL FUNCTIONS
+
 =cut
 
@@ -42 +44 @@
     my $OUT = $self->Context->Out;
 
-    if ($self->base->is_transactionnal) {
-        $self->add_func(
-            'transaction', {
-                help => 'change transaction mode',
-                code => sub {
-                    $self->Context->TransMode($_[1] eq 'on' ? 1 : 0);
-                },
-                completion => sub {
-                    $self->Context->TransMode == 0 ? 'on' : 'off';
-                },
-            }
-        );
-        $self->add_func(
-            'begin', {
-                help => 'Start transaction',
-                code => sub {
-                    $self->Context->TransStarted(1);
-                },
-            }
-        );
-        $self->add_func(
-            'commit', {
-                help => 'commit pending change',
-                code => sub {
-                    $_[0]->_commit;
-                },
-            }
-        );
-        $self->add_func(
-            'rollback', {
-                help => 'commit pending change',
-                code => sub {
-                    $_[0]->_rollback;
-                },
-            }
-        );
-    }
+=head3 help
+
+    help [command] - print help about command
+
+=cut
+
+    $self->add_func('help', {
+        completion => sub {
+            if (!$_[2]) { return sort keys %{ $_[0]->{funcs} || {}} }
+        },
+        code => sub {
+            my $env = shift;
+
+            $env->Help(@_);
+        },
+    });
+
+=head3 unexported
+
+    unexported yes|no|show
+
+switch or show base mode regarding' unexported objects behavior
+
+=cut
+
+    $self->add_func('unexported', {
+        completion => sub {
+            if (!$_[2]) {
+                return qw(yes no show);
+            }
+        },
+        code => sub {
+            my ($self, $arg) = @_;
+            if (!$arg) {
+                print $OUT "Unexported objects is" . ($self->base->unexported ?
+                "enable" : "disable") . "\n";
+            } elsif ($arg eq 'yes') {
+                $self->base->unexported(1);
+                print $OUT "Unexported are now show\n";
+            } elsif ($arg eq 'no') {
+                $self->base->unexported(0);
+                print $OUT "Unexported are no longer show\n";
+            } elsif ($arg eq 'show') {
+                print $OUT "Unexported objects is" . ($self->base->unexported ?
+                "enable" : "disable") . "\n";
+            } else {
+                print $OUT "wrong argument\n";
+            }
+        },
+    });
     $self->add_func('quit', { help => 'quit - exit the tool',
             code => sub { print "\n"; exit(0) }, });
@@ -94 +109 @@
     } );
 
-
-=head2 help
-
-    help [command] - print help about command
-
-=cut
-
-    $self->add_func('help', {
-        completion => sub {
-            if (!$_[2]) { return sort keys %{ $_[0]->{funcs} || {}} }
-        },
-        code => sub {
-            my $env = shift;
-
-            $env->Help(@_);
-        },
-    });
+    if ($self->base->is_transactionnal) {
+
+=head2 TRANSACTIONS FUNCTIONS
+
+    transaction [on|off]
+
+Enable or disable the transaction mode: ie automatic commit
+
+=cut
+
+        $self->add_func(
+            'transaction', {
+                code => sub {
+                    $self->Context->TransMode($_[1] eq 'on' ? 1 : 0);
+                },
+                completion => sub {
+                    $self->Context->TransMode == 0 ? 'on' : 'off';
+                },
+            }
+        );
+
+=head3 begin
+
+Start a transaction, meaning changes will be saved only by C<commit> and canceled by C<rollback>
+
+=cut
+
+        $self->add_func(
+            'begin', {
+                code => sub {
+                    $self->Context->TransStarted(1);
+                },
+            }
+        );
+
+=head3 commit
+
+Save pending changes in transaction mode or following C<begin>
+
+=cut
+        $self->add_func(
+            'commit', {
+                code => sub {
+                    $_[0]->_commit;
+                },
+            }
+        );
+
+=head3 rollback
+
+Cancel pending changes following a C<begin> or in transaction mode
+
+=cut
+        $self->add_func(
+            'rollback', {
+                code => sub {
+                    $_[0]->_rollback;
+                },
+            }
+        );
+    }
+
+=head2 GLOBAL and OBJECTS FUNCTION
+
+=head3 query
+
+    query objectname [attribute]
+    query [attribute]
+
+Show attribute
+
+options:
+
+=over 4
+
+=item -o|--otype objecttype
+
+In global context specify the object type (default: user)
+
+=item -e|--empty
+
+Show empty/unset attributes
+
+=item --ro
+
+Show readonly attributes
+
+=item --fmt format
+
+Instead displaying attribute list use C<format> as formating string
+
+=back
+
+=cut
 
     $self->add_func( 'query' => {
             proxy => '*',
-            help  => 'show attribute',
             completion => sub { },
             code => sub {
@@ -374 +465 @@
 
         podselect(
-            {-output => $fh, -sections => ["CLI FUNCTIONS/\Q$name"]},
+            {-output => $fh, -sections => ["CLI FUNCTIONS/.*/\Q$name"]},
             $self->{funcs}{$name}{podfile}
         );