domain

Documentation

Index

• 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) Id() string
  • func (e *Entity) IsZero() bool
  • func (e *Entity) Name() string
  • func (e *Entity) PluralName() string
  • func (e *Entity) SanitizeRecord(record *pubdomain.Record) (*pubdomain.Record, error)
  • func (e *Entity) SanitizeRecordPartially(record *pubdomain.Record) (*pubdomain.Record, error)
  • func (e *Entity) SingularName() string
  • func (e *Entity) String() string

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) 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) SanitizeRecord

func (e *Entity) SanitizeRecord(
	record *pubdomain.Record,
) (*pubdomain.Record, error)

SanitizeRecord checks that every attribute from the passed record meet all rules for all fields described by the entity and return a new sanitized record with the valid data.

By sanitizing, attributes and values that are not related to the fields described by the entity will be ignored and won't be included in the returned sanitized record

func (*Entity) SanitizeRecordPartially

func (e *Entity) SanitizeRecordPartially(
	record *pubdomain.Record,
) (*pubdomain.Record, error)

SanitizeRecordPartially only checks the attributes that the record contains. This means that fields described by the entity that are NOT included in the record data will be ignored.

It returns a new sanitized record with the valid data.

By sanitizing, attributes and values that are not related to the fields described by the entity will be ignored and won't be included in the returned sanitized record

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