Retrieving request data using JInput - Revision history

Robbiej: Added deprecation notice and link to Joomla Manual

2024-11-27T10:48:27Z

Added deprecation notice and link to Joomla Manual

← Older revision		Revision as of 10:48, 27 November 2024
Line 1:		Line 1:
			{{Warning\|This page has been superseded and is no longer maintained. Please go to the [https://manual.joomla.org/docs/general-concepts/input/ Joomla Manual ] instead}}

	{{version\|2.5,3.x\|platform=11.1,12.1}}		{{version\|2.5,3.x\|platform=11.1,12.1}}

2020-01-13T08:22:48Z

Add array syntax

← Older revision		Revision as of 08:22, 13 January 2020
Line 37:		Line 37:
	$p1 = $input->get('p1', 'xxx', 'string');		$p1 = $input->get('p1', 'xxx', 'string');
	</source>		</source>

			'''JInput returns an array of filtered entries if the user input is an array. Calling the above example with ?p1[]=xxx will return $p1 as array with one element 'xxx' filter as string.'''

	The method <tt>exists()</tt> can also be used to check if a parameter exists, but in practice this isn't often used, as using the <tt>default_value</tt> parameter usually covers adequately the case when a parameter is absent.		The method <tt>exists()</tt> can also be used to check if a parameter exists, but in practice this isn't often used, as using the <tt>default_value</tt> parameter usually covers adequately the case when a parameter is absent.

2019-08-19T10:19:39Z

some changes after review

← Older revision		Revision as of 10:19, 19 August 2019
Line 160:		Line 160:
	$input->getInt('memberId', 0);		$input->getInt('memberId', 0);
	</source>		</source>

			Except that <tt>getArray()</tt> is different; see [[Retrieving request data using JInput#Getting Multiple Values\|Getting Multiple Values]] below.

	To retrieve an object, you can use:		To retrieve an object, you can use:
Line 278:		Line 280:

	== Getting JSON string from request ==		== Getting JSON string from request ==
	'''NB!''' Available since Joomla! ~~Platform 12~~.1		'''NB!''' Available since Joomla! version 3.0.

	<source lang="php">$json = $input->json->get(param_name);</source>		<source lang="php">$json = $input->json->get(param_name);</source>
Line 294:		Line 296:
	$input->def('p2', "someval");		$input->def('p2', "someval");
	</source>		</source>
	creates a parameter p2 and sets its value to the string "someval", but only if p2 doesn't already exist. If p2 already exists then def('p2', "someval"); ~~does nothing.~~		creates a parameter p2 and sets its value to the string "someval", but only if p2 doesn't already exist. If p2 already exists then <tt>def('p2', "someval");</tt> does nothing.

	~~(This is how core Joomla sets up the values in the Input class instance whenever it starts up in response to an incoming HTTP request, finding the values from the PHP <tt>$_REQUEST~~</tt>~~, etc globals)~~.

	== Retrieving File Data ==		== Retrieving File Data ==

2019-08-16T21:12:36Z

Revamped to provide increased clarity, and include sample module code

2016-08-10T17:50:33Z

← Older revision		Revision as of 17:50, 10 August 2016
Line 167:		Line 167:
	<source lang="php">$foo = $jinput->post->get('varname', 'default_value', 'filter');</source>		<source lang="php">$foo = $jinput->post->get('varname', 'default_value', 'filter');</source>
	<source lang="php">$foo = $jinput->server->get('varname', 'default_value', 'filter');</source>		<source lang="php">$foo = $jinput->server->get('varname', 'default_value', 'filter');</source>

			===Getting JSON string from request===
			'''NB!''' Available since Joomla! Platform 12.1

			<source lang="php">$json = $jinput->json->get('varname');</source>

	===Setting Values===		===Setting Values===

2015-09-06T00:16:43Z

Fixed own incorrect edit (revision 68329): a single PHP object was meant (see revision 68300)

← Older revision		Revision as of 00:16, 6 September 2015
Line 116:		Line 116:
	$input->getInt('memberId', 0);		$input->getInt('memberId', 0);
	</source>		</source>

			To retrieve an object, you can use:
			<source lang="php">$foo = $jinput->get('varname', null, null);</source>

	===Getting Multiple Values===		===Getting Multiple Values===
Line 164:		Line 167:
	<source lang="php">$foo = $jinput->post->get('varname', 'default_value', 'filter');</source>		<source lang="php">$foo = $jinput->post->get('varname', 'default_value', 'filter');</source>
	<source lang="php">$foo = $jinput->server->get('varname', 'default_value', 'filter');</source>		<source lang="php">$foo = $jinput->server->get('varname', 'default_value', 'filter');</source>

	~~To retrieve an entire object, you can use:~~
	~~<source lang="php">$foo = $jinput->get('varname', null, null);</source>~~

	===Setting Values===		===Setting Values===

2015-09-05T17:53:19Z

Adjusted version template

← Older revision		Revision as of 17:53, 5 September 2015
Line 1:		Line 1:
	{{version\|2.5,3.1\|platform=11.1,12.1}}		{{version\|2.5,3.x\|platform=11.1,12.1}}

	==Requirements==		==Requirements==
	To be able to use JInput as described here, you must be using Joomla 2.5.0 or above.		To be able to use JInput as described here, you must be using Joomla 2.5.0 or above.

2015-09-05T17:33:59Z

Added clarification after user request

← Older revision		Revision as of 17:33, 5 September 2015
Line 17:		Line 17:

	The filter defaults to <code>cmd</code>.		The filter defaults to <code>cmd</code>.

			{{notice\|The code fragments in the following list show the ''implementation'' of the filters (assuming the value you want to retrieve is stored in <code>$source</code>). You do not need them to ''use'' JInput; all you need for using JInput is the code shown above.}}

	Available filters are:		Available filters are:

2015-07-13T16:31:30Z

Remove reference to the J 1.7.1 release, and change the paragraph to make sense with the current release.

← Older revision		Revision as of 16:31, 13 July 2015
Line 305:		Line 305:
	If you want to get data from a specific super global array, you can do $input->get->get(...) or $input->post->get(...).		If you want to get data from a specific super global array, you can do $input->get->get(...) or $input->post->get(...).

	~~So that's the basic idea~~. ~~Feel free to post more questions if you have any.~~		JApplication is deprecated, Use JApplicationCms instead unless specified otherwise. JRequest is deprecated but will remain in the CMS through the 3.x series at a minimum. As such, it is easiest to still use JRequest with CMS applications. In the future get the JInput object from the application instead.

	~~We'll be adding input as a public property to JApplication~~ in the ~~near future~~. ~~It might be an idea if the CMS folks so chose to release~~ a ~~1.7.1 that included this so developers can use it now~~. ~~Otherwise, at this point in time~~, it is ~~best~~ to still use JRequest.

	<noinclude>		<noinclude>

2015-07-06T21:19:08Z

Include in Category:Tutorials

← Older revision		Revision as of 21:19, 6 July 2015
Line 309:		Line 309:
	We'll be adding input as a public property to JApplication in the near future. It might be an idea if the CMS folks so chose to release a 1.7.1 that included this so developers can use it now. Otherwise, at this point in time, it is best to still use JRequest.		We'll be adding input as a public property to JApplication in the near future. It might be an idea if the CMS folks so chose to release a 1.7.1 that included this so developers can use it now. Otherwise, at this point in time, it is best to still use JRequest.

			<noinclude>
			[[Category:Tutorials]]
	[[Category:Development]]		[[Category:Development]]
			</noinclude>