TYPO3 Logo
Feed Generator
Release: 0.4

Loading data.

  • Introduction
  • Installation
  • Developer corner
  • Configuration
  • Report
  • API
    • Enums
      • Brotkrueml\FeedGenerator\Format\FeedFormat
    • Classes
      • Brotkrueml\FeedGenerator\Entity\Author
      • Brotkrueml\FeedGenerator\Entity\Category
      • Brotkrueml\FeedGenerator\Entity\Enclosure
      • Brotkrueml\FeedGenerator\Entity\Image
      • Brotkrueml\FeedGenerator\Entity\Item
    • Interfaces
      • Brotkrueml\FeedGenerator\Contract\AuthorInterface
      • Brotkrueml\FeedGenerator\Contract\CategoryInterface
      • Brotkrueml\FeedGenerator\Contract\EnclosureInterface
      • Brotkrueml\FeedGenerator\Contract\FeedCategoryInterface
      • Brotkrueml\FeedGenerator\Contract\FeedFormatAwareInterface
      • Brotkrueml\FeedGenerator\Contract\FeedInterface
      • Brotkrueml\FeedGenerator\Contract\ImageInterface
      • Brotkrueml\FeedGenerator\Contract\ItemInterface
      • Brotkrueml\FeedGenerator\Contract\RequestAwareInterface
      • Brotkrueml\FeedGenerator\Contract\StyleSheetInterface
  • Changelog
  • Sitemap

PAGE CONTENTS

  • API
    • Overview
  1. Start
  2. API
View source How to edit Edit on GitHub

Display settings


Color scheme of code blocks:


API¶

This chapter provides information about all necessary interfaces, classes and enumerations. For up-to-date information, please read the source code. The interfaces and classes primarily serve as a façade for the laminas/laminas-feed and jdecool/jsonfeed libraries being used.

This extension provides some implementations of interfaces as value objects. However, you can also create your own implementations as long as they implement the appropriate interfaces.

enum FeedFormat {
   ATOM
   JSON
   RSS
}

interface AuthorInterface
interface CategoryInterface
interface FeedInterface
interface FeedCategoryInterface
interface FeedFormatAwareInterface
interface ImageInterface
interface ItemInterface
interface RequestAwareInterface
interface StyleSheetInterface

class Author
class Image
class Item

class YourFeed
note left: This is your feed implementation class

YourFeed -[hidden]> FeedFormat


Author <|.. AuthorInterface
Category <|.. CategoryInterface
Image <|.. ImageInterface
Item <|.. ItemInterface

FeedInterface ..|> YourFeed : required
FeedCategoryInterface ..|> YourFeed : optional
FeedFormatAwareInterface ..|> YourFeed : optional
RequestAwareInterface ..|> YourFeed : optional
StyleSheetInterface ..|> YourFeed : optional

Item "1" *-- "0 .. n" Author : contains

YourFeed "1" *-- "0 .. n" Author : contains
YourFeed "1" *-- "0 .. n" Category : contains
YourFeed "1" *-- "0 .. 1" Image : contains
YourFeed "1" *-- "0 .. n" Item : contains
YourFeed .. FeedFormat : used in attributes

Overview¶

  • Enums
    • Brotkrueml\FeedGenerator\Format\FeedFormat
  • Classes
    • Brotkrueml\FeedGenerator\Entity\Author
    • Brotkrueml\FeedGenerator\Entity\Category
    • Brotkrueml\FeedGenerator\Entity\Enclosure
    • Brotkrueml\FeedGenerator\Entity\Image
    • Brotkrueml\FeedGenerator\Entity\Item
  • Interfaces
    • Brotkrueml\FeedGenerator\Contract\AuthorInterface
    • Brotkrueml\FeedGenerator\Contract\CategoryInterface
    • Brotkrueml\FeedGenerator\Contract\EnclosureInterface
    • Brotkrueml\FeedGenerator\Contract\FeedCategoryInterface
    • Brotkrueml\FeedGenerator\Contract\FeedFormatAwareInterface
    • Brotkrueml\FeedGenerator\Contract\FeedInterface
    • Brotkrueml\FeedGenerator\Contract\ImageInterface
    • Brotkrueml\FeedGenerator\Contract\ItemInterface
    • Brotkrueml\FeedGenerator\Contract\RequestAwareInterface
    • Brotkrueml\FeedGenerator\Contract\StyleSheetInterface
  • Previous
  • Next
  • Issues
  • Repository

Last updated: Oct 31, 2022 11:27

Last rendered: Oct 31, 2022 11:29

  • TYPO3 Theme 4.7.9
  • DRC v3.0.dev30
© Copyright since 2022 by Chris Müller
  • Legal Notice
  • Privacy Policy
  • Code of Conduct