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: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 708: 709: <?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;
/**
* Responsibility - singleton, instancing all core classes and handling request.
* - Global store and managing singleton application instance.
* - 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.).
* - Dispatching application http request/response (`\MvcCore\Application::Dispatch();`):
* - Completing request and response.
* - Calling pre/post handlers.
* - Controller/action dispatching.
* - Error handling and error responses.
*/
interface IApplication extends \MvcCore\Application\IConstants {
/***********************************************************************************
* `\MvcCore\Application` - Static Calls *
***********************************************************************************/
/**
* Returns singleton `\MvcCore\Application` instance as reference.
* @return \MvcCore\Application
*/
public static function GetInstance ();
/***********************************************************************************
* `\MvcCore\Application` - Getters *
***********************************************************************************/
/**
* Get if application is running as standard php project or as single file application.
* It should has values from:
* - `\MvcCore\IApplication::COMPILED_PHP`
* - `\MvcCore\IApplication::COMPILED_PHAR`
* - `\MvcCore\IApplication::COMPILED_SFU`
* - `\MvcCore\IApplication::NOT_COMPILED`
* Read more about every mode in interface: `\MvcCore\IApplication`.
* @var string
*/
public function GetCompiled ();
/**
* Get application environment class implementing `\MvcCore\IEnvironment`.
* Class to detect and manage environment name.
* @return \MvcCore\Environment|string
*/
public function GetEnvironmentClass ();
/**
* Get application config class implementing `\MvcCore\IConfig`.
* Class to load and parse (system) config(s).
* @return \MvcCore\Config|string
*/
public function GetConfigClass ();
/**
* Get application config class implementing `\MvcCore\IController`.
* Class to create default controller for request targeting views only
* and to handle small assets inside packed application.
* @return \MvcCore\Controller|string
*/
public function GetControllerClass ();
/**
* Get application debug class implementing `\MvcCore\IDebug`.
* Class to handle any application error to render the error in browser or log in HDD.
* @return \MvcCore\Debug|string
*/
public function GetDebugClass ();
/**
* Get application request class implementing `\MvcCore\IRequest`.
* Class to create describing HTTP request object.
* @return \MvcCore\Request|string
*/
public function GetRequestClass ();
/**
* Get application response class implementing `\MvcCore\IResponse`.
* Class to create HTTP response object to store response headers and response content.
* @return \MvcCore\Response|string
*/
public function GetResponseClass ();
/**
* Get application route class implementing `\MvcCore\IRoute`.
* Class to describe single route with match and replace pattern,
* controller, action, params default values and params constraints.
* @return \MvcCore\Route|string
*/
public function GetRouteClass ();
/**
* Get application router class implementing `\MvcCore\IRouter`.
* Class to store all routes, dispatch request by routes and generate URL addresses by routes.
* @return \MvcCore\Router|string
*/
public function GetRouterClass ();
/**
* Get application session class implementing `\MvcCore\ISession`.
* Class to configure session namespaces, session opening, writing and expirations.
* @return \MvcCore\Session|string
*/
public function GetSessionClass ();
/**
* Get application tool class implementing `\MvcCore\ITool`.
* Class to handle helper calls from MvcCore core modules.
* @return \MvcCore\Tool|string
*/
public function GetToolClass ();
/**
* Get application view class implementing `\MvcCore\IView`.
* Class to prepare and render controller view, sub-views and wrapper layout.
* @return \MvcCore\View|string
*/
public function GetViewClass ();
/**
* Returns environment detection instance.
* @var \MvcCore\Environment
*/
public function GetEnvironment ();
/**
* Returns currently dispatched controller instance.
* @return \MvcCore\Controller
*/
public function GetController ();
/**
* Returns currently used request instance.
* @return \MvcCore\Request
*/
public function GetRequest ();
/**
* Returns currently used response instance.
* @return \MvcCore\Response
*/
public function GetResponse ();
/**
* Returns currently used router instance.
* @return \MvcCore\Router
*/
public function GetRouter ();
/**
* Get application scripts and views directory name as `"App"` by default,
* where are following subdirectories by default:
* - `/App/Controllers`
* - `/App/Models`
* - `/App/Views`
* It should by reconfigured to custom value in the very application beginning.
* @return string
*/
public function GetAppDir ();
/**
* Get controllers directory name as `"Controllers"` by default, for all controller classes,
* it's placed directly in application directory by default.
* It should by reconfigured to custom value in the very application beginning.
* @return string
*/
public function GetControllersDir ();
/**
* Get views directory name as `"views"` by default, for all view elements,
* it's placed directly in application directory above by default.
* It should by reconfigured to custom value in the very application beginning.
* @return string
*/
public function GetViewsDir ();
/**
* Returns array with:
* - `0 => "index"` - Default controller name, from protected `\MvcCore\Application::$defaultControllerName`.
* - `1 => "index"` - Default action name, from protected `\MvcCore\Application::$defaultControllerDefaultActionName`.
* @return string[]
*/
public function GetDefaultControllerAndActionNames ();
/***********************************************************************************
* `\MvcCore\Application` - Setters *
***********************************************************************************/
/**
* Set if application is running as standard php project or as single file application.
* First param `$compiled` should has values from:
* - `\MvcCore\IApplication::COMPILED_PHP`
* - `\MvcCore\IApplication::COMPILED_PHAR`
* - `\MvcCore\IApplication::COMPILED_SFU`
* - `\MvcCore\IApplication::NOT_COMPILED`
* Read more about every mode in interface: `\MvcCore\IApplication`.
* Core configuration method.
* @param string $compiled
* @return \MvcCore\Application
*/
public function SetCompiled ($compiled = '');
/**
* Set application environment class implementing `\MvcCore\IEnvironment`.
* Class to detect and manage environment name.
* Core configuration method.
* @param string $environmentClass
* @return \MvcCore\Application
*/
public function SetEnvironmentClass ($environmentClass);
/**
* Set application config class implementing `\MvcCore\IConfig`.
* Class to load and parse (system) config(s).
* Core configuration method.
* @param string $configClass
* @return \MvcCore\Application
*/
public function SetConfigClass ($configClass);
/**
* Set application controller class implementing `\MvcCore\IController`.
* Class to create default controller for request targeting views only
* and to handle small assets inside packed application.
* Core configuration method.
* @param string $controllerClass
* @return \MvcCore\Application
*/
public function SetControllerClass ($controllerClass);
/**
* Set application debug class implementing `\MvcCore\IDebug`.
* Class to handle any application error to render the error in browser or log in HDD.
* Core configuration method.
* @param string $debugClass
* @return \MvcCore\Application
*/
public function SetDebugClass ($debugClass);
/**
* Set application request class implementing `\MvcCore\IRequest`.
* Class to create describing HTTP request object.
* Core configuration method.
* @param string $requestClass
* @return \MvcCore\Application
*/
public function SetRequestClass ($requestClass);
/**
* Set application response class implementing `\MvcCore\IResponse`.
* Class to create HTTP response object to store response headers and response content.
* Core configuration method.
* @param string $responseClass
* @return \MvcCore\Application
*/
public function SetResponseClass ($responseClass);
/**
* Set application route class implementing `\MvcCore\IRoute`.
* Class to describe single route with match and replace pattern,
* controller, action, params default values and params constraints.
* Core configuration method.
* @param string $routerClass
* @return \MvcCore\Application
*/
public function SetRouteClass ($routerClass);
/**
* Set application router class implementing `\MvcCore\IRouter`.
* Class to store all routes, dispatch request by routes and generate URL addresses by routes.
* Core configuration method.
* @param string $routerClass
* @return \MvcCore\Application
*/
public function SetRouterClass ($routerClass);
/**
* Set application session class implementing `\MvcCore\ISession`.
* Class to configure session namespaces, session opening, writing and expirations.
* Core configuration method.
* @param string $sessionClass
* @return \MvcCore\Application
*/
public function SetSessionClass ($sessionClass);
/**
* Set application tool class implementing `\MvcCore\ITool`.
* Class to handle helper calls from MvcCore core modules.
* Core configuration method.
* @param string $toolClass
* @return \MvcCore\Application
*/
public function SetToolClass ($toolClass);
/**
* Set application view class implementing `\MvcCore\IView`.
* Class to prepare and render controller view, sub-views and wrapper layout.
* Core configuration method.
* @param string $viewClass
* @return \MvcCore\Application
*/
public function SetViewClass ($viewClass);
/**
* Set currently dispatched controller instance.
* @param \MvcCore\Controller $controller
* @return \MvcCore\Application
*/
public function SetController (\MvcCore\IController $controller);
/**
* Set application scripts and views directory name (`"App"` by default),
* where are following subdirectories by default:
* - `/App/Controllers`
* - `/App/Models`
* - `/App/Views`
* It should by reconfigured to custom value in the very application beginning.
* Core configuration method.
* @param string $appDir
* @return \MvcCore\Application
*/
public function SetAppDir ($appDir);
/**
* Set controllers directory name (`"Controllers"` by default), for all controller classes,
* it's placed directly in application directory by default.
* It should by reconfigured to custom value in the very application beginning.
* Core configuration method.
* @param string $controllersDir
* @return \MvcCore\Application
*/
public function SetControllersDir ($controllersDir);
/**
* Set views directory name (`"views"` by default), for all view elements,
* it's placed directly in application directory above by default.
* It should by reconfigured to custom value in the very application beginning.
* Core configuration method.
* @param string $viewsDir
* @return \MvcCore\Application
*/
public function SetViewsDir ($viewsDir);
/**
* Set default controller name. `"Index"` value by default.
* Core configuration method.
* @param string $defaultControllerName
* @return \MvcCore\Application
*/
public function SetDefaultControllerName ($defaultControllerName);
/**
* Set default controller default action name. `"Index"` value by default.
* Core configuration method.
* @param string $defaultActionName
* @return \MvcCore\Application
*/
public function SetDefaultControllerDefaultActionName ($defaultActionName);
/**
* Set default controller common error action name. `"Error"` value by default.
* Core configuration method.
* @param string $defaultControllerErrorActionName
* @return \MvcCore\Application
*/
public function SetDefaultControllerErrorActionName ($defaultControllerErrorActionName);
/**
* Set default controller not found error action name. `"NotFound"` value by default.
* Core configuration method.
* @param string $defaultControllerNotFoundActionName
* @return \MvcCore\Application
*/
public function SetDefaultControllerNotFoundActionName ($defaultControllerNotFoundActionName);
/**
* Add pre route handler into pre route handlers queue to process them after
* every request has been completed into `\MvcCore\Request` describing object and before
* every request will be routed by `\MvcCore\Router::Route();` call.
* Callable should be void and it's params should be two with following types:
* - `\MvcCore\Request`
* - `\MvcCore\Response`
* Example:
* `\MvcCore\Application::GetInstance()->AddPreRouteHandler(function(
* \MvcCore\Request $request,
* \MvcCore\Response $response
* ) {
* $request->customVar = 'custom_value';
* });`
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPreRouteHandler (callable $handler, $priorityIndex = NULL);
/**
* Add post route handler into post route handlers queue to process them after
* every request has been completed into `\MvcCore\Request` describing object, after
* every request has been routed by `\MvcCore\Router::Route();` call and before
* every request has created target controller instance.
* Callable should be void and it's params should be two with following types:
* - `\MvcCore\Request`
* - `\MvcCore\Response`
* Example:
* `\MvcCore\Application::GetInstance()->AddPostRouteHandler(function(
* \MvcCore\Request $request,
* \MvcCore\Response $response
* ) {
* $request->customVar = 'custom_value';
* });`
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPostRouteHandler (callable $handler, $priorityIndex = NULL);
/**
* Add pre dispatch handler into pre dispatch handlers queue to process them after
* every request has been routed by `\MvcCore\Router::Route();` call, after
* every request has been dispatched by `\MvcCore\Controller::Dispatch();` and
* after every request has created and prepared target controller instance to dispatch.
* Callable should be void and it's params should be two with following types:
* - `\MvcCore\Request`
* - `\MvcCore\Response`
* Example:
* `\MvcCore\Application::GetInstance()->AddPreDispatchHandler(function(
* \MvcCore\Request $request,
* \MvcCore\Response $response
* ) {
* $request->customVar = 'custom_value';
* });`
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPreDispatchHandler (callable $handler, $priorityIndex = NULL);
/**
* Add post dispatch handler into post dispatch handlers queue to process them
* before every request is terminated by `\MvcCore\Application::Terminate();`.
* Every request terminated sooner has executed this post dispatch handlers queue.
* Callable should be void and it's params should be two with following types:
* - `\MvcCore\Request`
* - `\MvcCore\Response`
* Example:
* `\MvcCore\Application::GetInstance()->AddPostDispatchHandler(function(
* \MvcCore\Request $request,
* \MvcCore\Response $response
* ) {
* $request->customVar = 'custom_value';
* });`
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPostDispatchHandler (callable $handler, $priorityIndex = NULL);
/**
* Add post terminate handler into post terminate handlers queue to process them
* after every request is terminated by `\MvcCore\Application::Terminate();`.
* Callable should be void and it's params should be two with following types:
* - `\MvcCore\Request`
* - `\MvcCore\Response`
* Example:
* `\MvcCore\Application::GetInstance()->AddPostTerminateHandler(function(
* \MvcCore\Request $request,
* \MvcCore\Response $response
* ) {
* // close connection by previously configured
* // header: header('Connection: close');
* // and run background process now:
* });`
* @param callable $handler
* @param int|NULL $priorityIndex
* @return \MvcCore\Application
*/
public function AddPostTerminateHandler (callable $handler, $priorityIndex = NULL);
/***********************************************************************************
* `\MvcCore\Application` - Normal Dispatching *
***********************************************************************************/
/**
* Dispatch http request/response.
* - 1. Complete and init:
* - Complete describing environment object `\MvcCore\Request`.
* - Complete describing request object `\MvcCore\Request`.
* - Complete response storage object `\MvcCore\Response`.
* - Init debugging and logging by `\MvcCore\Debug::Init();`.
* - 2. (Process pre-route handlers queue.)
* - 3. Route request by your router or with `\MvcCore\Router::Route()` by default.
* - 4. (Process post-route handlers queue.)
* - 5. Create and set up controller instance.
* - 6. (Process pre-dispatch handlers queue.)
* - 7. Dispatch controller life-cycle.
* - Call `\MvcCore\Controller::Init()` and `\MvcCore\Controller::PreDispatch()`.
* - Call routed action method.
* - Call `\MvcCore\Controller::Render()` to render all views.
* - 6. Terminate request:
* - (Process post-dispatch handlers queue.)
* - Write session in `register_shutdown_function()` handler.
* - Send response headers if possible and echo response body.
* @return \MvcCore\Application
*/
public function Dispatch ();
/**
* Starts a session, standardly called from `\MvcCore\Controller::Init();`.
* But is should be called anytime sooner, for example in any pre request handler
* to redesign request before MVC dispatching or anywhere else.
* @return void
*/
public function SessionStart ();
/**
* Route request by router obtained by default by calling:
* `\MvcCore\Router::GetInstance();`.
* Store requested route inside configured
* router class to get it later by calling:
* `\MvcCore\Router::GetCurrentRoute();`
* @return bool
*/
public function RouteRequest ();
/**
* Process pre-route, pre-request or post-dispatch
* handlers queue by queue index. Call every handler in queue
* in try catch mode to catch any exceptions to call:
* `\MvcCore\Application::DispatchException($e);`.
* @param \callable[] $handlers
* @return bool
*/
public function ProcessCustomHandlers (& $handlers = []);
/**
* If controller class exists - try to dispatch controller,
* if only view file exists - try to render targeted view file
* with configured core controller instance (`\MvcCore\Controller` by default).
* @return bool
*/
public function DispatchRequest ();
/**
* Dispatch controller by:
* - By full class name and by action name
* - Or by view script full path
* Call exception callback if there is caught any
* exception in controller life-cycle dispatching process
* with first argument as caught exception.
* @param string $ctrlClassFullName
* @param string $actionNamePc
* @param string $viewScriptFullPath
* @param callable $exceptionCallback
* @return bool
*/
public function DispatchControllerAction (
$controllerClassFullName,
$actionNamePc,
$viewScriptFullPath,
callable $exceptionCallback
);
/**
* Generates url:
* - By `"Controller:Action"` name and params array
* (for routes configuration when routes array has keys with `"Controller:Action"` strings
* and routes has not controller name and action name defined inside).
* - By route name and params array
* (route name is key in routes configuration array, should be any string
* but routes must have information about controller name and action name inside).
* Result address (url string) should have two forms:
* - Nice rewritten URL by routes configuration
* (for apps with URL rewrite support (Apache `.htaccess` or IIS URL rewrite module)
* and when first param is key in routes configuration array).
* - For all other cases is URL form like: `"index.php?controller=ctrlName&action=actionName"`
* (when first param is not founded in routes configuration array).
* @param string $controllerActionOrRouteName Should be `"Controller:Action"` combination or just any route name as custom specific string.
* @param array $params Optional, array with params, key is param name, value is param value.
* @return string
*/
public function Url ($controllerActionOrRouteName = 'Index:Index', $params = []);
/**
* Terminate request.
* The only place in application where is called `echo '....'` without output buffering.
* - Process post-dispatch handlers queue.
* - Write session through registered handler into `register_shutdown_function()`.
* - Send HTTP headers (if still possible).
* - Echo response body.
* This method is always called INTERNALLY after controller
* life-cycle has been dispatched. But you can use it any
* time sooner for custom purposes.
* @return \MvcCore\Application
*/
public function Terminate ();
/***********************************************************************************
* `\MvcCore\Application` - Request Error Dispatching *
***********************************************************************************/
/**
* Dispatch caught exception:
* - If request is processing PHP package packing to determinate current script dependencies:
* - Do not log or render nothing.
* - If request is production mode:
* - Print exception in browser.
* - If request is not in development mode:
* - Log error and try to render error page by configured controller and error action:,
* `\App\Controllers\Index::Error();` by default.
* @param \Exception|string $exceptionOrMessage
* @param int|NULL $code
* @return bool
*/
public function DispatchException ($exceptionOrMessage, $code = NULL);
/**
* Render error by configured default controller and error action,
* `\App\Controllers\Index::Error();` by default.
* If there is no controller/action like that or any other exception happens,
* it's processed very simple plain text response with 500 http code.
* @param \Exception $e
* @return bool
*/
public function RenderError ($e);
/**
* Render error by configured default controller and not found error action,
* `\App\Controllers\Index::NotFound();` by default.
* If there is no controller/action like that or any other exception happens,
* it's processed very simple plain text response with 404 http code.
* @param \Exception $e
* @return bool
*/
public function RenderNotFound ($exceptionMessage = '');
/**
* Prepare very simple response with internal server error (500)
* as plain text response into `\MvcCore\Application::$response`.
* @param string $text
* @return bool
*/
public function RenderError500PlainText ($text = '');
/**
* Prepare very simple response with not found error (404)
* as plain text response into `\MvcCore\Application::$response`.
* @param string $text
* @return bool
*/
public function RenderError404PlainText ();
/***********************************************************************************
* `\MvcCore\Application` - Helper Methods *
***********************************************************************************/
/**
* Check if default application controller (`\App\Controllers\Index` by default) has specific action.
* If default controller has specific action - return default controller full name, else empty string.
* @param string $actionName
* @return string
*/
public function GetDefaultControllerIfHasAction ($actionName);
/**
* Complete standard MvcCore application controller full name in form:
* `\App\Controllers\<$controllerNamePascalCase>`.
* @param string $controllerNamePascalCase
* @return string
*/
public function CompleteControllerName ($controllerNamePascalCase);
/**
* Return `TRUE` if current request is default controller error action dispatching process.
* @return bool
*/
public function IsErrorDispatched ();
/**
* Return `TRUE` if current request is default controller not found error action dispatching process.
* @return bool
*/
public function IsNotFoundDispatched ();
}