]> git.llucax.com Git - mecon/samurai.git/blob - doc/apidoc/latex/classSAMURAI__Perfil.tex
Agrego documentacion funcional del Myrna. Agrego un permiso general de acceso a las...
[mecon/samurai.git] / doc / apidoc / latex / classSAMURAI__Perfil.tex
1 \hypertarget{classSAMURAI__Perfil}{
2 \section{Referencia de la Clase SAMURAI\_\-Perfil}
3 \label{classSAMURAI__Perfil}\index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
4 }
5
6
7 \subsection{Descripci\'{o}n detallada}
8 Clase para el manejo de los perfies. 
9
10 public 
11
12
13
14 Definici\'{o}n en la l\'{\i}nea 37 del archivo Perfil.php.\subsection*{M\'{e}todos p\'{u}blicos}
15 \begin{CompactItemize}
16 \item 
17 \hyperlink{classSAMURAI__Perfil_a0}{get\-Id} ()
18 \begin{CompactList}\small\item\em Gets Id. \item\end{CompactList}\item 
19 \hyperlink{classSAMURAI__Perfil_a1}{set\-Id} (\$id)
20 \begin{CompactList}\small\item\em Sets Id. \item\end{CompactList}\item 
21 \hyperlink{classSAMURAI__Perfil_a2}{get\-Descripcion} ()
22 \begin{CompactList}\small\item\em Gets Descripcion. \item\end{CompactList}\item 
23 \hyperlink{classSAMURAI__Perfil_a3}{set\-Descripcion} (\$descripcion)
24 \begin{CompactList}\small\item\em Sets Descripcion. \item\end{CompactList}\item 
25 \hyperlink{classSAMURAI__Perfil_a4}{get\-Tipo} ()
26 \begin{CompactList}\small\item\em Gets Tipo. \item\end{CompactList}\item 
27 \hyperlink{classSAMURAI__Perfil_a5}{set\-Tipo} (\$tipo)
28 \begin{CompactList}\small\item\em Sets Tipo. \item\end{CompactList}\item 
29 \hyperlink{classSAMURAI__Perfil_a6}{get\-Responsable} ()
30 \begin{CompactList}\small\item\em Gets Responsable. \item\end{CompactList}\item 
31 \hyperlink{classSAMURAI__Perfil_a7}{set\-Responsable} (\$responsable)
32 \begin{CompactList}\small\item\em Sets Responsable. \item\end{CompactList}\item 
33 \hyperlink{classSAMURAI__Perfil_a8}{SAMURAI\_\-Perfil} (\&\$db, \$id=null)
34 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
35 \hyperlink{classSAMURAI__Perfil_a9}{\_\-obtener\-Datos\-Db} ()
36 \begin{CompactList}\small\item\em Obtiene los datos de la base de datos. \item\end{CompactList}\item 
37 \hyperlink{classSAMURAI__Perfil_a10}{guardar\-Datos} (\$accion=grabar)
38 \begin{CompactList}\small\item\em Redirecciona segun la accion correspondiente. \item\end{CompactList}\item 
39 \hyperlink{classSAMURAI__Perfil_a11}{\_\-grabar\-Db} ()
40 \begin{CompactList}\small\item\em Graba la informacion del perfil en base. \item\end{CompactList}\item 
41 \hyperlink{classSAMURAI__Perfil_a12}{\_\-borrar\-Db} ()
42 \begin{CompactList}\small\item\em Borra la informacion del perfil de la base. \item\end{CompactList}\item 
43 \hyperlink{classSAMURAI__Perfil_a13}{\_\-modificar\-Db} ()
44 \end{CompactItemize}
45 \subsection*{M\'{e}todos p\'{u}blicos est\'{a}ticos}
46 \begin{CompactItemize}
47 \item 
48 \hyperlink{classSAMURAI__Perfil_e0}{\_\-get\-Id\-Perfiles} (\&\$db)
49 \begin{CompactList}\small\item\em Devuleve un array con los identificadores de todos los perfiles. \item\end{CompactList}\item 
50 \hyperlink{classSAMURAI__Perfil_e1}{get\-Perfiles} (\&\$db)
51 \end{CompactItemize}
52 \subsection*{Atributos p\'{u}blicos}
53 \begin{CompactItemize}
54 \item 
55 \hyperlink{classSAMURAI__Perfil_o0}{\_\-id}
56 \item 
57 \hyperlink{classSAMURAI__Perfil_o1}{\_\-descripcion}
58 \item 
59 \hyperlink{classSAMURAI__Perfil_o2}{\_\-tipo}
60 \item 
61 \hyperlink{classSAMURAI__Perfil_o3}{\_\-db}
62 \item 
63 \hyperlink{classSAMURAI__Perfil_o4}{\_\-responsable}
64 \end{CompactItemize}
65
66
67 \subsection{Documentaci\'{o}n del constructor y destructor}
68 \hypertarget{classSAMURAI__Perfil_a8}{
69 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
70 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
71 \subsubsection[SAMURAI\_\-Perfil]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::SAMURAI\_\-Perfil (\&\$ {\em db}, \$ {\em id} = null)}}
72 \label{classSAMURAI__Perfil_a8}
73
74
75 Constructor. 
76
77 Si recibe un identificador como parametro, busca la informacion en la base.
78
79 \begin{Desc}
80 \item[Parámetros:]
81 \begin{description}
82 \item[{\em SAMURAI\_\-DB}]\&\$db Objeto conexion \item[{\em int}]\$id Identificador del perfil.\end{description}
83 \end{Desc}
84 \begin{Desc}
85 \item[Devuelve:]void  public \end{Desc}
86
87
88 Definici\'{o}n en la l\'{\i}nea 182 del archivo Perfil.php.
89
90 References \_\-db, \_\-descripcion, \_\-id, \_\-obtener\-Datos\-Db(), \_\-tipo, y set\-Id().
91
92 Here is the call graph for this function:\begin{figure}[H]
93 \begin{center}
94 \leavevmode
95 \includegraphics[width=282pt]{classSAMURAI__Perfil_a8_cgraph}
96 \end{center}
97 \end{figure}
98
99
100 \subsection{Documentaci\'{o}n de las funciones miembro}
101 \hypertarget{classSAMURAI__Perfil_a12}{
102 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_borrarDb@{\_\-borrarDb}}
103 \index{_borrarDb@{\_\-borrarDb}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
104 \subsubsection[\_\-borrarDb]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::\_\-borrar\-Db ()}}
105 \label{classSAMURAI__Perfil_a12}
106
107
108 Borra la informacion del perfil de la base. 
109
110 \begin{Desc}
111 \item[Devuelve:]mixed  protected \end{Desc}
112
113
114 Definici\'{o}n en la l\'{\i}nea 271 del archivo Perfil.php.\hypertarget{classSAMURAI__Perfil_e0}{
115 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_getIdPerfiles@{\_\-getIdPerfiles}}
116 \index{_getIdPerfiles@{\_\-getIdPerfiles}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
117 \subsubsection[\_\-getIdPerfiles]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::\_\-get\-Id\-Perfiles (\&\$ {\em db})\hspace{0.3cm}{\tt  \mbox{[}static\mbox{]}}}}
118 \label{classSAMURAI__Perfil_e0}
119
120
121 Devuleve un array con los identificadores de todos los perfiles. 
122
123 \begin{Desc}
124 \item[Parámetros:]
125 \begin{description}
126 \item[{\em SAMURAI\_\-DB}]\&\$db Base de Datos\end{description}
127 \end{Desc}
128 \begin{Desc}
129 \item[Devuelve:]array(int)  protected \end{Desc}
130
131
132 Definici\'{o}n en la l\'{\i}nea 298 del archivo Perfil.php.\hypertarget{classSAMURAI__Perfil_a11}{
133 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_grabarDb@{\_\-grabarDb}}
134 \index{_grabarDb@{\_\-grabarDb}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
135 \subsubsection[\_\-grabarDb]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::\_\-grabar\-Db ()}}
136 \label{classSAMURAI__Perfil_a11}
137
138
139 Graba la informacion del perfil en base. 
140
141 \begin{Desc}
142 \item[Devuelve:]mixed  protected \end{Desc}
143
144
145 Definici\'{o}n en la l\'{\i}nea 258 del archivo Perfil.php.\hypertarget{classSAMURAI__Perfil_a13}{
146 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_modificarDb@{\_\-modificarDb}}
147 \index{_modificarDb@{\_\-modificarDb}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
148 \subsubsection[\_\-modificarDb]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::\_\-modificar\-Db ()}}
149 \label{classSAMURAI__Perfil_a13}
150
151
152 \begin{Desc}
153 \item[Devuelve:]mixed  protected \end{Desc}
154
155
156 Definici\'{o}n en la l\'{\i}nea 282 del archivo Perfil.php.\hypertarget{classSAMURAI__Perfil_a9}{
157 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_obtenerDatosDb@{\_\-obtenerDatosDb}}
158 \index{_obtenerDatosDb@{\_\-obtenerDatosDb}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
159 \subsubsection[\_\-obtenerDatosDb]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::\_\-obtener\-Datos\-Db ()}}
160 \label{classSAMURAI__Perfil_a9}
161
162
163 Obtiene los datos de la base de datos. 
164
165 \begin{Desc}
166 \item[Devuelve:]void  protected \end{Desc}
167
168
169 Definici\'{o}n en la l\'{\i}nea 205 del archivo Perfil.php.
170
171 References \_\-db, set\-Descripcion(), set\-Responsable(), y set\-Tipo().
172
173 Referenciado por SAMURAI\_\-Perfil().
174
175 Here is the call graph for this function:\begin{figure}[H]
176 \begin{center}
177 \leavevmode
178 \includegraphics[width=282pt]{classSAMURAI__Perfil_a9_cgraph}
179 \end{center}
180 \end{figure}
181 \hypertarget{classSAMURAI__Perfil_a2}{
182 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!getDescripcion@{getDescripcion}}
183 \index{getDescripcion@{getDescripcion}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
184 \subsubsection[getDescripcion]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::get\-Descripcion ()}}
185 \label{classSAMURAI__Perfil_a2}
186
187
188 Gets Descripcion. 
189
190 \begin{Desc}
191 \item[Devuelve:]string  public \end{Desc}
192
193
194 Definici\'{o}n en la l\'{\i}nea 107 del archivo Perfil.php.
195
196 References \_\-descripcion.\hypertarget{classSAMURAI__Perfil_a0}{
197 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!getId@{getId}}
198 \index{getId@{getId}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
199 \subsubsection[getId]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::get\-Id ()}}
200 \label{classSAMURAI__Perfil_a0}
201
202
203 Gets Id. 
204
205 \begin{Desc}
206 \item[Devuelve:]int  public \end{Desc}
207
208
209 Definici\'{o}n en la l\'{\i}nea 84 del archivo Perfil.php.
210
211 References \_\-id.\hypertarget{classSAMURAI__Perfil_e1}{
212 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!getPerfiles@{getPerfiles}}
213 \index{getPerfiles@{getPerfiles}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
214 \subsubsection[getPerfiles]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::get\-Perfiles (\&\$ {\em db})\hspace{0.3cm}{\tt  \mbox{[}static\mbox{]}}}}
215 \label{classSAMURAI__Perfil_e1}
216
217
218 \begin{Desc}
219 \item[Parámetros:]
220 \begin{description}
221 \item[{\em SAMURAI\_\-DB}]\&\$db Base de datos\end{description}
222 \end{Desc}
223 \begin{Desc}
224 \item[Devuelve:]array(Perfil)  public \end{Desc}
225
226
227 Definici\'{o}n en la l\'{\i}nea 312 del archivo Perfil.php.\hypertarget{classSAMURAI__Perfil_a6}{
228 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!getResponsable@{getResponsable}}
229 \index{getResponsable@{getResponsable}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
230 \subsubsection[getResponsable]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::get\-Responsable ()}}
231 \label{classSAMURAI__Perfil_a6}
232
233
234 Gets Responsable. 
235
236 \begin{Desc}
237 \item[Devuelve:]string  public \end{Desc}
238
239
240 Definici\'{o}n en la l\'{\i}nea 153 del archivo Perfil.php.
241
242 References \_\-responsable.\hypertarget{classSAMURAI__Perfil_a4}{
243 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!getTipo@{getTipo}}
244 \index{getTipo@{getTipo}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
245 \subsubsection[getTipo]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::get\-Tipo ()}}
246 \label{classSAMURAI__Perfil_a4}
247
248
249 Gets Tipo. 
250
251 \begin{Desc}
252 \item[Devuelve:]string  public \end{Desc}
253
254
255 Definici\'{o}n en la l\'{\i}nea 130 del archivo Perfil.php.
256
257 References \_\-tipo.\hypertarget{classSAMURAI__Perfil_a10}{
258 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!guardarDatos@{guardarDatos}}
259 \index{guardarDatos@{guardarDatos}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
260 \subsubsection[guardarDatos]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::guardar\-Datos (\$ {\em accion} = grabar)}}
261 \label{classSAMURAI__Perfil_a10}
262
263
264 Redirecciona segun la accion correspondiente. 
265
266 \begin{Desc}
267 \item[Parámetros:]
268 \begin{description}
269 \item[{\em string}]\$accion Representa la accion a desarrollar\end{description}
270 \end{Desc}
271 \begin{Desc}
272 \item[Devuelve:]mixed  public \end{Desc}
273
274
275 Definici\'{o}n en la l\'{\i}nea 245 del archivo Perfil.php.\hypertarget{classSAMURAI__Perfil_a3}{
276 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!setDescripcion@{setDescripcion}}
277 \index{setDescripcion@{setDescripcion}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
278 \subsubsection[setDescripcion]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::set\-Descripcion (\$ {\em descripcion})}}
279 \label{classSAMURAI__Perfil_a3}
280
281
282 Sets Descripcion. 
283
284 \begin{Desc}
285 \item[Parámetros:]
286 \begin{description}
287 \item[{\em string}]\$descripcion Descripcion.\end{description}
288 \end{Desc}
289 \begin{Desc}
290 \item[Devuelve:]void  public \end{Desc}
291
292
293 Definici\'{o}n en la l\'{\i}nea 119 del archivo Perfil.php.
294
295 References \_\-descripcion.
296
297 Referenciado por \_\-obtener\-Datos\-Db().\hypertarget{classSAMURAI__Perfil_a1}{
298 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!setId@{setId}}
299 \index{setId@{setId}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
300 \subsubsection[setId]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::set\-Id (\$ {\em id})}}
301 \label{classSAMURAI__Perfil_a1}
302
303
304 Sets Id. 
305
306 \begin{Desc}
307 \item[Parámetros:]
308 \begin{description}
309 \item[{\em int}]\$id Id.\end{description}
310 \end{Desc}
311 \begin{Desc}
312 \item[Devuelve:]void  public \end{Desc}
313
314
315 Definici\'{o}n en la l\'{\i}nea 96 del archivo Perfil.php.
316
317 References \_\-id.
318
319 Referenciado por SAMURAI\_\-Perfil().\hypertarget{classSAMURAI__Perfil_a7}{
320 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!setResponsable@{setResponsable}}
321 \index{setResponsable@{setResponsable}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
322 \subsubsection[setResponsable]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::set\-Responsable (\$ {\em responsable})}}
323 \label{classSAMURAI__Perfil_a7}
324
325
326 Sets Responsable. 
327
328 \begin{Desc}
329 \item[Parámetros:]
330 \begin{description}
331 \item[{\em string}]\$responsable Responsable.\end{description}
332 \end{Desc}
333 \begin{Desc}
334 \item[Devuelve:]void  public \end{Desc}
335
336
337 Definici\'{o}n en la l\'{\i}nea 165 del archivo Perfil.php.
338
339 References \_\-responsable.
340
341 Referenciado por \_\-obtener\-Datos\-Db().\hypertarget{classSAMURAI__Perfil_a5}{
342 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!setTipo@{setTipo}}
343 \index{setTipo@{setTipo}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
344 \subsubsection[setTipo]{\setlength{\rightskip}{0pt plus 5cm}SAMURAI\_\-Perfil::set\-Tipo (\$ {\em tipo})}}
345 \label{classSAMURAI__Perfil_a5}
346
347
348 Sets Tipo. 
349
350 \begin{Desc}
351 \item[Parámetros:]
352 \begin{description}
353 \item[{\em string}]\$tipo Tipo.\end{description}
354 \end{Desc}
355 \begin{Desc}
356 \item[Devuelve:]void  public \end{Desc}
357
358
359 Definici\'{o}n en la l\'{\i}nea 142 del archivo Perfil.php.
360
361 References \_\-tipo.
362
363 Referenciado por \_\-obtener\-Datos\-Db().
364
365 \subsection{Documentaci\'{o}n de los datos miembro}
366 \hypertarget{classSAMURAI__Perfil_o3}{
367 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_db@{\_\-db}}
368 \index{_db@{\_\-db}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
369 \subsubsection[\_\-db]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classSAMURAI__Perfil_o3}{SAMURAI\_\-Perfil::\_\-db}}}
370 \label{classSAMURAI__Perfil_o3}
371
372
373
374
375 Definici\'{o}n en la l\'{\i}nea 68 del archivo Perfil.php.
376
377 Referenciado por \_\-obtener\-Datos\-Db(), y SAMURAI\_\-Perfil().\hypertarget{classSAMURAI__Perfil_o1}{
378 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_descripcion@{\_\-descripcion}}
379 \index{_descripcion@{\_\-descripcion}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
380 \subsubsection[\_\-descripcion]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classSAMURAI__Perfil_o1}{SAMURAI\_\-Perfil::\_\-descripcion}}}
381 \label{classSAMURAI__Perfil_o1}
382
383
384
385
386 Definici\'{o}n en la l\'{\i}nea 52 del archivo Perfil.php.
387
388 Referenciado por get\-Descripcion(), SAMURAI\_\-Perfil(), y set\-Descripcion().\hypertarget{classSAMURAI__Perfil_o0}{
389 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_id@{\_\-id}}
390 \index{_id@{\_\-id}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
391 \subsubsection[\_\-id]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classSAMURAI__Perfil_o0}{SAMURAI\_\-Perfil::\_\-id}}}
392 \label{classSAMURAI__Perfil_o0}
393
394
395
396
397 Definici\'{o}n en la l\'{\i}nea 44 del archivo Perfil.php.
398
399 Referenciado por get\-Id(), SAMURAI\_\-Perfil(), y set\-Id().\hypertarget{classSAMURAI__Perfil_o4}{
400 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_responsable@{\_\-responsable}}
401 \index{_responsable@{\_\-responsable}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
402 \subsubsection[\_\-responsable]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classSAMURAI__Perfil_o4}{SAMURAI\_\-Perfil::\_\-responsable}}}
403 \label{classSAMURAI__Perfil_o4}
404
405
406
407
408 Definici\'{o}n en la l\'{\i}nea 76 del archivo Perfil.php.
409
410 Referenciado por get\-Responsable(), y set\-Responsable().\hypertarget{classSAMURAI__Perfil_o2}{
411 \index{SAMURAI_Perfil@{SAMURAI\_\-Perfil}!_tipo@{\_\-tipo}}
412 \index{_tipo@{\_\-tipo}!SAMURAI_Perfil@{SAMURAI\_\-Perfil}}
413 \subsubsection[\_\-tipo]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classSAMURAI__Perfil_o2}{SAMURAI\_\-Perfil::\_\-tipo}}}
414 \label{classSAMURAI__Perfil_o2}
415
416
417
418
419 Definici\'{o}n en la l\'{\i}nea 60 del archivo Perfil.php.
420
421 Referenciado por get\-Tipo(), SAMURAI\_\-Perfil(), y set\-Tipo().
422
423 La documentaci\'{o}n para esta clase fu\'{e} generada a partir del siguiente archivo:\begin{CompactItemize}
424 \item 
425 \hyperlink{Perfil_8php}{Perfil.php}\end{CompactItemize}