POT
POT
POT
Main menu

Download

Forum

SVN

Tutorials/Manuals
Package-level:
Extra info

RULES

INSTALL

CHANGELOG

LICENSE

README

NEWS

Todo List

Interfaces
IOTS_Cipher
IOTS_DAO
IOTS_DataDisplay
IOTS_DB
IOTS_Display
IOTS_FileCache
IOTS_GuildAction
IOTS_ItemsCache
Classes
E_OTS_ErrorCode
E_OTS_FileLoaderError
E_OTS_Generic
E_OTS_NoDriver
E_OTS_NotAContainer
E_OTS_NotLoaded
E_OTS_OTBMError
E_OTS_OutOfBuffer
E_OTS_ReadOnly
OTS_Account
OTS_AccountBan
OTS_AccountBans_List
OTS_Accounts_List
OTS_Admin
OTS_Ban
OTS_Bans_List
OTS_Base_DAO
OTS_Base_DB
OTS_Base_List
OTS_BinaryTools
OTS_Buffer
OTS_Container
OTS_DB_MySQL
OTS_DB_ODBC
OTS_DB_PostgreSQL
OTS_DB_SQLite
OTS_FileLoader
OTS_FileNode
OTS_Group
OTS_Groups_List
OTS_Guild
OTS_GuildRank
OTS_GuildRanks_List
OTS_Guilds_List
OTS_House
OTS_HousesList
OTS_InfoRespond
OTS_IPBan
OTS_IPBans_List
OTS_Item
OTS_ItemsList
OTS_ItemType
OTS_MapCoords
OTS_Monster
OTS_MonstersList
OTS_OTBMFile
OTS_Player
OTS_PlayerBan
OTS_PlayerBans_List
OTS_Players_List
OTS_Row_DAO
OTS_RSA
OTS_ServerInfo
OTS_ServerStatus
OTS_Spell
OTS_SpellsList
OTS_SQLField
OTS_SQLFilter
OTS_Toolbox
OTS_VocationsList
OTS_Waypoint
OTS_XTEA
POT

Class: OTS_ServerStatus

Source Location: /classes/OTS_ServerStatus.php

Class OTS_ServerStatus

Class Overview
Class Overview | Method Summary | Methods Detail | Constants Summary | Constants Detail

Wrapper for binary server status request.

Wrapper for binary server status request.

Located in /classes/OTS_ServerStatus.php [line 38] 



		
				Author(s):
		
    
		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  			 		  		

		
		API Tags:



  

    Property-read:  int $uptime: Uptime.
  

  

    Property-read:  string $ip: IP number.
  

  

    Property-read:  string $name: Server name.
  

  

    Property-read:  int $port: Server port.
  

  

    Property-read:  string $location: Server physical location.
  

  

    Property-read:  string $url: Website URL.
  

  

    Property-read:  string $serverVersion: Server version.
  

  

    Property-read:  string $owner: Owner name.
  

  

    Property-read:  string $eMail: Owner's e-mail.
  

  

    Property-read:  int $onlinePlayers: Players online count.
  

  

    Property-read:  int $maxPlayers: Maximum allowed players count.
  

  

    Property-read:  int $playersPeak: Record of players online.
  

  

    Property-read:  string $mapName: Map name.
  

  

    Property-read:  string $mapAuthor: Map author.
  

  

    Property-read:  int $mapWidth: Map width.
  

  

    Property-read:  int $mapHeight: Map height.
  

  

    Property-read:  string $motd: Message Of The Day.
  

  

    Property-read:  array $players: Online players list.
  






Information Tags:



			
Version:  0.1.4

				
Since:  0.1.4

	

				

		
				
		
Methods

		
				
		
		

		
[ Top ]

	






	
	

		
Constant Summary

		

			Class Overview
									| Constants Summary | Constants Detail
															| Method Summary | Methods Detail
									

		

			

			

					

					

					

					

					

					

					

					

					

					

					

					

					

					

							

					REQUEST_BASIC_SERVER_INFO  
					Basic server info.

				
								

					REQUEST_EXT_PLAYERS_INFO  
					Extended players info.

				
								

					REQUEST_MAP_INFO  
					Map info.

				
								

					REQUEST_MISC_SERVER_INFO  
					Server extra info.

				
								

					REQUEST_OWNER_SERVER_INFO  
					Server owner info.

				
								

					REQUEST_PLAYERS_INFO  
					Players stats info.

				
								

					REQUEST_PLAYER_STATUS_INFO  
					Player status info.

				
								

					RESPOND_BASIC_SERVER_INFO  
					Basic server respond.

				
								

					RESPOND_EXT_PLAYERS_INFO  
					Extended players info.

				
								

					RESPOND_MAP_INFO  
					Map respond.

				
								

					RESPOND_MISC_SERVER_INFO  
					Server extra respond.

				
								

					RESPOND_OWNER_SERVER_INFO  
					Server owner respond.

				
								

					RESPOND_PLAYERS_INFO  
					Players stats respond.

				
								

					RESPOND_PLAYER_STATUS_INFO  
					Player status info.

				
								

			

			
[ Top ]

		

	



	
	

		
Method Summary

		

			Class Overview
									    		    			    				| Constants Summary | Constants Detail
    			    					| Method Summary | Methods Detail
		

		

			

				

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

																																																																																																																																																																																
OTS_ServerStatus  
										__construct()  
					Reads info from respond packet.

				
																
string  
										getEMail()  
					Returns owner e-mail.

				
																
string  
										getIP()  
					Returns server IP.

				
																
string  
										getLocation()  
					Returns server location.

				
																
string  
										getMapAuthor()  
					Returns map author.

				
																
int  
										getMapHeight()  
					Returns map height.

				
																
string  
										getMapName()  
					Returns map name.

				
																
int  
										getMapWidth()  
					Returns map width.

				
																
int  
										getMaxPlayers()  
					Returns maximum amount of players online.

				
																
string  
										getMOTD()  
					Returns server's Message Of The Day

				
																
string  
										getName()  
					Returns server name.

				
																
int  
										getOnlinePlayers()  
					Returns current amount of players online.

				
																
string  
										getOwner()  
					Returns owner name.

				
																
array  
										getPlayers()  
					Returns list of players currently online.

				
																
int  
										getPlayersPeak()  
					Returns record of online players.

				
																
int  
										getPort()  
					Returns server port.

				
																
string  
										getServerVersion()  
					Returns server version.

				
																
int  
										getUptime()  
					Returns server uptime.

				
																
string  
										getURL()  
					Returns server website.

				
																
mixed  
										__get()  
					Magic PHP5 method.

				
												

			

			
[ Top ]

		

	



	
	

		
Methods

		

			Class Overview
																					| Constants Summary | Constants Detail
														| Method Summary | Methods Detail
					

		

			








	Constructor __construct  [line 212]





	

    

    
 
		OTS_ServerStatus __construct(
OTS_Buffer
$info 
)
    

    



	
Reads info from respond packet.



Reads info from respond packet.

			Parameters:

			

					

				OTS_Buffer  
				
				$info: 
				
				 Information packet.			

				


	

	API Tags:



  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getEMail  [line 354]





	

    

    
 
		string getEMail(
)
    

    



	
Returns owner e-mail.



Returns owner e-mail.

	

	API Tags:



  

    Return:  Owner e-mail.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getIP  [line 284]





	

    

    
 
		string getIP(
)
    

    



	
Returns server IP.



Returns server IP.

	

	API Tags:



  

    Return:  IP.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getLocation  [line 314]





	

    

    
 
		string getLocation(
)
    

    



	
Returns server location.



Returns server location.

	

	API Tags:



  

    Return:  Location.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getMapAuthor  [line 404]





	

    

    
 
		string getMapAuthor(
)
    

    



	
Returns map author.



Returns map author.

	

	API Tags:



  

    Return:  Mapper name.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getMapHeight  [line 424]





	

    

    
 
		int getMapHeight(
)
    

    



	
Returns map height.



Returns map height.

	

	API Tags:



  

    Return:  Map height.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getMapName  [line 394]





	

    

    
 
		string getMapName(
)
    

    



	
Returns map name.



Returns map name.

	

	API Tags:



  

    Return:  Map name.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getMapWidth  [line 414]





	

    

    
 
		int getMapWidth(
)
    

    



	
Returns map width.



Returns map width.

	

	API Tags:



  

    Return:  Map width.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getMaxPlayers  [line 374]





	

    

    
 
		int getMaxPlayers(
)
    

    



	
Returns maximum amount of players online.



Returns maximum amount of players online.

	

	API Tags:



  

    Return:  Maximum allowed count of players.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getMOTD  [line 434]





	

    

    
 
		string getMOTD(
)
    

    



	
Returns server's Message Of The Day



Returns server's Message Of The Day

	

	API Tags:



  

    Return:  Server MOTD.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getName  [line 294]





	

    

    
 
		string getName(
)
    

    



	
Returns server name.



Returns server name.

	

	API Tags:



  

    Return:  Name.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getOnlinePlayers  [line 364]





	

    

    
 
		int getOnlinePlayers(
)
    

    



	
Returns current amount of players online.



Returns current amount of players online.

	

	API Tags:



  

    Return:  Count of players.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getOwner  [line 344]





	

    

    
 
		string getOwner(
)
    

    



	
Returns owner name.



Returns owner name.

	

	API Tags:



  

    Return:  Owner name.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getPlayers  [line 444]





	

    

    
 
		array getPlayers(
)
    

    



	
Returns list of players currently online.



Returns list of players currently online.

	

	API Tags:



  

    Return:  List of players in format 'name' => level.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getPlayersPeak  [line 384]





	

    

    
 
		int getPlayersPeak(
)
    

    



	
Returns record of online players.



Returns record of online players.

	

	API Tags:



  

    Return:  Players online record.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getPort  [line 304]





	

    

    
 
		int getPort(
)
    

    



	
Returns server port.



Returns server port.

	

	API Tags:



  

    Return:  Port.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getServerVersion  [line 334]





	

    

    
 
		string getServerVersion(
)
    

    



	
Returns server version.



Returns server version.

	

	API Tags:



  

    Return:  Version.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getUptime  [line 274]





	

    

    
 
		int getUptime(
)
    

    



	
Returns server uptime.



Returns server uptime.

	

	API Tags:



  

    Return:  Uptime.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	getURL  [line 324]





	

    

    
 
		string getURL(
)
    

    



	
Returns server website.



Returns server website.

	

	API Tags:



  

    Return:  Website URL.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]










	__get  [line 455]





	

    

    
 
		mixed __get(
string
$name 
)
    

    



	
Magic PHP5 method.



Magic PHP5 method.

			Parameters:

			

					

				string  
				
				$name: 
				
				 Property name.			

				


	

	API Tags:



  

    Return:  Property value.
  

  

    Access:  public
  






Information Tags:



  

    Version:  0.1.4
  

  

    Throws:  OutOfBoundsException For non-supported properties.
  

  

    Since:  0.1.4
  




		
		

	
[ Top ]



		

	


	
	

		
Constants

		

			Class Overview
										| Constants Summary | Constants Detail
																		| Method Summary | Methods Detail
									

		

			




	

		
			REQUEST_BASIC_SERVER_INFO
			 =  1
			[line 43]
		
	


	
Basic server info.



Basic server info.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			REQUEST_EXT_PLAYERS_INFO
			 =  32
			[line 63]
		
	


	
Extended players info.



Extended players info.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			REQUEST_MAP_INFO
			 =  16
			[line 59]
		
	


	
Map info.



Map info.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			REQUEST_MISC_SERVER_INFO
			 =  4
			[line 51]
		
	


	
Server extra info.



Server extra info.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			REQUEST_OWNER_SERVER_INFO
			 =  2
			[line 47]
		
	


	
Server owner info.



Server owner info.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			REQUEST_PLAYERS_INFO
			 =  8
			[line 55]
		
	


	
Players stats info.



Players stats info.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			REQUEST_PLAYER_STATUS_INFO
			 =  64
			[line 67]
		
	


	
Player status info.



Player status info.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			RESPOND_BASIC_SERVER_INFO
			 =  0x10
			[line 72]
		
	


	
Basic server respond.



Basic server respond.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			RESPOND_EXT_PLAYERS_INFO
			 =  0x21
			[line 92]
		
	


	
Extended players info.



Extended players info.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			RESPOND_MAP_INFO
			 =  0x30
			[line 88]
		
	


	
Map respond.



Map respond.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			RESPOND_MISC_SERVER_INFO
			 =  0x12
			[line 80]
		
	


	
Server extra respond.



Server extra respond.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			RESPOND_OWNER_SERVER_INFO
			 =  0x11
			[line 76]
		
	


	
Server owner respond.



Server owner respond.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			RESPOND_PLAYERS_INFO
			 =  0x20
			[line 84]
		
	


	
Players stats respond.



Players stats respond.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]








	

		
			RESPOND_PLAYER_STATUS_INFO
			 =  0x22
			[line 96]
		
	


	
Player status info.



Player status info.
	
Information Tags:



  

    Version:  0.1.4
  

  

    Since:  0.1.4
  




	

	
[ Top ]