eftec/validationone

It's a php library for fetch and validate fields

1.17 2019-10-01 14:26 UTC

README

It's a PHP library for fetch and validate fields and store messages in different containers(including error, warning, info, and success) depending on the conditions.

Build Status Packagist Total Downloads Maintenance composer php php CocoaPods

Examples

Examples

Tutorial Form and Table with PHP

diagram example
It is an example of functionality. A normal example is more complex, even if it's only a few lines of code.

ValidationOne

Let's say we want to validate a value an input value (get) called "id", we could do the next things:

  • the default value is the text "ERROR"
  • the type of the value is an integer, so it must returns an integer. It also could be an integer,decimal,string,date,datestring and boolean
  • we add a condition, the value must be equals (eq) to 10. If fails then it returns a message (as error)
  • we add another condition, if the value must be equals (eq) to 30. If fails then it returns an info (not an error)
  • If the operation fails then it returns the default value.
  • And finally, we obtain the "id" from $_GET (parameter url).
$val=new ValidationOne();

$r = $val->def('ERROR')
    ->type('integer')
    ->condition("eq", "It's not equals to 10", 10)
    ->condition("eq", "It's not equals to 30 (info)", 30, 'info')
    ->ifFailThenDefault()
    ->get('id'); // <-- end of the chain

But, where is the error?. It's in messagelist

var_dump($val->messagelist->allArray()) // here we show all messages of any kind of type. 

However, we could also show a message by type (error, warning..) and only message by specific identifier.

var_dump($val->messageList->get('id')->allErrorOrWarning())) // All error or warning contained in the key "id".

Why the messages are store in some structure?. Is it not easy to simply return the error? .

The answer is a form. Le't say we have a form with 3 fields. If one of them fails, then the error must be visible for each field separately. Also the whole form could have it's own message.

condition ($type, $message="", $value=null, $level='error')

  • @param string $type

      number:req,eq,ne,gt,lt,gte,lte,between
      string:req,eq,ne,minlen,maxlen,betweenlen,notnull
      date:req,eq,ne,gt,lt,gte,lte,between
      boolean:req,eq,ne,true,false
      function:
          fn.static.Class.methodstatic
          fn.global.function
          fn.object.Class.method where object is a global $object
          fn.class.Class.method
          fn.class.\namespace\Class.method
    
  • @param string $message

     Message could uses the next variables '%field','%realfield','%value','%comp','%first','%second'  
    
  • @param null $value

  • @param string $level (error,warning,info,success)

  • @return ValidationOne

MessageList

MessageList is a list of containers of messages. It's aimed for convenience, so it features many methods to access of the information in different ways.

Messages are cataloged as follow

id Description Example
error The message is an error and it must be solved. It is a show stopper. Database is down
warning The message is a warning that maybe it could be ignored. The registry was stored but with warnings
info The message is an information Log is stored
success The message is a succesful operation Order Accepted

Sometimes, both errors are warning are considered as equals. So the system allows to read an error or warning.

Error has always the priority, then warning, info and success. If you want to read the first message, then it starts searching for errors.

You can obtain a message as an array of objects of the type MessageItem, as an array of string, or as an a single string (first message)

Pipeline

  • Input value, it could come from set()/post()/get()/request()/getFile()
  • What if the value doesn't exist?

version list

  • 2019-10.01 1.18 Added compatibility for phpunit/phpunit 5.7 and 6.5

  • 2019-10-01 1.17 Fixed a bug. If the input is zero, then it is considered as null.

  • 2019-08-10 1.16 Solved a problem with the datestring/datetimestring.

  • 2019-08-07 1.15

    • Added the type datestring and datetimestring. It reads a string and it converts into another string (as date or datetime)
    • Code formatted
  • 2019-03-08 1.14 Added getFile() to upload a file.

  • 2018-12-15 1.13 Added phpunit and travis.

  • 2018-10-29 1.12 getFile now it's available via ValidationOne()

  • 2018-10-22 1.11 Some fixes. Now isEmpty is called isMissing

  • 2018-10-22 1.10 New Features

    • Added ValidationInputOne, now the fetchs are done by this class (SRP principle)
    • Added a fix with the input, when the value expected is an array but it's returned a single value
  • 2018-10-15 1.9 Added some extra features

  • 2018-10-15 1.8 Some fixes and phpdocs, a new example

  • 2018-10-15 1.7 Added method addMessage() in ValidationOne. Now ErrorItem/ErrorList is called MessageItem and MessageList

  • 2018-10-06 1.5 added method first() in MessageItem

  • 2018-10-03 1.4 added defaultNatural()

  • 2018-10-02 1.3 basicvalidation() was deleted. It was restored.

  • 2018-10-02 1.2 array() is now isArray()

  • 2018-09-30 1.1 Some fixes

  • 2018-09-29 1.0 first version

todo

  • More examples
  • Documentation

Note

It's distributed as dual license, as lgpl-v3 and commercial.

You can use freely in your close source project. However, if you change this library, then the changes must be disclosed.