engine

Documentation

Index

• func Content(ctx interface{}, panel types.GetPanelFn)
• func Register(ada adapter.WebFrameWork)
• func User(ci interface{}) (models.UserModel, bool)
• type ConnectionSetter
• type Engine
  • func Default() *Engine
  • func (eng *Engine) AddAdapter(ada adapter.WebFrameWork) *Engine
  • func (eng *Engine) AddAuthService(processor auth.Processor) *Engine
  • func (eng *Engine) AddConfig(cfg config.Config) *Engine
  • func (eng *Engine) AddConfigFromINI(path string) *Engine
  • func (eng *Engine) AddConfigFromJSON(path string) *Engine
  • func (eng *Engine) AddConfigFromYAML(path string) *Engine
  • func (eng *Engine) AddPlugins(plugs ...plugins.Plugin) *Engine
  • func (eng *Engine) Clone(e *Engine) *Engine
  • func (eng *Engine) ClonedBySetter(setter Setter) *Engine
  • func (eng *Engine) Content(ctx interface{}, panel types.GetPanelFn)
  • func (eng *Engine) DB(driver string) db.Connection
  • func (eng *Engine) Data(method, url string, handler context.Handler)
  • func (eng *Engine) DefaultConnection() db.Connection
  • func (eng *Engine) HTML(method, url string, fn types.GetPanelInfoFn)
  • func (eng *Engine) HTMLFile(method, url, path string, data map[string]interface{})
  • func (eng *Engine) HTMLFiles(method, url string, data map[string]interface{}, files ...string)
  • func (eng *Engine) InitDatabase() *Engine
  • func (eng *Engine) MssqlConnection() db.Connection
  • func (eng *Engine) MysqlConnection() db.Connection
  • func (eng *Engine) PostgresqlConnection() db.Connection
  • func (eng *Engine) ResolveConnection(setter ConnectionSetter, driver string) *Engine
  • func (eng *Engine) ResolveMssqlConnection(setter ConnectionSetter) *Engine
  • func (eng *Engine) ResolveMysqlConnection(setter ConnectionSetter) *Engine
  • func (eng *Engine) ResolvePostgresqlConnection(setter ConnectionSetter) *Engine
  • func (eng *Engine) ResolveSqliteConnection(setter ConnectionSetter) *Engine
  • func (eng *Engine) SqliteConnection() db.Connection
  • func (eng *Engine) Use(router interface{}) error
  • func (eng *Engine) User(ci interface{}) (models.UserModel, bool)
• type Setter

Functions

func Content

func Content(ctx interface{}, panel types.GetPanelFn)

Content call the Content method of defaultAdapter. If defaultAdapter is nil, it will panic.

func Register

func Register(ada adapter.WebFrameWork)

Register set default adapter of engine.

func User

func User(ci interface{}) (models.UserModel, bool)

User call the User method of defaultAdapter.

Types

type ConnectionSetter

type ConnectionSetter func(db.Connection)

type Engine

type Engine struct {
	PluginList []plugins.Plugin
	Adapter    adapter.WebFrameWork
	Services   service.List
	// contains filtered or unexported fields
}

Engine is the core component of goAdmin. It has two attributes. PluginList is an array of plugin. Adapter is the adapter of web framework context and goAdmin context. The relationship of adapter and plugin is that the adapter use the plugin which contains routers and controller methods to inject into the framework entity and make it work.

func Default

func Default() *Engine

Default return the default engine instance.

func (*Engine) AddAdapter

func (eng *Engine) AddAdapter(ada adapter.WebFrameWork) *Engine

AddAdapter add the adapter of engine.

func (*Engine) AddAuthService

func (eng *Engine) AddAuthService(processor auth.Processor) *Engine

func (*Engine) AddConfig

func (eng *Engine) AddConfig(cfg config.Config) *Engine

AddConfig set the global config.

func (*Engine) AddConfigFromINI

func (eng *Engine) AddConfigFromINI(path string) *Engine

AddConfigFromINI set the global config from ini file.

func (*Engine) AddConfigFromJSON

func (eng *Engine) AddConfigFromJSON(path string) *Engine

AddConfigFromJSON set the global config from json file.

func (*Engine) AddConfigFromYAML

func (eng *Engine) AddConfigFromYAML(path string) *Engine

AddConfigFromYAML set the global config from yaml file.

func (*Engine) AddPlugins

func (eng *Engine) AddPlugins(plugs ...plugins.Plugin) *Engine

AddPlugins add the plugins and initialize them.

func (*Engine) Clone

func (eng *Engine) Clone(e *Engine) *Engine

func (*Engine) ClonedBySetter

func (eng *Engine) ClonedBySetter(setter Setter) *Engine

func (*Engine) Content

func (eng *Engine) Content(ctx interface{}, panel types.GetPanelFn)

Content call the Content method of engine adapter. If adapter is nil, it will panic.

func (*Engine) DB

func (eng *Engine) DB(driver string) db.Connection

db return the db connection of given driver.

func (*Engine) Data

func (eng *Engine) Data(method, url string, handler context.Handler)

func (*Engine) DefaultConnection

func (eng *Engine) DefaultConnection() db.Connection

func (*Engine) HTML

func (eng *Engine) HTML(method, url string, fn types.GetPanelInfoFn)

func (*Engine) HTMLFile

func (eng *Engine) HTMLFile(method, url, path string, data map[string]interface{})

func (*Engine) HTMLFiles

func (eng *Engine) HTMLFiles(method, url string, data map[string]interface{}, files ...string)

func (*Engine) InitDatabase

func (eng *Engine) InitDatabase() *Engine

InitDatabase initialize all database connection.

func (*Engine) MssqlConnection

func (eng *Engine) MssqlConnection() db.Connection

MssqlConnection return the mssql db connection of given driver.

func (*Engine) MysqlConnection

func (eng *Engine) MysqlConnection() db.Connection

MysqlConnection return the mysql db connection of given driver.

func (*Engine) PostgresqlConnection

func (eng *Engine) PostgresqlConnection() db.Connection

PostgresqlConnection return the postgresql db connection of given driver.

func (*Engine) ResolveConnection

func (eng *Engine) ResolveConnection(setter ConnectionSetter, driver string) *Engine

func (*Engine) ResolveMssqlConnection

func (eng *Engine) ResolveMssqlConnection(setter ConnectionSetter) *Engine

func (*Engine) ResolveMysqlConnection

func (eng *Engine) ResolveMysqlConnection(setter ConnectionSetter) *Engine

func (*Engine) ResolvePostgresqlConnection

func (eng *Engine) ResolvePostgresqlConnection(setter ConnectionSetter) *Engine

func (*Engine) ResolveSqliteConnection

func (eng *Engine) ResolveSqliteConnection(setter ConnectionSetter) *Engine

func (*Engine) SqliteConnection

func (eng *Engine) SqliteConnection() db.Connection

SqliteConnection return the sqlite db connection of given driver.

func (*Engine) Use

func (eng *Engine) Use(router interface{}) error

Use enable the adapter.

func (*Engine) User

func (eng *Engine) User(ci interface{}) (models.UserModel, bool)

User call the User method of engine adapter.

type Setter

type Setter func(*Engine)