├── tests
    ├── mvc
    │   ├── index.php
    │   ├── content
    │   │   └── images
    │   │   │   ├── mvc.png
    │   │   │   └── php.png
    │   ├── filters
    │   │   ├── EmptyFilter.php
    │   │   ├── NoResultErrorFilter.php
    │   │   ├── ExecutingWorldFilter.php
    │   │   ├── ErrorFilter.php
    │   │   └── ExecutedWorldFilter.php
    │   ├── views
    │   │   ├── shared
    │   │   │   ├── _empty.php
    │   │   │   ├── footer.php
    │   │   │   ├── error.php
    │   │   │   ├── _lite.php
    │   │   │   ├── header.php
    │   │   │   ├── _default.php
    │   │   │   └── _parent.php
    │   │   ├── home
    │   │   │   ├── prog.php
    │   │   │   ├── hello.php
    │   │   │   └── index.php
    │   │   └── account
    │   │   │   └── login.php
    │   ├── models
    │   │   ├── HomePage.php
    │   │   └── Login.php
    │   └── controllers
    │   │   ├── AccountController.php
    │   │   ├── FilterController.php
    │   │   ├── OutputCacheController.php
    │   │   └── HomeController.php
    ├── models
    │   ├── ModelA.php
    │   ├── ModelB.php
    │   └── ModelC.php
    ├── autoload.php
    ├── HttpRequest.php
    ├── HttpContextInfo.php
    ├── RouteCollectionTest.php
    ├── HttpResponse.php
    ├── UrlHelperTest.php
    ├── PathUtilityTest.php
    ├── FilterTest.php
    ├── HttpContext.php
    └── ArrayToObjectTest.php
├── .gitignore
├── .vscode
    └── tasks.json
├── composer.json
├── LICENSE
└── src
    ├── Info.php
    ├── UrlParameter.php
    ├── HttpAntiForgeryException.php
    ├── ActionNameValidationException.php
    ├── EventArgs.php
    ├── HttpRequest.php
    ├── CrossSiteScriptingValidation.php
    ├── ActionResult.php
    ├── FileCacheProviderConfig.php
    ├── RouteParsingException.php
    ├── HttpContext.php
    ├── EmptyResult.php
    ├── Loader.php
    ├── HttpContextInfo.php
    ├── SelectListGroup.php
    ├── RouteOptions.php
    ├── ModelStateEntry.php
    ├── ViewNotFoundException.php
    ├── ActionFilter.php
    ├── ExceptionResult.php
    ├── ActionExecutingContext.php
    ├── HttpRequestValidationException.php
    ├── RouteSegment.php
    ├── ModelDataAnnotation.php
    ├── Filter.php
    ├── OutputCacheLocation.php
    ├── index.php
    ├── ContentResult.php
    ├── HttpStatusCodeResult.php
    ├── ErrorHandlerEventArgs.php
    ├── ValidateAntiForgeryToken.php
    ├── UrlHelper.php
    ├── SelectListItem.php
    ├── HttpResponse.php
    ├── RedirectResult.php
    ├── JsonResult.php
    ├── ViewResult.php
    ├── FileResult.php
    ├── ExceptionContext.php
    ├── CacheProvider.php
    ├── ActionExecutedContext.php
    ├── RedirectToActionResult.php
    ├── IdleCacheProvider.php
    ├── Cache.php
    ├── ViewContext.php
    ├── HttpSessionProvider.php
    ├── PathUtility.php
    ├── View.php
    ├── RouteProvider.php
    ├── HttpContextBase.php
    └── ModelState.php


/tests/mvc/index.php:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | /composer.lock
3 | /docs
4 | /output
5 | /cache
6 | /tests/mvc/cache
7 | 


--------------------------------------------------------------------------------
/tests/mvc/content/images/mvc.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/php-mvc-project/php-mvc/HEAD/tests/mvc/content/images/mvc.png


--------------------------------------------------------------------------------
/tests/mvc/content/images/php.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/php-mvc-project/php-mvc/HEAD/tests/mvc/content/images/php.png


--------------------------------------------------------------------------------
/tests/mvc/filters/EmptyFilter.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace PhpMvcTest\Filters;
3 | 
4 | use \PhpMvc\ActionFilter;
5 | 
6 | class EmptyFilter extends ActionFilter {
7 | 
8 | }


--------------------------------------------------------------------------------
/tests/mvc/views/shared/_empty.php:
--------------------------------------------------------------------------------
1 | <?php
2 | use PhpMvc\Html;
3 | use PhpMvc\View;
4 | ?>
5 | <!--View file: <?=View::getViewFile()?>-->
6 | <?php Html::renderBody(); ?>


--------------------------------------------------------------------------------
/tests/models/ModelA.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | class ModelA {
 3 | 
 4 |     public $text;
 5 | 
 6 |     public $number;
 7 | 
 8 |     public $boolean;
 9 | 
10 |     public $array;
11 | 
12 | }


--------------------------------------------------------------------------------
/tests/mvc/models/HomePage.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace PhpMvcTest\Models;
 3 | 
 4 | class HomePage {
 5 | 
 6 |     public $title;
 7 | 
 8 |     public $text;
 9 | 
10 |     public $number;
11 | 
12 | }


--------------------------------------------------------------------------------
/tests/mvc/views/home/prog.php:
--------------------------------------------------------------------------------
1 | <?php 
2 | use PhpMvc\View;
3 | ?>
4 | <!--View file: <?=View::getViewFile()?>-->
5 | <h2>Index</h2>
6 | <p>This is another page of the most wonderful site in the world!</p>


--------------------------------------------------------------------------------
/tests/models/ModelB.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | require_once 'ModelA.php';
 3 | 
 4 | class ModelB {
 5 | 
 6 |     public $text;
 7 | 
 8 |     /**
 9 |      * @var ModelA
10 |      */
11 |     public $a;
12 | 
13 | }


--------------------------------------------------------------------------------
/tests/autoload.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | require_once __DIR__ . '/../vendor/autoload.php';
4 | 
5 | $classLoader = new \Composer\Autoload\ClassLoader();
6 | $classLoader->addPsr4("PhpMvcTest\\", __DIR__ . '/mvc', true);
7 | $classLoader->register();


--------------------------------------------------------------------------------
/tests/mvc/views/home/hello.php:
--------------------------------------------------------------------------------
 1 | <?php 
 2 | use PhpMvc\View;
 3 | use PhpMvc\Html;
 4 | 
 5 | $model = '';
 6 | 
 7 | View::setTitle('Hello world');
 8 | View::injectModel($model);
 9 | ?>
10 | 
11 | <!--View file: <?=View::getViewFile()?>-->
12 | 
13 | <h3>Model</h3>
14 | <?=$model?>


--------------------------------------------------------------------------------
/tests/mvc/views/shared/footer.php:
--------------------------------------------------------------------------------
1 | <?php 
2 | use PhpMvc\View;
3 | ?>
4 | <!--View file: <?=View::getViewFile()?>-->
5 | <footer>
6 |     <div class="container">
7 |         Copyright © <a href="https://github.com/meet-aleksey" target="_blank">Aleksey</a>, 2018.
8 |     </div>
9 | </footer>


--------------------------------------------------------------------------------
/tests/HttpRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | use PhpMvc\HttpRequestBase;
 3 | 
 4 | final class HttpRequest extends HttpRequestBase {
 5 | 
 6 |     public function __construct($serverVariables, $get = array(), $post = array()) {
 7 |         parent::__construct($serverVariables, array(), $get, $post);
 8 |     }
 9 |     
10 | }


--------------------------------------------------------------------------------
/tests/mvc/models/Login.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace PhpMvcTest\Models;
 3 | 
 4 | class Login {
 5 | 
 6 |     /**
 7 |      * User name.
 8 |      * 
 9 |      * @var string
10 |      */
11 |     public $username;
12 | 
13 |     /**
14 |      * Password.
15 |      * 
16 |      * @var string
17 |      */
18 |     public $password;
19 | 
20 | }


--------------------------------------------------------------------------------
/.vscode/tasks.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     // See https://go.microsoft.com/fwlink/?LinkId=733558
 3 |     // for the documentation about the tasks.json format
 4 |     "version": "2.0.0",
 5 |     "tasks": [
 6 |         {
 7 |             "label": "Test",
 8 |             "type": "shell",
 9 |             "command": "vendor/bin/phpunit --bootstrap tests/autoload.php tests --colors always"
10 |         }
11 |     ]
12 | }


--------------------------------------------------------------------------------
/tests/mvc/views/home/index.php:
--------------------------------------------------------------------------------
 1 | <?php 
 2 | use PhpMvc\View;
 3 | use PhpMvc\Html;
 4 | 
 5 | $model = new \PhpMvcTest\Models\HomePage();
 6 | 
 7 | View::setLayout('_default');
 8 | View::setTitle('Home page');
 9 | View::injectModel($model);
10 | ?>
11 | 
12 | <!--View file: <?=View::getViewFile()?>-->
13 | 
14 | <h2>Index</h2>
15 | <p>This is the main page of the most wonderful site in the world!</p>
16 | 


--------------------------------------------------------------------------------
/tests/mvc/views/shared/error.php:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html>
 3 | <head>
 4 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
 5 |     <meta name="viewport" content="width=device-width" />
 6 |     <title>Error</title>
 7 | </head>
 8 | <body>
 9 |     <hgroup>
10 |         <h1>Error.</h1>
11 |         <h2>An error occurred while processing the request.</h2>
12 |     </hgroup>
13 | </body>
14 | </html>


--------------------------------------------------------------------------------
/tests/models/ModelC.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | require_once 'ModelA.php';
 3 | require_once 'ModelB.php';
 4 | 
 5 | class ModelC {
 6 | 
 7 |     /**
 8 |      * @var ModelB
 9 |      */
10 |     public $b1;
11 | 
12 |     /**
13 |      * @var ModelB
14 |      */
15 |     public $b2;
16 | 
17 |     /**
18 |      * @var ModelB
19 |      */
20 |     public $b3;
21 | 
22 |     /**
23 |      * @var ModelA
24 |      */
25 |     public $a;
26 | 
27 | }


--------------------------------------------------------------------------------
/tests/mvc/views/shared/_lite.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | use PhpMvc\Html;
 3 | use PhpMvc\View;
 4 | ?>
 5 | <!--View file: <?=View::getViewFile()?>-->
 6 | <html>
 7 |     <head>
 8 |         <title><?=Html::getTitle('Lite layout')?> - PHP MVC Test project</title>
 9 |     </head>
10 |     <body>
11 |         <h1>Lite layout</h1>
12 | 
13 |         <div class="container">
14 |             <?php Html::renderBody(); ?>
15 |         </div>
16 |     </body>
17 | </html>


--------------------------------------------------------------------------------
/tests/mvc/filters/NoResultErrorFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace PhpMvcTest\Filters;
 3 | 
 4 | use \PhpMvc\ActionFilter;
 5 | use \PhpMvc\ContentResult;
 6 | 
 7 | class NoResultErrorFilter extends ActionFilter {
 8 | 
 9 |     /**
10 |      * Called when an exception occurs.
11 |      * 
12 |      * @param ExceptionContext $exceptionContext The context of action exception.
13 |      * 
14 |      * @return void
15 |      */
16 |     public function exception($exceptionContext) {
17 |         $exceptionContext->setExceptionHandled(true);
18 |     }
19 | 
20 | }


--------------------------------------------------------------------------------
/tests/HttpContextInfo.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | use PhpMvc\HttpContextInfo as HttpContextInfoBase;
 3 | 
 4 | /**
 5 |  * Represents the information needed to create an HTTP request context.
 6 |  */
 7 | class HttpContextInfo extends HttpContextInfoBase {
 8 | 
 9 |     /**
10 |      * @var bool
11 |      */
12 |     public $noOutputHeaders = false;
13 | 
14 |     /**
15 |      * @var array
16 |      */
17 |     public $serverVariables;
18 | 
19 |     /**
20 |      * @var array
21 |      */
22 |     public $get;
23 | 
24 |     /**
25 |      * @var array
26 |      */
27 |     public $post;
28 | 
29 | }


--------------------------------------------------------------------------------
/tests/mvc/filters/ExecutingWorldFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace PhpMvcTest\Filters;
 3 | 
 4 | use \PhpMvc\ActionFilter;
 5 | use \PhpMvc\ContentResult;
 6 | 
 7 | class ExecutingWorldFilter extends ActionFilter {
 8 | 
 9 |     /**
10 |      * Called before the action method executes.
11 |      * 
12 |      * @param ActionExecutingContext $actionExecutingContext The action executing context.
13 |      * 
14 |      * @return void
15 |      */
16 |     public function actionExecuting($actionExecutingContext) {
17 |         $actionExecutingContext->setResult(new ContentResult('executing the world!'));
18 |     }
19 | 
20 | }


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "php-mvc-project/php-mvc",
 3 |     "description": "Implementation of the MVC (Model-View-Controller) architectural pattern in PHP.",
 4 |     "keywords": ["mvc"],
 5 |     "license": "MIT",
 6 |     "type": "library",
 7 |     "authors": [
 8 |         {
 9 |             "name": "Meet Aleksey",
10 |             "homepage": "https://github.com/meet-aleksey"
11 |         }
12 |     ],
13 |     "require": {
14 |         "php": ">=7.0"
15 |     },
16 |     "require-dev": {
17 |         "phpunit/phpunit": "^7"
18 |     },
19 |     "autoload": {
20 |         "psr-4": { "PhpMvc\\": "src" }
21 |     }
22 | }


--------------------------------------------------------------------------------
/tests/mvc/filters/ErrorFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace PhpMvcTest\Filters;
 3 | 
 4 | use \PhpMvc\ActionFilter;
 5 | use \PhpMvc\ContentResult;
 6 | use \PhpMvc\ViewResult;
 7 | 
 8 | class ErrorFilter extends ActionFilter {
 9 | 
10 |     /**
11 |      * Called when an exception occurs.
12 |      * 
13 |      * @param ExceptionContext $exceptionContext The context of action exception.
14 |      * 
15 |      * @return void
16 |      */
17 |     public function exception($exceptionContext) {
18 |         $exceptionContext->setResult(new ViewResult('error'));
19 |         // $exceptionContext->setResult(new ContentResult('hello exception!'));
20 |     }
21 | 
22 | }


--------------------------------------------------------------------------------
/tests/mvc/filters/ExecutedWorldFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace PhpMvcTest\Filters;
 3 | 
 4 | use \PhpMvc\ActionFilter;
 5 | use \PhpMvc\ContentResult;
 6 | 
 7 | class ExecutedWorldFilter extends ActionFilter {
 8 | 
 9 |     /**
10 |      * Called after the action method executes.
11 |      * 
12 |      * @param ActionExecutedContext $actionExecutedContext The context of the action executed.
13 |      * 
14 |      * @return void
15 |      */
16 |     public function actionExecuted($actionExecutedContext) {
17 |         if (($ex = $actionExecutedContext->getException()) === null) {
18 |             $actionExecutedContext->setResult(new ContentResult('executed the world!'));
19 |         }
20 |         else {
21 |             $actionExecutedContext->setResult(new ContentResult($ex->getMessage()));
22 |         }
23 |     }
24 | 
25 | }


--------------------------------------------------------------------------------
/tests/mvc/views/shared/header.php:
--------------------------------------------------------------------------------
 1 | <?php 
 2 | use PhpMvc\View;
 3 | 
 4 | $model = '';
 5 | 
 6 | View::injectModel($model);
 7 | ?>
 8 | <!--View file: <?=View::getViewFile()?>-->
 9 | <header>
10 |   <nav class="navbar navbar-default">
11 |     <div class="container">
12 |       <div class="navbar-header">
13 |         <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-expanded="false">
14 |           <span class="sr-only">Toggle navigation</span>
15 |           <span class="icon-bar"></span>
16 |           <span class="icon-bar"></span>
17 |           <span class="icon-bar"></span>
18 |         </button>
19 |         <a class="navbar-brand" href="/">
20 |           <i class="glyphicon glyphicon-tasks"></i>
21 |           <?=$model?>
22 |         </a>
23 |       </div>
24 |     </div>
25 |   </nav>
26 | </header>


--------------------------------------------------------------------------------
/tests/mvc/views/shared/_default.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | use PhpMvc\Html;
 3 | use PhpMvc\View;
 4 | ?>
 5 | <!--View file: <?=View::getViewFile()?>-->
 6 | <html>
 7 |     <head>
 8 |         <title><?=Html::getTitle('Default layout')?> - PHP MVC Test project</title>
 9 |     </head>
10 |     <body>
11 |         <?php Html::render('header', 'PHP MVC'); ?>
12 | 
13 |         <div class="container">
14 |             <h1>Default layout</h1>
15 | 
16 |             <?=Html::validationSummary()?>
17 | 
18 |             <?php Html::renderBody(); ?>
19 | 
20 |             <h3>Model</h3>
21 |             <?php var_dump(View::getModel()); ?>
22 | 
23 |             <h3>ViewData</h3>
24 |             <?php var_dump(View::getData()); ?>
25 | 
26 |             <h3>ModelState</h3>
27 |             <?php var_dump(View::getModelState()); ?>
28 |         </div>
29 | 
30 |         <?php Html::render('footer'); ?>
31 |     </body>
32 | </html>


--------------------------------------------------------------------------------
/tests/mvc/views/shared/_parent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | use PhpMvc\Html;
 3 | use PhpMvc\View;
 4 | View::setLayout('_empty');
 5 | ?>
 6 | <!--View file: <?=View::getViewFile()?>-->
 7 | <html>
 8 |     <head>
 9 |         <title><?=Html::getTitle('Default layout with empty parent')?> - PHP MVC Test project</title>
10 |     </head>
11 |     <body>
12 |         <?php Html::render('header', 'PHP MVC'); ?>
13 | 
14 |         <div class="container">
15 |             <h1>Default layout with empty parent</h1>
16 | 
17 |             <?=Html::validationSummary()?>
18 | 
19 |             <?php Html::renderBody(); ?>
20 | 
21 |             <h3>Model</h3>
22 |             <?php var_dump(View::getModel()); ?>
23 | 
24 |             <h3>ViewData</h3>
25 |             <?php var_dump(View::getData()); ?>
26 | 
27 |             <h3>ModelState</h3>
28 |             <?php var_dump(View::getModelState()); ?>
29 |         </div>
30 | 
31 |         <?php Html::render('footer'); ?>
32 |     </body>
33 | </html>


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/tests/RouteCollectionTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | require_once 'HttpContext.php';
 5 | 
 6 | use PHPUnit\Framework\TestCase;
 7 | 
 8 | use PhpMvc\RouteCollection;
 9 | use PhpMvc\UrlParameter;
10 | use PhpMvc\Route;
11 | 
12 | final class RouteCollectionTest extends TestCase
13 | {
14 | 
15 |     public function testAddEmptyNameException(): void
16 |     {
17 |         $this->expectExceptionMessageRegExp('/must not be empty/');
18 | 
19 |         $routes = new RouteCollection('test');
20 | 
21 |         $route = new Route();
22 | 
23 |         $routes->add($route);
24 |     }
25 | 
26 |     public function testAddEmptyTemplateException(): void
27 |     {
28 |         $this->expectExceptionMessageRegExp('/template/');
29 | 
30 |         $routes = new RouteCollection('test');
31 | 
32 |         $route = new Route();
33 |         $route->name = 'default';
34 | 
35 |         $routes->add($route);
36 |     }
37 | 
38 |     public function testAddNonUniqueNameException(): void
39 |     {
40 |         $this->expectExceptionMessageRegExp('/unique name/');
41 | 
42 |         $routes = new RouteCollection('test');
43 | 
44 |         $route = new Route();
45 |         $route->name = 'default';
46 |         $route->template = '{controller}';
47 | 
48 |         $routes->add($route);
49 | 
50 |         $route = new Route();
51 |         $route->name = 'default';
52 |         $route->template = '{controller}';
53 | 
54 |         $routes->add($route);
55 |     }
56 | 
57 | }


--------------------------------------------------------------------------------
/tests/mvc/controllers/AccountController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace PhpMvcTest\Controllers;
 3 | 
 4 | use \PhpMvc\Model;
 5 | use \PhpMvc\Controller;
 6 | use \PhpMvc\OutputCache;
 7 | 
 8 | use \PhpMvcTest\Models\Login;
 9 | 
10 | class AccountController extends Controller {
11 | 
12 |     public function __construct() {
13 |         Model::set('login', 'login');
14 | 
15 |         Model::required('login', 'username');
16 |         Model::required('login', 'password', 'Password is required.');
17 |         
18 |         Model::display('login', 'username', 'Username', 'Username that you used when registering.'); 
19 |         Model::display('login', 'password', 'Password', 'Your password.');
20 | 
21 |         Model::validation('login', 'username', function($value, &$errorMessage) {
22 |             if ($value != 'root') {
23 |                 $errorMessage = 'Only "root" can login.';
24 |                 return false;
25 |             }
26 |             
27 |             return true;
28 |         });
29 |     }
30 | 
31 |     public function login($model) {
32 |         if ($this->isPost()) {
33 |             $modelState = $this->getModelState();
34 | 
35 |             if ($modelState->isValid()) {
36 |                 $this->setData('success', true);
37 |                 return $this->view();
38 |             }
39 |         }
40 | 
41 |         if (!isset($model)) {
42 |             $model = new \PhpMvcTest\Models\Login();
43 |         }
44 | 
45 |         return $this->view($model);
46 |     }
47 | 
48 | }


--------------------------------------------------------------------------------
/src/Info.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Contains information about PhpMvc.
30 |  */
31 | final class Info {
32 | 
33 |     const VERSION = '1.2.0';
34 | 
35 | }


--------------------------------------------------------------------------------
/src/UrlParameter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Contains the read-only value for the optional parameter.
30 |  */
31 | final class UrlParameter {
32 | 
33 |     /**
34 |      * The value indicates that the URL parameter is optional.
35 |      * 
36 |      * @var string
37 |      */
38 |     const OPTIONAL = '%OPTIONAL%';
39 | 
40 | }


--------------------------------------------------------------------------------
/src/HttpAntiForgeryException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * An exception occurs when a fake HTTP security token is detected.
30 |  */
31 | final class HttpAntiForgeryException extends \Exception {
32 | 
33 |     /**
34 |      * Initializes a new instance of the HttpAntiForgeryException.
35 |      * 
36 |      */
37 |     public function __construct() {
38 |         parent::__construct('Failed to decrypt the anti-forgery token.');
39 |     }
40 | 
41 | }


--------------------------------------------------------------------------------
/src/ActionNameValidationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Occurs if the action name contains illegal characters.
30 |  */
31 | final class ActionNameValidationException extends \Exception {
32 | 
33 |     /**
34 |      * Initializes a new instance of the ActionNameValidationException.
35 |      * 
36 |      */
37 |     public function __construct() {
38 |         parent::__construct('Action names can not begin with a "_".');
39 |     }
40 | 
41 | }


--------------------------------------------------------------------------------
/src/EventArgs.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents the base class for classes that contain event data, and provides a value to use for events that do not include event data.
30 |  */
31 | class EventArgs {
32 | 
33 |     /**
34 |      * Provides a value to use with events that do not have event data.
35 |      * 
36 |      * @return EventArgs
37 |      */
38 |     public static function getEmpty() {
39 |         return new EventArgs();
40 |     }
41 | 
42 | }


--------------------------------------------------------------------------------
/src/HttpRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents current request.
30 |  */
31 | final class HttpRequest extends HttpRequestBase {
32 | 
33 |     /**
34 |      * Initializes a new instance of the HttpRequest for the current request.
35 |      */
36 |     public function __construct() {
37 |         parent::__construct(
38 |             $_SERVER,
39 |             $_COOKIE,
40 |             $_GET,
41 |             $_POST,
42 |             $_FILES
43 |         );
44 |     }
45 | 
46 | }


--------------------------------------------------------------------------------
/src/CrossSiteScriptingValidation.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Detection of unsafe strings from the client.
30 |  */
31 | final class CrossSiteScriptingValidation {
32 | 
33 |     /**
34 |      * Checks whether the specified line is safe or not.
35 |      * 
36 |      * @param string $value The value to check.
37 |      * 
38 |      * @return bool
39 |      */
40 |     public static function IsDangerousString($value) {
41 |         return preg_match('/(\x3c([A-Za-z\x21\x2f\x3f]+))|(\x26\x23)/', $value) === 1;
42 |     }
43 | 
44 | }


--------------------------------------------------------------------------------
/src/ActionResult.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Defines a contract that represents the result of an action method.
30 |  */
31 | interface ActionResult {
32 | 
33 |     /**
34 |      * Executes the action and outputs the result.
35 |      * 
36 |      * @param ActionContext $actionContext The context in which the result is executed.
37 |      * The context information includes information about the action that was executed and request information.
38 |      * 
39 |      * @return void
40 |      */
41 |     function execute($actionContext);
42 | 
43 | }


--------------------------------------------------------------------------------
/tests/mvc/controllers/FilterController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace PhpMvcTest\Controllers;
 3 | 
 4 | use \PhpMvc\Filter;
 5 | use \PhpMvc\Controller;
 6 | 
 7 | class FilterController extends Controller {
 8 | 
 9 |     public function __construct() {
10 |         Filter::add('EmptyFilter');
11 | 
12 |         Filter::add('executingWorld', 'ExecutingWorldFilter');
13 |         Filter::add('executedWorld', 'ExecutedWorldFilter');
14 | 
15 |         Filter::add('executeWorld', 'ExecutingWorldFilter');
16 |         Filter::add('executeWorld', 'ExecutedWorldFilter');
17 | 
18 |         Filter::add('executeWorld2', 'ExecutedWorldFilter');
19 |         Filter::add('executeWorld2', 'ExecutingWorldFilter');
20 |         
21 |         Filter::add('error', 'ErrorFilter');
22 | 
23 |         Filter::add('errorNoResult', 'NoResultErrorFilter');
24 | 
25 |         Filter::add('errorRewrited', 'NoResultErrorFilter');
26 |         Filter::add('errorRewrited', 'ExecutedWorldFilter');
27 |     }
28 | 
29 |     public function index() {
30 |         return $this->content('index');
31 |     }
32 | 
33 |     public function executingWorld() {
34 |         return $this->content('this result will be redefined!');
35 |     }
36 | 
37 |     public function executedWorld() {
38 |         return $this->content('this result will be redefined!');
39 |     }
40 | 
41 |     public function executeWorld() {
42 |         return $this->content('this result will be redefined!');
43 |     }
44 | 
45 |     public function executeWorld2() {
46 |         return $this->content('this result will be redefined!');
47 |     }
48 | 
49 |     public function error() {
50 |         throw new \Exception('ой!');
51 |     }
52 | 
53 |     public function errorNoResult() {
54 |         throw new \Exception('error');
55 |     }
56 | 
57 |     public function errorRewrited() {
58 |         throw new \Exception('just make an exception in this world!');
59 |     }
60 | 
61 | }


--------------------------------------------------------------------------------
/src/FileCacheProviderConfig.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents a standard cache provider for storing the cache in the file system.
30 |  */
31 | final class FileCacheProviderConfig {
32 | 
33 |     /**
34 |      * The path to the cache files directory.
35 |      * 
36 |      * @var string
37 |      */
38 |     public $cachePath;
39 | 
40 |     /**
41 |      * The timeout of access to cache data, in milliseconds.
42 |      * 
43 |      * @var int
44 |      */
45 |     public $accessTime;
46 | 
47 |     /**
48 |      * Hash algorithm.
49 |      * 
50 |      * @var string|callback
51 |      */
52 |     public $hash;
53 | 
54 | }


--------------------------------------------------------------------------------
/src/RouteParsingException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Occurs when errors are detected during route parsing.
30 |  */
31 | class RouteParsingException extends \Exception {
32 | 
33 |     /**
34 |      * Initializes a new instance of the RouteSegmentsRequiredException.
35 |      * 
36 |      * @param Route $route The route.
37 |      * @param string|null $message The error message.
38 |      */
39 |     public function __construct($route, $message = null) {
40 |         if (!empty($message)) {
41 |             parent::__construct($message);
42 |         }
43 |         else {
44 |             parent::__construct('One or more errors occurred while parsing the route "' . $route->name . '"');
45 |         }
46 |     }
47 | 
48 | }


--------------------------------------------------------------------------------
/src/HttpContext.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents current HTTP context.
30 |  */
31 | final class HttpContext extends HttpContextBase {
32 | 
33 |     /**
34 |      * Gets or sets current HttpContext.
35 |      * 
36 |      * @var HttpContextBase
37 |      */
38 |     private static $current;
39 | 
40 |     /**
41 |      * Initializes a new instance of the HttpContext for the current request.
42 |      */
43 |     public function __construct($info) {
44 |         parent::__construct($info);
45 |     }
46 | 
47 |     /**
48 |      * Returs current HttpContext.
49 |      * 
50 |      * @return HttpContextBase
51 |      */
52 |     public static function getCurrent() {
53 |         return self::$current;
54 |     }
55 | 
56 | }


--------------------------------------------------------------------------------
/src/EmptyResult.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents a result that does nothing.
30 |  */
31 | class EmptyResult implements ActionResult {
32 | 
33 |     /**
34 |      * Initializes a new instance of EmptyResult.
35 |      */
36 |     public function __construct() {
37 |     }
38 | 
39 |     /**
40 |      * Executes the action and outputs the result.
41 |      * 
42 |      * @param ActionContext $actionContext The context in which the result is executed.
43 |      * The context information includes information about the action that was executed and request information.
44 |      * 
45 |      * @return void
46 |      */
47 |     public function execute($actionContext) {
48 |         $actionContext->getHttpContext()->getResponse()->end();
49 |     }
50 | 
51 | }


--------------------------------------------------------------------------------
/src/Loader.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | spl_autoload_register(function ($name) {
27 |     $segments = explode('\\', $name);
28 |     $fileName = array_slice($segments, -1)[0];
29 | 
30 |     array_pop($segments);
31 | 
32 |     if (!empty(PHPMVC_APP_NAMESPACE) && count($segments) > 0 && $segments[0] == PHPMVC_APP_NAMESPACE) {
33 |         array_shift($segments);
34 |     }
35 | 
36 |     $path = PHPMVC_ROOT_PATH . implode(PHPMVC_DS, $segments) . PHPMVC_DS . $fileName . '.php';
37 | 
38 |     if (!is_file($path)) {
39 |         $segments = array_map('strtolower', $segments);
40 |         $path = PHPMVC_ROOT_PATH . implode(PHPMVC_DS, $segments) . PHPMVC_DS . $fileName . '.php';
41 |     }
42 | 
43 |     if (!is_file($path)) {
44 |         return false;
45 |     }
46 | 
47 |     require_once $path;
48 | });


--------------------------------------------------------------------------------
/src/HttpContextInfo.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents the information needed to create an HTTP request context.
30 |  */
31 | class HttpContextInfo {
32 | 
33 |     /**
34 |      * Gets or sets route provider.
35 |      * 
36 |      * @var RouteProvider
37 |      */
38 |     public $routeProvider;
39 | 
40 |     /**
41 |      * Gets or sets cache provider.
42 |      * 
43 |      * @var CacheProvider
44 |      */
45 |     public $cacheProvider;
46 | 
47 |     /**
48 |      * Gets or sets request.
49 |      * 
50 |      * @var HttpRequestBase
51 |      */
52 |     public $request;
53 | 
54 |     /**
55 |      * Gets or sets response.
56 |      * 
57 |      * @var HttpResponseBase
58 |      */
59 |     public $response;
60 | 
61 |     /**
62 |      * Gets or sets session variables.
63 |      * 
64 |      * @var HttpSessionProvider
65 |      */
66 |     public $session;
67 | 
68 | }


--------------------------------------------------------------------------------
/src/SelectListGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents the optgroup HTML element and its attributes.
30 |  */
31 | class SelectListGroup {
32 | 
33 |     /**
34 |      * Gets or sets a value that indicates whether this SelectListGroup is disabled.
35 |      * 
36 |      * @var bool
37 |      */
38 |     public $disabled;
39 | 
40 |     /**
41 |      * Represents the value of the optgroup's label.
42 |      * 
43 |      * @var string
44 |      */
45 |     public $name;
46 | 
47 |     /**
48 |      * Initializes a new instance of the SelectListGroup.
49 |      * 
50 |      * @param string $name The value of the optgroup's label.
51 |      * @param bool $disabled The value that indicates whether this SelectListGroup is disabled.
52 |      */
53 |     public function __construct($name = null, $disabled = false) {
54 |         $this->name = $name;
55 |         $this->disabled = $disabled;
56 |     }
57 | 
58 | }


--------------------------------------------------------------------------------
/src/RouteOptions.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents route settings.
30 |  */
31 | class RouteOptions {
32 | 
33 |     /**
34 |      * Gets or sets a value indicating whether all generated URLs are lower-case.
35 |      * Default: TRUE.
36 |      * 
37 |      * @var bool
38 |      */
39 |     public $lowercaseUrls = true;
40 | 
41 |     /**
42 |      * Gets or sets a value indicating whether a trailing slash should be appended to the generated URLs.
43 |      * Default: FALSE.
44 |      * 
45 |      * @var bool
46 |      */
47 |     public $appendTrailingSlash = false;
48 | 
49 |     /**
50 |      * Indicates that the last segment should be deleted if the segment value is the default value.
51 |      * Default: TRUE.
52 |      * 
53 |      * @var bool
54 |      */
55 |     public $removeLastSegmentIfValueIsDefault = true;
56 | 
57 |     /**
58 |      * Other settings.
59 |      * 
60 |      * @var array
61 |      */
62 |     public $extendedFields = array();
63 | 
64 | }


--------------------------------------------------------------------------------
/src/ModelStateEntry.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents an entry in a ModelState.
30 |  */
31 | class ModelStateEntry {
32 | 
33 |     /**
34 |      * Gets or sets the key for this entry.
35 |      * 
36 |      * @var string
37 |      */
38 |     public $key;
39 | 
40 |     /**
41 |      * Gets or sets the value for this entry.
42 |      * 
43 |      * @var mixed
44 |      */
45 |     public $value;
46 | 
47 |     /**
48 |      * Get or sets the validation state for this entry.
49 |      * 
50 |      * @var bool|null
51 |      */
52 |     public $validationState;
53 |    
54 |     /**
55 |      * Initializes a new instance of ModelStateEntry with the specified key and value.
56 |      * 
57 |      * @param string $key The key of element.
58 |      * @param string $value The value of element.
59 |      */
60 |     public function __construct($key, $value) {
61 |         $this->key = $key;
62 |         $this->value = $value;
63 |         $this->validationState = null;
64 |     }
65 | 
66 | }


--------------------------------------------------------------------------------
/tests/mvc/views/account/login.php:
--------------------------------------------------------------------------------
 1 | <?php 
 2 | use PhpMvc\View;
 3 | use PhpMvc\Html;
 4 | 
 5 | $model = new \PhpMvcTest\Models\Login();
 6 | 
 7 | View::setLayout('_default');
 8 | View::setTitle('Login');
 9 | View::injectModel($model);
10 | ?>
11 | 
12 | <?php
13 |   if (View::getData('success') === true) {
14 |     echo 'It\'s a success! Undeniably!';
15 |   }
16 |   else {
17 | ?>
18 | <div class="modal show" tabindex="-1" role="dialog" style="position: static">
19 |   <div class="modal-dialog" role="document">
20 |     <div class="modal-content">
21 |       <div class="modal-header">
22 |         <h4 class="modal-title">Login for all</h4>
23 |       </div>
24 |       <div class="modal-body">
25 |         <form id="loginForm" action="<?=Html::action('Login', 'Account')?>" method="post" enctype="application/x-www-form-urlencoded">
26 |             <div class="form-group">
27 |                 <label for="login"><?=Html::displayName('username')?>:</label>
28 |                 <?=Html::textBox(
29 |                   'username',
30 |                   null, 
31 |                   array(
32 |                     'required' => 'required', 
33 |                     'class' => 'form-control',
34 |                     'id' => 'login'
35 |                   )
36 |                 )?>
37 |                 <?=Html::validationMessage('username')?>
38 |                 <?=Html::displayText('username')?>
39 |             </div>
40 |             <div class="form-group">
41 |                 <label for="password"><?=Html::displayName('password')?>:</label>
42 |                 <input 
43 |                     required
44 |                     type="password" 
45 |                     class="form-control" 
46 |                     id="password" 
47 |                     name="password" 
48 |                     value="<?=$model->password?>" 
49 |                 />
50 |                 <?=Html::validationMessage('password')?>
51 |                 <?=Html::displayText('password')?>
52 |             </div>
53 |         </form>
54 |       </div>
55 |       <div class="modal-footer">
56 |         <?=Html::actionLink('Cancel', 'Index', 'Home', null, array('class' => 'btn btn-default'))?>
57 |         <button type="button" class="btn btn-primary" onclick="$('#loginForm').submit()">Login</button>
58 |       </div>
59 |     </div>
60 |   </div>
61 | </div>
62 | <?php
63 |   }
64 | ?>


--------------------------------------------------------------------------------
/src/ViewNotFoundException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Occurs when the view file could not be found.
30 |  */
31 | class ViewNotFoundException extends \Exception {
32 | 
33 |     /**
34 |      * Initializes a new instance of the ViewNotFoundException.
35 |      * 
36 |      * @param string $path The path to the view file.
37 |      */
38 |     public function __construct($path) {
39 |         $message = "The view file could not be found. Search paths:\r\n";
40 |         $message .= $path . "\r\n";
41 |         $message .= PHPMVC_VIEW_PATH . PHPMVC_VIEW . PHPMVC_DS . $path . "\r\n";
42 |         $message .= PHPMVC_SHARED_PATH . $path . "\r\n";
43 | 
44 |         if (strlen($path) > 4 && substr($path, -4) != '.php') {
45 |             $path .= '.php';
46 |             $message .= $path . "\r\n";
47 |             $message .= PHPMVC_VIEW_PATH . PHPMVC_VIEW . PHPMVC_DS . $path . "\r\n";
48 |             $message .= PHPMVC_SHARED_PATH . $path . "\r\n";
49 |         }
50 | 
51 |         parent::__construct($message);
52 |     }
53 | 
54 | }


--------------------------------------------------------------------------------
/src/ActionFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents the base class for action filters.
30 |  */
31 | abstract class ActionFilter {
32 | 
33 |     /**
34 |      * Called before the action method executes.
35 |      * 
36 |      * @param ActionExecutingContext $actionExecutingContext The context of the executing action.
37 |      * 
38 |      * @return void
39 |      */
40 |     public function actionExecuting($actionExecutingContext) {
41 | 
42 |     }
43 | 
44 |     /**
45 |      * Called after the action method executes.
46 |      * 
47 |      * @param ActionExecutedContext $actionExecutedContext The context of the action executed.
48 |      * 
49 |      * @return void
50 |      */
51 |     public function actionExecuted($actionExecutedContext) {
52 | 
53 |     }
54 | 
55 |     /**
56 |      * Called when an exception occurs.
57 |      * 
58 |      * @param ExceptionContext $exceptionContext The context of action exception.
59 |      * 
60 |      * @return void
61 |      */
62 |     public function exception($exceptionContext) {
63 | 
64 |     }
65 | 
66 | }


--------------------------------------------------------------------------------
/src/ExceptionResult.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents a result containing an exception.
30 |  */
31 | class ExceptionResult implements ActionResult {
32 | 
33 |     /**
34 |      * Gets or sets exception instance.
35 |      * 
36 |      * @var \Exception
37 |      */
38 |     private $exception;
39 | 
40 |     /**
41 |      * Initializes a new instance of ExceptionResult.
42 |      * 
43 |      * @param \Exception $exception The exception instance.
44 |      */
45 |     public function __construct($exception) {
46 |         $this->exception = $exception;
47 |     }
48 | 
49 |     /**
50 |      * Executes the action and outputs the result.
51 |      * 
52 |      * @param ActionContext $actionContext The context in which the result is executed.
53 |      * The context information includes information about the action that was executed and request information.
54 |      * 
55 |      * @return void
56 |      */
57 |     public function execute($actionContext) {
58 |     }
59 | 
60 |     /**
61 |      * Returns exception instance.
62 |      * 
63 |      * @return \Exception
64 |      */
65 |     public function getException() {
66 |         return $this->exception;
67 |     }
68 | 
69 | }


--------------------------------------------------------------------------------
/src/ActionExecutingContext.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Provides the context for the actionExecuting method of the ActionFilter class.
30 |  */
31 | final class ActionExecutingContext extends ActionContext {
32 | 
33 |     /**
34 |      * Gets or sets the result that is returned by the action method.
35 |      * 
36 |      * @var ActionResult
37 |      */
38 |     private $result;
39 | 
40 |     /**
41 |      * Initializes a new instance of the ActionExecutingContext.
42 |      * 
43 |      * @param ActionContext $actionContext The context of the action.
44 |      */
45 |     public function __construct($actionContext) {
46 |         parent::__construct($actionContext);
47 |     }
48 | 
49 |     /**
50 |      * Gets the result that is returned by the action method.
51 |      * 
52 |      * @return void
53 |      */
54 |     public function getResult() {
55 |         return $this->result;
56 |     }
57 | 
58 |     /**
59 |      * Sets the result that is returned by the action method.
60 |      * 
61 |      * @param mixed $value The result to set.
62 |      * 
63 |      * @return void
64 |      */
65 |     public function setResult($value) {
66 |         $this->result = $value;
67 |     }
68 | 
69 | }


--------------------------------------------------------------------------------
/src/HttpRequestValidationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * The exception that is thrown when a potentially malicious input string is received from the client as part of the request data.
30 |  */
31 | final class HttpRequestValidationException extends \Exception {
32 | 
33 |     /**
34 |      * Initializes a new instance of the HttpRequestValidationException.
35 |      * 
36 |      */
37 |     public function __construct($source = null, $key = null, $value = null) {
38 |         $specific = '';
39 | 
40 |         if (!empty($source) && !empty($key) && !empty($value)) {
41 |             $specific = 'A potentially dangerous ' . $source . ' value was obtained from the client (' . $key . ' = "' . $value . '").' . chr(10) . chr(10);
42 |         }
43 | 
44 |         parent::__construct(
45 |             $specific . 
46 |             'Request validation detected a potentially dangerous input value from the client and aborted the request. ' .
47 |             'This might be an attemp of using cross-site scripting to compromise the security of your site. ' .
48 |             'You can disable request validation using the code AppBuilder::useValidation(array(\'crossSiteScripting\' => false)).'
49 |         );
50 |     }
51 | 
52 | }


--------------------------------------------------------------------------------
/src/RouteSegment.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents segment of route.
30 |  */
31 | class RouteSegment {
32 | 
33 |     /**
34 |      * Segment name.
35 |      * 
36 |      * @var string
37 |      */
38 |     public $name;
39 | 
40 |     /**
41 |      * Regular expressions pattern.
42 |      * 
43 |      * @var string
44 |      */
45 |     public $pattern;
46 | 
47 |     /**
48 |      * Indicates that the parameter is optional..
49 |      * 
50 |      * @var bool
51 |      */
52 |     public $optional;
53 | 
54 |     /**
55 |      * Default value.
56 |      * 
57 |      * @return string
58 |      */
59 |     public $default;
60 | 
61 |     /**
62 |      * Before text.
63 |      * 
64 |      * @var string
65 |      */
66 |     public $before;
67 | 
68 |     /**
69 |      * After text.
70 |      * 
71 |      * @var string
72 |      */
73 |     public $after;
74 | 
75 |     /**
76 |      * Glue to the previous segment.
77 |      * 
78 |      * @var bool
79 |      */
80 |     public $glued;
81 | 
82 |     /**
83 |      * Is pre-end.
84 |      * 
85 |      * @var bool
86 |      */
87 |     public $preEnd;
88 | 
89 |     /**
90 |      * The end :)
91 |      * 
92 |      * @var bool
93 |      */
94 |     public $end;
95 | 
96 | }


--------------------------------------------------------------------------------
/src/ModelDataAnnotation.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents metadata for models.
30 |  */
31 | final class ModelDataAnnotation {
32 | 
33 |     /**
34 |      * The display name of the model element.
35 |      * 
36 |      * @var string
37 |      */
38 |     public $displayName;
39 | 
40 |     /**
41 |      * The description of the model element.
42 |      * 
43 |      * @var string
44 |      */
45 |     public $displayText;
46 | 
47 |     /**
48 |      * Indicates that the model element is required and must contain a non-empty value.
49 |      * 
50 |      * @var array
51 |      */
52 |     public $required;
53 | 
54 |     /**
55 |      * Specifies the comparison of the model value with the value of another model parameter.
56 |      * 
57 |      * @var array
58 |      */
59 |     public $compareWith;
60 | 
61 |     /**
62 |      * Specifies the text size check parameter in the model value.
63 |      * 
64 |      * @var array
65 |      */
66 |     public $stringLength;
67 | 
68 |     /**
69 |      * Gets or sets parameters to check whether the model value falls within the specified range.
70 |      * 
71 |      * @var array
72 |      */
73 |     public $range;
74 | 
75 |     /**
76 |      * Specifies a user-defined function to check the model value.
77 |      * 
78 |      * @var array
79 |      */
80 |     public $customValidation;
81 | 
82 | }


--------------------------------------------------------------------------------
/src/Filter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents static methods for adding filters.
30 |  */
31 | final class Filter {
32 | 
33 |     /**
34 |      * List of filters.
35 |      * 
36 |      * @var array
37 |      */
38 |     private static $filters = array();
39 | 
40 |     /**
41 |      * Defines ActionContext.
42 |      * 
43 |      * @var ActionContext
44 |      */
45 |     private static $actionContext;
46 | 
47 |     /**
48 |      * Adds a filter.
49 |      * 
50 |      * @param string $actionOrFilterName The action name or filter name, if the filter should be used for the current controller.
51 |      * @param string $filterName The name of the filter, if the name of the action is specified in the first parameter.
52 |      * 
53 |      * @return void
54 |      */
55 |     public static function add($actionOrFilterName, $filterName = null) {
56 |         if (empty($filterName)) {
57 |             $filterName = $actionOrFilterName;
58 |             $actionOrFilterName = '.';
59 |         }
60 | 
61 |         if ($actionOrFilterName != '.' && !self::$actionContext->actionNameEquals($actionOrFilterName)) {
62 |             return;
63 |         }
64 | 
65 |         if (!isset(self::$filters[$actionOrFilterName])) {
66 |             self::$filters[$actionOrFilterName] = array();
67 |         }
68 | 
69 |         self::$filters[$actionOrFilterName][] = $filterName;
70 |     }
71 | 
72 | }


--------------------------------------------------------------------------------
/src/OutputCacheLocation.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Specifies the valid values for controlling the location of the output-cached HTTP response for a resource.
30 |  */
31 | final class OutputCacheLocation {
32 | 
33 |     /**
34 |      * The output cache can be located on the browser client (where the request originated), on a proxy server (or any other server) participating in the request, or on the server where the request was processed.
35 |      * 
36 |     * @var int
37 |      */
38 |     const ANY = 0;
39 | 
40 |     /**
41 |      * The output cache is located on the browser client where the request originated.
42 |      * 
43 |     * @var int
44 |      */
45 |     const CLIENT = 1;
46 | 
47 |     /**
48 |      * The output cache can be stored in any HTTP 1.1 cache-capable devices other than the origin server.
49 |      * 
50 |     * @var int
51 |      */
52 |     const DOWNSTREAM = 2;
53 | 
54 |     /**
55 |      * The output cache is disabled for the requested page.
56 |      * 
57 |      * @var int
58 |      */
59 |     const NONE = 3;
60 | 
61 |     /**
62 |      * The output cache is located on the Web server where the request was processed.
63 |      * 
64 |      * @var int
65 |      */
66 |     const SERVER = 4;
67 | 
68 |     /**
69 |      * The output cache can be stored only at the origin server or at the requesting client.
70 |      * 
71 |      * @var int
72 |      */
73 |     const SERVER_AND_CLIENT = 5;
74 | 
75 | }


--------------------------------------------------------------------------------
/tests/HttpResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | use PhpMvc\HttpResponseBase;
 3 | 
 4 | final class HttpResponse extends HttpResponseBase {
 5 | 
 6 |     private $noOutputHeaders = false;
 7 | 
 8 |     public function __construct($noOutputHeaders = false) {
 9 |         $this->noOutputHeaders = $noOutputHeaders;
10 |     }
11 | 
12 |     public function setNoOutputHeaders($value) {
13 |         $this->noOutputHeaders = $value;
14 |     }
15 | 
16 |     /**
17 |      * Clears all headers and content output from the current response.
18 |      * 
19 |      * @return void
20 |      */
21 |     public function clear() {
22 |         $this->header = array();
23 |         $this->cookies = array();
24 |         $this->files = array();
25 |         $this->statusCode = null;
26 |         $this->statusDescription = null;
27 |         $this->output = '';
28 |     }
29 | 
30 |     /**
31 |      * Sends all currently buffered output to the client.
32 |      * 
33 |      * @return void
34 |      */
35 |     public function flush() {
36 |         $this->output();
37 |         parent::flush();
38 |     }
39 | 
40 |     /**
41 |      * Sends all currently buffered output to the client and stops execution of the requested process.
42 |      * 
43 |      * @return void
44 |      */
45 |     public function end() {
46 |         parent::preSend();
47 |         $this->output();
48 |         parent::end();
49 | 
50 |         $this->clear();
51 |     }
52 | 
53 |     private function output() {
54 |         if (!$this->outputStarted() && empty($this->files) && !$this->noOutputHeaders) {
55 |             // status code and message
56 |             if (!empty($this->statusCode) || !empty($this->statusDescription)) {
57 |                 $statusCode = $this->statusCode;
58 | 
59 |                 if (empty($statusCode)) {
60 |                     $statusCode = 200;
61 |                 }
62 | 
63 |                 echo 'HTTP/1.1 ' . $statusCode . ' ' . $this->statusDescription;
64 |             }
65 |             else {
66 |                 echo 'HTTP/1.1 200 OK';
67 |             }
68 | 
69 |             echo chr(10);
70 | 
71 |             // headers
72 |             foreach ($this->headers as $name => $value) {
73 |                 echo $name . ': ' . $value . chr(10);
74 |             }
75 | 
76 |             // cookies
77 |             foreach ($this->cookies as $cookie) {
78 |                 echo 'Set-Cookie: ' . implode('; ', $cookie) . chr(10);
79 |             }
80 | 
81 |             echo chr(10);
82 |         }
83 | 
84 |         // files
85 |         foreach ($this->files as $file) {
86 |             $fp = fopen($file, 'rb');
87 |             echo bin2hex(fread($fp, 10));
88 |             fclose($fp);
89 |         }
90 | 
91 |         // text
92 |         if (!empty($this->output)) {
93 |             echo $this->output;
94 |         }
95 |     }
96 | 
97 | }


--------------------------------------------------------------------------------
/src/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | require_once 'InternalHelper.php';
27 | require_once 'UrlParameter.php';
28 | require_once 'RouteOptions.php';
29 | require_once 'RouteCollection.php';
30 | require_once 'RouteSegment.php';
31 | require_once 'Route.php';
32 | require_once 'RouteProvider.php';
33 | require_once 'DefaultRouteProvider.php';
34 | require_once 'CacheProvider.php';
35 | require_once 'IdleCacheProvider.php';
36 | require_once 'HttpContextBase.php';
37 | require_once 'HttpRequestBase.php';
38 | require_once 'HttpResponseBase.php';
39 | require_once 'HttpSessionProvider.php';
40 | require_once 'HttpContextInfo.php';
41 | require_once 'HttpContext.php';
42 | require_once 'HttpRequest.php';
43 | require_once 'HttpResponse.php';
44 | require_once 'HttpSession.php';
45 | require_once 'EventArgs.php';
46 | require_once 'ErrorHandlerEventArgs.php';
47 | require_once 'Model.php';
48 | require_once 'Filter.php';
49 | require_once 'OutputCacheLocation.php';
50 | require_once 'OutputCache.php';
51 | require_once 'ValidateAntiForgeryToken.php';
52 | require_once 'ModelState.php';
53 | require_once 'ModelStateEntry.php';
54 | require_once 'AppContext.php';
55 | require_once 'ActionContext.php';
56 | require_once 'ActionResult.php';
57 | require_once 'ViewResult.php';
58 | require_once 'ViewContext.php';
59 | require_once 'PathUtility.php';
60 | require_once 'View.php';
61 | require_once 'Html.php';
62 | require_once 'ActionExecutingContext.php';
63 | require_once 'ActionExecutedContext.php';
64 | require_once 'AppBuilder.php';


--------------------------------------------------------------------------------
/src/ContentResult.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents a user-defined content type that is the result of an action method.
30 |  */
31 | class ContentResult implements ActionResult {
32 | 
33 |     /**
34 |      * Gets or sets the content.
35 |      * 
36 |      * @var mixed
37 |      */
38 |     private $content;
39 | 
40 |     /**
41 |      * Gets or sets the type of the content. For example: text/plain, text/html.
42 |      * 
43 |      * @var string
44 |      */
45 |     private $contentType;
46 |    
47 |     /**
48 |      * Initializes a new instance of ContentResult.
49 |      * 
50 |      * @param string $content The content.
51 |      * @param string $contentType The content type. Default: text/plain.
52 |      */
53 |     public function __construct($content, $contentType = 'text/plain') {
54 |         $this->content = $content;
55 |         $this->contentType = $contentType;
56 |     }
57 | 
58 |     /**
59 |      * Executes the action and outputs the result.
60 |      * 
61 |      * @param ActionContext $actionContext The context in which the result is executed.
62 |      * The context information includes information about the action that was executed and request information.
63 |      * 
64 |      * @return void
65 |      */
66 |     public function execute($actionContext) {
67 |         $response = $actionContext->getHttpContext()->getResponse();
68 |         $response->addHeader('Content-Type', (!empty($this->contentType) ? $this->contentType : 'text/plain'));
69 |         $response->write($this->content);
70 |         $response->end();
71 |     }
72 | 
73 | }


--------------------------------------------------------------------------------
/src/HttpStatusCodeResult.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Provides a way to return an action result with a specific HTTP response status code and description.
30 |  */
31 | class HttpStatusCodeResult implements ActionResult {
32 | 
33 |     /**
34 |      * Gets the HTTP status code.
35 |      * 
36 |      * @var int
37 |      */
38 |     private $statusCode;
39 | 
40 |     /**
41 |      * Gets the HTTP status description.
42 |      * 
43 |      * @var string
44 |      */
45 |     private $statusDescription;
46 | 
47 |     /**
48 |      * Initializes a new instance of HttpStatusCodeResult.
49 |      * 
50 |      * @param int $statusCode The HTTP status code.
51 |      * @param string $statusDescription The HTTP status description.
52 |      */
53 |     public function __construct($statusCode, $statusDescription = null) {
54 |         $this->statusCode = $statusCode;
55 |         $this->statusDescription = $statusDescription;
56 |     }
57 | 
58 |     /**
59 |      * Executes the action and outputs the result.
60 |      * 
61 |      * @param ActionContext $actionContext The context in which the result is executed.
62 |      * The context information includes information about the action that was executed and request information.
63 |      * 
64 |      * @return void
65 |      */
66 |     public function execute($actionContext) {
67 |         $response = $actionContext->getHttpContext()->getResponse();
68 |         $response->setStatusCode($this->statusCode);
69 |         $response->setStatusDescription($this->statusDescription);
70 |         $response->write($result);
71 |         $response->end();
72 |     }
73 | 
74 | }


--------------------------------------------------------------------------------
/src/ErrorHandlerEventArgs.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents the arguments to the error event handler.
30 |  */
31 | final class ErrorHandlerEventArgs extends EventArgs {
32 | 
33 |     /**
34 |      * Exception instance.
35 |      * 
36 |      * @var \Exception
37 |      */
38 |     private $exception;
39 | 
40 |     /**
41 |      * Indicates that the processing is done and you do not need to run other handlers, including the standard handler.
42 |      * 
43 |      * @var bool
44 |      */
45 |     private $handled = false;
46 | 
47 |     /**
48 |      * Initializes a new instance of ErrorHandlerEventArgs.
49 |      * 
50 |      * @param \Exception $exception The exception instance.
51 |      */
52 |     public function __construct($exception) {
53 |         $this->exception = $exception;
54 |     }
55 | 
56 |     /**
57 |      * Gets exception.
58 |      * 
59 |      * @return \Exception
60 |      */
61 |     public function getException() {
62 |         return $this->exception;
63 |     }
64 | 
65 |     /**
66 |      * Gets exception message.
67 |      * 
68 |      * @return string
69 |      */
70 |     public function getMessage() {
71 |         return $this->exception->getMessage();
72 |     }
73 | 
74 |     /**
75 |      * Gets handled status.
76 |      * 
77 |      * @return bool
78 |      */
79 |     public function getHandled() {
80 |         return $this->handled;
81 |     }
82 | 
83 |     /**
84 |      * Sets handled status.
85 |      * 
86 |      * @param bool $value
87 |      * 
88 |      * @return void
89 |      */
90 |     public function setHandled($value) {
91 |         $this->handled = $value;
92 |     }
93 | 
94 | }


--------------------------------------------------------------------------------
/src/ValidateAntiForgeryToken.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents methods for managing the AntiForgeryToken validation.
30 |  */
31 | final class ValidateAntiForgeryToken {
32 | 
33 |     /**
34 |      * Defines ActionContext.
35 |      * 
36 |      * @var ActionContext
37 |      */
38 |     private static $actionContext;
39 | 
40 |     /**
41 |      * Gets or sets mode.
42 |      * 
43 |      * @var bool|null
44 |      */
45 |     private static $enable = null;
46 | 
47 |     /**
48 |      * Disables verification for the specified action.
49 |      * 
50 |      * @param string $actionName Action name.
51 |      * 
52 |      * @return void
53 |      */
54 |     public static function disable($actionName = null) {
55 |         self::set($actionName, false);
56 |     }
57 | 
58 |     /**
59 |      * Enables verification for the specified action.
60 |      * 
61 |      * @param string $actionName Action name.
62 |      * 
63 |      * @return void
64 |      */
65 |     public static function enable($actionName = null) {
66 |         self::set($actionName, true);
67 |     }
68 | 
69 |     /**
70 |      * Sets verification mode for the specified action.
71 |      * 
72 |      * @param string $actionName Action name.
73 |      * @param bool $enable Enable (true) or disable (false) verification.
74 |      * 
75 |      * @return void
76 |      */
77 |     public static function set($actionName = null, $enable) {
78 |         $actionName = ($actionName === null ? '.' : $actionName);
79 | 
80 |         if ($actionName != '.' && !self::$actionContext->actionNameEquals($actionName)) {
81 |             return;
82 |         }
83 | 
84 |         self::$enable = $enable;
85 |     }
86 | 
87 | }


--------------------------------------------------------------------------------
/src/UrlHelper.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Helper class for building URI.
30 |  */
31 | final class UrlHelper {
32 | 
33 |     /**
34 |      * Generates a URL with an absolute path for an action method, which contains the
35 |      * action name, controller name, route values, protocol to use, host name, and fragment.
36 |      * Generates an absolute URL if $schema and $host are non-null.
37 |      * 
38 |      * @param ActionContext $actionContext The current context of the action.
39 |      * @param string $actionName The name of the action.
40 |      * @param string $controllerName The name of the controller. Default: current controller.
41 |      * @param array $routeValues An array that contains the parameters for a route.
42 |      * @param string $fragment The URL fragment name (the anchor name).
43 |      * @param string $schema The protocol for the URL, such as "http" or "https".
44 |      * @param string $host The host name for the URL.
45 |      * 
46 |      * @return string
47 |      */
48 |     public static function action($actionContext, $actionName, $controllerName = null, $routeValues = null, $fragment = null, $schema = null, $host = null) {
49 |         if (empty($actionContext) || !$actionContext instanceof ActionContext) {
50 |             throw new \Exception('The $actionContext is requred and type must be derived from "\PhpMvc\ActionContext".');
51 |         }
52 | 
53 |         if (empty($actionName)) {
54 |             $modelState->addError($key, '$actionName is required. Value must not be empty.');
55 |         }
56 | 
57 |         return $actionContext->getHttpContext()->tryBuildUrl($actionName, $controllerName, $routeValues, $fragment, $schema, $host);
58 |     }
59 | 
60 | }


--------------------------------------------------------------------------------
/tests/mvc/controllers/OutputCacheController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace PhpMvcTest\Controllers;
 3 | 
 4 | use \PhpMvc\OutputCache;
 5 | use \PhpMvc\OutputCacheLocation;
 6 | use \PhpMvc\Controller;
 7 | 
 8 | class OutputCacheController extends Controller {
 9 | 
10 |     public function __construct() {
11 |         OutputCache::setLocation('nocache', OutputCacheLocation::NONE);
12 | 
13 |         OutputCache::setDuration('duration10', 10);
14 | 
15 |         OutputCache::set('locationServer', 10, OutputCacheLocation::SERVER);
16 |         OutputCache::set('locationClient', 10, OutputCacheLocation::CLIENT);
17 |         OutputCache::set('locationServerAndClient', 10, OutputCacheLocation::SERVER_AND_CLIENT);
18 |         OutputCache::set('locationDownstream', 10, OutputCacheLocation::DOWNSTREAM);
19 | 
20 |         OutputCache::setVaryByParam('varyByParam', 'id');
21 |         OutputCache::setDuration('varyByParam', 30);
22 | 
23 |         OutputCache::set('varyByParam2', 30, OutputCacheLocation::ANY, 'id;abc');
24 | 
25 |         OutputCache::setVaryByHeader('VaryByHeader', 'User-Agent');
26 |         OutputCache::setDuration('varybyheader', 30);
27 | 
28 |         OutputCache::setVaryByCustom('VARYBYCUSTOM', function ($actionContext) {
29 |             $userLanguages = $actionContext->getHttpContext()->getRequest()->userLanguages();
30 | 
31 |             if (isset($userLanguages['en'])) {
32 |                 return true;
33 |             }
34 |             else {
35 |                 return false;
36 |             }
37 |         });
38 |         OutputCache::setDuration('varybyCustom', 30);
39 |     }
40 | 
41 |     public function index($time) {
42 |         return $this->content('time => ' . $time);
43 |     }
44 | 
45 |     public function nocache($time) {
46 |         return $this->content('time => ' . $time);
47 |     }
48 | 
49 |     public function duration10($time) {
50 |         return $this->content('time => ' . $time);
51 |     }
52 | 
53 |     public function locationServer($time) {
54 |         return $this->content('time => ' . $time);
55 |     }
56 | 
57 |     public function locationClient($time) {
58 |         return $this->content('time => ' . $time);
59 |     }
60 | 
61 |     public function locationServerAndClient($time) {
62 |         return $this->content('time => ' . $time);
63 |     }
64 | 
65 |     public function locationDownstream($time) {
66 |         return $this->content('time => ' . $time);
67 |     }
68 | 
69 |     public function varyByParam($id, $time) {
70 |         return $this->content($id . ' => ' . $time);
71 |     }
72 | 
73 |     public function varyByParam2($id, $abc, $time) {
74 |         return $this->content($id . ' => ' . $abc . ' => ' . $time);
75 |     }
76 | 
77 |     public function varyByHeader($id, $time) {
78 |         return $this->content($this->getRequest()->userAgent() . ' => ' . $time);
79 |     }
80 | 
81 |     public function varyByCustom() {
82 |         $languages = $this->getHttpContext()->getRequest()->userLanguages();
83 |         return $this->content($this->getRequest()->get('time'));
84 |     }
85 | 
86 | }


--------------------------------------------------------------------------------
/src/SelectListItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents an item (<option>) in a HTML <select>.
30 |  */
31 | class SelectListItem {
32 | 
33 |     /**
34 |      * Gets or sets a value that indicates the display text of this SelectListItem.
35 |      * 
36 |      * @var string
37 |      */
38 |     public $text;
39 | 
40 |     /**
41 |      *  Gets or sets a value of this SelectListItem.
42 |      * 
43 |      * @var string
44 |      */
45 |     public $value;
46 | 
47 |     /**
48 |      * Gets or sets a value that indicates whether this SelectListItem is selected.
49 |      * 
50 |      * @var bool
51 |      */
52 |     public $selected;
53 | 
54 |     /**
55 |      * Gets or sets a value that indicates whether this SelectListItem is disabled.
56 |      * 
57 |      * @var bool
58 |      */
59 |     public $disabled;
60 | 
61 |     /**
62 |      * Represents the optgroup HTML element this item is wrapped into.
63 |      * In a select list, multiple groups with the same name are supported.
64 |      * They are compared with reference equality.
65 |      * 
66 |      * @var SelectListGroup
67 |      */
68 |     public $group;
69 | 
70 |     /**
71 |      * Initializes a new instance of the SelectListItem.
72 |      * 
73 |      * @param string $text The display text of this SelectListItem.
74 |      * @param string $value The value of this SelectListItem.
75 |      * @param bool $selected The value that indicates whether this SelectListItem is selected.
76 |      * @param bool $disabled The value that indicates whether this SelectListItem is disabled.
77 |      * @param SelectListGroup $group Represents the optgroup HTML element this item is wrapped into.
78 |      */
79 |     public function __construct($text = null, $value = null, $selected = false, $disabled = false, $group = null) {
80 |         $this->text = $text;
81 |         $this->value = $value;
82 |         $this->selected = $selected;
83 |         $this->disabled = $disabled;
84 |         $this->group = $group;
85 |     }
86 | 
87 | }


--------------------------------------------------------------------------------
/src/HttpResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Encapsulates HTTP-response information.
30 |  */
31 | final class HttpResponse extends HttpResponseBase {
32 | 
33 |     /**
34 |      * Sends all currently buffered output to the client.
35 |      * 
36 |      * @return void
37 |      */
38 |     public function flush() {
39 |         $this->output();
40 |         parent::flush();
41 |     }
42 | 
43 |     /**
44 |      * Sends all currently buffered output to the client and stops execution of the requested process.
45 |      * 
46 |      * @return void
47 |      */
48 |     public function end() {
49 |         parent::preSend();
50 |         $this->output();
51 |         parent::end();
52 |         exit();
53 |     }
54 | 
55 |     private function output() {
56 |         if (!$this->outputStarted()) {
57 |             // status code and message
58 |             if (!empty($this->statusCode) || !empty($this->statusDescription)) {
59 |                 $statusCode = $this->statusCode;
60 | 
61 |                 if (empty($statusCode)) {
62 |                     $statusCode = 200;
63 |                 }
64 | 
65 |                 $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
66 |                 header($protocol . ' ' . $statusCode . ' ' . $this->statusDescription);
67 |                 $GLOBALS['http_response_code'] = $statusCode;
68 |             }
69 | 
70 |             // cookies
71 |             foreach ($this->cookies as $cookie) {
72 |                 call_user_func_array('setcookie', $cookie);
73 |             }
74 | 
75 |             // headers
76 |             foreach ($this->headers as $name => $value) {
77 |                 header($name . ': ' . $value);
78 |             }
79 |         }
80 | 
81 |         // files
82 |         foreach ($this->files as $file) {
83 |             $fp = fopen($file, 'rb');
84 |             fpassthru($fp);
85 |             fclose($fp);
86 |         }
87 | 
88 |         // text
89 |         if (!empty($this->output)) {
90 |             echo $this->output;
91 |         }
92 |     }
93 | 
94 | }


--------------------------------------------------------------------------------
/src/RedirectResult.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Controls the processing of application actions by redirecting to a specified URI.
30 |  */
31 | class RedirectResult implements ActionResult {
32 | 
33 |     /**
34 |      * Gets or sets the target URL.
35 |      * 
36 |      * @var string
37 |      */
38 |     protected $url;
39 | 
40 |     /**
41 |      * Gets or sets a value that indicates whether the redirection should be permanent.
42 |      * 
43 |      * @var bool
44 |      */
45 |     private $permanent;
46 | 
47 |     /**
48 |      * Gets or sets an indication that the redirect preserves the initial request method.
49 |      * 
50 |      * @var bool
51 |      */
52 |     private $preserveMethod;
53 | 
54 |     /**
55 |      * Initializes a new instance of RedirectResult.
56 |      * 
57 |      * @param int $url The target URL.
58 |      * @param bool $permanent A value that indicates whether the redirection should be permanent.
59 |      * @param bool $preserveMethod If set to true, make the temporary redirect (307) or permanent redirect (308) preserve the intial request method.
60 |      */
61 |     public function __construct($url, $permanent = false, $preserveMethod = false) {
62 |         $this->url = $url;
63 |         $this->permanent = $permanent;
64 |         $this->preserveMethod = $preserveMethod;
65 |     }
66 | 
67 |     /**
68 |      * Executes the action and outputs the result.
69 |      * 
70 |      * @param ActionContext $actionContext The context in which the result is executed.
71 |      * The context information includes information about the action that was executed and request information.
72 |      * 
73 |      * @return void
74 |      */
75 |     public function execute($actionContext) {
76 |         $response = $actionContext->getHttpContext()->getResponse();
77 | 
78 |         if ($this->permanent === true && $this->preserveMethod !== true) {
79 |             $response->setStatusCode(301);
80 |         }
81 |         elseif ($this->permanent !== true && $this->preserveMethod === true) {
82 |             $response->setStatusCode(307);
83 |         }
84 |         elseif ($this->permanent === true && $this->preserveMethod === true) {
85 |             $response->setStatusCode(308);
86 |         }
87 | 
88 |         $response->addHeader('Location', $this->url);
89 | 
90 |         $response->end();
91 |     }
92 | 
93 | }


--------------------------------------------------------------------------------
/src/JsonResult.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
 4 |  * 
 5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
 6 |  * 
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  * 
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  * 
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace PhpMvc;
27 | 
28 | /**
29 |  * Represents a class that is used to send JSON-formatted content to the response.
30 |  */
31 | class JsonResult implements ActionResult {
32 | 
33 |     /**
34 |      * Gets or sets the data.
35 |      * 
36 |      * @var mixed
37 |      */
38 |     public $data;
39 | 
40 |     /**
41 |      * Bitmask consisting of JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, 
42 |      * JSON_HEX_APOS, JSON_NUMERIC_CHECK, JSON_PRETTY_PRINT, 
43 |      * JSON_UNESCAPED_SLASHES, JSON_FORCE_OBJECT, 
44 |      * JSON_PRESERVE_ZERO_FRACTION, JSON_UNESCAPED_UNICODE, 
45 |      * JSON_PARTIAL_OUTPUT_ON_ERROR. 
46 |      */
47 |     public $options;
48 | 
49 |     /** 
50 |      * Gets or sets the maximum depth. Must be greater than zero.
51 |      */
52 |     public $depth;
53 | 
54 |     /**
55 |      * Initializes a new instance of JsonResult.
56 |      * 
57 |      * @param mixed $data Data to encode.
58 |      * @param int $options Bitmask consisting of JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, 
59 |      * JSON_HEX_APOS, JSON_NUMERIC_CHECK, JSON_PRETTY_PRINT, 
60 |      * JSON_UNESCAPED_SLASHES, JSON_FORCE_OBJECT, 
61 |      * JSON_PRESERVE_ZERO_FRACTION, JSON_UNESCAPED_UNICODE, 
62 |      * JSON_PARTIAL_OUTPUT_ON_ERROR. 
63 |      * @param int $depth Set the maximum depth. Must be greater than zero. Default: 512.
64 |      */
65 |     public function __construct($data, $options = 0, $depth = 512) {
66 |         $this->data = $data;
67 |         $this->options = $options;
68 |         $this->depth = $depth;
69 |     }
70 | 
71 |     /**
72 |      * Executes the action and outputs the result.
73 |      * 
74 |      * @param ActionContext $actionContext The context in which the result is executed.
75 |      * The context information includes information about the action that was executed and request information.
76 |      * 
77 |      * @return void
78 |      */
79 |     public function execute($actionContext) {
80 |         // make json and exit
81 |         if (($result = json_encode($this->data, $this->options, $this->depth)) === false) {
82 |             throw new \ErrorException('JSON encode error #' . json_last_error() . ': ' . json_last_error_msg());
83 |         }
84 | 
85 |         $response = $actionContext->getHttpContext()->getResponse();
86 |         $response->addHeader('Content-Type', 'application/json');
87 |         $response->write($result);
88 |         $response->end();
89 |     }
90 | 
91 | }


--------------------------------------------------------------------------------
/src/ViewResult.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Represents the properties and methods that are needed to render a view.
 30 |  */
 31 | class ViewResult implements ActionResult {
 32 | 
 33 |     /**
 34 |      * Gets or sets layout file.
 35 |      * 
 36 |      * @var string
 37 |      */
 38 |     public $layout;
 39 | 
 40 |     /**
 41 |      * Gets or sets view file.
 42 |      */
 43 |     public $viewFile = null;
 44 | 
 45 |     /**
 46 |      * Gets or sets page title.
 47 |      * 
 48 |      * @var string
 49 |      */
 50 |     public $title;
 51 | 
 52 |     /**
 53 |      * Gets or sets model.
 54 |      * 
 55 |      * @var mixed
 56 |      */
 57 |     public $model;
 58 | 
 59 |     /**
 60 |      * Gets or sets view data.
 61 |      */
 62 |     public $viewData = array();
 63 | 
 64 |     public function __construct($viewOrModel = null, $model = null, $layout = null) {
 65 |         if (gettype($viewOrModel) === 'string') {
 66 |             if (($path = PathUtility::getViewFilePath($viewOrModel)) !== false) {
 67 |                 $this->viewFile = $path;
 68 |             }
 69 |             else {
 70 |                 if (empty($model)) {
 71 |                     $model = $viewOrModel;
 72 |                 }
 73 |                 else {
 74 |                     throw new ViewNotFoundException($viewOrModel);
 75 |                 }
 76 |             }
 77 |         }
 78 |         else {
 79 |             if (empty($model)) {
 80 |                 $model = $viewOrModel;
 81 |             }
 82 |             else {
 83 |                 throw new \Exception('The $viewOrModel parameter must contain the name of the view or the model. If the $viewOrModel parameter contains a model, the $model parameter value must be null.');
 84 |             }
 85 |         }
 86 | 
 87 |         $this->model = $model;
 88 |         $this->layout = $layout;
 89 |     }
 90 | 
 91 |     /**
 92 |      * Executes the action and outputs the result.
 93 |      * 
 94 |      * @param ViewContext $viewContext The view context.
 95 |      * 
 96 |      * @return void
 97 |      */
 98 |     public function execute($viewContext) {
 99 |         !empty($this->title) ? $viewContext->title = $this->title : null;
100 |         !empty($this->viewFile) ? $viewContext->viewFile = PathUtility::getViewFilePath($this->viewFile) : null;
101 |         !empty($this->layout) ? $viewContext->layout = PathUtility::getViewFilePath($this->layout) : null;
102 |         !empty($this->model) ? $viewContext->model = $this->model : null;
103 | 
104 |         if (!empty($this->viewData)) {
105 |             $viewContext->viewData = array_unique(array_merge($viewContext->viewData, $this->viewData), \SORT_REGULAR);
106 |         }
107 |     }
108 | 
109 | }


--------------------------------------------------------------------------------
/src/FileResult.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Represents class that is used to send binary file content to the response.
 30 |  */
 31 | class FileResult implements ActionResult {
 32 | 
 33 |     /**
 34 |      * Gets or sets path to file for output to client.
 35 |      * 
 36 |      * @var string
 37 |      */
 38 |     public $path;
 39 | 
 40 |     /**
 41 |      * Gets the content type to use for the response.
 42 |      * 
 43 |      * @var string
 44 |      */
 45 |     public $contentType;
 46 | 
 47 |     /**
 48 |      * Gets or sets the content-disposition header so that a file-download dialog box is displayed in the browser with the specified file name.
 49 |      * 
 50 |      * @var string
 51 |      */
 52 |     public $downloadName;
 53 |    
 54 |     /**
 55 |      * Initializes a new instance of FileResult.
 56 |      * 
 57 |      * @param string $path The file path to output.
 58 |      * @param string $contentType The content type.
 59 |      * @param string|bool $downloadName the content-disposition header so that a file-download dialog box is displayed in the browser with the specified file name.
 60 |      */
 61 |     public function __construct($path, $contentType = null, $downloadName = null) {
 62 |         $this->path = $path;
 63 |         $this->contentType = $contentType;
 64 |         $this->downloadName = $downloadName;
 65 | 
 66 |         if ($downloadName === true) {
 67 |             $downloadName = basename($this->path);
 68 |         }
 69 |     }
 70 |     
 71 |     /**
 72 |      * Executes the action and outputs the result.
 73 |      * 
 74 |      * @param ActionContext $actionContext The context in which the result is executed.
 75 |      * The context information includes information about the action that was executed and request information.
 76 |      * 
 77 |      * @return void
 78 |      */
 79 |     public function execute($actionContext) {
 80 |         if (($path = PathUtility::getFilePath($this->path)) === false) {
 81 |             throw new \Exception('File "' . $this->path . '" not found.');
 82 |         }
 83 | 
 84 |         if (empty($this->contentType) && function_exists('finfo_open') && ($fi = finfo_file(finfo_open(\FILEINFO_MIME_TYPE), $path) !== false)) {
 85 |             $this->contentType = $fi;
 86 |         }
 87 | 
 88 |         $response = $actionContext->getHttpContext()->getResponse();
 89 |         $response->addHeader('Content-Type', (!empty($this->contentType) ? $this->contentType : 'application/octet-stream'));
 90 |         $response->addHeader('Content-Length', filesize($path));
 91 | 
 92 |         if (!empty($this->downloadName)) {
 93 |             $response->addHeader('Content-Disposition', 'attachment; filename="' . $this->downloadName . '"');
 94 |         }
 95 | 
 96 |         $response->writeFile($path);
 97 | 
 98 |         $response->end();
 99 |     }
100 | 
101 | }


--------------------------------------------------------------------------------
/tests/UrlHelperTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | require_once 'HttpContext.php';
  5 | 
  6 | use PHPUnit\Framework\TestCase;
  7 | 
  8 | use PhpMvc\DefaultRouteProvider;
  9 | use PhpMvc\RouteCollection;
 10 | use PhpMvc\ActionContext;
 11 | use PhpMvc\UrlParameter;
 12 | use PhpMvc\ViewContext;
 13 | use PhpMvc\UrlHelper;
 14 | use PhpMvc\Route;
 15 | 
 16 | final class UrlHelperTest extends TestCase
 17 | {
 18 | 
 19 |     public function testAction(): void
 20 |     {
 21 |         echo chr(10);
 22 | 
 23 |         $routes = new DefaultRouteProvider();
 24 | 
 25 |         $routes->add('strange', 'test/abc/aaa/{action=1123}/ffff', array('controller' => 'home'));
 26 |         $routes->add('anyname', 'alibaba/the', array('controller' => 'abc', 'action' => 'kaadabrov'));
 27 |         $routes->add('test', 'testovich/{action=index}/{id?}', array('controller' => 'abc'));
 28 | 
 29 |         $routes->add(
 30 |             'news', 
 31 |             '{yyyy}-{mm}-{dd}/{id}', 
 32 |             array(
 33 |                 'controller' => 'news',
 34 |                 'action' => 'show'
 35 |             ),
 36 |             array(
 37 |                 'yyyy' => '\d{4}',
 38 |                 'mm' => '([0]{1}[1-9]{1})|([1]{1}[0-2]{1})',
 39 |                 'dd' => '[0-3]{1}[0-9]{1}',
 40 |                 'id' => '\d+'
 41 |             )
 42 |         );
 43 | 
 44 |         $routes->add('default', '{controller=Test}/{action=index}/{id?}');
 45 | 
 46 |         $httpContext = HttpContext::get('test/abc/aaa/aaaaa/ffff')->setRoutes($routes);
 47 | 
 48 |         $actionContext = new ActionContext($httpContext);
 49 | 
 50 |         $this->assertEquals(
 51 |             '/test/abc/aaa/bbbbb/ffff',
 52 |             $result = UrlHelper::action($actionContext, 'bbbbb')
 53 |         );
 54 | 
 55 |         echo $result . ' - OK' . chr(10);
 56 | 
 57 |         $httpContext = HttpContext::get('https://example.org/abcdef/test')->setRoutes($routes);
 58 | 
 59 |         $actionContext = new ActionContext($httpContext);
 60 | 
 61 |         $this->assertEquals(
 62 |             '/abcdef',
 63 |             $result = UrlHelper::action($actionContext, 'index')
 64 |         );
 65 | 
 66 |         echo $result . ' - OK' . chr(10);
 67 | 
 68 |         $this->assertEquals(
 69 |             'https://example.org/abcdef#test',
 70 |             $result = UrlHelper::action($actionContext, 'index', null, null, 'test', 'https', 'example.org')
 71 |         );
 72 | 
 73 |         echo $result . ' - OK' . chr(10);
 74 | 
 75 |         $this->assertEquals(
 76 |             'https://example.org/abcdef',
 77 |             $result = UrlHelper::action($actionContext, 'index', null, null, null, null, 'example.org')
 78 |         );
 79 | 
 80 |         echo $result . ' - OK' . chr(10);
 81 | 
 82 |         $this->assertEquals(
 83 |             'git://example.org/abcdef',
 84 |             $result = UrlHelper::action($actionContext, 'index', null, null, null, 'git')
 85 |         );
 86 | 
 87 |         echo $result . ' - OK' . chr(10);
 88 | 
 89 |         $this->assertEquals(
 90 |             '/abcdef/page/123?text=hello+world%21&n=555',
 91 |             $result = UrlHelper::action(
 92 |                 $actionContext, 
 93 |                 'page', 
 94 |                 null, 
 95 |                 array(
 96 |                     'id' => 123, 
 97 |                     'text' => 'hello world!', 
 98 |                     'n' => 555
 99 |                 )
100 |             )
101 |         );
102 | 
103 |         echo $result . ' - OK' . chr(10);
104 | 
105 |         $this->assertEquals(
106 |             '/testovich',
107 |             $result = UrlHelper::action($actionContext, 'index', 'abc')
108 |         );
109 | 
110 |         echo $result . ' - OK' . chr(10);
111 | 
112 |         $this->assertEquals(
113 |             '/testovich/examplovich', 
114 |             $result = UrlHelper::action($actionContext, 'examplovich', 'abc')
115 |         );
116 | 
117 |         echo $result . ' - OK' . chr(10);
118 | 
119 |         $this->assertEquals(
120 |             '/alibaba/the', 
121 |             $result = UrlHelper::action($actionContext, 'kaadabrov', 'abc')
122 |         );
123 | 
124 |         echo $result . ' - OK' . chr(10);
125 |     }
126 | 
127 | }


--------------------------------------------------------------------------------
/src/ExceptionContext.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Provides the context for the exception() method of the ActionFilter class.
 30 |  */
 31 | final class ExceptionContext extends ActionContext {
 32 | 
 33 |     /**
 34 |      * Gets or sets the result that is returned by the action method.
 35 |      * 
 36 |      * @var ActionResult
 37 |      */
 38 |     private $result;
 39 | 
 40 |     /**
 41 |      * Gets or sets the exception that occurred during the execution of the action method, if any.
 42 |      * 
 43 |      * @var \Exception
 44 |      */
 45 |     private $exception;
 46 | 
 47 |     /**
 48 |      * Gets or sets a value that indicates whether the exception has been handled.
 49 |      * 
 50 |      * @var bool
 51 |      */
 52 |     private $exceptionHandled;
 53 | 
 54 |     /**
 55 |      * Initializes a new instance of the ActionExecutedContext.
 56 |      * 
 57 |      * @param Controller $controller An instance of the controller.
 58 |      * @param \Exception $exception The instance of exception.
 59 |      */
 60 |     public function __construct($controller, $exception) {
 61 |         parent::__construct($controller);
 62 | 
 63 |         $this->exception = $exception;
 64 |         $this->exceptionHandled = false;
 65 |     }
 66 | 
 67 |     /**
 68 |      * Gets the result that is returned by the action method.
 69 |      * 
 70 |      * @return void
 71 |      */
 72 |     public function getResult() {
 73 |         return $this->result;
 74 |     }
 75 | 
 76 |     /**
 77 |      * Sets the result that is returned by the action method.
 78 |      * 
 79 |      * @param mixed $value The result to set.
 80 |      * 
 81 |      * @return void
 82 |      */
 83 |     public function setResult($value) {
 84 |         $this->result = $value;
 85 |     }
 86 | 
 87 |     /**
 88 |      * Gets the exception that occurred during the execution of the action method, if any.
 89 |      * 
 90 |      * @return \Exception
 91 |      */
 92 |     public function getException() {
 93 |         return $this->exception;
 94 |     }
 95 | 
 96 |     /**
 97 |      * Sets the exception that occurred during the execution of the action method, if any.
 98 |      * 
 99 |      * @param \Exception $exception Exception to set.
100 |      * 
101 |      * @return void
102 |      */
103 |     public function setException($exception) {
104 |         $this->exception = $exception;
105 |     }
106 | 
107 |     /**
108 |      * Gets a value that indicates whether the exception has been handled.
109 |      * 
110 |      * @return bool
111 |      */
112 |     public function getExceptionHandled() {
113 |         return $this->exceptionHandled;
114 |     }
115 | 
116 |     /**
117 |      * Sets a value that indicates whether the exception has been handled.
118 |      * 
119 |      * @var void
120 |      */
121 |     public function setExceptionHandled($value) {
122 |         $this->exceptionHandled = $value;
123 |     }
124 | 
125 | }


--------------------------------------------------------------------------------
/src/CacheProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Defines the contract that represents the cache provider.
 30 |  */
 31 | interface CacheProvider {
 32 | 
 33 |     /**
 34 |      * Inserts a cache entry into the cache.
 35 |      * 
 36 |      * @param string $key A unique identifier for the cache entry.
 37 |      * @param mixed|callback $value The value to insert.
 38 |      * @param int $duration The duration of storage the cache entry (in seconds).
 39 |      * @param string $regionName A named region in the cache to which the cache entry can be added.
 40 |      * 
 41 |      * @return void
 42 |      */
 43 |     function add($key, $value, $duration, $regionName = null);
 44 | 
 45 |     /**
 46 |      * Removes all cache entries.
 47 |      * 
 48 |      * @param string $regionName A name of region.
 49 |      * 
 50 |      * @return int Number of deleted records.
 51 |      */
 52 |     function clear($regionName = null);
 53 | 
 54 |     /**
 55 |      * Checks whether the cache entry already exists in the cache.
 56 |      * 
 57 |      * @param string $key A unique identifier for the cache entry.
 58 |      * @param string $regionName A name of region.
 59 |      * 
 60 |      * @return bool
 61 |      */
 62 |     function contains($key, $regionName = null);
 63 | 
 64 |     /**
 65 |      * Gets the total number of cache entries in the cache.
 66 |      * 
 67 |      * @param string $regionName A name of region.
 68 |      * 
 69 |      * @return int
 70 |      */
 71 |     function count($regionName = null);
 72 | 
 73 |     /**
 74 |      * Initializes the provider.
 75 |      * 
 76 |      * @return void
 77 |      */
 78 |     function init();
 79 | 
 80 |     /**
 81 |      * Gets the specified cache entry from the cache as an object.
 82 |      * 
 83 |      * @param string $key A unique identifier for the cache entry.
 84 |      * @param string $regionName A name of region.
 85 |      * 
 86 |      * @return mixed
 87 |      */
 88 |     function get($key, $regionName = null);
 89 | 
 90 |     /**
 91 |      * Gets a cache entry, or adds it if there is no cache entry.
 92 |      * 
 93 |      * @param string $key A unique identifier for the cache entry.
 94 |      * @param mixed|callback $value The value to insert.
 95 |      * @param int $duration The duration of storage the cache entry (in seconds).
 96 |      * @param string $regionName A name of region.
 97 |      * 
 98 |      * @return mixed
 99 |      */
100 |     function getOrAdd($key, $value, $duration, $regionName = null);
101 | 
102 |     /**
103 |      * Removes the cache entry from the cache.
104 |      * 
105 |      * @param string $key A unique identifier for the cache entry.
106 |      * @param string $regionName A name of region.
107 |      * 
108 |      * @return mixed An object that represents the value of the removed cache entry that was specified by the key,
109 |      * or null if the specified entry was not found.
110 |      */
111 |     function remove($key, $regionName = null);
112 | 
113 | }


--------------------------------------------------------------------------------
/tests/mvc/controllers/HomeController.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace PhpMvcTest\Controllers;
  3 | 
  4 | use \PhpMvc\View;
  5 | use \PhpMvc\Controller;
  6 | use \PhpMvc\ViewResult;
  7 | 
  8 | use \PhpMvcTest\Models\HomePage;
  9 | 
 10 | class HomeController extends Controller {
 11 | 
 12 |     public function __construct() {
 13 |         return $this->content('It\'s not safe!');
 14 |     }
 15 | 
 16 |     public function index($id) {
 17 |         $model = new HomePage();
 18 |         
 19 |         $model->title = 'Hello world!';
 20 |         $model->text = 'This data is transferred to the view through the model!';
 21 |         $model->number = 123;
 22 | 
 23 |         return $this->view($model);
 24 |     }
 25 | 
 26 |     public function makeView() {
 27 |         $view = new ViewResult();
 28 | 
 29 |         $view->viewFile = 'prog';
 30 |         $view->title = 'The view is created programmatically';
 31 |         $view->layout = '_default';
 32 | 
 33 |         $model = new HomePage();
 34 | 
 35 |         $model->title = 'World hello!';
 36 |         $model->text = 'The model contains text.';
 37 |         $model->number = 321;
 38 | 
 39 |         $view->model = $model;
 40 | 
 41 |         $view->viewData['key1'] = 'value1';
 42 |         $view->viewData['key2'] = 'value2';
 43 |         $view->viewData['key3'] = 'value3';
 44 | 
 45 |         return $view;
 46 |     }
 47 | 
 48 |     public function specifiedView() {
 49 |         return $this->view('hello', 'Test message passed to the view file "hello.php" from the action method "specifiedView".', '_lite');
 50 |     }
 51 | 
 52 |     public function setGetData() {
 53 |         $this->setData('key', 'value');
 54 |         $this->setData('message', 'Hello world!');
 55 |         $this->setData('option', true);
 56 |         $this->setData('int', 123);
 57 | 
 58 |         return $this->view('index');
 59 |     }
 60 | 
 61 |     public function differentWaysViewData() {
 62 |         $this->setData('setData', 'Hello setData!');
 63 |         $this->setData('setData2', 'Hello setData2!');
 64 | 
 65 |         $view = new ViewResult();
 66 | 
 67 |         $view->viewFile = '~/views/home/index.php';
 68 |         $view->layout = '_default';
 69 | 
 70 |         $view->viewData['viewData'] = 'Hello viewData!';
 71 |         $view->viewData['viewData2'] = 'Hello viewData2!';
 72 |         $view->viewData['setData2'] = 'Replaced setData2!';
 73 | 
 74 |         // TODO: one common collection of data is needed
 75 |         $this->setData('viewData2', 'This change will be ignored');
 76 | 
 77 |         return $view;
 78 |     }
 79 | 
 80 |     public function noViewFile() {
 81 |         return $this->view();
 82 |     }
 83 | 
 84 |     public function jsonData() {
 85 |         $data = array(1, 2, 3, 4, 5);
 86 | 
 87 |         return $this->json($data);
 88 |     }
 89 | 
 90 |     public function getContent() {
 91 |         return $this->content('This is plain text', 'text/plain');
 92 |     }
 93 | 
 94 |     public function string() {
 95 |         return 'hello world!';
 96 |     }
 97 | 
 98 |     public function arr() {
 99 |         return array(1, 2, 3, 4, 5);
100 |     }
101 | 
102 |     public function obj() {
103 |         $model = new HomePage();
104 | 
105 |         $model->title = 'Object result';
106 |         $model->text = 'This object will be returned in JSON format!';
107 |         $model->number = 555;
108 | 
109 |         return $model;
110 |     }
111 | 
112 |     public function getImage($download = false) {
113 |         if ($download) {
114 |             return $this->file('~/content/images/php.png', 'image/png', true);
115 |         }
116 |         else {
117 |             return $this->file('~/content/images/php.png', 'image/png');
118 |         }
119 |     }
120 | 
121 |     public function layoutWithParent() {
122 |         $view = new ViewResult();
123 | 
124 |         $view->viewFile = 'prog';
125 |         $view->title = 'The view is created programmatically';
126 |         $view->layout = '_parent';
127 | 
128 |         $model = new HomePage();
129 | 
130 |         $model->title = 'Hello work!';
131 |         $model->text = 'The model contains text.';
132 |         $model->number = 42;
133 | 
134 |         $view->model = $model;
135 | 
136 |         return $view;
137 |     }
138 | 
139 |     public function justModel($m) {
140 |         return $this->view('index');
141 |     }
142 | 
143 | }


--------------------------------------------------------------------------------
/tests/PathUtilityTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | use PHPUnit\Framework\TestCase;
 5 | 
 6 | use PhpMvc\PathUtility;
 7 | 
 8 | final class PathUtilityTest extends TestCase
 9 | {
10 | 
11 |     protected $preserveGlobalState = FALSE;
12 | 
13 |     protected $runTestInSeparateProcess = TRUE;
14 | 
15 |     public function __construct($name = null, array $data = [], $dataName = '')
16 |     {
17 |         parent::__construct($name, $data, $dataName);
18 | 
19 |         if (!defined('PHPMVC_ROOT_PATH')) {
20 |             $basePath = getcwd() . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'mvc';
21 | 
22 |             define('PHPMVC_ROOT_PATH', $basePath . DIRECTORY_SEPARATOR);
23 |             define('PHPMVC_DS', DIRECTORY_SEPARATOR);
24 |         }
25 |         
26 |     }
27 | 
28 |     public function testMapPath(): void
29 |     {
30 |         $this->assertEquals(PHPMVC_ROOT_PATH, PathUtility::mapPath());
31 |         $this->assertEquals(PHPMVC_ROOT_PATH, PathUtility::mapPath('~'));
32 |         $this->assertEquals(PHPMVC_ROOT_PATH, PathUtility::mapPath('~/'));
33 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home', PathUtility::mapPath('~/views/home'));
34 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home' . DIRECTORY_SEPARATOR . 'index.php', PathUtility::mapPath('~/views/home/index.php'));
35 |         $this->assertEquals(PHPMVC_ROOT_PATH, PathUtility::mapPath('/'));
36 |         $this->assertEquals(dirname(PHPMVC_ROOT_PATH), PathUtility::mapPath('../'));
37 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::mapPath('/index.php'));
38 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::mapPath('~/index.php'));
39 |     }
40 | 
41 |     public function testGetFilePath(): void
42 |     {
43 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::getFilePath('index.php'));
44 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::getFilePath('~index.php'));
45 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::getFilePath('~/index.php'));
46 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::getFilePath('/index.php'));
47 | 
48 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::getFilePath('index'));
49 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::getFilePath('~index'));
50 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::getFilePath('~/index'));
51 |         $this->assertEquals(PHPMVC_ROOT_PATH . 'index.php', PathUtility::getFilePath('/index'));
52 | 
53 |         $this->assertEquals(
54 |             PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home' . DIRECTORY_SEPARATOR . 'index.php', 
55 |             PathUtility::getFilePath('views/home/index.php')
56 |         );
57 |         $this->assertEquals(
58 |             PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home' . DIRECTORY_SEPARATOR . 'index.php',
59 |             PathUtility::getFilePath('~views/home/index.php')
60 |         );
61 |         $this->assertEquals(
62 |             PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home' . DIRECTORY_SEPARATOR . 'index.php',
63 |             PathUtility::getFilePath('~/views/home/index.php')
64 |         );
65 |         $this->assertEquals(
66 |             PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home' . DIRECTORY_SEPARATOR . 'index.php',
67 |             PathUtility::getFilePath('/views/home/index.php')
68 |         );
69 | 
70 |         $this->assertEquals(
71 |             PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home' . DIRECTORY_SEPARATOR . 'index.php', 
72 |             PathUtility::getFilePath('views/home/index')
73 |         );
74 |         $this->assertEquals(
75 |             PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home' . DIRECTORY_SEPARATOR . 'index.php',
76 |             PathUtility::getFilePath('~views/home/index')
77 |         );
78 |         $this->assertEquals(
79 |             PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home' . DIRECTORY_SEPARATOR . 'index.php',
80 |             PathUtility::getFilePath('~/views/home/index')
81 |         );
82 |         $this->assertEquals(
83 |             PHPMVC_ROOT_PATH . 'views' . DIRECTORY_SEPARATOR . 'home' . DIRECTORY_SEPARATOR . 'index.php',
84 |             PathUtility::getFilePath('/views/home/index')
85 |         );
86 |     }
87 | 
88 | }


--------------------------------------------------------------------------------
/src/ActionExecutedContext.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Provides the context for the actionExecuted method of the ActionFilter class.
 30 |  */
 31 | final class ActionExecutedContext extends ActionContext {
 32 | 
 33 |     /**
 34 |      * Gets or sets the result that is returned by the action method.
 35 |      * 
 36 |      * @var ActionResult
 37 |      */
 38 |     private $result;
 39 | 
 40 |     /**
 41 |      * Gets or sets the exception that occurred during the execution of the action method, if any.
 42 |      * 
 43 |      * @var \Exception
 44 |      */
 45 |     private $exception;
 46 | 
 47 |     /**
 48 |      * Gets or sets a value that indicates whether the exception has been handled.
 49 |      * 
 50 |      * @var bool
 51 |      */
 52 |     private $exceptionHandled;
 53 | 
 54 |     /**
 55 |      * Initializes a new instance of the ActionExecutedContext.
 56 |      * 
 57 |      * @param ActionContext $actionContext The context of the action.
 58 |      * @param ActionResult $result The action result.
 59 |      * @param exceptionContext $exceptionContext The context of exception, if there was an exception.
 60 |      */
 61 |     public function __construct($actionContext, $result, $exceptionContext) {
 62 |         parent::__construct($actionContext);
 63 | 
 64 |         $this->result = $result;
 65 | 
 66 |         if ($exceptionContext !== null) {
 67 |             $this->exception = $exceptionContext->getException();
 68 |             $this->exceptionHandled = $exceptionContext->getExceptionHandled();
 69 |         }
 70 |     }
 71 | 
 72 |     /**
 73 |      * Gets the result that is returned by the action method.
 74 |      * 
 75 |      * @return void
 76 |      */
 77 |     public function getResult() {
 78 |         return $this->result;
 79 |     }
 80 | 
 81 |     /**
 82 |      * Sets the result that is returned by the action method.
 83 |      * 
 84 |      * @param mixed $value The result to set.
 85 |      * 
 86 |      * @return void
 87 |      */
 88 |     public function setResult($value) {
 89 |         $this->result = $value;
 90 |     }
 91 | 
 92 |     /**
 93 |      * Gets the exception that occurred during the execution of the action method, if any.
 94 |      * 
 95 |      * @return \Exception
 96 |      */
 97 |     public function getException() {
 98 |         return $this->exception;
 99 |     }
100 | 
101 |     /**
102 |      * Sets the exception that occurred during the execution of the action method, if any.
103 |      * 
104 |      * @param \Exception $exception Exception to set.
105 |      * 
106 |      * @return void
107 |      */
108 |     public function setException($exception) {
109 |         $this->exception = $exception;
110 |     }
111 | 
112 |     /**
113 |      * Gets a value that indicates whether the exception has been handled.
114 |      * 
115 |      * @return bool
116 |      */
117 |     public function getExceptionHandled() {
118 |         return $this->exceptionHandled;
119 |     }
120 | 
121 |     /**
122 |      * Sets a value that indicates whether the exception has been handled.
123 |      * 
124 |      * @var void
125 |      */
126 |     public function setExceptionHandled($value) {
127 |         $this->exceptionHandled = $value;
128 |     }
129 | 
130 | }


--------------------------------------------------------------------------------
/src/RedirectToActionResult.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * An ActionResult that returns a Found (302), 
 30 |  * Moved Permanently (301), Temporary Redirect (307), 
 31 |  * or Permanent Redirect (308) response with a Location header. 
 32 |  * Targets a controller action.
 33 |  */
 34 | class RedirectToActionResult extends RedirectResult {
 35 | 
 36 |     /**
 37 |      * Gets or sets the name of the action to use for generating the URL.
 38 |      * 
 39 |      * @var string
 40 |      */
 41 |     private $actionName;
 42 | 
 43 |     /**
 44 |      * Gets or sets the name of the controller to use for generating the URL.
 45 |      * 
 46 |      * @var string
 47 |      */
 48 |     private $controllerName;
 49 | 
 50 |     /**
 51 |      * Gets or sets the route data to use for generating the URL.
 52 |      * 
 53 |      * @var array
 54 |      */
 55 |     private $routeValues;
 56 | 
 57 |     /**
 58 |      * Gets or sets the fragment to add to the URL.
 59 |      * 
 60 |      * @var string
 61 |      */
 62 |     private $fragment;
 63 | 
 64 |     /**
 65 |      * Gets or sets a value that indicates whether the redirection should be permanent.
 66 |      * 
 67 |      * @var bool
 68 |      */
 69 |     private $permanent;
 70 | 
 71 |     /**
 72 |      * Gets or sets an indication that the redirect preserves the initial request method.
 73 |      * 
 74 |      * @var bool
 75 |      */
 76 |     private $preserveMethod;
 77 | 
 78 |     /**
 79 |      * Initializes a new instance of RedirectToActionResult.
 80 |      * 
 81 |      * @param string $actionName The name of the action to use for generating the URL.
 82 |      * @param string $controllerName The name of the controller to use for generating the URL.
 83 |      * @param array $routeValues The route data to use for generating the URL.
 84 |      * @param string $fragment The fragment to add to the URL.
 85 |      * @param bool $permanent A value that indicates whether the redirection should be permanent.
 86 |      * @param bool $preserveMethod If set to true, make the temporary redirect (307) or permanent redirect (308) preserve the intial request method.
 87 |      */
 88 |     public function __construct($actionName, $controllerName = null, $routeValues = null, $fragment = null, $permanent = false, $preserveMethod = false) {
 89 |         parent::__construct(null, $permanent, $preserveMethod);
 90 | 
 91 |         $this->actionName = !empty($actionName) ? $actionName : PHPMVC_ACTION;
 92 |         $this->controllerName = !empty($controllerName) ? $controllerName : PHPMVC_VIEW;
 93 |         $this->routeValues = $routeValues;
 94 |         $this->fragment = $fragment;
 95 |     }
 96 | 
 97 |     /**
 98 |      * Executes the action and outputs the result.
 99 |      * 
100 |      * @param ActionContext $actionContext The context in which the result is executed.
101 |      * The context information includes information about the action that was executed and request information.
102 |      * 
103 |      * @return void
104 |      */
105 |     public function execute($actionContext) {
106 |         $this->url = UrlHelper::action($actionContext, $this->actionName, $this->controllerName, $this->routeValues, $this->fragment);
107 |         parent::execute($actionContext);
108 |     }
109 | 
110 | }


--------------------------------------------------------------------------------
/src/IdleCacheProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Represents a cache provider that does nothing.
 30 |  */
 31 | final class IdleCacheProvider implements CacheProvider {
 32 | 
 33 |     /**
 34 |      * Inserts a cache entry into the cache.
 35 |      * 
 36 |      * @param string $key A unique identifier for the cache entry.
 37 |      * @param mixed|callback $value The value to insert.
 38 |      * @param int $duration The duration of storage the cache entry (in seconds).
 39 |      * @param string $regionName A named region in the cache to which the cache entry can be added.
 40 |      * 
 41 |      * @return void
 42 |      */
 43 |     public function add($key, $value, $duration, $regionName = null) {
 44 |     }
 45 | 
 46 |     /**
 47 |      * Removes all cache entries.
 48 |      * 
 49 |      * @param string $regionName A name of region.
 50 |      * 
 51 |      * @return int Number of deleted records.
 52 |      */
 53 |     public function clear($regionName = null) {
 54 |         return 0;
 55 |     }
 56 | 
 57 |     /**
 58 |      * Checks whether the cache entry already exists in the cache.
 59 |      * 
 60 |      * @param string $key A unique identifier for the cache entry.
 61 |      * @param string $regionName A name of region.
 62 |      * 
 63 |      * @return bool
 64 |      */
 65 |     public function contains($key, $regionName = null) {
 66 |         return false;
 67 |     }
 68 | 
 69 |     /**
 70 |      * Gets the total number of cache entries in the cache.
 71 |      * 
 72 |      * @param string $regionName A name of region.
 73 |      * 
 74 |      * @return int
 75 |      */
 76 |     public function count($regionName = null) {
 77 |         return 0;
 78 |     }
 79 | 
 80 |     /**
 81 |      * Initializes the provider.
 82 |      * 
 83 |      * @return void
 84 |      */
 85 |     public function init() {
 86 |     }
 87 | 
 88 |     /**
 89 |      * Gets the specified cache entry from the cache as an object.
 90 |      * 
 91 |      * @param string $key A unique identifier for the cache entry.
 92 |      * @param string $regionName A name of region.
 93 |      * 
 94 |      * @return mixed
 95 |      */
 96 |     public function get($key, $regionName = null) {
 97 |         return null;
 98 |     }
 99 | 
100 |     /**
101 |      * Gets a cache entry, or adds it if there is no cache entry.
102 |      * 
103 |      * @param string $key A unique identifier for the cache entry.
104 |      * @param mixed|callback $value The value to insert.
105 |      * @param int $duration The duration of storage the cache entry (in seconds).
106 |      * @param string $regionName A name of region.
107 |      * 
108 |      * @return mixed
109 |      */
110 |     public function getOrAdd($key, $value, $duration, $regionName = null) {
111 |         if (is_callable($value) === true) {
112 |             return $value();
113 |         }
114 |         else {
115 |             return $value;
116 |         }
117 |     }
118 | 
119 |     /**
120 |      * Removes the cache entry from the cache.
121 |      * 
122 |      * @param string $key A unique identifier for the cache entry.
123 |      * @param string $regionName A name of region.
124 |      * 
125 |      * @return mixed An object that represents the value of the removed cache entry that was specified by the key,
126 |      * or null if the specified entry was not found.
127 |      */
128 |     public function remove($key, $regionName = null) {
129 |         return null;
130 |     }
131 | 
132 | }


--------------------------------------------------------------------------------
/src/Cache.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Represents the cache.
 30 |  */
 31 | final class Cache {
 32 | 
 33 |     /**
 34 |      * Gets or sets cache provider.
 35 |      * 
 36 |      * @var CacheProvider
 37 |      */
 38 |     private $provider = null;
 39 | 
 40 |     /**
 41 |      * Initializes a new instance of the Cache class.
 42 |      * 
 43 |      * @param CacheProvider $provider The cache provider instance.
 44 |      */
 45 |     public function __construct($provider) {
 46 |         if (!isset($provider) || !$provider instanceof CacheProvider) {
 47 |             throw new \Exception('The type of $provider must not be null and must implement the "\PhpMvc\CacheProvider".');
 48 |         }
 49 | 
 50 |         $this->provider = $provider;
 51 |     }
 52 | 
 53 |     /**
 54 |      * Inserts a cache entry into the cache.
 55 |      * 
 56 |      * @param string $key A unique identifier for the cache entry.
 57 |      * @param mixed|callback $value The value to insert.
 58 |      * @param int $duration The duration of storage the cache entry (in seconds).
 59 |      * @param string $regionName A named region in the cache to which the cache entry can be added.
 60 |      * 
 61 |      * @return void
 62 |      */
 63 |     public function add($key, $value, $duration, $regionName = null) {
 64 |         $this->provider->add($key, $value, $duration, $regionName);
 65 |     }
 66 | 
 67 |     /**
 68 |      * Removes all cache entries.
 69 |      * 
 70 |      * @param string $regionName A name of region.
 71 |      * 
 72 |      * @return int Number of deleted records.
 73 |      */
 74 |     public function clear($regionName = null) {
 75 |         return $this->provider->clear($regionName);
 76 |     }
 77 | 
 78 |     /**
 79 |      * Checks whether the cache entry already exists in the cache.
 80 |      * 
 81 |      * @param string $key A unique identifier for the cache entry.
 82 |      * @param string $regionName A name of region.
 83 |      * 
 84 |      * @return bool
 85 |      */
 86 |     public function contains($key, $regionName = null) {
 87 |         return $this->provider->contains($key, $regionName);
 88 |     }
 89 | 
 90 |     /**
 91 |      * Gets the specified cache entry from the cache as an object.
 92 |      * 
 93 |      * @param string $key A unique identifier for the cache entry.
 94 |      * @param string $regionName A name of region.
 95 |      * 
 96 |      * @return mixed
 97 |      */
 98 |     public function get($key, $regionName = null) {
 99 |         return $this->provider->get($key, $regionName);
100 |     }
101 | 
102 |     /**
103 |      * Gets a cache entry, or adds it if there is no cache entry.
104 |      * 
105 |      * @param string $key A unique identifier for the cache entry.
106 |      * @param mixed|callback $value The value to insert.
107 |      * @param int $duration The duration of storage the cache entry (in seconds).
108 |      * @param string $regionName A name of region.
109 |      * 
110 |      * @return mixed
111 |      */
112 |     public function getOrAdd($key, $value, $duration, $regionName = null) {
113 |         return $this->provider->getOrAdd($key, $value, $duration, $regionName);
114 |     }
115 | 
116 |     /**
117 |      * Removes the cache entry from the cache.
118 |      * 
119 |      * @param string $key A unique identifier for the cache entry.
120 |      * @param string $regionName A name of region.
121 |      * 
122 |      * @return mixed An object that represents the value of the removed cache entry that was specified by the key,
123 |      * or null if the specified entry was not found.
124 |      */
125 |     public function remove($key, $regionName = null) {
126 |         return $this->provider->remove($key, $regionName);
127 |     }
128 | 
129 | }


--------------------------------------------------------------------------------
/src/ViewContext.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Represents the context of the current view.
 30 |  */
 31 | final class ViewContext extends ActionContext {
 32 | 
 33 |     /**
 34 |      * Gets or sets layout file.
 35 |      * 
 36 |      * @var string
 37 |      */
 38 |     public $layout;
 39 | 
 40 |     /**
 41 |      * Gets or sets page title.
 42 |      * 
 43 |      * @var string
 44 |      */
 45 |     public $title;
 46 | 
 47 |     /**
 48 |      * Gets or sets content of the view.
 49 |      * 
 50 |      * @var string
 51 |      */
 52 |     public $content;
 53 | 
 54 |     /**
 55 |      * Gets or sets model.
 56 |      * 
 57 |      * @var mixed
 58 |      */
 59 |     public $model;
 60 | 
 61 |     /**
 62 |      * Gets or sets view data.
 63 |      * 
 64 |      * @var array
 65 |      */
 66 |     public $viewData = array();
 67 | 
 68 |     /**
 69 |      * Gets or sets result of action.
 70 |      * 
 71 |      * @var mixed
 72 |      */
 73 |     public $actionResult;
 74 | 
 75 |     /**
 76 |      * Gets or sets view file name.
 77 |      * 
 78 |      * @var string
 79 |      */
 80 |     public $viewFile;
 81 | 
 82 |     /**
 83 |      * Gets an object that contains the view context information for the parent action method.
 84 |      * 
 85 |      * @var ViewContext
 86 |      */
 87 |     public $parentActionViewContext;
 88 | 
 89 |     /**
 90 |      * Gets or sets parent view context.
 91 |      * 
 92 |      * @var ViewContext
 93 |      */
 94 |     public $parent;
 95 | 
 96 |     /**
 97 |      * Gets or sets body view context.
 98 |      * 
 99 |      * @var ViewContext
100 |      */
101 |     public $body;
102 | 
103 |     /**
104 |      * Initializes a new instance of ViewContext.
105 |      * 
106 |      * @param string $viewFile The view file path.
107 |      * @param ActionContext $actionContext The action context of the current request.
108 |      * @param ActionResult $actionResult The result of the action.
109 |      * @param mixed $model The view model.
110 |      * @param array $viewData The view data.
111 |      * @param ViewContext $parentActionViewContext The context of the main view.
112 |      * @param ViewContext $parent The context of the parent.
113 |      * @param ViewContext $body The context of the main child.
114 |      */
115 |     public function __construct($viewFile, $actionContext, $actionResult, $model, $viewData, $parentActionViewContext = null, $parent = null, $body = null) {
116 |         parent::__construct($actionContext->getHttpContext(), $actionContext->getRoute());
117 | 
118 |         $this->controller = $actionContext->getController();
119 |         $this->modelState = $actionContext->getModelState();
120 |         $this->arguments = $actionContext->getArguments();
121 |         $this->actionName = $actionContext->getActionName();
122 | 
123 |         $this->viewFile = $viewFile;
124 |         $this->model = $model;
125 |         $this->viewData = $viewData;
126 |         $this->actionResult = $actionResult;
127 |         $this->parentActionViewContext = $parentActionViewContext;
128 |         $this->parent = $parent;
129 |         $this->body = $body;
130 |     }
131 | 
132 |     /**
133 |      * Gets model state.
134 |      * 
135 |      * @return ModelState
136 |      */
137 |     public function getModelState() {
138 |         return $this->modelState;
139 |     }
140 | 
141 |     /**
142 |      * Gets the metadata for the specified model key.
143 |      * If there is no data, it returns null.
144 |      * 
145 |      * @param string @key The key to get metadata.
146 |      * 
147 |      * @return ModelDataAnnotation|null
148 |      */
149 |     public function getModelDataAnnotation($key) {
150 |         if (array_key_exists($key, $this->modelState->annotations)) {
151 |             return $this->modelState->annotations[$key];
152 |         }
153 |         else {
154 |             return null;
155 |         }
156 |     }
157 | 
158 | }


--------------------------------------------------------------------------------
/src/HttpSessionProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Defines the contract that represents the session state provider.
 30 |  */
 31 | interface HttpSessionProvider extends \ArrayAccess, \Iterator {
 32 | 
 33 |     /**
 34 |      * Discards session array changes and finish session.
 35 |      * 
 36 |      * @return bool
 37 |      */
 38 |     function abort();
 39 | 
 40 |     /**
 41 |      * Adds a new item to the session-state collection.
 42 |      * 
 43 |      * @param string $name The name of the item to add to the session-state collection.
 44 |      * @param mixed $value The value of the item to add to the session-state collection.
 45 |      * 
 46 |      * @return bool
 47 |      */
 48 |     function add($name, $value);
 49 | 
 50 |     /**
 51 |      * Clears all values from the session-state item collection.
 52 |      * 
 53 |      * @return bool
 54 |      */
 55 |     function clear();
 56 | 
 57 |     /**
 58 |      * Writes session data and end session.
 59 |      * 
 60 |      * @return bool
 61 |      */
 62 |     function commit();
 63 | 
 64 |     /**
 65 |      * Gets or sets the session cookie parameters.
 66 |      * 
 67 |      * @param array $param If params is specified, it will replace the current cookie params.
 68 |      * 
 69 |      * @return array|bool
 70 |      */
 71 |     function cookieParams($params = null);
 72 | 
 73 |     /**
 74 |      * Creates a new session id.
 75 |      * 
 76 |      * @param string $prefix If prefix is specified, new session id is prefixed by prefix.
 77 |      * 
 78 |      * @return string
 79 |      */
 80 |     function createId($prefix = null);
 81 | 
 82 |     /**
 83 |      * Decodes session data from a session encoded string.
 84 |      * 
 85 |      * @param string $data The encoded data to be stored.
 86 |      * 
 87 |      * @return bool
 88 |      */
 89 |     function decode($data);
 90 | 
 91 |     /**
 92 |      * Encodes the current session data as a session encoded string.
 93 |      * 
 94 |      * @return string
 95 |      */
 96 |     function encode();
 97 | 
 98 |     /**
 99 |      * Perform session data garbage collection.
100 |      * 
101 |      * @return int
102 |      */
103 |     function gc();
104 | 
105 |     /**
106 |      * Gets or sets a session value by name.
107 |      * 
108 |      * @param string $name The key name of the session value.
109 |      * 
110 |      * @return mixed
111 |      */
112 |     function get($name);
113 | 
114 |     /**
115 |      * Initializes the provider.
116 |      * 
117 |      * @return void
118 |      */
119 |     function init();
120 | 
121 |     /**
122 |      * Gets or sets the current session repository.
123 |      * 
124 |      * @param string $value If value is specified, it will replace the current session repository.
125 |      * 
126 |      * @return string
127 |      */
128 |     function repository($value = null);
129 | 
130 |     /**
131 |      * Re-initialize session array with original values.
132 |      * 
133 |      * @return bool
134 |      */
135 |     function reset();
136 | 
137 |     /**
138 |      * Gets and/or sets the current session id.
139 |      * 
140 |      * @param string $id If id is specified, it will replace the current session id.
141 |      * 
142 |      * @return string
143 |      */
144 |     function sessionId($id = null);
145 | 
146 |     /**
147 |      * Gets and/or sets the current session name.
148 |      * 
149 |      * @param string $name If name is specified, it will replace the current session name. 
150 |      * 
151 |      * @return string Returns the name of the current session.
152 |      * If name is given and function updates the session name, name of the old session is returned.
153 |      */
154 |     function sessionName($name = null);
155 | 
156 |     /**
157 |      * Returns the current session status.
158 |      * 
159 |      * * \PHP_SESSION_DISABLED - if sessions are disabled.
160 |      * * \PHP_SESSION_NONE - if sessions are enabled, but none exists.
161 |      * * \PHP_SESSION_ACTIVE - if sessions are enabled, and one exists.
162 |      * 
163 |      * @return int
164 |      */
165 |     function status();
166 | 
167 | }


--------------------------------------------------------------------------------
/tests/FilterTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | require_once 'HttpContext.php';
  5 | 
  6 | use PHPUnit\Framework\TestCase;
  7 | 
  8 | use PhpMvc\Route;
  9 | use PhpMvc\RouteCollection;
 10 | use PhpMvc\UrlParameter;
 11 | use PhpMvc\AppBuilder;
 12 | 
 13 | final class FilterTest extends TestCase
 14 | {
 15 | 
 16 |     protected $preserveGlobalState = false;
 17 | 
 18 |     protected $runTestInSeparateProcess = true;
 19 | 
 20 |     public function __construct($name = null, array $data = [], $dataName = '') {
 21 |         parent::__construct($name, $data, $dataName);
 22 | 
 23 |         $basePath = getcwd() . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'mvc';
 24 | 
 25 |         if (!defined('PHPMVC_DS')) {
 26 |             define('PHPMVC_DS', DIRECTORY_SEPARATOR);
 27 |         }
 28 | 
 29 |         if (!defined('PHPMVC_ROOT_PATH')) {
 30 |             define('PHPMVC_ROOT_PATH', $basePath . PHPMVC_DS);
 31 |         }
 32 | 
 33 |         AppBuilder::useNamespace('PhpMvcTest');
 34 |         AppBuilder::useBasePath($basePath);
 35 |     }
 36 | 
 37 |     public function testEmpty(): void
 38 |     {
 39 |         $httpContext = HttpContext::get('/filter')->useDefaultRoute()->noOutputHeaders();
 40 | 
 41 |         echo chr(10);
 42 |         echo 'Request: ' . $httpContext->getRequest()->rawUrl();
 43 | 
 44 |         ob_start();
 45 | 
 46 |         AppBuilder::useHttpContext($httpContext);
 47 |         AppBuilder::build();
 48 | 
 49 |         $result = ob_get_clean();
 50 | 
 51 |         $this->assertEquals('index', $result);
 52 | 
 53 |         echo ' - OK' . chr(10);
 54 |     }
 55 | 
 56 |     public function testExecuting(): void
 57 |     {
 58 |         $httpContext = HttpContext::get('/filter/executingWorld')->useDefaultRoute()->noOutputHeaders();
 59 | 
 60 |         echo chr(10);
 61 |         echo 'Request: ' . $httpContext->getRequest()->rawUrl();
 62 | 
 63 |         ob_start();
 64 | 
 65 |         AppBuilder::useHttpContext($httpContext);
 66 |         AppBuilder::build();
 67 | 
 68 |         $result = ob_get_clean();
 69 | 
 70 |         $this->assertEquals('executing the world!', $result);
 71 | 
 72 |         echo ' - OK' . chr(10);
 73 |     }
 74 | 
 75 |     public function testExecuted(): void
 76 |     {
 77 |         $httpContext = HttpContext::get('/filter/executedWorld')->useDefaultRoute()->noOutputHeaders();
 78 | 
 79 |         echo chr(10);
 80 |         echo 'Request: ' . $httpContext->getRequest()->rawUrl();
 81 | 
 82 |         ob_start();
 83 | 
 84 |         AppBuilder::useHttpContext($httpContext);
 85 |         AppBuilder::build();
 86 | 
 87 |         $result = ob_get_clean();
 88 | 
 89 |         $this->assertEquals('executed the world!', $result);
 90 | 
 91 |         echo ' - OK' . chr(10);
 92 |     }
 93 | 
 94 |     public function testExecute(): void
 95 |     {
 96 |         $httpContext = HttpContext::get('/filter/executeWorld')->useDefaultRoute()->noOutputHeaders();
 97 | 
 98 |         echo chr(10);
 99 |         echo 'Request: ' . $httpContext->getRequest()->rawUrl();
100 | 
101 |         ob_start();
102 | 
103 |         AppBuilder::useHttpContext($httpContext);
104 |         AppBuilder::build();
105 | 
106 |         $result = ob_get_clean();
107 | 
108 |         $this->assertEquals('executing the world!', $result);
109 | 
110 |         echo ' - OK' . chr(10);
111 |     }
112 | 
113 |     public function testExecute2(): void
114 |     {
115 |         $httpContext = HttpContext::get('/filter/executeWorld2')->useDefaultRoute()->noOutputHeaders();
116 | 
117 |         echo chr(10);
118 |         echo 'Request: ' . $httpContext->getRequest()->rawUrl();
119 | 
120 |         ob_start();
121 | 
122 |         AppBuilder::useHttpContext($httpContext);
123 |         AppBuilder::build();
124 | 
125 |         $result = ob_get_clean();
126 | 
127 |         $this->assertEquals('executing the world!', $result);
128 | 
129 |         echo ' - OK' . chr(10);
130 |     }
131 | 
132 |     public function testError(): void
133 |     {
134 |         $httpContext = HttpContext::get('/filter/error')->useDefaultRoute()->noOutputHeaders();
135 | 
136 |         echo chr(10);
137 |         echo 'Request: ' . $httpContext->getRequest()->rawUrl();
138 | 
139 |         ob_start();
140 | 
141 |         AppBuilder::useHttpContext($httpContext);
142 |         AppBuilder::build();
143 | 
144 |         $result = ob_get_clean();
145 | 
146 |         // $this->assertEquals('hello exception!', $result);
147 |         $this->assertContains('An error occurred while processing the request.', $result);
148 | 
149 |         echo ' - OK' . chr(10);
150 |     }
151 | 
152 |     public function testErrorNoResult(): void
153 |     {
154 |         $httpContext = HttpContext::get('/filter/errorNoResult')->useDefaultRoute()->noOutputHeaders();
155 | 
156 |         echo chr(10);
157 |         echo 'Request: ' . $httpContext->getRequest()->rawUrl();
158 | 
159 |         ob_start();
160 | 
161 |         AppBuilder::useHttpContext($httpContext);
162 |         AppBuilder::build();
163 | 
164 |         $result = ob_get_clean();
165 | 
166 |         $this->assertEquals('', $result);
167 | 
168 |         echo ' - OK' . chr(10);
169 |     }
170 | 
171 |     public function testErrorRewrited(): void
172 |     {
173 |         $httpContext = HttpContext::get('/filter/errorRewrited')->useDefaultRoute()->noOutputHeaders();
174 | 
175 |         echo chr(10);
176 |         echo 'Request: ' . $httpContext->getRequest()->rawUrl();
177 | 
178 |         ob_start();
179 | 
180 |         AppBuilder::useHttpContext($httpContext);
181 |         AppBuilder::build();
182 | 
183 |         $result = ob_get_clean();
184 | 
185 |         $this->assertEquals('just make an exception in this world!', $result);
186 | 
187 |         echo ' - OK' . chr(10);
188 |     }
189 | 
190 | }


--------------------------------------------------------------------------------
/src/PathUtility.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Provides utility methods for path operations.
 30 |  */
 31 | final class PathUtility {
 32 | 
 33 |     /**
 34 |      * Converts a virtual path to an physical path.
 35 |      * 
 36 |      * @param string $virtualPath The virtual path to convert to physical path.
 37 |      * 
 38 |      * @return string
 39 |      */
 40 |     public static function mapPath($virtualPath = null) {
 41 |         if (empty($virtualPath)) {
 42 |             return PHPMVC_ROOT_PATH;
 43 |         }
 44 | 
 45 |         if ($virtualPath[0] == '~' || $virtualPath[0] == '/') {
 46 |             $result = PHPMVC_ROOT_PATH;
 47 |             $result .= trim(substr($virtualPath, 1, strlen($virtualPath) - 1), '\\/');
 48 |         }
 49 |         elseif ($virtualPath[0] == '.') {
 50 |             $result = realpath(PHPMVC_ROOT_PATH . $virtualPath);
 51 |         }
 52 |         else {
 53 |             $result = PHPMVC_ROOT_PATH . $virtualPath;
 54 |         }
 55 | 
 56 |         return self::normalizePathSeparators($result);
 57 |     }
 58 | 
 59 |     /**
 60 |      * Checks whether the specified path is relative or not.
 61 |      * 
 62 |      * @param bool $path Path to check.
 63 |      * 
 64 |      * @return bool
 65 |      */
 66 |     public static function isRelativePath($path) {
 67 |         if ($path[0] == '~' || $path[0] == '.') {
 68 |             return true;
 69 |         }
 70 | 
 71 |         if ($path[0] == '/' && !is_file($path) && !is_dir($path)) {
 72 |             return true;
 73 |         }
 74 | 
 75 |         return false;
 76 |     }
 77 | 
 78 |     /**
 79 |      * Normalizes slashes in the specified path.
 80 |      * 
 81 |      * @param string $path The path with crazy slashes :P
 82 |      * 
 83 |      * @return string
 84 |      */
 85 |     private static function normalizePathSeparators($path)
 86 |     {
 87 |         $slash = (PHPMVC_DS == '/' ? '\\' : '/');
 88 | 
 89 |         return str_replace($slash, PHPMVC_DS, $path);
 90 |     }
 91 | 
 92 |     /**
 93 |      * Appends the .php extension to the specified path.
 94 |      * If the extension already exists, returns FALSE.
 95 |      * 
 96 |      * @param string $path Path to processing.
 97 |      * 
 98 |      * @return string|bool
 99 |      */
100 |     public static function appendPhpExtension($path) {
101 |         if (strlen($path) >= 4 && substr($path, -4) != '.php') {
102 |             return $path . '.php';
103 |         }
104 | 
105 |         return false;
106 |     }
107 | 
108 |     /**
109 |      * Returns the physical path to an existing file.
110 |      * If no path is found, returns FALSE.
111 |      * 
112 |      * @param string $path Relative or physical path.
113 |      * If no file is found on the specified path, an attempt will be made to add the extension .php to the specified path.
114 |      * 
115 |      * @return string|bool
116 |      */
117 |     public static function getFilePath($path) {
118 |         if (empty($path)) {
119 |             return false;
120 |         }
121 | 
122 |         if (is_file($path)) {
123 |             return $path;
124 |         }
125 | 
126 |         if (is_file($result = self::mapPath($path))) {
127 |             return $result;
128 |         }
129 | 
130 |         if (($result = self::appendPhpExtension($path)) !== false) {
131 |             return self::getFilePath($result);
132 |         }
133 | 
134 |         return false;
135 |     }
136 | 
137 |     /**
138 |      * Searches for a file with a specified name and returns the correct path.
139 |      * If the file is not found, returns FALSE. 
140 |      * 
141 |      * @param string $path The file name or file path.
142 |      * 
143 |      * @return string|bool
144 |      */
145 |     public static function getViewFilePath($path) {
146 |         if (empty($path)) {
147 |             return false;
148 |         }
149 | 
150 |         if ((strpos($path, '/') !== false || strpos($path, '\\') !== false) && is_file($result = $path)) {
151 |             return $result;
152 |         }
153 | 
154 |         if (self::isRelativePath($path) && is_file($result = self::mapPath($path))) {
155 |             return $result;
156 |         }
157 | 
158 |         if (is_file($result = PHPMVC_VIEW_PATH . PHPMVC_VIEW . PHPMVC_DS . $path)) {
159 |             return $result;
160 |         }
161 |        
162 |         if (is_file($result = PHPMVC_SHARED_PATH . $path)) {
163 |             return $result;
164 |         }
165 | 
166 |         if (($result = self::appendPhpExtension($path)) !== false) {
167 |             return self::getViewFilePath($result);
168 |         }
169 | 
170 |         return false;
171 |     }
172 | 
173 | }


--------------------------------------------------------------------------------
/src/View.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Represents the properties and methods that are needed to render a view.
 30 |  */
 31 | final class View {
 32 | 
 33 |     /**
 34 |      * Defines ViewContext.
 35 |      * 
 36 |      * @var ViewContext
 37 |      */
 38 |     private static $viewContext;
 39 | 
 40 |     /**
 41 |      * Gets the context of the current view.
 42 |      * 
 43 |      * @return ViewContext
 44 |      */
 45 |     public static function getViewContext() {
 46 |         return self::$viewContext;
 47 |     }
 48 | 
 49 |     /**
 50 |      * Gets context of the current request.
 51 |      * 
 52 |      * @return HttpContextBase
 53 |      */
 54 |     public static function getHttpContext() {
 55 |         return self::$viewContext->getHttpContext();
 56 |     }
 57 | 
 58 |     /**
 59 |      * Gets route of the current request.
 60 |      * 
 61 |      * @return Route
 62 |      */
 63 |     public static function getRoute() {
 64 |         return self::$viewContext->getHttpContext()->getRoute();
 65 |     }
 66 | 
 67 |     /**
 68 |      * Gets the HttpRequestBase object for the current request.
 69 |      * 
 70 |      * @return HttpRequestBase
 71 |      */
 72 |     public static function getRequest() {
 73 |         return self::$viewContext->getHttpContext()->getRequest();
 74 |     }
 75 | 
 76 |     /**
 77 |      * Gets the HttpResponseBase object for the current request.
 78 |      * 
 79 |      * @return HttpResponseBase
 80 |      */
 81 |     public static function getResponse() {
 82 |         return self::$viewContext->getHttpContext()->getResponse();
 83 |     }
 84 | 
 85 |     /**
 86 |      * Sets layout.
 87 |      * 
 88 |      * @param string $path The layout file name in the shared folder or full path to layout file.
 89 |      * 
 90 |      * @return void
 91 |      */
 92 |     public static function setLayout($path) {
 93 |         self::$viewContext->layout = $path;
 94 |     }
 95 | 
 96 |     /**
 97 |      * Gets current layout file name or path.
 98 |      * 
 99 |      * @return void
100 |      */
101 |     public static function getLayout() {
102 |         return self::$viewContext->layout;
103 |     }
104 | 
105 |     /**
106 |      * Sets page title.
107 |      * 
108 |      * @param string $title The title to set.
109 |      * 
110 |      * @return void
111 |      */
112 |     public static function setTitle($title) {
113 |         self::$viewContext->title = $title;
114 |     }
115 | 
116 |     /**
117 |      * Gets page title.
118 |      * 
119 |      * @return void
120 |      */
121 |     public static function getTitle() {
122 |         return self::$viewContext->title;
123 |     }
124 | 
125 |     /**
126 |      * Injects model to state.
127 |      * 
128 |      * @param mixed &$model Model to injection.
129 |      * 
130 |      * @return void
131 |      */
132 |     public static function injectModel(&$model) {
133 |         $actionResult = self::$viewContext->actionResult;
134 | 
135 |         if (!empty($actionResult)) {
136 |             if ($actionResult instanceof ViewResult && !empty($actionResult->model)) {
137 |                 $model = $actionResult->model;
138 |             }
139 |             else {
140 |                 $model = null;
141 |             }
142 |         }
143 |     }
144 | 
145 |     /**
146 |      * Sets data to view.
147 |      * 
148 |      * @param string $key Key associated with the data entry.
149 |      * @param string $value The value to set.
150 |      * 
151 |      * @return void
152 |      */
153 |     public static function setData($key, $value) {
154 |         self::$viewContext->viewData[$key] = $value;
155 |     }
156 | 
157 |     /**
158 |      * Gets the data with the specified key.
159 |      * If the specified key does not exist, function returns null.
160 |      * If no key is specified, returns all data.
161 |      * 
162 |      * @param string $key The key to get the data.
163 |      * 
164 |      * @return mixed|array|null
165 |      */
166 |     public static function getData($key = null) {
167 |         if (!isset($key)) {
168 |             return self::$viewContext->viewData;
169 |         }
170 |         else {
171 |             return isset(self::$viewContext->viewData[$key]) ? self::$viewContext->viewData[$key] : null;
172 |         }
173 |     }
174 | 
175 |     /**
176 |      * Gets model.
177 |      * 
178 |      * @return mixed|null
179 |      */
180 |     public static function getModel() {
181 |         return self::$viewContext->model;
182 |     }
183 | 
184 |     /**
185 |      * Gets model state.
186 |      * 
187 |      * @return ModelState
188 |      */
189 |     public static function getModelState() {
190 |         return self::$viewContext->getModelState();
191 |     }
192 | 
193 |     /**
194 |      * Gets view file name.
195 |      * 
196 |      * @return string
197 |      */
198 |     public static function getViewFile() {
199 |         return self::$viewContext->viewFile;
200 |     }
201 | 
202 | }


--------------------------------------------------------------------------------
/src/RouteProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Defines the contract that represents the route provider.
 30 |  */
 31 | interface RouteProvider {
 32 | 
 33 |     /**
 34 |      * Adds a rule.
 35 |      * 
 36 |      * @param string $name The unique name of the route.
 37 |      * @param string $template The template by which the route will be searched.
 38 |      * Use curly braces to denote the elements of the route.
 39 |      * For example: {controller}/{action}/{id}
 40 |      * {controller=Home}/{action=index}/{id?}
 41 |      * @param array $defaults An associative array containing the default values for the elements defined in the $template.
 42 |      * For example, $template is {controller}/{action}/{id}
 43 |      * $defaults = array('controller' => 'Home', 'action' => 'index', id => \PhpMvc\UrlParameter.OPTIONAL)
 44 |      * @param array $constraints An associative array containing regular expressions for checking the elements of the route.
 45 |      * For example, $template is {controller}/{action}/{id}
 46 |      * $constraints = array('id' => '\w+')
 47 |      * 
 48 |      * @return void
 49 |      */
 50 |     function add($name, $template, $defaults = null, $constraints = null);
 51 | 
 52 |     /**
 53 |      * Removes all routes.
 54 |      * 
 55 |      * @return void
 56 |      */
 57 |     function clear();
 58 | 
 59 |     /**
 60 |      * Gets ignored routes list.
 61 |      * 
 62 |      * @return Route[]
 63 |      */
 64 |     function getIgnored();
 65 | 
 66 |     /**
 67 |      * Gets routes list.
 68 |      * 
 69 |      * @return Route[]
 70 |      */
 71 |     function getRoutes();
 72 | 
 73 |     /**
 74 |      * Gets options.
 75 |      * 
 76 |      * @return RouteOptions
 77 |      */
 78 |     function getOptions();
 79 | 
 80 |     /**
 81 |      * Sets options.
 82 |      * 
 83 |      * @return void
 84 |      */
 85 |     function setOptions($options);
 86 | 
 87 |     /**
 88 |      * Inserts a route into the collection at the specified index.
 89 |      * 
 90 |      * @param int $index The zero-based index at which route should be inserted.
 91 |      * @param string $name The unique name of the route.
 92 |      * @param string $template The template by which the route will be searched.
 93 |      * Use curly braces to denote the elements of the route.
 94 |      * For example: {controller}/{action}/{id}
 95 |      * {controller=Home}/{action=index}/{id?}
 96 |      * @param array $defaults An associative array containing the default values for the elements defined in the $template.
 97 |      * For example, $template is {controller}/{action}/{id}
 98 |      * $defaults = array('controller' => 'Home', 'action' => 'index', id => \PhpMvc\UrlParameter.OPTIONAL)
 99 |      * @param array $constraints An associative array containing regular expressions for checking the elements of the route.
100 |      * For example, $template is {controller}/{action}/{id}
101 |      * $constraints = array('id' => '\w+')
102 |      * 
103 |      * @return void
104 |      */
105 |     function insert($index, $name, $template, $defaults = null, $constraints = null);
106 | 
107 |     /**
108 |      * Adds an URL pattern that should not be checked for matches against routes if a request URL meets the specified constraints.
109 |      * 
110 |      * @param string $template The URL pattern to be ignored.
111 |      * @param array $constraints An associative array containing regular expressions for checking the elements of the route.
112 |      * 
113 |      * @return void
114 |      */
115 |     function ignore($template, $constraints = null);
116 | 
117 |     /**
118 |      * Initializes the provider.
119 |      * 
120 |      * @return void
121 |      */
122 |     function init();
123 | 
124 |     /**
125 |      * Returns the first ignored route similar to the current url.
126 |      * 
127 |      * @param HttpContextBase $httpContext Context of the request.
128 |      * 
129 |      * @return Route|null
130 |      */
131 |     function matchIgnore($httpContext);
132 | 
133 |     /**
134 |      * Returns the first route similar to the current url.
135 |      * 
136 |      * @param HttpContextBase $httpContext Context of the request.
137 |      * 
138 |      * @return Route|null
139 |      */
140 |     function matchRoute($httpContext);
141 | 
142 |     /**
143 |      * Tries to build a url with the specified parameters.
144 |      * 
145 |      * @param HttpContextBase $httpContext The context of the request.
146 |      * @param string $actionName The name of the action.
147 |      * @param string $controllerName The name of the controller. Default: current controller.
148 |      * @param array $routeValues An array that contains the parameters for a route.
149 |      * @param string $fragment The URL fragment name (the anchor name).
150 |      * @param string $schema The protocol for the URL, such as "http" or "https".
151 |      * @param string $host The host name for the URL.
152 |      * 
153 |      * @return string
154 |      */
155 |     function tryBuildUrl($httpContext, $actionName, $controllerName = null, $routeValues = null, $fragment = null, $schema = null, $host = null);
156 | 
157 | }


--------------------------------------------------------------------------------
/tests/HttpContext.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | use PhpMvc\InternalHelper;
  3 | use PhpMvc\HttpContextBase;
  4 | use PhpMvc\IdleCacheProvider;
  5 | use PhpMvc\DefaultRouteProvider;
  6 | 
  7 | require_once 'HttpRequest.php';
  8 | require_once 'HttpResponse.php';
  9 | require_once 'HttpContextInfo.php';
 10 | 
 11 | final class HttpContext extends HttpContextBase {
 12 | 
 13 |     public function __construct($info) {
 14 |         if ($info->routeProvider === null) {
 15 |             $info->routeProvider = new DefaultRouteProvider();
 16 |         }
 17 | 
 18 |         if ($info->cacheProvider === null) {
 19 |             $info->cacheProvider = new IdleCacheProvider();
 20 |         }
 21 | 
 22 |         $info->request = new HttpRequest($info->serverVariables, $info->get, $info->post);
 23 |         $info->response = new HttpResponse($info->noOutputHeaders);
 24 | 
 25 |         parent::__construct($info);
 26 |     }
 27 | 
 28 |     /**
 29 |      * 
 30 |      * @return HttpContext
 31 |      */
 32 |     public function setCacheProvider($cacheProvider) {
 33 |         $this->cache = $cacheProvider;
 34 | 
 35 |         return $this;
 36 |     }
 37 | 
 38 |     /**
 39 |      * 
 40 |      * @return HttpContext
 41 |      */
 42 |     public function setRoutes($routeProvider) {
 43 |         $this->routes = $routeProvider;
 44 | 
 45 |         return $this;
 46 |     }
 47 | 
 48 |     /**
 49 |      * 
 50 |      * @return HttpContext
 51 |      */
 52 |     public function useDefaultRoute() {
 53 |         $routeProvider = new DefaultRouteProvider();
 54 |         $routeProvider->add('default', '{controller=Home}/{action=index}/{id?}');
 55 | 
 56 |         $this->routes = $routeProvider;
 57 | 
 58 |         return $this;
 59 |     }
 60 | 
 61 |     public function noOutputHeaders() {
 62 |         $this->response->setNoOutputHeaders(true);
 63 | 
 64 |         return $this;
 65 |     }
 66 | 
 67 |     public function outputHeaders() {
 68 |         $this->response->setNoOutputHeaders(false);
 69 | 
 70 |         return $this;
 71 |     }
 72 | 
 73 |     public static function getWithRoute($url, $routes, $ignoreRoutes = null, $serverVariables = null, $noOutputHeaders = false) {
 74 |         $serverVariables = ($serverVariables != null ? $serverVariables : array());
 75 | 
 76 |         $url = parse_url($url);
 77 | 
 78 |         if (empty($url['scheme'])) {
 79 |             $url['scheme'] = 'http';
 80 |         }
 81 | 
 82 |         if (empty($url['host'])) {
 83 |             $url['host'] = 'localhost';
 84 |         }
 85 | 
 86 |         if (empty($url['path'])) {
 87 |             $url['path'] = 'path';
 88 |         }
 89 |         
 90 |         if ($url['scheme'] === 'https') {
 91 |             $serverVariables['HTTPS'] = true;
 92 |             $serverVariables['SERVER_PORT'] = 443;
 93 |         }
 94 |         else {
 95 |             $serverVariables['SERVER_PORT'] = 80;
 96 |         }
 97 | 
 98 |         $serverVariables['REQUEST_METHOD'] = 'GET';
 99 |         $serverVariables['HTTP_HOST'] = $url['host'];
100 |         $serverVariables['REQUEST_URI'] = $url['path'] . (!empty($url['query']) ? '?' . $url['query'] : '');
101 | 
102 |         if (!empty($url['query'])) {
103 |             $serverVariables['QUERY_STRING'] = $url['query'];
104 |             parse_str($url['query'], $get);
105 |         }
106 |         else {
107 |             $get = array();
108 |         }
109 | 
110 |         $info = new HttpContextInfo();
111 |         $info->routeProvider = new DefaultRouteProvider();
112 |         $info->noOutputHeaders = $noOutputHeaders;
113 |         $info->serverVariables = $serverVariables;
114 |         $info->get = $get;
115 | 
116 |         if (!empty($routes)) {
117 |             foreach ($routes as $route) {
118 |                 $info->routeProvider->add($route->name, $route->template, $route->defaults, $route->constraints);
119 |             }
120 |         }
121 | 
122 |         if (!empty($ignoreRoutes)) {
123 |             foreach ($ignoreRoutes as $route) {
124 |                 $info->routeProvider->ignore($route->template, $route->constraints);
125 |             }
126 |         }
127 | 
128 |         return new HttpContext($info);
129 |     }
130 | 
131 |     public static function get($url, $serverVariables = null, $noOutputHeaders = false) {
132 |         return self::getWithRoute($url, null, null, $serverVariables, $noOutputHeaders);
133 |     }
134 | 
135 |     public static function post($url, $parameters = null, $routes = null, $ignoreRoutes = null, $serverVariables = null, $noOutputHeaders = false) {
136 |         $serverVariables = ($serverVariables != null ? $serverVariables : array());
137 | 
138 |         $url = parse_url($url);
139 | 
140 |         if (empty($url['scheme'])) {
141 |             $url['scheme'] = 'http';
142 |         }
143 | 
144 |         if (empty($url['host'])) {
145 |             $url['host'] = 'localhost';
146 |         }
147 | 
148 |         if (empty($url['path'])) {
149 |             $url['path'] = 'path';
150 |         }
151 |         
152 |         if ($url['scheme'] === 'https') {
153 |             $serverVariables['HTTPS'] = true;
154 |             $serverVariables['SERVER_PORT'] = 443;
155 |         }
156 |         else {
157 |             $serverVariables['SERVER_PORT'] = 80;
158 |         }
159 | 
160 |         $serverVariables['REQUEST_METHOD'] = 'POST';
161 |         $serverVariables['HTTP_HOST'] = $url['host'];
162 |         $serverVariables['REQUEST_URI'] = $url['path'] . (!empty($url['query']) ? '?' . $url['query'] : '');
163 | 
164 |         if (!empty($url['query'])) {
165 |             $serverVariables['QUERY_STRING'] = $url['query'];
166 |             parse_str($url['query'], $get);
167 |         }
168 |         else {
169 |             $get = array();
170 |         }
171 | 
172 |         $info = new HttpContextInfo();
173 |         $info->routeProvider = new DefaultRouteProvider();
174 |         $info->noOutputHeaders = $noOutputHeaders;
175 |         $info->serverVariables = $serverVariables;
176 |         $info->get = $get;
177 |         $info->post = $parameters;
178 | 
179 |         if (!empty($routes)) {
180 |             foreach ($routes as $route) {
181 |                 $info->routeProvider->add($route->name, $route->template, $route->defaults, $route->constraints);
182 |             }
183 |         }
184 | 
185 |         if (!empty($ignoreRoutes)) {
186 |             foreach ($ignoreRoutes as $route) {
187 |                 $info->routeProvider->ignore($route->template, $route->constraints);
188 |             }
189 |         }
190 | 
191 |         return new HttpContext($info);
192 |     }
193 | 
194 | }


--------------------------------------------------------------------------------
/src/HttpContextBase.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Serves as the base class for classes that contain HTTP-specific information about an individual HTTP request.
 30 |  */
 31 | abstract class HttpContextBase {
 32 | 
 33 |     /**
 34 |      * When overridden in a derived class, gets the Cache object for the current request.
 35 |      * 
 36 |      * @var Cache
 37 |      */
 38 |     protected $cache;
 39 | 
 40 |     /**
 41 |      * When overridden in a derived class, gets the HttpRequest object for the current HTTP request.
 42 |      * 
 43 |      * @var HttpRequestBase
 44 |      */
 45 |     protected $request;
 46 | 
 47 |     /**
 48 |      * When overridden in a derived class, gets the HttpResponse object for the current HTTP request.
 49 |      * 
 50 |      * @var HttpResponseBase
 51 |      */
 52 |     protected $response;
 53 | 
 54 |     /**
 55 |      * Gets the HttpSessionProvider for the current HTTP request.
 56 |      * 
 57 |      * @var HttpSessionProvider
 58 |      */
 59 |     protected $session;
 60 | 
 61 |     /**
 62 |      * The routes provider.
 63 |      * 
 64 |      * @var RouteProvider
 65 |      */
 66 |     protected $routes;
 67 | 
 68 |     /**
 69 |      * Current route.
 70 |      * 
 71 |      * @var Route
 72 |      */
 73 |     protected $route;
 74 | 
 75 |     /**
 76 |      * Indicates that the request must be ignored.
 77 |      */
 78 |     protected $ignoreRoute = null;
 79 | 
 80 |     /**
 81 |      * The initial timestamp of the current HTTP request.
 82 |      * 
 83 |      * @var int
 84 |      */
 85 |     protected $timestamp;
 86 | 
 87 |     /**
 88 |      * Initializes a new instance of the HttpContextBase.
 89 |      * 
 90 |      * @param HttpContextInfo $info Context info.
 91 |      */
 92 |     public function __construct($info) {
 93 |         if (!isset($info) || !$info instanceof HttpContextInfo) {
 94 |             throw new \Exception('The $info type must be the base of "\PhpMvc\HttpContextInfo".');
 95 |         }
 96 | 
 97 |         $date = new \DateTime();
 98 |         $this->timestamp = $date->getTimestamp();
 99 | 
100 |         $this->routes = $info->routeProvider;
101 |         $this->cache = $info->cacheProvider;
102 |         $this->request = $info->request;
103 |         $this->response = $info->response;
104 |         $this->session = $info->session;
105 |     }
106 | 
107 |     /**
108 |      * Gets cache provider.
109 |      * 
110 |      * @return Cache
111 |      */
112 |     public function getCache() {
113 |         return $this->cache;
114 |     }
115 | 
116 |     /**
117 |      * Gets the HttpRequestBase object.
118 |      * 
119 |      * @return HttpRequestBase
120 |      */
121 |     public function getRequest() {
122 |         return $this->request;
123 |     }
124 | 
125 |     /**
126 |      * Gets the HttpResponseBase object.
127 |      * 
128 |      * @return HttpResponseBase
129 |      */
130 |     public function getResponse() {
131 |         return $this->response;
132 |     }
133 | 
134 |     /**
135 |      * Gets the HttpSessionProvider.
136 |      * 
137 |      * @return array|mixed
138 |      */
139 |     public function getSession() {
140 |         return $this->session;
141 |     }
142 | 
143 |     /**
144 |      * Gets list of routes.
145 |      * 
146 |      * @return RouteCollection
147 |      */
148 |     public function getRoutes() {
149 |         return $this->routes->getRoutes();
150 |     }
151 | 
152 |     /**
153 |      * Returns a route that is comparable to the current request context.
154 |      * 
155 |      * @return Route|null
156 |      */
157 |     public function getRoute() {
158 |         if ($this->route === null && $this->isIgnoredRoute() === false) {
159 |             $this->route = $this->routes->matchRoute($this);
160 |         }
161 | 
162 |         return $this->route;
163 |     }
164 | 
165 |     /**
166 |      * Returns TRUE if the current route is to be ignored.
167 |      * 
168 |      * @return bool
169 |      */
170 |     public function isIgnoredRoute() {
171 |         if ($this->ignoreRoute === null) {
172 |             $this->ignoreRoute = ($this->route = $this->routes->matchIgnore($this)) !== null;
173 |         }
174 | 
175 |         return $this->ignoreRoute;
176 |     }
177 | 
178 |     /**
179 |      * Gets the initial timestamp of the current HTTP request.
180 |      * 
181 |      * @return int
182 |      */
183 |     public function getTimestamp() {
184 |         return $this->timestamp;
185 |     }
186 | 
187 |     
188 |     /**
189 |      * Tries to build a url with the specified parameters.
190 |      * 
191 |      * @param string $actionName The name of the action.
192 |      * @param string $controllerName The name of the controller. Default: current controller.
193 |      * @param array $routeValues An array that contains the parameters for a route.
194 |      * @param string $fragment The URL fragment name (the anchor name).
195 |      * @param string $schema The protocol for the URL, such as "http" or "https".
196 |      * @param string $host The host name for the URL.
197 |      * 
198 |      * @return string
199 |      */
200 |     public function tryBuildUrl($actionName, $controllerName = null, $routeValues = null, $fragment = null, $schema = null, $host = null) {
201 |         return $this->routes->tryBuildUrl($this, $actionName, $controllerName, $routeValues, $fragment, $schema, $host);
202 |     }
203 | 
204 | }


--------------------------------------------------------------------------------
/src/ModelState.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the php-mvc-project <https://github.com/php-mvc-project>
  4 |  * 
  5 |  * Copyright (c) 2018 Aleksey <https://github.com/meet-aleksey>
  6 |  * 
  7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 |  * of this software and associated documentation files (the "Software"), to deal
  9 |  * in the Software without restriction, including without limitation the rights
 10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 |  * copies of the Software, and to permit persons to whom the Software is
 12 |  * furnished to do so, subject to the following conditions:
 13 |  * 
 14 |  * The above copyright notice and this permission notice shall be included in all
 15 |  * copies or substantial portions of the Software.
 16 |  * 
 17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 |  * SOFTWARE.
 24 |  */
 25 | 
 26 | namespace PhpMvc;
 27 | 
 28 | /**
 29 |  * Encapsulates the state of model binding to a property of an action-method argument, or to the argument itself.
 30 |  */
 31 | class ModelState implements \ArrayAccess {
 32 | 
 33 |     /**
 34 |      * Gets or sets model state entries.
 35 |      * 
 36 |      * @var ModelStateEntry[]
 37 |      */
 38 |     public $items = array();
 39 | 
 40 |     /**
 41 |      * Gets or sets errors.
 42 |      * 
 43 |      * @var array
 44 |      */
 45 |     private $errors = array();
 46 | 
 47 |     /**
 48 |      * Gets or sets metadata of Model.
 49 |      * 
 50 |      * @var ModelDataAnnotation[]
 51 |      */
 52 |     public $annotations = array();
 53 | 
 54 |     /**
 55 |      * Returns true if the state does not contain errors; otherwise, false.
 56 |      * 
 57 |      * @param string $key If the key is specified, only the specified key will be checked for errors.
 58 |      * 
 59 |      * @return bool
 60 |      */
 61 |     public function isValid($key = null) {
 62 |         if (isset($key)) {
 63 |             return empty($this->errors[$key]);
 64 |         }
 65 |         else {
 66 |             return empty($this->errors);
 67 |         }
 68 |     }
 69 | 
 70 |     /**
 71 |      * Returns errors of the model state.
 72 |      * 
 73 |      * @param string $key If the key is specified, only errors for the specified key will be returned.
 74 |      * 
 75 |      * @return array
 76 |      */
 77 |     public function getErrors($key = null) {
 78 |         if (isset($key)) {
 79 |             return !empty($this->errors[$key]) ? $this->errors[$key] : array();
 80 |         }
 81 |         else {
 82 |             return $this->errors;
 83 |         }
 84 |     }
 85 | 
 86 |     /**
 87 |      * Gets the key-value pair.
 88 |      * 
 89 |      * @return array
 90 |      */
 91 |     public function getKeyValuePair() {
 92 |         $result = array();
 93 | 
 94 |         foreach ($this->items as $key => $entry) {
 95 |             $result[$key] = $entry->value;
 96 |         }
 97 | 
 98 |         return $result;
 99 |     }
100 | 
101 |     /**
102 |      * Gets the key sequence.
103 |      * 
104 |      * @return array
105 |      */
106 |     public function getKeys() {
107 |         return array_keys($this->items);
108 |     }
109 | 
110 |     /**
111 |      * Gets the value sequence.
112 |      * 
113 |      * @return array
114 |      */
115 |     public function getValues() {
116 |         $result = array();
117 | 
118 |         foreach ($this->items as $key => $entry) {
119 |             $result[] = $entry->value;
120 |         }
121 | 
122 |         return $result;
123 |     }
124 | 
125 |     /**
126 |      * Adds the specified errorMessage to the Errors instance that is associated with the specified key.
127 |      * 
128 |      * @param string $key The key of state to add error.
129 |      * @param mixed $error The error or error message to add.
130 |      * 
131 |      * @return void
132 |      */
133 |     public function addError($key, $error) {
134 |         if (is_array($key)) {
135 |             $key = implode('_', $key);
136 |         }
137 | 
138 |         if (array_key_exists($key, $this->errors)) {
139 |             $this->errors[$key][] = $error;
140 |         }
141 |         else {
142 |             $this->errors[$key] = array($error);
143 |         }
144 |     }
145 | 
146 |     /**
147 |      * Gets the metadata for the specified model key.
148 |      * If there is no data, it returns null.
149 |      * 
150 |      * @param string|string[] @key The key to get metadata.
151 |      * 
152 |      * @return ModelDataAnnotation|null
153 |      */
154 |     public function getAnnotation($key) {
155 |         if (is_array($key)) {
156 |             $key = implode('_', $key);
157 |         }
158 | 
159 |         if (array_key_exists($key, $this->annotations)) {
160 |             return $this->annotations[$key];
161 |         }
162 |         else {
163 |             return null;
164 |         }
165 |     }
166 | 
167 |     /**
168 |      * Creates an object from the model state entities.
169 |      * 
170 |      * @return object
171 |      */
172 |     public function toObject() {
173 |         return (object)$this->items;
174 |     }
175 | 
176 |     /**
177 |      * Whether or not an offset exists.
178 |      *
179 |      * @param string|int $offset An offset to check for.
180 |      * 
181 |      * @return bool
182 |      */
183 |     function offsetExists($offset)
184 |     {
185 |       return isset($this->items[$offset]);
186 |     }
187 | 
188 |     /**
189 |      * Returns the value at specified offset.
190 |      *
191 |      * @param mixed $offset The offset to retrieve.
192 |      * 
193 |      * @return mixed
194 |      */
195 |     function offsetGet($offset)
196 |     {
197 |       return isset($this->items[$offset]) ? $this->items[$offset] : null;
198 |     }
199 | 
200 |     /**
201 |      * Assigns a value to the specified offset.
202 |      *
203 |      * @param mixed $offset The offset to assign the value to.
204 |      * @param mixed $value The value to set.
205 |      * 
206 |      * @return void
207 |      */
208 |     function offsetSet($offset, $value)
209 |     {
210 |       $this->items[$offset] = $value;
211 |     }
212 | 
213 |     /**
214 |      * Unsets an offset.
215 |      *
216 |      * @param mixed $offset The offset to unset.
217 |      * 
218 |      * @return void
219 |      */
220 |     function offsetUnset($offset)
221 |     {
222 |       unset($this->items[$offset]);
223 |     }
224 | 
225 | }


--------------------------------------------------------------------------------
/tests/ArrayToObjectTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Test;
  3 | 
  4 | use PHPUnit\Framework\TestCase;
  5 | 
  6 | use PhpMvc\InternalHelper;
  7 | 
  8 | final class ArrayToObjectTest extends TestCase
  9 | {
 10 | 
 11 |     public function testStrict(): void
 12 |     {
 13 |         $array = array(
 14 |             'string' => 'hello',
 15 |             'number' => 123,
 16 |             'b_string' => 'world!',
 17 |             'b_number' => 321,
 18 |             'b_boolean' => true,
 19 |             'b_c_string' => 'I am C!',
 20 |             'b_c_number' => 111,
 21 |             'b_c_array' => array(1, 2, 3, 4, 5),
 22 |             'b_d[0]_string[0]' => 'first',
 23 |             'b_d[0]_string[1]' => 'second',
 24 |             'b_d[1]_string[0]' => 'second first',
 25 |             'b_d[1]_string[1]' => 'double second',
 26 |         );
 27 | 
 28 |         InternalHelper::arrayToObject($array, $result, '\Test\A');
 29 | 
 30 |         $this->assertEquals('hello', $result->string);
 31 |         $this->assertEquals(123, $result->number);
 32 |         $this->assertEquals('world!', $result->b->string);
 33 |         $this->assertEquals(321, $result->b->number);
 34 |         $this->assertEquals(true, $result->b->boolean);
 35 |         $this->assertEquals('I am C!', $result->b->c->string);
 36 |         $this->assertEquals(111, $result->b->c->number);
 37 |         $this->assertEquals(json_encode(array(1, 2, 3, 4, 5)), json_encode($result->b->c->array));
 38 |         $this->assertEquals('first', $result->b->d[0]->string[0]);
 39 |         $this->assertEquals('second', $result->b->d[0]->string[1]);
 40 |         $this->assertEquals('second first', $result->b->d[1]->string[0]);
 41 |         $this->assertEquals('double second', $result->b->d[1]->string[1]);
 42 | 
 43 |         $this->assertInstanceOf(A::class, $result);
 44 |         $this->assertInstanceOf(B::class, $result->b);
 45 |         $this->assertInstanceOf(C::class, $result->b->c);
 46 |         $this->assertInstanceOf(D::class, $result->b->d[0]);
 47 |         $this->assertInstanceOf(D::class, $result->b->d[1]);
 48 | 
 49 |         $this->assertInternalType('string', $result->string);
 50 |         $this->assertInternalType('integer', $result->number);
 51 |         $this->assertInternalType('string', $result->b->string);
 52 |         $this->assertInternalType('integer', $result->b->number);
 53 |         $this->assertInternalType('boolean', $result->b->boolean);
 54 |         $this->assertInternalType('string', $result->b->c->string);
 55 |         $this->assertInternalType('integer', $result->b->c->number);
 56 |         $this->assertInternalType('array', $result->b->c->array);
 57 |         $this->assertInternalType('string', $result->b->d[0]->string[0]);
 58 |         $this->assertInternalType('string', $result->b->d[0]->string[1]);
 59 |         $this->assertInternalType('string', $result->b->d[1]->string[0]);
 60 |         $this->assertInternalType('string', $result->b->d[1]->string[1]);
 61 |     }
 62 | 
 63 |     public function testNonStrict(): void
 64 |     {
 65 |         $array = array(
 66 |             'string' => 'hello',
 67 |             'number' => 123,
 68 |             'b_string' => 'world!',
 69 |             'b_number' => 321,
 70 |             'b_boolean' => true,
 71 |             'b_c_string' => 'I am C!',
 72 |             'b_c_number' => 111,
 73 |             'b_c_array' => array(1, 2, 3, 4, 5),
 74 |             'b_d[0]_string[0]' => 'first',
 75 |             'b_d[0]_string[1]' => 'second',
 76 |             'b_d[1]_string[0]' => 'second first',
 77 |             'b_d[1]_string[1]' => 'double second',
 78 |         );
 79 | 
 80 |         InternalHelper::arrayToObject($array, $result);
 81 | 
 82 |         $this->assertEquals('hello', $result->string);
 83 |         $this->assertEquals(123, $result->number);
 84 |         $this->assertEquals('world!', $result->b->string);
 85 |         $this->assertEquals(321, $result->b->number);
 86 |         $this->assertEquals(true, $result->b->boolean);
 87 |         $this->assertEquals('I am C!', $result->b->c->string);
 88 |         $this->assertEquals(111, $result->b->c->number);
 89 |         $this->assertEquals(json_encode(array(1, 2, 3, 4, 5)), json_encode($result->b->c->array));
 90 |         $this->assertEquals('first', $result->b->d[0]->string[0]);
 91 |         $this->assertEquals('second', $result->b->d[0]->string[1]);
 92 |         $this->assertEquals('second first', $result->b->d[1]->string[0]);
 93 |         $this->assertEquals('double second', $result->b->d[1]->string[1]);
 94 | 
 95 |         $this->assertInstanceOf(\stdClass::class, $result);
 96 |         $this->assertInstanceOf(\stdClass::class, $result->b);
 97 |         $this->assertInstanceOf(\stdClass::class, $result->b->c);
 98 |         $this->assertInstanceOf(\stdClass::class, $result->b->d[0]);
 99 |         $this->assertInstanceOf(\stdClass::class, $result->b->d[1]);
100 | 
101 |         $this->assertInternalType('string', $result->string);
102 |         $this->assertInternalType('integer', $result->number);
103 |         $this->assertInternalType('string', $result->b->string);
104 |         $this->assertInternalType('integer', $result->b->number);
105 |         $this->assertInternalType('boolean', $result->b->boolean);
106 |         $this->assertInternalType('string', $result->b->c->string);
107 |         $this->assertInternalType('integer', $result->b->c->number);
108 |         $this->assertInternalType('array', $result->b->c->array);
109 |         $this->assertInternalType('string', $result->b->d[0]->string[0]);
110 |         $this->assertInternalType('string', $result->b->d[0]->string[1]);
111 |         $this->assertInternalType('string', $result->b->d[1]->string[0]);
112 |         $this->assertInternalType('string', $result->b->d[1]->string[1]);
113 |     }
114 | 
115 | }
116 | 
117 | class A {
118 | 
119 |     /**
120 |      * @var string
121 |      */
122 |     public $string;
123 | 
124 |     /**
125 |      * @var int
126 |      */
127 |     public $number;
128 | 
129 |     /**
130 |      * @var B
131 |      */
132 |     public $b;
133 | 
134 | }
135 | 
136 | class B {
137 | 
138 |     /**
139 |      * @var string
140 |      */
141 |     public $string;
142 | 
143 |     /**
144 |      * @var int
145 |      */
146 |     public $number;
147 | 
148 |     /**
149 |      * @var bool
150 |      */
151 |     public $boolean;
152 | 
153 |     /**
154 |      * @var C
155 |      */
156 |     public $c;
157 | 
158 |     /**
159 |      * @var D[]
160 |      */
161 |     public $d;
162 | 
163 | }
164 | 
165 | class C {
166 | 
167 |     /**
168 |      * @var string
169 |      */
170 |     public $string;
171 | 
172 |     /**
173 |      * @var int
174 |      */
175 |     public $number;
176 | 
177 |     /**
178 |      * @var array
179 |      */
180 |     public $array;
181 | 
182 | }
183 | 
184 | class D {
185 | 
186 |     /**
187 |      * @var string
188 |      */
189 |     public $string;
190 | 
191 | }


--------------------------------------------------------------------------------