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: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: <?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`:
* - Main application objects container (request, response, controller, etc.).
* - MvcCore compile mode managing (single file mode, php, phar, or no package).
* - Global store for all main core class names, to use them as modules,
* to be changed any time (request class, response class, debug class, etc.).
*/
trait GettersSetters {
/***********************************************************************************
* `\MvcCore\Application` - Getters *
***********************************************************************************/
/**
* @inheritDocs
* @return string
*/
public function GetCompiled () {
/** @var $this \MvcCore\Application */
if ($this->compiled === NULL) {
$compiled = static::NOT_COMPILED;
if (strpos(__FILE__, 'phar://') === 0) {
$compiled = static::COMPILED_PHAR;
} else if (class_exists('\Packager_Php_Wrapper')) {
$compiled = constant('\Packager_Php_Wrapper::FS_MODE');
}
$this->compiled = $compiled;
}
return $this->compiled;
}
/**
* @inheritDocs
* @return \MvcCore\Environment|string
*/
public function GetEnvironmentClass () {
/** @var $this \MvcCore\Application */
return $this->environmentClass;
}
/**
* @inheritDocs
* @return \MvcCore\Config|string
*/
public function GetConfigClass () {
/** @var $this \MvcCore\Application */
return $this->configClass;
}
/**
* @inheritDocs
* @return \MvcCore\Controller|string
*/
public function GetControllerClass () {
/** @var $this \MvcCore\Application */
return $this->controllerClass;
}
/**
* @inheritDocs
* @return \MvcCore\Debug|string
*/
public function GetDebugClass () {
/** @var $this \MvcCore\Application */
return $this->debugClass;
}
/**
* @inheritDocs
* @return \MvcCore\Request|string
*/
public function GetRequestClass () {
/** @var $this \MvcCore\Application */
return $this->requestClass;
}
/**
* @inheritDocs
* @return \MvcCore\Response|string
*/
public function GetResponseClass () {
/** @var $this \MvcCore\Application */
return $this->responseClass;
}
/**
* @inheritDocs
* @return \MvcCore\Route|string
*/
public function GetRouteClass () {
/** @var $this \MvcCore\Application */
return $this->routeClass;
}
/**
* @inheritDocs
* @return \MvcCore\Router|string
*/
public function GetRouterClass () {
/** @var $this \MvcCore\Application */
return $this->routerClass;
}
/**
* @inheritDocs
* @return \MvcCore\Session|string
*/
public function GetSessionClass () {
/** @var $this \MvcCore\Application */
return $this->sessionClass;
}
/**
* @inheritDocs
* @return \MvcCore\Tool|string
*/
public function GetToolClass () {
/** @var $this \MvcCore\Application */
return $this->toolClass;
}
/**
* @inheritDocs
* @return \MvcCore\View|string
*/
public function GetViewClass () {
/** @var $this \MvcCore\Application */
return $this->viewClass;
}
/**
* @inheritDocs
* @var \MvcCore\Environment
*/
public function GetEnvironment () {
/** @var $this \MvcCore\Application */
if ($this->environment === NULL) {
$environmentClass = $this->environmentClass;
$this->environment = $environmentClass::CreateInstance();
}
return $this->environment;
}
/**
* @inheritDocs
* @return \MvcCore\Controller
*/
public function GetController () {
/** @var $this \MvcCore\Application */
return $this->controller;
}
/**
* @inheritDocs
* @return \MvcCore\Request
*/
public function GetRequest () {
/** @var $this \MvcCore\Application */
if ($this->request === NULL) {
$requestClass = $this->requestClass;
$this->request = $requestClass::CreateInstance();
}
return $this->request;
}
/**
* @inheritDocs
* @return \MvcCore\Response
*/
public function GetResponse () {
/** @var $this \MvcCore\Application */
if ($this->response === NULL) {
$responseClass = $this->responseClass;
$this->response = $responseClass::CreateInstance();
}
return $this->response;
}
/**
* @inheritDocs
* @return \MvcCore\Router
*/
public function GetRouter () {
/** @var $this \MvcCore\Application */
if ($this->router === NULL) {
$routerClass = $this->routerClass;
$this->router = $routerClass::GetInstance();
}
return $this->router;
}
/**
* @inheritDocs
* @return string
*/
public function GetAppDir () {
/** @var $this \MvcCore\Application */
return $this->appDir;
}
/**
* @inheritDocs
* @return string
*/
public function GetControllersDir () {
/** @var $this \MvcCore\Application */
return $this->controllersDir;
}
/**
* @inheritDocs
* @return string
*/
public function GetViewsDir () {
/** @var $this \MvcCore\Application */
return $this->viewsDir;
}
/**
* @inheritDocs
* @return string[]
*/
public function GetDefaultControllerAndActionNames () {
/** @var $this \MvcCore\Application */
return [$this->defaultControllerName, $this->defaultControllerDefaultActionName];
}
/***********************************************************************************
* `\MvcCore\Application` - Setters *
***********************************************************************************/
/**
* @inheritDocs
* @param string $compiled
* @return \MvcCore\Application
*/
public function SetCompiled ($compiled = '') {
/** @var $this \MvcCore\Application */
$this->compiled = $compiled;
return $this;
}
/**
* @inheritDocs
* @param string $environmentClass
* @return \MvcCore\Application
*/
public function SetEnvironmentClass ($environmentClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($environmentClass, 'environmentClass', 'MvcCore\IEnvironment');
}
/**
* @inheritDocs
* @param string $configClass
* @return \MvcCore\Application
*/
public function SetConfigClass ($configClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($configClass, 'configClass', 'MvcCore\IConfig');
}
/**
* @inheritDocs
* @param string $controllerClass
* @return \MvcCore\Application
*/
public function SetControllerClass ($controllerClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($controllerClass, 'controllerClass', 'MvcCore\IController');
}
/**
* @inheritDocs
* @param string $debugClass
* @return \MvcCore\Application
*/
public function SetDebugClass ($debugClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($debugClass, 'debugClass', 'MvcCore\IDebug');
}
/**
* @inheritDocs
* @param string $requestClass
* @return \MvcCore\Application
*/
public function SetRequestClass ($requestClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($requestClass, 'requestClass', 'MvcCore\IRequest');
}
/**
* @inheritDocs
* @param string $responseClass
* @return \MvcCore\Application
*/
public function SetResponseClass ($responseClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($responseClass, 'responseClass', 'MvcCore\IResponse');
}
/**
* @inheritDocs
* @param string $routeClass
* @return \MvcCore\Application
*/
public function SetRouteClass ($routeClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($routeClass, 'routeClass', 'MvcCore\IRoute');
}
/**
* @inheritDocs
* @param string $routerClass
* @return \MvcCore\Application
*/
public function SetRouterClass ($routerClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($routerClass, 'routerClass', 'MvcCore\IRouter');
}
/**
* @inheritDocs
* @param string $sessionClass
* @return \MvcCore\Application
*/
public function SetSessionClass ($sessionClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($sessionClass, 'sessionClass', 'MvcCore\ISession');
}
/**
* @inheritDocs
* @param string $toolClass
* @return \MvcCore\Application
*/
public function SetToolClass ($toolClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($toolClass, 'toolClass', 'MvcCore\ITool');
}
/**
* @inheritDocs
* @param string $viewClass
* @return \MvcCore\Application
*/
public function SetViewClass ($viewClass) {
/** @var $this \MvcCore\Application */
return $this->setCoreClass($viewClass, 'viewClass', 'MvcCore\IView');
}
/**
* @inheritDocs
* @param \MvcCore\Controller $controller
* @return \MvcCore\Application
*/
public function SetController (\MvcCore\IController $controller) {
/** @var $this \MvcCore\Application */
$this->controller = $controller;
return $this;
}
/**
* @inheritDocs
* @param string $appDir
* @return \MvcCore\Application
*/
public function SetAppDir ($appDir) {
/** @var $this \MvcCore\Application */
$this->appDir = $appDir;
return $this;
}
/**
* @inheritDocs
* @param string $controllersDir
* @return \MvcCore\Application
*/
public function SetControllersDir ($controllersDir) {
/** @var $this \MvcCore\Application */
$this->controllersDir = $controllersDir;
return $this;
}
/**
* @inheritDocs
* @param string $viewsDir
* @return \MvcCore\Application
*/
public function SetViewsDir ($viewsDir) {
/** @var $this \MvcCore\Application */
$this->viewsDir = $viewsDir;
return $this;
}
/**
* @inheritDocs
* @param string $defaultControllerName
* @return \MvcCore\Application
*/
public function SetDefaultControllerName ($defaultControllerName) {
/** @var $this \MvcCore\Application */
$this->defaultControllerName = $defaultControllerName;
return $this;
}
/**
* @inheritDocs
* @param string $defaultActionName
* @return \MvcCore\Application
*/
public function SetDefaultControllerDefaultActionName ($defaultActionName) {
/** @var $this \MvcCore\Application */
$this->defaultControllerDefaultActionName = $defaultActionName;
return $this;
}
/**
* @inheritDocs
* @param string $defaultControllerErrorActionName
* @return \MvcCore\Application
*/
public function SetDefaultControllerErrorActionName ($defaultControllerErrorActionName) {
/** @var $this \MvcCore\Application */
$this->defaultControllerErrorActionName = $defaultControllerErrorActionName;
return $this;
}
/**
* @inheritDocs
* @param string $defaultControllerNotFoundActionName
* @return \MvcCore\Application
*/
public function SetDefaultControllerNotFoundActionName ($defaultControllerNotFoundActionName) {
/** @var $this \MvcCore\Application */
$this->defaultControllerNotFoundActionName = $defaultControllerNotFoundActionName;
return $this;
}
/**
* @inheritDocs`
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPreRouteHandler (callable $handler, $priorityIndex = NULL) {
/** @var $this \MvcCore\Application */
if (!is_callable($handler))
throw new \InvalidArgumentException(
"[".get_class()."] Pre route handler is not callable (handler: {$handler}, priorityIndex: {$priorityIndex})."
);
return $this->setHandler($this->preRouteHandlers, $handler, $priorityIndex);
}
/**
* @inheritDocs
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPostRouteHandler (callable $handler, $priorityIndex = NULL) {
/** @var $this \MvcCore\Application */
if (!is_callable($handler))
throw new \InvalidArgumentException(
"[".get_class()."] Post route handler is not callable (handler: {$handler}, priorityIndex: {$priorityIndex})."
);
return $this->setHandler($this->postRouteHandlers, $handler, $priorityIndex);
}
/**
* @inheritDocs
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPreDispatchHandler (callable $handler, $priorityIndex = NULL) {
/** @var $this \MvcCore\Application */
if (!is_callable($handler))
throw new \InvalidArgumentException(
"[".get_class()."] Pre dispatch handler is not callable (handler: {$handler}, priorityIndex: {$priorityIndex})."
);
return $this->setHandler($this->preDispatchHandlers, $handler, $priorityIndex);
}
/**
* @inheritDocs
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPostDispatchHandler (callable $handler, $priorityIndex = NULL) {
/** @var $this \MvcCore\Application */
if (!is_callable($handler))
throw new \InvalidArgumentException(
"[".get_class()."] Post dispatch handler is not callable (handler: {$handler}, priorityIndex: {$priorityIndex})."
);
return $this->setHandler($this->postDispatchHandlers, $handler, $priorityIndex);
}
/**
* @inheritDocs
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPostTerminateHandler (callable $handler, $priorityIndex = NULL) {
/** @var $this \MvcCore\Application */
if (!is_callable($handler))
throw new \InvalidArgumentException(
"[".get_class()."] Post terminate handler is not callable (handler: {$handler}, priorityIndex: {$priorityIndex})."
);
return $this->setHandler($this->postTerminateHandlers, $handler, $priorityIndex);
}
}