atelierspierrot/mvc-fundamental

<?php
/**
 * This file is part of the MVC-Fundamental package.
 *
 * Copyright (c) 2013-2016 Pierre Cassat <me@e-piwi.fr> and contributors
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * The source code of this package is available online at
 * <http://github.com/atelierspierrot/mvc-fundamental>.
 */

namespace MVCFundamental\Interfaces;

use \Patterns\Interfaces\SingletonInterface;
use \Patterns\Interfaces\OptionableInterface;

/**
 * Interface FrontControllerInterface
 */
interface FrontControllerInterface
    extends SingletonInterface, OptionableInterface, ServiceContainerProviderInterface
{

    /**
     * @param   string $mode
     * @return  bool
     */
    public function isMode($mode);

    /**
     * This must boot the system, handle the request, send resulting response and terminate the system
     *
     * @param   \MVCFundamental\Interfaces\RequestInterface $request
     * @return  void
     */
    public function run(RequestInterface $request = null);

    /**
     * @param   \MVCFundamental\Interfaces\RequestInterface $request
     * @return  \MVCFundamental\Interfaces\ResponseInterface
     */
    public function handle(RequestInterface $request = null);

    /**
     * @param   \MVCFundamental\Interfaces\ResponseInterface $response
     * @return  mixed
     */
    public function send(ResponseInterface $response = null);

    /**
     * @param   string $url
     * @param   bool $follow
     * @return  void
     */
    public function redirect($url, $follow = false);

    /**
     * @param   string  $message
     * @param   int     $status
     * @param   int     $code
     * @param   string  $filename
     * @param   int     $lineno
     * @return  void
     */
    public function error($message, $status = 500, $code = 0, $filename = __FILE__, $lineno = __LINE__);

    /**
     * @param   string  $view_file
     * @param   array   $params
     * @return  string
     */
    public function render($view_file, array $params = array());

    /**
     * @param   string      $route
     * @param   callable    $callback
     * @param   string      $method
     * @return  void
     */
    public function addRoute($route, $callback, $method = 'get');

    /**
     * @param   string  $route
     * @param   array   $arguments
     * @param   string  $method
     * @return  string
     */
    public function callRoute($route, array $arguments = array(), $method = 'get');

    /**
     * @param   null|string $controller
     * @param   null|string $action
     * @param   array       $arguments
     * @return  string
     */
    public function callControllerAction($controller = null, $action = null, array $arguments = array());

    /**
     * Registers a new event listener
     *
     * @param   string      $event      The event name
     * @param   callable    $callback   The event callback
     * @return  void
     */
    public function on($event, $callback);

    /**
     * Unregisters a new event listener
     *
     * @param   string      $event      The event name
     * @param   callable    $callback   The event callback
     * @return  void
     */
    public function off($event, $callback);

    /**
     * Tiggers an event
     *
     * @param   string  $event
     * @param   mixed $subject The subject of the event
     * @return  void
     */
    public function trigger($event, $subject = null);
}