File forms/form.php

  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

<?php

namespace SIW\Forms;

use SIW\Formatting;
use SIW\Properties;
use SIW\Email\Template;

/**
 * Class om een Caldera Forms formulier toe te voegen
 * 
 * @copyright 2019 SIW Internationale Vrijwilligersprojecten
 * @since     3.0.0
 */
class Form {

    /**
     * Standaard cell-breedte
     */
    const DEFAULT_CELL_WIDTH = 6;

    /**
     * ID van het formulier
     *
     * @var string
     */
    protected $id;

    /**
     * Formulier
     *
     * @var array
     */
    protected $form;

    /**
     * Data uit configuratiebestand
     *
     * @var array
     */
    protected $data;

    /**
     * Standaardvelden
     *
     * @var array
     */
    protected $default_fields;

    /**
     * Instellingen voor e-mail
     *
     * @var array
     */
    protected $email_settings;

    /**
     * Init
     *
     * @param string $id
     */
    public function __construct( string $id ) {
        $this->id = $id;
        add_filter( 'caldera_forms_get_forms', [ $this, 'add_to_forms'] );
        add_filter( "caldera_forms_get_form-{$this->id}", [ $this, 'add_form' ] );
    }

    /**
     * Laadt data uit bestand
     * 
     * @return bool
     */
    protected function load_data() {

        
        $data = siw_get_data( "forms/{$this->id}" );
        if ( null === $data ) {
            return false;
        }
        $this->data = wp_parse_args_recursive( $data, [
            'args'          => [],
            'intro'         => '',
            'pages'         => [],
            'fields'        => [],
            'confirmation'  => [],
            'notification'  => [],
            'email_option'  => '',
        ]);

        $this->default_fields = siw_get_data( 'form-fields' );

        return true;
    }

    /**
     * Voegt formulier toe
     *
     * @param array $forms
     */
    public function add_to_forms( array $forms ) {
        $forms[ $this->id ] = apply_filters( "caldera_forms_get_form-{$this->id}", [] );
        return $forms;
    }

    /**
     * Voegt eigenschappen van formulier toe
     *
     * @param array $form
     * @return array
     */
    public function add_form( array $form ) {
        
        $form = wp_cache_get( $this->id, 'siw_forms' );
        if ( false !== $form ) {
            return $form;
        }

        if ( false === $this->load_data() ) {
            return [];
        }
        $this->email_settings = siw_get_email_settings( $this->id );
        $this->init_form();
        $this->set_pages();
        $this->set_fields();
        $this->set_mailer();
        $this->set_autoresponder();
        $this->set_spam_check();

        wp_cache_set( $this->id, $this->form, 'siw_forms' );

        return $this->form;
    }

    /**
     * Initialiseer formulier
     */
    protected function init_form() {
        $form = [
            'ID'                 => $this->id,
            'name'               => __( 'Formulier', 'siw' ),
            'db_support'         => false,
            'pinned'             => false,
            'pin_roles'          => [],
            'hide_form'          => true,
            'check_honey'        => true,
            'success'            => __( 'Je bericht werd succesvol verzonden.', 'siw' ),
            'form_ajax'          => true,
            'scroll_top'         => true,
            'has_ajax_callback'  => true,
            'custom_callback'    => 'siwGoogleAnalytics.trackFormSubmission',
            'layout_grid'        => [],
            'fields'             => [],
            'page_names'         => [],
            'auto_progress'      => true,
            'processors'         => [],
            'conditional_groups' => [],
            'settings'           => [
                'responsive' => [
                    'break_point' => 'sm',
                ],
            ],
            'mailer'             => []
        ];
        $this->form = wp_parse_args_recursive(
            $this->data['args'],
            $form
        );
    }

    /**
     *  Zet instellingen van mailer
     */
    protected function set_mailer() {
        $notification = $this->data['notification'];

        $this->form['mailer'] = [
            'on_insert'     => true,
            'sender_name'   => __( 'Website', 'siw' ),
            'sender_email'  => $this->email_settings['email'],
            'reply_to'      => "%{$this->data['primary_email']}%",
            'email_type'    => 'html',
            'recipients'    => $this->email_settings['email'],
            'email_subject' => $notification['subject'],
            'email_message' => $this->get_email_template(
                [
                    'subject'         => $notification['subject'],
                    'message'         => $notification['message'],
                    'show_signature'  => false,
                    'show_summary'    => true,
                ]
            ),
        ];
    }

    /**
     * Zet instellingen van autoresponder
     */
    protected function set_autoresponder() {
        $confirmation = $this->data['confirmation'];

        $config = [
            'sender_name'     => Properties::NAME,
            'sender_email'    => $this->email_settings['email'],
            'subject'         => $confirmation['subject'],
            'recipient_name'  => $confirmation['recipient_name'],
            'recipient_email' => "%{$this->data['primary_email']}%",
            'message'         => $this->get_email_template(
                [
                    'subject'         => $confirmation['subject'],
                    'message'         => $confirmation['message'],
                    'show_signature'  => true,
                    'signature_name'  => $this->email_settings['name'],
                    'signature_title' => $this->email_settings['title'],
                    'show_summary'    => true,
                ]
            ),
        ];
        $this->add_processor( 'confirmation', 'auto_responder', $config );
    }

    /**
     * Voegt formprocessor toe
     *
     * @param string $id
     * @param string $type
     * @param array $config
     * @param array $conditions
     */
    protected function add_processor( string $id, string $type, array $config, array $conditions = [] ) {
        $this->form['processors']["fp_{$id}"] = [
            'ID'         => "fp_{$id}",
            'type'       => $type,
            'config'     => $config,
            'conditions' => $conditions,
        ];
    }

    /**
     * Voegt form processor voor spam check toe
     */
    protected function set_spam_check() {
        $this->add_processor( 'spam_check', 'siw_spam_check', [ 'email' => $this->data['primary_email'] ] );
    }

    /**
     * Voegt pagina's toe
     * 
     * @todo: naam van formulier gebruiken als fallback
     */
    protected function set_pages() {
        if ( empty( $this->data['pages'] ) ) {
            $this->form['page_names'] = [
                __( 'Formulier', 'siw' ),
            ];
        }
        else {
            foreach ( $this->data['pages'] as $page ) {
                $this->form['page_names'][] = $page;
            }
        }
    }

    /**
     * Zet de velden van het formulier
     */
    protected function set_fields() {
        //Bepaal index van laatste pagina
        $last_page = count( $this->data['fields'] ) - 1;

        $form_structure = [];
        $row_index = 0;
        foreach ( $this->data['fields'] as $page_index => $rows ) {

            // Introtekst toevoegen als veld op eerste pagina
            if ( 0 === $page_index && ! empty( $this->data['intro'] ) ) {
                array_unshift(
                    $rows,
                    [
                        [
                            'slug'   => 'intro',
                            'type'   => 'html',
                            'width'  => 12,
                            'config' => [
                                'default' => Formatting::array_to_text( $this->data['intro'] ) . HR,
                            ],
                        ],
                    ]
                );
            }

            //Knoppen toevoegen
            $button_row = $this->generate_button_row( $page_index, $last_page );
            if ( ! empty( $button_row ) ) {
                array_push( $rows, $button_row );
            }

            $page_structure = [];
            foreach ( $rows as $row ) {
                $row_structure = [];
                $row_index ++;
                $cell_index = 0;
                foreach ( $row as $field ) {
                    $field = $this->parse_field( $field );
                    $this->form['fields'][ $field['slug'] ] = $field;
                    
                    if ( ! isset( $field['same_cell'] ) ) {
                        $cell_index++;
                        $row_structure[] = $field['width'] ?? self::DEFAULT_CELL_WIDTH;
                    }
                    $layout_fields[ $field['slug'] ] = "{$row_index}:{$cell_index}";
                }
                $page_structure[] = implode( ':', $row_structure );

            }
            $form_structure[] = implode( '|', $page_structure );
        }

        $this->form['layout_grid'] = [
            'fields'    => $layout_fields,
            'structure' => implode( '#', $form_structure ) . '|12',
        ];
    }

    /**
     * Undocumented function
     *
     * @param array|string $field
     * @param array
     */
    protected function parse_field( $field ) {

        // Gegevens van standaardvelden gebruiken indien van toepassing
        if ( isset( $field['slug'] ) && isset(  $this->default_fields[ $field['slug'] ] ) ) {
            $field = wp_parse_args_recursive( $field, $this->default_fields[ $field['slug'] ] );
        }

        if ( is_string( $field ) && isset(  $this->default_fields[ $field ] ) ) {
            $field = $this->default_fields[ $field ];
        }

        //Formatteer opties
        if ( isset( $field['config']['option'] ) ) {
            $field['config']['option'] = $this->format_options( $field['config']['option'] );
        }

        //Voeg condities toe
        if ( isset( $field['condition'] ) ) {
            $this->add_conditional_group( $field['slug'], $field['condition']['type'], $field['condition']['groups'] );
            $field['conditions'] = [ 'type' => "con_{$field['slug']}" ];
            unset( $field['condition'] );
        }

        $field = wp_parse_args_recursive(
            $field,
            [
                'ID'         => $field['slug'],
                'label'      => '',
                'required'   => true,
                'caption'    => '',
                'config'     => [
                    'custom_class' => '',
                    'default'      => '',
                ],
                'conditions' => [ 'type' => ''],
            ]
        );
        return $field;
    }

    /**
     * Genereert knoppenrij
     *
     * @param int $current_page
     * @param int $last_page
     * @return array
     */
    protected function generate_button_row( int $current_page, int $last_page ) {
        $button_row = [];
        
        // 'Vorige'-knop toevoegen
        if ( 0 != $current_page ) {
            $button_row[] = [
                'slug'    => "from_page_{$current_page}_to_previous",
                'type'    => 'button',
                'label'   => __( 'Vorige', 'siw' ),
                'config'  => [
                    'type'         => 'prev',
                    'class'        => 'kad-btn',
                ],
            ];
        }

        // 'Volgende'-knop toevoegen
        if ( $last_page != $current_page ) {
            $button_row[] = [
                'slug'    => "from_page_{$current_page}_to_next",
                'type'    => 'button',
                'label'   => __( 'Volgende', 'siw' ),
                'config'  => [
                    'type'         => 'next',
                    'class'        => 'kad-btn kad-btn-primary',
                ],
            ];
        }

        // 'Verzenden'-knop toevoegen
        if ( $last_page == $current_page  ) {
            $button_row[] = [
                'slug'    => 'verzenden',
                'type'    => 'button',
                'label'   => __( 'Verzenden', 'siw' ),
                'config'  => [
                    'type'         => 'submit',
                    'class'        => 'kad-btn kad-btn-primary',
                ],
            ];
        }

        return $button_row;
    }

    /**
     * Voegt condities toe
     *
     * @param string $slug
     * @param string $type
     * @param array $groups
     */
    protected function add_conditional_group( string $slug, string $type, array $groups ) {
        $condition_groups = [];

        foreach ( $groups as $group_index => $group ) {
            $condition_lines = [];

            foreach ( $group as $line_index => $line ) {
                $line['parent'] = "con_{$slug}_group_{$group_index}";
                $condition_lines["con_{$slug}_group_{$group_index}_line_{$line_index}"] = $line;
            }
            $condition_groups["con_{$slug}_group_{$group_index}"] = $condition_lines;;
        }

        $this->form['conditional_groups']['conditions'][ "con_{$slug}" ] = [
            'id'    => "con_{$slug}",
            'name'  => $slug,
            'type'  => $type,
            'group' => $condition_groups,
        ];
    }

    /**
     * Formatteert array met opties
     *
     * @param array $options
     * @return string
     */
    protected function format_options( array $options ) {

        $has_values = ( array_values( $options ) !== $options );

        foreach ( $options as $value => $label ) {
            $slug = $has_values ? sanitize_title( $value ) : sanitize_title( $label );
            $formatted_options[ $slug ] = [
                'value' => $slug,
                'label' => $label,
            ];
        }
        return $formatted_options;
    }

    /**
     * Haalt e-mailtemplate op
     *
     * @param array $args
     * @return string
     */
    protected function get_email_template( array $args ) {
        $template = new Template( $args );
        return $template->generate();
    }
}

Namespaces

Classes

Functions