#---------------------------------------------------------------------------
PROJECT_NAME = "SAMURAI"
PROJECT_NUMBER = "Sistema de Administracion y Mantenimiento de Usuarios Relativo a Intranet"
-OUTPUT_DIRECTORY = /home/martin/public_html/samurai/doc/dd
+OUTPUT_DIRECTORY = /home/martin/public_html/api/samurai
OUTPUT_LANGUAGE = Spanish
USE_WINDOWS_ENCODING = NO
EXTRACT_ALL = YES
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
-INPUT = doc.php
+INPUT = ../lib
FILE_PATTERNS = *.php
RECURSIVE = YES
EXCLUDE =
<XMI.exporterVersion>1.1.5</XMI.exporterVersion>
<XMI.exporterEncoding>UnicodeUTF8</XMI.exporterEncoding>
</XMI.documentation>
- <XMI.model xmi.name="Samurai" href="/home/martin/public_html/samurai/doc/uml/Samurai.xmi" />
+ <XMI.model xmi.name="Samurai" href="/home/martin/public_html/samurai/doc/Samurai.xmi" />
<XMI.metamodel xmi.name="UML" href="UML.xml" xmi.version="1.3" />
</XMI.header>
<XMI.content>
<docsettings viewid="336" documentation="" uniqueid="394" />
<umlobjects>
- <UML:Class stereotype="" package="" xmi.id="207" abstract="0" documentation="Clase para el manejo de los usuarios." name="SAMURAI_Usuario" static="0" scope="200" >
+ <UML:Class stereotype="" package="" xmi.id="207" abstract="0" documentation="Clase para el manejo de los usuarios.
+@see \ref page_samurai_html_usuario" name="SAMURAI_Usuario" static="0" scope="200" >
<UML:Operation stereotype="" package="" xmi.id="216" type="void" abstract="0" documentation="Constructor.Recibe como parametro opcional el login del usuario. y busca en la base la informacion referida a el." name="SAMURAI_Usuario" static="0" scope="200" >
<UML:Parameter stereotype="" package="" xmi.id="2" value="" type="&SAMURAI_DB" abstract="0" documentation="Objeto conexion." name="db" static="0" scope="200" />
<UML:Parameter stereotype="" package="" xmi.id="3" value="null" type="string" abstract="0" documentation="Login del usuario" name="login" static="0" scope="200" />
x2c:get set" name="perfiles" static="0" scope="202" />
<UML:Attribute stereotype="" package="" xmi.id="394" value="" type="int" abstract="0" documentation="Identificador del sistema en el cual se esta trabajando." name="idSistema" static="0" scope="202" />
</UML:Class>
- <UML:Class stereotype="" package="" xmi.id="208" abstract="0" documentation="Clase para el manejo de los perfies." name="SAMURAI_Perfil" static="0" scope="200" >
+ <UML:Class stereotype="" package="" xmi.id="208" abstract="0" documentation="Clase para el manejo de los perfies.
+@see \ref page_samurai_html_perfil" name="SAMURAI_Perfil" static="0" scope="200" >
<UML:Operation stereotype="" package="" xmi.id="229" type="void" abstract="0" documentation="Constructor. Si recibe un identificador como parametro, busca la informacion en la base. " name="SAMURAI_Perfil" static="0" scope="200" >
<UML:Parameter stereotype="" package="" xmi.id="2" value="" type="&SAMURAI_DB" abstract="0" documentation="Objeto conexion" name="db" static="0" scope="200" />
<UML:Parameter stereotype="" package="" xmi.id="3" value="null" type="int" abstract="0" documentation="Identificador del perfil." name="id" static="0" scope="200" />
<?xml version="1.0" encoding="UTF-8"?>
<xmi2code>
<option key="target" value="*"/>
- <option key="xmi-input" value="uml/Samurai.xmi"/>
+ <option key="xmi-input" value="Samurai.xmi"/>
<option key="config-file" value="xmi2code.config"/>
<option key="config-file-set" value="false"/>
<option key="handler" value="umbrello"/>
/** \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 {{{
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
}
// }}}
//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);
//}}}
}
//}}}
$row = array ($imagen->toHtml().' <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);
//}}}
}
//}}}
$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);
//}}}
}
//}}}
//
//
//
-/** \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
}
// }}}
//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);
// }}}
}
//}}}
}
// }}}
//DIBUJO LA PAGINA {{{
- $MARCO->addBody($TABLA);
+ $MARCO->addBodyContent($TABLA);
if (isset($ERROR)) {
- $MARCO->addBody($ERROR);
+ $MARCO->addBodyContent($ERROR);
}
- $MARCO->addBody($FORM);
+ $MARCO->addBodyContent($FORM);
// }}}
}
//}}}
// +X2C Class 208 :SAMURAI_Perfil
/**
* Clase para el manejo de los perfies.
+@see \ref page_samurai_html_perfil
*
* @access public
*/
} // -X2C Class :SAMURAI_Perfil
-?>
+?>
\ No newline at end of file
} // -X2C Class :SAMURAI_Permiso
-?>
+?>
\ No newline at end of file
// $Rev$
//
-/** \page page_
-
-\section PRUEBA PRUEBA
-hola esto es una prueba
-
- */
-
-
require_once 'PEAR.php';
require_once 'Perfil.php';
require_once 'MECON/Usuario.php';
// +X2C Class 207 :SAMURAI_Usuario
/**
* Clase para el manejo de los usuarios.
+@see \ref page_samurai_html_usuario
*
* @access public
*/
projects / mecon / samurai.git / commitdiff