Inheritance diagram for Check:

Public Member Functions
	check ($expected=false)
	Perform the check. More...

	clientConfig ()
	Public configuration. More...

	unBan ($addr)
	Unban a client's IP address. More...

Public Member Functions inherited from Component
	__construct ($fred, $config=null)

	__destruct ()

	config ($key, $default=null)
	Retrieve a config value. More...

	ping ()
	Ping function. More...

	filemtime ($filename)
	Filemtime with session cache. More...

	component ($name)
	Get a component (local or default). More...

	components (... $names)
	Get multiple components in an array. More...

Public Member Functions inherited from Thing
	propertyExists ($property)
	Check if a property exists (public or published). More...

	constants ($prefix=null)
	Return all constants. More...

	get ($key)
	Get one or more properties. More...

	set ($key, $value=null)
	Set one or more properties. More...

	__get ($key)

	__set ($key, $value)

Data Fields
	$delay = null
	Time (seconds) a ban stays in the registry (empty = use default). More...

Data Fields inherited from Component
	$filemtimeTtl = 0

Data Fields inherited from Thing
const	HIDDEN = 0
	Property is hidden. More...

const	READABLE = 1
	Property is readable. More...

const	WRITEABLE = 2
	Property is writeable. More...

const	READWRITE = 3
	Property is readable and writeable. More...

Additional Inherited Members
Protected Member Functions inherited from Component
	init ()

	done ()

	getSession ()

Protected Member Functions inherited from Thing
	publish ($property, $visibility=self::READABLE)
	Publish a property (or hide it again). More...

	alias ($alias, $property, $object=null)
	Define an alias for a property (of another object). More...

	configure ($config)
	Configure the object. More...

	_get ($key)
	Default getter if no specific setter is defined, and the property is also not published (readable). More...

	_set ($key, $value)
	Default setter if no specific setter is defined, and the property is also not published (writeable). More...

Protected Attributes inherited from Component
	$_fred = null

	$_config = null

	$_name = null

	$_components = []
	Local components (key = component name, value = component). More...

	$_session = null

Protected Attributes inherited from Thing
	$_published = []
	Published properties (key = name of property, value = visibility). More...

	$_aliases = []
	Alias properties (key = alias, value = [object,property]). More...

Detailed Description

Definition at line 5 of file Check.php.

Member Function Documentation

check ( $expected = false )

abstract

Perform the check.

Parameters

bool $expected True if this is an expected call.

Returns: bool True if everything is fine. False if something is wrong. Null if something is wrong, but it is not significant enough to add a ban for it (e.g. repeated error).

clientConfig ( )

Public configuration.

Returns: array Public configuration for this component in key => value pairs.

Reimplemented from Component.

Reimplemented in Csrf.

Definition at line 17 of file Check.php.

unBan ( $addr )

Unban a client's IP address.

Parameters

string $addr

Reimplemented in Polling, and Throttle.

Definition at line 25 of file Check.php.

$delay = null

Time (seconds) a ban stays in the registry (empty = use default).

Definition at line 7 of file Check.php.

The documentation for this class was generated from the following file: