Clean up of code pre realease commit

Author: Lawri van Buël

modules/livechat/src/LivechatWidgetHandler.php

@@ -200,6 +200,8 @@ private function setJavascriptParams($key) {
    *   Key to set the value in.
    * @param mixed $value
    *   Value to set in the key register.
+   * @return mixed
+   * @return mixed
    */
   private function buildJavaScriptArray($key, $value) {
     $ds = $this->form['#attached']['drupalSettings'][$this->getWidgetLibraryName()][$this->getWidgetLibraryRoute()][$key] = $value;

modules/rocket_chat_api/src/RocketChat/ApiClient.php

@@ -118,7 +118,7 @@ private function createClient($login = FALSE) {
       $userId = $this->config->getElement("rocket_chat_uid");
       $userToken = $this->config->getElement("rocket_chat_uit");
       $guzzleConfig = [
-        'base_uri' => $this->config->getElement('rocket_chat_url', "http://localhost:3000") . '/api/',//v1/ removed for info.
+        'base_uri' => $this->config->getElement('rocket_chat_url', "http://localhost:3000") . '/api/', // NOTE: v1/ removed for info. as its Deprecated in 1.0.0
         'allow_redirects' => FALSE,
         'timeout' => 60,
         'debug' => $this->config->isDebug(),

modules/rocket_chat_api/src/RocketChat/Collection/Channels.php

@@ -1,6 +1,7 @@
 <?php
 namespace Drupal\rocket_chat_api\RocketChat\Collection;
 
+use Drupal;
 use Drupal\rocket_chat_api\RocketChat\RocketChatStateinterface as StateInterface;
 use Drupal\rocket_chat_api\RocketChat\ApiClient;
 use Drupal\rocket_chat_api\RocketChat\Element\Channel;
@@ -33,7 +34,7 @@ class Channels implements CollectionInterface {
   public function __construct(StateInterface $state,ApiClient $apiClient) {
     $this->state = $state;
     $this->apiClient = $apiClient;
-    $this->Logger = \Drupal::logger("Rocket Chat API: Channels");
+    $this->Logger = Drupal::logger("Rocket Chat API: Channels");
 
   }
 
@@ -68,8 +69,6 @@ public function refreshCache($forceReload = FALSE){
       $found = Channel::getAllChannelsBatched($this->apiClient, $channels);
       $channelIds = [];
       foreach ($channels as $channel){
-//        $channelJson = json_encode($channel);
-        $channelIds[] = $channel['_id'];
         $this->state->set(self::CHANNEL . $channel['_id'], $channel);
       }
       $this->state->set(self::LIST,$channelIds);

modules/rocket_chat_api/src/RocketChat/Collection/Groups.php

@@ -1,5 +1,6 @@
 <?php
 namespace Drupal\rocket_chat_api\RocketChat\Collection;
+use Drupal;
 use Drupal\rocket_chat_api\RocketChat\RocketChatStateinterface as StateInterface;
 use Drupal\rocket_chat_api\RocketChat\ApiClient;
 use Drupal\rocket_chat_api\RocketChat\Element\Channel;
@@ -32,7 +33,7 @@ class Groups implements CollectionInterface {
   public function __construct(StateInterface $state,ApiClient $apiClient) {
     $this->state = $state;
     $this->apiClient = $apiClient;
-    $this->Logger = \Drupal::logger("Rocket Chat API: Groups");
+    $this->Logger = Drupal::logger("Rocket Chat API: Groups");
   }
 
   public function getCache($forceReload = FALSE){

modules/rocket_chat_api/src/RocketChat/Collection/Users.php

@@ -1,6 +1,7 @@
 <?php
 namespace Drupal\rocket_chat_api\RocketChat\Collection;
 
+use Drupal;
 use Drupal\rocket_chat_api\RocketChat\RocketChatStateinterface as StateInterface;
 use Drupal\rocket_chat_api\RocketChat\ApiClient;
 use Drupal\rocket_chat_api\RocketChat\Element\Channel;
@@ -35,11 +36,11 @@ class Users implements CollectionInterface {
   public function __construct(StateInterface $state,ApiClient $apiClient) {
     $this->state = $state;
     $this->apiClient = $apiClient;
-    $this->Logger = \Drupal::logger("Rocket Chat API: Users");
+    $this->Logger = Drupal::logger("Rocket Chat API: Users");
+    //Todo Decouple this
 
   }
 
-
   /**
    * @param bool $forceReload
    * @return array
@@ -57,7 +58,6 @@ public function getCache($forceReload = FALSE){
     return $users;
   }
 
-
   public function refreshCache($forceReload = FALSE){
     $lastUpdate = $this->state->get(self::UPDATE,0);
     $now = time();
@@ -85,6 +85,8 @@ public function refreshCache($forceReload = FALSE){
    * @param array $users
    * @param int $offset
    * @param int $size
+   * @return float|int
+   * @return float|int
    * @todo needs better Error checking / missing detection.
    */
   public static function getAllUsersBatched(ApiClient &$api, array &$users, $offset=0, $size=500){

modules/rocket_chat_api/src/RocketChat/Drupal8Config.php

@@ -9,6 +9,7 @@
    * Time: 16:38
    */
 
+  use Drupal;
   use Drupal\Core\Config\ConfigFactoryInterface;
   use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
   use Drupal\Core\Extension\ModuleHandlerInterface;
@@ -66,13 +67,14 @@ class Drupal8Config implements RocketChatConfigInterface, ContainerInjectionInte
      *   The ModuleHandler to interact with loaded modules.
      * @param \Drupal\Core\State\StateInterface $state
      *   The state interface to manipulate the States.
+     * @param \Drupal\Core\Messenger\MessengerInterface $messenger
      */
     public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $moduleHandler, StateInterface $state, MessengerInterface $messenger) {
       $this->config = $config_factory->get('rocket_chat.settings');
       $this->moduleHandler = $moduleHandler;
       $this->state = $state;
       $this->messenger = $messenger;
-      $this->Logger = \Drupal::logger("Rocket Chat API: Config");
+      $this->Logger = Drupal::logger("Rocket Chat API: Config");
     }
 
     /**

modules/rocket_chat_api/src/RocketChat/Element/Channel.php

@@ -21,13 +21,14 @@ class Channel {
   const WRITE           = 0b01000;
   const BROADCAST       = 0b10000;
 
+  //Encodes like this: [Broadcast, Writeable Readable, public Channel, privateGroup]
   //                             BWRCG
   const DEFAULT_CHANNEL_TYPE = 0b01110;
 
   /**
    * @var int Masked value indicating what type of Channel this uses;
    */
-  protected $ChannelType = NULL;//0b0111;//self::READ & self::WRITE & self::PUBLIC_CHANNEL;
+  protected $ChannelType = NULL;
   protected $ChannelName = NULL;
 
   private $ChannelMembers = [];
@@ -174,9 +175,6 @@ public function __get($name) {
    * @return bool|int
    */
   public function hasType($test){
-//    if($test === self::PRIVATE_CHANNEL){
-//      return (!$this->hasType(self::PUBLIC_CHANNEL));//Test if NOT public
-//    }
     return ($this->getChannelType() & $test) > 0;
   }
 
@@ -372,10 +370,8 @@ public function getChannelProxy(ApiClient $apiClient){
           $ChannelList = new Channels($drupal8State, $apiClient);
           //TODO needs to replaced by state cached version.
           $Channels = $ChannelList->getCache();
-//          Channel::getAllChannelsBatched($apiClient, $Channels);
           break;
         case "groups":
-          //TODO Replace with
           $GroupList = new Groups($drupal8State,$apiClient);
           $Channels = $GroupList->getCache();
           if(is_null($Channels) || empty($Channels)){
@@ -410,6 +406,8 @@ public function getChannelProxy(ApiClient $apiClient){
   /**
    * Get Channel Type (channels|groups) or (public | private type.
    * @return string
+   * @throws \Exception
+   * @throws \Exception
    */
   public function getChannelTypeName(){
     if ($this->hasType(Channel::PUBLIC_CHANNEL)) {
@@ -421,9 +419,8 @@ public function getChannelTypeName(){
       //Private Group
     }
     else {
-      //TODO report this fail state!
+      //TODO report this fial state better!
       throw new Exception("ERROR!");
-//      return NULL;
     }
     return $methodBase;
   }
@@ -463,7 +460,7 @@ private function fetchChannel(array &$Channels,ApiClient &$apiClient,bool $write
         $members[] = $myProxy['body']['username'];
       }
     }
-    $options['json']['members'] = $members;//Member names to add...
+    $options['json']['members'] = $members; //Member names to add...
 
     $ret = $apiClient->postToRocketChat("$methodBase.create", $options);
     //todo implement error check
@@ -485,7 +482,7 @@ private function fetchChannel(array &$Channels,ApiClient &$apiClient,bool $write
         $ownerJson['json']["userId"] = $myId; //Current User
         $remOwn = $apiClient->postToRocketChat("$methodBase.removeOwner", $ownerJson);
 
-        //todo implement error check
+        //todo implement better error check
       }
     } else {
       $logger = drupal::logger("Rocket Chat API");
@@ -494,10 +491,8 @@ private function fetchChannel(array &$Channels,ApiClient &$apiClient,bool $write
     }
   }
   else {
-    //TODO REplace with
     $ret = [];
     $ret['body'] = [];
-//    $ret['body'][rtrim($methodBase,"s")] = [];
     $ret['body'][rtrim($methodBase,"s")] = $this->getFromList($Channels);
     $ret2 = $apiClient->getFromRocketChat("$methodBase.info", ["query" => ["roomName" => $this->getSafeChannelName()]]);
     $ret3 = $ret;
@@ -507,8 +502,10 @@ private function fetchChannel(array &$Channels,ApiClient &$apiClient,bool $write
 
   /**
    * @param \Drupal\rocket_chat_api\RocketChat\ApiClient $apiClient
-   * @param \Drupal\rocket_chat_api\RocketChat\Element\User[] $user
+   * @param \Drupal\rocket_chat_api\RocketChat\Element\User[] $users
    *
+   * @return array
+   * @return array
    * @throws \Exception
    */
   public function addMembers(ApiClient $apiClient, $users) {
@@ -523,6 +520,8 @@ public function addMembers(ApiClient $apiClient, $users) {
    * @param \Drupal\rocket_chat_api\RocketChat\ApiClient $apiClient
    * @param \Drupal\rocket_chat_api\RocketChat\Element\User $user
    *
+   * @return bool|mixed
+   * @return bool|mixed
    * @throws \Exception
    */
   public function addMember(ApiClient $apiClient, User $user){
@@ -541,7 +540,7 @@ public function addMember(ApiClient $apiClient, User $user){
     }
     if(!$found){
       $user->getUserProxy($apiClient);
-      $method = $methodBase = $this->getChannelTypeName();//$user->getUserProxy($apiClient);
+      $method = $methodBase = $this->getChannelTypeName(); 
       $membersJson = [];
       $membersJson["json"] = [];
       $membersJson["json"]['roomId'] = $this->Channel['_id'];
@@ -550,7 +549,6 @@ public function addMember(ApiClient $apiClient, User $user){
       $this->getAllChannelMembersBatched($apiClient,$members);
 
       return $ret['body']['status'];
-//      return $ret['body']['success'];
     }
     return false;
   }
@@ -571,7 +569,7 @@ public function removeMember(ApiClient $apiClient, User $user){
     }
     if($found){
       $user->getUserProxy($apiClient);
-      $method = $methodBase = $this->getChannelTypeName();//$user->getUserProxy($apiClient);
+      $method = $methodBase = $this->getChannelTypeName();
       $membersJson = [];
       $membersJson["json"] = [];
       $membersJson["json"]['roomId'] = $this->Channel['_id'];
@@ -580,7 +578,6 @@ public function removeMember(ApiClient $apiClient, User $user){
       $this->getAllChannelMembersBatched($apiClient,$members);
 
       return $ret['body']['status'];
-      //      return $ret['body']['success'];
     }
     return false;
   }
@@ -617,12 +614,6 @@ public function getChannelURI(){
   }
 
   public function changeChannelName(ApiClient $apiClient, string $newName){
-//    $this->getChannelProxy($apiClient);
-//    $state = \Drupal::service('state');
-//    $ChannelList = new Channels(new Drupal8State($state), $apiClient);
-//    $Channels = $ChannelList->getCachedChannels();
-//    $ret = $this->fetchChannel($Channels, $apiClient, $this->hasType(Channel::WRITE), $this->getChannelTypeName());
-//
     $channelProxy = $this->getChannelProxy($apiClient);
     if(strcmp($this->getSafeChannelName(), self::toSafeChannelName($newName) !== 0)){
       $methodBase = $this->getChannelTypeName();
@@ -631,7 +622,7 @@ public function changeChannelName(ApiClient $apiClient, string $newName){
       $rename['json']['roomId'] = $this->Channel['_id'];
       $rename['json']['name'] = self::toSafeChannelName($newName);
       $ret = $apiClient->postToRocketChat($methodBase . ".rename",$rename);
-      //needs Check.
+      //TODO implement better Check.
       $this->Channel = $ret['body'][rtrim($methodBase, "s")];
       $state = Drupal::service('state');
       $ChannelList = new Channels(new Drupal8State($state), $apiClient);

modules/rocket_chat_api/src/RocketChat/Element/User.php

@@ -3,6 +3,7 @@
 namespace Drupal\rocket_chat_api\RocketChat\Element;
 
 
+use Drupal;
 use Drupal\rocket_chat_api\RocketChat\ApiClient;
 use Drupal\rocket_chat_api\RocketChat\Collection\Users;
 use Drupal\rocket_chat_api\RocketChat\RocketChatStateinterface;
@@ -94,7 +95,7 @@ public function __construct(RocketChatStateinterface $state, $username = NULL,$e
     $this->username = $username;
     $this->email = $email;
     $this->name = $name;
-    $this->Logger = \Drupal::logger("Rocket Chat API: User");
+    $this->Logger = Drupal::logger("Rocket Chat API: User");
   }
 
   /**
@@ -132,13 +133,14 @@ private function getFromList($list){
     }
     return NULL;
   }
+
   /**
    * Retrieve the Proxy, create the User if needed.
    *
    * @param \Drupal\rocket_chat_api\RocketChat\ApiClient $apiClient
    *
    * @return array|null
-   * @throws \Exception
+   * @throws Exception
    */
   public function getUserProxy(ApiClient $apiClient){
     if(empty($this->User)) {
@@ -150,9 +152,6 @@ public function getUserProxy(ApiClient $apiClient){
       }
       $usersState = new Users($this->state, $apiClient);
       $users = $usersState->getCache();
-
-//      $users = new Users($this->state, $apiClient);
-//      self::getAllUsersBatched($apiClient, $users);
       if (!$this->isInList($users)) {
         $options = [];
         $options['json'] = [];

modules/rocket_chat_group/rocket_chat_group.module

@@ -31,6 +31,7 @@ function rocket_chat_group_group_content_insert(Drupal\group\Entity\GroupContent
 //Update
 /**
  * Implements hook_ENTITY_TYPE_update().
+ * @param \Drupal\group\Entity\GroupContent $entity
  */
 function rocket_chat_group_group_content_update(Drupal\group\Entity\GroupContent $entity) {
   try {
@@ -47,6 +48,7 @@ function rocket_chat_group_group_content_update(Drupal\group\Entity\GroupContent
 //Delete
 /**
  * Implements hook_ENTITY_TYPE_delete().
+ * @param \Drupal\group\Entity\GroupContent $entity
  */
 function rocket_chat_group_group_content_delete(Drupal\group\Entity\GroupContent $entity) {
   try {
@@ -62,6 +64,11 @@ function rocket_chat_group_group_content_delete(Drupal\group\Entity\GroupContent
 
 /**
  * Implements hook_theme().
+ * @param $existing
+ * @param $type
+ * @param $theme
+ * @param $path
+ * @return \array[][]
  */
 function rocket_chat_group_theme($existing, $type, $theme, $path) {
   return moduleHelper::themeRocketChannelBLock($existing, $type, $theme, $path);