src/Model/Post/ThreadUser.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, 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\Model\Post;
  23
  24 use \BadMethodCallException;
  25 use Friendica\Database\Database;
  26 use Friendica\Database\DBA;
  27 use Friendica\Database\DBStructure;
  28
  29 class ThreadUser
  30 {
  31         /**
  32          * Insert a new URI user entry
  33          *
  34          * @param integer $uri_id
  35          * @param integer $uid
  36          * @param array   $fields
  37          * @return bool   success
  38          * @throws \Exception
  39          */
  40         public static function insert(int $uri_id, int $uid, array $data = [])
  41         {
  42                 if (empty($uri_id)) {
  43                         throw new BadMethodCallException('Empty URI_id');
  44                 }
  45
  46                 $fields = DBStructure::getFieldsForTable('post-thread-user', $data);
  47
  48                 // Additionally assign the key fields
  49                 $fields['uri-id'] = $uri_id;
  50                 $fields['uid'] = $uid;
  51
  52                 return DBA::insert('post-thread-user', $fields, Database::INSERT_IGNORE);
  53         }
  54
  55         /**
  56          * Update a URI user entry
  57          *
  58          * @param integer $uri_id
  59          * @param integer $uid
  60          * @param array   $data
  61          * @param bool    $insert_if_missing
  62          * @return bool
  63          * @throws \Exception
  64          */
  65         public static function update(int $uri_id, int $uid, array $data = [], bool $insert_if_missing = false)
  66         {
  67                 if (empty($uri_id)) {
  68                         throw new BadMethodCallException('Empty URI_id');
  69                 }
  70
  71                 $fields = DBStructure::getFieldsForTable('post-thread-user', $data);
  72
  73                 // Remove the key fields
  74                 unset($fields['uri-id']);
  75                 unset($fields['uid']);
  76
  77                 if (empty($fields)) {
  78                         return true;
  79                 }
  80
  81                 return DBA::update('post-thread-user', $fields, ['uri-id' => $uri_id, 'uid' => $uid], $insert_if_missing ? true : []);
  82         }
  83
  84         /**
  85          * Delete a row from the post-thread-user table
  86          *
  87          * @param array        $conditions Field condition(s)
  88          * @param array        $options
  89          *                           - cascade: If true we delete records in other tables that depend on the one we're deleting through
  90          *                           relations (default: true)
  91          *
  92          * @return boolean was the delete successful?
  93          * @throws \Exception
  94          */
  95         public static function delete(array $conditions, array $options = [])
  96         {
  97                 return DBA::delete('post-thread-user', $conditions, $options);
  98         }
  99
 100         /**
 101          * @param int $uri_id
 102          * @param int $uid
 103          * @return bool
 104          * @throws Exception
 105          */
 106         public static function getIgnored(int $uri_id, int $uid)
 107         {
 108                 $threaduser = DBA::selectFirst('post-thread-user', ['ignored'], ['uri-id' => $uri_id, 'uid' => $uid]);
 109                 if (empty($threaduser)) {
 110                         return false;
 111                 }
 112                 return (bool)$threaduser['ignored'];
 113         }
 114
 115         /**
 116          * @param int $uri_id
 117          * @param int $uid
 118          * @param int $ignored
 119          * @return void
 120          * @throws Exception
 121          */
 122         public static function setIgnored(int $uri_id, int $uid, int $ignored)
 123         {
 124                 DBA::update('post-thread-user', ['ignored' => $ignored], ['uri-id' => $uri_id, 'uid' => $uid], true);
 125         }
 126
 127         /**
 128          * @param int $uri_id
 129          * @param int $uid
 130          * @return bool
 131          * @throws Exception
 132          */
 133         public static function getPinned(int $uri_id, int $uid)
 134         {
 135                 $threaduser = DBA::selectFirst('post-thread-user', ['pinned'], ['uri-id' => $uri_id, 'uid' => $uid]);
 136                 if (empty($threaduser)) {
 137                         return false;
 138                 }
 139                 return (bool)$threaduser['pinned'];
 140         }
 141
 142         /**
 143          * @param int $uri_id
 144          * @param int $uid
 145          * @param int $pinned
 146          * @return void
 147          * @throws Exception
 148          */
 149         public static function setPinned(int $uri_id, int $uid, int $pinned)
 150         {
 151                 DBA::update('post-thread-user', ['pinned' => $pinned], ['uri-id' => $uri_id, 'uid' => $uid], true);
 152         }
 153 }