https://github.com/netresearch/t3x-contexts
Contexts for TYPO3 – can be used to modify page behaviour in the frontend based on several conditions
https://github.com/netresearch/t3x-contexts
multi-channel typo3-extension
Last synced: 8 months ago
JSON representation
Contexts for TYPO3 – can be used to modify page behaviour in the frontend based on several conditions
- Host: GitHub
- URL: https://github.com/netresearch/t3x-contexts
- Owner: netresearch
- License: agpl-3.0
- Created: 2013-03-11T14:10:52.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2025-11-17T13:21:40.000Z (8 months ago)
- Last Synced: 2025-11-17T15:12:25.145Z (8 months ago)
- Topics: multi-channel, typo3-extension
- Language: PHP
- Homepage:
- Size: 1.03 MB
- Stars: 10
- Watchers: 12
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Multi-channel contexts
Show and hide pages and content elements based on configurable "contexts".
With the use of contexts, TYPO3 is able to do multichannel output.
Examples for contexts:
- Screen size < 500px
- Browser runs on a tablet or mobile phone
- Location is 15km around a certain place
- User is from one of certain countries
- User entered website with GET-Parameter ``affID=foo``
- User IP matches a given rule
- A session variable is set
- A combination of any other rules
Apart from the context rules, this extension also provides an API to use
contexts in your own extensions.
* [Multi-channel contexts](#multi-channel-contexts)
* [Setup](#setup)
* [Creating and using contexts](#creating-and-using-contexts)
* [Creating a context](#creating-a-context)
* [Using a context](#using-a-context)
* [Context types](#context-types)
* [Domain](#domain)
* [Domain matching](#domain-matching)
* [GET parameter](#get-parameter)
* [IP address](#ip-address)
* [HTTP header](#http-header)
* [Logical context combination](#logical-context-combination)
* [Fluid template implementation](#fluid-template-implementation)
* [TypoScript implementation](#typoscript-implementation)
## Setup
1. Install and activate extension ``contexts``
2. Clear TYPO3 cache
Optional: Install extensions ``contexts_geolocation`` for location-based
context rules (continent, country, area) and
``contexts_wurfl`` for device-based rules
(type check: phone, tablet, TV, ...; screen sizes, device/browser type).
## Creating and using contexts
### Creating a context
1. Log into the TYPO3 backend as administrator
2. Goto Web/List view, root page (ID 0)
3. Create a new record: TYPO3 contexts -> Context
- Give it a title, e.g. "Affiliate ID: foo"
- Select a type: "GET parameter"
- GET parameter name: ``affID``
- Parameter value: ``foo``
- Activate "Store result in user session"
- Save and close
### Using a context
1. Goto Web/Page, select a page
2. Edit a content element
3. Select the "Contexts" tab
4. For Context "Affiliate ID: foo", select "Visible: yes"
5. Save
View the page. The content element is not visible.
Now add ``?affID=foo`` to the URL and load it.
The content element will be visible now.
You can visit other pages now. When you come back, the content element
will still be visible - even though the GET parameter is not in the URL
anymore - because "Store result in user session" had been activated.
## Context types
The ``contexts`` extension ships with a number of simple contexts.
All of them get stored in table ``tx_contexts_contexts``.
### Domain
A domain context matches when the domain the user visits is in the
configured list.
This is helpful if the site is available on several domains, or
when it is deployed on development/stage/live systems - you may choose
to show a content element on the development system only.
#### Domain matching
You may use one domain per line.
When the domain does not begin with a dot, it will only match fully:
``www.example.org`` will not match the configured domain ``example.org``.
It is possible to use a dot in front of the domain name.
In this case, all subdomains will match:
``some.www.example.org`` matches the configured domain ``.example.org``.
### GET parameter
Checks if a GET parameter is available and has a certain value.
Activate "Store result in user session" to keep the context when navigating
between pages.
When leaving the parameter values field empty, any non-empty parameter value
will activate the context.
### IP address
Matches the user's IP address. IPv4 and IPv6 are supported.
Supported notations:
- Full addresses: ``80.76.201.32``
- Prefix: ``80.76.201.32/27``, ``FE80::/16``
- Wildcards: ``80.76.201.*``, ``80.76.*.37``, ``80.76.*.*``
### HTTP header
Checks if an HTTP header is available and has a certain value.
Activate "Store result in user session" to keep the context when navigating
between pages.
When leaving the parameter values field empty, any non-empty parameter value
will activate the context.
### Logical context combination
Combines other contexts with logical operators.
Contexts are referenced via their alias and can be combined with
the following signs:
- logical and: ``&&``
- logical or: ``||``
- negation: ``!``
- parentheses to group parts of expressions: ``(...)``
### Session variable
This context checks if a session variable with the given name is
set (is not NULL).
## Fluid template implementation
The implementation of a context query in fluid templates looks like::
```html
is Mobile
is not Mobile
```
## TypoScript implementation
The implementation of a context query in TypoScript looks like::
```typo3_typoscript
[contextMatch("mobile")]
# do something, it's a mobile browser
[END]
```
# Testing
```bash
composer update
vendor/bin/phpcs Classes/ --standard=PSR12
vendor/bin/phpstan analyse --configuration phpstan.neon
vendor/bin/rector --dry-run
```