]> git.llucax.com Git - mecon/samurai.git/blobdiff - lib/SAMURAI/HTML/Perfil.php
Agregue la documentacion de Perfil Embebido y Usuario Embebido, y las referencias...
[mecon/samurai.git] / lib / SAMURAI / HTML / Perfil.php
index 372abf88a7591e3044bea152d2a56ce21857f37a..10dd15f60cfc026487e28bbe689a329a119b097d 100644 (file)
 /** \page page_samurai_html_perfil Perfil Embebido
 
 \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).
+    Samurai provee de una funcion que permite embeber la funcionalidad de 
+    perfiles 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 perfiles que se haya realizado un
+    session_start().
 
 \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.
+    Es una copia de la seccion Perfiles 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_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.
+    \subsection page_samurai_html_perfil_funcionamiento_validaciones Validaciones y Condiciones
+        - 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.
+        - No se pueden ingresar pefiles nuevos que ya esten cargados.
 
 \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.
+    SAMURAI_HTML_Perfil agrega el contenido directamente en el marco que se este
+    utilizando.
+    Para embeber los perfiles hay que hacerlo de la siguiente manera
 
-    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.
+    \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_perfil_permisos Pasos Finales
+    Para que los usuarios puedan acceder a los perfiles embebidos es necesario
+    que en el sistema en el cual se este embebiendo se agregen los permisos que
+    utiliza la seccion Perfiles (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
+        - perfil alta
+        - perfil baja
+        - perfil modificacion
+        - perfil tipo
 */
 
 //REQUIRE ONCE {{{
@@ -87,8 +89,10 @@ require_once 'MECON/HTML/Image.php';
 require_once 'PEAR.php';
 // }}}
 
-/** Funcion que se encarga agregar los componentes necesarios al sistema para
- * que se pueda realizar un abm de perfiles.  Sin los parametros no funciona
+/** 
+ * Funcion que se encarga agregar los componentes necesarios al sistema para
+ * que se pueda realizar un abm de perfiles.
+@see \ref page_samurai_html_perfil
  *
  * @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
@@ -184,9 +188,9 @@ function SAMURAI_HTML_Perfil(&$MARCO, $id_sistema) {
             }
         // }}}
         //AGREGO LA INFO AL MARCO {{{
-            $MARCO->addBody($TABLA3);
-            $MARCO->addBody($TABLA2->toHtml(1));
-            $MARCO->addBody($TABLA);
+            $MARCO->addBodyContent($TABLA3);
+            $MARCO->addBodyContent($TABLA2->toHtml(1));
+            $MARCO->addBodyContent($TABLA);
         //}}}
     }
     //}}}
@@ -288,11 +292,11 @@ function SAMURAI_HTML_Perfil(&$MARCO, $id_sistema) {
             $row    = array ($imagen->toHtml().'&nbsp;<b>SISTEMA: '.$SISTEMA->getNombre().'</b>');
             $TABLA3->addRow($row,'align=left');    
         //}}} 
-            $MARCO->addBody($TABLA3);
+            $MARCO->addBodyContent($TABLA3);
             if (isset($TABLA)) {
-                $MARCO->addBody($TABLA);
+                $MARCO->addBodyContent($TABLA);
             }
-            $MARCO->addBody($FORM);
+            $MARCO->addBodyContent($FORM);
         //}}}
     }
     //}}}
@@ -455,11 +459,11 @@ function SAMURAI_HTML_Perfil(&$MARCO, $id_sistema) {
             $TABLA3 = new MECON_HTML_Tabla ('cellspacing=0');
             $TABLA3->addRow($row,'align=left');    
 
-            $MARCO->addBody($TABLA3);
+            $MARCO->addBodyContent($TABLA3);
             if (isset($ERROR)) {
-                $MARCO->addBody($ERROR);
+                $MARCO->addBodyContent($ERROR);
             }
-            $MARCO->addBody($FORM);
+            $MARCO->addBodyContent($FORM);
     //}}}
     }
     //}}}