Docs For Class Inspekt

Class Inspekt_Cage

Description

Variable Summary

array $_source

Method Summary

static Inspekt_Cage Factory ( &$source, [string $conf_file = NULL], [string $conf_section = NULL], [boolean $strict = TRUE], array $source)

Inspekt_Cage Inspekt_Cage ()

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, [boolean $inc = TRUE])

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 = ISPK_HOST_ALLOW_ALL])

mixed testInt (mixed $key)

mixed testIp (mixed $key)

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

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

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

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

unknown testUri (unknown_type $key)

mixed testZip (mixed $key)

void _applyAutoFilters ()

mixed _getValue (string $key)

void _getValueRecursive ( $keys, $data_array)

void _keyExistsRecursive ( $keys, $data_array)

void _setSource ( &$newsource, array $newsource)

mixed _setValue (mixed $key, mixed $val)

void _setValueRecursive ( $keys, $val, $data_array)

Variables

mixed $_autofilter_conf = NULL (line 36)

array $_source = NULL (line 33)

Don't try to access this. ever.

Methods

static method Factory (line 62)

Takes an array and wraps it inside an object. If $strict is not set to FALSE, the original array will be destroyed, and the data can only be accessed via the object's accessor methods

static Inspekt_Cage Factory ( &$source, [string $conf_file = NULL], [string $conf_section = NULL], [boolean $strict = TRUE], array $source)

array $source
string $conf_file
string $conf_section
boolean $strict
&$source

Constructor Inspekt_Cage (line 43)

Inspekt_Cage Inspekt_Cage ()

getAlnum (line 175)

Returns only the alphabetic characters and digits in value.

tag: filter

mixed getAlnum (mixed $key)

mixed $key

getAlpha (line 159)

Returns only the alphabetic characters in value.

tag: filter

mixed getAlpha (mixed $key)

mixed $key

getDigits (line 191)

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

tag: filter

mixed getDigits (mixed $key)

mixed $key

getDir (line 207)

Returns dirname(value).

tag: filter

mixed getDir (mixed $key)

mixed $key

getInt (line 223)

Returns (int) value.

tag: filter

int getInt (mixed $key)

mixed $key

getPath (line 239)

Returns realpath(value).

tag: filter

mixed getPath (mixed $key)

mixed $key

getRaw (line 255)

Returns value.

tag: filter

mixed getRaw (string $key)

string $key

keyExists (line 707)

Checks if a key exists

bool keyExists (mixed $key)

mixed $key

noPath (line 692)

Returns basename(value).

tag: filter

mixed noPath (mixed $key)

mixed $key

noTags (line 676)

Returns value with all tags removed.

tag: filter

mixed noTags (mixed $key)

mixed $key

testAlnum (line 272)

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

tag: validator

mixed testAlnum (mixed $key)

mixed $key

testAlpha (line 293)

Returns value if every character is alphabetic, FALSE otherwise.

tag: validator

mixed testAlpha (mixed $key)

mixed $key

testBetween (line 319)

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.

tag: validator

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

mixed $key
mixed $min
mixed $max
boolean $inc

testCcnum (line 342)

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

tag: validator

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

mixed $key
mixed $type

testDate (line 363)

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

tag: validator

mixed testDate (mixed $key)

mixed $key

testDigits (line 384)

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

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

tag: validator

mixed testDigits (mixed $key)

mixed $key

testEmail (line 404)

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

tag: validator

mixed testEmail (mixed $key)

mixed $key

testFloat (line 424)

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

tag: validator

mixed testFloat (mixed $key)

mixed $key

testGreaterThan (line 445)

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

tag: validator

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

mixed $key
mixed $min

testHex (line 466)

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

tag: validator

mixed testHex (mixed $key)

mixed $key

testHostname (line 491)

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.

tag: validator

mixed testHostname (mixed $key, [integer $allow = ISPK_HOST_ALLOW_ALL])

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

testInt (line 511)

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

tag: validator

mixed testInt (mixed $key)

mixed $key

testIp (line 531)

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

tag: validator

mixed testIp (mixed $key)

mixed $key

testLessThan (line 552)

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

tag: validator

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

mixed $key
mixed $max

testOneOf (line 572)

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

tag: validator

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

mixed $key
$allowed

testPhone (line 593)

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

tag: validator

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

mixed $key
$country

testRegex (line 615)

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

tag: validator

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

mixed $key
mixed $pattern

testUri (line 636)

Enter description here...

tag: validator

unknown testUri (unknown_type $key)

unknown_type $key

testZip (line 656)

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

tag: validator

mixed testZip (mixed $key)

mixed $key

_applyAutoFilters (line 111)

void _applyAutoFilters ()

_getValue (line 746)

Retrieves a value from the _source array

mixed _getValue (string $key)

string $key

_getValueRecursive (line 758)

void _getValueRecursive ( $keys, $data_array)

$keys
$data_array

_keyExistsRecursive (line 720)

void _keyExistsRecursive ( $keys, $data_array)

$keys
$data_array

_setSource (line 100)

see: Inspekt_Cage::Factory()

void _setSource ( &$newsource, array $newsource)

array $newsource
&$newsource

_setValue (line 785)

Sets a value in the _source array

mixed _setValue (mixed $key, mixed $val)

mixed $key
mixed $val

_setValueRecursive (line 797)

void _setValueRecursive ( $keys, $val, $data_array)

$keys
$val
$data_array

Documentation generated on Mon, 31 Dec 2007 15:53:57 -0500 by phpDocumentor 1.4.1