Changeset 10765

Timestamp:

03/04/2021 11:49:42 PM (5 years ago)

Author:

coffee2code

Message:

Handbooks, Init: Add get_handbook() for obtaining a handbook based on post type.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook

Files:

• inc/init.php (modified) (1 diff)
• phpunit/tests/init.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/init.php

@@ -20 +20 @@
     public static function get_handbook_objects() {
         return self::$handbooks;
+    }
+
+    /**
+     * Returns a handbook of the given post type.
+     *
+     * @param string $post_type The handbook post type.
+     * @return WPorg_Handbook|false The handbook object, or false if no such
+     *                              handbook.
+     */
+    public static function get_handbook( $post_type ) {
+        $handbooks = self::get_handbook_objects();
+        return $handbooks[ $post_type ] ?? false;
     }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/init.php

@@ -70 +70 @@
 
     /*
+     * get_handbook()
+     */
+
+    public function test_get_handbook_for_invalid_handbook() {
+        $this->assertFalse( WPorg_Handbook_Init::get_handbook( 'nonexistent-handbook' ) );
+    }
+
+    public function test_get_handbook() {
+        $handbook = WPorg_Handbook_Init::get_handbook( 'handbook' );
+
+        $this->assertTrue( is_a( $handbook, 'WPorg_Handbook' ) );
+        $this->assertEquals( 'handbook', $handbook->post_type );
+    }
+
+    public function test_get_handbook_when_multiple_handbooks_present() {
+        reinit_handbooks( [ 'plugins-handbook', 'themes-handbook' ], 'post_types' );
+
+        $handbook = WPorg_Handbook_Init::get_handbook( 'plugins-handbook' );
+
+        $this->assertTrue( is_a( $handbook, 'WPorg_Handbook' ) );
+        $this->assertEquals( 'plugins-handbook', $handbook->post_type );
+    }
+
+    /*
      * get_post_types()
      */