← Précédent · Retour au README · Suivant →
Éléments
Élément racine
Formats : XML, RSS, JSON
Par défaut, le nom de l’élément racine est dérivé du nom de base de la classe du flux.
Par exemple, pour la classe App\Feeds\FooBarFeed, ce nom est foo_bar.
Pour ajouter un élément racine et/ou ses attributs, remplacez la méthode root :
namespace App\Feeds;
use App\Models\User;
use DragonCode\LaravelFeed\Data\ElementData;
use DragonCode\LaravelFeed\Feeds\Feed;
use Illuminate\Database\Eloquent\Builder;
use function now;
class RootElementFeed extends Feed
{
public function builder(): Builder
{
return User::query();
}
public function root(): ElementData
{
return new ElementData(
name : 'foo',
attributes: [
'count' => $this->builder()->count(),
'generated_at' => now(),
],
);
}
}
Pour désactiver l’ajout de l’élément racine, indiquez un nom vide : null ou "".
Ce code produit le résultat suivant :
<?xml version="1.0" encoding="UTF-8"?>
<foo count="2" generated_at="2025-09-04T04:08:12+00:00">
<user>
<id>1</id>
<name>User 1</name>
</user>
<user>
<id>2</id>
<name>User 2</name>
</user>
</foo>
Informations
Formats : XML, RSS, JSON, JSONL, CSV
Pour ajouter des informations au début de l’élément racine, s’il existe, ou sans celui-ci, remplacez la méthode info dans la classe du flux et créez un objet qui étend DragonCode\LaravelFeed\Feeds\Info\FeedInfo :
namespace App\Feeds;
use App\Feeds\Info\InfoMethodFeedInfo;
use App\Models\User;
use DragonCode\LaravelFeed\Feeds\Feed;
use DragonCode\LaravelFeed\Feeds\Info\FeedInfo;
use Illuminate\Database\Eloquent\Builder;
class InfoMethodFeed extends Feed
{
public function builder(): Builder
{
return User::query();
}
public function info(): FeedInfo
{
return new InfoMethodFeedInfo;
}
}
namespace App\Feeds\Info;
use DragonCode\LaravelFeed\Feeds\Info\FeedInfo;
use function config;
class InfoMethodFeedInfo extends FeedInfo
{
public function toArray(): array
{
return [
'company' => config('app.name'),
'url' => config('app.url'),
];
}
}
Ce code produit le résultat suivant :
<?xml version="1.0" encoding="UTF-8"?>
<info_method>
<company>Laravel</company>
<url>https://example.com</url>
<user>
<id>1</id>
<name>User 1</name>
</user>
<user>
<id>2</id>
<name>User 2</name>
</user>
</info_method>
Pour modifier l’ordre de sortie de l’élément racine par rapport au bloc d’informations, définissez le paramètre beforeInfo dans la méthode root :
namespace App\Feeds;
use App\Feeds\Info\InfoMethodFeedInfo;
use App\Models\User;
use DragonCode\LaravelFeed\Data\ElementData;
use DragonCode\LaravelFeed\Feeds\Feed;
use DragonCode\LaravelFeed\Feeds\Info\FeedInfo;
use Illuminate\Database\Eloquent\Builder;
class InfoMethodBeforeFalseTest extends Feed
{
public function builder(): Builder
{
return User::query();
}
public function root(): ElementData
{
return new ElementData(
name : 'info_method',
beforeInfo: false
);
}
public function info(): FeedInfo
{
return new InfoMethodFeedInfo;
}
}
Ce code produit le résultat suivant :
<?xml version="1.0" encoding="UTF-8"?>
<company>Laravel</company>
<url>https://example.com</url>
<info_method>
<user>
<id>1</id>
<name>User 1</name>
</user>
<user>
<id>2</id>
<name>User 2</name>
</user>
</info_method>
En-tête et pied de page
Formats : XML, RSS, JSON
Pour modifier l’en-tête et le pied de page, remplacez les méthodes header et footer :
namespace App\Feeds;
use App\Models\User;
use DragonCode\LaravelFeed\Feeds\Feed;
use Illuminate\Database\Eloquent\Builder;
class HeaderFooterFeed extends Feed
{
public function builder(): Builder
{
return User::query();
}
public function header(): string
{
return '<rss xmlns:g="http://base.google.com/ns/1.0" version="2.0">';
}
public function footer(): string
{
return "\n<g:footer>This is a custom footer element</g:footer>";
}
}
Ce code produit le résultat suivant :
<rss xmlns:g="http://base.google.com/ns/1.0" version="2.0">
<header_footer>
<user>
<id>1</id>
<name>User 1</name>
</user>
<user>
<id>2</id>
<name>User 2</name>
</user>
</header_footer>
<g:footer>This is a custom footer element</g:footer>
Attributs
Formats : XML, RSS
namespace App\Feeds;
use App\Feeds\Items\AttributeFeedItem;
use App\Models\User;
use DragonCode\LaravelFeed\Feeds\Feed;
use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
class AttributeFeed extends Feed
{
public function builder(): Builder
{
return User::query();
}
public function item(Model $model): FeedItem
{
return new AttributeFeedItem($model);
}
}
namespace App\Feeds\Items;
use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
class AttributeFeedItem extends FeedItem
{
public function attributes(): array
{
return [
'created_at' => $this->model->created_at,
];
}
}
Ce code produit le résultat suivant :
<?xml version="1.0" encoding="UTF-8"?>
<attribute>
<user created_at="2025-09-04T04:08:12+00:00">
<id>1</id>
<name>User 1</name>
</user>
<user created_at="2025-09-04T04:08:12+00:00">
<id>2</id>
<name>User 2</name>
</user>
</attribute>
Répartir entre plusieurs fichiers
Formats : XML, RSS, JSON, JSONL, CSV
Si nécessaire, vous pouvez limiter le nombre de lignes écrites dans chaque fichier ainsi que le nombre de fichiers. Utilisez pour cela les fonctions perFile et maxFiles.
namespace App\Feeds;
use App\Models\User;
use DragonCode\LaravelFeed\Feeds\Feed;
use Illuminate\Database\Eloquent\Builder;
class AttributeFeed extends Feed
{
public function builder(): Builder
{
return User::query();
}
public function perFile(): int
{
return 100;
}
public function maxFiles(): int
{
return 10;
}
}
Les méthodes fonctionnent indépendamment l’une de l’autre.
Lors de la répartition, un numéro séquentiel est ajouté aux noms des fichiers. Exemple :
attribute-1.xmlattribute-2.xmlattribute-3.xml