.. include:: /Includes.rst.txt

.. _api:

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

.. uml::

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

.. toctree::

   Enums/Index
   Classes/Index
   Interfaces/Index


.. _jdecool/jsonfeed: https://github.com/jdecool/jsonfeed
.. _laminas/laminas-feed: https://github.com/laminas/laminas-feed