Версия: 1.x

Фиды и данные

Основной API разделяет источник данных, отображение элемента, метаданные фида, структуру вывода и результат генерации.

Feed

DragonCode\LaravelFeed\Feeds\Feed — базовый класс экспорта. Реализуйте builder() и переопределяйте только нужные фиду точки вывода.

abstract public function builder(): Builder

Метод	Значение по умолчанию	Контракт
`builder(): Builder`	Абстрактный	Возвращает запрос Eloquent, используемый как источник данных.
`item(Model $model): FeedItem`	Новый базовый `FeedItem`	Преобразует одну модель в элемент вывода.
`transformers(): array`	`[]`	Добавляет имена классов преобразователей в начало для этого фида.
`chunkSize(): int`	`1000`	Размер блока запроса к базе данных.
`perFile(): int`	`0`	Количество записей в файле. Ноль отключает разделение по количеству.
`maxFiles(): int`	`0`	Максимальное количество файлов. Ноль не ограничивает его.
`header(): string`	Декларация XML для XML/RSS	Содержимое перед корнем и элементами.
`footer(): string`	Пустая строка	Содержимое после корня и элементов.
`root(): ElementData`	Имя элемента из имени класса	Определяет корневой элемент и атрибуты.
`info(): FeedInfo`	Пустой `FeedInfo`	Определяет информацию уровня фида.
`filename(): string`	Имя файла из имени класса	Возвращает имя выходного файла относительно диска.
`path($suffix): string`	Путь от адаптера	Возвращает локальный или определённый адаптером путь.
`storagePath($suffix): string`	Имя файла относительно диска	Возвращает путь для операций с хранилищем.
`storage(): FilesystemAdapter`	Диск `public`	Получает и проверяет диск файловой системы Laravel.
`format(): FeedFormatEnum`	`Xml`	Возвращает настроенный формат вывода.
`converterOptions(): array`	`[]`	Возвращает унаследованные значения атрибута `Config` для этого фида; дочерние ключи переопределяют родительские.

Feed использует Laravel Conditionable и Macroable.

Цели фида

DragonCode\LaravelFeed\Feeds\FeedTarget определяет один независимо генерируемый вывод. Его конструктор принимает непустой строковый ключ и необязательный массив параметров:

public function __construct(public readonly string $key, public readonly array $parameters = [])

Реализуйте DragonCode\LaravelFeed\Contracts\HasFeedTargets в классе фида, которому нужна эта возможность. Необязательный трейт DragonCode\LaravelFeed\Concerns\InteractsWithFeedTargets реализует forTarget() и target(), а класс фида реализует поиск:

Метод	Контракт
`targets(): iterable`	Лениво возвращает все доступные `FeedTarget` для полного запуска командой или по расписанию.
`findTarget(string $key): ?FeedTarget`	Напрямую разрешает одну явно указанную в команде цель с тем же ключом или возвращает `null`.
`forTarget(FeedTarget $target): static`	Возвращает настроенный клон и сбрасывает сохранённое в памяти имя файла.
`target(): FeedTarget`	Возвращает настроенную цель или выбрасывает `LogicException`, если цель не задана.

Конструктор отклоняет пустые ключи и ключи только из пробелов, но не нормализует и не очищает остальные значения. Параметры цели непрозрачны для пакета и сериализуются как снимок задания очереди. Ключ идентифицирует цель, поэтому должен быть стабильным и уникальным в пределах класса фида. См. настройку отдельных выходных файлов и выбор цели в команде.

FeedItem и FeedInfo

FeedItem получает текущую модель Eloquent. Его стандартные значения:

name() возвращает базовое имя класса модели в kebab case;
attributes() возвращает пустой массив;
toArray() возвращает массив модели.

FeedInfo::toArray() возвращает пустой массив. Оба класса используют Conditionable и Macroable; расширяйте их, если выводу нужна явная схема.

Формат дат элемента

Добавьте #[DateFormat('Y-m-d H:i')] из DragonCode\LaravelFeed\Attributes\DateFormat к классу FeedItem, чтобы переопределить его формат дат.

Возвращайте исходные значения DateTimeInterface из toArray() и настройте преобразование дат в модели. Уже отформатированные строки повторно не форматируются:

namespace App\Feeds\Items;

use DragonCode\LaravelFeed\Attributes\DateFormat;
use DragonCode\LaravelFeed\Feeds\Items\FeedItem;

#[DateFormat('Y-m-d H:i')]
class ProductFeedItem extends FeedItem
{
    public function toArray(): array
    {
        return [
            'finishedAt' => $this->model->finished_at,
            'createdAt' => $this->model->created_at,
            'updatedAt' => $this->model->updated_at,
        ];
    }
}

Атрибут действует во всех форматах вывода, включая даты во вложенных структурах JSON/XML и даты, которые возвращает attributes() для атрибутов элементов XML/RSS.

Ближайший родительский класс с атрибутом задаёт наследуемый формат; атрибут в дочернем классе переопределяет его. Атрибут имеет приоритет над форматами дат фида и глобальными форматами, сохраняя feeds.date.timezone.

FeedInfo, атрибуты корня и другие элементы без этого атрибута используют обычную настроенную цепочку преобразований.

ElementData

ElementData — объект только для чтения с тремя свойствами конструктора:

Свойство	Тип	Значение по умолчанию
`name`	`?string`	`null`
`attributes`	`array`	`[]`
`beforeInfo`	`bool`	`true`

Задайте name как null или пустую строку, чтобы не выводить корневой элемент. Задайте beforeInfo как false, чтобы записать информацию фида перед корнем.

Результат генерации

GeneratorService::feed() возвращает GenerationResultData. Свойство только для чтения paths содержит опубликованные файлы по порядку. records сопоставляет каждому пути количество записей в файле.

Методы программной генерации и регистрации перечислены в сервисах и контрактах выполнения.

FeedFormatEnum

Вариант	Значение
`Xml`	`xml`
`Json`	`json`
`JsonLines`	`jsonl`
`Csv`	`csv`
`Rss`	`rss`

Feed​

Цели фида​

FeedItem и FeedInfo​

Формат дат элемента​

ElementData​

Результат генерации​

FeedFormatEnum​

Смотрите также​