go-admin: github.com/GoAdminGroup/go-admin/engine Index | Files

package engine

import "github.com/GoAdminGroup/go-admin/engine"

Index

Package Files

engine.go

func Content Uses

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

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

func Register Uses

func Register(ada adapter.WebFrameWork)

Register set default adapter of engine.

func User Uses

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

User call the User method of defaultAdapter.

type ConnectionSetter Uses

type ConnectionSetter func(db.Connection)

type Engine Uses

type Engine struct {
    PluginList plugins.Plugins
    Adapter    adapter.WebFrameWork
    Services   service.List
    NavButtons *types.Buttons
    // 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 Uses

func Default() *Engine

Default return the default engine instance.

func (*Engine) AddAdapter Uses

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

AddAdapter add the adapter of engine.

func (*Engine) AddAuthService Uses

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

AddAuthService customize the auth logic with given callback function.

func (*Engine) AddConfig Uses

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

AddConfig set the global config.

func (*Engine) AddConfigFromINI Uses

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

AddConfigFromINI set the global config from ini file.

func (*Engine) AddConfigFromJSON Uses

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

AddConfigFromJSON set the global config from json file.

func (*Engine) AddConfigFromYAML Uses

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

AddConfigFromYAML set the global config from yaml file.

func (*Engine) AddDisplayFilterLimit Uses

func (eng *Engine) AddDisplayFilterLimit(limit int) *Engine

AddDisplayFilterLimit call types.AddDisplayFilterLimit.

func (*Engine) AddDisplayFilterSubstr Uses

func (eng *Engine) AddDisplayFilterSubstr(start int, end int) *Engine

AddDisplayFilterSubstr call types.AddDisplayFilterSubstr.

func (*Engine) AddDisplayFilterToLower Uses

func (eng *Engine) AddDisplayFilterToLower() *Engine

AddDisplayFilterToLower call types.AddDisplayFilterToLower.

func (*Engine) AddDisplayFilterToTitle Uses

func (eng *Engine) AddDisplayFilterToTitle() *Engine

AddDisplayFilterToTitle call types.AddDisplayFilterToTitle.

func (*Engine) AddDisplayFilterToUpper Uses

func (eng *Engine) AddDisplayFilterToUpper() *Engine

AddDisplayFilterToUpper call types.AddDisplayFilterToUpper.

func (*Engine) AddDisplayFilterTrimSpace Uses

func (eng *Engine) AddDisplayFilterTrimSpace() *Engine

AddDisplayFilterTrimSpace call types.AddDisplayFilterTrimSpace.

func (*Engine) AddDisplayFilterXssFilter Uses

func (eng *Engine) AddDisplayFilterXssFilter() *Engine

AddDisplayFilterXssFilter call types.AddDisplayFilterXssFilter.

func (*Engine) AddDisplayFilterXssJsFilter Uses

func (eng *Engine) AddDisplayFilterXssJsFilter() *Engine

AddDisplayFilterXssJsFilter call types.AddDisplayFilterXssJsFilter.

func (*Engine) AddGenerator Uses

func (eng *Engine) AddGenerator(key string, g table.Generator) *Engine

AddGenerator add table model generator.

func (*Engine) AddGenerators Uses

func (eng *Engine) AddGenerators(list ...table.GeneratorList) *Engine

AddGenerators add the admin generators.

func (*Engine) AddGlobalDisplayProcessFn Uses

func (eng *Engine) AddGlobalDisplayProcessFn(f types.FieldFilterFn) *Engine

AddGlobalDisplayProcessFn call types.AddGlobalDisplayProcessFn.

func (*Engine) AddNavButtons Uses

func (eng *Engine) AddNavButtons(title template2.HTML, icon string, action types.Action) *Engine

AddNavButtons add the nav buttons.

func (*Engine) AddPluginList Uses

func (eng *Engine) AddPluginList(plugs plugins.Plugins) *Engine

AddPluginList add the plugins

func (*Engine) AddPlugins Uses

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

AddPlugins add the plugins

func (*Engine) AdminPlugin Uses

func (eng *Engine) AdminPlugin() *admin.Admin

AdminPlugin get the admin plugin. if not exist, create one.

func (*Engine) Clone Uses

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

Clone copy a new Engine.

func (*Engine) ClonedBySetter Uses

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

ClonedBySetter copy a new Engine by a setter callback function.

func (*Engine) Content Uses

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 Uses

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

DB return the db connection of given driver.

func (*Engine) Data Uses

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

Data inject the route and corresponding handler to the web framework.

func (*Engine) DefaultConnection Uses

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

DefaultConnection return the default db connection.

func (*Engine) FindPluginByName Uses

func (eng *Engine) FindPluginByName(name string) (plugins.Plugin, bool)

FindPluginByName find the register plugin by given name.

func (*Engine) HTML Uses

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

HTML inject the route and corresponding handler wrapped by the given function to the web framework.

func (*Engine) HTMLFile Uses

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

HTMLFile inject the route and corresponding handler which returns the panel content of given html file path to the web framework.

func (*Engine) HTMLFiles Uses

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

HTMLFiles inject the route and corresponding handler which returns the panel content of given html files path to the web framework.

func (*Engine) HTMLFilesNoAuth Uses

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

HTMLFilesNoAuth inject the route and corresponding handler which returns the panel content of given html files path to the web framework without auth check.

func (*Engine) InitDatabase Uses

func (eng *Engine) InitDatabase() *Engine

InitDatabase initialize all database connection.

func (*Engine) MssqlConnection Uses

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

MssqlConnection return the mssql db connection of given driver.

func (*Engine) MysqlConnection Uses

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

MysqlConnection return the mysql db connection of given driver.

func (*Engine) PostgresqlConnection Uses

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

PostgresqlConnection return the postgresql db connection of given driver.

func (*Engine) ResolveConnection Uses

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

ResolveConnection resolve the specified driver connection.

func (*Engine) ResolveMssqlConnection Uses

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

ResolveMssqlConnection resolve the mssql connection.

func (*Engine) ResolveMysqlConnection Uses

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

ResolveMysqlConnection resolve the mysql connection.

func (*Engine) ResolvePostgresqlConnection Uses

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

ResolvePostgresqlConnection resolve the postgres connection.

func (*Engine) ResolveSqliteConnection Uses

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

ResolveSqliteConnection resolve the sqlite connection.

func (*Engine) SetCaptcha Uses

func (eng *Engine) SetCaptcha(captcha map[string]string) *Engine

SetCaptcha set the captcha config.

func (*Engine) SetCaptchaDriver Uses

func (eng *Engine) SetCaptchaDriver(driver string) *Engine

SetCaptchaDriver set the captcha config with driver.

func (*Engine) SqliteConnection Uses

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

SqliteConnection return the sqlite db connection of given driver.

func (*Engine) Use Uses

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

Use enable the adapter.

func (*Engine) User Uses

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

User call the User method of engine adapter.

type Setter Uses

type Setter func(*Engine)

Package engine imports 29 packages (graph) and is imported by 45 packages. Updated 2020-08-05. Refresh now. Tools for package owners.