Skip to main content

API reference

Use this section when you already know the workflow and need an exact class, method, configuration key, event, or failure contract.

AreaMain entry pointsReference
Configurationconfig/feeds.phpConfiguration
Feed classesFeed, FeedItem, FeedInfoFeeds and data
Output structureElementData, XML directivesElements, Directives
FormatsFeedFormatEnum, convertersSupported formats
RuntimeGeneratorService, FeedQuery, ScheduleFeedHelperRuntime services and contracts
LifecycleStarting and finished eventsEvents and exceptions
PresetsSitemap, RSS, Instagram, YandexPresets

Extension points

  • Extend Feed or a preset to define a data source and output contract.
  • Extend FeedItem and FeedInfo to control serialized data.
  • Implement DragonCode\LaravelFeed\Contracts\Transformer for custom scalar conversion.
  • Return DragonCode\LaravelFeed\Data\OptionalData when a field should be omitted.
  • Register macros on Feed, FeedItem, or FeedInfo for application-level helpers.

See Also