mshamaseen / laravel-ratchet

src/Traits/RoomUtility.php

<?php
/**
 * Created by PhpStorm.
 * User: shanmaseen
 * Date: 26/03/19
 * Time: 12:09 م
 */

namespace Shamaseen\Laravel\Ratchet\Traits;

use Shamaseen\Laravel\Ratchet\Objects\Clients\Client;
use Shamaseen\Laravel\Ratchet\Objects\Rooms\Room;

/**
 * ###### Use this trait ONLY in classes extend WebSocketController ######
 * Trait RoomUtility
 * @package Shamaseen\Laravel\Ratchet\Traits
 * @property-read $receiver
 * @property $clients
 * @property $userAuthSocketMapper
 * @property $request
 * @property $conn
 * @property $rooms
 */
trait RoomUtility
{

    function createRoom($room_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->receiver->rooms[$room_id] = new \Shamaseen\Laravel\Ratchet\Objects\Rooms\Room($room_id);

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

        return $this;
    }

    function addMember($room_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        /** @var Room $room */
        $room = $this->receiver->rooms[$room_id];
        /** @var Client $client */
        $client = $this->receiver->clients[$this->userAuthSocketMapper[\Auth::id()]];

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

        $room->addMember($client);
        array_push($client->rooms, $room_id);

        return $this;
    }

    /**
     * This function will automatically remove the room if no member still on it.
     * @param $room_id
     * @return RoomUtility

The return type RoomUtility is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    function removeMember($room_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        /** @var Room $room */
        $room = $this->receiver->rooms[$room_id];
        /** @var Client $client */
        $client = $this->receiver->clients[$this->userAuthSocketMapper[\Auth::id()]];
        $room->removeMember($client);

        unset($client->rooms[$room_id]);
        if (count($room->members) == 0) {
            unset($this->receiver->rooms[$room_id]);
        }

        return $this;
    }

    /**
     * @param int $room_id
     * @param int $user_id
     * @return bool
     */
    function hasMember($room_id, $user_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        /** @var Room $room */
        $room = $this->receiver->rooms[$room_id];
        $client = $this->clients[$this->userAuthSocketMapper[$user_id]];

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

        return $room->hasMember($client);
    }

    /**
     * @param $room_id
     * @param bool $createIfNotExist
     * @return bool|Room
     */
    function validateRoom($room_id, $createIfNotExist = false)

It is generally recommended to explicitly declare the visibility for methods.

    {
        if (!array_key_exists($room_id, $this->receiver->rooms)) {
            if ($createIfNotExist) {
                $room = $this->receiver->rooms[$room_id] = new Room($room_id);
                return $room;
            }
            $this->error($this->request, $this->conn, 'Room is not exist');

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

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

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

        }
        return true;
    }

    /**
     * @param $room_id
     * @param $message
     */
    function sendToRoom($room_id, $message)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->validateRoom($room_id);
        /** @var Room $room */
        $room = $this->rooms[$room_id];

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

        if (!$this->hasMember($room_id, \Auth::id())) {
            $this->error($this->request, $this->conn, 'You can\'t send a message to room which you are not in !');

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

        }

        foreach ($room->members as $member) {
            $this->sendToUser($member->id, $message);

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

        }
    }
}