capwelton / libapp

programs/Set/AppSSESet.php

<?php

//-------------------------------------------------------------------------

// OVIDENTIA http://www.ovidentia.org

// Ovidentia 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 2, 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, write to the Free Software

// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,

// USA.

//-------------------------------------------------------------------------

/**

 * @license http://opensource.org/licenses/gpl-license.php GNU General Public License (GPL)

 * @copyright Copyright (c) 2022 by SI4YOU ({@link https://www.siforyou.com})

 */

namespace Capwelton\LibApp\Set;



use Capwelton\LibApp\Func_App;

use function Capwelton\LibOrm\ORM_UserField;

The function Capwelton\LibOrm\ORM_UserField was not found. Maybe you did not declare it correctly or list all dependencies?

use function Capwelton\LibOrm\ORM_StringField;

The function Capwelton\LibOrm\ORM_StringField was not found. Maybe you did not declare it correctly or list all dependencies?

use function Capwelton\LibOrm\ORM_IntField;

The function Capwelton\LibOrm\ORM_IntField was not found. Maybe you did not declare it correctly or list all dependencies?

use function Capwelton\LibOrm\ORM_DatetimeField;

The function Capwelton\LibOrm\ORM_DatetimeField was not found. Maybe you did not declare it correctly or list all dependencies?

/**

 * @property ORMUserField      $user

 * @property ORMStringField    $data

 * @property ORMIntField       $type

 * @property ORMDatetimeField  $deleteOn

 *

 * @method AppSSE                       get()

 * @method AppSSE                       request()

 * @method AppSSE[]|ORMMySqlIterator    select()

 * @method AppSSE                       newRecord()

 * @method Func_App App()

 */

class AppSSESet extends AppRecordSet

{

    /**

     * @param Func_App $App

     */

    public function __construct(Func_App $App)

    {

        parent::__construct($App);


        $App = $this->App();

The assignment to $App is dead and can be removed.

        $this->setPrimaryKey('id');


        $this->addFields(

            ORM_UserField('user'),

            ORM_StringField('data'),

            ORM_IntField('type'),

            ORM_DatetimeField('deleteOn')

        );

    }

    

    public function selectUserSSE($user = null)

    {

        if(!isset($user)){

            $App = $this->App();

            $user = $App->getCurrentUser();

        }

        

        return $this->select($this->user->is($user));

The call to Capwelton\LibApp\Set\AppSSESet::select() has too many arguments starting with $this->user->is($user).

    }

    

    /**

     * Construct the data payload that will be send by the SSE request

     * @param int $user         Get the SSE data associated to this specified user id

     * @param boolean $delete   If true, every SSE data will be deleted after being sent to avoid sending multiple time the same data

     * @return string

     */

    public function getSSEData($user, $delete = false)

    {

        $hasData = false;

        $sseData = '{';

        

        $userSSEReloads = $this->select($this->user->is($user)->_AND_($this->type->is(AppSSE::TYPE_RELOAD_SELECTOR)));

The call to Capwelton\LibApp\Set\AppSSESet::select() has too many arguments starting with $this->user->is($user)->_AND_($this->type->is(Capwelton\LibApp\Set\AppSSE::TYPE_RELOAD_SELECTOR)).

        $reloadSelectors = array();

        $now = date('Y-m-d H:i:s');

        foreach ($userSSEReloads as $sseMsg){

            $reloadSelectors[] = $sseMsg->data;

            if($delete && $now > date($sseMsg->deleteOn)){

                $sseMsg->delete();

            }

        }

        

        if(!empty($reloadSelectors)){

            $sseData .= '"reloadSelector":'.bab_json_encode($reloadSelectors);

            $hasData = true;

        }

        

        $userSSEBrowserNotifications = $this->select($this->user->is($user)->_AND_($this->type->is(AppSSE::TYPE_BROWSER_NOTIFICATION)));

        $browserNotifications = array();

        foreach ($userSSEBrowserNotifications as $sseMsg){

            $browserNotifications[] = $sseMsg->data;

            if($delete){

                $sseMsg->delete();

            }

        }

        

        if(!empty($browserNotifications)){

            if($hasData){

                $sseData .= ', ';

            }

            $sseData .= '"browserNotifications":'.bab_json_encode($browserNotifications);

            $hasData = true;

The assignment to $hasData is dead and can be removed.

        }

        

        $sseData .= '}';

        

        return $sseData;

    }

    

    /**

     * Create a SSE event to reload DOM elements identified with the $reloadSelection class

     * @param string $reloadSelector    The css class of the element to reload (ex: ".reload_this_element" )

     * @param mixed  $for               The user id or a list of users id. If null, current user will be used, if 'all', all connected users will be used

     */

    public function newReloadSelector($reloadSelector, $for = null)

    {

        $App = $this->App();

        $users = array();

        if(!isset($for)){

            $users[] = $App->getCurrentUser();

        }

        else if(!is_array($for)){

            if($for === 'all'){

                $users = $App->getLoggedUsers();

            }

            else{

                $users[] = $for;

            }

        }

        

        $deleteOn = self::getDeleteOn();

        foreach ($users as $user){

            $record = $this->newRecord();

            $record->user = $user;

            $record->data = $reloadSelector;

            $record->type = AppSSE::TYPE_RELOAD_SELECTOR;

            $record->deleteOn = $deleteOn;

            $record->save();

        }

        

        return true;

    }

    

    /**

     * Create a SSE event to send a notification to the client browser.

     * Data can have the following attributes :

     * title => The title of the notification (required).

     * body => The body of the notification (required).

     * icon => A url to an icon to be displayed in the notification, ideal size is 64x64 (optional).

     * action => A url which the user will be redirected to when clicking on the notification (optional).

     * @param array $data

     * @param mixed  $for   The user id of a list of users id. If null, current user will be used, if 'all', all connected users will be used

     */

    public function newBrowserNotification($data, $for = null)

    {

        $App = $this->App();

        $users = array();

        if(!isset($for)){

            $users[] = $App->getCurrentUser();

        }

        else if(!is_array($for)){

            if($for === 'all'){

                $users = $App->getLoggedUsers();

            }

            else{

                $users[] = $for;

            }

        }

        

        $deleteOn = self::getDeleteOn();

        foreach ($users as $user){

            $record = $this->newRecord();

            $record->user = $user;

            $record->data = bab_json_encode($data);

            $record->type = AppSSE::TYPE_BROWSER_NOTIFICATION;

            $record->deleteOn = $deleteOn;

            $record->save();

        }

        

        return true;

    }

    

    public static function getDeleteOn()

    {

        $registry = app_getRegistry();

        $registry->changeDirectory('configuration');

        $registry->changeDirectory('SSE');

        $refreshFrequency = $registry->getValue('refreshFrequency', 3);

        return date("Y-m-d H:i:s", strtotime("+$refreshFrequency sec"));

    }

}