• Home
• Contao
• Input

PHP Class Contao\Input

The class functions as an adapter for the global input arrays ($_GET, $_POST, $_COOKIE) and safely returns their values. To prevent XSS vulnerabilities, you should always use the class when reading user input. Usage: if (Input::get('action') == 'register') { $username = Input::post('username'); $password = Input::post('password'); } Show file Open project: contao/core-bundle Class Usage Examples

Protected Properties

Property	Type	Description
$arrCache	array	Cache
$arrUnusedGet	array	Unused $_GET parameters
$blnMagicQuotes	boolean	Magic quotes setting
$objInstance	Input	Object instance (Singleton)

Public Methods

Method	Description
__clone ( )	Prevent cloning of the object (Singleton)
cleanKey ( mixed $varValue ) : mixed	Sanitize the variable names (thanks to Andreas Schempp)
cookie ( string $strKey, boolean $blnDecodeEntities = false ) : mixed	Return a $_COOKIE variable
decodeEntities ( mixed $varValue ) : mixed	Decode HTML entities
encodeInsertTags ( string $varValue ) : string	Encode the opening and closing delimiters of insert tags
encodeSpecialChars ( mixed $varValue ) : mixed	Encode special characters which are potentially dangerous
findPost ( string $strKey ) : mixed	Fallback to the session form data if there is no post data
get ( string $strKey, boolean $blnDecodeEntities = false, boolean $blnKeepUnused = false ) : mixed	Return a $_GET variable
getInstance ( ) : Input	Return the object instance (Singleton)
getUnusedGet ( ) : array	Return the unused GET parameters as array
hasUnusedGet ( ) : boolean	Return whether there are unused GET parameters
initialize ( )	Clean the global GPC arrays
post ( string $strKey, boolean $blnDecodeEntities = false ) : mixed	Return a $_POST variable
postHtml ( string $strKey, boolean $blnDecodeEntities = false ) : mixed	Return a $_POST variable preserving allowed HTML tags
postRaw ( string $strKey ) : mixed	Return a raw, unsafe $_POST variable
postUnsafeRaw ( string $strKey ) : mixed	Return a raw, unsafe and unfiltered $_POST variable
preserveBasicEntities ( mixed $varValue ) : mixed	Preserve basic entities by replacing them with square brackets (e.g. & becomes [amp])
resetCache ( )	Reset the internal cache
setCookie ( string $strKey, mixed $varValue )	Set a $_COOKIE variable
setGet ( string $strKey, mixed $varValue, boolean $blnAddUnused = false )	Set a $_GET variable
setPost ( string $strKey, mixed $varValue )	Set a $_POST variable
setUnusedGet ( string $strKey, mixed $varValue )	Set an unused GET parameter
stripSlashes ( mixed $varValue ) : mixed	Strip slashes
stripTags ( mixed $varValue, string $strAllowedTags = '' ) : mixed	Strip HTML and PHP tags preserving HTML comments
xssClean ( mixed $varValue, boolean $blnStrictMode = false ) : mixed	Clean a value and try to prevent XSS attacks

Protected Methods

Method	Description
__construct ( )	Clean the keys of the request arrays

Method Details

Property Details