init();
}
/**
* Load and init the base field class.
*
* @since 1.8.0
*/
public function init() {
}
/**
* Hooks.
*
* @since 1.7.7
*/
private function hooks() {
}
/**
* Load default field types.
*
* @since 1.0.0
*/
public function load() {
}
/**
* Produce tooltip HTML w/ icon.
*
* @since 1.8.0
*
* @param array $tooltip_text Tooltip text.
*
* @return string
*/
public function get_tooltip_html( $tooltip_text = false ) {
if ( false === $tooltip_text ) {
return false;
}
$html = charitable_get_tooltip_html( $tooltip_text );
return $html;
}
/**
* Output a hidden field for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param array $args Field params.
*
* @return string
*/
public function generate_hidden_field( $value = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'field_id' => '', // data.
);
$params = array_replace_recursive( $defaults, $args );
$field_id_attr = ( isset( $params['field_id'] ) && '' !== $params['field_id'] ) ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
if ( is_array( $params['name'] ) && isset( $params['name'][2] ) ) {
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
} elseif ( is_array( $params['name'] ) ) {
$params['name'] = implode( '-', $params['name'] );
}
$html = '';
$html .= '
';
return $html;
}
/**
* Output a generic text div/area for the form settings in the left sidebar.
*
* @since 1.8.0
* @version 1.8.1.12 - detect $icon is a jpg, png, or gif.
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_text( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'container_class' => '',
'placeholder' => '',
'tooltip' => false,
'icon' => false,
'fa_icon' => false,
'default' => false,
'add_commas' => false,
'type' => 'text', // could also be "url", etc.
'field_id' => '', // data.
);
$params = array_replace_recursive( $defaults, $args );
$params['container_class'] .= ( isset( $params['icon'] ) && false !== $params['icon'] ) ? ' has-icon' : false;
$icon = ( isset( $params['icon'] ) && false !== $params['icon'] ) ? charitable()->get_path( 'assets', false ) . $params['icon'] : false;
$fa_icon = ( isset( $params['fa_icon'] ) && false !== $params['fa_icon'] ) ? '' . esc_html( $params['description'] ) . '
' : false;
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( $params['tooltip'] ) : false;
$conditional_attr = ( isset( $params['conditional'] ) && '' !== $params['conditional'] ) ? 'data-conditional-id="' . intval( $params['conditional'] ) . '"' : false;
$value = false === $value && isset( $params['default'] ) && false !== $params['default'] ? esc_html( $params['default'] ) : $value;
$toggle_value = false;
$container_classes = explode( ' ', $params['container_class'] );
$container_classes = array_unique( $container_classes );
$params['container_class'] = implode( ' ', $container_classes );
if ( is_array( $value ) && key_exists( $params['name'][2], $value ) ) {
$value = $value[ $params['name'][2] ];
} elseif ( is_array( $value ) ) {
$value = reset( $value );
}
if ( is_array( $params['name'] ) && isset( $params['name'][2] ) ) {
$toggle_value = $params['name'][2];
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
} elseif ( is_array( $params['name'] ) ) {
$params['name'] = implode( '-', $params['name'] );
}
// santitize and remove all kinds of quotes from the input field text value.
$value = str_replace( array( '"', "'", '“', '”', '‘', '’' ), '', $value );
$value = esc_html( $value );
if ( true === $params['add_commas'] && '' !== $value ) {
$value = Charitable_Currency::get_instance()->get_sanitized_and_localized_amount( $value );
}
$field_id_attr .= isset( $toggle_value ) && '' !== $toggle_value ? ' data-ajax-label="' . $toggle_value . '"' : false;
// If the toggle is a css_class, add another css class so it's easier for us to target this.
if ( 'css_class' === $toggle_value ) {
$params['class'] .= ' charitable-custom-css-field';
}
$html = '
' . $label . ' ' . $tooltip_html . '
';
// Is icon a jpg, png, or gif?
if ( ! empty( $icon ) && false !== $icon ) :
if ( strpos( $icon, '.jpg' ) || strpos( $icon, '.png' ) || strpos( $icon, '.gif' ) ) {
$html .= '
';
} elseif ( false !== $icon ) {
$html .= '
' . $params['icon'] . ' ';
}
endif;
$html .= '
' . $description . '
';
return $html;
}
/**
* Output a toggle switch for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_toggle( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'container_class' => '',
'field_id' => '',
'title' => '',
'visibility' => false,
'checked_value' => '1',
'tooltip' => false,
'disabled' => false,
);
$params = array_replace_recursive( $defaults, $args );
if ( is_array( $value ) ) {
$value = reset( $value );
}
if ( is_array( $params['name'] ) ) {
$toggle_value = $params['name'][2];
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
// When disabled, force the value off so the toggle can't visually appear on.
if ( $params['disabled'] ) {
$value = false;
}
$checked = ( $value !== false && $value === $params['checked_value'] ) ? 'checked="checked"' : false;
$field_id_attr = isset( $params['field_id'] ) && '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$field_id_attr .= isset( $toggle_value ) && '' !== $toggle_value ? ' data-ajax-label="' . $toggle_value . '"' : false;
$params['container_class'] = $this->maybe_add_visibility_classes( $params['container_class'], $params['visibility'] );
if ( $params['disabled'] ) {
$params['container_class'] = trim( $params['container_class'] . ' charitable-panel-field-toggle-disabled' );
}
$css_classes = explode( ' ', $params['class'] );
$css_classes = array_unique( $css_classes );
$params['class'] = implode( ' ', $css_classes );
$css_container_classes = ! empty( $params['container_class'] ) ? explode( ' ', $params['container_class'] ) : array();
$css_container_classes = array_unique( $css_container_classes );
$params['container_class'] = implode( ' ', $css_container_classes );
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( $params['tooltip'] ) : '';
$disabled_attr = $params['disabled'] ? 'disabled="disabled"' : '';
$html = isset( $params['title'] ) && '' !== $params['title'] ? '' . esc_html( $params['title'] ) . ' ' : false;
$html .= '
' . $label . ' ' . $tooltip_html . '
';
return $html;
}
/**
* Output a toggle switch for the form settings in the left sidebar.
*
* @since 1.8.0
* @since 1.8.4.5 - bug fix for saving when $values is present.
*
* @param mixed $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_toggles( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => 'charitable-checkbox-for-toggle',
'container_class' => '',
'field_id' => '',
'type' => 'toggle',
'default' => array(),
'checked_value' => 'true',
'use_defaults' => true,
);
$params = array_replace_recursive( $defaults, $args );
if ( is_array( $params['name'] ) ) {
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$field_id_attr = '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$css_container_classes = isset( $params['container_class'] ) ? explode( ' ', $params['container_class'] ) : array();
$css_container_classes = array_unique( $css_container_classes );
$params['container_class'] = implode( ' ', $css_container_classes );
$html = '
' . $label . ' ';
foreach ( $params['options'] as $text => $box_id ) {
// If there is any value, we need to check if the box_id is in the value.
if ( ! empty( $value ) && is_array( $value ) ) {
if ( key_exists( $box_id, $value ) ) {
$checked = 'checked="checked"';
} else {
$checked = false;
}
} elseif ( is_array( $params['default'] ) && in_array( $box_id, $params['default'] ) ) {
$checked = 'checked="checked"';
} else {
$checked = false;
}
$toggle_name = $params['name'] . '[' . $box_id . ']';
$html .= '
' . $text . '
';
}
$html .= '
';
return $html;
}
/**
* Output a generic checkbox for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_checkbox( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
);
$params = array_replace_recursive( $defaults, $args );
if ( is_array( $value ) ) {
$value = reset( $value );
}
if ( is_array( $params['name'] ) ) {
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$checked = ( $value !== false && $value == $params['checked_value'] ) ? 'checked="checked"' : false;
$html = '
' . $label . '
';
return $html;
}
/**
* Output a generic set of checkboxes for the form settings in the left sidebar.
*
* @since 1.8.0
* @version 1.8.2 added tooltips, container_class.
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_checkboxes( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'container_class' => '',
'field_id' => '',
'tooltip' => false,
'visibility' => false,
'defaults' => array(),
);
$params = array_replace_recursive( $defaults, $args );
$extra_css = $this->maybe_add_visibility_classes( $params['class'], $params['visibility'] );
if ( ! is_array( $value ) && false !== $value ) {
$value = array( $value );
} elseif ( ! is_array( $value ) ) {
$value = array();
}
if ( is_array( $params['name'] ) ) {
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$css_container_classes = isset( $params['container_class'] ) ? explode( ' ', $params['container_class'] ) : array();
$css_container_classes = array_unique( $css_container_classes );
$params['container_class'] = implode( ' ', $css_container_classes );
$params['container_class'] .= $extra_css;
$field_id_attr = '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$description = ( isset( $params['description'] ) && false !== $params['description'] ) ? '' . esc_html( $params['description'] ) . '
' : false;
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( $params['tooltip'] ) : false;
$html = '
' . $label . ' ' . $tooltip_html . ' ' . $description;
foreach ( $params['options'] as $text => $box_id ) {
$checked = ( empty( $value ) && ! empty( $defaults ) && in_array( $box_id, $params['defaults'] ) )
|| ( $value !== false && key_exists( $box_id, $value ) && $value[ $box_id ] !== false ) ? 'checked="checked"' : false;
$html .= '
' . $text . '
';
}
$html .= '
';
return $html;
}
/**
* Output a generic set of radio buttons for the form settings in the left sidebar.
*
* @since 1.8.0
* @version 1.8.4.5
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_radio_options( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'container_class' => '',
'tooltip' => false,
'visibility' => false,
'field_id' => '', // data.
);
$params = array_replace_recursive( $defaults, $args );
$extra_css = $this->maybe_add_visibility_classes( $params['class'], $params['visibility'] );
if ( ! is_array( $value ) ) {
$value = array( $value );
}
if ( is_array( $params['name'] ) ) {
$toggle_value = $params['name'][2];
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$field_id_attr = ( isset( $params['field_id'] ) && '' !== $params['field_id'] ) ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$field_id_attr .= isset( $toggle_value ) && '' !== $toggle_value ? ' data-ajax-label="' . $toggle_value . '"' : false;
$description = ( isset( $params['description'] ) && false !== $params['description'] ) ? '' . esc_html( $params['description'] ) . '
' : false;
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( $params['tooltip'] ) : false;
$css_classes = explode( ' ', $params['class'] );
$css_classes = array_unique( $css_classes );
$params['class'] = implode( ' ', $css_classes );
$css_container_classes = isset( $params['container_class'] ) ? explode( ' ', $params['container_class'] ) : array();
$css_container_classes = array_unique( $css_container_classes );
$params['container_class'] = implode( ' ', $css_container_classes );
$params['container_class'] .= $extra_css;
$html = '
' . $label . ' ' . $tooltip_html . ' ';
foreach ( $params['options'] as $text => $box_id ) {
// For radio buttons, we just need to check if the value matches the box_id.
$checked = ( $value[0] === $box_id ) ? 'checked="checked"' : '';
// Only fall back to default if no value is set.
if ( empty( $value[0] ) && ! empty( $params['option_default'] ) && $box_id === $params['option_default'] ) {
$checked = 'checked="checked"';
}
$input_id = str_replace( '[', '-', $params['name'] );
$input_id = str_replace( ']', '-', $input_id );
$input_id = str_replace( '--', '-', $input_id );
$html .= '
' . $text . '
';
}
$html .= $description . '
';
return $html;
}
/**
* Output a generic dropdown for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_dropdown( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'container_class' => '',
'default' => false,
'visibility' => false,
'options' => false,
);
$params = array_replace_recursive( $defaults, $args );
if ( is_array( $value ) ) {
$value = reset( $value );
}
if ( is_array( $params['name'] ) ) {
$toggle_value = $params['name'][2];
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$field_id_attr = isset( $params['field_id'] ) && '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$field_id_attr .= isset( $toggle_value ) && '' !== $toggle_value ? ' data-ajax-label="' . $toggle_value . '"' : false;
$selected_value = isset( $params['selected_value'] ) ? esc_html( $params['selected_value'] ) : $value;
$default_value = isset( $params['default'] ) && false !== $params['default'] ? esc_html( $params['default'] ) : false;
$params['container_class'] = $this->maybe_add_visibility_classes( $params['class'], $params['visibility'] );
$css_classes = explode( ' ', $params['class'] );
$css_classes = array_unique( $css_classes );
$params['class'] = implode( ' ', $css_classes );
$css_container_classes = isset( $params['container_class'] ) ? explode( ' ', $params['container_class'] ) : array();
$css_container_classes = array_unique( $css_container_classes );
$params['container_class'] = implode( ' ', $css_container_classes );
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( $params['tooltip'] ) : false;
$html = '
' . $label . ' ' . $tooltip_html . ' ';
if ( false !== $params['options'] && is_array( $params['options'] ) && count( $params['options'] ) > 0 ) {
$html .= '
';
foreach ( $params['options'] as $option_value => $text ) {
$selected = ( $selected_value === '' && $default_value && $option_value === $default_value ) ? 'selected="selected"' : false;
$selected = ( false === $selected && $selected_value && $option_value === $selected_value ) ? 'selected="selected"' : false;
$html .= '' . $text . ' ';
}
$html .= ' ';
} elseif ( ! empty( $params['not_available'] ) ) {
$html .= '
' . esc_html( $params['not_available'] ) . '
';
}
$html .= '
';
return $html;
}
/**
* Output a generic textbox for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_textbox( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'container_class' => array(),
'placeholder' => '',
'description' => '',
'rows' => 10,
'field_id' => '',
'visibility' => false,
'hidden' => false,
'html' => false,
'code' => false,
'special' => false,
);
$params = array_replace_recursive( $defaults, $args );
if ( is_array( $value ) ) {
$value = reset( $value );
}
if ( is_array( $params['name'] ) ) {
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
if ( $params['html'] ) {
// add to class so quill can pick it up.
$params['class'] .= ' campaign-builder-htmleditor';
}
if ( $params['code'] ) {
// add to class so the js can pick it up.
$params['class'] .= ' campaign-builder-codeeditor';
}
// convert into an array to remove duplicates, then convert back to a string.
$css_classes = explode( ' ', $params['class'] );
$css_classes = array_unique( $css_classes );
$params['class'] = implode( ' ', $css_classes );
$css_container_classes = isset( $params['container_class'] ) && ! empty( $params['container_class'] ) ? explode( ' ', $params['container_class'] ) : array();
$css_container_classes = array_unique( $css_container_classes );
$params['container_classes'] = implode( ' ', $css_container_classes );
if ( $params['hidden'] ) { // if hidden is true, then this is output is deliberately hidden from the user. This is different from "visibility" which is used for conditional logic.
$params['container_classes'] .= ' charitable-hidden';
}
$field_id_attr = ( isset( $params['field_id'] ) && '' !== $params['field_id'] ) ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$description = ( isset( $params['description'] ) && '' !== trim( $params['description'] ) ) ? '' . esc_html( $params['description'] ) . '
' : false;
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( $params['tooltip'] ) : false;
if ( false !== $params['special'] ) {
if ( 'campaign_description' === $params['special'] && '' === trim( $value ) ) {
$value = '
This is an example of a campaign description. It should summarize thoughtfully what your campaign is about and what your goal(s) are. If this is the only campaign of your site you can link to a more detailed About page that introduces into more detail. The description here might say something like this:
Hi there! This campaign is to raise money for equipment, uniforms, and various other supplies for our local school sport team, The Tigers.
...or something like this:
The Tigers basebase team was founded in 1971 and has been providing fun after school activities for young children in the Dalls, Texas USA public schools ever since. The campaign is run by Mr. and Mrs. Smith and employs about 5 people including coaches and staff.
Since this is a new campaign, you as a Charitable admin should update this content by clicking on this block in the preview area in the campaign builder. 😄
';
}
}
if ( $params['html'] ) {
$html = '
' . $label . ' ' . $tooltip_html . ' ' . $description . '
' . $value . '
';
} elseif ( $params['code'] ) {
$html = '
' . $label . ' ' . $tooltip_html . ' ' . $description . '
';
} else {
$html = '
' . $label . ' ' . $tooltip_html . ' ' . $description . '
';
}
return apply_filters( 'charitable_campaign_builder_form_field_textbox', $html, $value, $label, $args );
}
/**
* Output a generic date picker for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_date( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'placeholder' => '',
'date-format' => 'F j, Y',
'data-date' => '',
'label-below' => '',
'visibility' => false,
'icon' => false,
'container_class' => '',
);
$params = array_replace_recursive( $defaults, $args );
if ( is_array( $value ) ) {
$value = reset( $value );
}
if ( $value === '0' || $value === 0 ) { // todo: adding this while we figure some things out.
$value = false;
}
if ( false !== $value && '' !== trim( $value ) && ! charitable_is_valid_timestamp( $value ) ) {
$value = date( $params['date-format'], strtotime( $value ) ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
}
if ( is_array( $params['name'] ) ) {
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$params['container_class'] .= ( isset( $params['icon'] ) && false !== $params['icon'] ) ? 'has-icon' : false;
$container_classes = explode( ' ', $params['container_class'] );
$container_classes = array_unique( $container_classes );
$params['container_class'] = implode( ' ', $container_classes );
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( $params['tooltip'] ) : false;
$icon = ( isset( $params['icon'] ) && false !== $params['icon'] ) ? charitable()->get_path( 'assets', false ) . $params['icon'] : false;
$html = '';
return $html;
}
/**
* Output a number slider for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_number_slider( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'css_class' => '',
'placeholder' => '',
'tooltip' => false,
'icon' => false,
'min' => 0,
'max' => 100,
'step' => 10,
'min_actual' => '',
'symbol' => '%',
'field_id' => '', // data.
'field_type' => '',
'visibility' => false,
);
$params = array_replace_recursive( $defaults, $args );
$container_classes = ( false !== $params['icon'] ) ? 'has-icon' : false;
$tooltip_html = ( false !== $params['tooltip'] ) ? $this->get_tooltip_html( $params['tooltip'] ) : false;
// css classes.
$css_classes = array();
$css_classes[] = $params['field_type'];
if ( ! empty( $params['css_class'] ) ) {
$css_classes[] = esc_attr( $params['css_class'] );
}
$css_classes = implode( ' ', $css_classes );
if ( is_array( $value ) && key_exists( $params['name'][2], $value ) ) {
$value = $value[ $params['name'][2] ];
} elseif ( is_array( $value ) ) {
$value = reset( $value );
}
if ( is_array( $params['name'] ) ) {
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$html = '';
$html .= '
' . $label . ' ' . $tooltip_html . '
';
$html .= '
' . $value . '
' . $params['symbol'] . 'minimum
';
$html .= '
' . esc_html( $params['description'] ) . '
' : false;
$css_classes = array();
$css_classes[] = $params['field_type'];
$css_classes[] = ( isset( $params['size'] ) && ! is_null( $params['size'] ) ) ? $params['size'] : 'regular';
$css_classes = implode( ' ', $css_classes );
if ( is_array( $value ) && key_exists( $params['name'][2], $value ) ) {
$value = $value[ $params['name'][2] ];
} elseif ( is_array( $value ) ) {
$value = reset( $value );
}
if ( is_array( $params['name'] ) ) {
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$html = '';
$html .= '
' . $label . ' ' . $tooltip_html . ' ';
$html .= ( false !== $description ) ? $description : false;
$html .= '
' . $label . ' ';
foreach ( $align_types as $align_type ) {
$active = ( $value === $align_type ) ? 'active' : false;
$html .= '
';
}
$html .= '
';
$html .= '
';
return $html;
}
/**
* Output a UI that is meant to multiple select for tags. Forked from the generate_dropdown.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_tag_selector( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'container_class' => '',
'default' => false,
'visibility' => false,
'options' => false,
'tooltip' => false,
);
$params = array_replace_recursive( $defaults, $args );
if ( is_array( $params['name'] ) ) {
$toggle_value = $params['name'][2];
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$field_id_attr = isset( $params['field_id'] ) && '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$field_id_attr .= isset( $toggle_value ) && '' !== $toggle_value ? ' data-ajax-label="' . $toggle_value . '"' : false;
$selected_value = isset( $params['selected_value'] ) ? esc_html( $params['selected_value'] ) : $value;
$default_value = isset( $params['default'] ) && false !== $params['default'] ? esc_html( $params['default'] ) : false;
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( $params['tooltip'] ) : false;
$params['container_class'] = $this->maybe_add_visibility_classes( $params['class'], $params['visibility'] );
$css_classes = explode( ' ', $params['class'] );
$css_classes = array_unique( $css_classes );
$params['class'] = implode( ' ', $css_classes );
$css_container_classes = isset( $params['container_class'] ) ? explode( ' ', $params['container_class'] ) : array();
$css_container_classes = array_unique( $css_container_classes );
$params['container_class'] = implode( ' ', $css_container_classes );
$html = '
' . $label . ' ' . $tooltip_html . ' ';
if ( empty( $params['options'] ) ) {
$html .= '
There are currently no Charitable specific tags. Click here to start adding some or read our documentation for more .
';
}
if ( false !== $params['options'] && is_array( $params['options'] ) && count( $params['options'] ) > 0 ) {
if ( empty( $params['options'] ) ) {
$html .= '
There are currently no Charitable specific tags. Click here to start adding some or read our documentation for more .
';
} else {
$html .= '
';
foreach ( $params['options'] as $option_value => $text ) {
$selected = is_array( $value ) && in_array( $option_value, $value, true ) ? 'selected="selected"' : false;
$html .= '' . $text . ' ';
}
$html .= ' ';
}
}
$html .= '
';
return $html;
}
/**
* Output a user/author/creator dropdown for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_user_dropdown( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'container_class' => '',
'default' => false,
'visibility' => false,
'options' => false,
'tooltip' => false,
);
$params = array_replace_recursive( $defaults, $args );
if ( is_array( $value ) ) {
$value = reset( $value );
}
if ( is_array( $params['name'] ) ) {
$toggle_value = $params['name'][2];
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$field_id_attr = isset( $params['field_id'] ) && '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$field_id_attr .= isset( $toggle_value ) && '' !== $toggle_value ? ' data-ajax-label="' . $toggle_value . '"' : false;
$selected_value = isset( $params['selected_value'] ) ? esc_html( $params['selected_value'] ) : $value;
$default_value = isset( $params['default'] ) && false !== $params['default'] ? esc_html( $params['default'] ) : false;
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( wp_strip_all_tags( $params['tooltip'] ) ) : false;
$params['container_class'] = $this->maybe_add_visibility_classes( $params['class'], $params['visibility'] );
$css_classes = explode( ' ', $params['class'] );
$css_classes = array_unique( $css_classes );
$params['class'] = implode( ' ', $css_classes );
$css_container_classes = isset( $params['container_class'] ) ? explode( ' ', $params['container_class'] ) : array();
$css_container_classes = array_unique( $css_container_classes );
$params['container_class'] = implode( ' ', $css_container_classes );
$html = '
' . $label . ' ' . $tooltip_html . ' ';
if ( false !== $params['options'] && is_array( $params['options'] ) && count( $params['options'] ) > 0 ) {
$html .= '';
foreach ( $params['options'] as $option_value => $user_data ) {
$text = esc_html( $user_data['text'] );
$avatar = ! empty( $user_data['avatar'] ) ? esc_url( $user_data['avatar'] ) : false;
$meta = ! empty( $user_data['meta'] ) ? ( $user_data['meta'] ) : false;
$selected = ( isset( $selected_value ) && $option_value !== false && intval( $option_value ) === intval( $selected_value ) ) ? 'selected="selected"' : false;
$selected = ( false === $selected && false !== $default_value && $option_value === $default_value ) ? 'selected="selected"' : $selected;
$html .= '' . $text . ' ';
}
$html .= ' ';
}
$html .= '
';
return $html;
}
/**
* Output a user/author/creator dropdown for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $campaign_data Campaign data.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_user_dropdown_mini( $campaign_data = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'container_class' => '',
'default' => false,
'visibility' => false,
'options' => false,
);
$params = array_replace_recursive( $defaults, $args );
// get a default value.
$value = ! empty( $campaign_data['settings']['general']['campaign_creator_id'] ) ? intval( $campaign_data['settings']['general']['campaign_creator_id'] ) : false;
if ( is_array( $params['name'] ) ) {
$toggle_value = $params['name'][2];
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$field_id_attr = isset( $params['field_id'] ) && '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$field_id_attr .= isset( $toggle_value ) && '' !== $toggle_value ? ' data-ajax-label="' . $toggle_value . '"' : false;
$selected_value = isset( $params['selected_value'] ) ? esc_html( $params['selected_value'] ) : $value;
$default_value = isset( $params['default'] ) && false !== $params['default'] ? esc_html( $params['default'] ) : false;
$css_classes = explode( ' ', $params['class'] );
$css_classes = array_unique( $css_classes );
$params['class'] = implode( ' ', $css_classes );
$css_container_classes = isset( $params['container_class'] ) ? explode( ' ', $params['container_class'] ) : array();
$css_container_classes = array_unique( $css_container_classes );
$params['container_class'] = implode( ' ', $css_container_classes );
$html = '
' . $label . ' ';
if ( false !== $params['options'] && is_array( $params['options'] ) && count( $params['options'] ) > 0 ) {
$html .= '';
foreach ( $params['options'] as $option_value => $user_data ) {
$text = esc_html( $user_data['text'] );
$avatar = ! empty( $user_data['avatar'] ) ? esc_url( $user_data['avatar'] ) : false;
$meta = ! empty( $user_data['meta'] ) ? ( $user_data['meta'] ) : false;
$selected = ( isset( $selected_value ) && $value !== false && $option_value == $selected_value ) ? 'selected="selected"' : false;
$selected = ( false === $selected && ( 0 === intval( $selected_value ) || false === $selected_value ) && false !== $default_value && $option_value == $default_value ) ? 'selected="selected"' : $selected;
$html .= '' . $text . ' ';
}
$html .= ' ';
}
$html .= '
';
return $html;
}
/**
* Output a generic div for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_div( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
);
$params = array_replace_recursive( $defaults, $args );
if ( is_array( $value ) ) {
$value = reset( $value );
}
if ( is_array( $params['name'] ) ) {
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
$html = '';
return $html;
}
/**
* Output a Charitable categories checkbox area for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
* @version 1.8.9.1
*/
public function generate_categories( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'tooltip' => false,
);
$params = array_replace_recursive( $defaults, $args );
$categories_terms = get_terms(
array(
'taxonomy' => 'campaign_category',
'hide_empty' => 0,
)
);
$tooltip_html = ( isset( $params['tooltip'] ) && false !== $params['tooltip'] ) ? $this->get_tooltip_html( wp_strip_all_tags( $params['tooltip'] ) ) : false;
$html = '
' . $label . ' ' . $tooltip_html . ' ';
if ( empty( $categories_terms ) ) {
$html .= '
There are currently no Charitable campaign categories. Click here to start adding some or read our documentation for more .
';
} else {
$html .= '
';
}
$html .= '
';
return $html;
}
/**
* Output a campaign creator/author for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
* @version 1.8.9.1
*/
public function generate_campaign_creator_info( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'creator_id' => 0,
);
$params = array_replace_recursive( $defaults, $args );
$html = '
' . $label . ' ';
ob_start();
// make sure this is a number/ID.
$params['creator_id'] = intval( $params['creator_id'] );
if ( $params['creator_id'] ) :
$creator = new Charitable_User( $params['creator_id'] );
?>
get_avatar(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
%s', esc_html_x( 'Joined on', 'joined on date', 'charitable' ), esc_html( date_i18n( 'F Y', strtotime( $creator->user_registered ) ) ) ); ?>
';
return $html;
}
/**
* Output a donation amounts area for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_donation_amounts( $value = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'type' => '', // for this field, this might be recurring... otherwise blank by default.
'visibility' => false,
'donation_description_label' => esc_html__( 'donation', 'charitable' ),
'from' => false, // field if it's coming from preview field/block.
'button_label' => esc_html__( 'Add a Suggested Amount', 'charitable' ),
'default' => false, // this is the index of the row id if there is a default value.
'data_add_row' => 'suggested-amount',
'data_delete_row' => 'suggested-amount',
);
$params = array_replace_recursive( $defaults, $args );
$field_id_attr = isset( $params['field_id'] ) && '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$params['class'] = $this->maybe_add_visibility_classes( $params['class'], $params['visibility'] );
$html = '
';
$donations_table_css = ! empty( $params['type'] ) ? esc_attr( $params['type'] ) . '-' : false;
$html .= '
';
// Only show this in the mean settings menu, not the settings for the block.
if ( 'field' !== $params['from'] ) {
$html .= '';
}
$html .= '
Default
Amount
Description (optional)
';
if ( is_array( $params['name'] ) ) {
// convert array( 'settings', $settings_tab_slug, 'name' ) to settings['tab_slug']['name'].
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
// get a default value.
$campaign_suggested_donations_default = isset( $params['default'] ) ? intval( $params['default'] ) : false;
// get the donation description label.
$donation_description_label = esc_html( $params['donation_description_label'] ) . '.';
// check and see if this is a new campaign, and if so add some defaults.
if ( false === $value && ! isset( $_GET['campaign_id'] ) ) { // phpcs:ignore
$value = array(
1 => array(
'amount' => 5,
'description' => esc_html__( 'This is a small ', 'charitable' ) . $donation_description_label,
),
2 => array(
'amount' => 10,
'description' => esc_html__( 'This is a slightly larger ', 'charitable' ) . $donation_description_label,
),
3 => array(
'amount' => 15,
'description' => esc_html__( 'This is a larger (and default) ', 'charitable' ) . $donation_description_label,
),
4 => array(
'amount' => 20,
'description' => esc_html__( 'This is a large ', 'charitable' ) . $donation_description_label,
),
);
$campaign_suggested_donations_default = 3;
}
$html .= '';
if ( false === $value ) { // used to have || $index === 0.
$html .= '
No suggested amounts have been created yet.
';
}
$default_field_name = ( 'recurring' === $params['type'] ) ? 'campaign_suggested_recurring_donations_default' : 'campaign_suggested_donations_default';
$html .= '
';
if ( false === $value ) { // used to have || $index === 0.
// do nothing.
} elseif ( is_array( $value ) && ! empty( $value ) ) {
foreach ( $value as $key_id => $donation_info ) {
$amount = isset( $donation_info['amount'] ) ? charitable_format_money( $donation_info['amount'] ) : false;
$description = isset( $donation_info['description'] ) ? esc_html( $donation_info['description'] ) : false;
$selected = $key_id == $campaign_suggested_donations_default ? 'checked="checked"' : false;
$html .= '
';
}
}
$html .= '
+ ' . $params['button_label'] . ' Clear Defaults
';
return $html;
}
/**
* Output a donation amounts area for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param array $campaign_data Campaign data.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_donation_amounts_mini( $campaign_data = false, $label = false, $args = false ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'visibility' => false,
'from' => false, // field if it's coming from preview field/block.
'button_label' => esc_html__( 'Add a Suggested Amount', 'charitable' ),
'default' => false, // this is the index of the row id if there is a default value.
);
$params = array_replace_recursive( $defaults, $args );
$field_id_attr = isset( $params['field_id'] ) && '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$params['class'] = $this->maybe_add_visibility_classes( $params['class'], $params['visibility'] );
$html = '
Suggested Donation Amounts ';
$html .= '
';
// Only show this in the mean settings menu, not the settings for the block.
if ( 'field' !== $params['from'] ) {
$html .= '';
}
$html .= '
Default
Amount
Description (optional)
';
if ( is_array( $params['name'] ) ) {
// convert array( 'settings', $settings_tab_slug, 'name' ) to settings['tab_slug']['name'].
$name = implode( '][', $params['name'] ) . ']';
$params['name'] = str_replace( $params['name'][0] . ']', $params['name'][0], $name );
}
// get a default value.
$campaign_suggested_donations_default = ! empty( $campaign_data['settings']['donation-options']['suggested_donations_default'] ) ? intval( $campaign_data['settings']['donation-options']['suggested_donations_default'] ) : false;
if ( ! empty( $campaign_data['settings']['donation-options']['donation_amounts'] ) ) {
$value = $campaign_data['settings']['donation-options']['donation_amounts'];
} else {
$value = false;
}
// check and see if this is a new campaign, and if so add some defaults.
if ( ( false === $campaign_data || empty( $campaign_data['settings']['donation-options'] ) ) && ! isset( $_GET['campaign_id'] ) ) { // phpcs:ignore
$value = array(
1 => array(
'amount' => 5,
'description' => esc_html__( 'This is a small donation.', 'charitable' ),
),
2 => array(
'amount' => 10,
'description' => esc_html__( 'This is a slightly larger donation.', 'charitable' ),
),
3 => array(
'amount' => 15,
'description' => esc_html__( 'This is a larger (and default) donation.', 'charitable' ),
),
4 => array(
'amount' => 20,
'description' => esc_html__( 'This is a large donation.', 'charitable' ),
),
);
$campaign_suggested_donations_default = 3;
}
$index = is_array( $value ) ? count( $value ) : 0;
$html .= '';
if ( false === $campaign_data || $index === 0 ) {
$html .= '
No suggested amounts have been created yet.
';
}
$html .= '
';
if ( is_array( $value ) && ! empty( $value ) ) {
foreach ( $value as $key_id => $donation_info ) {
$amount = isset( $donation_info['amount'] ) ? charitable_format_money( $donation_info['amount'] ) : false;
$description = isset( $donation_info['description'] ) ? esc_html( $donation_info['description'] ) : false;
$selected = $key_id === $campaign_suggested_donations_default ? 'checked="checked"' : false;
$html .= '
';
}
}
$html .= '
+ ' . $params['button_label'] . '
';
return $html;
}
/**
* Output a generic dividing bar for the form settings in the left sidebar.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_divider( $value = false, $label = false, $args = array() ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'creator_id' => '',
);
$params = array_replace_recursive( $defaults, $args );
$field_id_attr = '' !== $params['field_id'] ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$html = '
';
return $html;
}
/**
* Output a headline.
*
* @since 1.8.0
*
* @param string $value Field value.
* @param string $label Feld label.
* @param array $args Field params.
*
* @return string
*/
public function generate_headline( $text = '', $args = array() ) {
$defaults = array(
'name' => '',
'id' => '',
'class' => '',
'field_id' => '',
);
$params = array_replace_recursive( $defaults, $args );
$field_id_attr = '' !== trim( $params['field_id'] ) ? 'data-field-id="' . intval( $params['field_id'] ) . '"' : false;
$html = '
' . esc_html( $text ) . ' ';
return $html;
}
/**
* Add visibility classes to the CSS classes array if the field is conditionally visible.
*
* @since 1.8.0
*
* @param array $css_classes The CSS classes array.
* @param array $params_visibility The visibility parameters.
*
* @return array The updated CSS classes array.
*/
public function maybe_add_visibility_classes( $css_classes, $params_visibility ) {
if ( ! empty( $params_visibility ) ) {
// if there's items in the area, assume it's hidden at start.
$visible = false;
// is there any conditions where the field could be visible upon load?
if ( ! empty( $params_visibility['show'] ) ) {
$visible_count = 0;
// all conditions in this array need to be true for visible to be true.
foreach ( $params_visibility['show'] as $element_value => $required_value ) {
if ( $element_value === $required_value ) {
++$visible_count;
}
}
if ( $visible_count === count( $params_visibility['show'] ) ) {
$visible = true;
}
}
$css_classes .= ( false === $visible ) ? 'charitable-hidden' : '';
}
return $css_classes;
}
}
new Charitable_Builder_Form_Fields();