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

__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?

$this;
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.

boolean
isPrivacyPolicyAccepted()

Returns whether privacy policy is accepted

setPrivacyPolicyAccepted(boolean $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.

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).

Details

__construct(Filesystem $filesystem)

Initializes the instance.

Parameters

Filesystem $filesystem

bool isAutoAttachEnabled()

If the database already exists and is valid, lets just attach to it rather than installing over it?

Return Value

bool

$this; setAutoAttachEnabled(bool $value)

If the database already exists and is valid, lets just attach to it rather than installing over it?

Parameters

bool $value

Return Value

$this;

array getConfiguration()

Get the installation configuration options (persisted as /application/config/site_install.php).

Return Value

array

$this setConfiguration(array $value)

Set the installation configuration options (persisted as /application/config/site_install.php).

Parameters

array $value

Return Value

$this

string getUserEmail()

Get the admin user email.

Return Value

string

$this setUserEmail(string $value)

Set the admin user email.

Parameters

string $value

Return Value

$this

string getUserPasswordHash()

Get the admin password hash.

Return Value

string

$this setUserPasswordHash(string $value)

Set the admin password hash.

Parameters

string $value

Return Value

$this

boolean isPrivacyPolicyAccepted()

Returns whether privacy policy is accepted

Return Value

boolean

setPrivacyPolicyAccepted(boolean $privacyPolicyAccepted)

Set the privacy policy status

Parameters

boolean $privacyPolicyAccepted

string getStartingPointHandle()

Get the handle of the starting point.

Return Value

string

$this setStartingPointHandle(string $value)

Set the handle of the starting point.

Parameters

string $value

Return Value

$this

string getSiteName()

Get the name of the site.

Return Value

string

$this setSiteName(string $value)

Get the name of the site.

Parameters

string $value

Return Value

$this

string getSiteLocaleId()

Get the identifier of the site locale.

Return Value

string

$this setSiteLocaleId(string $value)

Set the identifier of the site locale.

Parameters

string $value

Return Value

$this

string getUiLocaleId()

Get the identifier of the UI locale.

Return Value

string

$this setUiLocaleId(string $value)

Set the identifier of the UI locale.

Parameters

string $value

Return Value

$this

string getServerTimeZoneId()

Get the server time zone identifier.

Return Value

string

$this setServerTimeZoneId(string $value)

Set the server time zone identifier.

Parameters

string $value

Return Value

$this

DateTimeZone getServerTimeZone(bool $fallbackToDefault)

Get the server time zone instance.

Parameters

bool $fallbackToDefault Fallback to the default one if the time zone is not defined?

Return Value

DateTimeZone

Exceptions

UserMessageException

bool hasConfigurationFiles()

Do the configuration files exist?

Return Value

bool

load()

Load the configuration options from file.

save()

Save the configuration options to file.

deleteFiles()

Delete the configuration files (if they exist).