InstallerOptions
class InstallerOptions (View source)
Properties
| protected Filesystem | $filesystem | The Filesystem instance to use. |
|
| protected bool | $autoAttachEnabled | If the database already exists and is valid, lets just attach to it rather than installing over it? |
|
| protected bool | $privacyPolicyAccepted | Whether the user has accepted the privacy policy from the front-end installation |
|
| protected array | $configuration | The installation configuration options (persisted as /application/config/site_install.php). |
|
| protected string | $userEmail | The admin user email. |
|
| protected string | $userPasswordHash | The admin password hash. |
|
| protected string | $startingPointHandle | The handle of the starting point. |
|
| protected string | $siteName | The name of the site. |
|
| protected string | $siteLocaleId | The identifier of the site locale. |
|
| protected string | $uiLocaleId | The identifier of the UI locale. |
|
| protected string | $serverTimeZoneId | The server time zone identifier. |
Methods
Initializes the instance.
If the database already exists and is valid, lets just attach to it rather than installing over it?
If the database already exists and is valid, lets just attach to it rather than installing over it?
Get the installation configuration options (persisted as /application/config/site_install.php).
Set the installation configuration options (persisted as /application/config/site_install.php).
Get the admin user email.
Set the admin user email.
Get the admin password hash.
Set the admin password hash.
Returns whether privacy policy is accepted
Set the privacy policy status
Get the handle of the starting point.
Set the handle of the starting point.
Get the name of the site.
Get the name of the site.
Get the identifier of the site locale.
Set the identifier of the site locale.
Get the identifier of the UI locale.
Set the identifier of the UI locale.
Get the server time zone identifier.
Set the server time zone identifier.
Get the server time zone instance.
Do the configuration files exist?
Load the configuration options from file.
Save the configuration options to file.
Delete the configuration files (if they exist).
Details
__construct(Filesystem $filesystem)
Initializes the instance.
bool
isAutoAttachEnabled()
If the database already exists and is valid, lets just attach to it rather than installing over it?
setAutoAttachEnabled(bool $value)
If the database already exists and is valid, lets just attach to it rather than installing over it?
array
getConfiguration()
Get the installation configuration options (persisted as /application/config/site_install.php).
$this
setConfiguration(array $value)
Set the installation configuration options (persisted as /application/config/site_install.php).
string
getUserEmail()
Get the admin user email.
$this
setUserEmail(string $value)
Set the admin user email.
string
getUserPasswordHash()
Get the admin password hash.
$this
setUserPasswordHash(string $value)
Set the admin password hash.
bool
isPrivacyPolicyAccepted()
Returns whether privacy policy is accepted
setPrivacyPolicyAccepted(bool $privacyPolicyAccepted)
Set the privacy policy status
string
getStartingPointHandle()
Get the handle of the starting point.
$this
setStartingPointHandle(string $value)
Set the handle of the starting point.
string
getSiteName()
Get the name of the site.
$this
setSiteName(string $value)
Get the name of the site.
string
getSiteLocaleId()
Get the identifier of the site locale.
$this
setSiteLocaleId(string $value)
Set the identifier of the site locale.
string
getUiLocaleId()
Get the identifier of the UI locale.
$this
setUiLocaleId(string $value)
Set the identifier of the UI locale.
string
getServerTimeZoneId()
Get the server time zone identifier.
$this
setServerTimeZoneId(string $value)
Set the server time zone identifier.
DateTimeZone
getServerTimeZone(bool $fallbackToDefault)
Get the server time zone instance.
bool
hasConfigurationFiles()
Do the configuration files exist?
load()
Load the configuration options from file.
save()
Save the configuration options to file.
deleteFiles()
Delete the configuration files (if they exist).