Documentation

BanList
in package

Table of Contents

$enabled  : bool
$file  : string
$list  : array<string|int, BanEntry>
__construct()  : mixed
add()  : void
addBan()  : BanEntry
getEntries()  : array<string|int, BanEntry>
getEntry()  : BanEntry|null
isBanned()  : bool
isEnabled()  : bool
load()  : void
remove()  : void
removeExpired()  : void
save()  : void
setEnabled()  : void

Properties

$enabled

private bool $enabled = true

Methods

__construct()

public __construct(string $file) : mixed
Parameters
$file : string
Return values
mixed —

addBan()

public addBan(string $target[, string|null $reason = null ][, DateTime|null $expires = null ][, string|null $source = null ]) : BanEntry
Parameters
$target : string
$reason : string|null = null
$expires : DateTime|null = null
$source : string|null = null
Return values
BanEntry —

isBanned()

public isBanned(string $name) : bool
Parameters
$name : string
Return values
bool —

isEnabled()

public isEnabled() : bool
Return values
bool —

load()

public load() : void
Return values
void —

remove()

public remove(string $name) : void
Parameters
$name : string
Return values
void —

removeExpired()

public removeExpired() : void
Return values
void —

save()

public save([bool $writeHeader = true ]) : void
Parameters
$writeHeader : bool = true
Return values
void —

setEnabled()

public setEnabled(bool $flag) : void
Parameters
$flag : bool
Return values
void —

Search results