TYPO3 Documentation: "Developing TYPO3 Extensions with Extbase and Fluid" (Book)
Home Page: https://docs.typo3.org/typo3cms/ExtbaseFluidBook/
This book has been here since TYPO3 v6.2. By now (2022) it is severely outdated. We are therefore in the process of reviewing, moving and removing its content.
The Extbase reference can now be found in TYPO3 Explained, Extbase reference.
New tutorials can be found at TYPO3 Explained, Extension development tutorials.
Move (and update / delete) content from Wiki:
When moving please make sure to always:
[[category: Moved]]Using wrong grammar / phrases / vocabulary:
No specific error, but could generally be improved.
This is necessary to become certified developer.
This chapter is completely outdated and should either be removed or rewritten:
https://docs.typo3.org/m/typo3/book-extbasefluid/master/en-us/8-Fluid/9-using-php-based-views.html
Some labels are defined at places where they are NOT in front of a headline. So they don't have an automatic link text and are difficult to use. This can be made better!
To find them, see:https://docs.typo3.org/typo3cms/ExtbaseFluidBook/Targets.html and watch out for '...' instead of a linktext:
Disclaimer: This description is opinionated, I have included it to explain why I think this issue is important and what I mean.
Summary: There are some things in this book that are already abundantly documented elsewhere (e.g OOP), but basic introductory information about TYPO3, Extbase and Fluid are missing.
What is missing
You might argue, that someone reads this book already knows TYPO3. But why is it assumed, they need an introduction to OOP? I would argue the other way around: I assume someone is knowledable in programming and needs an introduction to TYPO3.
What is there but not really important (or already documented elsewhere) if you want to program extensions:
Once a chapter has been reviewed and corrected, it can be checked off.
Here, we focus on following goals:
for master (10-dev) - July 21, 2019
for master (10-dev) - July 21, 2019
for master (10-dev) - July 21, 2019
Raised by @maikusch, the sections within Documentation/9-CrosscuttingConcerns/2-validating-domain-objects.rst are misleading. Code examples were adjusted via d9509fc#diff-eaedc983c891f372262095aee2860fc6 but do no longer match. validate() is now implemented instead of isValid(), but this does not match to extending the AbstractValidator class.
Which way is preferred and why. This way should be used through the whole section, with a small side note why it is preferred over the other.
This is necessary to become certified developer. Therefore this should be documented.
Sources:
Some of the text can be shortened to about half of the length without loosing much of the information.
While we do think having a few introductory sentences is good and this text does a good job of taking the user by the hand and leading him through the material, a few suggestions:
I guess there is an error in some of the examples on Developing a Custom ViewHelper:
As mentioned in the text below the example for The implementation it should be
use \TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
instead of
use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
This appears in several examples on the page but will lead to a deprecated note marked as strong.
That class is used in https://docs.typo3.org/typo3cms/ExtbaseFluidBook/10-Outlook/2-Backend-modules.html
You have to use \TYPO3\CMS\Extbase\Utility\ExtensionUtility now.
For this document, we probably need some sort of plan to coordinate the efforts and put them in the right order, and this for each version e.g.
Is this task realistic, who can help, how should we proceed?
I realized that the style for defenitionlists with the class .docutils do not render like "tables" (div class t3-row) for "propertys", "Data type" and "examples".
So please add this CSS to the "theme.css"
dl.docutils{
background-color: #f2ebe3;
border: 1px none #888;
border-top: 2px solid #988d81;
clear: both;
margin-bottom: 30px;
margin-top: 30px;
position:relative;
}
dl.docutils dt{
padding: 12px 8px;
color: #b34700;
font-size: 9px;
font-weight: 400;
}
dl.docutils dd{
padding: 12px 8px;
margin:0;
}
dl.docutils dt:nth-of-type(1){
font-weight: 700;
margin-right: 8px;
min-width: 30%;
margin: 0;
position:absolute;
}
dl.docutils dd:nth-of-type(1){
font-weight:700;
position:absolute;
margin-top:20px;
}
dl.docutils dt:nth-of-type(2){
border-left: 4px solid #fff;
position:relative;
left:30%;
top:0;
}
dl.docutils dd:nth-of-type(2){
border-left: 4px solid #fff;
position:relative;
left:30%;
top:0;
max-width:70%;
}
dl.docutils dt:nth-of-type(3){
border-top: 4px solid #fff;
}
Be aware that request hashes (HMAC) doesn't protect against Identity field manipulation.
An attacker can modify the identify field value and then can update value of
another record, even if he doesn't usually have access to it. You have to
implement your own validation for the Identity field value (verify ownership
of the record, add another hidden field which validates the identity field
value, etc..).
This section comes out of nowhere with no explanation of request hashes, identity and how this is relevant in this context.
Also, it says what doesn't work but does not provide example for good practice.
Add examples, links ...
Using a sidebar near the end of the page breaks the layout, see for example the following two sites:
https://docs.typo3.org/typo3cms/ExtbaseFluidBook/3-BlogExample/5-Get-Blog-from-the-Repository.html
and a screenshot showing the problem:
At this page: https://docs.typo3.org/typo3cms/ExtbaseFluidBook/4-FirstExtension/2-create-folder-structure-and-configuration-files.html
There is mentioned: "So that the extension can be loaded by TYPO3, we require two configuration files.".
But after that, there is only ext_emconf.php file. Which is the second configuration file?
The current Extbase Fluid Book currently contains 2 different versions: one for the TYPO3 version which is e.g. "latest" and another version for the book (1.0.0.) which appears in the Meta information on the start page. I find the second version (1.0.0) confusing and unnecessary. I think there should be only one version.
It is customary in the other guides to only use the version that corresponds with the branch and TYPO3 version.
Hi!
I am having a hard time finding all the options of calculation expressions and boolean expressions possible in fluid.
In the text at https://docs.typo3.org/m/typo3/book-extbasefluid/master/en-us/8-Fluid/7-using-boolean-conditions.html a text box is saying:
You find a complete list of all evaluating possibilities in appendix C in the section “Boolean expressions”.
I was unable to find an appendix C, unfortunately. Neither did I find any more or less up to date documentation about calculation and evaluation (e.g. a fluid variant of the in_array php function might exist as in operator, but no list seems to exist).
My use case would be something like {iterator.index} % 4 in [1, 2] to make a two-column chess-board layout. However, this bug report is not about the specific use case, but about the referenced but missing documentation. (I'll probably be better off with the fluid core CycleViewHelper for this implementation.)
For some people it's irritating that we don't provide information about how routes work in Extbase.
We should at least add a small paragraph or chapter about routing.
What's necessary, how does it work and how can someone adjust it.
We should provide the following:
Hint at https://docs.typo3.org/typo3cms/ExtbaseFluidBook/10-Outlook/4-Property-mapping.html how mapping is done for actions.
Perhaps we should also mention that there are existing extensions to configure URLs.
Also we should explain how Extbase routing differs from normal frameworks, as Extbase is a Framework within TYPO3 CMS.
Perhaps we can mention page types and also https://docs.typo3.org/typo3cms/ExtbaseFluidBook/b-ExtbaseReference/Index.html#features would be a nice hint at features.skipDefaultArguments
Should namespace be defined in partial or template?
There is a section for partials:
It currently works this way:
for TYPO3 8:
TYPO3 7:
I don't know what is the recommended way.
See also:
This is necessary in order to certify as a developer and should therefore be documented.
This book refers to several extensions, all of which are not available for TYPO3 9 and above:
I would propose to stick to one sample extension if possible and keep this one updated! However, I have not checked sufficiently if this is possible with the current text. A journey through the blog example is based heavily on the blog example. Having up to date code that works would be very helpful.
Necessary steps:
As this is necessary to become certified developer.
The description about $arguments on https://docs.typo3.org/typo3cms/ExtbaseFluidBook/b-ExtbaseReference/Index.html#localization
is not very clear. Example would be nice.
This is necessary to become a certified developer. Therefore this should be documented.
Only known source is the source code.
There should be information of how to write a WidgetViewHelper as is tried here for example:
https://stackoverflow.com/questions/50740942/typo3-custom-widget-viewhelper
After working through the example Creating a first extension with a composer installed TYPO3 V9.4 I get an error:
Core: Exception handler (WEB): Uncaught TYPO3 Exception: #1278450972:
Class MyVendor\StoreInventory\Controller\StoreInventoryController does not exist.
Reflection failed.
The reason seems to be that the autoload configuration has to be put into the root composer.json. I posted the details in an answer to a similar question on SO. Maybe this can be put into the appropriate place into the documentation.
Fluid is a standalone template engine. So there should be a nice documentation about the Template engine.
Also TYPO3 provide a system extension to enhance and integrate the template engine into TYPO3.
My proposal would be to split Extbase and Fluid into two separate documentations for now. Where we can decide later to split the Fluid documentation further, if helpful.
Under this section:
https://docs.typo3.org/typo3cms/ExtbaseFluidBook/3-BlogExample/11-Alternative-route-creating-a-new-posting.html
Code in Fluid, and code generated show labels "Author", "Title" and "Content", but Figure 3-5 show the labels adding afterwards " (Required)".
This is confusing for the user.
This knowledge is necessary for becoming a certified developer. Therefore this feature should be documented.
I followed the instructions 1 by 1 and copy/paste the examples to the files they should be in. The part with database is working fine - but the plugin cannot be finished, for all I got is an error 500 without a proper error log in the database. I checked all twice for error in structure, but it is exactly like the described one.
see TYPO3-Documentation/T3DocTeam#81
Change old and obsolete @dontvalidate to @ignorevalidation.
Need to be adjusted in versions from 6.2 on.
Hi, I'm trying to onboard in TYPO3 as fast as possible, so I've started with: Blog example extension. But immediately after installation, I'm getting: Class 'Tx_Extbase_Utility_Extension' not found exception.
Now I found, that Blog example is an Outdated extension with the last update at 2011!
Could you please update documentation, or send me a link for different example to smooth onboarding?
Error: Config directory doesn't contain a conf.py file.
When running make html, (as instructed by the readme) shpinx-build will emit the above error and refuse to build the documentation.
It seems that the project is meant to be viewed through the Typo3 sphinx-extension, which may obviate the need for a conf.py (I have no experience with neither sphinx nor the Typo3 extension.)
Additionally, after I generated a basic conf.py, the contents.rst file is missing when building from command line. I'm assuming Index.rst is supposed to fulfill that role.
I can provide a PR that will add a contens.rst & conf.py, however, I haven't gotten the sidebar to properly render (i.e. show the full navigation) in local builds. Alternatively, the Readme could be update to indicate that the documentation is meant to be viewed or compiled using the TER extension.
Maybe pull request 140 should be looked at again. Some translations are expressing something different, I think.
#140
In the warning in, the code example uses the core QueryBuilder and not Extbase Query.
Warning
You should always avoid making queries to the persistence layer outside of the domain model. Encapsulate these queries always in a repository.
Inside of the repositories, you can access the database using a database connection:
EXT:my_extension/Classes/Domain/Repository/MyRepository.php
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Utility\GeneralUtility;
$connection = GeneralUtility::makeInstance(ConnectionPool::class)
->getConnectionForTable('tx_sjroffers_domain_model_offer');
But right after the warning, it warns about the "Extbase" execute() method (where in the previous code snippet, it is not Extbase):
Since Extbase 1.2 (TYPO3 4.4), the method execute() returns a multidimensional array
This is at least slightly confusing, and it might be a good idea to add that we are using core persistence and why.
Also, I am not sure why we have this warning. Additionally, it seems out of place in the section on "Orderings in the query".
This manual has several problems:
This is also inspired by #198 and what others have suggested.
Between TYPO3 7 and 8 the default behaviour of ViewHelpers was changed:
before: HTML code was output as is
after: HTML output is escaped: < becomes <
The default behaviour can be changed:
/**
* By default the output is escaped.
*
* @var bool
*/
protected $escapeOutput = false;
In Fluid f:format.htmlentities, f:format.stripTags etc. can be applied.
see : https://typo3.slack.com/archives/C025BQLFA/p1499087019054498
This is necessary in order to become certified developer. Therefore this should be documented.
Stuff that might be useful while writing:
Taken from https://docs.typo3.org/typo3cms/extensions/core/latest/Changelog-9.html
There are more new annotations that do not seem to be documented, yet...
Sorry but the documentation on:
https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/10.0/Deprecation-87550-UseControllerClassesWhenRegisteringPluginsmodules.html
seem to be outdated according the Deprecation: #87550 - Use controller classes when registering plugins/modules:
https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/10.0/Deprecation-87550-UseControllerClassesWhenRegisteringPluginsmodules.html
I copied and installed the extension from the documentation after writing the extension step by step failed: https://github.com/TYPO3-Documentation-Examples/store_inventory
See also: https://docs.typo3.org/m/typo3/book-extbasefluid/9.5/en-us/4-FirstExtension/7-configuring-the-plugin.html
As per Documentation I should see an additional extension 'The Store Inventory List'. Which is not shown. I activated the "Store Inventory" Extension already.
Also as illustrated below, the "plugin" tab is missing on my backend (The screenshot is from the documentation).
After installation of the extension we can insert the plugin on a page. Don’t forget to set the sys folder, in which the products are stored, as the starting point (in our case “Inventory”) in the plugin. Otherwise your products are not found (see figure 4-4).
The following things I have tried:
System Info:
Typo3 v9.5 & Typo3 v8.7
PHP 7.2 with MariaDB
Local Dev Environment
Extensions managed by Composer
There is a Link Mismatch by Field type "inline"
http://typo3.org/documentation/ document-library/core-documentation/doc_core_api/4.3.0/view/4/2/
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.