Объяснение документации Teamspeak Framework

Question

Я использую TS Framework для считывания некоторых данных через запрос Teamspeak в PHP. Но документация ужасна!

Для отображения всех IP-адресов от всех клиентов я использую этот код:

foreach($ts3_VirtualServer->clientList() as $client)
{
    // skip query clients
    if($client["client_type"]) continue;

    $clientInfo = $client->getInfo();
    echo $clientInfo['connection_client_ip'] . "<br>";
} 

(это не полный код)

Где часть в документации, которая говорит, что getInfo() возвращается?

Ссылка на документацию

Answer 1

Этого нет в документации, поскольку он является абстрактным / обобщенным для всех объектов узлов.

Как вы можете видеть из TeamSpeak3_Node_Abstract:: getInfo ():

if ($extend) {
  $this->fetchNodeInfo();
}

if ($convert) {
  $info = $this->nodeInfo;

  foreach ($info as $key => $val) {
    $key = TeamSpeak3_Helper_String::factory($key);
    //...
  }

  return $info;
}

return $this->nodeInfo;

Возвращенные данные (отформатированные или напрямую) TeamSpeak3_Node_Abstract::$nodeInfo,

Поиск GitHub репо для nodeInfo = показывает, как несколько (дочерних) узлов устанавливают свои унаследованные nodeInfo имущество.

Например, у нас есть TeamSpeak3_Node_Host::fetchNodeInfo(), которая использует свойства, возвращаемые командами TeamSpeak3 Server Query hostinfo, instanceinfo:

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

Также, например, TeamSpeak3_Node_Server:: fetchNodeInfo (), которая использует свойства, возвращаемые serverinfo команда:

protected function fetchNodeInfo() {
  $this->nodeInfo = array_merge($this->nodeInfo,
    $this->request("serverinfo")->toList());
}

Как вы можете себе представить, несколько объектов TeamSpeak3 имеют соответствующие *info команда, которая возвращает свойства этого объекта.

Вы можете просмотреть несколько примеров результатов этих команд вместе с возвращенными свойствами в руководстве к TeamSpeak3 Server Query. Вот например, команда serverinfo.

Кроме того, в конце руководства вы можете найти несколько списков свойств объекта. Например, свойства виртуального сервера.