pubdomain

Documentation

Index

• Constants
• type Entity
  • func NewEntity(id string, name string, singularName string, pluralName string, ...) (*Entity, error)
  • func (e *Entity) Collection() string
  • func (e *Entity) Fields() []field.Field
  • func (e *Entity) GetFieldByName(name string) field.Field
  • func (e *Entity) Id() string
  • func (e *Entity) IsZero() bool
  • func (e *Entity) Name() string
  • func (e *Entity) PluralName() string
  • func (e *Entity) SingularName() string
  • func (e *Entity) String() string
• type FieldError
  • func NewFieldError(field string, message string) (*FieldError, error)
  • func (fe *FieldError) Field() string
  • func (fe *FieldError) IsZero() bool
  • func (fe *FieldError) Message() string
• type Pager
  • func NewPager(page uint32, size uint32) (*Pager, error)
  • func (p *Pager) IsZero() bool
  • func (p *Pager) Page() uint32
  • func (p *Pager) Size() uint32
  • func (p *Pager) String() string
• type Record
  • func NewRecord() *Record
  • func (rrd *Record) Data() recordData
  • func (rrd *Record) GetValueByKey(key string) interface{}
  • func (rrd *Record) IsZero() bool
  • func (rrd *Record) SetData(data recordData)
• type RecordValidationErrors
  • func NewRecordValidationErrors() *RecordValidationErrors
  • func (rve *RecordValidationErrors) AddError(fieldError *FieldError)
  • func (rve *RecordValidationErrors) Error() string
  • func (rve *RecordValidationErrors) Errors() []*FieldError
  • func (rve *RecordValidationErrors) IsZero() bool

Constants

const (
	// CreatedAt defines the name of the field/column/attribute of the record
	// that defines when the record was created or stored for the first time
	// in the data store
	CreatedAt = "created_at"
	// UpdatedAt defines the name of the field/column/attribute of the record
	// that defines when the record was updated for the last time
	// in the data store
	UpdatedAt = "updated_at"
)

Types

type Entity

type Entity struct {
	// contains filtered or unexported fields
}

Entity is a specific definition of an object/entity/thing inside a domain

func NewEntity

func NewEntity(
	id string,
	name string,
	singularName string,
	pluralName string,
	fields []field.Field,
	collection string,
) (*Entity, error)

NewEntity creates an instance of Entity

func (*Entity) Collection

func (e *Entity) Collection() string

Collection returns entity collection name

func (*Entity) Fields

func (e *Entity) Fields() []field.Field

Fields returns entity fields

func (*Entity) GetFieldByName

func (e *Entity) GetFieldByName(name string) field.Field

GetFieldByName returns a single field according to its name

func (*Entity) Id

func (e *Entity) Id() string

Id returns entity id

func (*Entity) IsZero

func (e *Entity) IsZero() bool

IsZero defines whether Entity is empty

func (*Entity) Name

func (e *Entity) Name() string

Name returns entity name

func (*Entity) PluralName

func (e *Entity) PluralName() string

PluralName returns entity plural name

func (*Entity) SingularName

func (e *Entity) SingularName() string

SingularName returns entity singular name

func (*Entity) String

func (e *Entity) String() string

String defines the string interface

type FieldError

type FieldError struct {
	// contains filtered or unexported fields
}

FieldError holds the error message for a specific field

func NewFieldError

func NewFieldError(field string, message string) (*FieldError, error)

NewFieldError creates a new instance of FieldError

func (*FieldError) Field

func (fe *FieldError) Field() string

Field returns the name of the field

func (*FieldError) IsZero

func (fe *FieldError) IsZero() bool

IsZero defines whether FieldError is empty

func (*FieldError) Message

func (fe *FieldError) Message() string

Message returns the error message related to the field

type Pager

type Pager struct {
	// contains filtered or unexported fields
}

Pager defines all the parameters needed to list records properly

func NewPager

func NewPager(
	page uint32,
	size uint32,
) (*Pager, error)

NewPager creates an instance of Pager

func (*Pager) IsZero

func (p *Pager) IsZero() bool

IsZero defines whether Pager is empty

func (*Pager) Page

func (p *Pager) Page() uint32

Page returns the number of the page

func (*Pager) Size

func (p *Pager) Size() uint32

Size returns the amount of records of the page

func (*Pager) String

func (p *Pager) String() string

String defines the string interface

type Record

type Record struct {
	// contains filtered or unexported fields
}

Record defines the data that holds the mapping between the name of the field and its value

func NewRecord

func NewRecord() *Record

NewRecord creates a new instance of Record

func (*Record) Data

func (rrd *Record) Data() recordData

Data returns all data of the record

func (*Record) GetValueByKey

func (rrd *Record) GetValueByKey(key string) interface{}

GetValueByKey returns the value of a specific key from the data

func (*Record) IsZero

func (rrd *Record) IsZero() bool

IsZero defines whether Record is empty

func (*Record) SetData

func (rrd *Record) SetData(data recordData)

SetData sets completely the data attribute Be careful using this method since it can modify original data

type RecordValidationErrors

type RecordValidationErrors struct {
	// contains filtered or unexported fields
}

RecordValidationErrors holds all the errors that were generated for validation of every field related to an entity

func NewRecordValidationErrors

func NewRecordValidationErrors() *RecordValidationErrors

NewRecordValidationErrors creates a new instance of RecordValidationErrors

func (*RecordValidationErrors) AddError

func (rve *RecordValidationErrors) AddError(fieldError *FieldError)

AddError adds a single error to the error list. A single error means that it adds the error message related to a field

func (*RecordValidationErrors) Error

func (rve *RecordValidationErrors) Error() string

Error returns a strigified version of all the errors. This method follows the default golang error interface

func (*RecordValidationErrors) Errors

func (rve *RecordValidationErrors) Errors() []*FieldError

Errors returns the list of errors

func (*RecordValidationErrors) IsZero

func (rve *RecordValidationErrors) IsZero() bool

IsZero defines whether RecordValidationErrors is empty