Ticket #5500: 5500.3.diff

src/bp-xprofile/admin/css/admin.css

@@ -284 +284 @@
         display: none;
         visibility: hidden;
 }
+
+.form-table.bp-date-options {
+        margin: 0 8px;
+}
+
+.form-table.bp-date-options th {
+        width: 150px;
+}
+
+.date-format-label {
+        display: inline-block;
+        width: 150px;
+}
+
+.date-format-custom-value,
+.date-range-numeric {
+        width: 56px;
+}

src/bp-xprofile/admin/js/admin.js

@@ -78 +78 @@
 function show_options( forWhat ) {
         var do_autolink;
 
-        for ( var i = 0; i < XProfileAdmin.supports_options_field_types.length; i++ ) {
-                document.getElementById( XProfileAdmin.supports_options_field_types[i] ).style.display = 'none';
+        for ( var i = 0; i < XProfileAdmin.do_settings_section_field_types.length; i++ ) {
+                document.getElementById( XProfileAdmin.do_settings_section_field_types[i] ).style.display = 'none';
         }
 
-        if ( XProfileAdmin.supports_options_field_types.indexOf( forWhat ) >= 0 ) {
+        if ( XProfileAdmin.do_settings_section_field_types.indexOf( forWhat ) >= 0 ) {
                 document.getElementById( forWhat ).style.display = '';
                 do_autolink = 'on';
         } else {
@@ -270 +270 @@
         // Handle title placeholder text the WordPress way
         titleHint( 'title' );
 
+        // On Date fields, selecting a date_format radio button should change the Custom value.
+        var $date_format = jQuery( 'input[name="date_format"]' );
+        var $date_format_custom_value = jQuery( '#date-format-custom-value' );
+        var $date_format_sample = jQuery( '#date-format-custom-sample' );
+        $date_format.click( function( e ) {
+                switch ( e.target.value ) {
+                        case 'elapsed' :
+                                $date_format_custom_value.val( '' );
+                                $date_format_sample.html( '' );
+                        break;
+
+                        case 'custom' :
+                        break;
+
+                        default :
+                                $date_format_custom_value.val( e.target.value );
+                                $date_format_sample.html( jQuery( e.target ).siblings( '.date-format-label' ).html() );
+                        break;
+                }
+        } );
+
+        // Clicking into the custom date format field should select the Custom radio button.
+        var $date_format_custom = jQuery( '#date-format-custom' );
+        $date_format_custom_value.focus( function() {
+                $date_format_custom.prop( 'checked', 'checked' );
+        } );
+
+        // Validate custom date field.
+        var $date_format_spinner = jQuery( '#date-format-custom-spinner' );
+        $date_format_custom_value.change( function( e ) {
+                $date_format_spinner.addClass( 'is-active' );
+                jQuery.post( ajaxurl, {
+                        action: 'date_format',
+                        date: e.target.value
+                },
+                function( response ) {
+                        $date_format_spinner.removeClass( 'is-active' );
+                        $date_format_sample.html( response );
+                } );
+        } );
+
         // tabs init with a custom tab template and an "add" callback filling in the content
         var $tab_items,
                 $tabs = jQuery( '#tabs' ).tabs();

src/bp-xprofile/bp-xprofile-admin.php

@@ -432 +432 @@
                                         bp_xprofile_update_field_meta( $field_id, 'do_autolink', 'off' );
                                 }
 
+                                if ( $field->type_obj->do_settings_section() ) {
+                                        $settings = isset( $_POST['field_settings'] ) ? wp_unslash( $_POST['field_settings'] ) : array();
+                                        $field->admin_save_settings( $settings );
+                                }
+
                                 /**
                                  * Fires at the end of the process to save a field for a user, if successful.
                                  *

src/bp-xprofile/bp-xprofile-cssjs.php

@@ -51 +51 @@
                 // types that support options, for use in showing/hiding the
                 // "please enter options for this field" section.
                 $strings = array(
-                        'supports_options_field_types' => array(),
+                        'do_settings_section_field_types' => array(),
                         'do_autolink' => '',
                 );
 
                 foreach ( bp_xprofile_get_field_types() as $field_type => $field_type_class ) {
                         $field = new $field_type_class();
-                        if ( $field->supports_options ) {
-                                $strings['supports_options_field_types'][] = $field_type;
+                        if ( $field->do_settings_section() ) {
+                                $strings['do_settings_section_field_types'][] = $field_type;
                         }
                 }
 

src/bp-xprofile/classes/class-bp-xprofile-field-type-datebox.php

@@ -30 +30 @@
 
                 $this->set_format( '/^\d{4}-\d{1,2}-\d{1,2} 00:00:00$/', 'replace' ); // "Y-m-d 00:00:00"
 
+                $this->do_settings_section = true;
+
                 /**
                  * Fires inside __construct() method for BP_XProfile_Field_Type_Datebox class.
                  *
@@ -239 +241 @@
                         case 'year':
                                 $html = sprintf( '<option value="" %1$s>%2$s</option>', selected( $year, 0, false ), /* translators: no option picked in select box */ __( '----', 'buddypress' ) );
 
-                                for ( $i = 2037; $i > 1901; $i-- ) {
+                                $settings = $this->get_field_settings( $this->field_obj->id );
+
+                                if ( 'relative' === $settings['range_type'] ) {
+                                        $start = date( 'Y' ) + $settings['range_relative_start'];
+                                        $end   = date( 'Y' ) + $settings['range_relative_end'];
+                                } else {
+                                        $start = $settings['range_absolute_start'];
+                                        $end   = $settings['range_absolute_end'];
+                                }
+
+                                for ( $i = $end; $i >= $start; $i-- ) {
                                         $html .= sprintf( '<option value="%1$s" %2$s>%3$s</option>', (int) $i, selected( $year, $i, false ), (int) $i );
                                 }
                         break;
@@ -315 +327 @@
         }
 
         /**
-         * This method usually outputs HTML for this field type's children options on the wp-admin Profile Fields
-         * "Add Field" and "Edit Field" screens, but for this field type, we don't want it, so it's stubbed out.
+         * Get settings for a given date field.
          *
-         * @since 2.0.0
+         * @since 2.7.0
+         *
+         * @param int $field_id ID of the field.
+         * @return array
+         */
+        public static function get_field_settings( $field_id ) {
+                $defaults = array(
+                        'date_format'          => 'Y-m-d',
+                        'date_format_custom'   => '',
+                        'range_type'           => 'absolute',
+                        'range_absolute_start' => date( 'Y' ) - 60,
+                        'range_absolute_end'   => date( 'Y' ) + 10,
+                        'range_relative_start' => '-10',
+                        'range_relative_end'   => '20',
+                );
+
+                $settings = array();
+                foreach ( $defaults as $key => $value ) {
+                        $saved = bp_xprofile_get_meta( $field_id, 'field', $key, true );
+                        if ( '' !== $saved ) {
+                                $settings[ $key ] = $saved;
+                        } else {
+                                $settings[ $key ] = $value;
+                        }
+                }
+
+                $settings = self::validate_settings( $settings );
+
+                return $settings;
+        }
+
+        /**
+         * Validate date field settings.
+         *
+         * @since 2.7.0
+         *
+         * @param array $settings Raw settings.
+         * @return array Validated settings.
+         */
+        public static function validate_settings( $settings ) {
+                foreach ( $settings as $key => &$value ) {
+                        switch ( $key ) {
+                                case 'range_type' :
+                                        if ( $value !== 'absolute' ) {
+                                                $value = 'relative';
+                                        }
+                                break;
+
+                                // @todo More date restrictions?
+                                case 'range_absolute_start' :
+                                case 'range_absolute_end' :
+                                        $value = absint( $value );
+                                break;
+
+                                case 'range_relative_start' :
+                                case 'range_relative_end' :
+                                        $value = intval( $value );
+                                break;
+                        }
+                }
+
+                return $settings;
+        }
+
+        /**
+         * Save settings from the field edit screen in the Dashboard.
+         *
+         * @param int   $field_id ID of the field.
+         * @param array $settings Array of settings.
+         * @return bool True on success.
+         */
+        public function admin_save_settings( $field_id, $settings ) {
+                $existing_settings = self::get_field_settings( $field_id );
+
+                $saved_settings = array();
+                foreach ( array_keys( $existing_settings ) as $setting ) {
+                        switch ( $setting ) {
+                                case 'range_relative_start' :
+                                case 'range_relative_end' :
+                                        $op_key = $setting . '_type';
+                                        if ( isset( $settings[ $op_key ] ) && 'past' === $settings[ $op_key ] ) {
+                                                $value = 0 - intval( $settings[ $setting ] );
+                                        } else {
+                                                $value = intval( $settings[ $setting ] );
+                                        }
+
+                                        $saved_settings[ $setting ] = $value;
+                                break;
+
+                                default :
+                                        if ( isset( $settings[ $setting ] ) ) {
+                                                $saved_settings[ $setting ] = wp_unslash( $settings[ $setting ] );
+                                        }
+                                break;
+                        }
+                }
+
+                $saved_settings = self::validate_settings( $saved_settings );
+
+                foreach ( $saved_settings as $setting_key => $setting_value ) {
+                        bp_xprofile_update_meta( $field_id, 'field', $setting_key, $setting_value );
+                }
+
+                return true;
+        }
+
+        /**
+         * Generate the settings markup for Date fields.
+         *
+         * @since 2.7.0
          *
          * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
          * @param string            $control_type  Optional. HTML input type used to render the current
          *                                         field's child options.
          */
-        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
+        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {
+                $type = array_search( get_class( $this ), bp_xprofile_get_field_types() );
+
+                if ( false === $type ) {
+                        return;
+                }
+
+                $class = $current_field->type != $type ? 'display: none;' : '';
+                $current_type_obj = bp_xprofile_create_field_type( $type );
+
+                $settings = self::get_field_settings( $current_field->id );
+                ?>
+
+<div id="<?php echo esc_attr( $type ); ?>" class="postbox bp-options-box" style="<?php echo esc_attr( $class ); ?> margin-top: 15px;">
+        <table class="form-table bp-date-options">
+                <tr>
+                        <th scope="row">
+                                <?php esc_html_e( 'Date format', 'buddypress' ); ?>
+                        </th>
+
+                        <td>
+                                <fieldset>
+                                        <legend class="screen-reader-text">
+                                                <?php esc_html_e( 'Date format', 'buddypress' ); ?>
+                                        </legend>
+
+                                        <?php foreach ( $this->get_date_formats() as $format ): ?>
+                                                <label for="date-format-<?php echo esc_attr( $format ); ?>">
+                                                        <input type="radio" name="field_settings[date_format]" id="date-format-<?php echo esc_attr( $format ); ?>" value="<?php echo esc_attr( $format ); ?>" <?php checked( $format, $settings['date_format'] ); ?> />
+                                                        <span class="date-format-label"><?php echo date_i18n( $format ); ?></span>
+                                                        <code><?php echo esc_html( $format ); ?></code>
+                                                </label>
+                                                <br />
+                                        <?php endforeach;?>
+
+                                        <label for="date-format-elapsed">
+                                                <input type="radio" name="field_settings[date_format]" id="date-format-elapsed" <?php checked( 'elapsed', $settings['date_format'] ); ?> value="elapsed" />
+                                                <span class="date-format-label"><?php esc_html_e( 'Time elapsed', 'buddypress' ); ?></span> <?php _e( '<code>4 years ago</code>, <code>4 years from now</code>', 'buddypress' ); ?>
+                                        </label>
+                                        <br />
+
+                                        <label for="date-format-custom">
+                                                <input type="radio" name="field_settings[date_format]" id="date-format-custom" <?php checked( 'custom', $settings['date_format'] ); ?> value="custom" />
+                                                <span class="date-format-label"><?php esc_html_e( 'Custom:', 'buddypress' ); ?></span>
+                                                <input type="text" name="field_settings[date_format_custom]" id="date-format-custom-value" class="date-format-custom-value" value="<?php echo esc_attr( $settings['date_format_custom'] ); ?>" /> <span class="screen-reader-text"><?php esc_html_e( 'Example:', 'buddypress' ); ?></span><span class="date-format-custom-sample" id="date-format-custom-sample"><?php if ( $settings['date_format_custom'] ) : ?><?php echo esc_html( date( $settings['date_format_custom'] ) ); endif; ?></span><span class="spinner" id="date-format-custom-spinner"></span>
+                                        </label>
+                                </fieldset>
+
+                                <p><a href="https://codex.wordpress.org/Formatting_Date_and_Time"><?php esc_html_e( 'Documentation on date and time formatting', 'buddypress' ); ?></a></p>
+                        </td>
+                </tr>
+
+                <tr>
+                        <th scope="row">
+                                <?php esc_html_e( 'Range', 'buddypress' ); ?>
+                        </th>
+
+                        <td>
+                                <fieldset>
+                                        <legend class="screen-reader-text">
+                                                <?php esc_html_e( 'Range', 'buddypress' ); ?>
+                                        </legend>
+
+                                        <label>
+                                                <input type="radio" name="field_settings[range_type]" id="range_type_absolute" value="absolute" <?php checked( 'absolute', $settings['range_type'] ); ?> />
+
+                                                <?php
+                                                printf(
+                                                        __( 'From %s to %s', 'buddypress' ),
+                                                        sprintf( '<input class="date-range-numeric" type="text" name="field_settings[range_absolute_start]" value="%s" />', esc_attr( $settings['range_absolute_start'] ) ),
+                                                        sprintf( '<input class="date-range-numeric" type="text" name="field_settings[range_absolute_end]" value="%s" />', esc_attr( $settings['range_absolute_end'] ) )
+                                                );
+                                                ?>
+                                        </label>
+                                        <br />
+
+                                        <label>
+                                                <input type="radio" name="field_settings[range_type]" id="range_type_relative" value="relative" <?php checked( 'relative', $settings['range_type'] ); ?> />
+
+                                                <?php
+                                                printf(
+                                                        __( 'From %s to %s', 'buddypress' ),
+                                                        sprintf(
+                                                                '<input type="text" class="date-range-numeric" name="field_settings[range_relative_start]" value="%s" /> <select name="field_settings[range_relative_start_type]"><option value="past" %s>%s</option><option value="future" %s>%s</option></select>',
+                                                                esc_attr( abs( $settings['range_relative_start'] ) ),
+                                                                selected( true, $settings['range_relative_start'] <= 0, false ),
+                                                                esc_attr__( 'years ago', 'buddypress' ),
+                                                                selected( true, $settings['range_relative_start'] > 0, false ),
+                                                                esc_attr__( 'years from now', 'buddypress' )
+                                                        ),
+                                                        sprintf(
+                                                                '<input type="text" class="date-range-numeric" name="field_settings[range_relative_end]" value="%s" /> <select name="field_settings[range_relative_end_type]"><option value="past" %s>%s</option><option value="future" %s>%s</option></select>',
+                                                                esc_attr( abs( $settings['range_relative_end'] ) ),
+                                                                selected( true, $settings['range_relative_end'] <= 0, false ),
+                                                                esc_attr__( 'years ago', 'buddypress' ),
+                                                                selected( true, $settings['range_relative_end'] > 0, false ),
+                                                                esc_attr__( 'years from now', 'buddypress' )
+                                                        )
+                                                );
+                                                ?>
+                                        </label>
+                                </fieldset>
+                        </td>
+                </tr>
+        </table>
+</div>
+                <?php
+        }
 
         /**
          * Format Date values for display.
@@ -344 +571 @@
                         $field_value = strtotime( $field_value );
                 }
 
-                return bp_format_time( $field_value, true, false );
+                $settings = self::get_field_settings( $field_id );
+
+                switch ( $settings['date_format'] ) {
+                        case 'elapsed' :
+                                $formatted = bp_core_time_since( $field_value );
+                        break;
+
+                        case 'custom' :
+                                $formatted = date( $settings['date_format_custom'], $field_value );
+                        break;
+
+                        default :
+                                $formatted = date( $settings['date_format'], $field_value );
+                        break;
+                }
+
+                return $formatted;
+        }
+
+        public function get_date_formats() {
+                $date_formats = array_unique( apply_filters( 'date_formats', array( __( 'F j, Y' ), 'Y-m-d', 'm/d/Y', 'd/m/Y' ) ) );
+
+                return apply_filters( 'bp_xprofile_date_field_date_formats', $date_formats );
         }
 }

src/bp-xprofile/classes/class-bp-xprofile-field-type.php

@@ -82 +82 @@
         public $supports_richtext = false;
 
         /**
+         * If the field type has a type-specific settings section on the Edit Field panel.
+         *
+         * @since 2.7.0
+         * @var bool
+         */
+        protected $do_settings_section;
+
+        /**
          * If object is created by an BP_XProfile_Field object.
          *
          * @since 2.0.0
@@ -229 +237 @@
         }
 
         /**
+         * Check whether the current field type should have a settings ("options") section on the Edit Field panel.
+         *
+         * Falls back on `supports_options` if no value is set by the field type.
+         *
+         * @since 2.7.0
+         *
+         * @return bool
+         */
+        public function do_settings_section() {
+                if ( null === $this->do_settings_section ) {
+                        $this->do_settings_section = $this->supports_options;
+                }
+
+                return (bool) $this->do_settings_section;
+        }
+
+        /**
          * Output the edit field HTML for this field type.
          *
          * Must be used inside the {@link bp_profile_fields()} template loop.
@@ -451 +476 @@
                 return $field_value;
         }
 
+        /**
+         * Save miscellaneous settings related to this field type.
+         *
+         * Override in a specific field type if it requires an admin save routine.
+         *
+         * @since 2.7.0
+         *
+         * @param int   $field_id Field ID.
+         * @param array $settings Array of settings.
+         */
+        public function admin_save_settings( $field_id, $settings ) {}
+
         /** Protected *************************************************************/
 
         /**

src/bp-xprofile/classes/class-bp-xprofile-field.php

@@ -1106 +1106 @@
         }
 
         /**
+         * Save miscellaneous settings for this field.
+         *
+         * Some field types have type-specific settings, which are saved here.
+         *
+         * @since 2.7.0
+         *
+         * @param array $settings Array of settings.
+         */
+        public function admin_save_settings( $settings ) {
+                return $this->type_obj->admin_save_settings( $this->id, $settings );
+        }
+
+        /**
          * Populates the items for radio buttons, checkboxes, and dropdown boxes.
          */
         public function render_admin_form_children() {