src/Content/Conversation/Entity/Timeline.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, 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\Content\Conversation\Entity;
  23
  24 /**
  25  * @property-read string $code           Channel code
  26  * @property-read string $label          Channel label
  27  * @property-read string $description    Channel description
  28  * @property-read string $accessKey      Access key
  29  * @property-read string $path           Path
  30  * @property-read int    $uid            User of the channel
  31  * @property-read string $includeTags    The tags to include in the channel
  32  * @property-read string $excludeTags    The tags to exclude in the channel
  33  * @property-read string $fullTextSearch full text search pattern
  34  */
  35 final class Timeline extends \Friendica\BaseEntity
  36 {
  37         const WHATSHOT         = 'whatshot';
  38         const FORYOU           = 'foryou';
  39         const FOLLOWERS        = 'followers';
  40         const SHARERSOFSHARERS = 'sharersofsharers';
  41         const IMAGE            = 'image';
  42         const VIDEO            = 'video';
  43         const AUDIO            = 'audio';
  44         const LANGUAGE         = 'language';
  45         const LOCAL            = 'local';
  46         const GLOBAL           = 'global';
  47         const STAR             = 'star';
  48         const MENTION          = 'mention';
  49         const RECEIVED         = 'received';
  50         const COMMENTED        = 'commented';
  51         const CREATED          = 'created';
  52
  53         /** @var string */
  54         protected $code;
  55         /** @var string */
  56         protected $label;
  57         /** @var string */
  58         protected $description;
  59         /** @var string */
  60         protected $accessKey;
  61         /** @var string */
  62         protected $path;
  63         /** @var int */
  64         protected $uid;
  65         /** @var string */
  66         protected $includeTags;
  67         /** @var string */
  68         protected $excludeTags;
  69         /** @var string */
  70         protected $fullTextSearch;
  71         /** @var int */
  72         protected $mediaType;
  73
  74         public function __construct(string $code = null, string $label = null, string $description = null, string $accessKey = null, string $path = null, int $uid = null, string $includeTags = null, string $excludeTags = null, string $fullTextSearch = null, int $mediaType = null)
  75         {
  76                 $this->code           = $code;
  77                 $this->label          = $label;
  78                 $this->description    = $description;
  79                 $this->accessKey      = $accessKey;
  80                 $this->path           = $path;
  81                 $this->uid            = $uid;
  82                 $this->includeTags    = $includeTags;
  83                 $this->excludeTags    = $excludeTags;
  84                 $this->fullTextSearch = $fullTextSearch;
  85                 $this->mediaType      = $mediaType;
  86         }
  87 }