DanySpin97 / PhpBotFramework

src/Localization/Localization.php

<?php
/*
 * This file is part of the PhpBotFramework.
 *
 * PhpBotFramework is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * PhpBotFramework 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace PhpBotFramework\Localization;

use PhpBotFramework\BasicBot;
use PhpBotFramework\Exceptions\BotException;

class Localization
{
    use File,
        LocalizedString;
    /**
     * \addtogroup Localization Localization
     * \brief Create a localized bot.
     * \details Using both a sql database and a redis database you can develop a localized bot with just a small impact on the performance.
     * By default the sql database will store the language permanently in a table which name is defined in $user_table.
     * The redis database will cache the language for the chat_id for a variable time.
     * You can use only the sql database if a redis database is not accessible.
     * These methods will treat groups as User so they will be stored in the table as normal user does.
     * @{
     */

    /** \brief Reference to the bot. */
    protected $bot;

    /** \brief Table containing bot users data into database. */
    public $user_table = 'User';

    /** \brief Name of the column that represents the user ID into database */
    public $id_column = 'chat_id';

    /** \brief Current user/group language. */
    public $language;

    public function __construct(BasicBot &$bot)
    {
        $this->bot = $bot;
    }

    /**
     * \brief Get current user's language from the database, and set it in $language.
     * @return string Language set for the current user, throw error if there is language is not set for the user.
     */
    public function getLanguageDatabase() : string
    {
        $pdo = $this->bot->getPDO();

It seems like you code against a specific sub-type and not the parent class PhpBotFramework\BasicBot as the method getPDO() does only exist in the following sub-classes of PhpBotFramework\BasicBot: DonateBot, EchoBot, PhpBotFramework\Bot, PhpBotFramework\Test\TestBot, WhoAmIBot. Maybe you want to instanceof check for one of these explicitly?

        // Get the language from the bot
        $sth = $pdo->prepare('SELECT language FROM ' . $this->user_table . ' WHERE '
                                                           . $this->id_column . ' = :chat_id');

        $chat_id = $this->bot->getChatID();
        $sth->bindParam(':chat_id', $chat_id);

        try {
            $sth->execute();
        } catch (\PDOException $e) {
            throw new BotException($e->getMessage() . "/n" . $e->getLine());
        }

        $row = $sth->fetch();

        if (isset($row['language'])) {
            $this->language = $row['language'];
            return $row['language'];
        }

        throw new BotException("Could not load language from database for user: $chat_id");
    }

    /**
     * \brief Set the current user language in database and internally.
     * \details Save it into database first.
     * @param string $language The language to set.
     * @return bool On sucess, return true, throws exception otherwise.
     */
    public function setLanguageDatabase(string $language) : bool
    {
        $pdo = $this->bot->getPDO();

It seems like you code against a specific sub-type and not the parent class PhpBotFramework\BasicBot as the method getPDO() does only exist in the following sub-classes of PhpBotFramework\BasicBot: DonateBot, EchoBot, PhpBotFramework\Bot, PhpBotFramework\Test\TestBot, WhoAmIBot. Maybe you want to instanceof check for one of these explicitly?

        // Update the language in the database
        $sth = $pdo->prepare('UPDATE ' . $this->user_table . ' SET language = :language WHERE '
                                             . $this->id_column . ' = :id');
        $sth->bindParam(':language', $language);

        $chat_id = $this->bot->getChatID();
        $sth->bindParam(':id', $chat_id);

        try {
            $sth->execute();
        } catch (\PDOException $e) {
            throw new BotException($e->getMessage());
        }

        $this->language = $language;

        return true;
    }

    /**
     * \brief Get current user language from Redis (as a cache) and set it in language.
     * \details Using Redis as cache, check for the language. On failure, get the language
     * from the database and store it (with default expiring time of one day) in Redis.
     *
     * It also change $language parameter of the bot to the language returned.
     * @param int $expiring_time <i>Optional</i>. Set the expiring time for the language on redis each time it is took from the sql database.
     * @return string Language for the current user, $default_language on errors.
     */
    public function getLanguageRedis(int $expiring_time = 86400) : string
    {
        $redis = $this->bot->getRedis();

It seems like you code against a specific sub-type and not the parent class PhpBotFramework\BasicBot as the method getRedis() does only exist in the following sub-classes of PhpBotFramework\BasicBot: DonateBot, EchoBot, PhpBotFramework\Bot, PhpBotFramework\Test\TestBot, WhoAmIBot. Maybe you want to instanceof check for one of these explicitly?

        $chat_id = $this->bot->getChatID();

        // Check if the language exists on Redis
        if ($redis->exists($this->bot->getChatID() . ':language')) {
            $this->language = $redis->get($chat_id . ':language');
            return $this->language;
        }

        // Set the value from the database
        $redis->setEx(
            $this->bot->getChatID() . ':language',
            $expiring_time,
            $this->getLanguageDatabase()
        );
        return $this->language;
    }

    /**
     * \brief Set the current user language in both Redis, database and internally.
     * \details Save it into database first, then create the expiring key on Redis.
     * @param string $language The language to set.
     * @param int $expiring_time <i>Optional</i>. Time for the language key in redis to expire.
     * @return bool On sucess, return true, throws exception otherwise.
     */
    public function setLanguageRedis(string $language, int $expiring_time = 86400) : bool
    {
        $redis = $this->bot->getRedis();

It seems like you code against a specific sub-type and not the parent class PhpBotFramework\BasicBot as the method getRedis() does only exist in the following sub-classes of PhpBotFramework\BasicBot: DonateBot, EchoBot, PhpBotFramework\Bot, PhpBotFramework\Test\TestBot, WhoAmIBot. Maybe you want to instanceof check for one of these explicitly?

        // If we could successfully set the language in the database
        if ($this->setLanguageDatabase($language)) {
            // Set the language in Redis
            $redis->setEx($this->bot->getChatID() . ':language', $expiring_time, $language);
            return true;
        }

        return false;
    }

    /** @} */
}