<?php

/**
 * @file
 * TeamSpeak 3 PHP Framework
 * $Id: Abstract.php 06/06/2016 22:27:13 scp@Svens-iMac $
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * @package   TeamSpeak3
 * @version   1.1.24
 * @author    Sven 'ScP' Paulsen
 * @copyright Copyright (c) 2010 by Planet TeamSpeak. All rights reserved.
 */

/**
 * @class TeamSpeak3_Adapter_Abstract
 * @brief Provides low-level methods for concrete adapters to communicate with a TeamSpeak 3 Server.
 */
abstract class TeamSpeak3_Adapter_Abstract
{
    /**
     * Stores user-provided options.
     *
     * @var array
     */
    protected $options = null;

    /**
     * Stores an TeamSpeak3_Transport_Abstract object.
     *
     * @var TeamSpeak3_Transport_Abstract
     */
    protected $transport = null;

    /**
     * The TeamSpeak3_Adapter_Abstract constructor.
     *
     * @param  array $options
     * @return TeamSpeak3_Adapter_Abstract
     */
    public function __construct(array $options)
    {
        $this->options = $options;

        if ($this->transport === null) {
            $this->syn();
        }
    }

    /**
     * The TeamSpeak3_Adapter_Abstract destructor.
     *
     * @return void
     */
    abstract public function __destruct();

    /**
     * Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote
     * server.
     *
     * @throws TeamSpeak3_Adapter_Exception
     * @return void
     */
    abstract protected function syn();

    /**
     * Commit pending data.
     *
     * @return array
     */
    public function __sleep()
    {
        return ['options'];
    }

    /**
     * Reconnects to the remote server.
     *
     * @return void
     */
    public function __wakeup()
    {
        $this->syn();
    }

    /**
     * Returns the profiler timer used for this connection adapter.
     *
     * @return TeamSpeak3_Helper_Profiler_Timer
     */
    public function getProfiler()
    {
        return TeamSpeak3_Helper_Profiler::get(spl_object_hash($this));
    }

    /**
     * Returns the transport object used for this connection adapter.
     *
     * @return TeamSpeak3_Transport_Abstract
     */
    public function getTransport()
    {
        return $this->transport;
    }

    /**
     * Loads the transport object object used for the connection adapter and passes a given set
     * of options.
     *
     * @param  array  $options
     * @param  string $transport
     * @throws TeamSpeak3_Adapter_Exception
     * @return void
     */
    protected function initTransport($options, $transport = 'TeamSpeak3_Transport_TCP')
    {
        if (!is_array($options)) {
            throw new TeamSpeak3_Adapter_Exception('transport parameters must provided in an array');
        }

        $this->transport = new $transport($options);
    }

    /**
     * Returns the hostname or IPv4 address the underlying TeamSpeak3_Transport_Abstract object
     * is connected to.
     *
     * @return string
     */
    public function getTransportHost()
    {
        return $this->getTransport()->getConfig('host', '0.0.0.0');
    }

    /**
     * Returns the port number of the server the underlying TeamSpeak3_Transport_Abstract object
     * is connected to.
     *
     * @return string
     */
    public function getTransportPort()
    {
        return $this->getTransport()->getConfig('port', '0');
    }
}
