Attention

TYPO3 v9 has reached its end-of-life September 30th, 2021 and is not maintained by the community anymore. Looking for a stable version? Use the version switch on the top left.

You can order Extended Long Term Support (ELTS) here: TYPO3 ELTS.

TCEMAIN¶

Configuration for the TYPO3 Core Engine (DataHandler). For general information, see the according section of the TYPO3 Core API document.

clearCacheCmd¶

Datatype

List of integers, all, pages or tags

Description

This allows you to have the frontend cache for additional pages cleared when saving to some page or branch of the page tree.

It it possible to trigger clearing of all caches or just the pages cache. It is also possible to target precise pages either by referring to their ID numbers or to tags that are attached to them.

Attaching tags to page cache is described in the TypoScript Reference.

Examples

TCEMAIN {
    # Clear the cache for page uid 12 and 23 when saving a record in this page
    clearCacheCmd = 12, 23
    # Clear all frontent page caches of pages
    clearCacheCmd = pages
    # Clear ALL caches
    clearCacheCmd = all
    # Clear cache for all pages tagged with tag "pagetag1"
    clearCacheCmd = cacheTag:pagetag1
}

Note

In order for the pages and all commands to work for non-admin users, make sure to set options.clearCache.pages = 1 or options.clearCache.all = 1 accordingly in the user TSconfig.

clearCache_disable¶

Datatype: boolean
Description: If set, then the automatic clearing of page cache when records are edited etc. is disabled. This also disables the significance of the two options clearCache_pageSiblingChildren and clearCache_pageGrandParent

clearCache_pageGrandParent¶

Datatype: boolean
Description: If set, then the grand parent of a page being edited will have the page cache cleared.

clearCache_pageSiblingChildren¶

Datatype

boolean

Description

If set, then children of all siblings of a page being edited will have the page cache cleared.

Default is that when a page record is edited, the cache for itself, the parent, and siblings (same level) is cleared.

disableHideAtCopy¶

Datatype

boolean

Description

Disables the hideAtCopy TCA feature if configured for the table.

Example

TCEMAIN.table.pages {
   # Pages will *not* have "(copy)" appended:
   disablePrependAtCopy = 1
   # Pages will *not* be hidden upon copy:
   disableHideAtCopy = 1
}

These settings adjust that a page which is copied will neither have "(copy X)" appended nor be hidden.

The last page in this tree, labeled "Test", is used as original to be copied. The first sub page was copied using the settings from the above example: It is labeled "Test" and is visible exactly like the original page. The page "Test (copy 2)" in the middle was in contrast copied in default mode: The page is hidden and the "(copy X)" suffix is added, if another page with the same named existed already.

Hidden page with added suffix after copying its original page¶

disablePrependAtCopy¶

Datatype

boolean

Description

Disable the prependAtCopy TCA feature if configured for the table.

The word "prepend" is misleading. The "(copy)" label is actually appended to the record title.

Example

TCEMAIN.table.pages {
   # Pages will *not* have "(copy)" appended:
   disablePrependAtCopy = 1
   # Pages will *not* be hidden upon copy:
   disableHideAtCopy = 1
}

These settings adjust that a page which is copied will neither have "(copy X)" appended nor be hidden.

The last page in this tree, labeled "Test", is used as original to be copied. The first sub page was copied using the settings from the above example: It is labeled "Test" and is visible exactly like the original page. The page "Test (copy 2)" in the middle was in contrast copied in default mode: The page is hidden and the "(copy X)" suffix is added, if another page with the same named existed already.

Hidden page with added suffix after copying its original page¶

permissions¶

everybody¶

Datatype

list of strings or integer 0-31

Description

Default permissions for everybody who is not the owner user or member of the owning group, key list: show, edit, delete, new, editcontent

Alternatively, it is allowed to set an integer between 0 and 31, indicating which bits corresponding to the key list should be set: show = 1, edit = 2, delete = 4, new = 8, editcontent = 16

Default

0

Example

TCEMAIN.permissions {
    # Everybody can at least see the page, normally everybody can do nothing
    everybody = show
}

The page "Community" was created with the settings from the example above. Compared to the two other pages created with default permissions you can see the effect: "Everybody" has read access:

Page with altered permissions for backend users, groups and everybody¶

group¶

Datatype

list of strings or integer 0-31

Description

Default permissions for group members, key list: show, edit, delete, new, editcontent

Alternatively, it is allowed to set an integer between 0 and 31, indicating which bits corresponding to the key list should be set: show = 1, edit = 2, delete = 4, new = 8, editcontent = 16

Default

show,edit,new,editcontent

Example

TCEMAIN.permissions {
    # Group can do anything, normally "delete" is disabled
    group = 31
}

The page "Community" was created with the settings from the example above. Compared to the two other pages created with default permissions you can see the effect: The Backend Group can now also delete the page by default:

Page with altered permissions for backend users, groups and everybody¶

groupid¶

Datatype

positive integer

Description

Hard code the default group of new and copied pages: The default user group is the "main group" of the backend user - the group in the very top of the users group-list. This setting allows to override this default and set a specific group uid.

Example

TCEMAIN {
    # Owner be_groups UID for new pages
    permissions.groupid = 3
}

In this instance, backend group with UID 3 is "test_group". With the configuration above a new page would be created with this group setting instead of the default, even if a user who is not member of that group creates the page:

Page with altered permissions for backend groups¶

user¶

Datatype

list of strings or integer 0-31

Description

Default permissions for owner user, key list: show, edit, delete, new, editcontent

Alternatively, it is allowed to set an integer between 0 and 31, indicating which bits corresponding to the key list should be set: show = 1, edit = 2, delete = 4, new = 8, editcontent = 16

Default

show,edit,delete,new,editcontent

Example

TCEMAIN.permissions {
    # User can do anything, this is identical to the default value
    user = 31
}

userid¶

Datatype

positive integer

Description

Hard code the default owner of new and copied pages: The default owner is usually the user that creates / copies the page, this setting allows to override this.

Example

TCEMAIN {
    # Owner be_users UID for new pages
    permissions.userid = 2
}

In this instance, backend user with UID 2 is "test". With the configuration above a new page would be created with this owner setting instead of the default, even if another user creates the page:

Page with altered permissions for backend users¶

preview¶

Datatype

array

Description

Configure preview link generated for the save+view button and other frontend view related buttons in the backend. This allows to have different preview URLs depending on the record type. A common use case is to have previews for blog or news records, and this feature allows you to define a different preview page for content elements as well, which might be handy if those are stored in a sysfolder.

TCEMAIN.preview {
    <table name> {
        previewPageId = 123
        disableButtonForDokType = 199, 254, 255
        useDefaultLanguageRecord = 0
        fieldToParameterMap {
            uid = tx_myext_pi1[showUid]
        }
        additionalGetParameters {
            tx_myext_pi1.special = HELLO # results in tx_myext_pi1[special]
        }
        useCacheHash = 1
    }
}

The previewPageId is the uid of the page to use for preview. If this setting is omitted the current page will be used. If the current page is not a normal page, the root page will be chosen.

The disableButtonForDokType setting allows you to disable the preview button for a given list of doktypes. If none are configured, this defaults to: 199, 254, 255 (Spacer, Folder and Recycler).

The useDefaultLanguageRecord defaults to 1 and ensures that translated records will use the uid of the default record for the preview link. You may disable this, if your extension can deal with the uid of translated records.

The fieldToParameterMap is a mapping which allows you to select fields of the record to be included as GET-parameters in the preview link. The key specifies the field name and the value specifies the GET-parameter name.

Finally additionalGetParameters allow you to add arbitrary GET-parameters and even override others.

The core automatically sets the "no_cache" and the "L" parameter. The language matches the language of the current record. You may override each parameter by using the additionalGetParameters configuration option.

Enable useCacheHash to add a cHash. This is essential for records displayed using Extbase which enforces cHash usage. If useCacheHash = 1 is not set, the no_cache parameter will be added just like before.

Note

Make sure not to set options.saveDocView.<table name> = 0, otherwise the save+view button will not be displayed when editing records of your table.

previewDomain¶

Datatype

string

Description

Defines a preview domain used for frontend previews triggered from the backend, for instance the "Save and View" button. The value must be a valid domain, optionally prefixed by a schema.

If the option is not specified, the first available domain record within the current rootline is used. If there is no domain record either, the current domain (and schema) used for the backend will be chosen.

Example

TCEMAIN.previewDomain = example.localhost
TCEMAIN.previewDomain = http://example.localhost
TCEMAIN.previewDomain = https://example.org

table¶

Processing options for tables. The table name is added, for instance TCEMAIN.table.pages.disablePrependAtCopy = 1 or TCEMAIN.table.tt_content.disablePrependAtCopy = 1.

translateToMessage¶

Datatype

string

Description

Defines the string that will be prepended to every field value if you copy an element to another language version. The special string "%s" will be replaced with the language title.

Default is Translate to [language title]:.

Example

TCEMAIN {
    # Set a German label
    translateToMessage = Bitte in "%s" übersetzen:
}