unix1/spoof

<?php

/**
 *  This is Spoof.
 *  Copyright (C) 2011-2017  Spoof project.
 *
 *  Spoof 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.
 *
 *  Spoof 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 Spoof.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace spoof\lib360\db\connection;

/**
 * Database connection interface.
 * This interface is used to define database connection.
 */
interface IConnection
{

    /**
     * Constructor for the database connection object instantiates the object
     * but does not connect it to a database.
     *
     * @param $config IConfig database connection configuration object
     */
    public function __construct(IConfig $config);

    /**
     * Parses name of the driver class from Config object.
     *
     * @param IConfig $config
     *
     * @return string driver class name
     *
     * @throws ConfigException when driver name cannot be determined
     */
    public function parseDriver(IConfig $config);

    /**
     * Connects the object to the database.
     *
     * @return mixed connection object
     */
    public function connect();

    /**
     * Checks whether the database connection is active.
     *
     * @return boolean TRUE if connected, FALSE otherwise
     */
    public function isConnected();

    /**
     * Retrieves the underlying connection object.
     *
     * @return mixed connection object if connected, NULL otherwise
     */
    public function getConnection();

    /**
     * Closes the connection.
     */
    public function disconnect();

}

?>