123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108 |
- <?php
- namespace Elgg\Notifications;
- /**
- * Notification container
- *
- * @package Elgg.Core
- * @subpackage Notifications
- * @since 1.10
- */
- class Notification {
- /** @var \ElggEntity The entity causing or creating the notification */
- protected $from;
- /** @var \ElggUser The user receiving the notification */
- protected $to;
- /** @var string A single sentence summary string */
- public $summary;
- /** @var string The subject of the notification. Email subject is one use. */
- public $subject;
- /** @var string The body of the notification. Email body is one use. */
- public $body;
- /** @var string The language of the notification */
- public $language;
- /** @var array Additional parameters */
- public $params;
- /**
- * Create a notification
- *
- * @param \ElggEntity $from The entity sending the notification (usually the site)
- * @param \ElggEntity $to The entity receiving the notification
- * @param string $language The language code for the notification
- * @param string $subject The subject of the notification
- * @param string $body The body of the notification
- * @param string $summary Optional summary of the notification
- * @param array $params Optional array of parameters
- * @throws \InvalidArgumentException
- */
- public function __construct(\ElggEntity $from, \ElggEntity $to, $language, $subject, $body, $summary = '', array $params = array()) {
- if (!$from) {
- throw new \InvalidArgumentException('$from is not a valid \ElggEntity');
- }
- if (!$to) {
- throw new \InvalidArgumentException('$to is not a valid \ElggEntity');
- }
- $this->from = $from;
- $this->to = $to;
- $this->language = $language;
- $this->subject = $subject;
- $this->body = $body;
- $this->summary = $summary;
- $this->params = $params;
- }
- /**
- * Get the sender entity
- *
- * @return \ElggEntity
- */
- public function getSender() {
- return $this->from;
- }
- /**
- * Get the sender entity guid
- *
- * @return int
- */
- public function getSenderGUID() {
- return $this->from->guid;
- }
- /**
- * Get the recipient entity
- *
- * @return \ElggEntity
- */
- public function getRecipient() {
- return $this->to;
- }
- /**
- * Get the recipient entity guid
- *
- * @return int
- */
- public function getRecipientGUID() {
- return $this->to->guid;
- }
- }
- /**
- * Notification container
- *
- * @package Elgg.Core
- * @subpackage Notifications
- * @since 1.9.0
- *
- * @deprecated 1.10 Use \Elgg\Notifications\Notification instead
- */
- class Elgg_Notifications_Notification extends \Elgg\Notifications\Notification {}
|