~vcs-imports/almidon/trunk

« back to all changes in this revision

Viewing changes to doc/phpdoc/almidon/AlmData.html

  • Committer: javier
  • Date: 2010-09-19 17:56:59 UTC
  • Revision ID: svn-v4:924a4236-293c-0410-b38f-c0813de1d4fd:trunk:402
class Data: documentado! (falta variables, queremos documentarlas o hacerlas privadas?)

Show diffs side-by-side

added added

removed removed

Lines of Context:
48
48
                                                                                                <div class="method-definition">
49
49
                                                                                        <span class="method-result">string</span>
50
50
                                                                                <a href="#basicError" title="details" class="method-name">basicError</a>
51
 
                                                                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$dsn</span>)
 
51
                                                                                        ([<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$dsn</span>)
52
52
                                                                        </div>
53
53
                                                                                                                                <div class="method-definition">
54
54
                                                                                        <span class="method-result">object CND</span>
63
63
                                                                                                                                <div class="method-definition">
64
64
                                                                                        <span class="method-result">resource</span>
65
65
                                                                                <a href="#connect" title="details" class="method-name">connect</a>
66
 
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dsn</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">false</span>])
 
66
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$dsn</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">false</span>])
67
67
                                                                        </div>
68
68
                                                                                                                                <div class="method-definition">
69
69
                                                                                        <span class="method-result">bool</span>
73
73
                                                                                                                                <div class="method-definition">
74
74
                                                                                        <span class="method-result">string</span>
75
75
                                                                                <a href="#escape" title="details" class="method-name">escape</a>
76
 
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$var</span>)
 
76
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$var</span>)
77
77
                                                                        </div>
78
78
                                                                                                                                <div class="method-definition">
79
79
                                                                                        <span class="method-result">array</span>
86
86
                                                                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$sqlcmd</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$calling</span> = <span class="var-default">null</span>])
87
87
                                                                        </div>
88
88
                                                                                                                                <div class="method-definition">
89
 
                                                                                        <span class="method-result">void</span>
 
89
                                                                                        <span class="method-result">array</span>
90
90
                                                                                <a href="#parseDSN" title="details" class="method-name">parseDSN</a>
91
 
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dsn</span>)
 
91
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$dsn</span>)
92
92
                                                                        </div>
93
93
                                                                                                                                <div class="method-definition">
94
94
                                                                                        <span class="method-result">void</span>
95
95
                                                                                <a href="#printError" title="details" class="method-name">printError</a>
96
 
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$error_msg</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$raise</span> = <span class="var-default">true</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$die</span> = <span class="var-default">false</span>])
 
96
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$error_msg</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$raise</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$die</span> = <span class="var-default">false</span>], <span class="var-type">bool</span>&nbsp;<span class="var-name">$rais</span>)
97
97
                                                                        </div>
98
98
                                                                                                                                <div class="method-definition">
99
99
                                                                                        <span class="method-result">resource</span>
100
100
                                                                                <a href="#query" title="details" class="method-name">query</a>
101
 
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$sqlcmd</span>)
 
101
                                                                                        (<span class="var-type">strign</span>&nbsp;<span class="var-name">$sqlcmd</span>)
102
102
                                                                        </div>
103
103
                                                                                                                                <div class="method-definition">
104
104
                                                                                        <span class="method-result">int</span>
105
105
                                                                                <a href="#rows" title="details" class="method-name">rows</a>
106
 
                                                                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>])
 
106
                                                                                        ([<span class="var-type">resource</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>])
107
107
                                                                        </div>
108
108
                                                                                                                                <div class="method-definition">
109
109
                                                                                        <span class="method-result">void</span>
110
110
                                                                                <a href="#setFunctions" title="details" class="method-name">setFunctions</a>
111
 
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dbtype</span>)
 
111
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$dbtype</span>)
112
112
                                                                        </div>
113
113
                                                                </div>
114
114
                </div>
130
130
<div class="oddrow">
131
131
        
132
132
        <div class="method-header">
133
 
                <span class="method-title">basicError</span> (line <span class="line-number">146</span>)
 
133
                <span class="method-title">basicError</span> (line <span class="line-number">159</span>)
134
134
        </div> 
135
135
        
136
136
        <!-- ========== Info from phpDoc block ========= -->
137
137
<p class="short-description">obtiene el ultimo error del db server, distintos comandos para cada db server</p>
138
138
        <ul class="tags">
139
 
                                <li><span class="field">return:</span> conteniendo el ultimo error (last_error)</li>
 
139
                                <li><span class="field">return:</span> conteniendo el ultimo error (last_error)  FIXME: por que hacer switch(dbtype) aqui?</li>
140
140
                        </ul>
141
141
        
142
142
        <div class="method-signature">
144
144
                <span class="method-name">
145
145
                        basicError
146
146
                </span>
147
 
                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$dsn</span>)
 
147
                                        ([<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$dsn</span>)
148
148
                        </div>
149
149
        
150
150
                        <ul class="parameters">
151
151
                                        <li>
152
 
                                <span class="var-type"></span>
153
 
                                <span class="var-name">$data</span>                     </li>
 
152
                                <span class="var-type">string</span>
 
153
                                <span class="var-name">$data</span><span class="var-description">: FIXME: que es esto?</span>                   </li>
154
154
                                        <li>
155
 
                                <span class="var-type"></span>
156
 
                                <span class="var-name">$dsn</span>                      </li>
 
155
                                <span class="var-type">string</span>
 
156
                                <span class="var-name">$dsn</span><span class="var-description">: dsn de conexion a db server</span>                    </li>
157
157
                                </ul>
158
158
                
159
159
                        
162
162
<div class="evenrow">
163
163
        
164
164
        <div class="method-header">
165
 
                <span class="method-title">cdn_connect</span> (line <span class="line-number">126</span>)
 
165
                <span class="method-title">cdn_connect</span> (line <span class="line-number">136</span>)
166
166
        </div> 
167
167
        
168
168
        <!-- ========== Info from phpDoc block ========= -->
186
186
<div class="oddrow">
187
187
        
188
188
        <div class="method-header">
189
 
                <span class="method-title">cdn_upload</span> (line <span class="line-number">136</span>)
 
189
                <span class="method-title">cdn_upload</span> (line <span class="line-number">146</span>)
190
190
        </div> 
191
191
        
192
192
        <!-- ========== Info from phpDoc block ========= -->
218
218
<div class="evenrow">
219
219
        
220
220
        <div class="method-header">
221
 
                <span class="method-title">connect</span> (line <span class="line-number">86</span>)
 
221
                <span class="method-title">connect</span> (line <span class="line-number">96</span>)
222
222
        </div> 
223
223
        
224
224
        <!-- ========== Info from phpDoc block ========= -->
225
 
<p class="short-description">Conexion a la base de datos</p>
 
225
<p class="short-description">Conexion a la base de datos, si no se ha hecho ya</p>
226
226
        <ul class="tags">
227
227
                                <li><span class="field">return:</span> de conexion</li>
228
228
                        </ul>
232
232
                <span class="method-name">
233
233
                        connect
234
234
                </span>
235
 
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dsn</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">false</span>])
 
235
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$dsn</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">false</span>])
236
236
                        </div>
237
237
        
238
238
                        <ul class="parameters">
239
239
                                        <li>
240
 
                                <span class="var-type"></span>
241
 
                                <span class="var-name">$dsn</span>                      </li>
 
240
                                <span class="var-type">string</span>
 
241
                                <span class="var-name">$dsn</span><span class="var-description">: dsn de conexion a la base de datos</span>                     </li>
242
242
                                        <li>
243
 
                                <span class="var-type"></span>
244
 
                                <span class="var-name">$options</span>                  </li>
 
243
                                <span class="var-type">bool</span>
 
244
                                <span class="var-name">$options</span><span class="var-description">: FIXME: se usa?</span>                     </li>
245
245
                                </ul>
246
246
                
247
247
                        
250
250
<div class="oddrow">
251
251
        
252
252
        <div class="method-header">
253
 
                <span class="method-title">disconnect</span> (line <span class="line-number">193</span>)
 
253
                <span class="method-title">disconnect</span> (line <span class="line-number">206</span>)
254
254
        </div> 
255
255
        
256
256
        <!-- ========== Info from phpDoc block ========= -->
274
274
<div class="evenrow">
275
275
        
276
276
        <div class="method-header">
277
 
                <span class="method-title">escape</span> (line <span class="line-number">214</span>)
 
277
                <span class="method-title">escape</span> (line <span class="line-number">229</span>)
278
278
        </div> 
279
279
        
280
280
        <!-- ========== Info from phpDoc block ========= -->
281
 
<p class="short-description">escape string by native db's function</p>
 
281
<p class="short-description">&quot;escapea&quot; una cadena para poder usarla de manera segura en comando sql</p>
282
282
        <ul class="tags">
283
 
                                <li><span class="field">return:</span> escaped</li>
 
283
                                <li><span class="field">return:</span> escaped string, lista para usar en sql</li>
284
284
                        </ul>
285
285
        
286
286
        <div class="method-signature">
288
288
                <span class="method-name">
289
289
                        escape
290
290
                </span>
291
 
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$var</span>)
 
291
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$var</span>)
292
292
                        </div>
293
293
        
294
294
                        <ul class="parameters">
295
295
                                        <li>
296
 
                                <span class="var-type"></span>
297
 
                                <span class="var-name">$var</span>                      </li>
 
296
                                <span class="var-type">string</span>
 
297
                                <span class="var-name">$var</span><span class="var-description">: cadena a &quot;escapear&quot;</span>                  </li>
298
298
                                </ul>
299
299
                
300
300
                        
303
303
<div class="oddrow">
304
304
        
305
305
        <div class="method-header">
306
 
                <span class="method-title">fetchRow</span> (line <span class="line-number">233</span>)
 
306
                <span class="method-title">fetchRow</span> (line <span class="line-number">248</span>)
307
307
        </div> 
308
308
        
309
309
        <!-- ========== Info from phpDoc block ========= -->
335
335
<div class="evenrow">
336
336
        
337
337
        <div class="method-header">
338
 
                <span class="method-title">isError</span> (line <span class="line-number">170</span>)
 
338
                <span class="method-title">isError</span> (line <span class="line-number">183</span>)
339
339
        </div> 
340
340
        
341
341
        <!-- ========== Info from phpDoc block ========= -->
342
342
<p class="short-description">Reporta si ha habido un error en la db</p>
343
343
        <ul class="tags">
344
 
                                <li><span class="field">return:</span> true si ya esta registrado el error, o lo registra y devuelve true si last_error</li>
 
344
                                <li><span class="field">return:</span> true si ya esta registrado el error, o lo registra y devuelve true si last_error  FIXME: Como se llama isError? Como podemos reportar quien lo llamo,         donde estaba el SQL que dio el error? Como usar $calling?</li>
345
345
                        </ul>
346
346
        
347
347
        <div class="method-signature">
367
367
<div class="oddrow">
368
368
        
369
369
        <div class="method-header">
370
 
                <span class="method-title">parseDSN</span> (line <span class="line-number">17</span>)
 
370
                <span class="method-title">parseDSN</span> (line <span class="line-number">21</span>)
371
371
        </div> 
372
372
        
373
373
        <!-- ========== Info from phpDoc block ========= -->
374
 
<p class="short-description">Obtiene info de conexion del DSN: dbtype, dbname, host, username, pass</p>
 
374
<p class="short-description">Obtiene info de conexion del DSN</p>
 
375
        <ul class="tags">
 
376
                                <li><span class="field">return:</span> con datos de conexion: dbtype, dbname, host, username, pass</li>
 
377
                        </ul>
375
378
        
376
379
        <div class="method-signature">
377
 
                <span class="method-result">void</span>
 
380
                <span class="method-result">array</span>
378
381
                <span class="method-name">
379
382
                        parseDSN
380
383
                </span>
381
 
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dsn</span>)
 
384
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$dsn</span>)
382
385
                        </div>
383
386
        
384
387
                        <ul class="parameters">
385
388
                                        <li>
386
 
                                <span class="var-type"></span>
387
 
                                <span class="var-name">$dsn</span>                      </li>
 
389
                                <span class="var-type">string</span>
 
390
                                <span class="var-name">$dsn</span><span class="var-description">: type://username:password@hostname/database</span>                     </li>
388
391
                                </ul>
389
392
                
390
393
                        
393
396
<div class="evenrow">
394
397
        
395
398
        <div class="method-header">
396
 
                <span class="method-title">printError</span> (line <span class="line-number">28</span>)
 
399
                <span class="method-title">printError</span> (line <span class="line-number">35</span>)
397
400
        </div> 
398
401
        
399
402
        <!-- ========== Info from phpDoc block ========= -->
404
407
                <span class="method-name">
405
408
                        printError
406
409
                </span>
407
 
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$error_msg</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$raise</span> = <span class="var-default">true</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$die</span> = <span class="var-default">false</span>])
 
410
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$error_msg</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$raise</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$die</span> = <span class="var-default">false</span>], <span class="var-type">bool</span>&nbsp;<span class="var-name">$rais</span>)
408
411
                        </div>
409
412
        
410
413
                        <ul class="parameters">
411
414
                                        <li>
412
 
                                <span class="var-type"></span>
413
 
                                <span class="var-name">$error_msg</span>                        </li>
 
415
                                <span class="var-type">string</span>
 
416
                                <span class="var-name">$error_msg</span><span class="var-description">: error a imprimir</span>                 </li>
 
417
                                        <li>
 
418
                                <span class="var-type">bool</span>
 
419
                                <span class="var-name">$rais</span><span class="var-description">: imprimir en pantalla. FIXME: se usa?</span>                  </li>
 
420
                                        <li>
 
421
                                <span class="var-type">bool</span>
 
422
                                <span class="var-name">$die</span><span class="var-description">: die después del reportar el error</span>                      </li>
414
423
                                        <li>
415
424
                                <span class="var-type"></span>
416
425
                                <span class="var-name">$raise</span>                    </li>
417
 
                                        <li>
418
 
                                <span class="var-type"></span>
419
 
                                <span class="var-name">$die</span>                      </li>
420
426
                                </ul>
421
427
                
422
428
                        
425
431
<div class="oddrow">
426
432
        
427
433
        <div class="method-header">
428
 
                <span class="method-title">query</span> (line <span class="line-number">224</span>)
 
434
                <span class="method-title">query</span> (line <span class="line-number">239</span>)
429
435
        </div> 
430
436
        
431
437
        <!-- ========== Info from phpDoc block ========= -->
439
445
                <span class="method-name">
440
446
                        query
441
447
                </span>
442
 
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$sqlcmd</span>)
 
448
                                        (<span class="var-type">strign</span>&nbsp;<span class="var-name">$sqlcmd</span>)
443
449
                        </div>
444
450
        
445
451
                        <ul class="parameters">
446
452
                                        <li>
447
 
                                <span class="var-type"></span>
448
 
                                <span class="var-name">$sqlcmd</span>                   </li>
 
453
                                <span class="var-type">strign</span>
 
454
                                <span class="var-name">$sqlcmd</span><span class="var-description">: comando sql a ejecutar</span>                      </li>
449
455
                                </ul>
450
456
                
451
457
                        
454
460
<div class="evenrow">
455
461
        
456
462
        <div class="method-header">
457
 
                <span class="method-title">rows</span> (line <span class="line-number">202</span>)
 
463
                <span class="method-title">rows</span> (line <span class="line-number">216</span>)
458
464
        </div> 
459
465
        
460
466
        <!-- ========== Info from phpDoc block ========= -->
468
474
                <span class="method-name">
469
475
                        rows
470
476
                </span>
471
 
                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>])
 
477
                                        ([<span class="var-type">resource</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>])
472
478
                        </div>
473
479
        
474
480
                        <ul class="parameters">
475
481
                                        <li>
476
 
                                <span class="var-type"></span>
477
 
                                <span class="var-name">$data</span>                     </li>
 
482
                                <span class="var-type">resource</span>
 
483
                                <span class="var-name">$data</span><span class="var-description">: recurso de query, si no se especifica se usa el de tabla actual</span>                       </li>
478
484
                                </ul>
479
485
                
480
486
                        
483
489
<div class="oddrow">
484
490
        
485
491
        <div class="method-header">
486
 
                <span class="method-title">setFunctions</span> (line <span class="line-number">41</span>)
 
492
                <span class="method-title">setFunctions</span> (line <span class="line-number">49</span>)
487
493
        </div> 
488
494
        
489
495
        <!-- ========== Info from phpDoc block ========= -->
490
 
<p class="short-description">Define las distintas funciones SQL segun cada db server: postgresql, sqlite, mysql</p>
 
496
<p class="short-description">Define las distintas funciones SQL segun cada db server</p>
491
497
        
492
498
        <div class="method-signature">
493
499
                <span class="method-result">void</span>
494
500
                <span class="method-name">
495
501
                        setFunctions
496
502
                </span>
497
 
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dbtype</span>)
 
503
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$dbtype</span>)
498
504
                        </div>
499
505
        
500
506
                        <ul class="parameters">
501
507
                                        <li>
502
 
                                <span class="var-type"></span>
503
 
                                <span class="var-name">$dbtype</span>                   </li>
 
508
                                <span class="var-type">string</span>
 
509
                                <span class="var-name">$dbtype</span><span class="var-description">: base de datos: psql, mysql, sqlite</span>                  </li>
504
510
                                </ul>
505
511
                
506
512
                        
511
517
 
512
518
 
513
519
        <p class="notes" id="credit">
514
 
                Documentation generated on Sun, 19 Sep 2010 07:46:51 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 
520
                Documentation generated on Sun, 19 Sep 2010 11:52:58 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
515
521
        </p>
516
522
        </div></body>
517
523
</html>
 
 
b'\\ No newline at end of file'