Front.php

Go to the documentation of this file.

<?php
 
namespace Rsi\Fred;
 
/**
 *  Front controller component.
 */
class Front extends Component{
 
  const EVENT_RENDER = 'front:render';
 
  public $defaultType = 'html';
  public $controllerNamespaces = []; //!< Namespace prefix (key) per controller name prefix (value).
  public $validControllerName = null; //!< Regex for valid controller names (empty = do not check).
 
  public $defaultControllerName = 'Home';
  public $unknownControllerName = 'Unknown';
  public $deniedControllerName = 'Denied';
 
  /**
   * Name for a controller by class name.
   * @param string $class_name  Class name for the controller.
   * @return string  Controller name.
   */
  public function controllerName($class_name){
    foreach($this->controllerNamespaces as $namespace => $prefix)
      if(($class_name == $namespace) || \Rsi\Str::startsWith($class_name,$namespace))
        return $prefix . str_replace('\\','/',substr($class_name,strlen($namespace)));
    return null;
  }
  /**
   * Class name for a controller.
   * @param string $name  Controller name.
   * @return string  Class name for the controller.
   */
  public function controllerClassName($name){
    foreach($this->controllerNamespaces as $namespace => $prefix) if(
      (!$prefix || ($name == $prefix) || \Rsi\Str::startsWith($name,$prefix . '/')) &&
      class_exists($class_name = $namespace . str_replace('/','\\',$prefix ? substr($name,strlen($prefix)) : '\\' . $name)) &&
      is_subclass_of($class_name,__NAMESPACE__ . '\\Controller')
    ) return $class_name;
    return null;
  }
  /**
   * Construct a controller.
   * @param string $name  Controller name.
   * @param string $class_name  Class name for the controller (derived from $name when empty).
   * @return \\Rsi\\Fred\\Controller
   */
  public function controllerFactory($name,$class_name = null){
    if(!$class_name) $class_name = $this->controllerClassName($name);
    return new $class_name($this->_fred,array_replace_recursive(
      $this->_fred->config('controller',[]),
      $this->_fred->config(array_merge(['controllers'],array_map('lcfirst',explode('/',$name))),[])
    ));
  }
  /**
   * Check if user is authorized for a controller.
   * @param string $name  Controller name.
   * @return bool  True if the user is authorized for the controller.
   */
  public function controllerAuthorized($name){
    $user = $this->component('user');
    $controller = $this->controllerFactory($name);
    return $user->authenticated($controller->authSets) && $user->authorized($controller->actionRight());
  }
  /**
   * Get controller by name.
   * @param string $name  Controller name.
   * @param bool $redir  Redirect to the denied or login controller if the user is not authorized to execute the requested
   *   controller action. Otherwise return false.
   * @return \\Rsi\\Fred\\Controller|bool
   */
  public function controller($name,$redir = true){
    extract($this->components('log','user'));
    $log->debug(__CLASS__ . "::controller('$name')",__FILE__,__LINE__);
    if($this->validControllerName && !preg_match($this->validControllerName,$name)) $name = $this->unknownControllerName;
    if(
      (!$name || !($class_name = $this->controllerClassName($name))) &&
      !($class_name = $this->controllerClassName($name = $name ? $this->unknownControllerName : $this->defaultControllerName))
    ) throw new \DomainException("Controller for '$name' does not exists");
    $controller = $this->controllerFactory($name,$class_name);
    if(!$user->authenticated($controller->authSets) || !$user->authorized($controller->right))
      $controller = $redir ? $this->controller($user->authenticationControllerName ?: $this->deniedControllerName) : false;
    return $controller;
  }
  /**
   * Execute the request and render the view.
   * An optionally provided action will be executed, which will also complement the request component. Afterwards the view is
   * rendered.
   */
  public function execute(){
    extract($this->components('alive','event','log','message','request','router'));
    $timer = $log->start(Log::DEBUG,__CLASS__ . '::execute: router',__FILE__,__LINE__);
    $controller = $this->controller($router->controllerName);
    $request->viewControllerName = $name = $controller->name;
    $log->stop($timer,null,null,__FILE__,__LINE__);
    $alive->journal($name . '::' . $controller->action);
    $timer = $log->start(Log::DEBUG,__CLASS__ . '::execute: $controller->execute()',__FILE__,__LINE__, ['controller' => $name]);
    $controller->execute();
    $log->stop($timer,null,null,__FILE__,__LINE__);
    if($request->viewControllerName != $name) $controller = $this->controller($name = $request->viewControllerName);
    else $controller->reset();
    foreach($request->errors as $id => $error) $message->error($error,false);
    $timer = $log->start(Log::DEBUG,__CLASS__ . '::execute: $controller->view->render()',__FILE__,__LINE__, ['controller' => $name]);
    $event->trigger(self::EVENT_RENDER,$this,$controller);
    $controller->view->render();
    $log->stop($timer,null,null,__FILE__,__LINE__);
  }
 
}