add_field( $this );
} // end add_to_section()
/**
* Returns the value for this field currently stored in the database.
* @return {mixed} The value stored in the database
*/
public function get_stored_field_value() {
$S = $this->get_section();
if( empty( $S ) ) {
return null;
}
$farr = $S->get_stored_field_values( $this->get_field_name() );
if( is_array( $farr ) && array_key_exists( $this->get_field_name(), $farr ) ) {
return $farr[$this->get_field_name()];
}
else {
return null;
}
} // end get_stored_field_value()
/**
* Returns an array of all ABDWPSM_Field objects saved and committed to sections.
* @return {ARRAY_N} Array of ABDWPSM_Field objects that are created and saved.
*/
public static function get_all_fields() {
return ABDWPSM_Settings_Manager::$fields;
} // end get_all_fields()
/**
* Gets the ABDWPSM_Field object with a field name matching the one specified in the
* section specified.
* @param {string} $field_name The name of the field to get.
* @return {object} The ABDWPSM_Field object with the specified name.
* @return {null} If no field object matches, null is returned.
*/
public static function get_field_by_field_name( $field_name, $Section ) {
foreach( $Section->get_fields() as $Field ) {
if( $Field->get_field_name() == $field_name ) {
return $Field;
}
}
return null;
} // end get_field_by_field_name()
/**
* Appends an option to the field options array.
* @param {string} $option_name The name of the option to append.
* @param {mixed} $option_value The value of the option to append.
*/
public function add_field_option( $option_name, $option_value ) {
if( !is_array( $this->my_field_options ) ) {
$this->my_field_options = array();
}
$this->my_field_options[$option_name] = $option_value;
}
/**
* Makes sure this field meets identifying property uniqueness requirements.
*/
public function ip_uniqueness_check() {
$My_Section = $this->get_section( false );
$my_fn = $this->get_field_name();
// Fields' identifying properties (IP) are the field_name, and they must be globally
// unique
// So, first, make sure we have a section and field_name set. If we don't then presumably
// this construct is still being built and we have nothing to check for.
// When committing this field later, it will call
// ip_uniqueness_check and should get past this point.
if( empty( $My_Section ) || empty( $my_fn ) ) {
// Field not complete, can't check uniqueness, return null.
return null;
}
// Okay, if we're here, we have everything set. We can check uniqueness.
foreach( ABDWPSM_Settings_Manager::$fields as $Field ) {
if( $Field->get_field_name() == $my_fn &&
$Field->get_section()->get_options_group()->get_db_option_name() == $my_fn &&
$Field != $this ) {
// Not unique!
ABDWPSM_Settings_Manager::die_with_message( 'Your field needs a unique identifying property (field_name) in its options group. ' . $my_fn . ' has already been used!' );
return;
}
}
// If we're here, then no matches were found and we can report that all is well.
return true;
}
/**
* Appends an option to the validator options array.
* @param {string} $option_name The name of the option to append.
* @param {mixed} $option_value The value of the option to append.
*/
public function add_validator_option( $option_name, $option_value ) {
if( !is_array( $this->my_validator_options ) ) {
$this->my_validator_options = array();
}
$this->my_validator_options[$option_name] = $option_value;
}
/**
* A wrapper around WordPress' add_settings_error() function that automatically
* fills in the tedious parameters.
* @param {string} $message The error message to display to the user.
* @param {string} $idcode Optional slug name to help identify the error for CSS and JavaScript targeting.
*/
public function add_validation_error_to_stack( $message, $idcode = null ) {
if( empty( $idcode ) ) {
$idcode = uniqid();
}
add_settings_error(
$this->get_field_name(),
$this->get_field_name() . '-' . $idcode,
$message
);
}
/**
* Outputs the HTML for this field input.
* @param {[type]} $args [description]
* @return {[type]} [description]
*/
public static function display_field_contents( $args ) {
$Field = self::get_field_by_field_name( $args['field_name'], $args['section'] );
$Field->display_field_contents_helper();
}
public function display_field_contents_helper() {
// Okay, the main goal is to display the field contents. BUT,
// if we have a settings error from a just finished submission,
// then there is likely a data persistence transient saved (saved
// in validation function in ./options-group.php --
// ABDWPSM_Options_Group::default_validation_function()).
//
// If the persistence exists, we need to override the values the
// fields will display with the data from the persistence.
$input_arr = get_transient( 'ABDWPSM_input_persistence' );
if( is_array( $input_arr ) ) {
// We have data persistence! Get the value for the current
// field if there is one and override the value.
$field_name = $this->get_field_name();
if( array_key_exists( $field_name, $input_arr ) ) {
// Override!
$this->data_persistence_value = $input_arr[$field_name];
// Remove this value from the transient so it doesn't show up
// in future page loads and update the transient.
unset( $input_arr[$field_name] );
set_transient( 'ABDWPSM_input_persistence', $input_arr );
}
else {
// Just to be absolutely sure no data persistence persists
// longer than we want, unset the data_persistence_value
$this->data_persistence_value = null;
}
}
$t = strtolower( $this->get_type() );
if( $t == 'text' || $t == 'password' || $t == 'email' ||
$t == 'url' || $t == 'textarea' || $t == 'wysiwyg' || $t == 'color' ||
$t == 'date' || $t == 'hidden' || $t == 'number' || $t == 'month' ||
$t == 'tel' || $t == 'time' || $t == 'week' ) {
$this->display_field_contents_helper_single();
}
else if ( $t == 'checkbox' || $t == 'radio' || $t == 'select' || $t == 'dropdown' ) {
$this->display_field_contents_helper_grouped();
}
else {
ABDWPSM_Settings_Manager::die_with_message( 'Invalid field type "' . $this->get_type() . '" supplied for ' . $Field->get_display_name() . ' field.' );
}
}
protected function display_field_contents_helper_single( ) {
$dname = $this->get_display_name();
$ddesc = $this->get_display_description();
$dex = $this->get_display_example();
$ftype = $this->get_type();
$fopt = $this->get_field_options_array();
$Section = $this->get_section();
if( empty( $Section ) ) {
ABDWPSM_Settings_Manager::die_with_message( 'Field has no section!' );
return;
}
$OG = $Section->get_options_group();
if( empty( $OG ) ) {
ABDWPSM_Settings_Manager::die_with_message( 'Section has no options group!');
}
$fname = $OG->get_db_option_name();
if( is_array( $this->get_field_name() ) ) {
foreach( $this->get_field_name() as $lvl ) {
$fname .= '[' . $lvl . ']';
}
}
else {
$fname .= '[' . $this->get_field_name() . ']';
}
$fid = str_replace('[', '_', $fname);
$fid = str_replace(']', '', $fid);
// Let's parse the field options a little to make life simpler
// Start with read only.
( array_key_exists( 'readonly', $fopt ) && $fopt['readonly'] ) ?
$readonly = 'readonly="readonly"' : $readonly = '';
// Now disabled
( array_key_exists( 'disabled', $fopt ) && $fopt['disabled'] ) ?
$disabled = 'disabled="disabled"' : $disabled = '';
// Required
( array_key_exists( 'required', $fopt ) && $fopt['required'] ) ?
$required = 'required="required"' : $required = '';
// Now default value
array_key_exists('default', $fopt) ?
$default = $fopt['default'] : $default = '';
// And style
array_key_exists('style', $fopt) ?
$style = $fopt['style'] : $style = '';
// Max length
array_key_exists('max_length', $fopt) ?
$maxlength = $fopt['max_length'] : $maxlength = '';
// Min length
array_key_exists('min_length', $fopt) ?
$minlength = $fopt['min_length'] : $minlength = '';
// Placeholder
array_key_exists('placeholder', $fopt) ?
$placeholder = $fopt['placeholder'] : $placeholder = '';
// Value override
array_key_exists('value_override', $fopt) ?
$value_override = $fopt['value_override'] : $value_override = null;
// WP Editor Settings Array
( array_key_exists('wysiwyg_settings_array', $fopt) && is_array( $fopt['wysiwyg_settings_array'] ) ) ?
$wp_ed_settings = $fopt['wysiwyg_settings_array'] : $wp_ed_settings = array();
// Now, let's get the value we're gonna put in the input.
// Unfortunately, there are several possibilities.
// Possibility #1: Data persistence from a previous failed submission attempt.
if( isset( $this->data_persistence_value ) && !is_null( $this->data_persistence_value ) ) {
$value = $this->data_persistence_value;
$this->data_persistence_value = null; // Clean up our mess
}
else {
// Possibility #2: Value override from the user
if( is_null( $value_override ) ) {
// Possibility #3: Existing value in the database
$cur_val = $this->get_stored_field_value();
if( !isset( $cur_val ) ) { // No value stored
// Possibility #4: Default value
$value = $default;
}
else {
$value = $cur_val; // Something was in the database, use it.
}
}
else {
$value = $value_override; // We have a user override.
}
}
// Covert value to HTML entities
$value = htmlentities( $value, ENT_QUOTES );
// Now, output the field
if( $ftype == 'textarea' ) {
echo '';
}
else if ( $ftype == 'wysiwyg' ) {
// Add name
$wp_ed_settings['textarea_name'] = $fname;
wp_editor( $value, $fid, $wp_ed_settings );
}
else {
echo "";
}
// And any description and example
if( !empty( $ddesc ) ) {
echo "
$ddesc
";
}
if( !empty( $dex ) ) {
echo "
Example: $dex
";
}
}
protected function display_field_contents_helper_grouped( ) {
$dname = $this->get_display_name();
$ddesc = $this->get_display_description();
$dex = $this->get_display_example();
$ftype = $this->get_type();
$fopt = $this->get_field_options_array();
$fname = $this->get_section()->get_options_group()->get_db_option_name();
if( is_array( $this->get_field_name() ) ) {
foreach( $this->get_field_name() as $lvl ) {
$fname .= '[' . $lvl . ']';
}
}
else {
$fname .= '[' . $this->get_field_name() . ']';
}
$fid = str_replace('[', '--', $fname);
$fid = str_replace(']', '', $fid);
// Let's parse the field options a little to make life simpler
// Start with read only.
( array_key_exists( 'readonly', $fopt ) && $fopt['readonly'] ) ?
$readonly = 'readonly="readonly"' : $readonly = '';
// Now disabled
( array_key_exists( 'disabled', $fopt ) && $fopt['disabled'] ) ?
$disabled = 'disabled="disabled"' : $disabled = '';
// Required
// Now disabled
( array_key_exists( 'required', $fopt ) && $fopt['required'] ) ?
$required = 'required="required"' : $required = '';
// Now default value
array_key_exists('default', $fopt) ?
$default = $fopt['default'] : $default = null;
// And style
array_key_exists('style', $fopt) ?
$style = $fopt['style'] : $style = '';
// Buttons
array_key_exists( 'choices', $fopt ) ?
$choices = $fopt['choices'] : ABDWPSM_Settings_Manager::die_with_message( "The $ftype field type must have a \"choices\" field_option! The $fname field does not." );
// Value override
array_key_exists('value_override', $fopt) ?
$value_override = $fopt['value_override'] : $value_override = null;
// Now, let's get the value we're gonna put in the input.
// Unfortunately, there are several possibilities.
// Possibility #1: Data persistence from a previous failed submission attempt.
if( isset( $this->data_persistence_value ) && !is_null( $this->data_persistence_value ) ) {
$cur_val = $this->data_persistence_value;
$this->data_persistence_value = null; // Clean up our mess
}
else {
// Possibility #2: Value override from the user
if( is_null( $value_override ) ) {
// Possibility #3: Existing value in the database
$cur_val = $this->get_stored_field_value();
if( !isset( $cur_val ) ) { // No value stored
// Possibility #4: Default value
$cur_val = $default;
}
else {
$cur_val = $cur_val; // Something was in the database, use it.
}
}
else {
$cur_val = $value_override; // We have a user override.
}
}
// If this is a checkbox, then the name must be in array notation
if( $ftype == 'checkbox' ) {
$fname .= '[]';
}
// There's a possibility $value contains an array of values or a
// single value of another type. To make life simple, let's
// make everything an array.
if( !is_array( $cur_val ) ) {
$cur_val = array( $cur_val );
}
// Now, we're gonna loop through the "choices" and output them in the
// appropriate construct.
// Now, loop through $buttons and output them
if ( $ftype == 'select' || $ftype == 'dropdown' ) {
$end_tag = "";
echo "