/** * Custom Post Type UI Admin UI. * * @package CPTUI * @subpackage AdminUI * @author WebDevStudios * @since 1.0.0 * @license GPL-2.0+ * * phpcs:disable WebDevStudios.All.RequireAuthor */ /** * Custom Post Type UI Admin UI * * @since 1.0.0 */ class cptui_admin_ui { /** * Return an opening `` tag. * * @since 1.0.0 * @since 1.13.0 Added attributes parameter * * @param array $atts Array of custom attributes to add to the tag. * @return string $value Opening `` tag with attributes. */ public function get_tr_start( $atts = [] ) { $atts_str = ''; if ( ! empty( $atts ) ) { $atts_str = ' ' . $this->get_custom_attributes( $atts ); } return ''; } /** * Return a closing `` tag. * * @since 1.0.0 * * @return string $value Closing `` tag. */ public function get_tr_end() { return ''; } /** * Return an opening `` tag. * * @since 1.0.0 * @since 1.13.0 Added attributes parameter. * * @param array $atts Array of attributes to add to the tag. * @return string $value Opening `` tag with attributes. */ public function get_th_start( $atts = [] ) { $atts_str = ''; if ( ! empty( $atts ) ) { $atts_str = ' ' . $this->get_custom_attributes( $atts ); } return ""; } /** * Return a closing `` tag. * * @since 1.0.0 * * @return string $value Closing `` tag. */ public function get_th_end() { return ''; } /** * Return an opening `` tag. * * @since 1.0.0 * @since 1.13.0 Added attributes parameter. * * @param array $atts Array of attributes to add to the tag. * @return string $value Opening `` tag. */ public function get_td_start( $atts = [] ) { $atts_str = ''; if ( ! empty( $atts ) ) { $atts_str = ' ' . $this->get_custom_attributes( $atts ); } return ""; } /** * Return a closing `` tag. * * @since 1.0.0 * * @return string $value Closing `` tag. */ public function get_td_end() { return ''; } /** * Return an opening `

` tag. * * @since 1.2.0 * @since 1.3.0 Added $args parameter. * @since 1.13.0 Added $atts parameter * * @param array $args Array of arguments. * @param array $atts Array of custom attributes for the tag. * @return string $value Opening `

` tag. */ public function get_fieldset_start( $args = [], $atts = [] ) { $fieldset = 'get_custom_attributes( $atts ); } $fieldset .= ' tabindex="0">'; return $fieldset; } /** * Return an closing `

` tag. * * @since 1.2.0 * * @return string $value Closing `

` tag. */ public function get_fieldset_end() { return '

'; } /** * Return an opening `` tag. * * @since 1.3.0 * * @return string */ public function get_legend_start( $atts = [] ) { $atts_str = ''; if ( ! empty( $atts ) ) { $atts_str = ' ' . $this->get_custom_attributes( $atts ); } return "` tag. * * @since 1.3.0 * * @return string */ public function get_legend_end() { return ''; } /** * Return string wrapped in a `

` tag. * * @since 1.0.0 * * @param string $text Content to wrap in a `

` tag. * @return string $value Content wrapped in a `

` tag. */ public function get_p( $text = '' ) { return '

' . $text . '

'; } /** * Return a form with for attribute. * * @since 1.0.0 * * @param string $label_for Form input to associate `` with. * @param string $label_text Text to display in the `` tag. * @return string $value `` tag with filled out parts. */ public function get_label( $label_for = '', $label_text = '' ) { return '' . wp_strip_all_tags( $label_text ) . ''; } /** * Return an html attribute denoting a required field. * * @since 1.3.0 * * @param bool $required Whether or not the field is required. * @return string `Required` attribute. */ public function get_required_attribute( $required = false ) { $attr = ''; if ( $required ) { $attr .= 'required="true"'; } return $attr; } /** * Return a `` to indicate required status, with class attribute. * * @since 1.0.0 * * @return string Span tag. */ public function get_required_span() { return ' *'; } /** * Return an aria-required attribute set to true. * * @since 1.3.0 * * @param bool $required Whether or not the field is required. * @return string Aria required attribute */ public function get_aria_required( $required = false ) { $attr = $required ? 'true' : 'false'; return 'aria-required="' . $attr . '"'; } /** * Return an `` tag with title attribute holding help text. * * @since 1.0.0 * * @param string $help_text Text to use in the title attribute. * @return string tag with filled out parts. */ public function get_help( $help_text = '' ) { return ''; } /** * Return a `` tag with the help text. * * @since 1.3.0 * * @param string $help_text Text to display after the input. * @return string */ public function get_description( $help_text = '' ) { return '

' . $help_text . '

'; } /** * Return a maxlength HTML attribute with a specified length. * * @since 1.0.0 * * @param string $length How many characters the max length should be set to. * @return string $value Maxlength HTML attribute. */ public function get_maxlength( $length = '' ) { return 'maxlength="' . esc_attr( $length ) . '"'; } /** * Return a onblur HTML attribute for a specified value. * * @since 1.0.0 * * @param string $text Text to place in the onblur attribute. * @return string $value Onblur HTML attribute. */ public function get_onblur( $text = '' ) { return 'onblur="' . esc_attr( $text ) . '"'; } /** * Return a placeholder HTML attribtue for a specified value. * * @since 1.3.0 * * @param string $text Text to place in the placeholder attribute. * @return string $value Placeholder HTML attribute. */ public function get_placeholder( $text = '' ) { return 'placeholder="' . esc_attr( $text ) . '"'; } /** * Return a span that will only be visible for screenreaders. * * @since 1.3.0 * * @param string $text Text to visually hide. * @return string $value Visually hidden text meant for screen readers. */ public function get_hidden_text( $text = '' ) { return '' . $text . ''; } /** * Return a populated `` input. * @return string $value Complete '; if ( ! empty( $args['selections']['options'] ) && is_array( $args['selections']['options'] ) ) { foreach ( $args['selections']['options'] as $val ) { $result = ''; $bool = disp_boolean( $val['attr'] ); if ( is_numeric( $args['selections']['selected'] ) ) { $selected = disp_boolean( $args['selections']['selected'] ); } elseif ( in_array( $args['selections']['selected'], [ 'true', 'false' ], true ) ) { $selected = $args['selections']['selected']; } if ( ! empty( $selected ) && $selected === $bool ) { $result = ' selected="selected"'; } else { if ( array_key_exists( 'default', $val ) && ! empty( $val['default'] ) ) { if ( empty( $selected ) ) { $result = ' selected="selected"'; } } } if ( ! is_numeric( $args['selections']['selected'] ) && ( ! empty( $args['selections']['selected'] ) && $args['selections']['selected'] === $val['attr'] ) ) { $result = ' selected="selected"'; } $value .= ''; } } $value .= ''; if ( ! empty( $args['aftertext'] ) ) { $value .= ' ' . $this->get_description( $args['aftertext'] ); } if ( $args['wrap'] ) { $value .= $this->get_td_end(); $value .= $this->get_tr_end(); } return $value; } /** * Return a text input. * * @since 1.0.0 * * @param array $args Arguments to use with the text input. * @return string Complete text `` with proper attributes. */ public function get_text_input( $args = [] ) { $defaults = $this->get_default_input_parameters( [ 'maxlength' => '', 'onblur' => '', ] ); $args = wp_parse_args( $args, $defaults ); $value = ''; if ( $args['wrap'] ) { $value .= $this->get_tr_start(); $value .= $this->get_th_start(); $value .= $this->get_label( $args['name'], $args['labeltext'] ); if ( $args['required'] ) { $value .= $this->get_required_span(); } $value .= $this->get_th_end(); $value .= $this->get_td_start(); } $value .= 'get_maxlength( $args['maxlength'] ); } if ( $args['onblur'] ) { $value .= ' ' . $this->get_onblur( $args['onblur'] ); } $value .= ' ' . $this->get_aria_required( $args['required'] ); $value .= ' ' . $this->get_required_attribute( $args['required'] ); if ( ! empty( $args['aftertext'] ) ) { if ( $args['placeholder'] ) { $value .= ' ' . $this->get_placeholder( $args['aftertext'] ); } } if ( ! empty( $args['data'] ) ) { foreach ( $args['data'] as $dkey => $dvalue ) { $value .= " data-{$dkey}=\"{$dvalue}\""; } } $value .= ' />'; if ( ! empty( $args['aftertext'] ) ) { $value .= $this->get_hidden_text( $args['aftertext'] ); } if ( $args['helptext'] ) { $value .= '
' . $this->get_description( $args['helptext'] ); } if ( $args['wrap'] ) { $value .= $this->get_td_end(); $value .= $this->get_tr_end(); } return $value; } /** * Return a `'; if ( ! empty( $args['aftertext'] ) ) { $value .= $args['aftertext']; } if ( $args['helptext'] ) { $value .= '
' . $this->get_description( $args['helptext'] ); } if ( $args['wrap'] ) { $value .= $this->get_td_end(); $value .= $this->get_tr_end(); } return $value; } /** * Return a checkbox ``. * * @since 1.0.0 * * @param array $args Arguments to use with the checkbox input. * @return string $value Complete checkbox `` with proper attributes. */ public function get_check_input( $args = [] ) { $defaults = $this->get_default_input_parameters( [ 'checkvalue' => '', 'checked' => 'true', 'checklisttext' => '', 'default' => false, ] ); $args = wp_parse_args( $args, $defaults ); $value = ''; if ( $args['wrap'] ) { $value .= $this->get_tr_start(); $value .= $this->get_th_start(); $value .= $args['checklisttext']; if ( $args['required'] ) { $value .= $this->get_required_span(); } $value .= $this->get_th_end(); $value .= $this->get_td_start(); } if ( isset( $args['checked'] ) && 'false' === $args['checked'] ) { $value .= ''; } else { $value .= ''; } $value .= $this->get_label( $args['name'], $args['labeltext'] ); $value .= '
'; if ( $args['wrap'] ) { $value .= $this->get_td_end(); $value .= $this->get_tr_end(); } return $value; } /** * Return a button ``. * * @since 1.3.0 * * @param array $args Arguments to use with the button input. * @return string Complete button ``. */ public function get_button( $args = [] ) { $value = ''; $classes = isset( $args['classes'] ) ? $args['classes'] : ''; $value .= ''; return $value; } /** * Returns an HTML block for previewing the menu icon. * * @param string $menu_icon URL or a name of the dashicons class. * * @return string $value HTML block with a layout of the menu icon preview. * @since 1.8.1 */ public function get_menu_icon_preview( $menu_icon = '' ) { $content = ''; if ( ! empty( $menu_icon ) ) { $content = '

'; if ( 0 === strpos( $menu_icon, 'dashicons-' ) ) { $content = '

'; } } return '

' . $content . '

'; } /** * Return some array_merged default arguments for all input types. * * @since 1.0.0 * * @param array $additions Arguments array to merge with our defaults. * @return array $value Merged arrays for our default parameters. */ public function get_default_input_parameters( $additions = [] ) { return array_merge( [ 'namearray' => '', 'name' => '', 'textvalue' => '', 'labeltext' => '', 'aftertext' => '', 'helptext' => '', 'helptext_after' => false, 'required' => false, 'wrap' => true, 'placeholder' => true, ], (array) $additions ); } /** * Return combined attributes string. * * @param array $attributes Array of attributes to combine. * * @return string * @since 1.13.0 */ public function get_custom_attributes( $attributes = [] ) { $formatted = []; if ( ! empty( $attributes ) ) { foreach ( $attributes as $key => $attribute ) { $formatted[] = "$key=\"$attribute\""; } } return implode( ' ', $formatted ); } }