<!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>[38112] trunk/src/wp-includes/class-feed.php: Docs: Add missing class, method, and property DocBlocks for feed classes.</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/38112">38112</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/38112","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-07-20 07:32:26 +0000 (Wed, 20 Jul 2016)</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'>Docs: Add missing class, method, and property DocBlocks for feed classes.
Covers:
* `WP_Feed_Cache`
* `WP_Feed_Cache_Transient`
* `WP_SimplePie_File`
* `WP_SimplePie_Sanitize_KSES`
Props ramiy, stevenkword.
Fixes <a href="https://core.trac.wordpress.org/ticket/36295">#36295</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclassfeedphp">trunk/src/wp-includes/class-feed.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclassfeedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-feed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-feed.php 2016-07-20 06:48:26 UTC (rev 38111)
+++ trunk/src/wp-includes/class-feed.php 2016-07-20 07:32:26 UTC (rev 38112)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,11 +3,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! class_exists( 'SimplePie', false ) )
</span><span class="cx" style="display: block; padding: 0 10px"> require_once( ABSPATH . WPINC . '/class-simplepie.php' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Core class used to implement a feed cache.
+ *
+ * @since 2.8.0
+ *
+ * @see SimplePie_Cache
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> class WP_Feed_Cache extends SimplePie_Cache {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Create a new SimplePie_Cache object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Creates a new SimplePie_Cache 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">- * @static
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.8.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $location URL location (scheme is used to determine handler).
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,14 +28,49 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Core class used to implement feed cache transients.
+ *
+ * @since 2.8.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> class WP_Feed_Cache_Transient {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Holds the transient name.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var string
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public $name;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Holds the transient mod name.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var string
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public $mod_name;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public $lifetime = 43200; //Default lifetime in cache of 12 hours
</del><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">- * Class instantiator.
- *
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Holds the cache duration in seconds.
+ *
+ * Defaults to 43200 seconds (12 hours).
+ *
+ * @since 2.8.0
+ * @access public
+ * @var int
+ */
+ public $lifetime = 43200;
+
+ /**
+ * Constructor.
+ *
+ * @since 2.8.0
+ * @since 3.2.0 Updated to use a PHP5 constructor.
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $location URL location (scheme is used to determine handler).
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $filename Unique identifier for cache object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $extension 'spi' or 'spc'.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -49,6 +92,9 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets the transient.
+ *
+ * @since 2.8.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param SimplePie $data Data to save.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,28 +111,48 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets the transient.
+ *
+ * @since 2.8.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return mixed Transient value.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function load() {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_transient($this->name);
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets mod transient.
+ *
+ * @since 2.8.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return mixed Transient value.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function mtime() {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_transient($this->mod_name);
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets mod transient.
+ *
+ * @since 2.8.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return bool False if value was not set and true if value was set.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function touch() {
</span><span class="cx" style="display: block; padding: 0 10px"> return set_transient($this->mod_name, time(), $this->lifetime);
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deletes transients.
+ *
+ * @since 2.8.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return true Always true.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function unlink() {
</span><span class="cx" style="display: block; padding: 0 10px"> delete_transient($this->name);
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -95,8 +161,32 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Core class for fetching remote files and reading local files with SimplePie.
+ *
+ * @since 2.8.0
+ *
+ * @see SimplePie_File
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> class WP_SimplePie_File extends SimplePie_File {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Constructor.
+ *
+ * @since 2.8.0
+ * @since 3.2.0 Updated to use a PHP5 constructor.
+ * @access public
+ *
+ * @param string $url Remote file URL.
+ * @param integer $timeout Optional. How long the connection should stay open in seconds.
+ * Default 10.
+ * @param integer $redirects Optional. The number of allowed redirects. Default 5.
+ * @param string|array $headers Optional. Array or string of headers to send with the request.
+ * Default null.
+ * @param string $useragent Optional. User-agent value sent. Default null.
+ * @param boolean $force_fsockopen Optional. Whether to force opening internet or unix domain socket
+ * connection or not. Default false.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function __construct($url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->url = $url;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->timeout = $timeout;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -136,15 +226,31 @@
</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">- * WordPress SimplePie Sanitization Class
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Core class used to implement SimpliePie feed sanitization.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Extension of the SimplePie_Sanitize class to use KSES, because
- * we cannot universally count on DOMDocument being available
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Extends the SimplePie_Sanitize class to use KSES, because
+ * we cannot universally count on DOMDocument being available.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @package WordPress
</del><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @see SimplePie_Sanitize
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_SimplePie_Sanitize_KSES extends SimplePie_Sanitize {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * WordPress SimplePie sanitization using KSES.
+ *
+ * Sanitizes the incoming data, to ensure that it matches the type of data expected, using KSES.
+ *
+ * @since 3.5.0
+ * @access public
+ *
+ * @param mixed $data The data that needs to be sanitized.
+ * @param integer $type The type of data that it's supposed to be.
+ * @param string $base Optional. The `xml:base` value to use when converting relative
+ * URLs to absolute ones. Default empty.
+ * @return mixed Sanitized data.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function sanitize( $data, $type, $base = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data = trim( $data );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $type & SIMPLEPIE_CONSTRUCT_MAYBE_HTML ) {
</span></span></pre>
</div>
</div>
</body>
</html>