model

package module
v0.0.67 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 9, 2023 License: MIT Imports: 2 Imported by: 42

README

Estructuras que utilizo con frecuencia en proyectos escritos en Go

ejemplo de uso en un objeto

func MedicalHistory() model.Object {
	return model.Object{
		Name:           "medicalhistory",
		PrincipalFieldsName: []string{"service_name"},
		Fields: []model.Field{
			{Name: "id_medicalhistory", Legend: "id", Input: unixid.InputPK()},
			{Name: "id_patient", Legend: "paciente", Input: unixid.InputPK()},

			{Name: "staff_id", Legend: "Id", Input: unixid.InputPK()},
			{Name: "staff_name", Legend: "Atendido por", Input: input.Text()},
			{Name: "staff_ocupation", Legend: "Especialidad", Input: input.Text()},
			{Name: "staff_area", Legend: "Area", Input: input.Check(Area{})},

			{Name: "service_id", Legend: "Prestación", Input: unixid.InputPK()},

			{Name: "day_attention", Legend: "Dia Atención", Input: input.Date()},
			{Name: "hour_attention", Legend: "Hora", Input: input.Hour(`min="08:15"`, `max="20:15"`)},

			{Name: "reason", Legend: "Motivo Consulta, Servicio o Procedimiento", Input: input.TextArea()},
			{Name: "diagnostic", Legend: "Diagnostico (Descripción)", Input: input.TextArea()},
			{Name: "prescription", Legend: "Prescripción (Conclusion)", Input: input.TextArea()},

			{Name: "last_print_file", Legend: "Ultima Impresión en Archivo", Input: input.Text()},
		},
	}
}

Documentation

Index

Constants

View Source 
const INPUT_PATTERN = `input\.(\w+)\([^)]*\)`
View Source 
const PREFIX_ID_NAME = "id_"

Variables

This section is empty.

Functions

func Error added in v0.0.40 

func Error(messages ...any) *err

only support: error, int, int64, string, map[string]interface{}

Types

type AfterClicked added in v0.0.52 

type AfterClicked interface {
	// data del objeto que fue cliqueado por el usuario
	UserClicked(data map[string]string)
}

type AfterCreate added in v0.0.46 

type AfterCreate interface {
	SetObjectInDomAfterCreate(data ...map[string]string) error
}

type AfterDelete added in v0.0.46 

type AfterDelete interface {
	SetObjectInDomAfterDelete(data ...map[string]string) error
}

type AfterRead added in v0.0.49 

type AfterRead interface {
	SetObjectInDomAfterRead(data ...map[string]string) error
}

type AfterUpdate added in v0.0.46 

type AfterUpdate interface {
	SetObjectInDomAfterUpdate(data ...map[string]string) error
}

type AppInfo added in v0.0.67 

type AppInfo struct {
	App_name         string
	App_version      string
	Business_name    string
	Business_address string
	Business_phone   string
}

type AuthAdapter added in v0.0.58 

type AuthAdapter interface {
	UserAuthNumber
}

type BackendHandler added in v0.0.46 

type BackendHandler struct {
	BootResponse

	CreateApi
	ReadApi
	UpdateApi
	DeleteApi

	FileHandler
}

type BootActions added in v0.0.44 

type BootActions struct {
	JsonBootActions string
}

type BootResponse added in v0.0.45 

type BootResponse interface {
	AddBootResponse(u *User) ([]Response, error)
}

type ContainerView added in v0.0.64 

type ContainerView interface {
	BuildContainerView(id, field_name string, allow_skip_completed bool) string
}

todo el contenido html por defecto del objeto

type CreateApi added in v0.0.31 

type CreateApi interface {
	Create(u *User, data ...map[string]string) error
}

type CutData added in v0.0.19 

type CutData struct {

	// ej Modelo Objeto: usuario := Object{Name: "Usuario",Fields: []Field{
	// 		{Name: "name"}, //0
	// 		{Name: "email"},//1
	// 		{Name: "phone"},//2
	// 	},}
	// ej data normal con todos los campos: {"name":"John Doe","email":"johndoe@example.com","phone":"555"}
	// version recortada Data: {"John Doe","johndoe@example.com","555"}
	// Index Objeto al codificar = {"0:0","1:1","2:2"}
	// ej no mail: {"marcel", "777"}
	// Index al codificar = {"0:0","1:2"}
	Index map[int8]int8 `json:"i"`
	//Data ej en mapa: "Data":[{"id":"222","name":"manzana","valor":"1200"}]
	// ahora: "Data":["222","manzana","1200"]
	Data []string `json:"d"`
}

type CutResponse added in v0.0.19 

type CutResponse struct {
	//Action,Object,Module,Message
	//ej: ["create","user","ModuleUsers","ok"]
	CutOptions []string  `json:"o"`
	CutData    []CutData `json:"d"`
}

func (*CutResponse) CutResponseDecode added in v0.0.21 

func (cr *CutResponse) CutResponseDecode(data []map[string]string) (out Response)

type DataBaseAdapter added in v0.0.35 

type DataBaseAdapter interface {
	IdHandler
	RunOnClientDB() bool //verdadero corren en el cliente ej browser. por defecto falso corre en el servidor
	// items support in server db: []map[string]string, map[string]string
	CreateObjectsInDB(table_name string, backup_required bool, items any) error

	// from_tables ej: "users,products" or: public.reservation, public.patient"
	// params: map[string]string ej:{
	// LIMIT: 10, 5, 100. note: Postgres y MySQL: "LIMIT 10", SQLite: "LIMIT 10 OFFSET 0" OR "" no limit
	// ORDER_BY: name,phone,address
	// SELECT: "name, phone, address" default *
	// WHERE: "patient.id_patient = reservation.id_patient AND reservation.id_staff = '2'"
	// ARGS: "1,4,33"
	// }
	ReadObjectsInDB(from_tables string, params ...map[string]string) ([]map[string]string, error)
	//params: callback fun ej: fun([]map[string]string,error)
	// "ORDER_BY": "patient_name", "SORT":"DESC" DEFAULT "ASC"
	ReadStringDataAsyncInDB(r ReadDBParams, callback func([]map[string]string, error))
	ReadAnyDataAsyncInDB(r ReadDBParams, callback func([]map[string]interface{}, error))

	UpdateObjectsInDB(table_name string, data ...map[string]string) error
	DeleteObjectsInDB(table_name string, data ...map[string]string) error

	CreateTablesInDB(objects []*Object, action Subsequently) error

	BackupDataBase(callback func(error))
}

type DeleteApi added in v0.0.31 

type DeleteApi interface {
	Delete(u *User, data ...map[string]string) ([]map[string]string, error)
}

type DomAdapter added in v0.0.47 

type DomAdapter interface {
	UserMessage

	InnerHTML(html_content string, o *Object)
	InsertAfterBegin(html_content string, o *Object)
	InsertBeforeEnd(html_content string, o *Object)

	Clicking(o *Object, id string) error

	ClickModule(module_name string) error
	CallFunction(functionName string, args ...any) error

	Form
}

type Field 

type Field struct {
	// si el campo comienza com id_ se considera como único y perteneciente a una tabla específica ej: id_user su tabla es user
	// otros ej: id_usuario, apellido, address, city etc
	Name          string
	Legend        string //como se mostrara al usuario el campo en el encabezado ej: "name" por "Nombre Usuario"
	SourceTable   string // tabla origen ej: patient,user,product
	NotRenderHtml bool   // si no se necesita en formulario html

	*Input

	SkipCompletionAllowed bool //se permite que el campo no este completado. por defecto siempre sera requerido

	Unique          bool //campo único e inalterable en db
	NotRequiredInDB bool // campo no requerido en base de datos al crear tabla
	Encrypted       bool // si estará encriptado su almacenamiento o no
}

func (Field) IsPrimaryKey added in v0.0.35 

func (f Field) IsPrimaryKey(o *Object) bool

type FileAdapter added in v0.0.64 

type FileAdapter interface {
	ReadFile(url_or_path string) ([]byte, error)
	DeleteFile(url_or_path string) error
}

type FileApi added in v0.0.33 

type FileApi interface {
	// ej: id:123
	GetFilePathByID(params map[string]string) (file_path, area string, err error)
}

type FileConfig added in v0.0.57 

type FileConfig struct {
	MaximumFilesAllowed int64  // numero máximo de archivos permitidos ej: 4,100 etc
	InputNameWithFiles  string // nombre del campo con los archivos multipart del formulario ej: files
	MaximumFileSize     int64  // tamaño máximo de todos los archivos
	MaximumKbSize       int64  // tamaño máximo individual kb ej: 100
	AllowedExtensions   string // exenciones permitidas ej: ".jpg, .png, .jpeg"

	ImagenWidth  string // ej: 800
	ImagenHeight string // ej: 600

	RootFolder string //ej: static_files default "app_files"
	FileType   string // ej: imagen,video,document,pdf

	SavedAsBlobInDb bool // si se guardara en el motor de la base de datos, por defecto en el disco como archivo

	//field
	FieldNameWithObjectID string //ej: id_medicalhistory
	Name                  string //ej: endoscopia, pictures
	Legend                string //ej: Imágenes,Boletas etc
	DefaultEnableInput    bool   // si se necesita habilitado resetear el campo por defecto falso

}

type FileHandler added in v0.0.59 

type FileHandler interface {
	// PrepareFileData(header_name, extension string, form_data map[string]string) map[string]string
	//header_name ej: fileHeader.Filename,user_area_file ej:1,5 extension ej: .jpeg
	RegisterNewFile(new *FileNewToStore, form_data map[string]string) (map[string]string, error)
	ConfigFile() *FileConfig
	UploadFolderPath(form_data map[string]string) string // carpeta de destino
	GenerateFileNameOnDisk() string                      // retornar nombre de archivo sin extension
	FileApi
}

type FileNewToStore added in v0.0.62 

type FileNewToStore struct {
	DescriptionInputName string //name in the input. whit extension ej: perrito.jpg,boleta_123.png
	UploadFolder         string //ej: ./files
	FileNameOnDisk       string // no extension ej: 1223, archivo_235, 001_file
	FileArea             string // area que tendrá el archivo ej: s,a,1,3,4
	Extension            string // ej .jpg,.mp4
	BlobData             any    // data del archivo
}

type Form added in v0.0.55 

type Form interface {
	FormReset(o *Object) error
	FormAutoFill(o *Object) error
	FormComplete(o *Object, data map[string]string) error
}

type FormAdapter added in v0.0.66 

type FormAdapter interface {
	BuildFormFields() map[string]interface{}
}

type FrontendBootActions added in v0.0.45 

type FrontendBootActions interface {
}

type FrontendHandler added in v0.0.46 

type FrontendHandler struct {
	AfterCreate
	AfterRead
	AfterUpdate
	AfterDelete

	AfterClicked

	NotifyBootData

	ViewHandler

	ViewReset
}

type Handlers added in v0.0.60 

type Handlers struct {
	AppInfo
	ThemeAdapter
	DataBaseAdapter
	TimeAdapter
	DomAdapter
	HttpAdapter
	AuthAdapter
	Logger
	// TEST  TestAdapter
	FileAdapter
	ObjectAdapter
}

type HttpAdapter added in v0.0.49 

type HttpAdapter interface {
	//action: create,read,update,delete,file
	SendJson(o *Object, in_data []map[string]string, action string, out_resp func([]Response, error))
	SendFormData(object_name string, data map[string]interface{}, out_resp func(Response, error))
}

type Icon added in v0.0.28 

type Icon struct {
	Id      string   //ej: icon-search, icon-btn-save, icon-btn-new
	ViewBox string   //ej: "0 0 16 16", "0 0 448 512"
	Paths   []string //ej: m11.51 11..,m7.051..,m3.267 15...
}

type IdHandler added in v0.0.56 

type IdHandler interface {
	GetNewID() string
}

type Input added in v0.0.5 

type Input struct {
	InputName string

	Minimum int
	Maximum int

	Tag
	ItemView
	InputReset
	Validate

	TestData
}

type InputReset added in v0.0.61 

type InputReset interface {
	ResetInput()
}

type ItemView added in v0.0.64 

type ItemView interface {
	BuildItemView(all_data ...map[string]string) (html string)
}

type Logger added in v0.0.60 

type Logger interface {
	// retorno una interfaz solo para simplificar funciones de tipo syscall/js
	Log(message ...any) interface{}
}

type Module 

type Module struct {
	//nombre modulo ej: chat,patient,user
	ModuleName string
	//Titulo que vera el usuario ej: "Modulo Fotografía"
	Title string
	// id icono para utilizar en sprite svg ej: icon-info
	IconID string

	//interfaz usuario modulo
	UI

	// ej:	`<div class="target-module">
	// 	<select name="select">
	// 		<option value="value1">Value 1</option>
	// 		<option value="value2" selected>Value 2</option>
	// 	</select>
	// </div>`
	HeaderInputTarget string

	//areas soportadas por el modulo ej: 'a','t','x'
	Areas []byte
	// objetos o componentes que contiene el modulo ej: patient,user,datalist,search....
	Objects []*Object

	// tipo de entradas usadas en el modulo
	Inputs []*Input
}

func (*Module) AddInputs added in v0.0.56 

func (m *Module) AddInputs(new_inputs []*Input, from string) error

from ej: file, user

type NotifyBootData added in v0.0.50 

type NotifyBootData interface {
	NotifyBootDataIsLoaded()
}

type Object 

type Object struct {
	// ej: module.client, client.search_footer,user.datalist
	Name  string
	Table string //tabla origen db ej: users

	PrincipalFieldsName []string //campos mas representativos ej: name, address, phone
	Fields              []Field  //campos

	*Module // módulo origen

	BackendHandler

	FrontendHandler

	PrinterHandler

	FormData map[string]string // data temporal formulario
	FormAdapter
}

func (Object) Columns 

func (o Object) Columns() (columns []string)

func (Object) DataDecode added in v0.0.19 

func (o Object) DataDecode(cut_data ...CutData) ([]map[string]string, error)

func (Object) DataEncode added in v0.0.19 

func (o Object) DataEncode(all_data ...map[string]string) (out []CutData)

DataEncode quita los nombres de los campos de la data según modelo del objeto

func (Object) FieldExist added in v0.0.16 

func (o Object) FieldExist(field_name string) (Field, bool)

func (Object) FieldsToFormValidate added in v0.0.66 

func (o Object) FieldsToFormValidate() (fiels_out []Field)

func (Object) FilterRemoveFields 

func (o Object) FilterRemoveFields(namesToRemove ...string) (fiels_out []Field)

func (Object) GetFieldsByNames added in v0.0.50 

func (o Object) GetFieldsByNames(required_names ...string) ([]Field, error)

func (Object) GetID 

func (o Object) GetID(data_search map[string]string) string

func (Object) GetRepresentativeTextField 

func (o Object) GetRepresentativeTextField(data_element map[string]string) (values string)

func (Object) GetTablesNames added in v0.0.50 

func (o Object) GetTablesNames() (out []string)

func (Object) JoinFieldNames added in v0.0.48 

func (o Object) JoinFieldNames(add_prefix_table_name bool) (out string)

ej: id_patient,patient_name,patient_run - add_prefix_table_name: true = patient.id_patient,patient.patient_name,patient.patient_run

func (Object) MainName 

func (o Object) MainName() string

func (Object) OnlyRequiredDbFieldsThisObject added in v0.0.63 

func (o Object) OnlyRequiredDbFieldsThisObject() (db_field []Field)

solo campos requeridos en la base de datos. NOTA: puntero []*Field no funciona con slice

func (Object) PrimaryKeyName 

func (o Object) PrimaryKeyName(options ...string) string

ej: "id_client", options: "add_prefix_table_name" = "client.id_client"

func (Object) RenderFields 

func (o Object) RenderFields() (fiels_out []Field)

func (Object) RequiredFields 

func (o Object) RequiredFields() (fiels_out []Field)

func (Object) Response added in v0.0.35 

func (o Object) Response(data []map[string]string, options ...string) Response

options ej: update,delete,"mensaje a enviar" default action: create

func (Object) TestData added in v0.0.39 

func (o Object) TestData(required_objects int, skip_id, wrong_data bool) ([]map[string]string, error)

func (Object) ValidateData added in v0.0.16 

func (o Object) ValidateData(its_new, its_update_or_delete bool, all_data ...map[string]string) error

validar data objeto

func (Object) Where added in v0.0.50 

func (o Object) Where(data map[string]string) (out string)

ej: reservation.id_patient = patient.id_patient AND reservation.id_staff = '1635574887' AND reservation.reservation_day = '29'

type ObjectAdapter added in v0.0.66 

type ObjectAdapter interface {
	GetObjectByName(name_to_search string) (*Object, error)
}

type Package added in v0.0.35 

type Package struct {
	SkipMeInResponse bool     `json:"-"` //  saltarme al difundir
	Recipients       []string `json:"-"` // lista de ip, token o ids según app para el reenvió al finalizar solicitud
	TargetArea       bool     `json:"-"` // si es falso el destino por defecto es publico de lo contrario sera para todos quines tengan la misma area del usuario solicitante
	Response
}

type Page added in v0.0.33 

type Page struct {
	StyleSheet string // url ej style.css

	AppName    string
	AppVersion string

	SpriteIcons string

	Menu string

	UserName string
	UserArea string
	Message  string

	Modules string

	Script string // ej main.js

	JsonBootActions string //index ej <meta name="JsonBootActions" content="{{.JsonBootActions}}">
}

index.html ej: {{.StyleSheet}} {{.AppName}} {{.AppVersion}} {{.SpriteIcons}} {{.Menu}} {{.Message}} {{.UserName}} {{.UserArea}} {{.Modules}} {{.Script}} {{.Data}}

type Path added in v0.0.27 

type Path interface {
	FolderPath() string
}

FolderPath() string ej: func (Object) FolderPath() string { _, filename, _, _ := runtime.Caller(0) dir := filepath.Dir(filename) return filepath.ToSlash(dir) }

type Permission 

type Permission struct {
	Read  bool
	Write bool
}

type PrinterHandler added in v0.0.66 

type PrinterHandler interface {
	PrintFormObject()
}

type ReadApi added in v0.0.31 

type ReadApi interface {
	Read(u *User, data ...map[string]string) ([]map[string]string, error)
}

type ReadDBParams added in v0.0.66 

type ReadDBParams struct {
	FROM_TABLE      string
	ID              string   // unique search
	WHERE           []string //
	SEARCH_ARGUMENT string
	ORDER_BY        string
	SORT_DESC       bool //default ASC
}

type Request 

type Request struct {
	//usuario que ejecuta la solicitud
	*User
	// paquetes de solicitud y respuesta
	Packages []Package
}

type Response 

type Response struct {
	Action  string              `json:"a,omitempty"` //acción a realizar con la solicitud: create, read, update, delete o error
	Object  string              `json:"o,omitempty"` //nombre de la tabla u objeto controlador hacia donde va la solicitud
	Message string              `json:"g,omitempty"` //mensaje para el usuario de la solicitud
	Data    []map[string]string `json:"d,omitempty"` //data entrada y respuesta json
}

type SourceData added in v0.0.44 

type SourceData interface {
	SourceData() map[string]string
}

type Subsequently added in v0.0.49 

type Subsequently interface {
	ActionExecutedLater()
}

acción a ejecutar posteriormente

type Tag added in v0.0.26 

type Tag interface {
	HtmlName() string
	ContainerView
}

type TestData added in v0.0.10 

type TestData interface {
	GoodTestData() (out []string)
	WrongTestData() (out []string)
}

type ThemeAdapter added in v0.0.47 

type ThemeAdapter interface {
	// MenuButtonTemplate ej: <li class="navbar-item"><a href="#` + module_name + `" tabindex="` + index + `" class="navbar-link" name="` + module_name + `">
	// <svg aria-hidden="true" focusable="false" class="fa-primary"><use xlink:href="#` + icon_id + `" /></svg>
	// <span class="link-text">` + title + `</span></a></li>
	MenuButtonTemplate(module_name, index, icon_id, title string) string
	MenuClassName() string // ej: .menu-container
	MenuItemClass() string // ej: navbar-item

	ModuleClassName() string //ej: slider_panel

	ModuleTemplate(m *Module, form *Object, list ContainerView) string

	FunctionMessageName() string // ej: ShowMessageToUser
	// ej query: "div#"+o.ModuleName+" [data-id='"+o.Name+"']"
	QuerySelectorObject(module_name, object_name string) (query string)
}

type TimeAdapter added in v0.0.47 

type TimeAdapter interface {
	TimeNow
	TimeWeek
}

type TimeNow added in v0.0.52 

type TimeNow interface {
	// layout ej: 2006-01-02
	ToDay(layout string) string
}

type TimeWeek added in v0.0.52 

type TimeWeek interface {
	//date ej: 2006-01-02,  0 para Domingo, 1 para Lunes, etc.
	WeekDayNumber(date_in string) (int, error)
}

type UI added in v0.0.26 

type UI interface {
	UserInterface(options ...string) string
}

type UnixTimeHandler added in v0.0.56 

type UnixTimeHandler interface {
	UnixNano() int64
}

ej: time.Now()

type UpdateApi added in v0.0.31 

type UpdateApi interface {
	Update(u *User, data ...map[string]string) error
}

type User 

type User struct {
	Token          string // token de sesión solicitante
	Id             string // id usuario
	Ip             string
	Name           string
	Area           string //0 sin area.. un que byte y uint8 son lo mismo en go la idea que aca sea un valor de carácter ej: a,s,p...
	AccessLevel    string // aquí valor numérico 0 a 255
	LastConnection string //time.Time

}

type UserAuthNumber added in v0.0.51 

type UserAuthNumber interface {
	UserAuthNumber() (string, error)
}

ej: 1 or 2 or 34 or 400.....

type UserMessage added in v0.0.52 

type UserMessage interface {
	// retorno una interfaz solo para simplificar funciones de tipo syscall/js
	UserMessage(message ...any) interface{}
}

type Validate added in v0.0.5 

type Validate interface {
	//options html ej: data-option="ch_doc"
	ValidateField(data_in string, skip_validation bool, options ...string) error
}

type ViewHandler added in v0.0.50 

type ViewHandler interface {
	ViewHandlerName() string
	ContainerView
	ItemView
}

type ViewReset added in v0.0.66 

type ViewReset interface {
	ResetView()
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.