user

Documentation

Index

• Variables
• func Image(response *goyave.Response, request *goyave.Request)
• func Register(response *goyave.Response, request *goyave.Request)
• func Show(response *goyave.Response, request *goyave.Request)
• func Update(response *goyave.Response, request *goyave.Request)

Variables

var (
	// InsertRequest validates Post requests for users
	InsertRequest validation.RuleSet = validation.RuleSet{
		"email":    {"required", "string", "email", "between:3,100", "unique:users"},
		"username": {"required", "string", "between:3,100", "unique:users"},
		"image":    {"nullable", "file", "image", "max:2048", "count:1"},
		"password": {"required", "string", "between:6,100", "password"},
	}

	// UpdateRequest validates Patch requests for users
	UpdateRequest validation.RuleSet = validation.RuleSet{
		"email":    {"string", "email", "between:3,100", "unique:users"},
		"username": {"string", "between:3,100", "unique:users"},
		"image":    {"nullable", "file", "image", "max:2048", "count:1"},
		"password": {"string", "between:6,100", "password"},
	}

	// LoginRequest validates user login requests
	LoginRequest validation.RuleSet = validation.RuleSet{
		"email":    {"required", "string", "email"},
		"password": {"required", "string"},
	}
)

var (
	// StoragePath the path used to store user profile pictures
	StoragePath string = ""
)

Functions

func Image

func Image(response *goyave.Response, request *goyave.Request)

Image returns the profile picture of the authenticated user. A default profile picture is sent if the user doesn't have a profile picture.

func Register

func Register(response *goyave.Response, request *goyave.Request)

Register insert a new user in the database

func Show

func Show(response *goyave.Response, request *goyave.Request)

Show returns the authenticated user

func Update

func Update(response *goyave.Response, request *goyave.Request)

Update replaces the record of the authenticated user If the profile picture is modified, the previous one is deleted.