ayacoo / podigee
Podigee - Provides a podigee online media helper
Package info
Type:typo3-cms-extension
pkg:composer/ayacoo/podigee
Requires
- php: >=8.2 < 8.6
- typo3/cms-core: ^14.3
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.91
- helmich/typo3-typoscript-lint: ^3.3
- phpstan/extension-installer: ^1.4
- phpstan/phpstan: ^1.12
- phpstan/phpstan-phpunit: ^1.4
- phpstan/phpstan-strict-rules: ^1.6
- phpunit/phpunit: ^11.5.44
- squizlabs/php_codesniffer: ^3.13
- symfony/console: ^7.0
- symfony/translation: ^7.0
- typo3/coding-standards: ^0.5.5
- typo3/testing-framework: ^9.3
README
1 Features
- Podigee podcasts can be created as a file in the TYPO3 file list
- Podigee podcasts can be used and output with the text with media element
- Update metadata via command
2 Usage
2.1 Installation
Installation using Composer
The recommended way to install the extension is using Composer.
Run the following command within your Composer based TYPO3 project:
composer require ayacoo/podigee
2.2 TypoScript settings
Privacy
With plugin.tx_podigee.settings.privacy = 1 you can ensure that the IFrame is
built with data-src instead of src. If you need more options to influence the HTML, you can
use a PSR-14 event.
3 Developer Corner
3.1 ModifyPodigeeOutputEvent
If you want to modify the output of the Podigee HTML, you can use
the ModifyPodigeeOutputEvent.
EventListener registration
In your extension, extend Configuration/Services.yaml once:
Vendor\ExtName\EventListener\PodigeeOutputEventListener: tags: - name: event.listener identifier: 'podigee/output' event: Ayacoo\Podigee\Event\ModifyPodigeeOutputEvent
<?php namespace Vendor\ExtName\EventListener; use Ayacoo\Podigee\Event\ModifyPodigeeOutputEvent; class PodigeeOutputEventListener { public function __invoke(ModifyPodigeeOutputEvent $event): void { $output = $event->getOutput(); $output = str_replace('src', 'data-src', $output); $event->setOutput($output); } }
3.2 Backend Preview
In the backend, TextMedia displays the title of the element and the preview image of the podcast.
If you want to influence this, you can activate an EventListener here. The project contains a file called TextMediaPodigeePreviewEventListener.php.example. This can serve as a guide if you want to control more content yourself.
3.3 Content security policy
By default, CSP settings are added for the frontend and backend. These settings can be modified via YAML or events.
Take a look at the current documentation: https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/ContentSecurityPolicy/Index.html
4 Administration corner
4.1 Versions and support
| Podigee | TYPO3 | PHP | Support / Development |
|---|---|---|---|
| 2.x | 14.x | 8.2 - 8.5 | features, bugfixes, security updates |
| 1.x | 13.x | 8.2 - 8.5 | features, bugfixes, security updates |
4.2 Release Management
podigee uses semantic versioning, which means, that
- bugfix updates (e.g. 1.0.0 => 1.0.1) just includes small bugfixes or security relevant stuff without breaking changes,
- minor updates (e.g. 1.0.0 => 1.1.0) includes new features and smaller tasks without breaking changes,
- and major updates (e.g. 1.0.0 => 2.0.0) breaking changes which can be refactorings, features or bugfixes.
4.3 Contribution
Pull Requests are gladly welcome! Nevertheless please don't forget to add an issue and connect it to your pull requests. This is very helpful to understand what kind of issue the PR is going to solve.
Bugfixes: Please describe what kind of bug your fix solve and give us feedback how to reproduce the issue. We're going to accept only bugfixes if we can reproduce the issue.
5 Thanks / Notices
- Special thanks to Georg Ringer and his news extension. A good template to build a TYPO3 extension. Here, for example, the structure of README.md is used.
- Thanks also to b13 for the online-media-updater extension. Parts of it were allowed to be included in this extension.
6 Support
If you are happy with the extension and would like to support it in any way, I would appreciate the support of social institutions.