diff --git a/CHANGELOG b/CHANGELOG index 21825d1..2366e93 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,6 +1,15 @@ -Tested compatibility to version: 3.2.0 x64 +Tested compatibility to version: 3.3.1 x64 __________________________________________ +Version: 1.0.2.5 - Thu, 30 Aug 2018 + +~ changed description of logAdd, loglevels added (thanks to derrodirik) +~ changed description of banList (thanks to derrodirik) +~ changed description of clientGetNameFromUid (thanks to WrightProjects) +~ added filter function to serverGroupList (thanks to thomas-rolling) +~ overworked documentation, especially return-types (thanks to thomas-rolling) + + Version: 1.0.2.4 - Tue, 05 Jun 2018 + added customSet and customDelete function diff --git a/composer.json b/composer.json index 1eebe81..854a6d7 100644 --- a/composer.json +++ b/composer.json @@ -4,7 +4,7 @@ "keywords": ["ts3","ts3admin","admin","teamspeak","teamspeak3"], "homepage": "https://github.com/par0noid/ts3admin.class", "type": "library", - "version": "1.0.2.4", + "version": "1.0.2.5", "require": { "php": ">=5.0.0" }, diff --git a/docs/manual/annotated.html b/docs/manual/annotated.html index 3bd2f09..fdd2380 100644 --- a/docs/manual/annotated.html +++ b/docs/manual/annotated.html @@ -23,7 +23,7 @@ Logo
ts3admin.class -  1.0.2.4 +  1.0.2.5
The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
diff --git a/docs/manual/classes.html b/docs/manual/classes.html index 9b05ddd..4ead7f8 100644 --- a/docs/manual/classes.html +++ b/docs/manual/classes.html @@ -23,7 +23,7 @@ Logo
ts3admin.class -  1.0.2.4 +  1.0.2.5
The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
diff --git a/docs/manual/classts3admin.html b/docs/manual/classts3admin.html index cfedf69..4897dd3 100644 --- a/docs/manual/classts3admin.html +++ b/docs/manual/classts3admin.html @@ -23,7 +23,7 @@ Logo
ts3admin.class -  1.0.2.4 +  1.0.2.5
The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
@@ -326,8 +326,8 @@    serverGroupGetIconBySGID ($serverGroupID)   - serverGroupList () -  + serverGroupList ($type=null) +   serverGroupPermList ($sgid, $permsid=false)    serverGroupRename ($sgid, $name) @@ -594,7 +594,7 @@

Returns
void
+
Returns
array
@@ -827,7 +827,7 @@

Returns
boolean success
+
Returns
array success
@@ -848,7 +848,7 @@

Author
Stefan Zehnpfennig
-
Returns
boolean success
+
Returns
array success
@@ -868,6 +868,7 @@

banList

Displays a list of active bans on the selected virtual server.

+

Note: If [name] is always empty use [lastnickname]

Output:

 Array
 {
@@ -882,6 +883,7 @@ 

Author
Stefan Zehnpfennig
Returns
array banlist
@@ -961,7 +963,7 @@

Returns
boolean success
+
Returns
array success
@@ -1012,7 +1014,7 @@

Returns
boolean success
+
Returns
array success
@@ -1064,7 +1066,7 @@

Returns
boolean success
+
Returns
array success
@@ -1276,7 +1278,7 @@

Returns
boolean success
+
Returns
array success
@@ -1320,7 +1322,7 @@

Returns
boolean success
+
Returns
array success
@@ -1352,7 +1354,8 @@

Author
Stefan Zehnpfennig
@@ -1363,7 +1366,7 @@

Returns
boolean success
+
Returns
array success
@@ -1480,7 +1483,7 @@

Returns
boolean success
+
Returns
array success
@@ -1526,7 +1529,7 @@

Returns
boolean success
+
Returns
array success
@@ -1570,7 +1573,7 @@

Returns
boolean success
+
Returns
array success
@@ -1728,7 +1731,7 @@

Returns
boolean success
+
Returns
array success
@@ -1771,7 +1774,7 @@

Returns
boolean success
+
Returns
array success
@@ -1924,7 +1927,7 @@

Returns
boolean success
+
Returns
array success
@@ -2090,7 +2093,7 @@

Returns
boolean success
+
Returns
array success
@@ -2183,7 +2186,7 @@

Returns
boolean success
+
Returns
array success
@@ -2242,7 +2245,7 @@

Returns
boolean success
+
Returns
array success
@@ -2284,7 +2287,7 @@

Returns
boolean success
+
Returns
array success
@@ -2478,7 +2481,7 @@

Returns
boolean success
+
Returns
array success
@@ -2521,7 +2524,7 @@

Returns
boolean success
+
Returns
array success
@@ -2763,6 +2766,7 @@

Returns
boolean success
+
Returns
array success
@@ -2941,7 +2945,7 @@

Returns
boolean success
+
Returns
array success
@@ -2984,7 +2988,7 @@

Author
Stefan Zehnpfennig
Parameters
- +
intege$cldbidclientDBID
integer$cldbidclientDBID
boolean$permsidset true to add -permsid param [optional]
@@ -3028,7 +3032,7 @@

Returns
boolean success

+
Returns
array success
@@ -3093,7 +3097,7 @@

Returns
boolean success
+
Returns
array success
@@ -3132,7 +3136,7 @@

Returns
boolean success
+
Returns
array success
@@ -3171,7 +3175,7 @@

Returns
boolean success
+
Returns
array success
@@ -3199,7 +3203,7 @@

Returns
boolean success
+
Returns
array success
@@ -3258,7 +3262,7 @@

Author
Stefan Zehnpfennig
-
Returns
boolean success
+
Returns
array success
@@ -3600,7 +3604,7 @@

Returns
boolean success
+
Returns
array success
@@ -3650,7 +3654,7 @@

Returns
boolean success
+
Returns
array success
@@ -3732,7 +3736,7 @@

Returns
boolean success
+
Returns
array success
@@ -4045,7 +4049,7 @@

Returns
boolean success
+
Returns
array success
@@ -4084,7 +4088,7 @@

Returns
boolean success
+
Returns
array success
@@ -4251,7 +4255,7 @@

getQueryClid

Returns the server query client id

-
Author
toxiicdev (.net)
+
Author
toxiicdev
Returns
int value
@@ -4280,7 +4284,7 @@

Returns
boolean success
+
Returns
array success
@@ -4355,7 +4359,7 @@

Returns
boolean success
+
Returns
array success
@@ -4424,6 +4428,7 @@

logAdd

Writes a custom entry into the servers log. Depending on your permissions, you'll be able to add entries into the server instance log and/or your virtual servers log. The loglevel parameter specifies the type of the entry.

+

Hint: Log level 1: "Error", Log Level 2: "Warning", Log Level 3: "Debug", Log level 4: "Info"

Author
Stefan Zehnpfennig
Parameters
@@ -4432,7 +4437,7 @@

Returns
boolean success
+
Returns
array success
@@ -4471,7 +4476,7 @@

Returns
boolean success
+
Returns
array success
@@ -4492,7 +4497,7 @@

Author
Stefan Zehnpfennig
-
Returns
boolean success
+
Returns
array success
@@ -4558,7 +4563,7 @@

Returns
multidimensional-array logEntries
+
Returns
array logEntries
@@ -4604,7 +4609,7 @@

Returns
boolean success
+
Returns
array success
@@ -4632,7 +4637,7 @@

Returns
boolean success
+
Returns
array success
@@ -4822,7 +4827,7 @@

Author
Stefan Zehnpfennig
Parameters

- +
string$permsidspermNames
array$permsidspermNames
@@ -5092,7 +5097,7 @@

Returns
boolean success
+
Returns
array success
@@ -5151,7 +5156,7 @@

Returns
boolean success
+
Returns
array success
@@ -5198,7 +5203,7 @@

Author
toxiicdev (.net)
+

Author
toxiicdev
Parameters
@@ -5253,7 +5258,7 @@

Returns
boolean success
+
Returns
array success
@@ -5316,7 +5321,7 @@

See also
http://forum.teamspeak.com/showthread.php/84280-Sendtextmessage-by-query-client http://forum.teamspeak.com/showthread.php/84280-Sendtextmessage-by-query-client
-
Returns
boolean success
+
Returns
array success
@@ -5383,7 +5388,7 @@

Returns
boolean success
+
Returns
array success
@@ -5415,7 +5420,7 @@

Returns
boolean success
+
Returns
array success
@@ -5498,7 +5503,7 @@

Returns
boolean success
+
Returns
array success
@@ -5542,7 +5547,7 @@

Returns
boolean success
+
Returns
array success
@@ -5586,7 +5591,7 @@

Returns
boolean success
+
Returns
array success
@@ -5630,7 +5635,7 @@

Returns
boolean success
+
Returns
array success
@@ -5677,7 +5682,7 @@

Returns
multidimensional-array serverGroupClientList
+
Returns
array serverGroupClientList
@@ -5774,7 +5779,7 @@

Returns
boolean success
+
Returns
array success
@@ -5813,7 +5818,7 @@

Returns
boolean success
+
Returns
array success
@@ -5857,7 +5862,7 @@

Returns
boolean success
+
Returns
array success
@@ -5892,8 +5897,8 @@

-

◆ serverGroupList()

+ +

◆ serverGroupList()

@@ -5901,7 +5906,8 @@

serverGroupList

- + +
string$typetextserver|textchannel|textprivate
() $type = null)
@@ -5916,8 +5922,19 @@

Author
Stefan Zehnpfennig

+
Parameters
+ + +
integer$typegroupDbType (0 = template, 1 = normal, 2 = query) By default get all groups
+
+
Returns
array serverGroupList
@@ -6005,7 +6022,7 @@

Returns
boolean success
+
Returns
array success
@@ -6258,7 +6275,7 @@

serverNotifyUnregister

Unregisters server notify event

-
Author
toxiicdev (.net)
+
Author
toxiicdev
@@ -6286,7 +6303,7 @@

Returns
boolean success
+
Returns
array success
@@ -6347,7 +6364,7 @@

Author
Stefan Zehnpfennig
-
Returns
string snapshot
+
Returns
array snapshot
@@ -6389,7 +6406,7 @@

Returns
boolean success
+
Returns
array success
@@ -6417,7 +6434,7 @@

Returns
boolean success
+
Returns
array success
@@ -6456,7 +6473,7 @@

Returns
boolean success
+
Returns
array success
@@ -6511,12 +6528,12 @@

string$pwtemporary password string$durationdurations in seconds string$descdescription [optional] - string$tcidcid user enters on connect (0 = Default channel) [optional] + integer$tcidcid user enters on connect (0 = Default channel) [optional] string$tcpwchannelPW -
Returns
boolean success
+
Returns
array success
@@ -6544,7 +6561,7 @@

Returns
boolean success
+
Returns
array success
@@ -6622,7 +6639,7 @@

Returns
boolean success
+
Returns
array success
@@ -6650,7 +6667,7 @@

Returns
boolean success
+
Returns
array success
@@ -6772,7 +6789,7 @@

Returns
boolean success
+
Returns
array success
@@ -6831,7 +6848,7 @@

Returns
boolean success
+
Returns
array success
@@ -6874,7 +6891,7 @@

Parameters
- +
string$filepathPath to your file
string$iconID[optional] Desired IconID (Must be higher than 1.000.000.000, and lower than 2.147.483.647)
string | integer$iconID[optional] Desired IconID (Must be higher than 1.000.000.000, and lower than 2.147.483.647)
diff --git a/docs/manual/dir_10a6f60a3f69272b5db7ea1b7bf5dbe7.html b/docs/manual/dir_10a6f60a3f69272b5db7ea1b7bf5dbe7.html index d5c6b89..12024ec 100644 --- a/docs/manual/dir_10a6f60a3f69272b5db7ea1b7bf5dbe7.html +++ b/docs/manual/dir_10a6f60a3f69272b5db7ea1b7bf5dbe7.html @@ -23,7 +23,7 @@ Logo
ts3admin.class -  1.0.2.4 +  1.0.2.5
The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
diff --git a/docs/manual/dir_2efd5a1bd54080b406def48476f5ebfa.html b/docs/manual/dir_2efd5a1bd54080b406def48476f5ebfa.html index 9ec7d00..94bb107 100644 --- a/docs/manual/dir_2efd5a1bd54080b406def48476f5ebfa.html +++ b/docs/manual/dir_2efd5a1bd54080b406def48476f5ebfa.html @@ -23,7 +23,7 @@ Logo
ts3admin.class -  1.0.2.4 +  1.0.2.5
The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
diff --git a/docs/manual/dir_516e7709f2195dc55b84d083c8c936b3.html b/docs/manual/dir_516e7709f2195dc55b84d083c8c936b3.html index f83464a..86b5eee 100644 --- a/docs/manual/dir_516e7709f2195dc55b84d083c8c936b3.html +++ b/docs/manual/dir_516e7709f2195dc55b84d083c8c936b3.html @@ -23,7 +23,7 @@ Logo
ts3admin.class -  1.0.2.4 +  1.0.2.5
The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
diff --git a/docs/manual/dir_5e8b704f3f6c02a2a30269a1c43b2cb8.html b/docs/manual/dir_5e8b704f3f6c02a2a30269a1c43b2cb8.html index ff9ac5e..b7d68f2 100644 --- a/docs/manual/dir_5e8b704f3f6c02a2a30269a1c43b2cb8.html +++ b/docs/manual/dir_5e8b704f3f6c02a2a30269a1c43b2cb8.html @@ -23,7 +23,7 @@ Logo
ts3admin.class -  1.0.2.4 +  1.0.2.5
The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
diff --git a/docs/manual/files.html b/docs/manual/files.html index 972ca6d..3bb52d2 100644 --- a/docs/manual/files.html +++ b/docs/manual/files.html @@ -23,7 +23,7 @@ Logo
ts3admin.class -  1.0.2.4 +  1.0.2.5
The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
diff --git a/docs/manual/functions.html b/docs/manual/functions.html index 63566d0..9d42c53 100644 --- a/docs/manual/functions.html +++ b/docs/manual/functions.html @@ -23,7 +23,7 @@ Logo
ts3admin.class -  1.0.2.4 +  1.0.2.5
The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
@@ -491,7 +491,7 @@

- s -

    : ts3admin
  • serverGroupList() -: ts3admin +: ts3admin
  • serverGroupPermList() : ts3admin diff --git a/docs/manual/functions_func.html b/docs/manual/functions_func.html index 32d9dc3..bfecf5f 100644 --- a/docs/manual/functions_func.html +++ b/docs/manual/functions_func.html @@ -23,7 +23,7 @@ Logo
    ts3admin.class -  1.0.2.4 +  1.0.2.5
    The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
    @@ -491,7 +491,7 @@

    - s -

      : ts3admin
    • serverGroupList() -: ts3admin +: ts3admin
    • serverGroupPermList() : ts3admin diff --git a/docs/manual/index.html b/docs/manual/index.html index 6b2d7a8..c8df75d 100644 --- a/docs/manual/index.html +++ b/docs/manual/index.html @@ -23,7 +23,7 @@ Logo
      ts3admin.class -  1.0.2.4 +  1.0.2.5
      The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
      diff --git a/docs/manual/search/all_c.js b/docs/manual/search/all_c.js index 45b1d13..308ccda 100644 --- a/docs/manual/search/all_c.js +++ b/docs/manual/search/all_c.js @@ -16,7 +16,7 @@ var searchData= ['servergroupdeleteclient',['serverGroupDeleteClient',['../classts3admin.html#a0d982897e1ebb4ebe12cd5eee6db0a3b',1,'ts3admin']]], ['servergroupdeleteperm',['serverGroupDeletePerm',['../classts3admin.html#ae8e8e1cbbf1281b444b01e54fc586494',1,'ts3admin']]], ['servergroupgeticonbysgid',['serverGroupGetIconBySGID',['../classts3admin.html#a161c011310ca77b6691bdf11e53b1c25',1,'ts3admin']]], - ['servergrouplist',['serverGroupList',['../classts3admin.html#ac89ee94ef837a904529d6d56cf1f7ae8',1,'ts3admin']]], + ['servergrouplist',['serverGroupList',['../classts3admin.html#a7009fd7705a07c74e1f3d0ca1f3701b3',1,'ts3admin']]], ['servergrouppermlist',['serverGroupPermList',['../classts3admin.html#a6720544c69b6b994442733b64067003d',1,'ts3admin']]], ['servergrouprename',['serverGroupRename',['../classts3admin.html#a03622d2fc78eaa4c561a5799e8f4e9e9',1,'ts3admin']]], ['servergroupsbyclientid',['serverGroupsByClientID',['../classts3admin.html#a5fc18de3af7cb86abcf366dffa163a52',1,'ts3admin']]], diff --git a/docs/manual/search/functions_c.js b/docs/manual/search/functions_c.js index 45b1d13..308ccda 100644 --- a/docs/manual/search/functions_c.js +++ b/docs/manual/search/functions_c.js @@ -16,7 +16,7 @@ var searchData= ['servergroupdeleteclient',['serverGroupDeleteClient',['../classts3admin.html#a0d982897e1ebb4ebe12cd5eee6db0a3b',1,'ts3admin']]], ['servergroupdeleteperm',['serverGroupDeletePerm',['../classts3admin.html#ae8e8e1cbbf1281b444b01e54fc586494',1,'ts3admin']]], ['servergroupgeticonbysgid',['serverGroupGetIconBySGID',['../classts3admin.html#a161c011310ca77b6691bdf11e53b1c25',1,'ts3admin']]], - ['servergrouplist',['serverGroupList',['../classts3admin.html#ac89ee94ef837a904529d6d56cf1f7ae8',1,'ts3admin']]], + ['servergrouplist',['serverGroupList',['../classts3admin.html#a7009fd7705a07c74e1f3d0ca1f3701b3',1,'ts3admin']]], ['servergrouppermlist',['serverGroupPermList',['../classts3admin.html#a6720544c69b6b994442733b64067003d',1,'ts3admin']]], ['servergrouprename',['serverGroupRename',['../classts3admin.html#a03622d2fc78eaa4c561a5799e8f4e9e9',1,'ts3admin']]], ['servergroupsbyclientid',['serverGroupsByClientID',['../classts3admin.html#a5fc18de3af7cb86abcf366dffa163a52',1,'ts3admin']]], diff --git a/docs/manual/ts3admin_8class_8php.html b/docs/manual/ts3admin_8class_8php.html index d9f4599..99e23f7 100644 --- a/docs/manual/ts3admin_8class_8php.html +++ b/docs/manual/ts3admin_8class_8php.html @@ -23,7 +23,7 @@ Logo
      ts3admin.class -  1.0.2.4 +  1.0.2.5
      The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!
      @@ -82,7 +82,7 @@

      The ts3admin.class is a powerful api for communication with Teamspeak 3 Servers from your website! Your creativity knows no bounds!

      Author
      Stefan Zehnpfennig
      -
      Version
      1.0.2.4
      +
      Version
      1.0.2.5