Cambios. No se utiliza mas $_SESSION[samurai][login] en cambio se utiliza $_SESSION...

[mecon/samurai.git] / lib / SAMURAI / HTML / Perfil.php

diff --git a/lib/SAMURAI/HTML/Perfil.php b/lib/SAMURAI/HTML/Perfil.php
index a1e1e5a878bc174ace3611c048c675e0171313ef..f447971e24430a2e23b90cb98fa89f6e5d7e4f1f 100644 (file)
--- a/lib/SAMURAI/HTML/Perfil.php
+++ b/lib/SAMURAI/HTML/Perfil.php
@@ -20,8 +20,60 @@
 // $Id$
 //
 
+/** \page page_samurai_html_perfil Perfil Embebido
 
-//REQUIRE ONCE GENERALES {{{
+\section page_samurai_html_perfil_descripcion Descripcion
+    Funcion que sirve para embeber la funcionalidad de los perfiles dentro de
+    los sistemas que asi lo requieran (Es una copia de la funcionalidad de la
+    seccion).
+    Necesita para funcionar que se le pase como parametro la referencia al
+    objeto MECON_Marco que se este utilizando, ademas del identificador del
+    sistema del sistema en el cual se esta trabajando.
+    El funcionamiento es completamente independiente del sistema en el cual se
+    trabaje, no es necesario que se ingrese como seccion o subseccion. De hecho
+    como se ve en el ejemplo solo se embebe una tabla o formulario pero se
+    pueden agregar cosas particulares antes y despues de el.
+    
+    \note Trabaja con variables de sesion asi que es necesario que antes de llamar a
+    esta funcion se haya realizado un session_start() (Por ejemplo en el prepend).
+
+\section page_samurai_html_perfil_funcionamiento Funcionamiento
+    Al ser una copia de la seccion de Samurai, los permisos y validaciones que
+    se realizan en esta funcion son las mismas que se realizan en Samurai.
+
+    \subsection page_samurai_html_perfil_funcionamiento_validaciones Validaciones
+        Se realizan las siguientes validaciones:
+            - Los nombres de los perfiles nuevos deben ser distintos. 
+            - Los espacios entre las palabras que componen el nombre de un
+              perfil son eliminados. Ej: Agregar    Usuario
+              se cambia por Agregar Usuario.
+            - Es obligatorio que los perfiles contengan al menos un permiso.
+            - No puede haber dos perfiles con los mismos permisos.
+            - No se pueden borrar perfiles que esten asociados a usuarios.
+
+\section page_samurai_html_perfil_ejemplo Ejemplo
+    La utilizacion de perfiles embebido no genera condiciones, queda a criterio
+    del desarrollador incluir esta funcionalidad en el lugar que quiera.
+
+    De esta manera se agrega la funcionalidad:
+    \code
+    include 'SAMURAI/HTML/Perfil.php';
+
+    SAMURAI_HTML_Perfil($MARCO, $ID_SISTEMA);
+    \endcode
+    
+    En donde $MARCO es el objeto MECON_Marco que utiliza el sistema y
+    $ID_SISTEMA es el identificador numerico del sistema en el cual se esta
+    trabajando.
+
+    Antes o despues de esto se pueden agregar componentes pertenecientes al
+    sistema.
+
+    \note Es necesario para ver el contenido de la pagina hacer 
+    $MARCO->display() al final de la misma.
+*/
+
+//REQUIRE ONCE {{{
 require_once 'SAMURAI/DB.php';
 require_once 'SAMURAI/Perm.php';
 require_once 'SAMURAI/constantes.php';
@@ -35,23 +87,15 @@ require_once 'MECON/HTML/Image.php';
 require_once 'PEAR.php';
 // }}}
 
-// Funciones para agregar la seccion SAMURAI_Perfil en los sistemas.
-// Con esto se pueden embeber el abm de perfiles como una seccion/subseccion mas
-// de un sistema cualquiera.
-// Es necesario para que funcione que se haya realizado un session_start()
-// antes, por ejemplo en el prepend.
-
-    /**
-     * Funcion que se encarga agregar los componentes necesarios al sistema para que
-     * se pueda realizar un abm de perfiles.
-     * Sin los parametros no funciona
-     *
-     * @param MECON_Marco &$MARCO      Referencia al objeto MECON_Marco que se este utilizando en la pagina
-     * @param int          $id_sistema Identificador del sistema en el cual se esta trabajando
-     *
-     * @return void
-     */
-//SAMURAI__HTML_Perfil {{{
+/** Funcion que se encarga agregar los componentes necesarios al sistema para
+ * que se pueda realizar un abm de perfiles.  Sin los parametros no funciona
+ *
+ * @param MECON_Marco &$MARCO      Referencia al objeto MECON_Marco que se este utilizando en la pagina
+ * @param int          $id_sistema Identificador del sistema en el cual se esta trabajando
+ *
+ * @return void
+ */
+//SAMURAI_HTML_Perfil {{{
 function SAMURAI_HTML_Perfil(&$MARCO, $id_sistema) {
 
     $_SESSION['samurai']['id_sistema'] = $id_sistema;
@@ -424,4 +468,5 @@ function SAMURAI_HTML_Perfil(&$MARCO, $id_sistema) {
     }
     //}}}
 }
+//}}}
 ?>