Environment.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Core;
 
use Composer\InstalledVersions;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
class ‪Environment
{
    protected static ‪$supportedCgiServerApis = [
        'fpm-fcgi',
        'cgi',
        'isapi',
        'cgi-fcgi',
        'srv', // HHVM with fastcgi
    ];
 
    protected static ‪$cli;
 
    protected static ‪$composerMode;
 
    protected static ‪$context;
 
    protected static ‪$projectPath;
 
    protected static ‪$composerRootPath;
 
    protected static ‪$publicPath;
 
    protected static ‪$currentScript;
 
    protected static ‪$os;
 
    protected static ‪$varPath;
 
    protected static ‪$configPath;
 
    public static function ‪initialize(
        ‪ApplicationContext ‪$context,
        bool ‪$cli,
        bool ‪$composerMode,
        string ‪$projectPath,
        string ‪$publicPath,
        string ‪$varPath,
        string ‪$configPath,
        string ‪$currentScript,
        string ‪$os
    ) {
        self::$cli = ‪$cli;
        self::$composerMode = ‪$composerMode;
        self::$context = ‪$context;
        self::$projectPath = ‪$projectPath;
        self::$composerRootPath = ‪$composerMode ? ‪PathUtility::getCanonicalPath(InstalledVersions::getRootPackage()['install_path']) : '';
        self::$publicPath = ‪$publicPath;
        self::$varPath = ‪$varPath;
        self::$configPath = ‪$configPath;
        self::$currentScript = ‪$currentScript;
        self::$os = ‪$os;
    }
 
    public static function ‪getContext(): ‪ApplicationContext
    {
        return ‪self::$context;
    }
 
    public static function ‪isComposerMode(): bool
    {
        return ‪self::$composerMode;
    }
 
    public static function ‪isCli(): bool
    {
        return ‪self::$cli;
    }
 
    public static function ‪getProjectPath(): string
    {
        return ‪self::$projectPath;
    }
 
    public static function ‪getComposerRootPath(): string
    {
        if (self::$composerMode === false) {
            throw new \BadMethodCallException('Composer root path is only available in Composer mode', 1631700480);
        }
 
        return ‪self::$composerRootPath;
    }
 
    public static function ‪getPublicPath(): string
    {
        return ‪self::$publicPath;
    }
 
    public static function ‪getVarPath(): string
    {
        return ‪self::$varPath;
    }
 
    public static function ‪getConfigPath(): string
    {
        return ‪self::$configPath;
    }
 
    public static function ‪getCurrentScript(): string
    {
        return ‪self::$currentScript;
    }
 
    public static function ‪getLabelsPath(): string
    {
        if (self::$publicPath === self::$projectPath) {
            return ‪self::getPublicPath() . '/typo3conf/l10n';
        }
        return ‪self::getVarPath() . '/labels';
    }
 
    public static function ‪getFrameworkBasePath(): string
    {
        return ‪self::getPublicPath() . '/typo3/sysext';
    }
 
    public static function ‪getExtensionsPath(): string
    {
        return ‪self::getPublicPath() . '/typo3conf/ext';
    }
 
    public static function ‪getLegacyConfigPath(): string
    {
        return ‪self::getPublicPath() . '/typo3conf';
    }
 
    public static function ‪isWindows(): bool
    {
        return self::$os === 'WINDOWS';
    }
 
    public static function ‪isUnix(): bool
    {
        return self::$os === 'UNIX';
    }
 
    public static function ‪isRunningOnCgiServer(): bool
    {
        return in_array(PHP_SAPI, self::$supportedCgiServerApis, true);
    }
 
    public static function ‪usesCgiFixPathInfo(): bool
    {
        return !empty(ini_get('cgi.fix_pathinfo'));
    }
 
    public static function ‪toArray(): array
    {
        return [
            'context' => (string)self::getContext(),
            'cli' => ‪self::isCli(),
            'projectPath' => ‪self::getProjectPath(),
            'publicPath' => ‪self::getPublicPath(),
            'varPath' => ‪self::getVarPath(),
            'configPath' => ‪self::getConfigPath(),
            'currentScript' => ‪self::getCurrentScript(),
            'os' => ‪self::isWindows() ? 'WINDOWS' : 'UNIX',
        ];
    }
}