Documentation
¶
Index ¶
- Constants
- Variables
- func ID(idValidator IDValidator) validation.Rule
- func TValidate(t Translator, v validation.Validatable) error
- func TValidateByHexa(t hexa.Translator, v validation.Validatable) error
- func TValidateErr(t Translator, err error) error
- func TranslateByHexa(t hexa.Translator, err error) error
- type ConfirmRule
- type IDValidator
- type TranslateBag
- type Translator
Constants ¶
const Version = "v1.0.0"
Version is the package current version.
Variables ¶
var ( ErrInternalValidation = hexa.NewError( http.StatusInternalServerError, "lib.translation.internal_error", ).SetError(errors.New("internal error")) ErrValidationError = hexa.NewError( http.StatusBadRequest, "lib.translation.invalid_input_data_error", ).SetError(errors.New("invalid input data")) )
var ( IRCardNumber = validation.Match(regexp.MustCompile("^\\d{16}$")).ErrorObject(ErrIRCardNumberInvalid) IRAccountNumber = validation.Match(regexp.MustCompile("^(\\d{5,19})$")).ErrorObject(ErrIRAccountNumberInvalid) IRIBAN = validation.Match(regexp.MustCompile("^IR[0-9]{24}$")).ErrorObject(ErrIRIBANNumberInvalid) )
var ( IRPhoneRegex = regexp.MustCompile("^(\\+98|0)9\\d{9}$") IRPhone98Regex = regexp.MustCompile("^\\+989\\d{9}$") IRPhone0Regex = regexp.MustCompile("^09\\d{9}$") )
var ( IRPhone = validation.Match(IRPhoneRegex).ErrorObject(ErrIRPhoneInvalid) IRPhone98 = validation.Match(IRPhone98Regex).ErrorObject(ErrIRPhoneInvalid) IRPhone0 = validation.Match(IRPhone0Regex).ErrorObject(ErrIRPhoneInvalid) )
IRPhone is the iran phone number validation rule.
var ( IRTel = validation.Match(regexp.MustCompile("^(\\+98|0)\\d{10}$")).ErrorObject(ErrIRTelInvalid) IRTel98 = validation.Match(regexp.MustCompile("^\\+98\\d{10}$")).ErrorObject(ErrIRTelInvalid) IRTel0 = validation.Match(regexp.MustCompile("^0\\d{10}$")).ErrorObject(ErrIRTelInvalid) )
IRTel is the iran telephone number validation rule.
var ErrIRAccountNumberInvalid = validation.NewError("validation_ir_account_number_invalid", "Iran account number is invalid")
var ErrIRCardNumberInvalid = validation.NewError("validation_ir_card_number_invalid", "Iran card number is invalid")
ErrIRCreditCardInvalid is the default IRCreditCard validation rules error.
var ErrIRIBANNumberInvalid = validation.NewError("validation_ir_iban_invalid", "Iran IBAN is invalid")
var ErrIRNationalIDInvalid = validation.NewError("validation_ir_national_id_invalid", "Iran national ID is invalid")
ErrIRNationalIDInvalid is the default IRNationalID validation rules error.
var ErrIRPhoneInvalid = validation.NewError("validation_ir_phone_invalid", "Iran phone number is invalid")
ErrIRPhoneInvalid is the default IRPhone validation rules error.
var ErrIRPostalCodeInvalid = validation.NewError("validation_ir_postal_code_invalid", "Iran postal code number is invalid")
ErrIRPostalCodeInvalid is the default IRPostalCode validation rules error.
var ErrIRTelInvalid = validation.NewError("validation_ir_tel_invalid", "Iran telephone number is invalid")
ErrIRTelInvalid is the default IRTelephone validation rules error.
var ErrInvalidConfirmation = validation.NewError("validation_invalid_confirmation", "confirmation value is invalid")
ErrInvalidConfirmation is the error that returns in case of invalid confirmation value.
var ErrInvalidID = validation.NewError("validation_invalid_id", "ID value is invalid")
ErrInvalidID is the default invalid id validation error
var ErrMoneyInvalid = validation.NewError("validation_money_invalid", "Money value is invalid")
ErrMoneyInvalid is the default Money validation rules error.
var ErrSocialNetworkIdentifierInvalid = validation.NewError("validation_social_network_identifier_invalid", "Social network identifier is invalid")
ErrSocialNetworkIdentifierInvalid is the default SocialNetworkIdentifier validation rules error.
var IRNationalID = validation.By(func(value interface{}) error { value, isNil := validation.Indirect(value) if isNil || validation.IsEmpty(value) { return nil } if str, ok := value.(string); ok && isValidIranianNationalCode(str) { return nil } return ErrIRNationalIDInvalid })
IRNationalID is the Iran national ID validator.
var IRPostalCode = validation.Match(regexp.MustCompile("^\\d{10}$")).ErrorObject(ErrIRPostalCodeInvalid)
IRPostalCode is the postal code of Iran rule var IRPostalCode = validation.Match(regexp.MustCompile(`^\b(?!(\d)\1{3})[13-9]{4}[1346-9][013-9]{5}\b$`)).ErrorObject(ErrIRPostalCodeInvalid)
var Money = validation.Match(regexp.MustCompile("^(0|[1-9]\\d*)?(\\.\\d+)?$")).ErrorObject(ErrMoneyInvalid)
Money is the money validation rule. values should be positive decimals values.
var SocialNetworkIdentifier = validation.Match(regexp.MustCompile("^[A-Za-z]{2,}[_-]?[A-Za-z0-9]{2,}$")).ErrorObject(ErrSocialNetworkIdentifierInvalid)
SocialNetworkIdentifier is the social social network identifier rule It's for telegram accounts.
Functions ¶
func ID ¶
func ID(idValidator IDValidator) validation.Rule
ID function return new validator to validate id.
func TValidate ¶
func TValidate(t Translator, v validation.Validatable) error
TValidate get a translator and validatable interface, validate and return hexa error.
func TValidateByHexa ¶
func TValidateByHexa(t hexa.Translator, v validation.Validatable) error
TValidateByHexa validate by provided translator and check to detect right driver.
func TValidateErr ¶
func TValidateErr(t Translator, err error) error
TValidate get a translator and validatable interface, validate and return hexa error.
func TranslateByHexa ¶
func TranslateByHexa(t hexa.Translator, err error) error
TranslateByHexa validate by provided translator and check to detect right driver.
Types ¶
type ConfirmRule ¶
type ConfirmRule struct {
// contains filtered or unexported fields
}
ConfirmRule is a validation rule that validates if a value can confirm another value.
func Confirm ¶
func Confirm(value interface{}) ConfirmRule
func (ConfirmRule) Error ¶
func (r ConfirmRule) Error(message string) ConfirmRule
Error sets the error message for the rule.
func (ConfirmRule) ErrorObject ¶
func (r ConfirmRule) ErrorObject(err validation.Error) ConfirmRule
ErrorObject sets the error struct for the rule.
func (ConfirmRule) Validate ¶
func (r ConfirmRule) Validate(value interface{}) error
Validate checks if the given value is valid or not.
type IDValidator ¶
type IDValidator func(val interface{}) error
type TranslateBag ¶
type TranslateBag struct {
// contains filtered or unexported fields
}
TranslateBag is the bag contains translated validation errors or error.
func (*TranslateBag) AddMsgToGroup ¶
func (t *TranslateBag) AddMsgToGroup(key string, msg *TranslateBag)
AddMsgToGroup add message to the group
func (*TranslateBag) IsEmpty ¶
func (t *TranslateBag) IsEmpty() bool
IsEmpty specify that error bag is empty or not.
func (*TranslateBag) Map ¶
func (t *TranslateBag) Map(forceMap bool) interface{}
TOMap fucntion convert TranslateBag to a map[string]interface{}. but if bag just has a single message it check if forceMap is true, return map["error"]=<message>, otherwise returns just string message.
possible values:
- map[string]interface : when TranslateBag contains group of messages or contains single message with forceMap=true.
- string: when TranslateBag contains singleMessage with forceMap=false.
- nil : When TranslateBag does not hav single message nor group of messages.
func (*TranslateBag) SetSingleMsg ¶
func (t *TranslateBag) SetSingleMsg(msg string)
SetSingleMsg set single error message.
type Translator ¶
type Translator interface {
// Translate translate validation error.
Translate(err error) (*TranslateBag, error)
// Wrap translated messages in a hexa Error, if err is nil, return nil.
WrapTranslationByError(err error) hexa.Error
}
Translator is the ozzo-validation error translator.
func NewHexaDriverErrorTranslator ¶
func NewHexaDriverErrorTranslator(t hexa.Translator) Translator
NewHexaDriverErrorTranslator returns new instance of hexaTranslator that translate ozzo-validation errors.