id = $id;
$this->action = $action;
$this->method = $method;
$this->attributes = $attributes;
}
/**
* Set form fields.
*
* @param array $fields Form fields.
*/
public function set_fields( $fields = array() ) {
$this->fields = $fields;
}
/**
* Set form buttons.
*
* @param array $buttons Form buttons.
*/
public function set_buttons( $buttons = array() ) {
$this->buttons = $buttons;
}
/**
* Set errors.
*
* @param array $errors Form errors.
*/
protected function set_errors( $errors = array() ) {
$this->errors[] = $errors;
}
/**
* Set success message.
*
* @param string $success Form success message.
*/
public function set_success_message( $success = '' ) {
$this->success = $success;
}
/**
* Get submitted data.
*
* @return array Submitted data.
*/
public function get_submitted_data() {
$data = $this->submitted_form_data();
return $data;
}
/**
* Get submitted attachments.
*
* @return array Submitted attachments.
*/
public function get_attachments() {
$attachments = $this->uploaded_files();
return $attachments;
}
/**
* Get current page.
*
* @return string Currente Page URL.
*/
protected function get_current_page() {
$url = 'http';
if ( isset( $_SERVER['HTTPS'] ) && 'on' == $_SERVER['HTTPS'] ) {
$url .= 's';
}
$url .= '://';
if ( '80' != $_SERVER['SERVER_PORT'] ) {
$url .= $_SERVER['SERVER_NAME'] . ':' . $_SERVER['SERVER_PORT'] . $_SERVER['REQUEST_URI'];
} else {
$url .= $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI'];
}
return $url;
}
/**
* Get field label via ID.
*
* @param string $id Field ID.
*
* @return string Field label.
*/
protected function get_field_label( $id ) {
foreach ( $this->fields as $fieldset ) {
foreach ( $fieldset['fields'] as $field ) {
if ( $field['id'] == $id ) {
return $field['label'];
}
}
}
return '';
}
/**
* Process form and fields attributes.
*
* @param array $attributes Attributes as array.
*
* @return string Attributes as string.
*/
protected function process_attributes( $attributes = array() ) {
$attrs = '';
if ( ! empty( $attributes ) ) {
foreach ( $attributes as $key => $attribute ) {
$attrs .= ' ' . $key . '="' . $attribute . '"';
}
}
return $attrs;
}
/**
* Sets the field default value.
*
* @return string Default value.
*/
protected function default_field( $id, $default ) {
if ( 'get' == $this->method ) {
return isset( $_GET[ $id ] ) ? sanitize_text_field( $_GET[ $id ] ) : $default;
} else {
return isset( $_POST[ $id ] ) ? sanitize_text_field( $_POST[ $id ] ) : $default;
}
}
/**
* Process form fields.
*
* @return string Form fields HTML.
*/
protected function process_fields() {
$html = '';
if ( ! empty( $this->fields ) ) {
foreach ( $this->fields as $key => $fieldset ) {
$fieldset_attributes = isset( $fieldset['attributes'] ) ? $fieldset['attributes'] : array();
$html .= sprintf( '';
}
}
return $html;
}
/**
* Process form buttons.
*
* @return string Form buttons HTML.
*/
protected function process_buttons() {
$html = '';
if ( ! empty( $this->buttons ) ) {
foreach ( $this->buttons as $button ) {
$attributes = isset( $button['attributes'] ) ? $button['attributes'] : array( 'class' => 'btn btn-primary' );
$html .= sprintf(
'',
$button['id'],
$button['type'],
$this->process_attributes( $attributes ),
$button['label']
);
}
} else {
$html .= '';
}
$html .= '
';
return $html;
}
/**
* Display error messages.
*
* @param string $html Form HTML.
*
* @return string Error messages.
*/
public function display_error_messages( $html ) {
if ( ! empty( $this->errors ) ) {
$html .= '';
foreach ( $this->errors as $error ) {
$html .= '
' . $error . '
';
}
$html .= '
';
if ( ! empty( $this->success ) ) {
$html .= '
' . $this->success . '
';
} else {
$html .= '
' . __( 'Form submitted successfully!', 'avalon-b' ) . '
';
}
$html .= '
', $id );
$html .= sprintf( '', $id, $label, $this->required_field_alert( $attributes ) );
$html .= sprintf( '', $id, $default, $this->process_attributes( $attributes ) );
$html .= ! empty( $description ) ? '' . $description . '' : '';
$html .= '
';
return $html;
}
/**
* Hidden field.
*
* @param string $id Field id.
* @param string $default Default value.
* @param array $attributes Array with field attributes.
*
* @return string HTML of the field.
*/
protected function field_hidden( $id, $default, $attributes ) {
// Set the default type.
if ( ! isset( $attributes['type'] ) ) {
$attributes['type'] = 'hidden';
}
$html = sprintf( '', $id, $default, $this->process_attributes( $attributes ) );
return $html;
}
/**
* Textarea field.
*
* @param string $id Field id.
* @param string $label Field label.
* @param string $default Default value.
* @param string $description Field description.
* @param array $attributes Array with field attributes.
*
* @return string HTML of the field.
*/
protected function field_textarea( $id, $label, $default, $description, $attributes ) {
// Set the default class.
if ( ! isset( $attributes['class'] ) ) {
$attributes['class'] = 'form-control';
}
if ( ! isset( $attributes['cols'] ) ) {
$attributes['cols'] = '60';
}
if ( ! isset( $attributes['rows'] ) ) {
$attributes['rows'] = '4';
}
$html = sprintf( '', $id );
$html .= sprintf( '', $id, $label, $this->required_field_alert( $attributes ) );
$html .= sprintf( '', $id, $this->process_attributes( $attributes ), $default );
$html .= ! empty( $description ) ? '' . $description . '' : '';
$html .= '
';
return $html;
}
/**
* Checkbox field.
*
* @param string $id Field id.
* @param string $label Field label.
* @param string $default Default value.
* @param string $description Field description.
* @param array $attributes Array with field attributes.
*
* @return string HTML of the field.
*/
protected function field_checkbox( $id, $label, $default, $description, $attributes ) {
// Set the checked attribute
if ( ! empty( $default ) ) {
$attributes['checked'] = 'checked';
}
$html = sprintf( '', $id );
$html .= '';
$html .= ! empty( $description ) ? '' . $description . '' : '';
$html .= '
';
return $html;
}
/**
* Select field.
*
* @param string $id Field id.
* @param string $label Field label.
* @param string $default Default value.
* @param string $description Field description.
* @param array $attributes Array with field attributes.
* @param array $options Array with field options (value => name).
*
* @return string HTML of the field.
*/
protected function field_select( $id, $label, $default, $description, $attributes, $options ) {
// Set the default class.
if ( ! isset( $attributes['class'] ) ) {
$attributes['class'] = 'form-control';
}
// If multiple add a array in the option.
$multiple = ( in_array( 'multiple', $attributes ) ) ? '[]' : '';
$html = sprintf( '', $id );
$html .= sprintf( '', $id, $label, $this->required_field_alert( $attributes ) );
$html .= sprintf( '';
$html .= ! empty( $description ) ? '' . $description . '' : '';
$html .= '
';
return $html;
}
/**
* Radio field.
*
* @param string $id Field id.
* @param string $label Field label.
* @param string $default Default value.
* @param string $description Field description.
* @param array $attributes Array with field attributes.
* @param array $options Array with field options (value => label).
*
* @return string HTML of the field.
*/
protected function field_radio( $id, $label, $default, $description, $attributes, $options ) {
$html = sprintf( '';
return $html;
}
/**
* Checks if the form data is valid.
*
* @return bool
*/
protected function is_valid() {
$valid = empty( $this->errors ) ? true : false;
return $valid;
}
/**
* Gests the form submitted data.
*
* @return array Form submitted data.
*/
protected function submitted_form_data() {
// Checks the form method.
if ( 'get' == $this->method ) {
$data = $_GET;
} else {
$data = $_POST;
}
return $data;
}
/**
* Gests the form submitted files.
*
* @return array Form submitted files.
*/
protected function submitted_form_files() {
$files = array();
// Checks the form method.
if ( 0 < count( $_FILES ) ) {
$files = $_FILES;
}
return $files;
}
/**
* Validates the form data.
*/
protected function validate_form_data() {
$errors = array();
// Sets the data.
$data = $this->submitted_form_data();
$files = $this->submitted_form_files();
if ( ! empty( $this->fields ) && ! empty( $data ) ) {
foreach ( $this->fields as $fieldset ) {
foreach ( $fieldset['fields'] as $field ) {
$id = $field['id'];
$type = $field['type'];
$label = isset( $field['label'] ) ? $field['label'] : '';
$value = ! empty( $data[ $id ] ) ? $data[ $id ] : '';
$required = isset( $field['required'] ) && $field['required'] ? true : false;
if ( $type != 'file' && $required && empty( $data[ $id ] ) ) {
$this->set_errors( sprintf( __( '%s is required.', 'avalon-b' ), '' . $label . '' ) );
}
switch ( $type ) {
case 'email':
if ( ! is_email( $value ) ) {
$this->set_errors( sprintf( __( '%s must be an email address valid.', 'avalon-b' ), '' . $label . '' ) );
}
break;
case 'file':
if ( count($files) >= 1 ) {
if ( $required && empty( $files[ $id ]['name'] ) ) {
$this->set_errors( sprintf( __( '%s is required.', 'avalon-b' ), '' . $label . '' ) );
}
}
break;
default:
$custom_message = apply_filters( 'odin_front_end_form_valid_' . $this->id . '_' . $id, '', $label, $value );
if ( $custom_message ) {
$this->set_errors( $custom_message );
}
break;
}
}
}
}
// Sets the errors.
if ( ! empty( $this->errors ) ) {
// Remove valid param.
if ( isset( $_GET['success'] ) && 1 == $_GET['success'] ) {
unset( $_GET['success'] );
}
}
}
/**
* Redirect to current page.
*/
protected function redirect() {
@ob_clean();
$url = $this->get_current_page();
$url = apply_filters( 'odin_front_end_form_redirect_' . $this->id, add_query_arg( 'success', '1', $url ) );
wp_redirect( $url, 303 );
exit;
}
/**
* Process the send form files.
*
* @return array
*/
protected function uploaded_files() {
require_once ABSPATH . 'wp-admin/includes/image.php';
require_once ABSPATH . 'wp-admin/includes/file.php';
require_once ABSPATH . 'wp-admin/includes/media.php';
$attachments = array();
foreach ( $this->fields as $fieldset ) {
foreach ( $fieldset['fields'] as $field ) {
$id = $field['id'];
if ( 'file' == $field['type'] && isset( $_FILES[ $id ] ) ) {
$attachment_id = media_handle_upload( $id, 0 );
if ( is_wp_error( $attachment_id ) ) {
$error = apply_filters( 'odin_front_end_form_upload_error_' . $this->id, sprintf( '%s %s.', '' . $this->get_field_label( $id ) . '', $attachment_id->get_error_message() ) );
$this->set_errors( $error );
} else {
$attachments[ $id ] = array(
'file' => get_attached_file( $attachment_id ),
'url' => wp_get_attachment_url( $attachment_id )
);
}
}
}
}
return $attachments;
}
/**
* Form init.
* Hook this in the WordPress init action.
*/
public function init() {
$submitted_data = $this->submitted_form_data();
$uploaded_files = $this->get_attachments();
if ( ! empty( $submitted_data ) && isset( $submitted_data['odin_form_action'] ) && $this->id == $submitted_data['odin_form_action'] ) {
// Validates the form data.
$this->validate_form_data();
if ( $this->is_valid() ) {
// Hook to process submitted form data.
do_action( 'odin_front_end_form_submitted_data_' . $this->id, $submitted_data, $uploaded_files );
// Redirect after submit.
$this->redirect();
} else {
add_filter( 'odin_front_end_form_messages_' . $this->id, array( $this, 'display_error_messages' ) );
}
}
}
/**
* Render the form.
*
* @return string Form HTML.
*/
public function render() {
$html = '';
// Display error messages.
$html .= apply_filters( 'odin_front_end_form_messages_' . $this->id, $html );
// Display success message.
$html .= $this->display_success_message();
// Process the fields.
$fields = $this->process_fields();
// Generate the form.
$html .= sprintf(
'';
return $html;
}
}