univie/univie_pure

This extension allows you to seamlessly integrate academic content from the Elsevier Pure Research Information System (API v524) into your TYPO3 website, displaying publications, projects, datasets, and equipment details. Based on the Vienna Pure extension, our implementation has been specifically o

dev-master 2025-04-28 11:40 UTC

Requires

• php: >=8.2.0
• georgringer/numbered-pagination: >=2.0.1
• goaop/framework: ^1.1
• typo3/cms-core: ^12.4

Requires (Dev)

• codeception/aspect-mock: ^0.5.1
• php-mock/php-mock-phpunit: ^2.10
• phpunit/php-code-coverage: ^10.1
• phpunit/phpunit: ^10
• typo3/cms-fluid-styled-content: ^12.4
• typo3/cms-frontend: ^12.4
• typo3/cms-install: ^12.4
• typo3/coding-standards: ^0.7.1
• typo3/testing-framework: ^8.2

GPL-2.0-or-later

• TYPO3-Team LUIS LUH

README

Overview

Univie Pure (T3LUH FIS) is a TYPO3 Extension designed to integrate with the Elsevier Pure Web Service, allowing seamless display of Publications, Datasets, Equipment, and Projects on TYPO3-powered websites. It is fully compatible with Pure Web Service version 524 and is based on the Vienna Pure Extension.

Features

• Fetch and display publications, projects, datasets, and equipment from Elsevier Pure Web Service.
• Provides configurable TYPO3 plugins for embedding Pure API data.
• Supports caching for improved performance.
• Compatible with TYPO3 version 12.4.
• Designed to work with Pure/FIS API v524.

Installation

1. Install via Composer

composer require univie/univie-pure

2. Manual Installation

1. Download the extension and place it in your TYPO3 /typo3conf/ext/ directory.
2. Activate the extension in the TYPO3 backend under Admin Tools → Extensions.
3. Clear TYPO3 cache.

3. Configure Environment Variables

Set up your .env file in the TYPO3 Root-Directory with the following credentials:

PURE_URI=https://your-pure-instance/ws/api/524/
PURE_APIKEY=your-api-key
PURE_ENDPOINT=/ws/api/524/

4. Using Cache Warmup

Before using the Plugin run this Cache Warmup. (i.e. in crontab every 24h)

php typo3/sysext/core/bin/typo3 cache:warmup --group univie_pure

Usage

1. Adding a Plugin to a Page

1. In TYPO3 backend, go to a page where you want to display Pure data.
2. Add a new content element and select the T3LUH FIS plugin.
3. Configure the plugin settings (e.g., Publication List, Project List, Dataset List, Equipment List).
4. Save and preview the page.

API Documentation of the Pure Endpoint

Public API documentation is available at:

• FIS API Docs or
• TU/e Pure API Docs

Development

Running PHPUnit Tests

# Only Unit Tests
ddev exec  .Build/vendor/phpunit/phpunit/phpunit -c Tests/phpunit.xml --testsuite "Unit Tests"
# Only Functional Tests
ddev exec  .Build/vendor/phpunit/phpunit/phpunit -c Tests/phpunit.xml --testsuite "Functional Tests"

Contributing

1. Fork the repository.
2. Create a feature branch (git checkout -b feature-xyz).
3. Commit your changes (git commit -m 'Add feature xyz').
4. Push to the branch (git push origin feature-xyz).
5. Open a Pull Request.

License

This extension is licensed under the GNU GENERAL PUBLIC LICENSE Version 3.

Maintainers

• Alex Ebeling-Hoppe - [e-mail]
• Organization/Institution - University of Vienna / LUIS - Leibniz University Hannover

Support

For questions or issues, please open a ticket on GitHub Issues.