| Property | Type | Description | |
|---|---|---|---|
| $countryPlugins | CountryPlugin | ||
| $dataTypePlugins | |||
| $db | Database | ||
| $exportTypePlugins | |||
| $geoData | GeoData | ||
| $language | Language | ||
| $smarty | Smarty | ||
| $translations | Translations | ||
| $user | Account |
| Method | Description | |
|---|---|---|
| checkAllowMultiUserAnonymousUse ( ) | ||
| checkDemoMode ( ) | TODO Yuck! Why does this return a boolean as a frickin' string?! Was I drunk? | |
| checkIsInstalled ( ) | Full installation of the program is determined by (a) the settings.php file existing and (b) the "installationComplete" setting value existing in the database. Note: this function assumes the database connection in Core::$db has already been created. | |
| checkIsLoggedIn ( ) | ||
| checkSettingsFileExists ( ) | ||
| getContinents ( ) | ||
| getDataTypeGroups ( ) | ||
| getDbName ( ) | ||
| getDbPassword ( ) | ||
| getDbTablePrefix ( ) | ||
| getDbUsername ( ) | ||
| getDefaultCountryPlugins ( ) | ||
| getDefaultExportType ( ) | Returns the out-the-box default Export Type. | |
| getDefaultLanguageFile ( ) | ||
| getDefaultNumRows ( ) | ||
| getDefaultTheme ( ) | Used during the installation process only: it returns the default theme for new installations. | |
| getEncryptionSalt ( ) | ||
| getHostname ( ) | ||
| getMaxDataSetHistorySize ( ) | ||
| getMaxDemoModeRows ( ) | ||
| getMaxGeneratedRows ( ) | ||
| getMinimumMySQLVersion ( ) | Returns the minimum MySQL version required to run this script. Used during installation to ensure the server environment is adequate. | |
| getMinimumPHPVersion ( ) | Returns the minimum PHP version required to run this script. Used during installation to ensure the server environment is adequate. | |
| getPluginSettings ( $pluginType, $pluginFolder ) : mixed | Added in 3.1.4. This allows any plugins to have custom settings defined in $pluginSettings. This function returns null if no settings exist for the plugin, or whatever settings have been provided. | |
| getVersion ( ) | ||
| init ( string $runtimeContext = "ui" ) | Core::init() | |
| initSessions ( ) | ||
| initUser ( boolean $bypass = false ) | Initializes the current logged in user and stores their Account object in Core::$user. | |
| isApiEnabled ( ) : boolean | Determines whether the REST API functionality is available or not. | |
| isInstalling ( ) | ||
| isSmartySecurityEnabled ( ) | ||
| isUsingMinifiedResources ( ) : boolean | Returns a boolean signifying whether we should use the minified + bundled resources generated via Grunt. |
| Method | Description | |
|---|---|---|
| initCountries ( ) | Called by Core::init(), this initializes Core::$countryPlugins. | |
| initDataTypes ( $runtimeContext ) | Called by Core::init(), this initializes Core::$dataTypePlugins. Note that this will contain ALL installed plugins, not those that are selected by a particular user. In 3.2.2 that feature was added, so use Account::getDataTypePlugins() instead. | |
| initDatabase ( ) | Initializes the Database object and stores it in Core::$db. | |
| initExportTypes ( $runtimeContext ) | Called by Core::init(), this initializes Core::$exportTypePlugins. | |
| initGeoData ( ) | This function returns the actual data populated in the database by the Country plugins. It returns an array of country data, contains regions and cities. | |
| initSmarty ( ) | Initializes the Smarty object used for things like rendering the Smarty templates found in resources/templates/ - and for other misc uses. | |
| loadSettingsFile ( ) | Core::loadSettingsFile() |
| public static checkAllowMultiUserAnonymousUse ( ) |
| public static checkDemoMode ( ) |
| public static checkIsInstalled ( ) |
| public static getDefaultExportType ( ) |
| public static getDefaultTheme ( ) |
| public static getMinimumMySQLVersion ( ) |
| public static getMinimumPHPVersion ( ) |
| public static getPluginSettings ( $pluginType, $pluginFolder ) : mixed | ||
| $pluginType | ||
| $pluginFolder | ||
| return | mixed | |
| public static init ( string $runtimeContext = "ui" ) | ||
| $runtimeContext | string | This determines the context in which the Core is being initialized. This
info is used to let plugins instantiate themselves differently, as well as prevent the loading
of incomplete parts of the script. installation: a fresh installation, DB not installed yet installationDatabaseReady: during installation after the DB has been installed ui: (default) for the main generator page generation: when we're in the process of creating actual data resetPlugins: initialized everything except the plugins, which may be safely reset |
| public static isApiEnabled ( ) : boolean | ||
| return | boolean | |
| public static isUsingMinifiedResources ( ) : boolean | ||
| return | boolean | |
| public static CountryPlugin $countryPlugins | ||
| return | CountryPlugin | |
| public static Translations $translations | ||
| return | Translations | |
