FilesExpand file tree

develop

/

QueuePushResult.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

67 lines (58 loc) · 1.37 KB

develop

/

QueuePushResult.php

Copy path

Top

File metadata and controls

• Code
• Blame

67 lines (58 loc) · 1.37 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

<?php

declare(strict_types=1);

/**

* This file is part of CodeIgniter Queue.

*

* (c) CodeIgniter Foundation <admin@codeigniter.com>

*

* For the full copyright and license information, please view

* the LICENSE file that was distributed with this source code.

*/

namespace CodeIgniter\Queue;

/**

* Represents the result of a queue push operation.

*/

class QueuePushResult

{

public function __construct(

protected readonly bool $success,

protected readonly ?int $jobId = null,

protected readonly ?string $error = null,

) {

}

/**

* Creates a successful push result.

*/

public static function success(int $jobId): self

{

return new self(true, $jobId);

}

/**

* Creates a failed push result.

*/

public static function failure(?string $error = null): self

{

return new self(false, null, $error);

}

/**

* Returns whether the push operation was successful.

*/

public function getStatus(): bool

{

return $this->success;

}

/**

* Returns the job ID if the push was successful, null otherwise.

*/

public function getJobId(): ?int

{

return $this->jobId;

}

/**

* Returns the error message if the push failed, null otherwise.

*/

public function getError(): ?string

{

return $this->error;

}

}