Refactoring With Contracts

vluzrmos · May 9, 2015 · 3700207 · 3700207
1 parent bad9ec7
commit 3700207
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 6 deletions.
diff --git a/src/Vluzrmos/Socketio/Broadcast.php b/src/Vluzrmos/Socketio/Broadcast.php
@@ -3,7 +3,7 @@
 namespace Vluzrmos\Socketio;
 use Illuminate\Contracts\Redis\Database as Redis;
 
-class Broadcast {
+class Broadcast implements Contracts\Broadcast{
 
     /**
      * @var \Redis;
@@ -18,10 +18,11 @@ public function __construct(Redis $redis){
     }
 
     /**
-     * @param $channel
-     * @param $event
-     * @param $message
-     * @return int
+     * Publish a message to a channel
+     * @param String $channel Channel name
+     * @param String $event Event name
+     * @param String|Array|Serializable $message the message
+     * @return mixed
      */
     public function publish($channel, $event, $message){
         return $this->redis->publish($channel, json_encode([

diff --git a/src/Vluzrmos/Socketio/Contracts/Broadcast.php b/src/Vluzrmos/Socketio/Contracts/Broadcast.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Vluzrmos\Socketio\Contracts;
+
+interface Broadcast{
+
+    /**
+     * Publish a message to a channel
+     * @param String $channel Channel name
+     * @param String $event Event name
+     * @param String|Array|Serializable $message the message
+     * @return mixed
+     */
+    public function publish($channel, $event, $message);
+}
diff --git a/src/Vluzrmos/Socketio/helpers.php b/src/Vluzrmos/Socketio/helpers.php
@@ -3,7 +3,7 @@
 if(!function_exists('publish')){
 
     /**
-     * Publish something to a channel
+     * Publish a message to a channel
      * @param String $channel Channel name
      * @param String $event Event name
      * @param String|Array|Serializable $message the message