<!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][7836] trunk: Introduce xprofile_get_field_visibility_level()</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/7836">7836</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-02-10 16:29:06 +0000 (Mon, 10 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce xprofile_get_field_visibility_level()
This is a simple function for grabbing the visibility level attached to a given
field by a specific user, sensitive to admin-provided defaults and override
settings.
See <a href="http://buddypress.trac.wordpress.org/ticket/4636">#4636</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpxprofilebpxprofilefunctionsphp">trunk/bp-xprofile/bp-xprofile-functions.php</a></li>
<li><a href="#trunkteststestcasesxprofilefunctionsphp">trunk/tests/testcases/xprofile/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-xprofile/bp-xprofile-functions.php (7835 => 7836)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-xprofile/bp-xprofile-functions.php 2014-02-09 12:05:23 UTC (rev 7835)
+++ trunk/bp-xprofile/bp-xprofile-functions.php 2014-02-10 16:29:06 UTC (rev 7836)
</span><span class="lines">@@ -287,6 +287,40 @@
</span><span class="cx"> return bp_update_user_meta( $user_id, 'bp_xprofile_visibility_levels', $current_visibility_levels );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Get the visibility level for a field.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $field_id The ID of the xprofile field.
+ * @param int $user_id The ID of the user to whom the data belongs.
+ * @return string
+ */
+function xprofile_get_field_visibility_level( $field_id = 0, $user_id = 0 ) {
+ $current_level = '';
+
+ if ( empty( $field_id ) || empty( $user_id ) ) {
+ return $current_level;
+ }
+
+ $current_levels = bp_get_user_meta( $user_id, 'bp_xprofile_visibility_levels', true );
+ $current_level = isset( $current_levels[ $field_id ] ) ? $current_levels[ $field_id ] : '';
+
+ // Use the user's stored level, unless custom visibility is disabled
+ $field = new BP_XProfile_Field( $field_id );
+ if ( isset( $field->allow_custom_visibility ) && 'disabled' === $field->allow_custom_visibility ) {
+ $current_level = $field->default_visibility;
+ }
+
+ // If we're still empty, it means that overrides are permitted, but the
+ // user has not provided a value. Use the default value.
+ if ( empty( $current_level ) ) {
+ $current_level = $field->default_visibility;
+ }
+
+ return $current_level;
+}
+
</ins><span class="cx"> function xprofile_delete_field_data( $field, $user_id ) {
</span><span class="cx"> if ( is_numeric( $field ) )
</span><span class="cx"> $field_id = $field;
</span></span></pre></div>
<a id="trunkteststestcasesxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/xprofile/functions.php (7835 => 7836)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/xprofile/functions.php 2014-02-09 12:05:23 UTC (rev 7835)
+++ trunk/tests/testcases/xprofile/functions.php 2014-02-10 16:29:06 UTC (rev 7836)
</span><span class="lines">@@ -92,4 +92,68 @@
</span><span class="cx">
</span><span class="cx"> $this->assertFalse( wp_cache_get( 'fullname_field_id', 'bp_xprofile' ) );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group xprofile_get_field_visibility_level
+ */
+ public function test_bp_xprofile_get_field_visibility_level_missing_params() {
+ $this->assertSame( '', xprofile_get_field_visibility_level( 0, 1 ) );
+ $this->assertSame( '', xprofile_get_field_visibility_level( 1, 0 ) );
+ }
+
+ /**
+ * @group xprofile_get_field_visibility_level
+ */
+ public function test_bp_xprofile_get_field_visibility_level_user_set() {
+ $u = $this->create_user();
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'field_group_id' => $g->id,
+ 'type' => 'textbox',
+ ) );
+
+ bp_xprofile_update_meta( $f->id, 'field', 'default_visibility', 'adminsonly' );
+ bp_xprofile_update_meta( $f->id, 'field', 'allow_custom_visibility', 'allowed' );
+
+ xprofile_set_field_visibility_level( $f->id, $u, 'loggedin' );
+
+ $this->assertSame( 'loggedin', xprofile_get_field_visibility_level( $f->id, $u ) );
+ }
+
+ /**
+ * @group xprofile_get_field_visibility_level
+ */
+ public function test_bp_xprofile_get_field_visibility_level_user_unset() {
+ $u = $this->create_user();
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'field_group_id' => $g->id,
+ 'type' => 'textbox',
+ ) );
+
+ bp_xprofile_update_meta( $f->id, 'field', 'default_visibility', 'adminsonly' );
+ bp_xprofile_update_meta( $f->id, 'field', 'allow_custom_visibility', 'allowed' );
+
+ $this->assertSame( 'adminsonly', xprofile_get_field_visibility_level( $f->id, $u ) );
+
+ }
+
+ /**
+ * @group xprofile_get_field_visibility_level
+ */
+ public function test_bp_xprofile_get_field_visibility_level_admin_override() {
+ $u = $this->create_user();
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'field_group_id' => $g->id,
+ 'type' => 'textbox',
+ ) );
+
+ bp_xprofile_update_meta( $f->id, 'field', 'default_visibility', 'adminsonly' );
+ bp_xprofile_update_meta( $f->id, 'field', 'allow_custom_visibility', 'disabled' );
+
+ xprofile_set_field_visibility_level( $f->id, $u, 'loggedin' );
+
+ $this->assertSame( 'adminsonly', xprofile_get_field_visibility_level( $f->id, $u ) );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>