Docs For Class HTTP_FloodControl

void __construct(
mixed
$options)

Constructor

Access: public

Overridden in child classes as:

HTTP_FloodControl_Container_MDB2::__construct(): Constructor

HTTP_FloodControl_Container_File::__construct(): Constructor

HTTP_FloodControl_Container_MDB::__construct(): Constructor

HTTP_FloodControl_Container_DB::__construct(): Constructor

Parameters:

mixed $options — Additional options for the container object.

[ Top ]

void gc(
int
$lifetime)

Garbage collector

This function is responsible for garbage collection. It is responsible for deleting old counter logs.

Has to be overwritten by each container class

Abstract:
Access: public

Overridden in child classes as:

HTTP_FloodControl_Container_MDB2::gc(): Garbage collector

HTTP_FloodControl_Container_File::gc(): Garbage collector

HTTP_FloodControl_Container_MDB::gc(): Garbage collector

HTTP_FloodControl_Container_DB::gc(): Garbage collector

Parameters:

int $lifetime — Maximum lifetime of counter logs.

[ Top ]

mixed read(

$uniqueId, string
$uniqurId)

Read data associated with a given unique ID

Has to be overwritten by each container class.

Return: An array of data associated with a given unique ID or false in case of incorrect data format.
Abstract:
Access: public

Overridden in child classes as:

HTTP_FloodControl_Container_MDB2::read(): Read data associated with a given unique ID

HTTP_FloodControl_Container_File::read(): Read data associated with a given unique ID

HTTP_FloodControl_Container_MDB::read(): Read data associated with a given unique ID

HTTP_FloodControl_Container_DB::read(): Read data associated with a given unique ID

Parameters:

string	`$uniqurId`	—	IP address or other unique ID.
	`$uniqueId`	—

[ Top ]

void set(
)

Init container

Has to be overwritten by each container class.

Abstract:
Access: public

Overridden in child classes as:

HTTP_FloodControl_Container_MDB2::set(): Init MDB2 container

HTTP_FloodControl_Container_File::set(): Init File container

HTTP_FloodControl_Container_MDB::set(): Init MDB container

HTTP_FloodControl_Container_DB::set(): Init DB container

[ Top ]

void write(
string
$uniqueId, array
$data)

Write data associated with a given unique ID to container

Has to be overwritten by each container class

Abstract:
Access: public

Overridden in child classes as:

HTTP_FloodControl_Container_MDB2::write(): Write data associated with a given unique ID to container

HTTP_FloodControl_Container_File::write(): Write data associated with a given unique ID to container

HTTP_FloodControl_Container_MDB::write(): Write data associated with a given unique ID to container

HTTP_FloodControl_Container_DB::write(): Write data associated with a given unique ID to container

Parameters:

string	`$uniqueId`	—	IP address or other unique ID.
array	`$data`	—	The data associated with a given unique ID.

[ Top ]

void _parseOptions(
array
$options)

Parse options passed to the container class

Has to be overwritten by each container class.

Access: protected

Parameters:

array $options — Options array.

[ Top ]

void _setDefaults(
)

Set some default options

Has to be overwritten by each container class.

Abstract:
Access: protected

Overridden in child classes as:

HTTP_FloodControl_Container_MDB2::_setDefaults(): Set some default options

HTTP_FloodControl_Container_File::_setDefaults(): Set some default options

HTTP_FloodControl_Container_MDB::_setDefaults(): Set some default options

HTTP_FloodControl_Container_DB::_setDefaults(): Set some default options

[ Top ]

Class: HTTP_FloodControl_Container

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$_options = null

Method Detail

__construct (Constructor) [line 67]

Parameters:

gc [line 167]

Parameters:

read [line 135]

Parameters:

set [line 120]

write [line 150]

Parameters:

_parseOptions [line 100]

Parameters:

_setDefaults [line 86]