Ticket #2959: 2959.diff

src/includes/users/functions.php

@@ -169 +169 @@
         return apply_filters( 'bbp_current_author_ua', $retval );
 }
 
+/** User Taxonomy Terms *******************************************************/
+
+/**
+ * Check if the user term is set on an object
+ *
+ * @since 2.7 bbPress ()
+ *
+ * @param int $object_id The object id
+ * @param int $user_id The user id
+ * @param string $taxonomy The object user taxonomy
+ * @uses get_post_meta() To check if the user term is set on the object
+ * @uses apply_filters() Calls 'bbp_object_has_user_term' with the object id,
+ *                        user id, and taxonomy
+ * @return bool Returns true if the user term is set on the object for the
+ *               taxonomy, otherwise false
+ */
+function bbp_object_has_user_term( $object_id = 0, $user_id = 0, $taxonomy = '' ) {
+        if ( empty( $object_id ) || empty( $user_id ) || empty( $taxonomy ) ) {
+                return;
+        }
+
+        $user_ids = get_post_meta( $object_id, $taxonomy, false );
+        $retval = (bool) in_array( $user_id, $user_ids );
+        return apply_filters( 'bbp_object_has_user_term', $retval, $object_id, $user_id, $taxonomy );
+}
+
+/**
+ * Set a user term on an object
+ *
+ * @since 2.7 bbPress ()
+ *
+ * @param int $object_id The object id
+ * @param int $user_id The user id
+ * @param string $taxonomy The user term taxonomy
+ * @uses bbp_object_has_user_term() To check if the term has already been set
+ * @uses add_post_meta() To set the term on the object
+ * @uses apply_filters() Calls 'bbp_add_object_user_term' with the object id, user
+ *                        id, and taxonomy
+ * @return bool Returns true if the user taxonomy term is added to the object,
+ *               otherwise false
+ */
+function bbp_add_object_user_term( $object_id = 0, $user_id = 0, $taxonomy = '' ) {
+        if ( empty( $object_id ) || empty( $user_id ) || empty( $taxonomy ) ) {
+                return;
+        }
+
+        if ( bbp_object_has_user_term( $object_id, $user_id, $taxonomy ) ) {
+                $retval = false;
+        } else {
+                $retval = (bool) add_post_meta( $object_id, $taxonomy, $user_id, false );
+        }
+        return apply_filters( 'bbp_add_object_user_term', $retval, $object_id, $user_id, $taxonomy );
+}
+
+/**
+ * Remove a user term from an object
+ *
+ * @since 2.7 bbPress ()
+ *
+ * @param int $object_id The post id
+ * @param int $user_id The user id
+ * @param string $taxonomy The user term taxonomy
+ * @uses bbp_object_has_user_term() To check if the term is set
+ * @uses delete_post_meta() To remove the term from the object
+ * @uses apply_filters() Calls 'bbp_remove_object_user_term' with the object
+ *                        id, user id, and taxonomy
+ * @return bool Returns true is the user taxonomy term is removed from the object,
+ *               otherwise false
+ */
+function bbp_remove_object_user_term( $object_id = 0, $user_id = 0, $taxonomy = '' ) {
+        if ( empty( $object_id ) || empty( $user_id ) || empty( $taxonomy ) ) {
+                return;
+        }
+
+        if ( ! bbp_object_has_user_term( $object_id, $user_id, $taxonomy ) ) {
+                $retval = false;
+        } else {
+                $retval = delete_post_meta( $object_id, $taxonomy, $user_id );
+        }
+        return apply_filters( 'bbp_remove_object_user_term', $retval, $object_id, $user_id, $taxonomy );
+}
+
+/**
+ * Get objects for a user taxonomy term
+ *
+ * @since 2.7 bbPress ()
+ *
+ * @param int $user_id The user id
+ * @param string $taxonomy The user term taxonomy
+ * @param string $object_type Optional. The object type
+ * @uses post_type_exists() To validate the object type
+ * @uses get_posts() To get the objects with a meta query
+ * @uses apply_filters() Calls 'bbp_get_objects_by_user_term' with the objects,
+ *                        user_id, taxonomy, and object type
+ * @return array Returns the objects with the user taxonomy term
+ */
+function bbp_get_objects_by_user_term( $user_id = 0, $taxonomy = '', $object_type = null ) {
+        if ( empty( $user_id ) || empty( $taxonomy ) || $object_type && ! post_type_exists( $object_type ) ) {
+                return;
+        }
+
+        $args = array(
+                'meta_key'    => $taxonomy,
+                'meta_type'   => 'NUMERIC',
+                'meta_value'  => $user_id,
+                'numberposts' => -1
+        );
+        if ( $object_type ) {
+                $args['post_type'] = $object_type;
+        }
+        $objects = get_posts( $args );
+        return apply_filters( 'bbp_get_objects_by_user_term', $objects, $user_id, $taxonomy, $object_type );
+}
+
+/**
+ * Get user taxonomy terms for an object
+ *
+ * @since 2.7 bbPress ()
+ *
+ * @param int $object_id The object id
+ * @param string $taxonomy The user term taxonomy
+ * @uses get_post_meta() To get the user taxonomy terms
+ * @uses apply_filters() Calls 'bbp_get_user_terms_by_object' with the user
+ *                        taxonomy terms, object id, and taxonomy
+ * @return array Returns the user taxonomy terms of the object
+ */
+function bbp_get_user_terms_by_object( $object_id = 0, $taxonomy = '' ) {
+        if ( empty( $object_id ) || empty( $taxonomy ) ) {
+                return;
+        }
+
+        $retval = get_post_meta( $object_id, $taxonomy, false );
+        return apply_filters( 'bbp_get_user_terms_by_object', $retval, $object_id, $taxonomy );
+}
+
 /** Favorites *****************************************************************/
 
 /**

tests/phpunit/testcases/users/functions/functions.php

@@ -86 +86 @@
         }
 
         /**
+         * @covers ::bbp_object_has_user_term
+         */
+        public function test_bbp_object_has_user_term() {
+                $u = $this->factory->user->create();
+                $t = $this->factory->topic->create();
+
+                $r = bbp_object_has_user_term( $t, $u, $this->user_taxonomy );
+
+                $this->assertFalse( $r );
+
+                // Add user term.
+                add_post_meta( $t, $this->user_taxonomy, $u, false );
+
+                $r = bbp_object_has_user_term( $t, $u, $this->user_taxonomy );
+
+                $this->assertTrue( $r );
+        }
+
+        /**
+         * @covers ::bbp_add_object_user_term
+         */
+        public function test_bbp_add_object_user_term() {
+                $u = $this->factory->user->create_many( 3 );
+                $t = $this->factory->topic->create();
+
+                // Add object terms.
+                foreach ( $u as $k => $v ) {
+                        bbp_add_object_user_term( $t, $v, $this->user_taxonomy );
+                }
+
+                $r = get_post_meta( $t, $this->user_taxonomy, false );
+
+                $this->assertCount( 3, $r );
+        }
+
+        /**
+         * @covers ::bbp_remove_object_user_term
+         */
+        public function test_bbp_remove_object_user_term() {
+                $u = $this->factory->user->create();
+                $t = $this->factory->topic->create();
+
+                // Add object terms.
+                add_post_meta( $t, $this->user_taxonomy, $u, false );
+
+                $r = get_post_meta( $t, $this->user_taxonomy, false );
+
+                $this->assertCount( 1, $r );
+
+                $r = bbp_remove_object_user_term( $t, $u, $this->user_taxonomy );
+
+                $this->assertTrue( $r );
+
+                $r = get_post_meta( $t, $this->user_taxonomy, false );
+
+                $this->assertCount( 0, $r );
+        }
+
+        /**
+         * @covers ::bbp_get_objects_by_user_term
+         */
+        public function test_bbp_get_objects_by_user_term() {
+                $u = $this->factory->user->create();
+                $t = $this->factory->topic->create_many( 3 );
+
+                // Add object terms.
+                foreach ( $t as $k => $v ) {
+                        add_post_meta( $v, $this->user_taxonomy, $u, false );
+                }
+
+                $r = bbp_get_objects_by_user_term( $u, $this->user_taxonomy, 'topic' );
+
+                $this->assertCount( 3, $r );
+        }
+
+        /**
+         * @covers ::bbp_get_user_terms_by_object
+         */
+        public function test_bbp_get_user_terms_by_object() {
+                $u = $this->factory->user->create_many( 3 );
+                $t = $this->factory->topic->create();
+
+                // Add object terms.
+                foreach ( $u as $k => $v ) {
+                        add_post_meta( $t, $this->user_taxonomy, $u, false );
+                }
+
+                $r = bbp_get_user_terms_by_object( $t, $this->user_taxonomy );
+
+                $this->assertCount( 3, $r );
+        }
+
+        /**
          * @covers ::bbp_edit_user_handler
          * @todo   Implement test_bbp_edit_user_handler().
          */
@@ -172 +265 @@
                         'This test has not been implemented yet.'
                 );
         }
+
+        public function setUp() {
+                parent::setUp();
+
+                $this->user_taxonomy = '_bbp_test_user_taxonomy';
+        }
 }