src/foundation/api/revel/field.go

   1 // Copyright (c) 2012-2016 The Revel Framework Authors, All rights reserved.
   2 // Revel Framework source code and usage is governed by a MIT style
   3 // license that can be found in the LICENSE file.
   4
   5 package revel
   6
   7 import (
   8         "reflect"
   9         "strings"
  10 )
  11
  12 // Field represents a data field that may be collected in a web form.
  13 type Field struct {
  14         Name       string
  15         Error      *ValidationError
  16         viewArgs   map[string]interface{}
  17         controller *Controller
  18 }
  19
  20 func NewField(name string, viewArgs map[string]interface{}) *Field {
  21         err, _ := viewArgs["errors"].(map[string]*ValidationError)[name]
  22         controller, _ := viewArgs["_controller"].(*Controller)
  23         return &Field{
  24                 Name:       name,
  25                 Error:      err,
  26                 viewArgs:   viewArgs,
  27                 controller: controller,
  28         }
  29 }
  30
  31 // ID returns an identifier suitable for use as an HTML id.
  32 func (f *Field) ID() string {
  33         return strings.Replace(f.Name, ".", "_", -1)
  34 }
  35
  36 // Flash returns the flashed value of this Field.
  37 func (f *Field) Flash() string {
  38         v, _ := f.viewArgs["flash"].(map[string]string)[f.Name]
  39         return v
  40 }
  41
  42 // Options returns the option list of this Field.
  43 func (f *Field) Options() []string {
  44         if f.viewArgs["options"] == nil {
  45                 return nil
  46         }
  47         v, _ := f.viewArgs["options"].(map[string][]string)[f.Name]
  48         return v
  49 }
  50
  51 // FlashArray returns the flashed value of this Field as a list split on comma.
  52 func (f *Field) FlashArray() []string {
  53         v := f.Flash()
  54         if v == "" {
  55                 return []string{}
  56         }
  57         return strings.Split(v, ",")
  58 }
  59
  60 // Value returns the current value of this Field.
  61 func (f *Field) Value() interface{} {
  62         pieces := strings.Split(f.Name, ".")
  63         answer, ok := f.viewArgs[pieces[0]]
  64         if !ok {
  65                 return ""
  66         }
  67
  68         val := reflect.ValueOf(answer)
  69         for i := 1; i < len(pieces); i++ {
  70                 if val.Kind() == reflect.Ptr {
  71                         val = val.Elem()
  72                 }
  73                 val = val.FieldByName(pieces[i])
  74                 if !val.IsValid() {
  75                         return ""
  76                 }
  77         }
  78
  79         return val.Interface()
  80 }
  81
  82 // ErrorClass returns ErrorCSSClass if this field has a validation error, else empty string.
  83 func (f *Field) ErrorClass() string {
  84         if f.Error != nil {
  85                 if errorClass, ok := f.viewArgs["ERROR_CLASS"]; ok {
  86                         return errorClass.(string)
  87                 }
  88                 return ErrorCSSClass
  89         }
  90         return ""
  91 }
  92
  93 // Get the short name and translate it
  94 func (f *Field) ShortName() string {
  95         name := f.Name
  96         if i := strings.LastIndex(name, "."); i > 0 {
  97                 name = name[i+1:]
  98         }
  99         return f.Translate(name)
 100 }
 101
 102 // Translate the text
 103 func (f *Field) Translate(text string, args ...interface{}) string {
 104         if f.controller != nil {
 105                 text = f.controller.Message(text, args...)
 106         }
 107         return text
 108 }