<!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>[32534] trunk/src/wp-includes/class-wp-admin-bar.php: In `class-wp-admin-bar.php`, clarify/add some doc blocks.</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/32534">32534</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/32534","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-21 21:38:41 +0000 (Thu, 21 May 2015)</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'>In `class-wp-admin-bar.php`, clarify/add some doc blocks.
See <a href="https://core.trac.wordpress.org/ticket/32444">#32444</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpadminbarphp">trunk/src/wp-includes/class-wp-admin-bar.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpadminbarphp"></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-wp-admin-bar.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-admin-bar.php 2015-05-21 21:30:31 UTC (rev 32533)
+++ trunk/src/wp-includes/class-wp-admin-bar.php 2015-05-21 21:38:41 UTC (rev 32534)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,6 +12,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private $bound = false;
</span><span class="cx" style="display: block; padding: 0 10px"> public $user;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @param string $name
+ * @return string|array|null
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function __get( $name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'proto' :
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,10 +73,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'admin_bar_init' );
</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">+ /**
+ * @param array $node
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function add_menu( $node ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->add_node( $node );
</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">+ /**
+ * @param string $id
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function remove_menu( $id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->remove_node( $id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -143,6 +153,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_set_node( $args );
</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">+ /**
+ * @param array $args
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final protected function _set_node( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->nodes[ $args['id'] ] = (object) $args;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -150,6 +163,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Gets a node.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $id
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return object Node.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> final public function get_node( $id ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -157,6 +171,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return clone $node;
</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">+ /**
+ * @param string $id
+ * @return object|null
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final protected function _get_node( $id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->bound )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -168,6 +186,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->nodes[ $id ];
</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">+ /**
+ * @return array|null
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final public function get_nodes() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $nodes = $this->_get_nodes() )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -178,6 +199,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $nodes;
</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">+ /**
+ * @return array|null
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final protected function _get_nodes() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->bound )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,12 +232,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Remove a node.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string The ID of the item.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $id The ID of the item.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function remove_node( $id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_unset_node( $id );
</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">+ /**
+ * @param string $id
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final protected function _unset_node( $id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $this->nodes[ $id ] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,6 +251,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_render( $root );
</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">+ /**
+ * @return object|null
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final protected function _bind() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->bound )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -345,6 +375,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $root;
</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">+ /**
+ *
+ * @global bool $is_IE
+ * @param object $root
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final protected function _render( $root ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $is_IE;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -380,6 +415,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?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">+ /**
+ * @param object $node
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final protected function _render_container( $node ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $node->type != 'container' || empty( $node->children ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -391,10 +429,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ?></div><?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">+ /**
+ * @param object $node
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final protected function _render_group( $node ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $node->type == 'container' )
- return $this->_render_container( $node );
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $node->type == 'container' ) {
+ $this->_render_container( $node );
+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $node->type != 'group' || empty( $node->children ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -410,6 +452,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ?></ul><?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">+ /**
+ * @param object $node
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> final protected function _render_item( $node ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $node->type != 'item' )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -482,6 +527,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </li><?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">+ /**
+ * @param string $id Unused.
+ * @param object $node
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function recursive_render( $id, $node ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _deprecated_function( __METHOD__, '3.3', 'WP_Admin_bar::render(), WP_Admin_Bar::_render_item()' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_render_item( $node );
</span></span></pre>
</div>
</div>
</body>
</html>