Merge pull request #311 from bowphp/refactor/code-base

code formatting

Author: papac

composer.json

@@ -16,7 +16,8 @@
         "fakerphp/faker": "^1.20",
         "neitanod/forceutf8": "^2.0",
         "ramsey/uuid": "^4.7",
-        "ext-ftp": "*"
+        "ext-ftp": "*",
+        "ext-openssl": "*"
     },
     "require-dev": {
         "pda/pheanstalk": "^5.0",

src/Auth/README.md

@@ -8,7 +8,7 @@ use Bow\Http\Exception\UnauthorizedException;
 
 $auth = auth();
 
-$logged = $auth->attemps(["username" => "name@example.com", "password" => "password"]);
+$logged = $auth->attempts(["username" => "name@example.com", "password" => "password"]);
 
 if (!$logged) {
     throw new UnauthorizedException("Access denied");

src/Notification/CanSendNotification.php

@@ -4,7 +4,13 @@
 
 trait CanSendNotification
 {
-    public function sendNotification(Notification $notification)
+    /**
+     * Send notification from authenticate user
+     *
+     * @param Notification $notification
+     * @return void
+     */
+    public function sendNotification(Notification $notification): void
     {
         $notification->process($this);
     }

src/Notification/Channel/ChannelInterface.php

@@ -10,5 +10,5 @@ interface ChannelInterface
      * @param mixed $message
      * @return void
      */
-    public function send(mixed $message);
+    public function send(mixed $message): void;
 }

src/Notification/Channel/DatabaseChannel.php

@@ -12,7 +12,7 @@ class DatabaseChannel implements ChannelInterface
      * @param mixed $message
      * @return void
      */
-    public function send(mixed $message)
+    public function send(mixed $message): void
     {
     }
 }

src/Notification/Channel/MailChannel.php

@@ -4,7 +4,6 @@
 
 use Bow\Mail\Mail;
 use Bow\Mail\Message;
-use Bow\Notification\Channel\ChannelInterface;
 
 class MailChannel implements ChannelInterface
 {
@@ -14,7 +13,7 @@ class MailChannel implements ChannelInterface
      * @param mixed $message
      * @return void
      */
-    public function send(mixed $message)
+    public function send(mixed $message): void
     {
         if ($message instanceof Message) {
             Mail::getInstance()->send($message);

src/Notification/Notification.php

@@ -22,28 +22,26 @@ abstract class Notification
     /**
      * Returns the available channels to be used
      *
-     * @param \Bow\Database\Barry\Model $notifiable
+     * @param Model $notifiable
      * @return array
      */
     abstract public function channels(Model $notifiable): array;
 
     /**
      * Send notification to mail
      *
-     * @param \Bow\Database\Barry\Model $notifiable
-     * @return mixed
+     * @param Model $notifiable
+     * @return Message|null
      */
     public function toMail(Model $notifiable): ?Message
     {
-        $message = new Message();
-
-        return $message;
+        return new Message();
     }
 
     /**
      * Send notification to database
      *
-     * @param \Bow\Database\Barry\Model $notifiable
+     * @param Model $notifiable
      * @return array
      */
     public function toDatabase(Model $notifiable): array
@@ -53,10 +51,10 @@ public function toDatabase(Model $notifiable): array
 
     /**
      * Process the notification
-     * @param \Bow\Database\Barry\Model $notifiable
+     * @param Model $notifiable
      * @return void
      */
-    final function process(Model $notifiable)
+    final function process(Model $notifiable): void
     {
         $channels = $this->channels($notifiable);
 

src/Queue/Adapters/BeanstalkdAdapter.php

@@ -134,6 +134,7 @@ public function run(string $queue = null): void
             } else {
                 $this->pheanstalk->release($job, $this->getPriority($producer->getPriority()), $producer->getDelay());
             }
+
             $this->sleep(1);
         }
     }

src/Queue/Adapters/SQSAdapter.php

@@ -99,10 +99,12 @@ public function size(string $queue): int
      *
      * @param ?string $queue
      * @return void
+     * @throws \ErrorException
      */
     public function run(?string $queue = null): void
     {
         $this->sleep($this->sleep ?? 5);
+        $message = null;
 
         try {
             $result = $this->sqs->receiveMessage([
@@ -130,31 +132,31 @@ public function run(?string $queue = null): void
             error_log($e->getMessage());
             app('logger')->error($e->getMessage(), $e->getTrace());
 
-            if (isset($message)) {
-                cache(
-                    "job:failed:" . $message["ReceiptHandle"],
-                    $message["Body"]
-                );
+            if (!$message) {
+                $this->sleep(1);
+                return;
             }
 
+            cache("job:failed:" . $message["ReceiptHandle"], $message["Body"]);
+
             // Check if producer has been loaded
             if (!isset($producer)) {
                 $this->sleep(1);
                 return;
             }
 
             // Execute the onException method for notify the producer
-            // and let developper to decide if the job should be delete
+            // and let developer decide if the job should be deleted
             $producer->onException($e);
 
-            // Check if the job should be delete
+            // Check if the job should be deleted
             if ($producer->jobShouldBeDelete()) {
-                $result = $this->sqs->deleteMessage([
+                $this->sqs->deleteMessage([
                     'QueueUrl' => $this->config["url"],
                     'ReceiptHandle' => $message['ReceiptHandle']
                 ]);
             } else {
-                $result = $this->sqs->changeMessageVisibilityBatch([
+                $this->sqs->changeMessageVisibilityBatch([
                     'QueueUrl' => $this->config["url"],
                     'Entries' => [
                         'Id' => $producer->getId(),
@@ -163,6 +165,7 @@ public function run(?string $queue = null): void
                     ],
                 ]);
             }
+
             $this->sleep(1);
         }
     }

src/Queue/Connection.php

@@ -30,7 +30,7 @@ class Connection
     /**
      * The supported connection
      *
-     * @param array
+     * @var array
      */
     private static array $connections = [
         "beanstalkd" => BeanstalkdAdapter::class,
@@ -50,11 +50,12 @@ public function __construct(array $config)
     }
 
     /**
-     * Push the new connection support in connectors managment
+     * Push the new connection support in connectors management
      *
      * @param string $name
-     * @param string $name
+     * @param string $classname
      * @return bool
+     * @throws ErrorException
      */
     public static function pushConnection(string $name, string $classname): bool
     {