PhpBotFramework\Utilities\DatabaseHandler

Complexity

Total Complexity

14

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	connect()	0	14	2
A	mergeWithDefaults()	0	4	1
A	stringify()	0	20	3
B	addUser()	0	38	3
B	broadcastMessage()	0	45	5

<?php

namespace PhpBotFramework\Utilities;

trait DatabaseHandler {
    /**
     * \brief Open a database connection using PDO.
     * \details Provides a simpler way to initialize a database connection 
     *  and create a PDO instance.
     * @param $params Parameters for initialize connection.
     * @return True on success.
     */
    public function connect($params) {
        try {
            $config = $this->stringify($this->mergeWithDefaults($params));

            $this->pdo = new \PDO($config, $params['username'], $params['password']);

The property pdo does not exist. Did you maybe forget to declare it?

            $this->pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);

            return true;
        } catch(PDOException $e) {

The class PhpBotFramework\Utilities\PDOException does not exist. Did you forget a USE statement, or did you not list all dependencies?

            echo 'Unable to connect to database, an error occured:' . $e->getMessage();
        }

        return false;
    }

    protected function mergeWithDefaults($params) {
        $DEFAULTS = [ 'adapter' => 'mysql', 'host' => 'localhost' ];
        return array_merge($DEFAULTS, $params);
    }

    /** \brief Returns a string that can passed to PDO in order to open connection. */
    protected function stringify($params) : string {
        $response = $params['adapter'] . ':';
        $fields = [];

        foreach ($params as $field => $value) {
            /**
             *Check if the current field matches one of the fields
             * that are passed to PDO in another way and so don't need
             * to be included in the string.
             */
            if (in_array($field, ['adapter', 'username', 'password'])) {
                unset($params[$field]);
                continue;
            }

            array_push($fields, $field . '=' . $value);
        }

        return $response . join(';', $fields);
    }

    /**
     * \addtogroup Users-handle Users handling
     * \brief Handle bot users on the database.
     * @{
     */

    /** \brief Table contaning bot users data in the sql database. */
    public $user_table = '"User"';

    /** \brief Name of the column that represents the user id in the sql database */
    public $id_column = 'chat_id';

    /** \brief Add a user to the database.
     * \details Add a user to the database in Bot::$user_table table and Bot::$id_column column using Bot::$pdo connection.
     * @param $chat_id chat_id of the user to add.
     * @return True on success.
     */
    public function addUser($chat_id) : bool {

        // Is there database connection?
        if (!isset($this->pdo)) {

            throw new BotException("Database connection not set");

        }

        // Create insertion query and initialize variable
        $query = "INSERT INTO $this->user_table ($this->id_column) VALUES (:chat_id)";

        // Prepare the query
        $sth = $this->pdo->prepare($query);

        // Add the chat_id to the query
        $sth->bindParam(':chat_id', $chat_id);

        try {

            $sth->execute();
            $success = true;

        } catch (PDOException $e) {

The class PhpBotFramework\Utilities\PDOException does not exist. Did you forget a USE statement, or did you not list all dependencies?

            echo $e->getMessage();

            $success = false;

        }

        // Close statement
        $sth = null;

$sth is not used, you could remove the assignment.

        // Return result
        return $success;

    }

    /**
     * \brief Broadcast a message to all user registred on the database.
     * \details Send a message to all users subscribed, change Bot::$user_table and Bot::$id_column to match your database structure is.
     * This method requires Bot::$pdo connection set.
     * All parameters are the same as CoreBot::sendMessage.
     * Because a limitation of Telegram Bot API the bot will have a delay after 20 messages sent in different chats.
     * @see CoreBot::sendMessage
     */
    public function broadcastMessage($text, string $reply_markup = null, string $parse_mode = 'HTML', bool $disable_web_preview = true, bool $disable_notification = false) {

        // Is there database connection?
        if (!isset($this->pdo)) {

            throw new BotException("Database connection not set");

        }

        // Prepare the query to get all chat_id from the database
        $sth = $this->pdo->prepare("SELECT $this->id_column FROM $this->user_table");

        try {

            $sth->execute();

        } catch (PDOException $e) {

The class PhpBotFramework\Utilities\PDOException does not exist. Did you forget a USE statement, or did you not list all dependencies?

            echo $e->getMessage();

        }

        // Iterate over all the row got
        while ($user = $sth->fetch()) {

            // Call getChat to know that this users haven't blocked the bot
            $user_data = $this->getChat($user[$this->id_column]);

It seems like getChat() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            // Did they block it?
            if ($user_data !== false) {

                // Change the chat_id for the next API method
                $this->setChatID($user[$this->id_column]);

It seems like setChatID() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                // Send the message
                $this->sendMessage($text, $reply_markup, null, $parse_mode, $disable_web_preview, $disable_notification);

It seems like sendMessage() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            }

        }

        // Close statement
        $sth = null;

$sth is not used, you could remove the assignment.

    }

    /** @} */

}