AuthorizationHandler.php

<?php
/*
 * This file has its roots as part of the Mojavi package which was
 * Copyright (c) 2003 Sean Kerr. It has been incorporated into this
 * derivative work under the terms of the LGPL V2.1.
 * (http://www.gnu.org/licenses/lgpl-2.1.html)
 */

namespace Xmf\Xadr;

/**
 * An AuthorizationHandler determines the method for authorizing a user's
 * action requests.
 *
 * @category  Xmf\Xadr\AuthorizationHandler
 * @package   Xmf
 * @author    Richard Griffith <richard@geekwright.com>
 * @author    Sean Kerr <skerr@mojavi.org>
 * @copyright 2013-2015 XOOPS Project (http://xoops.org)
 * @copyright 2003 Sean Kerr
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @link      http://xoops.org
 */
abstract class AuthorizationHandler extends ContextAware
{

    /**
     * Determine the user authorization status for an action request.
     *
     *  _This should never be called manually._
     *
     * @param Action $action An Action instance.
     *
     * @return bool true if authorized, false otherwise
     */
    abstract public function execute(Action $action);
}