systemConfig
systemConfig class extends systemConfigBase and adds specific methods to fetch frequently used parameters. These include the database DSN which will be populated with the username, database etc if they are set, timezone, users, paths etc.
Note: in most cases these methods return a systemConfigParam object, but in the case of isProduction and registerExceptionHandler / registerErrorHandler the boolean value is returned.
Methods
public __construct()
Returns new systemConfig
public isProduction()
Returns true if the system is in production, default is true (more secure)
public registerErrorHandler()
Returns true if the built-in errorHandler should be registered with PHP
public registerExceptionHandler()
Returns true if the built-in exceptionHandler should be registered with PHP
public registerDefaultDatabaseDsn()
If true, a default DSN will be built and assigned to the dbManager. This causes the dbManager to be loaded - but not connected.
public checkFolderPermissions()
Returns true if the temporary and log folders should be checked on each invocation; Should be disabled on production servers.
public getSystemLocale()
Returns the system locale, default is 'en'
public getSystemTimeZone()
Returns the system timezone, default is UTC (GMT0)
public getSystemFromAddress()
Returns the system from email address
public getSystemHostname()
Returns the system hostname
public getSystemGroup()
Returns the default system group
public getSystemGroupGid()
Returns the Posix ID for the current group
public getSystemUser()
Returns the default system user
public getSystemUserId()
Returns the Posix ID for the current user
public getSystemUriSeparator()
Returns the URI separator to use in URI strings
public getSystemLogType()
Returns the current logging type, this is the name of a valid systemLogWriter object
public getSystemLogFolderPermissions()
Returns the permissions to apply to created log folders
public getSystemLogFilePermissions()
Returns the permissions to apply to created log files
public getSystemLogLevel()
Returns the current log level (as defined in systemLogLevel)
public getSystemLogDateFormat()
Returns the date format to use on log entries
public getSystemLogUseExtendedExceptionData()
Returns the date format to use on log entries
public getDatabaseDsn()
Returns the system default DSN string
public getDatabaseType()
Returns the system default database TYPE
public getDatabaseHost()
Returns the database host
public getDatabasePort()
Returns the database port
public getDatabaseUser()
Returns the system default database user
public getDatabaseUserWeb()
Returns username for a web script
public getDatabaseUserScript()
Returns username for a CLI script
public getDatabaseUserDaemon()
Returns username for a daemon process
public getDatabasePassword()
Returns the system default database password
public getDatabase($inDatabase)
Returns the configured database name for the friendly name
public getDatabaseDefault()
Returns a default database to connect to
public getDatabaseDatetimeFormat()
Returns the date() string format for the databases datetime field
public getDatabaseDateFormat()
Returns the date() string format for the databases date field
public getDatabaseTimeFormat()
Returns the date() string format for the databases time field
public getPathLibraries()
Returns the path to the libraries
public getPathApps()
Returns the path to the apps
public getPathData()
Returns the path to the data folder
public getPathDaemons()
Returns the path to the daemons
public getPathLogs()
Returns the path to the logs
public getPathTemp()
Returns the path to the temp
public getPathTemplateTemp()
Returns the path to the smarty temp folders
public getPathTemplateCompile()
Returns the path to the smarty temp compile folders
public getPathTemplateCache()
Returns the path to the smarty temp cache folders
public getPathTools()
Returns the path to the tools
public getPathClasses()
Returns the path to the classes folder (what was plugins) that contains non-core classes
public getPathWebsites()
Returns the path to the websites
public getWurflUriLocation()
Returns the URI location to the master WURFL XML file
public getWurflMaxImportSize()
Returns the maximum allowed file import size, value should be in bytes e.g. 0.5MB = 512000
public getWurflMaxExportSize()
Returns the maximum number of devices that can be exported at any one time
public getMaxImageSizeForPreview()
Returns the maximum allowed size for an image to previewed (in bytes)
public getImagePreviewWidth()
Returns the preview width for image previews
public getImagePreviewHeight()
Returns the preview height for image previews
public getGeneratorDaoTemplate()
Returns the default generator Data Access Object template
public getGeneratorTestCaseTemplate()
Returns the default generator Test Case template
public getGeneratorUserTemplatePath()
Returns the path to user generated templates for generator
public getMvcGeneratorUserTemplatePath()
Returns the path to user generated templates for mvcGenerator
Inherited Methods
- systemConfigBase::reset()
- systemConfigBase::load()
- systemConfigBase::save()
- systemConfigBase::addSection()
- systemConfigBase::getSection()
- systemConfigBase::getParam()
- systemConfigBase::setBasePath()
- systemConfigBase::getBasePath()
- systemConfigBase::getConfigParams()
- systemConfigBase::setConfigParams()
- systemConfigBase::getLastConfigFile()
- systemConfigBase::setLastConfigFile()
- systemConfigBase::getModified()
- systemConfigBase::_convertToBoolean()
- baseSet::isModified()
- baseSet::setModified()
- baseSet::count()
- baseSet::getCount()
- baseSet::_getItem()
- baseSet::_setItem()
- baseSet::_setValue()
- baseSet::_removeItem()
- baseSet::_removeItemWithValue()
- baseSet::_resetSet()
- baseSet::_findItem()
- baseSet::_itemKeyExists()
- baseSet::_itemValueInSet()
- baseSet::_itemCount()
- baseSet::_mergeSets()
- baseSet::_reverseSet()
- baseSet::getIterator()
- IteratorAggregate::getIterator()
- Countable::count()
Posted by: Scorpio Documentor (Writer), in System on 19 Nov 2009 @ 20:31
Tags: countable, iteratoraggregate, system, systemconfig, systemconfigbase, traversable,
This
work is licenced under a
Creative Commons Licence.