Download the PHP package friendsoftypo3/headless without Composer

On this page you can find all versions of the php package friendsoftypo3/headless. 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?

Informations about the package headless

TYPO3 Extension headless - JSON Content API for TYPO3 Headless solution

TYPO3 13 TYPO3 12 TYPO3 11 CI Status Coverage Status

Headless

Headless allows you to render JSON from TYPO3 content. You can customize output by changing types, names and nesting of fields.

This extension provides backend part (JSON API) for TYPO3 PWA solution. Second part is a JavaScript application nuxt-typo3 which consumes JSON API and renders the content using Vue.js and Nuxt. See frontend documentation here: https://typo3-headless.github.io/nuxt-typo3/

If you have any questions just drop a line in #initiative-headless-pwa Slack channel.

URL
Repository: https://github.com/TYPO3-Headless/headless
Read online: https://docs.typo3.org/p/friendsoftypo3/headless/main/en-us/
TER: https://extensions.typo3.org/extension/headless/
Slack: https://typo3.slack.com/channels/initiative-headless-pwa

Features

Additional extensions and integrations

Requirements and compatibility

EXT:headless version TYPO3 support PHP support Status
>= 4.0 12, 13 >= 8.1 Active development & support
>= 3.0 11 >= 7.4, <= 8.2 Critical bugfixes only
>= 2.0 9, 10 >= 7.2, <=7.4 Critical bugfixes only

Quickstart / Demo

If you want to take a look at working demo including frontend, backend and demo data, use our DDEV based demo project here: https://github.com/TYPO3-Initiatives/pwa-demo

Installation

Install extension using composer

composer require friendsoftypo3/headless

Documentation

Extension documentation

How to start with TYPO3 Headless video tutorial

Whether you are a developer, content manager, or a tech enthusiast, this tutorial is tailored to provide a comprehensive introduction to TYPO3 Headless, helping you to get started on your journey with confidence.

video still

Configuration

Since versions: 4.2 | 3.5 Flag headless is required to configure in site configuration!

This flag instructs how EXT:headless should behave in multisite instance.

For each site you can set in which mode site is operated (standard aka HTML response, headless, or mixed mode).

You can set headless flag manually in yaml file or via site configuration in the backend:

Possible values:

While the legacy flag (true|false) is still recognized, transitioning to the integer notation is recommended.

Configuration steps

For a chosen site in TYPO3, follow these steps:

To enable Headless Mode:

To enable Mixed Mode:

The mixed mode flag (value of 2) instructs the EXT:headless extension to additionally check for the Accept header with a value of application/json when processing requests to the particular site in the TYPO3 instance.

JSON Content Object

In headless extension we implemented new JSON Content Object, which allows you to specify what fields you want to output, and how they will look. First, let's take a look at simple example

Output

in addition, keyword fields allow you to nest multiple times fields in json, e.g.

Output

INT, FLOAT & BOOL Content Objects for use in JSON Content Object

We introduce new simple content objects to improve JSON API response for frontend developers. We can set correct property types, so frontend does not have to deal with string values for fields with numeric values or field that should be true/false.

Output

Customizing

You can override every field in output using typoscript. This extension allows you to use standard typoscript objects such as TEXT, COA, CASE.

Example page response ⬇️

image

DataProcessing

You can use Data Processors just like in FLUIDTEMPLATE Content Object, e.g.

Built in data processors

We provide multiple data processors for headless rendering purposes.

DatabaseQueryProcessor

Used for fetching records from the database.

FilesProcessor

This processor should be used to process files (standard or media files).

Also, it allows you to process images. See docs chapter: Images for details.

GalleryProcessor

Should be used along with FilesProcessor (chained). Used for processing mutliple media files.

MenuProcessor

Used for navigation. Works just like standard menu processor.

FlexFormProcessor

Used for processing flexforms.

RootSitesProcessor

Render your all headless sites configuration for your frontend application.

Contributing

Alt

Development

Development for this extension is happening as part of the TYPO3 PWA initiative, see https://typo3.org/community/teams/typo3-development/initiatives/pwa/ If you have any questions, join the #initiative-headless-pwa Slack channel.

Credits

A special thanks goes to macopedia.com company, which is sponsoring development of this solution.


All versions of headless with dependencies

PHP Build Version
Package Version
Requires ext-json Version *
typo3/cms-core Version ^11.5
typo3/cms-install Version ^11.5
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 friendsoftypo3/headless contains the following files

Loading the files please wait ....