版本：1.x

元素

根元素

格式： XML、RSS、JSON

提示

默认情况下，根元素名称由 Feed 类的基本名称生成。

例如，App\Feeds\FooBarFeed 类对应的名称是 foo_bar。

要添加根元素和／或其属性，请覆盖 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(),
            ],
        );
    }
}

要禁用根元素，请将其名称指定为空值，即 null 或 ""。

该代码会生成：

<?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>

信息

格式： XML、RSS、JSON、JSONL、CSV

要在根元素（如果存在）的开头添加信息，或在没有根元素时添加信息，请覆盖 Feed 类中的 info 方法，并创建一个继承 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'),
        ];
    }
}

该代码会生成：

<?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>

如需更改根元素与信息块的输出顺序，请在 root 方法中设置 beforeInfo 参数：

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;
    }
}

该代码会生成：

<?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>

页眉和页脚

格式： XML、RSS、JSON

要更改页眉和页脚，请覆盖 header 和 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>";
    }
}

该代码会生成：

<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>

属性

格式： 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,
        ];
    }
}

该代码会生成：

<?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>

拆分文件

格式： XML、RSS、JSON、JSONL、CSV

如有需要，可以限制每个文件的输出行数以及文件总数。使用 perFile 和 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;
    }
}

这两个方法彼此独立。

拆分时，文件名会添加连续编号。例如：

attribute-1.xml
attribute-2.xml
attribute-3.xml

根元素​

信息​

页眉和页脚​

属性​

拆分文件​

另请参阅​

根元素

信息

页眉和页脚

属性

拆分文件

另请参阅