TeamSpeak3_Adapter_ServerQuery_Reply Class Reference

Provides methods to analyze and format a ServerQuery reply. More...

Public Member Functions
	__construct (array $rpl, $cmd=null, TeamSpeak3_Node_Host $con=null, $exp=TRUE)
	Creates a new TeamSpeak3_Adapter_ServerQuery_Reply object. More...
	getCommandString ()
	Returns the command used to get this reply. More...
	getErrorProperty ($ident, $default=null)
	Returns the value for a specified error property. More...
	getNotifyEvents ()
	Returns an array of events that occured before or during this reply. More...
	toArray ()
	Returns a multi-dimensional array containing the reply splitted in multiple rows and columns. More...
	toAssocArray ($ident)
	Returns a multi-dimensional assoc array containing the reply splitted in multiple rows and columns. More...
	toLines ()
	Returns the reply as a standard PHP array where each element represents one item. More...
	toList ()
	Returns an array containing the reply splitted in multiple rows and columns. More...
	toObjectArray ()
	Returns an array containing stdClass objects. More...
	toString ()
	Returns the reply as an TeamSpeak3_Helper_String object. More...
	toTable ()
	Returns the reply as a standard PHP array where each element represents one item in table format. More...

Protected Member Functions
	fetchError ($err)
	Parses a ServerQuery error and throws a TeamSpeak3_Adapter_ServerQuery_Exception object if there's an error. More...
	fetchReply ($rpl)
	Parses a ServerQuery reply and creates a TeamSpeak3_Helper_String object. More...

Detailed Description

Provides methods to analyze and format a ServerQuery reply.

Constructor & Destructor Documentation

__construct()

__construct	(	array	$rpl,
			$cmd = null,
		TeamSpeak3_Node_Host	$con = null,
			$exp = TRUE
	)

Creates a new TeamSpeak3_Adapter_ServerQuery_Reply object.

Parameters

array	$rpl
string	$cmd
boolean	$exp
TeamSpeak3_Node_Host	$con

Returns

TeamSpeak3_Adapter_ServerQuery_Reply

  {
    $this->cmd = new TeamSpeak3_Helper_String($cmd);
    $this->con = $con;
    $this->exp = (bool) $exp;
    
    $this->fetchError(array_pop($rpl));
    $this->fetchReply($rpl);
  }

Member Function Documentation

fetchError()

fetchError (   $err )

protected

Parses a ServerQuery error and throws a TeamSpeak3_Adapter_ServerQuery_Exception object if there's an error.

Parameters

string

$err

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

void

  {
    $cells = $err->section(TeamSpeak3::SEPARATOR_CELL, 1, 3);

    foreach($cells->split(TeamSpeak3::SEPARATOR_CELL) as $pair)
    {
      list($ident, $value) = $pair->split(TeamSpeak3::SEPARATOR_PAIR);

      $this->err[$ident->toString()] = $value->isInt() ? $value->toInt() : $value->unescape();
    }

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

    if($this->getErrorProperty("id", 0x00) != 0x00 && $this->exp)
    {
      if($permid = $this->getErrorProperty("failed_permid"))
      {
        if($permsid = key($this->con->request("permget permid=" . $permid, FALSE)->toAssocArray("permsid")))
        {
          $suffix = " (failed on " . $permsid . ")";
        }
        else
        {
          $suffix = " (failed on " . $this->cmd->section(TeamSpeak3::SEPARATOR_CELL) . " " . $permid . "/0x" . strtoupper(dechex($permid)) . ")";
        }
      }
      elseif($details = $this->getErrorProperty("extra_msg"))
      {
        $suffix = " (" . trim($details) . ")";
      }
      else
      {
        $suffix = "";
      }
      
      throw new TeamSpeak3_Adapter_ServerQuery_Exception($this->getErrorProperty("msg") . $suffix, $this->getErrorProperty("id"));
    }
  }

fetchReply()

fetchReply (   $rpl )

protected

Parses a ServerQuery reply and creates a TeamSpeak3_Helper_String object.

Parameters

string

$rpl

Returns

void

  {
    foreach($rpl as $key => $val)
    {
      if($val->startsWith(TeamSpeak3::GREET))
      {
        unset($rpl[$key]);
      }
      elseif($val->startsWith(TeamSpeak3::EVENT))
      {
        $this->evt[] = new TeamSpeak3_Adapter_ServerQuery_Event($rpl[$key], $this->con);
        unset($rpl[$key]);
      }
    }

    $this->rpl = new TeamSpeak3_Helper_String(implode(TeamSpeak3::SEPARATOR_LIST, $rpl));
  }

getCommandString()

getCommandString

(

)

Returns the command used to get this reply.

Returns

TeamSpeak3_Helper_String

  {
    return new TeamSpeak3_Helper_String($this->cmd);
  }

getErrorProperty()

getErrorProperty	(		$ident,
			$default = null
	)

Returns the value for a specified error property.

Parameters

string	$ident
mixed	$default

Returns

mixed

  {
    return (array_key_exists($ident, $this->err)) ? $this->err[$ident] : $default;
  }

getNotifyEvents()

getNotifyEvents

(

)

Returns an array of events that occured before or during this reply.

Returns

array

  {
    return $this->evt;
  }

toArray()

toArray

(

)

Returns a multi-dimensional array containing the reply splitted in multiple rows and columns.

Returns

array

  {
    $array = array();
    $table = $this->toTable(1);

    for($i = 0; $i < count($table); $i++)
    {
      foreach($table[$i] as $pair)
      {
        if(!count($pair))
        {
          continue;
        }
        
        if(!$pair->contains(TeamSpeak3::SEPARATOR_PAIR))
        {
          $array[$i][$pair->toString()] = null;
        }
        else
        {
          list($ident, $value) = $pair->split(TeamSpeak3::SEPARATOR_PAIR, 2);

          $array[$i][$ident->toString()] = $value->isInt() ? $value->toInt() : (!func_num_args() ? $value->unescape() : $value);
        }
      }
    }

    return $array;
  }

toAssocArray()

toAssocArray

(

$ident

)

Returns a multi-dimensional assoc array containing the reply splitted in multiple rows and columns.

The identifier specified by key will be used while indexing the array.

Parameters

$key

Returns

array

  {
    $nodes = (func_num_args() > 1) ? $this->toArray(1) : $this->toArray();
    $array = array();

    foreach($nodes as $node)
    {
      if(isset($node[$ident]))
      {
        $array[(is_object($node[$ident])) ? $node[$ident]->toString() : $node[$ident]] = $node;
      }
      else
      {
        throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid parameter", 0x602);
      }
    }

    return $array;
  }

toLines()

toLines

(

)

Returns the reply as a standard PHP array where each element represents one item.

Returns

array

  {
    if(!count($this->rpl)) return array();

    $list = $this->toString(0)->split(TeamSpeak3::SEPARATOR_LIST);

    if(!func_num_args())
    {
      for($i = 0; $i < count($list); $i++) $list[$i]->unescape();
    }

    return $list;
  }

toList()

toList

(

)

Returns an array containing the reply splitted in multiple rows and columns.

Returns

array

  {
    $array = func_num_args() ? $this->toArray(1) : $this->toArray();

    if(count($array) == 1)
    {
      return array_shift($array);
    }

    return $array;
  }

toObjectArray()

toObjectArray

(

)

Returns an array containing stdClass objects.

Returns

ArrayObject

  {
    $array = (func_num_args() > 1) ? $this->toArray(1) : $this->toArray();

    for($i = 0; $i < count($array); $i++)
    {
      $array[$i] = (object) $array[$i];
    }

    return $array;
  }

toString()

toString

(

)

Returns the reply as an TeamSpeak3_Helper_String object.

Returns

TeamSpeak3_Helper_String

  {
    return (!func_num_args()) ? $this->rpl->unescape() : $this->rpl;
  }

toTable()

toTable

(

)

Returns the reply as a standard PHP array where each element represents one item in table format.

Returns

array

  {
    $table = array();

    foreach($this->toLines(0) as $cells)
    {
      $pairs = $cells->split(TeamSpeak3::SEPARATOR_CELL);

      if(!func_num_args())
      {
        for($i = 0; $i < count($pairs); $i++) $pairs[$i]->unescape();
      }

      $table[] = $pairs;
    }

    return $table;
  }

---

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

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