BanEntry Class Reference

Public Member Functions
	__construct ($name)
	getName ()
	getCreated ()
	setCreated (\DateTime $date)
	getSource ()
	setSource ($source)
	getExpires ()
	setExpires ($date)
	hasExpired ()
	getReason ()
	setReason ($reason)
	getString ()

Static Public Member Functions
static	fromString ($str)

Static Public Attributes
static	$format = "Y-m-d H:i:s O"

Constructor & Destructor Documentation

__construct()

__construct

(

$name

)

BanEntry constructor.

Parameters

$name

                                      {
        $this->name = strtolower($name);
        $this->creationDate = new \DateTime();
    }

Member Function Documentation

fromString()

static fromString (   $str )

static

Parameters

string

$str

Returns

BanEntry

                                           {
        if(strlen($str) < 2){
            return null;
        }else{
            $str = explode("|", trim($str));
            $entry = new BanEntry(trim(array_shift($str)));
            if(count($str) > 0){
                $datetime = \DateTime::createFromFormat(self::$format, array_shift($str));
                if(!($datetime instanceof \DateTime)){
                    MainLogger::getLogger()->alert("Error parsing date for BanEntry for player \"" . $entry->getName() . "\", the format may be invalid!");
                    return $entry;
                }
                $entry->setCreated($datetime);
                if(count($str) > 0){
                    $entry->setSource(trim(array_shift($str)));
                    if(count($str) > 0){
                        $expire = trim(array_shift($str));
                        if(strtolower($expire) !== "forever" and strlen($expire) > 0){
                            $entry->setExpires(\DateTime::createFromFormat(self::$format, $expire));
                        }
                        if(count($str) > 0){
                            $entry->setReason(trim(array_shift($str)));
                        }
                    }
                }
            }

            return $entry;
        }
    }

getCreated()

getCreated

(

)

Returns

                                {
        return $this->creationDate;
    }

getExpires()

getExpires

(

)

Returns

                                {
        return $this->expirationDate;
    }

getName()

getName

(

)

Returns

string

                              : string{
        return $this->name;
    }

getReason()

getReason

(

)

Returns

string

                               {
        return $this->reason;
    }

getSource()

getSource

(

)

Returns

string

                               {
        return $this->source;
    }

getString()

getString

(

)

Returns

string

                               {
        $str = "";
        $str .= $this->getName();
        $str .= "|";
        $str .= $this->getCreated()->format(self::$format);
        $str .= "|";
        $str .= $this->getSource();
        $str .= "|";
        $str .= $this->getExpires() === null ? "Forever" : $this->getExpires()->format(self::$format);
        $str .= "|";
        $str .= $this->getReason();

        return $str;
    }

hasExpired()

hasExpired

(

)

Returns

bool

                                {
        $now = new \DateTime();

        return $this->expirationDate === null ? false : $this->expirationDate < $now;
    }

setCreated()

setCreated

(

\DateTime

$date

)

Parameters

\DateTime

$date

                                               {
        $this->creationDate = $date;
    }

setExpires()

setExpires

(

$date

)

Parameters

\DateTime

$date

                                     {
        $this->expirationDate = $date;
    }

setReason()

setReason

(

$reason

)

Parameters

$reason

                                      {
        $this->reason = $reason;
    }

setSource()

setSource

(

$source

)

Parameters

$source

                                      {
        $this->source = $source;
    }

Field Documentation

$format

$format = "Y-m-d H:i:s O"

static

---

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

• src/pocketmine/permission/BanEntry.php