Changeset 8688

Timestamp:

04/25/2019 09:34:14 PM (6 years ago)

Author:

coffee2code

Message:

Developer: Convert WP REST API handbook importer to inherit from DevHub_Docs_Importer.

Location:

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer

Files:

• functions.php (modified) (1 diff)
• inc/handbooks.php (modified) (3 diffs)
• inc/rest-api.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php

@@ -75 +75 @@
     // Coding Standards handbook.
     require __DIR__ . '/inc/import-coding-standards.php';
-}
-
-/**
- * REST API handbook.
- */
-if ( class_exists( '\\WordPressdotorg\\Markdown\\Importer' ) ) {
+
+    // REST API handbook.
     require __DIR__ . '/inc/rest-api.php';
 }

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/handbooks.php

@@ -27 +27 @@
         add_filter( 'handbook_post_type_defaults', array( __CLASS__, 'filter_handbook_post_type_defaults' ), 10, 2 );
         add_filter( 'handbook_post_types', array( __CLASS__, 'filter_handbook_post_types' ) );
-        add_filter( 'handbook_label', array( __CLASS__, 'filter_handbook_label' ), 10, 2 );
         add_action( 'init', array( __CLASS__, 'do_init' ) );
     }
@@ -98 +97 @@
     public static function filter_handbook_post_types( $types ) {
         if ( ! self::$post_types ) {
-            self::$post_types = apply_filters( 'devhub_handbook_post_types', [ 'plugin', 'rest-api', 'theme' ] );
+            self::$post_types = apply_filters( 'devhub_handbook_post_types', [ 'plugin', 'theme' ] );
         }
 
@@ -188 +187 @@
 
     /**
-     * Overrides the default handbook label used as the base for various handbook
-     * post type related strings.
-     *
-     * @param string $label     The default label, which is merely a santized
-     *                          version of the handbook name.
-     * @param string $post_type The handbook post type.
-     * @return string
-     */
-    public static function filter_handbook_label( $label, $post_type ) {
-        if ( 'rest-api-handbook' === $post_type ) {
-            $label = __( 'REST API Handbook', 'wporg' );
-        }
-
-        return $label;
-    }
-
-    /**
      * For specific credit pages, link @usernames references to their profiles on
      * profiles.wordpress.org.

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/rest-api.php

@@ -1 +1 @@
 <?php
 
-use WordPressdotorg\Markdown\Editor;
-use WordPressdotorg\Markdown\Importer;
+class DevHub_REST_API extends DevHub_Docs_Importer {
+    /**
+     * Initializes object.
+     */
+    public function init() {
+        parent::do_init(
+            'rest-api',
+            'rest-api',
+            'https://raw.githubusercontent.com/WP-API/docs/master/bin/manifest.json'
+        );
 
-class DevHub_REST_API extends Importer {
-    /**
-     * Singleton instance.
-     *
-     * @var static
-     */
-    protected static $instance;
-
-    /**
-     * Get the singleton instance, or create if needed.
-     *
-     * @return static
-     */
-    public static function instance() {
-        if ( empty( static::$instance ) ) {
-            static::$instance = new static();
-        }
-
-        return static::$instance;
-    }
-
-    protected function get_base() {
-        return home_url( 'rest-api/' );
-    }
-
-    protected function get_manifest_url() {
-        return 'https://raw.githubusercontent.com/WP-API/docs/master/bin/manifest.json';
-    }
-
-    public function get_post_type() {
-        return 'rest-api-handbook';
-    }
-
-    public function init() {
-        add_filter( 'cron_schedules', array( $this, 'filter_cron_schedules' ) );
-        add_action( 'init', array( $this, 'register_cron_jobs' ) );
-        add_action( 'devhub_restapi_import_manifest', array( $this, 'import_manifest' ) );
-        add_action( 'devhub_restapi_import_all_markdown', array( $this, 'import_all_markdown' ) );
-
-        $editor = new Editor( $this );
-        $editor->init();
+        add_filter( 'handbook_label', array( $this, 'change_handbook_label' ), 10, 2 );
     }
 
     /**
-     * Filter cron schedules to add a 15 minute schedule, if there isn't one.
+     * Overrides the default handbook label since post type name does not directly
+     * translate to post type label.
+     *
+     * @param string $label     The default label, which is merely a sanitized
+     *                          version of the handbook name.
+     * @param string $post_type The handbook post type.
+     * @return string
      */
-    public function filter_cron_schedules( $schedules ) {
-        if ( empty( $schedules['15_minutes'] ) ) {
-            $schedules['15_minutes'] = array(
-                'interval' => 15 * MINUTE_IN_SECONDS,
-                'display'  => '15 minutes'
-            );
+    public static function change_handbook_label( $label, $post_type ) {
+        if ( $this->get_post_type() === $post_type ) {
+            $label = __( 'REST API Handbook', 'wporg' );
         }
-        return $schedules;
-    }
 
-    public function register_cron_jobs() {
-        if ( ! wp_next_scheduled( 'devhub_restapi_import_manifest' ) ) {
-            wp_schedule_event( time(), '15_minutes', 'devhub_restapi_import_manifest' );
-        }
-        if ( ! wp_next_scheduled( 'devhub_restapi_import_all_markdown' ) ) {
-            wp_schedule_event( time(), '15_minutes', 'devhub_restapi_import_all_markdown' );
-        }
+        return $label;
     }
 }