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

Class: ListInFile

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

Class Overview


Handle


Variables

Methods


Child classes:

Buffer
Buffer class, record ip access count.
WhiteList
A WhiteList is a list of zero or more IP networks. The list is read from a config file.
BlackList
An IP can't be staticly add in the list.

Class Details

[line 273]
Handle



[ Top ]


Class Variables

$file =

[line 278]



Tags:

access:  protected

Type:   mixed


[ Top ]

$list =

[line 283]



Tags:

var:  internal list
access:  protected

Type:   Array


[ Top ]



Class Methods


constructor __construct [line 292]

ListInFile __construct( String $file)

ListInFile constructor.

Reads the file content and update the internal list.




Tags:

access:  public


Overridden in child classes as:

Buffer::__construct()
Buffer constructor.
BlackList::__construct()

Parameters:

String   $file   file

[ Top ]

method readLine [line 348]

void readLine( String $line)

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



Tags:

access:  public


Overridden in child classes as:

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

Parameters:

String   $line   raw line

[ Top ]

method sync [line 323]

void sync( )

Write the full list to the file.



Tags:

access:  public


Overridden in child classes as:

WhiteList::sync()

[ Top ]

method writeLine [line 362]

String writeLine( String $key, String $value)

Return a formated record.



Tags:

access:  public


Overridden in child classes as:

Buffer::writeLine()
Return a formated record.

Parameters:

String   $key   key
String   $value   value

[ Top ]


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