werkraum-media / thuecat Goto Github PK

Connects TYPO3 with "Thüringer Content Architektur Tourismus"

Home Page: https://docs.typo3.org/p/werkraummedia/thuecat/master/en-us/

PHP 90.13% HTML 9.65% Nix 0.22%

thuecat's Introduction

ThüCAT integration into TYPO3 CMS

ThüCAT is ¨Thüringer Content Architektur Tourismus¨. This is an extension for TYPO3 CMS (https://typo3.org/) to integrate ThüCAT. The existing API is integrated and allows importing data into the system.

Full documentation available at https://docs.typo3.org/p/werkraummedia/thuecat/master/en-us/.

Current state

The extension already allows:

Create configuration to import:
- specified resources via static configuration, e.g. defined organisation or towns.
- sync scope, a syncScopeId to always update delivered resources.
Support multiple languages
Import of the following types (not all properties are supported):
- Organisations (responsible for content)
- Towns
- Tourist information
- Tourist attraction
Backend module:
- To inspect current existing organisations and their towns and tourist information
- To inspect import configuration
- To create import configuration
- To inspect past imports and possible errors, as well as number of affected records
Frontend:
- Content element to display tourist attraction
- Page Type to reference tourist attraction
- Descriptions are formatted HTML, use f:format.html ViewHelper for rendering.

Short time goals

Content element to display town, tourist information and organisation.
Extending import to include further properties

Installation

Please configure API Key via Extension Configuration.

Configuration records need to be created, e.g. by visiting the ThüCAT module. Those can then be imported via the same module.

thuecat's People

Contributors

Stargazers

Watchers

Forkers

bnf crpozo chriwo

thuecat's Issues

Remove api key from sites

Documentation matches code base which expects API key to be defined within Extension Configuration.
Still the extension extends UI of sites to also allow configuration of an API key. This should be removed as it is not used anyway.

Add new configuration type syncScope

A new API was added which allows syncing records which have changed.
It also consists of a collection of records.

The documentation (in German) is available at: https://cms.thuecat.org/developer

It makes sense to provide a dedicated configuration for that approach.

Provide proper condition method in model instead of huge condition in view

See: #63 (comment)

Add function for countable offers

Currently its not possible to add a condition, if offers are in the model.

Auto import missing relations

Some objects have relations. E.g. a Tourist Information has a relation to a town. The foreign object (town) might not exist while importing the object (Tourist Information).

It might make sense to auto import those relations.

Add proper documentation

Add Documentation which contains the features, functionality, usage. This should explicitly include how to handle templates (overwrite / exchange).

Allow to store log and configuration outside of page root

This is necessary to allow editors to adjust configurations and to read logs.

Template Attraction CE

Provide a basic bootstrap template.

Extend information for TouristAttraction

One customer wants to import further information (tracked in their project management).
This issue is just there for a reference.

Set correct extension version

The ext version is different from the tagged version

Do not use the `_` for new identifier in DataHandler

The _ inside the uid has a special meaning, see

if (strpos($value, '_') === false) {
    $affectedTable = $tcaFieldConf['foreign_table'];
    $prependTable = false;
} else {
    $parts = explode('_', $value);
    $value = array_pop($parts);
    $affectedTable = implode('_', $parts);
    $prependTable = true;
}
$value = $this->substNEWwithIDs[$value];
// The record is new, but was also auto-versionized and has another new id:
if (isset($this->autoVersionIdMap[$affectedTable][$value])) {
    $value = $this->autoVersionIdMap[$affectedTable][$value];
}
if ($prependTable) {
    $value = $affectedTable . '_' . $value;
}
// Set a hint that this was a new child record:
$this->newRelatedIDs[$affectedTable][] = $value;
$valueArray[$key] = $value;

https://github.com/TYPO3/TYPO3.CMS/blob/10.4/typo3/sysext/core/Classes/DataHandling/DataHandler.php#L6249

We should not use the _ to follow the documented and expected behaviour.

The _ has no consequences right now, because we do not use the uids in relations yet. But this might change in the future and would result in broken behaviour.

Improve template handling to work out of the box as expected

Keep existing logic, but use 0 as key. This follows EXT:fluid_styled_content, which also provides its templates under key 0.
That way it should work as expected for all editors our of the box.

Deleting a configuration causes an error if there were error entries

If a configuration is deleted although there are error entries for this configuration, this leads to the following error:

Return value of WerkraumMedia\ThueCat\Domain\Model\Backend\ImportLog::getConfiguration() must be an instance of WerkraumMedia\ThueCat\Domain\Model\Backend\ImportConfiguration, null returned