search

planetteamspeak / ts3phpframework

Modern use-at-will framework that provides individual components to manage TeamSpeak 3 Server instances
https://www.planetteamspeak.com
GNU General Public License v3.0
211 stars 59 forks source link

URI option/flag clients_before_channels #112

Closed Sebbo94BY closed 6 years ago

Sebbo94BY commented 6 years ago

I don't like the doxygen documentation as I still can't find what I need. Due to this, I've created a wiki page for beginners: https://github.com/planetteamspeak/ts3phpframework/wiki/Factory-options-and-flags-explained

I'll create some more such pages to get started as easy as possible. :)

But... I didn't found out for what the option / flag clients_before_channels is. Could somebody please explain it? Thanks in advance!

ronindesign commented 6 years ago

Awesome, thanks for making a few pages. I think using the wiki is a great idea and I also dislike Doxygen format. I've also made a few wiki pages (downstream as Sven has not confirmed using wiki): https://github.com/ronindesign/ts3phpframework/wiki

Maybe we can create another doc site using something like ReadTheDocs? However, we'll probably want to stick with something that is mostly generated from code (aside from additional examples). We want to be careful not to create another asset requiring additional upkeep.

Re: clients_before_channels - I believe this is sorting / display in the server tree. If you check the code, you can see if the flag clients_before_channels is set, then setLoadClientlistFirst(True) is called.

For this we have in TeamSpeak3_Node_Host::setLoadClientlistFirst():

Sets the option to decide whether clients should be sorted before sub-channels to support the new TeamSpeak 3 Client display mode or not.

$this->setStorage("_client_top", $first);
$this->sort_clients_channels = $first;

You should be able to use the HTML Viewer on a web page to visualize the effect this will have on sorting order when displaying users and sub-channels together.

Sebbo94BY commented 6 years ago

Thank you for the feedback - I've updated the wiki page! :)

I think the wiki page is enough for my purpose. I only want to write down a short, but more helpful get started tutorial. I don't want to explain every single function - I only want to explain, how you need to start in order to work with these functions. :)