TeamSpeak 3 PHP Framework: TeamSpeak3_Node

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

    return ($ident && array_key_exists($ident, $this->version)) ? $this->version[$ident] : $this->version;
  }

TeamSpeak3_Node_Host::serverSelect	(	$	sid,
		$	virtual = `null`
	)

Selects a virtual server by ID to allow further interaction.

Parameters:

integer	$sid
boolean	$virtual

Returns:: void

Definition at line 128 of file Host.php.

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

Referenced by logAdd(), serverDeselect(), and serverSelectById().

  {
    if($this->whoami !== null && $this->serverSelectedId() == $sid) return;

    $virtual = ($virtual !== null) ? $virtual : $this->start_offline_virtual;
    $getargs = func_get_args();

    $this->execute("use", array("sid" => $sid, $virtual ? "-virtual" : null));

    if($sid != 0 && $this->predefined_query_name !== null)
    {
      $this->execute("clientupdate", array("client_nickname" => (string) $this->predefined_query_name));
    }

    $this->whoamiReset();

    $this->setStorage("_server_use", array(__FUNCTION__, $getargs));

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerselected", $this);
  }

TeamSpeak3_Node_Host::serverSelectById	(	$	sid,
		$	virtual = `null`
	)

Alias for serverSelect().

Parameters:

integer	$sid
boolean	$virtual

Returns:: void

Definition at line 156 of file Host.php.

References serverSelect().

Referenced by serverGetById().

  {
    $this->serverSelect($sid, $virtual);
  }

TeamSpeak3_Node_Host::serverSelectByPort	(	$	port,
		$	virtual = `null`
	)

Selects a virtual server by UDP port to allow further interaction.

Parameters:

integer	$port
boolean	$virtual

Returns:: void

Definition at line 168 of file Host.php.

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

Referenced by serverGetByPort().

  {
    if($this->whoami !== null && $this->serverSelectedPort() == $port) return;

    $virtual = ($virtual !== null) ? $virtual : $this->start_offline_virtual;
    $getargs = func_get_args();

    $this->execute("use", array("port" => $port, $virtual ? "-virtual" : null));

    if($port != 0 && $this->predefined_query_name !== null)
    {
      $this->execute("clientupdate", array("client_nickname" => (string) $this->predefined_query_name));
    }

    $this->whoamiReset();

    $this->setStorage("_server_use", array(__FUNCTION__, $getargs));

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerselected", $this);
  }

TeamSpeak3_Node_Host::serverDeselect ( )

Deselects the active virtual server.

Returns:: void

Definition at line 194 of file Host.php.

References TeamSpeak3_Node_Abstract\delStorage(), and serverSelect().

Referenced by logAdd(), serverStart(), and serverStop().

  {
    $this->serverSelect(0);

    $this->delStorage("_server_use");
  }

TeamSpeak3_Node_Host::serverIdGetByPort ( $ port )

Returns the ID of a virtual server matching the given port.

Parameters:

integer $port

Returns:: integer

Definition at line 207 of file Host.php.

References TeamSpeak3_Node_Abstract\execute().

  {
    $sid = $this->execute("serveridgetbyport", array("virtualserver_port" => $port))->toList();

    return $sid["server_id"];
  }

TeamSpeak3_Node_Host::serverGetPortById ( $ sid )

Returns the port of a virtual server matching the given ID.

Parameters:

integer $sid

Returns:: integer

Definition at line 220 of file Host.php.

References serverList().

  {
    if(!array_key_exists((string) $sid, $this->serverList()))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid serverID", 0x400);
    }

    return $this->serverList[intval((string) $sid)]["virtualserver_port"];
  }

TeamSpeak3_Node_Host::serverGetSelected ( )

Returns the TeamSpeak3_Node_Server object matching the currently selected ID.

Returns:: TeamSpeak3_Node_Server

Definition at line 235 of file Host.php.

References serverGetById(), and serverSelectedId().

  {
    return $this->serverGetById($this->serverSelectedId());
  }

TeamSpeak3_Node_Host::serverGetById ( $ sid )

Returns the TeamSpeak3_Node_Server object matching the given ID.

Parameters:

integer $sid

Returns:: TeamSpeak3_Node_Server

Definition at line 246 of file Host.php.

References serverSelectById().

Referenced by serverGetSelected().

  {
    $this->serverSelectById($sid);

    return new TeamSpeak3_Node_Server($this, array("virtualserver_id" => intval($sid)));
  }

TeamSpeak3_Node_Host::serverGetByPort ( $ port )

Returns the TeamSpeak3_Node_Server object matching the given port number.

Parameters:

integer $port

Returns:: TeamSpeak3_Node_Server

Definition at line 259 of file Host.php.

References serverSelectByPort(), and serverSelectedId().

Referenced by serverGetByTSDNS().

  {
    $this->serverSelectByPort($port);

    return new TeamSpeak3_Node_Server($this, array("virtualserver_id" => $this->serverSelectedId()));
  }

TeamSpeak3_Node_Host::serverGetByName ( $ name )

Returns the first TeamSpeak3_Node_Server object matching the given name.

Parameters:

string $name

Exceptions:

Returns:: TeamSpeak3_Node_Server

Definition at line 273 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 290 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 309 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 341 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 360 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 375 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 394 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 412 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 425 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 449 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 460 of file Host.php.

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

TeamSpeak3_Node_Host::permissionList ( )

Returns a list of permissions available on the server instance.

Returns:: array

Definition at line 470 of file Host.php.

References permissionGetCategoryById(), permissionGetGrantById(), and TeamSpeak3_Node_Abstract\request().

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

  {
    if($this->permissionList === null)
    {
      $this->permissionList = $this->request("permissionlist")->toAssocArray("permname");

      foreach($this->permissionList as $permname => $permdata)
      {
        $this->permissionList[$permname]["permcatid"] = $this->permissionGetCategoryById($permdata["permid"]);
        $this->permissionList[$permname]["permgrant"] = $this->permissionGetGrantById($permdata["permid"]);
      }
    }

    return $this->permissionList;
  }

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 492 of file Host.php.

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

  {
    $permtree = array();
    $reflects = new ReflectionClass("TeamSpeak3");

    foreach($reflects->getConstants() as $key => $val)
    {
      if(!TeamSpeak3_Helper_String::factory($key)->startsWith("PERM_CAT") || $val == 0xFF)
      {
        continue;
      }

      $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($this->permissionGetCategoryById($permission["permid"]) == $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 540 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 561 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 578 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 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 597 of file Host.php.

References permissionGetIdByName().

Referenced by permissionList(), and permissionTree().

  {
    if(!is_numeric($permid))
    {
      $permid = $this->permissionGetIdByName($permid);
    }

    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 616 of file Host.php.

References permissionGetIdByName().

Referenced by permissionList().

  {
    if(!is_numeric($permid))
    {
      $permid = $this->permissionGetIdByName($permid);
    }

    return (int) bindec(substr(decbin($permid), -8))+0xFF00;
  }

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 632 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 652 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 664 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 678 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 690 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 706 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 724 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 740 of file Host.php.

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 757 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 774 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 786 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 796 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 806 of file Host.php.

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

TeamSpeak3_Node_Host::fetchNodeList ( ) [protected]

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 814 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]

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 827 of file Host.php.

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

    $this->nodeInfo = array_merge($this->nodeInfo, $info1, $info2);
  }

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 842 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 855 of file Host.php.

  {
    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 867 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 880 of file Host.php.

  {
    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 892 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 905 of file Host.php.

  {
    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 917 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 930 of file Host.php.

  {
    return $this->sort_clients_channels;
  }

TeamSpeak3_Node_Host::getAdapter ( )

Returns the underlying TeamSpeak3_Adapter_ServerQuery object.

Returns:: TeamSpeak3_Adapter_ServerQuery

Definition at line 940 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

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 950 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

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 960 of file Host.php.

  {
    return "host";
  }

TeamSpeak3_Node_Host::getSymbol ( )

Returns a symbol representing the node.

Returns:: string

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 970 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 981 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

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 1012 of file Host.php.

References getAdapterHost().

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

TeamSpeak3_Node_Abstract::request ( $ cmd ) [inherited]

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

Parameters:

string $cmd

Returns:: TeamSpeak3_Adapter_ServerQuery_Reply

Reimplemented in TeamSpeak3_Node_Server.

Definition at line 70 of file Abstract.php.

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

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

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 82 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 94 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 105 of file Abstract.php.

  {
    return $this->parent;
  }

TeamSpeak3_Node_Abstract::getId ( ) [inherited]

Returns the primary ID of the current node.

Returns:: integer

Definition at line 115 of file Abstract.php.

  {
    return $this->nodeId;
  }

TeamSpeak3_Node_Abstract::iconIsLocal ( $ key ) [inherited]

Returns TRUE if the node icon has a local source.

Returns:: boolean

Definition at line 125 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.

Returns:: TeamSpeak3_Helper_String

Definition at line 135 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.

Returns:: string

Definition at line 147 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 188 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()`
	)		`[protected, inherited]`

Filters given node list array using specified filter rules.

Parameters:

array	$nodes
array	$rules

Returns:: array

Definition at line 218 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 260 of file Abstract.php.

References 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 318 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 348 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 358 of file Abstract.php.

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 371 of file Abstract.php.