Constants¶
Constants normally define paths and database information. These values are global and cannot be changed when they are first defined. This is why constants are used for such vital information.
These constants are defined at various points during the bootstrap sequence.
Note
To make the table below a bit more compact, namespaces were left out. Here are the fully qualified class names referred to below:
- “SystemEnvironmentBuilder” =
\TYPO3\CMS\Core\Core\SystemEnvironmentBuilder
- “Bootstrap” =
\TYPO3\CMS\Core\Core\Bootstrap
Table 1: Traditional List¶
Constant | Defined in | Description | Avail. in FE |
---|---|---|---|
TYPO3_MODE | init.php | Mode of TYPO3: Set to either “FE” or “BE” depending on frontend or
backend execution. So in init.php and thumbs.php this value is
“BE”. |
Yes value = “FE” |
TYPO3_OS | SystemEnvironmentBuilder::getTypo3Os() | Operating systen; Windows = “WIN”, other = “” (presumed to be some sort of Unix) | Yes |
PATH_thisScript | SystemEnvironmentBuilder::definePaths() | Abs. path to current script. | Yes |
TYPO3_mainDir | SystemEnvironmentBuilder::definePaths() | This is the directory of the backend administration for the sites of
this TYPO3 installation. Hardcoded to typo3/ . Must be a subdirectory
to the website. See elsewhere for descriptions on how to change the
default admin directory, typo3/ , to something else. |
Yes |
PATH_typo3 | SystemEnvironmentBuilder::definePaths() | Abs. path of the TYPO3 admin dir (PATH_site + TYPO3_mainDir ). |
No |
PATH_typo3_mod | SystemEnvironmentBuilder::definePaths() | Relative path (from the PATH_typo3 ) to a properly configured module. |
No |
PATH_site | SystemEnvironmentBuilder::definePaths() | Absolute path to directory with the frontend (one directory above
PATH_typo3 ) |
Yes |
PATH_typo3conf | SystemEnvironmentBuilder::definePaths() | Absolute TYPO3 configuration path (local, not part of source). | Yes |
TYPO3_db | Bootstrap::populateLocalConfiguration() | Name of the database, for example “t3_coreinstall”. Is defined after
the inclusion of typo3conf/LocalConfiguration.php (same for the other
TYPO3_* constants below. |
Yes |
TYPO3_db_username | Bootstrap::populateLocalConfiguration() | Database username | Yes |
TYPO3_db_password | Bootstrap::populateLocalConfiguration() | Database password | Yes |
TYPO3_db_host | Bootstrap::populateLocalConfiguration() | Database hostname, e.g. “localhost” | Yes |
TYPO3_extTableDef_script | Bootstrap::populateLocalConfiguration() | Name of a php-include script found in “typo3conf/” that contains PHP code that further modifies the table definitions set by the TYPO3 CMS Core. Deprecated. Make Extensions instead. |
Yes |
TYPO3_DLOG | Bootstrap::defineLoggingAndExceptionConstants() | If true, calls to \TYPO3\CMS\Core\Utility\GeneralUtility::devLog() can be made in both frontend
and backend; This is event logging which can help to track debugging
in general. |
Yes |
TYPO3_MOD_PATH | [prior to init.php] | Path to module relative to PATH_typo3 (as defined in the module
configuration). Must be defined prior to init.php . |
|
TYPO3_enterInstallScript | [prior to init.php] | If defined and set true the Install Tool is activated and the script
exits after that. Used in Example: define('TYPO3_enterInstallScript', '1');
|
No |
TYPO3_PROCEED_IF_NO_USER | [prior to init.php] | If defined and set true the bootstrapping process will return to the parent script even if no backend user was authenticated! For example, this constant is set by the define('TYPO3_PROCEED_IF_NO_USER', 1);
require ('init.php');
Please be very careful with this feature - use it only when you have total control of what you are doing! |
No |
TYPO3_cliMode | [prior to init.php] | Initiates CLI (Command Line Interface) mode. This is used when you want a shell executable PHP script to initialize a TYPO3 backend. For more details see Initializing TYPO3 backend in a PHP shell script in Inside TYPO3. |
No |
TYPO3_version | SystemEnvironmentBuilder::defineBaseConstants() | The TYPO3 version, as a “x.y.z” number. Development versions will be either “x.y.z-dev” for stable versions or “x.y-dev” for the current master. | Yes |
TYPO3_branch | SystemEnvironmentBuilder::defineBaseConstants() | The TYPO3 version Branch, as a “x.y” number. Without the patch level. | Yes |
Table 2: Base Constants¶
Check \TYPO3\CMS\Core\Core\SystemEnvironmentBuilder::defineBaseConstants
for updates.
This version, branch and copyright¶
Constant | Example value |
---|---|
TYPO3_version | ‘7.6.1-dev’ |
TYPO3_branch | ‘7.6’ |
TYPO3_copyright_year | ‘1998-2015’ |
TYPO3 external links¶
Constant | Example value |
---|---|
TYPO3_URL_GENERAL | ‘https://typo3.org/’ |
TYPO3_URL_LICENSE | ‘https://typo3.org/typo3-cms/overview/licenses/’ |
TYPO3_URL_EXCEPTION | ‘https://typo3.org/go/exception/CMS/’ |
TYPO3_URL_MAILINGLISTS | ‘https://lists.typo3.org/cgi-bin/mailman/listinfo’ |
TYPO3_URL_DOCUMENTATION | ‘https://typo3.org/documentation/’ |
TYPO3_URL_DOCUMENTATION_TSREF | ‘https://docs.typo3.org/typo3cms/TyposcriptReference/’ |
TYPO3_URL_DOCUMENTATION_TSCONFIG | ‘https://docs.typo3.org/typo3cms/TSconfigReference/’ |
TYPO3_URL_CONSULTANCY | ‘https://typo3.org/support/professional-services/’ |
TYPO3_URL_CONTRIBUTE | ‘https://typo3.org/contribute/’ |
TYPO3_URL_SECURITY | ‘https://typo3.org/teams/security/’ |
TYPO3_URL_DOWNLOAD | ‘https://typo3.org/download/’ |
TYPO3_URL_SYSTEMREQUIREMENTS | ‘https://typo3.org/typo3-cms/overview/requirements/’ |
TYPO3_URL_DONATE | ‘https://typo3.org/donate/online-donation/’ |
TYPO3_URL_WIKI_OPCODECACHE | ‘ Note The TYPO3 Wiki instance has been retired since 2021. |
String constants¶
Constant | Value | Description |
---|---|---|
NUL | chr(0) | A null |
TAB | chr(9) | A tabulator |
LF | chr(10) | A linefeed |
CR | chr(13) | A carriage return |
SUB | chr(26) | A sub (substitute) character |
CRLF | CR + LF | Carriage return + linefeed pair |
Operating system identifier¶
Constant | Value | Description |
---|---|---|
TYPO3_OS | self::getTypo3Os()) | Either “WIN” or empty string |
Service error constants¶
Constant | Value | Description |
---|---|---|
T3_ERR_SV_GENERAL | -1 | General error - something went wrong |
T3_ERR_SV_NOT_AVAIL | -2 | During execution it showed that the service is not available and should be ignored. The service itself should call $this->setNonAvailable() |
T3_ERR_SV_WRONG_SUBTYPE | -3 | Passed subtype is not possible with this service |
T3_ERR_SV_NO_INPUT | -4 | Passed subtype is not possible with this service |
T3_ERR_SV_FILE_NOT_FOUND | -20 | File not found which the service should process |
T3_ERR_SV_FILE_READ | -21 | File not readable |
T3_ERR_SV_FILE_WRITE | -22 | File not writable |
T3_ERR_SV_PROG_NOT_FOUND | -40 | Passed subtype is not possible with this service |
T3_ERR_SV_PROG_FAILED | -41 | Passed subtype is not possible with this service |