Changeset 8547

Timestamp:

06/25/2014 01:36:44 PM (10 years ago)

Author:

boonebgorges

Message:

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 #5630

Location:

trunk/src/bp-xprofile

Files:

• bp-xprofile-classes.php (modified) (2 diffs)
• bp-xprofile-filters.php (modified) (3 diffs)

trunk/src/bp-xprofile/bp-xprofile-classes.php

@@ -1696 +1696 @@
      */
     public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
+
+    /**
+     * 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;
+    }
 }
 
@@ -2852 +2874 @@
     }
 
+    /**
+     * 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;
+    }
 
     /**

trunk/src/bp-xprofile/bp-xprofile-filters.php

@@ -50 +50 @@
 add_filter( 'bp_get_the_profile_field_value',           'xprofile_filter_format_field_value', 1, 2 );
 add_filter( 'bp_get_the_site_member_profile_data',      'xprofile_filter_format_field_value', 1, 2 );
+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 );
 add_filter( 'bp_get_the_profile_field_value',           'xprofile_filter_link_profile_data',  9, 2 );
 
@@ -117 +119 @@
 
 /**
- * xprofile_filter_format_field_value()
- *
- * Runs stripslashes on XProfile fields. If is field_type is 'datebox'
- * then the date will be formatted by bp_format_time().
- *
- * @since BuddyPress (1.0)
+ * Runs stripslashes on XProfile fields.
+ *
+ * @since BuddyPress (1.0.0)
  *
  * @param string $field_value XProfile field_value to be filtered.
  * @param string $field_type XProfile field_type to be filtered.
- *
- * @uses bp_format_time()
- *
  * @return string $field_value Filtered XProfile field_value. False on failure.
  */
@@ -135 +131 @@
         return false;
 
-    if ( 'datebox' == $field_type ) {
-
-        // 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 );
-        }
-
-    } else {
+    if ( 'datebox' != $field_type ) {
         $field_value = str_replace(']]>', ']]>', $field_value );
     }
 
     return stripslashes( $field_value );
+}
+
+/**
+ * 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;
+        }
+
+        if ( method_exists( $class, 'display_filter' ) ) {
+            $field_value = call_user_func( array( $class, 'display_filter' ), $field_value );
+        }
+    }
+
+    return $field_value;
+}
+
+/**
+ * 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 );
 }