# README

validation

validation is a form validation for a data validation and error collecting using Go.

Installation and tests

Install:

go get github.com/coscms/xweb/validation

Test:

go test github.com/coscms/xweb/validation

Example

Direct Use:

import (
	"github.com/coscms/xweb/validation"
	"log"
)

type User struct {
	Name string
	Age int
}

func main() {
	u := User{"man", 40}
	valid := validation.Validation{}
	valid.Required(u.Name, "name")
	valid.MaxSize(u.Name, 15, "nameMax")
	valid.Range(u.Age, 0, 140, "age")
	if valid.HasErrors() {
		// validation does not pass
		// print invalid message
		for _, err := range valid.Errors {
			log.Println(err.Key, err.Message)
		}
	}
	// or use like this
	if v := valid.Max(u.Age, 140); !v.Ok {
		log.Println(v.Error.Key, v.Error.Message)
	}
}

Struct Tag Use:

import (
	"github.com/coscms/xweb/validation"
)

// validation function follow with "valid" tag
// functions divide with ";"
// parameters in parentheses "()" and divide with ","
// Match function's pattern string must in "//"
type User struct {
	Id   int
	Name string `valid:"Required;Match(/^(test)?\\w*@;com$/)"`
	Age  int    `valid:"Required;Range(1, 140)"`
}
type Profile struct {
	Id   int
	Email string `valid:"Required;Match(/^\\w+@coscms\\.com$/)"`
	Addr  string `valid:"Required"`
}
type NotValid struct {
	A string
	B string
}
type Group struct {
	Id   int
	User
	*Profile
	NotValid `valid:"-"` //valid标签设为“-”，意味着跳过此项不查询其成员
}

func main() {
	valid := Validation{}
	u := User{Name: "test", Age: 40}
	b, err := valid.Valid(u) //检查所有字段
	//b, err := valid.Valid(u, "Name", "Age") //检查指定字段：Name和Age
	if err != nil {
		// handle error
	}
	if !b {
		// validation does not pass
		// blabla...
	}

	valid.Clear()

	u := Group{
		User:           User{Name: "test", Age: 40},
		Profile:        &Profile{Email:"[email protected]",Addr:"address"},
		NotValid:       NotValid{},
	}
	b, err := valid.Valid(u) //检查所有字段
	//b, err := valid.Valid(u, "User.Name", "Profile.Email") //检查指定字段
	if err != nil {
		// handle error
	}
	if !b {
		// validation does not pass
		// blabla...
	}
}

Struct Tag Functions:

-
Required
Min(min int)
Max(max int)
Range(min, max int)
MinSize(min int)
MaxSize(max int)
Length(length int)
Alpha
Numeric
AlphaNumeric
Match(pattern string)
AlphaDash
Email
IP
Base64
Mobile
Tel
Phone
ZipCode