twypo

Twig for TYPO3

How to use it

1. cd path/to/your/typo3conf/ext && git clone https://github.com/julianxhokaxhiu/twypo.git --recursive or install it directly from TER.
2. Enable the "Twypo" extension inside your Backend
3. In Include static (from extensions): of your main template add the voice Twypo: Framework Setup.
4. Refresh your page and you're done.

Is it ready for production?

Nope, it's not.

But it's a Kickstart that a lot of guys at cron IT GmbH helped me on starting this project.

Why?

Simply because there were a lot of POC but none of them was a working extension like "drop-in and run". So, this is my own effort to bring this kind of logic to the people that want to use it.

What can you do for me?

If you're a TYPO3 developer, you can help me to scrape in the correct way the data from the system to arrays/dictionaries.

If you're a user, then just wait for it to be ready.

Which is the license of this project?

I like the MIT license. Just use it as you like, but remember to keep the original author(s) in your source code files. Read the LICENSE file for more information.

Reference

The namespace used for the returned collection on the view, is based on the default empty installation of typo3.

You can change some of them (ex. left, middle, etc.) using the TypoScript configuration. See TWYPO_COLUMN_MAPPING in setup.txt.

Also the main layout entrypoint will be decided through the Layout option of the current page on the backend. To see which file will be called, based on that option, see TWYPO_LAYOUT_MAPPING in setup.txt.

app
  css
    path // Relative Path of CSS files
    files // array of files found in the cssFiles TS folder
  js
    path // Relative Path of JS files
    files // array of files found in the jsFiles TS folder
  menu // The website main menu
  page // The current page information (title, subtitle, etc.)
  content // The current items for the page.
    left // The left area of the current page
    	@items
    middle // The middle area of the current page
    	@items
    right // The right area of the current page
    	@items
    border // The border area of the current page
    	@items

Each @items is an array made of single items that have these properties:

title // The item header text
text // The item content text
link
  url // The url of the link
  target // the target of the link
files // array of items
  ...
    url // The abs url of the image
    type // The fileType (internal integer used by Typo3 to flag "content" items stored on the DB)
    mime // The mimetype
    title // The title of the file
    description // The description of the file
    extension // The extension of the file
    missing // This flag tells you if the file is missing in the disk

If you want to know what's inside of app:

{{ dump(app) }}

or inside of app.menu

{{ dump(app.menu) }}

If you want to see how these @items are currently printed, see index.twig.

Extension Developers Reference

You can integrate Twypo directly from your plugin and provide the required data and functions by using one simple line of code:

global $TWYPO;

Include that line in any module, function or PHP code that is requiring it, and afterwards you can use public available APIs to assign template data (or internal data, mostly used for setting temporary data between modules that doesn't live in the same moment).

List of Public available API:

• $TWYPO->scrapeData(): mostly used by Twypo itself, useful for scraping basic data that comes directly from TYPO3 itself, for example Menus.
• $TWYPO->get($key): get the template Data value for the corresponding key (a string).
• $TWYPO->getInternal($key): get the internal Data value for the corresponding key (a string).
• $TWYPO->assign($key,$value): set the template Data value for the assigned key (a string).
• $TWYPO->assignInternal($key,$value) set the internal Data value for the assigned key (a string).