Tea in a nutshell

The example extension EXT:tea was created as an example of best practises on automatic code checks.

Hint

If you want to learn more about automatic code checks see the documentation of tea and the chapter on Testing in this manual.

In this manual, however we will ignore the testing and just explain how this example extension works. The extension demonstrates basic functionality and is very well tested.

Attention

The example extension tea should not be used as a kickstarter or template for your own extension. It is an example to be studied and copied from.

Steps in this tutorial:

  1. Extension configuration and installation

    Create the files needed to have a minimal running extension and install it.

  2. Directory structure

    Have a look at the directory structure of the example extension and learn which files should go where.

  3. The model

    We define a database schema and make it visible to TYPO3. Then we create a PHP class as a model of the real-life tea flavour.

  4. The Repository

    The repository helps us to fetch tea objects from the database.

Note

This tutorial is work in progress. As we want to prevent epic pull requests, we will create it step by step. Stay tuned.