<!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>[BuddyPress][6312] trunk/bp-core/bp-core-classes.php: Buttons:</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, #logmsg > ol { margin-left: 0; 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://buddypress.trac.wordpress.org/changeset/6312">6312</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2012-09-06 04:45:50 +0000 (Thu, 06 Sep 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Buttons:
* Clean up BP_Button class.
* See r6311 for first pass.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcoreclassesphp">trunk/bp-core/bp-core-classes.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcoreclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-classes.php (6311 => 6312)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-classes.php 2012-09-06 04:36:26 UTC (rev 6311)
+++ trunk/bp-core/bp-core-classes.php 2012-09-06 04:45:50 UTC (rev 6312)
</span><span class="lines">@@ -872,6 +872,20 @@
</span><span class="cx"> *
</span><span class="cx"> * API to create BuddyPress buttons
</span><span class="cx"> *
</span><ins>+ * component: Which component this button is for
+ * must_be_logged_in: Button only appears for logged in users
+ * block_self: Button will not appear when viewing your own profile.
+ * wrapper: div|span|p|li|false for no wrapper
+ * wrapper_id: The DOM ID of the button wrapper
+ * wrapper_class: The DOM class of the button wrapper
+ * link_href: The destination link of the button
+ * link_title: Title of the button
+ * link_id: The DOM ID of the button
+ * link_class: The DOM class of the button
+ * link_rel: The DOM rel of the button
+ * link_text: The text of the button
+ * contents: The contents of the button
+ *
</ins><span class="cx"> * @package BuddyPress Core
</span><span class="cx"> * @since BuddyPress (1.2.6)
</span><span class="cx"> */
</span><span class="lines">@@ -980,21 +994,12 @@
</span><span class="cx">
</span><span class="cx"> public $contents = '';
</span><span class="cx">
</span><ins>+ /** Methods ***************************************************************/
+
</ins><span class="cx"> /**
</span><del>- * Builds the button based on passed parameters:
</del><ins>+ * Builds the button based on class parameters:
</ins><span class="cx"> *
</span><del>- * component: Which component this button is for
- * must_be_logged_in: Button only appears for logged in users
- * block_self: Button will not appear when viewing your own profile.
- * wrapper: div|span|p|li|false for no wrapper
- * wrapper_id: The DOM ID of the button wrapper
- * wrapper_class: The DOM class of the button wrapper
- * link_href: The destination link of the button
- * link_title: Title of the button
- * link_id: The DOM ID of the button
- * link_class: The DOM class of the button
- * link_rel: The DOM rel of the button
- * link_text: The contents of the button
</del><ins>+ * @since BuddyPress (1.2.6)
</ins><span class="cx"> *
</span><span class="cx"> * @param array $args
</span><span class="cx"> * @return bool False if not allowed
</span><span class="lines">@@ -1002,25 +1007,24 @@
</span><span class="cx"> public function __construct( $args = '' ) {
</span><span class="cx">
</span><span class="cx"> $r = wp_parse_args( $args, get_class_vars( __CLASS__ ) );
</span><del>- extract( $r, EXTR_SKIP );
</del><span class="cx">
</span><span class="cx"> // Required button properties
</span><del>- $this->id = $id;
- $this->component = $component;
- $this->must_be_logged_in = (bool)$must_be_logged_in;
- $this->block_self = (bool)$block_self;
- $this->wrapper = $wrapper;
</del><ins>+ $this->id = $r['id'];
+ $this->component = $r['component'];
+ $this->must_be_logged_in = (bool) $r['must_be_logged_in'];
+ $this->block_self = (bool) $r['block_self'];
+ $this->wrapper = $r['wrapper'];
</ins><span class="cx">
</span><span class="cx"> // $id and $component are required
</span><del>- if ( empty( $id ) || empty( $component ) )
</del><ins>+ if ( empty( $r['id'] ) || empty( $r['component'] ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> // No button if component is not active
</span><del>- if ( !bp_is_active( $this->component ) )
</del><ins>+ if ( ! bp_is_active( $this->component ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> // No button for guests if must be logged in
</span><del>- if ( true == $this->must_be_logged_in && !is_user_logged_in() )
</del><ins>+ if ( true == $this->must_be_logged_in && ! is_user_logged_in() )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> // No button if viewing your own profile
</span><span class="lines">@@ -1031,20 +1035,20 @@
</span><span class="cx"> if ( false !== $this->wrapper ) {
</span><span class="cx">
</span><span class="cx"> // Wrapper ID
</span><del>- if ( !empty( $wrapper_id ) ) {
- $this->wrapper_id = ' id="' . $wrapper_id . '"';
</del><ins>+ if ( !empty( $r['wrapper_id'] ) ) {
+ $this->wrapper_id = ' id="' . $r['wrapper_id'] . '"';
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Wrapper class
</span><del>- if ( !empty( $wrapper_class ) ) {
- $this->wrapper_class = ' class="generic-button ' . $wrapper_class . '"';
</del><ins>+ if ( !empty( $r['wrapper_class'] ) ) {
+ $this->wrapper_class = ' class="generic-button ' . $r['wrapper_class'] . '"';
</ins><span class="cx"> } else {
</span><span class="cx"> $this->wrapper_class = ' class="generic-button"';
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Set before and after
</span><del>- $before = '<' . $wrapper . $this->wrapper_class . $this->wrapper_id . '>';
- $after = '</' . $wrapper . '>';
</del><ins>+ $before = '<' . $r['wrapper'] . $this->wrapper_class . $this->wrapper_id . '>';
+ $after = '</' . $r['wrapper'] . '>';
</ins><span class="cx">
</span><span class="cx"> // No wrapper
</span><span class="cx"> } else {
</span><span class="lines">@@ -1052,34 +1056,25 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Link properties
</span><del>- if ( !empty( $link_id ) )
- $this->link_id = ' id="' . $link_id . '"';
</del><ins>+ if ( !empty( $r['link_id'] ) ) $this->link_id = ' id="' . $r['link_id'] . '"';
+ if ( !empty( $r['link_href'] ) ) $this->link_href = ' href="' . $r['link_href'] . '"';
+ if ( !empty( $r['link_title'] ) ) $this->link_title = ' title="' . $r['link_title'] . '"';
+ if ( !empty( $r['link_rel'] ) ) $this->link_rel = ' rel="' . $r['link_rel'] . '"';
+ if ( !empty( $r['link_class'] ) ) $this->link_class = ' class="' . $r['link_class'] . '"';
+ if ( !empty( $r['link_text'] ) ) $this->link_text = $r['link_text'];
</ins><span class="cx">
</span><del>- if ( !empty( $link_href ) )
- $this->link_href = ' href="' . $link_href . '"';
-
- if ( !empty( $link_title ) )
- $this->link_title = ' title="' . $link_title . '"';
-
- if ( !empty( $link_rel ) )
- $this->link_rel = ' rel="' . $link_rel . '"';
-
- if ( !empty( $link_class ) )
- $this->link_class = ' class="' . $link_class . '"';
-
- if ( !empty( $link_text ) )
- $this->link_text = $link_text;
-
</del><span class="cx"> // Build the button
</span><span class="cx"> $this->contents = $before . '<a'. $this->link_href . $this->link_title . $this->link_id . $this->link_rel . $this->link_class . '>' . $this->link_text . '</a>' . $after;
</span><span class="cx">
</span><span class="cx"> // Allow button to be manipulated externally
</span><del>- $this->contents = apply_filters( 'bp_button_' . $component . '_' . $id, $this->contents, $this, $before, $after );
</del><ins>+ $this->contents = apply_filters( 'bp_button_' . $this->component . '_' . $this->id, $this->contents, $this, $before, $after );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Return contents of button
</span><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.2.6)
+ *
</ins><span class="cx"> * @return string
</span><span class="cx"> */
</span><span class="cx"> public function contents() {
</span><span class="lines">@@ -1088,6 +1083,8 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Output contents of button
</span><ins>+ *
+ * @since BuddyPress (1.2.6)
</ins><span class="cx"> */
</span><span class="cx"> public function display() {
</span><span class="cx"> if ( !empty( $this->contents ) )
</span></span></pre>
</div>
</div>
</body>
</html>