classes/pllogger.php

   1 <?php
   2 /*
   3  * Copyright (C) 2003-2011 Polytechnique.org
   4  * http://opensource.polytechnique.org/
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 abstract class PlLogger
  22 {
  23     /** The constructor, creates a new entry in the sessions table
  24      *
  25      * @param $uid the id of the logged user
  26      * @param $suid the id of the administrator who has just su'd to the user
  27      * @return VOID
  28      */
  29     abstract public function __construct($uid, $suid = 0);
  30
  31     /** Logs an action and its related data.
  32      *
  33      * @param $action le type d'action
  34      * @param $data les données (id de liste, etc.)
  35      * @return VOID
  36      */
  37     abstract public function log($action, $data = null);
  38
  39     /** Check validity of the logger.
  40      *
  41      * @param $uid the uid of the current session.
  42      * @return TRUE if the logger can still be used.
  43      */
  44     abstract public function isValid($uid);
  45
  46     /** Return a dummy logger.
  47      */
  48     public static function dummy($uid, $suid = 0) {
  49         return new DummyLogger($uid, $suid);
  50     }
  51 }
  52
  53 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
  54 ?>