https://github.com/friendsofredaxo/asset_import
Ein AddOn zum Importieren von Medien aus verschiedenen Quellen (Pixabay, Pexels etc.) direkt in den REDAXO Medienpool.
https://github.com/friendsofredaxo/asset_import
media pexels-api pixabay-api redaxo redaxo-addon
Last synced: about 1 year ago
JSON representation
Ein AddOn zum Importieren von Medien aus verschiedenen Quellen (Pixabay, Pexels etc.) direkt in den REDAXO Medienpool.
- Host: GitHub
- URL: https://github.com/friendsofredaxo/asset_import
- Owner: FriendsOfREDAXO
- License: mit
- Created: 2024-12-30T14:48:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-22T21:25:06.000Z (over 1 year ago)
- Last Synced: 2025-03-30T08:31:25.151Z (about 1 year ago)
- Topics: media, pexels-api, pixabay-api, redaxo, redaxo-addon
- Language: PHP
- Homepage: https://github.com/FriendsOfREDAXO/asset_import
- Size: 1.45 MB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Asset Import für REDAXO
Ein AddOn zum Importieren von Medien aus verschiedenen Quellen (Pixabay, Pexels etc.) direkt in den REDAXO Medienpool.
## Features
- Bildsuche über verschiedene Provider
- Video-Suche (abhängig vom Provider)
- Vorschau der Assets
- Direkter Import in den Medienpool
- Kategoriezuweisung
- 24h API-Cache für bessere Performance
- Erweiterbar durch weitere Provider
## Installation
1. Im REDAXO Installer das AddOn `asset_import` herunterladen
2. Installation durchführen
3. Provider konfigurieren unter "Asset Import > Einstellungen"
## Provider registrieren
Provider können in der boot.php eines anderen AddOns registriert werden:
```php
// Provider-Klasse implementieren
namespace MyAddon\Provider;
class MyProvider extends \FriendsOfRedaxo\AssetImport\Asset\AbstractProvider
{
// Provider Implementation
}
// Provider im Asset Import registrieren
if (\rex_addon::get('asset_import')->isAvailable()) {
\FriendsOfRedaxo\AssetImport\AssetImporter::registerProvider(MyProvider::class);
}
```
## Provider implementieren
Ein Provider muss das ProviderInterface implementieren:
```php
public function getName(): string; // Eindeutiger Name
public function getTitle(): string; // Anzeigename
public function getIcon(): string; // FontAwesome Icon
public function isConfigured(): bool; // Prüft Konfiguration
public function getConfigFields(): array; // Konfigurationsfelder
public function search(): array; // Suchmethode
public function import(): bool; // Import Methode
public function getDefaultOptions(): array; // Standard-Optionen
```
Die abstrakte Klasse `AbstractProvider` bietet bereits:
- API Caching (24h)
- Medienpool Import
- Konfigurationsverwaltung
## Beispiel Provider für File import aus lokalem Ordner
### Was macht der Provider?
Der FTP Upload Provider ermöglicht es, Dateien aus einem definierten Upload-Verzeichnis in den REDAXO Medienpool zu importieren. Er ist ein gutes Beispiel dafür, wie ein eigener Provider für das Asset Import AddOn implementiert werden kann.
### Features
- Durchsucht das `ftpupload`-Verzeichnis im REDAXO-Root rekursiv
- Unterstützt Bilder (jpg, jpeg, png, gif, webp) und Videos (mp4, webm)
- Sortiert Dateien nach Änderungsdatum (neueste zuerst)
- Bietet Suche nach Dateinamen
- Paginierte Ergebnisse (20 pro Seite)
### Installation
1. Erstelle Provider-Klasse in deinem AddOn:
```php
// in /redaxo/src/addons/project/lib/Provider/FtpUploadProvider.php
'image'
];
}
protected function searchApi(string $query, int $page = 1, array $options = []): array
{
$items = [];
$type = $options['type'] ?? 'image';
$uploadPath = rex_path::base('ftpupload');
if (is_dir($uploadPath)) {
$files = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator($uploadPath, \RecursiveDirectoryIterator::SKIP_DOTS),
\RecursiveIteratorIterator::SELF_FIRST
);
foreach ($files as $file) {
if ($file->isFile()) {
$fileType = $this->getFileType($file->getFilename());
// Nur Bilder und Videos berücksichtigen
if ($fileType && ($type === 'all' || $type === $fileType)) {
if (empty($query) || stripos($file->getFilename(), $query) !== false) {
$relativePath = str_replace($uploadPath, '', $file->getPathname());
$relativePath = ltrim($relativePath, '/\\');
$filename = $file->getFilename();
$items[] = [
'id' => md5($relativePath),
'preview_url' => rex_url::base('ftpupload/' . $relativePath),
'title' => $filename,
'author' => 'FTP Upload',
'type' => $fileType,
'size' => [
'original' => ['url' => rex_url::base('ftpupload/' . $relativePath)]
]
];
}
}
}
}
// Sortiere nach Datum absteigend
usort($items, function($a, $b) use ($uploadPath) {
$timeA = filemtime($uploadPath . '/' . $a['title']);
$timeB = filemtime($uploadPath . '/' . $b['title']);
return $timeB - $timeA;
});
// Paginierung
$itemsPerPage = 20;
$offset = ($page - 1) * $itemsPerPage;
$items = array_slice($items, $offset, $itemsPerPage);
}
$total = count($items);
return [
'items' => $items,
'total' => $total,
'page' => $page,
'total_pages' => ceil($total / 20)
];
}
private function getFileType(string $filename): ?string
{
$ext = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
$types = [
'image' => ['jpg', 'jpeg', 'png', 'gif', 'webp'],
'video' => ['mp4', 'webm']
];
foreach ($types as $type => $extensions) {
if (in_array($ext, $extensions)) {
return $type;
}
}
return null;
}
}
```
2. Provider in deinem AddOn registrieren:
```php
// in /redaxo/src/addons/project/boot.php
if (\rex_addon::get('asset_import')->isAvailable()) {
\FriendsOfRedaxo\AssetImport\AssetImporter::registerProvider(\Project\Provider\FtpUploadProvider::class);
}
```
3. `ftpupload`-Verzeichnis im REDAXO-Root erstellen und Schreibrechte setzen
### Verzeichnisstruktur
```
redaxo/
├── src/
│ └── addons/
│ └── project/
│ ├── lib/
│ │ └── Provider/
│ │ └── FtpUploadProvider.php
│ └── boot.php
└── ftpupload/
├── bilder/
└── videos/
```
### Funktionsweise
1. **Verzeichnis-Scan:**
- Durchsucht das `ftpupload`-Verzeichnis rekursiv
- Filtert nach unterstützten Dateitypen
- Berücksichtigt nur Bilder und Videos
2. **Suche:**
- Filtert Dateien nach Suchbegriff im Dateinamen
- Typ-Filter für Bilder oder Videos
3. **Sortierung & Paginierung:**
- Sortiert nach Änderungsdatum (neueste zuerst)
- 20 Einträge pro Seite
- Unterstützt Blättern durch die Ergebnisse
4. **Import:**
- Nutzt den Standard-Import des AbstractProvider
- Importiert direkt in den Medienpool
## API Referenz
### AbstractProvider
Die Basisklasse, von der alle Provider erben müssen. Stellt grundlegende Funktionalitäten und Schnittstellen bereit.
#### Hauptmethoden
```php
public function getName(): string
```
Gibt einen eindeutigen Bezeichner für den Provider zurück.
```php
public function getTitle(): string
```
Gibt den Anzeigenamen zurück, der in der Benutzeroberfläche angezeigt wird.
```php
public function getIcon(): string
```
Gibt einen FontAwesome-Icon-Bezeichner zurück (z.B. 'fa-cloud').
```php
public function isConfigured(): bool
```
Prüft, ob der Provider alle erforderlichen Konfigurationseinstellungen hat.
```php
public function getConfigFields(): array
```
Gibt Konfigurationsfelder für die Provider-Einstellungsseite zurück. Jedes Feld sollte ein Array mit folgenden Elementen sein:
- `name`: Feldbezeichner
- `type`: Eingabetyp ('text', 'password', 'select')
- `label`: Übersetzungsschlüssel für das Label
- `notice`: Optionaler Übersetzungsschlüssel für Hilfetext
- `options`: Array von Optionen für Select-Felder
```php
public function search(string $query, int $page = 1, array $options = []): array
```
Führt die Suche durch und gibt Ergebnisse in folgendem Format zurück:
```php
[
'items' => [
[
'id' => string, // Eindeutige ID
'preview_url' => string, // Vorschaubild-URL
'title' => string, // Asset-Titel
'author' => string, // Ersteller/Autor
'type' => string, // 'image' oder 'video'
'size' => [ // Verfügbare Größen
'tiny' => ['url' => string],
'small' => ['url' => string],
'medium' => ['url' => string],
'large' => ['url' => string],
'original' => ['url' => string]
]
]
],
'total' => int, // Gesamtanzahl der Ergebnisse
'page' => int, // Aktuelle Seitennummer
'total_pages' => int // Gesamtanzahl der Seiten
]
```
```php
public function import(string $url, string $filename): bool
```
Importiert ein Asset in den REDAXO-Medienpool. Gibt bei Erfolg true zurück.
#### Geschützte Methoden
```php
protected function searchApi(string $query, int $page = 1, array $options = []): array
```
Implementierung der eigentlichen API-Suche. Muss von Provider-Klassen implementiert werden.
```php
protected function getCacheLifetime(): int
```
Gibt die Cache-Lebensdauer in Sekunden zurück. Standard: 86400 (24 Stunden)
```php
protected function getDefaultOptions(): array
```
Gibt Standard-Suchoptionen zurück. Standard: `['type' => 'all']`
### AssetImporter
Statische Klasse zur Verwaltung von Providern.
```php
public static function registerProvider(string $providerClass): void
```
Registriert eine neue Provider-Klasse.
```php
public static function getProviders(): array
```
Gibt alle registrierten Provider-Klassen zurück.
```php
public static function getProvider(string $name): ?AbstractProvider
```
Gibt Provider-Instanz anhand des Namens zurück oder null, wenn nicht gefunden.
### Cache
Das AddOn verwendet das eingebaute Caching-System von REDAXO, um API-Antworten zu speichern. Cache-Einträge werden in der Tabelle `rex_asset_import_cache` gespeichert mit:
- `provider`: Provider-Bezeichner
- `cache_key`: MD5-Hash der Abfrageparameter
- `response`: JSON-kodierte API-Antwort
- `created`: Erstellungszeitpunkt
- `valid_until`: Ablaufzeitpunkt
Die Standard-Cache-Lebensdauer beträgt 24 Stunden und kann pro Provider durch Überschreiben von `getCacheLifetime()` angepasst werden.
### Lizenz
MIT
## Lizenz
MIT Lizenz, siehe [LICENSE](LICENSE)
## Autoren
**Friends Of REDAXO**
* http://www.redaxo.org
* https://github.com/FriendsOfREDAXO
**Project Lead**
[Thomas Skerbis](https://github.com/skerbis)