src/Object/Api/Mastodon/Poll.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\Object\Api\Mastodon;
  23
  24 use Friendica\BaseDataTransferObject;
  25 use Friendica\Util\DateTimeFormat;
  26
  27 /**
  28  * Class Poll
  29  *
  30  * @see https://docs.joinmastodon.org/entities/poll/
  31  */
  32 class Poll extends BaseDataTransferObject
  33 {
  34         /** @var string */
  35         protected $id;
  36         /** @var string|null (Datetime) */
  37         protected $expires_at;
  38         /** @var bool */
  39         protected $expired = false;
  40         /** @var bool */
  41         protected $multiple = false;
  42         /** @var int */
  43         protected $votes_count = 0;
  44         /** @var int|null */
  45         protected $voters_count = 0;
  46         /** @var bool|null */
  47         protected $voted = false;
  48         /** @var array|null */
  49         protected $own_votes = false;
  50         /** @var array */
  51         protected $options = [];
  52         /** @var Emoji[] */
  53         protected $emojis = [];
  54
  55         /**
  56          * Creates a poll record.
  57          *
  58          * @param array $question Array with the question
  59          * @param array $options  Array of question options
  60          * @param bool  $expired  "true" if the question is expired
  61          * @param int   $votes    Number of total votes
  62          * @param array $ownvotes Own vote
  63          */
  64         public function __construct(array $question, array $options, bool $expired, int $votes, array $ownvotes = null)
  65         {
  66                 $this->id           = (string)$question['id'];
  67                 $this->expires_at   = !empty($question['end-time']) ? DateTimeFormat::utc($question['end-time'], DateTimeFormat::JSON) : null;
  68                 $this->expired      = $expired;
  69                 $this->multiple     = (bool)$question['multiple'];
  70                 $this->votes_count  = $votes;
  71                 $this->voters_count = $this->multiple ? $question['voters'] : null;
  72                 $this->voted        = null;
  73                 $this->own_votes    = $ownvotes;
  74                 $this->options      = $options;
  75                 $this->emojis       = [];
  76         }
  77 }