SetupService
Read onlyYes
Service class helping to manage parts of the setup process (set configuration, create backend user, create a basic site, create default backend groups, etc.)
This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.
Table of Contents
Methods
- __construct() : mixed
- createBackendUserGroups() : void
- Initializes backend user group presets. Currently hard-coded to editor and advanced editor.
- createSite() : string
- createSiteConfiguration() : void
- Creates a site configuration with one language "English" which is the de-facto default language for TYPO3 in general.
- createUser() : void
- Create a backend user with maintainer and admin flag set by default, because the initial user always requires these flags to grant full permissions to the system.
- prepareSystemSettings() : void
- setInstallToolPassword() : bool
- setSiteName() : bool
Methods
__construct()
public
__construct(ConfigurationManager $configurationManager, SiteWriter $siteWriter, YamlFileLoader $yamlFileLoader) : mixed
Parameters
- $configurationManager : ConfigurationManager
- $siteWriter : SiteWriter
- $yamlFileLoader : YamlFileLoader
createBackendUserGroups()
Initializes backend user group presets. Currently hard-coded to editor and advanced editor.
public
createBackendUserGroups([bool $createEditor = true ][, bool $createAdvancedEditor = true ]) : void
When more backend user group presets are added, please refactor (maybe DTO).
Parameters
- $createEditor : bool = true
- $createAdvancedEditor : bool = true
createSite()
public
createSite() : string
Return values
stringcreateSiteConfiguration()
Creates a site configuration with one language "English" which is the de-facto default language for TYPO3 in general.
public
createSiteConfiguration(string $identifier, int $rootPageId, string $siteUrl) : void
Parameters
- $identifier : string
- $rootPageId : int
- $siteUrl : string
Tags
createUser()
Create a backend user with maintainer and admin flag set by default, because the initial user always requires these flags to grant full permissions to the system.
public
createUser(string $username, string $password[, string $email = '' ]) : void
Parameters
- $username : string
- $password : string
- $email : string = ''
prepareSystemSettings()
public
prepareSystemSettings([bool $forceOverwrite = false ]) : void
Parameters
- $forceOverwrite : bool = false
Tags
setInstallToolPassword()
public
setInstallToolPassword(string $password) : bool
Parameters
- $password : string
Return values
boolsetSiteName()
public
setSiteName(string $name) : bool
Parameters
- $name : string