vendor/botman/botman/src/Messages/Incoming/IncomingMessage.php line 260

Open in your IDE?
  1. <?php
  3. namespace BotMan\BotMan\Messages\Incoming;
  5. use BotMan\BotMan\Messages\Attachments\Contact;
  6. use BotMan\BotMan\Messages\Attachments\Location;
  7. use Illuminate\Support\Collection;
  9. class IncomingMessage
  10. {
  11. /** @var string */
  12. protected $message;
  14. /** @var string */
  15. protected $sender;
  17. /** @var string */
  18. protected $recipient;
  20. /** @var string */
  21. protected $bot_id;
  23. /** @var array */
  24. protected $images = [];
  26. /** @var array */
  27. protected $videos = [];
  29. /** @var mixed */
  30. protected $payload;
  32. /** @var array */
  33. protected $extras = [];
  35. /** @var array */
  36. private $audio = [];
  38. /** @var array */
  39. private $files = [];
  41. /** @var \BotMan\BotMan\Messages\Attachments\Location */
  42. private $location;
  44. /** @var \BotMan\BotMan\Messages\Attachments\Contact */
  45. private $contact;
  47. /** @var bool */
  48. protected $isFromBot = false;
  50. public function __construct($message, $sender, $recipient, $payload = null, $bot_id = '')
  51. {
  52. $this->message = $message;
  53. $this->sender = $sender;
  54. $this->recipient = $recipient;
  55. $this->payload = $payload;
  56. $this->bot_id = $bot_id;
  57. }
  59. /**
  60. * @return string
  61. */
  62. public function getRecipient()
  63. {
  64. return $this->recipient;
  65. }
  67. /**
  68. * @return string
  69. */
  70. public function getSender()
  71. {
  72. return $this->sender;
  73. }
  75. /**
  76. * @return mixed
  77. */
  78. public function getPayload()
  79. {
  80. return $this->payload;
  81. }
  83. /**
  84. * @return string
  85. */
  86. public function getText()
  87. {
  88. return $this->message;
  89. }
  91. /**
  92. * @return string
  93. */
  94. public function getConversationIdentifier()
  95. {
  96. return 'conversation-' . $this->bot_id . sha1((string)$this->getSender()) . '-' . sha1((string)$this->getRecipient());
  97. }
  99. /**
  100. * We don't know the user, since conversations are originated on the channel.
  101. *
  102. * @return string
  103. */
  104. public function getOriginatedConversationIdentifier()
  105. {
  106. return 'conversation-' . $this->bot_id . sha1((string)$this->getSender()) . '-' . sha1('');
  107. }
  109. /**
  110. * @param string $key
  111. * @param mixed $value
  112. * @return IncomingMessage
  113. */
  114. public function addExtras($key, $value)
  115. {
  116. $this->extras[$key] = $value;
  118. return $this;
  119. }
  121. /**
  122. * @param string|null $key
  123. * @return mixed
  124. */
  125. public function getExtras($key = null)
  126. {
  127. if (!is_null($key)) {
  128. return Collection::make($this->extras)->get($key);
  129. }
  131. return $this->extras;
  132. }
  134. /**
  135. * @param array $images
  136. */
  137. public function setImages(array $images)
  138. {
  139. $this->images = $images;
  140. }
  142. /**
  143. * Returns the message image Objects.
  144. * @return array
  145. */
  146. public function getImages()
  147. {
  148. return $this->images;
  149. }
  151. /**
  152. * @param array $videos
  153. */
  154. public function setVideos(array $videos)
  155. {
  156. $this->videos = $videos;
  157. }
  159. /**
  160. * Returns the message video Objects.
  161. * @return array
  162. */
  163. public function getVideos()
  164. {
  165. return $this->videos;
  166. }
  168. /**
  169. * @param array $audio
  170. */
  171. public function setAudio(array $audio)
  172. {
  173. $this->audio = $audio;
  174. }
  176. /**
  177. * Returns the message audio Objects.
  178. * @return array
  179. */
  180. public function getAudio()
  181. {
  182. return $this->audio;
  183. }
  185. /**
  186. * @param array $files
  187. */
  188. public function setFiles(array $files)
  189. {
  190. $this->files = $files;
  191. }
  193. /**
  194. * @return array
  195. */
  196. public function getFiles()
  197. {
  198. return $this->files;
  199. }
  201. /**
  202. * @param \BotMan\BotMan\Messages\Attachments\Location $location
  203. */
  204. public function setLocation(Location $location)
  205. {
  206. $this->location = $location;
  207. }
  209. /**
  210. * @return \BotMan\BotMan\Messages\Attachments\Location
  211. */
  212. public function getLocation(): Location
  213. {
  214. if (empty($this->location)) {
  215. throw new \UnexpectedValueException('This message does not contain a location');
  216. }
  218. return $this->location;
  219. }
  221. /**
  222. * @return \BotMan\BotMan\Messages\Attachments\Contact
  223. */
  224. public function getContact(): Contact
  225. {
  226. if (empty($this->contact)) {
  227. throw new \UnexpectedValueException('This message does not contain a contact');
  228. }
  230. return $this->contact;
  231. }
  233. /**
  234. * @param \BotMan\BotMan\Messages\Attachments\Contact $contact
  235. */
  236. public function setContact(Contact $contact)
  237. {
  238. $this->contact = $contact;
  239. }
  241. /**
  242. * @return bool
  243. */
  244. public function isFromBot(): bool
  245. {
  246. return $this->isFromBot;
  247. }
  249. /**
  250. * @param bool $isFromBot
  251. */
  252. public function setIsFromBot(bool $isFromBot)
  253. {
  254. $this->isFromBot = $isFromBot;
  255. }
  257. /**
  258. * @param string $message
  259. */
  260. public function setText(string $message)
  261. {
  262. $this->message = $message;
  263. }
  264. }