captcha

Documentation

Index

• Constants
• Variables
• func GenAndRecordCaptchaID(ctx echo.Context, opt *hdlCaptcha.Options) string
• func GenCaptchaError(ctx echo.Context, err error, captchaName string, data interface{}) echo.Data
• func Get(name string) func() ICaptcha
• func GetAllNames() []string
• func GetCaptchaID(ctx echo.Context, opt *hdlCaptcha.Options, id string) (string, error)
• func GetHistoryOrNewCaptchaID(ctx echo.Context, opt *hdlCaptcha.Options) string
• func GetOk(name string) (func() ICaptcha, bool)
• func Has(name string) bool
• func Register(name string, ic func() ICaptcha)
• type ICaptcha

Constants

const (
	TypeDefault = `default`
	TypeAPI     = `api`
)

Variables

var (
	//ErrCaptcha 验证码错误
	ErrCaptcha = echo.NewError(`Captcha is incorrect`, code.CaptchaError)
	//ErrCaptchaIdMissing 缺少captchaId
	ErrCaptchaIdMissing = echo.NewError(`Missing captchaId`, code.CaptchaIdMissing).SetZone(`captchaId`)
	//ErrCaptchaCodeRequired 验证码不能为空
	ErrCaptchaCodeRequired = echo.NewError(`Captcha code is required`, code.CaptchaCodeRequired).SetZone(`code`)
)

Functions

func GenAndRecordCaptchaID

func GenAndRecordCaptchaID(ctx echo.Context, opt *hdlCaptcha.Options) string

func GenCaptchaError

func GenCaptchaError(ctx echo.Context, err error, captchaName string, data interface{}) echo.Data

func Get

func Get(name string) func() ICaptcha

func GetAllNames

func GetAllNames() []string

func GetCaptchaID

func GetCaptchaID(ctx echo.Context, opt *hdlCaptcha.Options, id string) (string, error)

func GetHistoryOrNewCaptchaID

func GetHistoryOrNewCaptchaID(ctx echo.Context, opt *hdlCaptcha.Options) string

func GetOk

func GetOk(name string) (func() ICaptcha, bool)

func Has

func Has(name string) bool

func Register

func Register(name string, ic func() ICaptcha)

Types

type ICaptcha

type ICaptcha interface {
	Init(echo.H) error
	// keysValues: key1, value1, key2, value2
	Render(ctx echo.Context, templatePath string, keysValues ...interface{}) template.HTML
	Verify(ctx echo.Context, hostAlias string, name string, captchaIdent ...string) echo.Data
	MakeData(ctx echo.Context, hostAlias string, name string) echo.H
}