<!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][7839] trunk/bp-core/bp-core-component.php: Introduce meta_tables param for BP_Component</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/7839">7839</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-02-11 02:58:47 +0000 (Tue, 11 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce meta_tables param for BP_Component
This utility method is used to set up configuration for $wpdb integration
and use of the WordPress metadata API
Also includes restructuring of the global_tables set in BP_Component.
See <a href="http://buddypress.trac.wordpress.org/ticket/4551">#4551</a>
Props johnjamesjacoby</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcorecomponentphp">trunk/bp-core/bp-core-component.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcorecomponentphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-component.php (7838 => 7839)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-component.php 2014-02-11 02:28:57 UTC (rev 7838)
+++ trunk/bp-core/bp-core-component.php 2014-02-11 02:58:47 UTC (rev 7839)
</span><span class="lines">@@ -107,6 +107,24 @@
</span><span class="cx"> */
</span><span class="cx"> public $root_slug = '';
</span><span class="cx">
</span><ins>+ /**
+ * Metadata tables for the component (if applicable)
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @var array
+ */
+ public $meta_tables = array();
+
+ /**
+ * Global tables for the component (if applicable)
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @var array
+ */
+ public $global_tables = array();
+
</ins><span class="cx"> /** Methods ***************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -181,6 +199,8 @@
</span><span class="cx"> * component directory search box. Eg, 'Search Groups...'.
</span><span class="cx"> * @type array $global_tables Optional. An array of database table
</span><span class="cx"> * names.
</span><ins>+ * @type array $meta_tables Optional. An array of metadata table
+ * names.
</ins><span class="cx"> * }
</span><span class="cx"> */
</span><span class="cx"> public function setup_globals( $args = array() ) {
</span><span class="lines">@@ -197,7 +217,8 @@
</span><span class="cx"> 'has_directory' => false,
</span><span class="cx"> 'notification_callback' => '',
</span><span class="cx"> 'search_string' => '',
</span><del>- 'global_tables' => ''
</del><ins>+ 'global_tables' => '',
+ 'meta_tables' => '',
</ins><span class="cx"> ) );
</span><span class="cx">
</span><span class="cx"> // Slug used for permalink URI chunk after root
</span><span class="lines">@@ -215,16 +236,14 @@
</span><span class="cx"> // Notifications callback
</span><span class="cx"> $this->notification_callback = apply_filters( 'bp_' . $this->id . '_notification_callback', $r['notification_callback'] );
</span><span class="cx">
</span><del>- // Set up global table names
- if ( !empty( $r['global_tables'] ) ) {
</del><ins>+ // Set the global table names, if applicable
+ if ( ! empty( $r['global_tables'] ) ) {
+ $this->register_global_tables( $r['global_tables'] );
+ }
</ins><span class="cx">
</span><del>- // This filter allows for component-specific filtering of table names
- // To filter *all* tables, use the 'bp_core_get_table_prefix' filter instead
- $r['global_tables'] = apply_filters( 'bp_' . $this->id . '_global_tables', $r['global_tables'] );
-
- foreach ( $r['global_tables'] as $global_name => $table_name ) {
- $this->$global_name = $table_name;
- }
</del><ins>+ // Set the metadata table, if applicable
+ if ( ! empty( $r['meta_tables'] ) ) {
+ $this->register_meta_tables( $r['meta_tables'] );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /** BuddyPress ********************************************************/
</span><span class="lines">@@ -444,6 +463,65 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Register global tables for the component, so that it may use WordPress's database API.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param array $tables
+ */
+ public function register_global_tables( $tables = array() ) {
+
+ // This filter allows for component-specific filtering of table names
+ // To filter *all* tables, use the 'bp_core_get_table_prefix' filter instead
+ $tables = apply_filters( 'bp_' . $this->id . '_global_tables', $tables );
+
+ // Add to the BuddyPress global object
+ if ( !empty( $tables ) && is_array( $tables ) ) {
+ foreach ( $tables as $global_name => $table_name ) {
+ $this->$global_name = $table_name;
+ }
+
+ // Keep a record of the metadata tables in the component
+ $this->global_tables = $tables;
+ }
+
+ do_action( 'bp_' . $this->id . '_register_global_tables' );
+ }
+
+ /**
+ * Register component metadata tables.
+ *
+ * Metadata tables are registered in the $wpdb global, for
+ * compatibility with the WordPress metadata API.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param array $tables
+ */
+ public function register_meta_tables( $tables = array() ) {
+ global $wpdb;
+
+ // This filter allows for component-specific filtering of table names
+ // To filter *all* tables, use the 'bp_core_get_table_prefix' filter instead
+ $tables = apply_filters( 'bp_' . $this->id . '_meta_tables', $tables );
+
+ /**
+ * Add the name of each metadata table to WPDB to allow BuddyPress
+ * components to play nicely with the WordPress metadata API.
+ */
+ if ( !empty( $tables ) && is_array( $tables ) ) {
+ foreach( $tables as $meta_prefix => $table_name ) {
+ $wpdb->{$meta_prefix . 'meta'} = $table_name;
+ }
+
+ // Keep a record of the metadata tables in the component
+ $this->meta_tables = $tables;
+ }
+
+ do_action( 'bp_' . $this->id . '_register_meta_tables' );
+ }
+
+ /**
</ins><span class="cx"> * Set up the component post types.
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.5.0)
</span></span></pre>
</div>
</div>
</body>
</html>