Interface InputProviderInterface

This interface describes an input provider.

An input provider provides access to parameters, values and persistent values.

Direct known implementers

DcGeneral\Contao\InputProvider

Namespace: DcGeneral
Package: DcGeneral
Located at InputProviderInterface.php

Methods summary
`public mixed`	# `getParameter( string $strKey, boolean $blnRaw = false )` Retrieve a request parameter. Retrieve a request parameter. In plain HTTP, this will be a $_GET parameter, for other implementations consult the API. Parameters `$strKey` `string` $strKey The name of the parameter to be retrieved. `$blnRaw` `boolean` $blnRaw Boolean flag to determine if the content shall be returned RAW or rather be stripped of potential malicious content. Returns `mixed`
`public DcGeneral\InputProviderInterface`	# `setParameter( string $strKey, mixed $varValue )` Save/change a request parameter. Save/change a request parameter. In plain HTTP, this will be a $_GET parameter, for other implementations consult the API. Parameters `$strKey` `string` $strKey The name of the parameter to be stored. `$varValue` `mixed` $varValue The value to be stored. Returns `DcGeneral\InputProviderInterface`
`public DcGeneral\InputProviderInterface`	# `unsetParameter( string $strKey )` Unset a request parameter. Unset a request parameter. In plain HTTP, this will be a $_GET parameter, for other implementations consult the API. Parameters `$strKey` `string` $strKey The name of the parameter to be removed. Returns `DcGeneral\InputProviderInterface`
`public boolean`	# `hasParameter( string $strKey )` Determines if a request parameter is defined. Determines if a request parameter is defined. In plain HTTP, this will be a $_GET parameter, for other implementations consult the API. Parameters `$strKey` `string` $strKey The name of the parameter to be checked. Returns `boolean`
`public mixed`	# `getValue( string $strKey, boolean $blnRaw = false )` Retrieve a request value. Retrieve a request value. In plain HTTP, this will be a $_POST value, for other implementations consult the API. Parameters `$strKey` `string` $strKey The name of the value to be retrieved. `$blnRaw` `boolean` $blnRaw Boolean flag to determine if the content shall be returned RAW or rather be stripped of potential malicious content. Returns `mixed`
`public DcGeneral\InputProviderInterface`	# `setValue( string $strKey, mixed $varValue )` Save/change a request value. Save/change a request value. In plain HTTP, this will be a $_POST value, for other implementations consult the API. Parameters `$strKey` `string` $strKey The name of the value to be stored. `$varValue` `mixed` $varValue The value to be stored. Returns `DcGeneral\InputProviderInterface`
`public DcGeneral\InputProviderInterface`	# `unsetValue( string $strKey )` Unset a request value. Unset a request value. In plain HTTP, this will be a $_POST value, for other implementations consult the API. Parameters `$strKey` `string` $strKey The name of the value to be removed. Returns `DcGeneral\InputProviderInterface`
`public boolean`	# `hasValue( string $strKey )` Determines if a request value is defined. Determines if a request value is defined. In plain HTTP, this will be a $_POST value, for other implementations consult the API. Parameters `$strKey` `string` $strKey The name of the value to be checked. Returns `boolean`
`public mixed`	# `getPersistentValue( string $strKey )` Retrieve a persistent value. Retrieve a persistent value. Usually this value is being kept in the user session. Parameters `$strKey` `string` $strKey The name of the value to be retrieved. Returns `mixed`
`public DcGeneral\InputProviderInterface`	# `setPersistentValue( string $strKey, mixed $varValue )` Save/change a persistent value. Save/change a persistent value. Usually this value is being kept in the user session. Parameters `$strKey` `string` $strKey The name of the value to be stored. `$varValue` `mixed` $varValue The value to be stored. Returns `DcGeneral\InputProviderInterface`
`public boolean`	# `hasPersistentValue( string $strKey )` Determines if a persistent value is defined. Determines if a persistent value is defined. Usually this value is being kept in the user session. Parameters `$strKey` `string` $strKey The name of the value to be checked. Returns `boolean`
`public string`	# `getRequestUrl( )` Retrieve the current request url. Retrieve the current request url. Returns `string`