<?php
/*
 * Gallery - a web based photo album viewer and editor
 * Copyright (C) 2000-2008 Bharat Mediratta
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
 */

/**
 * Interface for authentication plugins.
 * Authentication must be fast since it takes place at the beginning of every request.
 * Multiple plugins may be registered at the same time.  They are instantiated one by one, as
 * needed.  The first plugin to successfully return a user object wins.
 *
 * @package GalleryCore
 * @subpackage Classes
 * @author Bharat Mediratta <bharat@menalto.com>
 * @version $Revision: 17580 $
 * @abstract
 */
class GalleryAuthPlugin {

    /**
     * Perform authentication & return a user object
     *
     * @return array GalleryStatus a status code
     *               GalleryUser the active user or null
     */
    function getUser() {
	return array(GalleryCoreApi::error(ERROR_UNIMPLEMENTED), null);
    }
}
?>