lib/SAMURAI/perl.php

   1 <?php
   2
   3 /**
   4 \page perm.epl SAMURAI_Perm para Perl
   5
   6 \section desc Descripcion
   7 Libreria en Perl para el manejo de permisos. Mantiene la misma interfaz que
   8 SAMURAI_Perm, adaptandose al lenguaje.
   9
  10 \section func Funcionamiento
  11 El funcionamiento es similar al del objeto de PHP. Primero debe 'crearse' el
  12 objeto llamando a la funcion new con los parametros correspondientes, esto
  13 cargara en una variable de sesion los datos. A partir de dichos datos
  14 trabajara con las diferentes funciones.
  15
  16 \section uso Utilizacion
  17 Estos son los pasos para utilizar la libreria:
  18
  19 Primero debe invocarse el archivo libreria:
  20 \code  Execute('/var/www/sistemas/samurai/lib_perl/Perm.epl'); \endcode
  21
  22 Luego se 'crea' el objeto:
  23 \code $ret->{SAMURAI_Perm}->{new} (<usuario>, <sistema>); \endcode
  24 En donde <usuario> es el login@organismo del usuario con el que se esta
  25 trabajando y <sistema> es el identificador numerico del sistema.
  26
  27 Para cambiar el sistema en el cual se esta trabajando se utiliza el siguiente
  28 metodo:
  29 \code $ret->{SAMURAI_Perm}->{setSistema} (<sistema>); \endcode
  30
  31 Para averiguar si el usuario tiene permisos en un sistema se utiliza el
  32 siguiente metodo:
  33 \code $ret->{SAMURAI_Perm}->{tiene} () \endcode
  34 En este caso devuelve 1 si el usuario tiene al menos un permiso en el sistema
  35 seteado.
  36 \code $ret->{SAMURAI_Perm}->{tiene} (<permiso A>, <permiso B>) \endcode
  37 En este caso devuelve 1 si el usuario tiene alguno de los permisos pasados por
  38 parametro. A diferencia de la libreria de perl, tiene solo puede recibir una
  39 lista de permisos, no acepta arrays por parametro.
  40
  41 El metodo getPermisos permite obtener un hash con los permisos del usuario en un
  42 sistema determinado.
  43 Si se pasa un sistema por parametro devuelve los permisos de dicho sistema, en
  44 caso contrario devuelve los permisos del sistema seteado.
  45 \code $ret->{SAMURAI_Perm}->{getPermisos} (<sistema>) \endcode
  46
  47 El metodo chequear verifica que el usuario tenga al menos un permiso de los
  48 pasados por parametro en el sistema. En caso de no tener ningun permiso imprime
  49 en pantalla el cartel de no autorizado y corta la ejecucion de la pagina.
  50 \code $ret->{SAMURAI_Perm}->{chequear} (<permiso A>, <permiso B>) \endcode
  51
  52 El metodo getObservaciones devuelve un hash con las observaciones de un permiso
  53 en un sistema en particular.
  54 \code $ret->{SAMURAI_Perm}->{getObservaciones} (<permiso>,<sistema) \endcode
  55 */
  56 ?>