This commit is contained in:
tobi132 2019-07-22 12:14:54 +02:00
parent e7c381d651
commit fb9ead2690

View File

@ -14,7 +14,7 @@
/** /**
* Wrapper for binary server status request. * Wrapper for binary server status request.
* *
* @package POT * @package POT
* @property-read int $uptime Uptime. * @property-read int $uptime Uptime.
* @property-read string $ip IP number. * @property-read string $ip IP number.
@ -103,116 +103,116 @@ class OTS_ServerStatus
const RESPOND_SERVER_SOFTWARE_INFO = 0x23; const RESPOND_SERVER_SOFTWARE_INFO = 0x23;
/** /**
* Server name. * Server name.
* *
* @var string * @var string
*/ */
private $name; private $name;
/** /**
* Server IP. * Server IP.
* *
* @var string * @var string
*/ */
private $ip; private $ip;
/** /**
* Server port. * Server port.
* *
* @var string * @var string
*/ */
private $port; private $port;
/** /**
* Owner name. * Owner name.
* *
* @var string * @var string
*/ */
private $owner; private $owner;
/** /**
* Owner's e-mail. * Owner's e-mail.
* *
* @var string * @var string
*/ */
private $eMail; private $eMail;
/** /**
* Message of the day. * Message of the day.
* *
* @var stirng * @var string
*/ */
private $motd; private $motd;
/** /**
* Server location. * Server location.
* *
* @var string * @var string
*/ */
private $location; private $location;
/** /**
* Website URL. * Website URL.
* *
* @var stirng * @var string
*/ */
private $url; private $url;
/** /**
* Uptime. * Uptime.
* *
* @var int * @var int
*/ */
private $uptime; private $uptime;
/** /**
* Status version. * Status version.
* *
* @var string * @var string
*/ */
private $version; private $version;
/** /**
* Players online. * Players online.
* *
* @var int * @var int
*/ */
private $online; private $online;
/** /**
* Maximum players. * Maximum players.
* *
* @var int * @var int
*/ */
private $max; private $max;
/** /**
* Players peak. * Players peak.
* *
* @var int * @var int
*/ */
private $peak; private $peak;
/** /**
* Map name. * Map name.
* *
* @var string * @var string
*/ */
private $map; private $map;
/** /**
* Map author. * Map author.
* *
* @var string * @var string
*/ */
private $author; private $author;
/** /**
* Map width. * Map width.
* *
* @var int * @var int
*/ */
private $width; private $width;
/** /**
* Map height. * Map height.
* *
* @var int * @var int
*/ */
private $height; private $height;
/** /**
* Players online list. * Players online list.
* *
* @var array * @var array
*/ */
private $players = array(); private $players = array();
/** /**
* Server software. * Server software.
* *
* @var string * @var string
*/ */
private $softwareName; private $softwareName;
@ -221,7 +221,7 @@ class OTS_ServerStatus
/** /**
* Reads info from respond packet. * Reads info from respond packet.
* *
* @param OTS_Buffer $info Information packet. * @param OTS_Buffer $info Information packet.
*/ */
public function __construct(OTS_Buffer $info) public function __construct(OTS_Buffer $info)
@ -277,7 +277,7 @@ class OTS_ServerStatus
$this->players[$name] = $info->getLong(); $this->players[$name] = $info->getLong();
} }
break; break;
case self::RESPOND_SERVER_SOFTWARE_INFO: case self::RESPOND_SERVER_SOFTWARE_INFO:
$this->softwareName = $info->getString(); $this->softwareName = $info->getString();
$this->softwareVersion = $info->getString(); $this->softwareVersion = $info->getString();
@ -289,7 +289,7 @@ class OTS_ServerStatus
/** /**
* Returns server uptime. * Returns server uptime.
* *
* @return int Uptime. * @return int Uptime.
*/ */
public function getUptime() public function getUptime()
@ -299,7 +299,7 @@ class OTS_ServerStatus
/** /**
* Returns server IP. * Returns server IP.
* *
* @return string IP. * @return string IP.
*/ */
public function getIP() public function getIP()
@ -309,7 +309,7 @@ class OTS_ServerStatus
/** /**
* Returns server name. * Returns server name.
* *
* @return string Name. * @return string Name.
*/ */
public function getName() public function getName()
@ -319,7 +319,7 @@ class OTS_ServerStatus
/** /**
* Returns server port. * Returns server port.
* *
* @return int Port. * @return int Port.
*/ */
public function getPort() public function getPort()
@ -329,7 +329,7 @@ class OTS_ServerStatus
/** /**
* Returns server location. * Returns server location.
* *
* @return string Location. * @return string Location.
*/ */
public function getLocation() public function getLocation()
@ -339,7 +339,7 @@ class OTS_ServerStatus
/** /**
* Returns server website. * Returns server website.
* *
* @return string Website URL. * @return string Website URL.
*/ */
public function getURL() public function getURL()
@ -349,7 +349,7 @@ class OTS_ServerStatus
/** /**
* Returns server version. * Returns server version.
* *
* @return string Version. * @return string Version.
*/ */
public function getServerVersion() public function getServerVersion()
@ -359,7 +359,7 @@ class OTS_ServerStatus
/** /**
* Returns owner name. * Returns owner name.
* *
* @return string Owner name. * @return string Owner name.
*/ */
public function getOwner() public function getOwner()
@ -369,7 +369,7 @@ class OTS_ServerStatus
/** /**
* Returns owner e-mail. * Returns owner e-mail.
* *
* @return string Owner e-mail. * @return string Owner e-mail.
*/ */
public function getEMail() public function getEMail()
@ -379,7 +379,7 @@ class OTS_ServerStatus
/** /**
* Returns current amount of players online. * Returns current amount of players online.
* *
* @return int Count of players. * @return int Count of players.
*/ */
public function getOnlinePlayers() public function getOnlinePlayers()
@ -389,7 +389,7 @@ class OTS_ServerStatus
/** /**
* Returns maximum amount of players online. * Returns maximum amount of players online.
* *
* @return int Maximum allowed count of players. * @return int Maximum allowed count of players.
*/ */
public function getMaxPlayers() public function getMaxPlayers()
@ -399,7 +399,7 @@ class OTS_ServerStatus
/** /**
* Returns record of online players. * Returns record of online players.
* *
* @return int Players online record. * @return int Players online record.
*/ */
public function getPlayersPeak() public function getPlayersPeak()
@ -409,7 +409,7 @@ class OTS_ServerStatus
/** /**
* Returns map name. * Returns map name.
* *
* @return string Map name. * @return string Map name.
*/ */
public function getMapName() public function getMapName()
@ -419,7 +419,7 @@ class OTS_ServerStatus
/** /**
* Returns map author. * Returns map author.
* *
* @return string Mapper name. * @return string Mapper name.
*/ */
public function getMapAuthor() public function getMapAuthor()
@ -429,7 +429,7 @@ class OTS_ServerStatus
/** /**
* Returns map width. * Returns map width.
* *
* @return int Map width. * @return int Map width.
*/ */
public function getMapWidth() public function getMapWidth()
@ -439,7 +439,7 @@ class OTS_ServerStatus
/** /**
* Returns map height. * Returns map height.
* *
* @return int Map height. * @return int Map height.
*/ */
public function getMapHeight() public function getMapHeight()
@ -449,7 +449,7 @@ class OTS_ServerStatus
/** /**
* Returns server's Message Of The Day * Returns server's Message Of The Day
* *
* @return string Server MOTD. * @return string Server MOTD.
*/ */
public function getMOTD() public function getMOTD()
@ -459,7 +459,7 @@ class OTS_ServerStatus
/** /**
* Returns list of players currently online. * Returns list of players currently online.
* *
* @return array List of players in format 'name' => level. * @return array List of players in format 'name' => level.
*/ */
public function getPlayers() public function getPlayers()
@ -468,7 +468,7 @@ class OTS_ServerStatus
/** /**
* Returns software name. * Returns software name.
* *
* @return string Software name. * @return string Software name.
*/ */
public function getSoftwareName() public function getSoftwareName()
@ -478,7 +478,7 @@ class OTS_ServerStatus
/** /**
* Returns software version. * Returns software version.
* *
* @return string Software version. * @return string Software version.
*/ */
public function getSoftwareVersion() public function getSoftwareVersion()
@ -488,7 +488,7 @@ class OTS_ServerStatus
/** /**
* Returns software protocol. * Returns software protocol.
* *
* @return string Software protocol. * @return string Software protocol.
*/ */
public function getSoftwareProtocol() public function getSoftwareProtocol()
@ -498,7 +498,7 @@ class OTS_ServerStatus
/** /**
* Magic PHP5 method. * Magic PHP5 method.
* *
* @param string $name Property name. * @param string $name Property name.
* @return mixed Property value. * @return mixed Property value.
* @throws OutOfBoundsException For non-supported properties. * @throws OutOfBoundsException For non-supported properties.