Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.8 KB

README.md

File metadata and controls

40 lines (31 loc) · 1.8 KB

phly/phly-rule-validation

This library provides a barebones validation framework for use with web forms and API payloads.

Users will define rule sets, which produce result sets. A rule set is composed of one or more rules, each tied to a specific key in the data set under validation. Each rule will produce a result on validation, and these results are aggregated into the result set.

Goals of this library

The explicit goals of this library are:

  • Provide an idempotent way to validate individual items and/or data sets.
  • Provide an extensible framework for developing validation rules, results, and rule and result sets.
  • Allow handling optional data, with default values.
  • Allow reporting validation error messages.
  • Ensure missing required values are reported as validation failures.
  • Use as few dependencies as possible.

Non-goals:

  • Creating an extensive set of validation rule classes.
  • Providing extensive mechanisms for validating and returning nested data sets. (Note: basic support for nested data sets is provided, but it is up to consumers to wire them.)
  • Providing a configuration-driven mechanism for creating rule sets.
  • Providing HTML form input representations or all metadata required to create HTML form input representations.

Table of Contents