<!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>[8688] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer: Developer: Convert WP REST API handbook importer to inherit from `DevHub_Docs_Importer`.</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/8688">8688</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/8688","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 21:34:14 +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: Convert WP REST API handbook importer to inherit from `DevHub_Docs_Importer`.</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>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperinchandbooksphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/handbooks.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincrestapiphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/rest-api.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 21:01:17 UTC (rev 8687)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php 2019-04-25 21:34:14 UTC (rev 8688)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,12 +74,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Coding Standards handbook.
</span><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/inc/import-coding-standards.php';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-}
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/**
- * REST API handbook.
- */
-if ( class_exists( '\\WordPressdotorg\\Markdown\\Importer' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // REST API handbook.
</ins><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/inc/rest-api.php';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperinchandbooksphp"></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/inc/handbooks.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/handbooks.php 2019-04-25 21:01:17 UTC (rev 8687)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/handbooks.php 2019-04-25 21:34:14 UTC (rev 8688)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,7 +26,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public static function init() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'handbook_post_type_defaults', array( __CLASS__, 'filter_handbook_post_type_defaults' ), 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'handbook_post_types', array( __CLASS__, 'filter_handbook_post_types' ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'handbook_label', array( __CLASS__, 'filter_handbook_label' ), 10, 2 );
</del><span class="cx" style="display: block; padding: 0 10px"> add_action( 'init', array( __CLASS__, 'do_init' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -97,7 +96,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function filter_handbook_post_types( $types ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! self::$post_types ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::$post_types = apply_filters( 'devhub_handbook_post_types', [ 'plugin', 'rest-api', 'theme' ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$post_types = apply_filters( 'devhub_handbook_post_types', [ 'plugin', 'theme' ] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return self::$post_types;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,23 +186,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 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;
- }
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * For specific credit pages, link @usernames references to their profiles on
</span><span class="cx" style="display: block; padding: 0 10px"> * profiles.wordpress.org.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincrestapiphp"></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/inc/rest-api.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/rest-api.php 2019-04-25 21:01:17 UTC (rev 8687)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/rest-api.php 2019-04-25 21:34:14 UTC (rev 8688)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,71 +1,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-use WordPressdotorg\Markdown\Editor;
-use WordPressdotorg\Markdown\Importer;
-
-class DevHub_REST_API extends Importer {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+class DevHub_REST_API extends DevHub_Docs_Importer {
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Singleton instance.
- *
- * @var static
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Initializes object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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';
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> public function init() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ parent::do_init(
+ 'rest-api',
+ 'rest-api',
+ 'https://raw.githubusercontent.com/WP-API/docs/master/bin/manifest.json'
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $editor = new Editor( $this );
- $editor->init();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'handbook_label', array( $this, 'change_handbook_label' ), 10, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter cron schedules to add a 15 minute schedule, if there isn't one.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function filter_cron_schedules( $schedules ) {
- if ( empty( $schedules['15_minutes'] ) ) {
- $schedules['15_minutes'] = array(
- 'interval' => 15 * MINUTE_IN_SECONDS,
- 'display' => '15 minutes'
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function change_handbook_label( $label, $post_type ) {
+ if ( $this->get_post_type() === $post_type ) {
+ $label = __( 'REST API Handbook', 'wporg' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $schedules;
- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $label;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>