Skip to content

Latest commit

 

History

History
294 lines (201 loc) · 8.07 KB

README.md

File metadata and controls

294 lines (201 loc) · 8.07 KB
Raw

WFV Validation

Build Status Scrutinizer Code Quality

Official Documentation: https://macder.github.io/wfv/

WFV is an elegant way to work with custom forms in WordPress.

A simple fluid and concise API to manage user input, validation, feedback, and safe output.

WFV is intended for developers who prefer creating and managing forms at the code level. This is not a WYSIWYG type plugin and is not targeted for users who are not comfortable writing code.

Table of Contents

Features

Basic Example

functions.php or anywhere that makes sense

<?php
$contact_form = array(
  'first_name' => [
    'label' => 'First name',
    'rules' => 'required',
  ],
  'email' => [
    'label' => 'Email',
    'rules' => 'required|email',
  ],
  'message' => [
    'label' => 'Message',
    'rules' => 'required',
  ],
);

// Validation passed.
add_action( 'contact_form', function ( $form ) {
  echo 'Thank you '. $form->input()->escape('first_name');
});

// Turn $contact_form into an instance of FormComposite
wfv_create( 'contact_form', $contact_form );

Theme template

<form method="post">

  <input name="first_name" type="text" value="<?php $contact_form->display('first_name'); ?>">
  <small><?php echo $contact_form->errors()->first('first_name'); ?></small>

  <input name="email" type="text" value="<?php $contact_form->display('email'); ?>">
  <small><?php echo $contact_form->errors()->first('email'); ?></small>

  <textarea name="message"><?php $contact_form->display('message'); ?></textarea>
  <small><?php echo $contact_form->errors()->first('message'); ?></small>

  <?php $contact_form->get_token_fields(); ?>
  <input type="submit" value="Send">

</form>

Install

Note: WFV is currently an alpha pre-release. An official packaged release is not yet available.

In the meantime, you may install the latest alpha by either downloading the zip, or with git. Note that Composer is required for both methods

Zip

Download the latest pre-release zip

Extract into ./wp-content/plugins

In the WFV plugin folder run composer install

Activate in the Plugins section of the Admin Dashboard

Git

$ cd ./wp-content/plugins

$ git clone https://github.com/macder/wfv-validation.git

$ cd wfv-validation

$ composer install

Activate in the Plugins section of the Admin Dashboard

Contributing

Contributions are always welcome and encouraged. Before contributing a new feature or fix, please check the issues section (open and closed) to make sure no one is already working on what you intend.

  • If there is no open or closed issue, open a new issue so that others know you are working on something.
  • If an issue is already open, you may be able to help. Make a comment in the issue that you intend to help out. If no one is working on the issue, it will be assigned to you, otherwise ask if they require help. Please use a common sense approach
  • If you require help or you stop working on an issue before it is complete, make a comment about it. Please do not hijack an issue by abandoning it without telling anyone.

Workflow

WFV follows the Gitflow Workflow. If you are not familiar with it, please read this and this

Testing

NOTE: This section may be slightly outdated and will be updated ASAP

Prerequisites

A working wp-cli install.

Install PHPunit dependency by running bin/lib/install_phpunit.sh.

This will composer require the correct package for your local PHP version. The install is isolated to the project.

Setup

Interactive Setup

The easiest way to get setup and test is using the interactive bash script bin/start_tests

It's menu driven, with the hope of making more of the process self explanatory.

1) Set Local Parameters

Rename bin/tests_sample.conf to bin/tests.conf, then open with an editor.

Set your local parameters, you know the drill.

2) Start

#!/bin/bash

# From plugin root:
$: cd bin
$: ./start_tests

--------------------------------
 W F V   U N I T  T E S T I N G
--------------------------------
 MAIN MENU
--------------------------------

  1. SSH Tunnel For Remote DB
  2. Start WordPress Testing Instance
  3. Run Tests

  4. Exit

Enter choice [ 1 - 4 ]

1. SSH Tunnel:
Starts SSH tunnel to a remote DB host. If your DB is local, you don't need this.

2. Start wp-tests Instance
Creates and starts the wp-tests instance.

3.Run Tests

--------------------------------
 W F V   U N I T  T E S T I N G
--------------------------------
 UNIT TESTS
--------------------------------

  0. Back

  1. ALL
  2. Collectable
  3. Inspection Agent
  4. Director
  5. Form Artisan
  6. Error Collection
  7. Input Collection
  8. Message Collection
  9. Rule Collection
  10. Form Composite

  11. Exit

Enter choice [ 1 - 11 ]

Skip Main Menu

#!/bin/bash

# Open testing menu
$: ./start_tests test

Manual Setup

The nuts and bolts of what ./start_tests is doing

Create the testing instance

If database is local:

#!/bin/bash

# From plugin root
$: bash bin/lib/install_wp_tests.sh wordpress_test db_user db_pass localhost latest

If database is remote (Docker, Vagrant, VM) open a SSH tunnel:

#!/bin/bash

# e.g. from local:

$: ssh -N -L 5555:127.0.0.1:3306 [email protected] -vv
#!/bin/bash

# Then, in a new local terminal:

$: cd ~/wfv-validation/
$: bash bin/lib/install_wp_tests.sh wordpress_test db_user db_pass 127.0.0.1:5555 latest true

Developing Locally on WordPress with Remote Database Over SSH

Run Tests

#!/bin/bash

# Individual

$: vendor/bin/phpunit tests/Collection/InputCollectionTest --report-useless-tests --verbose
#!/bin/bash

# Full suite

$: vendor/bin/phpunit --report-useless-tests --verbose

Support:

PHP: 5.4+
WordPress: 4.x.x including multisite

Unsupported Minimum:
PHP: 5.4+
WordPress: 3.7 including multisite

PHP 7.0+ with latest WordPress is recommended.

External Resources