Source of file MessageManager.php

<?php

/*

* This file is part of the NextDom software (https://github.com/NextDom or http://nextdom.github.io).

* Copyright (c) 2018 NextDom.

*

* 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, version 2.

*

* 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/>.

*/

/* This file is part of Jeedom.

 *

 * Jeedom 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.

 *

 * Jeedom 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 Jeedom. If not, see <http://www.gnu.org/licenses/>.

 */

namespace NextDom\Managers;

use NextDom\Enums\DateFormat;

use NextDom\Helpers\DBHelper;

use NextDom\Helpers\Utils;

use NextDom\Managers\Parents\BaseManager;

use NextDom\Managers\Parents\CommonManager;

use NextDom\Model\Entity\Message;

/**

 * Class MessageManager

 * @package NextDom\Managers

 */

class MessageManager extends BaseManager

{

    use CommonManager;

    const CLASS_NAME = Message::class;

    const DB_CLASS_NAME = '`message`';

    /**

     *

     * @param string $_type

     * @param string $_message

     * @param string $_action

     * @param mixed $_logicalId

     * @param bool $_writeMessage

     * @throws \NextDom\Exceptions\CoreException

     * @throws \ReflectionException

     */

    public static function add($_type, $_message, $_action = '', $_logicalId = '', $_writeMessage = true)

    {

        $message = (new Message())

            ->setPlugin(Utils::secureXSS($_type))

            ->setMessage(Utils::secureXSS($_message))

            ->setAction(Utils::secureXSS($_action))

            ->setDate(date(DateFormat::FULL))

            ->setLogicalId(Utils::secureXSS($_logicalId));

        $message->save($_writeMessage);

    }

    /**

     * @param string $_plugin

     * @param string $_logicalId

     * @param bool $_search

     * @return bool

     * @throws \Exception

     */

    public static function removeAll($_plugin = '', $_logicalId = '', $_search = false)

    {

        $values = [];

        $sql = 'DELETE FROM ' . self::DB_CLASS_NAME;

        if ($_plugin != '') {

            $values['plugin'] = $_plugin;

            $sql .= ' WHERE `plugin` = :plugin';

            if ($_logicalId != '') {

                if ($_search) {

                    $values['logicalId'] = '%' . $_logicalId . '%';

                    $sql .= ' AND `logicalId` LIKE :logicalId';

                } else {

                    $values['logicalId'] = $_logicalId;

                    $sql .= ' AND `logicalId` = :logicalId';

                }

            }

        }

        DBHelper::exec($sql, $values);

        EventManager::add('message::refreshMessageNumber');

        return true;

    }

    /**

     * @return mixed

     * @throws \NextDom\Exceptions\CoreException

     */

    public static function nbMessage()

    {

        $sql = 'SELECT count(*)

                FROM ' . self::DB_CLASS_NAME;

        $count = DBHelper::getOne($sql);

        return $count['count(*)'];

    }

    /**

     * @param $_plugin

     * @param $_logicalId

     * @return Message[]|null

     * @throws \Exception

     */

    public static function byPluginLogicalId($_plugin, $_logicalId)

    {

        $values = [

            'logicalId' => $_logicalId,

            'plugin' => $_plugin,

        ];

        $sql = static::getBaseSQL() . '

                WHERE `logicalId` = :logicalId

                AND `plugin` = :plugin';

        return DBHelper::getAllObjects($sql, $values, self::CLASS_NAME);

    }

    /**

     * @param $_plugin

     * @return array|mixed|null

     * @throws \NextDom\Exceptions\CoreException

     * @throws \ReflectionException

     */

    public static function byPlugin($_plugin)

    {

        $values = [

            'plugin' => $_plugin,

        ];

        $sql = static::getBaseSQL() . '

                WHERE `plugin` = :plugin

                ORDER BY `date` DESC';

        return DBHelper::getAllObjects($sql, $values, self::CLASS_NAME);

    }

    /**

     * @return array|mixed|null

     * @throws \NextDom\Exceptions\CoreException

     */

    public static function listPlugin()

    {

        $sql = 'SELECT DISTINCT(`plugin`)

                FROM ' . self::DB_CLASS_NAME;

        return DBHelper::getAll($sql);

    }

    /**

     * @return array|mixed|null

     * @throws \NextDom\Exceptions\CoreException

     */

    public static function all()

    {

        return static::getAllOrdered('date', true, 500);

    }

    /**

     * @param $pluginId

     * @param $logicialId

     * @return mixed

     */

    public static function removeByPluginLogicalId($pluginId, $logicialId)

    {

        $values = [

            'logicalId' => $logicialId,

            'plugin' => $pluginId,

        ];

        $sql = 'DELETE FROM ' . self::DB_CLASS_NAME . '

                WHERE `logicalId` = :logicalId

                AND `plugin` = :plugin';

        return DBHelper::exec($sql, $values);

    }

}