Docs For Class Zend_Filter_Input

## Class Zend_Filter_Input

Description

- license: New BSD License
- copyright: Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Filter/Input.php (line 36)

Variable Summary
mixed $_source
Method Summary
Zend_Filter_Input __construct ([ &$source = NULL], [ $strict = TRUE])
mixed getAlnum (mixed $key)
mixed getAlpha (mixed $key)
mixed getDigits (mixed $key)
mixed getDir (mixed $key)
int getInt (mixed $key)
mixed getPath (mixed $key)
mixed getRaw (string $key)
bool keyExists (mixed $key)
mixed noPath (mixed $key)
mixed noTags (mixed $key)
mixed testAlnum (mixed $key)
mixed testAlpha (mixed $key)
mixed testBetween (mixed $key, mixed $min, mixed $max, [ $inc = TRUE], boolean $inclusive)
mixed testCcnum (mixed $key, [mixed $type = NULL])
mixed testDate (mixed $key)
mixed testDigits (mixed $key)
mixed testEmail (mixed $key)
mixed testFloat (mixed $key)
mixed testGreaterThan (mixed $key, [mixed $min = NULL])
mixed testHex (mixed $key)
mixed testHostname (mixed $key, [integer $allow = Zend_Filter::HOST_ALLOW_ALL])
mixed testInt (mixed $key)
mixed testIp (mixed $key)
mixed testLessThan (mixed $key, [mixed $max = NULL])
mixed testName (mixed $key)
mixed testOneOf (mixed $key, [ $allowed = NULL])
mixed testPhone (mixed $key, [ $country = 'US'])
mixed testRegex (mixed $key, [mixed $pattern = NULL])
void testUri ( $key)
mixed testZip (mixed $key)
Variables
mixed $_source = NULL (line 38)

- access: protected

Methods
Constructor __construct (line 40)

- access: public

Zend_Filter_Input __construct ([ &$source = NULL], [ $strict = TRUE])

- &$source
- $strict

getAlnum (line 71)

Returns only the alphabetic characters and digits in value.

- access: public

mixed getAlnum (mixed $key)

- mixed $key

getAlpha (line 56)

Returns only the alphabetic characters in value.

- access: public

mixed getAlpha (mixed $key)

- mixed $key

getDigits (line 86)

Returns only the digits in value. This differs from getInt().

- access: public

mixed getDigits (mixed $key)

- mixed $key

getDir (line 101)

Returns dirname(value).

- access: public

mixed getDir (mixed $key)

- mixed $key

getInt (line 116)

Returns (int) value.

- access: public

int getInt (mixed $key)

- mixed $key

getPath (line 131)

Returns realpath(value).

- access: public

mixed getPath (mixed $key)

- mixed $key

getRaw (line 146)

Returns value.

- access: public

mixed getRaw (string $key)

- string $key

keyExists (line 589)

Checks if a key exists

- access: public

bool keyExists (mixed $key)

- mixed $key

noPath (line 575)

Returns basename(value).

- access: public

mixed noPath (mixed $key)

- mixed $key

noTags (line 560)

Returns value with all tags removed.

- access: public

mixed noTags (mixed $key)

- mixed $key

testAlnum (line 162)

Returns value if every character is alphabetic or a digit, FALSE otherwise.

- access: public

mixed testAlnum (mixed $key)

- mixed $key

testAlpha (line 182)

Returns value if every character is alphabetic, FALSE otherwise.

- access: public

mixed testAlpha (mixed $key)

- mixed $key

testBetween (line 207)

Returns value if it is greater than or equal to $min and less than or equal to $max, FALSE otherwise. If $inc is set to FALSE, then the value must be strictly greater than $min and strictly less than $max.

- access: public

mixed testBetween (mixed $key, mixed $min, mixed $max, [ $inc = TRUE], boolean $inclusive)

- mixed $key
- mixed $min
- mixed $max
- boolean $inclusive
- $inc

testCcnum (line 229)

Returns value if it is a valid credit card number format. The optional second argument allows developers to indicate the type.

- access: public

mixed testCcnum (mixed $key, [mixed $type = NULL])

- mixed $key
- mixed $type

testDate (line 249)

Returns $value if it is a valid date, FALSE otherwise. The date is required to be in ISO 8601 format.

- access: public

mixed testDate (mixed $key)

- mixed $key

testDigits (line 269)

Returns value if every character is a digit, FALSE otherwise.

This is just like isInt(), except there is no upper limit.

- access: public

mixed testDigits (mixed $key)

- mixed $key

testEmail (line 288)

Returns value if it is a valid email format, FALSE otherwise.

- access: public

mixed testEmail (mixed $key)

- mixed $key

testFloat (line 307)

Returns value if it is a valid float value, FALSE otherwise.

- access: public

mixed testFloat (mixed $key)

- mixed $key

testGreaterThan (line 327)

Returns value if it is greater than $min, FALSE otherwise.

- access: public

mixed testGreaterThan (mixed $key, [mixed $min = NULL])

- mixed $key
- mixed $min

testHex (line 347)

Returns value if it is a valid hexadecimal format, FALSE otherwise.

- access: public

mixed testHex (mixed $key)

- mixed $key

testHostname (line 371)

Returns value if it is a valid hostname, FALSE otherwise.

Depending upon the value of $allow, Internet domain names, IP addresses, and/or local network names are considered valid. The default is HOST_ALLOW_ALL, which considers all of the above to be valid.

- access: public

mixed testHostname (mixed $key, [integer $allow = Zend_Filter::HOST_ALLOW_ALL])

- mixed $key
- integer $allow: bitfield for HOST_ALLOW_DNS, HOST_ALLOW_IP, HOST_ALLOW_LOCAL

testInt (line 390)

Returns value if it is a valid integer value, FALSE otherwise.

- access: public

mixed testInt (mixed $key)

- mixed $key

testIp (line 409)

Returns value if it is a valid IP format, FALSE otherwise.

- access: public

mixed testIp (mixed $key)

- mixed $key

testLessThan (line 429)

Returns value if it is less than $max, FALSE otherwise.

- access: public

mixed testLessThan (mixed $key, [mixed $max = NULL])

- mixed $key
- mixed $max

testName (line 449)

Returns value if it is a valid format for a person's name, FALSE otherwise.

- access: public

mixed testName (mixed $key)

- mixed $key

testOneOf (line 468)

Returns value if it is one of $allowed, FALSE otherwise.

- access: public

mixed testOneOf (mixed $key, [ $allowed = NULL])

- mixed $key
- $allowed

testPhone (line 488)

Returns value if it is a valid phone number format, FALSE otherwise. The optional second argument indicates the country.

- access: public

mixed testPhone (mixed $key, [ $country = 'US'])

- mixed $key
- $country

testRegex (line 509)

Returns value if it matches $pattern, FALSE otherwise. Uses preg_match() for the matching.

- access: public

mixed testRegex (mixed $key, [mixed $pattern = NULL])

- mixed $key
- mixed $pattern

testUri (line 522)

- access: public

void testUri ( $key)

- $key

testZip (line 541)

Returns value if it is a valid US ZIP, FALSE otherwise.

- access: public

mixed testZip (mixed $key)

- mixed $key

Documentation generated on Sun, 29 Oct 2006 21:27:20 -0600 by phpDocumentor 1.3.0RC6