BanList Class Reference

Public Member Functions
	__construct ($file)
	isEnabled ()
	setEnabled ($flag)
	getEntries ()
	isBanned ($name)
	add (BanEntry $entry)
	addBan ($target, $reason=null, $expires=null, $source=null)
	remove ($name)
	removeExpired ()
	load ()
	save ($flag=true)

Constructor & Destructor Documentation

__construct()

__construct

(

$file

)

Parameters

string

$file

                                      {
        $this->file = $file;
    }

Member Function Documentation

add()

add

(

BanEntry

$entry

)

Parameters

BanEntry

$entry

                                        {
        $this->list[$entry->getName()] = $entry;
        $this->save();
    }

addBan()

addBan	(		$target,
			$reason = null,
			$expires = null,
			$source = null
	)

Parameters

string	$target
string	$reason
\DateTime	$expires
string	$source

Returns

BanEntry

                                                                                    {
        $entry = new BanEntry($target);
        $entry->setSource($source != null ? $source : $entry->getSource());
        $entry->setExpires($expires);
        $entry->setReason($reason != null ? $reason : $entry->getReason());

        $this->list[$entry->getName()] = $entry;
        $this->save();

        return $entry;
    }

getEntries()

getEntries

(

)

Returns

BanEntry[]

                                {
        $this->removeExpired();

        return $this->list;
    }

isBanned()

isBanned

(

$name

)

Parameters

string

$name

Returns

bool

                                   {
        $name = strtolower($name);
        if(!$this->isEnabled()){
            return false;
        }else{
            $this->removeExpired();

            return isset($this->list[$name]);
        }
    }

isEnabled()

isEnabled

(

)

Returns

bool

                               {
        return $this->enabled === true;
    }

load()

load

(

)

                          {
        $this->list = [];
        $fp = @fopen($this->file, "r");
        if(is_resource($fp)){
            while(($line = fgets($fp)) !== false){
                if($line{0} !== "#"){
                    $entry = BanEntry::fromString($line);
                    if($entry instanceof BanEntry){
                        $this->list[$entry->getName()] = $entry;
                    }
                }
            }
            fclose($fp);
        }else{
            MainLogger::getLogger()->error("Could not load ban list");
        }
    }

remove()

remove

(

$name

)

Parameters

string

$name

                                 {
        $name = strtolower($name);
        if(isset($this->list[$name])){
            unset($this->list[$name]);
            $this->save();
        }
    }

removeExpired()

removeExpired

(

)

                                   {
        foreach($this->list as $name => $entry){
            if($entry->hasExpired()){
                unset($this->list[$name]);
            }
        }
    }

save()

save

(

$flag = true

)

Parameters

bool

$flag

                                      {
        $this->removeExpired();
        $fp = @fopen($this->file, "w");
        if(is_resource($fp)){
            if($flag === true){
                fwrite($fp, "# Updated " . strftime("%x %H:%M", time()) . " by " . Server::getInstance()->getName() . " " . Server::getInstance()->getPocketMineVersion() . "\n");
                fwrite($fp, "# victim name | ban date | banned by | banned until | reason\n\n");
            }

            foreach($this->list as $entry){
                fwrite($fp, $entry->getString() . "\n");
            }
            fclose($fp);
        }else{
            MainLogger::getLogger()->error("Could not save ban list");
        }
    }

setEnabled()

setEnabled

(

$flag

)

Parameters

bool

$flag

                                     {
        $this->enabled = (bool) $flag;
    }

---

The documentation for this class was generated from the following file:

• src/pocketmine/permission/BanList.php