diff --git a/.gitattributes b/.gitattributes index 16d8d2934..6b37e6727 100644 --- a/.gitattributes +++ b/.gitattributes @@ -4,6 +4,7 @@ /.travis.yml export-ignore /composer.lock export-ignore /docs/ export-ignore +/infection.json.dist export-ignore /mkdocs.yml export-ignore /phpcs.xml export-ignore /phpunit.xml.dist export-ignore diff --git a/.gitignore b/.gitignore index 245087af8..a7677c949 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,8 @@ /clover.xml /coveralls-upload.json /docs/html/ +/infection-log.txt +/infection.json /phpunit.xml /vendor/ /zf-mkdoc-theme.tgz diff --git a/.travis.yml b/.travis.yml index 3c5f852b5..49bc879bd 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,26 +13,6 @@ env: matrix: include: - - php: 5.6 - env: - - DEPS=lowest - - php: 5.6 - env: - - DEPS=locked - - LEGACY_DEPS="phpunit/phpunit" - - php: 5.6 - env: - - DEPS=latest - - php: 7 - env: - - DEPS=lowest - - php: 7 - env: - - DEPS=locked - - LEGACY_DEPS="phpunit/phpunit" - - php: 7 - env: - - DEPS=latest - php: 7.1 env: - DEPS=lowest @@ -58,8 +38,7 @@ before_install: - if [[ $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi install: - - travis_retry composer install $COMPOSER_ARGS --ignore-platform-reqs - - if [[ $LEGACY_DEPS != '' ]]; then travis_retry composer update $COMPOSER_ARGS --with-dependencies $LEGACY_DEPS ; fi + - travis_retry composer install $COMPOSER_ARGS - if [[ $DEPS == 'latest' ]]; then travis_retry composer update $COMPOSER_ARGS ; fi - if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable $COMPOSER_ARGS ; fi - if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry composer require --dev $COMPOSER_ARGS $COVERAGE_DEPS ; fi diff --git a/LICENSE.md b/LICENSE.md index 63df4102c..d44ab5dc7 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright (c) 2005-2017, Zend Technologies USA, Inc. +Copyright (c) 2005-2018, Zend Technologies USA, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, diff --git a/composer.json b/composer.json index e34462775..7994474a5 100644 --- a/composer.json +++ b/composer.json @@ -15,24 +15,33 @@ "slack": "https://zendframework-slack.herokuapp.com", "forum": "https://discourse.zendframework.com/c/questions/components" }, + "repositories": [ + { + "type": "vcs", + "url": "https://github.com/Xerkus/zend-router.git" + } + ], "require": { + "php": "^7.1", "container-interop/container-interop": "^1.2", - "php": "^5.6 || ^7.0", + "fig/http-message-util": "^1.1", + "psr/container": "^1.0", + "psr/http-message": "^1.0", + "psr/http-server-handler": "^1.0", + "zendframework/zend-diactoros": "^1.7", "zendframework/zend-eventmanager": "^3.2", - "zendframework/zend-http": "^2.7", - "zendframework/zend-modulemanager": "^2.8", - "zendframework/zend-router": "^3.0.2", + "zendframework/zend-httphandlerrunner": "^1.0", + "zendframework/zend-router": "dev-make-mvc-great-again", "zendframework/zend-servicemanager": "^3.3", "zendframework/zend-stdlib": "^3.1", - "zendframework/zend-view": "^2.9" + "zendframework/zend-view": "^2.10" }, "require-dev": { - "http-interop/http-middleware": "^0.4.1", - "phpunit/phpunit": "^6.4.4 || ^5.7.14", + "phpunit/phpunit": "^7.0", "zendframework/zend-coding-standard": "~1.0.0", - "zendframework/zend-json": "^2.6.1 || ^3.0", - "zendframework/zend-psr7bridge": "^1.0", - "zendframework/zend-stratigility": "^2.0.1" + "zendframework/zend-json": "^3.0", + "zendframework/zend-stratigility": "3.0.0-alpha3", + "zendframework/zend-validator": "^2.10" }, "suggest": { "zendframework/zend-json": "(^2.6.1 || ^3.0) To auto-deserialize JSON body content in AbstractRestfulController extensions, when json_decode is unavailable", diff --git a/composer.lock b/composer.lock index 0087b6629..c8af484bf 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "This file is @generated automatically" ], - "content-hash": "4dca15262833c4fd34ad940c5472e161", + "content-hash": "5b872e10eb6c5b2512b0533ce4cc1198", "packages": [ { "name": "container-interop/container-interop", @@ -37,6 +37,56 @@ "homepage": "https://github.com/container-interop/container-interop", "time": "2017-02-14T19:40:03+00:00" }, + { + "name": "fig/http-message-util", + "version": "1.1.2", + "source": { + "type": "git", + "url": "https://github.com/php-fig/http-message-util.git", + "reference": "20b2c280cb6914b7b83089720df44e490f4b42f0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/http-message-util/zipball/20b2c280cb6914b7b83089720df44e490f4b42f0", + "reference": "20b2c280cb6914b7b83089720df44e490f4b42f0", + "shasum": "" + }, + "require": { + "php": "^5.3 || ^7.0", + "psr/http-message": "^1.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.1.x-dev" + } + }, + "autoload": { + "psr-4": { + "Fig\\Http\\Message\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "description": "Utility classes and constants for use with PSR-7 (psr/http-message)", + "keywords": [ + "http", + "http-message", + "psr", + "psr-7", + "request", + "response" + ], + "time": "2017-02-09T16:10:21+00:00" + }, { "name": "psr/container", "version": "1.0.0", @@ -87,108 +137,159 @@ "time": "2017-02-14T16:28:37+00:00" }, { - "name": "zendframework/zend-config", - "version": "3.1.0", + "name": "psr/http-message", + "version": "1.0.1", "source": { "type": "git", - "url": "https://github.com/zendframework/zend-config.git", - "reference": "a12e4a592bf66d9629b84960e268f3752e53abe4" + "url": "https://github.com/php-fig/http-message.git", + "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-config/zipball/a12e4a592bf66d9629b84960e268f3752e53abe4", - "reference": "a12e4a592bf66d9629b84960e268f3752e53abe4", + "url": "https://api.github.com/repos/php-fig/http-message/zipball/f6561bf28d520154e4b0ec72be95418abe6d9363", + "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363", "shasum": "" }, "require": { - "ext-json": "*", - "php": "^5.6 || ^7.0", - "psr/container": "^1.0", - "zendframework/zend-stdlib": "^2.7.7 || ^3.1" + "php": ">=5.3.0" }, - "conflict": { - "container-interop/container-interop": "<1.2.0" + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } }, - "require-dev": { - "malukenho/docheader": "^0.1.5", - "phpunit/phpunit": "^5.7 || ^6.0", - "zendframework/zend-coding-standard": "~1.0.0", - "zendframework/zend-filter": "^2.7.1", - "zendframework/zend-i18n": "^2.7.3", - "zendframework/zend-servicemanager": "^2.7.8 || ^3.2.1" + "autoload": { + "psr-4": { + "Psr\\Http\\Message\\": "src/" + } }, - "suggest": { - "zendframework/zend-filter": "^2.7.1; install if you want to use the Filter processor", - "zendframework/zend-i18n": "^2.7.3; install if you want to use the Translator processor", - "zendframework/zend-servicemanager": "^2.7.8 || ^3.2.1; if you need an extensible plugin manager for use with the Config Factory" + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "description": "Common interface for HTTP messages", + "homepage": "https://github.com/php-fig/http-message", + "keywords": [ + "http", + "http-message", + "psr", + "psr-7", + "request", + "response" + ], + "time": "2016-08-06T14:39:51+00:00" + }, + { + "name": "psr/http-server-handler", + "version": "1.0.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/http-server-handler.git", + "reference": "439d92054dc06097f2406ec074a2627839955a02" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/http-server-handler/zipball/439d92054dc06097f2406ec074a2627839955a02", + "reference": "439d92054dc06097f2406ec074a2627839955a02", + "shasum": "" + }, + "require": { + "php": ">=7.0", + "psr/http-message": "^1.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "3.1-dev", - "dev-develop": "3.2-dev" + "dev-master": "1.0.x-dev" } }, "autoload": { "psr-4": { - "Zend\\Config\\": "src/" + "Psr\\Http\\Server\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD-3-Clause" + "MIT" ], - "description": "provides a nested object property based user interface for accessing this configuration data within application code", - "homepage": "https://github.com/zendframework/zend-config", + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "description": "Common interface for HTTP server-side request handler", "keywords": [ - "config", - "zf2" + "handler", + "http", + "http-interop", + "psr", + "psr-15", + "psr-7", + "request", + "response", + "server" ], - "time": "2017-02-22T14:31:10+00:00" + "time": "2018-01-22T17:04:15+00:00" }, { - "name": "zendframework/zend-escaper", - "version": "2.5.2", + "name": "zendframework/zend-diactoros", + "version": "1.7.0", "source": { "type": "git", - "url": "https://github.com/zendframework/zend-escaper.git", - "reference": "2dcd14b61a72d8b8e27d579c6344e12c26141d4e" + "url": "https://github.com/zendframework/zend-diactoros.git", + "reference": "ed6ce7e2105c400ca10277643a8327957c0384b7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-escaper/zipball/2dcd14b61a72d8b8e27d579c6344e12c26141d4e", - "reference": "2dcd14b61a72d8b8e27d579c6344e12c26141d4e", + "url": "https://api.github.com/repos/zendframework/zend-diactoros/zipball/ed6ce7e2105c400ca10277643a8327957c0384b7", + "reference": "ed6ce7e2105c400ca10277643a8327957c0384b7", "shasum": "" }, "require": { - "php": ">=5.5" + "php": "^5.6 || ^7.0", + "psr/http-message": "^1.0" + }, + "provide": { + "psr/http-message-implementation": "1.0" }, "require-dev": { - "fabpot/php-cs-fixer": "1.7.*", - "phpunit/phpunit": "~4.0" + "ext-dom": "*", + "ext-libxml": "*", + "phpunit/phpunit": "^5.7.16 || ^6.0.8", + "zendframework/zend-coding-standard": "~1.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "2.5-dev", - "dev-develop": "2.6-dev" + "dev-master": "1.7.x-dev", + "dev-develop": "1.8.x-dev" } }, "autoload": { "psr-4": { - "Zend\\Escaper\\": "src/" + "Zend\\Diactoros\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD-3-Clause" + "BSD-2-Clause" ], - "homepage": "https://github.com/zendframework/zend-escaper", + "description": "PSR HTTP Message implementations", + "homepage": "https://github.com/zendframework/zend-diactoros", "keywords": [ - "escaper", - "zf2" + "http", + "psr", + "psr-7" ], - "time": "2016-06-30T19:48:38+00:00" + "time": "2018-01-04T18:21:48+00:00" }, { "name": "zendframework/zend-eventmanager", @@ -245,57 +346,58 @@ "time": "2017-07-11T19:17:22+00:00" }, { - "name": "zendframework/zend-http", - "version": "2.7.0", + "name": "zendframework/zend-httphandlerrunner", + "version": "1.0.0", "source": { "type": "git", - "url": "https://github.com/zendframework/zend-http.git", - "reference": "78aa510c0ea64bfb2aa234f50c4f232c9531acfa" + "url": "https://github.com/zendframework/zend-httphandlerrunner.git", + "reference": "9010659232e98c3fbfa575c184f7945e26e20380" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-http/zipball/78aa510c0ea64bfb2aa234f50c4f232c9531acfa", - "reference": "78aa510c0ea64bfb2aa234f50c4f232c9531acfa", + "url": "https://api.github.com/repos/zendframework/zend-httphandlerrunner/zipball/9010659232e98c3fbfa575c184f7945e26e20380", + "reference": "9010659232e98c3fbfa575c184f7945e26e20380", "shasum": "" }, "require": { - "php": "^5.6 || ^7.0", - "zendframework/zend-loader": "^2.5.1", - "zendframework/zend-stdlib": "^3.1 || ^2.7.7", - "zendframework/zend-uri": "^2.5.2", - "zendframework/zend-validator": "^2.10.1" + "php": "^7.1", + "psr/http-message": "^1.0", + "psr/http-message-implementation": "^1.0", + "psr/http-server-handler": "^1.0" }, "require-dev": { - "phpunit/phpunit": "^6.4.1 || ^5.7.15", + "phpunit/phpunit": "^6.3", "zendframework/zend-coding-standard": "~1.0.0", - "zendframework/zend-config": "^3.1 || ^2.6" + "zendframework/zend-diactoros": "^1.7" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "2.7-dev", - "dev-develop": "2.8-dev" + "dev-master": "1.0-dev" + }, + "zf": { + "config-provider": "Zend\\HttpHandlerRunner\\ConfigProvider" } }, "autoload": { "psr-4": { - "Zend\\Http\\": "src/" + "Zend\\HttpHandlerRunner\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], - "description": "provides an easy interface for performing Hyper-Text Transfer Protocol (HTTP) requests", - "homepage": "https://github.com/zendframework/zend-http", + "description": "Execute PSR-15 RequestHandlerInterface instances and emit responses they generate.", "keywords": [ "ZendFramework", - "http", - "http client", - "zend", + "components", + "expressive", + "psr-15", + "psr-7", "zf" ], - "time": "2017-10-13T12:06:24+00:00" + "time": "2018-02-05T14:21:31+00:00" }, { "name": "zendframework/zend-loader", @@ -341,96 +443,35 @@ ], "time": "2015-06-03T14:05:47+00:00" }, - { - "name": "zendframework/zend-modulemanager", - "version": "2.8.1", - "source": { - "type": "git", - "url": "https://github.com/zendframework/zend-modulemanager.git", - "reference": "710c13353b1ff0975777dbeb39bbf1c85e3353a3" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-modulemanager/zipball/710c13353b1ff0975777dbeb39bbf1c85e3353a3", - "reference": "710c13353b1ff0975777dbeb39bbf1c85e3353a3", - "shasum": "" - }, - "require": { - "php": "^5.6 || ^7.0", - "zendframework/zend-config": "^3.1 || ^2.6", - "zendframework/zend-eventmanager": "^3.2 || ^2.6.3", - "zendframework/zend-stdlib": "^3.0 || ^2.7" - }, - "require-dev": { - "phpunit/phpunit": "^6.0.8 || ^5.7.15", - "zendframework/zend-coding-standard": "~1.0.0", - "zendframework/zend-console": "^2.6", - "zendframework/zend-di": "^2.6", - "zendframework/zend-loader": "^2.5", - "zendframework/zend-mvc": "^2.7", - "zendframework/zend-servicemanager": "^3.0.3 || ^2.7.5" - }, - "suggest": { - "zendframework/zend-console": "Zend\\Console component", - "zendframework/zend-loader": "Zend\\Loader component if you are not using Composer autoloading for your modules", - "zendframework/zend-mvc": "Zend\\Mvc component", - "zendframework/zend-servicemanager": "Zend\\ServiceManager component" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.8-dev", - "dev-develop": "2.9-dev" - } - }, - "autoload": { - "psr-4": { - "Zend\\ModuleManager\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "homepage": "https://github.com/zendframework/zend-modulemanager", - "keywords": [ - "modulemanager", - "zf2" - ], - "time": "2017-11-01T18:30:41+00:00" - }, { "name": "zendframework/zend-router", - "version": "3.0.2", + "version": "dev-make-mvc-great-again", "source": { "type": "git", - "url": "https://github.com/zendframework/zend-router.git", - "reference": "03763610632a9022aff22a0e8f340852e68392a1" + "url": "https://github.com/Xerkus/zend-router.git", + "reference": "b0dea47dc05ebae7217246b6b81f006bdd1aa009" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-router/zipball/03763610632a9022aff22a0e8f340852e68392a1", - "reference": "03763610632a9022aff22a0e8f340852e68392a1", + "url": "https://api.github.com/repos/Xerkus/zend-router/zipball/b0dea47dc05ebae7217246b6b81f006bdd1aa009", + "reference": "b0dea47dc05ebae7217246b6b81f006bdd1aa009", "shasum": "" }, "require": { - "container-interop/container-interop": "^1.1", - "php": "^5.5 || ^7.0", - "zendframework/zend-http": "^2.5", - "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3", - "zendframework/zend-stdlib": "^2.7.5 || ^3.0" - }, - "conflict": { - "zendframework/zend-mvc": "<3.0.0" + "container-interop/container-interop": "^1.2", + "php": "^7.1", + "psr/http-message": "^1.0", + "zendframework/zend-diactoros": "^1.7", + "zendframework/zend-servicemanager": "^3.3", + "zendframework/zend-stdlib": "^3.1" }, "require-dev": { - "phpunit/phpunit": "^4.5", - "sebastian/version": "^1.0.4", - "squizlabs/php_codesniffer": "^2.3", - "zendframework/zend-i18n": "^2.6" + "phpunit/phpunit": "^7.0", + "zendframework/zend-coding-standard": "~1.0.0", + "zendframework/zend-i18n": "^2.7.4" }, "suggest": { - "zendframework/zend-i18n": "^2.6, if defining translatable HTTP path segments" + "zendframework/zend-i18n": "^2.7.4, if defining translatable HTTP path segments" }, "type": "library", "extra": { @@ -448,30 +489,61 @@ "Zend\\Router\\": "src/" } }, - "notification-url": "https://packagist.org/downloads/", + "autoload-dev": { + "psr-4": { + "ZendTest\\Router\\": "test/" + } + }, + "scripts": { + "check": [ + "@cs-check", + "@test" + ], + "cs-check": [ + "phpcs" + ], + "cs-fix": [ + "phpcbf" + ], + "test": [ + "phpunit --colors=always" + ], + "test-coverage": [ + "phpunit --colors=always --coverage-clover clover.xml" + ] + }, "license": [ "BSD-3-Clause" ], - "homepage": "https://github.com/zendframework/zend-router", + "description": "Flexible routing system for HTTP and console applications", "keywords": [ - "mvc", "routing", - "zf2" + "zend", + "zendframework", + "zf" ], - "time": "2016-05-31T20:47:48+00:00" + "support": { + "docs": "https://docs.zendframework.com/zend-router/", + "issues": "https://github.com/zendframework/zend-router/issues", + "source": "https://github.com/zendframework/zend-router", + "rss": "https://github.com/zendframework/zend-router/releases.atom", + "slack": "https://zendframework-slack.herokuapp.com", + "forum": "https://discourse.zendframework.com/c/questions/components" + }, + "time": "2018-02-03T06:17:22+00:00" }, { "name": "zendframework/zend-servicemanager", - "version": "3.3.0", + "version": "3.3.2", "source": { "type": "git", "url": "https://github.com/zendframework/zend-servicemanager.git", - "reference": "c3036efb81f71bfa36cc9962ee5d4474f36581d0" + "reference": "9f35a104b8d4d3b32da5f4a3b6efc0dd62e5af42" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-servicemanager/zipball/c3036efb81f71bfa36cc9962ee5d4474f36581d0", - "reference": "c3036efb81f71bfa36cc9962ee5d4474f36581d0", + "url": "https://api.github.com/repos/zendframework/zend-servicemanager/zipball/9f35a104b8d4d3b32da5f4a3b6efc0dd62e5af42", + "reference": "9f35a104b8d4d3b32da5f4a3b6efc0dd62e5af42", "shasum": "" }, "require": { @@ -485,10 +557,10 @@ "psr/container-implementation": "^1.0" }, "require-dev": { - "mikey179/vfsstream": "^1.6", + "mikey179/vfsstream": "^1.6.5", "ocramius/proxy-manager": "^1.0 || ^2.0", - "phpbench/phpbench": "^0.10.0", - "phpunit/phpunit": "^5.7 || ^6.0.6", + "phpbench/phpbench": "^0.13.0", + "phpunit/phpunit": "^5.7.25 || ^6.4.4", "zendframework/zend-coding-standard": "~1.0.0" }, "suggest": { @@ -503,7 +575,7 @@ "extra": { "branch-alias": { "dev-master": "3.3-dev", - "dev-develop": "3.4-dev" + "dev-develop": "4.0-dev" } }, "autoload": { @@ -515,13 +587,18 @@ "license": [ "BSD-3-Clause" ], - "homepage": "https://github.com/zendframework/zend-servicemanager", + "description": "Factory-Driven Dependency Injection Container", "keywords": [ + "PSR-11", + "ZendFramework", + "dependency-injection", + "di", + "dic", "service-manager", "servicemanager", "zf" ], - "time": "2017-03-01T22:08:02+00:00" + "time": "2018-01-29T16:48:37+00:00" }, { "name": "zendframework/zend-stdlib", @@ -568,136 +645,18 @@ ], "time": "2016-09-13T14:38:50+00:00" }, - { - "name": "zendframework/zend-uri", - "version": "2.5.2", - "source": { - "type": "git", - "url": "https://github.com/zendframework/zend-uri.git", - "reference": "0bf717a239432b1a1675ae314f7c4acd742749ed" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-uri/zipball/0bf717a239432b1a1675ae314f7c4acd742749ed", - "reference": "0bf717a239432b1a1675ae314f7c4acd742749ed", - "shasum": "" - }, - "require": { - "php": "^5.5 || ^7.0", - "zendframework/zend-escaper": "^2.5", - "zendframework/zend-validator": "^2.5" - }, - "require-dev": { - "fabpot/php-cs-fixer": "1.7.*", - "phpunit/phpunit": "~4.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.5-dev", - "dev-develop": "2.6-dev" - } - }, - "autoload": { - "psr-4": { - "Zend\\Uri\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "description": "a component that aids in manipulating and validating ยป Uniform Resource Identifiers (URIs)", - "homepage": "https://github.com/zendframework/zend-uri", - "keywords": [ - "uri", - "zf2" - ], - "time": "2016-02-17T22:38:51+00:00" - }, - { - "name": "zendframework/zend-validator", - "version": "2.10.1", - "source": { - "type": "git", - "url": "https://github.com/zendframework/zend-validator.git", - "reference": "010084ddbd33299bf51ea6f0e07f8f4e8bd832a8" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-validator/zipball/010084ddbd33299bf51ea6f0e07f8f4e8bd832a8", - "reference": "010084ddbd33299bf51ea6f0e07f8f4e8bd832a8", - "shasum": "" - }, - "require": { - "container-interop/container-interop": "^1.1", - "php": "^5.6 || ^7.0", - "zendframework/zend-stdlib": "^2.7.6 || ^3.1" - }, - "require-dev": { - "phpunit/phpunit": "^6.0.8 || ^5.7.15", - "zendframework/zend-cache": "^2.6.1", - "zendframework/zend-coding-standard": "~1.0.0", - "zendframework/zend-config": "^2.6", - "zendframework/zend-db": "^2.7", - "zendframework/zend-filter": "^2.6", - "zendframework/zend-http": "^2.5.4", - "zendframework/zend-i18n": "^2.6", - "zendframework/zend-math": "^2.6", - "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3", - "zendframework/zend-session": "^2.8", - "zendframework/zend-uri": "^2.5" - }, - "suggest": { - "zendframework/zend-db": "Zend\\Db component, required by the (No)RecordExists validator", - "zendframework/zend-filter": "Zend\\Filter component, required by the Digits validator", - "zendframework/zend-i18n": "Zend\\I18n component to allow translation of validation error messages", - "zendframework/zend-i18n-resources": "Translations of validator messages", - "zendframework/zend-math": "Zend\\Math component, required by the Csrf validator", - "zendframework/zend-servicemanager": "Zend\\ServiceManager component to allow using the ValidatorPluginManager and validator chains", - "zendframework/zend-session": "Zend\\Session component, ^2.8; required by the Csrf validator", - "zendframework/zend-uri": "Zend\\Uri component, required by the Uri and Sitemap\\Loc validators" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.10-dev", - "dev-develop": "2.11-dev" - }, - "zf": { - "component": "Zend\\Validator", - "config-provider": "Zend\\Validator\\ConfigProvider" - } - }, - "autoload": { - "psr-4": { - "Zend\\Validator\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "description": "provides a set of commonly needed validators", - "homepage": "https://github.com/zendframework/zend-validator", - "keywords": [ - "validator", - "zf2" - ], - "time": "2017-08-22T14:19:23+00:00" - }, { "name": "zendframework/zend-view", - "version": "2.9.0", + "version": "2.10.0", "source": { "type": "git", "url": "https://github.com/zendframework/zend-view.git", - "reference": "3b6342c381c4437a03fc81d0064c0bb8924914d3" + "reference": "4478cc5dd960e2339d88b363ef99fa278700e80e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-view/zipball/3b6342c381c4437a03fc81d0064c0bb8924914d3", - "reference": "3b6342c381c4437a03fc81d0064c0bb8924914d3", + "url": "https://api.github.com/repos/zendframework/zend-view/zipball/4478cc5dd960e2339d88b363ef99fa278700e80e", + "reference": "4478cc5dd960e2339d88b363ef99fa278700e80e", "shasum": "" }, "require": { @@ -728,7 +687,7 @@ "zendframework/zend-router": "^3.0.1", "zendframework/zend-serializer": "^2.6.1", "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3", - "zendframework/zend-session": "^2.6.2", + "zendframework/zend-session": "^2.8.1", "zendframework/zend-uri": "^2.5" }, "suggest": { @@ -752,8 +711,8 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "2.9-dev", - "dev-develop": "3.0-dev" + "dev-master": "2.10.x-dev", + "dev-develop": "2.11.x-dev" } }, "autoload": { @@ -771,91 +730,43 @@ "view", "zf2" ], - "time": "2017-03-21T15:05:56+00:00" + "time": "2018-01-17T22:21:50+00:00" } ], - "packages-dev": [ - { - "name": "doctrine/instantiator", - "version": "1.1.0", - "source": { - "type": "git", - "url": "https://github.com/doctrine/instantiator.git", - "reference": "185b8868aa9bf7159f5f953ed5afb2d7fcdc3bda" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/doctrine/instantiator/zipball/185b8868aa9bf7159f5f953ed5afb2d7fcdc3bda", - "reference": "185b8868aa9bf7159f5f953ed5afb2d7fcdc3bda", - "shasum": "" - }, - "require": { - "php": "^7.1" - }, - "require-dev": { - "athletic/athletic": "~0.1.8", - "ext-pdo": "*", - "ext-phar": "*", - "phpunit/phpunit": "^6.2.3", - "squizlabs/php_codesniffer": "^3.0.2" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.2.x-dev" - } - }, - "autoload": { - "psr-4": { - "Doctrine\\Instantiator\\": "src/Doctrine/Instantiator/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Marco Pivetta", - "email": "ocramius@gmail.com", - "homepage": "http://ocramius.github.com/" - } - ], - "description": "A small, lightweight utility to instantiate objects in PHP without invoking their constructors", - "homepage": "https://github.com/doctrine/instantiator", - "keywords": [ - "constructor", - "instantiate" - ], - "time": "2017-07-22T11:58:36+00:00" - }, + "packages-dev": [ { - "name": "http-interop/http-middleware", - "version": "0.4.1", + "name": "doctrine/instantiator", + "version": "1.1.0", "source": { "type": "git", - "url": "https://github.com/http-interop/http-middleware.git", - "reference": "9a801fe60e70d5d608b61d56b2dcde29516c81b9" + "url": "https://github.com/doctrine/instantiator.git", + "reference": "185b8868aa9bf7159f5f953ed5afb2d7fcdc3bda" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/http-interop/http-middleware/zipball/9a801fe60e70d5d608b61d56b2dcde29516c81b9", - "reference": "9a801fe60e70d5d608b61d56b2dcde29516c81b9", + "url": "https://api.github.com/repos/doctrine/instantiator/zipball/185b8868aa9bf7159f5f953ed5afb2d7fcdc3bda", + "reference": "185b8868aa9bf7159f5f953ed5afb2d7fcdc3bda", "shasum": "" }, "require": { - "php": ">=5.3.0", - "psr/http-message": "^1.0" + "php": "^7.1" + }, + "require-dev": { + "athletic/athletic": "~0.1.8", + "ext-pdo": "*", + "ext-phar": "*", + "phpunit/phpunit": "^6.2.3", + "squizlabs/php_codesniffer": "^3.0.2" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.0.x-dev" + "dev-master": "1.2.x-dev" } }, "autoload": { "psr-4": { - "Interop\\Http\\ServerMiddleware\\": "src/" + "Doctrine\\Instantiator\\": "src/Doctrine/Instantiator/" } }, "notification-url": "https://packagist.org/downloads/", @@ -864,23 +775,18 @@ ], "authors": [ { - "name": "PHP-FIG", - "homepage": "http://www.php-fig.org/" + "name": "Marco Pivetta", + "email": "ocramius@gmail.com", + "homepage": "http://ocramius.github.com/" } ], - "description": "Common interface for HTTP server-side middleware", + "description": "A small, lightweight utility to instantiate objects in PHP without invoking their constructors", + "homepage": "https://github.com/doctrine/instantiator", "keywords": [ - "factory", - "http", - "middleware", - "psr", - "psr-17", - "psr-7", - "request", - "response" + "constructor", + "instantiate" ], - "abandoned": "http-interop/http-server-middleware", - "time": "2017-01-14T15:23:42+00:00" + "time": "2017-07-22T11:58:36+00:00" }, { "name": "myclabs/deep-copy", @@ -1085,29 +991,35 @@ }, { "name": "phpdocumentor/reflection-docblock", - "version": "4.1.1", + "version": "4.3.0", "source": { "type": "git", "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git", - "reference": "2d3d238c433cf69caeb4842e97a3223a116f94b2" + "reference": "94fd0001232e47129dd3504189fa1c7225010d08" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/2d3d238c433cf69caeb4842e97a3223a116f94b2", - "reference": "2d3d238c433cf69caeb4842e97a3223a116f94b2", + "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/94fd0001232e47129dd3504189fa1c7225010d08", + "reference": "94fd0001232e47129dd3504189fa1c7225010d08", "shasum": "" }, "require": { "php": "^7.0", - "phpdocumentor/reflection-common": "^1.0@dev", + "phpdocumentor/reflection-common": "^1.0.0", "phpdocumentor/type-resolver": "^0.4.0", "webmozart/assert": "^1.0" }, "require-dev": { - "mockery/mockery": "^0.9.4", - "phpunit/phpunit": "^4.4" + "doctrine/instantiator": "~1.0.5", + "mockery/mockery": "^1.0", + "phpunit/phpunit": "^6.4" }, "type": "library", + "extra": { + "branch-alias": { + "dev-master": "4.x-dev" + } + }, "autoload": { "psr-4": { "phpDocumentor\\Reflection\\": [ @@ -1126,7 +1038,7 @@ } ], "description": "With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.", - "time": "2017-08-30T18:51:59+00:00" + "time": "2017-11-30T07:14:17+00:00" }, { "name": "phpdocumentor/type-resolver", @@ -1177,16 +1089,16 @@ }, { "name": "phpspec/prophecy", - "version": "v1.7.2", + "version": "1.7.3", "source": { "type": "git", "url": "https://github.com/phpspec/prophecy.git", - "reference": "c9b8c6088acd19d769d4cc0ffa60a9fe34344bd6" + "reference": "e4ed002c67da8eceb0eb8ddb8b3847bb53c5c2bf" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpspec/prophecy/zipball/c9b8c6088acd19d769d4cc0ffa60a9fe34344bd6", - "reference": "c9b8c6088acd19d769d4cc0ffa60a9fe34344bd6", + "url": "https://api.github.com/repos/phpspec/prophecy/zipball/e4ed002c67da8eceb0eb8ddb8b3847bb53c5c2bf", + "reference": "e4ed002c67da8eceb0eb8ddb8b3847bb53c5c2bf", "shasum": "" }, "require": { @@ -1198,7 +1110,7 @@ }, "require-dev": { "phpspec/phpspec": "^2.5|^3.2", - "phpunit/phpunit": "^4.8 || ^5.6.5" + "phpunit/phpunit": "^4.8.35 || ^5.7" }, "type": "library", "extra": { @@ -1236,45 +1148,44 @@ "spy", "stub" ], - "time": "2017-09-04T11:05:03+00:00" + "time": "2017-11-24T13:59:53+00:00" }, { "name": "phpunit/php-code-coverage", - "version": "5.2.3", + "version": "6.0.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "8e1d2397d8adf59a3f12b2878a3aaa66d1ab189d" + "reference": "f8ca4b604baf23dab89d87773c28cc07405189ba" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/8e1d2397d8adf59a3f12b2878a3aaa66d1ab189d", - "reference": "8e1d2397d8adf59a3f12b2878a3aaa66d1ab189d", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/f8ca4b604baf23dab89d87773c28cc07405189ba", + "reference": "f8ca4b604baf23dab89d87773c28cc07405189ba", "shasum": "" }, "require": { "ext-dom": "*", "ext-xmlwriter": "*", - "php": "^7.0", + "php": "^7.1", "phpunit/php-file-iterator": "^1.4.2", "phpunit/php-text-template": "^1.2.1", - "phpunit/php-token-stream": "^2.0", + "phpunit/php-token-stream": "^3.0", "sebastian/code-unit-reverse-lookup": "^1.0.1", "sebastian/environment": "^3.0", "sebastian/version": "^2.0.1", "theseer/tokenizer": "^1.1" }, "require-dev": { - "ext-xdebug": "^2.5", - "phpunit/phpunit": "^6.0" + "phpunit/phpunit": "^7.0" }, "suggest": { - "ext-xdebug": "^2.5.5" + "ext-xdebug": "^2.6.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "5.2.x-dev" + "dev-master": "6.0-dev" } }, "autoload": { @@ -1289,7 +1200,7 @@ "authors": [ { "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", + "email": "sebastian@phpunit.de", "role": "lead" } ], @@ -1300,20 +1211,20 @@ "testing", "xunit" ], - "time": "2017-11-03T13:47:33+00:00" + "time": "2018-02-02T07:01:41+00:00" }, { "name": "phpunit/php-file-iterator", - "version": "1.4.2", + "version": "1.4.5", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-file-iterator.git", - "reference": "3cc8f69b3028d0f96a9078e6295d86e9bf019be5" + "reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/3cc8f69b3028d0f96a9078e6295d86e9bf019be5", - "reference": "3cc8f69b3028d0f96a9078e6295d86e9bf019be5", + "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/730b01bc3e867237eaac355e06a36b85dd93a8b4", + "reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4", "shasum": "" }, "require": { @@ -1347,7 +1258,7 @@ "filesystem", "iterator" ], - "time": "2016-10-03T07:40:28+00:00" + "time": "2017-11-27T13:52:08+00:00" }, { "name": "phpunit/php-text-template", @@ -1392,28 +1303,28 @@ }, { "name": "phpunit/php-timer", - "version": "1.0.9", + "version": "2.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-timer.git", - "reference": "3dcf38ca72b158baf0bc245e9184d3fdffa9c46f" + "reference": "8b8454ea6958c3dee38453d3bd571e023108c91f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/3dcf38ca72b158baf0bc245e9184d3fdffa9c46f", - "reference": "3dcf38ca72b158baf0bc245e9184d3fdffa9c46f", + "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/8b8454ea6958c3dee38453d3bd571e023108c91f", + "reference": "8b8454ea6958c3dee38453d3bd571e023108c91f", "shasum": "" }, "require": { - "php": "^5.3.3 || ^7.0" + "php": "^7.1" }, "require-dev": { - "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0" + "phpunit/phpunit": "^7.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.0-dev" + "dev-master": "2.0-dev" } }, "autoload": { @@ -1428,7 +1339,7 @@ "authors": [ { "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", + "email": "sebastian@phpunit.de", "role": "lead" } ], @@ -1437,33 +1348,33 @@ "keywords": [ "timer" ], - "time": "2017-02-26T11:10:40+00:00" + "time": "2018-02-01T13:07:23+00:00" }, { "name": "phpunit/php-token-stream", - "version": "2.0.1", + "version": "3.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-token-stream.git", - "reference": "9a02332089ac48e704c70f6cefed30c224e3c0b0" + "reference": "21ad88bbba7c3d93530d93994e0a33cd45f02ace" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/9a02332089ac48e704c70f6cefed30c224e3c0b0", - "reference": "9a02332089ac48e704c70f6cefed30c224e3c0b0", + "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/21ad88bbba7c3d93530d93994e0a33cd45f02ace", + "reference": "21ad88bbba7c3d93530d93994e0a33cd45f02ace", "shasum": "" }, "require": { "ext-tokenizer": "*", - "php": "^7.0" + "php": "^7.1" }, "require-dev": { - "phpunit/phpunit": "^6.2.4" + "phpunit/phpunit": "^7.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "2.0-dev" + "dev-master": "3.0-dev" } }, "autoload": { @@ -1486,20 +1397,20 @@ "keywords": [ "tokenizer" ], - "time": "2017-08-20T05:47:52+00:00" + "time": "2018-02-01T13:16:43+00:00" }, { "name": "phpunit/phpunit", - "version": "6.4.4", + "version": "7.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "562f7dc75d46510a4ed5d16189ae57fbe45a9932" + "reference": "9b3373439fdf2f3e9d1578f5e408a3a0d161c3bc" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/562f7dc75d46510a4ed5d16189ae57fbe45a9932", - "reference": "562f7dc75d46510a4ed5d16189ae57fbe45a9932", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/9b3373439fdf2f3e9d1578f5e408a3a0d161c3bc", + "reference": "9b3373439fdf2f3e9d1578f5e408a3a0d161c3bc", "shasum": "" }, "require": { @@ -1511,15 +1422,15 @@ "myclabs/deep-copy": "^1.6.1", "phar-io/manifest": "^1.0.1", "phar-io/version": "^1.0", - "php": "^7.0", + "php": "^7.1", "phpspec/prophecy": "^1.7", - "phpunit/php-code-coverage": "^5.2.2", - "phpunit/php-file-iterator": "^1.4.2", + "phpunit/php-code-coverage": "^6.0", + "phpunit/php-file-iterator": "^1.4.3", "phpunit/php-text-template": "^1.2.1", - "phpunit/php-timer": "^1.0.9", - "phpunit/phpunit-mock-objects": "^4.0.3", - "sebastian/comparator": "^2.0.2", - "sebastian/diff": "^2.0", + "phpunit/php-timer": "^2.0", + "phpunit/phpunit-mock-objects": "^6.0", + "sebastian/comparator": "^2.1", + "sebastian/diff": "^3.0", "sebastian/environment": "^3.1", "sebastian/exporter": "^3.1", "sebastian/global-state": "^2.0", @@ -1527,16 +1438,12 @@ "sebastian/resource-operations": "^1.0", "sebastian/version": "^2.0.1" }, - "conflict": { - "phpdocumentor/reflection-docblock": "3.0.2", - "phpunit/dbunit": "<3.0" - }, "require-dev": { "ext-pdo": "*" }, "suggest": { "ext-xdebug": "*", - "phpunit/php-invoker": "^1.1" + "phpunit/php-invoker": "^2.0" }, "bin": [ "phpunit" @@ -1544,7 +1451,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "6.4.x-dev" + "dev-master": "7.0-dev" } }, "autoload": { @@ -1570,33 +1477,30 @@ "testing", "xunit" ], - "time": "2017-11-08T11:26:09+00:00" + "time": "2018-02-02T05:04:08+00:00" }, { "name": "phpunit/phpunit-mock-objects", - "version": "4.0.4", + "version": "6.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit-mock-objects.git", - "reference": "2f789b59ab89669015ad984afa350c4ec577ade0" + "reference": "e495e5d3660321b62c294d8c0e954d02d6ce2573" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/2f789b59ab89669015ad984afa350c4ec577ade0", - "reference": "2f789b59ab89669015ad984afa350c4ec577ade0", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/e495e5d3660321b62c294d8c0e954d02d6ce2573", + "reference": "e495e5d3660321b62c294d8c0e954d02d6ce2573", "shasum": "" }, "require": { "doctrine/instantiator": "^1.0.5", - "php": "^7.0", + "php": "^7.1", "phpunit/php-text-template": "^1.2.1", - "sebastian/exporter": "^3.0" - }, - "conflict": { - "phpunit/phpunit": "<6.0" + "sebastian/exporter": "^3.1" }, "require-dev": { - "phpunit/phpunit": "^6.0" + "phpunit/phpunit": "^7.0" }, "suggest": { "ext-soap": "*" @@ -1604,7 +1508,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "4.0.x-dev" + "dev-master": "6.0.x-dev" } }, "autoload": { @@ -1619,7 +1523,7 @@ "authors": [ { "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", + "email": "sebastian@phpunit.de", "role": "lead" } ], @@ -1629,24 +1533,26 @@ "mock", "xunit" ], - "time": "2017-08-03T14:08:16+00:00" + "time": "2018-02-01T13:11:13+00:00" }, { - "name": "psr/http-message", - "version": "1.0.1", + "name": "psr/http-server-middleware", + "version": "1.0.0", "source": { "type": "git", - "url": "https://github.com/php-fig/http-message.git", - "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363" + "url": "https://github.com/php-fig/http-server-middleware.git", + "reference": "ea17eb1fb2c8df6db919cc578451a8013c6a0ae5" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-fig/http-message/zipball/f6561bf28d520154e4b0ec72be95418abe6d9363", - "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363", + "url": "https://api.github.com/repos/php-fig/http-server-middleware/zipball/ea17eb1fb2c8df6db919cc578451a8013c6a0ae5", + "reference": "ea17eb1fb2c8df6db919cc578451a8013c6a0ae5", "shasum": "" }, "require": { - "php": ">=5.3.0" + "php": ">=7.0", + "psr/http-message": "^1.0", + "psr/http-server-handler": "^1.0" }, "type": "library", "extra": { @@ -1656,7 +1562,7 @@ }, "autoload": { "psr-4": { - "Psr\\Http\\Message\\": "src/" + "Psr\\Http\\Server\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", @@ -1669,17 +1575,18 @@ "homepage": "http://www.php-fig.org/" } ], - "description": "Common interface for HTTP messages", - "homepage": "https://github.com/php-fig/http-message", + "description": "Common interface for HTTP server-side middleware", "keywords": [ "http", - "http-message", + "http-interop", + "middleware", "psr", + "psr-15", "psr-7", "request", "response" ], - "time": "2016-08-06T14:39:51+00:00" + "time": "2018-01-22T17:08:31+00:00" }, { "name": "sebastian/code-unit-reverse-lookup", @@ -1728,21 +1635,21 @@ }, { "name": "sebastian/comparator", - "version": "2.1.0", + "version": "2.1.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/comparator.git", - "reference": "1174d9018191e93cb9d719edec01257fc05f8158" + "reference": "34369daee48eafb2651bea869b4b15d75ccc35f9" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/1174d9018191e93cb9d719edec01257fc05f8158", - "reference": "1174d9018191e93cb9d719edec01257fc05f8158", + "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/34369daee48eafb2651bea869b4b15d75ccc35f9", + "reference": "34369daee48eafb2651bea869b4b15d75ccc35f9", "shasum": "" }, "require": { "php": "^7.0", - "sebastian/diff": "^2.0", + "sebastian/diff": "^2.0 || ^3.0", "sebastian/exporter": "^3.1" }, "require-dev": { @@ -1788,32 +1695,33 @@ "compare", "equality" ], - "time": "2017-11-03T07:16:52+00:00" + "time": "2018-02-01T13:46:46+00:00" }, { "name": "sebastian/diff", - "version": "2.0.1", + "version": "3.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/diff.git", - "reference": "347c1d8b49c5c3ee30c7040ea6fc446790e6bddd" + "reference": "e09160918c66281713f1c324c1f4c4c3037ba1e8" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/347c1d8b49c5c3ee30c7040ea6fc446790e6bddd", - "reference": "347c1d8b49c5c3ee30c7040ea6fc446790e6bddd", + "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/e09160918c66281713f1c324c1f4c4c3037ba1e8", + "reference": "e09160918c66281713f1c324c1f4c4c3037ba1e8", "shasum": "" }, "require": { - "php": "^7.0" + "php": "^7.1" }, "require-dev": { - "phpunit/phpunit": "^6.2" + "phpunit/phpunit": "^7.0", + "symfony/process": "^2 || ^3.3 || ^4" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "2.0-dev" + "dev-master": "3.0-dev" } }, "autoload": { @@ -1838,9 +1746,12 @@ "description": "Diff implementation", "homepage": "https://github.com/sebastianbergmann/diff", "keywords": [ - "diff" + "diff", + "udiff", + "unidiff", + "unified diff" ], - "time": "2017-08-03T08:09:46+00:00" + "time": "2018-02-01T13:45:15+00:00" }, { "name": "sebastian/environment", @@ -2358,110 +2269,18 @@ "description": "A small library for converting tokenized PHP source code into XML and potentially other formats", "time": "2017-04-07T12:08:54+00:00" }, - { - "name": "webimpress/composer-extra-dependency", - "version": "0.2.2", - "source": { - "type": "git", - "url": "https://github.com/webimpress/composer-extra-dependency.git", - "reference": "31fa56391d30f03b1180c87610cbe22254780ad9" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/webimpress/composer-extra-dependency/zipball/31fa56391d30f03b1180c87610cbe22254780ad9", - "reference": "31fa56391d30f03b1180c87610cbe22254780ad9", - "shasum": "" - }, - "require": { - "composer-plugin-api": "^1.1", - "php": "^5.6 || ^7.0" - }, - "require-dev": { - "composer/composer": "^1.5.2", - "mikey179/vfsstream": "^1.6.5", - "phpunit/phpunit": "^5.7.22 || ^6.4.1", - "zendframework/zend-coding-standard": "~1.0.0" - }, - "type": "composer-plugin", - "extra": { - "class": "Webimpress\\ComposerExtraDependency\\Plugin" - }, - "autoload": { - "psr-4": { - "Webimpress\\ComposerExtraDependency\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-2-Clause" - ], - "description": "Composer plugin to require extra dependencies", - "homepage": "https://github.com/webimpress/composer-extra-dependency", - "keywords": [ - "composer", - "dependency", - "webimpress" - ], - "time": "2017-10-17T17:15:14+00:00" - }, - { - "name": "webimpress/http-middleware-compatibility", - "version": "0.1.4", - "source": { - "type": "git", - "url": "https://github.com/webimpress/http-middleware-compatibility.git", - "reference": "8ed1c2c7523dce0035b98bc4f3a73ca9cd1d3717" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/webimpress/http-middleware-compatibility/zipball/8ed1c2c7523dce0035b98bc4f3a73ca9cd1d3717", - "reference": "8ed1c2c7523dce0035b98bc4f3a73ca9cd1d3717", - "shasum": "" - }, - "require": { - "http-interop/http-middleware": "^0.1.1 || ^0.2 || ^0.3 || ^0.4.1 || ^0.5", - "php": "^5.6 || ^7.0", - "webimpress/composer-extra-dependency": "^0.2.2" - }, - "require-dev": { - "phpunit/phpunit": "^5.7.23 || ^6.4.3" - }, - "type": "library", - "extra": { - "dependency": [ - "http-interop/http-middleware" - ] - }, - "autoload": { - "files": [ - "autoload/http-middleware.php" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-2-Clause" - ], - "description": "Compatibility library for Draft PSR-15 HTTP Middleware", - "homepage": "https://github.com/webimpress/http-middleware-compatibility", - "keywords": [ - "middleware", - "psr-15", - "webimpress" - ], - "time": "2017-10-17T17:31:10+00:00" - }, { "name": "webmozart/assert", - "version": "1.2.0", + "version": "1.3.0", "source": { "type": "git", "url": "https://github.com/webmozart/assert.git", - "reference": "2db61e59ff05fe5126d152bd0655c9ea113e550f" + "reference": "0df1908962e7a3071564e857d86874dad1ef204a" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/webmozart/assert/zipball/2db61e59ff05fe5126d152bd0655c9ea113e550f", - "reference": "2db61e59ff05fe5126d152bd0655c9ea113e550f", + "url": "https://api.github.com/repos/webmozart/assert/zipball/0df1908962e7a3071564e857d86874dad1ef204a", + "reference": "0df1908962e7a3071564e857d86874dad1ef204a", "shasum": "" }, "require": { @@ -2498,7 +2317,7 @@ "check", "validate" ], - "time": "2016-11-23T20:04:58+00:00" + "time": "2018-01-29T19:49:41+00:00" }, { "name": "zendframework/zend-coding-standard", @@ -2530,78 +2349,70 @@ "time": "2016-11-09T21:30:43+00:00" }, { - "name": "zendframework/zend-diactoros", - "version": "1.6.1", + "name": "zendframework/zend-escaper", + "version": "2.5.2", "source": { "type": "git", - "url": "https://github.com/zendframework/zend-diactoros.git", - "reference": "c8664b92a6d5bc229e48b0923486c097e45a7877" + "url": "https://github.com/zendframework/zend-escaper.git", + "reference": "2dcd14b61a72d8b8e27d579c6344e12c26141d4e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-diactoros/zipball/c8664b92a6d5bc229e48b0923486c097e45a7877", - "reference": "c8664b92a6d5bc229e48b0923486c097e45a7877", + "url": "https://api.github.com/repos/zendframework/zend-escaper/zipball/2dcd14b61a72d8b8e27d579c6344e12c26141d4e", + "reference": "2dcd14b61a72d8b8e27d579c6344e12c26141d4e", "shasum": "" }, "require": { - "php": "^5.6 || ^7.0", - "psr/http-message": "^1.0" - }, - "provide": { - "psr/http-message-implementation": "1.0" + "php": ">=5.5" }, "require-dev": { - "ext-dom": "*", - "ext-libxml": "*", - "phpunit/phpunit": "^5.7.16 || ^6.0.8", - "zendframework/zend-coding-standard": "~1.0" + "fabpot/php-cs-fixer": "1.7.*", + "phpunit/phpunit": "~4.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.6-dev", - "dev-develop": "1.7-dev" + "dev-master": "2.5-dev", + "dev-develop": "2.6-dev" } }, "autoload": { "psr-4": { - "Zend\\Diactoros\\": "src/" + "Zend\\Escaper\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD-2-Clause" + "BSD-3-Clause" ], - "description": "PSR HTTP Message implementations", - "homepage": "https://github.com/zendframework/zend-diactoros", + "homepage": "https://github.com/zendframework/zend-escaper", "keywords": [ - "http", - "psr", - "psr-7" + "escaper", + "zf2" ], - "time": "2017-10-12T15:24:51+00:00" + "time": "2016-06-30T19:48:38+00:00" }, { "name": "zendframework/zend-json", - "version": "3.0.0", + "version": "3.1.0", "source": { "type": "git", "url": "https://github.com/zendframework/zend-json.git", - "reference": "f42a1588e75c2a3e338cd94c37906231e616daab" + "reference": "4dd940e8e6f32f1d36ea6b0677ea57c540c7c19c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-json/zipball/f42a1588e75c2a3e338cd94c37906231e616daab", - "reference": "f42a1588e75c2a3e338cd94c37906231e616daab", + "url": "https://api.github.com/repos/zendframework/zend-json/zipball/4dd940e8e6f32f1d36ea6b0677ea57c540c7c19c", + "reference": "4dd940e8e6f32f1d36ea6b0677ea57c540c7c19c", "shasum": "" }, "require": { - "php": "^5.5 || ^7.0" + "php": "^5.6 || ^7.0" }, "require-dev": { - "phpunit/phpunit": "~4.0", - "squizlabs/php_codesniffer": "^2.3", - "zendframework/zend-stdlib": "^2.7 || ^3.0" + "phpunit/phpunit": "^5.7.23 || ^6.4.3", + "zendframework/zend-coding-standard": "~1.0.0", + "zendframework/zend-stdlib": "^2.7.7 || ^3.1" }, "suggest": { "zendframework/zend-json-server": "For implementing JSON-RPC servers", @@ -2610,8 +2421,8 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "3.0-dev", - "dev-develop": "3.1-dev" + "dev-master": "3.1.x-dev", + "dev-develop": "3.2.x-dev" } }, "autoload": { @@ -2624,126 +2435,158 @@ "BSD-3-Clause" ], "description": "provides convenience methods for serializing native PHP to JSON and decoding JSON to native PHP", - "homepage": "https://github.com/zendframework/zend-json", "keywords": [ + "ZendFramework", "json", - "zf2" + "zf" ], - "time": "2016-04-01T02:34:00+00:00" + "time": "2018-01-04T17:51:34+00:00" }, { - "name": "zendframework/zend-psr7bridge", - "version": "1.0.0", + "name": "zendframework/zend-stratigility", + "version": "3.0.0alpha3", "source": { "type": "git", - "url": "https://github.com/zendframework/zend-psr7bridge.git", - "reference": "935721336ded76fd5ba90ba7637c7d85b4d0cf68" + "url": "https://github.com/zendframework/zend-stratigility.git", + "reference": "e346801682bad999320ee89285b62643f27735a9" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-psr7bridge/zipball/935721336ded76fd5ba90ba7637c7d85b4d0cf68", - "reference": "935721336ded76fd5ba90ba7637c7d85b4d0cf68", + "url": "https://api.github.com/repos/zendframework/zend-stratigility/zipball/e346801682bad999320ee89285b62643f27735a9", + "reference": "e346801682bad999320ee89285b62643f27735a9", "shasum": "" }, "require": { - "php": "^5.6 || ^7.0", + "php": "^7.1", "psr/http-message": "^1.0", - "zendframework/zend-diactoros": "^1.1", - "zendframework/zend-http": "^2.6" + "psr/http-server-middleware": "^1.0", + "zendframework/zend-escaper": "^2.3" }, "require-dev": { - "phpunit/phpunit": "^5.7.15 || ^6.0.8", - "zendframework/zend-coding-standard": "~1.0.0" + "malukenho/docheader": "^0.1.6", + "phpunit/phpunit": "^6.5.5", + "zendframework/zend-coding-standard": "~1.0.0", + "zendframework/zend-diactoros": "^1.0" + }, + "suggest": { + "psr/http-message-implementation": "Please install a psr/http-message-implementation to consume Stratigility; e.g., zendframework/zend-diactoros" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.0-dev", - "dev-develop": "1.1-dev" + "dev-master": "3.0-dev", + "dev-develop": "3.1-dev", + "dev-release-3.0.0": "3.0.x-dev" } }, "autoload": { + "files": [ + "src/functions/double-pass-middleware.php", + "src/functions/host.php", + "src/functions/middleware.php", + "src/functions/path.php" + ], "psr-4": { - "Zend\\Psr7Bridge\\": "src/" + "Zend\\Stratigility\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], - "description": "PSR-7 <-> Zend\\Http bridge", - "homepage": "https://github.com/zendframework/zend-psr7bridge", + "description": "PSR-7 middleware foundation for building and dispatching middleware pipelines", "keywords": [ "ZendFramework", "http", - "psr", + "middleware", + "psr-15", "psr-7", - "zend" + "zf" ], - "time": "2017-08-02T15:52:02+00:00" + "time": "2018-02-05T21:18:43+00:00" }, { - "name": "zendframework/zend-stratigility", - "version": "2.1.2", + "name": "zendframework/zend-validator", + "version": "2.10.2", "source": { "type": "git", - "url": "https://github.com/zendframework/zend-stratigility.git", - "reference": "7dfec8dee92dad0d01e68365015f2848c250fe9f" + "url": "https://github.com/zendframework/zend-validator.git", + "reference": "38109ed7d8e46cfa71bccbe7e6ca80cdd035f8c9" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/zendframework/zend-stratigility/zipball/7dfec8dee92dad0d01e68365015f2848c250fe9f", - "reference": "7dfec8dee92dad0d01e68365015f2848c250fe9f", + "url": "https://api.github.com/repos/zendframework/zend-validator/zipball/38109ed7d8e46cfa71bccbe7e6ca80cdd035f8c9", + "reference": "38109ed7d8e46cfa71bccbe7e6ca80cdd035f8c9", "shasum": "" }, "require": { + "container-interop/container-interop": "^1.1", "php": "^5.6 || ^7.0", - "psr/http-message": "^1.0", - "webimpress/http-middleware-compatibility": "^0.1.3", - "zendframework/zend-escaper": "^2.3" + "zendframework/zend-stdlib": "^2.7.6 || ^3.1" }, "require-dev": { - "malukenho/docheader": "^0.1.5", "phpunit/phpunit": "^6.0.8 || ^5.7.15", + "zendframework/zend-cache": "^2.6.1", "zendframework/zend-coding-standard": "~1.0.0", - "zendframework/zend-diactoros": "^1.0" + "zendframework/zend-config": "^2.6", + "zendframework/zend-db": "^2.7", + "zendframework/zend-filter": "^2.6", + "zendframework/zend-http": "^2.5.4", + "zendframework/zend-i18n": "^2.6", + "zendframework/zend-math": "^2.6", + "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3", + "zendframework/zend-session": "^2.8", + "zendframework/zend-uri": "^2.5" }, "suggest": { - "psr/http-message-implementation": "Please install a psr/http-message-implementation to consume Stratigility; e.g., zendframework/zend-diactoros" + "zendframework/zend-db": "Zend\\Db component, required by the (No)RecordExists validator", + "zendframework/zend-filter": "Zend\\Filter component, required by the Digits validator", + "zendframework/zend-i18n": "Zend\\I18n component to allow translation of validation error messages", + "zendframework/zend-i18n-resources": "Translations of validator messages", + "zendframework/zend-math": "Zend\\Math component, required by the Csrf validator", + "zendframework/zend-servicemanager": "Zend\\ServiceManager component to allow using the ValidatorPluginManager and validator chains", + "zendframework/zend-session": "Zend\\Session component, ^2.8; required by the Csrf validator", + "zendframework/zend-uri": "Zend\\Uri component, required by the Uri and Sitemap\\Loc validators" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "2.1.0-dev", - "dev-develop": "2.2.0-dev" + "dev-master": "2.10.x-dev", + "dev-develop": "2.11.x-dev" + }, + "zf": { + "component": "Zend\\Validator", + "config-provider": "Zend\\Validator\\ConfigProvider" } }, "autoload": { "psr-4": { - "Zend\\Stratigility\\": "src/" + "Zend\\Validator\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], - "description": "Middleware for PHP", - "homepage": "https://github.com/zendframework/zend-stratigility", + "description": "provides a set of commonly needed validators", + "homepage": "https://github.com/zendframework/zend-validator", "keywords": [ - "http", - "middleware", - "psr-7" + "validator", + "zf2" ], - "time": "2017-10-12T13:14:14+00:00" + "time": "2018-02-01T17:05:33+00:00" } ], "aliases": [], "minimum-stability": "stable", - "stability-flags": [], + "stability-flags": { + "zendframework/zend-router": 20, + "zendframework/zend-stratigility": 15 + }, "prefer-stable": false, "prefer-lowest": false, "platform": { - "php": "^5.6 || ^7.0" + "php": "^7.1" }, "platform-dev": [] } diff --git a/docs/book/intro.md b/docs/book/intro.md index 178e64aea..859635af2 100644 --- a/docs/book/intro.md +++ b/docs/book/intro.md @@ -25,7 +25,7 @@ Within the MVC layer, several sub-components are exposed: - `Zend\Mvc\Controller`, a set of abstract "controller" classes with basic responsibilities such as event wiring, action dispatching, etc., as well as controller plugins. -- `Zend\Mvc\Service` provides a set of zend-servicemanager factories and +- `Zend\Mvc\Container` provides a set of zend-servicemanager factories and definitions for the default application workflow. - `Zend\Mvc\View` provides default wiring for renderer selection, view script resolution, helper registration, and more; additionally, it provides a @@ -271,7 +271,7 @@ services available by default yet. You can greatly simplify things by using the ```php use Zend\Loader\AutoloaderFactory; -use Zend\Mvc\Service\ServiceManagerConfig; +use Zend\Mvc\Container\ServiceManagerConfig; use Zend\ServiceManager\ServiceManager; // setup autoloader @@ -300,7 +300,7 @@ You can make this even simpler by using the `init()` method of the ```php use Zend\Loader\AutoloaderFactory; use Zend\Mvc\Application; -use Zend\Mvc\Service\ServiceManagerConfig; +use Zend\Mvc\Container\ServiceManagerConfig; use Zend\ServiceManager\ServiceManager; // setup autoloader diff --git a/docs/book/services.md b/docs/book/services.md index 1e3a82e66..4aaae2508 100644 --- a/docs/book/services.md +++ b/docs/book/services.md @@ -1,7 +1,7 @@ # Default Services The default and recommended way to write zend-mvc applications uses a set of -services defined in the `Zend\Mvc\Service` namespace. This chapter details what +services defined in the `Zend\Mvc\Container` namespace. This chapter details what each of those services are, the classes they represent, and the configuration options available. @@ -17,17 +17,17 @@ somewhat complex set of services and their factories has been created. We'll try to give a simplified explanation of the process. When a `Zend\Mvc\Application` is created, a `Zend\ServiceManager\ServiceManager` -object is created and configured via `Zend\Mvc\Service\ServiceManagerConfig`. +object is created and configured via `Zend\Mvc\Container\ServiceManagerConfig`. The `ServiceManagerConfig` gets the configuration from `config/application.config.php` (or some other application configuration you passed to the `Application` when creating it). From all the service and -factories provided in the `Zend\Mvc\Service` namespace, `ServiceManagerConfig` +factories provided in the `Zend\Mvc\Container` namespace, `ServiceManagerConfig` is responsible of configuring only three: `SharedEventManager`, `EventManager`, and `ModuleManager`. After this, the `Application` fetches the `ModuleManager`. At this point, the `ModuleManager` further configures the `ServiceManager` with services and -factories provided in `Zend\Mvc\Service\ServiceListenerFactory`. This approach +factories provided in `Zend\Mvc\Container\ServiceListenerFactory`. This approach allows us to keep the main application configuration concise, and to give the developer the power to configure different parts of the MVC system from within the modules, overriding any default configuration in these MVC services. @@ -84,14 +84,14 @@ services configured out of the box. ### Factories -- `Application`, mapping to `Zend\Mvc\Service\ApplicationFactory`. +- `Application`, mapping to `Zend\Mvc\Container\ApplicationFactory`. -- `Config`, mapping to `Zend\Mvc\Service\ConfigFactory`. Internally, this +- `Config`, mapping to `Zend\Mvc\Container\ConfigFactory`. Internally, this pulls the `ModuleManager` service, calls its `loadModules()` method, and retrieves the merged configuration from the module event. As such, this service contains the entire, merged application configuration. -- `ControllerManager`, mapping to `Zend\Mvc\Service\ControllerLoaderFactory`. +- `ControllerManager`, mapping to `Zend\Mvc\Container\ControllerManagerFactory`. This creates an instance of `Zend\Mvc\Controller\ControllerManager`, passing the service manager instance. Additionally, it uses the `DiStrictAbstractServiceFactory` service, effectively allowing you to fall @@ -112,7 +112,7 @@ services configured out of the box. service, as long as the `setPluginManager` method is implemented. - `ControllerPluginManager`, mapping to - `Zend\Mvc\Service\ControllerPluginManagerFactory`. This instantiates the + `Zend\Mvc\Container\ControllerPluginManagerFactory`. This instantiates the `Zend\Mvc\Controller\PluginManager` instance, passing it the service manager instance. It also uses the `DiAbstractServiceFactory` service, effectively allowing you to fall back to DI in order to retrieve your [controller plugins](plugins.md). @@ -158,13 +158,13 @@ services configured out of the box. This creates an instance of `Zend\Mvc\Service\DiStrictAbstractServiceFactoryFactory`, injecting the `Di` service instance. -- `EventManager`, mapping to `Zend\Mvc\Service\EventManagerFactory`. This +- `EventManager`, mapping to `Zend\Mvc\Container\EventManagerFactory`. This factory returns a *discrete* instance of `Zend\EventManager\EventManager` on each request. This service is not shared by default, allowing the ability to have an `EventManager` per service, with a shared `SharedEventManager` injected in each. -- `FilterManager`, mapping to `Zend\Mvc\Service\FilterManagerFactory`. This +- `FilterManager`, mapping to `Zend\Mvc\Container\FilterManagerFactory`. This instantiates the `Zend\Filter\FilterPluginManager` instance, passing it the service manager instance; this is used to manage filters for [filter chains](http://docs.zendframework.com/zend-filter/filter-chains/). It also uses the `DiAbstractServiceFactory` service, effectively allowing @@ -180,11 +180,6 @@ services configured out of the box. the `Config` service, and pulls from the `router` key, configuring a `Zend\Router\Http\TreeRouteStack` instance. -- `HttpViewManager`, mapping to `Zend\Mvc\Service\HttpViewManagerFactory`. - This creates and returns an instance of `Zend\Mvc\View\Http\ViewManager`, - which in turn registers and initializes a number of HTTP-specific view - services. - - `HydratorManager`, mapping to `Zend\Mvc\Service\HydratorManagerFactory`. This creates and returns an instance of `Zend\Stdlib\Hydrator\HydratorPluginManager`, which can be used to manage and persist hydrator instances. @@ -193,14 +188,14 @@ services configured out of the box. This creates and returns an instance of `Zend\InputFilter\InputFilterPluginManager`, which can be used to manage and persist input filter instances. -- `ModuleManager`, mapping to `Zend\Mvc\Service\ModuleManagerFactory`. This is +- `ModuleManager`, mapping to `Zend\Mvc\Container\ModuleManagerFactory`. This is perhaps the most complex factory in the MVC stack. It expects that an `ApplicationConfig` service has been injected, with keys for `module_listener_options` and `modules`; see the quick start for samples. It creates an instance of `Zend\ModuleManager\Listener\DefaultListenerAggregate`, using the `module_listener_options` retrieved. It then checks if a service with the name `ServiceListener` exists; if not, it sets a factory with that - name mapping to `Zend\Mvc\Service\ServiceListenerFactory`. A bunch of + name mapping to `Zend\Mvc\Container\ServiceListenerFactory`. A bunch of service listeners will be added to the `ServiceListener`, like listeners for the `getServiceConfig`, `getControllerConfig`, `getControllerPluginConfig`, and `getViewHelperConfig` module methods. Next, it retrieves the @@ -216,20 +211,20 @@ services configured out of the box. allowing the instance to be used anywhere a translator may be required in the framework. -- `PaginatorPluginManager`, mapping to `Zend\Mvc\Service\PaginatorPluginManagerFactory`. +- `PaginatorPluginManager`, mapping to `Zend\Mvc\Container\PaginatorPluginManagerFactory`. This instantiates the `Zend\Paginator\AdapterPluginManager` instance, passing it the service manager instance. This is used to manage [paginator adapters](https://docs.zendframework.com/zend-paginator/advanced/#custom-data-source-adapters). It also uses the `DiAbstractServiceFactory` service, effectively allowing you to fall back to DI in order to retrieve paginator adapters. -- `Request`, mapping to `Zend\Mvc\Service\RequestFactory`. The factory is used +- `Request`, mapping to `Zend\Mvc\Container\RequestFactory`. The factory is used to create and return a request instance, according to the current environment. If the current environment is a console environment, it will create a `Zend\Console\Request`; otherwise, for HTTP environments, it creates a `Zend\Http\PhpEnvironment\Request`. -- `Response`, mapping to `Zend\Mvc\Service\ResponseFactory`. The factory is +- `Response`, mapping to `Zend\Mvc\Container\ResponseFactory`. The factory is used to create and return a response instance, according to the current environment. If the current environment is a console environment, it will create a `Zend\Console\Response`; otherwise, for HTTP environments, it @@ -249,7 +244,7 @@ services configured out of the box. which returns an instance of `Zend\Serializer\AdapterPluginManager`. This is a plugin manager for managing serializer adapter instances. -- `ServiceListener`, mapping to `Zend\Mvc\Service\ServiceListenerFactory`. The +- `ServiceListener`, mapping to `Zend\Mvc\Container\ServiceListenerFactory`. The factory is used to instantiate the `ServiceListener`, while allowing easy extending. It checks if a service with the name `ServiceListenerInterface` exists, which must implement `Zend\ModuleManager\Listener\ServiceListenerInterface`, @@ -266,15 +261,15 @@ services configured out of the box. It also uses the `DiAbstractServiceFactory` service, effectively allowing you to fall back to DI in order to retrieve validators. -- `ViewFeedRenderer`, mapping to `Zend\Mvc\Service\ViewFeedRendererFactory`, +- `ViewFeedRenderer`, mapping to `Zend\Mvc\Container\ViewFeedRendererFactory`, which returns an instance of `Zend\View\Renderer\FeedRenderer`, used to render feeds. -- `ViewFeedStrategy`, mapping to `Zend\Mvc\Service\ViewFeedStrategyFactory`, +- `ViewFeedStrategy`, mapping to `Zend\Mvc\Container\ViewFeedStrategyFactory`, which returns an instance of `Zend\View\Strategy\FeedStrategy`, used to select the `ViewFeedRenderer` given the appropriate criteria. -- `ViewHelperManager`, mapping to `Zend\Mvc\Service\ViewHelperManagerFactory`, +- `ViewHelperManager`, mapping to `Zend\Mvc\Container\ViewHelperManagerFactory`, which returns an instance of `Zend\View\HelperManager`. This is a plugin manager for managing view helper instances. @@ -282,24 +277,24 @@ services configured out of the box. which returns an instance of `Zend\View\Renderer\JsonRenderer`, used to render JSON structures. -- `ViewJsonStrategy`, mapping to `Zend\Mvc\Service\ViewJsonStrategyFactory`, +- `ViewJsonStrategy`, mapping to `Zend\Mvc\Container\ViewJsonStrategyFactory`, which returns an instance of `Zend\View\Strategy\JsonStrategy`, used to select the `ViewJsonRenderer` given the appropriate criteria. -- `ViewManager`, mapping to `Zend\Mvc\Service\ViewManagerFactory`. The factory +- `ViewManager`, mapping to `Zend\Mvc\Container\ViewManagerFactory`. The factory is used to create and return a view manager, according to the current environment. If the current environment is a console environment, it will create a `Zend\Mvc\View\Console\ViewManager`; otherwise, for HTTP environments, it returns a `Zend\Mvc\View\Http\ViewManager`. -- `ViewResolver`, mapping to `Zend\Mvc\Service\ViewResolverFactory`, which +- `ViewResolver`, mapping to `Zend\Mvc\Container\ViewResolverFactory`, which creates and returns the aggregate view resolver. It also attaches the `ViewTemplateMapResolver` and `ViewTemplatePathStack` services to it. -- `ViewTemplateMapResolver`, mapping to `Zend\Mvc\Service\ViewTemplateMapResolverFactory`, +- `ViewTemplateMapResolver`, mapping to `Zend\Mvc\Container\ViewTemplateMapResolverFactory`, which creates, configures and returns the `Zend\View\Resolver\TemplateMapResolver`. -- `ViewTemplatePathStack`, mapping to `Zend\Mvc\Service\ViewTemplatePathStackFactory`, +- `ViewTemplatePathStack`, mapping to `Zend\Mvc\Container\ViewTemplatePathStackFactory`, which creates, configures and returns the `Zend\View\Resolver\TemplatePathStack`. ### Abstract factories @@ -519,7 +514,7 @@ created and managed by the `ViewManager`: - `ViewHelperManager`, representing and aliased to `Zend\View\HelperPluginManager`. It is seeded with the `ServiceManager`. Created via the - `Zend\Mvc\Service\ViewHelperManagerFactory`. + `Zend\Mvc\Container\ViewHelperManagerFactory`. - The `Router` service is retrieved, and injected into the `Url` helper. diff --git a/infection.json.dist b/infection.json.dist new file mode 100644 index 000000000..b883a216b --- /dev/null +++ b/infection.json.dist @@ -0,0 +1,11 @@ +{ + "timeout": 10, + "source": { + "directories": [ + "src" + ] + }, + "logs": { + "text": "infection-log.txt" + } +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 1d2f5d300..50551655c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -23,4 +23,4 @@ pages: site_name: zend-mvc site_description: 'zend-mvc: MVC application provider' repo_url: 'https://github.com/zendframework/zend-mvc' -copyright: 'Copyright (c) 2005-2017 Zend Technologies USA Inc.' +copyright: 'Copyright (c) 2005-2018 Zend Technologies USA Inc.' diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 2cffbef67..1668ad5a4 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,34 +1,22 @@ - - ./test/ + + ./test - - - disable - - - - + ./src - - - - diff --git a/src/Application.php b/src/Application.php index cc66cbb22..2cd33ec69 100644 --- a/src/Application.php +++ b/src/Application.php @@ -5,13 +5,19 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc; +use Psr\Container\ContainerInterface; +use Psr\Http\Message\ServerRequestInterface as Request; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; use Zend\EventManager\EventManagerAwareInterface; use Zend\EventManager\EventManagerInterface; -use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\RequestInterface; -use Zend\Stdlib\ResponseInterface; +use Zend\EventManager\ListenerAggregateInterface; +use Zend\Mvc\View\Http\ViewManager; +use Zend\Router\RouteStackInterface; /** * Main application class for invoking applications @@ -60,14 +66,18 @@ class Application implements * @var array */ protected $defaultListeners = [ - 'RouteListener', - 'MiddlewareListener', - 'DispatchListener', - 'HttpMethodListener', - 'ViewManager', - 'SendResponseListener', + RouteListener::class, + MiddlewareListener::class, + DispatchListener::class, + HttpMethodListener::class, + ViewManager::class, ]; + /** + * @var string[]|ListenerAggregateInterface[] + */ + private $listeners = []; + /** * MVC event token * @var MvcEvent @@ -80,115 +90,90 @@ class Application implements protected $events; /** - * @var \Zend\Stdlib\RequestInterface + * @var ContainerInterface */ - protected $request; + protected $container; /** - * @var ResponseInterface + * @var RouteStackInterface */ - protected $response; + private $router; /** - * @var ServiceManager + * If application was bootstrapped + * + * @var bool */ - protected $serviceManager; + private $bootstrapped = false; /** * Constructor * - * @param ServiceManager $serviceManager - * @param null|EventManagerInterface $events - * @param null|RequestInterface $request - * @param null|ResponseInterface $response + * @param ContainerInterface $container IoC container from which to pull services + * @param RouteStackInterface $router Configured router for RouteListener + * @param EventManagerInterface $events + * @param array $listeners Extra listeners to attach on bootstrap + * Can be container keys or instances of ListenerAggregateInterface */ public function __construct( - ServiceManager $serviceManager, - EventManagerInterface $events = null, - RequestInterface $request = null, - ResponseInterface $response = null + ContainerInterface $container, + RouteStackInterface $router, + EventManagerInterface $events, + array $listeners = [] ) { - $this->serviceManager = $serviceManager; - $this->setEventManager($events ?: $serviceManager->get('EventManager')); - $this->request = $request ?: $serviceManager->get('Request'); - $this->response = $response ?: $serviceManager->get('Response'); - } + $this->container = $container; + $this->router = $router; + $this->setEventManager($events); + $this->listeners = $listeners; - /** - * Retrieve the application configuration - * - * @return array|object - */ - public function getConfig() - { - return $this->serviceManager->get('config'); + // @TODO response prototype? } /** * Bootstrap the application * * Defines and binds the MvcEvent, and passes it the request, response, and - * router. Attaches the ViewManager as a listener. Triggers the bootstrap + * router. Attaches default listeners. Triggers the bootstrap * event. - * - * @param array $listeners List of listeners to attach. - * @return Application */ - public function bootstrap(array $listeners = []) + public function bootstrap() : void { - $serviceManager = $this->serviceManager; - $events = $this->events; - - // Setup default listeners - $listeners = array_unique(array_merge($this->defaultListeners, $listeners)); + if ($this->bootstrapped) { + return; + } + $events = $this->events; + // @TODO may be move this to constructor + $listeners = array_unique(array_merge($this->defaultListeners, $this->listeners), \SORT_REGULAR); foreach ($listeners as $listener) { - $serviceManager->get($listener)->attach($events); + if ($listener instanceof ListenerAggregateInterface) { + $listener->attach($events); + continue; + } + $this->container->get($listener)->attach($events); } // Setup MVC Event - $this->event = $event = new MvcEvent(); + $this->event = $event = new MvcEvent(); $event->setName(MvcEvent::EVENT_BOOTSTRAP); $event->setTarget($this); $event->setApplication($this); - $event->setRequest($this->request); - $event->setResponse($this->response); - $event->setRouter($serviceManager->get('Router')); + $event->setRouter($this->router); // Trigger bootstrap events $events->triggerEvent($event); - return $this; + $this->bootstrapped = true; } /** * Retrieve the service manager * - * @return ServiceManager - */ - public function getServiceManager() - { - return $this->serviceManager; - } - - /** - * Get the request object - * - * @return \Zend\Stdlib\RequestInterface + * @return ContainerInterface */ - public function getRequest() + public function getContainer() : ContainerInterface { - return $this->request; - } - - /** - * Get the response object - * - * @return ResponseInterface - */ - public function getResponse() - { - return $this->response; + return $this->container; } /** @@ -196,7 +181,7 @@ public function getResponse() * * @return MvcEvent */ - public function getMvcEvent() + public function getMvcEvent() : ?MvcEvent { return $this->event; } @@ -205,16 +190,15 @@ public function getMvcEvent() * Set the event manager instance * * @param EventManagerInterface $eventManager - * @return Application + * @return void */ - public function setEventManager(EventManagerInterface $eventManager) + public function setEventManager(EventManagerInterface $eventManager) : void { $eventManager->setIdentifiers([ __CLASS__, get_class($this), ]); $this->events = $eventManager; - return $this; } /** @@ -224,73 +208,20 @@ public function setEventManager(EventManagerInterface $eventManager) * * @return EventManagerInterface */ - public function getEventManager() + public function getEventManager() : EventManagerInterface { return $this->events; } - /** - * Static method for quick and easy initialization of the Application. - * - * If you use this init() method, you cannot specify a service with the - * name of 'ApplicationConfig' in your service manager config. This name is - * reserved to hold the array from application.config.php. - * - * The following services can only be overridden from application.config.php: - * - * - ModuleManager - * - SharedEventManager - * - EventManager & Zend\EventManager\EventManagerInterface - * - * All other services are configured after module loading, thus can be - * overridden by modules. - * - * @param array $configuration - * @return Application - */ - public static function init($configuration = []) - { - // Prepare the service manager - $smConfig = isset($configuration['service_manager']) ? $configuration['service_manager'] : []; - $smConfig = new Service\ServiceManagerConfig($smConfig); - - $serviceManager = new ServiceManager(); - $smConfig->configureServiceManager($serviceManager); - $serviceManager->setService('ApplicationConfig', $configuration); - - // Load modules - $serviceManager->get('ModuleManager')->loadModules(); - - // Prepare list of listeners to bootstrap - $listenersFromAppConfig = isset($configuration['listeners']) ? $configuration['listeners'] : []; - $config = $serviceManager->get('config'); - $listenersFromConfigService = isset($config['listeners']) ? $config['listeners'] : []; - - $listeners = array_unique(array_merge($listenersFromConfigService, $listenersFromAppConfig)); - - return $serviceManager->get('Application')->bootstrap($listeners); - } - - /** - * Run the application - * - * @triggers route(MvcEvent) - * Routes the request, and sets the RouteMatch object in the event. - * @triggers dispatch(MvcEvent) - * Dispatches a request, using the discovered RouteMatch and - * provided request. - * @triggers dispatch.error(MvcEvent) - * On errors (controller not found, action not supported, etc.), - * populates the event with information about the error type, - * discovered controller, and controller class (if known). - * Typically, a handler should return a populated Response object - * that can be returned immediately. - * @return self - */ - public function run() + public function handle(Request $request) : ResponseInterface { + if (! $this->bootstrapped) { + $this->bootstrap(); + } $events = $this->events; + // @TODO revisit later for multi-request improvements $event = $this->event; + $event->setRequest($request); // Define callback used to determine whether or not to short-circuit $shortCircuit = function ($r) use ($event) { @@ -315,8 +246,7 @@ public function run() $event->setResponse($response); $event->stopPropagation(false); // Clear before triggering $events->triggerEvent($event); - $this->response = $response; - return $this; + return $event->getResponse(); } } @@ -337,12 +267,9 @@ public function run() $event->setResponse($response); $event->stopPropagation(false); // Clear before triggering $events->triggerEvent($event); - $this->response = $response; - return $this; + return $event->getResponse(); } - $response = $this->response; - $event->setResponse($response); return $this->completeRequest($event); } @@ -353,9 +280,9 @@ public function run() * event object. * * @param MvcEvent $event - * @return Application + * @return MvcEvent */ - protected function completeRequest(MvcEvent $event) + protected function completeRequest(MvcEvent $event) : ResponseInterface { $events = $this->events; $event->setTarget($this); @@ -368,6 +295,7 @@ protected function completeRequest(MvcEvent $event) $event->stopPropagation(false); // Clear before triggering $events->triggerEvent($event); - return $this; + // @TODO handle missing response. Investigate possibility for using middleware delegate + return ($event->getResponse() ?? new Response()); } } diff --git a/src/ApplicationInterface.php b/src/ApplicationInterface.php index 6f8c4062f..07d34b391 100644 --- a/src/ApplicationInterface.php +++ b/src/ApplicationInterface.php @@ -5,37 +5,20 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc; +use Psr\Container\ContainerInterface; +use Psr\Http\Server\RequestHandlerInterface; use Zend\EventManager\EventsCapableInterface; -interface ApplicationInterface extends EventsCapableInterface +interface ApplicationInterface extends EventsCapableInterface, RequestHandlerInterface { /** * Get the locator object * - * @return \Zend\ServiceManager\ServiceLocatorInterface - */ - public function getServiceManager(); - - /** - * Get the request object - * - * @return \Zend\Stdlib\RequestInterface - */ - public function getRequest(); - - /** - * Get the response object - * - * @return \Zend\Stdlib\ResponseInterface - */ - public function getResponse(); - - /** - * Run the application - * - * @return self + * @return ContainerInterface */ - public function run(); + public function getContainer() : ContainerInterface; } diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php new file mode 100644 index 000000000..4d34363b0 --- /dev/null +++ b/src/ConfigProvider.php @@ -0,0 +1,141 @@ + $this->getDependencyConfig(), + ]; + } + + public function getDependencyConfig() : array + { + return [ + 'aliases' => [ + 'ControllerManager' => ControllerManager::class, + 'ControllerPluginManager' => ControllerPluginManager::class, + 'DispatchListener' => DispatchListener::class, + 'HttpDefaultRenderingStrategy' => DefaultRenderingStrategy::class, + 'HttpExceptionStrategy' => ExceptionStrategy::class, + 'HttpMethodListener' => HttpMethodListener::class, + 'HttpRouteNotFoundStrategy' => RouteNotFoundStrategy::class, + 'HttpViewManager' => ViewManager::class, + 'InjectTemplateListener' => InjectTemplateListener::class, + 'MiddlewareListener' => MiddlewareListener::class, + 'RouteListener' => RouteListener::class, + 'RoutePluginManager' => RoutePluginManager::class, + 'View' => View::class, + 'ViewFeedRenderer' => FeedRenderer::class, + 'ViewFeedStrategy' => FeedStrategy::class, + 'ViewHelperManager' => HelperPluginManager::class, + 'ViewJsonRenderer' => JsonRenderer::class, + 'ViewJsonStrategy' => JsonStrategy::class, + 'ViewManager' => ViewManager::class, + 'ViewPhpRenderer' => PhpRenderer::class, + 'ViewPhpRendererStrategy' => PhpRendererStrategy::class, + 'ViewPrefixPathStackResolver' => PrefixPathStackResolver::class, + 'ViewRenderer' => PhpRenderer::class, + 'ViewResolver' => 'Zend\Mvc\View\Resolver', + 'ViewTemplateMapResolver' => TemplateMapResolver::class, + 'ViewTemplatePathStack' => TemplatePathStack::class, + 'EventManagerInterface' => 'EventManager', + EventManagerInterface::class => 'EventManager', + 'SharedEventManager' => SharedEventManager::class, + 'SharedEventManagerInterface' => SharedEventManager::class, + 'Zend\Mvc\Router' => 'HttpRouter', + AggregateResolver::class => 'Zend\Mvc\View\Resolver', + EventManagerInterface::class => 'EventManager', + RendererInterface::class => PhpRenderer::class, + ResolverInterface::class => 'Zend\Mvc\View\Resolver', + SharedEventManagerInterface::class => SharedEventManager::class, + ], + 'factories' => [ + 'EventManager' => EventManagerFactory::class, + 'Zend\Mvc\View\Resolver' => ViewResolverFactory::class, + Application::class => ApplicationFactory::class, + ControllerManager::class => ControllerManagerFactory::class, + ControllerPluginManager::class => ControllerPluginManagerFactory::class, + DefaultRenderingStrategy::class => DefaultRenderingStrategyFactory::class, + DispatchListener::class => DispatchListenerFactory::class, + ExceptionStrategy::class => ExceptionStrategyFactory::class, + FeedRenderer::class => InvokableFactory::class, + FeedStrategy::class => ViewFeedStrategyFactory::class, + HelperPluginManager::class => ViewHelperManagerFactory::class, + HttpMethodListener::class => HttpMethodListenerFactory::class, + InjectTemplateListener::class => InjectTemplateListenerFactory::class, + JsonRenderer::class => InvokableFactory::class, + JsonStrategy::class => ViewJsonStrategyFactory::class, + MiddlewareListener::class => InvokableFactory::class, + PhpRenderer::class => ViewPhpRendererFactory::class, + PhpRendererStrategy::class => ViewPhpRendererStrategyFactory::class, + PrefixPathStackResolver::class => ViewPrefixPathStackResolverFactory::class, + RouteListener::class => InvokableFactory::class, + RouteNotFoundStrategy::class => RouteNotFoundStrategyFactory::class, + SharedEventManager::class => InvokableFactory::class, + TemplateMapResolver::class => ViewTemplateMapResolverFactory::class, + TemplatePathStack::class => ViewTemplatePathStackFactory::class, + View::class => ViewFactory::class, + ViewManager::class => InvokableFactory::class, + ], + 'shared' => [ + 'EventManager' => false, + ], + ]; + } +} diff --git a/src/Container/ApplicationFactory.php b/src/Container/ApplicationFactory.php new file mode 100644 index 000000000..0a7f3769a --- /dev/null +++ b/src/Container/ApplicationFactory.php @@ -0,0 +1,41 @@ +get('config') ?? []; + $listeners = $config[Application::class]['listeners'] ?? []; + + $application = new Application( + $container, + $container->get('Zend\Mvc\Router'), + $container->get('EventManager'), + $listeners + ); + + return $application; + } +} diff --git a/src/Service/ControllerManagerFactory.php b/src/Container/ControllerManagerFactory.php similarity index 60% rename from src/Service/ControllerManagerFactory.php rename to src/Container/ControllerManagerFactory.php index a1dd50812..24558f4a8 100644 --- a/src/Service/ControllerManagerFactory.php +++ b/src/Container/ControllerManagerFactory.php @@ -5,13 +5,14 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; use Zend\Mvc\Controller\ControllerManager; -use Zend\ServiceManager\Factory\FactoryInterface; -class ControllerManagerFactory implements FactoryInterface +class ControllerManagerFactory { /** * Create the controller manager service @@ -24,15 +25,21 @@ class ControllerManagerFactory implements FactoryInterface * if the controller implements a setPluginManager() method. * * @param ContainerInterface $container - * @param string $Name - * @param null|array $options + * @param string $name + * @param array|null $options * @return ControllerManager */ - public function __invoke(ContainerInterface $container, $name, array $options = null) + public function __invoke(ContainerInterface $container, string $name, array $options = null) : ControllerManager { - if ($options) { + if (null !== $options) { return new ControllerManager($container, $options); } - return new ControllerManager($container); + return new ControllerManager($container, $this->getControllersConfig($container)); + } + + public function getControllersConfig(ContainerInterface $container) : array + { + $config = $container->has('config') ? $container->get('config') : []; + return $config['controllers'] ?? []; } } diff --git a/src/Container/ControllerPluginManagerFactory.php b/src/Container/ControllerPluginManagerFactory.php new file mode 100644 index 000000000..42e54b8db --- /dev/null +++ b/src/Container/ControllerPluginManagerFactory.php @@ -0,0 +1,36 @@ +getPluginsConfig($container)); + } + + public function getPluginsConfig(ContainerInterface $container) : array + { + $config = $container->has('config') ? $container->get('config') : []; + return $config['controller_plugins'] ?? []; + } +} diff --git a/src/Service/HttpDefaultRenderingStrategyFactory.php b/src/Container/DefaultRenderingStrategyFactory.php similarity index 69% rename from src/Service/HttpDefaultRenderingStrategyFactory.php rename to src/Container/DefaultRenderingStrategyFactory.php index 21a47daae..450eb1ff7 100644 --- a/src/Service/HttpDefaultRenderingStrategyFactory.php +++ b/src/Container/DefaultRenderingStrategyFactory.php @@ -5,25 +5,31 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; use Zend\Mvc\View\Http\DefaultRenderingStrategy; -use Zend\ServiceManager\Factory\FactoryInterface; use Zend\View\View; -class HttpDefaultRenderingStrategyFactory implements FactoryInterface +class DefaultRenderingStrategyFactory { - use HttpViewManagerConfigTrait; + use ViewManagerConfigTrait; /** * @param ContainerInterface $container - * @param string $name - * @param null|array $options + * @param string $name + * @param array|null $options * @return DefaultRenderingStrategy + * @throws \Psr\Container\ContainerExceptionInterface + * @throws \Psr\Container\NotFoundExceptionInterface */ - public function __invoke(ContainerInterface $container, $name, array $options = null) - { + public function __invoke( + ContainerInterface $container, + string $name, + array $options = null + ) : DefaultRenderingStrategy { $strategy = new DefaultRenderingStrategy($container->get(View::class)); $config = $this->getConfig($container); diff --git a/src/Container/DispatchListenerFactory.php b/src/Container/DispatchListenerFactory.php new file mode 100644 index 000000000..c0121fd5c --- /dev/null +++ b/src/Container/DispatchListenerFactory.php @@ -0,0 +1,32 @@ +get(ControllerManager::class)); + } +} diff --git a/src/Service/EventManagerFactory.php b/src/Container/EventManagerFactory.php similarity index 64% rename from src/Service/EventManagerFactory.php rename to src/Container/EventManagerFactory.php index 98bc186a6..ba6a36dbe 100644 --- a/src/Service/EventManagerFactory.php +++ b/src/Container/EventManagerFactory.php @@ -5,13 +5,14 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; use Zend\EventManager\EventManager; -use Zend\ServiceManager\Factory\FactoryInterface; -class EventManagerFactory implements FactoryInterface +class EventManagerFactory { /** * Create an EventManager instance @@ -20,11 +21,13 @@ class EventManagerFactory implements FactoryInterface * of SharedEventManager. * * @param ContainerInterface $container - * @param string $name - * @param null|array $options + * @param string $name + * @param array|null $options * @return EventManager + * @throws \Psr\Container\ContainerExceptionInterface + * @throws \Psr\Container\NotFoundExceptionInterface */ - public function __invoke(ContainerInterface $container, $name, array $options = null) + public function __invoke(ContainerInterface $container, string $name, array $options = null) : EventManager { $shared = $container->has('SharedEventManager') ? $container->get('SharedEventManager') : null; diff --git a/src/Service/HttpExceptionStrategyFactory.php b/src/Container/ExceptionStrategyFactory.php similarity index 80% rename from src/Service/HttpExceptionStrategyFactory.php rename to src/Container/ExceptionStrategyFactory.php index 6798f5a0a..b57883142 100644 --- a/src/Service/HttpExceptionStrategyFactory.php +++ b/src/Container/ExceptionStrategyFactory.php @@ -5,23 +5,24 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; use Zend\Mvc\View\Http\ExceptionStrategy; -use Zend\ServiceManager\Factory\FactoryInterface; -class HttpExceptionStrategyFactory implements FactoryInterface +class ExceptionStrategyFactory { - use HttpViewManagerConfigTrait; + use ViewManagerConfigTrait; /** * @param ContainerInterface $container - * @param string $name - * @param null|array $options + * @param string $name + * @param array|null $options * @return ExceptionStrategy */ - public function __invoke(ContainerInterface $container, $name, array $options = null) + public function __invoke(ContainerInterface $container, string $name, array $options = null) : ExceptionStrategy { $strategy = new ExceptionStrategy(); $config = $this->getConfig($container); diff --git a/src/Container/HttpMethodListenerFactory.php b/src/Container/HttpMethodListenerFactory.php new file mode 100644 index 000000000..52186c70b --- /dev/null +++ b/src/Container/HttpMethodListenerFactory.php @@ -0,0 +1,33 @@ +has('config') ? $container->get('config') : []; + $enabled = $config['http_methods_listener']['enabled'] ?? true; + $allowedMethods = $config['http_methods_listener']['allowed_methods'] ?? null; + + return new HttpMethodListener($enabled, $allowedMethods); + } +} diff --git a/src/Service/InjectTemplateListenerFactory.php b/src/Container/InjectTemplateListenerFactory.php similarity index 50% rename from src/Service/InjectTemplateListenerFactory.php rename to src/Container/InjectTemplateListenerFactory.php index effd137a3..e066a703c 100644 --- a/src/Service/InjectTemplateListenerFactory.php +++ b/src/Container/InjectTemplateListenerFactory.php @@ -5,30 +5,37 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); + +namespace Zend\Mvc\Container; use Interop\Container\ContainerInterface; use Zend\Mvc\View\Http\InjectTemplateListener; -use Zend\ServiceManager\Factory\FactoryInterface; -class InjectTemplateListenerFactory implements FactoryInterface +class InjectTemplateListenerFactory { + use ViewManagerConfigTrait; + /** - * {@inheritDoc} - * * Create and return an InjectTemplateListener instance. * + * @param ContainerInterface $container + * @param string $name + * @param array|null $options * @return InjectTemplateListener */ - public function __invoke(ContainerInterface $container, $name, array $options = null) - { + public function __invoke( + ContainerInterface $container, + string $name, + array $options = null + ) : InjectTemplateListener { $listener = new InjectTemplateListener(); - $config = $container->get('config'); + $config = $this->getConfig($container); - if (isset($config['view_manager']['controller_map']) - && (is_array($config['view_manager']['controller_map'])) + if (isset($config['controller_map']) + && (is_array($config['controller_map'])) ) { - $listener->setControllerMap($config['view_manager']['controller_map']); + $listener->setControllerMap($config['controller_map']); } return $listener; diff --git a/src/Service/HttpRouteNotFoundStrategyFactory.php b/src/Container/RouteNotFoundStrategyFactory.php similarity index 86% rename from src/Service/HttpRouteNotFoundStrategyFactory.php rename to src/Container/RouteNotFoundStrategyFactory.php index a426d1aea..60bef95c3 100644 --- a/src/Service/HttpRouteNotFoundStrategyFactory.php +++ b/src/Container/RouteNotFoundStrategyFactory.php @@ -5,15 +5,16 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; use Zend\Mvc\View\Http\RouteNotFoundStrategy; -use Zend\ServiceManager\Factory\FactoryInterface; -class HttpRouteNotFoundStrategyFactory implements FactoryInterface +class RouteNotFoundStrategyFactory { - use HttpViewManagerConfigTrait; + use ViewManagerConfigTrait; /** * @param ContainerInterface $container @@ -21,7 +22,7 @@ class HttpRouteNotFoundStrategyFactory implements FactoryInterface * @param null|array $options * @return RouteNotFoundStrategy */ - public function __invoke(ContainerInterface $container, $name, array $options = null) + public function __invoke(ContainerInterface $container, string $name, array $options = null) : RouteNotFoundStrategy { $strategy = new RouteNotFoundStrategy(); $config = $this->getConfig($container); diff --git a/src/Service/ViewFactory.php b/src/Container/ViewFactory.php similarity index 62% rename from src/Service/ViewFactory.php rename to src/Container/ViewFactory.php index ed5852752..f64473e4f 100644 --- a/src/Service/ViewFactory.php +++ b/src/Container/ViewFactory.php @@ -5,22 +5,25 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; -use Zend\ServiceManager\Factory\FactoryInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; use Zend\View\Strategy\PhpRendererStrategy; use Zend\View\View; -class ViewFactory implements FactoryInterface +class ViewFactory { /** * @param ContainerInterface $container - * @param string $name - * @param null|array $options + * @param string $name + * @param array|null $options * @return View + * @throws \Psr\Container\ContainerExceptionInterface + * @throws \Psr\Container\NotFoundExceptionInterface */ - public function __invoke(ContainerInterface $container, $name, array $options = null) + public function __invoke(ContainerInterface $container, string $name, array $options = null) : View { $view = new View(); $events = $container->get('EventManager'); diff --git a/src/Service/ViewFeedStrategyFactory.php b/src/Container/ViewFeedStrategyFactory.php similarity index 58% rename from src/Service/ViewFeedStrategyFactory.php rename to src/Container/ViewFeedStrategyFactory.php index 61a0d6c1a..085dc3aa0 100644 --- a/src/Service/ViewFeedStrategyFactory.php +++ b/src/Container/ViewFeedStrategyFactory.php @@ -5,13 +5,15 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; -use Zend\ServiceManager\Factory\FactoryInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; +use Zend\View\Renderer\FeedRenderer; use Zend\View\Strategy\FeedStrategy; -class ViewFeedStrategyFactory implements FactoryInterface +class ViewFeedStrategyFactory { /** * Create and return the Feed view strategy @@ -22,12 +24,14 @@ class ViewFeedStrategyFactory implements FactoryInterface * It then attaches the strategy to the View service, at a priority of 100. * * @param ContainerInterface $container - * @param string $name - * @param null|array $options + * @param string $name + * @param array|null $options * @return FeedStrategy + * @throws \Psr\Container\ContainerExceptionInterface + * @throws \Psr\Container\NotFoundExceptionInterface */ - public function __invoke(ContainerInterface $container, $name, array $options = null) + public function __invoke(ContainerInterface $container, string $name, array $options = null) : FeedStrategy { - return new FeedStrategy($container->get('ViewFeedRenderer')); + return new FeedStrategy($container->get(FeedRenderer::class)); } } diff --git a/src/Service/ViewHelperManagerFactory.php b/src/Container/ViewHelperManagerFactory.php similarity index 56% rename from src/Service/ViewHelperManagerFactory.php rename to src/Container/ViewHelperManagerFactory.php index 371885b19..2899b0b06 100644 --- a/src/Service/ViewHelperManagerFactory.php +++ b/src/Container/ViewHelperManagerFactory.php @@ -5,43 +5,38 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; -use Zend\Router\RouteMatch; -use Zend\ServiceManager\Exception\ServiceNotCreatedException; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; use Zend\View\Helper as ViewHelper; use Zend\View\HelperPluginManager; -class ViewHelperManagerFactory extends AbstractPluginManagerFactory +class ViewHelperManagerFactory { - const PLUGIN_MANAGER_CLASS = HelperPluginManager::class; - - /** - * An array of helper configuration classes to ensure are on the helper_map stack. - * - * These are *not* imported; that way they can be optional dependencies. - * - * @todo Remove these once their components have Modules defined. - * @var array - */ - protected $defaultHelperMapClasses = []; + use ViewManagerConfigTrait; /** * Create and return the view helper manager * * @param ContainerInterface $container + * @param string $name + * @param array|null $options * @return HelperPluginManager - * @throws ServiceNotCreatedException + * @throws \Psr\Container\ContainerExceptionInterface + * @throws \Psr\Container\NotFoundExceptionInterface */ - public function __invoke(ContainerInterface $container, $requestedName, array $options = null) + public function __invoke(ContainerInterface $container, string $name, array $options = null) : HelperPluginManager { - $options = $options ?: []; - $options['factories'] = isset($options['factories']) ? $options['factories'] : []; - $plugins = parent::__invoke($container, $requestedName, $options); + if (null === $options) { + $config = $container->has('config') ? $container->get('config') : []; + $options = $config['view_helpers'] ?? []; + } + $plugins = new HelperPluginManager($container, $options); // Override plugin factories - $plugins = $this->injectOverrideFactories($plugins, $container); + $this->injectOverrideFactories($plugins, $container); return $plugins; } @@ -51,10 +46,12 @@ public function __invoke(ContainerInterface $container, $requestedName, array $o * * @param HelperPluginManager $plugins * @param ContainerInterface $services - * @return HelperPluginManager + * @return void */ private function injectOverrideFactories(HelperPluginManager $plugins, ContainerInterface $services) { + $override = $plugins->getAllowOverride(); + $plugins->setAllowOverride(true); // Configure URL view helper $urlFactory = $this->createUrlHelperFactory($services); $plugins->setFactory(ViewHelper\Url::class, $urlFactory); @@ -69,8 +66,7 @@ private function injectOverrideFactories(HelperPluginManager $plugins, Container $doctypeFactory = $this->createDoctypeHelperFactory($services); $plugins->setFactory(ViewHelper\Doctype::class, $doctypeFactory); $plugins->setFactory('zendviewhelperdoctype', $doctypeFactory); - - return $plugins; + $plugins->setAllowOverride($override); } /** @@ -87,16 +83,7 @@ private function createUrlHelperFactory(ContainerInterface $services) { return function () use ($services) { $helper = new ViewHelper\Url; - $helper->setRouter($services->get('HttpRouter')); - - $match = $services->get('Application') - ->getMvcEvent() - ->getRouteMatch() - ; - - if ($match instanceof RouteMatch) { - $helper->setRouteMatch($match); - } + $helper->setRouter($services->get('Zend\Mvc\Router')); return $helper; }; @@ -107,24 +94,19 @@ private function createUrlHelperFactory(ContainerInterface $services) * * Uses configuration and request services to configure the helper. * - * @param ContainerInterface $services + * @param ContainerInterface $container * @return callable */ - private function createBasePathHelperFactory(ContainerInterface $services) + private function createBasePathHelperFactory(ContainerInterface $container) { - return function () use ($services) { - $config = $services->has('config') ? $services->get('config') : []; + return function () use ($container) { $helper = new ViewHelper\BasePath; - if (isset($config['view_manager']) && isset($config['view_manager']['base_path'])) { - $helper->setBasePath($config['view_manager']['base_path']); - return $helper; - } - - $request = $services->get('Request'); + $viewConfig = $this->getConfig($container); - if (is_callable([$request, 'getBasePath'])) { - $helper->setBasePath($request->getBasePath()); + if (isset($viewConfig['base_path'])) { + $helper->setBasePath($viewConfig['base_path']); + return $helper; } return $helper; @@ -137,17 +119,17 @@ private function createBasePathHelperFactory(ContainerInterface $services) * Other view helpers depend on this to decide which spec to generate their tags * based on. This is why it must be set early instead of later in the layout phtml. * - * @param ContainerInterface $services + * @param ContainerInterface $container * @return callable */ - private function createDoctypeHelperFactory(ContainerInterface $services) + private function createDoctypeHelperFactory(ContainerInterface $container) { - return function () use ($services) { - $config = $services->has('config') ? $services->get('config') : []; - $config = isset($config['view_manager']) ? $config['view_manager'] : []; + return function () use ($container) { $helper = new ViewHelper\Doctype; - if (isset($config['doctype']) && $config['doctype']) { - $helper->setDoctype($config['doctype']); + + $viewConfig = $this->getConfig($container); + if (isset($viewConfig['doctype']) && $viewConfig['doctype']) { + $helper->setDoctype($viewConfig['doctype']); } return $helper; }; diff --git a/src/Service/ViewJsonStrategyFactory.php b/src/Container/ViewJsonStrategyFactory.php similarity index 61% rename from src/Service/ViewJsonStrategyFactory.php rename to src/Container/ViewJsonStrategyFactory.php index 1f5615031..5cb93b6be 100644 --- a/src/Service/ViewJsonStrategyFactory.php +++ b/src/Container/ViewJsonStrategyFactory.php @@ -5,13 +5,15 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; -use Zend\ServiceManager\Factory\FactoryInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; +use Zend\View\Renderer\JsonRenderer; use Zend\View\Strategy\JsonStrategy; -class ViewJsonStrategyFactory implements FactoryInterface +class ViewJsonStrategyFactory { /** * Create and return the JSON view strategy @@ -22,13 +24,15 @@ class ViewJsonStrategyFactory implements FactoryInterface * It then attaches the strategy to the View service, at a priority of 100. * * @param ContainerInterface $container - * @param string $name - * @param null|array $options + * @param string $name + * @param array|null $options * @return JsonStrategy + * @throws \Psr\Container\ContainerExceptionInterface + * @throws \Psr\Container\NotFoundExceptionInterface */ - public function __invoke(ContainerInterface $container, $name, array $options = null) + public function __invoke(ContainerInterface $container, string $name, array $options = null) : JsonStrategy { - $jsonRenderer = $container->get('ViewJsonRenderer'); + $jsonRenderer = $container->get(JsonRenderer::class); $jsonStrategy = new JsonStrategy($jsonRenderer); return $jsonStrategy; } diff --git a/src/Service/HttpViewManagerConfigTrait.php b/src/Container/ViewManagerConfigTrait.php similarity index 84% rename from src/Service/HttpViewManagerConfigTrait.php rename to src/Container/ViewManagerConfigTrait.php index 6c6efa62d..ace17a612 100644 --- a/src/Service/HttpViewManagerConfigTrait.php +++ b/src/Container/ViewManagerConfigTrait.php @@ -5,18 +5,20 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); + +namespace Zend\Mvc\Container; use ArrayAccess; -use Interop\Container\ContainerInterface; +use Psr\Container\ContainerInterface; -trait HttpViewManagerConfigTrait +trait ViewManagerConfigTrait { /** * Retrieve view_manager configuration, if present. * * @param ContainerInterface $container - * @return array + * @return array|ArrayAccess */ private function getConfig(ContainerInterface $container) { diff --git a/src/Container/ViewPhpRendererFactory.php b/src/Container/ViewPhpRendererFactory.php new file mode 100644 index 000000000..a20c19a92 --- /dev/null +++ b/src/Container/ViewPhpRendererFactory.php @@ -0,0 +1,34 @@ +setHelperPluginManager($container->get(HelperPluginManager::class)); + $renderer->setResolver($container->get('Zend\Mvc\View\Resolver')); + + return $renderer; + } +} diff --git a/src/Service/ViewPhpRendererStrategyFactory.php b/src/Container/ViewPhpRendererStrategyFactory.php similarity index 56% rename from src/Service/ViewPhpRendererStrategyFactory.php rename to src/Container/ViewPhpRendererStrategyFactory.php index 6b83c7254..dbf9692a9 100644 --- a/src/Service/ViewPhpRendererStrategyFactory.php +++ b/src/Container/ViewPhpRendererStrategyFactory.php @@ -5,22 +5,25 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; -use Zend\ServiceManager\Factory\FactoryInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; use Zend\View\Renderer\PhpRenderer; use Zend\View\Strategy\PhpRendererStrategy; -class ViewPhpRendererStrategyFactory implements FactoryInterface +class ViewPhpRendererStrategyFactory { /** * @param ContainerInterface $container - * @param string $name - * @param null|array $options + * @param string $name + * @param array|null $options * @return PhpRendererStrategy + * @throws \Psr\Container\ContainerExceptionInterface + * @throws \Psr\Container\NotFoundExceptionInterface */ - public function __invoke(ContainerInterface $container, $name, array $options = null) + public function __invoke(ContainerInterface $container, string $name, array $options = null) : PhpRendererStrategy { return new PhpRendererStrategy($container->get(PhpRenderer::class)); } diff --git a/src/Service/ViewPrefixPathStackResolverFactory.php b/src/Container/ViewPrefixPathStackResolverFactory.php similarity index 54% rename from src/Service/ViewPrefixPathStackResolverFactory.php rename to src/Container/ViewPrefixPathStackResolverFactory.php index 08e9f49e1..0ccb78a9e 100644 --- a/src/Service/ViewPrefixPathStackResolverFactory.php +++ b/src/Container/ViewPrefixPathStackResolverFactory.php @@ -5,14 +5,17 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace Zend\Mvc\Service; +declare(strict_types=1); -use Interop\Container\ContainerInterface; -use Zend\ServiceManager\Factory\FactoryInterface; +namespace Zend\Mvc\Container; + +use Psr\Container\ContainerInterface; use Zend\View\Resolver\PrefixPathStackResolver; -class ViewPrefixPathStackResolverFactory implements FactoryInterface +class ViewPrefixPathStackResolverFactory { + use ViewManagerConfigTrait; + /** * Create the template prefix view resolver * @@ -20,18 +23,17 @@ class ViewPrefixPathStackResolverFactory implements FactoryInterface * ['view_manager']['prefix_template_path_stack'] * * @param ContainerInterface $container - * @param string $name - * @param null|array $options + * @param string $name + * @param array|null $options * @return PrefixPathStackResolver */ - public function __invoke(ContainerInterface $container, $name, array $options = null) - { - $config = $container->get('config'); - $prefixes = []; - - if (isset($config['view_manager']['prefix_template_path_stack'])) { - $prefixes = $config['view_manager']['prefix_template_path_stack']; - } + public function __invoke( + ContainerInterface $container, + string $name, + array $options = null + ) : PrefixPathStackResolver { + $config = $this->getConfig($container); + $prefixes = $config['prefix_template_path_stack'] ?? []; return new PrefixPathStackResolver($prefixes); } diff --git a/src/Container/ViewResolverFactory.php b/src/Container/ViewResolverFactory.php new file mode 100644 index 000000000..cd7c9c05f --- /dev/null +++ b/src/Container/ViewResolverFactory.php @@ -0,0 +1,56 @@ +get(TemplateMapResolver::class); + /* @var $pathResolver ResolverInterface */ + $pathResolver = $container->get(TemplatePathStack::class); + /* @var $prefixPathStackResolver ResolverInterface */ + $prefixPathStackResolver = $container->get(PrefixPathStackResolver::class); + + $resolver + ->attach($mapResolver) + ->attach($pathResolver) + ->attach($prefixPathStackResolver) + ->attach(new RelativeFallbackResolver($mapResolver)) + ->attach(new RelativeFallbackResolver($pathResolver)) + ->attach(new RelativeFallbackResolver($prefixPathStackResolver)); + + return $resolver; + } +} diff --git a/src/Container/ViewTemplateMapResolverFactory.php b/src/Container/ViewTemplateMapResolverFactory.php new file mode 100644 index 000000000..7c40c3b39 --- /dev/null +++ b/src/Container/ViewTemplateMapResolverFactory.php @@ -0,0 +1,39 @@ +getConfig($container); + $map = []; + if (is_array($config) && isset($config['template_map'])) { + $map = $config['template_map']; + } + return new TemplateMapResolver($map); + } +} diff --git a/src/Container/ViewTemplatePathStackFactory.php b/src/Container/ViewTemplatePathStackFactory.php new file mode 100644 index 000000000..672ec58e3 --- /dev/null +++ b/src/Container/ViewTemplatePathStackFactory.php @@ -0,0 +1,48 @@ +getConfig($container); + + $templatePathStack = new TemplatePathStack(); + + if (is_array($config)) { + if (isset($config['template_path_stack'])) { + $templatePathStack->addPaths($config['template_path_stack']); + } + if (isset($config['default_template_suffix'])) { + $templatePathStack->setDefaultSuffix($config['default_template_suffix']); + } + } + + return $templatePathStack; + } +} diff --git a/src/Controller/AbstractActionController.php b/src/Controller/AbstractActionController.php index 54277ab31..e512a4e79 100644 --- a/src/Controller/AbstractActionController.php +++ b/src/Controller/AbstractActionController.php @@ -5,10 +5,14 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller; +use Zend\Diactoros\Response; use Zend\Mvc\Exception; use Zend\Mvc\MvcEvent; +use Zend\Router\RouteResult; use Zend\View\Model\ViewModel; /** @@ -41,9 +45,22 @@ public function indexAction() public function notFoundAction() { $event = $this->getEvent(); - $routeMatch = $event->getRouteMatch(); - $routeMatch->setParam('action', 'not-found'); + $request = $event->getRequest(); + /** @var RouteResult $routeResult */ + // + $routeResult = $request->getAttribute(RouteResult::class); + if (! $routeResult) { + // this should never be reached normally + throw new Exception\DomainException('Missing route result'); + } + $params = $routeResult->getMatchedParams(); + $params['action'] = 'not-found'; + $routeResult = $routeResult->withMatchedParams($params); + $request = $request->withAttribute(RouteResult::class, $routeResult); + $event->setRequest($request); + $response = $this->getResponse() ?? new Response(); + $event->setResponse($response->withStatus(404)); $helper = $this->plugin('createHttpNotFoundModel'); return $helper($event->getResponse()); } @@ -57,16 +74,17 @@ public function notFoundAction() */ public function onDispatch(MvcEvent $e) { - $routeMatch = $e->getRouteMatch(); - if (! $routeMatch) { + /** @var RouteResult $routeResult */ + $routeResult = $e->getRequest()->getAttribute(RouteResult::class); + if (! $routeResult) { /** * @todo Determine requirements for when route match is missing. * Potentially allow pulling directly from request metadata? */ - throw new Exception\DomainException('Missing route matches; unsure how to retrieve action'); + throw new Exception\DomainException('Missing route result; unsure how to retrieve action'); } - $action = $routeMatch->getParam('action', 'not-found'); + $action = $routeResult->getMatchedParams()['action'] ?? 'not-found'; $method = static::getMethodFromAction($action); if (! method_exists($this, $method)) { diff --git a/src/Controller/AbstractController.php b/src/Controller/AbstractController.php index da634c5c6..9fb72a1af 100644 --- a/src/Controller/AbstractController.php +++ b/src/Controller/AbstractController.php @@ -5,20 +5,20 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface as Request; +use Zend\Diactoros\Response; use Zend\EventManager\EventInterface as Event; use Zend\EventManager\EventManager; use Zend\EventManager\EventManagerAwareInterface; use Zend\EventManager\EventManagerInterface; -use Zend\Http\PhpEnvironment\Response as HttpResponse; -use Zend\Http\Request as HttpRequest; use Zend\Mvc\InjectApplicationEventInterface; use Zend\Mvc\MvcEvent; use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\DispatchableInterface as Dispatchable; -use Zend\Stdlib\RequestInterface as Request; -use Zend\Stdlib\ResponseInterface as Response; /** * Abstract controller @@ -45,17 +45,7 @@ abstract class AbstractController implements protected $plugins; /** - * @var Request - */ - protected $request; - - /** - * @var Response - */ - protected $response; - - /** - * @var Event + * @var MvcEvent */ protected $event; @@ -81,26 +71,18 @@ abstract public function onDispatch(MvcEvent $e); * Dispatch a request * * @events dispatch.pre, dispatch.post - * @param Request $request - * @param null|Response $response - * @return Response|mixed + * @param Request $request + * @return mixed|Response */ - public function dispatch(Request $request, Response $response = null) + public function dispatch(Request $request) { - $this->request = $request; - if (! $response) { - $response = new HttpResponse(); - } - $this->response = $response; - $e = $this->getEvent(); $e->setName(MvcEvent::EVENT_DISPATCH); $e->setRequest($request); - $e->setResponse($response); $e->setTarget($this); $result = $this->getEventManager()->triggerEventUntil(function ($test) { - return ($test instanceof Response); + return ($test instanceof ResponseInterface); }, $e); if ($result->stopped()) { @@ -113,38 +95,29 @@ public function dispatch(Request $request, Response $response = null) /** * Get request object * - * @return Request + * @return null|Request */ - public function getRequest() + public function getRequest() : ?Request { - if (! $this->request) { - $this->request = new HttpRequest(); - } - - return $this->request; + return $this->getEvent()->getRequest(); } /** * Get response object * - * @return Response + * @return ResponseInterface */ - public function getResponse() + public function getResponse() : ?ResponseInterface { - if (! $this->response) { - $this->response = new HttpResponse(); - } - - return $this->response; + return $this->getEvent()->getResponse(); } /** * Set the event manager instance used by this context * - * @param EventManagerInterface $events - * @return AbstractController + * @param EventManagerInterface $events */ - public function setEventManager(EventManagerInterface $events) + public function setEventManager(EventManagerInterface $events) : void { $className = get_class($this); @@ -161,8 +134,6 @@ public function setEventManager(EventManagerInterface $events) $this->events = $events; $this->attachDefaultListeners(); - - return $this; } /** @@ -218,10 +189,8 @@ public function getEvent() /** * Get plugin manager - * - * @return PluginManager */ - public function getPluginManager() + public function getPluginManager() : PluginManager { if (! $this->plugins) { $this->setPluginManager(new PluginManager(new ServiceManager())); @@ -234,15 +203,12 @@ public function getPluginManager() /** * Set plugin manager * - * @param PluginManager $plugins - * @return AbstractController + * @param PluginManager $plugins */ - public function setPluginManager(PluginManager $plugins) + public function setPluginManager(PluginManager $plugins) : void { $this->plugins = $plugins; $this->plugins->setController($this); - - return $this; } /** diff --git a/src/Controller/AbstractRestfulController.php b/src/Controller/AbstractRestfulController.php index cff21f6db..a6b78a7c9 100644 --- a/src/Controller/AbstractRestfulController.php +++ b/src/Controller/AbstractRestfulController.php @@ -4,14 +4,19 @@ * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (http://www.zend.com) * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ + +declare(strict_types=1); + namespace Zend\Mvc\Controller; -use Zend\Http\Request as HttpRequest; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Zend\Diactoros\Response; +use Zend\Diactoros\Stream; use Zend\Json\Json; use Zend\Mvc\Exception; use Zend\Mvc\MvcEvent; -use Zend\Stdlib\RequestInterface as Request; -use Zend\Stdlib\ResponseInterface as Response; +use Zend\Router\RouteResult; /** * Abstract RESTful controller @@ -74,9 +79,9 @@ abstract class AbstractRestfulController extends AbstractController * @param string $name * @return self */ - public function setIdentifierName($name) + public function setIdentifierName(string $name) { - $this->identifierName = (string) $name; + $this->identifierName = $name; return $this; } @@ -98,7 +103,9 @@ public function getIdentifierName() */ public function create($data) { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -113,7 +120,9 @@ public function create($data) */ public function delete($id) { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -130,7 +139,9 @@ public function delete($id) */ public function deleteList($data) { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -145,7 +156,9 @@ public function deleteList($data) */ public function get($id) { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -159,7 +172,9 @@ public function get($id) */ public function getList() { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -177,7 +192,9 @@ public function getList() */ public function head($id = null) { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -197,7 +214,9 @@ public function head($id = null) */ public function options() { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -216,7 +235,9 @@ public function options() */ public function patch($id, $data) { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -234,7 +255,9 @@ public function patch($id, $data) */ public function replaceList($data) { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -252,7 +275,9 @@ public function replaceList($data) */ public function patchList($data) { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -268,7 +293,9 @@ public function patchList($data) */ public function update($id, $data) { - $this->response->setStatusCode(405); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(405) + ); return [ 'content' => 'Method Not Allowed' @@ -282,35 +309,15 @@ public function update($id, $data) */ public function notFoundAction() { - $this->response->setStatusCode(404); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withStatus(404) + ); return [ 'content' => 'Page not found' ]; } - /** - * Dispatch a request - * - * If the route match includes an "action" key, then this acts basically like - * a standard action controller. Otherwise, it introspects the HTTP method - * to determine how to handle the request, and which method to delegate to. - * - * @events dispatch.pre, dispatch.post - * @param Request $request - * @param null|Response $response - * @return mixed|Response - * @throws Exception\InvalidArgumentException - */ - public function dispatch(Request $request, Response $response = null) - { - if (! $request instanceof HttpRequest) { - throw new Exception\InvalidArgumentException('Expected an HTTP request'); - } - - return parent::dispatch($request, $response); - } - /** * Handle the request * @@ -321,19 +328,20 @@ public function dispatch(Request $request, Response $response = null) */ public function onDispatch(MvcEvent $e) { - $routeMatch = $e->getRouteMatch(); - if (! $routeMatch) { + /** @var RouteResult $routeResult */ + $routeResult = $e->getRequest()->getAttribute(RouteResult::class); + if (! $routeResult) { /** * @todo Determine requirements for when route match is missing. * Potentially allow pulling directly from request metadata? */ - throw new Exception\DomainException('Missing route matches; unsure how to retrieve action'); + throw new Exception\DomainException('Missing route result; unsure how to retrieve action'); } $request = $e->getRequest(); // Was an "action" requested? - $action = $routeMatch->getParam('action', false); + $action = $routeResult->getMatchedParams()['action'] ?? null; if ($action) { // Handle arbitrary methods, ending in Action $method = static::getMethodFromAction($action); @@ -356,7 +364,7 @@ public function onDispatch(MvcEvent $e) break; // DELETE case 'delete': - $id = $this->getIdentifier($routeMatch, $request); + $id = $this->getIdentifier($request); if ($id !== false) { $action = 'delete'; @@ -371,7 +379,7 @@ public function onDispatch(MvcEvent $e) break; // GET case 'get': - $id = $this->getIdentifier($routeMatch, $request); + $id = $this->getIdentifier($request); if ($id !== false) { $action = 'get'; $return = $this->get($id); @@ -382,25 +390,26 @@ public function onDispatch(MvcEvent $e) break; // HEAD case 'head': - $id = $this->getIdentifier($routeMatch, $request); + $id = $this->getIdentifier($request); if ($id === false) { $id = null; } $action = 'head'; $headResult = $this->head($id); - $response = ($headResult instanceof Response) ? clone $headResult : $e->getResponse(); - $response->setContent(''); - $return = $response; + $response = ($headResult instanceof ResponseInterface) + ? $headResult + : $e->getResponse() ?? new Response(); + $return = $response->withBody(new Stream('php://memory', 'wb+')); break; // OPTIONS case 'options': $action = 'options'; - $this->options(); - $return = $e->getResponse(); + $response = $this->options(); + $return = $response ?? $e->getResponse() ?? new Response(); break; // PATCH case 'patch': - $id = $this->getIdentifier($routeMatch, $request); + $id = $this->getIdentifier($request); $data = $this->processBodyContent($request); if ($id !== false) { @@ -409,17 +418,8 @@ public function onDispatch(MvcEvent $e) break; } - // TODO: This try-catch should be removed in the future, but it - // will create a BC break for pre-2.2.0 apps that expect a 405 - // instead of going to patchList - try { - $action = 'patchList'; - $return = $this->patchList($data); - } catch (Exception\RuntimeException $ex) { - $response = $e->getResponse(); - $response->setStatusCode(405); - return $response; - } + $action = 'patchList'; + $return = $this->patchList($data); break; // POST case 'post': @@ -428,7 +428,7 @@ public function onDispatch(MvcEvent $e) break; // PUT case 'put': - $id = $this->getIdentifier($routeMatch, $request); + $id = $this->getIdentifier($request); $data = $this->processBodyContent($request); if ($id !== false) { @@ -442,12 +442,15 @@ public function onDispatch(MvcEvent $e) break; // All others... default: - $response = $e->getResponse(); - $response->setStatusCode(405); + $response = ($e->getResponse() ?? new Response())->withStatus(405); return $response; } - $routeMatch->setParam('action', $action); + $params = $routeResult->getMatchedParams(); + $params['action'] = $action; + $routeResult = $routeResult->withMatchedParams($params); + $request = $request->withAttribute(RouteResult::class, $routeResult); + $e->setRequest($request); $e->setResult($return); return $return; } @@ -455,36 +458,39 @@ public function onDispatch(MvcEvent $e) /** * Process post data and call create * - * @param Request $request + * @param ServerRequestInterface $request * @return mixed * @throws Exception\DomainException If a JSON request was made, but no * method for parsing JSON is available. */ - public function processPostData(Request $request) + public function processPostData(ServerRequestInterface $request) { if ($this->requestHasContentType($request, self::CONTENT_TYPE_JSON)) { - return $this->create($this->jsonDecode($request->getContent())); + return $this->create($this->jsonDecode($request->getBody()->__toString())); } - return $this->create($request->getPost()->toArray()); + $payload = $request->getParsedBody() ?: []; + return $this->create($payload); } /** * Check if request has certain content type * - * @param Request $request + * @param ServerRequestInterface $request * @param string|null $contentType * @return bool + * @throws \Exception */ - public function requestHasContentType(Request $request, $contentType = '') + public function requestHasContentType(ServerRequestInterface $request, $contentType = '') : bool { - /** @var $headerContentType \Zend\Http\Header\ContentType */ - $headerContentType = $request->getHeaders()->get('content-type'); - if (! $headerContentType) { + $headersContentType = $request->getHeader('content-type'); + if (empty($headersContentType)) { return false; } - $requestedContentType = $headerContentType->getFieldValue(); + // @TODO implement proper content negotiation + + $requestedContentType = array_pop($headersContentType); if (false !== strpos($requestedContentType, ';')) { $headerData = explode(';', $requestedContentType); $requestedContentType = array_shift($headerData); @@ -546,24 +552,18 @@ public function addHttpMethodHandler($method, /* Callable */ $handler) * Attempts to see if an identifier was passed in either the URI or the * query string, returning it if found. Otherwise, returns a boolean false. * - * @param \Zend\Router\RouteMatch $routeMatch - * @param Request $request + * @param ServerRequestInterface $request * @return false|mixed */ - protected function getIdentifier($routeMatch, $request) + protected function getIdentifier(ServerRequestInterface $request) { $identifier = $this->getIdentifierName(); - $id = $routeMatch->getParam($identifier, false); + $id = $request->getAttribute($identifier, false); if ($id !== false) { return $id; } - $id = $request->getQuery()->get($identifier, false); - if ($id !== false) { - return $id; - } - - return false; + return $request->getQueryParams()[$identifier] ?? false; } /** @@ -580,13 +580,13 @@ protected function getIdentifier($routeMatch, $request) * @throws Exception\DomainException If a JSON request was made, but no * method for parsing JSON is available. */ - protected function processBodyContent($request) + protected function processBodyContent(ServerRequestInterface $request) { - $content = $request->getContent(); + $content = $request->getBody()->__toString(); // JSON content? decode and return it. if ($this->requestHasContentType($request, self::CONTENT_TYPE_JSON)) { - return $this->jsonDecode($request->getContent()); + return $this->jsonDecode($content); } parse_str($content, $parsedParams); diff --git a/src/Controller/ControllerManager.php b/src/Controller/ControllerManager.php index 20e721655..fc1037154 100644 --- a/src/Controller/ControllerManager.php +++ b/src/Controller/ControllerManager.php @@ -5,15 +5,16 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller; -use Interop\Container\ContainerInterface; +use Psr\Container\ContainerInterface; use Zend\EventManager\EventManagerAwareInterface; use Zend\EventManager\SharedEventManagerInterface; use Zend\ServiceManager\AbstractPluginManager; use Zend\ServiceManager\ConfigInterface; use Zend\ServiceManager\Exception\InvalidServiceException; -use Zend\Stdlib\DispatchableInterface; /** * Manager for loading controllers @@ -34,7 +35,7 @@ class ControllerManager extends AbstractPluginManager * * @var string */ - protected $instanceOf = DispatchableInterface::class; + protected $instanceOf = Dispatchable::class; /** * Constructor @@ -79,7 +80,7 @@ public function validate($plugin) * pass. * * @param ContainerInterface $container - * @param DispatchableInterface $controller + * @param Dispatchable $controller */ public function injectEventManager(ContainerInterface $container, $controller) { @@ -97,7 +98,7 @@ public function injectEventManager(ContainerInterface $container, $controller) * Initializer: inject plugin manager * * @param ContainerInterface $container - * @param DispatchableInterface $controller + * @param Dispatchable $controller */ public function injectPluginManager(ContainerInterface $container, $controller) { @@ -105,6 +106,6 @@ public function injectPluginManager(ContainerInterface $container, $controller) return; } - $controller->setPluginManager($container->get('ControllerPluginManager')); + $controller->setPluginManager($container->get(PluginManager::class)); } } diff --git a/src/Controller/Dispatchable.php b/src/Controller/Dispatchable.php new file mode 100644 index 000000000..7eafdf729 --- /dev/null +++ b/src/Controller/Dispatchable.php @@ -0,0 +1,16 @@ + 'ConsoleAdapter', FilterPluginManager::class => 'FilterManager', HydratorPluginManager::class => 'HydratorManager', InputFilterPluginManager::class => 'InputFilterManager', @@ -98,7 +97,7 @@ class LazyControllerAbstractFactory implements AbstractFactoryInterface /** * {@inheritDoc} * - * @return DispatchableInterface + * @return Dispatchable */ public function __invoke(ContainerInterface $container, $requestedName, array $options = null) { @@ -131,7 +130,7 @@ public function canCreate(ContainerInterface $container, $requestedName) return false; } - return in_array(DispatchableInterface::class, class_implements($requestedName), true); + return in_array(Dispatchable::class, class_implements($requestedName), true); } /** @@ -146,10 +145,8 @@ public function canCreate(ContainerInterface $container, $requestedName) private function resolveParameter(ContainerInterface $container, $requestedName) { /** - * @param ReflectionClass $parameter + * @param ReflectionParameter $parameter * @return mixed - * @throws ServiceNotFoundException If type-hinted parameter cannot be - * resolved to a service in the container. */ return function (ReflectionParameter $parameter) use ($container, $requestedName) { if ($parameter->isArray() @@ -164,7 +161,7 @@ private function resolveParameter(ContainerInterface $container, $requestedName) } if (! $parameter->getClass()) { - return; + return null; } $type = $parameter->getClass()->getName(); diff --git a/src/Controller/MiddlewareController.php b/src/Controller/MiddlewareController.php index aee5e269d..d92f85706 100644 --- a/src/Controller/MiddlewareController.php +++ b/src/Controller/MiddlewareController.php @@ -5,24 +5,23 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller; use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Message\ServerRequestInterface as Request; +use Psr\Http\Server\RequestHandlerInterface; use Zend\EventManager\EventManagerInterface; -use Zend\Http\Request; use Zend\Mvc\Exception\ReachedFinalHandlerException; use Zend\Mvc\Exception\RuntimeException; use Zend\Mvc\MvcEvent; -use Zend\Psr7Bridge\Psr7ServerRequest; -use Zend\Router\RouteMatch; -use Zend\Stratigility\Delegate\CallableDelegateDecorator; use Zend\Stratigility\MiddlewarePipe; /** * @internal don't use this in your codebase, or else @ocramius will hunt you * down. This is just an internal hack to make middleware trigger - * 'dispatch' events attached to the DispatchableInterface identifier. + * 'dispatch' events attached to the Dispatchable identifier. * * Specifically, it will receive a @see MiddlewarePipe and a * @see ResponseInterface prototype, and then dispatch the pipe whilst still @@ -38,21 +37,13 @@ final class MiddlewareController extends AbstractController */ private $pipe; - /** - * @var ResponseInterface - */ - private $responsePrototype; - public function __construct( MiddlewarePipe $pipe, - ResponseInterface $responsePrototype, EventManagerInterface $eventManager, MvcEvent $event ) { $this->eventIdentifier = __CLASS__; $this->pipe = $pipe; - $this->responsePrototype = $responsePrototype; - $this->setEventManager($eventManager); $this->setEvent($event); } @@ -64,60 +55,22 @@ public function __construct( */ public function onDispatch(MvcEvent $e) { - $routeMatch = $e->getRouteMatch(); - $psr7Request = $this->populateRequestParametersFromRoute( - $this->loadRequest()->withAttribute(RouteMatch::class, $routeMatch), - $routeMatch - ); - - $result = $this->pipe->process($psr7Request, new CallableDelegateDecorator( - function () { + $request = $e->getRequest(); + + $finalHandler = new class implements RequestHandlerInterface { + /** + * Handle the request and return a response. + */ + public function handle(Request $request) : ResponseInterface + { throw ReachedFinalHandlerException::create(); - }, - $this->responsePrototype - )); - - $e->setResult($result); - - return $result; - } - - /** - * @return \Zend\Diactoros\ServerRequest - * - * @throws RuntimeException - */ - private function loadRequest() - { - $request = $this->request; - - if (! $request instanceof Request) { - throw new RuntimeException(sprintf( - 'Expected request to be a %s, %s given', - Request::class, - get_class($request) - )); - } + } + }; - return Psr7ServerRequest::fromZend($request); - } - - /** - * @param ServerRequestInterface $request - * @param RouteMatch|null $routeMatch - * - * @return ServerRequestInterface - */ - private function populateRequestParametersFromRoute(ServerRequestInterface $request, RouteMatch $routeMatch = null) - { - if (! $routeMatch) { - return $request; - } + $response = $this->pipe->process($request, $finalHandler); - foreach ($routeMatch->getParams() as $key => $value) { - $request = $request->withAttribute($key, $value); - } + $e->setResult($response); - return $request; + return $response; } } diff --git a/src/Controller/Plugin/AbstractPlugin.php b/src/Controller/Plugin/AbstractPlugin.php index c00a570cf..b0dc62677 100644 --- a/src/Controller/Plugin/AbstractPlugin.php +++ b/src/Controller/Plugin/AbstractPlugin.php @@ -5,9 +5,11 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin; -use Zend\Stdlib\DispatchableInterface as Dispatchable; +use Zend\Mvc\Controller\Dispatchable; abstract class AbstractPlugin implements PluginInterface { @@ -32,7 +34,7 @@ public function setController(Dispatchable $controller) * * @return null|Dispatchable */ - public function getController() + public function getController() : ?Dispatchable { return $this->controller; } diff --git a/src/Controller/Plugin/AcceptableViewModelSelector.php b/src/Controller/Plugin/AcceptableViewModelSelector.php index 7a7a5efe7..c629eaca6 100644 --- a/src/Controller/Plugin/AcceptableViewModelSelector.php +++ b/src/Controller/Plugin/AcceptableViewModelSelector.php @@ -5,10 +5,13 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin; use Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart; use Zend\Http\Request; +use Zend\Mvc\Exception\RuntimeException; use Zend\Mvc\InjectApplicationEventInterface; use Zend\Mvc\MvcEvent; use Zend\Mvc\Exception\DomainException; @@ -42,7 +45,7 @@ class AcceptableViewModelSelector extends AbstractPlugin /** * Default array to match against. * - * @var Array + * @var array|null */ protected $defaultMatchAgainst; @@ -86,7 +89,7 @@ public function getViewModel( $name = $this->getViewModelName($matchAgainst, $returnDefault, $resultReference); if (! $name) { - return; + return null; } if (! class_exists($name)) { @@ -102,7 +105,7 @@ public function getViewModel( * @param array $matchAgainst (optional) The Array to match against * @param bool $returnDefault (optional) If no match is available. Return default instead * @param AbstractFieldValuePart|null $resultReference (optional) The object that was matched. - * @return ModelInterface|null Returns null if $returnDefault = false and no match could be made + * @return string|null Returns null if $returnDefault = false and no match could be made */ public function getViewModelName( array $matchAgainst = null, @@ -132,7 +135,7 @@ public function match(array $matchAgainst = null) $headers = $request->getHeaders(); if ((! $matchAgainst && ! $this->defaultMatchAgainst) || ! $headers->has('accept')) { - return; + return null; } if (! $matchAgainst) { @@ -148,11 +151,12 @@ public function match(array $matchAgainst = null) /** @var $accept \Zend\Http\Header\Accept */ $accept = $headers->get('Accept'); - if (($res = $accept->match($matchAgainstString)) === false) { - return; + $res = $accept->match($matchAgainstString); + if ($res instanceof AbstractFieldValuePart) { + return $res; } - return $res; + return null; } /** @@ -160,9 +164,9 @@ public function match(array $matchAgainst = null) * @param string $defaultViewModelName The default View Model name * @return AcceptableViewModelSelector provides fluent interface */ - public function setDefaultViewModelName($defaultViewModelName) + public function setDefaultViewModelName(string $defaultViewModelName) { - $this->defaultViewModelName = (string) $defaultViewModelName; + $this->defaultViewModelName = $defaultViewModelName; return $this; } @@ -220,7 +224,11 @@ protected function injectViewModelName($modelAcceptString, $modelName) */ protected function extractViewModelName(AbstractFieldValuePart $res) { - $modelName = $res->getMatchedAgainst()->params[self::INJECT_VIEWMODEL_NAME]; + $matched = $res->getMatchedAgainst(); + if (! $matched) { + throw new RuntimeException('Matched field value part is not set'); + } + $modelName = $matched->params[self::INJECT_VIEWMODEL_NAME]; return str_replace('|', '\\', $modelName); } diff --git a/src/Controller/Plugin/CreateHttpNotFoundModel.php b/src/Controller/Plugin/CreateHttpNotFoundModel.php index dd35143e2..dcdae007d 100644 --- a/src/Controller/Plugin/CreateHttpNotFoundModel.php +++ b/src/Controller/Plugin/CreateHttpNotFoundModel.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin; use Zend\Http\Response; @@ -19,10 +21,8 @@ class CreateHttpNotFoundModel extends AbstractPlugin * * @return ViewModel */ - public function __invoke(Response $response) + public function __invoke() { - $response->setStatusCode(404); - return new ViewModel(['content' => 'Page not found']); } } diff --git a/src/Controller/Plugin/Forward.php b/src/Controller/Plugin/Forward.php index 32f2d8273..595274ca6 100644 --- a/src/Controller/Plugin/Forward.php +++ b/src/Controller/Plugin/Forward.php @@ -5,15 +5,17 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin; use Zend\EventManager\SharedEventManagerInterface as SharedEvents; use Zend\Mvc\Controller\ControllerManager; +use Zend\Mvc\Controller\Dispatchable; use Zend\Mvc\Exception; use Zend\Mvc\InjectApplicationEventInterface; use Zend\Mvc\MvcEvent; -use Zend\Router\RouteMatch; -use Zend\Stdlib\CallbackHandler; +use Zend\Router\RouteResult; class Forward extends AbstractPlugin { @@ -56,9 +58,9 @@ public function __construct(ControllerManager $controllers) * @param int $maxNestedForwards * @return self */ - public function setMaxNestedForwards($maxNestedForwards) + public function setMaxNestedForwards(integer $maxNestedForwards) { - $this->maxNestedForwards = (int) $maxNestedForwards; + $this->maxNestedForwards = $maxNestedForwards; return $this; } @@ -82,7 +84,7 @@ public function getListenersToDetach() // from getting attached to the ViewModel twice when a calling action // returns the output generated by a forwarded action. $this->listenersToDetach = [[ - 'id' => 'Zend\Stdlib\DispatchableInterface', + 'id' => Dispatchable::class, 'event' => MvcEvent::EVENT_DISPATCH, 'class' => 'Zend\Mvc\View\Http\InjectViewModelListener', ]]; @@ -124,9 +126,18 @@ public function dispatch($name, array $params = null) // Allow passing parameters to seed the RouteMatch with & copy matched route name if ($params !== null) { - $routeMatch = new RouteMatch($params); - $routeMatch->setMatchedRouteName($event->getRouteMatch()->getMatchedRouteName()); - $event->setRouteMatch($routeMatch); + $request = $event->getRequest(); + $routeResult = $request->getAttribute(RouteResult::class); + if ($routeResult) { + $routeResult = $routeResult->withMatchedParams($params); + } else { + $routeResult = RouteResult::fromRouteMatch($params); + } + foreach ($params as $name => $param) { + $request = $request->withAttribute($name, $param); + } + $request = $request->withAttribute(RouteResult::class, $routeResult); + $event->setRequest($request); } if ($this->numNestedForwards > $this->maxNestedForwards) { @@ -140,7 +151,7 @@ public function dispatch($name, array $params = null) $sharedEvents = $event->getApplication()->getEventManager()->getSharedManager(); $listeners = $this->detachProblemListeners($sharedEvents); - $return = $controller->dispatch($event->getRequest(), $event->getResponse()); + $return = $controller->dispatch($event->getRequest()); // If we detached any listeners, reattach them now: $this->reattachProblemListeners($sharedEvents, $listeners); @@ -282,7 +293,7 @@ private function getSharedListenersById($id, $event, SharedEvents $sharedEvents) * Varies detachment based on zend-eventmanager version. * * @param string|int $id - * @param callable|CallbackHandler $listener + * @param callable $listener * @param SharedEvents $sharedEvents * @return void */ diff --git a/src/Controller/Plugin/Layout.php b/src/Controller/Plugin/Layout.php index 89e41588e..7171ba66c 100644 --- a/src/Controller/Plugin/Layout.php +++ b/src/Controller/Plugin/Layout.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin; use Zend\Mvc\Exception; @@ -25,10 +27,10 @@ class Layout extends AbstractPlugin * @param string $template * @return Layout */ - public function setTemplate($template) + public function setTemplate(string $template) { $viewModel = $this->getViewModel(); - $viewModel->setTemplate((string) $template); + $viewModel->setTemplate($template); return $this; } diff --git a/src/Controller/Plugin/Params.php b/src/Controller/Plugin/Params.php index eeed5456b..f09660961 100644 --- a/src/Controller/Plugin/Params.php +++ b/src/Controller/Plugin/Params.php @@ -5,8 +5,13 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Message\UploadedFileInterface; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\Exception\RuntimeException; use Zend\Mvc\InjectApplicationEventInterface; @@ -32,15 +37,17 @@ public function __invoke($param = null, $default = null) * * @param string $name File name to retrieve, or null to get all. * @param mixed $default Default value to use when the file is missing. - * @return array|\ArrayAccess|null + * @return array|UploadedFileInterface[]|UploadedFileInterface|null */ public function fromFiles($name = null, $default = null) { + $files = $this->getController()->getRequest()->getUploadedFiles(); + if ($name === null) { - return $this->getController()->getRequest()->getFiles($name, $default)->toArray(); + return $files; } - return $this->getController()->getRequest()->getFiles($name, $default); + return $files[$name] ?? $default; } /** @@ -48,15 +55,23 @@ public function fromFiles($name = null, $default = null) * * @param string $header Header name to retrieve, or null to get all. * @param mixed $default Default value to use when the requested header is missing. - * @return null|\Zend\Http\Header\HeaderInterface + * @return string[][]|string[] */ - public function fromHeader($header = null, $default = null) + public function fromHeader($header = null, array $default = []) { + /** + * @var ServerRequestInterface $request + */ + $request = $this->getController()->getRequest(); if ($header === null) { - return $this->getController()->getRequest()->getHeaders($header, $default)->toArray(); + return $request->getHeaders(); + } + + if (! $request->hasHeader($header)) { + return $default; } - return $this->getController()->getRequest()->getHeaders($header, $default); + return $request->getHeader($header); } /** @@ -68,11 +83,12 @@ public function fromHeader($header = null, $default = null) */ public function fromPost($param = null, $default = null) { + $parsedBody = $this->getController()->getRequest()->getParsedBody(); if ($param === null) { - return $this->getController()->getRequest()->getPost($param, $default)->toArray(); + return $parsedBody; } - return $this->getController()->getRequest()->getPost($param, $default); + return $parsedBody[$param] ?? $default; } /** @@ -84,11 +100,12 @@ public function fromPost($param = null, $default = null) */ public function fromQuery($param = null, $default = null) { + $query = $this->getController()->getRequest()->getQueryParams(); if ($param === null) { - return $this->getController()->getRequest()->getQuery($param, $default)->toArray(); + return $query; } - return $this->getController()->getRequest()->getQuery($param, $default); + return $query[$param] ?? $default; } /** @@ -103,16 +120,10 @@ public function fromRoute($param = null, $default = null) { $controller = $this->getController(); - if (! $controller instanceof InjectApplicationEventInterface) { - throw new RuntimeException( - 'Controllers must implement Zend\Mvc\InjectApplicationEventInterface to use this plugin.' - ); - } - if ($param === null) { - return $controller->getEvent()->getRouteMatch()->getParams(); + return $controller->getRequest()->getAttributes(); } - return $controller->getEvent()->getRouteMatch()->getParam($param, $default); + return $controller->getRequest()->getAttribute($param, $default); } } diff --git a/src/Controller/Plugin/PluginInterface.php b/src/Controller/Plugin/PluginInterface.php index 1a9fdaffa..c73a1cb76 100644 --- a/src/Controller/Plugin/PluginInterface.php +++ b/src/Controller/Plugin/PluginInterface.php @@ -5,9 +5,11 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin; -use Zend\Stdlib\DispatchableInterface as Dispatchable; +use Zend\Mvc\Controller\Dispatchable; interface PluginInterface { @@ -24,5 +26,5 @@ public function setController(Dispatchable $controller); * * @return null|Dispatchable */ - public function getController(); + public function getController() : ?Dispatchable; } diff --git a/src/Controller/Plugin/Redirect.php b/src/Controller/Plugin/Redirect.php index df9b650d4..b343d81e7 100644 --- a/src/Controller/Plugin/Redirect.php +++ b/src/Controller/Plugin/Redirect.php @@ -5,9 +5,12 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin; -use Zend\Http\Response; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; use Zend\Mvc\Exception; use Zend\Mvc\InjectApplicationEventInterface; use Zend\Mvc\MvcEvent; @@ -18,7 +21,6 @@ class Redirect extends AbstractPlugin { protected $event; - protected $response; /** * Generate redirect response based on given route @@ -27,12 +29,16 @@ class Redirect extends AbstractPlugin * @param array $params Parameters to use in url generation, if any * @param array $options RouteInterface-specific options to use in url generation, if any * @param bool $reuseMatchedParams Whether to reuse matched parameters - * @return Response + * @return ResponseInterface * @throws Exception\DomainException if composed controller does not implement InjectApplicationEventInterface, or * router cannot be found in controller event */ - public function toRoute($route = null, $params = [], $options = [], $reuseMatchedParams = false) - { + public function toRoute( + $route = null, + $params = [], + $options = [], + $reuseMatchedParams = false + ) : ResponseInterface { $controller = $this->getController(); if (! $controller || ! method_exists($controller, 'plugin')) { throw new Exception\DomainException( @@ -55,22 +61,23 @@ public function toRoute($route = null, $params = [], $options = [], $reuseMatche * Generate redirect response based on given URL * * @param string $url - * @return Response + * @return ResponseInterface */ - public function toUrl($url) + public function toUrl($url) : ResponseInterface { $response = $this->getResponse(); - $response->getHeaders()->addHeaderLine('Location', $url); - $response->setStatusCode(302); + $response = $response->withStatus(302) + ->withoutHeader('Location') + ->withAddedHeader('Location', $url); return $response; } /** * Refresh to current route * - * @return Response + * @return ResponseInterface */ - public function refresh() + public function refresh() : ResponseInterface { return $this->toRoute(null, [], [], true); } @@ -78,22 +85,14 @@ public function refresh() /** * Get the response * - * @return Response + * @return ResponseInterface * @throws Exception\DomainException if unable to find response */ - protected function getResponse() + protected function getResponse() : ResponseInterface { - if ($this->response) { - return $this->response; - } - $event = $this->getEvent(); - $response = $event->getResponse(); - if (! $response instanceof Response) { - throw new Exception\DomainException('Redirect plugin requires event compose a response'); - } - $this->response = $response; - return $this->response; + $response = $event->getResponse() ?? new Response(); + return $response; } /** @@ -102,7 +101,7 @@ protected function getResponse() * @return MvcEvent * @throws Exception\DomainException if unable to find event */ - protected function getEvent() + protected function getEvent() : MvcEvent { if ($this->event) { return $this->event; diff --git a/src/Controller/Plugin/Service/ForwardFactory.php b/src/Controller/Plugin/Service/ForwardFactory.php index 2bf729545..606a70747 100644 --- a/src/Controller/Plugin/Service/ForwardFactory.php +++ b/src/Controller/Plugin/Service/ForwardFactory.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin\Service; use Interop\Container\ContainerInterface; diff --git a/src/Controller/Plugin/Url.php b/src/Controller/Plugin/Url.php index 7a050a175..6cd9ba2f8 100644 --- a/src/Controller/Plugin/Url.php +++ b/src/Controller/Plugin/Url.php @@ -5,14 +5,16 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller\Plugin; use Traversable; use Zend\EventManager\EventInterface; use Zend\Mvc\Exception; use Zend\Mvc\InjectApplicationEventInterface; -use Zend\Mvc\ModuleRouteListener; use Zend\Mvc\MvcEvent; +use Zend\Router\RouteResult; use Zend\Router\RouteStackInterface; class Url extends AbstractPlugin @@ -51,14 +53,15 @@ public function fromRoute($route = null, $params = [], $options = [], $reuseMatc $event = $controller->getEvent(); $router = null; - $matches = null; + $request = null; if ($event instanceof MvcEvent) { $router = $event->getRouter(); - $matches = $event->getRouteMatch(); + $request = $event->getRequest(); } elseif ($event instanceof EventInterface) { $router = $event->getParam('router', false); - $matches = $event->getParam('route-match', false); + $request = $event->getParam('request', false); } + $matches = $request ? $request->getAttribute(RouteResult::class) : null; if (! $router instanceof RouteStackInterface) { throw new Exception\DomainException( 'Url plugin requires that controller event compose a router; none found' @@ -68,36 +71,32 @@ public function fromRoute($route = null, $params = [], $options = [], $reuseMatc if (3 == func_num_args() && is_bool($options)) { $reuseMatchedParams = $options; $options = []; + } elseif (\is_bool($options)) { + $options = []; } if ($route === null) { if (! $matches) { - throw new Exception\RuntimeException('No RouteMatch instance present'); + throw new Exception\RuntimeException('No RouteResult instance present'); } + /** + * @var string|null + */ $route = $matches->getMatchedRouteName(); if ($route === null) { - throw new Exception\RuntimeException('RouteMatch does not contain a matched route name'); + throw new Exception\RuntimeException('RouteResult does not contain a matched route name'); } } if ($reuseMatchedParams && $matches) { - $routeMatchParams = $matches->getParams(); - - if (isset($routeMatchParams[ModuleRouteListener::ORIGINAL_CONTROLLER])) { - $routeMatchParams['controller'] = $routeMatchParams[ModuleRouteListener::ORIGINAL_CONTROLLER]; - unset($routeMatchParams[ModuleRouteListener::ORIGINAL_CONTROLLER]); - } - - if (isset($routeMatchParams[ModuleRouteListener::MODULE_NAMESPACE])) { - unset($routeMatchParams[ModuleRouteListener::MODULE_NAMESPACE]); - } + $routeMatchParams = $matches->getMatchedParams(); $params = array_merge($routeMatchParams, $params); } $options['name'] = $route; - return $router->assemble($params, $options); + return $router->assemble($params, $options)->__toString(); } } diff --git a/src/Controller/PluginManager.php b/src/Controller/PluginManager.php index 5a9295903..8efeec433 100644 --- a/src/Controller/PluginManager.php +++ b/src/Controller/PluginManager.php @@ -5,12 +5,14 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Controller; +use Zend\Mvc\Controller\Plugin\PluginInterface; use Zend\ServiceManager\AbstractPluginManager; use Zend\ServiceManager\Exception\InvalidServiceException; use Zend\ServiceManager\Factory\InvokableFactory; -use Zend\Stdlib\DispatchableInterface; /** * Plugin manager implementation for controllers @@ -73,7 +75,7 @@ class PluginManager extends AbstractPluginManager ]; /** - * @var DispatchableInterface + * @var Dispatchable */ protected $controller; @@ -88,7 +90,7 @@ class PluginManager extends AbstractPluginManager * plugin is lost. * * @param string $name - * @return DispatchableInterface + * @return PluginInterface */ public function get($name, array $options = null) { @@ -101,10 +103,10 @@ public function get($name, array $options = null) /** * Set controller * - * @param DispatchableInterface $controller + * @param Dispatchable $controller * @return PluginManager */ - public function setController(DispatchableInterface $controller) + public function setController(Dispatchable $controller) { $this->controller = $controller; @@ -114,9 +116,9 @@ public function setController(DispatchableInterface $controller) /** * Retrieve controller instance * - * @return null|DispatchableInterface + * @return null|Dispatchable */ - public function getController() + public function getController() : ?Dispatchable { return $this->controller; } @@ -137,7 +139,7 @@ public function injectController($plugin) } $controller = $this->getController(); - if (! $controller instanceof DispatchableInterface) { + if (! $controller) { return; } diff --git a/src/DispatchListener.php b/src/DispatchListener.php index ed7c7fe68..713e8ad7e 100644 --- a/src/DispatchListener.php +++ b/src/DispatchListener.php @@ -5,12 +5,14 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc; use ArrayObject; use Zend\EventManager\AbstractListenerAggregate; use Zend\EventManager\EventManagerInterface; -use Zend\Router\RouteMatch; +use Zend\Router\RouteResult; use Zend\ServiceManager\Exception\InvalidServiceException; use Zend\Stdlib\ArrayUtils; @@ -75,12 +77,12 @@ public function attach(EventManagerInterface $events, $priority = 1) public function onDispatch(MvcEvent $e) { if (null !== $e->getResult()) { - return; + return null; } - $routeMatch = $e->getRouteMatch(); - $controllerName = $routeMatch instanceof RouteMatch - ? $routeMatch->getParam('controller', 'not-found') + $routeResult = $e->getRequest()->getAttribute(RouteResult::class); + $controllerName = $routeResult instanceof RouteResult + ? $routeResult->getMatchedParams()['controller'] ?? 'not-found' : 'not-found'; $application = $e->getApplication(); $events = $application->getEventManager(); @@ -90,7 +92,7 @@ public function onDispatch(MvcEvent $e) // Query abstract controllers, too! if (! $controllerManager->has($controllerName)) { $return = $this->marshalControllerNotFoundEvent( - $application::ERROR_CONTROLLER_NOT_FOUND, + Application::ERROR_CONTROLLER_NOT_FOUND, $controllerName, $e, $application @@ -102,7 +104,7 @@ public function onDispatch(MvcEvent $e) $controller = $controllerManager->get($controllerName); } catch (Exception\InvalidControllerException $exception) { $return = $this->marshalControllerNotFoundEvent( - $application::ERROR_CONTROLLER_INVALID, + Application::ERROR_CONTROLLER_INVALID, $controllerName, $e, $application, @@ -111,7 +113,7 @@ public function onDispatch(MvcEvent $e) return $this->complete($return, $e); } catch (InvalidServiceException $exception) { $return = $this->marshalControllerNotFoundEvent( - $application::ERROR_CONTROLLER_INVALID, + Application::ERROR_CONTROLLER_INVALID, $controllerName, $e, $application, @@ -121,9 +123,6 @@ public function onDispatch(MvcEvent $e) } catch (\Throwable $exception) { $return = $this->marshalBadControllerEvent($controllerName, $e, $application, $exception); return $this->complete($return, $e); - } catch (\Exception $exception) { // @TODO clean up once PHP 7 requirement is enforced - $return = $this->marshalBadControllerEvent($controllerName, $e, $application, $exception); - return $this->complete($return, $e); } if ($controller instanceof InjectApplicationEventInterface) { @@ -131,25 +130,17 @@ public function onDispatch(MvcEvent $e) } $request = $e->getRequest(); - $response = $application->getResponse(); - $caughtException = null; try { - $return = $controller->dispatch($request, $response); + $return = $controller->dispatch($request); } catch (\Throwable $ex) { - $caughtException = $ex; - } catch (\Exception $ex) { // @TODO clean up once PHP 7 requirement is enforced - $caughtException = $ex; - } - - if ($caughtException !== null) { $e->setName(MvcEvent::EVENT_DISPATCH_ERROR); - $e->setError($application::ERROR_EXCEPTION); + $e->setError(Application::ERROR_EXCEPTION); $e->setController($controllerName); $e->setControllerClass(get_class($controller)); - $e->setParam('exception', $caughtException); + $e->setParam('exception', $ex); - $return = $application->getEventManager()->triggerEvent($e)->last(); + $return = $events->triggerEvent($e)->last(); if (! $return) { $return = $e->getResult(); } @@ -165,8 +156,7 @@ public function reportMonitorEvent(MvcEvent $e) { $error = $e->getError(); $exception = $e->getParam('exception'); - // @TODO clean up once PHP 7 requirement is enforced - if ($exception instanceof \Exception || $exception instanceof \Throwable) { + if ($exception instanceof \Throwable) { zend_monitor_custom_event_ex( $error, $exception->getMessage(), @@ -190,6 +180,7 @@ protected function complete($return, MvcEvent $event) $return = new ArrayObject($return, ArrayObject::ARRAY_AS_PROPS); } } + // @TODO should this set $return as a response into mvc event? $event->setResult($return); return $return; } @@ -200,7 +191,7 @@ protected function complete($return, MvcEvent $event) * @param string $type * @param string $controllerName * @param MvcEvent $event - * @param Application $application + * @param ApplicationInterface $application * @param \Throwable|\Exception $exception * @return mixed */ @@ -208,7 +199,7 @@ protected function marshalControllerNotFoundEvent( $type, $controllerName, MvcEvent $event, - Application $application, + ApplicationInterface $application, $exception = null ) { $event->setName(MvcEvent::EVENT_DISPATCH_ERROR); @@ -233,18 +224,18 @@ protected function marshalControllerNotFoundEvent( * * @param string $controllerName * @param MvcEvent $event - * @param Application $application + * @param ApplicationInterface $application * @param \Throwable|\Exception $exception * @return mixed */ protected function marshalBadControllerEvent( $controllerName, MvcEvent $event, - Application $application, + ApplicationInterface $application, $exception ) { $event->setName(MvcEvent::EVENT_DISPATCH_ERROR); - $event->setError($application::ERROR_EXCEPTION); + $event->setError(Application::ERROR_EXCEPTION); $event->setController($controllerName); $event->setParam('exception', $exception); diff --git a/src/Exception/BadMethodCallException.php b/src/Exception/BadMethodCallException.php index 50c951c8c..76d9c4825 100644 --- a/src/Exception/BadMethodCallException.php +++ b/src/Exception/BadMethodCallException.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; class BadMethodCallException extends \BadMethodCallException implements ExceptionInterface diff --git a/src/Exception/DomainException.php b/src/Exception/DomainException.php index 8988e676d..fcf8b7c5b 100644 --- a/src/Exception/DomainException.php +++ b/src/Exception/DomainException.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; class DomainException extends \DomainException implements ExceptionInterface diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php index 28c62d879..7000e1d3e 100644 --- a/src/Exception/ExceptionInterface.php +++ b/src/Exception/ExceptionInterface.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; interface ExceptionInterface diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php index fd7c910cd..c66f779da 100644 --- a/src/Exception/InvalidArgumentException.php +++ b/src/Exception/InvalidArgumentException.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface diff --git a/src/Exception/InvalidControllerException.php b/src/Exception/InvalidControllerException.php index 51afa29e5..225e5dfcb 100644 --- a/src/Exception/InvalidControllerException.php +++ b/src/Exception/InvalidControllerException.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; class InvalidControllerException extends \Exception implements ExceptionInterface diff --git a/src/Exception/InvalidMiddlewareException.php b/src/Exception/InvalidMiddlewareException.php index 5e4982e8c..f76f9493c 100644 --- a/src/Exception/InvalidMiddlewareException.php +++ b/src/Exception/InvalidMiddlewareException.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; final class InvalidMiddlewareException extends RuntimeException @@ -18,9 +20,8 @@ final class InvalidMiddlewareException extends RuntimeException * @param string $middlewareName * @return self */ - public static function fromMiddlewareName($middlewareName) + public static function fromMiddlewareName(string $middlewareName) { - $middlewareName = (string)$middlewareName; $instance = new self(sprintf('Cannot dispatch middleware %s', $middlewareName)); $instance->middlewareName = $middlewareName; return $instance; diff --git a/src/Exception/InvalidPluginException.php b/src/Exception/InvalidPluginException.php index bb3f3cd00..9f69dbe83 100644 --- a/src/Exception/InvalidPluginException.php +++ b/src/Exception/InvalidPluginException.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; class InvalidPluginException extends \Exception implements ExceptionInterface diff --git a/src/Exception/MissingLocatorException.php b/src/Exception/MissingLocatorException.php index 359d14c3e..93cc33f97 100644 --- a/src/Exception/MissingLocatorException.php +++ b/src/Exception/MissingLocatorException.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; class MissingLocatorException extends RuntimeException diff --git a/src/Exception/ReachedFinalHandlerException.php b/src/Exception/ReachedFinalHandlerException.php index 874d48b80..b90239def 100644 --- a/src/Exception/ReachedFinalHandlerException.php +++ b/src/Exception/ReachedFinalHandlerException.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; class ReachedFinalHandlerException extends RuntimeException diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php index 4469264e8..1a1171450 100644 --- a/src/Exception/RuntimeException.php +++ b/src/Exception/RuntimeException.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Exception; class RuntimeException extends \RuntimeException implements ExceptionInterface diff --git a/src/HttpMethodListener.php b/src/HttpMethodListener.php index 77e8e007d..af3e800f5 100644 --- a/src/HttpMethodListener.php +++ b/src/HttpMethodListener.php @@ -5,12 +5,15 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc; +use Fig\Http\Message\RequestMethodInterface as RequestMethod; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; use Zend\EventManager\AbstractListenerAggregate; use Zend\EventManager\EventManagerInterface; -use Zend\Http\Request as HttpRequest; -use Zend\Http\Response as HttpResponse; class HttpMethodListener extends AbstractListenerAggregate { @@ -18,16 +21,16 @@ class HttpMethodListener extends AbstractListenerAggregate * @var array */ protected $allowedMethods = [ - HttpRequest::METHOD_CONNECT, - HttpRequest::METHOD_DELETE, - HttpRequest::METHOD_GET, - HttpRequest::METHOD_HEAD, - HttpRequest::METHOD_OPTIONS, - HttpRequest::METHOD_PATCH, - HttpRequest::METHOD_POST, - HttpRequest::METHOD_PUT, - HttpRequest::METHOD_PROPFIND, - HttpRequest::METHOD_TRACE, + RequestMethod::METHOD_HEAD, + RequestMethod::METHOD_GET, + RequestMethod::METHOD_POST, + RequestMethod::METHOD_PUT, + RequestMethod::METHOD_PATCH, + RequestMethod::METHOD_DELETE, + RequestMethod::METHOD_OPTIONS, + RequestMethod::METHOD_TRACE, + RequestMethod::METHOD_CONNECT, + 'PROPFIND', ]; /** @@ -37,7 +40,7 @@ class HttpMethodListener extends AbstractListenerAggregate /** * @param bool $enabled - * @param array $allowedMethods + * @param null|array $allowedMethods */ public function __construct($enabled = true, $allowedMethods = []) { @@ -66,24 +69,20 @@ public function attach(EventManagerInterface $events, $priority = 1) /** * @param MvcEvent $e - * @return void|HttpResponse + * @return null|ResponseInterface */ - public function onRoute(MvcEvent $e) + public function onRoute(MvcEvent $e) : ?ResponseInterface { $request = $e->getRequest(); - $response = $e->getResponse(); - - if (! $request instanceof HttpRequest || ! $response instanceof HttpResponse) { - return; - } $method = $request->getMethod(); if (in_array($method, $this->getAllowedMethods())) { - return; + return null; } - $response->setStatusCode(405); + $response = $e->getResponse() ?? new Response(); + $response = $response->withStatus(405); return $response; } @@ -118,8 +117,8 @@ public function isEnabled() /** * @param bool $enabled */ - public function setEnabled($enabled) + public function setEnabled(bool $enabled) { - $this->enabled = (bool) $enabled; + $this->enabled = $enabled; } } diff --git a/src/InjectApplicationEventInterface.php b/src/InjectApplicationEventInterface.php index 18ae5af1c..c99e67d4a 100644 --- a/src/InjectApplicationEventInterface.php +++ b/src/InjectApplicationEventInterface.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc; use Zend\EventManager\EventInterface as Event; diff --git a/src/MiddlewareListener.php b/src/MiddlewareListener.php index 618325451..9d6ca3a83 100644 --- a/src/MiddlewareListener.php +++ b/src/MiddlewareListener.php @@ -5,23 +5,26 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc; -use Interop\Container\ContainerInterface; -use Interop\Http\ServerMiddleware\MiddlewareInterface; -use Psr\Http\Message\ResponseInterface as PsrResponseInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface as PsrServerRequestInterface; +use Psr\Container\ContainerInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Throwable; use Zend\EventManager\AbstractListenerAggregate; use Zend\EventManager\EventManagerInterface; use Zend\Mvc\Exception\InvalidMiddlewareException; -use Zend\Mvc\Exception\ReachedFinalHandlerException; use Zend\Mvc\Controller\MiddlewareController; -use Zend\Psr7Bridge\Psr7Response; -use Zend\Router\RouteMatch; -use Zend\Stratigility\Delegate\CallableDelegateDecorator; +use Zend\Router\RouteResult; +use Zend\Stratigility\Middleware\RequestHandlerMiddleware; use Zend\Stratigility\MiddlewarePipe; +use function is_object; +use function get_class; +use function gettype; + class MiddlewareListener extends AbstractListenerAggregate { /** @@ -30,7 +33,7 @@ class MiddlewareListener extends AbstractListenerAggregate * @param EventManagerInterface $events * @return void */ - public function attach(EventManagerInterface $events, $priority = 1) + public function attach(EventManagerInterface $events, $priority = 1) : void { $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, [$this, 'onDispatch'], 1); } @@ -44,31 +47,31 @@ public function attach(EventManagerInterface $events, $priority = 1) public function onDispatch(MvcEvent $event) { if (null !== $event->getResult()) { - return; + return null; } - $routeMatch = $event->getRouteMatch(); - $middleware = $routeMatch->getParam('middleware', false); - if (false === $middleware) { - return; + /** @var RouteResult $routeResult */ + $routeResult = $event->getRequest()->getAttribute(RouteResult::class); + if (! $routeResult) { + return null; + } + $middleware = $routeResult->getMatchedParams()['middleware'] ?? null; + if (null === $middleware) { + return null; } $request = $event->getRequest(); $application = $event->getApplication(); - $response = $application->getResponse(); - $serviceManager = $application->getServiceManager(); - - $psr7ResponsePrototype = Psr7Response::fromZend($response); + $container = $application->getContainer(); try { $pipe = $this->createPipeFromSpec( - $serviceManager, - $psr7ResponsePrototype, + $container, is_array($middleware) ? $middleware : [$middleware] ); } catch (InvalidMiddlewareException $invalidMiddlewareException) { $return = $this->marshalInvalidMiddleware( - $application::ERROR_MIDDLEWARE_CANNOT_DISPATCH, + Application::ERROR_MIDDLEWARE_CANNOT_DISPATCH, $invalidMiddlewareException->toMiddlewareName(), $event, $application, @@ -78,24 +81,17 @@ public function onDispatch(MvcEvent $event) return $return; } - $caughtException = null; + $return = null; try { $return = (new MiddlewareController( $pipe, - $psr7ResponsePrototype, - $application->getServiceManager()->get('EventManager'), + $application->getContainer()->get('EventManager'), $event - ))->dispatch($request, $response); - } catch (\Throwable $ex) { - $caughtException = $ex; - } catch (\Exception $ex) { // @TODO clean up once PHP 7 requirement is enforced - $caughtException = $ex; - } - - if ($caughtException !== null) { + ))->dispatch($request); + } catch (Throwable $ex) { $event->setName(MvcEvent::EVENT_DISPATCH_ERROR); - $event->setError($application::ERROR_EXCEPTION); - $event->setParam('exception', $caughtException); + $event->setError(Application::ERROR_EXCEPTION); + $event->setParam('exception', $ex); $events = $application->getEventManager(); $results = $events->triggerEvent($event); @@ -107,46 +103,52 @@ public function onDispatch(MvcEvent $event) $event->setError(''); - if (! $return instanceof PsrResponseInterface) { - $event->setResult($return); - return $return; - } - $response = Psr7Response::toZend($return); - $event->setResult($response); - return $response; + $event->setResult($return); + return $return; } /** * Create a middleware pipe from the array spec given. * * @param ContainerInterface $serviceLocator - * @param ResponseInterface $responsePrototype * @param array $middlewaresToBePiped * @return MiddlewarePipe * @throws InvalidMiddlewareException */ private function createPipeFromSpec( ContainerInterface $serviceLocator, - ResponseInterface $responsePrototype, array $middlewaresToBePiped - ) { + ) : MiddlewarePipe { $pipe = new MiddlewarePipe(); - $pipe->setResponsePrototype($responsePrototype); foreach ($middlewaresToBePiped as $middlewareToBePiped) { if (null === $middlewareToBePiped) { throw InvalidMiddlewareException::fromNull(); } - $middlewareName = is_string($middlewareToBePiped) ? $middlewareToBePiped : get_class($middlewareToBePiped); - if (is_string($middlewareToBePiped) && $serviceLocator->has($middlewareToBePiped)) { $middlewareToBePiped = $serviceLocator->get($middlewareToBePiped); } - if (! $middlewareToBePiped instanceof MiddlewareInterface && ! is_callable($middlewareToBePiped)) { - throw InvalidMiddlewareException::fromMiddlewareName($middlewareName); + + if ($middlewareToBePiped instanceof MiddlewareInterface) { + $pipe->pipe($middlewareToBePiped); + continue; + } + if ($middlewareToBePiped instanceof RequestHandlerInterface) { + $middlewareToBePiped = new RequestHandlerMiddleware($middlewareToBePiped); + $pipe->pipe($middlewareToBePiped); + continue; } + /* + * callable and auto-invokable is not allowed for security reasons, as middleware parameter + * could potentially come from matched route parameter and middleware + * is fetched from main container. + */ + + $middlewareName = is_string($middlewareToBePiped) + ? $middlewareToBePiped + : (is_object($middlewareToBePiped) ? get_class($middlewareToBePiped) : gettype($middlewareToBePiped)); - $pipe->pipe($middlewareToBePiped); + throw InvalidMiddlewareException::fromMiddlewareName($middlewareName); } return $pipe; } @@ -157,16 +159,16 @@ private function createPipeFromSpec( * @param string $type * @param string $middlewareName * @param MvcEvent $event - * @param Application $application - * @param \Exception $exception + * @param ApplicationInterface $application + * @param Throwable $exception * @return mixed */ protected function marshalInvalidMiddleware( $type, $middlewareName, MvcEvent $event, - Application $application, - \Exception $exception = null + ApplicationInterface $application, + Throwable $exception = null ) { $event->setName(MvcEvent::EVENT_DISPATCH_ERROR); $event->setError($type); diff --git a/src/ModuleRouteListener.php b/src/ModuleRouteListener.php deleted file mode 100644 index 02fc72be9..000000000 --- a/src/ModuleRouteListener.php +++ /dev/null @@ -1,74 +0,0 @@ -listeners[] = $events->attach(MvcEvent::EVENT_ROUTE, [$this, 'onRoute'], $priority); - } - - /** - * Listen to the "route" event and determine if the module namespace should - * be prepended to the controller name. - * - * If the route match contains a parameter key matching the MODULE_NAMESPACE - * constant, that value will be prepended, with a namespace separator, to - * the matched controller parameter. - * - * @param MvcEvent $e - * @return null - */ - public function onRoute(MvcEvent $e) - { - $matches = $e->getRouteMatch(); - if (! $matches instanceof RouteMatch) { - // Can't do anything without a route match - return; - } - - $module = $matches->getParam(self::MODULE_NAMESPACE, false); - if (! $module) { - // No module namespace found; nothing to do - return; - } - - $controller = $matches->getParam('controller', false); - if (! $controller) { - // no controller matched, nothing to do - return; - } - - // Ensure the module namespace has not already been applied - if (0 === strpos($controller, $module)) { - return; - } - - // Keep the originally matched controller name around - $matches->setParam(self::ORIGINAL_CONTROLLER, $controller); - - // Prepend the controllername with the module, and replace it in the - // matches - $controller = $module . '\\' . str_replace(' ', '', ucwords(str_replace('-', ' ', $controller))); - $matches->setParam('controller', $controller); - } -} diff --git a/src/MvcEvent.php b/src/MvcEvent.php index f9918377c..265723219 100644 --- a/src/MvcEvent.php +++ b/src/MvcEvent.php @@ -5,13 +5,14 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface as Request; use Zend\EventManager\Event; -use Zend\Router\RouteMatch; use Zend\Router\RouteStackInterface; -use Zend\Stdlib\RequestInterface as Request; -use Zend\Stdlib\ResponseInterface as Response; use Zend\View\Model\ModelInterface as Model; use Zend\View\Model\ViewModel; @@ -37,7 +38,7 @@ class MvcEvent extends Event protected $request; /** - * @var Response + * @var ResponseInterface */ protected $response; @@ -51,11 +52,6 @@ class MvcEvent extends Event */ protected $router; - /** - * @var null|RouteMatch - */ - protected $routeMatch; - /** * @var Model */ @@ -65,13 +61,12 @@ class MvcEvent extends Event * Set application instance * * @param ApplicationInterface $application - * @return MvcEvent + * @return void */ - public function setApplication(ApplicationInterface $application) + public function setApplication(ApplicationInterface $application) : void { $this->setParam('application', $application); $this->application = $application; - return $this; } /** @@ -79,7 +74,7 @@ public function setApplication(ApplicationInterface $application) * * @return ApplicationInterface */ - public function getApplication() + public function getApplication() : ApplicationInterface { return $this->application; } @@ -98,44 +93,20 @@ public function getRouter() * Set router * * @param RouteStackInterface $router - * @return MvcEvent + * @return void */ - public function setRouter(RouteStackInterface $router) + public function setRouter(RouteStackInterface $router) : void { $this->setParam('router', $router); $this->router = $router; - return $this; } /** - * Get route match - * - * @return null|RouteMatch - */ - public function getRouteMatch() - { - return $this->routeMatch; - } - - /** - * Set route match - * - * @param RouteMatch $matches - * @return MvcEvent - */ - public function setRouteMatch(RouteMatch $matches) - { - $this->setParam('route-match', $matches); - $this->routeMatch = $matches; - return $this; - } - - /** - * Get request + * Get request. Not available during bootstrap * * @return Request */ - public function getRequest() + public function getRequest() : ?Request { return $this->request; } @@ -144,21 +115,20 @@ public function getRequest() * Set request * * @param Request $request - * @return MvcEvent + * @return void */ - public function setRequest(Request $request) + public function setRequest(Request $request) : void { $this->setParam('request', $request); $this->request = $request; - return $this; } /** * Get response * - * @return Response + * @return ResponseInterface */ - public function getResponse() + public function getResponse() : ?ResponseInterface { return $this->response; } @@ -166,26 +136,24 @@ public function getResponse() /** * Set response * - * @param Response $response - * @return MvcEvent + * @param ResponseInterface $response + * @return void */ - public function setResponse(Response $response) + public function setResponse(ResponseInterface $response) : void { $this->setParam('response', $response); $this->response = $response; - return $this; } /** * Set the view model * * @param Model $viewModel - * @return MvcEvent + * @return void */ - public function setViewModel(Model $viewModel) + public function setViewModel(Model $viewModel) : void { $this->viewModel = $viewModel; - return $this; } /** @@ -193,7 +161,7 @@ public function setViewModel(Model $viewModel) * * @return Model */ - public function getViewModel() + public function getViewModel() : Model { if (null === $this->viewModel) { $this->setViewModel(new ViewModel()); @@ -217,11 +185,10 @@ public function getResult() * @param mixed $result * @return MvcEvent */ - public function setResult($result) + public function setResult($result) : void { $this->setParam('__RESULT__', $result); $this->result = $result; - return $this; } /** @@ -229,7 +196,7 @@ public function setResult($result) * * @return bool */ - public function isError() + public function isError() : bool { return (bool) $this->getParam('error', false); } @@ -238,12 +205,11 @@ public function isError() * Set the error message (indicating error in handling request) * * @param string $message - * @return MvcEvent + * @return void */ - public function setError($message) + public function setError($message) : void { $this->setParam('error', $message); - return $this; } /** diff --git a/src/ResponseSender/AbstractResponseSender.php b/src/ResponseSender/AbstractResponseSender.php deleted file mode 100644 index ed719d5d0..000000000 --- a/src/ResponseSender/AbstractResponseSender.php +++ /dev/null @@ -1,42 +0,0 @@ -headersSent()) { - return $this; - } - - $response = $event->getResponse(); - - foreach ($response->getHeaders() as $header) { - if ($header instanceof MultipleHeaderInterface) { - header($header->toString(), false); - continue; - } - header($header->toString()); - } - - $status = $response->renderStatusLine(); - header($status); - - $event->setHeadersSent(); - return $this; - } -} diff --git a/src/ResponseSender/HttpResponseSender.php b/src/ResponseSender/HttpResponseSender.php deleted file mode 100644 index 1131cab3f..000000000 --- a/src/ResponseSender/HttpResponseSender.php +++ /dev/null @@ -1,49 +0,0 @@ -contentSent()) { - return $this; - } - $response = $event->getResponse(); - echo $response->getContent(); - $event->setContentSent(); - return $this; - } - - /** - * Send HTTP response - * - * @param SendResponseEvent $event - * @return HttpResponseSender - */ - public function __invoke(SendResponseEvent $event) - { - $response = $event->getResponse(); - if (! $response instanceof Response) { - return $this; - } - - $this->sendHeaders($event) - ->sendContent($event); - $event->stopPropagation(true); - return $this; - } -} diff --git a/src/ResponseSender/PhpEnvironmentResponseSender.php b/src/ResponseSender/PhpEnvironmentResponseSender.php deleted file mode 100644 index 5309e11f0..000000000 --- a/src/ResponseSender/PhpEnvironmentResponseSender.php +++ /dev/null @@ -1,32 +0,0 @@ -getResponse(); - if (! $response instanceof Response) { - return $this; - } - - $this->sendHeaders($event) - ->sendContent($event); - $event->stopPropagation(true); - return $this; - } -} diff --git a/src/ResponseSender/ResponseSenderInterface.php b/src/ResponseSender/ResponseSenderInterface.php deleted file mode 100644 index 8322ae631..000000000 --- a/src/ResponseSender/ResponseSenderInterface.php +++ /dev/null @@ -1,19 +0,0 @@ -setParam('response', $response); - $this->response = $response; - return $this; - } - - /** - * @return \Zend\Stdlib\ResponseInterface - */ - public function getResponse() - { - return $this->response; - } - - /** - * Set content sent for current response - * - * @return SendResponseEvent - */ - public function setContentSent() - { - $response = $this->getResponse(); - $contentSent = $this->getParam('contentSent', []); - $contentSent[spl_object_hash($response)] = true; - $this->setParam('contentSent', $contentSent); - $this->contentSent[spl_object_hash($response)] = true; - return $this; - } - - /** - * @return bool - */ - public function contentSent() - { - $response = $this->getResponse(); - if (isset($this->contentSent[spl_object_hash($response)])) { - return true; - } - return false; - } - - /** - * Set headers sent for current response object - * - * @return SendResponseEvent - */ - public function setHeadersSent() - { - $response = $this->getResponse(); - $headersSent = $this->getParam('headersSent', []); - $headersSent[spl_object_hash($response)] = true; - $this->setParam('headersSent', $headersSent); - $this->headersSent[spl_object_hash($response)] = true; - return $this; - } - - /** - * @return bool - */ - public function headersSent() - { - $response = $this->getResponse(); - if (isset($this->headersSent[spl_object_hash($response)])) { - return true; - } - return false; - } -} diff --git a/src/ResponseSender/SimpleStreamResponseSender.php b/src/ResponseSender/SimpleStreamResponseSender.php deleted file mode 100644 index 3d1be8f75..000000000 --- a/src/ResponseSender/SimpleStreamResponseSender.php +++ /dev/null @@ -1,49 +0,0 @@ -contentSent()) { - return $this; - } - $response = $event->getResponse(); - $stream = $response->getStream(); - fpassthru($stream); - $event->setContentSent(); - } - - /** - * Send stream response - * - * @param SendResponseEvent $event - * @return SimpleStreamResponseSender - */ - public function __invoke(SendResponseEvent $event) - { - $response = $event->getResponse(); - if (! $response instanceof Stream) { - return $this; - } - - $this->sendHeaders($event); - $this->sendStream($event); - $event->stopPropagation(true); - return $this; - } -} diff --git a/src/RouteListener.php b/src/RouteListener.php index 4fd1fc37f..9cc9a4bf4 100644 --- a/src/RouteListener.php +++ b/src/RouteListener.php @@ -5,11 +5,13 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc; use Zend\EventManager\AbstractListenerAggregate; use Zend\EventManager\EventManagerInterface; -use Zend\Router\RouteMatch; +use Zend\Router\RouteResult; class RouteListener extends AbstractListenerAggregate { @@ -34,21 +36,26 @@ public function attach(EventManagerInterface $events, $priority = 1) * Seeds the event with the route match on completion. * * @param MvcEvent $event - * @return null|RouteMatch + * @return null|RouteResult|mixed */ public function onRoute(MvcEvent $event) { $request = $event->getRequest(); $router = $event->getRouter(); - $routeMatch = $router->match($request); + $routeResult = $router->match($request); - if ($routeMatch instanceof RouteMatch) { - $event->setRouteMatch($routeMatch); - return $routeMatch; + if ($routeResult->isSuccess()) { + foreach ($routeResult->getMatchedParams() as $name => $param) { + $request = $request->withAttribute($name, $param); + } + $request = $request->withAttribute(RouteResult::class, $routeResult); + $event->setRequest($request); + return $routeResult; } $event->setName(MvcEvent::EVENT_DISPATCH_ERROR); $event->setError(Application::ERROR_ROUTER_NO_MATCH); + $event->setParam(RouteResult::class, $routeResult); $target = $event->getTarget(); $results = $target->getEventManager()->triggerEvent($event); diff --git a/src/SendResponseListener.php b/src/SendResponseListener.php deleted file mode 100644 index 1b939ef6e..000000000 --- a/src/SendResponseListener.php +++ /dev/null @@ -1,139 +0,0 @@ -setIdentifiers([ - __CLASS__, - get_class($this), - ]); - $this->eventManager = $eventManager; - $this->attachDefaultListeners(); - return $this; - } - - /** - * Retrieve the event manager - * - * Lazy-loads an EventManager instance if none registered. - * - * @return EventManagerInterface - */ - public function getEventManager() - { - if (! $this->eventManager instanceof EventManagerInterface) { - $this->setEventManager(new EventManager()); - } - return $this->eventManager; - } - - /** - * Attach the aggregate to the specified event manager - * - * @param EventManagerInterface $events - * @param int $priority - * @return void - */ - public function attach(EventManagerInterface $events, $priority = 1) - { - $this->listeners[] = $events->attach(MvcEvent::EVENT_FINISH, [$this, 'sendResponse'], -10000); - } - - /** - * Send the response - * - * @param MvcEvent $e - * @return void - */ - public function sendResponse(MvcEvent $e) - { - $response = $e->getResponse(); - if (! $response instanceof Response) { - return; // there is no response to send - } - $event = $this->getEvent(); - $event->setResponse($response); - $event->setTarget($this); - $this->getEventManager()->triggerEvent($event); - } - - /** - * Get the send response event - * - * @return SendResponseEvent - */ - public function getEvent() - { - if (! $this->event instanceof SendResponseEvent) { - $this->setEvent(new SendResponseEvent()); - } - return $this->event; - } - - /** - * Set the send response event - * - * @param SendResponseEvent $e - * @return SendResponseEvent - */ - public function setEvent(SendResponseEvent $e) - { - $this->event = $e; - return $this; - } - - /** - * Register the default event listeners - * - * The order in which the response sender are listed here, is by their usage: - * PhpEnvironmentResponseSender has highest priority, because it's used most often. - * SimpleStreamResponseSender is not used that often, so has a lower priority. - * You can attach your response sender before or after every default response sender implementation. - * All default response sender implementation have negative priority. - * You are able to attach listeners without giving a priority and your response sender would be first to try. - * - * @return SendResponseListener - */ - protected function attachDefaultListeners() - { - $events = $this->getEventManager(); - $events->attach(SendResponseEvent::EVENT_SEND_RESPONSE, new PhpEnvironmentResponseSender(), -1000); - $events->attach(SendResponseEvent::EVENT_SEND_RESPONSE, new SimpleStreamResponseSender(), -3000); - $events->attach(SendResponseEvent::EVENT_SEND_RESPONSE, new HttpResponseSender(), -4000); - } -} diff --git a/src/Service/AbstractPluginManagerFactory.php b/src/Service/AbstractPluginManagerFactory.php index 0224eb99e..8e2a9c4d7 100644 --- a/src/Service/AbstractPluginManagerFactory.php +++ b/src/Service/AbstractPluginManagerFactory.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\Service; use Interop\Container\ContainerInterface; diff --git a/src/Service/ApplicationFactory.php b/src/Service/ApplicationFactory.php deleted file mode 100644 index 2871cc334..000000000 --- a/src/Service/ApplicationFactory.php +++ /dev/null @@ -1,36 +0,0 @@ -get('EventManager'), - $container->get('Request'), - $container->get('Response') - ); - } -} diff --git a/src/Service/ConfigFactory.php b/src/Service/ConfigFactory.php deleted file mode 100644 index 4b9fbcbe6..000000000 --- a/src/Service/ConfigFactory.php +++ /dev/null @@ -1,37 +0,0 @@ -get('ModuleManager'); - $moduleManager->loadModules(); - $moduleParams = $moduleManager->getEvent()->getParams(); - return $moduleParams['configListener']->getMergedConfig(false); - } -} diff --git a/src/Service/ControllerPluginManagerFactory.php b/src/Service/ControllerPluginManagerFactory.php deleted file mode 100644 index 3b5c5a5fe..000000000 --- a/src/Service/ControllerPluginManagerFactory.php +++ /dev/null @@ -1,15 +0,0 @@ -get('ControllerManager')); - } -} diff --git a/src/Service/HttpMethodListenerFactory.php b/src/Service/HttpMethodListenerFactory.php deleted file mode 100644 index 7562ac9b8..000000000 --- a/src/Service/HttpMethodListenerFactory.php +++ /dev/null @@ -1,38 +0,0 @@ -get('config'); - - if (! isset($config['http_methods_listener'])) { - return new HttpMethodListener(); - } - - $listenerConfig = $config['http_methods_listener']; - $enabled = array_key_exists('enabled', $listenerConfig) - ? $listenerConfig['enabled'] - : true; - $allowedMethods = (isset($listenerConfig['allowed_methods']) && is_array($listenerConfig['allowed_methods'])) - ? $listenerConfig['allowed_methods'] - : null; - - return new HttpMethodListener($enabled, $allowedMethods); - } -} diff --git a/src/Service/HttpViewManagerFactory.php b/src/Service/HttpViewManagerFactory.php deleted file mode 100644 index 07745e372..000000000 --- a/src/Service/HttpViewManagerFactory.php +++ /dev/null @@ -1,28 +0,0 @@ -get('ApplicationConfig'); - $listenerOptions = new ListenerOptions($configuration['module_listener_options']); - $defaultListeners = new DefaultListenerAggregate($listenerOptions); - $serviceListener = $container->get('ServiceListener'); - - $serviceListener->addServiceManager( - $container, - 'service_manager', - 'Zend\ModuleManager\Feature\ServiceProviderInterface', - 'getServiceConfig' - ); - - $serviceListener->addServiceManager( - 'ControllerManager', - 'controllers', - 'Zend\ModuleManager\Feature\ControllerProviderInterface', - 'getControllerConfig' - ); - $serviceListener->addServiceManager( - 'ControllerPluginManager', - 'controller_plugins', - 'Zend\ModuleManager\Feature\ControllerPluginProviderInterface', - 'getControllerPluginConfig' - ); - $serviceListener->addServiceManager( - 'ViewHelperManager', - 'view_helpers', - 'Zend\ModuleManager\Feature\ViewHelperProviderInterface', - 'getViewHelperConfig' - ); - $serviceListener->addServiceManager( - 'RoutePluginManager', - 'route_manager', - 'Zend\ModuleManager\Feature\RouteProviderInterface', - 'getRouteConfig' - ); - - $events = $container->get('EventManager'); - $defaultListeners->attach($events); - $serviceListener->attach($events); - - $moduleEvent = new ModuleEvent; - $moduleEvent->setParam('ServiceManager', $container); - - $moduleManager = new ModuleManager($configuration['modules'], $events); - $moduleManager->setEvent($moduleEvent); - - return $moduleManager; - } -} diff --git a/src/Service/PaginatorPluginManagerFactory.php b/src/Service/PaginatorPluginManagerFactory.php deleted file mode 100644 index eac7de893..000000000 --- a/src/Service/PaginatorPluginManagerFactory.php +++ /dev/null @@ -1,15 +0,0 @@ -setEventManager($container->get('EventManager')); - return $listener; - } -} diff --git a/src/Service/ServiceListenerFactory.php b/src/Service/ServiceListenerFactory.php deleted file mode 100644 index 4416fb6e8..000000000 --- a/src/Service/ServiceListenerFactory.php +++ /dev/null @@ -1,240 +0,0 @@ - [ - 'application' => 'Application', - 'Config' => 'config', - 'configuration' => 'config', - 'Configuration' => 'config', - 'HttpDefaultRenderingStrategy' => View\Http\DefaultRenderingStrategy::class, - 'MiddlewareListener' => 'Zend\Mvc\MiddlewareListener', - 'request' => 'Request', - 'response' => 'Response', - 'RouteListener' => 'Zend\Mvc\RouteListener', - 'SendResponseListener' => 'Zend\Mvc\SendResponseListener', - 'View' => 'Zend\View\View', - 'ViewFeedRenderer' => 'Zend\View\Renderer\FeedRenderer', - 'ViewJsonRenderer' => 'Zend\View\Renderer\JsonRenderer', - 'ViewPhpRendererStrategy' => 'Zend\View\Strategy\PhpRendererStrategy', - 'ViewPhpRenderer' => 'Zend\View\Renderer\PhpRenderer', - 'ViewRenderer' => 'Zend\View\Renderer\PhpRenderer', - 'Zend\Mvc\Controller\PluginManager' => 'ControllerPluginManager', - 'Zend\Mvc\View\Http\InjectTemplateListener' => 'InjectTemplateListener', - 'Zend\View\Renderer\RendererInterface' => 'Zend\View\Renderer\PhpRenderer', - 'Zend\View\Resolver\TemplateMapResolver' => 'ViewTemplateMapResolver', - 'Zend\View\Resolver\TemplatePathStack' => 'ViewTemplatePathStack', - 'Zend\View\Resolver\AggregateResolver' => 'ViewResolver', - 'Zend\View\Resolver\ResolverInterface' => 'ViewResolver', - ], - 'invokables' => [], - 'factories' => [ - 'Application' => ApplicationFactory::class, - 'config' => 'Zend\Mvc\Service\ConfigFactory', - 'ControllerManager' => 'Zend\Mvc\Service\ControllerManagerFactory', - 'ControllerPluginManager' => 'Zend\Mvc\Service\ControllerPluginManagerFactory', - 'DispatchListener' => 'Zend\Mvc\Service\DispatchListenerFactory', - 'HttpExceptionStrategy' => HttpExceptionStrategyFactory::class, - 'HttpMethodListener' => 'Zend\Mvc\Service\HttpMethodListenerFactory', - 'HttpRouteNotFoundStrategy' => HttpRouteNotFoundStrategyFactory::class, - 'HttpViewManager' => 'Zend\Mvc\Service\HttpViewManagerFactory', - 'InjectTemplateListener' => 'Zend\Mvc\Service\InjectTemplateListenerFactory', - 'PaginatorPluginManager' => 'Zend\Mvc\Service\PaginatorPluginManagerFactory', - 'Request' => 'Zend\Mvc\Service\RequestFactory', - 'Response' => 'Zend\Mvc\Service\ResponseFactory', - 'ViewHelperManager' => 'Zend\Mvc\Service\ViewHelperManagerFactory', - View\Http\DefaultRenderingStrategy::class => HttpDefaultRenderingStrategyFactory::class, - 'ViewFeedStrategy' => 'Zend\Mvc\Service\ViewFeedStrategyFactory', - 'ViewJsonStrategy' => 'Zend\Mvc\Service\ViewJsonStrategyFactory', - 'ViewManager' => 'Zend\Mvc\Service\ViewManagerFactory', - 'ViewResolver' => 'Zend\Mvc\Service\ViewResolverFactory', - 'ViewTemplateMapResolver' => 'Zend\Mvc\Service\ViewTemplateMapResolverFactory', - 'ViewTemplatePathStack' => 'Zend\Mvc\Service\ViewTemplatePathStackFactory', - 'ViewPrefixPathStackResolver' => 'Zend\Mvc\Service\ViewPrefixPathStackResolverFactory', - 'Zend\Mvc\MiddlewareListener' => InvokableFactory::class, - 'Zend\Mvc\RouteListener' => InvokableFactory::class, - 'Zend\Mvc\SendResponseListener' => SendResponseListenerFactory::class, - 'Zend\View\Renderer\FeedRenderer' => InvokableFactory::class, - 'Zend\View\Renderer\JsonRenderer' => InvokableFactory::class, - 'Zend\View\Renderer\PhpRenderer' => ViewPhpRendererFactory::class, - 'Zend\View\Strategy\PhpRendererStrategy' => ViewPhpRendererStrategyFactory::class, - 'Zend\View\View' => ViewFactory::class, - ], - ]; - - /** - * Create the service listener service - * - * Tries to get a service named ServiceListenerInterface from the service - * locator, otherwise creates a ServiceListener instance, passing it the - * container instance and the default service configuration, which can be - * overridden by modules. - * - * It looks for the 'service_listener_options' key in the application - * config and tries to add service/plugin managers as configured. The value - * of 'service_listener_options' must be a list (array) which contains the - * following keys: - * - * - service_manager: the name of the service manage to create as string - * - config_key: the name of the configuration key to search for as string - * - interface: the name of the interface that modules can implement as string - * - method: the name of the method that modules have to implement as string - * - * @param ServiceLocatorInterface $serviceLocator - * @return ServiceListenerInterface - * @throws ServiceNotCreatedException for invalid ServiceListener service - * @throws ServiceNotCreatedException For invalid configurations. - */ - public function __invoke(ContainerInterface $container, $requestedName, array $options = null) - { - $configuration = $container->get('ApplicationConfig'); - - $serviceListener = $container->has('ServiceListenerInterface') - ? $container->get('ServiceListenerInterface') - : new ServiceListener($container); - - if (! $serviceListener instanceof ServiceListenerInterface) { - throw new ServiceNotCreatedException( - 'The service named ServiceListenerInterface must implement ' - . ServiceListenerInterface::class - ); - } - - $serviceListener->setDefaultServiceConfig($this->defaultServiceConfig); - - if (isset($configuration['service_listener_options'])) { - $this->injectServiceListenerOptions($configuration['service_listener_options'], $serviceListener); - } - - return $serviceListener; - } - - /** - * Validate and inject plugin manager options into the service listener. - * - * @param array $options - * @param ServiceListenerInterface $serviceListener - * @throws ServiceListenerInterface for invalid $options types - */ - private function injectServiceListenerOptions($options, ServiceListenerInterface $serviceListener) - { - if (! is_array($options)) { - throw new ServiceNotCreatedException(sprintf( - 'The value of service_listener_options must be an array, %s given.', - (is_object($options) ? get_class($options) : gettype($options)) - )); - } - - foreach ($options as $key => $newServiceManager) { - $this->validatePluginManagerOptions($newServiceManager, $key); - - $serviceListener->addServiceManager( - $newServiceManager['service_manager'], - $newServiceManager['config_key'], - $newServiceManager['interface'], - $newServiceManager['method'] - ); - } - } - - /** - * Validate the structure and types for plugin manager configuration options. - * - * Ensures all required keys are present in the expected types. - * - * @param array $options - * @param string $name Plugin manager service name; used for exception messages - * @throws ServiceNotCreatedException for any missing configuration options. - * @throws ServiceNotCreatedException for configuration options of invalid types. - */ - private function validatePluginManagerOptions($options, $name) - { - if (! is_array($options)) { - throw new ServiceNotCreatedException(sprintf( - 'Plugin manager configuration for "%s" is invalid; must be an array, received "%s"', - $name, - (is_object($options) ? get_class($options) : gettype($options)) - )); - } - - if (! isset($options['service_manager'])) { - throw new ServiceNotCreatedException(sprintf(self::MISSING_KEY_ERROR, $name, 'service_manager')); - } - - if (! is_string($options['service_manager'])) { - throw new ServiceNotCreatedException(sprintf( - self::VALUE_TYPE_ERROR, - 'service_manager', - gettype($options['service_manager']) - )); - } - - if (! isset($options['config_key'])) { - throw new ServiceNotCreatedException(sprintf(self::MISSING_KEY_ERROR, $name, 'config_key')); - } - - if (! is_string($options['config_key'])) { - throw new ServiceNotCreatedException(sprintf( - self::VALUE_TYPE_ERROR, - 'config_key', - gettype($options['config_key']) - )); - } - - if (! isset($options['interface'])) { - throw new ServiceNotCreatedException(sprintf(self::MISSING_KEY_ERROR, $name, 'interface')); - } - - if (! is_string($options['interface'])) { - throw new ServiceNotCreatedException(sprintf( - self::VALUE_TYPE_ERROR, - 'interface', - gettype($options['interface']) - )); - } - - if (! isset($options['method'])) { - throw new ServiceNotCreatedException(sprintf(self::MISSING_KEY_ERROR, $name, 'method')); - } - - if (! is_string($options['method'])) { - throw new ServiceNotCreatedException(sprintf( - self::VALUE_TYPE_ERROR, - 'method', - gettype($options['method']) - )); - } - } -} diff --git a/src/Service/ServiceManagerConfig.php b/src/Service/ServiceManagerConfig.php deleted file mode 100644 index dc1073a4e..000000000 --- a/src/Service/ServiceManagerConfig.php +++ /dev/null @@ -1,173 +0,0 @@ - [], - 'aliases' => [ - 'EventManagerInterface' => EventManager::class, - EventManagerInterface::class => 'EventManager', - ModuleManager::class => 'ModuleManager', - ServiceListener::class => 'ServiceListener', - SharedEventManager::class => 'SharedEventManager', - 'SharedEventManagerInterface' => 'SharedEventManager', - SharedEventManagerInterface::class => 'SharedEventManager', - ], - 'delegators' => [], - 'factories' => [ - 'EventManager' => EventManagerFactory::class, - 'ModuleManager' => ModuleManagerFactory::class, - 'ServiceListener' => ServiceListenerFactory::class, - ], - 'lazy_services' => [], - 'initializers' => [], - 'invokables' => [], - 'services' => [], - 'shared' => [ - 'EventManager' => false, - ], - ]; - - /** - * Constructor - * - * Merges internal arrays with those passed via configuration, and also - * defines: - * - * - factory for the service 'SharedEventManager'. - * - initializer for EventManagerAwareInterface implementations - * - * @param array $config - */ - public function __construct(array $config = []) - { - $this->config['factories']['ServiceManager'] = function ($container) { - return $container; - }; - - $this->config['factories']['SharedEventManager'] = function () { - return new SharedEventManager(); - }; - - $this->config['initializers'] = ArrayUtils::merge($this->config['initializers'], [ - 'EventManagerAwareInitializer' => function ($first, $second) { - if ($first instanceof ContainerInterface) { - $container = $first; - $instance = $second; - } else { - $container = $second; - $instance = $first; - } - - if (! $instance instanceof EventManagerAwareInterface) { - return; - } - - $eventManager = $instance->getEventManager(); - - // If the instance has an EM WITH an SEM composed, do nothing. - if ($eventManager instanceof EventManagerInterface - && $eventManager->getSharedManager() instanceof SharedEventManagerInterface - ) { - return; - } - - $instance->setEventManager($container->get('EventManager')); - }, - ]); - - parent::__construct($config); - } - - /** - * Configure service container. - * - * Uses the configuration present in the instance to configure the provided - * service container. - * - * Before doing so, it adds a "service" entry for the ServiceManager class, - * pointing to the provided service container. - * - * @param ServiceManager $services - * @return ServiceManager - */ - public function configureServiceManager(ServiceManager $services) - { - $this->config['services'][ServiceManager::class] = $services; - - /* - printf("Configuration prior to configuring servicemanager:\n"); - foreach ($this->config as $type => $list) { - switch ($type) { - case 'aliases': - case 'delegators': - case 'factories': - case 'invokables': - case 'lazy_services': - case 'services': - case 'shared': - foreach (array_keys($list) as $name) { - printf(" %s (%s)\n", $name, $type); - } - break; - - case 'initializers': - case 'abstract_factories': - foreach ($list as $callable) { - printf(" %s (%s)\n", (is_object($callable) ? get_class($callable) : $callable), $type); - } - break; - - default: - break; - } - } - */ - - // This is invoked as part of the bootstrapping process, and requires - // the ability to override services. - $services->setAllowOverride(true); - parent::configureServiceManager($services); - $services->setAllowOverride(false); - - return $services; - } - - /** - * Return all service configuration - * - * @return array - */ - public function toArray() - { - return $this->config; - } -} diff --git a/src/Service/ViewManagerFactory.php b/src/Service/ViewManagerFactory.php deleted file mode 100644 index 28c1ecb76..000000000 --- a/src/Service/ViewManagerFactory.php +++ /dev/null @@ -1,28 +0,0 @@ -get('HttpViewManager'); - } -} diff --git a/src/Service/ViewPhpRendererFactory.php b/src/Service/ViewPhpRendererFactory.php deleted file mode 100644 index 3cd3d836b..000000000 --- a/src/Service/ViewPhpRendererFactory.php +++ /dev/null @@ -1,30 +0,0 @@ -setHelperPluginManager($container->get('ViewHelperManager')); - $renderer->setResolver($container->get('ViewResolver')); - - return $renderer; - } -} diff --git a/src/Service/ViewResolverFactory.php b/src/Service/ViewResolverFactory.php deleted file mode 100644 index ae743b8d2..000000000 --- a/src/Service/ViewResolverFactory.php +++ /dev/null @@ -1,49 +0,0 @@ -get('ViewTemplateMapResolver'); - /* @var $pathResolver ResolverInterface */ - $pathResolver = $container->get('ViewTemplatePathStack'); - /* @var $prefixPathStackResolver ResolverInterface */ - $prefixPathStackResolver = $container->get('ViewPrefixPathStackResolver'); - - $resolver - ->attach($mapResolver) - ->attach($pathResolver) - ->attach($prefixPathStackResolver) - ->attach(new ViewResolver\RelativeFallbackResolver($mapResolver)) - ->attach(new ViewResolver\RelativeFallbackResolver($pathResolver)) - ->attach(new ViewResolver\RelativeFallbackResolver($prefixPathStackResolver)); - - return $resolver; - } -} diff --git a/src/Service/ViewTemplateMapResolverFactory.php b/src/Service/ViewTemplateMapResolverFactory.php deleted file mode 100644 index 18146d50f..000000000 --- a/src/Service/ViewTemplateMapResolverFactory.php +++ /dev/null @@ -1,39 +0,0 @@ -get('config'); - $map = []; - if (is_array($config) && isset($config['view_manager'])) { - $config = $config['view_manager']; - if (is_array($config) && isset($config['template_map'])) { - $map = $config['template_map']; - } - } - return new ViewResolver\TemplateMapResolver($map); - } -} diff --git a/src/Service/ViewTemplatePathStackFactory.php b/src/Service/ViewTemplatePathStackFactory.php deleted file mode 100644 index cf7f01af0..000000000 --- a/src/Service/ViewTemplatePathStackFactory.php +++ /dev/null @@ -1,48 +0,0 @@ -get('config'); - - $templatePathStack = new ViewResolver\TemplatePathStack(); - - if (is_array($config) && isset($config['view_manager'])) { - $config = $config['view_manager']; - if (is_array($config)) { - if (isset($config['template_path_stack'])) { - $templatePathStack->addPaths($config['template_path_stack']); - } - if (isset($config['default_template_suffix'])) { - $templatePathStack->setDefaultSuffix($config['default_template_suffix']); - } - } - } - - return $templatePathStack; - } -} diff --git a/src/View/Http/CreateViewModelListener.php b/src/View/Http/CreateViewModelListener.php index f75186110..b410fbc96 100644 --- a/src/View/Http/CreateViewModelListener.php +++ b/src/View/Http/CreateViewModelListener.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\View\Http; use Zend\EventManager\AbstractListenerAggregate; @@ -18,7 +20,7 @@ class CreateViewModelListener extends AbstractListenerAggregate /** * {@inheritDoc} */ - public function attach(Events $events, $priority = 1) + public function attach(Events $events, $priority = 1) : void { $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, [$this, 'createViewModelFromArray'], -80); $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, [$this, 'createViewModelFromNull'], -80); @@ -30,7 +32,7 @@ public function attach(Events $events, $priority = 1) * @param MvcEvent $e * @return void */ - public function createViewModelFromArray(MvcEvent $e) + public function createViewModelFromArray(MvcEvent $e) : void { $result = $e->getResult(); if (! ArrayUtils::hasStringKeys($result, true)) { @@ -47,7 +49,7 @@ public function createViewModelFromArray(MvcEvent $e) * @param MvcEvent $e * @return void */ - public function createViewModelFromNull(MvcEvent $e) + public function createViewModelFromNull(MvcEvent $e) : void { $result = $e->getResult(); if (null !== $result) { diff --git a/src/View/Http/DefaultRenderingStrategy.php b/src/View/Http/DefaultRenderingStrategy.php index 5031966c8..3469d55bc 100644 --- a/src/View/Http/DefaultRenderingStrategy.php +++ b/src/View/Http/DefaultRenderingStrategy.php @@ -5,13 +5,18 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\View\Http; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; use Zend\EventManager\AbstractListenerAggregate; use Zend\EventManager\EventManagerInterface; use Zend\Mvc\Application; use Zend\Mvc\MvcEvent; -use Zend\Stdlib\ResponseInterface as Response; +use Zend\Mvc\View\RequestWrapper; +use Zend\Mvc\View\ResponseWrapper; use Zend\View\Model\ModelInterface as ViewModel; use Zend\View\View; @@ -43,7 +48,7 @@ public function __construct(View $view) /** * {@inheritDoc} */ - public function attach(EventManagerInterface $events, $priority = 1) + public function attach(EventManagerInterface $events, $priority = 1) : void { $this->listeners[] = $events->attach(MvcEvent::EVENT_RENDER, [$this, 'render'], -10000); $this->listeners[] = $events->attach(MvcEvent::EVENT_RENDER_ERROR, [$this, 'render'], -10000); @@ -53,12 +58,11 @@ public function attach(EventManagerInterface $events, $priority = 1) * Set layout template value * * @param string $layoutTemplate - * @return DefaultRenderingStrategy + * @return void */ - public function setLayoutTemplate($layoutTemplate) + public function setLayoutTemplate(string $layoutTemplate) : void { - $this->layoutTemplate = (string) $layoutTemplate; - return $this; + $this->layoutTemplate = $layoutTemplate; } /** @@ -66,7 +70,7 @@ public function setLayoutTemplate($layoutTemplate) * * @return string */ - public function getLayoutTemplate() + public function getLayoutTemplate() : string { return $this->layoutTemplate; } @@ -75,13 +79,13 @@ public function getLayoutTemplate() * Render the view * * @param MvcEvent $e - * @return Response|null - * @throws \Exception + * @return null|ResponseInterface + * @throws \Throwable */ - public function render(MvcEvent $e) + public function render(MvcEvent $e) : ?ResponseInterface { $result = $e->getResult(); - if ($result instanceof Response) { + if ($result instanceof ResponseInterface) { return $result; } @@ -90,37 +94,32 @@ public function render(MvcEvent $e) $response = $e->getResponse(); $viewModel = $e->getViewModel(); if (! $viewModel instanceof ViewModel) { - return; + return null; } $view = $this->view; - $view->setRequest($request); - $view->setResponse($response); - - $caughtException = null; + // @TODO fix after view is updated + $responseWrapper = new ResponseWrapper($response ?? new Response()); + $view->setRequest(new RequestWrapper($request)); + $view->setResponse($responseWrapper); try { $view->render($viewModel); } catch (\Throwable $ex) { - $caughtException = $ex; - } catch (\Exception $ex) { // @TODO clean up once PHP 7 requirement is enforced - $caughtException = $ex; - } - - if ($caughtException !== null) { if ($e->getName() === MvcEvent::EVENT_RENDER_ERROR) { - throw $caughtException; + throw $ex; } $application = $e->getApplication(); $events = $application->getEventManager(); $e->setError(Application::ERROR_EXCEPTION); - $e->setParam('exception', $caughtException); + $e->setParam('exception', $ex); $e->setName(MvcEvent::EVENT_RENDER_ERROR); $events->triggerEvent($e); } - return $response; + $e->setResponse($responseWrapper->getResponse()); + return $responseWrapper->getResponse(); } } diff --git a/src/View/Http/ExceptionStrategy.php b/src/View/Http/ExceptionStrategy.php index 440358210..2d8168dcc 100644 --- a/src/View/Http/ExceptionStrategy.php +++ b/src/View/Http/ExceptionStrategy.php @@ -5,14 +5,16 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\View\Http; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; use Zend\EventManager\AbstractListenerAggregate; use Zend\EventManager\EventManagerInterface; -use Zend\Http\Response as HttpResponse; use Zend\Mvc\Application; use Zend\Mvc\MvcEvent; -use Zend\Stdlib\ResponseInterface as Response; use Zend\View\Model\ViewModel; class ExceptionStrategy extends AbstractListenerAggregate @@ -44,9 +46,9 @@ public function attach(EventManagerInterface $events, $priority = 1) * @param bool $displayExceptions * @return ExceptionStrategy */ - public function setDisplayExceptions($displayExceptions) + public function setDisplayExceptions(bool $displayExceptions) { - $this->displayExceptions = (bool) $displayExceptions; + $this->displayExceptions = $displayExceptions; return $this; } @@ -66,9 +68,9 @@ public function displayExceptions() * @param string $exceptionTemplate * @return ExceptionStrategy */ - public function setExceptionTemplate($exceptionTemplate) + public function setExceptionTemplate(string $exceptionTemplate) { - $this->exceptionTemplate = (string) $exceptionTemplate; + $this->exceptionTemplate = $exceptionTemplate; return $this; } @@ -103,7 +105,7 @@ public function prepareExceptionViewModel(MvcEvent $e) // Do nothing if the result is a response object $result = $e->getResult(); - if ($result instanceof Response) { + if ($result instanceof ResponseInterface) { return; } @@ -126,14 +128,12 @@ public function prepareExceptionViewModel(MvcEvent $e) $response = $e->getResponse(); if (! $response) { - $response = new HttpResponse(); - $response->setStatusCode(500); + $response = new Response(); + $response = $response->withStatus(500); + $e->setResponse($response); + } elseif ($response->getStatusCode() === 200) { + $response = $response->withStatus(500); $e->setResponse($response); - } else { - $statusCode = $response->getStatusCode(); - if ($statusCode === 200) { - $response->setStatusCode(500); - } } break; diff --git a/src/View/Http/InjectRoutematchParamsListener.php b/src/View/Http/InjectRoutematchParamsListener.php deleted file mode 100644 index adcaf29b9..000000000 --- a/src/View/Http/InjectRoutematchParamsListener.php +++ /dev/null @@ -1,83 +0,0 @@ -listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, [$this, 'injectParams'], 90); - } - - /** - * Take parameters from RouteMatch and inject them into the request. - * - * @param MvcEvent $e - * @return void - */ - public function injectParams(MvcEvent $e) - { - $routeMatchParams = $e->getRouteMatch()->getParams(); - $request = $e->getRequest(); - - if (! $request instanceof HttpRequest) { - // unsupported request type - return; - } - - $params = $request->get(); - - if ($this->overwrite) { - // Overwrite existing parameters, or create new ones if not present. - foreach ($routeMatchParams as $key => $val) { - $params->$key = $val; - } - return; - } - - // Only create new parameters. - foreach ($routeMatchParams as $key => $val) { - if (! $params->offsetExists($key)) { - $params->$key = $val; - } - } - } - - /** - * Should RouteMatch parameters replace existing Request params? - * - * @param bool $overwrite - */ - public function setOverwrite($overwrite) - { - $this->overwrite = $overwrite; - } - - /** - * @return bool - */ - public function getOverwrite() - { - return $this->overwrite; - } -} diff --git a/src/View/Http/InjectTemplateListener.php b/src/View/Http/InjectTemplateListener.php index 3b110a787..e8aada1c5 100644 --- a/src/View/Http/InjectTemplateListener.php +++ b/src/View/Http/InjectTemplateListener.php @@ -5,11 +5,14 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\View\Http; use Zend\EventManager\AbstractListenerAggregate; use Zend\EventManager\EventManagerInterface as Events; use Zend\Mvc\MvcEvent; +use Zend\Router\RouteResult; use Zend\Stdlib\StringUtils; use Zend\View\Model\ModelInterface as ViewModel; @@ -23,16 +26,16 @@ class InjectTemplateListener extends AbstractListenerAggregate protected $controllerMap = []; /** - * Flag to force the use of the route match controller param + * Flag to force the use of the route result controller param * * @var boolean */ - protected $preferRouteMatchController = false; + protected $preferRouteResultController = false; /** * {@inheritDoc} */ - public function attach(Events $events, $priority = 1) + public function attach(Events $events, $priority = 1) : void { $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, [$this, 'injectTemplate'], -90); } @@ -46,7 +49,7 @@ public function attach(Events $events, $priority = 1) * @param MvcEvent $e * @return void */ - public function injectTemplate(MvcEvent $e) + public function injectTemplate(MvcEvent $e) : void { $model = $e->getResult(); if (! $model instanceof ViewModel) { @@ -58,9 +61,17 @@ public function injectTemplate(MvcEvent $e) return; } - $routeMatch = $e->getRouteMatch(); - if ($preferRouteMatchController = $routeMatch->getParam('prefer_route_match_controller', false)) { - $this->setPreferRouteMatchController($preferRouteMatchController); + /** + * @var RouteResult $routeResult + */ + $routeResult = $e->getRequest()->getAttribute(RouteResult::class); + $matchedParams = []; + if ($routeResult) { + $matchedParams = $routeResult->getMatchedParams(); + } + if ($preferRouteResultController = ($matchedParams['prefer_route_result_controller'] ?? false)) { + // @TODO this has potential for reuse side effects. Fix it. + $this->setPreferRouteResultController($preferRouteResultController); } $controller = $e->getTarget(); @@ -68,14 +79,14 @@ public function injectTemplate(MvcEvent $e) $controller = get_class($controller); } - $routeMatchController = $routeMatch->getParam('controller', ''); - if (! $controller || ($this->preferRouteMatchController && $routeMatchController)) { + $routeMatchController = $matchedParams['controller'] ?? null; + if (! $controller || ($this->preferRouteResultController && $routeMatchController)) { $controller = $routeMatchController; } $template = $this->mapController($controller); - $action = $routeMatch->getParam('action'); + $action = $matchedParams['action'] ?? null; if (null !== $action) { $template .= '/' . $this->inflectName($action); } @@ -86,22 +97,21 @@ public function injectTemplate(MvcEvent $e) * Set map of controller namespace -> template pairs * * @param array $map - * @return self + * @return void */ - public function setControllerMap(array $map) + public function setControllerMap(array $map) : void { krsort($map); $this->controllerMap = $map; - return $this; } /** * Maps controller to template if controller namespace is whitelisted or mapped * * @param string $controller controller FQCN - * @return string|false template name or false if controller was not matched + * @return string template name */ - public function mapController($controller) + public function mapController($controller) : string { $mapped = ''; foreach ($this->controllerMap as $namespace => $replacement) { @@ -144,7 +154,7 @@ public function mapController($controller) * @param string $name * @return string */ - protected function inflectName($name) + protected function inflectName($name) : string { if (StringUtils::hasPcreUnicodeSupport()) { $pattern = ['#(?<=(?:\p{Lu}))(\p{Lu}\p{Ll})#', '#(?<=(?:\p{Ll}|\p{Nd}))(\p{Lu})#']; @@ -166,7 +176,7 @@ protected function inflectName($name) * @param string $controller * @return string */ - protected function deriveControllerClass($controller) + protected function deriveControllerClass($controller) : string { if (false !== strpos($controller, '\\')) { $controller = substr($controller, strrpos($controller, '\\') + 1); @@ -185,18 +195,17 @@ protected function deriveControllerClass($controller) * Sets the flag to instruct the listener to prefer the route match controller param * over the class name * - * @param boolean $preferRouteMatchController */ - public function setPreferRouteMatchController($preferRouteMatchController) + public function setPreferRouteResultController(bool $preferRouteResultController) : void { - $this->preferRouteMatchController = (bool) $preferRouteMatchController; + $this->preferRouteResultController = $preferRouteResultController; } /** * @return boolean */ - public function isPreferRouteMatchController() + public function isPreferRouteResultController() : bool { - return $this->preferRouteMatchController; + return $this->preferRouteResultController; } } diff --git a/src/View/Http/InjectViewModelListener.php b/src/View/Http/InjectViewModelListener.php index 6a61a9b32..ef5637630 100644 --- a/src/View/Http/InjectViewModelListener.php +++ b/src/View/Http/InjectViewModelListener.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\View\Http; use Zend\EventManager\AbstractListenerAggregate; @@ -18,7 +20,7 @@ class InjectViewModelListener extends AbstractListenerAggregate /** * {@inheritDoc} */ - public function attach(Events $events, $priority = 1) + public function attach(Events $events, $priority = 1) : void { $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, [$this, 'injectViewModel'], -100); $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, [$this, 'injectViewModel'], -100); @@ -35,7 +37,7 @@ public function attach(Events $events, $priority = 1) * @param MvcEvent $e * @return void */ - public function injectViewModel(MvcEvent $e) + public function injectViewModel(MvcEvent $e) : void { $result = $e->getResult(); if (! $result instanceof ViewModel) { diff --git a/src/View/Http/RouteNotFoundStrategy.php b/src/View/Http/RouteNotFoundStrategy.php index 12d397f92..ac8df8fa5 100644 --- a/src/View/Http/RouteNotFoundStrategy.php +++ b/src/View/Http/RouteNotFoundStrategy.php @@ -5,14 +5,17 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\View\Http; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; use Zend\EventManager\AbstractListenerAggregate; use Zend\EventManager\EventManagerInterface; -use Zend\Http\Response as HttpResponse; use Zend\Mvc\Application; use Zend\Mvc\MvcEvent; -use Zend\Stdlib\ResponseInterface as Response; +use Zend\Router\RouteResult; use Zend\View\Model\ViewModel; class RouteNotFoundStrategy extends AbstractListenerAggregate @@ -48,7 +51,7 @@ class RouteNotFoundStrategy extends AbstractListenerAggregate /** * {@inheritDoc} */ - public function attach(EventManagerInterface $events, $priority = 1) + public function attach(EventManagerInterface $events, $priority = 1) : void { $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, [$this, 'prepareNotFoundViewModel'], -90); $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, [$this, 'detectNotFoundError']); @@ -59,12 +62,11 @@ public function attach(EventManagerInterface $events, $priority = 1) * Set value indicating whether or not to display exceptions related to a not-found condition * * @param bool $displayExceptions - * @return RouteNotFoundStrategy + * @return void */ - public function setDisplayExceptions($displayExceptions) + public function setDisplayExceptions(bool $displayExceptions) : void { - $this->displayExceptions = (bool) $displayExceptions; - return $this; + $this->displayExceptions = $displayExceptions; } /** @@ -72,7 +74,7 @@ public function setDisplayExceptions($displayExceptions) * * @return bool */ - public function displayExceptions() + public function displayExceptions() : bool { return $this->displayExceptions; } @@ -81,12 +83,11 @@ public function displayExceptions() * Set value indicating whether or not to display the reason for a not-found condition * * @param bool $displayNotFoundReason - * @return RouteNotFoundStrategy + * @return void */ - public function setDisplayNotFoundReason($displayNotFoundReason) + public function setDisplayNotFoundReason(bool $displayNotFoundReason) : void { - $this->displayNotFoundReason = (bool) $displayNotFoundReason; - return $this; + $this->displayNotFoundReason = $displayNotFoundReason; } /** @@ -94,7 +95,7 @@ public function setDisplayNotFoundReason($displayNotFoundReason) * * @return bool */ - public function displayNotFoundReason() + public function displayNotFoundReason() : bool { return $this->displayNotFoundReason; } @@ -103,12 +104,11 @@ public function displayNotFoundReason() * Get template for not found conditions * * @param string $notFoundTemplate - * @return RouteNotFoundStrategy + * @return void */ - public function setNotFoundTemplate($notFoundTemplate) + public function setNotFoundTemplate(string $notFoundTemplate) : void { - $this->notFoundTemplate = (string) $notFoundTemplate; - return $this; + $this->notFoundTemplate = $notFoundTemplate; } /** @@ -116,7 +116,7 @@ public function setNotFoundTemplate($notFoundTemplate) * * @return string */ - public function getNotFoundTemplate() + public function getNotFoundTemplate() : string { return $this->notFoundTemplate; } @@ -130,7 +130,7 @@ public function getNotFoundTemplate() * @param MvcEvent $e * @return void */ - public function detectNotFoundError(MvcEvent $e) + public function detectNotFoundError(MvcEvent $e) : void { $error = $e->getError(); if (empty($error)) { @@ -144,10 +144,11 @@ public function detectNotFoundError(MvcEvent $e) $this->reason = $error; $response = $e->getResponse(); if (! $response) { - $response = new HttpResponse(); - $e->setResponse($response); + // @TODO inject and use response factory + $response = new Response(); } - $response->setStatusCode(404); + $response = $response->withStatus(404); + $e->setResponse($response); break; default: return; @@ -160,16 +161,16 @@ public function detectNotFoundError(MvcEvent $e) * @param MvcEvent $e * @return void */ - public function prepareNotFoundViewModel(MvcEvent $e) + public function prepareNotFoundViewModel(MvcEvent $e) : void { $vars = $e->getResult(); - if ($vars instanceof Response) { + if ($vars instanceof ResponseInterface) { // Already have a response as the result return; } $response = $e->getResponse(); - if ($response->getStatusCode() != 404) { + if (! $response || $response->getStatusCode() != 404) { // Only handle 404 responses return; } @@ -212,7 +213,7 @@ public function prepareNotFoundViewModel(MvcEvent $e) * @param ViewModel $model * @return void */ - protected function injectNotFoundReason(ViewModel $model) + protected function injectNotFoundReason(ViewModel $model) : void { if (! $this->displayNotFoundReason()) { return; @@ -239,7 +240,7 @@ protected function injectNotFoundReason(ViewModel $model) * @param MvcEvent $e * @return void */ - protected function injectException($model, $e) + protected function injectException($model, $e) : void { if (! $this->displayExceptions()) { return; @@ -249,8 +250,7 @@ protected function injectException($model, $e) $exception = $e->getParam('exception', false); - // @TODO clean up once PHP 7 requirement is enforced - if (! $exception instanceof \Exception && ! $exception instanceof \Throwable) { + if (! $exception instanceof \Throwable) { return; } @@ -270,7 +270,7 @@ protected function injectException($model, $e) * @param MvcEvent $e * @return void */ - protected function injectController($model, $e) + protected function injectController($model, MvcEvent $e) : void { if (! $this->displayExceptions() && ! $this->displayNotFoundReason()) { return; @@ -278,12 +278,16 @@ protected function injectController($model, $e) $controller = $e->getController(); if (empty($controller)) { - $routeMatch = $e->getRouteMatch(); - if (empty($routeMatch)) { + if (! $e->getRequest()) { + return; + } + /** @var RouteResult $result */ + $result = $e->getRequest()->getAttribute(RouteResult::class); + if (empty($result)) { return; } - $controller = $routeMatch->getParam('controller', false); + $controller = $result->getMatchedParams()['controller'] ?? null; if (! $controller) { return; } diff --git a/src/View/Http/ViewManager.php b/src/View/Http/ViewManager.php index 67802c5ac..85bf43626 100644 --- a/src/View/Http/ViewManager.php +++ b/src/View/Http/ViewManager.php @@ -5,15 +5,19 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace Zend\Mvc\View\Http; use ArrayAccess; +use Psr\Container\ContainerInterface; use Traversable; use Zend\EventManager\AbstractListenerAggregate; use Zend\EventManager\EventManagerInterface; use Zend\EventManager\ListenerAggregateInterface; +use Zend\Mvc\Controller\Dispatchable; use Zend\Mvc\MvcEvent; -use Zend\ServiceManager\ServiceManager; +use Zend\View\HelperPluginManager; use Zend\View\View; /** @@ -51,9 +55,9 @@ class ViewManager extends AbstractListenerAggregate protected $event; /** - * @var ServiceManager + * @var ContainerInterface */ - protected $services; + protected $container; /**@+ * Various properties representing strategies and objects instantiated and @@ -71,7 +75,7 @@ class ViewManager extends AbstractListenerAggregate /** * {@inheritDoc} */ - public function attach(EventManagerInterface $events, $priority = 1) + public function attach(EventManagerInterface $events, $priority = 1) : void { $this->listeners[] = $events->attach(MvcEvent::EVENT_BOOTSTRAP, [$this, 'onBootstrap'], 10000); } @@ -82,11 +86,11 @@ public function attach(EventManagerInterface $events, $priority = 1) * @param $event * @return void */ - public function onBootstrap($event) + public function onBootstrap(MvcEvent $event) : void { $application = $event->getApplication(); - $services = $application->getServiceManager(); - $config = $services->get('config'); + $container = $application->getContainer(); + $config = $container->get('config'); $events = $application->getEventManager(); $sharedEvents = $events->getSharedManager(); @@ -95,16 +99,16 @@ public function onBootstrap($event) || $config['view_manager'] instanceof ArrayAccess) ? $config['view_manager'] : []; - $this->services = $services; + $this->container = $container; $this->event = $event; - $routeNotFoundStrategy = $services->get('HttpRouteNotFoundStrategy'); - $exceptionStrategy = $services->get('HttpExceptionStrategy'); - $mvcRenderingStrategy = $services->get('HttpDefaultRenderingStrategy'); + $routeNotFoundStrategy = $container->get(RouteNotFoundStrategy::class); + $exceptionStrategy = $container->get(ExceptionStrategy::class); + $mvcRenderingStrategy = $container->get(DefaultRenderingStrategy::class); $this->injectViewModelIntoPlugin(); - $injectTemplateListener = $services->get('Zend\Mvc\View\Http\InjectTemplateListener'); + $injectTemplateListener = $container->get(InjectTemplateListener::class); $createViewModelListener = new CreateViewModelListener(); $injectViewModelListener = new InjectViewModelListener(); @@ -118,31 +122,31 @@ public function onBootstrap($event) $mvcRenderingStrategy->attach($events); $sharedEvents->attach( - 'Zend\Stdlib\DispatchableInterface', + Dispatchable::class, MvcEvent::EVENT_DISPATCH, [$createViewModelListener, 'createViewModelFromArray'], -80 ); $sharedEvents->attach( - 'Zend\Stdlib\DispatchableInterface', + Dispatchable::class, MvcEvent::EVENT_DISPATCH, [$routeNotFoundStrategy, 'prepareNotFoundViewModel'], -90 ); $sharedEvents->attach( - 'Zend\Stdlib\DispatchableInterface', + Dispatchable::class, MvcEvent::EVENT_DISPATCH, [$createViewModelListener, 'createViewModelFromNull'], -80 ); $sharedEvents->attach( - 'Zend\Stdlib\DispatchableInterface', + Dispatchable::class, MvcEvent::EVENT_DISPATCH, [$injectTemplateListener, 'injectTemplate'], -90 ); $sharedEvents->attach( - 'Zend\Stdlib\DispatchableInterface', + Dispatchable::class, MvcEvent::EVENT_DISPATCH, [$injectViewModelListener, 'injectViewModel'], -100 @@ -160,7 +164,7 @@ public function getView() return $this->view; } - $this->view = $this->services->get(View::class); + $this->view = $this->container->get(View::class); return $this->view; } @@ -176,7 +180,7 @@ public function getViewModel() } $this->viewModel = $model = $this->event->getViewModel(); - $layoutTemplate = $this->services->get('HttpDefaultRenderingStrategy')->getLayoutTemplate(); + $layoutTemplate = $this->container->get(DefaultRenderingStrategy::class)->getLayoutTemplate(); $model->setTemplate($layoutTemplate); return $this->viewModel; @@ -194,7 +198,7 @@ public function getViewModel() * @param EventManagerInterface $events * @return void */ - protected function registerMvcRenderingStrategies(EventManagerInterface $events) + protected function registerMvcRenderingStrategies(EventManagerInterface $events) : void { if (! isset($this->config['mvc_strategies'])) { return; @@ -212,7 +216,7 @@ protected function registerMvcRenderingStrategies(EventManagerInterface $events) continue; } - $listener = $this->services->get($mvcStrategy); + $listener = $this->container->get($mvcStrategy); if ($listener instanceof ListenerAggregateInterface) { $listener->attach($events, 100); } @@ -230,7 +234,7 @@ protected function registerMvcRenderingStrategies(EventManagerInterface $events) * * @return void */ - protected function registerViewStrategies() + protected function registerViewStrategies() : void { if (! isset($this->config['strategies'])) { return; @@ -251,7 +255,7 @@ protected function registerViewStrategies() continue; } - $listener = $this->services->get($strategy); + $listener = $this->container->get($strategy); if ($listener instanceof ListenerAggregateInterface) { $listener->attach($events, 100); } @@ -261,10 +265,10 @@ protected function registerViewStrategies() /** * Injects the ViewModel view helper with the root view model. */ - private function injectViewModelIntoPlugin() + private function injectViewModelIntoPlugin() : void { $model = $this->getViewModel(); - $plugins = $this->services->get('ViewHelperManager'); + $plugins = $this->container->get(HelperPluginManager::class); $plugin = $plugins->get('viewmodel'); $plugin->setRoot($model); } diff --git a/src/View/RequestWrapper.php b/src/View/RequestWrapper.php new file mode 100644 index 000000000..9121616bf --- /dev/null +++ b/src/View/RequestWrapper.php @@ -0,0 +1,55 @@ +request = $request; + } + + public function getRequest() : Request + { + return $this->request; + } + + public function setRequest(Request $request) : void + { + $this->request = $request; + } + + /** + * Set content + * + * @param mixed $content + * @return mixed + */ + public function setContent($content) + { + } + + /** + * Get content + * + * @return mixed + */ + public function getContent() + { + return $this->request->getBody()->__toString(); + } +} diff --git a/src/View/ResponseWrapper.php b/src/View/ResponseWrapper.php new file mode 100644 index 000000000..659e4f1eb --- /dev/null +++ b/src/View/ResponseWrapper.php @@ -0,0 +1,59 @@ +response = $response; + } + + public function getResponse() : ResponseInterface + { + return $this->response; + } + + public function setResponse(ResponseInterface $response) : void + { + $this->response = $response; + } + + /** + * Set content + * + * @param mixed $content + * @return mixed + */ + public function setContent($content) + { + $stream = new Stream('php://memory', 'wb+'); + $stream->write($content); + $this->response = $this->response->withBody($stream); + } + + /** + * Get content + * + * @return mixed + */ + public function getContent() + { + return $this->response->getBody()->__toString(); + } +} diff --git a/test/Application/AllowsReturningEarlyFromRoutingTest.php b/test/Application/AllowsReturningEarlyFromRoutingTest.php index 77b0f560f..6ee6993ec 100644 --- a/test/Application/AllowsReturningEarlyFromRoutingTest.php +++ b/test/Application/AllowsReturningEarlyFromRoutingTest.php @@ -5,12 +5,18 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; use PHPUnit\Framework\TestCase; -use Zend\Http\PhpEnvironment\Response; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\MvcEvent; +/** + * @coversNothing + */ class AllowsReturningEarlyFromRoutingTest extends TestCase { use PathControllerTrait; @@ -25,8 +31,8 @@ public function testAllowsReturningEarlyFromRouting() return $response; }); - $result = $application->run(); - $this->assertSame($application, $result); - $this->assertSame($response, $result->getResponse()); + $request = new ServerRequest([], [], 'http://example.local/path', 'GET', 'php://memory'); + $resultResponse = $application->handle($request); + $this->assertSame($response, $resultResponse); } } diff --git a/test/Application/BadControllerTrait.php b/test/Application/BadControllerTrait.php index 5d2f57d75..f824218ea 100644 --- a/test/Application/BadControllerTrait.php +++ b/test/Application/BadControllerTrait.php @@ -5,59 +5,24 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; -use ReflectionProperty; -use Zend\Http\PhpEnvironment\Request; -use Zend\Http\PhpEnvironment\Response; use Zend\Mvc\Application; use Zend\Mvc\Controller\ControllerManager; -use Zend\Mvc\Service\ServiceManagerConfig; -use Zend\Mvc\Service\ServiceListenerFactory; +use Zend\Mvc\View\Http\ViewManager; use Zend\Router; -use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\ArrayUtils; use ZendTest\Mvc\Controller\TestAsset\BadController; use ZendTest\Mvc\TestAsset; +use ZendTest\Mvc\TestAsset\ApplicationConfigHelper; trait BadControllerTrait { public function prepareApplication() { - $config = [ - 'router' => [ - 'routes' => [ - 'path' => [ - 'type' => Router\Http\Literal::class, - 'options' => [ - 'route' => '/bad', - 'defaults' => [ - 'controller' => 'bad', - 'action' => 'test', - ], - ], - ], - ], - ], - ]; - - $serviceListener = new ServiceListenerFactory(); - $r = new ReflectionProperty($serviceListener, 'defaultServiceConfig'); - $r->setAccessible(true); - $serviceConfig = $r->getValue($serviceListener); - - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - (new Router\ConfigProvider())->getDependencyConfig() - ); - - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - [ - 'aliases' => [ - 'ControllerLoader' => ControllerManager::class, - 'ControllerManager' => ControllerManager::class, - ], + $config = ApplicationConfigHelper::getConfig([ + 'dependencies' => [ 'factories' => [ ControllerManager::class => function ($services) { return new ControllerManager($services, ['factories' => [ @@ -66,37 +31,28 @@ public function prepareApplication() }, ]]); }, - 'Router' => function ($services) { - return $services->get('HttpRouter'); - }, ], 'invokables' => [ - 'Request' => Request::class, - 'Response' => Response::class, - 'ViewManager' => TestAsset\MockViewManager::class, - 'SendResponseListener' => TestAsset\MockSendResponseListener::class, - 'BootstrapListener' => TestAsset\StubBootstrapListener::class, + ViewManager::class => TestAsset\MockViewManager::class, ], - 'services' => [ - 'config' => $config, - 'ApplicationConfig' => [ - 'modules' => [], - 'module_listener_options' => [ - 'config_cache_enabled' => false, - 'cache_dir' => 'data/cache', - 'module_paths' => [], + ], + 'router' => [ + 'routes' => [ + 'path' => [ + 'type' => Router\Route\Literal::class, + 'options' => [ + 'route' => '/bad', + 'defaults' => [ + 'controller' => 'bad', + 'action' => 'test', + ], ], ], ], - ] - ); - $services = new ServiceManager(); - (new ServiceManagerConfig($serviceConfig))->configureServiceManager($services); - $application = $services->get('Application'); - - $request = $services->get('Request'); - $request->setUri('http://example.local/bad'); - + ], + ]); + $container = ApplicationConfigHelper::configureContainer($config); + $application = $container->get(Application::class); $application->bootstrap(); return $application; } diff --git a/test/Application/ControllerIsDispatchedTest.php b/test/Application/ControllerIsDispatchedTest.php index 42aed39bb..80d278aa4 100644 --- a/test/Application/ControllerIsDispatchedTest.php +++ b/test/Application/ControllerIsDispatchedTest.php @@ -5,11 +5,17 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\MvcEvent; +/** + * @coversNothing + */ class ControllerIsDispatchedTest extends TestCase { use PathControllerTrait; @@ -18,8 +24,9 @@ public function testControllerIsDispatchedDuringRun() { $application = $this->prepareApplication(); - $response = $application->run()->getResponse(); - $this->assertContains('PathController', $response->getContent()); - $this->assertContains(MvcEvent::EVENT_DISPATCH, $response->toString()); + $request = new ServerRequest([], [], 'http://example.local/path', 'GET', 'php://memory'); + $response = $application->handle($request); + $this->assertContains('PathController', $response->getBody()->__toString()); + $this->assertContains(MvcEvent::EVENT_DISPATCH, $response->getBody()->__toString()); } } diff --git a/test/Application/ExceptionsRaisedInDispatchableShouldRaiseDispatchErrorEventTest.php b/test/Application/ExceptionsRaisedInDispatchableShouldRaiseDispatchErrorEventTest.php index 105137ff3..972cb9559 100644 --- a/test/Application/ExceptionsRaisedInDispatchableShouldRaiseDispatchErrorEventTest.php +++ b/test/Application/ExceptionsRaisedInDispatchableShouldRaiseDispatchErrorEventTest.php @@ -5,11 +5,18 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\MvcEvent; +/** + * @coversNothing + */ class ExceptionsRaisedInDispatchableShouldRaiseDispatchErrorEventTest extends TestCase { use BadControllerTrait; @@ -21,16 +28,18 @@ public function testExceptionsRaisedInDispatchableShouldRaiseDispatchErrorEvent( { $application = $this->prepareApplication(); - $response = $application->getResponse(); $events = $application->getEventManager(); - $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($response) { + $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { $exception = $e->getParam('exception'); $this->assertInstanceOf('Exception', $exception); - $response->setContent($exception->getMessage()); + $response = new Response(); + $response->getBody()->write($exception->getMessage()); + $e->setResponse($response); return $response; }); - $application->run(); - $this->assertContains('Raised an exception', $response->getContent()); + $request = new ServerRequest([], [], 'http://example.local/bad', 'GET', 'php://memory'); + $response = $application->handle($request); + $this->assertContains('Raised an exception', $response->getBody()->__toString()); } } diff --git a/test/Application/InabilityToRetrieveControllerShouldTriggerDispatchErrorTest.php b/test/Application/InabilityToRetrieveControllerShouldTriggerDispatchErrorTest.php index 614124c3d..906aeed86 100644 --- a/test/Application/InabilityToRetrieveControllerShouldTriggerDispatchErrorTest.php +++ b/test/Application/InabilityToRetrieveControllerShouldTriggerDispatchErrorTest.php @@ -5,12 +5,19 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\Application; use Zend\Mvc\MvcEvent; +/** + * @coversNothing + */ class InabilityToRetrieveControllerShouldTriggerDispatchErrorTest extends TestCase { use MissingControllerTrait; @@ -22,17 +29,18 @@ public function testInabilityToRetrieveControllerShouldTriggerDispatchError() { $application = $this->prepareApplication(); - $response = $application->getResponse(); $events = $application->getEventManager(); - $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($response) { + $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { $error = $e->getError(); $controller = $e->getController(); - $response->setContent("Code: " . $error . '; Controller: ' . $controller); + $response = new Response(); + $response->getBody()->write("Code: " . $error . '; Controller: ' . $controller); return $response; }); - $application->run(); - $this->assertContains(Application::ERROR_CONTROLLER_NOT_FOUND, $response->getContent()); - $this->assertContains('bad', $response->getContent()); + $request = new ServerRequest([], [], 'http://example.local/bad', 'GET', 'php://memory'); + $response = $application->handle($request); + $this->assertContains(Application::ERROR_CONTROLLER_NOT_FOUND, $response->getBody()->__toString()); + $this->assertContains('bad', $response->getBody()->__toString()); } } diff --git a/test/Application/InabilityToRetrieveControllerShouldTriggerExceptionTest.php b/test/Application/InabilityToRetrieveControllerShouldTriggerExceptionTest.php index d7983a1d9..1a3e6163f 100644 --- a/test/Application/InabilityToRetrieveControllerShouldTriggerExceptionTest.php +++ b/test/Application/InabilityToRetrieveControllerShouldTriggerExceptionTest.php @@ -5,12 +5,19 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\Application; use Zend\Mvc\MvcEvent; +/** + * @coversNothing + */ class InabilityToRetrieveControllerShouldTriggerExceptionTest extends TestCase { use MissingControllerTrait; @@ -22,17 +29,18 @@ public function testInabilityToRetrieveControllerShouldTriggerExceptionError() { $application = $this->prepareApplication(); - $response = $application->getResponse(); $events = $application->getEventManager(); - $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($response) { + $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { $error = $e->getError(); $controller = $e->getController(); - $response->setContent("Code: " . $error . '; Controller: ' . $controller); + $response = new Response(); + $response->getBody()->write("Code: " . $error . '; Controller: ' . $controller); return $response; }); - $application->run(); - $this->assertContains(Application::ERROR_CONTROLLER_NOT_FOUND, $response->getContent()); - $this->assertContains('bad', $response->getContent()); + $request = new ServerRequest([], [], 'http://example.local/bad', 'GET', 'php://memory'); + $response = $application->handle($request); + $this->assertContains(Application::ERROR_CONTROLLER_NOT_FOUND, $response->getBody()->__toString()); + $this->assertContains('bad', $response->getBody()->__toString()); } } diff --git a/test/Application/InitializationIntegrationTest.php b/test/Application/InitializationIntegrationTest.php deleted file mode 100644 index bd60864f4..000000000 --- a/test/Application/InitializationIntegrationTest.php +++ /dev/null @@ -1,45 +0,0 @@ - [ - 'Zend\Router', - 'Application', - ], - 'module_listener_options' => [ - 'module_paths' => [ - __DIR__ . '/TestAsset/modules', - ], - ], - ]; - - $application = Application::init($appConfig); - - $request = $application->getRequest(); - $request->setUri('http://example.local/path'); - $request->setRequestUri('/path'); - - ob_start(); - $application->run(); - $content = ob_get_clean(); - - $response = $application->getResponse(); - $this->assertContains('Application\\Controller\\PathController', $response->getContent()); - $this->assertContains('Application\\Controller\\PathController', $content); - $this->assertContains(MvcEvent::EVENT_DISPATCH, $response->toString()); - } -} diff --git a/test/Application/InvalidControllerTypeShouldTriggerDispatchErrorTest.php b/test/Application/InvalidControllerTypeShouldTriggerDispatchErrorTest.php index 709f7be06..d15ddf3e0 100644 --- a/test/Application/InvalidControllerTypeShouldTriggerDispatchErrorTest.php +++ b/test/Application/InvalidControllerTypeShouldTriggerDispatchErrorTest.php @@ -5,12 +5,19 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\Application; use Zend\Mvc\MvcEvent; +/** + * @coversNothing + */ class InvalidControllerTypeShouldTrigerDispatchErrorTest extends TestCase { use InvalidControllerTypeTrait; @@ -22,18 +29,19 @@ public function testInvalidControllerTypeShouldTriggerDispatchError() { $application = $this->prepareApplication(); - $response = $application->getResponse(); $events = $application->getEventManager(); - $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($response) { + $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { $error = $e->getError(); $controller = $e->getController(); $class = $e->getControllerClass(); - $response->setContent("Code: " . $error . '; Controller: ' . $controller . '; Class: ' . $class); + $response = new Response(); + $response->getBody()->write("Code: " . $error . '; Controller: ' . $controller . '; Class: ' . $class); return $response; }); - $application->run(); - $this->assertContains(Application::ERROR_CONTROLLER_INVALID, $response->getContent()); - $this->assertContains('bad', $response->getContent()); + $request = new ServerRequest([], [], 'http://example.local/bad', 'GET', 'php://memory'); + $response = $application->handle($request); + $this->assertContains(Application::ERROR_CONTROLLER_INVALID, $response->getBody()->__toString()); + $this->assertContains('bad', $response->getBody()->__toString()); } } diff --git a/test/Application/InvalidControllerTypeTrait.php b/test/Application/InvalidControllerTypeTrait.php index 5478a638a..3e041fd85 100644 --- a/test/Application/InvalidControllerTypeTrait.php +++ b/test/Application/InvalidControllerTypeTrait.php @@ -5,97 +5,54 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; -use ReflectionProperty; use stdClass; -use Zend\Http\PhpEnvironment\Request; -use Zend\Http\PhpEnvironment\Response; use Zend\Mvc\Application; use Zend\Mvc\Controller\ControllerManager; -use Zend\Mvc\Service\ServiceManagerConfig; -use Zend\Mvc\Service\ServiceListenerFactory; +use Zend\Mvc\View\Http\ViewManager; use Zend\Router; -use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\ArrayUtils; use ZendTest\Mvc\TestAsset; +use ZendTest\Mvc\TestAsset\ApplicationConfigHelper; trait InvalidControllerTypeTrait { public function prepareApplication() { - $config = [ - 'router' => [ - 'routes' => [ - 'path' => [ - 'type' => Router\Http\Literal::class, - 'options' => [ - 'route' => '/bad', - 'defaults' => [ - 'controller' => 'bad', - 'action' => 'test', - ], - ], - ], - ], - ], - ]; - - $serviceListener = new ServiceListenerFactory(); - $r = new ReflectionProperty($serviceListener, 'defaultServiceConfig'); - $r->setAccessible(true); - $serviceConfig = $r->getValue($serviceListener); - - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - (new Router\ConfigProvider())->getDependencyConfig() - ); - - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - [ - 'aliases' => [ - 'ControllerLoader' => 'ControllerManager', - ], + $config = ApplicationConfigHelper::getConfig([ + 'dependencies' => [ 'factories' => [ - 'ControllerManager' => function ($services) { + ControllerManager::class => function ($services) { return new ControllerManager($services, ['factories' => [ 'bad' => function () { return new stdClass(); }, ]]); }, - 'Router' => function ($services) { - return $services->get('HttpRouter'); - }, ], 'invokables' => [ - 'Request' => Request::class, - 'Response' => Response::class, - 'ViewManager' => TestAsset\MockViewManager::class, - 'SendResponseListener' => TestAsset\MockSendResponseListener::class, - 'BootstrapListener' => TestAsset\StubBootstrapListener::class, + ViewManager::class => TestAsset\MockViewManager::class, ], - 'services' => [ - 'config' => $config, - 'ApplicationConfig' => [ - 'modules' => [], - 'module_listener_options' => [ - 'config_cache_enabled' => false, - 'cache_dir' => 'data/cache', - 'module_paths' => [], + ], + 'router' => [ + 'routes' => [ + 'path' => [ + 'type' => Router\Route\Literal::class, + 'options' => [ + 'route' => '/bad', + 'defaults' => [ + 'controller' => 'bad', + 'action' => 'test', + ], ], ], ], - ] - ); - $services = new ServiceManager(); - (new ServiceManagerConfig($serviceConfig))->configureServiceManager($services); - $application = $services->get('Application'); - - $request = $services->get('Request'); - $request->setUri('http://example.local/bad'); - + ], + ]); + $container = ApplicationConfigHelper::configureContainer($config); + $application = $container->get(Application::class); $application->bootstrap(); return $application; } diff --git a/test/Application/MissingControllerTrait.php b/test/Application/MissingControllerTrait.php index 8921b78ea..a34d9ef7d 100644 --- a/test/Application/MissingControllerTrait.php +++ b/test/Application/MissingControllerTrait.php @@ -5,28 +5,32 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; -use ReflectionProperty; -use Zend\Http\PhpEnvironment\Request; -use Zend\Http\PhpEnvironment\Response; use Zend\Mvc\Application; -use Zend\Mvc\Service\ServiceManagerConfig; -use Zend\Mvc\Service\ServiceListenerFactory; +use Zend\Mvc\View\Http\ViewManager; use Zend\Router; -use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\ArrayUtils; use ZendTest\Mvc\TestAsset; +use ZendTest\Mvc\TestAsset\ApplicationConfigHelper; trait MissingControllerTrait { public function prepareApplication() { - $config = [ + $config = ApplicationConfigHelper::getConfig([ + 'dependencies' => [ + 'factories' => [ + ], + 'invokables' => [ + ViewManager::class => TestAsset\MockViewManager::class, + ], + ], 'router' => [ 'routes' => [ 'path' => [ - 'type' => Router\Http\Literal::class, + 'type' => Router\Route\Literal::class, 'options' => [ 'route' => '/bad', 'defaults' => [ @@ -37,53 +41,9 @@ public function prepareApplication() ], ], ], - ]; - - $serviceListener = new ServiceListenerFactory(); - $r = new ReflectionProperty($serviceListener, 'defaultServiceConfig'); - $r->setAccessible(true); - $serviceConfig = $r->getValue($serviceListener); - - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - (new Router\ConfigProvider())->getDependencyConfig() - ); - - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - [ - 'factories' => [ - 'Router' => function ($services) { - return $services->get('HttpRouter'); - }, - ], - 'invokables' => [ - 'Request' => Request::class, - 'Response' => Response::class, - 'ViewManager' => TestAsset\MockViewManager::class, - 'SendResponseListener' => TestAsset\MockSendResponseListener::class, - 'BootstrapListener' => TestAsset\StubBootstrapListener::class, - ], - 'services' => [ - 'config' => $config, - 'ApplicationConfig' => [ - 'modules' => [], - 'module_listener_options' => [ - 'config_cache_enabled' => false, - 'cache_dir' => 'data/cache', - 'module_paths' => [], - ], - ], - ], - ] - ); - $services = new ServiceManager(); - (new ServiceManagerConfig($serviceConfig))->configureServiceManager($services); - $application = $services->get('Application'); - - $request = $services->get('Request'); - $request->setUri('http://example.local/bad'); - + ]); + $container = ApplicationConfigHelper::configureContainer($config); + $application = $container->get(Application::class); $application->bootstrap(); return $application; } diff --git a/test/Application/PathControllerTrait.php b/test/Application/PathControllerTrait.php index f511e8684..bd6cfac77 100644 --- a/test/Application/PathControllerTrait.php +++ b/test/Application/PathControllerTrait.php @@ -5,57 +5,23 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; -use ReflectionProperty; -use Zend\Http\PhpEnvironment\Request; -use Zend\Http\PhpEnvironment\Response; use Zend\Mvc\Application; use Zend\Mvc\Controller\ControllerManager; -use Zend\Mvc\Service\ServiceManagerConfig; -use Zend\Mvc\Service\ServiceListenerFactory; +use Zend\Mvc\View\Http\ViewManager; use Zend\Router; -use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\ArrayUtils; use ZendTest\Mvc\TestAsset; +use ZendTest\Mvc\TestAsset\ApplicationConfigHelper; trait PathControllerTrait { public function prepareApplication() { - $config = [ - 'router' => [ - 'routes' => [ - 'path' => [ - 'type' => Router\Http\Literal::class, - 'options' => [ - 'route' => '/path', - 'defaults' => [ - 'controller' => 'path', - ], - ], - ], - ], - ], - ]; - - $serviceListener = new ServiceListenerFactory(); - $r = new ReflectionProperty($serviceListener, 'defaultServiceConfig'); - $r->setAccessible(true); - $serviceConfig = $r->getValue($serviceListener); - - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - (new Router\ConfigProvider())->getDependencyConfig() - ); - - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - [ - 'aliases' => [ - 'ControllerLoader' => ControllerManager::class, - 'ControllerManager' => ControllerManager::class, - ], + $config = ApplicationConfigHelper::getConfig([ + 'dependencies' => [ 'factories' => [ ControllerManager::class => function ($services) { return new ControllerManager($services, ['factories' => [ @@ -64,39 +30,27 @@ public function prepareApplication() }, ]]); }, - 'Router' => function ($services) { - return $services->get('HttpRouter'); - }, ], 'invokables' => [ - 'Request' => Request::class, - 'Response' => Response::class, - 'ViewManager' => TestAsset\MockViewManager::class, - 'SendResponseListener' => TestAsset\MockSendResponseListener::class, - 'BootstrapListener' => TestAsset\StubBootstrapListener::class, + ViewManager::class => TestAsset\MockViewManager::class, ], - 'services' => [ - 'config' => $config, - 'ApplicationConfig' => [ - 'modules' => [ - 'Zend\Router', - ], - 'module_listener_options' => [ - 'config_cache_enabled' => false, - 'cache_dir' => 'data/cache', - 'module_paths' => [], + ], + 'router' => [ + 'routes' => [ + 'path' => [ + 'type' => Router\Route\Literal::class, + 'options' => [ + 'route' => '/path', + 'defaults' => [ + 'controller' => 'path', + ], ], ], ], - ] - ); - $services = new ServiceManager(); - (new ServiceManagerConfig($serviceConfig))->configureServiceManager($services); - $application = $services->get('Application'); - - $request = $services->get('Request'); - $request->setUri('http://example.local/path'); - + ], + ]); + $container = ApplicationConfigHelper::configureContainer($config); + $application = $container->get(Application::class); $application->bootstrap(); return $application; } diff --git a/test/Application/RoutingSuccessTest.php b/test/Application/RoutingSuccessTest.php index d2c05d6af..9ad096d14 100644 --- a/test/Application/RoutingSuccessTest.php +++ b/test/Application/RoutingSuccessTest.php @@ -5,12 +5,18 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Application; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\MvcEvent; -use Zend\Router\RouteMatch; +use Zend\Router\RouteResult; +/** + * @coversNothing + */ class RoutingSuccessTest extends TestCase { use PathControllerTrait; @@ -22,13 +28,14 @@ public function testRoutingIsExcecutedDuringRun() $log = []; $application->getEventManager()->attach(MvcEvent::EVENT_ROUTE, function ($e) use (&$log) { - $match = $e->getRouteMatch(); - $this->assertInstanceOf(RouteMatch::class, $match, 'Did not receive expected route match'); - $log['route-match'] = $match; + $result = $e->getRequest()->getAttribute(RouteResult::class); + $this->assertInstanceOf(RouteResult::class, $result, 'Did not receive expected route match'); + $log['route-result'] = $result; }, -100); - $application->run(); - $this->assertArrayHasKey('route-match', $log); - $this->assertInstanceOf(RouteMatch::class, $log['route-match']); + $request = new ServerRequest([], [], 'http://example.local/path', 'GET', 'php://memory'); + $resultResponse = $application->handle($request); + $this->assertArrayHasKey('route-result', $log); + $this->assertInstanceOf(RouteResult::class, $log['route-result']); } } diff --git a/test/Application/TestAsset/modules/Application/Module.php b/test/Application/TestAsset/modules/Application/Module.php deleted file mode 100644 index 0cb6a0fe9..000000000 --- a/test/Application/TestAsset/modules/Application/Module.php +++ /dev/null @@ -1,29 +0,0 @@ - [ - 'namespaces' => [ - __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__, - ], - ], - ]; - } -} diff --git a/test/Application/TestAsset/modules/Application/config/module.config.php b/test/Application/TestAsset/modules/Application/config/module.config.php deleted file mode 100644 index db068ccca..000000000 --- a/test/Application/TestAsset/modules/Application/config/module.config.php +++ /dev/null @@ -1,64 +0,0 @@ - [ - 'factories' => [ - 'path' => function () { - return new Controller\PathController(); - }, - ], - ], - 'router' => [ - 'routes' => [ - 'path' => [ - 'type' => 'literal', - 'options' => [ - 'route' => '/path', - 'defaults' => [ - 'controller' => 'path', - ], - ], - ], - ], - ], - 'service_manager' => [ - 'factories' => [ - 'Request' => function () { - return new HttpRequest(); - }, - 'Response' => function () { - return new HttpResponse(); - }, - 'Router' => HttpRouterFactory::class, - 'ViewManager' => HttpViewManagerFactory::class, - ], - ], - 'view_manager' => [ - 'display_not_found_reason' => true, - 'display_exceptions' => true, - 'doctype' => 'HTML5', - 'not_found_template' => 'error/404', - 'exception_template' => 'error/index', - 'template_map' => [ - 'layout/layout' => __DIR__ . '/../view/layout/layout.phtml', - 'application/index/index' => __DIR__ . '/../view/application/index/index.phtml', - 'error/404' => __DIR__ . '/../view/error/404.phtml', - 'error/index' => __DIR__ . '/../view/error/index.phtml', - ], - 'template_path_stack' => [ - __DIR__ . '/../view', - ], - ], -]; diff --git a/test/Application/TestAsset/modules/Application/src/Application/Controller/PathController.php b/test/Application/TestAsset/modules/Application/src/Application/Controller/PathController.php deleted file mode 100644 index fd9db7fe9..000000000 --- a/test/Application/TestAsset/modules/Application/src/Application/Controller/PathController.php +++ /dev/null @@ -1,25 +0,0 @@ -setContent(__METHOD__); - return $response; - } -} diff --git a/test/Application/TestAsset/modules/Application/view/application/index/index.phtml b/test/Application/TestAsset/modules/Application/view/application/index/index.phtml deleted file mode 100644 index ff98a33ff..000000000 --- a/test/Application/TestAsset/modules/Application/view/application/index/index.phtml +++ /dev/null @@ -1,5 +0,0 @@ -

Home Page

- -

- This is the home page. -

diff --git a/test/Application/TestAsset/modules/Application/view/error/404.phtml b/test/Application/TestAsset/modules/Application/view/error/404.phtml deleted file mode 100644 index f53d90ae7..000000000 --- a/test/Application/TestAsset/modules/Application/view/error/404.phtml +++ /dev/null @@ -1,107 +0,0 @@ -

A 404 error occurred

-

message ?>

- -reason) && $this->reason): ?> - -reason) { - case 'error-controller-cannot-dispatch': - $reasonMessage = 'The requested controller was unable to dispatch the request.'; - break; - case 'error-controller-not-found': - $reasonMessage = 'The requested controller could not be mapped to an existing controller class.'; - break; - case 'error-controller-invalid': - $reasonMessage = 'The requested controller was not dispatchable.'; - break; - case 'error-router-no-match': - $reasonMessage = 'The requested URL could not be matched by routing.'; - break; - default: - $reasonMessage = 'We cannot determine at this time why a 404 was generated.'; - break; -} -?> - -

- - - -controller) && $this->controller): ?> - -
-
Controller:
-
escapeHtml($this->controller) ?> -controller_class) - && $this->controller_class - && $this->controller_class != $this->controller -) { - echo '(' . sprintf('resolves to %s', $this->escapeHtml($this->controller_class)) . ')'; -} -?> -
-
- - - -display_exceptions) && $this->display_exceptions): ?> - -exception) && $this->exception instanceof Exception): ?> -
-

Additional information:

-

exception); ?>

-
-
File:
-
- 
exception->getFile() ?>:exception->getLine() ?>
-
-
Message:
-
- 
exception->getMessage() ?>
-
-
Stack trace:
-
- 
exception->getTraceAsString() ?>
-
-
-exception->getPrevious(); - if ($e) : -?> -
-

Previous exceptions:

- - - - - -

No Exception available

- - - - diff --git a/test/Application/TestAsset/modules/Application/view/error/index.phtml b/test/Application/TestAsset/modules/Application/view/error/index.phtml deleted file mode 100644 index 5f013493b..000000000 --- a/test/Application/TestAsset/modules/Application/view/error/index.phtml +++ /dev/null @@ -1,62 +0,0 @@ -

An error occurred

-

message ?>

- -display_exceptions) && $this->display_exceptions): ?> - -exception) && $this->exception instanceof Exception): ?> -
-

Additional information:

-

exception); ?>

-
-
File:
-
- 
exception->getFile() ?>:exception->getLine() ?>
-
-
Message:
-
- 
escapeHtml($this->exception->getMessage()) ?>
-
-
Stack trace:
-
- 
escapeHtml($this->exception->getTraceAsString()) ?>
-
-
-exception->getPrevious(); - if ($e) : -?> -
-

Previous exceptions:

- - - - - -

No Exception available

- - - - diff --git a/test/Application/TestAsset/modules/Application/view/layout/layout.phtml b/test/Application/TestAsset/modules/Application/view/layout/layout.phtml deleted file mode 100644 index ac6e48032..000000000 --- a/test/Application/TestAsset/modules/Application/view/layout/layout.phtml +++ /dev/null @@ -1,14 +0,0 @@ -doctype(); ?> - - - - - headTitle('ZF2 Skeleton Application')->setSeparator(' - ')->setAutoEscape(false) ?> - - - -
- content; ?> -
- - diff --git a/test/ApplicationTest.php b/test/ApplicationTest.php index 35da58855..e9a841ae1 100644 --- a/test/ApplicationTest.php +++ b/test/ApplicationTest.php @@ -5,125 +5,101 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc; use PHPUnit\Framework\TestCase; -use ReflectionMethod; +use Prophecy\Prophecy\ObjectProphecy; use ReflectionProperty; -use stdClass; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManager; +use Zend\EventManager\ListenerAggregateInterface; use Zend\EventManager\SharedEventManager; use Zend\EventManager\Test\EventListenerIntrospectionTrait; -use Zend\Http\PhpEnvironment; -use Zend\Http\PhpEnvironment\Response; -use Zend\ModuleManager\Listener\ConfigListener; -use Zend\ModuleManager\ModuleEvent; use Zend\Mvc\Application; -use Zend\Mvc\Controller\ControllerManager; +use Zend\Mvc\DispatchListener; +use Zend\Mvc\HttpMethodListener; +use Zend\Mvc\MiddlewareListener; use Zend\Mvc\MvcEvent; -use Zend\Mvc\Service\ServiceManagerConfig; -use Zend\Mvc\Service\ServiceListenerFactory; -use Zend\Router; -use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\ArrayUtils; -use Zend\Stdlib\ResponseInterface; -use Zend\View\Model\ViewModel; +use Zend\Mvc\RouteListener; +use Zend\Mvc\View\Http\ViewManager; +use Zend\Router\RouteStackInterface; +/** + * @covers \Zend\Mvc\Application + */ class ApplicationTest extends TestCase { use EventListenerIntrospectionTrait; + use ContainerTrait; /** - * @var ServiceManager + * @var Application */ - protected $serviceManager; + private $application; /** - * @var Application + * @var ObjectProphecy */ - protected $application; + private $container; + + /** + * @var ObjectProphecy + */ + private $router; + + /** + * @var EventManager + */ + private $events; + + /** + * @var array + */ + private $listeners = []; public function setUp() { - $serviceListener = new ServiceListenerFactory(); - $r = new ReflectionProperty($serviceListener, 'defaultServiceConfig'); - $r->setAccessible(true); - $serviceConfig = $r->getValue($serviceListener); + $this->container = $this->mockContainerInterface(); - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - (new Router\ConfigProvider())->getDependencyConfig() - ); + $this->router = $this->prophesize(RouteStackInterface::class); + $this->events = new EventManager(new SharedEventManager()); - $serviceConfig = ArrayUtils::merge( - $serviceConfig, - [ - 'invokables' => [ - 'Request' => PhpEnvironment\Request::class, - 'Response' => PhpEnvironment\Response::class, - 'ViewManager' => TestAsset\MockViewManager::class, - 'SendResponseListener' => TestAsset\MockSendResponseListener::class, - 'BootstrapListener' => TestAsset\StubBootstrapListener::class, - ], - 'factories' => [ - 'Router' => Router\RouterFactory::class, - ], - 'services' => [ - 'config' => [], - 'ApplicationConfig' => [ - 'modules' => [ - 'Zend\Router', - ], - 'module_listener_options' => [ - 'config_cache_enabled' => false, - 'cache_dir' => 'data/cache', - 'module_paths' => [], - ], - ], - ], - ] - ); - $this->serviceManager = new ServiceManager(); - (new ServiceManagerConfig($serviceConfig))->configureServiceManager($this->serviceManager); - $this->serviceManager->setAllowOverride(true); - $this->application = $this->serviceManager->get('Application'); - } + $this->injectServiceInContainer($this->container, 'config', []); - public function getConfigListener() - { - $manager = $this->serviceManager->get('ModuleManager'); - $listeners = $this->getArrayOfListenersForEvent(ModuleEvent::EVENT_LOAD_MODULE, $manager->getEventManager()); - return array_reduce($listeners, function ($found, $listener) { - if ($found || ! is_array($listener)) { - return $found; - } - $listener = array_shift($listener); - if ($listener instanceof ConfigListener) { - return $listener; - } - }); - } + $route = $this->prophesize(RouteListener::class); + $this->injectServiceInContainer($this->container, RouteListener::class, $route->reveal()); + $this->listeners[RouteListener::class] = $route; - public function testRequestIsPopulatedFromServiceManager() - { - $request = $this->serviceManager->get('Request'); - $this->assertSame($request, $this->application->getRequest()); - } + $dispatch = $this->prophesize(DispatchListener::class); + $this->injectServiceInContainer($this->container, DispatchListener::class, $dispatch->reveal()); + $this->listeners[DispatchListener::class] = $dispatch; - public function testResponseIsPopulatedFromServiceManager() - { - $response = $this->serviceManager->get('Response'); - $this->assertSame($response, $this->application->getResponse()); + $middleware = $this->prophesize(MiddlewareListener::class); + $this->injectServiceInContainer($this->container, MiddlewareListener::class, $middleware->reveal()); + $this->listeners[MiddlewareListener::class] = $middleware; + + $viewManager = $this->prophesize(ViewManager::class); + $this->injectServiceInContainer($this->container, ViewManager::class, $viewManager->reveal()); + $this->listeners[ViewManager::class] = $viewManager; + + $httpMethod = $this->prophesize(HttpMethodListener::class); + $this->injectServiceInContainer($this->container, HttpMethodListener::class, $httpMethod->reveal()); + $this->listeners[HttpMethodListener::class] = $httpMethod; + + $this->application = new Application( + $this->container->reveal(), + $this->router->reveal(), + $this->events + ); } public function testEventManagerIsPopulated() { - $events = $this->serviceManager->get('EventManager'); - $sharedEvents = $events->getSharedManager(); - $appEvents = $this->application->getEventManager(); - $this->assertInstanceOf(EventManager::class, $appEvents); - $this->assertNotSame($events, $appEvents); - $this->assertSame($sharedEvents, $appEvents->getSharedManager()); + $appEvents = $this->application->getEventManager(); + $this->assertSame($this->events, $appEvents); } public function testEventManagerListensOnApplicationContext() @@ -134,21 +110,11 @@ public function testEventManagerListensOnApplicationContext() $this->assertEquals($expected, array_values($identifiers)); } - public function testServiceManagerIsPopulated() + public function testContainerIsPopulated() { - $this->assertSame($this->serviceManager, $this->application->getServiceManager()); + $this->assertSame($this->container->reveal(), $this->application->getContainer()); } - public function testConfigIsPopulated() - { - $smConfig = $this->serviceManager->get('config'); - $appConfig = $this->application->getConfig(); - $this->assertEquals( - $smConfig, - $appConfig, - sprintf('SM config: %s; App config: %s', var_export($smConfig, 1), var_export($appConfig, 1)) - ); - } public function testEventsAreEmptyAtFirst() { @@ -161,66 +127,52 @@ public function testEventsAreEmptyAtFirst() $this->assertAttributeEquals([], 'identifiers', $sharedEvents); } - /** - * @param string $listenerServiceName - * @param string $event - * @param string $method - * - * @dataProvider bootstrapRegistersListenersProvider - */ - public function testBootstrapRegistersListeners($listenerServiceName, $event, $method, $isCustom = false) + public function testBootstrapRegistersListeners() { - $listenerService = $this->serviceManager->get($listenerServiceName); - $this->application->bootstrap($isCustom ? (array) $listenerServiceName : []); - $events = $this->application->getEventManager(); - - $foundListener = false; - $listeners = $this->getArrayOfListenersForEvent($event, $events); - $this->assertContains([$listenerService, $method], $listeners); - } + foreach ($this->listeners as $listener) { + $listener->attach($this->events)->shouldBeCalled(); + } - public function bootstrapRegistersListenersProvider() - { - // @codingStandardsIgnoreStart - // [ Service Name, Event, Method, isCustom ] - return [ - 'route' => ['RouteListener' , MvcEvent::EVENT_ROUTE , 'onRoute', false], - 'dispatch' => ['DispatchListener' , MvcEvent::EVENT_DISPATCH , 'onDispatch', false], - 'middleware' => ['MiddlewareListener' , MvcEvent::EVENT_DISPATCH , 'onDispatch', false], - 'send_response' => ['SendResponseListener' , MvcEvent::EVENT_FINISH , 'sendResponse', false], - 'view_manager' => ['ViewManager' , MvcEvent::EVENT_BOOTSTRAP , 'onBootstrap', false], - 'http_method' => ['HttpMethodListener' , MvcEvent::EVENT_ROUTE , 'onRoute', false], - 'bootstrap' => ['BootstrapListener' , MvcEvent::EVENT_BOOTSTRAP , 'onBootstrap', true ], - ]; - // @codingStandardsIgnoreEnd + $this->application->bootstrap(); } public function testBootstrapAlwaysRegistersDefaultListeners() { + $application = new Application( + $this->container->reveal(), + $this->router->reveal(), + $this->events, + ['Custom'] + ); + $r = new ReflectionProperty($this->application, 'defaultListeners'); $r->setAccessible(true); - $defaultListenersNames = $r->getValue($this->application); - $defaultListeners = []; - foreach ($defaultListenersNames as $defaultListenerName) { - $defaultListeners[] = $this->serviceManager->get($defaultListenerName); + $defaultListeners = $r->getValue($this->application); + foreach ($defaultListeners as $defaultListenerName) { + $custom = $this->prophesize(ListenerAggregateInterface::class); + $custom->attach($this->events)->shouldBeCalled(); + $this->injectServiceInContainer($this->container, $defaultListenerName, $custom->reveal()); } - $this->application->bootstrap(['BootstrapListener']); - $eventManager = $this->application->getEventManager(); + $custom = $this->prophesize(ListenerAggregateInterface::class); + $custom->attach($this->events)->shouldBeCalled(); + $this->injectServiceInContainer($this->container, 'Custom', $custom->reveal()); - $registeredListeners = []; - foreach ($this->getEventsFromEventManager($eventManager) as $event) { - foreach ($this->getListenersForEvent($event, $eventManager) as $listener) { - if (is_array($listener)) { - $listener = array_shift($listener); - } - $registeredListeners[] = $listener; - } - } + $application->bootstrap(); + } - foreach ($defaultListeners as $defaultListener) { - $this->assertContains($defaultListener, $registeredListeners); - } + public function testBootstrapAttachesInstanceOfListenerAggregate() + { + $custom = $this->prophesize(ListenerAggregateInterface::class); + $custom->attach($this->events)->shouldBeCalled(); + $application = new Application( + $this->container->reveal(), + $this->router->reveal(), + $this->events, + [$custom->reveal()] + ); + + $application->bootstrap(); } public function testBootstrapRegistersConfiguredMvcEvent() @@ -230,272 +182,255 @@ public function testBootstrapRegistersConfiguredMvcEvent() $event = $this->application->getMvcEvent(); $this->assertInstanceOf(MvcEvent::class, $event); - $request = $this->application->getRequest(); - $response = $this->application->getResponse(); - $router = $this->serviceManager->get('HttpRouter'); - $this->assertFalse($event->isError()); - $this->assertSame($request, $event->getRequest()); - $this->assertSame($response, $event->getResponse()); - $this->assertSame($router, $event->getRouter()); + $this->assertNull($event->getRequest()); + $this->assertNull($event->getResponse()); + $this->assertSame($this->router->reveal(), $event->getRouter()); $this->assertSame($this->application, $event->getApplication()); $this->assertSame($this->application, $event->getTarget()); } - public function setupPathController($addService = true) + public function testBootstrapTriggersBootstrapEvent() { - $request = $this->serviceManager->get('Request'); - $request->setUri('http://example.local/path'); - - $router = $this->serviceManager->get('HttpRouter'); - $route = Router\Http\Literal::factory([ - 'route' => '/path', - 'defaults' => [ - 'controller' => 'path', - ], - ]); - $router->addRoute('path', $route); - $this->serviceManager->setService('HttpRouter', $router); - $this->serviceManager->setService('Router', $router); - - if ($addService) { - $this->services->addFactory('ControllerManager', function ($services) { - return new ControllerManager($services, ['factories' => [ - 'path' => function () { - return new TestAsset\PathController; - }, - ]]); - }); - } - + $called = false; + $this->application->getEventManager()->attach( + MvcEvent::EVENT_BOOTSTRAP, + function ($e) use (&$called) { + $this->assertInstanceOf(MvcEvent::class, $e); + $called = true; + } + ); $this->application->bootstrap(); - return $this->application; + $this->assertTrue($called); } - public function setupActionController() + public function testBootstrapTriggersOnlyOnce() { - $request = $this->serviceManager->get('Request'); - $request->setUri('http://example.local/sample'); - - $router = $this->serviceManager->get('HttpRouter'); - $route = Router\Http\Literal::factory([ - 'route' => '/sample', - 'defaults' => [ - 'controller' => 'sample', - 'action' => 'test', - ], - ]); - $router->addRoute('sample', $route); - - $this->serviceManager->setFactory('ControllerManager', function ($services) { - return new ControllerManager($services, ['factories' => [ - 'sample' => function () { - return new Controller\TestAsset\SampleController(); - }, - ]]); - }); - + $called = 0; + $this->application->getEventManager()->attach( + MvcEvent::EVENT_BOOTSTRAP, + function ($e) use (&$called) { + $this->assertInstanceOf(MvcEvent::class, $e); + $called++; + } + ); $this->application->bootstrap(); - return $this->application; + $this->application->bootstrap(); + $this->assertEquals(1, $called); } - public function setupBadController($addService = true, $action = 'test') + public function testHandleTriggersBootstrapImplicitly() { - $request = $this->serviceManager->get('Request'); - $request->setUri('http://example.local/bad'); - - $router = $this->serviceManager->get('HttpRouter'); - $route = Router\Http\Literal::factory([ - 'route' => '/bad', - 'defaults' => [ - 'controller' => 'bad', - 'action' => $action, - ], - ]); - $router->addRoute('bad', $route); - - if ($addService) { - $this->serviceManager->setFactory('ControllerManager', function ($services) { - return new ControllerManager($services, ['factories' => [ - 'bad' => function () { - return new Controller\TestAsset\BadController(); - }, - ]]); - }); - } + $called = false; + $this->application->getEventManager()->attach( + MvcEvent::EVENT_BOOTSTRAP, + function ($e) use (&$called) { + $called = true; + } + ); + $request = new ServerRequest([], [], 'http://example.local/', 'GET', 'php://memory'); + $this->application->handle($request); + $this->assertTrue($called); + } + public function testRequestAndResponseAreNotAvailableDuringBootstrap() + { + $this->application->getEventManager()->attach( + MvcEvent::EVENT_BOOTSTRAP, + function (MvcEvent $e) { + $this->assertNull($e->getRequest()); + $this->assertNull($e->getResponse()); + } + ); $this->application->bootstrap(); - return $this->application; } - public function testFinishEventIsTriggeredAfterDispatching() + public function testRequestIsAvailableForRouteEvent() { - $application = $this->setupActionController(); - $application->getEventManager()->attach(MvcEvent::EVENT_FINISH, function ($e) { - return $e->getResponse()->setContent($e->getResponse()->getBody() . 'foobar'); - }); - $application->run(); - $this->assertContains( - 'foobar', - $this->application->getResponse()->getBody(), - 'The "finish" event was not triggered ("foobar" not in response)' + $this->application->getEventManager()->attach( + MvcEvent::EVENT_ROUTE, + function (MvcEvent $e) { + $this->assertNotNull($e->getRequest()); + } ); + $request = new ServerRequest([], [], 'http://example.local/', 'GET', 'php://memory'); + $this->application->handle($request); } - /** - * @group error-handling - */ - public function testRoutingFailureShouldTriggerDispatchError() + public function testRequestIsAvailableForDispatchEvent() { - $application = $this->setupBadController(); - $router = new Router\SimpleRouteStack(); - $event = $application->getMvcEvent(); - $event->setRouter($router); - - $response = $application->getResponse(); - $events = $application->getEventManager(); - $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($response) { - $error = $e->getError(); - $response->setContent("Code: " . $error); - return $response; - }); - - $application->run(); - $this->assertTrue($event->isError()); - $this->assertContains(Application::ERROR_ROUTER_NO_MATCH, $response->getContent()); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_ROUTE, + function (MvcEvent $e) { + $this->assertNotNull($e->getRequest()); + } + ); + $request = new ServerRequest([], [], 'http://example.local/', 'GET', 'php://memory'); + $this->application->handle($request); } - /** - * @group error-handling - */ - public function testLocatorExceptionShouldTriggerDispatchError() + public function testHandleTriggersEventsInOrder() { - $application = $this->setupPathController(false); - $controllerLoader = $application->getServiceManager()->get('ControllerManager'); - $response = new Response(); - $application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($response) { - return $response; - }); - - $result = $application->run(); - $this->assertSame($application, $result, get_class($result)); - $this->assertSame($response, $result->getResponse(), get_class($result)); + $this->application->bootstrap(); + + $expected = [ + MvcEvent::EVENT_ROUTE, + MvcEvent::EVENT_DISPATCH, + MvcEvent::EVENT_RENDER, + MvcEvent::EVENT_FINISH, + ]; + $triggered = []; + $this->application->getEventManager()->attach( + '*', + function (MvcEvent $e) use (&$triggered) { + $triggered[] = $e->getName(); + } + ); + + $request = new ServerRequest([], [], 'http://example.local/', 'GET', 'php://memory'); + $this->application->handle($request); + $this->assertEquals($expected, $triggered); } /** - * @requires PHP 7.0 - * @group error-handling + * @group ZF2-171 */ - public function testPhp7ErrorRaisedInDispatchableShouldRaiseDispatchErrorEvent() + public function testFinishShouldTriggerEvenIfRouteEventReturnsResponse() { - $this->setupBadController(true, 'test-php7-error'); - $response = $this->application->getResponse(); - $events = $this->application->getEventManager(); - $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($response) { - $exception = $e->getParam('exception'); - $response->setContent($exception->getMessage()); - return $response; - }); - - $this->application->run(); - $this->assertContains('Raised an error', $response->getContent()); + $this->application->bootstrap(); + + $expected = [ + MvcEvent::EVENT_ROUTE, + MvcEvent::EVENT_FINISH, + ]; + $triggered = []; + $this->application->getEventManager()->attach( + '*', + function (MvcEvent $e) use (&$triggered) { + $triggered[] = $e->getName(); + }, + 100 + ); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_ROUTE, + function (MvcEvent $e) { + return new Response(); + } + ); + + $request = new ServerRequest([], [], 'http://example.local/', 'GET', 'php://memory'); + $this->application->handle($request); + $this->assertEquals($expected, $triggered); } /** - * @group error-handling + * @group ZF2-171 */ - public function testFailureForRouteToReturnRouteMatchShouldPopulateEventError() + public function testRenderAndFinishShouldTriggerRunEvenIfRouteEventSetsError() { - $application = $this->setupBadController(); - $router = new Router\SimpleRouteStack(); - $event = $application->getMvcEvent(); - $event->setRouter($router); - - $response = $application->getResponse(); - $events = $application->getEventManager(); - $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($response) { - $error = $e->getError(); - $response->setContent("Code: " . $error); - return $response; - }); - - $application->run(); - $this->assertTrue($event->isError()); - $this->assertEquals(Application::ERROR_ROUTER_NO_MATCH, $event->getError()); + $this->application->bootstrap(); + + $expected = [ + MvcEvent::EVENT_ROUTE, + MvcEvent::EVENT_RENDER, + MvcEvent::EVENT_FINISH, + ]; + $triggered = []; + $this->application->getEventManager()->attach( + '*', + function (MvcEvent $e) use (&$triggered) { + $triggered[] = $e->getName(); + }, + 100 + ); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_ROUTE, + function (MvcEvent $e) { + $e->setError('Route error'); + } + ); + + $request = new ServerRequest([], [], 'http://example.local/', 'GET', 'php://memory'); + $this->application->handle($request); + $this->assertEquals($expected, $triggered); } /** * @group ZF2-171 */ - public function testFinishShouldRunEvenIfRouteEventReturnsResponse() + public function testFinishShouldTriggerEvenIfDispatchEventReturnsResponse() { $this->application->bootstrap(); - $response = $this->application->getResponse(); - $events = $this->application->getEventManager(); - $events->attach(MvcEvent::EVENT_ROUTE, function ($e) use ($response) { - return $response; - }, 100); - - $token = new stdClass; - $events->attach(MvcEvent::EVENT_FINISH, function ($e) use ($token) { - $token->foo = 'bar'; - }); - - $this->application->run(); - $this->assertTrue(isset($token->foo)); - $this->assertEquals('bar', $token->foo); + + $expected = [ + MvcEvent::EVENT_ROUTE, + MvcEvent::EVENT_DISPATCH, + MvcEvent::EVENT_FINISH, + ]; + $triggered = []; + $this->application->getEventManager()->attach( + '*', + function (MvcEvent $e) use (&$triggered) { + $triggered[] = $e->getName(); + }, + 100 + ); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_DISPATCH, + function (MvcEvent $e) { + return new Response(); + } + ); + + $request = new ServerRequest([], [], 'http://example.local/', 'GET', 'php://memory'); + $this->application->handle($request); + $this->assertEquals($expected, $triggered); } /** * @group ZF2-171 */ - public function testFinishShouldRunEvenIfDispatchEventReturnsResponse() + public function testRenderAndFinishShouldTriggerEvenIfDispatchEventSetsError() { $this->application->bootstrap(); - $response = $this->application->getResponse(); - $events = $this->application->getEventManager(); - $events->clearListeners(MvcEvent::EVENT_ROUTE); - $events->attach(MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { - return $response; - }, 100); - - $token = new stdClass; - $events->attach(MvcEvent::EVENT_FINISH, function ($e) use ($token) { - $token->foo = 'bar'; - }); - - $this->application->run(); - $this->assertTrue(isset($token->foo)); - $this->assertEquals('bar', $token->foo); - } - public function testApplicationShouldBeEventTargetAtFinishEvent() - { - $application = $this->setupActionController(); - - $events = $application->getEventManager(); - $response = $application->getResponse(); - $events->attach(MvcEvent::EVENT_FINISH, function ($e) use ($response) { - $response->setContent("EventClass: " . get_class($e->getTarget())); - return $response; - }); + $expected = [ + MvcEvent::EVENT_ROUTE, + MvcEvent::EVENT_DISPATCH, + MvcEvent::EVENT_RENDER, + MvcEvent::EVENT_FINISH, + ]; + $triggered = []; + $this->application->getEventManager()->attach( + '*', + function (MvcEvent $e) use (&$triggered) { + $triggered[] = $e->getName(); + }, + 100 + ); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_DISPATCH, + function (MvcEvent $e) { + $e->setError('Dispatch error'); + } + ); - $application->run(); - $this->assertContains(Application::class, $response->getContent()); + $request = new ServerRequest([], [], 'http://example.local/', 'GET', 'php://memory'); + $this->application->handle($request); + $this->assertEquals($expected, $triggered); } - public function testOnDispatchErrorEventPassedToTriggersShouldBeTheOriginalOne() + public function testApplicationShouldBeEventTargetAtFinishEvent() { - $application = $this->setupPathController(false); - $controllerManager = $application->getServiceManager()->get('ControllerManager'); - $model = $this->createMock(ViewModel::class); - $application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($model) { - $e->setResult($model); - }); - - $application->run(); - $event = $application->getMvcEvent(); - $this->assertInstanceOf(ViewModel::class, $event->getResult()); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_FINISH, + function (MvcEvent $e) { + $this->assertSame($this->application, $e->getTarget()); + } + ); + + $request = new ServerRequest([], [], 'http://example.local/sample', 'GET', 'php://memory'); + $this->application->handle($request); } /** @@ -505,22 +440,22 @@ public function testReturnsResponseFromListenerWhenRouteEventShortCircuits() { $this->application->bootstrap(); $testResponse = new Response(); - $response = $this->application->getResponse(); - $events = $this->application->getEventManager(); - $events->clearListeners(MvcEvent::EVENT_DISPATCH); - $events->attach(MvcEvent::EVENT_ROUTE, function ($e) use ($testResponse) { - $testResponse->setContent('triggered'); - return $testResponse; - }, 100); - - $triggered = false; - $events->attach(MvcEvent::EVENT_FINISH, function ($e) use ($testResponse, &$triggered) { - $this->assertSame($testResponse, $e->getResponse()); - $triggered = true; - }); - - $this->application->run(); - $this->assertTrue($triggered); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_ROUTE, + function ($e) use ($testResponse) { + return $testResponse; + } + ); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_FINISH, + function (MvcEvent $e) use ($testResponse) { + $this->assertSame($testResponse, $e->getResponse()); + } + ); + + $request = new ServerRequest([], [], 'http://example.local/sample', 'GET', 'php://memory'); + $response = $this->application->handle($request); + $this->assertSame($testResponse, $response); } /** @@ -530,108 +465,22 @@ public function testReturnsResponseFromListenerWhenDispatchEventShortCircuits() { $this->application->bootstrap(); $testResponse = new Response(); - $response = $this->application->getResponse(); - $events = $this->application->getEventManager(); - $events->clearListeners(MvcEvent::EVENT_ROUTE); - $events->attach(MvcEvent::EVENT_DISPATCH, function ($e) use ($testResponse) { - $testResponse->setContent('triggered'); - return $testResponse; - }, 100); - - $triggered = false; - $events->attach(MvcEvent::EVENT_FINISH, function ($e) use ($testResponse, &$triggered) { - $this->assertSame($testResponse, $e->getResponse()); - $triggered = true; - }); - - $this->application->run(); - $this->assertTrue($triggered); - } - - public function testCompleteRequestShouldReturnApplicationInstance() - { - $r = new ReflectionMethod($this->application, 'completeRequest'); - $r->setAccessible(true); - - $this->application->bootstrap(); - $event = $this->application->getMvcEvent(); - $result = $r->invoke($this->application, $event); - $this->assertSame($this->application, $result); - } - - public function testFailedRoutingShouldBePreventable() - { - $this->application->bootstrap(); - - $response = $this->createMock(ResponseInterface::class); - $finishMock = $this->getMockBuilder(stdClass::class) - ->setMethods(['__invoke']) - ->getMock(); - $routeMock = $this->getMockBuilder(stdClass::class) - ->setMethods(['__invoke']) - ->getMock(); - $dispatchMock = $this->getMockBuilder(stdClass::class) - ->setMethods(['__invoke']) - ->getMock(); - - $routeMock->expects($this->once())->method('__invoke')->will($this->returnCallback(function (MvcEvent $event) { - $event->stopPropagation(true); - $event->setRouteMatch(new Router\RouteMatch([])); - })); - $dispatchMock->expects($this->once())->method('__invoke')->will($this->returnValue($response)); - $finishMock->expects($this->once())->method('__invoke')->will($this->returnCallback(function (MvcEvent $event) { - $event->stopPropagation(true); - })); - - $this->application->getEventManager()->attach(MvcEvent::EVENT_ROUTE, $routeMock, 100); - $this->application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH, $dispatchMock, 100); - $this->application->getEventManager()->attach(MvcEvent::EVENT_FINISH, $finishMock, 100); - - $this->application->run(); - $this->assertSame($response, $this->application->getMvcEvent()->getResponse()); - } - - public function testCanRecoverFromApplicationError() - { - $this->application->bootstrap(); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_DISPATCH, + function ($e) use ($testResponse) { + return $testResponse; + } + ); + $this->application->getEventManager()->attach( + MvcEvent::EVENT_FINISH, + function (MvcEvent $e) use ($testResponse) { + $this->assertSame($testResponse, $e->getResponse()); + } + ); - $response = $this->createMock(ResponseInterface::class); - $errorMock = $this->getMockBuilder(stdClass::class) - ->setMethods(['__invoke']) - ->getMock(); - $finishMock = $this->getMockBuilder(stdClass::class) - ->setMethods(['__invoke']) - ->getMock(); - $routeMock = $this->getMockBuilder(stdClass::class) - ->setMethods(['__invoke']) - ->getMock(); - $dispatchMock = $this->getMockBuilder(stdClass::class) - ->setMethods(['__invoke']) - ->getMock(); - - $errorMock->expects($this->once())->method('__invoke')->will($this->returnCallback(function (MvcEvent $event) { - $event->stopPropagation(true); - $event->setRouteMatch(new Router\RouteMatch([])); - $event->setError(''); - })); - $routeMock->expects($this->once())->method('__invoke')->will($this->returnCallback(function (MvcEvent $event) { - $event->stopPropagation(true); - $event->setName(MvcEvent::EVENT_DISPATCH_ERROR); - $event->setError(Application::ERROR_ROUTER_NO_MATCH); - return $event->getApplication()->getEventManager()->triggerEvent($event)->last(); - })); - $dispatchMock->expects($this->once())->method('__invoke')->will($this->returnValue($response)); - $finishMock->expects($this->once())->method('__invoke')->will($this->returnCallback(function (MvcEvent $event) { - $event->stopPropagation(true); - })); - - $this->application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, $errorMock, 100); - $this->application->getEventManager()->attach(MvcEvent::EVENT_ROUTE, $routeMock, 100); - $this->application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH, $dispatchMock, 100); - $this->application->getEventManager()->attach(MvcEvent::EVENT_FINISH, $finishMock, 100); - - $this->application->run(); - $this->assertSame($response, $this->application->getMvcEvent()->getResponse()); + $request = new ServerRequest([], [], 'http://example.local/sample', 'GET', 'php://memory'); + $response = $this->application->handle($request); + $this->assertSame($testResponse, $response); } public function eventPropagation() @@ -647,37 +496,33 @@ public function eventPropagation() */ public function testEventPropagationStatusIsClearedBetweenEventsDuringRun($events) { - $event = new MvcEvent(); - $event->setTarget($this->application); - $event->setApplication($this->application) - ->setRequest($this->application->getRequest()) - ->setResponse($this->application->getResponse()) - ->setRouter($this->serviceManager->get('Router')); + $this->application->bootstrap(); + $event = $this->application->getMvcEvent(); $event->stopPropagation(true); - // Intentionally not calling bootstrap; setting mvc event - $r = new ReflectionProperty($this->application, 'event'); - $r->setAccessible(true); - $r->setValue($this->application, $event); - // Setup listeners that stop propagation, but do nothing else $marker = []; foreach ($events as $event) { $marker[$event] = true; } - $marker = (object) $marker; - $listener = function ($e) use ($marker) { - $marker->{$e->getName()} = $e->propagationIsStopped(); + $listener = function (MvcEvent $e) use (&$marker) { + $marker[$e->getName()] = $e->propagationIsStopped(); $e->stopPropagation(true); }; foreach ($events as $event) { $this->application->getEventManager()->attach($event, $listener); } - $this->application->run(); + $request = new ServerRequest([], [], 'http://example.local/sample', 'GET', 'php://memory'); + $this->application->handle($request); foreach ($events as $event) { - $this->assertFalse($marker->{$event}, sprintf('Assertion failed for event "%s"', $event)); + $this->assertFalse($marker[$event], sprintf('Assertion failed for event "%s"', $event)); } } + + public function testBadRequestShouldEmitAppropriateResponse() + { + $this->markTestIncomplete('Not implemented'); + } } diff --git a/test/ConfigProviderTest.php b/test/ConfigProviderTest.php new file mode 100644 index 000000000..feb3ff4b4 --- /dev/null +++ b/test/ConfigProviderTest.php @@ -0,0 +1,41 @@ +provider = new ConfigProvider(); + } + + public function testInvocationReturnsArray() + { + $config = ($this->provider)(); + $this->assertInternalType('array', $config); + return $config; + } + + /** + * @depends testInvocationReturnsArray + */ + public function testReturnedArrayContainsDependencies(array $config) + { + $this->assertArrayHasKey('dependencies', $config); + $this->assertInternalType('array', $config['dependencies']); + } +} diff --git a/test/Container/ApplicationFactoryTest.php b/test/Container/ApplicationFactoryTest.php new file mode 100644 index 000000000..4b5989df5 --- /dev/null +++ b/test/Container/ApplicationFactoryTest.php @@ -0,0 +1,97 @@ +container = $this->mockContainerInterface(); + $this->factory = new ApplicationFactory(); + + $this->router = $this->prophesize(RouteStackInterface::class); + $this->events = $this->prophesize(EventManagerInterface::class); + + $this->injectServiceInContainer($this->container, 'Zend\Mvc\Router', $this->router); + $this->injectServiceInContainer($this->container, 'EventManager', $this->events); + $this->injectServiceInContainer($this->container, 'config', []); + } + public function testInjectsListenersFromConfig() + { + // application default listeners + $route = $this->prophesize(RouteListener::class); + $this->injectServiceInContainer($this->container, RouteListener::class, $route->reveal()); + $dispatch = $this->prophesize(DispatchListener::class); + $this->injectServiceInContainer($this->container, DispatchListener::class, $dispatch->reveal()); + $middleware = $this->prophesize(MiddlewareListener::class); + $this->injectServiceInContainer($this->container, MiddlewareListener::class, $middleware->reveal()); + $viewManager = $this->prophesize(ViewManager::class); + $this->injectServiceInContainer($this->container, ViewManager::class, $viewManager->reveal()); + $httpMethod = $this->prophesize(HttpMethodListener::class); + $this->injectServiceInContainer($this->container, HttpMethodListener::class, $httpMethod->reveal()); + + + $listener = $this->prophesize(ListenerAggregateInterface::class); + $listener->attach($this->events)->shouldBecalled(); + $this->injectServiceInContainer($this->container, 'listenerToInject', $listener->reveal()); + $this->injectServiceInContainer( + $this->container, + 'config', + [ + Application::class => [ + 'listeners' => ['listenerToInject'] + ] + ] + ); + + $app = $this->factory->__invoke($this->container->reveal(), Application::class); + $app->bootstrap(); + } +} diff --git a/test/Container/ControllerManagerFactoryTest.php b/test/Container/ControllerManagerFactoryTest.php new file mode 100644 index 000000000..db867796b --- /dev/null +++ b/test/Container/ControllerManagerFactoryTest.php @@ -0,0 +1,65 @@ +container = $this->mockContainerInterface(); + $this->factory = new ControllerManagerFactory(); + } + + public function testInjectsContainerIntoControllerManager() + { + $container = $this->container->reveal(); + $controllerManager = $this->factory->__invoke($container, ControllerManager::class); + $controllerManager->setFactory('Foo', function ($injectedContainer) use ($container) { + $this->assertSame($container, $injectedContainer); + return $this->prophesize(Dispatchable::class)->reveal(); + }); + $controllerManager->get('Foo'); + } + + public function testPullsControllersConfigFromConfigService() + { + $this->injectServiceInContainer($this->container, 'config', [ + 'controllers' => [ + 'factories' => [ + 'Foo' => function () { + }, + ] + ] + ]); + $controllerManager = $this->factory->__invoke($this->container->reveal(), ControllerManager::class); + $this->assertTrue($controllerManager->has('Foo')); + } +} diff --git a/test/Container/ControllerPluginManagerFactoryTest.php b/test/Container/ControllerPluginManagerFactoryTest.php new file mode 100644 index 000000000..f2a85f10f --- /dev/null +++ b/test/Container/ControllerPluginManagerFactoryTest.php @@ -0,0 +1,65 @@ +container = $this->mockContainerInterface(); + $this->factory = new ControllerPluginManagerFactory(); + } + + public function testInjectsContainerIntoPluginManager() + { + $container = $this->container->reveal(); + $pluginManager = $this->factory->__invoke($container, PluginManager::class); + $pluginManager->setFactory('Foo', function ($injectedContainer) use ($container) { + $this->assertSame($container, $injectedContainer); + return $this->prophesize(PluginInterface::class)->reveal(); + }); + $pluginManager->get('Foo'); + } + + public function testPullsPluginsConfigFromConfigService() + { + $this->injectServiceInContainer($this->container, 'config', [ + 'controller_plugins' => [ + 'factories' => [ + 'Foo' => function () { + }, + ] + ] + ]); + $pluginManager = $this->factory->__invoke($this->container->reveal(), PluginManager::class); + $this->assertTrue($pluginManager->has('Foo')); + } +} diff --git a/test/Container/DispatchListenerFactoryTest.php b/test/Container/DispatchListenerFactoryTest.php new file mode 100644 index 000000000..c9a2cb030 --- /dev/null +++ b/test/Container/DispatchListenerFactoryTest.php @@ -0,0 +1,37 @@ +mockContainerInterface(); + $this->injectServiceInContainer( + $container, + ControllerManager::class, + $this->prophesize(ControllerManager::class)->reveal() + ); + $factory = new DispatchListenerFactory(); + + $listener = $factory->__invoke($container->reveal(), DispatchListener::class); + $this->assertInstanceOf(DispatchListener::class, $listener); + } +} diff --git a/test/Container/EventManagerFactoryTest.php b/test/Container/EventManagerFactoryTest.php new file mode 100644 index 000000000..2e14d1bcb --- /dev/null +++ b/test/Container/EventManagerFactoryTest.php @@ -0,0 +1,44 @@ +mockContainerInterface(); + $factory = new EventManagerFactory(); + + $events = $factory->__invoke($container->reveal(), 'EventManager'); + $this->assertInstanceOf(EventManager::class, $events); + } + + public function testInjectsSharedEventManagerIfAvailable() + { + $container = $this->mockContainerInterface(); + $factory = new EventManagerFactory(); + $shared = new SharedEventManager(); + $this->injectServiceInContainer($container, 'SharedEventManager', $shared); + + $events = $factory->__invoke($container->reveal(), 'EventManager'); + $this->assertSame($shared, $events->getSharedManager()); + } +} diff --git a/test/Service/HttpMethodListenerFactoryTest.php b/test/Container/HttpMethodListenerFactoryTest.php similarity index 54% rename from test/Service/HttpMethodListenerFactoryTest.php rename to test/Container/HttpMethodListenerFactoryTest.php index 230ad0ae4..441c22eb2 100644 --- a/test/Service/HttpMethodListenerFactoryTest.php +++ b/test/Container/HttpMethodListenerFactoryTest.php @@ -5,34 +5,42 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace ZendTest\Mvc\Service; +declare(strict_types=1); + +namespace ZendTest\Mvc\Container; -use Interop\Container\ContainerInterface; use PHPUnit\Framework\TestCase; -use PHPUnit_Framework_MockObject_MockObject as MockObject; -use Zend\Mvc\Service\HttpMethodListenerFactory; -use Zend\ServiceManager\ServiceLocatorInterface; +use Prophecy\Prophecy\ObjectProphecy; +use Zend\Mvc\Container\HttpMethodListenerFactory; +use Zend\Mvc\HttpMethodListener; +use ZendTest\Mvc\ContainerTrait; /** - * @covers Zend\Mvc\Service\HttpMethodListenerFactory + * @covers \Zend\Mvc\Container\HttpMethodListenerFactory */ class HttpMethodListenerFactoryTest extends TestCase { + use ContainerTrait; + + /** + * @var ObjectProphecy + */ + protected $container; + /** - * @var ServiceLocatorInterface|MockObject + * @var HttpMethodListenerFactory */ - protected $serviceLocator; + private $factory; public function setUp() { - $this->serviceLocator = $this->prophesize(ServiceLocatorInterface::class); - $this->serviceLocator->willImplement(ContainerInterface::class); + $this->container = $this->mockContainerInterface(); + $this->factory = new HttpMethodListenerFactory(); } public function testCreateWithDefaults() { - $factory = new HttpMethodListenerFactory(); - $listener = $factory($this->serviceLocator->reveal(), 'HttpMethodListener'); + $listener = $this->factory->__invoke($this->container->reveal(), HttpMethodListener::class); $this->assertTrue($listener->isEnabled()); $this->assertNotEmpty($listener->getAllowedMethods()); } @@ -44,10 +52,9 @@ public function testCreateWithConfig() 'allowed_methods' => ['FOO', 'BAR'] ]; - $this->serviceLocator->get('config')->willReturn($config); + $this->injectServiceInContainer($this->container, 'config', $config); - $factory = new HttpMethodListenerFactory(); - $listener = $factory($this->serviceLocator->reveal(), 'HttpMethodListener'); + $listener = $this->factory->__invoke($this->container->reveal(), HttpMethodListener::class); $listenerConfig = $config['http_methods_listener']; diff --git a/test/Service/InjectTemplateListenerFactoryTest.php b/test/Container/InjectTemplateListenerFactoryTest.php similarity index 76% rename from test/Service/InjectTemplateListenerFactoryTest.php rename to test/Container/InjectTemplateListenerFactoryTest.php index 2fb0b4e0d..aa6e5a73f 100644 --- a/test/Service/InjectTemplateListenerFactoryTest.php +++ b/test/Container/InjectTemplateListenerFactoryTest.php @@ -5,22 +5,26 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace ZendTest\Mvc\Service; +declare(strict_types=1); + +namespace ZendTest\Mvc\Container; use ArrayObject; -use Interop\Container\ContainerInterface; use PHPUnit\Framework\TestCase; -use Zend\Mvc\Service\InjectTemplateListenerFactory; +use Zend\Mvc\Container\InjectTemplateListenerFactory; use Zend\Mvc\View\Http\InjectTemplateListener; -use Zend\ServiceManager\ServiceLocatorInterface; +use ZendTest\Mvc\ContainerTrait; /** - * Tests for {@see \Zend\Mvc\Service\InjectTemplateListenerFactory} + * Tests for {@see \Zend\Mvc\Container\InjectTemplateListenerFactory} * - * @covers \Zend\Mvc\Service\InjectTemplateListenerFactory + * @covers \Zend\Mvc\Container\InjectTemplateListenerFactory + * @covers \Zend\Mvc\Container\ViewManagerConfigTrait */ class InjectTemplateListenerFactoryTest extends TestCase { + use ContainerTrait; + public function testFactoryCanCreateInjectTemplateListener() { $this->buildInjectTemplateListenerWithConfig([]); @@ -60,13 +64,11 @@ public function testFactoryCanSetControllerMapViaArrayAccessVM() */ private function buildInjectTemplateListenerWithConfig($config) { - $serviceLocator = $this->prophesize(ServiceLocatorInterface::class); - $serviceLocator->willImplement(ContainerInterface::class); - - $serviceLocator->get('config')->willReturn($config); + $container = $this->mockContainerInterface(); + $this->injectServiceInContainer($container, 'config', $config); $factory = new InjectTemplateListenerFactory(); - $listener = $factory($serviceLocator->reveal(), 'InjectTemplateListener'); + $listener = $factory($container->reveal(), 'InjectTemplateListener'); $this->assertInstanceOf(InjectTemplateListener::class, $listener); diff --git a/test/Service/ViewFeedStrategyFactoryTest.php b/test/Container/ViewFeedStrategyFactoryTest.php similarity index 58% rename from test/Service/ViewFeedStrategyFactoryTest.php rename to test/Container/ViewFeedStrategyFactoryTest.php index d6f24b7e9..223313df6 100644 --- a/test/Service/ViewFeedStrategyFactoryTest.php +++ b/test/Container/ViewFeedStrategyFactoryTest.php @@ -5,30 +5,32 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace ZendTest\Mvc\Service; +declare(strict_types=1); + +namespace ZendTest\Mvc\Container; -use Interop\Container\ContainerInterface; use PHPUnit\Framework\TestCase; -use Zend\Mvc\Service\ViewFeedStrategyFactory; +use Zend\Mvc\Container\ViewFeedStrategyFactory; use Zend\View\Renderer\FeedRenderer; use Zend\View\Strategy\FeedStrategy; +use ZendTest\Mvc\ContainerTrait; +/** + * @covers \Zend\Mvc\Container\ViewFeedStrategyFactory + */ class ViewFeedStrategyFactoryTest extends TestCase { - private function createContainer() - { - $renderer = $this->prophesize(FeedRenderer::class); - $container = $this->prophesize(ContainerInterface::class); - $container->get('ViewFeedRenderer')->will(function () use ($renderer) { - return $renderer->reveal(); - }); - return $container->reveal(); - } + use ContainerTrait; public function testReturnsFeedStrategy() { + $container = $this->mockContainerInterface(); + $renderer = $this->prophesize(FeedRenderer::class); + $this->injectServiceInContainer($container, FeedRenderer::class, $renderer->reveal()); + $factory = new ViewFeedStrategyFactory(); - $result = $factory($this->createContainer(), 'ViewFeedStrategy'); + + $result = $factory($container->reveal(), 'ViewFeedStrategy'); $this->assertInstanceOf(FeedStrategy::class, $result); } } diff --git a/test/Service/ViewHelperManagerFactoryTest.php b/test/Container/ViewHelperManagerFactoryTest.php similarity index 94% rename from test/Service/ViewHelperManagerFactoryTest.php rename to test/Container/ViewHelperManagerFactoryTest.php index fc9b3a15b..68e854fec 100644 --- a/test/Service/ViewHelperManagerFactoryTest.php +++ b/test/Container/ViewHelperManagerFactoryTest.php @@ -5,19 +5,23 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace ZendTest\Mvc\Service; +declare(strict_types=1); + +namespace ZendTest\Mvc\Container; use PHPUnit\Framework\TestCase; -use Zend\Http\PhpEnvironment\Request; use Zend\Mvc\Application; +use Zend\Mvc\Container\ViewHelperManagerFactory; use Zend\Mvc\MvcEvent; -use Zend\Mvc\Service\ViewHelperManagerFactory; -use Zend\Router\RouteMatch; use Zend\Router\RouteStackInterface; use Zend\ServiceManager\ServiceManager; use Zend\View\Helper; use Zend\View\HelperPluginManager; +/** + * @covers \Zend\Mvc\Container\ViewHelperManagerFactory + * @covers \Zend\Mvc\Container\ViewManagerConfigTrait + */ class ViewHelperManagerFactoryTest extends TestCase { public function setUp() @@ -133,6 +137,7 @@ public function basePathConfiguration() */ public function testBasePathHelperFactoryCanBeInvokedViaShortNameOrFullClassName($name, array $services, $expected) { + $this->markTestIncomplete('Base path handling changed. Needs new tests'); foreach ($services as $key => $value) { if (is_callable($value)) { $this->services->setFactory($key, $value); diff --git a/test/Service/ViewJsonStrategyFactoryTest.php b/test/Container/ViewJsonStrategyFactoryTest.php similarity index 58% rename from test/Service/ViewJsonStrategyFactoryTest.php rename to test/Container/ViewJsonStrategyFactoryTest.php index 0768537c9..b67a43e63 100644 --- a/test/Service/ViewJsonStrategyFactoryTest.php +++ b/test/Container/ViewJsonStrategyFactoryTest.php @@ -5,30 +5,31 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace ZendTest\Mvc\Service; +declare(strict_types=1); + +namespace ZendTest\Mvc\Container; -use Interop\Container\ContainerInterface; use PHPUnit\Framework\TestCase; -use Zend\Mvc\Service\ViewJsonStrategyFactory; +use Zend\Mvc\Container\ViewJsonStrategyFactory; use Zend\View\Renderer\JsonRenderer; use Zend\View\Strategy\JsonStrategy; +use ZendTest\Mvc\ContainerTrait; +/** + * @covers \Zend\Mvc\Container\ViewJsonStrategyFactory + */ class ViewJsonStrategyFactoryTest extends TestCase { - private function createContainer() - { - $renderer = $this->prophesize(JsonRenderer::class); - $container = $this->prophesize(ContainerInterface::class); - $container->get('ViewJsonRenderer')->will(function () use ($renderer) { - return $renderer->reveal(); - }); - return $container->reveal(); - } + use ContainerTrait; public function testReturnsJsonStrategy() { + $container = $this->mockContainerInterface(); + $renderer = $this->prophesize(JsonRenderer::class); + $this->injectServiceInContainer($container, JsonRenderer::class, $renderer->reveal()); + $factory = new ViewJsonStrategyFactory(); - $result = $factory($this->createContainer(), 'ViewJsonStrategy'); + $result = $factory($container->reveal(), JsonStrategy::class); $this->assertInstanceOf(JsonStrategy::class, $result); } } diff --git a/test/Service/ViewPrefixPathStackResolverFactoryTest.php b/test/Container/ViewPrefixPathStackResolverFactoryTest.php similarity index 60% rename from test/Service/ViewPrefixPathStackResolverFactoryTest.php rename to test/Container/ViewPrefixPathStackResolverFactoryTest.php index e0dedba2c..19d6f0341 100644 --- a/test/Service/ViewPrefixPathStackResolverFactoryTest.php +++ b/test/Container/ViewPrefixPathStackResolverFactoryTest.php @@ -5,22 +5,29 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ -namespace ZendTest\Mvc\Service; +declare(strict_types=1); + +namespace ZendTest\Mvc\Container; -use Interop\Container\ContainerInterface; use PHPUnit\Framework\TestCase; -use Zend\Mvc\Service\ViewPrefixPathStackResolverFactory; -use Zend\ServiceManager\ServiceLocatorInterface; +use Zend\Mvc\Container\ViewPrefixPathStackResolverFactory; use Zend\View\Resolver\PrefixPathStackResolver; +use ZendTest\Mvc\ContainerTrait; +/** + * + * @covers \Zend\Mvc\Container\ViewPrefixPathStackResolverFactory + * @covers \Zend\Mvc\Container\ViewManagerConfigTrait + */ class ViewPrefixPathStackResolverFactoryTest extends TestCase { + use ContainerTrait; + public function testCreateService() { - $serviceLocator = $this->prophesize(ServiceLocatorInterface::class); - $serviceLocator->willImplement(ContainerInterface::class); + $container = $this->mockContainerInterface(); - $serviceLocator->get('config')->willReturn([ + $this->injectServiceInContainer($container, 'config', [ 'view_manager' => [ 'prefix_template_path_stack' => [ 'album/' => [], @@ -29,7 +36,7 @@ public function testCreateService() ]); $factory = new ViewPrefixPathStackResolverFactory(); - $resolver = $factory($serviceLocator->reveal(), 'ViewPrefixPathStackResolver'); + $resolver = $factory($container->reveal(), 'ViewPrefixPathStackResolver'); $this->assertInstanceOf(PrefixPathStackResolver::class, $resolver); } diff --git a/test/ContainerTrait.php b/test/ContainerTrait.php new file mode 100644 index 000000000..05e78cbf7 --- /dev/null +++ b/test/ContainerTrait.php @@ -0,0 +1,53 @@ +prophesize(ContainerInterface::class); + $container->has(Argument::type('string'))->willReturn(false); + + return $container; + } + + /** + * Inject a service into the container mock. + * + * Adjust `has('service')` and `get('service')` returns. + * + * @param ObjectProphecy $container + * @param string $serviceName + * @param mixed $service + * @return void + */ + protected function injectServiceInContainer(ObjectProphecy $container, $serviceName, $service) + { + $container->has($serviceName)->willReturn(true); + $container->get($serviceName)->willReturn($service); + } +} diff --git a/test/Controller/AbstractControllerTest.php b/test/Controller/AbstractControllerTest.php index c7a2f2867..ee3adac04 100644 --- a/test/Controller/AbstractControllerTest.php +++ b/test/Controller/AbstractControllerTest.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller; use PHPUnit\Framework\TestCase; @@ -12,8 +14,8 @@ use Zend\EventManager\EventManagerAwareInterface; use Zend\EventManager\EventManagerInterface; use Zend\Mvc\Controller\AbstractController; +use Zend\Mvc\Controller\Dispatchable; use Zend\Mvc\InjectApplicationEventInterface; -use Zend\Stdlib\DispatchableInterface; /** * @covers \Zend\Mvc\Controller\AbstractController @@ -101,7 +103,7 @@ public function testSetEventManagerWithDefaultIdentifiersIncludesImplementedInte ->method('setIdentifiers') ->with($this->logicalAnd( $this->contains(EventManagerAwareInterface::class), - $this->contains(DispatchableInterface::class), + $this->contains(Dispatchable::class), $this->contains(InjectApplicationEventInterface::class) )); diff --git a/test/Controller/ActionControllerTest.php b/test/Controller/ActionControllerTest.php index c1d5f0dc0..503bb74d8 100644 --- a/test/Controller/ActionControllerTest.php +++ b/test/Controller/ActionControllerTest.php @@ -5,23 +5,25 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller; use PHPUnit\Framework\TestCase; use ReflectionClass; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManager; use Zend\EventManager\SharedEventManager; use Zend\EventManager\SharedEventManagerInterface; -use Zend\Http\Request; -use Zend\Http\Response; use Zend\Mvc\Controller\AbstractActionController; +use Zend\Mvc\Controller\Dispatchable; use Zend\Mvc\Controller\Plugin\Url; use Zend\Mvc\Controller\PluginManager; use Zend\Mvc\InjectApplicationEventInterface; use Zend\Mvc\MvcEvent; -use Zend\Router\RouteMatch; +use Zend\Router\RouteResult; use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\DispatchableInterface; use Zend\View\Model\ModelInterface; use ZendTest\Mvc\Controller\TestAsset\SampleController; use ZendTest\Mvc\Controller\TestAsset\SampleInterface; @@ -31,16 +33,17 @@ class ActionControllerTest extends TestCase public $controller; public $event; public $request; - public $response; + public $sharedEvents; + public $routeResult; + public $events; public function setUp() { $this->controller = new SampleController(); - $this->request = new Request(); - $this->response = null; - $this->routeMatch = new RouteMatch(['controller' => 'controller-sample']); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $routeResult = RouteResult::fromRouteMatch(['controller' => 'controller-sample']); + $this->request = $request->withAttribute(RouteResult::class, $routeResult); $this->event = new MvcEvent(); - $this->event->setRouteMatch($this->routeMatch); $this->controller->setEvent($this->event); $this->sharedEvents = new SharedEventManager(); @@ -48,6 +51,17 @@ public function setUp() $this->controller->setEventManager($this->events); } + public function requestWithMatchedParams(ServerRequest $request, array $params) + { + /** @var RouteResult $routeResult */ + $routeResult = $request->getAttribute(RouteResult::class); + $routeResult = $routeResult->withMatchedParams(\array_merge($routeResult->getMatchedParams(), $params)); + foreach ($params as $name => $param) { + $request = $request->withAttribute($name, $param); + } + return $request->withAttribute(RouteResult::class, $routeResult); + } + /** * @param SharedEventManager * @return EventManager @@ -59,41 +73,41 @@ protected function createEventManager(SharedEventManagerInterface $sharedManager public function testDispatchInvokesNotFoundActionWhenNoActionPresentInRouteMatch() { - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $response = $this->controller->getResponse(); $this->assertEquals(404, $response->getStatusCode()); $this->assertInstanceOf(ModelInterface::class, $result); $this->assertEquals('content', $result->captureTo()); $vars = $result->getVariables(); - $this->assertArrayHasKey('content', $vars, var_export($vars, 1)); + $this->assertArrayHasKey('content', $vars, var_export($vars, true)); $this->assertContains('Page not found', $vars['content']); } public function testDispatchInvokesNotFoundActionWhenInvalidActionPresentInRouteMatch() { - $this->routeMatch->setParam('action', 'totally-made-up-action'); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->requestWithMatchedParams($this->request, ['action' => 'totally-made-up-action']); + $result = $this->controller->dispatch($request); $response = $this->controller->getResponse(); $this->assertEquals(404, $response->getStatusCode()); $this->assertInstanceOf(ModelInterface::class, $result); $this->assertEquals('content', $result->captureTo()); $vars = $result->getVariables(); - $this->assertArrayHasKey('content', $vars, var_export($vars, 1)); + $this->assertArrayHasKey('content', $vars, var_export($vars, true)); $this->assertContains('Page not found', $vars['content']); } public function testDispatchInvokesProvidedActionWhenMethodExists() { - $this->routeMatch->setParam('action', 'test'); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->requestWithMatchedParams($this->request, ['action' => 'test']); + $result = $this->controller->dispatch($request); $this->assertTrue(isset($result['content'])); $this->assertContains('test', $result['content']); } public function testDispatchCallsActionMethodBasedOnNormalizingAction() { - $this->routeMatch->setParam('action', 'test.some-strangely_separated.words'); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->requestWithMatchedParams($this->request, ['action' => 'test.some-strangely_separated.words']); + $result = $this->controller->dispatch($request); $this->assertTrue(isset($result['content'])); $this->assertContains('Test Some Strangely Separated Words', $result['content']); } @@ -101,76 +115,76 @@ public function testDispatchCallsActionMethodBasedOnNormalizingAction() public function testShortCircuitsBeforeActionIfPreDispatchReturnsAResponse() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $this->controller->getEventManager()->attach(MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { return $response; }, 100); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testPostDispatchEventAllowsReplacingResponse() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $this->controller->getEventManager()->attach(MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { return $response; }, -10); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testEventManagerListensOnDispatchableInterfaceByDefault() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $sharedEvents = $this->controller->getEventManager()->getSharedManager(); - $sharedEvents->attach(DispatchableInterface::class, MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { + $sharedEvents->attach(Dispatchable::class, MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { return $response; }, 10); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testEventManagerListensOnActionControllerClassByDefault() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $sharedEvents = $this->controller->getEventManager()->getSharedManager(); $sharedEvents->attach(AbstractActionController::class, MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { return $response; }, 10); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testEventManagerListensOnClassNameByDefault() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $sharedEvents = $this->controller->getEventManager()->getSharedManager(); $sharedEvents->attach(get_class($this->controller), MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { return $response; }, 10); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testEventManagerListensOnInterfaceName() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $sharedEvents = $this->controller->getEventManager()->getSharedManager(); $sharedEvents->attach(SampleInterface::class, MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { return $response; }, 10); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testDispatchInjectsEventIntoController() { - $this->controller->dispatch($this->request, $this->response); + $this->controller->dispatch($this->request); $event = $this->controller->getEvent(); $this->assertNotNull($event); $this->assertSame($this->event, $event); diff --git a/test/Controller/ControllerManagerTest.php b/test/Controller/ControllerManagerTest.php index b4aac9522..fca318db0 100644 --- a/test/Controller/ControllerManagerTest.php +++ b/test/Controller/ControllerManagerTest.php @@ -4,97 +4,128 @@ * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (http://www.zend.com) * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + +declare(strict_types=1); namespace ZendTest\Mvc\Controller; use PHPUnit\Framework\TestCase; -use ReflectionClass; +use Prophecy\Prophecy\ObjectProphecy; +use Psr\Container\ContainerInterface; use Zend\EventManager\EventManager; -use Zend\EventManager\EventManagerInterface; use Zend\EventManager\SharedEventManager; -use Zend\EventManager\SharedEventManagerInterface; use Zend\Mvc\Controller\ControllerManager; -use Zend\Mvc\Controller\PluginManager as ControllerPluginManager; -use Zend\ServiceManager\Config; -use Zend\ServiceManager\Exception\ServiceNotFoundException; -use Zend\ServiceManager\ServiceManager; +use Zend\Mvc\Controller\Dispatchable; +use Zend\Mvc\Controller\PluginManager; +use Zend\ServiceManager\Exception\InvalidServiceException; +use ZendTest\Mvc\ContainerTrait; use ZendTest\Mvc\Controller\TestAsset\SampleController; +/** + * @covers \Zend\Mvc\Controller\ControllerManager + */ class ControllerManagerTest extends TestCase { - public function setUp() - { - $this->sharedEvents = new SharedEventManager; - $this->events = $this->createEventManager($this->sharedEvents); - - $this->services = new ServiceManager(); - (new Config([ - 'factories' => [ - 'ControllerPluginManager' => function ($services) { - return new ControllerPluginManager($services); - }, - ], - 'services' => [ - 'EventManager' => $this->events, - 'SharedEventManager' => $this->sharedEvents, - ], - ]))->configureServiceManager($this->services); - - $this->controllers = new ControllerManager($this->services); - } + use ContainerTrait; + + /** + * @var ObjectProphecy|ContainerInterface + */ + private $container; /** - * @param SharedEventManager - * @return EventManager + * @var ObjectProphecy|PluginManager */ - protected function createEventManager(SharedEventManagerInterface $sharedManager) + private $plugins; + + /** + * @var SharedEventManager + */ + private $sharedEvents; + + /** + * @var EventManager + */ + private $events; + + /** + * @var ControllerManager + */ + private $controllers; + + /** + * @var SampleController + */ + private $controller; + + public function setUp() { - return new EventManager($sharedManager); + $this->container = $this->mockContainerInterface(); + $this->plugins = $this->prophesize(PluginManager::class); + $this->sharedEvents = new SharedEventManager(); + $this->events = new EventManager($this->sharedEvents); + + $this->injectServiceInContainer($this->container, 'EventManager', $this->events); + $this->injectServiceInContainer($this->container, PluginManager::class, $this->plugins->reveal()); + + $this->controllers = new ControllerManager($this->container->reveal()); + $this->controller = new SampleController(); + $this->controllers->setFactory(SampleController::class, function () { + return $this->controller; + }); } public function testCanInjectEventManager() { - $controller = new SampleController(); - - $this->controllers->injectEventManager($this->services, $controller); + $this->container->get('EventManager')->shouldBeCalled(); + $controller = $this->controllers->get(SampleController::class); // The default AbstractController implementation lazy instantiates an EM // instance, which means we need to check that that instance gets injected // with the shared EM instance. $events = $controller->getEventManager(); - $this->assertInstanceOf(EventManagerInterface::class, $events); - $this->assertSame($this->sharedEvents, $events->getSharedManager()); + $this->assertSame($events, $this->events); } public function testCanInjectPluginManager() { - $controller = new SampleController(); + $this->container->get(PluginManager::class)->shouldBeCalled(); + $controller = $this->controllers->get(SampleController::class); - $this->controllers->injectPluginManager($this->services, $controller); - - $this->assertSame($this->services->get('ControllerPluginManager'), $controller->getPluginManager()); + $this->assertSame($this->plugins->reveal(), $controller->getPluginManager()); } public function testInjectEventManagerWillNotOverwriteExistingEventManagerIfItAlreadyHasASharedManager() { - $events = $this->createEventManager($this->sharedEvents); - $controller = new SampleController(); - $controller->setEventManager($events); + $events = new EventManager($this->sharedEvents); + $this->controller->setEventManager($events); - $this->controllers->injectEventManager($this->services, $controller); + $this->container->get('EventManager')->shouldNotBeCalled(); + $controller = $this->controllers->get(SampleController::class); $this->assertSame($events, $controller->getEventManager()); $this->assertSame($this->sharedEvents, $events->getSharedManager()); } - /** - * @covers Zend\ServiceManager\ServiceManager::has - * @covers Zend\ServiceManager\AbstractPluginManager::get - */ - public function testDoNotUsePeeringServiceManagers() + public function testRequiresControllerToBeDispatchable() + { + $this->controllers->setFactory('Foo', function () { + return new \stdClass; + }); + + $this->expectException(InvalidServiceException::class); + $this->expectExceptionMessage(\sprintf('must implement %s', Dispatchable::class)); + $this->controllers->get('Foo'); + } + + public function testInitializersSkipIfDispatchableIsNotPluginOrEventAware() { - $this->assertFalse($this->controllers->has('EventManager')); - $this->expectException(ServiceNotFoundException::class); - $this->controllers->get('EventManager'); + $this->controllers->setFactory('Foo', function () { + return $this->prophesize(Dispatchable::class)->reveal(); + }); + + $this->controllers->get('Foo'); + $this->assertTrue(true, 'No assertions made, no errors expected'); } } diff --git a/test/Controller/IntegrationTest.php b/test/Controller/IntegrationTest.php index a6569a88a..8ce0d2594 100644 --- a/test/Controller/IntegrationTest.php +++ b/test/Controller/IntegrationTest.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller; use PHPUnit\Framework\TestCase; @@ -27,7 +29,7 @@ public function setUp() 'SharedEventManager' => $this->sharedEvents, ], 'factories' => [ - 'ControllerPluginManager' => function ($services) { + PluginManager::class => function ($services) { return new PluginManager($services); }, 'EventManager' => function () { diff --git a/test/Controller/LazyControllerAbstractFactoryTest.php b/test/Controller/LazyControllerAbstractFactoryTest.php index 6e3e385cc..037cfbbe8 100644 --- a/test/Controller/LazyControllerAbstractFactoryTest.php +++ b/test/Controller/LazyControllerAbstractFactoryTest.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller; use Interop\Container\ContainerInterface; diff --git a/test/Controller/MiddlewareControllerTest.php b/test/Controller/MiddlewareControllerTest.php index b76d1769b..83b9455a6 100644 --- a/test/Controller/MiddlewareControllerTest.php +++ b/test/Controller/MiddlewareControllerTest.php @@ -5,20 +5,23 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller; use PHPUnit\Framework\TestCase; use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManager; use Zend\EventManager\EventManagerInterface; -use Zend\Http\Request; -use Zend\Http\Response; use Zend\Mvc\Controller\AbstractController; +use Zend\Mvc\Controller\Dispatchable; use Zend\Mvc\Controller\MiddlewareController; -use Zend\Mvc\Exception\RuntimeException; use Zend\Mvc\MvcEvent; -use Zend\Stdlib\DispatchableInterface; -use Zend\Stdlib\RequestInterface; +use Zend\Stratigility\Middleware\CallableMiddlewareDecorator; use Zend\Stratigility\MiddlewarePipe; /** @@ -31,11 +34,6 @@ class MiddlewareControllerTest extends TestCase */ private $pipe; - /** - * @var ResponseInterface|\PHPUnit_Framework_MockObject_MockObject - */ - private $responsePrototype; - /** * @var EventManagerInterface */ @@ -56,7 +54,7 @@ class MiddlewareControllerTest extends TestCase */ protected function setUp() { - $this->pipe = $this->createMock(MiddlewarePipe::class); + $this->pipe = new MiddlewarePipe(); $this->responsePrototype = $this->createMock(ResponseInterface::class); $this->eventManager = $this->createMock(EventManagerInterface::class); $this->event = new MvcEvent(); @@ -64,7 +62,6 @@ protected function setUp() $this->controller = new MiddlewareController( $this->pipe, - $this->responsePrototype, $this->eventManager, $this->event ); @@ -76,13 +73,12 @@ public function testWillAssignCorrectEventManagerIdentifiers() self::assertContains(MiddlewareController::class, $identifiers); self::assertContains(AbstractController::class, $identifiers); - self::assertContains(DispatchableInterface::class, $identifiers); + self::assertContains(Dispatchable::class, $identifiers); } public function testWillDispatchARequestAndResponseWithAGivenPipe() { - $request = new Request(); - $response = new Response(); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); $result = $this->createMock(ResponseInterface::class); /* @var $dispatchListener callable|\PHPUnit_Framework_MockObject_MockObject */ $dispatchListener = $this->getMockBuilder(\stdClass::class)->setMethods(['__invoke'])->getMock(); @@ -95,51 +91,22 @@ public function testWillDispatchARequestAndResponseWithAGivenPipe() $dispatchListener ->expects(self::once()) ->method('__invoke') - ->with(self::callback(function (MvcEvent $event) use ($request, $response) { + ->with(self::callback(function (MvcEvent $event) use ($request) { self::assertSame($this->event, $event); self::assertSame(MvcEvent::EVENT_DISPATCH, $event->getName()); self::assertSame($this->controller, $event->getTarget()); self::assertSame($request, $event->getRequest()); - self::assertSame($response, $event->getResponse()); return true; })); - $this->pipe->expects(self::once())->method('process')->willReturn($result); + $this->pipe->pipe(new CallableMiddlewareDecorator(function () use ($result) { + return $result; + })); - $controllerResult = $this->controller->dispatch($request, $response); + $controllerResult = $this->controller->dispatch($request); self::assertSame($result, $controllerResult); self::assertSame($result, $this->event->getResult()); } - - public function testWillRefuseDispatchingInvalidRequestTypes() - { - /* @var $request RequestInterface */ - $request = $this->createMock(RequestInterface::class); - $response = new Response(); - /* @var $dispatchListener callable|\PHPUnit_Framework_MockObject_MockObject */ - $dispatchListener = $this->getMockBuilder(\stdClass::class)->setMethods(['__invoke'])->getMock(); - - $this->eventManager->attach(MvcEvent::EVENT_DISPATCH, $dispatchListener, 100); - - $dispatchListener - ->expects(self::once()) - ->method('__invoke') - ->with(self::callback(function (MvcEvent $event) use ($request, $response) { - self::assertSame($this->event, $event); - self::assertSame(MvcEvent::EVENT_DISPATCH, $event->getName()); - self::assertSame($this->controller, $event->getTarget()); - self::assertSame($request, $event->getRequest()); - self::assertSame($response, $event->getResponse()); - - return true; - })); - - $this->pipe->expects(self::never())->method('process'); - - $this->expectException(RuntimeException::class); - - $this->controller->dispatch($request, $response); - } } diff --git a/test/Controller/Plugin/AcceptableViewModelSelectorTest.php b/test/Controller/Plugin/AcceptableViewModelSelectorTest.php index 40320a29a..6457a0dd1 100644 --- a/test/Controller/Plugin/AcceptableViewModelSelectorTest.php +++ b/test/Controller/Plugin/AcceptableViewModelSelectorTest.php @@ -5,12 +5,14 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\ServerRequest; use Zend\Http\Header\Accept\FieldValuePart\AcceptFieldValuePart; use Zend\Mvc\Controller\Plugin\AcceptableViewModelSelector; -use Zend\Http\Request; use Zend\Mvc\Exception\InvalidArgumentException; use Zend\Mvc\MvcEvent; use Zend\Http\Header\Accept; @@ -21,7 +23,8 @@ class AcceptableViewModelSelectorTest extends TestCase { public function setUp() { - $this->request = new Request(); + return self::markTestIncomplete('Content negotiation part needs rewrite'); + $this->request = new ServerRequest([], [], null, 'GET', 'php://memory'); $event = new MvcEvent(); $event->setRequest($this->request); diff --git a/test/Controller/Plugin/CreateHttpNotFoundModelTest.php b/test/Controller/Plugin/CreateHttpNotFoundModelTest.php index 953f9166d..265323b7d 100644 --- a/test/Controller/Plugin/CreateHttpNotFoundModelTest.php +++ b/test/Controller/Plugin/CreateHttpNotFoundModelTest.php @@ -5,10 +5,11 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin; use PHPUnit\Framework\TestCase; -use Zend\Http\Response; use Zend\Mvc\Controller\Plugin\CreateHttpNotFoundModel; use Zend\View\Model\ViewModel; @@ -19,15 +20,13 @@ */ class CreateHttpNotFoundModelTest extends TestCase { - public function testBuildsModelWithErrorMessageAndSetsResponseStatusCode() + public function testBuildsModelWithErrorMessage() { - $response = new Response(); $plugin = new CreateHttpNotFoundModel(); - $model = $plugin->__invoke($response); + $model = $plugin->__invoke(); $this->assertInstanceOf(ViewModel::class, $model); $this->assertSame('Page not found', $model->getVariable('content')); - $this->assertSame(404, $response->getStatusCode()); } } diff --git a/test/Controller/Plugin/ForwardTest.php b/test/Controller/Plugin/ForwardTest.php index b8a928b96..e75313e2c 100644 --- a/test/Controller/Plugin/ForwardTest.php +++ b/test/Controller/Plugin/ForwardTest.php @@ -5,16 +5,18 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin; use PHPUnit\Framework\TestCase; use ReflectionClass; use stdClass; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManager; use Zend\EventManager\SharedEventManager; use Zend\EventManager\SharedEventManagerInterface; -use Zend\Http\Request; -use Zend\Http\Response; use Zend\Mvc\ApplicationInterface; use Zend\Mvc\Controller\ControllerManager; use Zend\Mvc\Controller\Plugin\Forward; @@ -23,7 +25,7 @@ use Zend\Mvc\Exception\DomainException; use Zend\Mvc\Exception\InvalidControllerException; use Zend\Mvc\MvcEvent; -use Zend\Router\RouteMatch; +use Zend\Router\RouteResult; use Zend\ServiceManager\Config; use Zend\ServiceManager\Exception\InvalidServiceException; use Zend\ServiceManager\Exception\ServiceNotCreatedException; @@ -63,19 +65,18 @@ public function setUp() $event = new MvcEvent(); $event->setApplication($mockApplication); - $event->setRequest(new Request()); - $event->setResponse(new Response()); - - $routeMatch = new RouteMatch(['action' => 'test']); - $routeMatch->setMatchedRouteName('some-route'); - $event->setRouteMatch($routeMatch); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $routeResult = RouteResult::fromRouteMatch(['action' => 'test'], 'some-route'); + $request = $request->withAttribute(RouteResult::class, $routeResult); + $event->setRequest($request); $config = new Config([ 'aliases' => [ - 'ControllerLoader' => 'ControllerManager', + 'ControllerPluginManager' => PluginManager::class, + 'ControllerManager' => ControllerManager::class, ], 'factories' => [ - 'ControllerManager' => function ($services, $name) { + ControllerManager::class => function ($services, $name) { $plugins = $services->get('ControllerPluginManager'); return new ControllerManager($services, ['factories' => [ @@ -86,7 +87,7 @@ public function setUp() }, ]]); }, - 'ControllerPluginManager' => function ($services, $name) { + PluginManager::class => function ($services, $name) { return new PluginManager($services); }, 'EventManager' => function ($services, $name) { @@ -148,7 +149,7 @@ public function testDispatchRaisesDomainExceptionIfDiscoveredControllerIsNotDisp $plugin->setController($this->controller); $this->expectException(InvalidServiceException::class); - $this->expectExceptionMessage('DispatchableInterface'); + $this->expectExceptionMessage('Dispatchable'); $plugin->dispatch('bogus'); } @@ -162,7 +163,7 @@ public function testDispatchRaisesDomainExceptionIfCircular() ], 'factories' => [ 'ControllerManager' => function ($services) use ($event) { - $plugins = $services->get('ControllerPluginManager'); + $plugins = $services->get(PluginManager::class); return new ControllerManager($services, ['factories' => [ 'forward' => function ($services) use ($plugins) { @@ -178,7 +179,7 @@ public function testDispatchRaisesDomainExceptionIfCircular() }, ]]); }, - 'ControllerPluginManager' => function ($services) { + PluginManager::class => function ($services) { return new PluginManager($services); }, 'EventManager' => function ($services, $name) { @@ -309,20 +310,13 @@ public function testDispatchWillSeedRouteMatchWithPassedParameters() public function testRouteMatchObjectRemainsSameFollowingForwardDispatch() { - $routeMatch = $this->controller->getEvent()->getRouteMatch(); - $matchParams = $routeMatch->getParams(); - $matchMatchedRouteName = $routeMatch->getMatchedRouteName(); - $result = $this->plugin->dispatch('forward', [ + $routeResult = $this->controller->getRequest()->getAttribute(RouteResult::class); + $this->plugin->dispatch('forward', [ 'action' => 'test-matches', 'param1' => 'foobar', - ]); - $testMatch = $this->controller->getEvent()->getRouteMatch(); - $testParams = $testMatch->getParams(); - $testMatchedRouteName = $testMatch->getMatchedRouteName(); - - $this->assertSame($routeMatch, $testMatch); - $this->assertEquals($matchParams, $testParams); - $this->assertEquals($matchMatchedRouteName, $testMatchedRouteName); + ]); + $testResult = $this->controller->getRequest()->getAttribute(RouteResult::class); + $this->assertSame($routeResult, $testResult); } public function testAllowsPassingEmptyArrayOfRouteParams() @@ -332,6 +326,7 @@ public function testAllowsPassingEmptyArrayOfRouteParams() $this->assertTrue(isset($result['status'])); $this->assertEquals('not-found', $result['status']); $this->assertTrue(isset($result['params'])); + unset($result['params'][RouteResult::class]); $this->assertEquals([], $result['params']); } diff --git a/test/Controller/Plugin/LayoutTest.php b/test/Controller/Plugin/LayoutTest.php index 225df0533..150990c1c 100644 --- a/test/Controller/Plugin/LayoutTest.php +++ b/test/Controller/Plugin/LayoutTest.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin; use PHPUnit\Framework\TestCase; diff --git a/test/Controller/Plugin/ParamsTest.php b/test/Controller/Plugin/ParamsTest.php index 9f578d452..5ad513e70 100644 --- a/test/Controller/Plugin/ParamsTest.php +++ b/test/Controller/Plugin/ParamsTest.php @@ -5,29 +5,37 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin; use PHPUnit\Framework\TestCase; -use Zend\Http\Header\GenericHeader; -use Zend\Http\Request; -use Zend\Http\Response; +use Psr\Http\Message\ServerRequestInterface; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; +use Zend\Diactoros\UploadedFile; use Zend\Mvc\MvcEvent; -use Zend\Router\RouteMatch; +use Zend\Router\RouteResult; use ZendTest\Mvc\Controller\TestAsset\SampleController; class ParamsTest extends TestCase { + /** + * @var ServerRequestInterface + */ + public $request; + public function setUp() { - $this->request = new Request; + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $request = $request->withAttribute('value', 'rm:1234'); + $request = $request->withAttribute('other', '1234:rm'); + $request = $request->withAttribute(RouteResult::class, RouteResult::fromRouteMatch([])); + $this->request = $request; $event = new MvcEvent; $event->setRequest($this->request); $event->setResponse(new Response()); - $event->setRouteMatch(new RouteMatch([ - 'value' => 'rm:1234', - 'other' => '1234:rm', - ])); $this->controller = new SampleController(); $this->controller->setEvent($event); @@ -62,7 +70,7 @@ public function testFromRouteNotReturnsExpectedValueWithDefault() public function testFromRouteReturnsAllIfEmpty() { $value = $this->plugin->fromRoute(); - $this->assertEquals($value, ['value' => 'rm:1234', 'other' => '1234:rm']); + $this->assertEquals($this->request->getAttributes(), $value); } public function testFromQueryReturnsDefaultIfSet() @@ -131,15 +139,15 @@ public function testFromPostReturnsAllIfEmpty() public function testFromFilesReturnsExpectedValue() { - $file = [ - 'name' => 'test.txt', - 'type' => 'text/plain', - 'size' => 0, - 'tmp_name' => '/tmp/' . uniqid(), - 'error' => UPLOAD_ERR_OK, - ]; - $this->request->getFiles()->set('test', $file); - $this->controller->dispatch($this->request); + $file = new UploadedFile( + '/tmp/' . uniqid(), + 0, + \UPLOAD_ERR_OK, + 'test.txt', + 'text/plain' + ); + $request = $this->request->withUploadedFiles(['test' => $file]); + $this->controller->dispatch($request); $value = $this->plugin->fromFiles('test'); $this->assertEquals($value, $file); @@ -147,24 +155,25 @@ public function testFromFilesReturnsExpectedValue() public function testFromFilesReturnsAllIfEmpty() { - $file = [ - 'name' => 'test.txt', - 'type' => 'text/plain', - 'size' => 0, - 'tmp_name' => '/tmp/' . uniqid(), - 'error' => UPLOAD_ERR_OK, - ]; - - $file2 = [ - 'name' => 'file2.txt', - 'type' => 'text/plain', - 'size' => 1, - 'tmp_name' => '/tmp/' . uniqid(), - 'error' => UPLOAD_ERR_OK, - ]; - $this->request->getFiles()->set('file', $file); - $this->request->getFiles()->set('file2', $file2); - $this->controller->dispatch($this->request); + $file = new UploadedFile( + '/tmp/' . uniqid(), + 0, + \UPLOAD_ERR_OK, + 'test.txt', + 'text/plain' + ); + + $file2 = new UploadedFile( + '/tmp/' . uniqid(), + 1, + \UPLOAD_ERR_OK, + 'file2.txt', + 'text/plain' + ); + + $request = $this->request->withUploadedFiles(['file' => $file, 'file2' => $file2]); + + $this->controller->dispatch($request); $value = $this->plugin->fromFiles(); $this->assertEquals($value, ['file' => $file, 'file2' => $file2]); @@ -172,26 +181,22 @@ public function testFromFilesReturnsAllIfEmpty() public function testFromHeaderReturnsExpectedValue() { - $header = new GenericHeader('X-TEST', 'test'); - $this->request->getHeaders()->addHeader($header); - $this->controller->dispatch($this->request); + $request = $this->request->withAddedHeader('X-TEST', 'test'); + $this->controller->dispatch($request); $value = $this->plugin->fromHeader('X-TEST'); - $this->assertSame($value, $header); + $this->assertSame($value, ['test']); } public function testFromHeaderReturnsAllIfEmpty() { - $header = new GenericHeader('X-TEST', 'test'); - $header2 = new GenericHeader('OTHER-TEST', 'value:12345'); - - $this->request->getHeaders()->addHeader($header); - $this->request->getHeaders()->addHeader($header2); + $request = $this->request->withAddedHeader('X-TEST', 'test') + ->withAddedHeader('OTHER-TEST', 'value:12345'); - $this->controller->dispatch($this->request); + $this->controller->dispatch($request); $value = $this->plugin->fromHeader(); - $this->assertSame($value, ['X-TEST' => 'test', 'OTHER-TEST' => 'value:12345']); + $this->assertSame($value, ['X-TEST' => ['test'], 'OTHER-TEST' => ['value:12345']]); } public function testInvokeWithNoArgumentsReturnsInstance() @@ -201,19 +206,23 @@ public function testInvokeWithNoArgumentsReturnsInstance() protected function setQuery() { - $this->request->setMethod(Request::METHOD_GET); - $this->request->getQuery()->set('value', 'query:1234'); - $this->request->getQuery()->set('other', '1234:other'); + $request = $this->request->withMethod('GET') + ->withQueryParams([ + 'value' => 'query:1234', + 'other' => '1234:other', + ]); - $this->controller->dispatch($this->request); + $this->controller->dispatch($request); } protected function setPost() { - $this->request->setMethod(Request::METHOD_POST); - $this->request->getPost()->set('value', 'post:1234'); - $this->request->getPost()->set('other', '2345:other'); + $request = $this->request->withMethod('POST') + ->withParsedBody([ + 'value' => 'post:1234', + 'other' => '2345:other', + ]); - $this->controller->dispatch($this->request); + $this->controller->dispatch($request); } } diff --git a/test/Controller/Plugin/RedirectTest.php b/test/Controller/Plugin/RedirectTest.php index 64f68051d..a3813b00a 100644 --- a/test/Controller/Plugin/RedirectTest.php +++ b/test/Controller/Plugin/RedirectTest.php @@ -5,26 +5,33 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin; use PHPUnit\Framework\TestCase; -use Zend\Http\Response; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\Controller\Plugin\Redirect as RedirectPlugin; use Zend\Mvc\Exception\DomainException; use Zend\Mvc\Exception\RuntimeException; use Zend\Mvc\MvcEvent; -use Zend\Router\Http\Literal as LiteralRoute; -use Zend\Router\Http\Segment as SegmentRoute; -use Zend\Router\RouteMatch; +use Zend\Router\Route\Literal as LiteralRoute; +use Zend\Router\Route\Segment as SegmentRoute; +use Zend\Router\RouteResult; use Zend\Router\SimpleRouteStack; use ZendTest\Mvc\Controller\TestAsset\SampleController; class RedirectTest extends TestCase { + /** + * @var RedirectPlugin + */ + public $plugin; + public function setUp() { - $this->response = new Response(); - $router = new SimpleRouteStack; $router->addRoute('home', LiteralRoute::factory([ 'route' => '/', @@ -34,13 +41,14 @@ public function setUp() ])); $this->router = $router; - $routeMatch = new RouteMatch([]); - $routeMatch->setMatchedRouteName('home'); - $this->routeMatch = $routeMatch; - $event = new MvcEvent(); + + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $request = $request->withAttribute(RouteResult::class, RouteResult::fromRouteMatch([], 'home')); + $this->request = $request; + $event->setRequest($request); + $event->setRouter($router); - $event->setResponse($this->response); $this->event = $event; $this->controller = new SampleController(); @@ -52,19 +60,17 @@ public function setUp() public function testPluginCanRedirectToRouteWhenProperlyConfigured() { $response = $this->plugin->toRoute('home'); - $this->assertTrue($response->isRedirect()); - $headers = $response->getHeaders(); - $location = $headers->get('Location'); - $this->assertEquals('/', $location->getFieldValue()); + $this->assertEquals(302, $response->getStatusCode()); + $this->assertCount(1, $response->getHeader('Location')); + $this->assertEquals('/', $response->getHeader('Location')[0]); } public function testPluginCanRedirectToUrlWhenProperlyConfigured() { $response = $this->plugin->toUrl('/foo'); - $this->assertTrue($response->isRedirect()); - $headers = $response->getHeaders(); - $location = $headers->get('Location'); - $this->assertEquals('/foo', $location->getFieldValue()); + $this->assertEquals(302, $response->getStatusCode()); + $this->assertCount(1, $response->getHeader('Location')); + $this->assertEquals('/foo', $response->getHeader('Location')[0]); } public function testPluginWithoutControllerRaisesDomainException() @@ -84,22 +90,15 @@ public function testPluginWithoutControllerEventRaisesDomainException() $plugin->toRoute('home'); } - public function testPluginWithoutResponseInEventRaisesDomainException() + public function testPluginWithoutResponseInEventReturnsNewResponse() { - $controller = new SampleController(); - $event = new MvcEvent(); - $controller->setEvent($event); - $plugin = $controller->plugin('redirect'); - $this->expectException(DomainException::class); - $this->expectExceptionMessage('event compose'); - $plugin->toRoute('home'); + $this->assertInstanceOf(ResponseInterface::class, $this->plugin->toRoute('home')); } public function testRedirectToRouteWithoutRouterInEventRaisesDomainException() { $controller = new SampleController(); $event = new MvcEvent(); - $event->setResponse($this->response); $controller->setEvent($event); $plugin = $controller->plugin('redirect'); $this->expectException(DomainException::class); @@ -109,20 +108,18 @@ public function testRedirectToRouteWithoutRouterInEventRaisesDomainException() public function testPluginWithoutRouteMatchesInEventRaisesExceptionWhenNoRouteProvided() { + $request = $this->request->withoutAttribute(RouteResult::class); + $this->controller->getEvent()->setRequest($request); $this->expectException(RuntimeException::class); - $this->expectExceptionMessage('RouteMatch'); + $this->expectExceptionMessage('RouteResult'); $url = $this->plugin->toRoute(); } public function testPassingNoArgumentsWithValidRouteMatchGeneratesUrl() { - $routeMatch = new RouteMatch([]); - $routeMatch->setMatchedRouteName('home'); - $this->controller->getEvent()->setRouteMatch($routeMatch); $response = $this->plugin->toRoute(); - $headers = $response->getHeaders(); - $location = $headers->get('Location'); - $this->assertEquals('/', $location->getFieldValue()); + $this->assertCount(1, $response->getHeader('Location')); + $this->assertEquals('/', $response->getHeader('Location')[0]); } public function testCanReuseMatchedParameters() @@ -133,15 +130,14 @@ public function testCanReuseMatchedParameters() 'controller' => SampleController::class, ], ])); - $routeMatch = new RouteMatch([ - 'controller' => 'foo', - ]); - $routeMatch->setMatchedRouteName('replace'); - $this->controller->getEvent()->setRouteMatch($routeMatch); + $request = $this->request->withAttribute(RouteResult::class, RouteResult::fromRouteMatch( + ['controller' => 'foo'], + 'replace' + )); + $this->controller->getEvent()->setRequest($request); $response = $this->plugin->toRoute('replace', ['action' => 'bar'], [], true); - $headers = $response->getHeaders(); - $location = $headers->get('Location'); - $this->assertEquals('/foo/bar', $location->getFieldValue()); + $this->assertCount(1, $response->getHeader('Location')); + $this->assertEquals('/foo/bar', $response->getHeader('Location')[0]); } public function testCanPassBooleanValueForThirdArgumentToAllowReusingRouteMatches() @@ -152,34 +148,29 @@ public function testCanPassBooleanValueForThirdArgumentToAllowReusingRouteMatche 'controller' => SampleController::class, ], ])); - $routeMatch = new RouteMatch([ - 'controller' => 'foo', - ]); - $routeMatch->setMatchedRouteName('replace'); - $this->controller->getEvent()->setRouteMatch($routeMatch); + $request = $this->request->withAttribute(RouteResult::class, RouteResult::fromRouteMatch( + ['controller' => 'foo'], + 'replace' + )); + $this->controller->getEvent()->setRequest($request); $response = $this->plugin->toRoute('replace', ['action' => 'bar'], true); - $headers = $response->getHeaders(); - $location = $headers->get('Location'); - $this->assertEquals('/foo/bar', $location->getFieldValue()); + $this->assertCount(1, $response->getHeader('Location')); + $this->assertEquals('/foo/bar', $response->getHeader('Location')[0]); } public function testPluginCanRefreshToRouteWhenProperlyConfigured() { - $this->event->setRouteMatch($this->routeMatch); $response = $this->plugin->refresh(); - $this->assertTrue($response->isRedirect()); - $headers = $response->getHeaders(); - $location = $headers->get('Location'); - $this->assertEquals('/', $location->getFieldValue()); + $this->assertEquals(302, $response->getStatusCode()); + $this->assertCount(1, $response->getHeader('Location')); + $this->assertEquals('/', $response->getHeader('Location')[0]); } public function testPluginCanRedirectToRouteWithNullWhenProperlyConfigured() { - $this->event->setRouteMatch($this->routeMatch); $response = $this->plugin->toRoute(); - $this->assertTrue($response->isRedirect()); - $headers = $response->getHeaders(); - $location = $headers->get('Location'); - $this->assertEquals('/', $location->getFieldValue()); + $this->assertEquals(302, $response->getStatusCode()); + $this->assertCount(1, $response->getHeader('Location')); + $this->assertEquals('/', $response->getHeader('Location')[0]); } } diff --git a/test/Controller/Plugin/TestAsset/ListenerStub.php b/test/Controller/Plugin/TestAsset/ListenerStub.php index cf0455d38..bd0fe2bac 100644 --- a/test/Controller/Plugin/TestAsset/ListenerStub.php +++ b/test/Controller/Plugin/TestAsset/ListenerStub.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin\TestAsset; class ListenerStub diff --git a/test/Controller/Plugin/TestAsset/SamplePlugin.php b/test/Controller/Plugin/TestAsset/SamplePlugin.php index f5fcfbb35..1fad2dd3f 100644 --- a/test/Controller/Plugin/TestAsset/SamplePlugin.php +++ b/test/Controller/Plugin/TestAsset/SamplePlugin.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin\TestAsset; use Zend\Mvc\Controller\Plugin\AbstractPlugin; diff --git a/test/Controller/Plugin/TestAsset/SamplePluginFactory.php b/test/Controller/Plugin/TestAsset/SamplePluginFactory.php index d6def1829..6eca684d3 100644 --- a/test/Controller/Plugin/TestAsset/SamplePluginFactory.php +++ b/test/Controller/Plugin/TestAsset/SamplePluginFactory.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin\TestAsset; use Interop\Container\ContainerInterface; diff --git a/test/Controller/Plugin/TestAsset/SamplePluginWithConstructor.php b/test/Controller/Plugin/TestAsset/SamplePluginWithConstructor.php index 3404a54fe..9abd205e8 100644 --- a/test/Controller/Plugin/TestAsset/SamplePluginWithConstructor.php +++ b/test/Controller/Plugin/TestAsset/SamplePluginWithConstructor.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin\TestAsset; use Zend\Mvc\Controller\Plugin\AbstractPlugin; diff --git a/test/Controller/Plugin/TestAsset/SamplePluginWithConstructorFactory.php b/test/Controller/Plugin/TestAsset/SamplePluginWithConstructorFactory.php index a4c1f4a89..9374133e4 100644 --- a/test/Controller/Plugin/TestAsset/SamplePluginWithConstructorFactory.php +++ b/test/Controller/Plugin/TestAsset/SamplePluginWithConstructorFactory.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin\TestAsset; use Interop\Container\ContainerInterface; diff --git a/test/Controller/Plugin/UrlTest.php b/test/Controller/Plugin/UrlTest.php index 393d3fa7a..c00dbc8bf 100644 --- a/test/Controller/Plugin/UrlTest.php +++ b/test/Controller/Plugin/UrlTest.php @@ -5,20 +5,20 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\Plugin; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\ServerRequest; use Zend\Mvc\Controller\Plugin\Url as UrlPlugin; use Zend\Mvc\Exception\DomainException; use Zend\Mvc\Exception\RuntimeException; use Zend\Mvc\MvcEvent; -use Zend\Mvc\ModuleRouteListener; -use Zend\Router\Http\Literal as LiteralRoute; -use Zend\Router\Http\Segment as SegmentRoute; -use Zend\Router\Http\Segment; -use Zend\Router\Http\TreeRouteStack; -use Zend\Router\Http\Wildcard; -use Zend\Router\RouteMatch; +use Zend\Router\Route\Literal as LiteralRoute; +use Zend\Router\Route\Segment as SegmentRoute; +use Zend\Router\Route\Segment; +use Zend\Router\RouteResult; use Zend\Router\SimpleRouteStack; use ZendTest\Mvc\Controller\TestAsset\SampleController; @@ -95,14 +95,16 @@ public function testPluginWithoutRouterInEventRaisesDomainException() public function testPluginWithoutRouteMatchesInEventRaisesExceptionWhenNoRouteProvided() { $this->expectException(RuntimeException::class); - $this->expectExceptionMessage('RouteMatch'); + $this->expectExceptionMessage('RouteResult'); $url = $this->plugin->fromRoute(); } public function testPluginWithRouteMatchesReturningNoMatchedRouteNameRaisesExceptionWhenNoRouteProvided() { $event = $this->controller->getEvent(); - $event->setRouteMatch(new RouteMatch([])); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $request = $request->withAttribute(RouteResult::class, RouteResult::fromRouteMatch([])); + $event->setRequest($request); $this->expectException(RuntimeException::class); $this->expectExceptionMessage('matched'); $url = $this->plugin->fromRoute(); @@ -110,9 +112,9 @@ public function testPluginWithRouteMatchesReturningNoMatchedRouteNameRaisesExcep public function testPassingNoArgumentsWithValidRouteMatchGeneratesUrl() { - $routeMatch = new RouteMatch([]); - $routeMatch->setMatchedRouteName('home'); - $this->controller->getEvent()->setRouteMatch($routeMatch); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $request = $request->withAttribute(RouteResult::class, RouteResult::fromRouteMatch([], 'home')); + $this->controller->getEvent()->setRequest($request); $url = $this->plugin->fromRoute(); $this->assertEquals('/', $url); } @@ -125,11 +127,12 @@ public function testCanReuseMatchedParameters() 'controller' => SampleController::class, ], ])); - $routeMatch = new RouteMatch([ - 'controller' => 'foo', - ]); - $routeMatch->setMatchedRouteName('replace'); - $this->controller->getEvent()->setRouteMatch($routeMatch); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $request = $request->withAttribute(RouteResult::class, RouteResult::fromRouteMatch( + ['controller' => 'foo'], + 'replace' + )); + $this->controller->getEvent()->setRequest($request); $url = $this->plugin->fromRoute('replace', ['action' => 'bar'], [], true); $this->assertEquals('/foo/bar', $url); } @@ -142,59 +145,13 @@ public function testCanPassBooleanValueForThirdArgumentToAllowReusingRouteMatche 'controller' => SampleController::class, ], ])); - $routeMatch = new RouteMatch([ - 'controller' => 'foo', - ]); - $routeMatch->setMatchedRouteName('replace'); - $this->controller->getEvent()->setRouteMatch($routeMatch); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $request = $request->withAttribute(RouteResult::class, RouteResult::fromRouteMatch( + ['controller' => 'foo'], + 'replace' + )); + $this->controller->getEvent()->setRequest($request); $url = $this->plugin->fromRoute('replace', ['action' => 'bar'], true); $this->assertEquals('/foo/bar', $url); } - - /** - * - */ - public function testRemovesModuleRouteListenerParamsWhenReusingMatchedParameters() - { - $router = new TreeRouteStack; - $router->addRoute('default', [ - 'type' => Segment::class, - 'options' => [ - 'route' => '/:controller/:action', - 'defaults' => [ - ModuleRouteListener::MODULE_NAMESPACE => 'ZendTest\Mvc\Controller\TestAsset', - 'controller' => 'SampleController', - 'action' => 'Dash' - ] - ], - 'child_routes' => [ - 'wildcard' => [ - 'type' => Wildcard::class, - 'options' => [ - 'param_delimiter' => '=', - 'key_value_delimiter' => '%' - ] - ] - ] - ]); - - $routeMatch = new RouteMatch([ - ModuleRouteListener::MODULE_NAMESPACE => 'ZendTest\Mvc\Controller\TestAsset', - 'controller' => 'Rainbow' - ]); - $routeMatch->setMatchedRouteName('default/wildcard'); - - $event = new MvcEvent(); - $event->setRouter($router) - ->setRouteMatch($routeMatch); - - $moduleRouteListener = new ModuleRouteListener(); - $moduleRouteListener->onRoute($event); - - $controller = new SampleController(); - $controller->setEvent($event); - $url = $controller->plugin('url')->fromRoute('default/wildcard', ['Twenty' => 'Cooler'], true); - - $this->assertEquals('/Rainbow/Dash=Twenty%Cooler', $url); - } } diff --git a/test/Controller/PluginManagerTest.php b/test/Controller/PluginManagerTest.php index 596589602..28b7d6cc1 100644 --- a/test/Controller/PluginManagerTest.php +++ b/test/Controller/PluginManagerTest.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller; use PHPUnit\Framework\TestCase; diff --git a/test/Controller/RestfulControllerTest.php b/test/Controller/RestfulControllerTest.php index a7ca8186b..42db6402c 100644 --- a/test/Controller/RestfulControllerTest.php +++ b/test/Controller/RestfulControllerTest.php @@ -5,23 +5,27 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller; use PHPUnit\Framework\TestCase; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; use ReflectionClass; use ReflectionObject; use stdClass; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManager; use Zend\EventManager\SharedEventManager; use Zend\EventManager\SharedEventManagerInterface; -use Zend\Http\Response; use Zend\Mvc\Controller\AbstractRestfulController; +use Zend\Mvc\Controller\Dispatchable; use Zend\Mvc\Controller\Plugin\Url; use Zend\Mvc\InjectApplicationEventInterface; use Zend\Mvc\MvcEvent; -use Zend\Router\RouteMatch; -use Zend\Stdlib\DispatchableInterface; -use ZendTest\Mvc\Controller\TestAsset\Request; +use Zend\Router\RouteResult; use ZendTest\Mvc\Controller\TestAsset\RestfulContentTypeTestController; use ZendTest\Mvc\Controller\TestAsset\RestfulMethodNotAllowedTestController; use ZendTest\Mvc\Controller\TestAsset\RestfulTestController; @@ -30,20 +34,22 @@ class RestfulControllerTest extends TestCase { public $controller; public $emptyController; + /** + * @var ServerRequest + */ public $request; - public $response; - public $routeMatch; public $event; + public $sharedEvents; + public $events; public function setUp() { $this->controller = new RestfulTestController(); $this->emptyController = new RestfulMethodNotAllowedTestController(); - $this->request = new Request(); - $this->response = new Response(); - $this->routeMatch = new RouteMatch(['controller' => 'controller-restful']); - $this->event = new MvcEvent; - $this->event->setRouteMatch($this->routeMatch); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $routeResult = RouteResult::fromRouteMatch(['controller' => 'controller-restful']); + $this->request = $request->withAttribute(RouteResult::class, $routeResult); + $this->event = new MvcEvent(); $this->controller->setEvent($this->event); $this->emptyController->setEvent($this->event); @@ -52,6 +58,17 @@ public function setUp() $this->controller->setEventManager($this->events); } + public function requestWithMatchedParams(ServerRequest $request, array $params) + { + /** @var RouteResult $routeResult */ + $routeResult = $request->getAttribute(RouteResult::class); + $routeResult = $routeResult->withMatchedParams(\array_merge($routeResult->getMatchedParams(), $params)); + foreach ($params as $name => $param) { + $request = $request->withAttribute($name, $param); + } + return $request->withAttribute(RouteResult::class, $routeResult); + } + /** * @param SharedEventManager * @return EventManager @@ -69,66 +86,80 @@ public function testDispatchInvokesListWhenNoActionPresentAndNoIdentifierOnGet() new stdClass, ]; $this->controller->entities = $entities; - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertArrayHasKey('entities', $result); $this->assertEquals($entities, $result['entities']); - $this->assertEquals('getList', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'getList', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testDispatchInvokesGetMethodWhenNoActionPresentAndIdentifierPresentOnGet() { $entity = new stdClass; $this->controller->entity = $entity; - $this->routeMatch->setParam('id', 1); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->requestWithMatchedParams($this->request, ['id' => 1]); + $result = $this->controller->dispatch($request); $this->assertArrayHasKey('entity', $result); $this->assertEquals($entity, $result['entity']); - $this->assertEquals('get', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'get', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testDispatchInvokesCreateMethodWhenNoActionPresentAndPostInvoked() { $entity = ['id' => 1, 'name' => __FUNCTION__]; - $this->request->setMethod('POST'); - $post = $this->request->getPost(); - $post->fromArray($entity); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->request->withMethod('POST'); + $request = $request->withParsedBody($entity); + $result = $this->controller->dispatch($request); $this->assertArrayHasKey('entity', $result); $this->assertEquals($entity, $result['entity']); - $this->assertEquals('create', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'create', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testCanReceiveStringAsRequestContent() { $string = "any content"; - $this->request->setMethod('PUT'); - $this->request->setContent($string); - $this->routeMatch->setParam('id', $id = 1); + $request = $this->request->withMethod('PUT'); + $request->getBody()->write($string); + $request = $this->requestWithMatchedParams($request, ['id' => 1]); $controller = new RestfulContentTypeTestController(); $controller->setEvent($this->event); - $result = $controller->dispatch($this->request, $this->response); + $result = $controller->dispatch($request); - $this->assertEquals($id, $result['id']); + $this->assertEquals(1, $result['id']); $this->assertEquals($string, $result['data']); - $this->assertEquals('update', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'update', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testDispatchInvokesUpdateMethodWhenNoActionPresentAndPutInvokedWithIdentifier() { $entity = ['name' => __FUNCTION__]; $string = http_build_query($entity); - $this->request->setMethod('PUT') - ->setContent($string); - $this->routeMatch->setParam('id', 1); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->request->withMethod('PUT'); + $request->getBody()->write($string); + $request = $this->requestWithMatchedParams($request, ['id' => 1]); + $result = $this->controller->dispatch($request); $this->assertArrayHasKey('entity', $result); $test = $result['entity']; $this->assertArrayHasKey('id', $test); $this->assertEquals(1, $test['id']); $this->assertArrayHasKey('name', $test); $this->assertEquals(__FUNCTION__, $test['name']); - $this->assertEquals('update', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'update', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testDispatchInvokesReplaceListMethodWhenNoActionPresentAndPutInvokedWithoutIdentifier() @@ -139,11 +170,14 @@ public function testDispatchInvokesReplaceListMethodWhenNoActionPresentAndPutInv ['id' => uniqid(), 'name' => __FUNCTION__], ]; $string = http_build_query($entities); - $this->request->setMethod('PUT') - ->setContent($string); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->request->withMethod('PUT'); + $request->getBody()->write($string); + $result = $this->controller->dispatch($request); $this->assertEquals($entities, $result); - $this->assertEquals('replaceList', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'replaceList', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testDispatchInvokesPatchListMethodWhenNoActionPresentAndPatchInvokedWithoutIdentifier() @@ -154,23 +188,29 @@ public function testDispatchInvokesPatchListMethodWhenNoActionPresentAndPatchInv ['id' => uniqid(), 'name' => __FUNCTION__], ]; $string = http_build_query($entities); - $this->request->setMethod('PATCH') - ->setContent($string); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->request->withMethod('PATCH'); + $request->getBody()->write($string); + $result = $this->controller->dispatch($request); $this->assertEquals($entities, $result); - $this->assertEquals('patchList', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'patchList', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testDispatchInvokesDeleteMethodWhenNoActionPresentAndDeleteInvokedWithIdentifier() { $entity = ['id' => 1, 'name' => __FUNCTION__]; $this->controller->entity = $entity; - $this->request->setMethod('DELETE'); - $this->routeMatch->setParam('id', 1); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->request->withMethod('DELETE'); + $request = $this->requestWithMatchedParams($request, ['id' => 1]); + $result = $this->controller->dispatch($request); $this->assertEquals([], $result); $this->assertEquals([], $this->controller->entity); - $this->assertEquals('delete', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'delete', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testDispatchInvokesDeleteListMethodWhenNoActionPresentAndDeleteInvokedWithoutIdentifier() @@ -184,27 +224,31 @@ public function testDispatchInvokesDeleteListMethodWhenNoActionPresentAndDeleteI $this->controller->entity = $entities; $string = http_build_query($entities); - $this->request->setMethod('DELETE') - ->setContent($string); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->request->withMethod('DELETE'); + $request->getBody()->write($string); + $result = $this->controller->dispatch($request); $this->assertEmpty($this->controller->entity); $this->assertEquals(204, $result->getStatusCode()); - $this->assertTrue($result->getHeaders()->has('X-Deleted')); - $this->assertEquals('deleteList', $this->routeMatch->getParam('action')); + $this->assertTrue($result->hasHeader('X-Deleted')); + $this->assertEquals( + 'deleteList', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testDispatchInvokesOptionsMethodWhenNoActionPresentAndOptionsInvoked() { - $this->request->setMethod('OPTIONS'); - $result = $this->controller->dispatch($this->request, $this->response); - $this->assertSame($this->response, $result); - $this->assertEquals('options', $this->routeMatch->getParam('action')); - $headers = $result->getHeaders(); - $this->assertTrue($headers->has('Allow')); - $allow = $headers->get('Allow'); + $request = $this->request->withMethod('OPTIONS'); + $result = $this->controller->dispatch($request); + $this->assertEquals( + 'options', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); + $this->assertTrue($result->hasHeader('Allow')); + $allow = $result->getHeader('Allow')[0]; $expected = explode(', ', 'GET, POST, PUT, DELETE, PATCH, HEAD, TRACE'); sort($expected); - $test = explode(', ', $allow->getFieldValue()); + $test = explode(', ', $allow); sort($test); $this->assertEquals($expected, $test); } @@ -217,10 +261,10 @@ public function testDispatchInvokesPatchMethodWhenNoActionPresentAndPatchInvoked $this->controller->entity = $entity; $entity = ['name' => __FUNCTION__]; $string = http_build_query($entity); - $this->request->setMethod('PATCH') - ->setContent($string); - $this->routeMatch->setParam('id', 1); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->request->withMethod('PATCH'); + $request->getBody()->write($string); + $request = $this->requestWithMatchedParams($request, ['id' => 1]); + $result = $this->controller->dispatch($request); $this->assertArrayHasKey('entity', $result); $test = $result['entity']; $this->assertArrayHasKey('id', $test); @@ -229,7 +273,10 @@ public function testDispatchInvokesPatchMethodWhenNoActionPresentAndPatchInvoked $this->assertEquals(__FUNCTION__, $test['name']); $this->assertArrayHasKey('type', $test); $this->assertEquals('standard', $test['type']); - $this->assertEquals('patch', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'patch', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } /** @@ -237,17 +284,23 @@ public function testDispatchInvokesPatchMethodWhenNoActionPresentAndPatchInvoked */ public function testOnDispatchHonorsStatusCodeWithHeadMethod() { - $this->controller->headResponse = new Response(); - $this->controller->headResponse->setStatusCode(418); - $this->controller->headResponse->getHeaders()->addHeaderLine('Custom-Header', 'Header Value'); - $this->routeMatch->setParam('id', 1); - $this->request->setMethod('HEAD'); - $result = $this->controller->dispatch($this->request, $this->response); + $response = new Response(); + $response = $response + ->withStatus(418) + ->withAddedHeader('Custom-Header', 'Header Value'); + + $this->controller->headResponse = $response; + $request = $this->request->withMethod('HEAD'); + $request = $this->requestWithMatchedParams($request, ['id' => 1]); + $result = $this->controller->dispatch($request); $this->assertEquals(418, $result->getStatusCode()); - $this->assertEquals('', $result->getContent()); - $this->assertEquals('head', $this->routeMatch->getParam('action')); - $this->assertEquals('Header Value', $result->getHeaders()->get('Custom-Header')->getFieldValue()); + $this->assertEquals('', $result->getBody()->__toString()); + $this->assertEquals( + 'head', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); + $this->assertEquals('Header Value', $result->getHeader('Custom-Header')[0] ?? 'No header set'); } public function testDispatchInvokesHeadMethodWhenNoActionPresentAndHeadInvokedWithoutIdentifier() @@ -258,53 +311,55 @@ public function testDispatchInvokesHeadMethodWhenNoActionPresentAndHeadInvokedWi new stdClass, ]; $this->controller->entities = $entities; - $this->request->setMethod('HEAD'); - $result = $this->controller->dispatch($this->request, $this->response); - $this->assertSame($this->response, $result); - $content = $result->getContent(); + $request = $this->request->withMethod('HEAD'); + $result = $this->controller->dispatch($request); + $content = $result->getBody()->__toString(); $this->assertEquals('', $content); - $this->assertEquals('head', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'head', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testDispatchInvokesHeadMethodWhenNoActionPresentAndHeadInvokedWithIdentifier() { $entity = new stdClass; $this->controller->entity = $entity; - $this->routeMatch->setParam('id', 1); - $this->request->setMethod('HEAD'); - $result = $this->controller->dispatch($this->request, $this->response); - $this->assertSame($this->response, $result); - $content = $result->getContent(); + $request = $this->request->withMethod('HEAD'); + $request = $this->requestWithMatchedParams($request, ['id' => 1]); + $result = $this->controller->dispatch($request); + $content = $result->getBody()->__toString(); $this->assertEquals('', $content); - $this->assertEquals('head', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'head', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); - $headers = $this->controller->getResponse()->getHeaders(); - $this->assertTrue($headers->has('X-ZF2-Id')); - $header = $headers->get('X-ZF2-Id'); - $this->assertEquals(1, $header->getFieldValue()); + $this->assertTrue($result->hasHeader('X-ZF2-Id')); + $this->assertEquals(1, $result->getHeader('X-ZF2-Id')[0]); } public function testAllowsRegisteringCustomHttpMethodsWithHandlers() { $this->controller->addHttpMethodHandler('DESCRIBE', [$this->controller, 'describe']); - $this->request->setMethod('DESCRIBE'); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->request->withMethod('DESCRIBE'); + $result = $this->controller->dispatch($request); $this->assertArrayHasKey('description', $result); $this->assertContains('::describe', $result['description']); } public function testDispatchCallsActionMethodBasedOnNormalizingAction() { - $this->routeMatch->setParam('action', 'test.some-strangely_separated.words'); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->requestWithMatchedParams($this->request, ['action' => 'test.some-strangely_separated.words']); + $result = $this->controller->dispatch($request); $this->assertArrayHasKey('content', $result); $this->assertContains('Test Some Strangely Separated Words', $result['content']); } public function testDispatchCallsNotFoundActionWhenActionPassedThatCannotBeMatched() { - $this->routeMatch->setParam('action', 'test-some-made-up-action'); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->requestWithMatchedParams($this->request, ['action' => 'test-some-made-up-action']); + $result = $this->controller->dispatch($request); $response = $this->controller->getResponse(); $this->assertEquals(404, $response->getStatusCode()); $this->assertArrayHasKey('content', $result); @@ -314,45 +369,45 @@ public function testDispatchCallsNotFoundActionWhenActionPassedThatCannotBeMatch public function testShortCircuitsBeforeActionIfPreDispatchReturnsAResponse() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $this->controller->getEventManager()->attach(MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { return $response; }, 10); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testPostDispatchEventAllowsReplacingResponse() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $this->controller->getEventManager()->attach(MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { return $response; }, -10); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testEventManagerListensOnDispatchableInterfaceByDefault() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $this->sharedEvents->attach( - DispatchableInterface::class, + Dispatchable::class, MvcEvent::EVENT_DISPATCH, function ($e) use ($response) { return $response; }, 10 ); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testEventManagerListensOnRestfulControllerClassByDefault() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $this->sharedEvents->attach( AbstractRestfulController::class, MvcEvent::EVENT_DISPATCH, @@ -361,14 +416,14 @@ function ($e) use ($response) { }, 10 ); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testEventManagerListensOnClassNameByDefault() { $response = new Response(); - $response->setContent('short circuited!'); + $response->getBody()->write('short circuited!'); $this->sharedEvents->attach( get_class($this->controller), MvcEvent::EVENT_DISPATCH, @@ -377,13 +432,13 @@ function ($e) use ($response) { }, 10 ); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($this->request); $this->assertSame($response, $result); } public function testDispatchInjectsEventIntoController() { - $this->controller->dispatch($this->request, $this->response); + $this->controller->dispatch($this->request); $event = $this->controller->getEvent(); $this->assertNotNull($event); $this->assertSame($this->event, $event); @@ -414,11 +469,11 @@ public function testMethodOverloadingShouldInvokePluginAsFunctorIfPossible() public function testParsingDataAsJsonWillReturnAsArray() { - $this->request->setMethod('POST'); - $this->request->getHeaders()->addHeaderLine('Content-type', 'application/json'); - $this->request->setContent('{"foo":"bar"}'); + $request = $this->request->withMethod('POST') + ->withAddedHeader('Content-type', 'application/json'); + $request->getBody()->write('{"foo":"bar"}'); - $result = $this->controller->dispatch($this->request, $this->response); + $result = $this->controller->dispatch($request); $this->assertInternalType('array', $result); $this->assertEquals(['entity' => ['foo' => 'bar']], $result); } @@ -438,9 +493,9 @@ public function matchingContentTypes() */ public function testRequestingContentTypeReturnsTrueForValidMatches($contentType) { - $this->request->getHeaders()->addHeaderLine('Content-Type', $contentType); + $request = $this->request->withAddedHeader('Content-Type', $contentType); $this->assertTrue($this->controller->requestHasContentType( - $this->request, + $request, RestfulTestController::CONTENT_TYPE_JSON )); } @@ -458,18 +513,18 @@ public function nonMatchingContentTypes() */ public function testRequestingContentTypeReturnsFalseForInvalidMatches($contentType) { - $this->request->getHeaders()->addHeaderLine('Content-Type', $contentType); + $request = $this->request->withAddedHeader('Content-Type', $contentType); $this->assertFalse($this->controller->requestHasContentType( - $this->request, + $request, RestfulTestController::CONTENT_TYPE_JSON )); } public function testDispatchWithUnrecognizedMethodReturns405Response() { - $this->request->setMethod('PROPFIND'); - $result = $this->controller->dispatch($this->request, $this->response); - $this->assertInstanceOf(Response::class, $result); + $request = $this->request->withMethod('PROPFIND'); + $result = $this->controller->dispatch($request); + $this->assertInstanceOf(ResponseInterface::class, $result); $this->assertEquals(405, $result->getStatusCode()); } @@ -477,11 +532,14 @@ public function testDispatchInvokesGetMethodWhenNoActionPresentAndZeroIdentifier { $entity = new stdClass; $this->controller->entity = $entity; - $this->routeMatch->setParam('id', 0); - $result = $this->controller->dispatch($this->request, $this->response); + $request = $this->requestWithMatchedParams($this->request, ['id' => 0]); + $result = $this->controller->dispatch($request); $this->assertArrayHasKey('entity', $result); $this->assertEquals($entity, $result['entity']); - $this->assertEquals('get', $this->routeMatch->getParam('action')); + $this->assertEquals( + 'get', + $this->controller->getRequest()->getAttribute(RouteResult::class)->getMatchedParams()['action'] ?? null + ); } public function testIdentifierNameDefaultsToId() @@ -503,13 +561,13 @@ public function testUsesConfiguredIdentifierNameToGetIdentifier() $this->controller->setIdentifierName('name'); - $this->routeMatch->setParam('name', 'foo'); - $result = $getIdentifier->invoke($this->controller, $this->routeMatch, $this->request); + $request = $this->request->withAttribute('name', 'foo'); + $result = $getIdentifier->invoke($this->controller, $request); $this->assertEquals('foo', $result); - $this->routeMatch->setParam('name', false); - $this->request->getQuery()->set('name', 'bar'); - $result = $getIdentifier->invoke($this->controller, $this->routeMatch, $this->request); + $request = $this->request->withAttribute('name', false); + $request = $this->request->withQueryParams(['name' => 'bar']); + $result = $getIdentifier->invoke($this->controller, $request); $this->assertEquals('bar', $result); } @@ -518,21 +576,19 @@ public function testUsesConfiguredIdentifierNameToGetIdentifier() */ public function testNotImplementedMethodSets504HttpCode($method, $content, array $routeParams) { - $this->request->setMethod($method); + $request = $this->request->withMethod($method); if ($content) { - $this->request->setContent($content); + $request->getBody()->write($content); } - foreach ($routeParams as $name => $value) { - $this->routeMatch->setParam($name, $value); - } + $request = $this->requestWithMatchedParams($request, $routeParams); - $result = $this->emptyController->dispatch($this->request, $this->response); + $result = $this->emptyController->dispatch($request); $response = $this->emptyController->getResponse(); $this->assertEquals(405, $response->getStatusCode()); - $this->assertEquals('Method Not Allowed', $this->response->getReasonPhrase()); + $this->assertEquals('Method Not Allowed', $response->getReasonPhrase()); } public function providerNotImplementedMethodSets504HttpCodeProvider() diff --git a/test/Controller/TestAsset/BadController.php b/test/Controller/TestAsset/BadController.php index 72d39f857..41bd15674 100644 --- a/test/Controller/TestAsset/BadController.php +++ b/test/Controller/TestAsset/BadController.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractActionController; diff --git a/test/Controller/TestAsset/ControllerAcceptingConfigToConstructor.php b/test/Controller/TestAsset/ControllerAcceptingConfigToConstructor.php index 4f68b91e1..3f312ff12 100644 --- a/test/Controller/TestAsset/ControllerAcceptingConfigToConstructor.php +++ b/test/Controller/TestAsset/ControllerAcceptingConfigToConstructor.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractActionController; diff --git a/test/Controller/TestAsset/ControllerAcceptingWellKnownServicesAsConstructorParameters.php b/test/Controller/TestAsset/ControllerAcceptingWellKnownServicesAsConstructorParameters.php index 5e4a48fd8..65384d936 100644 --- a/test/Controller/TestAsset/ControllerAcceptingWellKnownServicesAsConstructorParameters.php +++ b/test/Controller/TestAsset/ControllerAcceptingWellKnownServicesAsConstructorParameters.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractActionController; diff --git a/test/Controller/TestAsset/ControllerLoaderAbstractFactory.php b/test/Controller/TestAsset/ControllerLoaderAbstractFactory.php index d5626ec8e..4d174062e 100644 --- a/test/Controller/TestAsset/ControllerLoaderAbstractFactory.php +++ b/test/Controller/TestAsset/ControllerLoaderAbstractFactory.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Interop\Container\ContainerInterface; diff --git a/test/Controller/TestAsset/ControllerWithEmptyConstructor.php b/test/Controller/TestAsset/ControllerWithEmptyConstructor.php index ec791c2a5..651a69674 100644 --- a/test/Controller/TestAsset/ControllerWithEmptyConstructor.php +++ b/test/Controller/TestAsset/ControllerWithEmptyConstructor.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractActionController; diff --git a/test/Controller/TestAsset/ControllerWithMixedConstructorParameters.php b/test/Controller/TestAsset/ControllerWithMixedConstructorParameters.php index ed2f2408b..0ddfb8208 100644 --- a/test/Controller/TestAsset/ControllerWithMixedConstructorParameters.php +++ b/test/Controller/TestAsset/ControllerWithMixedConstructorParameters.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractActionController; diff --git a/test/Controller/TestAsset/ControllerWithScalarParameters.php b/test/Controller/TestAsset/ControllerWithScalarParameters.php index 7cde14553..3cea036cf 100644 --- a/test/Controller/TestAsset/ControllerWithScalarParameters.php +++ b/test/Controller/TestAsset/ControllerWithScalarParameters.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractActionController; diff --git a/test/Controller/TestAsset/ControllerWithTypeHintedConstructorParameter.php b/test/Controller/TestAsset/ControllerWithTypeHintedConstructorParameter.php index 204fb1c2d..1c3bdfc0b 100644 --- a/test/Controller/TestAsset/ControllerWithTypeHintedConstructorParameter.php +++ b/test/Controller/TestAsset/ControllerWithTypeHintedConstructorParameter.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractActionController; diff --git a/test/Controller/TestAsset/ForwardController.php b/test/Controller/TestAsset/ForwardController.php index 89dfd49c9..e22f73f41 100644 --- a/test/Controller/TestAsset/ForwardController.php +++ b/test/Controller/TestAsset/ForwardController.php @@ -5,9 +5,12 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractActionController; +use Zend\Router\RouteResult; class ForwardController extends AbstractActionController { @@ -19,7 +22,7 @@ public function testAction() public function testMatchesAction() { $e = $this->getEvent(); - return $e->getRouteMatch()->getParams(); + return $e->getRequest()->getAttribute(RouteResult::class)->getMatchedParams(); } public function notFoundAction() diff --git a/test/Controller/TestAsset/Request.php b/test/Controller/TestAsset/Request.php index 837f3a405..16695aa77 100644 --- a/test/Controller/TestAsset/Request.php +++ b/test/Controller/TestAsset/Request.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Http\Request as HttpRequest; diff --git a/test/Controller/TestAsset/RestfulContentTypeTestController.php b/test/Controller/TestAsset/RestfulContentTypeTestController.php index 67c8767a9..fb8179ecc 100644 --- a/test/Controller/TestAsset/RestfulContentTypeTestController.php +++ b/test/Controller/TestAsset/RestfulContentTypeTestController.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractRestfulController; diff --git a/test/Controller/TestAsset/RestfulMethodNotAllowedTestController.php b/test/Controller/TestAsset/RestfulMethodNotAllowedTestController.php index c65efd817..6cccfb4d8 100644 --- a/test/Controller/TestAsset/RestfulMethodNotAllowedTestController.php +++ b/test/Controller/TestAsset/RestfulMethodNotAllowedTestController.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractRestfulController; diff --git a/test/Controller/TestAsset/RestfulTestController.php b/test/Controller/TestAsset/RestfulTestController.php index 2ea70f296..2bd7b374b 100644 --- a/test/Controller/TestAsset/RestfulTestController.php +++ b/test/Controller/TestAsset/RestfulTestController.php @@ -5,8 +5,12 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; use Zend\Mvc\Controller\AbstractRestfulController; class RestfulTestController extends AbstractRestfulController @@ -15,7 +19,7 @@ class RestfulTestController extends AbstractRestfulController public $entity = []; /** - * @var \Zend\Stdlib\ResponseInterface|null + * @var ResponseInterface|null */ public $headResponse; @@ -45,7 +49,7 @@ public function delete($id) /** * Delete the collection * - * @return \Zend\Http\Response + * @return ResponseInterface */ public function deleteList($data) { @@ -60,9 +64,9 @@ public function deleteList($data) } } - $response = $this->getResponse(); - $response->setStatusCode(204); - $response->getHeaders()->addHeaderLine('X-Deleted', 'true'); + $response = $this->getResponse() ?? new Response(); + $response = $response->withStatus(204) + ->withAddedHeader('X-Deleted', 'true'); return $response; } @@ -90,13 +94,13 @@ public function getList() /** * Retrieve the headers for a given resource - * - * @return void */ public function head($id = null) { if ($id) { - $this->getResponse()->getHeaders()->addHeaderLine('X-ZF2-Id', $id); + $this->getEvent()->setResponse( + ($this->getResponse() ?? new Response())->withAddedHeader('X-ZF2-Id', $id) + ); } if ($this->headResponse) { @@ -107,13 +111,12 @@ public function head($id = null) /** * Return list of allowed HTTP methods * - * @return \Zend\Http\Response + * @return ResponseInterface */ public function options() { - $response = $this->getResponse(); - $headers = $response->getHeaders(); - $headers->addHeaderLine('Allow', 'GET, POST, PUT, DELETE, PATCH, HEAD, TRACE'); + $response = $this->getResponse() ?? new Response(); + $response = $response->withAddedHeader('Allow', 'GET, POST, PUT, DELETE, PATCH, HEAD, TRACE'); return $response; } diff --git a/test/Controller/TestAsset/SampleController.php b/test/Controller/TestAsset/SampleController.php index 5fb42d06d..16ce21afe 100644 --- a/test/Controller/TestAsset/SampleController.php +++ b/test/Controller/TestAsset/SampleController.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\Mvc\Controller\AbstractActionController; diff --git a/test/Controller/TestAsset/SampleInterface.php b/test/Controller/TestAsset/SampleInterface.php index 995e5119a..cee2dfa6b 100644 --- a/test/Controller/TestAsset/SampleInterface.php +++ b/test/Controller/TestAsset/SampleInterface.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; interface SampleInterface diff --git a/test/Controller/TestAsset/UneventfulController.php b/test/Controller/TestAsset/UneventfulController.php index 1444147e3..68cc04e88 100644 --- a/test/Controller/TestAsset/UneventfulController.php +++ b/test/Controller/TestAsset/UneventfulController.php @@ -5,15 +5,17 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; -use Zend\Stdlib\DispatchableInterface; -use Zend\Stdlib\RequestInterface; -use Zend\Stdlib\ResponseInterface as Response; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Zend\Mvc\Controller\Dispatchable; -class UneventfulController implements DispatchableInterface +class UneventfulController implements Dispatchable { - public function dispatch(RequestInterface $request, Response $response = null) + public function dispatch(ServerRequestInterface $request, ResponseInterface $response = null) { } } diff --git a/test/Controller/TestAsset/UnlocatableControllerLoaderAbstractFactory.php b/test/Controller/TestAsset/UnlocatableControllerLoaderAbstractFactory.php index c9d2648a9..b8e5d4bcf 100644 --- a/test/Controller/TestAsset/UnlocatableControllerLoaderAbstractFactory.php +++ b/test/Controller/TestAsset/UnlocatableControllerLoaderAbstractFactory.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Interop\Container\ContainerInterface; diff --git a/test/Controller/TestAsset/UnlocatableEventfulController.php b/test/Controller/TestAsset/UnlocatableEventfulController.php index 98c3cfb78..5b74ee745 100644 --- a/test/Controller/TestAsset/UnlocatableEventfulController.php +++ b/test/Controller/TestAsset/UnlocatableEventfulController.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\Controller\TestAsset; use Zend\EventManager\EventInterface as Event; diff --git a/test/DispatchListenerTest.php b/test/DispatchListenerTest.php index 41da5d19f..2cf5d0ca0 100644 --- a/test/DispatchListenerTest.php +++ b/test/DispatchListenerTest.php @@ -5,40 +5,39 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc; use PHPUnit\Framework\TestCase; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManager; -use Zend\Http\Request; -use Zend\Http\Response; use Zend\Mvc\Application; use Zend\Mvc\Controller\ControllerManager; use Zend\Mvc\DispatchListener; use Zend\Mvc\MvcEvent; -use Zend\Router\RouteMatch; +use Zend\Router\RouteResult; use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\ResponseInterface; use Zend\View\Model\ModelInterface; class DispatchListenerTest extends TestCase { - public function createMvcEvent($controllerMatched) + public function createMvcEvent(string $controllerMatched) { - $response = new Response(); - $routeMatch = $this->prophesize(RouteMatch::class); - $routeMatch->getParam('controller', 'not-found')->willReturn('path'); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); - $eventManager = new EventManager(); + $routeResult = RouteResult::fromRouteMatch(['controller' => $controllerMatched]); + $request = $request->withAttribute(RouteResult::class, $routeResult); + $eventManager = new EventManager(); $application = $this->prophesize(Application::class); $application->getEventManager()->willReturn($eventManager); - $application->getResponse()->willReturn($response); $event = new MvcEvent(); - $event->setRequest(new Request()); - $event->setResponse($response); + $event->setRequest($request); $event->setApplication($application->reveal()); - $event->setRouteMatch($routeMatch->reveal()); return $event; } @@ -59,8 +58,9 @@ public function testControllerManagerUsingAbstractFactory() $return = $listener->onDispatch($event); - $this->assertEmpty($log, var_export($log, 1)); - $this->assertSame($event->getResponse(), $return); + $this->assertEmpty($log, var_export($log, true)); + // @TODO should response be set in mvc event? + // $this->assertSame($event->getResponse(), $return); $this->assertSame(200, $return->getStatusCode()); } @@ -122,7 +122,7 @@ public function alreadySetMvcEventResultProvider() [$this], [$this->createMock(ModelInterface::class)], [$this->createMock(ResponseInterface::class)], - [$this->createMock(Response::class)], + [new Response()], [['view model data' => 'as an array']], [['foo' => new \stdClass()]], ['a response string'], diff --git a/test/Exception/InvalidMiddlewareExceptionTest.php b/test/Exception/InvalidMiddlewareExceptionTest.php index 8311d7945..87b35fe25 100644 --- a/test/Exception/InvalidMiddlewareExceptionTest.php +++ b/test/Exception/InvalidMiddlewareExceptionTest.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc; use PHPUnit\Framework\TestCase; diff --git a/test/Exception/ReachedFinalHandlerExceptionTest.php b/test/Exception/ReachedFinalHandlerExceptionTest.php index 8628ddd5c..b420173a6 100644 --- a/test/Exception/ReachedFinalHandlerExceptionTest.php +++ b/test/Exception/ReachedFinalHandlerExceptionTest.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc; use PHPUnit\Framework\TestCase; diff --git a/test/HttpMethodListenerTest.php b/test/HttpMethodListenerTest.php index 86d033994..43c1c3409 100644 --- a/test/HttpMethodListenerTest.php +++ b/test/HttpMethodListenerTest.php @@ -5,16 +5,15 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManagerInterface; -use Zend\Http\Request as HttpRequest; -use Zend\Http\Response as HttpResponse; use Zend\Mvc\HttpMethodListener; use Zend\Mvc\MvcEvent; -use Zend\Stdlib\Request; -use Zend\Stdlib\Response; /** * @covers Zend\Mvc\HttpMethodListener @@ -64,26 +63,11 @@ public function testDoesntAttachIfDisabled() $this->listener->attach($eventManager); } - public function testOnRouteDoesNothingIfNotHttpEnvironment() - { - $event = new MvcEvent(); - $event->setRequest(new Request()); - - $this->assertNull($this->listener->onRoute($event)); - - $event->setRequest(new HttpRequest()); - $event->setResponse(new Response()); - - $this->assertNull($this->listener->onRoute($event)); - } - public function testOnRouteDoesNothingIfIfMethodIsAllowed() { $event = new MvcEvent(); - $request = new HttpRequest(); - $request->setMethod('foo'); + $request = new ServerRequest([], [], null, 'FOO', 'php://memory'); $event->setRequest($request); - $event->setResponse(new HttpResponse()); $this->listener->setAllowedMethods(['foo']); @@ -93,14 +77,12 @@ public function testOnRouteDoesNothingIfIfMethodIsAllowed() public function testOnRouteReturns405ResponseIfMethodNotAllowed() { $event = new MvcEvent(); - $request = new HttpRequest(); - $request->setMethod('foo'); + $request = new ServerRequest([], [], null, 'FOO', 'php://memory'); $event->setRequest($request); - $event->setResponse(new HttpResponse()); $response = $this->listener->onRoute($event); - $this->assertInstanceOf(HttpResponse::class, $response); + $this->assertNotNull($response); $this->assertSame(405, $response->getStatusCode()); } } diff --git a/test/MiddlewareListenerTest.php b/test/MiddlewareListenerTest.php index c11c7165c..fa4f01e4b 100644 --- a/test/MiddlewareListenerTest.php +++ b/test/MiddlewareListenerTest.php @@ -5,51 +5,53 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc; +use Exception; use Interop\Container\ContainerInterface; -use Interop\Http\ServerMiddleware\MiddlewareInterface; +use Psr\Http\Server\MiddlewareInterface; use PHPUnit\Framework\TestCase; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\RequestHandlerInterface; use Zend\Diactoros\Response\HtmlResponse; -use Zend\Diactoros\Response as DiactorosResponse; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManager; use Zend\EventManager\SharedEventManager; -use Zend\Http\Request; -use Zend\Http\Response; use Zend\Mvc\Application; +use Zend\Mvc\Controller\Dispatchable; use Zend\Mvc\Exception\InvalidMiddlewareException; use Zend\Mvc\Exception\ReachedFinalHandlerException; use Zend\Mvc\MiddlewareListener; use Zend\Mvc\MvcEvent; -use Zend\Router\RouteMatch; +use Zend\Router\RouteResult; use Zend\ServiceManager\ServiceManager; -use Zend\Stdlib\DispatchableInterface; +use Zend\Stratigility\Middleware\CallableMiddlewareDecorator; use Zend\View\Model\ModelInterface; class MiddlewareListenerTest extends TestCase { - /** - * @var \Prophecy\Prophecy\ObjectProphecy - */ - private $routeMatch; - /** * Create an MvcEvent, populated with everything it needs. * * @param string $middlewareMatched Middleware service matched by routing * @param mixed $middleware Value to return for middleware service + * @param array $matchedParams * @return MvcEvent */ - public function createMvcEvent($middlewareMatched, $middleware = null) + public function createMvcEvent($middlewareMatched, $middleware = null, array $matchedParams = []) { - $response = new Response(); - $this->routeMatch = $this->prophesize(RouteMatch::class); - $this->routeMatch->getParam('middleware', false)->willReturn($middlewareMatched); - $this->routeMatch->getParams()->willReturn([]); + $response = new Response(); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); - $eventManager = new EventManager(); + $matchedParams['middleware'] = $middlewareMatched; + $routeResult = RouteResult::fromRouteMatch($matchedParams); + $request = $request->withAttribute(RouteResult::class, $routeResult); + + $eventManager = new EventManager(); $serviceManager = new ServiceManager([ 'factories' => [ 'EventManager' => function () { @@ -63,42 +65,36 @@ public function createMvcEvent($middlewareMatched, $middleware = null) $application = $this->prophesize(Application::class); $application->getEventManager()->willReturn($eventManager); - $application->getServiceManager()->willReturn($serviceManager); - $application->getResponse()->willReturn($response); + $application->getContainer()->willReturn($serviceManager); $event = new MvcEvent(); - $event->setRequest(new Request()); + $event->setRequest($request); $event->setResponse($response); $event->setApplication($application->reveal()); - $event->setRouteMatch($this->routeMatch->reveal()); return $event; } public function testSuccessfullyDispatchesMiddleware() { - $event = $this->createMvcEvent('path', function ($request, $response) { - $this->assertInstanceOf(ServerRequestInterface::class, $request); - $this->assertInstanceOf(ResponseInterface::class, $response); - $response->getBody()->write('Test!'); + $response = new Response(); + $middleware = new CallableMiddlewareDecorator(function () use ($response) { return $response; }); + $event = $this->createMvcEvent('path', $middleware); $application = $event->getApplication(); $application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { - $this->fail(sprintf('dispatch.error triggered when it should not be: %s', var_export($e->getError(), 1))); + $this->fail(sprintf('dispatch.error triggered when it should not be: %s', var_export($e->getError(), true))); }); $listener = new MiddlewareListener(); - $return = $listener->onDispatch($event); - $this->assertInstanceOf(Response::class, $return); - - $this->assertInstanceOf(Response::class, $return); - $this->assertSame(200, $return->getStatusCode()); - $this->assertEquals('Test!', $return->getBody()); + $return = $listener->onDispatch($event); + $this->assertSame($response, $event->getResult()); + $this->assertSame($response, $return); } - public function testSuccessfullyDispatchesHttpInteropMiddleware() + public function testSuccessfullyDispatchesPsrMiddleware() { $expectedOutput = uniqid('expectedOutput', true); @@ -109,11 +105,11 @@ public function testSuccessfullyDispatchesHttpInteropMiddleware() $application = $event->getApplication(); $application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { - $this->fail(sprintf('dispatch.error triggered when it should not be: %s', var_export($e->getError(), 1))); + $this->fail(sprintf('dispatch.error triggered when it should not be: %s', var_export($e->getError(), true))); }); $listener = new MiddlewareListener(); - $return = $listener->onDispatch($event); + $return = $listener->onDispatch($event); $this->assertInstanceOf(Response::class, $return); $this->assertInstanceOf(Response::class, $return); @@ -121,92 +117,28 @@ public function testSuccessfullyDispatchesHttpInteropMiddleware() $this->assertEquals($expectedOutput, $return->getBody()); } - public function testMatchedRouteParamsAreInjectedToRequestAsAttributes() - { - $matchedRouteParam = uniqid('matched param', true); - $routeAttribute = null; - - $event = $this->createMvcEvent( - 'foo', - function (ServerRequestInterface $request, ResponseInterface $response) use (&$routeAttribute) { - $routeAttribute = $request->getAttribute(RouteMatch::class); - $response->getBody()->write($request->getAttribute('myParam', 'param did not exist')); - return $response; - } - ); - - $this->routeMatch->getParams()->willReturn([ - 'myParam' => $matchedRouteParam, - ]); - - $listener = new MiddlewareListener(); - $return = $listener->onDispatch($event); - $this->assertInstanceOf(Response::class, $return); - $this->assertSame($matchedRouteParam, $return->getBody()); - $this->assertSame($this->routeMatch->reveal(), $routeAttribute); - } - - public function testSuccessfullyDispatchesPipeOfCallableAndHttpInteropStyleMiddlewares() + public function testTriggersErrorForCallableMiddleware() { - $response = new Response(); - $routeMatch = $this->prophesize(RouteMatch::class); - $routeMatch->getParams()->willReturn([]); - $routeMatch->getParam('middleware', false)->willReturn([ - 'firstMiddleware', - 'secondMiddleware', - ]); - - $eventManager = new EventManager(); - - $serviceManager = $this->prophesize(ContainerInterface::class); - $serviceManager->get('EventManager')->willReturn($eventManager); - $serviceManager->has('firstMiddleware')->willReturn(true); - $serviceManager->get('firstMiddleware')->willReturn(function ($request, $response, $next) { - $this->assertInstanceOf(ServerRequestInterface::class, $request); - $this->assertInstanceOf(ResponseInterface::class, $response); - $this->assertTrue(is_callable($next)); - return $next($request->withAttribute('firstMiddlewareAttribute', 'firstMiddlewareValue'), $response); + $event = $this->createMvcEvent('path', function () { + return new Response(); }); - $secondMiddleware = $this->createMock(MiddlewareInterface::class); - $secondMiddleware->expects($this->once()) - ->method('process') - ->willReturnCallback(function (ServerRequestInterface $request) { - return new HtmlResponse($request->getAttribute('firstMiddlewareAttribute')); - }); - - $serviceManager->has('secondMiddleware')->willReturn(true); - $serviceManager->get('secondMiddleware')->willReturn($secondMiddleware); - - $application = $this->prophesize(Application::class); - $application->getEventManager()->willReturn($eventManager); - $application->getServiceManager()->will(function () use ($serviceManager) { - return $serviceManager->reveal(); - }); - $application->getResponse()->willReturn($response); - - $event = new MvcEvent(); - $event->setRequest(new Request()); - $event->setResponse($response); - $event->setApplication($application->reveal()); - $event->setRouteMatch($routeMatch->reveal()); + $application = $event->getApplication(); - $event->getApplication()->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { - $this->fail(sprintf('dispatch.error triggered when it should not be: %s', var_export($e->getError(), 1))); + $application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { + $this->assertEquals(Application::ERROR_MIDDLEWARE_CANNOT_DISPATCH, $e->getError()); + $this->assertEquals('Closure', $e->getController()); + return 'FAILED'; }); $listener = new MiddlewareListener(); - $return = $listener->onDispatch($event); - $this->assertInstanceOf(Response::class, $return); - - $this->assertInstanceOf('Zend\Http\Response', $return); - $this->assertSame(200, $return->getStatusCode()); - $this->assertEquals('firstMiddlewareValue', $return->getBody()); + $return = $listener->onDispatch($event); + $this->assertEquals('FAILED', $return); } public function testTriggersErrorForUncallableMiddleware() { - $event = $this->createMvcEvent('path'); + $event = $this->createMvcEvent('path'); $application = $event->getApplication(); $application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { @@ -216,16 +148,17 @@ public function testTriggersErrorForUncallableMiddleware() }); $listener = new MiddlewareListener(); - $return = $listener->onDispatch($event); + $return = $listener->onDispatch($event); $this->assertEquals('FAILED', $return); } public function testTriggersErrorForExceptionRaisedInMiddleware() { - $exception = new \Exception(); - $event = $this->createMvcEvent('path', function ($request, $response) use ($exception) { + $exception = new Exception(); + $middleware = new CallableMiddlewareDecorator(function () use ($exception) { throw $exception; }); + $event = $this->createMvcEvent('path', $middleware); $application = $event->getApplication(); $application->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) use ($exception) { @@ -235,7 +168,7 @@ public function testTriggersErrorForExceptionRaisedInMiddleware() }); $listener = new MiddlewareListener(); - $return = $listener->onDispatch($event); + $return = $listener->onDispatch($event); $this->assertEquals('FAILED', $return); } @@ -244,10 +177,11 @@ public function testTriggersErrorForExceptionRaisedInMiddleware() */ public function testCanLoadFromAbstractFactory() { - $response = new Response(); - $routeMatch = $this->prophesize(RouteMatch::class); - $routeMatch->getParam('middleware', false)->willReturn('test'); - $routeMatch->getParams()->willReturn([]); + $response = new Response(); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + + $routeResult = RouteResult::fromRouteMatch(['middleware' => 'test']); + $request = $request->withAttribute(RouteResult::class, $routeResult); $eventManager = new EventManager(); @@ -262,21 +196,19 @@ function () { $application = $this->prophesize(Application::class); $application->getEventManager()->willReturn($eventManager); - $application->getServiceManager()->willReturn($serviceManager); - $application->getResponse()->willReturn($response); + $application->getContainer()->willReturn($serviceManager); $event = new MvcEvent(); - $event->setRequest(new Request()); + $event->setRequest($request); $event->setResponse($response); $event->setApplication($application->reveal()); - $event->setRouteMatch($routeMatch->reveal()); $eventManager->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { - $this->fail(sprintf('dispatch.error triggered when it should not be: %s', var_export($e->getError(), 1))); + $this->fail(sprintf('dispatch.error triggered when it should not be: %s', var_export($e->getError(), true))); }); $listener = new MiddlewareListener(); - $return = $listener->onDispatch($event); + $return = $listener->onDispatch($event); $this->assertInstanceOf(Response::class, $return); $this->assertSame(200, $return->getStatusCode()); @@ -285,28 +217,27 @@ function () { public function testMiddlewareWithNothingPipedReachesFinalHandlerException() { - $response = new Response(); - $routeMatch = $this->prophesize(RouteMatch::class); - $routeMatch->getParams()->willReturn([]); - $routeMatch->getParam('middleware', false)->willReturn([]); + $response = new Response(); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + + $routeResult = RouteResult::fromRouteMatch(['middleware' => []]); + $request = $request->withAttribute(RouteResult::class, $routeResult); $eventManager = new EventManager(); $serviceManager = $this->prophesize(ContainerInterface::class); $application = $this->prophesize(Application::class); $application->getEventManager()->willReturn($eventManager); - $application->getServiceManager()->will(function () use ($serviceManager) { + $application->getContainer()->will(function () use ($serviceManager) { return $serviceManager->reveal(); }); - $application->getResponse()->willReturn($response); $serviceManager->get('EventManager')->willReturn($eventManager); $event = new MvcEvent(); - $event->setRequest(new Request()); + $event->setRequest($request); $event->setResponse($response); $event->setApplication($application->reveal()); - $event->setRouteMatch($routeMatch->reveal()); $event->getApplication()->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { $this->assertEquals(Application::ERROR_EXCEPTION, $e->getError()); @@ -315,32 +246,31 @@ public function testMiddlewareWithNothingPipedReachesFinalHandlerException() }); $listener = new MiddlewareListener(); - $return = $listener->onDispatch($event); + $return = $listener->onDispatch($event); $this->assertEquals('FAILED', $return); } public function testNullMiddlewareThrowsInvalidMiddlewareException() { - $response = new Response(); - $routeMatch = $this->prophesize(RouteMatch::class); - $routeMatch->getParams()->willReturn([]); - $routeMatch->getParam('middleware', false)->willReturn([null]); + $response = new Response(); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + + $routeResult = RouteResult::fromRouteMatch(['middleware' => [null]]); + $request = $request->withAttribute(RouteResult::class, $routeResult); $eventManager = new EventManager(); $serviceManager = $this->prophesize(ContainerInterface::class); $application = $this->prophesize(Application::class); $application->getEventManager()->willReturn($eventManager); - $application->getServiceManager()->will(function () use ($serviceManager) { + $application->getContainer()->will(function () use ($serviceManager) { return $serviceManager->reveal(); }); - $application->getResponse()->willReturn($response); $event = new MvcEvent(); - $event->setRequest(new Request()); + $event->setRequest($request); $event->setResponse($response); $event->setApplication($application->reveal()); - $event->setRouteMatch($routeMatch->reveal()); $event->getApplication()->getEventManager()->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) { $this->assertEquals(Application::ERROR_MIDDLEWARE_CANNOT_DISPATCH, $e->getError()); @@ -357,12 +287,15 @@ public function testNullMiddlewareThrowsInvalidMiddlewareException() public function testValidMiddlewareDispatchCancelsPreviousDispatchFailures() { $middlewareName = uniqid('middleware', true); - $routeMatch = new RouteMatch(['middleware' => $middlewareName]); - $response = new DiactorosResponse(); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + + $routeResult = RouteResult::fromRouteMatch(['middleware' => $middlewareName]); + $request = $request->withAttribute(RouteResult::class, $routeResult); + $response = new Response(); /* @var $application Application|\PHPUnit_Framework_MockObject_MockObject */ - $application = $this->createMock(Application::class); - $eventManager = new EventManager(); - $middleware = $this->getMockBuilder(\stdClass::class)->setMethods(['__invoke'])->getMock(); + $application = $this->createMock(Application::class); + $eventManager = new EventManager(); + $middleware = $this->getMockBuilder(MiddlewareInterface::class)->setMethods(['process'])->getMock(); $serviceManager = new ServiceManager([ 'factories' => [ 'EventManager' => function () { @@ -374,21 +307,18 @@ public function testValidMiddlewareDispatchCancelsPreviousDispatchFailures() ], ]); - $application->expects(self::any())->method('getRequest')->willReturn(new Request()); $application->expects(self::any())->method('getEventManager')->willReturn($eventManager); - $application->expects(self::any())->method('getServiceManager')->willReturn($serviceManager); - $application->expects(self::any())->method('getResponse')->willReturn(new Response()); - $middleware->expects(self::once())->method('__invoke')->willReturn($response); + $application->expects(self::any())->method('getContainer')->willReturn($serviceManager); + $middleware->expects(self::once())->method('process')->willReturn($response); $event = new MvcEvent(); - $event->setRequest(new Request()); + $event->setRequest($request); $event->setApplication($application); $event->setError(Application::ERROR_CONTROLLER_CANNOT_DISPATCH); - $event->setRouteMatch($routeMatch); $listener = new MiddlewareListener(); - $result = $listener->onDispatch($event); + $result = $listener->onDispatch($event); self::assertInstanceOf(Response::class, $result); self::assertInstanceOf(Response::class, $event->getResult()); @@ -398,15 +328,18 @@ public function testValidMiddlewareDispatchCancelsPreviousDispatchFailures() public function testValidMiddlewareFiresDispatchableInterfaceEventListeners() { $middlewareName = uniqid('middleware', true); - $routeMatch = new RouteMatch(['middleware' => $middlewareName]); - $response = new DiactorosResponse(); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + + $routeResult = RouteResult::fromRouteMatch(['middleware' => $middlewareName]); + $request = $request->withAttribute(RouteResult::class, $routeResult); + $response = new Response(); /* @var $application Application|\PHPUnit_Framework_MockObject_MockObject */ - $application = $this->createMock(Application::class); - $sharedManager = new SharedEventManager(); + $application = $this->createMock(Application::class); + $sharedManager = new SharedEventManager(); /* @var $sharedListener callable|\PHPUnit_Framework_MockObject_MockObject */ $sharedListener = $this->getMockBuilder(\stdClass::class)->setMethods(['__invoke'])->getMock(); - $eventManager = new EventManager(); - $middleware = $this->getMockBuilder(\stdClass::class)->setMethods(['__invoke'])->getMock(); + $eventManager = new EventManager(); + $middleware = $this->getMockBuilder(MiddlewareInterface::class)->setMethods(['process'])->getMock(); $serviceManager = new ServiceManager([ 'factories' => [ 'EventManager' => function () use ($sharedManager) { @@ -418,22 +351,19 @@ public function testValidMiddlewareFiresDispatchableInterfaceEventListeners() ], ]); - $application->expects(self::any())->method('getRequest')->willReturn(new Request()); $application->expects(self::any())->method('getEventManager')->willReturn($eventManager); - $application->expects(self::any())->method('getServiceManager')->willReturn($serviceManager); - $application->expects(self::any())->method('getResponse')->willReturn(new Response()); - $middleware->expects(self::once())->method('__invoke')->willReturn($response); + $application->expects(self::any())->method('getContainer')->willReturn($serviceManager); + $middleware->expects(self::once())->method('process')->willReturn($response); $event = new MvcEvent(); - $event->setRequest(new Request()); + $event->setRequest($request); $event->setApplication($application); $event->setError(Application::ERROR_CONTROLLER_CANNOT_DISPATCH); - $event->setRouteMatch($routeMatch); $listener = new MiddlewareListener(); - $sharedManager->attach(DispatchableInterface::class, MvcEvent::EVENT_DISPATCH, $sharedListener); + $sharedManager->attach(Dispatchable::class, MvcEvent::EVENT_DISPATCH, $sharedListener, 9001); $sharedListener->expects(self::once())->method('__invoke')->with($event); $listener->onDispatch($event); @@ -447,11 +377,14 @@ public function testValidMiddlewareFiresDispatchableInterfaceEventListeners() public function testWillNotDispatchWhenAnMvcEventResultIsAlreadySet($alreadySetResult) { $middlewareName = uniqid('middleware', true); - $routeMatch = new RouteMatch(['middleware' => $middlewareName]); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + + $routeResult = RouteResult::fromRouteMatch(['middleware' => $middlewareName]); + $request = $request->withAttribute(RouteResult::class, $routeResult); /* @var $application Application|\PHPUnit_Framework_MockObject_MockObject */ - $application = $this->createMock(Application::class); - $eventManager = new EventManager(); - $middleware = $this->getMockBuilder(\stdClass::class)->setMethods(['__invoke'])->getMock(); + $application = $this->createMock(Application::class); + $eventManager = new EventManager(); + $middleware = $this->getMockBuilder(\stdClass::class)->setMethods(['__invoke'])->getMock(); $serviceManager = new ServiceManager([ 'factories' => [ 'EventManager' => function () { @@ -463,19 +396,16 @@ public function testWillNotDispatchWhenAnMvcEventResultIsAlreadySet($alreadySetR ], ]); - $application->expects(self::any())->method('getRequest')->willReturn(new Request()); $application->expects(self::any())->method('getEventManager')->willReturn($eventManager); - $application->expects(self::any())->method('getServiceManager')->willReturn($serviceManager); - $application->expects(self::any())->method('getResponse')->willReturn(new Response()); + $application->expects(self::any())->method('getContainer')->willReturn($serviceManager); $middleware->expects(self::never())->method('__invoke'); $event = new MvcEvent(); $event->setResult($alreadySetResult); // a result is already there - listener should bail out early - $event->setRequest(new Request()); + $event->setRequest($request); $event->setApplication($application); $event->setError(Application::ERROR_CONTROLLER_CANNOT_DISPATCH); - $event->setRouteMatch($routeMatch); $listener = new MiddlewareListener(); @@ -501,7 +431,7 @@ public function alreadySetMvcEventResultProvider() [new \stdClass()], [$this], [$this->createMock(ModelInterface::class)], - [$this->createMock(Response::class)], + [$this->createMock(ResponseInterface::class)], [['view model data' => 'as an array']], [['foo' => new \stdClass()]], ['a response string'], diff --git a/test/ModuleRouteListenerTest.php b/test/ModuleRouteListenerTest.php deleted file mode 100644 index 622f54f05..000000000 --- a/test/ModuleRouteListenerTest.php +++ /dev/null @@ -1,137 +0,0 @@ -request = new Request(); - $this->events = new EventManager(); - $this->router = new Router\Http\TreeRouteStack(); - $this->routeListener = new RouteListener(); - $this->moduleRouteListener = new ModuleRouteListener(); - - $this->routeListener->attach($this->events); - $this->moduleRouteListener->attach($this->events, -1); - } - - public function testRouteReturningModuleNamespaceInRouteMatchTriggersControllerRename() - { - $this->router->addRoute('foo', [ - 'type' => 'Literal', - 'options' => [ - 'route' => '/foo', - 'defaults' => [ - ModuleRouteListener::MODULE_NAMESPACE => 'Foo', - 'controller' => 'Index', - ], - ], - ]); - $this->request->setUri('/foo'); - $event = new MvcEvent(); - $event->setName('route'); - $event->setRouter($this->router); - $event->setRequest($this->request); - $this->events->triggerEvent($event); - - $matches = $event->getRouteMatch(); - $this->assertInstanceOf(RouteMatch::class, $matches); - $this->assertEquals('Foo\Index', $matches->getParam('controller')); - $this->assertEquals('Index', $matches->getParam(ModuleRouteListener::ORIGINAL_CONTROLLER)); - } - - public function testRouteNotReturningModuleNamespaceInRouteMatchLeavesControllerUntouched() - { - $this->router->addRoute('foo', [ - 'type' => 'Literal', - 'options' => [ - 'route' => '/foo', - 'defaults' => [ - 'controller' => 'Index', - ], - ], - ]); - $this->request->setUri('/foo'); - $event = new MvcEvent(); - $event->setName('route'); - $event->setRouter($this->router); - $event->setRequest($this->request); - $this->events->triggerEvent($event); - - $matches = $event->getRouteMatch(); - $this->assertInstanceOf(RouteMatch::class, $matches); - $this->assertEquals('Index', $matches->getParam('controller')); - } - - public function testMultipleRegistrationShouldNotResultInMultiplePrefixingOfControllerName() - { - $moduleListener = new ModuleRouteListener(); - $moduleListener->attach($this->events); - - $this->router->addRoute('foo', [ - 'type' => 'Literal', - 'options' => [ - 'route' => '/foo', - 'defaults' => [ - ModuleRouteListener::MODULE_NAMESPACE => 'Foo', - 'controller' => 'Index', - ], - ], - ]); - $this->request->setUri('/foo'); - $event = new MvcEvent(); - $event->setName('route'); - $event->setRouter($this->router); - $event->setRequest($this->request); - $this->events->triggerEvent($event); - - $matches = $event->getRouteMatch(); - $this->assertInstanceOf(RouteMatch::class, $matches); - $this->assertEquals('Foo\Index', $matches->getParam('controller')); - $this->assertEquals('Index', $matches->getParam(ModuleRouteListener::ORIGINAL_CONTROLLER)); - } - - public function testRouteMatchIsTransformedToProperControllerClassName() - { - $moduleListener = new ModuleRouteListener(); - $moduleListener->attach($this->events); - - $this->router->addRoute('foo', [ - 'type' => 'Literal', - 'options' => [ - 'route' => '/foo', - 'defaults' => [ - ModuleRouteListener::MODULE_NAMESPACE => 'Foo', - 'controller' => 'some-index', - ], - ], - ]); - - $this->request->setUri('/foo'); - $event = new MvcEvent(); - $event->setName('route'); - $event->setRouter($this->router); - $event->setRequest($this->request); - $this->events->triggerEvent($event); - - $matches = $event->getRouteMatch(); - $this->assertInstanceOf(RouteMatch::class, $matches); - $this->assertEquals('Foo\SomeIndex', $matches->getParam('controller')); - $this->assertEquals('some-index', $matches->getParam(ModuleRouteListener::ORIGINAL_CONTROLLER)); - } -} diff --git a/test/ResponseSender/AbstractResponseSenderTest.php b/test/ResponseSender/AbstractResponseSenderTest.php deleted file mode 100644 index 05f14bb2d..000000000 --- a/test/ResponseSender/AbstractResponseSenderTest.php +++ /dev/null @@ -1,102 +0,0 @@ -markTestSkipped('Xdebug extension needed, skipped test'); - } - $headers = [ - 'Content-Length: 2000', - 'Transfer-Encoding: chunked' - ]; - $response = new Response(); - $response->getHeaders()->addHeaders($headers); - - $mockSendResponseEvent = $this->getMockBuilder(SendResponseEvent::class) - ->setMethods(['getResponse']) - ->getMock(); - - $mockSendResponseEvent->expects( - $this->any() - ) - ->method('getResponse') - ->will($this->returnValue($response)); - - $responseSender = $this->getMockForAbstractClass(AbstractResponseSender::class); - $responseSender->sendHeaders($mockSendResponseEvent); - - $sentHeaders = xdebug_get_headers(); - $diff = array_diff($sentHeaders, $headers); - - if (count($diff)) { - $header = array_shift($diff); - $this->assertContains('XDEBUG_SESSION', $header); - $this->assertEquals(0, count($diff)); - } - - $expected = []; - if (version_compare(phpversion('xdebug'), '2.2.0', '>=')) { - $expected = xdebug_get_headers(); - } - - $responseSender->sendHeaders($mockSendResponseEvent); - $this->assertEquals($expected, xdebug_get_headers()); - } - - /** - * @runInSeparateProcess - */ - public function testSendHeadersSendsStatusLast() - { - if (! function_exists('xdebug_get_headers')) { - $this->markTestSkipped('Xdebug extension needed, skipped test'); - } - - $mockResponse = $this->createMock(Response::class); - $mockResponse - ->expects($this->once()) - ->method('getHeaders') - ->will($this->returnValue(Headers::fromString('Location: example.com'))); - $mockResponse - ->expects($this->once()) - ->method('renderStatusLine') - ->will($this->returnValue('X-Test: HTTP/1.1 202 Accepted')); - - $mockSendResponseEvent = $this->getMockBuilder(SendResponseEvent::class) - ->setMethods(['getResponse']) - ->getMock(); - $mockSendResponseEvent->expects($this->any())->method('getResponse')->will($this->returnValue($mockResponse)); - - $responseSender = $this->getMockForAbstractClass(AbstractResponseSender::class); - $responseSender->sendHeaders($mockSendResponseEvent); - - $sentHeaders = xdebug_get_headers(); - - $this->assertCount(2, $sentHeaders); - $this->assertEquals('Location: example.com', $sentHeaders[0]); - $this->assertEquals( - 'X-Test: HTTP/1.1 202 Accepted', - $sentHeaders[1], - 'Status header is sent last to prevent header() from overwriting the ZF status code when a Location ' - . 'header is used' - ); - } -} diff --git a/test/ResponseSender/PhpEnvironmentResponseSenderTest.php b/test/ResponseSender/PhpEnvironmentResponseSenderTest.php deleted file mode 100644 index be983e243..000000000 --- a/test/ResponseSender/PhpEnvironmentResponseSenderTest.php +++ /dev/null @@ -1,67 +0,0 @@ -getMockForAbstractClass(ResponseInterface::class); - $mockSendResponseEvent = $this->getSendResponseEventMock(); - $mockSendResponseEvent->expects($this->any())->method('getResponse')->will($this->returnValue($mockResponse)); - $responseSender = new PhpEnvironmentResponseSender(); - ob_start(); - $responseSender($mockSendResponseEvent); - $body = ob_get_clean(); - $this->assertEquals('', $body); - } - - public function testSendResponseTwoTimesPrintsResponseOnlyOnce() - { - $mockResponse = $this->createMock(Response::class); - $mockResponse->expects($this->any())->method('getContent')->will($this->returnValue('body')); - $mockSendResponseEvent = $this->getSendResponseEventMock(); - $mockSendResponseEvent->expects($this->any())->method('getResponse')->will($this->returnValue($mockResponse)); - $mockSendResponseEvent->expects($this->once())->method('setContentSent'); - $responseSender = new PhpEnvironmentResponseSender(); - ob_start(); - $responseSender($mockSendResponseEvent); - $body = ob_get_clean(); - $this->assertEquals('body', $body); - - ob_start(); - $responseSender($mockSendResponseEvent); - $body = ob_get_clean(); - $this->assertEquals('', $body); - } - - protected function getSendResponseEventMock() - { - $returnValue = false; - $mockSendResponseEvent = $this->getMockBuilder(SendResponseEvent::class) - ->setMethods(['getResponse', 'contentSent', 'setContentSent']) - ->getMock(); - - $mockSendResponseEvent->expects($this->any()) - ->method('contentSent') - ->will($this->returnCallback(function () use (&$returnValue) { - if (false === $returnValue) { - $returnValue = true; - return false; - } - return true; - })); - return $mockSendResponseEvent; - } -} diff --git a/test/ResponseSender/SendResponseEventTest.php b/test/ResponseSender/SendResponseEventTest.php deleted file mode 100644 index e8eb9d2bc..000000000 --- a/test/ResponseSender/SendResponseEventTest.php +++ /dev/null @@ -1,32 +0,0 @@ -getMockForAbstractClass(ResponseInterface::class); - $mockResponse2 = $this->getMockForAbstractClass(ResponseInterface::class); - $event = new SendResponseEvent(); - $event->setResponse($mockResponse); - $this->assertFalse($event->headersSent()); - $this->assertFalse($event->contentSent()); - $event->setHeadersSent(); - $event->setContentSent(); - $this->assertTrue($event->headersSent()); - $this->assertTrue($event->contentSent()); - $event->setResponse($mockResponse2); - $this->assertFalse($event->headersSent()); - $this->assertFalse($event->contentSent()); - } -} diff --git a/test/ResponseSender/SimpleStreamResponseSenderTest.php b/test/ResponseSender/SimpleStreamResponseSenderTest.php deleted file mode 100644 index aca16d9ed..000000000 --- a/test/ResponseSender/SimpleStreamResponseSenderTest.php +++ /dev/null @@ -1,56 +0,0 @@ -getMockForAbstractClass(Stdlib\ResponseInterface::class); - $mockSendResponseEvent = $this->getSendResponseEventMock($mockResponse); - $responseSender = new SimpleStreamResponseSender(); - ob_start(); - $responseSender($mockSendResponseEvent); - $body = ob_get_clean(); - $this->assertEquals('', $body); - } - - public function testSendResponseTwoTimesPrintsResponseOnlyOnce() - { - $file = fopen(__DIR__ . '/TestAsset/sample-stream-file.txt', 'rb'); - $mockResponse = $this->createMock(Response\Stream::class); - $mockResponse->expects($this->once())->method('getStream')->will($this->returnValue($file)); - $mockSendResponseEvent = $this->getSendResponseEventMock($mockResponse); - $responseSender = new SimpleStreamResponseSender(); - ob_start(); - $responseSender($mockSendResponseEvent); - $body = ob_get_clean(); - $expected = file_get_contents(__DIR__ . '/TestAsset/sample-stream-file.txt'); - $this->assertEquals($expected, $body); - - ob_start(); - $responseSender($mockSendResponseEvent); - $body = ob_get_clean(); - $this->assertEquals('', $body); - } - - protected function getSendResponseEventMock($response) - { - $mockSendResponseEvent = $this->getMockBuilder(ResponseSender\SendResponseEvent::class) - ->setMethods(['getResponse']) - ->getMock(); - $mockSendResponseEvent->expects($this->any())->method('getResponse')->will($this->returnValue($response)); - return $mockSendResponseEvent; - } -} diff --git a/test/ResponseSender/TestAsset/sample-stream-file.txt b/test/ResponseSender/TestAsset/sample-stream-file.txt deleted file mode 100644 index a63f5a148..000000000 --- a/test/ResponseSender/TestAsset/sample-stream-file.txt +++ /dev/null @@ -1,10 +0,0 @@ -/** - * Zend Framework (http://framework.zend.com/) - * - * @link http://github.com/zendframework/zf2 for the canonical source repository - * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) - * @license http://framework.zend.com/license/new-bsd New BSD License - * @package Zend_Mvc - */ - -This is a sample file that will be streamed during the unit tests. \ No newline at end of file diff --git a/test/SendResponseListenerTest.php b/test/SendResponseListenerTest.php deleted file mode 100644 index d0b75d0a2..000000000 --- a/test/SendResponseListenerTest.php +++ /dev/null @@ -1,46 +0,0 @@ -getEventManager()->getIdentifiers(); - $expected = [SendResponseListener::class]; - $this->assertEquals($expected, array_values($identifiers)); - } - - public function testSendResponseTriggersSendResponseEvent() - { - $listener = new SendResponseListener(); - $result = []; - $listener->getEventManager()->attach(SendResponseEvent::EVENT_SEND_RESPONSE, function ($e) use (&$result) { - $result['target'] = $e->getTarget(); - $result['response'] = $e->getResponse(); - }, 10000); - $mockResponse = $this->getMockForAbstractClass(ResponseInterface::class); - $mockMvcEvent = $this->getMockBuilder(MvcEvent::class) - ->setMethods(['getResponse']) - ->getMock(); - $mockMvcEvent->expects($this->any())->method('getResponse')->will($this->returnValue($mockResponse)); - $listener->sendResponse($mockMvcEvent); - $expected = [ - 'target' => $listener, - 'response' => $mockResponse - ]; - $this->assertEquals($expected, $result); - } -} diff --git a/test/Service/ControllerManagerFactoryTest.php b/test/Service/ControllerManagerFactoryTest.php deleted file mode 100644 index 39aa57ddc..000000000 --- a/test/Service/ControllerManagerFactoryTest.php +++ /dev/null @@ -1,109 +0,0 @@ -defaultServiceConfig = [ - 'aliases' => [ - 'SharedEventManager' => SharedEventManager::class, - ], - 'factories' => [ - 'ControllerManager' => $loaderFactory, - 'ControllerPluginManager' => ControllerPluginManagerFactory::class, - 'EventManager' => EventManagerFactory::class, - SharedEventManager::class => InvokableFactory::class, - ], - 'services' => [ - 'config' => [], - ], - ]; - $this->services = new ServiceManager(); - (new Config($this->defaultServiceConfig))->configureServiceManager($this->services); - } - - public function testCannotLoadInvalidDispatchable() - { - $loader = $this->services->get('ControllerManager'); - - // Ensure the class exists and can be autoloaded - $this->assertTrue(class_exists(InvalidDispatchableClass::class)); - - try { - $loader->get(InvalidDispatchableClass::class); - $this->fail('Retrieving the invalid dispatchable should fail'); - } catch (\Exception $e) { - do { - $this->assertNotContains('Should not instantiate this', $e->getMessage()); - } while ($e = $e->getPrevious()); - } - } - - public function testCannotLoadControllerFromPeer() - { - $services = new ServiceManager(); - (new Config(array_merge_recursive($this->defaultServiceConfig, ['services' => [ - 'foo' => $this, - ]])))->configureServiceManager($services); - $loader = $services->get('ControllerManager'); - - $this->expectException(Exception\ExceptionInterface::class); - $loader->get('foo'); - } - - public function testControllerLoadedCanBeInjectedWithValuesFromPeer() - { - $loader = $this->services->get('ControllerManager'); - $loader->setAlias('ZendTest\Dispatchable', TestAsset\Dispatchable::class); - $loader->setFactory(TestAsset\Dispatchable::class, InvokableFactory::class); - - $controller = $loader->get('ZendTest\Dispatchable'); - $this->assertInstanceOf(TestAsset\Dispatchable::class, $controller); - $this->assertSame($this->services->get('EventManager'), $controller->getEventManager()); - $this->assertSame($this->services->get('ControllerPluginManager'), $controller->getPluginManager()); - } - - public function testCallPluginWithControllerPluginManager() - { - $controllerPluginManager = $this->services->get('ControllerPluginManager'); - $controllerPluginManager->setAlias('samplePlugin', SamplePlugin::class); - $controllerPluginManager->setFactory(SamplePlugin::class, InvokableFactory::class); - - $controller = new SampleController; - $controllerPluginManager->setController($controller); - - $plugin = $controllerPluginManager->get('samplePlugin'); - $this->assertEquals($controller, $plugin->getController()); - } -} diff --git a/test/Service/RequestFactoryTest.php b/test/Service/RequestFactoryTest.php deleted file mode 100644 index bf3382e6c..000000000 --- a/test/Service/RequestFactoryTest.php +++ /dev/null @@ -1,23 +0,0 @@ -prophesize(ContainerInterface::class)->reveal(), 'Request'); - $this->assertInstanceOf(HttpRequest::class, $request); - } -} diff --git a/test/Service/ResponseFactoryTest.php b/test/Service/ResponseFactoryTest.php deleted file mode 100644 index 47c6a6142..000000000 --- a/test/Service/ResponseFactoryTest.php +++ /dev/null @@ -1,23 +0,0 @@ -prophesize(ContainerInterface::class)->reveal(), 'Response'); - $this->assertInstanceOf(HttpResponse::class, $response); - } -} diff --git a/test/Service/SendResponseListenerFactoryTest.php b/test/Service/SendResponseListenerFactoryTest.php deleted file mode 100644 index e9adc2f22..000000000 --- a/test/Service/SendResponseListenerFactoryTest.php +++ /dev/null @@ -1,55 +0,0 @@ -prophesize(SharedEventManagerInterface::class); - $events = $this->prophesize(EventManagerInterface::class); - $events->getSharedManager()->will([$sharedEvents, 'reveal']); - - $events->setIdentifiers([SendResponseListener::class, SendResponseListener::class])->shouldBeCalled(); - $events->attach( - SendResponseEvent::EVENT_SEND_RESPONSE, - Argument::type(PhpEnvironmentResponseSender::class), - -1000 - )->shouldBeCalled(); - $events->attach( - SendResponseEvent::EVENT_SEND_RESPONSE, - Argument::type(SimpleStreamResponseSender::class), - -3000 - )->shouldBeCalled(); - $events->attach( - SendResponseEvent::EVENT_SEND_RESPONSE, - Argument::type(HttpResponseSender::class), - -4000 - )->shouldBeCalled(); - - $container = $this->prophesize(ContainerInterface::class); - $container->get('EventManager')->will([$events, 'reveal']); - - $factory = new SendResponseListenerFactory(); - $listener = $factory($container->reveal()); - $this->assertInstanceOf(SendResponseListener::class, $listener); - $this->assertSame($events->reveal(), $listener->getEventManager()); - } -} diff --git a/test/Service/ServiceListenerFactoryTest.php b/test/Service/ServiceListenerFactoryTest.php deleted file mode 100644 index 0d71cb93a..000000000 --- a/test/Service/ServiceListenerFactoryTest.php +++ /dev/null @@ -1,184 +0,0 @@ -sm = $this->getMockBuilder(ServiceManager::class) - ->setMethods(['get']) - ->getMock(); - - $this->factory = new ServiceListenerFactory(); - } - - /** - * @expectedException Zend\ServiceManager\Exception\ServiceNotCreatedException - * @expectedExceptionMessage The value of service_listener_options must be an array, string given. - */ - public function testInvalidOptionType() - { - $this->sm->expects($this->once()) - ->method('get') - ->will($this->returnValue(['service_listener_options' => 'string'])); - - $this->factory->__invoke($this->sm, 'ServiceListener'); - } - - /** - * @expectedException Zend\ServiceManager\Exception\ServiceNotCreatedException - * @expectedExceptionMessage Invalid service listener options detected, 0 array must contain service_manager key. - */ - public function testMissingServiceManager() - { - $config['service_listener_options'][0]['service_manager'] = null; - $config['service_listener_options'][0]['config_key'] = 'test'; - $config['service_listener_options'][0]['interface'] = 'test'; - $config['service_listener_options'][0]['method'] = 'test'; - - $this->sm->expects($this->once()) - ->method('get') - ->will($this->returnValue($config)); - - $this->factory->__invoke($this->sm, 'ServiceListener'); - } - - /** - * @expectedException Zend\ServiceManager\Exception\ServiceNotCreatedException - * @expectedExceptionMessage Invalid service listener options detected, service_manager must be a string, - * integer given. - */ - public function testInvalidTypeServiceManager() - { - $config['service_listener_options'][0]['service_manager'] = 1; - $config['service_listener_options'][0]['config_key'] = 'test'; - $config['service_listener_options'][0]['interface'] = 'test'; - $config['service_listener_options'][0]['method'] = 'test'; - - $this->sm->expects($this->once()) - ->method('get') - ->will($this->returnValue($config)); - - $this->factory->__invoke($this->sm, 'ServiceListener'); - } - - /** - * @expectedException Zend\ServiceManager\Exception\ServiceNotCreatedException - * @expectedExceptionMessage Invalid service listener options detected, 0 array must contain config_key key. - */ - public function testMissingConfigKey() - { - $config['service_listener_options'][0]['service_manager'] = 'test'; - $config['service_listener_options'][0]['config_key'] = null; - $config['service_listener_options'][0]['interface'] = 'test'; - $config['service_listener_options'][0]['method'] = 'test'; - - $this->sm->expects($this->once()) - ->method('get') - ->will($this->returnValue($config)); - - $this->factory->__invoke($this->sm, 'ServiceListener'); - } - - /** - * @expectedException Zend\ServiceManager\Exception\ServiceNotCreatedException - * @expectedExceptionMessage Invalid service listener options detected, config_key must be a string, integer given. - */ - public function testInvalidTypeConfigKey() - { - $config['service_listener_options'][0]['service_manager'] = 'test'; - $config['service_listener_options'][0]['config_key'] = 1; - $config['service_listener_options'][0]['interface'] = 'test'; - $config['service_listener_options'][0]['method'] = 'test'; - - $this->sm->expects($this->once()) - ->method('get') - ->will($this->returnValue($config)); - - $this->factory->__invoke($this->sm, 'ServiceListener'); - } - - /** - * @expectedException Zend\ServiceManager\Exception\ServiceNotCreatedException - * @expectedExceptionMessage Invalid service listener options detected, 0 array must contain interface key. - */ - public function testMissingInterface() - { - $config['service_listener_options'][0]['service_manager'] = 'test'; - $config['service_listener_options'][0]['config_key'] = 'test'; - $config['service_listener_options'][0]['interface'] = null; - $config['service_listener_options'][0]['method'] = 'test'; - - $this->sm->expects($this->once()) - ->method('get') - ->will($this->returnValue($config)); - - $this->factory->__invoke($this->sm, 'ServiceListener'); - } - - /** - * @expectedException Zend\ServiceManager\Exception\ServiceNotCreatedException - * @expectedExceptionMessage Invalid service listener options detected, interface must be a string, integer given. - */ - public function testInvalidTypeInterface() - { - $config['service_listener_options'][0]['service_manager'] = 'test'; - $config['service_listener_options'][0]['config_key'] = 'test'; - $config['service_listener_options'][0]['interface'] = 1; - $config['service_listener_options'][0]['method'] = 'test'; - - $this->sm->expects($this->once()) - ->method('get') - ->will($this->returnValue($config)); - - $this->factory->__invoke($this->sm, 'ServiceListener'); - } - - /** - * @expectedException Zend\ServiceManager\Exception\ServiceNotCreatedException - * @expectedExceptionMessage Invalid service listener options detected, 0 array must contain method key. - */ - public function testMissingMethod() - { - $config['service_listener_options'][0]['service_manager'] = 'test'; - $config['service_listener_options'][0]['config_key'] = 'test'; - $config['service_listener_options'][0]['interface'] = 'test'; - $config['service_listener_options'][0]['method'] = null; - - $this->sm->expects($this->once()) - ->method('get') - ->will($this->returnValue($config)); - - $this->factory->__invoke($this->sm, 'ServiceListener'); - } - - /** - * @expectedException Zend\ServiceManager\Exception\ServiceNotCreatedException - * @expectedExceptionMessage Invalid service listener options detected, method must be a string, integer given. - */ - public function testInvalidTypeMethod() - { - $config['service_listener_options'][0]['service_manager'] = 'test'; - $config['service_listener_options'][0]['config_key'] = 'test'; - $config['service_listener_options'][0]['interface'] = 'test'; - $config['service_listener_options'][0]['method'] = 1; - - $this->sm->expects($this->once()) - ->method('get') - ->will($this->returnValue($config)); - - $this->factory->__invoke($this->sm, 'ServiceListener'); - } -} diff --git a/test/Service/ServiceManagerConfigTest.php b/test/Service/ServiceManagerConfigTest.php deleted file mode 100644 index c767403e8..000000000 --- a/test/Service/ServiceManagerConfigTest.php +++ /dev/null @@ -1,198 +0,0 @@ -config = new ServiceManagerConfig(); - $this->services = new ServiceManager(); - $this->config->configureServiceManager($this->services); - } - - /** - * @param null|SharedEventManagerInterface - * @return EventManager - */ - protected function createEventManager(SharedEventManagerInterface $sharedManager = null) - { - return new EventManager($sharedManager ?: $this->services->get('SharedEventManager')); - } - - /** - * @group 3786 - */ - public function testEventManagerAwareInterfaceIsNotInjectedIfPresentButSharedManagerIs() - { - $events = $this->createEventManager(); - EventManagerAwareObject::$defaultEvents = $events; - - $this->services->setAlias('EventManagerAwareObject', EventManagerAwareObject::class); - $this->services->setFactory(EventManagerAwareObject::class, InvokableFactory::class); - - $instance = $this->services->get('EventManagerAwareObject'); - $this->assertInstanceOf(EventManagerAwareObject::class, $instance); - $this->assertSame($events, $instance->getEventManager()); - $this->assertSame($this->services->get('SharedEventManager'), $events->getSharedManager()); - } - - /** - * @group 6266 - */ - public function testCanMergeCustomConfigWithDefaultConfig() - { - $custom = [ - 'invokables' => [ - 'foo' => stdClass::class, - ], - 'factories' => [ - 'bar' => function () { - return new stdClass(); - }, - ], - ]; - - $sm = new ServiceManager(); - (new ServiceManagerConfig($custom))->configureServiceManager($sm); - - $this->assertTrue($sm->has('foo')); - $this->assertTrue($sm->has('bar')); - $this->assertTrue($sm->has('ModuleManager')); - } - - /** - * @group 6266 - */ - public function testCanOverrideDefaultConfigWithCustomConfig() - { - $custom = [ - 'invokables' => [ - 'foo' => stdClass::class, - ], - 'factories' => [ - 'ModuleManager' => function () { - return new stdClass(); - }, - ], - ]; - - $sm = new ServiceManager(); - (new ServiceManagerConfig($custom))->configureServiceManager($sm); - - $this->assertTrue($sm->has('foo')); - $this->assertTrue($sm->has('ModuleManager')); - - $this->assertInstanceOf(stdClass::class, $sm->get('ModuleManager')); - } - - /** - * @group 6266 - */ - public function testCanAddDelegators() - { - /* - * Create delegator closure - */ - $delegator = function ($container, $name, $callback, array $options = null) { - $service = $callback(); - $service->bar = 'baz'; - return $service; - }; - - $config = [ - 'aliases' => [ - 'foo' => stdClass::class, - ], - 'factories' => [ - stdClass::class => InvokableFactory::class, - ], - 'delegators' => [ - stdClass::class => [ $delegator ], - ], - ]; - - $sm = new ServiceManager(); - (new ServiceManagerConfig($config))->configureServiceManager($sm); - - $std = $sm->get('foo'); - $this->assertInstanceOf(stdClass::class, $std); - $this->assertEquals('baz', $std->bar); - } - - /** - * @group 6266 - */ - public function testEventManagerInitializerCanBeReplaced() - { - $instance = $this->createMock(EventManagerAwareInterface::class); - $initializer = $this->getMockBuilder(stdClass::class) - ->setMethods(['__invoke']) - ->getMock(); - $config = new ServiceManagerConfig([ - 'initializers' => [ - 'EventManagerAwareInitializer' => $initializer, - ], - 'factories' => [ - 'EventManagerAware' => function () use ($instance) { - return $instance; - }, - ], - ]); - $serviceManager = new ServiceManager(); - $config->configureServiceManager($serviceManager); - - $initializer->expects($this->once())->method('__invoke')->with($serviceManager, $instance); - - $instance->expects($this->never())->method('getEventManager'); - $instance->expects($this->never())->method('setEventManager'); - - $serviceManager->get('EventManagerAware'); - } - - /** - * @group 101 - */ - public function testCreatesAFactoryForTheServiceManagerThatReturnsIt() - { - $serviceManager = new ServiceManager(); - $config = new ServiceManagerConfig(); - $config->configureServiceManager($serviceManager); - - $this->assertTrue($serviceManager->has('ServiceManager'), 'Missing ServiceManager service!'); - $this->assertSame($serviceManager, $serviceManager->get('ServiceManager')); - } -} diff --git a/test/Service/TestAsset/ControllerWithDependencies.php b/test/Service/TestAsset/ControllerWithDependencies.php deleted file mode 100644 index b7b4c41eb..000000000 --- a/test/Service/TestAsset/ControllerWithDependencies.php +++ /dev/null @@ -1,32 +0,0 @@ -injectedValue = $injected; - } - - public function dispatch(RequestInterface $request, ResponseInterface $response = null) - { - } -} diff --git a/test/Service/TestAsset/Dispatchable.php b/test/Service/TestAsset/Dispatchable.php deleted file mode 100644 index 4c5de0272..000000000 --- a/test/Service/TestAsset/Dispatchable.php +++ /dev/null @@ -1,21 +0,0 @@ -events; - } -} diff --git a/test/Service/TestAsset/EventManagerAwareObject.php b/test/Service/TestAsset/EventManagerAwareObject.php deleted file mode 100644 index 61478abde..000000000 --- a/test/Service/TestAsset/EventManagerAwareObject.php +++ /dev/null @@ -1,39 +0,0 @@ -events = $events; - } - - /** - * @return EventManagerInterface - */ - public function getEventManager() - { - if (! $this->events instanceof EventManagerInterface - && static::$defaultEvents instanceof EventManagerInterface - ) { - $this->setEventManager(static::$defaultEvents); - } - return $this->events; - } -} diff --git a/test/Service/TestAsset/InvalidDispatchableClass.php b/test/Service/TestAsset/InvalidDispatchableClass.php deleted file mode 100644 index 6e01df4a9..000000000 --- a/test/Service/TestAsset/InvalidDispatchableClass.php +++ /dev/null @@ -1,18 +0,0 @@ -prophesize(HttpViewManager::class); - $container = $this->prophesize(ContainerInterface::class); - $container->get('HttpViewManager')->will(function () use ($http) { - return $http->reveal(); - }); - return $container->reveal(); - } - - public function testReturnsHttpViewManager() - { - $factory = new ViewManagerFactory(); - $result = $factory($this->createContainer(), 'ViewManager'); - $this->assertInstanceOf(HttpViewManager::class, $result); - } -} diff --git a/test/TestAsset/ApplicationConfigHelper.php b/test/TestAsset/ApplicationConfigHelper.php new file mode 100644 index 000000000..261410b46 --- /dev/null +++ b/test/TestAsset/ApplicationConfigHelper.php @@ -0,0 +1,41 @@ +services[$name])) { - throw new ServiceNotFoundException(); - } - - return call_user_func_array($this->services[$name]); - } - - public function has($name) - { - return (isset($this->services[$name])); - } - - public function build($name, array $options = null) - { - if (! isset($this->services[$name])) { - throw new ServiceNotFoundException(); - } - - return call_user_func_array($this->services[$name], $options); - } - - public function add($name, $callback) - { - $this->services[$name] = $callback; - } - - public function remove($name) - { - if (isset($this->services[$name])) { - unset($this->services[$name]); - } - } -} diff --git a/test/TestAsset/Middleware.php b/test/TestAsset/Middleware.php index 289bc3b12..a0b125d58 100644 --- a/test/TestAsset/Middleware.php +++ b/test/TestAsset/Middleware.php @@ -5,15 +5,25 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\TestAsset; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\ResponseInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Zend\Diactoros\Response; -class Middleware +class Middleware implements MiddlewareInterface { - public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next = null) + /** + * Process an incoming server request and return a response, optionally delegating + * response creation to a handler. + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface { + $response = new Response(); $response->getBody()->write(__CLASS__); return $response; } diff --git a/test/TestAsset/MiddlewareAbstractFactory.php b/test/TestAsset/MiddlewareAbstractFactory.php index ccde7d726..d6456387f 100644 --- a/test/TestAsset/MiddlewareAbstractFactory.php +++ b/test/TestAsset/MiddlewareAbstractFactory.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\TestAsset; use Interop\Container\ContainerInterface; diff --git a/test/TestAsset/MockSendResponseListener.php b/test/TestAsset/MockSendResponseListener.php deleted file mode 100644 index 850314031..000000000 --- a/test/TestAsset/MockSendResponseListener.php +++ /dev/null @@ -1,24 +0,0 @@ -listeners[] = $events->attach(MvcEvent::EVENT_FINISH, [$this, 'sendResponse'], -10000); - } - - public function sendResponse($e) - { - } -} diff --git a/test/TestAsset/MockViewManager.php b/test/TestAsset/MockViewManager.php index d97a52256..6e6a02f6c 100644 --- a/test/TestAsset/MockViewManager.php +++ b/test/TestAsset/MockViewManager.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\TestAsset; use Zend\EventManager\AbstractListenerAggregate; diff --git a/test/TestAsset/PathController.php b/test/TestAsset/PathController.php index 44e7631e3..d03aca84b 100644 --- a/test/TestAsset/PathController.php +++ b/test/TestAsset/PathController.php @@ -5,20 +5,20 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\TestAsset; -use Zend\Stdlib\DispatchableInterface; -use Zend\Stdlib\RequestInterface as Request; -use Zend\Stdlib\ResponseInterface as Response; +use Psr\Http\Message\ServerRequestInterface as Request; +use Zend\Diactoros\Response; +use Zend\Mvc\Controller\Dispatchable; -class PathController implements DispatchableInterface +class PathController implements Dispatchable { - public function dispatch(Request $request, Response $response = null) + public function dispatch(Request $request) { - if (! $response) { - $response = new HttpResponse(); - } - $response->setContent(__METHOD__); + $response = new Response(); + $response->getBody()->write(__METHOD__); return $response; } } diff --git a/test/TestAsset/StubBootstrapListener.php b/test/TestAsset/StubBootstrapListener.php index b3a8528fb..f8c15946b 100644 --- a/test/TestAsset/StubBootstrapListener.php +++ b/test/TestAsset/StubBootstrapListener.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\TestAsset; use Zend\EventManager\ListenerAggregateInterface; diff --git a/test/View/CreateViewModelListenerTest.php b/test/View/CreateViewModelListenerTest.php index dc2eb7fa1..894437b95 100644 --- a/test/View/CreateViewModelListenerTest.php +++ b/test/View/CreateViewModelListenerTest.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\View; use PHPUnit\Framework\TestCase; diff --git a/test/View/DefaultRendereringStrategyTest.php b/test/View/DefaultRendereringStrategyTest.php index a608877dd..6aed0d104 100644 --- a/test/View/DefaultRendereringStrategyTest.php +++ b/test/View/DefaultRendereringStrategyTest.php @@ -5,15 +5,16 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\View; use PHPUnit\Framework\TestCase; -use Zend\EventManager\Event; +use Zend\Diactoros\Response; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManager; use Zend\EventManager\SharedEventManager; use Zend\EventManager\Test\EventListenerIntrospectionTrait; -use Zend\Http\Request; -use Zend\Http\Response; use Zend\Mvc\Application; use Zend\Mvc\MvcEvent; use Zend\Mvc\View\Http\DefaultRenderingStrategy; @@ -39,13 +40,13 @@ class DefaultRendereringStrategyTest extends TestCase public function setUp() { $this->view = new View(); - $this->request = new Request(); + $this->request = new ServerRequest([], [], null, 'GET', 'php://memory'); $this->response = new Response(); $this->event = new MvcEvent(); $this->renderer = new PhpRenderer(); - $this->event->setRequest($this->request) - ->setResponse($this->response); + $this->event->setRequest($this->request); + $this->event->setResponse($this->response); $this->strategy = new DefaultRenderingStrategy($this->view); } @@ -123,6 +124,7 @@ public function testBypassesRenderingIfResultIsAResponse() public function testTriggersRenderErrorEventInCaseOfRenderingException() { + $this->markTestIncomplete('Tests needs to be updated'); $resolver = new TemplateMapResolver(); $resolver->add('exception', __DIR__ . '/_files/exception.phtml'); $this->renderer->setResolver($resolver); @@ -155,7 +157,7 @@ public function testTriggersRenderErrorEventInCaseOfRenderingException() ], ]))->configureServiceManager($services); - $application = new Application($services, $services->get('EventManager'), $this->request, $this->response); + $application = new Application($services, $services->get('EventManager')); $this->event->setApplication($application); $test = (object) ['flag' => false]; diff --git a/test/View/ExceptionStrategyTest.php b/test/View/ExceptionStrategyTest.php index e61b6e450..9626bdecf 100644 --- a/test/View/ExceptionStrategyTest.php +++ b/test/View/ExceptionStrategyTest.php @@ -5,12 +5,14 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\View; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\Response; use Zend\EventManager\EventManager; use Zend\EventManager\Test\EventListenerIntrospectionTrait; -use Zend\Http\Response; use Zend\Mvc\Application; use Zend\Mvc\MvcEvent; use Zend\Mvc\View\Http\ExceptionStrategy; @@ -20,6 +22,11 @@ class ExceptionStrategyTest extends TestCase { use EventListenerIntrospectionTrait; + /** + * @var ExceptionStrategy + */ + private $strategy; + public function setUp() { $this->strategy = new ExceptionStrategy(); @@ -79,7 +86,7 @@ public function testCatchesApplicationExceptions() $this->strategy->prepareExceptionViewModel($event); $response = $event->getResponse(); - $this->assertTrue($response->isServerError()); + $this->assertEquals(500, $response->getStatusCode()); $model = $event->getResult(); $this->assertInstanceOf(ViewModel::class, $model); @@ -103,7 +110,7 @@ public function testCatchesUnknownErrorTypes() $this->strategy->prepareExceptionViewModel($event); $response = $event->getResponse(); - $this->assertTrue($response->isServerError()); + $this->assertEquals(500, $response->getStatusCode()); } public function testEmptyErrorInEventResultsInNoOperations() @@ -134,7 +141,8 @@ public function testDoesNothingIfEventResultIsAResponse() $event->setResult($response); $event->setError('foobar'); - $this->assertNull($this->strategy->prepareExceptionViewModel($event)); + $this->strategy->prepareExceptionViewModel($event); + $this->assertSame($response, $event->getResponse()); } public function testAttachesListenerAtExpectedPriority() @@ -165,7 +173,7 @@ public function testReuseResponseStatusCodeIfItExists() { $event = new MvcEvent(); $response = new Response(); - $response->setStatusCode(401); + $response = $response->withStatus(401); $event->setResponse($response); $this->strategy->prepareExceptionViewModel($event); $response = $event->getResponse(); diff --git a/test/View/Http/ViewManagerTest.php b/test/View/Http/ViewManagerTest.php new file mode 100644 index 000000000..3bc8cf78e --- /dev/null +++ b/test/View/Http/ViewManagerTest.php @@ -0,0 +1,24 @@ +markTestIncomplete('ViewManager needs tests'); + } +} diff --git a/test/View/InjectTemplateListenerTest.php b/test/View/InjectTemplateListenerTest.php index 8636bfde8..abcc34deb 100644 --- a/test/View/InjectTemplateListenerTest.php +++ b/test/View/InjectTemplateListenerTest.php @@ -5,15 +5,17 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\View; use PHPUnit\Framework\TestCase; +use Zend\Diactoros\ServerRequest; use Zend\EventManager\EventManager; use Zend\EventManager\Test\EventListenerIntrospectionTrait; -use Zend\Mvc\ModuleRouteListener; use Zend\Mvc\MvcEvent; -use Zend\Router\RouteMatch; use Zend\Mvc\View\Http\InjectTemplateListener; +use Zend\Router\RouteResult; use Zend\View\Model\ViewModel; use ZendTest\Mvc\Controller\TestAsset\SampleController; @@ -21,23 +23,28 @@ class InjectTemplateListenerTest extends TestCase { use EventListenerIntrospectionTrait; + /** + * @var MvcEvent + */ + private $event; + public function setUp() { - $controllerMap = [ - 'MappedNs' => true, - 'ZendTest\MappedNs' => true, - ]; $this->listener = new InjectTemplateListener(); - $this->listener->setControllerMap($controllerMap); $this->event = new MvcEvent(); - $this->routeMatch = new RouteMatch([]); - $this->event->setRouteMatch($this->routeMatch); + $request = new ServerRequest([], [], null, 'GET', 'php://memory'); + $this->event->setRequest($request); } public function testSetsTemplateBasedOnRouteMatchIfNoTemplateIsSetOnViewModel() { - $this->routeMatch->setParam('controller', 'Foo\Controller\SomewhatController'); - $this->routeMatch->setParam('action', 'useful'); + $result = RouteResult::fromRouteMatch([ + 'controller' => 'Foo\Controller\SomewhatController', + 'action' => 'useful', + ]); + $this->event->setRequest( + $this->event->getRequest()->withAttribute(RouteResult::class, $result) + ); $model = new ViewModel(); $this->event->setResult($model); @@ -49,7 +56,12 @@ public function testSetsTemplateBasedOnRouteMatchIfNoTemplateIsSetOnViewModel() public function testUsesModuleAndControllerOnlyIfNoActionInRouteMatch() { - $this->routeMatch->setParam('controller', 'Foo\Controller\SomewhatController'); + $result = RouteResult::fromRouteMatch([ + 'controller' => 'Foo\Controller\SomewhatController', + ]); + $this->event->setRequest( + $this->event->getRequest()->withAttribute(RouteResult::class, $result) + ); $model = new ViewModel(); $this->event->setResult($model); @@ -61,7 +73,12 @@ public function testUsesModuleAndControllerOnlyIfNoActionInRouteMatch() public function testNormalizesLiteralControllerNameIfNoNamespaceSeparatorPresent() { - $this->routeMatch->setParam('controller', 'SomewhatController'); + $result = RouteResult::fromRouteMatch([ + 'controller' => 'SomewhatController', + ]); + $this->event->setRequest( + $this->event->getRequest()->withAttribute(RouteResult::class, $result) + ); $model = new ViewModel(); $this->event->setResult($model); @@ -73,8 +90,13 @@ public function testNormalizesLiteralControllerNameIfNoNamespaceSeparatorPresent public function testNormalizesNamesToLowercase() { - $this->routeMatch->setParam('controller', 'Somewhat.DerivedController'); - $this->routeMatch->setParam('action', 'some-UberCool'); + $result = RouteResult::fromRouteMatch([ + 'controller' => 'Somewhat.DerivedController', + 'action' => 'some-UberCool', + ]); + $this->event->setRequest( + $this->event->getRequest()->withAttribute(RouteResult::class, $result) + ); $model = new ViewModel(); $this->event->setResult($model); @@ -92,8 +114,13 @@ public function testLackOfViewModelInResultBypassesTemplateInjection() public function testBypassesTemplateInjectionIfResultViewModelAlreadyHasATemplate() { - $this->routeMatch->setParam('controller', 'Foo\Controller\SomewhatController'); - $this->routeMatch->setParam('action', 'useful'); + $result = RouteResult::fromRouteMatch([ + 'controller' => 'Foo\Controller\SomewhatController', + 'action' => 'useful', + ]); + $this->event->setRequest( + $this->event->getRequest()->withAttribute(RouteResult::class, $result) + ); $model = new ViewModel(); $model->setTemplate('custom'); @@ -116,84 +143,14 @@ public function testMapsSubNamespaceToSubDirectory() $this->assertEquals('zend-test/mvc/test-asset/sample', $myViewModel->getTemplate()); } - public function testMapsSubNamespaceToSubDirectoryWithControllerFromRouteMatch() - { - $this->routeMatch->setParam(ModuleRouteListener::MODULE_NAMESPACE, 'Aj\Controller\SweetAppleAcres\Reports'); - $this->routeMatch->setParam('controller', 'CiderSales'); - $this->routeMatch->setParam('action', 'PinkiePieRevenue'); - - $moduleRouteListener = new ModuleRouteListener; - $moduleRouteListener->onRoute($this->event); - - $model = new ViewModel(); - $this->event->setResult($model); - $this->listener->injectTemplate($this->event); - - $this->assertEquals('aj/sweet-apple-acres/reports/cider-sales/pinkie-pie-revenue', $model->getTemplate()); - } - - public function testMapsSubNamespaceToSubDirectoryWithControllerFromRouteMatchHavingSubNamespace() - { - $this->routeMatch->setParam(ModuleRouteListener::MODULE_NAMESPACE, 'Aj\Controller\SweetAppleAcres\Reports'); - $this->routeMatch->setParam('controller', 'Sub\CiderSales'); - $this->routeMatch->setParam('action', 'PinkiePieRevenue'); - - $moduleRouteListener = new ModuleRouteListener; - $moduleRouteListener->onRoute($this->event); - - $model = new ViewModel(); - $this->event->setResult($model); - $this->listener->injectTemplate($this->event); - - $this->assertEquals('aj/sweet-apple-acres/reports/sub/cider-sales/pinkie-pie-revenue', $model->getTemplate()); - } - - public function testMapsSubNamespaceToSubDirectoryWithControllerFromEventTarget() - { - $this->routeMatch->setParam(ModuleRouteListener::MODULE_NAMESPACE, 'ZendTest\Mvc\Controller\TestAsset'); - $this->routeMatch->setParam('action', 'test'); - - $moduleRouteListener = new ModuleRouteListener; - $moduleRouteListener->onRoute($this->event); - - $myViewModel = new ViewModel(); - $myController = new SampleController(); - - $this->event->setTarget($myController); - $this->event->setResult($myViewModel); - $this->listener->injectTemplate($this->event); - - $this->assertEquals('zend-test/mvc/test-asset/sample/test', $myViewModel->getTemplate()); - } - - public function testMapsSubNamespaceToSubDirectoryWithControllerFromEventTargetShouldMatchControllerFromRouteParam() - { - $this->routeMatch->setParam(ModuleRouteListener::MODULE_NAMESPACE, 'ZendTest\Mvc\Controller'); - $this->routeMatch->setParam('controller', 'TestAsset\SampleController'); - $this->routeMatch->setParam('action', 'test'); - - $moduleRouteListener = new ModuleRouteListener; - $moduleRouteListener->onRoute($this->event); - - $myViewModel = new ViewModel(); - $this->event->setResult($myViewModel); - $this->listener->injectTemplate($this->event); - - $template1 = $myViewModel->getTemplate(); - - $myViewModel = new ViewModel(); - $myController = new SampleController(); - - $this->event->setTarget($myController); - $this->event->setResult($myViewModel); - $this->listener->injectTemplate($this->event); - - $this->assertEquals($template1, $myViewModel->getTemplate()); - } - public function testControllerMatchedByMapIsInflected() { - $this->routeMatch->setParam('controller', 'MappedNs\SubNs\Controller\Sample'); + $result = RouteResult::fromRouteMatch([ + 'controller' => 'MappedNs\SubNs\Controller\Sample', + ]); + $this->event->setRequest( + $this->event->getRequest()->withAttribute(RouteResult::class, $result) + ); $myViewModel = new ViewModel(); $this->event->setResult($myViewModel); @@ -201,7 +158,6 @@ public function testControllerMatchedByMapIsInflected() $this->assertEquals('mapped-ns/sub-ns/sample', $myViewModel->getTemplate()); - $this->listener->setControllerMap(['ZendTest' => true]); $myViewModel = new ViewModel(); $myController = new SampleController(); $this->event->setTarget($myController); @@ -240,30 +196,6 @@ public function testControllerMapMatchedPrefixReplacedByStringValue() $this->assertEquals('string-value/index', $template); } - public function testUsingNamespaceRouteParameterGivesSameResultAsFullControllerParameter() - { - $this->routeMatch->setParam('controller', 'MappedNs\Foo\Controller\Bar\Baz\Sample'); - $myViewModel = new ViewModel(); - - $this->event->setResult($myViewModel); - $this->listener->injectTemplate($this->event); - - $template1 = $myViewModel->getTemplate(); - - $this->routeMatch->setParam(ModuleRouteListener::MODULE_NAMESPACE, 'MappedNs\Foo\Controller\Bar'); - $this->routeMatch->setParam('controller', 'Baz\Sample'); - - $moduleRouteListener = new ModuleRouteListener; - $moduleRouteListener->onRoute($this->event); - - $myViewModel = new ViewModel(); - - $this->event->setResult($myViewModel); - $this->listener->injectTemplate($this->event); - - $this->assertEquals($template1, $myViewModel->getTemplate()); - } - public function testControllerMapOnlyFullNamespaceMatches() { $this->listener->setControllerMap([ @@ -325,11 +257,17 @@ public function testDetachesListeners() $this->assertEquals(0, count($listeners)); } - public function testPrefersRouteMatchController() + public function testPrefersRouteResultController() { - $this->assertFalse($this->listener->isPreferRouteMatchController()); - $this->listener->setPreferRouteMatchController(true); - $this->routeMatch->setParam('controller', 'Some\Other\Service\Namespace\Controller\Sample'); + $this->assertFalse($this->listener->isPreferRouteResultController()); + $this->listener->setPreferRouteResultController(true); + + $result = RouteResult::fromRouteMatch([ + 'controller' => 'Some\Other\Service\Namespace\Controller\Sample', + ]); + $this->event->setRequest( + $this->event->getRequest()->withAttribute(RouteResult::class, $result) + ); $myViewModel = new ViewModel(); $myController = new SampleController(); @@ -342,19 +280,19 @@ public function testPrefersRouteMatchController() public function testPrefersRouteMatchControllerWithRouteMatchAndControllerMap() { - $this->assertFalse($this->listener->isPreferRouteMatchController()); + $this->assertFalse($this->listener->isPreferRouteResultController()); $controllerMap = [ 'Some\Other\Service\Namespace\Controller\Sample' => 'another/sample' ]; - $this->routeMatch->setParam('prefer_route_match_controller', true); - $this->routeMatch->setParam('controller', 'Some\Other\Service\Namespace\Controller\Sample'); - - $preferRouteMatchControllerRouteMatchConfig = $this->routeMatch->getParam( - 'prefer_route_match_controller', - false + $result = RouteResult::fromRouteMatch([ + 'prefer_route_result_controller' => true, + 'controller' => 'Some\Other\Service\Namespace\Controller\Sample', + ]); + $this->event->setRequest( + $this->event->getRequest()->withAttribute(RouteResult::class, $result) ); - $this->listener->setPreferRouteMatchController($preferRouteMatchControllerRouteMatchConfig); + $this->listener->setControllerMap($controllerMap); $myViewModel = new ViewModel(); diff --git a/test/View/InjectViewModelListenerTest.php b/test/View/InjectViewModelListenerTest.php index e8401d87a..731e4c69e 100644 --- a/test/View/InjectViewModelListenerTest.php +++ b/test/View/InjectViewModelListenerTest.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\View; use PHPUnit\Framework\TestCase; @@ -12,7 +14,6 @@ use Zend\EventManager\Test\EventListenerIntrospectionTrait; use Zend\Mvc\MvcEvent; use Zend\Mvc\View\Http\InjectViewModelListener; -use Zend\Router\RouteMatch; use Zend\View\Model\ViewModel; class InjectViewModelListenerTest extends TestCase @@ -23,8 +24,6 @@ public function setUp() { $this->listener = new InjectViewModelListener(); $this->event = new MvcEvent(); - $this->routeMatch = new RouteMatch([]); - $this->event->setRouteMatch($this->routeMatch); } public function testReplacesEventModelWithChildModelIfChildIsMarkedTerminal() diff --git a/test/View/RouteNotFoundStrategyTest.php b/test/View/RouteNotFoundStrategyTest.php index 5766ddad3..6a593070b 100644 --- a/test/View/RouteNotFoundStrategyTest.php +++ b/test/View/RouteNotFoundStrategyTest.php @@ -5,12 +5,15 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\View; use PHPUnit\Framework\TestCase; +use Psr\Http\Message\ResponseInterface; +use Zend\Diactoros\Response; use Zend\EventManager\EventManager; use Zend\EventManager\Test\EventListenerIntrospectionTrait; -use Zend\Http\Response; use Zend\Mvc\Application; use Zend\Mvc\MvcEvent; use Zend\Mvc\View\Http\RouteNotFoundStrategy; @@ -48,7 +51,7 @@ public function testLeavesReturnedMessageIntact($result, $assertion) { $response = new Response(); $event = new MvcEvent(); - $response->setStatusCode(404); + $response = $response->withStatus(404); $event->setResponse($response); $event->setResult($result); @@ -80,12 +83,11 @@ public function test404ErrorsInject404ResponseStatusCode() 'error-controller-invalid' => Application::ERROR_CONTROLLER_INVALID, 'error-router-no-match' => Application::ERROR_ROUTER_NO_MATCH, ]; - $event->setResponse($response); foreach ($errors as $key => $error) { - $response->setStatusCode(200); + $event->setResponse($response); $event->setError($error); $this->strategy->detectNotFoundError($event); - $this->assertTrue($response->isNotFound(), 'Failed asserting against ' . $key); + $this->assertEquals(404, $event->getResponse()->getStatusCode(), 'Failed asserting against ' . $key); } } @@ -98,11 +100,10 @@ public function testRouterAndDispatchErrorsInjectReasonInViewModelWhenAllowed() 'error-controller-invalid' => Application::ERROR_CONTROLLER_INVALID, 'error-router-no-match' => Application::ERROR_ROUTER_NO_MATCH, ]; - $event->setResponse($response); foreach ([true, false] as $allow) { $this->strategy->setDisplayNotFoundReason($allow); foreach ($errors as $key => $error) { - $response->setStatusCode(200); + $event->setResponse($response); $event->setResult(null); $event->setError($error); $this->strategy->detectNotFoundError($event); @@ -130,10 +131,10 @@ public function testNon404ErrorsInjectNoStatusCode() null, ]; foreach ($errors as $error) { - $response->setStatusCode(200); + $event->setResponse($response); $event->setError($error); $this->strategy->detectNotFoundError($event); - $this->assertFalse($response->isNotFound()); + $this->assertNotEquals(404, $event->getResponse()->getStatusCode()); } } @@ -141,8 +142,8 @@ public function testResponseAsResultDoesNotPrepare404ViewModel() { $response = new Response(); $event = new MvcEvent(); - $event->setResponse($response) - ->setResult($response); + $event->setResponse($response); + $event->setResult($response); $this->strategy->prepareNotFoundViewModel($event); $model = $event->getResult(); @@ -159,7 +160,6 @@ public function testNon404ResponseDoesNotPrepare404ViewModel() { $response = new Response(); $event = new MvcEvent(); - $response->setStatusCode(200); $event->setResponse($response); $this->strategy->prepareNotFoundViewModel($event); @@ -173,11 +173,26 @@ public function testNon404ResponseDoesNotPrepare404ViewModel() $this->addToAssertionCount(1); } + public function testOnNoResponseDoesNotPrepare404ViewModel() + { + $event = new MvcEvent(); + + $this->strategy->prepareNotFoundViewModel($event); + $model = $event->getResult(); + if ($model instanceof ViewModel) { + $this->assertNotEquals($this->strategy->getNotFoundTemplate(), $model->getTemplate()); + $variables = $model->getVariables(); + $this->assertArrayNotHasKey('message', $variables); + } + + $this->addToAssertionCount(1); + } + public function test404ResponsePrepares404ViewModelWithTemplateFromStrategy() { $response = new Response(); $event = new MvcEvent(); - $response->setStatusCode(404); + $response = $response->withStatus(404); $event->setResponse($response); $this->strategy->prepareNotFoundViewModel($event); @@ -191,11 +206,11 @@ public function test404ResponsePrepares404ViewModelWithTemplateFromStrategy() public function test404ResponsePrepares404ViewModelWithReasonWhenAllowed() { $response = new Response(); + $response = $response->withStatus(404); $event = new MvcEvent(); foreach ([true, false] as $allow) { $this->strategy->setDisplayNotFoundReason($allow); - $response->setStatusCode(404); $event->setResult(null); $event->setResponse($response); $this->strategy->prepareNotFoundViewModel($event); @@ -214,13 +229,13 @@ public function test404ResponsePrepares404ViewModelWithReasonWhenAllowed() public function test404ResponsePrepares404ViewModelWithExceptionWhenAllowed() { $response = new Response(); + $response = $response->withStatus(404); $event = new MvcEvent(); $exception = new \Exception(); $event->setParam('exception', $exception); foreach ([true, false] as $allow) { $this->strategy->setDisplayExceptions($allow); - $response->setStatusCode(404); $event->setResult(null); $event->setResponse($response); $this->strategy->prepareNotFoundViewModel($event); @@ -240,6 +255,7 @@ public function test404ResponsePrepares404ViewModelWithExceptionWhenAllowed() public function test404ResponsePrepares404ViewModelWithControllerWhenAllowed() { $response = new Response(); + $response = $response->withStatus(404); $event = new MvcEvent(); $controller = 'some-or-other'; $controllerClass = 'Some\Controller\OrOtherController'; @@ -249,7 +265,6 @@ public function test404ResponsePrepares404ViewModelWithControllerWhenAllowed() foreach (['setDisplayNotFoundReason', 'setDisplayExceptions'] as $method) { foreach ([true, false] as $allow) { $this->strategy->$method($allow); - $response->setStatusCode(404); $event->setResult(null); $event->setResponse($response); $this->strategy->prepareNotFoundViewModel($event); @@ -280,8 +295,8 @@ public function testInjectsHttpResponseIntoEventIfNoneAlreadyPresent() $event->setError($error); $this->strategy->detectNotFoundError($event); $response = $event->getResponse(); - $this->assertInstanceOf(Response::class, $response); - $this->assertTrue($response->isNotFound(), 'Failed asserting against ' . $key); + $this->assertInstanceOf(ResponseInterface::class, $response); + $this->assertEquals(404, $response->getStatusCode(), 'Failed asserting against ' . $key); } } diff --git a/test/View/TestAsset/DumbStrategy.php b/test/View/TestAsset/DumbStrategy.php index 3369410ca..217c96889 100644 --- a/test/View/TestAsset/DumbStrategy.php +++ b/test/View/TestAsset/DumbStrategy.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + namespace ZendTest\Mvc\View\TestAsset; use ArrayObject; diff --git a/test/_autoload.php b/test/_autoload.php index a496a8f6a..d2f903736 100644 --- a/test/_autoload.php +++ b/test/_autoload.php @@ -5,6 +5,8 @@ * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License */ +declare(strict_types=1); + if (! class_exists(PHPUnit_Framework_Assert::class) && class_exists(PHPUnit\Framework\Assert::class) ) {