]> git.mxchange.org Git - friendica.git/blob - src/Object/Api/Mastodon/Relationship.php
Replace BaseEntity with BaseDataTransferObject class for API representation classes
[friendica.git] / src / Object / Api / Mastodon / Relationship.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2020, Friendica
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\Model\Contact;
26 use Friendica\Util\Network;
27
28 /**
29  * Class Relationship
30  *
31  * @see https://docs.joinmastodon.org/api/entities/#relationship
32  */
33 class Relationship extends BaseDataTransferObject
34 {
35         /** @var int */
36         protected $id;
37         /** @var bool */
38         protected $following = false;
39         /** @var bool */
40         protected $followed_by = false;
41         /** @var bool */
42         protected $blocking = false;
43         /** @var bool */
44         protected $muting = false;
45         /** @var bool */
46         protected $muting_notifications = false;
47         /** @var bool */
48         protected $requested = false;
49         /** @var bool */
50         protected $domain_blocking = false;
51         /**
52          * Unsupported
53          * @var bool
54          */
55         protected $showing_reblogs = true;
56         /**
57          * Unsupported
58          * @var bool
59          */
60         protected $endorsed = false;
61
62         /**
63          * @param int   $userContactId Contact row Id with uid != 0
64          * @param array $userContact   Full Contact table record with uid != 0
65          */
66         public function __construct(int $userContactId, array $userContact = [])
67         {
68                 $this->id                   = $userContactId;
69                 $this->following            = in_array($userContact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND]);
70                 $this->followed_by          = in_array($userContact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND]);
71                 $this->blocking             = (bool)$userContact['blocked'] ?? false;
72                 $this->muting               = (bool)$userContact['readonly'] ?? false;
73                 $this->muting_notifications = (bool)$userContact['readonly'] ?? false;
74                 $this->requested            = (bool)$userContact['pending'] ?? false;
75                 $this->domain_blocking      = Network::isUrlBlocked($userContact['url'] ?? '');
76
77                 return $this;
78         }
79 }