Docs For Class cyts

method admin_clearChannel [line 837]

boolean admin_clearChannel(
integer
$cID, [integer
$kMode = 1], [mixed
$param = NULL])

admin_clearChannel: Removes all players from the target Channel

Tags:

return:	success
see:	cyts::info_getChannelByName(), to get a channel's id from its name
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$cID	The Channel ID
integer	$kMode	(1 - Move To Channel $param, 2 - Kick From Server with reason $param, 3 - Remove From Server)
mixed	$param	The target channel id if $kMode = 1 or the reason if $kMode = 2

[ Top ]

method admin_dbUserAdd [line 980]

boolean admin_dbUserAdd(
string
$lName, string
$lPass, [boolean
$lSA = false])

admin_dbUserAdd: Adds a user to the UserDB

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string	$lName	Username
string	$lPass	Password
boolean	$lSA	Server Admin

[ Top ]

method admin_dbUserChangePW [line 1008]

boolean admin_dbUserChangePW(
integer
$uID, string
$uPW)

admin_dbUserChangePW: Changes the password of user $uID to $uPW

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$uID	UserID
string	$uPW	User password

[ Top ]

method admin_dbUserChangeSA [line 1023]

boolean admin_dbUserChangeSA(
integer
$uID, [boolean
$uSA = false])

admin_dbUserChangeSA: Changes the Server Admin status of a user
Note: This function requires a login with a server admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$uID	UserID
boolean	$uSA	Server admin status (1 - True, 0 - False)

[ Top ]

method admin_dbUserDel [line 994]

boolean admin_dbUserDel(
integer
$uID)

admin_dbUserDel: Deletes a user ftom the UserDB

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$uID

UserID

[ Top ]

method admin_dbUserList [line 923]

array admin_dbUserList(
)

admin_dbUserList: Returns a list of all known users in the database

array:
[0] => Unparsed DB-Row
[1] => Userid
[2] => Serveradmin (0 - False, -1 - True)
[3] => Account created
[4] => Last Login
[5] => Username

Tags:

return:	user list
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method admin_getDBUserByName [line 944]

integer admin_getDBUserByName(
string
$uName)

admin_getDBUserByName: Returns the ID of the user $uName

Tags:

return:	UserID, -1 at failure
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$uName

User Name

[ Top ]

method admin_getDBUserData [line 961]

array admin_getDBUserData(
integer
$uID)

admin_getDBUserData: Returns the data of the user $uID

Tags:

return:	user data, false at failure
access:	public
version:	1.0
author:	Steven Barth

Parameters:

integer

$uID

UserID

[ Top ]

method admin_kick [line 791]

boolean admin_kick(
integer
$pID, [string
$reason = ""])

admin_kick: Kicks the target player from the server

Tags:

return:	True at success, False at failure
see:	cyts::info_getPlayerByName(), to get a player's id from its username
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$pID	The player ID
string	$reason	Reason for kick

[ Top ]

method admin_kickFromChannel [line 775]

boolean admin_kickFromChannel(
integer
$pID)

admin_kickFromChannel: Moves the target player from his/her current channel to the default channel

Tags:

return:	True at success, False at failure
see:	cyts::info_getPlayerByName(), to get a player's id from its username
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$pID

The player ID

[ Top ]

method admin_kickIdler [line 872]

integer admin_kickIdler(
float
$tIdle, integer
$tFlag, [integer
$kMode = 1], [mixed
$param = NULL])

admin_kickIdler: Removes the target idle players (Evaluates the KI function)
Note: If you want to use two or more flags, sum them (e.g. 7 for Unregistered & Registered Users in Unregistered Channels)

Tags:

return:	affected users, 0 at failure
access:	public
version:	2.0
author:	Steven Barth

Parameters:

float	$tIdle	Idle time in minutes
integer	$tFlag	Target Flag (1 - Unregistered Users, 2 - Registered User, 4 - Unregistered Channels, 8 - Registered Channels)
integer	$kMode	(1 - Move To Channel $param, 2 - Kick From Server, 3 - Remove From Server)
mixed	$param	The target channel ID if $kMode = 1 or the reason if $kMode = 2

[ Top ]

method admin_move [line 821]

boolean admin_move(
integer
$pID, integer
$cID)

admin_move: Moves the target player $pID to the target channel $cID

Tags:

return:	True at success, False at failure
see:	cyts::info_getChannelByName(), to get a channel's id from its name
see:	cyts::info_getPlayerByName(), to get a player's id from its username
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$pID	The Player ID
integer	$cID	The Channel ID

[ Top ]

method admin_remove [line 805]

boolean admin_remove(
integer
$pID)

admin_remove: Silently removes the target player from the server

Tags:

return:	True at success, False at failure
see:	cyts::info_getPlayerByName(), to get a player's id from its username
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$pID

The player ID

[ Top ]

method connect [line 78]

boolean connect(
string
$sIP, integer
$sTCP, [integer
$sUDP = false], [integer
$sTimeout = 3])

connect: Connects to a given TS-Server

Tags:

return:	status
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string	$sIP	The server's IP-Adress
integer	$sTCP	The server's TCP-Queryport
integer	$sUDP	The subserver's UDP-Port (optional)
integer	$sTimeout	Socket timeout in seconds

[ Top ]

method debug [line 248]

array debug(
)

debug: Returns all replies sent by the server

Tags:

return:	replies
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method debug_lastreply [line 260]

string debug_lastreply(
)

debug_lastreply: Returns last reply form TS2-Server

Tags:

return:	reply
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method disconnect [line 108]

void disconnect(
)

disconnect: Closes any open connection

Tags:

access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method extendcall [line 236]

string extendcall(
string
$sCall)

extendcall: Executes a command on the server and resets channel and user

Tags:

return:	Server reply
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$sCall

Command string

[ Top ]

method fastcall [line 223]

string fastcall(
string
$sCall)

fastcall: Executes a command on the server

Tags:

return:	Server reply
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$sCall

Command string

[ Top ]

method info_channelInfo [line 466]

array info_channelInfo(
integer
$cID)

info_channelInfo: Returns the channel data of $cID or false at any error

Tags:

return:	channel data, false at failure
see:	cyts::info_channelList(), for array description
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$cID

The Channel ID

[ Top ]

method info_channelList [line 377]

array info_channelList(
)

info_channelList: Returns a list of channels that are available on the server

array:
[0], [unparsed] => Unparsed channelstring
[1], [id] => ChannelID
[2], [codec] => Codec (from 0 to 13):
[3], [parent] => Parent ChannelID (-1 if no Subchannel)
[4], [order] => Channel Order
[5], [maxusers] => Max Users
[6], [name] => Name
[7], [flags] => Flags (1 - Unregistered(U), 2 - Moderated(M), 4 - Private(P), 8 - Subchannels(S), 16 - Default(D))
[8], [password] => Passworded (1 - True, 0 - False)
[9], [topic] => Topic

Tags:

return:	multi-dimensional array with channel data
see:	cyts::info_getCodec(), for getting a codecs name by its id
see:	cyts::info_translateFlag(), for converting flags to arrays
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method info_channelNameList [line 410]

array info_channelNameList(
)

info_channelNameList: Returns a list of channels with their IDs

Tags:

return:	array (channelId => channelName)
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method info_channelUser [line 709]

array info_channelUser(
integer
$cID)

info_channelUser: Returns all users in the target channel in an array

Tags:

return:	user list, false at failure
see:	getPlayers(), for an array description
see:	getChannelByName(), for converting a channel name to an ID
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$cID

The Channel ID

[ Top ]

method info_defaultChannel [line 690]

integer info_defaultChannel(
)

info_defaultChannel: Returns the default channel of the sub-server or false at any error

Tags:

return:	ChannelID, false at failure
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method info_extendServerList [line 578]

array info_extendServerList(
)

info_extendServerList: Returns all known subservers of a TeamSpeak Server with their server info

Tags:

return:	server list, false at failure
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method info_getChannelByName [line 447]

integer info_getChannelByName(
string
$cName)

info_getChannelByName: Returns the ChannelID of the channel with the name $cName or -1 if no channel $cName is existing

Tags:

return:	ChannelID, -1 at failure
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$cName

The Channel name

[ Top ]

method info_getCodec [line 530]

codecname info_getCodec(
integer
$cID)

info_getCodec: Returns the Codec by its name

Tags:

return:	or false at failure
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$cID

The Codec ID

[ Top ]

method info_getPlayerByName [line 430]

integer info_getPlayerByName(
string
$pName)

info_getPlayerByName: Returns the PlayerID of the player with the name $pName or -1 if no user $pName is online

Tags:

return:	PlayerID, -1 at failure
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$pName

The Player name

[ Top ]

method info_globalInfo [line 668]

array info_globalInfo(
)

info_globalInfo: Returns some information about the server

array:
[total_server_uptime] => Server uptime (String)
[total_server_version] => Server version
[total_server_platform] => Server OS
[total_servers] => Total sub-servers
[total_users_online] => Total users online on all sub-servers
[total_users_maximal] => Users maximum on all sub-servers
[total_channels] => Total channels on all servers
[total_bytesreceived] => Total bytes received by server
[total_bytessend] => Total bytes sent by server
[total_packetssend] => Total packets sent by server
[total_packetsreceived] => Total bytes received by server
[total_bwoutlastmin] => Outgoing bandwith (last minute)
[total_bwoutlastsec] => Outgoing bandwith (last second)
[total_bwinlastmin] => Incoming bandwith (last minute)
[total_bwinlastsec] => Incoming bandwith (last second)
[isp_ispname] => Server ISP
[isp_linkurl] => Server ISP - Homepage
[isp_adminemail] => Server ISP - Admin E-Mail
[isp_countrynumber] => Server ISP - Contrynumber

Tags:

return:	serverinformation
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method info_playerImage [line 500]

away, info_playerImage(
integer
$pID)

info_playerImage: Returns the Image that the player has in the TeamSpeak Client

Tags:

return:	sndmuted, micmuted, chancmd, player or false at failure
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$pID

The Player ID

[ Top ]

method info_playerInfo [line 483]

array info_playerInfo(
integer
$pID)

info_playerInfo: Returns the player data of $pID or false at any error

Tags:

return:	player data, false at failure
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$pID

The Player ID

[ Top ]

method info_playerList [line 311]

array info_playerList(
)

info_playerList: Returns a list of players that are connected to the server

array:
[0], [unparsed] => Unparsed playerstring
[1], [p_id] => PlayerID
[2], [c_id] => ChannelID
[3], [ps] => Packets sent by server
[4], [bs] => Bytes sent by server
[5], [pr] => Packets received by server
[6], [br] => Bytes received by server
[7], [pl] => Packet Loss
[8], [ping] => Ping
[9], [logintime] => Seconds since Login
[10], [idletime] => Idletime in seconds
[11], [cprivs] => Channelflags (1 - CA, 2 - O, 4 - V, 8 - AO, 16 - AV)
[12], [pprivs] => Serverflags (1 - SA, 2 - Allowed To Register(AR), 4 - R, 8 - ???, 16 - Sticky)
[13], [pflags] => Playerflags (1 - Channel Commander(CC), 2 - Voice Request(VR), 4 - No Whisper(NW), 8 - Away(AW), 16 - Mic Muted(MM), 32 - Snd Muted(SM), 64 - Rec(RC))
[14], [ip] => IP-Adress (Note: This will be 0.0.0.0 for all players if you are not logged in as a server admin)
[15], [nick] => Nickname
[16], [loginname] => Loginname (empty if user is not registered)

Tags:

return:	multi-dimensional array with player data
access:	public
see:	cyts::info_translateFlag(), for converting flags to arrays
version:	2.0
author:	Steven Barth

[ Top ]

method info_playerNameList [line 345]

array info_playerNameList(
)

info_playerNameList: Returns a list of players with their IDs and Names

Tags:

return:	array (playerId => playerName)
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method info_serverInfo [line 624]

array info_serverInfo(
)

info_serverInfo: Returns some information about the sub-server

array:
[server_id] => Server ID (not UDP-Port)
[server_name] => Server name
[server_platform] => Server OS
[server_welcomemessage] => Server welcome message
[server_webpost_linkurl] => Server webpost linkurl
[server_webpost_posturl] => Server webpost posturl
[server_password] => Server passworded (1 - True, 0 - False)
[server_clan_server] => Clan server (1 - True, 0 - False)
[server_udpport] => UDP-Port
[server_maxusers] => Slots
[server_packetssend] => Packets sent by sub-server
[server_bytessend] => Bytes sent by sub-server
[server_packetsreceived] => Packets received by sub-server
[server_bytesreceived] => Bytes received by sub-server
[server_uptime] => Server uptime in seconds
[server_currentusers] => Connected players
[server_currentchannels] => Existing channels
[server_bwinlastsec] => Incoming bandwith (last second)
[server_bwoutlastsec] => Outgoing bandwith (last second)
[server_bwinlastmin] => Incoming bandwith (last minute)
[server_bwoutlastmin] => Outgoing bandwith (last minute)
[average_packet_loss] => Average Packet Loss

Tags:

return:	serverinformation
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method info_serverList [line 557]

array info_serverList(
)

info_serverList: Returns all known subservers of a TeamSpeak Server

Tags:

return:	server list, false at failure
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method info_translateFlag [line 729]

array info_translateFlag(
integer
$vFlag, [integer
$fType = 1], [boolean
$oStr = false])

info_translateFlag: Translates given flags to arrays

Tags:

return:	array flags, false at failure
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$vFlag	The given flag
integer	$fType	The type of the flag (1 - Player-Channel-Flag, 2 - Player-Server-Flag, 3 - Player-Player-Flag, 4 - Channel-Channel-Flag)
boolean	$oStr	Output as a string, if not as an array

[ Top ]

method login [line 124]

boolean login(
string
$sUser, string
$sPass)

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string	$sUser	Username
string	$sPass	Password

[ Top ]

method sadmin_banClear [line 1641]

boolean sadmin_banClear(
integer
$bID)

sadmin_banClear: Deletes the banlist Note: This function requires a login with a super admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$bID

banid

[ Top ]

method sadmin_banDel [line 1627]

boolean sadmin_banDel(
integer
$bID)

sadmin_banDel: Deletes a banentry Note: This function requires a login with a super admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$bID

banid

[ Top ]

method sadmin_banIP [line 1613]

boolean sadmin_banIP(
integer
$pIP, integer
$bTime)

sadmin_banIP: Bans a target IP Note: This function requires a login with a super admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$pIP	IP-Adress
integer	$bTime	bantime in minutes

[ Top ]

method sadmin_banList [line 1654]

array sadmin_banList(
)

sadmin_banList: Lists current IP-Bans Note: This function requires a login with a super admin account

Tags:

return:	banlist
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method sadmin_banPlayer [line 1598]

boolean sadmin_banPlayer(
integer
$pID, integer
$bTime)

sadmin_banPlayer: Bans a target Player Note: This function requires a login with a super admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$pID	payerid
integer	$bTime	bantime in minutes

[ Top ]

method sadmin_channelInfo [line 1265]

array sadmin_channelInfo(
integer
$cID)

sadmin_channelInfo: Returns several information about a Channel and its Users

Note: This function requires a login with a super admin account Output: [0] => Array ( [0], [unparsed] => Unparsed Channelstring [1], [c_id] => Channel-ID [2], [c_pid] => Parent Channel [3], [c_dbid] => Channel-DBID [4], [c_name] => Channel-Name [5], [c_fU] => Channel Flag Unregistered [6], [c_fM] => Channel Flag Moderated [7], [c_fP] => Channel Flag Private [8], [c_fH] => Channel Flag Subchannels [9], [c_fD] => Channel Flag Default [10], [c_codec] => Channel Codec [11], [c_order] => Channel Order [12], [c_maxusers] => Channel MaxUsers [13], [c_created] => Channel Creation Date/Time [14], [c_topic] => Channel Topic [15], [c_desctiption] => Channel Description ) [1, 2, 3, ...] => Array ( [0], [unparsed] => Unparsed User String [1], [p_id] => PlayerID [2], [p_nick] => Nickname [3], [sa] => Server-Admin [4], [ca] => Channel-Admin [5], [o] => Operator [6], [ao] => Auto-Operator [7], [v] => Voice [8], [av] => Auto-Voice [9], [cst] => Channel Sticky [10], [reg] => Registriert )

Tags:

return:	channel information
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$cID

Channel ID

[ Top ]

method sadmin_dbChannelInfo [line 1379]

array sadmin_dbChannelInfo(
integer
$cID)

sadmin_dbChannelInfo: Returns several information about a channels and its saved flags (kind of dbuserlist for channels)

Note: This function requires a login with a super admin account Output: [0] => Array ( [0], [unparsed] => Unparsed Channelstring [1], [c_dbid] => Channel Database ID [2], [c_dbpid] => Parent Channel Database ID [3], [c_name] => Channel-Name [4], [c_fU] => Channel Flag Unregistered [5], [c_fM] => Channel Flag Moderated [6], [c_fP] => Channel Flag Private [7], [c_fH] => Channel Flag Subchannels [8], [c_fD] => Channel Flag Default [9], [c_codec] => Channel Codec [10], [c_order] => Channel Order [11], [c_maxusers] => Channel MaxUsers [12], [c_created] => Channel Creation Date/Time [13], [c_topic] => Channel Topic [14], [c_desctiption] => Channel Description ) [1, 2, 3, ...] => Array ( [0], [unparsed] => Unparsed User String [1], [p_dbid] => Player Database ID [2], [loginname] => Nickname [3], [ca] => Server-Admin [4], [ao] => Channel-Admin [5], [av] => Operator )

Tags:

return:	channel information
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$cID

Channel Database ID

[ Top ]

method sadmin_dbFindPlayer [line 1411]

array sadmin_dbFindPlayer(
string
$sQuery)

sadmin_dbFindPlayer: Finds a player in the database based on a string Note: This function requires a login with a super admin account

Tags:

return:	search matches
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$sQuery

Suchstring

[ Top ]

method sadmin_dbServerInfo [line 1459]

array sadmin_dbServerInfo(
integer
$sID, [array
$sList = false])

sadmin_dbServerInfo: Returns the data of a specified server Note: This function requires a login with a super admin account

Tags:

return:	server list
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$sID	serverid
array	$sList	serverlist (optional)

[ Top ]

method sadmin_dbServerList [line 1432]

array sadmin_dbServerList(
)

sadmin_dbServerList: Lists all servers, there UDP-Port, ID, Name and Status Note: This function requires a login with a super admin account

Tags:

return:	server list
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method sadmin_dbSUserAdd [line 1099]

boolean sadmin_dbSUserAdd(
string
$lName, string
$lPass, boolean
$lSA)

sadmin_dbSUserAdd: Adds a user to the UserDB

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string	$lName	Username
string	$lPass	Password
boolean	$lSA	Server Admin

[ Top ]

method sadmin_dbSUserChangePW [line 1126]

boolean sadmin_dbSUserChangePW(
integer
$uID, string
$uPW)

sadmin_dbSUserChangePW: Changes the password of user $uID to $uPW

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$uID	UserID
string	$uPW	User password

[ Top ]

method sadmin_dbSUserDel [line 1112]

boolean sadmin_dbSUserDel(
integer
$uID)

sadmin_dbSUserDel: Deletes a user from the UserDB

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$uID

UserID

[ Top ]

method sadmin_dbSUserList [line 1042]

array sadmin_dbSUserList(
)

sadmin_dbSUserList: Returns a list of all known users in the database

array:
[0] => Unparsed DB-Row
[1] => Userid
[2] => Account created
[3] => Last Login
[4] => Username

Tags:

return:	user list
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method sadmin_findChannel [line 1189]

array sadmin_findChannel(
string
$sQuery)

sadmin_findChannel: Finds a channel based on a string Note: This function requires a login with a super admin account

Tags:

return:	search matches
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$sQuery

Suchstring

[ Top ]

method sadmin_findPlayer [line 1211]

array sadmin_findPlayer(
string
$sQuery)

sadmin_findPlayer: Finds a player based on a string Note: This function requires a login with a super admin account

Tags:

return:	search matches
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$sQuery

Suchstring

[ Top ]

method sadmin_getDBSUserByName [line 1063]

integer sadmin_getDBSUserByName(
string
$uName)

sadmin_getDBSUserByName: Returns the ID of the user $uName

Tags:

return:	UserID, -1 at failure
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$uName

User Name

[ Top ]

method sadmin_getDBSUserData [line 1080]

array sadmin_getDBSUserData(
integer
$uID)

sadmin_getDBSUserData: Returns the data of the user $uID

Tags:

return:	user data, false at failure
access:	public
version:	1.0
author:	Steven Barth

Parameters:

integer

$uID

UserID

[ Top ]

method sadmin_logFind [line 1566]

array sadmin_logFind(
string
$lQuery)

sadmin_logFind: Finds serverlog entries Note: This function requires a login with a super admin account

Tags:

return:	logdata
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$lQuery

search querystring

[ Top ]

method sadmin_logRead [line 1549]

array sadmin_logRead(
integer
$lNum)

sadmin_logRead: Reads serverlog entries Note: This function requires a login with a super admin account

Tags:

return:	logdata
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$lNum

number of lines

[ Top ]

method sadmin_logWrite [line 1583]

array sadmin_logWrite(
string
$lLine)

sadmin_logWrite: Writes a line to logfile Note: This function requires a login with a super admin account

Tags:

return:	logdata
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$lLine

line

[ Top ]

method sadmin_messageAll [line 1174]

boolean sadmin_messageAll(
string
$sMsg, [boolean
$uHide = false])

sadmin_messageUser: Sends a Message to a all Subserver Note: This function requires a login with a super admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string	$sMsg	Message
boolean	$uHide	Hide Loginname

[ Top ]

method sadmin_messageServer [line 1141]

boolean sadmin_messageServer(
string
$sMsg, [boolean
$uHide = false])

sadmin_messageServer: Sends a Message to a Subserver Note: This function requires a login with a super admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string	$sMsg	Message
boolean	$uHide	Hide Loginname

[ Top ]

method sadmin_messageUser [line 1158]

boolean sadmin_messageUser(
integer
$uID, string
$sMsg, [boolean
$uHide = false])

sadmin_messageUser: Sends a Message to a User Note: This function requires a login with a super admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$uID	UserID
string	$sMsg	Message
boolean	$uHide	Hide Loginname

[ Top ]

method sadmin_playerInfo [line 1321]

array sadmin_playerInfo(
integer
$cID)

sadmin_playerInfo: Returns several information about a User and the server and channel rights of him

Note: This function requires a login with a super admin account Output: [0] => Array ( [0], [unparsed] => Unparsed playerstring
[1], [p_id] => PlayerID
[2], [p_dbid] => Player Database ID
[3], [c_id] => Channel ID
[4], [nickname] => Nickname
[5], [loginname] => Loginname
[6], [sa] => Server Administrator
[7], [st] => Channel Sticky
[8], [ip] => IP
) [1, 2, 3, ...] => Array ( [0], [unparsed] => Unparsed Channelstring [1], [p_id] => Channel-ID [2], [p_dbpid] => Parent Channel [3], [c_id] => Channel-DBID [4], [nicknae] => Channel-Name [5], [loginname] => Channel Flag Unregistered [6], [sa] => Channel Flag Moderated [7], [st] => Channel Flag Private [8], [ip] => Channel Flag Subchannels )

Tags:

return:	channel information
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$cID

Channel ID

[ Top ]

method sadmin_serverAdd [line 1520]

boolean sadmin_serverAdd(
integer
$sUDP)

sadmin_serverAdd: Adds a server Note: This function requires a login with a super admin account

Tags:

return:	status
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$sUDP

udp-port

[ Top ]

method sadmin_serverDelete [line 1506]

boolean sadmin_serverDelete(
integer
$sID)

sadmin_serverDelete: Deletes the server Note: This function requires a login with a super admin account

Tags:

return:	status
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$sID

serverid

[ Top ]

method sadmin_serverSet [line 1535]

boolean sadmin_serverSet(
string
$sVar, string
$sVal)

sadmin_serverSet: Sets a server variable Note: This function requires a login with a super admin account

Tags:

return:	status
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string	$sVar	config-variable
string	$sVal	config-value

[ Top ]

method sadmin_serverStart [line 1479]

boolean sadmin_serverStart(
integer
$sID)

sadmin_serverStart: Starts the server Note: This function requires a login with a super admin account

Tags:

return:	status
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$sID

serverid

[ Top ]

method sadmin_serverStop [line 1492]

boolean sadmin_serverStop(
)

sadmin_serverStop: Stops the server Note: This function requires a login with a super admin account

Tags:

return:	status
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method sadmin_sppriv [line 1682]

boolean sadmin_sppriv(
integer
$pID, string
$sPriv, string
$pVal)

sadmin_sppriv: Sets server privileges Note: This function requires a login with a super admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer	$pID	payerid
string	$sPriv	privilege
string	$pVal	value

[ Top ]

method select [line 275]

boolean select(
integer
$sUDP)

select: Select a TeamSpeak subserver

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

integer

$sUDP

The subserver UDP-Port

[ Top ]

method slogin [line 146]

boolean slogin(
string
$sUser, string
$sPass)

slogin: Authenticates with the server as superadmin

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string	$sUser	Username
string	$sPass	Password

[ Top ]

method wi_login [line 165]

boolean wi_login(
[string
$wiPort = 14534], [mixed
$sTimeout = 3])

wi_login: Authenticates with the webinterface as admin

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$wiPort

WebInterface-Port

[ Top ]

method wi_readGroupPermissions [line 1807]

array wi_readGroupPermissions(
string
$class)

wi_readGroupPermissions: Reads the group permissions of the specified usergroup Note: This function requires a login with a webinterface-activated admin account

Tags:

return:	group permissions (permission => 0\|1)
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$class

(sa | ca | op | v | r | u)

[ Top ]

method wi_readHostSettings [line 1752]

array wi_readHostSettings(
)

wi_readHostSettings: Reads the host settings from the webinterface Note: This function requires a login with a webinterface-activated admin account

Tags:

return:	server vars
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method wi_readServerSettings [line 1695]

array wi_readServerSettings(
)

wi_readServerSettings: Reads the server settings from the webinterface Note: This function requires a login with a webinterface-activated admin account

Tags:

return:	server vars
access:	public
version:	2.0
author:	Steven Barth

[ Top ]

method wi_select [line 205]

boolean wi_select(
[string
$sID = NULL])

wi_select: Selects a server through Webinterface

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string

$sID

ServerID

[ Top ]

method wi_writeGroupPermissions [line 1836]

boolean wi_writeGroupPermissions(
string
$class, [array
$sData = array()])

wi_writeGroupPermissions: Writes the group permissions of the specified usergroup Note: This function requires a login with a webinterface-activated admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

string	$class	(sa \| ca \| op \| v \| r \| u)
array	$sData	group permissions (permission => 0\|1)

[ Top ]

method wi_writeHostSettings [line 1780]

boolean wi_writeHostSettings(
[array
$sData = array()])

wi_writeHostSettings: Writes the host settings to the webinterface Note: This function requires a login with a webinterface-activated admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

array

$sData

data to set [key => val]

[ Top ]

method wi_writeServerSettings [line 1724]

boolean wi_writeServerSettings(
[array
$sData = array()])

wi_writeServerSettings: Writes the server settings to the webinterface Note: This function requires a login with a webinterface-activated admin account

Tags:

return:	success
access:	public
version:	2.0
author:	Steven Barth

Parameters:

array

$sData

data to set [key => val]

[ Top ]

Class: cyts

Class Overview

Methods

Class Details

Class Methods

method admin_clearChannel [line 837]

Tags:

Parameters:

method admin_dbUserAdd [line 980]

Tags:

Parameters:

method admin_dbUserChangePW [line 1008]

Tags:

Parameters:

method admin_dbUserChangeSA [line 1023]

Tags:

Parameters:

method admin_dbUserDel [line 994]

Tags:

Parameters:

method admin_dbUserList [line 923]

Tags:

method admin_getDBUserByName [line 944]

Tags:

Parameters:

method admin_getDBUserData [line 961]

Tags:

Parameters:

method admin_kick [line 791]

Tags:

Parameters:

method admin_kickFromChannel [line 775]

Tags:

Parameters:

method admin_kickIdler [line 872]

Tags:

Parameters:

method admin_move [line 821]

Tags:

Parameters:

method admin_remove [line 805]

Tags:

Parameters:

method connect [line 78]

Tags:

Parameters:

method debug [line 248]

Tags:

method debug_lastreply [line 260]

Tags:

method disconnect [line 108]

Tags:

method extendcall [line 236]

Tags:

Parameters:

method fastcall [line 223]

Tags:

Parameters:

method info_channelInfo [line 466]

Tags:

Parameters:

method info_channelList [line 377]

Tags:

method info_channelNameList [line 410]

Tags:

method info_channelUser [line 709]

Tags:

Parameters:

method info_defaultChannel [line 690]

Tags:

method info_extendServerList [line 578]

Tags:

method info_getChannelByName [line 447]

Tags:

Parameters:

method info_getCodec [line 530]

Tags:

Parameters:

method info_getPlayerByName [line 430]

Tags: