Code styles

Author: lnpbk

src/Twilio.php

@@ -26,14 +26,14 @@ class Twilio
     public function __construct(TwilioService $twilioService, TwilioConfig $config)
     {
         $this->twilioService = $twilioService;
-        $this->config = $config;
+        $this->config        = $config;
     }
 
     /**
      * Send a TwilioMessage to the a phone number.
      *
      * @param  TwilioMessage $message
-     * @param                $to
+     * @param  string        $to
      * @param bool           $useAlphanumericSender
      * @return mixed
      * @throws CouldNotSendNotification
@@ -55,7 +55,14 @@ public function sendMessage(TwilioMessage $message, $to, $useAlphanumericSender
         throw CouldNotSendNotification::invalidMessageObject($message);
     }
 
-    protected function sendSmsMessage($message, $to)
+    /**
+     * Send an sms message using the Twilio Service.
+     *
+     * @param TwilioSmsMessage $message
+     * @param string           $to
+     * @return \Twilio\Rest\Api\V2010\Account\MessageInstance
+     */
+    protected function sendSmsMessage(TwilioSmsMessage $message, $to)
     {
         $params = [
             'from' => $this->getFrom($message),
@@ -69,7 +76,14 @@ protected function sendSmsMessage($message, $to)
         return $this->twilioService->messages->create($to, $params);
     }
 
-    protected function makeCall($message, $to)
+    /**
+     * Make a call using the Twilio Service.
+     *
+     * @param TwilioCallMessage $message
+     * @param string            $to
+     * @return \Twilio\Rest\Api\V2010\Account\CallInstance
+     */
+    protected function makeCall(TwilioCallMessage $message, $to)
     {
         return $this->twilioService->calls->create(
             $to,
@@ -78,21 +92,31 @@ protected function makeCall($message, $to)
         );
     }
 
-    protected function getFrom($message)
+    /**
+     * Get the from address from message, or config.
+     *
+     * @param TwilioMessage $message
+     * @return string
+     * @throws CouldNotSendNotification
+     */
+    protected function getFrom(TwilioMessage $message)
     {
-        if (! $from = $message->getFrom() ?: $this->config->getFrom()) {
+        if ( ! $from = $message->getFrom() ?: $this->config->getFrom()) {
             throw CouldNotSendNotification::missingFrom();
         }
 
         return $from;
     }
 
+    /**
+     * Get the alphanumeric sender from config, if one exists.
+     *
+     * @return string|null
+     */
     protected function getAlphanumericSender()
     {
         if ($sender = $this->config->getAlphanumericSender()) {
             return $sender;
         }
-
-        return null;
     }
 }

src/TwilioCallMessage.php

@@ -7,8 +7,7 @@ class TwilioCallMessage extends TwilioMessage
     /**
      * Set the message url.
      *
-     * @param  string  $url
-     *
+     * @param  string $url
      * @return $this
      */
     public function url($url)

src/TwilioChannel.php

@@ -23,8 +23,8 @@ class TwilioChannel
     /**
      * TwilioChannel constructor.
      *
-     * @param Twilio  $twilio
-     * @param Dispatcher  $events
+     * @param Twilio     $twilio
+     * @param Dispatcher $events
      */
     public function __construct(Twilio $twilio, Dispatcher $events)
     {
@@ -35,23 +35,23 @@ public function __construct(Twilio $twilio, Dispatcher $events)
     /**
      * Send the given notification.
      *
-     * @param  mixed  $notifiable
-     * @param  \Illuminate\Notifications\Notification  $notification
+     * @param  mixed                                  $notifiable
+     * @param  \Illuminate\Notifications\Notification $notification
      * @return mixed
      * @throws CouldNotSendNotification
      */
     public function send($notifiable, Notification $notification)
     {
         try {
-            $to = $this->getTo($notifiable);
-            $message = $notification->toTwilio($notifiable);
+            $to        = $this->getTo($notifiable);
+            $message   = $notification->toTwilio($notifiable);
             $useSender = $this->canReceiveAlphanumericSender($notifiable);
 
             if (is_string($message)) {
                 $message = new TwilioSmsMessage($message);
             }
 
-            if (! $message instanceof TwilioMessage) {
+            if ( ! $message instanceof TwilioMessage) {
                 throw CouldNotSendNotification::invalidMessageObject($message);
             }
 
@@ -63,6 +63,13 @@ public function send($notifiable, Notification $notification)
         }
     }
 
+    /**
+     * Get the address to send a notification to.
+     *
+     * @param mixed $notifiable
+     * @return mixed
+     * @throws CouldNotSendNotification
+     */
     protected function getTo($notifiable)
     {
         if ($notifiable->routeNotificationFor('twilio')) {
@@ -76,7 +83,8 @@ protected function getTo($notifiable)
     }
 
     /**
-     * Get the alphanumeric sender
+     * Get the alphanumeric sender.
+     *
      * @param $notifiable
      * @return mixed|null
      * @throws CouldNotSendNotification

src/TwilioConfig.php

@@ -18,39 +18,57 @@ public function __construct(array $config)
         $this->config = $config;
     }
 
+    /**
+     * Get the account sid.
+     *
+     * @return string
+     */
     public function getAccountSid()
     {
         return $this->config['account_sid'];
     }
 
+    /**
+     * Get the auth token.
+     *
+     * @return string
+     */
     public function getAuthToken()
     {
         return $this->config['auth_token'];
     }
 
     /**
-     * Get the from entity from config
+     * Get the default from address.
+     *
+     * @return string
      */
     public function getFrom()
     {
         return $this->config['from'];
     }
 
+    /**
+     * Get the alphanumeric sender.
+     *
+     * @return string
+     */
     public function getAlphanumericSender()
     {
         if (isset($this->config['alphanumeric_sender'])) {
             return $this->config['alphanumeric_sender'];
         }
-
-        return null;
     }
 
+    /**
+     * Get the service sid.
+     *
+     * @return string
+     */
     public function getServiceSid()
     {
         if (isset($this->config['sms_service_sid'])) {
             return $this->config['sms_service_sid'];
         }
-
-        return null;
     }
 }

src/TwilioMessage.php

@@ -19,8 +19,8 @@ abstract class TwilioMessage
     public $from;
 
     /**
+     * Create a message object.
      * @param string $content
-     *
      * @return static
      */
     public static function create($content = '')
@@ -31,7 +31,7 @@ public static function create($content = '')
     /**
      * Create a new message instance.
      *
-     * @param  string  $content
+     * @param  string $content
      */
     public function __construct($content = '')
     {
@@ -41,8 +41,7 @@ public function __construct($content = '')
     /**
      * Set the message content.
      *
-     * @param  string  $content
-     *
+     * @param  string $content
      * @return $this
      */
     public function content($content)
@@ -55,8 +54,7 @@ public function content($content)
     /**
      * Set the phone number the message should be sent from.
      *
-     * @param  string  $from
-     *
+     * @param  string $from
      * @return $this
      */
     public function from($from)
@@ -68,6 +66,7 @@ public function from($from)
 
     /**
      * Get the from address
+     *
      * @return string
      */
     public function getFrom()

src/TwilioSmsMessage.php

@@ -10,7 +10,8 @@ class TwilioSmsMessage extends TwilioMessage
     public $alphaNumSender = null;
 
     /**
-     * Get the from address of this message
+     * Get the from address of this message.
+     *
      * @return null|string
      */
     public function getFrom()
@@ -27,7 +28,8 @@ public function getFrom()
     }
 
     /**
-     * Set the alphanumeric sender
+     * Set the alphanumeric sender.
+     *
      * @param $sender
      */
     public function sender($sender)