doc/DBObject/DBObject.xmi

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <XMI xmlns:UML="org.omg/standards/UML" verified="false" timestamp="" xmi.version="1.2" >
   3  <XMI.header>
   4   <XMI.documentation>
   5    <XMI.exporter>umbrello uml modeller http://uml.sf.net</XMI.exporter>
   6    <XMI.exporterVersion>1.1.5</XMI.exporterVersion>
   7    <XMI.exporterEncoding>UnicodeUTF8</XMI.exporterEncoding>
   8   </XMI.documentation>
   9   <XMI.model xmi.name="DBObject" href="/home/luca/public_html/meconlib/doc/DBObject/DBObject.xmi" />
  10   <XMI.metamodel xmi.name="UML" href="UML.xml" xmi.version="1.3" />
  11  </XMI.header>
  12  <XMI.content>
  13   <docsettings viewid="12" documentation="" uniqueid="22" />
  14   <umlobjects>
  15    <UML:Class stereotype="interface" package="" xmi.id="16" abstract="1" documentation="Interfaz genérica para objetos que pueden ser guardados y/o operan con bases de datos.
  16 Utilizando esta interfaz se pueden hacer objetos genericos que manejen DBO, como por ejemplo tablas para listarlos. La forma común de recorrer una serie de resultados de una búsqueda de DBO puede verse en el método buscar()." name="MECON_DBO" static="0" scope="200" >
  17     <UML:Operation stereotype="" package="" xmi.id="17" type="mixed" abstract="1" documentation="Carga el objeto desde una base de datos.
  18 Si hay un error, devuelve un PEAR_Error, si no devuelve la cantidad de objetos encontrados y carga el primero (si hay al menos un resultado).
  19 En el caso típico, se setea la propiedad que es la clave de la base de datos (siendo el resto nulas). Por ejemplo:
  20 @code
  21 class miDBO extends MECON_DBO {
  22         // Definición...
  23 }
  24 $db = DB::connect('mi DSN');
  25 $miDBO = new MiDBO();
  26 $miDBO->id = 5;
  27 $e =$miDBO->cargar($db);
  28 if (PEAR::isError($e)) {
  29         echo 'Hubo un error: ' . $e->getMessage();
  30 } elseif (!$e) {
  31         echo 'No existe en la base de datos.';
  32 } elseif ($e == 1) {
  33         var_dump($miDBO);
  34 } else {
  35         echo &quot;Se encontraron $e elementos!';
  36 }
  37 @endcode
  38 @see buscar()
  39 @internal
  40 En el caso general, se hace un &lt;tt>SELECT&lt;/tt> con un &lt;tt>WHERE&lt;/tt> basado en los atributos no nulos concatenados con &lt;tt>AND&lt;/tt>." name="cargar" static="0" scope="200" >
  41      <UML:Parameter stereotype="" package="" xmi.id="1" value="null" type="mixed" abstract="0" documentation="DB o DB_Result a usar para la carga." name="db" static="0" scope="200" />
  42     </UML:Operation>
  43     <UML:Operation stereotype="" package="" xmi.id="18" type="mixed" abstract="1" documentation="Guarda el objeto en una base de datos.
  44 Si alguna clave es &lt;tt>null&lt;/tt>, generalmente se guarda un objeto nuevo autoincrementando la clave en &lt;tt>null&lt;/tt>. Si todas las claves son distintas de &lt;tt>null&lt;/tt> y existe un objeto con las mismas claves, se modifica del existente los campos que el objeto no tenga en &lt;tt>null&lt;/tt>; si no existe da error a menos que se use el indicador &lt;tt>\$nuevo&lt;/tt>, en cuyo caso se agrega como nuevo. Si hay un error, devuelve un PEAR_Error. Si se guardan los datos bien, devuelve &lt;tt>true&lt;/tt>.
  45 Por ejemplo:
  46 @code
  47 class miDBO extends MECON_DBO {
  48         // Definición...
  49 }
  50 $db = DB::connect('mi DSN');
  51 $miDBO = new MiDBO();
  52 $miDBO->id = 5;
  53 $miDBO->nombre = 'Petete';
  54 $miDBO->edad = 65;
  55 // Crea una nueva entrada en la DB.
  56 $e =$miDBO->guardar($db, true);
  57 if ($e === true) {
  58         echo 'Se guardó bien.';
  59 } else {
  60         echo 'Hubo un error: ' . $e->getMessage();
  61 }
  62 // Cambia la edad del objeto recién guardado.
  63 $miDBO->edad = 56;
  64 $e =$miDBO->guardar($db);
  65 if ($e === true) {
  66         echo 'Se actualizó bien.';
  67 } else {
  68         echo 'Hubo un error: '. $e->getMessage();
  69 }
  70 @endcode
  71 @internal
  72 En el caso general, se hace un &lt;tt>UPDATE&lt;/tt> con un &lt;tt>WHERE&lt;/tt> basado en la(s) clave(s) concatenadas con &lt;/tt>AND&lt;/tt>, y un &lt;tt>SET&lt;/tt> con los atributos no &lt;tt>nulos&lt;/tt>." name="guardar" static="0" scope="200" >
  73      <UML:Parameter stereotype="" package="" xmi.id="1" value="null" type="DB" abstract="0" documentation="Base de datos a usar para guardar el objeto." name="db" static="0" scope="200" />
  74      <UML:Parameter stereotype="" package="" xmi.id="2" value="false" type="bool" abstract="0" documentation="Indica si debe forzarse a guardar una entrada nueva en la DB. Se usa típicamente en bases cuya clave es externa y no puede especificarse un elemento nuevo con \c null en la clave." name="nuevo" static="0" scope="200" />
  75     </UML:Operation>
  76     <UML:Operation stereotype="" package="" xmi.id="19" type="mixed" abstract="1" documentation="Borra el objeto de una base de datos.
  77 Si hay un error, devuelve un PEAR_Error. Si no, devuelve la cantidad de objetos borrados de la base de datos.
  78 Por ejemplo:
  79 @code
  80 class miDBO extends MECON_DBO {
  81         // Definición...
  82 }
  83 $db = DB::connect('mi DSN');
  84 $miDBO = new MiDBO();
  85 $miDBO->id = 5;
  86 $e =$miDBO->borrar($db);
  87 if (PEAR::isError($e)) {
  88         echo 'Hubo un error: ' . $e->getMessage();
  89 } elseif (!$e) {
  90         echo 'No estaba en la base de datos.';
  91 } elseif ($e == 1) {
  92         echo 'Se borró de la base de datos';
  93 } else {
  94         echo &quot;Se borraron $e elementos!';
  95 }
  96 @endcode
  97 @internal
  98 En el caso general, se hace un &lt;tt>DELETE&lt;/tt> con un &lt;tt>WHERE&lt;/tt> basado en los atributos no nulos concatenados con &lt;tt>AND&lt;/tt>." name="borrar" static="0" scope="200" >
  99      <UML:Parameter stereotype="" package="" xmi.id="1" value="null" type="DB" abstract="0" documentation="Base de datos de donde borrar el objeto." name="db" static="0" scope="200" />
 100     </UML:Operation>
 101     <UML:Operation stereotype="" package="" xmi.id="20" type="mixed" abstract="1" documentation="Busca un objeto en una base de datos.
 102 Si hay un error, devuelve un PEAR_Error. Si no, devuelve un DB_Result con los resultados de la búsqueda.
 103 Por ejemplo:
 104 @code
 105 class miDBO extends MECON_DBO {
 106         // Definición...
 107 }
 108 $db = DB::connect('mi DSN');
 109 $miDBO = new MiDBO();
 110 $miDBO->nombre = 'rez';
 111 $res = $miDBO->buscar($db, MECON_DBO_AND, 'nombre ASC');
 112 if (PEAR::isError($res)) {
 113         echo 'Hubo un error.';
 114 } else {
 115         echo 'Se encontraron ' . $res->numRows() . ' elementos.';
 116         while (($miDBO->cargar($res) = $e) === true) {
 117                 var_dump($miDBO);
 118         }
 119         if (PEAR::isError($e)) {
 120                 echo 'Hubo un error: ' . $e->getMessage();
 121         }
 122 }
 123 @endcode
 124 @see cargar()
 125 @internal
 126 Es similar a cargar, ya que se hace un &lt;tt>SELECT&lt;/tt> con un &lt;tt>WHERE&lt;/tt> basado en los atributos no nulos pero puede concatenarse con &lt;tt>AND&lt;/tt> u &lt;tt>OR&lt;/tt> y se busca con &lt;tt>LIKE&lt;/tt> para que dea más general." name="buscar" static="0" scope="200" >
 127      <UML:Parameter stereotype="" package="" xmi.id="1" value="null" type="DB" abstract="0" documentation="Base de datos a utilizar en la búsqueda." name="db" static="0" scope="200" />
 128      <UML:Parameter stereotype="" package="" xmi.id="2" value="MECON_DBO_OR" type="int" abstract="0" documentation="Indica que operador se usa para la búsqueda. Puede ser MECON_DBO_AND o MECON_DBO_OR." name="operador" static="0" scope="200" />
 129      <UML:Parameter stereotype="" package="" xmi.id="3" value="''" type="mixed" abstract="0" documentation="Campos por los cuales ordenar. El formato es &lt;tt>campo (ASC|DESC)&lt;/tt> (siedo &lt;tt>ASC&lt;/tt> si se lo ordena de forma ascendente y &lt;tt>DESC&lt;/tt> si se lo ordena de forma descendente). Puede pasarse un &lt;em>string&lt;/em> o un &lt;em>array&lt;/em> con varios &lt;em>strings&lt;/em> con este formato para ordenarlo por más de un campo a la vez." name="orden" static="0" scope="200" />
 130     </UML:Operation>
 131    </UML:Class>
 132   </umlobjects>
 133   <diagrams>
 134    <diagram snapgrid="0" showattsig="1" fillcolor="#ffffc0" zoom="100" showgrid="0" showopsig="1" usefillcolor="1" snapx="10" canvaswidth="733" snapy="10" showatts="1" xmi.id="12" documentation="" type="402" showops="1" showpackage="0" name="diagrama de clases" localid="30000" showstereotype="0" showscope="1" snapcsgrid="0" font="Helvetica,12,-1,5,50,0,0,0,0,0" linecolor="#ff0000" canvasheight="619" >
 135     <widgets>
 136      <UML:ClassWidget usesdiagramfillcolour="0" width="564" showattsigs="601" usesdiagramusefillcolour="0" x="59" linecolour="#ff0000" y="26" showopsigs="601" instancename="" usesdiagramlinecolour="0" fillcolour="#ffffc0" height="93" usefillcolor="1" showattributes="1" isinstance="0" xmi.id="16" showoperations="1" showpackage="0" showscope="1" showstereotype="0" font="Helvetica,10,-1,5,48,0,0,0,0,0" />
 137     </widgets>
 138     <messages/>
 139     <associations/>
 140    </diagram>
 141   </diagrams>
 142   <listview>
 143    <listitem open="1" type="800" id="-1" label="Vistas" >
 144     <listitem open="1" type="801" id="-1" label="Vista lógica" >
 145      <listitem open="0" type="807" id="12" label="diagrama de clases" />
 146      <listitem open="1" type="817" id="16" label="MECON_DBO" >
 147       <listitem open="0" type="815" id="19" label="borrar" />
 148       <listitem open="0" type="815" id="20" label="buscar" />
 149       <listitem open="0" type="815" id="17" label="cargar" />
 150       <listitem open="0" type="815" id="18" label="guardar" />
 151      </listitem>
 152     </listitem>
 153     <listitem open="1" type="802" id="-1" label="Vista de caso de uso" />
 154     <listitem open="1" type="821" id="-1" label="Component View" />
 155     <listitem open="0" type="823" id="-1" label="Diagrams" />
 156     <listitem open="1" type="827" id="-1" label="Deployment View" />
 157    </listitem>
 158   </listview>
 159  </XMI.content>
 160 </XMI>