EmailConfigurationProvider
in package
Class EmailConfigurationProvider
Table of Contents
- $db : CI_DB_query_builder
- $keyField : string
- $table : string
- $valueField : string
- __construct() : mixed
- EmailConfigurationProvider constructor.
- auth() : string
- Returns the smtp auth configuration value.
- backupServer() : string
- Returns the smtp backup server configuration value.
- charset() : string
- Returns the charset configuration value for emails.
- emailTransport() : string
- Returns the email transport configuration value.
- encryption() : string
- Returns the smtp encryption configuration value.
- languageCode() : string
- Returns the language code configuration value.
- mainServer() : string
- Returns the smtp main server configuration value.
- password() : string
- Returns the smtp password configuration value.
- port() : string
- Returns the smtp port configuration value.
- sendMailPath() : string
- Returns the send mail path configuration value.
- useHtmlMail() : bool
- Returns true if html emails should be used.
- user() : string
- Returns the smtp user configuration value.
- _getEmailConfig() : string
- Returns the email configuration value for the given key.
- defaultLanguage() : string
- Returns the default language configuration value.
Properties
$db
protected
CI_DB_query_builder
$db
$keyField
protected
string
$keyField
= 'key'
$table
protected
string
$table
= 'gx_configurations'
$valueField
protected
string
$valueField
= 'value'
Methods
__construct()
EmailConfigurationProvider constructor.
public
__construct(CI_DB_query_builder $db) : mixed
Parameters
- $db : CI_DB_query_builder
Return values
mixed —auth()
Returns the smtp auth configuration value.
public
auth() : string
Return values
string —Configuration value of emails smtp auth.
backupServer()
Returns the smtp backup server configuration value.
public
backupServer() : string
Return values
string —Configuration value of emails smtp backup server.
charset()
Returns the charset configuration value for emails.
public
charset() : string
$_SESSION['language_charset'] will be used if it is set. If not, the charset of the default shop language is taken.
Return values
string —emailTransport()
Returns the email transport configuration value.
public
emailTransport() : string
Return values
string —Configuration value of email transport.
encryption()
Returns the smtp encryption configuration value.
public
encryption() : string
Return values
string —Configuration value of emails smtp encryption.
languageCode()
Returns the language code configuration value.
public
languageCode() : string
The code is 'de', if $_SESSION['language'] is equal to 'german'. Any other case will return en.
Return values
string —mainServer()
Returns the smtp main server configuration value.
public
mainServer() : string
Return values
string —Configuration value of emails smtp main server.
password()
Returns the smtp password configuration value.
public
password() : string
Return values
string —Configuration value of emails smtp password.
port()
Returns the smtp port configuration value.
public
port() : string
Return values
string —Configuration value of emails smtp port.
sendMailPath()
Returns the send mail path configuration value.
public
sendMailPath() : string
Return values
string —Configuration value of send mail path.
useHtmlMail()
Returns true if html emails should be used.
public
useHtmlMail() : bool
The configuration value will be read from configuration table.
Return values
bool —user()
Returns the smtp user configuration value.
public
user() : string
Return values
string —Configuration value of emails smtp username.
_getEmailConfig()
Returns the email configuration value for the given key.
private
_getEmailConfig(string $key) : string
The configuration value will be read from the configurations table.
Parameters
- $key : string
-
Key of expected configuration value.
Return values
string —Configuration value of given key.
defaultLanguage()
Returns the default language configuration value.
private
defaultLanguage() : string
Return values
string —Configuration value of default language.