src/Navigation/Notifications/ValueObject/FormattedNavNotification.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Navigation\Notifications\ValueObject;
  23
  24 use Friendica\BaseEntity;
  25
  26 /**
  27  * A view-only object for printing item notifications to the frontend
  28  */
  29 class FormattedNavNotification extends BaseEntity
  30 {
  31         /** @var array */
  32         protected $contact;
  33         /** @var string */
  34         protected $timestamp;
  35         /** @var string */
  36         protected $plaintext;
  37         /** @var string */
  38         protected $html;
  39         /** @var string */
  40         protected $href;
  41         /** @var bool */
  42         protected $seen;
  43
  44         /**
  45          * @param string $contact_name  Contact display name
  46          * @param string $contact_url   Contact profile URL
  47          * @param string $contact_photo Contact picture URL
  48          * @param string $timestamp     Unix timestamp
  49          * @param string $plaintext     Localized notification message with the placeholder replaced by the contact name
  50          * @param string $html          Full HTML string of the notification menu element
  51          * @param string $href          Absolute URL this notification should send the user to when interacted with
  52          * @param bool   $seen          Whether the user interacted with this notification once
  53          */
  54         public function __construct(string $contact_name, string $contact_url, string $contact_photo, string $timestamp, string $plaintext, string $html, string $href, bool $seen)
  55         {
  56                 // Properties differ from constructor because this structure is used in the "nav-update" Javascript event listener
  57                 $this->contact = [
  58                         'name'  => $contact_name,
  59                         'url'   => $contact_url,
  60                         'photo' => $contact_photo,
  61                 ];
  62                 $this->timestamp = $timestamp;
  63                 $this->plaintext = $plaintext;
  64                 $this->html      = $html;
  65                 $this->href      = $href;
  66                 $this->seen      = $seen;
  67         }
  68 }