TeamSpeak3_Adapter_ServerQuery Class Reference

Provides low-level methods for ServerQuery communication with a TeamSpeak 3 Server. More...

Inheritance diagram for TeamSpeak3_Adapter_ServerQuery:

Public Member Functions
	__destruct ()
	The TeamSpeak3_Adapter_ServerQuery destructor. More...
	getHost ()
	Returns the TeamSpeak3_Node_Host object of the current connection. More...
	getQueryCount ()
	Returns the number of queries executed on the server. More...
	getQueryLastTimestamp ()
	Returns the timestamp of the last command. More...
	getQueryRuntime ()
	Returns the total runtime of all queries. More...
	prepare ($cmd, array $params=array())
	Uses given parameters and returns a prepared ServerQuery command. More...
	request ($cmd, $throw=TRUE)
	Sends a prepared command to the server and returns the result. More...
	wait ()
	Waits for the server to send a notification message and returns the result. More...
Public Member Functions inherited from TeamSpeak3_Adapter_Abstract
	__construct (array $options)
	The TeamSpeak3_Adapter_Abstract constructor. More...
	__destruct ()
	The TeamSpeak3_Adapter_Abstract destructor. More...
	__sleep ()
	Commit pending data. More...
	__wakeup ()
	Reconnects to the remote server. More...
	getProfiler ()
	Returns the profiler timer used for this connection adapter. More...
	getTransport ()
	Returns the transport object used for this connection adapter. More...
	getTransportHost ()
	Returns the hostname or IPv4 address the underlying TeamSpeak3_Transport_Abstract object is connected to. More...
	getTransportPort ()
	Returns the port number of the server the underlying TeamSpeak3_Transport_Abstract object is connected to. More...

Protected Member Functions
	syn ()
	Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote server. More...
Protected Member Functions inherited from TeamSpeak3_Adapter_Abstract
	initTransport ($options, $transport="TeamSpeak3_Transport_TCP")
	Loads the transport object object used for the connection adapter and passes a given set of options. More...
	syn ()
	Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote server. More...

Detailed Description

Provides low-level methods for ServerQuery communication with a TeamSpeak 3 Server.

Constructor & Destructor Documentation

__destruct()

__destruct

(

)

The TeamSpeak3_Adapter_ServerQuery destructor.

Returns

void

  {
    if($this->getTransport() instanceof TeamSpeak3_Transport_Abstract && $this->transport->isConnected())
    {
      try
      {
        $this->request("quit");
      }
      catch(Exception $e)
      {
        return;
      }
    }
  }

Member Function Documentation

getHost()

getHost

(

)

Returns the TeamSpeak3_Node_Host object of the current connection.

Returns

TeamSpeak3_Node_Host

  {
    if($this->host === null)
    {
      $this->host = new TeamSpeak3_Node_Host($this);
    }

    return $this->host;
  }

getQueryCount()

getQueryCount

(

)

Returns the number of queries executed on the server.

Returns

integer

  {
    return $this->count;
  }

getQueryLastTimestamp()

getQueryLastTimestamp

(

)

Returns the timestamp of the last command.

Returns

integer

  {
    return $this->timer;
  }

getQueryRuntime()

getQueryRuntime

(

)

Returns the total runtime of all queries.

Returns

mixed

  {
    return $this->getProfiler()->getRuntime();
  }

prepare()

prepare	(		$cmd,
		array	$params = array()
	)

Uses given parameters and returns a prepared ServerQuery command.

Parameters

string	$cmd
array	$params

Returns

string

  {
    $args = array();
    $cells = array();

    foreach($params as $ident => $value)
    {
      $ident = is_numeric($ident) ? "" : strtolower($ident) . TeamSpeak3::SEPARATOR_PAIR;

      if(is_array($value))
      {
        $value = array_values($value);

        for($i = 0; $i < count($value); $i++)
        {
          if($value[$i] === null) continue;
          elseif($value[$i] === FALSE) $value[$i] = 0x00;
          elseif($value[$i] === TRUE) $value[$i] = 0x01;
          elseif($value[$i] instanceof TeamSpeak3_Node_Abstract) $value[$i] = $value[$i]->getId();

          $cells[$i][] = $ident . TeamSpeak3_Helper_String::factory($value[$i])->escape()->toUtf8();
        }
      }
      else
      {
        if($value === null) continue;
        elseif($value === FALSE) $value = 0x00;
        elseif($value === TRUE) $value = 0x01;
        elseif($value instanceof TeamSpeak3_Node_Abstract) $value = $value->getId();

        $args[] = $ident . TeamSpeak3_Helper_String::factory($value)->escape()->toUtf8();
      }
    }

    foreach(array_keys($cells) as $ident) $cells[$ident] = implode(TeamSpeak3::SEPARATOR_CELL, $cells[$ident]);

    if(count($args)) $cmd .= " " . implode(TeamSpeak3::SEPARATOR_CELL, $args);
    if(count($cells)) $cmd .= " " . implode(TeamSpeak3::SEPARATOR_LIST, $cells);

    return trim($cmd);
  }

request()

request	(		$cmd,
			$throw = TRUE
	)

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

Parameters

string	$cmd
boolean	$throw

Exceptions

TeamSpeak3_Adapter_Exception

Returns

TeamSpeak3_Adapter_ServerQuery_Reply

  {
    $query = TeamSpeak3_Helper_String::factory($cmd)->section(TeamSpeak3::SEPARATOR_CELL);

    if(strstr($cmd, "\r") || strstr($cmd, "\n"))
    {
      throw new TeamSpeak3_Adapter_Exception("illegal characters in command '" . $query . "'");
    }
    elseif(in_array($query, $this->block))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("command not found", 0x100);
    }

    TeamSpeak3_Helper_Signal::getInstance()->emit("serverqueryCommandStarted", $cmd);

    $this->getProfiler()->start();
    $this->getTransport()->sendLine($cmd);
    $this->timer = time();
    $this->count++;

    $rpl = array();

    do {
      $str = $this->getTransport()->readLine();
      $rpl[] = $str;
    } while($str instanceof TeamSpeak3_Helper_String && $str->section(TeamSpeak3::SEPARATOR_CELL) != TeamSpeak3::ERROR);

    $this->getProfiler()->stop();

    $reply = new TeamSpeak3_Adapter_ServerQuery_Reply($rpl, $cmd, $this->getHost(), $throw);

    TeamSpeak3_Helper_Signal::getInstance()->emit("serverqueryCommandFinished", $cmd, $reply);

    return $reply;
  }

syn()

syn ( )

protected

Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote server.

Exceptions

TeamSpeak3_Adapter_Exception

Returns

void

  {
    $this->initTransport($this->options);
    $this->transport->setAdapter($this);

    TeamSpeak3_Helper_Profiler::init(spl_object_hash($this));

    $rdy = $this->getTransport()->readLine();

    if(!$rdy->startsWith(TeamSpeak3::READY) && !$rdy->startsWith(TeamSpeak3::TEA_READY))
    {
      throw new TeamSpeak3_Adapter_Exception("invalid reply from the server (" . $rdy . ")");
    }

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

wait()

wait

(

)

Waits for the server to send a notification message and returns the result.

Exceptions

TeamSpeak3_Adapter_Exception

Returns

TeamSpeak3_Adapter_ServerQuery_Event

  {
    if($this->getTransport()->getConfig("blocking"))
    {
      throw new TeamSpeak3_Adapter_Exception("only available in non-blocking mode");
    }

    do {
      $evt = $this->getTransport()->readLine();
    } while($evt instanceof TeamSpeak3_Helper_String && !$evt->section(TeamSpeak3::SEPARATOR_CELL)->startsWith(TeamSpeak3::EVENT));

    return new TeamSpeak3_Adapter_ServerQuery_Event($evt, $this->getHost());
  }

---

The documentation for this class was generated from the following file:

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Adapter/ServerQuery.php