src/Model/Post/Collection.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\Model\Post;
  23
  24 use Friendica\Database\DBA;
  25 use BadMethodCallException;
  26 use Friendica\Database\Database;
  27 use Friendica\DI;
  28 use Friendica\Model\Item;
  29 use Friendica\Protocol\ActivityPub;
  30
  31 class Collection
  32 {
  33         const FEATURED = 0;
  34
  35         /**
  36          * Add a post to a collection
  37          *
  38          * @param integer $uri_id
  39          * @param integer $type
  40          * @param integer $author_id
  41          * @param integer $cache_uid If set to a non zero value, the featured cache is cleared
  42          */
  43         public static function add(int $uri_id, int $type, int $author_id, int $cache_uid = 0)
  44         {
  45                 if (empty($uri_id)) {
  46                         throw new BadMethodCallException('Empty URI_id');
  47                 }
  48
  49                 DBA::insert('post-collection', ['uri-id' => $uri_id, 'type' => $type, 'author-id' => $author_id], Database::INSERT_IGNORE);
  50
  51                 if (!empty($cache_uid) && ($type == self::FEATURED)) {
  52                         DI::cache()->delete(ActivityPub\Transmitter::CACHEKEY_FEATURED . $cache_uid);
  53                 }
  54         }
  55
  56         /**
  57          * Remove a post from a collection
  58          *
  59          * @param integer $uri_id
  60          * @param integer $type
  61          * @param integer $cache_uid If set to a non zero value, the featured cache is cleared
  62          */
  63         public static function remove(int $uri_id, int $type, int $cache_uid = 0)
  64         {
  65                 if (empty($uri_id)) {
  66                         throw new BadMethodCallException('Empty URI_id');
  67                 }
  68
  69                 DBA::delete('post-collection', ['uri-id' => $uri_id, 'type' => $type]);
  70
  71                 if (!empty($cache_uid) && ($type == self::FEATURED)) {
  72                         DI::cache()->delete(ActivityPub\Transmitter::CACHEKEY_FEATURED . $cache_uid);
  73                 }
  74         }
  75
  76         /**
  77          * Fetch collections for a given contact
  78          *
  79          * @param integer $cid
  80          * @param [type] $type
  81          * @param array $fields
  82          * @return array
  83          */
  84         public static function selectToArrayForContact(int $cid, int $type = self::FEATURED, array $fields = [])
  85         {
  86                 return DBA::selectToArray('collection-view', $fields, ['cid' => $cid, 'private' => [Item::PUBLIC, Item::UNLISTED], 'deleted' => false, 'type' => $type]);
  87         }
  88 }