src/Moderation/Entity/Report.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\Moderation\Entity;
  23
  24 /**
  25  * @property-read int            $id
  26  * @property-read int            $reporterId
  27  * @property-read int            $cid
  28  * @property-read string         $comment
  29  * @property-read string|null    $category
  30  * @property-read bool           $forward
  31  * @property-read array          $postUriIds
  32  * @property-read int            $uid
  33  * @property-read \DateTime|null $created
  34  */
  35 class Report extends \Friendica\BaseEntity
  36 {
  37         /** @var int|null */
  38         protected $id;
  39         /** @var int ID of the contact making a moderation report*/
  40         protected $reporterId;
  41         /** @var int ID of the contact being reported*/
  42         protected $cid;
  43         /** @var string Optional comment */
  44         protected $comment;
  45         /** @var string Optional category */
  46         protected $category;
  47         /** @var string Violated rules */
  48         protected $rules;
  49         /** @var bool Whether this report should be forwarded to the remote server */
  50         protected $forward;
  51         /** @var \DateTime|null When the report was created */
  52         protected $created;
  53         /** @var array Optional list of URI IDs of posts supporting the report*/
  54         protected $postUriIds;
  55         /** @var int ID of the user making a moderation report*/
  56         protected $uid;
  57
  58         public function __construct(int $reporterId, int $cid, \DateTime $created, string $comment = '', string $category = null, string $rules = '', bool $forward = false, array $postUriIds = [], int $uid = null, int $id = null)
  59         {
  60                 $this->reporterId = $reporterId;
  61                 $this->cid        = $cid;
  62                 $this->created    = $created;
  63                 $this->comment    = $comment;
  64                 $this->category   = $category;
  65                 $this->rules      = $rules;
  66                 $this->forward    = $forward;
  67                 $this->postUriIds = $postUriIds;
  68                 $this->uid        = $uid;
  69                 $this->id         = $id;
  70         }
  71 }