| 1 | <?php |
||
| 9 | final class RocketChat |
||
| 10 | { |
||
| 11 | /** @var \GuzzleHttp\Client */ |
||
| 12 | private $http; |
||
| 13 | |||
| 14 | /** @var string */ |
||
| 15 | private $url; |
||
| 16 | |||
| 17 | /** @var string */ |
||
| 18 | private $token; |
||
| 19 | |||
| 20 | /** @var string|null */ |
||
| 21 | private $defaultChannel; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * @param \GuzzleHttp\Client $http |
||
| 25 | * @param string $url |
||
| 26 | * @param string $token |
||
| 27 | * @param string|null $defaultChannel |
||
| 28 | * @return void |
||
|
|
|||
| 29 | */ |
||
| 30 | 4 | public function __construct(HttpClient $http, string $url, string $token, ?string $defaultChannel = null) |
|
| 37 | |||
| 38 | /** |
||
| 39 | * Returns RocketChat token. |
||
| 40 | * |
||
| 41 | * @return string |
||
| 42 | */ |
||
| 43 | 1 | public function getToken(): string |
|
| 47 | |||
| 48 | /** |
||
| 49 | * Returns default channel id or name. |
||
| 50 | * |
||
| 51 | * @return string|null |
||
| 52 | */ |
||
| 53 | 1 | public function getDefaultChannel(): ?string |
|
| 57 | |||
| 58 | /** |
||
| 59 | * Send a message. |
||
| 60 | * |
||
| 61 | * @param string $to |
||
| 62 | * @param array $message |
||
| 63 | * @return void |
||
| 64 | */ |
||
| 65 | 3 | public function sendMessage(string $to, array $message): void |
|
| 75 | |||
| 76 | /** |
||
| 77 | * Perform a simple post request. |
||
| 78 | * |
||
| 79 | * @param string $url |
||
| 80 | * @param array $options |
||
| 81 | * @return void |
||
| 82 | */ |
||
| 83 | 3 | private function post(string $url, array $options): void |
|
| 87 | } |
||
| 88 |
Adding a
@returnannotation to a constructor is not recommended, since a constructor does not have a meaningful return value.Please refer to the PHP core documentation on constructors.