Project

General

Profile

Feature #17885 » db_new_cleanup_v1_(doc_core_api).txt

Administrator Admin, 2007-12-05 00:12

 

###################################################################################
#
# $TCA array reference -> Reference for the ['ctrl'] section:
#
# *** Modify Key ***
#

Key:
hideTable

Description:

Hide this table in record-listings and in record-new-listings.
This value can be overwritten by the equal key of "TSconfig -> MOD -> Web>List (mod.web_list)"

Note: It also affects the newWizards-array.

###################################################################################
#
# $TCA array reference -> Reference for the ['ctrl'] section:
#
# *** New Key ***
#

Key:
hideNewTable

Description:

Hide this table in new-record-listings.

Note: It does not affect the newWizards-array.

###################################################################################
#
# $TCA array reference -> Reference for the ['ctrl'] section:
#
# *** New Key ***
#

Key:
hideNewTable

Datatype:
boolean

Description:
Hide this table in new-record-listings.

Note: It does not affect the newWizards-array.

###################################################################################
#
# $TCA array reference -> Reference for the ['ctrl'] section:
#
# *** New Key ***
#

Key:
disableNewTable

Datatype:
boolean

Description:
Instead of the new-record-listing default-item, the first item of the newWizards-array is taken.
This item must have 'path' = disabled and 'level = 1, otherwise the whole table is ignored.


###################################################################################
#
# $TCA array reference
#
# *** New Section/Chapter ***
#

Title:
['newWizards'] section

The "newWizards" section contains properties related to the new-record-listing.

It is possible to add wizards like the page-wizard or the content-wizard.
You can also group tables of an extension, so the list gets more readable.

The new-record-listing has three levels:
* 0: current page & 'page after'
* 1: default for new-record of table
* 2: default for wizard

The newWizards can be affected by some key of the TCA-ctrl.

This table showns the keys of the ['newWizard'][id] array:

Table
* Key:
* Datatype:
* Default:
* Description:

Key:type
Datatype:string
Default: "wizard"
Description:
The type defines how and what one entry is displayed.

Following types are possible:

* "wizard"
You can link to any script with some parameters and a label.
* "disabled"
You can display a label as an entry.
* "table"
You can create a a entry like the default one
* "pageafter"
Only need for the 'Page after' entry.


Key:icon
Datatype:string
Default:
Description:
Pointing to the icon file to use for the entry.

Icons should be dimensioned 18x16 pixels (the last two right-most pixel columns in the width should preferably be empty) and of the GIF or PNG file type.

The value of the option can be any of these:

1. If there is a slash ( / ) in the value: It must be a relative filepath pointing to the icon file relative to the typo3/ (admin) folder. You may start that path with '../' if you like to get your icon from a folder in the PATH_site path.
For extensions, see example below.
2. If there is just a filename: It must exist in the "typo3/gfx/i/" folder.
3. If no icon is set, the icon of the table is used. So you do not need it for the type "table" and "pageafter"

Example: How to assign an icon from an extension
"icon" => t3lib_extMgm::extRelPath($_EXTKEY)."tt_news.gif",
Key:label
Datatype:string (LS)
Default:
Description:
The label for the wizard.
The default value is the label of the table.


Key:level
Datatype:integer
Default: type "pageafter": 0,else: 2,
Description:
Level in for displaying in the tree.

0: current page & 'page after'
1: default for new-record of table
2: default for wizard etc.

If you set a wizard to level 1, all wizards after this one will be added to this entry.

Note: You cannot change this value for the type "pageafter"


Key:path
Datatype:string
Default:
Description:
Only needed for the type "wizard".

Reference to the wizard-script.

Example of the tt_content:

$TCA['tt_content']['newWizards'] => array(
0 => array(
'label' => 'LLL:EXT:lang/locallang_misc.xml:clickForWizard',
'icon' => 'gfx/new_record.gif',
'path' => t3lib_extMgm::extRelPath($_EXTKEY).'layout/db_new_content_el.php',
),
),

Note: If you set this key to 'self', the document calls it self. It is only needed for 'pages'-table.

Key:parameter
Datatype:array
Default:empty
Description:
Only usable for the type "wizard"

You can add some get-parameter to the url to set some parameters.
'id' is set to the current-page-id.
'returnUrl' is set to the current url.
Both values cannot be changed.

Example of the pages-table:
$TCA['tt_content']['newWizards'] => array(
0 => array(
'label' => 'LLL:EXT:lang/locallang_misc.xml:clickForWizard',
'icon' => 'gfx/new_page.gif',
'path' => 'self',
'parameter' => array(
'pagesOnly' => '1'
),
)

Note: If you set this key to 'self', the document calls it self. It is only needed for 'pages'-table.


Key:table
Datatype:string
Default:"this table"
Description:
Only useable for the type "table". Displaying a new-record-entry like the default entry.

(2-2/3)