]> git.llucax.com Git - mecon/samurai.git/blobdiff - lib/SAMURAI/HTML/Usuario.php
Agregue la documentacion de Perfil Embebido y Usuario Embebido, y las referencias...
[mecon/samurai.git] / lib / SAMURAI / HTML / Usuario.php
index d33e814817f646ce9d5d6318ace0df60e6193aff..1c9dfb5c3544ae6069285dc9b8d9d8c730f4c614 100644 (file)
 //
 //
 //
-/** \page page_samurai_html_usuario Usuario Embebido
 
+/** \page page_samurai_html_usuario Usuario Embebido
 
 \section page_samurai_html_usuario_descripcion Descripcion
-
-    Funcion que sirve para embeber la funcionalidad de los usuario 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).
+    Samurai provee de una funcion que permite embeber la funcionalidad de 
+    usuarios dentro de aquellos sistemas que asi lo requieran.
+    Es completamente independiente del sistema en el cual trabaja y puede ser
+    agregado de cualquier manera (Seccion, Subseccion o Contenido) al sistema.
+        
+    \note Es necesario para embeber los usuarios que se haya realizado un
+    session_start().
 
 \section page_samurai_html_usuario_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.
+    Es una copia de la seccion Usuarios dentro de SAMURAI. Se relizan las mismas
+    verificaciones, tiene las mismas condiciones y se utilizan los mismos 
+    permisos que en este.
 
-    \subsection page_samurai_html_usuario_funcionamiento_validaciones Validaciones
-        Se realizan las siguientes validaciones:
-            - Cualquier usuario que se quiera agregar debe haberse logueado al
-              menos una vez a la intranet.
-            - No puede cargarse dos veces el mismo usuario en un sistema. Solo
-              se modifican sus datos.
-            - Cada vez que se carga un usuario es necesario asignarle al menos
-              un permiso, sino no va a permitir que se ingrese el mismo.
+    \subsection page_samurai_html_usuario_funcionamiento_validaciones Validaciones y Condiciones
+        - Cualquier usuario que se quiera agregar debe haberse logueado al
+          menos una vez a la intranet.
+        - No puede cargarse dos veces el mismo usuario en un sistema.
+        - Cada vez que se carga un usuario es necesario asignarle al menos
+          un perfil, sino no va a permitir que se ingrese el mismo.
 
 \section page_samurai_html_usuario_ejemplo Ejemplo
-    La utilizacion de usuario embebido no genera condiciones, queda a criterio
-    del desarrollador incluir esta funcionalidad en el lugar que quiera.
-
-    De esta manera se agrega la funcionalidad:
+    SAMURAI_HTML_Usuario agrega el contenido directamente en el marco que se 
+    este utilizando.
+    Para embeber los usuarios hay que hacerlo de la siguiente manera
+    
     \code
     include 'SAMURAI/HTML/Usuario.php';
-
     SAMURAI_HTML_Usuario($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.
+     
+    \note $MARCO es el objeto MECON_Marco o el objeto HTML_DietMarco de
+    intranet. 
+    $ID_SISTEMA es el identificador numerico en el cual se esta realizando la
+    accion de embeber.
 
-    Antes o despues de esto se pueden agregar componentes pertenecientes al
-    sistema.
+\section page_samurai_html_usuario_permisos Pasos Finales
+    Para que los usuarios puedan acceder a los usuarios embebidos es necesario
+    que en el sistema en el cual se este embebiendo se agregen los permisos que
+    utiliza la seccion Usuarios (enumerados mas abajo), y que estos mediante
+    perfiles se asignen a usuarios.
+    Esto implica que por lo menos un usuario tendra que ser cargado desde
+    SAMURAI para que este tenga acceso a la zona embebida.
 
-    \note Es necesario para ver el contenido de la pagina hacer 
-    $MARCO->display() al final de la misma.
+    Permisos
+        - usuario alta
+        - usuario baja
+        - usuario modificacion
 */
 
 //REQUIRE ONCE {{{
     require_once 'SAMURAI/constantes.php';
 //}}}
 
-/** Funcion que se encarga agregar los componentes necesarios al sistema para
+/** 
+ * Funcion que se encarga agregar los componentes necesarios al sistema para
  * que se pueda realizar un abm de usuarios.
+@see \ref page_samurai_html_usuario
  *
  * @param MECON_Marco &$MARCO      Referencia al objeto MECON_Marco que se este
  *                                 utilizando en la pagina
@@ -176,9 +177,9 @@ function SAMURAI_HTML_Usuario(&$MARCO, $id_sistema) {
             }
         // }}}
         //DIBUJO LA PAGINA {{{
-            $MARCO->addBody($TABLA3);
-            $MARCO->addBody($TABLA2->toHtml(1));
-            $MARCO->addBody($TABLA);
+            $MARCO->addBodyContent($TABLA3);
+            $MARCO->addBodyContent($TABLA2->toHtml(1));
+            $MARCO->addBodyContent($TABLA);
         // }}}
     }
     //}}}
@@ -314,11 +315,11 @@ function SAMURAI_HTML_Usuario(&$MARCO, $id_sistema) {
             }
         // }}}
         //DIBUJO LA PAGINA {{{
-            $MARCO->addBody($TABLA);
+            $MARCO->addBodyContent($TABLA);
             if (isset($ERROR)) {
-                $MARCO->addBody($ERROR);
+                $MARCO->addBodyContent($ERROR);
             }
-            $MARCO->addBody($FORM);
+            $MARCO->addBodyContent($FORM);
         // }}}
     }
     //}}}