From 92934f51294f84ac1be95a0c57ce7a77f1f221d1 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Mart=C3=ADn=20Marrese?= Date: Mon, 20 Oct 2003 20:13:00 +0000 Subject: [PATCH] Documentacion para el Doxygen de la libreria de perl. --- doc/Samurai.xmi | 6 +++-- lib/SAMURAI/Perm.php | 2 ++ lib/SAMURAI/Sistema.php | 2 +- lib/SAMURAI/perl.php | 56 +++++++++++++++++++++++++++++++++++++++++ test/prueba.epl | 2 +- 5 files changed, 64 insertions(+), 4 deletions(-) create mode 100644 lib/SAMURAI/perl.php diff --git a/doc/Samurai.xmi b/doc/Samurai.xmi index 6ad652c..4f5c737 100644 --- a/doc/Samurai.xmi +++ b/doc/Samurai.xmi @@ -250,7 +250,9 @@ x2c:include: DB.php" name="DB" static="0" scope="200" /> - + @@ -282,7 +284,7 @@ x2c:set" name="sistema" static="0" scope="202" /> - + diff --git a/lib/SAMURAI/Perm.php b/lib/SAMURAI/Perm.php index ad31b05..67f38c8 100644 --- a/lib/SAMURAI/Perm.php +++ b/lib/SAMURAI/Perm.php @@ -30,6 +30,8 @@ // +X2C Class 377 :SAMURAI_Perm /** * Chequeador de permisos. +Para la libreria de perl: +@see perm.epl * * @package SAMURAI * @access public diff --git a/lib/SAMURAI/Sistema.php b/lib/SAMURAI/Sistema.php index fe7eb75..61ad5d9 100644 --- a/lib/SAMURAI/Sistema.php +++ b/lib/SAMURAI/Sistema.php @@ -1051,4 +1051,4 @@ class SAMURAI_Sistema { } // -X2C Class :SAMURAI_Sistema -?> +?> \ No newline at end of file diff --git a/lib/SAMURAI/perl.php b/lib/SAMURAI/perl.php new file mode 100644 index 0000000..2e2580b --- /dev/null +++ b/lib/SAMURAI/perl.php @@ -0,0 +1,56 @@ +{SAMURAI_Perm}->{new} (, ); \endcode +En donde es el login@organismo del usuario con el que se esta +trabajando y es el identificador numerico del sistema. + +Para cambiar el sistema en el cual se esta trabajando se utiliza el siguiente +metodo: +\code $ret->{SAMURAI_Perm}->{setSistema} (); \endcode + +Para averiguar si el usuario tiene permisos en un sistema se utiliza el +siguiente metodo: +\code $ret->{SAMURAI_Perm}->{tiene} () \endcode +En este caso devuelve 1 si el usuario tiene al menos un permiso en el sistema +seteado. +\code $ret->{SAMURAI_Perm}->{tiene} (, ) \endcode +En este caso devuelve 1 si el usuario tiene alguno de los permisos pasados por +parametro. A diferencia de la libreria de perl, tiene solo puede recibir una +lista de permisos, no acepta arrays por parametro. + +El metodo getPermisos permite obtener un hash con los permisos del usuario en un +sistema determinado. +Si se pasa un sistema por parametro devuelve los permisos de dicho sistema, en +caso contrario devuelve los permisos del sistema seteado. +\code $ret->{SAMURAI_Perm}->{getPermisos} () \endcode + +El metodo chequear verifica que el usuario tenga al menos un permiso de los +pasados por parametro en el sistema. En caso de no tener ningun permiso imprime +en pantalla el cartel de no autorizado y corta la ejecucion de la pagina. +\code $ret->{SAMURAI_Perm}->{chequear} (, ) \endcode + +El metodo getObservaciones devuelve un hash con las observaciones de un permiso +en un sistema en particular. +\code $ret->{SAMURAI_Perm}->{getObservaciones} (, diff --git a/test/prueba.epl b/test/prueba.epl index 5ebac2f..1137369 100644 --- a/test/prueba.epl +++ b/test/prueba.epl @@ -8,7 +8,7 @@ vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4 ft=perl: use Data::Dumper; - Execute('./../lib_perl/Perm.epl'); + Execute('/var/www/sistemas/samurai/lib_perl/Perm.epl'); #define('SAMURAI_PERM', 44); #define('SAMURAI_PERM_DEVELOPER', 66); -- 2.43.0