<!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>[2124] 2013/frederickding/importer/trunk: Add PHPDoc to explain more thoroughly all WP_Importer_Cron methods.</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 { 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">
<dt>Revision</dt> <dd><a href="http://gsoc.trac.wordpress.org/changeset/2124">2124</a></dd>
<dt>Author</dt> <dd>frederick.ding</dd>
<dt>Date</dt> <dd>2013-07-17 03:35:47 +0000 (Wed, 17 Jul 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add PHPDoc to explain more thoroughly all WP_Importer_Cron methods.
See <a href="http://gsoc.trac.wordpress.org/ticket/327">#327</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#2013frederickdingimportertrunkgitignore">2013/frederickding/importer/trunk/.gitignore</a></li>
<li><a href="#2013frederickdingimportertrunkclasswpimportercronphp">2013/frederickding/importer/trunk/class-wp-importer-cron.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="2013frederickdingimportertrunkgitignore"></a>
<div class="modfile"><h4>Modified: 2013/frederickding/importer/trunk/.gitignore (2123 => 2124)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/frederickding/importer/trunk/.gitignore 2013-07-16 22:54:22 UTC (rev 2123)
+++ 2013/frederickding/importer/trunk/.gitignore 2013-07-17 03:35:47 UTC (rev 2124)
</span><span class="lines">@@ -1 +1,4 @@
</span><span class="cx"> .idea/
</span><ins>+.settings/
+.buildpath
+.project
</ins></span></pre></div>
<a id="2013frederickdingimportertrunkclasswpimportercronphp"></a>
<div class="modfile"><h4>Modified: 2013/frederickding/importer/trunk/class-wp-importer-cron.php (2123 => 2124)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/frederickding/importer/trunk/class-wp-importer-cron.php 2013-07-16 22:54:22 UTC (rev 2123)
+++ 2013/frederickding/importer/trunk/class-wp-importer-cron.php 2013-07-17 03:35:47 UTC (rev 2124)
</span><span class="lines">@@ -6,6 +6,9 @@
</span><span class="cx"> *
</span><span class="cx"> * Forked from the Tumblr Importer (http://wordpress.org/plugins/tumblr-importer/)
</span><span class="cx"> * at revision 477917; original work by Otto42 and westi.
</span><ins>+ *
+ * @package WordPress
+ * @subpackage Importer
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> if ( !class_exists( 'WP_Importer_Cron' ) ) :
</span><span class="lines">@@ -21,6 +24,10 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ *
+ * @since 0.7.0
+ */
</ins><span class="cx"> class WP_Importer_Cron extends WP_Importer {
</span><span class="cx">
</span><span class="cx"> function __construct() {
</span><span class="lines">@@ -35,7 +42,7 @@
</span><span class="cx"> // add the importer hook
</span><span class="cx"> add_action( 'wp_cron_importer_hook', array( $this, 'importer_callback' ) );
</span><span class="cx">
</span><del>- //load the variables
</del><ins>+ // load the variables
</ins><span class="cx"> $options = get_option( get_class($this) );
</span><span class="cx">
</span><span class="cx"> if ( is_array($options) )
</span><span class="lines">@@ -43,25 +50,51 @@
</span><span class="cx"> $this->$key = $value;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Check to see if you have time remaining on the clock
</del><ins>+ /**
+ * Checks whether there is time remaining until the execution deadline.
+ *
+ * @return boolean
+ */
</ins><span class="cx"> function have_time() {
</span><del>- if ( time() - $this->_importer_started > $this->_max_execution_time ) return false;
</del><ins>+ if ( time() - $this->_importer_started > $this->_max_execution_time )
+ return false;
</ins><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // add the once every three minute schedule
</del><ins>+ /**
+ * Registers a per-minute cron schedule.
+ *
+ * This is a filter for cron_schedules.
+ *
+ * @see wp_get_schedules()
+ * @param array $schedules
+ * @return array filtered schedules
+ */
</ins><span class="cx"> function importer_schedule( $schedules ) {
</span><del>- $schedules['everyminute'] = array( 'interval' => 60, 'display' => __('Every Minute') );
</del><ins>+ $schedules['everyminute'] = array(
+ 'interval' => 60,
+ 'display' => __( 'Once Per Minute' )
+ );
</ins><span class="cx"> return $schedules;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // schedule an importer job
- function schedule_import_job( $function_name, $args=array() ) {
</del><ins>+ /**
+ * Schedules an importer job on the per-minute cron schedule.
+ *
+ * @param callback $function_name
+ * @param array $args optional
+ */
+ function schedule_import_job( $function_name, $args = array() ) {
</ins><span class="cx"> $this->callback = $function_name;
</span><del>- wp_schedule_event(time(), 'everyminute', 'wp_cron_importer_hook' , $args);
</del><ins>+ wp_schedule_event( time(), 'everyminute', 'wp_cron_importer_hook',
+ $args );
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- // internal callback that checks for a finished import and clears old jobs out
</del><ins>+ /**
+ * Dispatches a cron event to an importer job or cleans up.
+ *
+ * @param array $args optional
+ */
</ins><span class="cx"> function importer_callback( $args=array() ) {
</span><span class="cx"> $args = (array)$args;
</span><span class="cx">
</span><span class="lines">@@ -78,15 +111,23 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // function to let the class save its own variables
</del><ins>+ /**
+ * Saves object variables to an option for statefulness.
+ *
+ * On later runs, these variables are loaded from the option during
+ * instantiation.
+ *
+ * @return boolean
+ */
</ins><span class="cx"> function save_vars() {
</span><del>- $vars = get_object_vars($this);
- foreach($vars as $var=>$val) {
- if ($var[0] == "_") unset ($vars[$var]);
</del><ins>+ $vars = get_object_vars( $this );
+ foreach ( $vars as $var => $val ) {
+ if ( $var[0] == "_" )
+ unset( $vars[$var] );
</ins><span class="cx"> }
</span><del>- update_option( get_class($this), $vars );
-
- return !empty($vars);
</del><ins>+ update_option( get_class( $this ), $vars );
+
+ return ! empty( $vars );
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>