<!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][8066] trunk/bp-groups/bp-groups-template.php: Code quality improvements to BP_Group_Membership_Requests_Template</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://buddypress.trac.wordpress.org/changeset/8066">8066</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-03-06 19:22:16 +0000 (Thu, 06 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Code quality improvements to BP_Group_Membership_Requests_Template
- Refactor constructor to accept params as an associative array
- Don't use extract() in constructor
- Docblock
See <a href="http://buddypress.trac.wordpress.org/ticket/5440">#5440</a>
Props dcavins</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpgroupsbpgroupstemplatephp">trunk/bp-groups/bp-groups-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpgroupsbpgroupstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-template.php (8065 => 8066)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-template.php 2014-03-06 19:09:04 UTC (rev 8065)
+++ trunk/bp-groups/bp-groups-template.php 2014-03-06 19:22:16 UTC (rev 8066)
</span><span class="lines">@@ -2928,24 +2928,55 @@
</span><span class="cx"> var $pag_links;
</span><span class="cx"> var $total_request_count;
</span><span class="cx">
</span><del>- function __construct( $group_id, $per_page, $max ) {
</del><ins>+ /**
+ * Constructor method.
+ *
+ * @param array $args {
+ * @type int $group_id ID of the group whose membership requests
+ * are being queried. Default: current group id.
+ * @type int $per_page Number of records to return per page of
+ * results. Default: 10.
+ * @type int $max Max items to return. Default: false (show all)
+ * }
+ */
+ function __construct( $args = array() ) {
</ins><span class="cx">
</span><ins>+ // Backward compatibility with old method of passing arguments
+ if ( ! is_array( $args ) || func_num_args() > 1 ) {
+ _deprecated_argument( __METHOD__, '2.0.0', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddypress' ), __METHOD__, __FILE__ ) );
+
+ $old_args_keys = array(
+ 0 => 'group_id',
+ 1 => 'per_page',
+ 2 => 'max',
+ );
+
+ $func_args = func_get_args();
+ $args = bp_core_parse_args_array( $old_args_keys, $func_args );
+ }
+
+ $r = wp_parse_args( $args, array(
+ 'group_id' => bp_get_current_group_id(),
+ 'per_page' => 10,
+ 'max' => false,
+ ) );
+
</ins><span class="cx"> $this->pag_page = isset( $_REQUEST['mrpage'] ) ? intval( $_REQUEST['mrpage'] ) : 1;
</span><del>- $this->pag_num = isset( $_REQUEST['num'] ) ? intval( $_REQUEST['num'] ) : $per_page;
- $this->requests = BP_Groups_Group::get_membership_requests( $group_id, $this->pag_num, $this->pag_page );
</del><ins>+ $this->pag_num = isset( $_REQUEST['num'] ) ? intval( $_REQUEST['num'] ) : $r['per_page'];
+ $this->requests = BP_Groups_Group::get_membership_requests( $r['group_id'], $this->pag_num, $this->pag_page );
</ins><span class="cx">
</span><del>- if ( !$max || $max >= (int) $this->requests['total'] )
</del><ins>+ if ( !$r['max'] || $r['max'] >= (int) $this->requests['total'] )
</ins><span class="cx"> $this->total_request_count = (int) $this->requests['total'];
</span><span class="cx"> else
</span><del>- $this->total_request_count = (int) $max;
</del><ins>+ $this->total_request_count = (int) $r['max'];
</ins><span class="cx">
</span><span class="cx"> $this->requests = $this->requests['requests'];
</span><span class="cx">
</span><del>- if ( $max ) {
- if ( $max >= count($this->requests) )
</del><ins>+ if ( $r['max'] ) {
+ if ( $r['max'] >= count($this->requests) )
</ins><span class="cx"> $this->request_count = count($this->requests);
</span><span class="cx"> else
</span><del>- $this->request_count = (int) $max;
</del><ins>+ $this->request_count = (int) $r['max'];
</ins><span class="cx"> } else {
</span><span class="cx"> $this->request_count = count($this->requests);
</span><span class="cx"> }
</span><span class="lines">@@ -3014,9 +3045,8 @@
</span><span class="cx"> );
</span><span class="cx">
</span><span class="cx"> $r = wp_parse_args( $args, $defaults );
</span><del>- extract( $r, EXTR_SKIP );
</del><span class="cx">
</span><del>- $requests_template = new BP_Groups_Membership_Requests_Template( $group_id, $per_page, $max );
</del><ins>+ $requests_template = new BP_Groups_Membership_Requests_Template( $r );
</ins><span class="cx"> return apply_filters( 'bp_group_has_membership_requests', $requests_template->has_requests(), $requests_template );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>