diff --git a/install.php b/install.php new file mode 100644 index 0000000..acf6cb6 --- /dev/null +++ b/install.php @@ -0,0 +1,172 @@ + + +
+" . htmlspecialchars($output, ENT_QUOTES) . ""; + } + + if($echo) echo($output); + + return $output; + } +} + +/*! + * \mainpage API Documentation + * + * \section welcome_sec Introduction + * + * \subsection welcome1 What is the TS3 PHP Framework? + * Initially released in January 2010, the TS3 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 TS3 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. + * + * \subsection welcome2 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. + * + * \section sysreqs_sec Requirements + * The TS3 PHP Framework currently supports PHP 5.2.1 or later, but we strongly recommend the most current release of + * PHP for critical security and performance enhancements. If you want to create a web application using the TS3 PHP + * Framework, you need a PHP 5 interpreter with a web server configured to handle PHP scripts correctly. + * + * Note that the majority of TS3 PHP Framework development and deployment is done on nginx, so there is more community + * experience and testing performed on nginx than on other web servers. + * + * \section feature_sec Features + * 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 + * - ... + * + * \section example_sec Usage Examples + * + * \subsection example1 1. Kick a single Client from a Virtual Server + * @code + * // load framework files + * require_once("libraries/TeamSpeak3/TeamSpeak3.php"); + * + * // connect to local server, authenticate and spawn an object for the virtual server on port 9987 + * $ts3_VirtualServer = TeamSpeak3::factory("serverquery://username:password@127.0.0.1:10011/?server_port=9987"); + * + * // kick the client with ID 123 from the server + * $ts3_VirtualServer->clientKick(123, TeamSpeak3::KICK_SERVER, "evil kick XD"); + * + * // spawn an object for the client by unique identifier and do the kick + * $ts3_VirtualServer->clientGetByUid("FPMPSC6MXqXq751dX7BKV0JniSo=")->kick(TeamSpeak3::KICK_SERVER, "evil kick XD"); + * + * // spawn an object for the client by current nickname and do the kick + * $ts3_VirtualServer->clientGetByName("ScP")->kick(TeamSpeak3::KICK_SERVER, "evil kick XD"); + * @endcode + * + * \subsection example2 2. Kick all Clients from a Virtual Server + * @code + * // load framework files + * require_once("libraries/TeamSpeak3/TeamSpeak3.php"); + * + * // connect to local server, authenticate and spawn an object for the virtual server on port 9987 + * $ts3_VirtualServer = TeamSpeak3::factory("serverquery://username:password@127.0.0.1:10011/?server_port=9987"); + * + * // query clientlist from virtual server + * $arr_ClientList = $ts3_VirtualServer->clientList(); + * + * // kick all clients online with a single command + * $ts3_VirtualServer->clientKick($arr_ClientList, TeamSpeak3::KICK_SERVER, "evil kick XD"); + * @endcode + * + * \subsection example3 3. Print the Nicknames of connected Android Clients + * @code + * // load framework files + * require_once("libraries/TeamSpeak3/TeamSpeak3.php"); + * + * // connect to local server, authenticate and spawn an object for the virtual server on port 9987 + * $ts3_VirtualServer = TeamSpeak3::factory("serverquery://username:password@127.0.0.1:10011/?server_port=9987"); + * + * // query clientlist from virtual server and filter by platform + * $arr_ClientList = $ts3_VirtualServer->clientList(array("client_platform" => "Android")); + * + * // walk through list of clients + * foreach($arr_ClientList as $ts3_Client) + * { + * echo $ts3_Client . " is using " . $ts3_Client["client_platform"] . "
| %5 | %8 %9 | %11%12 |