Fix casing of bool||NULL types in function definitions

modules/sms_user/src/AccountRegistration.php

@@ -355,7 +355,7 @@ protected function generateUniqueUsername() {
    *
    * @param \Drupal\Core\Entity\EntityConstraintViolationListInterface $violations
    *   A violation list.
-   * @param string|NULL $incoming_form
+   * @param string|null $incoming_form
    *   Incoming form, if applicable.
    *
    * @return \Drupal\Core\Entity\EntityConstraintViolationListInterface
@@ -382,7 +382,7 @@ protected function removeAcceptableViolations(EntityConstraintViolationListInter
    * @param string $name
    *   The configuration name.
    *
-   * @return array|NULL
+   * @return array|null
    *   The values for the requested configuration.
    */
   protected function settings($name) {

modules/sms_user/src/ActiveHoursInterface.php

@@ -32,7 +32,7 @@ public function inHours(UserInterface $user, $now = 'now');
    *   A time or strtotime() relative string localised to the users timezone.
    *   Defaults to current time for the user.
    *
-   * @return \Drupal\sms_user\ActiveHoursDates|FALSE
+   * @return \Drupal\sms_user\ActiveHoursDates|false
    *   A date pair, or FALSE if no next date could be determined.
    */
   public function findNextTime(UserInterface $user, $now = 'now');

modules/sms_user/tests/src/Kernel/SmsFrameworkUserAccountRegistrationServiceTest.php

@@ -545,7 +545,7 @@ protected function countUsers() {
   /**
    * Count number of registered users.
    *
-   * @return \Drupal\user\UserInterface|NULL
+   * @return \Drupal\user\UserInterface|null
    *   Get last created user, or NULL if no users in database.
    */
   protected function getLastUser() {

src/Entity/PhoneNumberSettingsInterface.php

@@ -116,7 +116,7 @@ public function setPurgeVerificationPhoneNumber($purge);
    * @param string $map
    *   ID to map field name, as found in sms.phone.*.*.fields.$map.
    *
-   * @return string|NULL
+   * @return string|null
    *   A field name, or NULL if not set.
    */
   public function getFieldName($map);
@@ -126,7 +126,7 @@ public function getFieldName($map);
    *
    * @param string $map
    *   ID to map field name, as found in sms.phone.*.*.fields.$map.
-   * @param string|NULL $field_name
+   * @param string|null $field_name
    *   A field name, or NULL to unset.
    *
    * @return $this

src/Entity/PhoneNumberVerificationInterface.php

@@ -21,7 +21,7 @@ public function getCreatedTime();
   /**
    * Gets the entity for the phone number verification.
    *
-   * @return \Drupal\Core\Entity\EntityInterface|NULL
+   * @return \Drupal\Core\Entity\EntityInterface|null
    *   The entity for the phone number verification, or NULL if it is missing.
    */
   public function getEntity();

src/Entity/SmsMessage.php

@@ -167,7 +167,7 @@ public function getSender() {
   /**
    * {@inheritdoc}
    *
-   * @param string|NULL $sender
+   * @param string|null $sender
    *   The name of the sender. Or NULL to defer to the label of the sender
    *   entity.
    *

src/Entity/SmsMessageInterface.php

@@ -14,7 +14,7 @@ interface SmsMessageInterface extends ContentEntityInterface, PlainSmsMessageInt
   /**
    * Gets the entity who sent the SMS message.
    *
-   * @return \Drupal\Core\Entity\EntityInterface|NULL
+   * @return \Drupal\Core\Entity\EntityInterface|null
    *   The entity who sent the SMS message, or NULL if it is missing.
    */
   public function getSenderEntity();
@@ -33,7 +33,7 @@ public function setSenderEntity(EntityInterface $entity);
   /**
    * Gets the entity who will receive the SMS message.
    *
-   * @return \Drupal\Core\Entity\EntityInterface|NULL
+   * @return \Drupal\Core\Entity\EntityInterface|null
    *   The entity who will receive the SMS message, or NULL if it is missing.
    */
   public function getRecipientEntity();
@@ -101,7 +101,7 @@ public function setSendTime($send_time);
    * This value does not indicate whether the message was sent, only that the
    * gateway accepted the request.
    *
-   * @return int|NULL
+   * @return int|null
    *   The timestamp when SMS message was processed, or NULL if not processed.
    */
   public function getProcessedTime();

src/Event/RecipientGatewayEvent.php

@@ -119,7 +119,7 @@ public function addGateway(SmsGatewayInterface $gateway, $priority = 0) {
    *
    * @param string $gateway_id
    *   A gateway plugin ID.
-   * @param int|NULL $priority
+   * @param int|null $priority
    *   The priority of the gateway to remove, or NULL to remove all gateways
    *   with the identifier.
    *

src/EventSubscriber/SmsMessageProcessor.php

@@ -215,7 +215,7 @@ public function ensureGateways(SmsMessageEvent $event) {
    * @param string $recipient
    *   A recipient phone number.
    *
-   * @return \Drupal\sms\Entity\SmsGatewayInterface|NULL
+   * @return \Drupal\sms\Entity\SmsGatewayInterface|null
    *   A gateway for the phone number, or NULL if there is no gateway.
    */
   protected function getGatewayForPhoneNumber($recipient) {

src/Message/SmsDeliveryReportInterface.php

@@ -10,7 +10,7 @@ interface SmsDeliveryReportInterface {
   /**
    * Gets the gateway tracking ID for the message.
    *
-   * @return string|NULL
+   * @return string|null
    *   The gateway tracking ID for the message, or NULL if there is no tracking
    *   ID.
    */
@@ -19,7 +19,7 @@ public function getMessageId();
   /**
    * Sets the gateway tracking ID for the message.
    *
-   * @param string|NULL $message_id
+   * @param string|null $message_id
    *   The gateway tracking ID for the message, or NULL if there is no tracking
    *   ID.
    *
@@ -50,7 +50,7 @@ public function setRecipient($recipient);
   /**
    * Gets the status of the message.
    *
-   * @return string|NULL
+   * @return string|null
    *   A status code from \Drupal\sms\Message\SmsMessageReportStatus, or NULL if
    *   unknown.
    */
@@ -59,7 +59,7 @@ public function getStatus();
   /**
    * Sets the status of the message.
    *
-   * @param string|NULL $status
+   * @param string|null $status
    *   A status code from \Drupal\sms\Message\SmsMessageReportStatus, or NULL if
    *   unknown.
    *
@@ -90,15 +90,15 @@ public function setStatusMessage($message);
   /**
    * Gets the time the message was queued.
    *
-   * @return int|NULL
+   * @return int|null
    *   The timestamp when the message was queued, or NULL if unknown.
    */
   public function getTimeQueued();
 
   /**
    * Sets the time the message was queued.
    *
-   * @param int|NULL $time
+   * @param int|null $time
    *   The timestamp when the message was queued, or NULL if unknown.
    *
    * @return $this
@@ -109,7 +109,7 @@ public function setTimeQueued($time);
   /**
    * Gets the time the message was delivered to the recipient.
    *
-   * @return int|NULL
+   * @return int|null
    *   The timestamp when the message was delivered to the recipient, or NULL if
    *   unknown.
    */
@@ -118,7 +118,7 @@ public function getTimeDelivered();
   /**
    * Sets the time the message was delivered to the recipient.
    *
-   * @param int|NULL $time
+   * @param int|null $time
    *   The timestamp when the message was delivered to the recipient, or NULL if
    *   unknown.
    *

src/Message/SmsMessageInterface.php

@@ -64,7 +64,7 @@ public function removeRecipients(array $recipients);
   /**
    * Get the gateway for this message.
    *
-   * @return \Drupal\sms\Entity\SmsGatewayInterface|NULL
+   * @return \Drupal\sms\Entity\SmsGatewayInterface|null
    *   A gateway plugin instance, or NULL to let the provider decide.
    */
   public function getGateway();
@@ -145,7 +145,7 @@ public function removeOption($name);
   /**
    * Get the result associated with this SMS message.
    *
-   * @return \Drupal\sms\Message\SmsMessageResultInterface|NULL
+   * @return \Drupal\sms\Message\SmsMessageResultInterface|null
    *   The result associated with this SMS message, or NULL if there is no
    *   result.
    */
@@ -154,7 +154,7 @@ public function getResult();
   /**
    * Set the result associated with this SMS message.
    *
-   * @param \Drupal\sms\Message\SmsMessageResultInterface|NULL $result
+   * @param \Drupal\sms\Message\SmsMessageResultInterface|null $result
    *   The result to associate with this SMS message, or NULL if there is no
    *   result.
    *
@@ -166,15 +166,15 @@ public function setResult(SmsMessageResultInterface $result = NULL);
   /**
    * Gets the name of the sender of this SMS message.
    *
-   * @return string|NULL
+   * @return string|null
    *   The name of the sender, or NULL if none is defined.
    */
   public function getSender();
 
   /**
    * Set the name of the sender of this SMS message.
    *
-   * @param string|NULL $sender
+   * @param string|null $sender
    *   The name of the sender.
    *
    * @return $this
@@ -231,7 +231,7 @@ public function getUuid();
   /**
    * Gets the user who created the SMS message.
    *
-   * @return int|NULL
+   * @return int|null
    *   The ID of the user who created the message. Or NULL if no user entity is
    *   associated as the sender.
    */

src/Message/SmsMessageResultInterface.php

@@ -10,7 +10,7 @@ interface SmsMessageResultInterface {
   /**
    * Gets the error of the message.
    *
-   * @return string|NULL
+   * @return string|null
    *   A error code from \Drupal\sms\Message\SmsMessageResultError, or NULL if
    *   there was no error.
    */
@@ -22,7 +22,7 @@ public function getError();
    * Usually a setting an error on a result indicates something went wrong with
    * the entire transaction.
    *
-   * @param string|NULL $error
+   * @param string|null $error
    *   A error code from \Drupal\sms\Message\SmsMessageResultError, or NULL if
    *   unknown.
    *
@@ -56,7 +56,7 @@ public function setErrorMessage($message);
    * @param string $recipient
    *   The number of the recipient for which the report is to be retrieved.
    *
-   * @return \Drupal\sms\Message\SmsDeliveryReportInterface|NULL
+   * @return \Drupal\sms\Message\SmsDeliveryReportInterface|null
    *   A delivery report object, or NULL if there is no report for the
    *   recipient.
    *
@@ -97,15 +97,15 @@ public function addReport(SmsDeliveryReportInterface $report);
   /**
    * Gets the credit balance after this transaction.
    *
-   * @return float|NULL
+   * @return float|null
    *   The credit balance after the message is processed, or NULL if unknown.
    */
   public function getCreditsBalance();
 
   /**
    * Sets the credit balance after this transaction.
    *
-   * @param float|NULL $balance
+   * @param float|null $balance
    *   The credit balance after the message is processed, or NULL if unknown.
    *
    * @return $this
@@ -119,15 +119,15 @@ public function setCreditsBalance($balance);
   /**
    * Gets the credits consumed for this transaction.
    *
-   * @return float|NULL
+   * @return float|null
    *   The credits consumed for this transaction, or NULL if unknown.
    */
   public function getCreditsUsed();
 
   /**
    * Sets the credits consumed for this transaction.
    *
-   * @param float|NULL $credits_used
+   * @param float|null $credits_used
    *   The credits consumed for this transaction, or NULL if unknown.
    *
    * @return $this

src/Plugin/SmsGatewayPluginInterface.php

@@ -31,7 +31,7 @@ public function send(SmsMessageInterface $sms);
    * The 'credit_balance_available' plugin annotation should be set to inform
    * the framework whether this gateway supports balance queries.
    *
-   * @return float|NULL
+   * @return float|null
    *   The credit balance of the gateway, or NULL if unknown.
    */
   public function getCreditsBalance();
@@ -56,7 +56,7 @@ public function parseDeliveryReports(Request $request, Response $response);
   /**
    * Gets delivery reports from the gateway.
    *
-   * @param string[]|NULL $message_ids
+   * @param string[]|null $message_ids
    *   A list of specific message ID's to pull, or NULL to get any reports which
    *   have not been requested previously.
    *

src/Provider/PhoneNumberProviderInterface.php

@@ -15,7 +15,7 @@ interface PhoneNumberProviderInterface {
    *
    * @param \Drupal\Core\Entity\EntityInterface $entity
    *   An entity to get phone numbers.
-   * @param bool|NULL $verified
+   * @param bool|null $verified
    *   Whether the returned phone numbers must be verified, or NULL to get all
    *   phone numbers regardless of status.
    *
@@ -35,7 +35,7 @@ public function getPhoneNumbers(EntityInterface $entity, $verified = TRUE);
    * @param \Drupal\sms\Message\SmsMessageInterface $sms_message
    *   The SMS message to send to the entity.
    *
-   * @return \Drupal\sms\Message\SmsMessageResultInterface|FALSE
+   * @return \Drupal\sms\Message\SmsMessageResultInterface|false
    *   The message result from the gateway.
    *
    * @throws \Drupal\sms\Exception\NoPhoneNumberException

src/Provider/PhoneNumberVerificationInterface.php

@@ -18,7 +18,7 @@ interface PhoneNumberVerificationInterface {
    * @param string $bundle
    *   An entity bundle.
    *
-   * @return \Drupal\sms\Entity\PhoneNumberSettingsInterface|NULL
+   * @return \Drupal\sms\Entity\PhoneNumberSettingsInterface|null
    *   A phone number settings entity, or NULL if it does not exist.
    */
   public function getPhoneNumberSettings($entity_type_id, $bundle);
@@ -29,7 +29,7 @@ public function getPhoneNumberSettings($entity_type_id, $bundle);
    * @param \Drupal\Core\Entity\EntityInterface $entity
    *   The entity to get settings.
    *
-   * @return \Drupal\sms\Entity\PhoneNumberSettingsInterface|NULL
+   * @return \Drupal\sms\Entity\PhoneNumberSettingsInterface|null
    *   A phone number settings entity, or NULL if it does not exist.
    *
    * @throws \Drupal\sms\Exception\PhoneNumberSettingsException
@@ -43,7 +43,7 @@ public function getPhoneNumberSettingsForEntity(EntityInterface $entity);
    * @param string $code
    *   A string to check is a verification code.
    *
-   * @return \Drupal\sms\Entity\PhoneNumberVerificationInterface|FALSE
+   * @return \Drupal\sms\Entity\PhoneNumberVerificationInterface|false
    *   A phone number verification entity, or FALSE if $code is not a valid
    *   verification code.
    */
@@ -59,7 +59,7 @@ public function getPhoneVerificationByCode($code);
    *
    * @param string $phone_number
    *   A phone number.
-   * @param bool|NULL $verified
+   * @param bool|null $verified
    *   Whether the returned phone numbers must be verified, or NULL to get all
    *   regardless of status.
    * @param string $entity_type
@@ -78,7 +78,7 @@ public function getPhoneVerificationByPhoneNumber($phone_number, $verified = TRU
    * @param string $phone_number
    *   A phone number.
    *
-   * @return \Drupal\sms\Entity\PhoneNumberVerificationInterface|NULL
+   * @return \Drupal\sms\Entity\PhoneNumberVerificationInterface|null
    *   The phone number verification for an entity and phone number pair.
    */
   public function getPhoneVerificationByEntity(EntityInterface $entity, $phone_number);
@@ -94,7 +94,7 @@ public function getPhoneVerificationByEntity(EntityInterface $entity, $phone_num
    * @param string $phone_number
    *   A phone number.
    *
-   * @return \Drupal\sms\Entity\PhoneNumberVerificationInterface|NULL
+   * @return \Drupal\sms\Entity\PhoneNumberVerificationInterface|null
    *   A phone number verification.
    */
   public function newPhoneVerification(EntityInterface $entity, $phone_number);