rightpress-forms.class.php 13.3 KB
Newer Older
Pham Huy committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
<?php

// Exit if accessed directly
if (!defined('ABSPATH')) {
    exit;
}

/**
 * RightPress Forms Helper
 */
if (!class_exists('RightPress_Forms')) {

final class RightPress_Forms
{

    /**
     * Render text field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function text($params)
    {
        self::input('text', $params, array('value', 'maxlength', 'placeholder', 'readonly'));
    }

    /**
     * Render hidden field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function hidden($params)
    {
        self::input('hidden', $params, array('value'));
    }

    /**
     * Render text area field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function textarea($params)
    {
        // Get attributes
        $attributes = self::attributes($params, array('value', 'maxlength', 'placeholder', 'rows'), 'textarea');

        // Get value
        $value = !empty($params['value']) ? $params['value'] : '';

        // Generate field html
        $field_html = '<textarea ' . $attributes . '>' . $value . '</textarea>';

        // Render field
        self::output($params, $field_html, 'textarea');
    }

    /**
     * Render password field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function password($params)
    {
        $params['autocomplete'] = 'off';
        self::input('password', $params, array('value', 'maxlength', 'placeholder'));
    }

    /**
     * Render email field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function email($params)
    {
        self::input('email', $params, array('value', 'maxlength', 'placeholder'));
    }

    /**
     * Render decimal field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function decimal($params)
    {
        self::number($params, true);
    }

    /**
     * Render number field
     *
     * @access public
     * @param array $params
     * @param bool $is_decimal
     * @return void
     */
    public static function number($params, $is_decimal = false)
    {
        // Accept decimals
        if ($is_decimal) {
            $params['step'] = 'any';
        }

        // Print field
        self::input('number', $params, array('value', 'maxlength', 'placeholder', 'step', 'min'));
    }

    /**
     * Render date field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function date($params)
    {
        // Disable autocomplete
        $params['autocomplete'] = 'off';

        // Display as regular text field, will initialize Datetimepicker based on object's class
        self::input('text', $params, array('value', 'placeholder'), true);
    }

    /**
     * Render select field
     *
     * @access public
     * @param array $params
     * @param bool $is_multiple
     * @param bool $is_grouped
     * @param bool $prepend_group_key
     * @return void
     */
    public static function select($params, $is_multiple = false, $is_grouped = false, $prepend_group_key = false)
    {
        // Get attributes
        $attributes = self::attributes($params, array(), 'select');

        // Get options
        $options = self::options($params, $is_grouped, $prepend_group_key);

        // Check if it's multiselect
        $multiple_html = $is_multiple ? 'multiple' : '';

        // Generate field html
        $field_html = '<select ' . $multiple_html . ' ' . $attributes . '>' . $options . '</select>';

        // Render field
        $field_type = $is_multiple ? 'multiselect' : ($is_grouped ? 'grouped_select' : 'select');
        self::output($params, $field_html, $field_type);
    }

    /**
     * Render grouped select field
     *
     * @access public
     * @param array $params
     * @param bool $prepend_group_key
     * @return void
     */
    public static function grouped_select($params, $prepend_group_key = false)
    {
        self::select($params, false, true, $prepend_group_key);
    }

    /**
     * Render multiselect field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function multiselect($params)
    {
        self::select($params, true);
    }

    /**
     * Render checkbox field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function checkbox($params)
    {
        self::checkbox_or_radio('checkbox', $params);
    }

    /**
     * Render radio field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function radio($params)
    {
        self::checkbox_or_radio('radio', $params);
    }

    /**
     * Render checkbox or radio field
     *
     * @access public
     * @param string $type
     * @param array $params
     * @return void
     */
    public static function checkbox_or_radio($type, $params)
    {
        $field_html = '';

        // Single field?
        if (empty($params['options'])) {
            $attributes = self::attributes($params, array('value', 'checked'), $type);
            $field_html .= '<input type="' . $type . '" ' . $attributes . '>';
        }

        // Set of fields - iterate over options and generate field for each option
        else {

            // Open list
            $field_html .= '<ul>';

            // Iterate over field options and display as individual items
            foreach ($params['options'] as $key => $label) {

                // Customize params
                $custom_params = $params;
                $custom_params['id'] = $custom_params['id'] . '_' . $key;

                // Get attributes
                $attributes = self::attributes($custom_params, array(), $type);

                // Check if this item needs to be checked
                if (isset($params['value'])) {
                    $values = (array) $params['value'];
                    $checked = in_array($key, $values) ? 'checked="checked"' : '';
                }
                else {
                    $checked = (isset($params['checked']) && in_array($key, $params['checked']) ? 'checked="checked"' : '');
                }

                // Generate HTML
                $field_html .= '<li><input type="' . $type . '" value="' . $key . '" ' . $checked . ' ' . $attributes . '>' . (!empty($label) ? ' ' . $label : '') . '</li>';
            }

            // Close list
            $field_html .= '</ul>';
        }

        // Render field
        self::output($params, $field_html, $type);
    }

    /**
     * Render file field
     *
     * @access public
     * @param array $params
     * @return void
     */
    public static function file($params)
    {
        self::input('file', $params, array('accept'));
    }

    /**
     * Render generic input field
     *
     * @access public
     * @param string $type
     * @param array $params
     * @param array $custom_attributes
     * @param bool $is_date
     * @return void
     */
    private static function input($type, $params, $custom_attributes = array(), $is_date = false)
    {
        // Get attributes
        $attributes = self::attributes($params, $custom_attributes, $type);

        // Generate field html
        $field_html = '<input type="' . $type . '" ' . $attributes . '>';

        // Render field
        self::output($params, $field_html, $type, $is_date);
    }

    /**
     * Render attributes
     *
     * @access public
     * @param array $params
     * @param array $custom
     * @param string $type
     * @return void
     */
    private static function attributes($params, $custom = array(), $type = 'text')
    {
        $html = '';

        // Get full list of attributes
        $attributes = array_merge(array('type', 'name', 'id', 'class', 'autocomplete', 'style', 'title', 'placeholder'), $custom);

        // Additional attributes for admin ui
        if (is_admin()) {
            $attributes[] = 'required';
            $attributes[] = 'disabled';
        }

        // Extract attributes and append to html string
        foreach ($attributes as $attribute) {
            if (isset($params[$attribute]) && !RightPress_Help::is_empty($params[$attribute])) {
                $html .= $attribute . '="' . $params[$attribute] . '" ';
            }
        }

        // Extract any data attributes
        foreach ($params as $param_key => $param) {
            if (RightPress_Help::string_begins_with_substring($param_key, 'data-') && !in_array($param_key, $attributes, true)) {
                $html .= $param_key . '="' . $param . '" ';
            }
        }

        // Return attributes string
        return $html;
    }

    /**
     * Get options for select field
     *
     * @access public
     * @param array $params
     * @param bool $is_grouped
     * @param bool $prepend_group_key
     * @return string
     */
    private static function options($params, $is_grouped = false, $prepend_group_key = false)
    {
        $html = '';
        $selected = array();

        // Get selected option(s)
        if (isset($params['value'])) {
            $selected = (array) $params['value'];
        }
        else if (!empty($params['selected'])) {
            $selected = (array) $params['selected'];
        }

        // Extract options and append to html string
        if (!empty($params['options']) && is_array($params['options'])) {

            // Fix array depth if options are not grouped
            if (!$is_grouped) {
                $params['options'] = array(
                    'not_grouped' => array(
                        'options' => $params['options'],
                    ),
                );
            }

            // Iterate over option groups
            foreach ($params['options'] as $group_key => $group) {

                // Option group start
                if ($is_grouped) {
                    $html .= '<optgroup label="' . $group['label'] . '">';
                }

                // Iterate over options
                foreach ($group['options'] as $option_key => $option) {

                    // Get option key
                    $option_key = (($is_grouped && $prepend_group_key) ? $group_key . '__' . $option_key : $option_key);

                    // Check if option is selected
                    $selected_html = in_array($option_key, $selected) ? 'selected="selected"' : '';

                    // Format option html
                    $html .= '<option value="' . $option_key . '" ' . $selected_html . '>' . $option . '</option>';
                }

                // Option group end
                if ($is_grouped) {
                    $html .= '</optgroup>';
                }
            }
        }

        return $html;
    }

    /**
     * Render field label
     *
     * @access public
     * @param array $params
     * @return string
     */
    private static function label($params)
    {
        echo self::label_html($params);
    }

    /**
     * Get field label html
     *
     * @access public
     * @param array $params
     * @return string
     */
    private static function label_html($params)
    {
        // Check if label needs to be displayed
        if (!empty($params['id']) && isset($params['label']) && !RightPress_Help::is_empty($params['label'])) {

            // Return label html
            return '<label for="' . $params['id'] . '">' . $params['label'] . '</label>';
        }

        return '';
    }

    /**
     * Render field description
     *
     * @access public
     * @param array $params
     * @return string
     */
    private static function description($params)
    {
        echo self::description_html($params);
    }

    /**
     * Get field description html
     *
     * @access public
     * @param array $params
     * @return string
     */
    private static function description_html($params)
    {
        if (!empty($params['description'])) {
            return '<small>' . $params['description'] . '</small>';
        }

        return '';
    }

    /**
     * Output field based on context
     *
     * @access public
     * @param array $params
     * @param string $field_html
     * @param string $type
     * @param bool $is_date
     * @return void
     */
    private static function output($params, $field_html, $type, $is_date = false)
    {
        // Open container
        self::output_begin($type, $is_date);

        // Print label
        self::label($params);

        // Print field
        echo $field_html;

        // Print description after field
        self::description($params, 'after');

        // Close container
        self::output_end($type);
    }

    /**
     * Output container begin
     *
     * @access public
     * @param string $type
     * @param bool $is_date
     * @return void
     */
    private static function output_begin($type, $is_date = false)
    {

    }

    /**
     * Output container end
     *
     * @access public
     * @param string $type
     * @return void
     */
    private static function output_end($type)
    {

    }

    /**
     * Check if field type has options
     *
     * @access public
     * @param string $type
     * @return bool
     */
    public static function has_options($type)
    {
        return in_array($type, array('select', 'multiselect', 'checkbox', 'radio'));
    }

}
}