Download the PHP package spooner-web/tcabuilder without Composer

On this page you can find all versions of the php package spooner-web/tcabuilder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of spooner-web/tcabuilder

Informations about the package tcabuilder

The TCA Builder

pipeline status coverage report Latest Version

What does it do?

With the TCA builder you have the possibility to create or change the fields in type list in an easy and speaking way.

Times of semicolons within field names are gone.

For example:

  1. Compose the field list for the form of a content element or any other record
  2. Change the types of existing definitions

Introducing TcaCreator in v1.6.0

With the TCA creator you have the possibility to create TCA forms from scratch and do not need to think about the configuration of the default fields like the ctrl section or the default fields in the columns section.

More to see in the Examples Section

Installation

Installation via composer

composer require spooner-web/tcabuilder

:warning: In a composer install, the package won't be in typo3conf/ext folder but in vendor

Installation via classic mode

  1. Head to https://extensions.typo3.org/extension/tcabuilder
  2. Download the ZIP file
  3. Upload it to your TYPO3 instance using non-composer mode

Installation via Extension Manager

  1. Update your extension list
  2. Search for "tcabuilder"
  3. Install

Composer fails checking out this package

As composer is not able to detect the ZIP archive of a self-hosted GitLab instance, there may occur problems when deploying or building a project with this package.

To fix this issue, you need to add the GitLab built-in packagist API into the repositories section of your project composer.json:

Usage

General usage

Recommendation is to use the TcaBuilder in the php files of your Configuration/TCA/Overrides/ folder of your extension.

  1. Instantiate the TcaBuilder class
  2. Set the table and type to configure (may also be a not existing type yet)
  3. Use the methods to manipulate
  4. Save to the TCA
  5. Flush caches
  6. See result

Methods

Main methods

Method name Description Parameters
setTable Sets the table to load configuration from string $tableName
setType Sets the type to load configuration from string $typeName
load Loads configuration if it's an existing type
loadConfiguration Shorter method to run setTable, setType and load at once string $tableName
string $typeName
useLocalLangFile Set a locallang file (beginning with EXT:) to use in labels string $localLangFile
saveToTca Saves the manipulated configuration to TCA bool $resetAfterSave (optional)
returnAsArray Instead of saving the configuration it returns it directly as array

Manipulating types

Method name Description Parameters
addField Adds a field to selected type string $typeName
string $position (optional)
string $alternativeLabel (optional)
removeField Removes a field from selected type string $fieldName
moveField Moves a field to a new position (alternatively with a new label) string $fieldName
string $newPosition
string $newLabel (optional)
addPalette Adds an existing palette to selected type string $paletteName
string $position (optional)
string $alternativeLabel (optional)
removePalette Removes a palette from selected type string $paletteName
movePalette Moves a palette to a new position (alternatively with a new label) string $paletteName
string $newPosition
string $newLabel (optional)
addDiv Adds a div (tab) to selected type string $divName
string $label
removeDiv Removes a div (tab) from selected type, either by position (index, beginning with 0) or by label string|int $positionOrLabel
addOverride Adds a custom override of a field string $fieldName
array $configuration
initialize Initializes the type with an empty list

Manipulating palettes

Method name Description Parameters
addCustomPalette Creates a new palette (and optionally inserts it directly to given position) string $paletteId
array $fields
string $label (optional)
string $position (optional)
addFieldToPalette Adds a field to a palette string $paletteId
string $field
string $position (optional)
removeFieldFromPalette Removes a field from a palette string $paletteId
string $field
initializePalette Initializes the palette with an empty list string $paletteId

Helper methods

Method name Description Parameters Returns
getPaletteString Finds the complete palette string which is used in list (for using it in position strings) string $paletteName string The complete palette string with --palette-- and the possible label config
getDivString Finds the complete div string which is used in list (for using it in position strings), either by position (index, beginning with 0) or by label string|int $positionOrLabel string The complete palette string with --div-- and the div's label

Possible values for positioning fields, palettes or divs

Value Description
before:<item> Moves the item before the given item
after:<item> Moves the item after the given item
replace:<item> Replaces the given item

Examples (TCA builder)

Add an own content element

Change existing configurations

Use language file

Do minimal changes

Examples (Tca Creator)

Creating TCA configuration for a new table (inside custom extension)

All versions of tcabuilder with dependencies

PHP Build Version
Package Version
Requires php Version >= 7.4, < 8.4
typo3/cms-backend Version ^v11.5 || ^v12.4 || ^v13.2
typo3/cms-core Version ^v11.5 || ^v12.4 || ^v13.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package spooner-web/tcabuilder contains the following files

Loading the files please wait ...