EnableFileService
Basic Service to check and create install tool files
This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.
Table of Contents
Constants
- FIRST_INSTALL_FILE_PATH = 'FIRST_INSTALL'
- INSTALL_TOOL_ENABLE_FILE_LIFETIME = 3600
- INSTALL_TOOL_ENABLE_FILE_PATH = 'typo3conf/ENABLE_INSTALL_TOOL'
Methods
- checkInstallToolEnableFile() : bool
- Checks if the install tool file exists
- createInstallToolEnableFile() : bool
- Creates the INSTALL_TOOL_ENABLE file
- installToolEnableFileExists() : bool
- Checks if the install tool file exists
- installToolEnableFileLifetimeExpired() : bool
- Checks if the lifetime of the install tool file is expired
- isFirstInstallAllowed() : bool
- isInstallToolEnableFilePermanent() : bool
- Checks if the install tool file should be kept
- removeFirstInstallFile() : bool
- Removes the FIRST_INSTALL file
- removeInstallToolEnableFile() : bool
- Removes the INSTALL_TOOL_ENABLE file
- extendInstallToolEnableFileLifetime() : mixed
- Updates the last modification of the ENABLE_INSTALL_TOOL file
- getFirstInstallFilePaths() : array<string|int, mixed>
- Returns the paths to the FIRST_INSTALL files
- getInstallToolEnableFilePath() : string
- Returns the path to the INSTALL_TOOL_ENABLE file
Constants
FIRST_INSTALL_FILE_PATH
    public
        string
    FIRST_INSTALL_FILE_PATH
    = 'FIRST_INSTALL'
    
        Relative path to FIRST_INSTALL file
INSTALL_TOOL_ENABLE_FILE_LIFETIME
    public
        string
    INSTALL_TOOL_ENABLE_FILE_LIFETIME
    = 3600
    
        Maximum age of ENABLE_INSTALL_TOOL file before it gets removed (in seconds)
INSTALL_TOOL_ENABLE_FILE_PATH
    public
        string
    INSTALL_TOOL_ENABLE_FILE_PATH
    = 'typo3conf/ENABLE_INSTALL_TOOL'
    
        Relative path to ENABLE_INSTALL_TOOL file
Methods
checkInstallToolEnableFile()
Checks if the install tool file exists
    public
            static        checkInstallToolEnableFile() : bool
    Return values
boolcreateInstallToolEnableFile()
Creates the INSTALL_TOOL_ENABLE file
    public
            static        createInstallToolEnableFile() : bool
    Return values
boolinstallToolEnableFileExists()
Checks if the install tool file exists
    public
            static        installToolEnableFileExists() : bool
    Return values
boolinstallToolEnableFileLifetimeExpired()
Checks if the lifetime of the install tool file is expired
    public
            static        installToolEnableFileLifetimeExpired() : bool
    Return values
boolisFirstInstallAllowed()
    public
            static        isFirstInstallAllowed() : bool
    Return values
boolisInstallToolEnableFilePermanent()
Checks if the install tool file should be kept
    public
            static        isInstallToolEnableFilePermanent() : bool
    Return values
boolremoveFirstInstallFile()
Removes the FIRST_INSTALL file
    public
            static        removeFirstInstallFile() : bool
    Return values
boolremoveInstallToolEnableFile()
Removes the INSTALL_TOOL_ENABLE file
    public
            static        removeInstallToolEnableFile() : bool
    Return values
boolextendInstallToolEnableFileLifetime()
Updates the last modification of the ENABLE_INSTALL_TOOL file
    protected
            static        extendInstallToolEnableFileLifetime() : mixed
    getFirstInstallFilePaths()
Returns the paths to the FIRST_INSTALL files
    protected
            static        getFirstInstallFilePaths() : array<string|int, mixed>
    Return values
array<string|int, mixed>getInstallToolEnableFilePath()
Returns the path to the INSTALL_TOOL_ENABLE file
    protected
            static        getInstallToolEnableFilePath() : string