跳到主要内容
版本：1.x

← 上一页 · 返回 README · 下一页 →

指令

格式： XML

保留指令

只有生成 XML 格式的 Feed 时才能使用这些指令。

@attributes​

表示属性数组。

可以使用名为 @attributes 的键为节点添加属性：

namespace App\Feeds;

use App\Feeds\Info\AttributesDirectiveFeedInfo;
use App\Feeds\Items\AttributesDirectiveFeedItem;
use App\Models\User;
use DragonCode\LaravelFeed\Feeds\Feed;
use DragonCode\LaravelFeed\Feeds\Info\FeedInfo;
use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class AttributesDirectiveFeed extends Feed
{
    public function builder(): Builder
    {
        return User::query();
    }

    public function info(): FeedInfo
    {
        return new AttributesDirectiveFeedInfo;
    }

    public function item(Model $model): FeedItem
    {
        return new AttributesDirectiveFeedItem($model);
    }
}
namespace App\Feeds\Info;

use DragonCode\LaravelFeed\Feeds\Info\FeedInfo;

use function fake;

class AttributesDirectiveFeedInfo extends FeedInfo
{
    public function toArray(): array
    {
        return [
            'company' => [
                '@attributes' => ['since' => fake()->year],
            ],

            'url' => config('app.url'),
        ];
    }
}
namespace App\Feeds\Items;

use DragonCode\LaravelFeed\Feeds\Items\FeedItem;

class AttributesDirectiveFeedItem extends FeedItem
{
    public function toArray(): array
    {
        return [
            'name' => $this->model->name,

            'contact' => [
                '@attributes' => [
                    'email' => $this->model->email,
                    'phone' => '555-000-' . $this->model->id,
                ],
            ],
        ];
    }
}

该代码会生成：

<?xml version="1.0" encoding="UTF-8"?>
<attributes_directive>

<company since="1994"/>
<url>https://example.com</url>

<user>
  <name>User 1</name>
  <contact email="[email protected]" phone="555-000-1"/>
</user>
<user>
  <name>User 2</name>
  <contact email="[email protected]" phone="555-000-2"/>
</user>

</attributes_directive>

@value​

表示直接使用指定值。

提示

@value 字段的值必须是字符串。

可以使用名为 @value 的键为节点添加值：

namespace App\Feeds\Items;

use DragonCode\LaravelFeed\Feeds\Items\FeedItem;

class ValueDirectiveFeedItem extends FeedItem
{
    public function toArray(): array
    {
        return [
            'name' => [
                '@value' => $this->model->name,
            ],

            'contact' => [
                '@attributes' => ['type' => 'email'],
                '@value'      => $this->model->email,
            ],
        ];
    }
}

该代码会生成：

<?xml version="1.0" encoding="UTF-8"?>
<value_directive>

<user>
  <name>User 1</name>
  <contact type="email">[email protected]</contact>
</user>
<user>
  <name>User 2</name>
  <contact type="email">[email protected]</contact>
</user>

</value_directive>

@cdata​

允许使用未经转换的 XML 标记。

提示

也可以将节点值包装在 CDATA 段中，从而使用保留字符。

可以使用名为 @cdata 的键为节点添加 CDATA：

namespace App\Feeds\Items;

use DragonCode\LaravelFeed\Feeds\Items\FeedItem;

use function sprintf;

class CdataDirectiveFeedItem extends FeedItem
{
    public function toArray(): array
    {
        return [
            'name' => [
                '@cdata' => sprintf('<h1>%s</h1>', $this->model->name),
            ],

            'email' => $this->model->email,
        ];
    }
}

该代码会生成：

<?xml version="1.0" encoding="UTF-8"?>
<cdata_directive>

<user>
  <name><![CDATA[<h1>User 1</h1>]]></name>
  <email>[email protected]</email>
</user>
<user>
  <name><![CDATA[<h1>User 2</h1>]]></name>
  <email>[email protected]</email>
</user>

</cdata_directive>

@mixed​

允许在文档结构中直接使用 XML 标记。

要原样插入 XML 片段，请使用 @mixed 指令：

namespace App\Feeds\Items;

use DragonCode\LaravelFeed\Feeds\Items\FeedItem;

class MixedDirectiveFeedItem extends FeedItem
{
    public function toArray(): array
    {
        return [
            'name' => $this->model->name,

            '@mixed' => <<<XML
                <some>
                    <first>Foo</first>
                    <second>{$this->model->email}</second>
                </some>
                XML,
        ];
    }
}

该代码会生成：

<?xml version="1.0" encoding="UTF-8"?>
<mixed_directive>

<user>
  <name>User 1</name>
  <some>
    <first>Foo</first>
    <second>[email protected]</second>
</some>
</user>
<user>
  <name>User 2</name>
  <some>
    <first>Foo</first>
    <second>[email protected]</second>
</some>
</user>

</mixed_directive>

@custom​

用于列出具有相同键的元素数组。

有时需要放置一组名称相同的元素。

为此，请在键名开头添加 @ 符号：

namespace App\Feeds\Items;

use DragonCode\LaravelFeed\Feeds\Items\FeedItem;

use function fake;

class ArrayDirectiveFeedItem extends FeedItem
{
    public function toArray(): array
    {
        return [
            'name' => $this->model->name,

            '@avatar' => [
                fake()->imageUrl(),
                fake()->imageUrl(),
            ],

            '@images' => [
                [
                    '@attributes' => ['name' => fake()->words(asText: true)],
                    '@value'      => fake()->imageUrl(),
                ],
                [
                    '@attributes' => ['name' => fake()->words(asText: true)],
                    '@value'      => fake()->imageUrl(),
                ],
            ],
        ];
    }
}

该代码会生成：

<?xml version="1.0" encoding="UTF-8"?>
<array_directive>

<user>
  <name>User 1</name>
  <avatar>https://via.placeholder.com/640x480.png/00ffff?text=aut</avatar>
  <avatar>https://via.placeholder.com/640x480.png/0022dd?text=et</avatar>
  <images name="doloremque distinctio facere">https://via.placeholder.com/640x480.png/0099dd?text=ea</images>
  <images name="fuga odio expedita">https://via.placeholder.com/640x480.png/00cc77?text=sint</images>
</user>
<user>
  <name>User 2</name>
  <avatar>https://via.placeholder.com/640x480.png/00ff99?text=est</avatar>
  <avatar>https://via.placeholder.com/640x480.png/003300?text=non</avatar>
  <images name="distinctio et aliquam">https://via.placeholder.com/640x480.png/0099aa?text=accusantium</images>
  <images name="consequatur soluta nemo">https://via.placeholder.com/640x480.png/0099cc?text=ab</images>
</user>

</array_directive>

另请参阅​