This repository contains IDE plugins for:
- TYPO3 CMS related functionality
- the TYPO3 Fluid Templating Language
- the TypoScript configuration language
While these 3 plugins work together and may use each others' library functions and extension points, each may be used independently from the others - with a limited feature set.
The plugins in the JetBrains Plugin repository:
On PhpStorm or IntelliJ:
- open "File" -> "Settings"
- select "Plugins"
- select "Browse Plugins"
- search "TYPO3 CMS Plugin"
- choose the plugin in the left pane, click the install button in the right pane
- hit apply, close the window
- restart your IDE
- profit!
- TypeProvider for
GeneralUtility::makeInstance
- TypeProvider for
GeneralUtility::makeInstanceService
- TypeProvider for
ObjectManager::get
- TypeProvider for
$GLOBALS['TYPO3_DB']
,$GLOBALS['TSFE']
,$GLOBALS['BE_USER']
and$GLOBALS['TYPO3_REQUEST']
- CompletionContributor for
UriBuilder::buildUriFromRoute
andBackendUtility::getAjaxUrl
- CompletionContributor for
IconFactory::getIcon
- Annotator for both valid and invalid route references to make them distinguishable from normal strings
- Annotator for both valid and invalid icon references to core-defined icons
- LineMarkerProvider to allow quick navigation to the route definition
- Inspection: Extbase
@inject
property injection + QuickFix - Experimental: Generate Fluid Styled Content Element (please report bugs!)
- Generate ViewHelpers
- Generate ActionControllers
- Create TYPO3 Projects from sketch
- classic layout (through https://github.com/TYPO3/TYPO3.CMS)
- composer based project through https://github.com/TYPO3/TYPO3.CMS.BaseDistribution
Contributions are very welcome! 🎉
If you want to sustain further development, you can donate via PayPal, Patreon or Invoice.
- IntelliJ IDEA works best when developing the plugin (Community Edition should be sufficient), but in theory, every Java IDE or even your text-editor should work
git clone https://github.com/cedricziel/idea-php-typo3-plugin.git
cd idea-php-typo3-plugin
- start the IDE:
- TYPO3 CMS Plugin:
./gradlew :typo3-cms:runIde
-gradlew.bat runIde
for Windows - TYPO3 Fluid Plugin
./gradlew :lang-fluid:runIde
-gradlew.bat runIde
for Windows - TypoScript Plugin
./gradlew :lang-typoscript:runIde
-gradlew.bat runIde
for Windows - CTRL + C to terminate the execution
- TYPO3 CMS Plugin:
- to begin development with IntelliJ, please import the
build.gradle
file asnew project from existing sources
- from IntelliJ run the Gradle task
runIde
(in debug mode), set break-points, profit! - run tests:
./gradlew check
- ideally: send your pull request from a feature branch
Thank you to Daniel Espendiller and Adrien Brault for providing their Symfony2 Plugin in the first place. It is a great inspiration for possible solutions and parts of the code.
Icons used in this project are provided by:
- Göran Bodenschatz (@coding46)
- TYPO3.Icons (MIT Licensed)
We're glad, to have YourKit as a sponsor!
YourKit supports open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.
MIT