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