Class: ClientThrottling

Source Location: /plugins/throttling/client/ClientThrottling.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientThrottling

Client Throttling

Variables

Methods

Inherited Constants

Class: ClientPlugin

ClientPlugin::ENABLE_LEVEL_FULL
ClientPlugin::ENABLE_LEVEL_LOAD
ClientPlugin::ENABLE_LEVEL_PROCESS
ClientPlugin::ENABLE_LEVEL_SERVERCALL

Inherited Variables

Class: ClientPlugin

ClientPlugin::$cartoclient
ClientPlugin::$config
ClientPlugin::$enabledLevel

Class: PluginBase

PluginBase::$basePath
PluginBase::$name
PluginBase::$overriddenRequest

Inherited Methods

Class: ClientPlugin

ClientPlugin::__construct(): Constructor
ClientPlugin::checkBool(): Checks if variable $variable has a boolean (0 or 1) value $value.
ClientPlugin::checkInt(): Checks if variable $variable has an integer positive or zero value $value.
ClientPlugin::checkNumeric(): Checks if variable $variable has a numeric value $value.
ClientPlugin::disable(): Sets the enable level to ClientPlugin::ENABLE_LEVEL_SERVERCALL.
ClientPlugin::enable(): Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
ClientPlugin::getCartoclient()
ClientPlugin::getConfig()
ClientPlugin::getEnabledLevel(): Returns the enable level.
ClientPlugin::getFolderId(): get folder id if set in plugin config
ClientPlugin::getHttpValue(): Returns the user-submitted $key data if it is set.
ClientPlugin::initializeConfig(): Initializes plugin configuration
ClientPlugin::isEnabledAtLevel(): Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
ClientPlugin::setEnableLevel(): Sets the enable level (to be used with the AJAX mode).

Class: PluginBase

PluginBase::__construct(): Constructor
PluginBase::account(): Records an accounting message for plugins
PluginBase::getBasePath()
PluginBase::getExtendedName()
PluginBase::getName()
PluginBase::getRequest(): Get plugin's request or result out of MapRequest or MapResult
PluginBase::initialize(): Plugin initialization (can be extended in custom plugins)
PluginBase::initializeConfig(): Initializes plugin
PluginBase::preInitialize(): Plugin pre initialization. In most cases, plugins should use
PluginBase::replacePlugin(): Returns name of parent plugin in case of plugin extension
PluginBase::setBasePath()
PluginBase::setExtendedName()
PluginBase::setName()

Class Details

[line 31]
Client Throttling

[ Top ]

Class Variables

$black =

[line 46]

Tags:

access:

protected

Type:

BlackList

[ Top ]

$blockAccess = true

[line 57]

Tags:

var:	True if the plugin really block the request. If false, the request is not blocked but the blacklist state is filled as well.
access:	protected

Type:

Boolean

[ Top ]

$buffers = array()

[line 51]

Tags:

var:	Array of Buffer
access:	protected

Type:

Array

[ Top ]

$buffersUpdateRequired = false

[line 62]

Tags:

access:

protected

Type:

Boolean

[ Top ]

$log =

[line 36]

Tags:

access:

private

Type:	Logger
Overrides:	Array

[ Top ]

$white =

[line 41]

Tags:

access:

protected

Type:

WhiteList

[ Top ]

Class Methods

constructor __construct [line 67]

ClientThrottling __construct(
)

Tags:

access:	public
see:	ClientPlugin::__construct()

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method checkBuffersOverflow [line 275]

array checkBuffersOverflow(
Integer
$ip)

Checks if given IP has reached the max request limit of some buffer.

Tags:

return:	Return whatever the user overflow the buffer and the buffer name.
access:	protected

Parameters:

Integer

$ip

[ Top ]

method clearBuffers [line 289]

void clearBuffers(
Integer
$now)

Clear all buffers.

Tags:

access:

protected

Parameters:

Integer

$now

now timestamp

[ Top ]

method handleHttpGetRequest [line 150]

void handleHttpGetRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpGetRequest()

[ Top ]

method handleHttpPostRequest [line 143]

void handleHttpPostRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

[ Top ]

method handleRequest [line 158]

void handleRequest(
array
$request)

Common method to handle both Get or Post request

Tags:

access:

protected

Parameters:

array

$request

HTTP request

[ Top ]

method initLists [line 75]

void initLists(
)

Instanciates lists objects and some config vars.

Tags:

access:

protected

[ Top ]

method notify [line 233]

void notify(
String
$ip, String
$what, Integer
$when)

Send a notification by sending a mail and/or writing the envent to the log file.

Tags:

access:

protected

Parameters:

String	$ip	ip
String	$what	what A text describing the event
Integer	$when	when When does the event occurs (timestamp)

[ Top ]

method renderForm [line 298]

void renderForm(
Smarty
$template)

Tags:

access:	public
see:	GuiProvider::renderForm()

[ Top ]

method sync [line 261]

void sync(
mixed
$ip)

Synchronize the blacklist and all buffers.

Tags:

access:

protected

[ Top ]

Documentation generated on Thu, 09 Feb 2012 13:30:55 +0100 by phpDocumentor 1.3.0RC3