Adição de DocBlocks

base/core/config.class.php

@@ -7,47 +7,56 @@
 class Config {
 
    /**
-    * @var \Core\Config - Instância do objeto Config
+    * Instância do objeto Config
+    * @var Config
     */
    private static $instance;
 
    /**
-    * @var array - Configurações padrão
+    * Configurações padrão
+    * @var array
     */
    protected $defaults = [];
 
    /**
-    * @var array - Configurações setadas
+    * Configurações setadas
+    * @var array
     */
    protected $settings = [];
 
    /**
-    * @var string - Idioma
+    * Idioma
+    * @var string
     */
    protected $lang;
 
    /**
-    * @var string - Diretório da aplicação
+    * Diretório da aplicação
+    * @var string
     */
    protected $dir;
 
    /**
-    * @var string - Nome da aplicação
+    * Nome da aplicação
+    * @var string
     */
    protected $name;
 
    /**
-    * @var string - Diretório das Views
+    * Diretório das Views
+    * @var string
     */
    protected $views;
 
    /**
-    * @var string - Diretório dos Models
+    * Diretório dos Models
+    * @var string
     */
    protected $models;
 
    /**
-    * @var string - Diretório dos Controllers
+    * Diretório dos Controllers
+    * @var string
     */
    protected $controllers;
 
@@ -64,12 +73,14 @@ class Config {
    protected $email;
 
    /**
-    * @var array - Configurações de Autenticação
+    * Configurações de Autenticação
+    * @var array
     */
    protected $authentication;
 
    /**
-    * @var array - Configurações de Banco de Dados
+    * Configurações de Banco de Dados
+    * @var array
     */
    protected $database;
 
@@ -79,14 +90,16 @@ class Config {
    protected $appconfigs;
 
    /**
-    * @var book - Usar sistema de rotas 
-    * 
+    * Usar sistema de rotas
+    * @var bool
+    *
     * @default TRUE
     */
-   protected $useroutes;
+   protected $useroutes = TRUE;
 
    /**
-    * @var bool - Não parsear URL caso não encontre a rota (url/controller/action)
+    * Não parsear URL caso não encontre a rota (url/controller/action)
+    * @var bool
     */
    protected $onlyroutes;
 
@@ -95,10 +108,8 @@ class Config {
     * Nome do diretório do aplicativo (caso esteja no diretório padrão /apps/<nome>/) 
     * ou caminho completo do diretório
     * 
-    * @param string $dir 
-    * 
-    * @return Config
-    * 
+    * Config constructor.
+    * @param array $defaults
     */
    function __construct($defaults = []) {
 
@@ -113,9 +124,9 @@ function __construct($defaults = []) {
    }
 
    /**
-    * Seta as
-    * @param type $app 
-    * @return type
+    * @param $app string
+    * @return Config
+    * @throws Exception\InvalidApplicationException
     */
    public static function SetApplication($app) {
 
@@ -141,8 +152,7 @@ public static function SetApplication($app) {
 
    /**
     * Seta as configurações
-    * @param array $configs Configurações
-    * @return void
+    * @param array $configs
     */
    public function Configure(array $configs) {
       //var_dump($configs);
@@ -154,13 +164,23 @@ public function Configure(array $configs) {
       }
    }
 
+   /**
+    * Seta configurações
+    * @param array $settings
+    */
    public static function Set(array $settings = []) {
       if (empty($settings))
          $settings = self::$instance->defaults;
       self::$instance->settings = array_merge_recursive(self::$instance->settings, $settings);
       self::$instance->Configure($settings);
+
    }
 
+   /**
+    * Retornar diretório da aplicação
+    * @param string $app
+    * @return string
+    */
    private static function getAppDir($app = NULL) {
 
       if (is_null($app) && !empty(self::$instance))
@@ -187,8 +207,8 @@ private static function getAppDir($app = NULL) {
 
    /**
     * Seta propriedades padrões
-    * @param array $defaults - Array de propriedades
-    * @return array - Propriedades padrões
+    * @param array $defaults
+    * @return array
     */
    private function defaults(array $defaults = []) {
       return $this->defaults = array_merge_recursive([
@@ -205,10 +225,10 @@ private function defaults(array $defaults = []) {
 
    /**
     * Seta configurações da aplicação
-    * @param string $prop - Nome da propriedade
-    * @param mixin|null $value - Se o valor for NULL retorna o valor da propriedade setada.
-    * @param bool $setnull - Se o valor for TRUE, vai setar o valor mesmo que seja NULL
-    * @return mixin
+    * @param $prop
+    * @param mixed $value
+    * @param bool $setnull
+    * @return mixed
     */
    public function appconfigs($prop, $value = NULL, $setnull = FALSE) {
       if (!is_array($this->appconfigs))

base/core/controller.class.php

@@ -6,23 +6,65 @@
 * Controller
 */
 class Controller {
+
+   /**
+    * Identifica se é pra imprimir o retorno ou não.
+    * @var bool
+    */
    public $outputreturn = TRUE;
+
+   /**
+    * Output a ser impresso
+    * @var string
+    */
    public $output = '';
 
+   /**
+    * @var Router
+    */
    public $router;
+
+   /**
+    * @var Router
+    */
    public $route;
+
+   /**
+    * @var Request
+    */
    public $request;
+
+   /**
+    * @var array
+    */
    public $cache = [];
+
+   /**
+    * @var Load
+    */
    protected $load;
+
+   /**
+    * @var Model
+    */
    protected $model;
+
+   /**
+    * @var Config
+    */
    protected $config;
 
+   /**
+    * @var Connection
+    */
    public static $connection = NULL;
 
+   /**
+    * Controller constructor.
+    * @param Request|NULL $request
+    */
    function __construct(Request $request = NULL) {
 
-      //$this->request = New Request();
-
       $this->request = is_null($request) ? Request::getInstance() : $request;
       $this->config  = Config::getInstance();
 
@@ -32,13 +74,17 @@ function __construct(Request $request = NULL) {
 
       $this->startConnection();
 
-      $controller = get_class($this);
-
       $this->checkPermission();
 
       Model::$controller = $this;
    }
 
+   /**
+    * Executa o controlador. Em breve será papel do Dispatch
+    * @param mixed $param
+    * @return string
+    * @throws Exception
+    */
    public function execute($param = NULL){
 
       if (!is_callable([$this, $this->request->action]))
@@ -49,6 +95,14 @@ public function execute($param = NULL){
       return call_user_func_array([$this, $this->request->action], (array) $param);
    }
 
+   /**
+    * Executa um determinado controller
+    * @param string $controller Nome do Controller
+    * @param string $action Método do Controller
+    * @param array $args Argumentos para o Controller
+    * @return mixed
+    * @throws Exception
+    */
    public function controller($controller, $action = 'index', $args = NULL) {
 
       $class = "\\Controller\\{$controller}Controller";