site_setup

README

site-setup

Site Setup plugin for Ecletus Framework

Documentation

Index

• Variables
• func OnRegister(dis plug.EventDispatcherInterface, cb func(e *SiteSetupEvent))
• func OnSetup(dis plug.EventDispatcherInterface, cb func(e *SiteSetupEvent) error)
• func Trigger(dis plug.PluginEventDispatcherInterface, eventName string, site *core.Site, ...) error
• type Plugin
  • func (p *Plugin) OnRegister()
  • func (p *Plugin) RequireOptions() []string
• type PostMigratePlugin
• type PostSetupPlugin
• type PreMigratePlugin
• type PreSetupPlugin
• type SiteSetupEvent

Variables

var (
	E_SETUP    = PKG + ".setup"
	E_REGISTER = PKG + ".register"
)

var (
	PKG = path_helpers.GetCalledDir()
)

Functions

func OnRegister

func OnRegister(dis plug.EventDispatcherInterface, cb func(e *SiteSetupEvent))

func OnSetup

func OnSetup(dis plug.EventDispatcherInterface, cb func(e *SiteSetupEvent) error)

func Trigger

func Trigger(dis plug.PluginEventDispatcherInterface, eventName string, site *core.Site, cmd *cobra.Command) error

Types

type Plugin

type Plugin struct {
	plug.EventDispatcher
	SitesRegisterKey string
}

func (*Plugin) OnRegister

func (p *Plugin) OnRegister()

func (*Plugin) RequireOptions

func (p *Plugin) RequireOptions() []string

type PostMigratePlugin

type PostMigratePlugin interface {
	PostMigrate(site *core.Site) (err error)
}

type PostSetupPlugin

type PostSetupPlugin interface {
	PostSetup(site *core.Site) (err error)
}

type PreMigratePlugin

type PreMigratePlugin interface {
	PreMigrate(site *core.Site) (err error)
}

type PreSetupPlugin

type PreSetupPlugin interface {
	PreSetup(site *core.Site) (err error)
}

type SiteSetupEvent

type SiteSetupEvent struct {
	plug.PluginEventInterface
	Site     *core.Site
	SetupCMD *cobra.Command
}