[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * BuddyPress XProfile Classes.
   4   *
   5   * @package BuddyPress
   6   * @subpackage XProfileClasses
   7   * @since 2.0.0
   8   */
   9  
  10  // Exit if accessed directly.
  11  defined( 'ABSPATH' ) || exit;
  12  
  13  /**
  14   * Textbox xprofile field type.
  15   *
  16   * @since 2.0.0
  17   */
  18  class BP_XProfile_Field_Type_Textbox extends BP_XProfile_Field_Type {
  19  
  20      /**
  21       * Constructor for the textbox field type.
  22       *
  23       * @since 2.0.0
  24       */
  25  	public function __construct() {
  26          parent::__construct();
  27  
  28          $this->category = _x( 'Single Fields', 'xprofile field type category', 'buddypress' );
  29          $this->name     = _x( 'Text Box', 'xprofile field type', 'buddypress' );
  30  
  31          $this->set_format( '/^.*$/', 'replace' );
  32  
  33          /**
  34           * Fires inside __construct() method for BP_XProfile_Field_Type_Textbox class.
  35           *
  36           * @since 2.0.0
  37           *
  38           * @param BP_XProfile_Field_Type_Textbox $this Current instance of
  39           *                                             the field type text box.
  40           */
  41          do_action( 'bp_xprofile_field_type_textbox', $this );
  42      }
  43  
  44      /**
  45       * Output the edit field HTML for this field type.
  46       * Must be used inside the {@link bp_profile_fields()} template loop.
  47       *
  48       * @since 2.0.0
  49       *
  50       * @param array $raw_properties Optional key/value array of
  51       *                              {@link http://dev.w3.org/html5/markup/input.text.html permitted attributes}
  52       *                              that you want to add.
  53       */
  54  	public function edit_field_html( array $raw_properties = array() ) {
  55  
  56          // User_id is a special optional parameter that certain other fields
  57          // types pass to {@link bp_the_profile_field_options()}.
  58          if ( isset( $raw_properties['user_id'] ) ) {
  59              unset( $raw_properties['user_id'] );
  60          }
  61  
  62          $r = bp_parse_args(
  63              $raw_properties,
  64              array(
  65                  'type'  => 'text',
  66                  'value' => bp_get_the_profile_field_edit_value(),
  67              )
  68          );
  69          ?>
  70  
  71          <legend id="<?php bp_the_profile_field_input_name(); ?>-1">
  72              <?php bp_the_profile_field_name(); ?>
  73              <?php bp_the_profile_field_required_label(); ?>
  74          </legend>
  75  
  76          <?php
  77  
  78          /** This action is documented in bp-xprofile/bp-xprofile-classes */
  79          do_action( bp_get_the_profile_field_errors_action() ); ?>
  80  
  81          <input <?php echo $this->get_edit_field_html_elements( $r ); ?> aria-labelledby="<?php bp_the_profile_field_input_name(); ?>-1" aria-describedby="<?php bp_the_profile_field_input_name(); ?>-3">
  82  
  83          <?php if ( bp_get_the_profile_field_description() ) : ?>
  84              <p class="description" id="<?php bp_the_profile_field_input_name(); ?>-3"><?php bp_the_profile_field_description(); ?></p>
  85          <?php endif; ?>
  86  
  87          <?php
  88      }
  89  
  90      /**
  91       * Output HTML for this field type on the wp-admin Profile Fields screen.
  92       *
  93       * Must be used inside the {@link bp_profile_fields()} template loop.
  94       *
  95       * @since 2.0.0
  96       *
  97       * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
  98       */
  99  	public function admin_field_html( array $raw_properties = array() ) {
 100  
 101          $r = bp_parse_args(
 102              $raw_properties,
 103              array(
 104                  'type' => 'text',
 105              )
 106          );
 107          ?>
 108  
 109          <label for="<?php bp_the_profile_field_input_name(); ?>" class="screen-reader-text"><?php
 110              /* translators: accessibility text */
 111              esc_html_e( 'Textbox', 'buddypress' );
 112          ?></label>
 113          <input <?php echo $this->get_edit_field_html_elements( $r ); ?>>
 114  
 115          <?php
 116      }
 117  
 118      /**
 119       * This method usually outputs HTML for this field type's children options on the wp-admin Profile Fields
 120       * "Add Field" and "Edit Field" screens, but for this field type, we don't want it, so it's stubbed out.
 121       *
 122       * @since 2.0.0
 123       *
 124       * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
 125       * @param string            $control_type  Optional. HTML input type used to render the
 126       *                                         current field's child options.
 127       */
 128  	public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
 129  }