[API] TS3 PHP Framework

[ScP]

Current Version: 1.1.24

• Addons Page
• Changelog
• Documentation
  
• Website
• Donate

DOWNLOAD NOW

What is the TS3 PHP Framework?
Initially released in January 2010, the TeamSpeak 3 PHP Framework is a powerful, open source, object-oriented framework implemented in PHP 5 and licensed under the GNU General Public License. It's based on simplicity and a rigorously tested agile codebase. Extend the functionality of your servers with scripts or create powerful web applications to manage all features of your TeamSpeak 3 Server instances.

Tested. Thoroughly. Enterprise-ready and built with agile methods, the TeamSpeak 3 PHP Framework has been unit-tested from the start to ensure that all code remains stable and easy for you to extend, re-test with your extensions, and further maintain.

Why should I use the TS3 PHP Framework rather than other PHP libraries?
The TS3 PHP Framework is a is a modern use-at-will framework that provides individual components to communicate with the TeamSpeak 3 Server.

There are lots of arguments for the TS3 PHP Framework in comparison with other PHP based libraries. It is the most dynamic and feature-rich piece of software in its class. In addition, it's always up-to-date and 100% compatible to almost any TeamSpeak 3 Server version available.

What are the key features of the TS3 PHP Framework?
Features of the TS3 PHP Framework include:

• Fully object-oriented PHP 5 and E_STRICT compliant components
• Access to all TeamSpeak 3 Server features via ServerQuery
• Integrated full featured and customizable TSViewer interfaces
• Full support for file transfers to up- and /or download custom icons and other stuff
• Powerful error handling capablities using exceptions and customizable error messages
• Query mechanisms for several official services such as the blacklist and auto-update servers
• Dynamic signal slots for event based scripting
• ...

Speed up new development and reduce maintenance costs by using the TS3 PHP Framework!

[MichaelP]

why was it deleted? :-o

[Stefan1200]

why was it deleted? :-o

http://forum.teamspeak.com/showpost....73&postcount=4

[Pimmetje]

I want to generate json with this lib. But i can't find a way to make a difference with channels and subchannels. with the factory i make a connection. than i do a channelList() on the object. Somehow i get all channels (including the subchannels). the subChannelList() wont return any data on all those channels.

Anyone can see what i am doing wrong? I can make some example if it is needed. But the code i have at the moment is a little bit big to change to something what points out the problem i have.

[kasebone]

I like the option of the TS Viewer. But do I need to cache the display? I can imagine that when many users are watching the viewer the ts3 server gehts overloaded when every page impression creates a new serverquery.

[Pimmetje]

Your webserver gets banned if it loads too much. So there are 2 things u can do whitelist the ip of the webserver or use cache for 30-45 seconds

[kasebone]

Ok, thanks :-)

[ScP]

I'll reopen the original thread again soon when the new version is ready. Here's the latest changelog:

===============================================================================
                        TS 3 PHP Framework - Changelog
                          Copyright Planet TeamSpeak
                        http://www.planetteamspeak.com
===============================================================================
   + Added feature or noticable improvement
   - Bug fix or something removed
   * Changed or Information
   ! Important - Take note!
===============================================================================

=== Release 1.0.27-dev - ?? May 2010 ===
 ! upgrading your servers to 3.0.0-beta23 (build >= 11062) is mandatory
 + added TeamSpeak3_Adapter_Update which allows you to query the latest TS3
   version numbers from the master server
 * TeamSpeak3_Viewer_Html interface now displays custom icons

=== Release 1.0.26-beta - 14 Apr 2010 ===
 ! codebase converted to Zend Studio 7.1.2 project
 + added TeamSpeak3_Node_Server::channelSpacerCreate()
 + added TeamSpeak3_Node_Server::channelSpacerGetType() 
 + added constants for different channel spacer types (WIP)
 - fixed unused parameters in TeamSpeak3_Node_Channel::permRemove()
 - fixed unused parameters in TeamSpeak3_Node_Server::channelFileRename()
 * TeamSpeak3_Helper_String::contains() now supports RegExp patterns and is
   case-insensitive
 * lists generated by TeamSpeak3_Node_Server::channelFileList() are now sorted 
   by filenname
 * TeamSpeak3_Viewer_Html interface now calculates server uptime correctly
 * changed examples to include new features
 * internal release only

=== Release 1.0.25-beta - 1 Apr 2010 ===
 ! upgrading your servers to 3.0.0-beta21 (build >= 10608) is mandatory
 + added TeamSpeak3_Exception::registerCustomMessage()
 + added TeamSpeak3_Exception::unregisterCustomMessage()
 + added TeamSpeak3_Helper_Convert::groupType()
 + added TeamSpeak3_Helper_Convert::permissionType()
 + added TeamSpeak3_Helper_Convert::password()
 + added TeamSpeak3_Helper_String::filterAlnum()
 + added TeamSpeak3_Helper_String::filterAlpha()
 + added TeamSpeak3_Helper_String::filterDigits()
 + added constants for different group auto-update types
 - changed invalid variable name in TeamSpeak3_Adapter_ServerQuery::request()
 * TeamSpeak3_Adapter_FileTransfer::download() now supports fpassthru() to
   write the results to the PHP output buffer which can be very useful when 
   transferring large files
 * TeamSpeak3_Helper_Convert::seconds() now supports custom output format
 * internal release only

=== Release 1.0.24-beta - 24 Feb 2010 ===
 ! upgrading your servers to 3.0.0-beta19 (build >= 10368) is mandatory
 + added TeamSpeak3_Node_Abstract::iconIsLocal()
 + added TeamSpeak3_Node_Abstract::iconGetName()
 + added TeamSpeak3_Node_Server::iconDownload()
 + added TeamSpeak3_Node_Server::iconUpload()
 + added TeamSpeak3_Node_Channel::iconDownload()
 + added TeamSpeak3_Node_Client::iconDownload()
 + added TeamSpeak3_Node_Servergroup::iconDownload()
 + added TeamSpeak3_Node_Channelgroup::iconDownload()
 * TeamSpeak3_Transport_TCP methods will now read and write in small steps
   of 4096 bytes
 * TeamSpeak3_Node_Server snapshot methods now support three different export
   formats (SNAPSHOT_STRING, SNAPSHOT_BASE64, SNAPSHOT_HEXDEC)
 * internal release only

=== Release 1.0.23-beta - 28 Jan 2010 ===
 ! upgrading your servers to 3.0.0-beta17 (build >= 10036) is mandatory
 + added TeamSpeak3_Node_Server::customInfo()
 + added TeamSpeak3_Node_Client::customInfo()
 + added priority speaker information to TeamSpeak3_Viewer_Html interface
 * changed fetch mode from toAssocArray() to toArray() in several methods
 * spl_autoload_register() is only called once even if TeamSpeak3::init() is
   called multiple times
 - changed invalid variable name in TeamSpeak3_Node_Server::clientGetByUid()
 - changed invalid description for TeamSpeak3_Node_Client::remServerGroup()
 
=== Release 1.0.22-beta - 18 Jan 2010 ===
 ! library now requires PHP version 5.2.1 or newer
 ! upgrading your servers to 3.0.0-beta13 (build >= 9802) is mandatory
 + added TeamSpeak3_Adapter_Abstract::getProfiler()
 + added TeamSpeak3_Adapter_ServerQuery::getQueryCount()
 + added TeamSpeak3_Adapter_ServerQuery::getQueryRuntime()
 + added TeamSpeak3_Node_Server::customSearch()
 * adapter classes will now start their own timer for profiling
 * added "-times" to default clientList() parameters
 * added optional command parameters "tokendescription" and "tokencustomset" 
   to TeamSpeak3_Node_Server::tokenCreate()
 - fixed error exception in TeamSpeak3_Adapter_ServerQuery destructor
 - removed undefined variable in TeamSpeak3_Node_Server::channelFileRename()

=== Release 1.0.21-beta - 10 Jan 2010 ===
 ! all thrown TeamSpeak 3 Server error exceptions are now of objects of type
   TeamSpeak3_Adapter_ServerQuery_Exception
 ! TeamSpeak3_Node_Abstract::offsetSet() is now a wrapper for the modify() 
   method to allow direct modifications of node properties
 + added TeamSpeak3_Helper_Convert::codec()
 + added TeamSpeak3_Node_Abstract::toArray()
 + added TeamSpeak3_Node_Abstract::toString()
 + added TeamSpeak3_Node_Server::clientCount()
 + added TeamSpeak3_Node_Server::clientListDb()
 + added TeamSpeak3_Node_Server::clientFind()
 + added TeamSpeak3_Node_Server::clientFindDb()
 + added TeamSpeak3_Node_Host::setPredefinedQueryName()
 + added TeamSpeak3_Node_Host::setExcludeQueryClients()
 + added optional "timeout" parameter to TeamSpeak3::factory()
 + added optional "nickname" parameter to TeamSpeak3::factory()
 * error exception messages thrown by TeamSpeak3_Transport_TCP::connect()
   will be UTF-8 encoded
 * set some fancy titles in TeamSpeak3_Viewer_Html interface
 * tweaked some of the implemented RecursiveIterator methods
 * using strtr() instead of str_replace() in TeamSpeak3_Helper_String::arg()
 * isset($node) no longer queries node information automatically
 - fixed error exception when trying to start profiler timer twice
 - fixed invalid node list format after reset
 
=== Release 1.0.20-beta - 08 Jan 2010 ===
 ! factory URI now supports #no_query_clients fragment to remove ServerQuery
   clients from client lists and viewers
 + added TeamSpeak3_Helper_Profiler
 + added TeamSpeak3_Helper_Convert (WIP)
 - fixed unnessesary command requests on empty list caches
 - fixed recursion bug on empty virtual servers

=== Release 1.0.19-beta - 07 Jan 2010 ===
 + added TeamSpeak3_Adapter_Abstract::getTransportHost()
 + added TeamSpeak3_Adapter_Abstract::getTransportPort()
 + added TeamSpeak3_Node_Host::getAdapterHost()
 + added TeamSpeak3_Node_Host::getAdapterPort()
 + added TeamSpeak3_Node_Server::snapshotCreate()
 + added TeamSpeak3_Node_Server::snapshotDeploy()
 + added TeamSpeak3_Node_Server::selfPermOverview()
 * given parameter strings will be UTF-8 encoded while commands are prepared
 * TeamSpeak3_Node_Host::__toString() now returns hostname or IPv4 address
   instead of "TeamSpeak 3 Host"
 * public beta release

=== Release 1.0.18-beta - 06 Jan 2010 ===
 ! added code examples
 ! added online docs (http://docs.planetteamspeak.com/ts3/php/framework/)
 + added TeamSpeak3_Node_Client::avatarGetName()
 + added TeamSpeak3_Node_Client::avatarDownload()
 + added TeamSpeak3_Node_Client::permOverview()
 * TeamSpeak3_Viewer_Html constructor now supports custom image paths
 * whoami cache will be updated when creating temporary channels
 * whoami cache will be updated when moving own client
 - fixed "already member of channel" issue when sending two text messages to
   the same channel
 - ServerQuery adapter no longer tries to quit in desctructor when transport 
   is not connected
 - replaced invalid data types in method descriptions

=== Release 1.0.17-beta - 05 Jan 2010 ===
 * internal beta release

Stay tuned!

[ginger|HFD]

State of Art as always. If you guys want high quality, then you will love the way how ScP does it.

Dont forget to donate once its released guys! Cant imagine how many hours are inside of that framework.

[Nightwing]

Great work, Sven!
Is a release of a sample-viewer also planned?

ToM

[ScP]

Great work, Sven!
Is a release of a sample-viewer also planned?

ToM

A TSViewer script is included in the examples I'll deliver with the new release.

[Nightwing]

Great news, thanks Sven!

ToM

[Pimmetje]

I there a way to generate a array or something from the channels and clients (i would like to have JSON) This way i can load the viewer with ajax. At the moment i have one running but it does not see a differents for channel and subchannel
if i do $ts3_vs->channelList() i get all channels AND subchannels but i can't figure out how to see the difference between channel and subchannel. Am i missing something?

[ScP]

At the moment i have one running but it does not see a differents for channel and subchannel
if i do $ts3_vs->channelList() i get all channels AND subchannels but i can't figure out how to see the difference between channel and subchannel. Am i missing something?

Each channel has a property called pid (ID of the parent channel). If the pid is 0, you're dealing with a top-level channel.

I've uploaded an internal test release of the framework (1.0.27-beta). The documentation is not updated yet, but I've fixed several bugs and added a few new features. The final version with updated docs will follow soon.

Note that I've temporary disabled the support for custom icons in the TeamSpeak3_Viewer_Html interface in this release. Current public versions of the TeamSpeak 3 Server do not provide a -icon parameter for channel and clientlists yet so custom icon support would mean one extra command per channel and client which is not very efficient on a large server.

***REMOVED OUTDATED URL***

ScP needs YOU!!!^^

The reason for this pre-release is that I need your feedback on one specific feature. I've added a method called serverGroupIdentify() which can be called on any TeamSpeak3_Node_Server object. This method tries to identify the most powerful server group on a virtual server by a set of rules I defined. An example is included in the package. On my test servers the script always returned the correct group, but I can imagine that there are some complex configurations out there which could cause weird results.

Please try to setup this example script on your servers and tell me if the result was correct. Thank you!

[Pimmetje]

Whats the use of the methode getSubchannels? when channelList() returns all it channels at ones? I understand that is because of the way TS3 returns all channels at once. But i think it would be nice when the framework would solve the problem of finding the correct channels (subchannels).

Or am i still missing a point?