filter_var(3) [php man page]

FILTER_VAR(3)								 1							     FILTER_VAR(3)

filter_var - Filters a variable with a specified filter

SYNOPSIS

       mixed filter_var (mixed	$variable, [int  $filter = FILTER_DEFAULT], [mixed  $options])

DESCRIPTION

PARAMETERS

	      o $variable
		- Value to filter.

	      o $filter
		-  The ID of the filter to apply. The "Types of filters" manual page lists the available filters.  If omitted, FILTER_DEFAULT will
		be used, which is equivalent to FILTER_UNSAFE_RAW. This will result in no filtering taking place by default.

	      o $options
		- Associative array of options or bitwise disjunction of flags. If filter accepts options, flags can be provided in "flags"  field
		of  array.  For the "callback" filter, callable type should be passed. The callback must accept one argument, the value to be fil-
		tered, and return the value after filtering/sanitizing it.

	      <?php
	      // for filters that accept options, use this format
	      $options = array(
		  'options' => array(
		      'default' => 3, // value to return if the filter fails
		      // other options here
		      'min_range' => 0
		  ),
		  'flags' => FILTER_FLAG_ALLOW_OCTAL,
	      );
	      $var = filter_var('0755', FILTER_VALIDATE_INT, $options);

	      // for filter that only accept flags, you can pass them directly
	      $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);

	      // for filter that only accept flags, you can also pass as an array
	      $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN,
				array('flags' => FILTER_NULL_ON_FAILURE));

	      // callback validate filter
	      function foo($value)
	      {
		  // Expected format: Surname, GivenNames
		  if (strpos($value, ", ") === false) return false;
		  list($surname, $givennames) = explode(", ", $value, 2);
		  $empty = (empty($surname) || empty($givennames));
		  $notstrings = (!is_string($surname) || !is_string($givennames));
		  if ($empty || $notstrings) {
		      return false;
		  } else {
		      return $value;
		  }
	      }
	      $var = filter_var('Doe, Jane Sue', FILTER_CALLBACK, array('options' => 'foo'));
	      ?>

RETURN VALUES

	Returns the filtered data, or FALSE if the filter fails.

EXAMPLES

       Example #1

	      A filter_var(3) example

	      <?php
	      var_dump(filter_var('bob@example.com', FILTER_VALIDATE_EMAIL));
	      var_dump(filter_var('http://example.com', FILTER_VALIDATE_URL, FILTER_FLAG_PATH_REQUIRED));
	      ?>

	      The above example will output:

	      string(15) "bob@example.com"
	      bool(false)

SEE ALSO

       filter_var_array(3), filter_input(3), filter_input_array(3), "Types of filters", information about the callback type.

PHP Documentation Group 													     FILTER_VAR(3)

FILTER_VAR_ARRAY(3)							 1						       FILTER_VAR_ARRAY(3)

filter_var_array - Gets multiple variables and optionally filters them

SYNOPSIS

       mixed filter_var_array (array  $data, [mixed  $definition], [bool  $add_empty = true])

DESCRIPTION

	This function is useful for retrieving many values without repetitively calling filter_var(3).

PARAMETERS

	      o $data
		- An array with string keys containing the data to filter.

	      o $definition
		-  An  array defining the arguments. A valid key is a string containing a variable name and a valid value is either a filter type,
		or an array optionally specifying the filter, flags and options. If the value is an array, valid keys are filter  which  specifies
		the  filter  type, flags which specifies any flags that apply to the filter, and options which specifies any options that apply to
		the filter. See the example below for a better understanding.  This parameter can be also an integer holding  a  filter  constant.
		Then all values in the input array are filtered by this filter.

	      o $add_empty
		- Add missing keys as NULL to the return value.

RETURN VALUES

	An  array  containing  the  values  of the requested variables on success, or FALSE on failure. An array value will be FALSE if the filter
       fails, or NULL if the variable is not set.

EXAMPLES

       Example #1

	      A filter_var_array(3) example

	      <?php
	      error_reporting(E_ALL | E_STRICT);
	      $data = array(
		  'product_id'	  => 'libgd<script>',
		  'component'	  => '10',
		  'versions'	  => '2.0.33',
		  'testscalar'	  => array('2', '23', '10', '12'),
		  'testarray'	  => '2',
	      );

	      $args = array(
		  'product_id'	 => FILTER_SANITIZE_ENCODED,
		  'component'	 => array('filter'    => FILTER_VALIDATE_INT,
					  'flags'     => FILTER_FORCE_ARRAY,
					  'options'   => array('min_range' => 1, 'max_range' => 10)
					 ),
		  'versions'	 => FILTER_SANITIZE_ENCODED,
		  'doesnotexist' => FILTER_VALIDATE_INT,
		  'testscalar'	 => array(
					  'filter' => FILTER_VALIDATE_INT,
					  'flags'  => FILTER_REQUIRE_SCALAR,
					 ),
		  'testarray'	 => array(
					  'filter' => FILTER_VALIDATE_INT,
					  'flags'  => FILTER_FORCE_ARRAY,
					 )

	      );

	      $myinputs = filter_var_array($data, $args);

	      var_dump($myinputs);
	      echo "
";
	      ?>

	      The above example will output:

	      array(6) {
		["product_id"]=>
		array(1) {
		  [0]=>
		  string(17) "libgd%3Cscript%3E"
		}
		["component"]=>
		array(1) {
		  [0]=>
		  int(10)
		}
		["versions"]=>
		array(1) {
		  [0]=>
		  string(6) "2.0.33"
		}
		["doesnotexist"]=>
		NULL
		["testscalar"]=>
		bool(false)
		["testarray"]=>
		array(1) {
		  [0]=>
		  int(2)
		}
	      }

CHANGELOG

       +--------+------------------------------+
       |Version |			       |
       |	|			       |
       |	|	  Description	       |
       |	|			       |
       +--------+------------------------------+
       | 5.4.0	|			       |
       |	|			       |
       |	|  Added $add_empty parameter. |
       |	|			       |
       +--------+------------------------------+
SEE ALSO

       filter_input_array(3), filter_var(3), filter_input(3), "Types of filters".

PHP Documentation Group 												       FILTER_VAR_ARRAY(3)