]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Post.php
Merge pull request #9 from nupplaphil/dependabot/composer/guzzlehttp/guzzle-6.5.8
[friendica.git] / src / Model / Post.php
index d56674c3e09ddc4388856883012245163e67929b..56898e3b2961d4c20119fd9512add03d18ad02ad 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
  *
@@ -39,7 +39,7 @@ 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');
@@ -107,8 +107,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,19 +126,20 @@ class Post
        }
 
        /**
-        * Check if post data exists
+        * Check if post-user-view records exists
         *
         * @param array $condition array of fields for condition
         *
         * @return boolean Are there rows for that condition?
         * @throws \Exception
         */
-       public static function exists($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
@@ -151,22 +154,65 @@ class Post
         * $count = Post::count($condition);
         * @throws \Exception
         */
-       public static function count(array $condition = [], array $params = [])
+       public static function count(array $condition = [], array $params = []): int
        {
                return DBA::count('post-user-view', $condition, $params);
        }
 
        /**
-        * Retrieve a single record from the post table and returns it in an associative array
+        * 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('post-view', $condition, $params);
+       }
+
+       /**
+        * Retrieve a single record from the post-user-view view and returns it in an associative array
         *
         * @param array $fields
         * @param array $condition
         * @param array $params
+        * @param bool  $user_mode true = post-user-view, false = post-view
         * @return bool|array
         * @throws \Exception
         * @see   DBA::select
         */
-       public static function selectFirst(array $fields = [], array $condition = [], $params = [])
+       public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
        {
                $params['limit'] = 1;
 
@@ -182,7 +228,32 @@ 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-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::selectPosts($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-thread-user-view view and returns it in an associative array
         *
         * @param array $fields
         * @param array $condition
@@ -191,7 +262,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;
 
@@ -207,7 +278,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
@@ -216,7 +287,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);
 
@@ -244,7 +315,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);
@@ -260,7 +331,7 @@ 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
@@ -269,13 +340,28 @@ class Post
         * @return boolean|object
         * @throws \Exception
         */
-       public static function select(array $selected = [], array $condition = [], $params = [])
+       public static function select(array $selected = [], array $condition = [], array $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
+        * @param array $params    Array of several parameters
+        *
+        * @return boolean|object
+        * @throws \Exception
+        */
+       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
@@ -284,7 +370,7 @@ class Post
         * @return boolean|object
         * @throws \Exception
         */
-       public static function selectThread(array $selected = [], array $condition = [], $params = [])
+       public static function selectThread(array $selected = [], array $condition = [], array $params = [])
        {
                return self::selectView('post-thread-user-view', $selected, $condition, $params);
        }
@@ -301,7 +387,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;
@@ -332,7 +418,7 @@ 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
@@ -342,13 +428,29 @@ class Post
         * @return boolean|object
         * @throws \Exception
         */
-       public static function selectForUser($uid, array $selected = [], array $condition = [], $params = [])
+       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 for a given user
+       /**
+        * 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
+        *
+        * @return boolean|object
+        * @throws \Exception
+        */
+       public static function selectPostsForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
+       {
+               return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
+       }
+
+       /**
+        * 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
@@ -358,13 +460,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
@@ -374,7 +476,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;
 
@@ -389,39 +491,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
         *
@@ -574,7 +643,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);
        }