<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[8685] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer: Developer: Add base class `DevHub_Docs_Importer` to handle the majority of DevHub-specific functionality related to importing GitHub-hosted docs.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/8685">8685</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/8685","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-04-25 20:19:28 +0000 (Thu, 25 Apr 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Developer: Add base class `DevHub_Docs_Importer` to handle the majority of DevHub-specific functionality related to importing GitHub-hosted docs.
See <a href="http://meta.trac.wordpress.org/ticket/3377">#3377</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperfunctionsphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincimportdocsphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/import-docs.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php 2019-04-25 20:17:09 UTC (rev 8684)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php 2019-04-25 20:19:28 UTC (rev 8685)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,6 +66,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/inc/cli.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Docs importer.
+ */
+if ( class_exists( '\\WordPressdotorg\\Markdown\\Importer' ) ) {
+ // Docs Importer base class.
+ require __DIR__ . '/inc/import-docs.php';
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * REST API handbook.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( class_exists( '\\WordPressdotorg\\Markdown\\Importer' ) ) {
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincimportdocsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/import-docs.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/import-docs.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/import-docs.php 2019-04-25 20:19:28 UTC (rev 8685)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,162 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+use WordPressdotorg\Markdown\Editor;
+use WordPressdotorg\Markdown\Importer;
+
+class DevHub_Docs_Importer extends Importer {
+ /**
+ * Singleton instance.
+ *
+ * @var static
+ */
+ protected static $instances;
+
+ /**
+ * The post type for the given docs importer. (Hypenated and without "handbook".)
+ *
+ * @var string
+ */
+ protected $post_type;
+
+ /**
+ * The slug base.
+ *
+ * @var string
+ */
+ protected $base;
+
+ /**
+ * The manifest URL.
+ *
+ * E.g. https://raw.githubusercontent.com/WP-API/docs/master/bin/manifest.json
+ *
+ * @var string
+ */
+ protected $manifest_url;
+
+ /**
+ * Get the singleton instance, or create if needed.
+ *
+ * @return static
+ */
+ public static function instance() {
+ $class = get_called_class();
+
+ if ( empty( static::$instances[ $class ] ) ) {
+ static::$instances[ $class ] = new $class;
+ }
+
+ return static::$instances[ $class ];
+ }
+
+ /**
+ * Returns the base URL for the handbook.
+ *
+ * @return string
+ */
+ protected function get_base() {
+ return home_url( "{$this->base}/" );
+ }
+
+ /**
+ * Returns the manifest URL.
+ *
+ * @return string
+ */
+ protected function get_manifest_url() {
+ return $this->manifest_url;
+ }
+
+ /**
+ * Returns the post type for the imported handbook.
+ *
+ * @return string
+ */
+ public function get_post_type() {
+ return "{$this->post_type}-handbook";
+ }
+
+ /**
+ * Initializes the object.
+ *
+ * @param string $post_type The post type base. Hypenated and without "handbook".
+ * @param string $base The slug for the post type.
+ * @param string $manifest_url The manifest URL.
+ */
+ public function do_init( $post_type, $base, $manifest_url ) {
+ $this->post_type = $post_type;
+ $this->base = $base;
+ $this->manifest_url = $manifest_url;
+
+ add_filter( 'devhub_handbook_post_types', array( $this, 'amend_post_types' ) );
+ add_filter( 'handbook_post_type_defaults', array( $this, 'override_post_type_slug' ), 10, 2 );
+ add_filter( 'cron_schedules', array( $this, 'filter_cron_schedules' ) );
+ add_action( 'init', array( $this, 'register_cron_jobs' ) );
+ add_action( "devhub_{$this->post_type}_import_manifest", array( $this, 'import_manifest' ) );
+ add_action( "devhub_{$this->post_type}_import_all_markdown", array( $this, 'import_all_markdown' ) );
+
+ $editor = new Editor( $this );
+ $editor->init();
+ }
+
+ /**
+ * Adds the post type to the list of handbook post types.
+ *
+ * @param array Array of post type slugs.
+ * @return array
+ */
+ public function amend_post_types( $post_types ) {
+ $post_types[] = $this->post_type;
+
+ return $post_types;
+ }
+
+ /**
+ * Overrides the handbook post type slug.
+ *
+ * This is generally only necessary if the post type does not match the post
+ * type slug.
+ *
+ * @param array $config Array of post type config items.
+ * @param string $slug The post type slug.
+ * @return array
+ */
+ public function override_post_type_slug( $config, $slug ) {
+ // If filtering is for this post type and the base and the post type don't
+ // match, then filter post type defaults.
+ if ( $this->post_type === $config['rewrite']['slug'] && $this->post_type !== $this->base ) {
+ $config['rewrite']['slug'] = $this->base;
+ }
+
+ return $config;
+ }
+
+ /**
+ * Filters cron schedules to add a 15 minute schedule, if there isn't one.
+ *
+ * @param array $schedules Cron schedules.
+ * @return array
+ */
+ public function filter_cron_schedules( $schedules ) {
+ if ( empty( $schedules['15_minutes'] ) ) {
+ $schedules['15_minutes'] = array(
+ 'interval' => 15 * MINUTE_IN_SECONDS,
+ 'display' => '15 minutes'
+ );
+ }
+
+ return $schedules;
+ }
+
+ /**
+ * Registers cron jobs.
+ */
+ public function register_cron_jobs() {
+ if ( ! wp_next_scheduled( "devhub_{$this->post_type}_import_manifest" ) ) {
+ wp_schedule_event( time(), '15_minutes', "devhub_{$this->post_type}_import_manifest" );
+ }
+
+ if ( ! wp_next_scheduled( "devhub_{$this->post_type}_import_all_markdown" ) ) {
+ wp_schedule_event( time(), '15_minutes', "devhub_{$this->post_type}_import_all_markdown" );
+ }
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>