directory

Documentation

Overview

Package directory provides features for currencies, currency rates, conversion of prices to a specified currency format, countries and regions.

Index

• Constants
• Variables
• func BaseCurrencyCode(cr config.Reader) (language.Currency, error)
• func DefaultCountry(cr config.Reader, r ...config.Retriever) string
• func ShowNonRequiredState(cr config.Reader, r ...config.Retriever) bool
• type Country
• type Currency
• type Region

Constants

const (
	PathSystemCurrencyInstalled = "system/currency/installed"

	// PathCurrencyBase defines the app base currency code
	PathCurrencyBase    = "currency/options/base"
	PathCurrencyDefault = "currency/options/default"
	PathCurrencyAllow   = "currency/options/allow"

	// PathOptionalZipCountries lists ISO2 country codes which have optional Zip/Postal pre-configured
	PathOptionalZipCountries = "general/country/optional_zip_countries"
	// PathStatesRequired lists countries, for which state is required. No default values.
	PathStatesRequired = "general/region/state_required"
	// PathDisplayAllStates detects whether or not display the state for the country, if it is not required
	PathDisplayAllStates = "general/region/display_all"
	PathDefaultCountry   = "general/country/default"
	PathDefaultLocale    = "general/locale/code"
	PathDefaultTimezone  = "general/locale/timezone"
)

Variables

var PackageConfiguration config.SectionSlice

PackageConfiguration contains the main configuration

var TableCollection csdb.TableStructureSlice

TableCollection handles all tables and its columns. init() in generated Go file will set the value.

Functions

func BaseCurrencyCode

func BaseCurrencyCode(cr config.Reader) (language.Currency, error)

BaseCurrencyCode retrieves application base currency code

func DefaultCountry

func DefaultCountry(cr config.Reader, r ...config.Retriever) string

DefaultCountry returns the country code. Store argument is optional.

func ShowNonRequiredState

func ShowNonRequiredState(cr config.Reader, r ...config.Retriever) bool

ShowNonRequiredState

Types

type Country

type Country struct {
}

type Currency

type Currency struct {
	// contains filtered or unexported fields
}

type Region

type Region struct {
}