app

Documentation

Overview

Package app represents Ottemo application object.

That package contains routines which allows other components to register callbacks on application start/end, API functions for administrator login, system configuration values, etc. So, this package contains the code addressed to application instance. Ottemo packages should address this package to interact with running application instance but not to "github.com/ottemo/foundaton" package".

Index

• Constants
• func End() error
• func GetDashboardURL(path string) string
• func GetSessionTimeZone(session api.InterfaceSession) (string, error)
• func GetStorefrontURL(path string) string
• func GetVerboseVersion() string
• func GetVersion() string
• func GetcommerceURL(path string) string
• func Init() error
• func OnAppEnd(callback func() error)
• func OnAppInit(callback func() error)
• func OnAppStart(callback func() error)
• func SendMail(to string, subject string, body string) error
• func SendMailEx(headers map[string]string, body string, context map[string]interface{}) error
• func Serve() error
• func SetSessionTimeZone(session api.InterfaceSession, zone string) (interface{}, error)
• func Start() error

Constants

const (
	ConstVersionMajor = 1
	ConstVersionMinor = 4
	ConstSprintNumber = 5

	ConstConfigPathGroup      = "general"
	ConstConfigPathAppGroup   = "general.app"
	ConstConfigPathStoreGroup = "general.store"
	ConstConfigPathMailGroup  = "general.mail"

	ConstConfigPathStorefrontURL = "general.app.storefront_url"
	ConstConfigPathDashboardURL  = "general.app.dashboard_url"
	ConstConfigPathcommerceURL   = "general.app.commerce_url"

	ConstConfigPathStoreName  = "general.store.name"
	ConstConfigPathStoreEmail = "general.store.email"

	ConstConfigPathStoreRootLogin    = "general.store.root_login"
	ConstConfigPathStoreRootPassword = "general.store.root_password"

	ConstConfigPathStoreCountry      = "general.store.country"
	ConstConfigPathStoreState        = "general.store.state"
	ConstConfigPathStoreCity         = "general.store.city"
	ConstConfigPathStoreAddressline1 = "general.store.addressline1"
	ConstConfigPathStoreAddressline2 = "general.store.addressline2"
	ConstConfigPathStoreZip          = "general.store.zip"

	ConstConfigPathStoreTimeZone = "general.store.timezone"

	ConstConfigPathMailFrom      = "general.mail.from"
	ConstConfigPathMailSignature = "general.mail.footer"
	ConstConfigPathMailServer    = "general.mail.server"
	ConstConfigPathMailPort      = "general.mail.port"
	ConstConfigPathMailUser      = "general.mail.user"
	ConstConfigPathMailPassword  = "general.mail.password"

	ConstConfigPathContactUsRecipient = "general.app.recipient"

	ConstConfigPathVerfifyEmail = ConstConfigPathAppGroup + ".verifyemail"

	ConstErrorModule = "app"
	ConstErrorLevel  = env.ConstErrorLevelService

	ConstAllowGuest = true
)

Package global constants

Functions

func End

func End() error

End fires application end event for all registered modules

func GetDashboardURL

func GetDashboardURL(path string) string

GetDashboardURL returns url related to dashboard server

func GetSessionTimeZone

func GetSessionTimeZone(session api.InterfaceSession) (string, error)

GetSessionTimeZone - return time zone of session

func GetStorefrontURL

func GetStorefrontURL(path string) string

GetStorefrontURL returns url related to storefront server

func GetVerboseVersion

func GetVerboseVersion() string

GetVerboseVersion returns verbose information about application build

func GetVersion

func GetVersion() string

GetVersion returns current version number

func GetcommerceURL

func GetcommerceURL(path string) string

GetcommerceURL returns url related to commerce server

func Init

func Init() error

Init fires application init event for all registered modules

func OnAppEnd

func OnAppEnd(callback func() error)

OnAppEnd registers callback function on application start event

func OnAppInit

func OnAppInit(callback func() error)

OnAppInit registers callback function on application init event

func OnAppStart

func OnAppStart(callback func() error)

OnAppStart registers callback function on application start event

func SendMail

func SendMail(to string, subject string, body string) error

SendMail sends mail via smtp server specified in config

func SendMailEx

func SendMailEx(headers map[string]string, body string, context map[string]interface{}) error

SendMailEx sends mail via smtp server specified in config - use nil context and/or headers for default values

func Serve

func Serve() error

Serve runs HTTP server in current go routine

func SetSessionTimeZone

func SetSessionTimeZone(session api.InterfaceSession, zone string) (interface{}, error)

SetSessionTimeZone - validate time zone and set it to session

func Start

func Start() error

Start fires application start event for all registered modules