Class Filter_Value

Represents a filtered value.

Core\Object implements Core\Chainable

Extended by

Core\Set implements Core\Accessor

Extended by

Core\Value implements Core\Comparable, Core\Equality, Core\Identity

Extended by

Core\Filter_Value

Namespace: Core
Package: Core\Filter
Since: 3.1
Requires: PHP 5.3
Version: 1.0
Located at Filter.inc.php

Methods summary

`public`	# `__construct( mixed $value, boolean $unfilteredValue, $errorFlag = null )` Initialises a new value instance. Initialises a new value instance. Parameters `$value` $unfilteredValue Unfiltered value originally fed to filter. `$unfilteredValue` $errorFlag Optional error condition. If not provided, the error condition is set if the given value is either `false` or `null`. `$errorFlag` Since 3.1 Overrides `Core\Value::__construct`
`public boolean`	# `valid( )` Checks the error flag whether the filter operation succeeded or failed. Checks the error flag whether the filter operation succeeded or failed. Returns boolean `true`, if filter operation succeeded and the value represented by this instance is the successfully filtered value, otherwise `false`. Since 3.1

Methods inherited from Core\Value

__clone(), __invoke(), __toString(), bit(), bool(), compareTo(), explode(), filter(), float(), int(), isArray(), isBoolean(), isCallable(), isCallback(), isEqualTo(), isFloat(), isIdenticalTo(), isInteger(), isNull(), isNumeric(), isObject(), isOffset(), isResource(), isScalar(), isString(), set(), string(), stringObject(), toArray(), toLower(), toUpper()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Value

Bit, Boolean, Float, Integer, LowercaseString, String, StringObject, UppercaseString

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

`protected boolean`	`$_v_errorFlag` Filter result error flag. Filter result error flag. Since 3.1	#
`protected mixed`	`$_v_unfilteredValue` Unfiltered value. Unfiltered value. Since 3.1	#

Properties inherited from Core\Value

$_v_onSet, $_v_value

Magic properties

`public read-only boolean`	`$errorFlag` If `true`, the input value did not correspond to the required format or couldn't be processed. If set to `false`, this instance represents the filtered value.
`public read-only mixed`	`$unfilteredValue` Original value fed to filter.
`public read-only boolean`	`$valid` See `Core\Filter_Value::valid()`.

Magic properties inherited from Core\Value

$bit, $bool, $float, $int, $isArray, $isBoolean, $isCallable, $isCallback, $isFloat, $isInteger, $isNull, $isNumeric, $isObject, $isOffset, $isResource, $isScalar, $isString, $onSet, $string, $stringObject, $value

Magic properties inherited from Core\Object

$hash, $uuid