Class: HTTP_FloodControl_Container_DB

Source Location: /HTTP_FloodControl-0.1.1/FloodControl/Container/DB.php

Class Overview

HTTP_FloodControl_Container
   |
   --HTTP_FloodControl_Container_DB

PEAR::DB container class for storing data of HTTP_FloodControl package

Author(s):

Vagharshak Tozalakyan <vagh at tozalakyan.com>

Variables

$_db

Methods

Inherited Variables

Class: HTTP_FloodControl_Container

HTTP_FloodControl_Container::$_options

Inherited Methods

Class: HTTP_FloodControl_Container

HTTP_FloodControl_Container::__construct(): Constructor
HTTP_FloodControl_Container::gc(): Garbage collector
HTTP_FloodControl_Container::read(): Read data associated with a given unique ID
HTTP_FloodControl_Container::set(): Init container
HTTP_FloodControl_Container::write(): Write data associated with a given unique ID to container
HTTP_FloodControl_Container::_parseOptions(): Parse options passed to the container class
HTTP_FloodControl_Container::_setDefaults(): Set some default options

Class Details

[line 64]
PEAR::DB container class for storing data of HTTP_FloodControl package

Create the following table to store counter logs:

 CREATE TABLE `fc_logs` (

      `unique_id` varchar(32) NOT NULL,
      `data` text NOT NULL,
      `access` int UNSIGNED NOT NULL,
      PRIMARY KEY (`unique_id`)
 );

Author: Vagharshak Tozalakyan <vagh@tozalakyan.com>
Link: http://pear.php.net/package/HTTP_FloodControl
License: GNU Lesser General Public License

[ Top ]

Class Variables

$_db = null

[line 75]

Database handle

Access: protected

Type:

object

[ Top ]

Method Detail

__construct (Constructor) [line 88]

void __construct(
mixed
$options)

Constructor

Access: public

Overrides HTTP_FloodControl_Container::__construct() (Constructor)

Parameters:

mixed $options — An array of additional options for the container object or a DSN string.

[ Top ]

gc [line 213]

void gc(
int
$lifetime)

Garbage collector

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

Throws: HTTP_FloodControl_Exception if an error occured during garbage collection.
Access: public

Overrides HTTP_FloodControl_Container::gc() (Garbage collector)

Parameters:

int $lifetime — Maximum lifetime of counter logs.

[ Top ]

read [line 151]

mixed read(

$uniqueId, string
$uniqurId)

Read data associated with a given unique ID

Return: An array of data associated with a given unique ID or false in case of incorrect data format.
Throws: HTTP_FloodControl_Exception if an error occured while reading from database.
Access: public

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

Parameters:

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

[ Top ]

set [line 124]

void set(
)

Init DB container

Throws: HTTP_FloodControl_Exception if it is impossible to establish database connection.
Access: public

Overrides HTTP_FloodControl_Container::set() (Init container)

[ Top ]

write [line 175]

void write(
string
$uniqueId, array
$data)

Write data associated with a given unique ID to container

Throws: HTTP_FloodControl_Exception if an error occured during writing process.
Access: public

Overrides HTTP_FloodControl_Container::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 ]

_setDefaults [line 107]

void _setDefaults(
)

Set some default options

Access: protected

Overrides HTTP_FloodControl_Container::_setDefaults() (Set some default options)

[ Top ]