1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license  https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Application;

/**
 * Trait as partial class for `\MvcCore\Application`:
 * - Helper methods for normal requests and error requests dispatching.
 * - Helper methods for core classes configuration.
 */
trait Helpers {

    /***********************************************************************************
     *                   `\MvcCore\Application` - Helper Methods                     *
     ***********************************************************************************/

    /**
     * @inheritDocs
     * @param string $actionName
     * @return string
     */
    public function GetDefaultControllerIfHasAction ($actionName) {
        $defaultControllerName = $this->CompleteControllerName($this->defaultControllerName);
        if (
            class_exists($defaultControllerName) && 
            method_exists($defaultControllerName, $actionName . 'Action')
        ) {
            return $defaultControllerName;
        }
        return '';
    }

    /**
     * @inheritDocs
     * @param string $controllerNamePascalCase
     * @return string
     */
    public function CompleteControllerName ($controllerNamePascalCase) {
        if (substr($controllerNamePascalCase, 0, 2) == '//') 
            return '\\' . ltrim($controllerNamePascalCase, '/');
        return '\\' . implode('\\', [
            $this->appDir,
            $this->controllersDir,
            ltrim($controllerNamePascalCase, '\\')
        ]);
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsErrorDispatched () {
        $toolClass = $this->toolClass;
        $defaultCtrlName = $toolClass::GetDashedFromPascalCase($this->defaultControllerName);
        $errorActionName = $toolClass::GetDashedFromPascalCase($this->defaultControllerErrorActionName);
        return $this->request->GetControllerName() == $defaultCtrlName &&
            $this->request->GetActionName() == $errorActionName;
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsNotFoundDispatched () {
        $toolClass = $this->toolClass;
        $defaultCtrlName = $toolClass::GetDashedFromPascalCase($this->defaultControllerName);
        $errorActionName = $toolClass::GetDashedFromPascalCase($this->defaultControllerNotFoundActionName);
        return $this->request->GetControllerName() == $defaultCtrlName &&
            $this->request->GetActionName() == $errorActionName;
    }

    /**
     * Set core class name only if given class string implements
     * given core interface, else thrown an exception.
     * @param string $newCoreClassName
     * @param string $coreClassVar
     * @param string $coreClassInterface
     * @throws \Exception
     * @return \MvcCore\Application
     */
    protected function setCoreClass ($newCoreClassName, $coreClassVar, $coreClassInterface) {
        if (call_user_func(
            [$this->toolClass, 'CheckClassInterface'], 
            $newCoreClassName, $coreClassInterface, TRUE, TRUE // check static methods and throw an exception if false
        )) $this->$coreClassVar = $newCoreClassName;
        /** @var $this \MvcCore\Application */
        return $this;
    }

    /**
     * Set pre-route, pre-dispatch or post-dispatch handler under specific priority index.
     * @param array $handlers Application handlers collection reference.
     * @param callable $handler
     * @param int|NULL $priorityIndex
     * @return \MvcCore\Application
     */
    protected function setHandler (array & $handlers, callable $handler, $priorityIndex = NULL) {
        // there is possible to call any `callable` as closure function in variable
        // except forms like `'ClassName::methodName'` and `['childClassName', 'parent::methodName']`
        // and `[$childInstance, 'parent::methodName']`.
        $closureCalling = (
            (is_string($handler) && strpos($handler, '::') !== FALSE) ||
            (is_array($handler) && strpos($handler[1], '::') !== FALSE)
        ) ? FALSE : TRUE;
        if ($priorityIndex === NULL) {
            $handlers[] = [$closureCalling, $handler];
        } else {
            if (isset($handlers[$priorityIndex])) {
                array_splice($handlers, $priorityIndex, 0, [$closureCalling, $handler]);
            } else {
                $handlers[$priorityIndex] = [$closureCalling, $handler];
            }
        }
        /** @var $this \MvcCore\Application */
        return $this;
    }
}