Replace `boolean` with `bool` in PHP documentation
authorMatthias Schmidt <gravatronics@live.com>
Tue, 19 Jan 2021 06:38:18 +0000 (07:38 +0100)
committerMatthias Schmidt <gravatronics@live.com>
Tue, 19 Jan 2021 06:38:18 +0000 (07:38 +0100)
files/lib/data/conversation/Conversation.class.php
files/lib/data/conversation/ConversationParticipantList.class.php
files/lib/data/conversation/message/ConversationMessage.class.php
files/lib/data/conversation/message/ViewableConversationMessageList.class.php
files/lib/system/conversation/ConversationHandler.class.php
files/lib/system/event/listener/UserGroupAddCanBeAddedAsConversationParticipantListener.class.php

index 2c4a6df36432e320f1b16d5b39247bf39f24387e..65e3805d6f1929149d63240f138dbc86325b80d2 100644 (file)
@@ -72,7 +72,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
 
     /**
      * true if the current user can add users without limitations
-     * @var boolean
+     * @var bool
      */
     protected $canAddUnrestricted;
 
@@ -84,7 +84,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
 
     /**
      * true if the current user is an active participant of this conversation
-     * @var boolean
+     * @var bool
      */
     protected $isActiveParticipant;
 
@@ -110,7 +110,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
     /**
      * Returns true if this conversation is new for the active user.
      *
-     * @return  boolean
+     * @return  bool
      */
     public function isNew()
     {
@@ -125,7 +125,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
      * Returns true if the active user doesn't have read the given message.
      *
      * @param ConversationMessage $message
-     * @return  boolean
+     * @return  bool
      */
     public function isNewMessage(ConversationMessage $message)
     {
@@ -139,7 +139,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
     /**
      * Returns true if the conversation is not closed or the user was not removed.
      *
-     * @return      boolean
+     * @return      bool
      */
     public function canReply()
     {
@@ -241,7 +241,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
     /**
      * Returns true if the active user has the permission to read this conversation.
      *
-     * @return  boolean
+     * @return  bool
      */
     public function canRead()
     {
@@ -263,7 +263,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
     /**
      * Returns true if the current user can add new participants to this conversation.
      *
-     * @return  boolean
+     * @return  bool
      */
     public function canAddParticipants()
     {
@@ -297,7 +297,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
     /**
      * Returns true if the current user can add participants without limitations.
      *
-     * @return      boolean
+     * @return      bool
      */
     public function canAddParticipantsUnrestricted()
     {
@@ -351,7 +351,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
     /**
      * Returns a list of the ids of all participants.
      *
-     * @param boolean $excludeLeftParticipants
+     * @param bool $excludeLeftParticipants
      * @return  int[]
      */
     public function getParticipantIDs($excludeLeftParticipants = false)
@@ -375,8 +375,8 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
     /**
      * Returns a list of the usernames of all participants.
      *
-     * @param boolean $excludeSelf
-     * @param boolean $leftByOwnChoice
+     * @param bool $excludeSelf
+     * @param bool $leftByOwnChoice
      * @return  string[]
      */
     public function getParticipantNames($excludeSelf = false, $leftByOwnChoice = false)
@@ -404,7 +404,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
     /**
      * Returns false if the active user is the last participant of this conversation.
      *
-     * @return  boolean
+     * @return  bool
      */
     public function hasOtherParticipants()
     {
@@ -446,7 +446,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
     /**
      * Returns true if the current user is an active participant of this conversation.
      *
-     * @return      boolean
+     * @return      bool
      */
     public function isActiveParticipant()
     {
@@ -482,7 +482,7 @@ class Conversation extends DatabaseObject implements IPopoverObject, IRouteContr
      *
      * @param int[] $conversationIDs
      * @param int $userID
-     * @return  boolean
+     * @return  bool
      */
     public static function isParticipant(array $conversationIDs, $userID = null)
     {
index 9c5c9b3024be57555de36f2c3f7ad9df1275110c..004c0c19bb8a8f2a570788f35889aa9568ad1999 100644 (file)
@@ -32,7 +32,7 @@ class ConversationParticipantList extends UserProfileList
      *
      * @param int $conversationID
      * @param int $userID
-     * @param boolean $isAuthor true if given user is the author of this conversation
+     * @param bool $isAuthor true if given user is the author of this conversation
      */
     public function __construct($conversationID, $userID = 0, $isAuthor = false)
     {
index 7fddaea927cc6b5908ab62188cb6f31e49e7cf7e..9fe307f5fce03c7a6668ccccb5e9dd554cc3c7c6 100644 (file)
@@ -71,7 +71,7 @@ class ConversationMessage extends DatabaseObject implements IMessage
     /**
      * Assigns and returns the embedded attachments.
      *
-     * @param boolean $ignoreCache
+     * @param bool $ignoreCache
      * @return  GroupedAttachmentList
      */
     public function getAttachments($ignoreCache = false)
@@ -152,7 +152,7 @@ class ConversationMessage extends DatabaseObject implements IMessage
     /**
      * Returns true if current user may edit this message.
      *
-     * @return  boolean
+     * @return  bool
      */
     public function canEdit()
     {
index 3b990e66fb32d411448991ac208312764d7594cb..807634482a9b608d0ca019fb8888a36593f2a9ae 100644 (file)
@@ -59,13 +59,13 @@ class ViewableConversationMessageList extends ConversationMessageList
 
     /**
      * enables/disables the loading of attachments
-     * @var boolean
+     * @var bool
      */
     protected $attachmentLoading = true;
 
     /**
      * enables/disables the loading of embedded objects
-     * @var boolean
+     * @var bool
      */
     protected $embeddedObjectLoading = true;
 
@@ -173,7 +173,7 @@ class ViewableConversationMessageList extends ConversationMessageList
     /**
      * Enables/disables the loading of attachments.
      *
-     * @param boolean $enable
+     * @param bool $enable
      */
     public function enableAttachmentLoading($enable = true)
     {
@@ -183,7 +183,7 @@ class ViewableConversationMessageList extends ConversationMessageList
     /**
      * Enables/disables the loading of embedded objects.
      *
-     * @param boolean $enable
+     * @param bool $enable
      */
     public function enableEmbeddedObjectLoading($enable = true)
     {
index a3b8eb5b55e1627cf1a1a898d9721dcbf4d50f68..555f11764bf9195353337ab5fa0b521d87c6f735 100644 (file)
@@ -36,7 +36,7 @@ class ConversationHandler extends SingletonFactory
      * Returns the number of unread conversations for given user.
      *
      * @param int $userID
-     * @param boolean $skipCache
+     * @param bool $skipCache
      * @return  int
      */
     public function getUnreadConversationCount($userID = null, $skipCache = false)
index 6def4804c1c42a41178bfb1e7adf09ae7607889a..09594f1d31eca6d4e40d42f821619e1b958ba013 100644 (file)
@@ -25,7 +25,7 @@ class UserGroupAddCanBeAddedAsConversationParticipantListener implements IParame
 
     /**
      * true if group can be added as participant
-     * @var boolean
+     * @var bool
      */
     protected $canBeAddedAsConversationParticipant = 0;