<?php
// Hoplite
// Copyright (c) 2015 Blue Static
//
// 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 3 of the License, or 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, see <http://www.gnu.org/licenses/>.

namespace hoplite\http;

/*!
  An Interceptor runs as part of FrontController::RouteRequest() to provide
  extra processing before the Action is Invoke()ed. The Action is provided to
  allow the Interceptor to change the control flow based on characteristics
  of the Action processor. An Interceptor may interrupt the control flow by
  calling SendResponse() on the controller.
*/
interface Interceptor
{
  /*!
    Performs the action and fills out the response's data model.
  */
  public function DoIntercept(FrontController $controller,
                              Action $action = NULL,
                              Request $request,
                              Response $response);
}