Skip to content
This repository was archived by the owner on Nov 27, 2023. It is now read-only.

Commit 91f164f

Browse files
julienbornsteinjulienbornstein
committed
add some missing null types in phpdoc
- In ServiceBusRestProxy, fix phpdoc @return : receiveMessage() receiveQueueMessage() and receiveSubscriptionMessage() can return null - In BrokerProperties, by default, when initiate an instance of the class, all properties are unset, so they are null. Fixing Phpdoc for properties, getters and setters
1 parent dc63350 commit 91f164f

File tree

2 files changed

+48
-48
lines changed

2 files changed

+48
-48
lines changed

‎src/ServiceBus/Models/BrokerProperties.php‎

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -45,105 +45,105 @@ class BrokerProperties
4545
/**
4646
* The correlation ID.
4747
*
48-
* @var string
48+
* @var string|null
4949
*/
5050
private $_correlationId;
5151

5252
/**
5353
* The session ID.
5454
*
55-
* @var string
55+
* @var string|null
5656
*/
5757
private $_sessionId;
5858

5959
/**
6060
* The delivery count.
6161
*
62-
* @var int
62+
* @var int|null
6363
*/
6464
private $_deliveryCount;
6565

6666
/**
6767
* The locked until time.
6868
*
69-
* @var \DateTime
69+
* @var \DateTime|null
7070
*/
7171
private $_lockedUntilUtc;
7272

7373
/**
7474
* The lock token.
7575
*
76-
* @var string
76+
* @var string|null
7777
*/
7878
private $_lockToken;
7979

8080
/**
8181
* The message Id.
8282
*
83-
* @var string
83+
* @var string|null
8484
*/
8585
private $_messageId;
8686

8787
/**
8888
* The label.
8989
*
90-
* @var string
90+
* @var string|null
9191
*/
9292
private $_label;
9393

9494
/**
9595
* The reply to.
9696
*
97-
* @var string
97+
* @var string|null
9898
*/
9999
private $_replyTo;
100100

101101
/**
102102
* The sequence number.
103103
*
104-
* @var string
104+
* @var string|null
105105
*/
106106
private $_sequenceNumber;
107107

108108
/**
109109
* The time to live.
110110
*
111-
* @var float
111+
* @var float|null
112112
*/
113113
private $_timeToLive;
114114

115115
/**
116116
* The to.
117117
*
118-
* @var string
118+
* @var string|null
119119
*/
120120
private $_to;
121121

122122
/**
123123
* The scheduled enqueue time.
124124
*
125-
* @var \DateTime
125+
* @var \DateTime|null
126126
*/
127127
private $_scheduledEnqueueTimeUtc;
128128

129129
/**
130130
* The reply to session ID.
131131
*
132-
* @var string
132+
* @var string|null
133133
*/
134134
private $_replyToSessionId;
135135

136136
/**
137137
* The location of the message.
138138
*
139-
* @var string
139+
* @var string|null
140140
*/
141141
private $_messageLocation;
142142

143143
/**
144144
* The location of the lock.
145145
*
146-
* @var string
146+
* @var string|null
147147
*/
148148
private $_lockLocation;
149149

@@ -274,7 +274,7 @@ public static function create($brokerPropertiesJson)
274274
/**
275275
* Gets the correlation ID.
276276
*
277-
* @return string
277+
* @return string|null
278278
*/
279279
public function getCorrelationId()
280280
{
@@ -284,7 +284,7 @@ public function getCorrelationId()
284284
/**
285285
* Sets the correlation ID.
286286
*
287-
* @param string $correlationId The correlation ID
287+
* @param string|null $correlationId The correlation ID
288288
*/
289289
public function setCorrelationId($correlationId)
290290
{
@@ -294,7 +294,7 @@ public function setCorrelationId($correlationId)
294294
/**
295295
* Gets the session ID.
296296
*
297-
* @return string
297+
* @return string|null
298298
*/
299299
public function getSessionId()
300300
{
@@ -304,7 +304,7 @@ public function getSessionId()
304304
/**
305305
* Sets the session ID.
306306
*
307-
* @param string $sessionId The ID of the session
307+
* @param string|null $sessionId The ID of the session
308308
*/
309309
public function setSessionId($sessionId)
310310
{
@@ -314,7 +314,7 @@ public function setSessionId($sessionId)
314314
/**
315315
* Gets the delivery count.
316316
*
317-
* @return int
317+
* @return int|null
318318
*/
319319
public function getDeliveryCount()
320320
{
@@ -324,7 +324,7 @@ public function getDeliveryCount()
324324
/**
325325
* Sets the delivery count.
326326
*
327-
* @param int $deliveryCount The count of the delivery
327+
* @param int|null $deliveryCount The count of the delivery
328328
*/
329329
public function setDeliveryCount($deliveryCount)
330330
{
@@ -334,7 +334,7 @@ public function setDeliveryCount($deliveryCount)
334334
/**
335335
* Gets the locked until time.
336336
*
337-
* @return \DateTime
337+
* @return \DateTime|null
338338
*/
339339
public function getLockedUntilUtc()
340340
{
@@ -344,7 +344,7 @@ public function getLockedUntilUtc()
344344
/**
345345
* Sets the locked until time.
346346
*
347-
* @param \DateTime $lockedUntilUtc The locked until time
347+
* @param \DateTime|null $lockedUntilUtc The locked until time
348348
*/
349349
public function setLockedUntilUtc(\DateTime $lockedUntilUtc)
350350
{
@@ -354,7 +354,7 @@ public function setLockedUntilUtc(\DateTime $lockedUntilUtc)
354354
/**
355355
* Gets lock token.
356356
*
357-
* @return string
357+
* @return string|null
358358
*/
359359
public function getLockToken()
360360
{
@@ -364,7 +364,7 @@ public function getLockToken()
364364
/**
365365
* Sets the lock token.
366366
*
367-
* @param string $lockToken The lock token
367+
* @param string|null $lockToken The lock token
368368
*/
369369
public function setLockToken($lockToken)
370370
{
@@ -374,7 +374,7 @@ public function setLockToken($lockToken)
374374
/**
375375
* Gets the message ID.
376376
*
377-
* @return string
377+
* @return string|null
378378
*/
379379
public function getMessageId()
380380
{
@@ -384,7 +384,7 @@ public function getMessageId()
384384
/**
385385
* Sets the message ID.
386386
*
387-
* @param string $messageId The ID of the message
387+
* @param string|null $messageId The ID of the message
388388
*/
389389
public function setMessageId($messageId)
390390
{
@@ -394,7 +394,7 @@ public function setMessageId($messageId)
394394
/**
395395
* Gets the label.
396396
*
397-
* @return string
397+
* @return string|null
398398
*/
399399
public function getLabel()
400400
{
@@ -404,7 +404,7 @@ public function getLabel()
404404
/**
405405
* Sets the label.
406406
*
407-
* @param string $label The label of the broker property
407+
* @param string|null $label The label of the broker property
408408
*/
409409
public function setLabel($label)
410410
{
@@ -414,7 +414,7 @@ public function setLabel($label)
414414
/**
415415
* Gets the reply to.
416416
*
417-
* @return string
417+
* @return string|null
418418
*/
419419
public function getReplyTo()
420420
{
@@ -424,7 +424,7 @@ public function getReplyTo()
424424
/**
425425
* Sets the reply to.
426426
*
427-
* @param string $replyTo The reply to
427+
* @param string|null $replyTo The reply to
428428
*/
429429
public function setReplyTo($replyTo)
430430
{
@@ -434,7 +434,7 @@ public function setReplyTo($replyTo)
434434
/**
435435
* Gets the sequence number.
436436
*
437-
* @return int
437+
* @return int|null
438438
*/
439439
public function getSequenceNumber()
440440
{
@@ -444,7 +444,7 @@ public function getSequenceNumber()
444444
/**
445445
* Sets the sequence number.
446446
*
447-
* @param int $sequenceNumber The sequence number
447+
* @param int|null $sequenceNumber The sequence number
448448
*/
449449
public function setSequenceNumber($sequenceNumber)
450450
{
@@ -454,7 +454,7 @@ public function setSequenceNumber($sequenceNumber)
454454
/**
455455
* Gets time to live.
456456
*
457-
* @return string
457+
* @return string|null
458458
*/
459459
public function getTimeToLive()
460460
{
@@ -464,7 +464,7 @@ public function getTimeToLive()
464464
/**
465465
* Sets time to live.
466466
*
467-
* @param string $timeToLive The time to live
467+
* @param string|null $timeToLive The time to live
468468
*/
469469
public function setTimeToLive($timeToLive)
470470
{
@@ -474,7 +474,7 @@ public function setTimeToLive($timeToLive)
474474
/**
475475
* Gets to.
476476
*
477-
* @return string
477+
* @return string|null
478478
*/
479479
public function getTo()
480480
{
@@ -484,7 +484,7 @@ public function getTo()
484484
/**
485485
* Sets to.
486486
*
487-
* @param string $to To
487+
* @param string|null $to To
488488
*/
489489
public function setTo($to)
490490
{
@@ -494,7 +494,7 @@ public function setTo($to)
494494
/**
495495
* Gets scheduled enqueue time UTC.
496496
*
497-
* @return \DateTime
497+
* @return \DateTime|null
498498
*/
499499
public function getScheduledEnqueueTimeUtc()
500500
{
@@ -504,7 +504,7 @@ public function getScheduledEnqueueTimeUtc()
504504
/**
505505
* Sets scheduled enqueue time UTC.
506506
*
507-
* @param \DateTime $scheduledEnqueueTimeUtc The scheduled enqueue time
507+
* @param \DateTime|null $scheduledEnqueueTimeUtc The scheduled enqueue time
508508
*/
509509
public function setScheduledEnqueueTimeUtc(\DateTime $scheduledEnqueueTimeUtc)
510510
{
@@ -514,7 +514,7 @@ public function setScheduledEnqueueTimeUtc(\DateTime $scheduledEnqueueTimeUtc)
514514
/**
515515
* Gets reply to session ID.
516516
*
517-
* @return string
517+
* @return string|null
518518
*/
519519
public function getReplyToSessionId()
520520
{
@@ -524,7 +524,7 @@ public function getReplyToSessionId()
524524
/**
525525
* Sets reply to session.
526526
*
527-
* @param string $replyToSessionId reply to session
527+
* @param string|null $replyToSessionId reply to session
528528
*/
529529
public function setReplyToSessionId($replyToSessionId)
530530
{
@@ -534,7 +534,7 @@ public function setReplyToSessionId($replyToSessionId)
534534
/**
535535
* Gets message location.
536536
*
537-
* @return string
537+
* @return string|null
538538
*/
539539
public function getMessageLocation()
540540
{
@@ -544,7 +544,7 @@ public function getMessageLocation()
544544
/**
545545
* Sets the location of the message.
546546
*
547-
* @param string $messageLocation The location of the message
547+
* @param string|null $messageLocation The location of the message
548548
*/
549549
public function setMessageLocation($messageLocation)
550550
{
@@ -554,7 +554,7 @@ public function setMessageLocation($messageLocation)
554554
/**
555555
* Gets the location of the lock.
556556
*
557-
* @return string
557+
* @return string|null
558558
*/
559559
public function getLockLocation()
560560
{
@@ -564,7 +564,7 @@ public function getLockLocation()
564564
/**
565565
* Sets the location of the lock.
566566
*
567-
* @param string $lockLocation The location of the lock
567+
* @param string|null $lockLocation The location of the lock
568568
*/
569569
public function setLockLocation($lockLocation)
570570
{

0 commit comments

Comments
 (0)