<!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][8547] trunk/src/bp-xprofile: Introduce BP_XProfile_Field_Type::display_filter(), and implement in BP_XProfile_Field_Type_Datebox.</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/8547">8547</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-06-25 13:36:44 +0000 (Wed, 25 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce BP_XProfile_Field_Type::display_filter(), and implement in BP_XProfile_Field_Type_Datebox.
The new display_filter() method makes it easy for field types to customize the
appearance of its values. In the case of Datebox fields, this means formatting
the MySQL- or UNIX-formatted date in the format of bp_format_time().
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5630">#5630</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofileclassesphp">trunk/src/bp-xprofile/bp-xprofile-classes.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofilefiltersphp">trunk/src/bp-xprofile/bp-xprofile-filters.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofilebpxprofileclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-classes.php (8546 => 8547)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-classes.php 2014-06-24 21:23:15 UTC (rev 8546)
+++ trunk/src/bp-xprofile/bp-xprofile-classes.php 2014-06-25 13:36:44 UTC (rev 8547)
</span><span class="lines">@@ -1695,6 +1695,28 @@
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> */
</span><span class="cx"> public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
</span><ins>+
+ /**
+ * Format Date values for display.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param string $field_value The date value, as saved in the database.
+ * Typically, this is a MySQL-formatted date string (Y-m-d H:i:s).
+ * @return string Date formatted by bp_format_time().
+ */
+ public static function display_filter( $field_value ) {
+ // If Unix timestamp
+ if ( is_numeric( $field_value ) ) {
+ $field_value = bp_format_time( $field_value, true, false );
+
+ // If MySQL timestamp
+ } else {
+ $field_value = bp_format_time( strtotime( $field_value ), true, false );
+ }
+
+ return $field_value;
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -2851,6 +2873,21 @@
</span><span class="cx"> <?php
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Allow field types to modify the appearance of their values.
+ *
+ * By default, this is a pass-through method that does nothing. Only
+ * override in your own field type if you need to provide custom
+ * filtering for output values.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param mixed $field_value Field value.
+ * @return mixed
+ */
+ public static function display_filter( $field_value ) {
+ return $field_value;
+ }
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Internal protected/private helper methods past this point.
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofilefiltersphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-filters.php (8546 => 8547)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-filters.php 2014-06-24 21:23:15 UTC (rev 8546)
+++ trunk/src/bp-xprofile/bp-xprofile-filters.php 2014-06-25 13:36:44 UTC (rev 8547)
</span><span class="lines">@@ -49,6 +49,8 @@
</span><span class="cx">
</span><span class="cx"> add_filter( 'bp_get_the_profile_field_value', 'xprofile_filter_format_field_value', 1, 2 );
</span><span class="cx"> add_filter( 'bp_get_the_site_member_profile_data', 'xprofile_filter_format_field_value', 1, 2 );
</span><ins>+add_filter( 'xprofile_get_field_data', 'xprofile_filter_format_field_value_by_field_id', 5, 2 );
+add_filter( 'bp_get_the_profile_field_value', 'xprofile_filter_format_field_value_by_type', 5, 2 );
</ins><span class="cx"> add_filter( 'bp_get_the_profile_field_value', 'xprofile_filter_link_profile_data', 9, 2 );
</span><span class="cx">
</span><span class="cx"> add_filter( 'xprofile_data_value_before_save', 'xprofile_sanitize_data_value_before_save', 1, 2 );
</span><span class="lines">@@ -116,42 +118,61 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * xprofile_filter_format_field_value()
</del><ins>+ * Runs stripslashes on XProfile fields.
</ins><span class="cx"> *
</span><del>- * Runs stripslashes on XProfile fields. If is field_type is 'datebox'
- * then the date will be formatted by bp_format_time().
</del><ins>+ * @since BuddyPress (1.0.0)
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
- *
</del><span class="cx"> * @param string $field_value XProfile field_value to be filtered.
</span><span class="cx"> * @param string $field_type XProfile field_type to be filtered.
</span><del>- *
- * @uses bp_format_time()
- *
</del><span class="cx"> * @return string $field_value Filtered XProfile field_value. False on failure.
</span><span class="cx"> */
</span><span class="cx"> function xprofile_filter_format_field_value( $field_value, $field_type = '' ) {
</span><span class="cx"> if ( !isset( $field_value ) || empty( $field_value ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- if ( 'datebox' == $field_type ) {
</del><ins>+ if ( 'datebox' != $field_type ) {
+ $field_value = str_replace(']]>', ']]>', $field_value );
+ }
</ins><span class="cx">
</span><del>- // If Unix timestamp
- if ( is_numeric( $field_value ) ) {
- $field_value = bp_format_time( $field_value, true, false );
</del><ins>+ return stripslashes( $field_value );
+}
</ins><span class="cx">
</span><del>- // If MySQL timestamp
- } else {
- $field_value = bp_format_time( strtotime( $field_value ), true, false );
</del><ins>+/**
+ * Apply display_filter() filters as defined by the BP_XProfile_Field_Type classes, when fetched inside a bp_has_profile() loop.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param mixed $field_value Field value.
+ * @param string $field_type Field type.
+ * @return mixed
+ */
+function xprofile_filter_format_field_value_by_type( $field_value, $field_type = '' ) {
+ foreach ( bp_xprofile_get_field_types() as $type => $class ) {
+ if ( $type !== $field_type ) {
+ continue;
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- } else {
- $field_value = str_replace(']]>', ']]>', $field_value );
</del><ins>+ if ( method_exists( $class, 'display_filter' ) ) {
+ $field_value = call_user_func( array( $class, 'display_filter' ), $field_value );
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- return stripslashes( $field_value );
</del><ins>+ return $field_value;
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Apply display_filter() filters as defined by the BP_XProfile_Field_Type classes, when fetched by xprofile_get_field_data().
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param mixed $field_value Field value.
+ * @param int $field_id Field type.
+ */
+function xprofile_filter_format_field_value_by_field_id( $field_value, $field_id ) {
+ $field = new BP_XProfile_Field( $field_id );
+ return xprofile_filter_format_field_value_by_type( $field_value, $field->type );
+}
+
</ins><span class="cx"> function xprofile_filter_link_profile_data( $field_value, $field_type = 'textbox' ) {
</span><span class="cx"> if ( 'datebox' == $field_type )
</span><span class="cx"> return $field_value;
</span></span></pre>
</div>
</div>
</body>
</html>