Plugins
[ class tree: Plugins ] [ index: Plugins ] [ all elements ]

Class: WhiteList

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

Class Overview

ListInFile
   |
   --WhiteList

A WhiteList is a list of zero or more IP networks. The list is read from a config file.


Methods


Inherited Variables

Inherited Methods

Class: ListInFile

ListInFile::__construct()
ListInFile constructor.
ListInFile::readLine()
Convert a raw line from the file to it's internal representation.
ListInFile::sync()
Write the full list to the file.
ListInFile::writeLine()
Return a formated record.

Class Details

[line 163]
A WhiteList is a list of zero or more IP networks. The list is read from a config file.



[ Top ]


Class Methods


method contains [line 197]

Boolean contains( String $ip)

Return whatever the provided IP is contained into the white list.



Tags:

access:  public


Parameters:

String   $ip   ip eg. 192.168.12.7

[ Top ]

method readLine [line 170]

void readLine( String $line)

Convert a raw line from the file to it's internal representation.



Tags:

access:  public


Overrides ListInFile::readLine() (Convert a raw line from the file to it's internal representation.)

Parameters:

String   $line   raw line

[ Top ]

method sync [line 187]

void sync( )



Tags:

access:  public


Overrides ListInFile::sync() (Write the full list to the file.)

[ Top ]


Documentation generated on Thu, 04 Sep 2008 11:40:00 +0200 by phpDocumentor 1.3.0RC3