TeamSpeak 3 PHP Framework: TeamSpeak3_Node

Returns: TeamSpeak3_Node_Server

Definition at line 283 of file Host.php.

References TeamSpeak3_Node_Abstract\$server, and serverList().

   {
     foreach($this->serverList() as $server)
     {
       if($server["virtualserver_name"] == $name) return $server;
     }
 
     throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid serverID", 0x400);
   }

TeamSpeak3_Node_Host::serverGetByUid ( $uid)

Returns the first TeamSpeak3_Node_Server object matching the given unique identifier.

Parameters

string $uid

Exceptions

Returns: TeamSpeak3_Node_Server

Definition at line 300 of file Host.php.

References TeamSpeak3_Node_Abstract\$server, and serverList().

   {
     foreach($this->serverList() as $server)
     {
       if($server["virtualserver_unique_identifier"] == $uid) return $server;
     }
 
     throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid serverID", 0x400);
   }

TeamSpeak3_Node_Host::serverGetByTSDNS ( $tsdns)

Returns the first TeamSpeak3_Node_Server object matching the given TSDNS hostname.

Like the TeamSpeak 3 Client, this method will start looking for a TSDNS server on the second-level domain including a fallback to the third-level domain of the specified $tsdns parameter.

Parameters

string $tsdns

Exceptions

Returns: TeamSpeak3_Node_Server

Definition at line 319 of file Host.php.

References TeamSpeak3_Helper_String\factory(), TeamSpeak3\factory(), TeamSpeak3_Helper_Uri\getFQDNParts(), and serverGetByPort().

   {
     $parts = TeamSpeak3_Helper_Uri::getFQDNParts($tsdns);
     $query = TeamSpeak3_Helper_String::factory(array_shift($parts));
 
     while($part = array_shift($parts))
     {
       $query->prepend($part);
 
       try
       {
         $port = TeamSpeak3::factory("tsdns://" . $query . "/?timeout=3")->resolve($tsdns)->section(":", 1);
 
         return $this->serverGetByPort($port == "" ? 9987 : $port);
       }
       catch(TeamSpeak3_Transport_Exception $e)
       {
         /* skip "Connection timed out" and "Connection refused" */
         if($e->getCode() != 10060 && $e->getCode() != 10061) throw $e;
       }
     }
 
     throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid serverID", 0x400);
   }

TeamSpeak3_Node_Host::serverCreate ( array $properties = array())

Creates a new virtual server using given properties and returns an assoc array containing the new ID and initial admin token.

Parameters

array $properties

Returns: array

Definition at line 351 of file Host.php.

References TeamSpeak3_Node_Abstract\$server, TeamSpeak3_Node_Abstract\execute(), TeamSpeak3_Helper_Signal\getInstance(), and serverListReset().

   {
     $this->serverListReset();
 
     $detail = $this->execute("servercreate", $properties)->toList();
     $server = new TeamSpeak3_Node_Server($this, array("virtualserver_id" => intval($detail["sid"])));
 
     TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServercreated", $this, $detail["sid"]);
     TeamSpeak3_Helper_Signal::getInstance()->emit("notifyTokencreated", $server, $detail["token"]);
 
     return $detail;
   }

TeamSpeak3_Node_Host::serverDelete ( $sid)

Deletes the virtual server specified by ID.

Parameters

integer $sid

Returns: void

Definition at line 370 of file Host.php.

References TeamSpeak3_Node_Abstract\execute(), TeamSpeak3_Helper_Signal\getInstance(), and serverListReset().

   {
     $this->serverListReset();
 
     $this->execute("serverdelete", array("sid" => $sid));
 
     TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerdeleted", $this, $sid);
   }

TeamSpeak3_Node_Host::serverStart ( $sid)

Starts the virtual server specified by ID.

Parameters

integer $sid

Returns: void

Definition at line 385 of file Host.php.

References TeamSpeak3_Node_Abstract\execute(), TeamSpeak3_Helper_Signal\getInstance(), serverDeselect(), serverListReset(), and serverSelectedId().

   {
     if($sid == $this->serverSelectedId())
     {
       $this->serverDeselect();
     }
 
     $this->execute("serverstart", array("sid" => $sid));
     $this->serverListReset();
 
     TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerstarted", $this, $sid);
   }

TeamSpeak3_Node_Host::serverStop ( $sid)

Stops the virtual server specified by ID.

Parameters

integer $sid

Returns: void

Definition at line 404 of file Host.php.

References TeamSpeak3_Node_Abstract\execute(), TeamSpeak3_Helper_Signal\getInstance(), serverDeselect(), serverListReset(), and serverSelectedId().

   {
     if($sid == $this->serverSelectedId())
     {
       $this->serverDeselect();
     }
 
     $this->execute("serverstop", array("sid" => $sid));
     $this->serverListReset();
 
     TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerstopped", $this, $sid);
   }

TeamSpeak3_Node_Host::serverStopProcess ( )

Stops the entire TeamSpeak 3 Server instance by shutting down the process.

Returns: void

Definition at line 422 of file Host.php.

References TeamSpeak3_Node_Abstract\execute(), and TeamSpeak3_Helper_Signal\getInstance().

   {
     TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServershutdown", $this);
 
     $this->execute("serverprocessstop");
   }

TeamSpeak3_Node_Host::serverList ( array $filter = array())

Returns an array filled with TeamSpeak3_Node_Server objects.

Parameters

array $filter

Returns: array

Definition at line 435 of file Host.php.

References TeamSpeak3_Node_Abstract\$server, TeamSpeak3_Node_Abstract\filterList(), TeamSpeak3_Node_Abstract\request(), and TeamSpeak3_Node_Abstract\resetNodeList().

Referenced by fetchNodeList(), serverGetByName(), serverGetByUid(), serverGetPortById(), and serverListReset().

   {
     if($this->serverList === null)
     {
       $servers = $this->request("serverlist -uid")->toAssocArray("virtualserver_id");
 
       $this->serverList = array();
 
       foreach($servers as $sid => $server)
       {
         $this->serverList[$sid] = new TeamSpeak3_Node_Server($this, $server);
       }
 
       $this->resetNodeList();
     }
 
     return $this->filterList($this->serverList, $filter);
   }

TeamSpeak3_Node_Host::serverListReset ( )

Resets the list of virtual servers.

Returns: void

Definition at line 459 of file Host.php.

References TeamSpeak3_Node_Abstract\resetNodeList(), and serverList().

Referenced by serverCreate(), serverDelete(), serverStart(), and serverStop().

   {
     $this->resetNodeList();
     $this->serverList = null;
   }

TeamSpeak3_Node_Host::bindingList ( )

Returns a list of IP addresses used by the server instance on multi-homed machines.

Returns: array

Definition at line 470 of file Host.php.

References TeamSpeak3_Node_Abstract\request().

   {
     return $this->request("bindinglist")->toArray();
   }

TeamSpeak3_Node_Host::permissionList ( )

Returns a list of permissions available on the server instance.

Returns: array

Definition at line 480 of file Host.php.

References $permissionList, TeamSpeak3_Helper_String\factory(), fetchPermissionList(), permissionGetCategoryById(), and permissionGetGrantById().

Referenced by fetchPermissionList(), permissionGetIdByName(), permissionGetNameById(), and permissionTree().

   {
     if($this->permissionList === null)
     {
       $this->fetchPermissionList();
     }
 
     foreach($this->permissionList as $permname => $permdata)
     {
       if(isset($permdata["permcatid"]) && $permdata["permgrant"])
       {
         continue;
       }
 
       $this->permissionList[$permname]["permcatid"] = $this->permissionGetCategoryById($permdata["permid"]);
       $this->permissionList[$permname]["permgrant"] = $this->permissionGetGrantById($permdata["permid"]);
 
       $grantsid = "i_needed_modify_power_" . substr($permname, 2);
 
       if(!$permdata["permname"]->startsWith("i_needed_modify_power_") && !isset($this->permissionList[$grantsid]))
       {
         $this->permissionList[$grantsid]["permid"]    = $this->permissionList[$permname]["permgrant"];
         $this->permissionList[$grantsid]["permname"]  = TeamSpeak3_Helper_String::factory($grantsid);
         $this->permissionList[$grantsid]["permdesc"]  = null;
         $this->permissionList[$grantsid]["permcatid"] = 0xFF;
         $this->permissionList[$grantsid]["permgrant"] = $this->permissionList[$permname]["permgrant"];
       }
     }
 
     return $this->permissionList;
   }

TeamSpeak3_Node_Host::permissionCats ( )

Returns a list of permission categories available on the server instance.

Returns: array

Definition at line 517 of file Host.php.

References $permissionCats, and fetchPermissionCats().

Referenced by fetchPermissionCats(), permissionGetCategoryById(), and permissionTree().

   {
     if($this->permissionCats === null)
     {
       $this->fetchPermissionCats();
     }
 
     return $this->permissionCats;
   }

TeamSpeak3_Node_Host::permissionEnds ( )

Returns a list of permission category endings available on the server instance.

Returns: array

Definition at line 532 of file Host.php.

References $permissionCats, and fetchPermissionList().

Referenced by fetchPermissionList(), and permissionGetCategoryById().

   {
     if($this->permissionEnds === null)
     {
       $this->fetchPermissionList();
     }
 
     return $this->permissionCats;
   }

TeamSpeak3_Node_Host::permissionTree ( )

Returns an array filled with all permission categories known to the server including their ID, name and parent.

Returns: array

Definition at line 548 of file Host.php.

References TeamSpeak3_Helper_String\factory(), TeamSpeak3_Helper_Convert\permissionCategory(), permissionCats(), and permissionList().

   {
     $permtree = array();
 
     foreach($this->permissionCats() as $key => $val)
     {
       $permtree[$val]["permcatid"]      = $val;
       $permtree[$val]["permcathex"]     = "0x" . dechex($val);
       $permtree[$val]["permcatname"]    = TeamSpeak3_Helper_String::factory(TeamSpeak3_Helper_Convert::permissionCategory($val));
       $permtree[$val]["permcatparent"]  = $permtree[$val]["permcathex"]{3} == 0 ? 0 : hexdec($permtree[$val]["permcathex"]{2} . 0);
       $permtree[$val]["permcatchilren"] = 0;
       $permtree[$val]["permcatcount"]   = 0;
 
       if(isset($permtree[$permtree[$val]["permcatparent"]]))
       {
         $permtree[$permtree[$val]["permcatparent"]]["permcatchilren"]++;
       }
 
       if($permtree[$val]["permcatname"]->contains("/"))
       {
         $permtree[$val]["permcatname"] = $permtree[$val]["permcatname"]->section("/", 1)->trim();
       }
 
       foreach($this->permissionList() as $permission)
       {
         if($permission["permid"]["permcatid"] == $val)
         {
           $permtree[$val]["permcatcount"]++;
         }
       }
     }
 
     return $permtree;
   }

TeamSpeak3_Node_Host::permissionFind ( $permid)

Returns the IDs of all clients, channels or groups using the permission with the specified ID.

Parameters

integer $permid

Returns: array

Definition at line 590 of file Host.php.

References TeamSpeak3_Node_Abstract\current(), and TeamSpeak3_Node_Abstract\execute().

   {
     if(!is_array($permid))
     {
       $permident = (is_numeric($permid)) ? "permid" : "permsid";
     }
     else
     {
       $permident = (is_numeric(current($permid))) ? "permid" : "permsid";
     }
 
     return $this->execute("permfind", array($permident => $permid))->toArray();
   }

TeamSpeak3_Node_Host::permissionGetIdByName ( $name)

Returns the ID of the permission matching the given name.

Parameters

string $name

Exceptions

Returns: integer

Definition at line 611 of file Host.php.

References permissionList().

Referenced by permissionGetCategoryById(), and permissionGetGrantById().

   {
     if(!array_key_exists((string) $name, $this->permissionList()))
     {
       throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid permission ID", 0xA02);
     }
 
     return $this->permissionList[(string) $name]["permid"];
   }

TeamSpeak3_Node_Host::permissionGetNameById ( $permid)

Returns the name of the permission matching the given ID.

Parameters

integer $permid

Exceptions

Returns: TeamSpeak3_Helper_String

Definition at line 628 of file Host.php.

References permissionList().

   {
     foreach($this->permissionList() as $name => $perm)
     {
       if($perm["permid"] == $permid) return new TeamSpeak3_Helper_String($name);
     }
 
     throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid permission ID", 0xA02);
   }

TeamSpeak3_Node_Host::permissionGetCategoryById ( $permid)

Returns the internal category of the permission matching the given ID.

All pre-3.0.7 permission IDs are are 2 bytes wide. The first byte identifies the category while the second byte is the permission count within that group.

Parameters

integer $permid

Returns: integer

Definition at line 647 of file Host.php.

References fetchPermissionCats(), fetchPermissionList(), permissionCats(), permissionEnds(), and permissionGetIdByName().

Referenced by permissionList().

   {
     if(!is_numeric($permid))
     {
       $permid = $this->permissionGetIdByName($permid);
     }
 
     if($permid < 0x1000)
     {
       if($this->permissionEnds === null)
       {
         $this->fetchPermissionList();
       }
 
       if($this->permissionCats === null)
       {
         $this->fetchPermissionCats();
       }
 
       $catids = array_values($this->permissionCats());
 
       foreach($this->permissionEnds as $key => $val)
       {
         if($val >= $permid && isset($catids[$key]))
         {
           return $catids[$key];
         }
       }
 
       return 0;
     }
     else
     {
       return (int) $permid >> 8;
     }
   }

TeamSpeak3_Node_Host::permissionGetGrantById ( $permid)

Returns the internal ID of the i_needed_modify_power_* or grant permission.

Every permission has an associated i_needed_modify_power_* permission, for example b_client_ban_create has an associated permission called i_needed_modify_power_client_ban_create.

Parameters

integer $permid

Returns: integer

Definition at line 693 of file Host.php.

References permissionGetIdByName().

Referenced by permissionList().

   {
     if(!is_numeric($permid))
     {
       $permid = $this->permissionGetIdByName($permid);
     }
 
     if($permid < 0x1000)
     {
       return (int) $permid+0x8000;
     }
     else
     {
       return (int) bindec(substr(decbin($permid), -8))+0xFF00;
     }
   }

TeamSpeak3_Node_Host::serverGroupPermAutoAssign	(	$sgtype,
		$permid,
		$permvalue,
		$permnegated = `FALSE`,
		$permskip = `FALSE`
	)

Adds a set of specified permissions to all regular server groups on all virtual servers.

The target groups will be identified by the value of their i_group_auto_update_type permission specified with $sgtype.

Parameters

integer	$sgtype
integer	$permid
integer	$permvalue
integer	$permnegated
integer	$permskip

Returns: void

Definition at line 721 of file Host.php.

References TeamSpeak3_Node_Abstract\current(), and TeamSpeak3_Node_Abstract\execute().

   {
     if(!is_array($permid))
     {
       $permident = (is_numeric($permid)) ? "permid" : "permsid";
     }
     else
     {
       $permident = (is_numeric(current($permid))) ? "permid" : "permsid";
     }
 
     $this->execute("servergroupautoaddperm", array("sgtype" => $sgtype, $permident => $permid, "permvalue" => $permvalue, "permnegated" => $permnegated, "permskip" => $permskip));
   }

TeamSpeak3_Node_Host::serverGroupPermAutoRemove	(	$sgtype,
		$permid
	)

Removes a set of specified permissions from all regular server groups on all virtual servers.

The target groups will be identified by the value of their i_group_auto_update_type permission specified with $sgtype.

Parameters

integer	$sgtype
integer	$permid

Returns: void

Definition at line 743 of file Host.php.

References TeamSpeak3_Node_Abstract\current(), and TeamSpeak3_Node_Abstract\execute().

   {
     if(!is_array($permid))
     {
       $permident = (is_numeric($permid)) ? "permid" : "permsid";
     }
     else
     {
       $permident = (is_numeric(current($permid))) ? "permid" : "permsid";
     }
 
     $this->execute("servergroupautodelperm", array("sgtype" => $sgtype, $permident => $permid));
   }

TeamSpeak3_Node_Host::selfPermCheck ( $permid)

Returns an array containing the value of a specified permission for your own client.

Parameters

integer $permid

Returns: array

Definition at line 763 of file Host.php.

References TeamSpeak3_Node_Abstract\current(), and TeamSpeak3_Node_Abstract\execute().

   {
     if(!is_array($permid))
     {
       $permident = (is_numeric($permid)) ? "permid" : "permsid";
     }
     else
     {
       $permident = (is_numeric(current($permid))) ? "permid" : "permsid";
     }
 
     return $this->execute("permget", array($permident => $permid))->toAssocArray("permsid");
   }

TeamSpeak3_Node_Host::modify ( array $properties)

Changes the server instance configuration using given properties.

Parameters

array $properties

Returns: void

Definition at line 783 of file Host.php.

References TeamSpeak3_Node_Abstract\execute(), and TeamSpeak3_Node_Abstract\resetNodeInfo().

   {
     $this->execute("instanceedit", $properties);
     $this->resetNodeInfo();
   }

TeamSpeak3_Node_Host::message ( $msg)

Sends a text message to all clients on all virtual servers in the TeamSpeak 3 Server instance.

Parameters

string $msg

Returns: void

Definition at line 795 of file Host.php.

References TeamSpeak3_Node_Abstract\execute().

   {
     $this->execute("gm", array("msg" => $msg));
   }

TeamSpeak3_Node_Host::logView	(	$lines = `30`,
		$begin_pos = `null`,
		$reverse = `null`,
		$instance = `TRUE`
	)

Displays a specified number of entries (1-100) from the servers log.

Parameters

integer	$lines
integer	$begin_pos
boolean	$reverse
boolean	$instance

Returns: array

Definition at line 809 of file Host.php.

References TeamSpeak3_Node_Abstract\execute().

   {
     return $this->execute("logview", array("lines" => $lines, "begin_pos" => $begin_pos, "instance" => $instance, "reverse" => $reverse))->toArray();
   }

TeamSpeak3_Node_Host::logAdd	(	$logmsg,
		$loglevel = `TeamSpeak3::LOGLEVEL_INFO`
	)

Writes a custom entry into the server instance log.

Parameters

string	$logmsg
integer	$loglevel

Returns: void

Definition at line 821 of file Host.php.

References TeamSpeak3_Node_Abstract\execute(), serverDeselect(), serverSelect(), and serverSelectedId().

   {
     $sid = $this->serverSelectedId();
 
     $this->serverDeselect();
     $this->execute("logadd", array("logmsg" => $logmsg, "loglevel" => $loglevel));
     $this->serverSelect($sid);
   }

TeamSpeak3_Node_Host::login	(	$username,
		$password
	)

Authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials.

Parameters

string	$username
string	$password

Returns: void

Definition at line 837 of file Host.php.

References TeamSpeak3_Node_Abstract\execute(), TeamSpeak3_Helper_Signal\getInstance(), TeamSpeak3_Node_Abstract\setStorage(), and whoamiReset().

Referenced by __wakeup().

   {
     $this->execute("login", array("client_login_name" => $username, "client_login_password" => $password));
     $this->whoamiReset();
 
     $crypt = new TeamSpeak3_Helper_Crypt($username);
 
     $this->setStorage("_login_user", $username);
     $this->setStorage("_login_pass", $crypt->encrypt($password));
 
     TeamSpeak3_Helper_Signal::getInstance()->emit("notifyLogin", $this);
   }

TeamSpeak3_Node_Host::logout ( )

Deselects the active virtual server and logs out from the server instance.

Returns: void

Definition at line 855 of file Host.php.

References TeamSpeak3_Node_Abstract\delStorage(), TeamSpeak3_Helper_Signal\getInstance(), TeamSpeak3_Node_Abstract\request(), and whoamiReset().

   {
     $this->request("logout");
     $this->whoamiReset();
 
     $this->delStorage("_login_user");
     $this->delStorage("_login_pass");
 
     TeamSpeak3_Helper_Signal::getInstance()->emit("notifyLogout", $this);
   }

TeamSpeak3_Node_Host::whoami ( )

Returns information about your current ServerQuery connection.

Returns: array

Definition at line 871 of file Host.php.

References $whoami, and TeamSpeak3_Node_Abstract\request().

Referenced by serverSelect(), serverSelectByPort(), whoamiGet(), whoamiReset(), and whoamiSet().

   {
     if($this->whoami === null)
     {
       $this->whoami = $this->request("whoami")->toList();
     }
 
     return $this->whoami;
   }

TeamSpeak3_Node_Host::whoamiGet	(	$ident,
		$default = `null`
	)

Returns a single value from the current ServerQuery connection info.

Parameters

string	$ident
mixed	$default

Returns: mixed

Definition at line 888 of file Host.php.

References whoami().

Referenced by serverSelectedId(), and serverSelectedPort().

   {
     if(array_key_exists($ident, $this->whoami()))
     {
       return $this->whoami[$ident];
     }
 
     return $default;
   }

TeamSpeak3_Node_Host::whoamiSet	(	$ident,
		$value = `null`
	)

Sets a single value in the current ServerQuery connection info.

Parameters

string	$ident
mixed	$value

Returns: mixed

Definition at line 905 of file Host.php.

References TeamSpeak3_Helper_String\factory(), and whoami().

   {
     $this->whoami();
 
     $this->whoami[$ident] = (is_numeric($value)) ? intval($value) : TeamSpeak3_Helper_String::factory($value);
   }

TeamSpeak3_Node_Host::whoamiReset ( )

Resets the current ServerQuery connection info.

Returns: void

Definition at line 917 of file Host.php.

References whoami().

Referenced by login(), logout(), serverSelect(), and serverSelectByPort().

   {
     $this->whoami = null;
   }

TeamSpeak3_Node_Host::getAdapterHost ( )

Returns the hostname or IPv4 address the adapter is connected to.

Returns: string

Definition at line 927 of file Host.php.

Referenced by __toString().

   {
     return $this->getParent()->getTransportHost();
   }

TeamSpeak3_Node_Host::getAdapterPort ( )

Returns the network port the adapter is connected to.

Returns: string

Definition at line 937 of file Host.php.

   {
     return $this->getParent()->getTransportPort();
   }

TeamSpeak3_Node_Host::fetchNodeList ( )

protected

Definition at line 945 of file Host.php.

References TeamSpeak3_Node_Abstract\$server, and serverList().

   {
     $servers = $this->serverList();
 
     foreach($servers as $server)
     {
       $this->nodeList[] = $server;
     }
   }

TeamSpeak3_Node_Host::fetchNodeInfo ( )

protected

Definition at line 958 of file Host.php.

References TeamSpeak3_Node_Abstract\request().

   {
     $info1 = $this->request("hostinfo")->toList();
     $info2 = $this->request("instanceinfo")->toList();
 
     $this->nodeInfo = array_merge($this->nodeInfo, $info1, $info2);
   }

TeamSpeak3_Node_Host::fetchPermissionList ( )

protected

Definition at line 969 of file Host.php.

References permissionEnds(), permissionList(), and TeamSpeak3_Node_Abstract\request().

Referenced by permissionEnds(), permissionGetCategoryById(), and permissionList().

   {
     $reply = $this->request("permissionlist -new")->toArray();
     $start = 1;
 
     $this->permissionEnds = array();
     $this->permissionList = array();
 
     foreach($reply as $line)
     {
       if(array_key_exists("group_id_end", $line))
       {
         $this->permissionEnds[] = $line["group_id_end"];
       }
       else
       {
         $this->permissionList[$line["permname"]->toString()] = array_merge(array("permid" => $start++), $line);
       }
     }
   }

TeamSpeak3_Node_Host::fetchPermissionCats ( )

protected

Definition at line 993 of file Host.php.

References TeamSpeak3_Helper_String\factory(), and permissionCats().

Referenced by permissionCats(), and permissionGetCategoryById().

   {
     $permcats = array();
     $reflects = new ReflectionClass("TeamSpeak3");
 
     foreach($reflects->getConstants() as $key => $val)
     {
       if(!TeamSpeak3_Helper_String::factory($key)->startsWith("PERM_CAT") || $val == 0xFF)
       {
         continue;
       }
 
       $permcats[$key] = $val;
     }
 
     $this->permissionCats = $permcats;
   }

TeamSpeak3_Node_Host::setPredefinedQueryName ( $name = null)

Sets a pre-defined nickname for ServerQuery clients which will be used automatically after selecting a virtual server.

Parameters

string $name

Returns: void

Definition at line 1018 of file Host.php.

   {
     $this->setStorage("_query_nick", $name);
 
     $this->predefined_query_name = $name;
   }

TeamSpeak3_Node_Host::getPredefinedQueryName ( )

Returns the pre-defined nickname for ServerQuery clients which will be used automatically after selecting a virtual server.

Returns: string

Definition at line 1031 of file Host.php.

References $predefined_query_name.

   {
     return $this->predefined_query_name;
   }

TeamSpeak3_Node_Host::setExcludeQueryClients ( $exclude = FALSE)

Sets the option to decide whether ServerQuery clients should be excluded from node lists or not.

Parameters

boolean $exclude

Returns: void

Definition at line 1043 of file Host.php.

   {
     $this->setStorage("_query_hide", $exclude);
 
     $this->exclude_query_clients = $exclude;
   }

TeamSpeak3_Node_Host::getExcludeQueryClients ( )

Returns the option to decide whether ServerQuery clients should be excluded from node lists or not.

Returns: boolean

Definition at line 1056 of file Host.php.

References $exclude_query_clients.

   {
     return $this->exclude_query_clients;
   }

TeamSpeak3_Node_Host::setUseOfflineAsVirtual ( $virtual = FALSE)

Sets the option to decide whether offline servers will be started in virtual mode by default or not.

Parameters

boolean $virtual

Returns: void

Definition at line 1068 of file Host.php.

   {
     $this->setStorage("_do_virtual", $virtual);
 
     $this->start_offline_virtual = $virtual;
   }

TeamSpeak3_Node_Host::getUseOfflineAsVirtual ( )

Returns the option to decide whether offline servers will be started in virtual mode by default or not.

Returns: boolean

Definition at line 1081 of file Host.php.

References $start_offline_virtual.

   {
     return $this->start_offline_virtual;
   }

TeamSpeak3_Node_Host::setLoadClientlistFirst ( $first = FALSE)

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

Parameters

boolean $first

Returns: void

Definition at line 1093 of file Host.php.

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

TeamSpeak3_Node_Host::getLoadClientlistFirst ( )

Returns the option to decide whether offline servers will be started in virtual mode by default or not.

Returns: boolean

Definition at line 1106 of file Host.php.

References $sort_clients_channels.

   {
     return $this->sort_clients_channels;
   }

TeamSpeak3_Node_Host::getAdapter ( )

Returns the underlying TeamSpeak3_Adapter_ServerQuery object.

Returns: TeamSpeak3_Adapter_ServerQuery

Definition at line 1116 of file Host.php.

   {
     return $this->getParent();
   }

TeamSpeak3_Node_Host::getUniqueId ( )

Returns a unique identifier for the node which can be used as a HTML property.

Returns: string

Definition at line 1126 of file Host.php.

   {
     return "ts3_h";
   }

TeamSpeak3_Node_Host::getIcon ( )

Returns the name of a possible icon to display the node object.

Returns: string

Definition at line 1136 of file Host.php.

   {
     return "host";
   }

TeamSpeak3_Node_Host::getSymbol ( )

Returns a symbol representing the node.

Returns: string

Definition at line 1146 of file Host.php.

   {
     return "+";
   }

TeamSpeak3_Node_Host::__wakeup ( )

Re-authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials and re-selects a previously selected virtual server.

Returns: void

Definition at line 1157 of file Host.php.

References TeamSpeak3_Node_Abstract\$server, TeamSpeak3_Node_Abstract\getStorage(), and login().

   {
     $username = $this->getStorage("_login_user");
     $password = $this->getStorage("_login_pass");
 
     if($username && $password)
     {
       $crypt = new TeamSpeak3_Helper_Crypt($username);
 
       $this->login($username, $crypt->decrypt($password));
     }
 
     $this->predefined_query_name = $this->getStorage("_query_nick");
     $this->exclude_query_clients = $this->getStorage("_query_hide", FALSE);
     $this->start_offline_virtual = $this->getStorage("_do_virtual", FALSE);
     $this->sort_clients_channels = $this->getStorage("_client_top", FALSE);
 
     if($server = $this->getStorage("_server_use"))
     {
       $func = array_shift($server);
       $args = array_shift($server);
 
       call_user_func_array(array($this, $func), $args);
     }
   }

TeamSpeak3_Node_Host::__toString ( )

Returns a string representation of this node.

Returns: string

Definition at line 1188 of file Host.php.

References getAdapterHost().

   {
     return (string) $this->getAdapterHost();
   }

TeamSpeak3_Node_Abstract::request	(	$cmd,
		$throw = `TRUE`
	)

inherited

Sends a prepared command to the server and returns the result.

Parameters

string	$cmd
boolean	$throw

Returns: TeamSpeak3_Adapter_ServerQuery_Reply

Definition at line 71 of file Abstract.php.

Referenced by bindingList(), TeamSpeak3_Node_Abstract\execute(), fetchNodeInfo(), fetchPermissionList(), logout(), serverList(), version(), and whoami().

   {
     return $this->getParent()->request($cmd, $throw);
   }

TeamSpeak3_Node_Abstract::prepare	(		$cmd,
		array	$params = `array()`
	)

inherited

Uses given parameters and returns a prepared ServerQuery command.

Parameters

string	$cmd
array	$params

Returns: TeamSpeak3_Helper_String

Definition at line 83 of file Abstract.php.

TeamSpeak3_Node_Exception

Referenced by TeamSpeak3_Node_Abstract\execute().

   {
     return $this->getParent()->prepare($cmd, $params);
   }

TeamSpeak3_Node_Abstract::execute	(		$cmd,
		array	$params = `array()`
	)

inherited

Prepares and executes a ServerQuery command and returns the result.

Parameters

string	$cmd
array	$params

Returns: TeamSpeak3_Adapter_ServerQuery_Reply

Definition at line 95 of file Abstract.php.

References TeamSpeak3_Node_Abstract\prepare(), and TeamSpeak3_Node_Abstract\request().

   {
     return $this->request($this->prepare($cmd, $params));
   }

TeamSpeak3_Node_Abstract::getParent ( )

inherited

Returns the parent object of the current node.

Returns: TeamSpeak3_Adapter_ServerQuery; TeamSpeak3_Node_Abstract

Definition at line 106 of file Abstract.php.

References TeamSpeak3_Node_Abstract\$parent.

   {
     return $this->parent;
   }

TeamSpeak3_Node_Abstract::getId ( )

inherited

Returns the primary ID of the current node.

Returns: integer

Definition at line 116 of file Abstract.php.

References TeamSpeak3_Node_Abstract\$nodeId.

   {
     return $this->nodeId;
   }

TeamSpeak3_Node_Abstract::iconIsLocal ( $key)

inherited

Returns TRUE if the node icon has a local source.

Parameters

string $key

Returns: boolean

Definition at line 127 of file Abstract.php.

Referenced by TeamSpeak3_Node_Channelgroup\iconDownload(), TeamSpeak3_Node_Servergroup\iconDownload(), TeamSpeak3_Node_Client\iconDownload(), TeamSpeak3_Node_Channel\iconDownload(), and TeamSpeak3_Node_Server\iconDownload().

   {
     return ($this[$key] > 0 && $this[$key] < 1000) ? TRUE : FALSE;
   }

TeamSpeak3_Node_Abstract::iconGetName ( $key)

inherited

Returns the internal path of the node icon.

Parameters

string $key

Returns: TeamSpeak3_Helper_String

Definition at line 138 of file Abstract.php.

Referenced by TeamSpeak3_Node_Abstract\getInfo(), TeamSpeak3_Node_Channelgroup\iconDownload(), TeamSpeak3_Node_Servergroup\iconDownload(), TeamSpeak3_Node_Client\iconDownload(), TeamSpeak3_Node_Channel\iconDownload(), and TeamSpeak3_Node_Server\iconDownload().

   {
     $iconid = ($this[$key] < 0) ? (pow(2, 32))-($this[$key]*-1) : $this[$key];
 
     return new TeamSpeak3_Helper_String("/icon_" . $iconid);
   }

TeamSpeak3_Node_Abstract::getClass ( $prefix = "ts3_")

inherited

Returns a possible classname for the node which can be used as a HTML property.

Parameters

string $prefix

Returns: string

Definition at line 151 of file Abstract.php.

References TeamSpeak3_Helper_String\factory().

   {
     if($this instanceof TeamSpeak3_Node_Channel && $this->isSpacer())
     {
       return $prefix . "spacer";
     }
     elseif($this instanceof TeamSpeak3_Node_Client && $this["client_type"])
     {
       return $prefix . "query";
     }
 
     return $prefix . TeamSpeak3_Helper_String::factory(get_class($this))->section("_", 2)->toLower();
   }

TeamSpeak3_Node_Abstract::getViewer ( TeamSpeak3_Viewer_Interface $viewer)

inherited

Returns the HTML code to display a TeamSpeak 3 viewer.

Parameters

TeamSpeak3_Viewer_Interface $viewer

Returns: string

Definition at line 192 of file Abstract.php.

References TeamSpeak3_Viewer_Interface\fetchObject().

   {
     $html = $viewer->fetchObject($this);
 
     $iterator = new RecursiveIteratorIterator($this, RecursiveIteratorIterator::SELF_FIRST);
 
     foreach($iterator as $node)
     {
       $siblings = array();
 
       for($level = 0; $level < $iterator->getDepth(); $level++)
       {
         $siblings[] = ($iterator->getSubIterator($level)->hasNext()) ? 1 : 0;
       }
 
       $siblings[] = (!$iterator->getSubIterator($level)->hasNext()) ? 1 : 0;
 
       $html .= $viewer->fetchObject($node, $siblings);
     }
 
     return $html;
   }

TeamSpeak3_Node_Abstract::filterList	(	array	$nodes = `array()`,
		array	$rules = `array()`
	)

protectedinherited

Filters given node list array using specified filter rules.

Parameters

array	$nodes
array	$rules

Returns: array

Definition at line 222 of file Abstract.php.

Referenced by TeamSpeak3_Node_Server\channelGroupList(), TeamSpeak3_Node_Server\channelList(), TeamSpeak3_Node_Channel\clientList(), TeamSpeak3_Node_Server\clientList(), TeamSpeak3_Node_Server\serverGroupList(), serverList(), and TeamSpeak3_Node_Channel\subChannelList().

   {
     if(!empty($rules))
     {
       foreach($nodes as $node)
       {
         if(!$node instanceof TeamSpeak3_Node_Abstract) continue;
 
         $props = $node->getInfo(FALSE);
         $props = array_intersect_key($props, $rules);
         $match = TRUE;
 
         foreach($props as $key => $val)
         {
           if($val instanceof TeamSpeak3_Helper_String)
           {
             $match = $val->contains($rules[$key], TRUE);
           }
           else
           {
             $match = $val == $rules[$key];
           }
 
           if($match === FALSE)
           {
             unset($nodes[$node->getId()]);
           }
         }
       }
     }
 
     return $nodes;
   }

TeamSpeak3_Node_Abstract::getInfo	(	$extend = `TRUE`,
		$convert = `FALSE`
	)

inherited

Returns all information available on this node.

If $convert is enabled, some property values will be converted to human-readable values.

Parameters

boolean	$extend
boolean	$convert

Returns: array

Definition at line 264 of file Abstract.php.

References TeamSpeak3_Node_Abstract\$nodeInfo, TeamSpeak3_Helper_Convert\bytes(), TeamSpeak3_Helper_String\factory(), TeamSpeak3_Node_Abstract\fetchNodeInfo(), TeamSpeak3_Node_Abstract\iconGetName(), TeamSpeak3_Helper_Convert\seconds(), and TeamSpeak3_Helper_Convert\version().

   {
     if($extend)
     {
       $this->fetchNodeInfo();
     }
 
     if($convert)
     {
       $info = $this->nodeInfo;
 
       foreach($info as $key => $val)
       {
         $key = TeamSpeak3_Helper_String::factory($key);
 
         if($key->contains("_bytes_"))
         {
           $info[$key->toString()] = TeamSpeak3_Helper_Convert::bytes($val);
         }
         elseif($key->contains("_bandwidth_"))
         {
           $info[$key->toString()] = TeamSpeak3_Helper_Convert::bytes($val) . "/s";
         }
         elseif($key->contains("_packets_"))
         {
           $info[$key->toString()] = number_format($val, null, null, ".");
         }
         elseif($key->contains("_packetloss_"))
         {
           $info[$key->toString()] = sprintf("%01.2f", floatval($val->toString())*100) . "%";
         }
         elseif($key->endsWith("_uptime"))
         {
           $info[$key->toString()] = TeamSpeak3_Helper_Convert::seconds($val);
         }
         elseif($key->endsWith("_version"))
         {
           $info[$key->toString()] = TeamSpeak3_Helper_Convert::version($val);
         }
         elseif($key->endsWith("_icon_id"))
         {
           $info[$key->toString()] = $this->iconGetName($key)->filterDigits();
         }
       }
 
       return $info;
     }
 
     return $this->nodeInfo;
   }

TeamSpeak3_Node_Abstract::getProperty	(	$property,
		$default = `null`
	)

inherited

Returns the specified property or a pre-defined default value from the node info array.

Parameters

string	$property
mixed	$default

Returns: mixed

Definition at line 322 of file Abstract.php.

References TeamSpeak3_Node_Abstract\fetchNodeInfo(), and TeamSpeak3_Node_Abstract\offsetExists().

Referenced by TeamSpeak3_Node_Server\sortClientList(), and TeamSpeak3_Node_Server\sortGroupList().

   {
     if(!$this->offsetExists($property))
     {
       $this->fetchNodeInfo();
     }
 
     if(!$this->offsetExists($property))
     {
       return $default;
     }
 
     return $this->nodeInfo[(string) $property];
   }

TeamSpeak3_Node_Abstract::toString ( )

inherited

Returns a string representation of this node.

Returns: string

Definition at line 352 of file Abstract.php.

References TeamSpeak3_Node_Abstract\__toString().

   {
     return $this->__toString();
   }

TeamSpeak3_Node_Abstract::toArray ( )

inherited

Returns an assoc array filled with current node info properties.

Returns: array

Definition at line 362 of file Abstract.php.

References TeamSpeak3_Node_Abstract\$nodeList.

Referenced by TeamSpeak3_Node_Server\channelFileInfo().

   {
     return $this->nodeList;
   }

TeamSpeak3_Node_Abstract::__call	(		$name,
		array	$args
	)

inherited

Called whenever we're using an unknown method.

Parameters

string	$name
array	$args

Exceptions

Returns: mixed

Definition at line 375 of file Abstract.php.