]> git.llucax.com Git - z.facultad/75.43/tp1.git/commitdiff
Se corrige documentación.
authorLeandro Lucarella <llucax@gmail.com>
Wed, 4 May 2005 20:17:43 +0000 (20:17 +0000)
committerLeandro Lucarella <llucax@gmail.com>
Wed, 4 May 2005 20:17:43 +0000 (20:17 +0000)
src/lib/file.log.php

index be05b963fa84aa4f6853c07228490d7e915d1826..97770180e03ea121bbe76745d381ddc8a7b3b479 100644 (file)
@@ -11,9 +11,9 @@
 require_once 'lib/file.php';
 
 /**
- * Obtiene el log de un usuario
+ * Abre el archivo de log.
  *
- * @return array con id, password, email (false si hubo error o no está).
+ * @return false si hubo error, el file pointer del archivo si se abrió bien.
  */
 function file_log_open($user)
 {
@@ -21,9 +21,9 @@ function file_log_open($user)
 }
 
 /**
- * Obtiene el log de un usuario
+ * Obtiene el próximo mensaje del log.
  *
- * @return array con id, password, email (false si hubo error o no está).
+ * @return array con (fecha, mensaje) o false si no hay más.
  */
 function file_log_next($fp)
 {
@@ -31,9 +31,9 @@ function file_log_next($fp)
 }
 
 /**
- * Obtiene el log de un usuario
+ * Se posiciona en un mensaje de log determinado.
  *
- * @return array con id, password, email (false si hubo error o no está).
+ * @return false si hubo error.
  */
 function file_log_seek($fp, $pos)
 {
@@ -42,9 +42,9 @@ function file_log_seek($fp, $pos)
 }
 
 /**
- * Obtiene el log de un usuario
+ * Se posiciona en el primer mensaje de log que sea posterior a $fecha_desde.
  *
- * @return array con id, password, email (false si hubo error o no está).
+ * @return posición del archivo donde empiezan los mensajes posteriores.
  */
 function file_log_seek_fecha($fp, $fecha_desde)
 {
@@ -66,9 +66,9 @@ function file_log_seek_fecha($fp, $fecha_desde)
 }
 
 /**
- * Obtiene el log de un usuario
+ * Cierra el archivo de log
  *
- * @return array con id, password, email (false si hubo error o no está).
+ * @return false si hay error.
  */
 function file_log_close($fp)
 {
@@ -76,9 +76,10 @@ function file_log_close($fp)
 }
 
 /**
- * Obtiene la información de un usuario.
+ * Obtiene la cantidad de mensajes de log que hay para un usuario.
+ * Si se especifica $fecha_desde, se cuentan sólo los posteriores a esa fecha.
  *
- * @return array con id, password, email (false si hubo error o no está).
+ * @return cantidad de mensajes de log.
  */
 function file_log_count($user, $fecha_desde = null)
 {
@@ -91,9 +92,9 @@ function file_log_count($user, $fecha_desde = null)
 }
 
 /**
- * Guarda un nuevo usuario.
+ * Agrega un nuevo mensaje de log.
  *
- * @return bool false si hay error o ya existe.
+ * @return bool false si hay error.
  */
 function file_log_add($user, $msg)
 {