heimrichhannot/contao-request

This package is abandoned and no longer maintained. The author suggests using the heimrichhannot/contao-request-bundle package instead.

A request class, that brings the symfony/http-foundation to contao.

1.5.0 2022-01-13 09:45 UTC

Requires

• php: ~5.4 || ~7.0 || ^8.0
• contao-community-alliance/composer-plugin: ~2.4 || ~3.0
• contao/core-bundle: ^3.5.1 || ~4.1
• symfony/http-foundation: >=2.7
• wa72/htmlpagedom: ^1.3 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.2
• phpunit/phpunit: ~5.6 || ~6.0
• satooshi/php-coveralls: ^1.0

LGPL-3.0-or-later

• Heimrich & Hannot

• symfony
• request
• contao

README

Contao uses it own Input class, that check the request for $_GET, $_POST and more parameters. This is done directly on $_GET, $_POST Server Parameters and for Tests it is not possible to simulate the HTTP-Server. Here HeimrichHannot\Request put on and provide the sumilation of your own HTTP-Server object with help of symfony/http-foundation.

Technical instruction

Use the following alternatives for contao Input or Environment calls

Contao	Request
\Input::get($strKey)	\HeimrichHannot\Request\Request::getGet($strKey)
\Input::post($strKey)	\HeimrichHannot\Request\Request::getPost($strKey)
\Input::postHtml($strKey)	\HeimrichHannot\Request\Request::getPostHtml($strKey)
\Input::postRaw($strKey)	\HeimrichHannot\Request\Request::getPostRaw($strKey)
\Input::setPost($strKey, $varValue)	\HeimrichHannot\Request\Request::setPost($strKey, $varValue)
\Input::setGet($strKey, $varValue)	\HeimrichHannot\Request\Request::setGet($strKey, $varValue)
isset($_GET[$strKey])	\HeimrichHannot\Request\Request::hasGet($strKey)
isset($_POST[$strKey])	\HeimrichHannot\Request\Request::hasPost($strKey)
\Environment::get('isAjaxRequest')	\HeimrichHannot\Request\Request::getInstance()->isXmlHttpRequest()

Insert tags

For convenience we provide insert tags for some request method parameters.

**CAUTION: If you use the insert tags in SQL-Query Context, be sure that you escape the insert tag values by using e.g. prepare('field=?'')->execute('{{request_get::auto_item}}'') **

Insert tag	Description
{{request_get::*}}	This tag will be replaced with the XSS protected value of the query parameter (replace * with the name of the query parameter, e.g. auto_item)
{{request_post::*}}	This tag will be replaced with the XSS protected value of the post parameter (replace * with the name of the post parameter, e.g. FORM_SUBMIT)