]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Post.php
Funkwhale context file moved
[friendica.git] / src / Model / Post.php
index b0e77fe373d49625fccfb18f70b5c15f933a099d..2b71e2f142075b48c19512295e98aa76e71063c8 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2022, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -27,6 +27,7 @@ use Friendica\Core\System;
 use Friendica\Database\Database;
 use Friendica\Database\DBA;
 use Friendica\Database\DBStructure;
+use Friendica\DI;
 use Friendica\Protocol\Activity;
 
 class Post
@@ -39,13 +40,13 @@ class Post
         * @return int    ID of inserted post
         * @throws \Exception
         */
-       public static function insert(int $uri_id, array $data = [])
+       public static function insert(int $uri_id, array $data = []): int
        {
                if (empty($uri_id)) {
                        throw new BadMethodCallException('Empty URI_id');
                }
 
-               $fields = DBStructure::getFieldsForTable('post', $data);
+               $fields = DI::dbaDefinition()->truncateFieldsForTable('post', $data);
 
                // Additionally assign the key fields
                $fields['uri-id'] = $uri_id;
@@ -107,8 +108,10 @@ class Post
         * @param object $stmt statement object
         * @param bool   $do_close
         * @return array Data array
+        * @todo Find proper type-hint for $stmt and maybe avoid boolean
         */
-       public static function toArray($stmt, $do_close = true) {
+       public static function toArray($stmt, bool $do_close = true)
+       {
                if (is_bool($stmt)) {
                        return $stmt;
                }
@@ -124,24 +127,23 @@ class Post
        }
 
        /**
-        * Check if post data exists
+        * Check if post-user-view records exists
         *
         * @param array $condition array of fields for condition
-        * @param bool  $user_mode true = post-user-view, false = post-view
         *
         * @return boolean Are there rows for that condition?
         * @throws \Exception
         */
-       public static function exists($condition, bool $user_mode = true) {
-               return DBA::exists($user_mode ? 'post-user-view' : 'post-view', $condition);
+       public static function exists(array $condition): bool
+       {
+               return DBA::exists('post-user-view', $condition);
        }
 
        /**
-        * Counts the posts satisfying the provided condition
+        * Counts the post-user-view records satisfying the provided condition
         *
         * @param array        $condition array of fields for condition
         * @param array        $params    Array of several parameters
-        * @param bool         $user_mode true = post-user-view, false = post-view
         *
         * @return int
         *
@@ -153,13 +155,55 @@ class Post
         * $count = Post::count($condition);
         * @throws \Exception
         */
-       public static function count(array $condition = [], array $params = [], bool $user_mode = true)
+       public static function count(array $condition = [], array $params = []): int
+       {
+               return DBA::count('post-user-view', $condition, $params);
+       }
+
+       /**
+        * Counts the post-thread-user-view records satisfying the provided condition
+        *
+        * @param array        $condition array of fields for condition
+        * @param array        $params    Array of several parameters
+        *
+        * @return int
+        *
+        * Example:
+        * $condition = ["uid" => 1, "network" => 'dspr'];
+        * or:
+        * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
+        *
+        * $count = Post::count($condition);
+        * @throws \Exception
+        */
+       public static function countThread(array $condition = [], array $params = []): int
+       {
+               return DBA::count('post-thread-user-view', $condition, $params);
+       }
+
+       /**
+        * Counts the post-view records satisfying the provided condition
+        *
+        * @param array        $condition array of fields for condition
+        * @param array        $params    Array of several parameters
+        *
+        * @return int
+        *
+        * Example:
+        * $condition = ["network" => 'dspr'];
+        * or:
+        * $condition = ["`network` IN (?, ?)", 1, 'dfrn', 'dspr'];
+        *
+        * $count = Post::count($condition);
+        * @throws \Exception
+        */
+       public static function countPosts(array $condition = [], array $params = []): int
        {
-               return DBA::count($user_mode ? 'post-user-view' : 'post-view', $condition, $params);
+               return DBA::count('post-view', $condition, $params);
        }
 
        /**
-        * Retrieve a single record from the post table and returns it in an associative array
+        * Retrieve a single record from the post-user-view view and returns it in an associative array
         *
         * @param array $fields
         * @param array $condition
@@ -169,11 +213,36 @@ class Post
         * @throws \Exception
         * @see   DBA::select
         */
-       public static function selectFirst(array $fields = [], array $condition = [], $params = [], bool $user_mode = true)
+       public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
+       {
+               $params['limit'] = 1;
+
+               $result = self::select($fields, $condition, $params);
+
+               if (is_bool($result)) {
+                       return $result;
+               } else {
+                       $row = self::fetch($result);
+                       DBA::close($result);
+                       return $row;
+               }
+       }
+
+       /**
+        * Retrieve a single record from the post-view view and returns it in an associative array
+        *
+        * @param array $fields
+        * @param array $condition
+        * @param array $params
+        * @return bool|array
+        * @throws \Exception
+        * @see   DBA::select
+        */
+       public static function selectFirstPost(array $fields = [], array $condition = [], array $params = [])
        {
                $params['limit'] = 1;
 
-               $result = self::select($fields, $condition, $params, $user_mode);
+               $result = self::selectPosts($fields, $condition, $params);
 
                if (is_bool($result)) {
                        return $result;
@@ -185,7 +254,7 @@ class Post
        }
 
        /**
-        * Retrieve a single record from the post-thread table and returns it in an associative array
+        * Retrieve a single record from the post-thread-user-view view and returns it in an associative array
         *
         * @param array $fields
         * @param array $condition
@@ -194,7 +263,7 @@ class Post
         * @throws \Exception
         * @see   DBA::select
         */
-       public static function selectFirstThread(array $fields = [], array $condition = [], $params = [])
+       public static function selectFirstThread(array $fields = [], array $condition = [], array $params = [])
        {
                $params['limit'] = 1;
 
@@ -210,7 +279,7 @@ class Post
        }
 
        /**
-        * Select rows from the post table and returns them as an array
+        * Select rows from the post-user-view view and returns them as an array
         *
         * @param array $selected  Array of selected fields, empty for all
         * @param array $condition Array of fields for condition
@@ -219,7 +288,7 @@ class Post
         * @return array
         * @throws \Exception
         */
-       public static function selectToArray(array $fields = [], array $condition = [], $params = [])
+       public static function selectToArray(array $fields = [], array $condition = [], array $params = [])
        {
                $result = self::select($fields, $condition, $params);
 
@@ -247,7 +316,7 @@ class Post
         * @return boolean|object
         * @throws \Exception
         */
-       private static function selectView(string $view, array $selected = [], array $condition = [], $params = [])
+       private static function selectView(string $view, array $selected = [], array $condition = [], array $params = [])
        {
                if (empty($selected)) {
                        $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
@@ -263,23 +332,22 @@ class Post
        }
 
        /**
-        * Select rows from the post table
+        * Select rows from the post-user-view view
         *
         * @param array $selected  Array of selected fields, empty for all
         * @param array $condition Array of fields for condition
         * @param array $params    Array of several parameters
-        * @param bool  $user_mode true = post-user-view, false = post-view
         *
         * @return boolean|object
         * @throws \Exception
         */
-       public static function select(array $selected = [], array $condition = [], $params = [], bool $user_mode = true)
+       public static function select(array $selected = [], array $condition = [], array $params = [])
        {
-               return self::selectView($user_mode ? 'post-user-view' : 'post-view', $selected, $condition, $params);
+               return self::selectView('post-user-view', $selected, $condition, $params);
        }
 
        /**
-        * Select rows from the post table
+        * Select rows from the post-view view
         *
         * @param array $selected  Array of selected fields, empty for all
         * @param array $condition Array of fields for condition
@@ -288,7 +356,22 @@ class Post
         * @return boolean|object
         * @throws \Exception
         */
-       public static function selectThread(array $selected = [], array $condition = [], $params = [])
+       public static function selectPosts(array $selected = [], array $condition = [], array $params = [])
+       {
+               return self::selectView('post-view', $selected, $condition, $params);
+       }
+
+       /**
+        * Select rows from the post-thread-user-view view
+        *
+        * @param array $selected  Array of selected fields, empty for all
+        * @param array $condition Array of fields for condition
+        * @param array $params    Array of several parameters
+        *
+        * @return boolean|object
+        * @throws \Exception
+        */
+       public static function selectThread(array $selected = [], array $condition = [], array $params = [])
        {
                return self::selectView('post-thread-user-view', $selected, $condition, $params);
        }
@@ -305,7 +388,7 @@ class Post
         * @return boolean|object
         * @throws \Exception
         */
-       private static function selectViewForUser(string $view, $uid, array $selected = [], array $condition = [], $params = [])
+       private static function selectViewForUser(string $view, int $uid, array $selected = [], array $condition = [], array $params = [])
        {
                if (empty($selected)) {
                        $selected = Item::DISPLAY_FIELDLIST;
@@ -336,24 +419,39 @@ class Post
        }
 
        /**
-        * Select rows from the post view for a given user
+        * Select rows from the post-user-view view for a given user
+        *
+        * @param integer $uid       User ID
+        * @param array   $selected  Array of selected fields, empty for all
+        * @param array   $condition Array of fields for condition
+        * @param array   $params    Array of several parameters
+        *
+        * @return boolean|object
+        * @throws \Exception
+        */
+       public static function selectForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
+       {
+               return self::selectViewForUser('post-user-view', $uid, $selected, $condition, $params);
+       }
+
+       /**
+        * Select rows from the post-view view for a given user
         *
         * @param integer $uid       User ID
         * @param array   $selected  Array of selected fields, empty for all
         * @param array   $condition Array of fields for condition
         * @param array   $params    Array of several parameters
-        * @param bool    $user_mode true = post-user-view, false = post-view
         *
         * @return boolean|object
         * @throws \Exception
         */
-       public static function selectForUser($uid, array $selected = [], array $condition = [], $params = [], bool $user_mode = true)
+       public static function selectPostsForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
        {
-               return self::selectViewForUser($user_mode ? 'post-user-view' : 'post-view', $uid, $selected, $condition, $params);
+               return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
        }
 
-               /**
-        * Select rows from the post view for a given user
+       /**
+        * Select rows from the post-thread-user-view view for a given user
         *
         * @param integer $uid       User ID
         * @param array   $selected  Array of selected fields, empty for all
@@ -363,13 +461,13 @@ class Post
         * @return boolean|object
         * @throws \Exception
         */
-       public static function selectThreadForUser($uid, array $selected = [], array $condition = [], $params = [])
+       public static function selectThreadForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
        {
                return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
        }
 
        /**
-        * Retrieve a single record from the post view for a given user and returns it in an associative array
+        * Retrieve a single record from the post-user-view view for a given user and returns it in an associative array
         *
         * @param integer $uid User ID
         * @param array   $selected
@@ -379,7 +477,7 @@ class Post
         * @throws \Exception
         * @see   DBA::select
         */
-       public static function selectFirstForUser($uid, array $selected = [], array $condition = [], $params = [])
+       public static function selectFirstForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
        {
                $params['limit'] = 1;
 
@@ -394,39 +492,6 @@ class Post
                }
        }
 
-       /**
-        * Select pinned rows from the item table for a given user
-        *
-        * @param integer $uid       User ID
-        * @param array   $selected  Array of selected fields, empty for all
-        * @param array   $condition Array of fields for condition
-        * @param array   $params    Array of several parameters
-        *
-        * @return boolean|object
-        * @throws \Exception
-        */
-       public static function selectPinned(int $uid, array $selected = [], array $condition = [], $params = [])
-       {
-               $postthreaduser = DBA::select('post-thread-user', ['uri-id'], ['uid' => $uid, 'pinned' => true]);
-               if (!DBA::isResult($postthreaduser)) {
-                       return $postthreaduser;
-               }
-
-               $pinned = [];
-               while ($useritem = DBA::fetch($postthreaduser)) {
-                       $pinned[] = $useritem['uri-id'];
-               }
-               DBA::close($postthreaduser);
-
-               if (empty($pinned)) {
-                       return [];
-               }
-
-               $condition = DBA::mergeConditions(['uri-id' => $pinned, 'uid' => $uid, 'gravity' => GRAVITY_PARENT], $condition);
-
-               return self::selectForUser($uid, $selected, $condition, $params);
-       }
-
        /**
         * Update existing post entries
         *
@@ -460,7 +525,7 @@ class Post
                // To ensure the data integrity we do it in an transaction
                DBA::transaction();
 
-               $update_fields = DBStructure::getFieldsForTable('post-user', $fields);
+               $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-user', $fields);
                if (!empty($update_fields)) {
                        $affected_count = 0;
                        $posts = DBA::select('post-user-view', ['post-user-id'], $condition);
@@ -477,7 +542,7 @@ class Post
                        $affected = $affected_count;
                }
 
-               $update_fields = DBStructure::getFieldsForTable('post-content', $fields);
+               $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-content', $fields);
                if (!empty($update_fields)) {
                        $affected_count = 0;
                        $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
@@ -494,7 +559,7 @@ class Post
                        $affected = max($affected, $affected_count);
                }
 
-               $update_fields = DBStructure::getFieldsForTable('post', $fields);
+               $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post', $fields);
                if (!empty($update_fields)) {
                        $affected_count = 0;
                        $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
@@ -528,7 +593,7 @@ class Post
                        $affected = max($affected, $affected_count);
                }
 
-               $update_fields = DBStructure::getFieldsForTable('post-thread', $fields);
+               $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread', $fields);
                if (!empty($update_fields)) {
                        $affected_count = 0;
                        $posts = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
@@ -545,7 +610,7 @@ class Post
                        $affected = max($affected, $affected_count);
                }
 
-               $update_fields = DBStructure::getFieldsForTable('post-thread-user', $fields);
+               $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread-user', $fields);
                if (!empty($update_fields)) {
                        $affected_count = 0;
                        $posts = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
@@ -579,7 +644,7 @@ class Post
         * @return boolean was the delete successful?
         * @throws \Exception
         */
-       public static function delete(array $conditions, array $options = [])
+       public static function delete(array $conditions, array $options = []): bool
        {
                return DBA::delete('post', $conditions, $options);
        }