Brotkrueml\FeedGenerator\Contract\ItemInterface

interface ItemInterface

Fully qualified name

\Brotkrueml\FeedGenerator\Contract\ItemInterface

getId ( )

Get a unique identifier associated with this item. These are optional so long as a link is added; i.e. if no identifier is provided, the link is used.

returntype

string

getTitle ( )

Get the title of the item.

returntype

string

getDescription ( )

Get the description of the item.

returntype

Brotkrueml\FeedGenerator\Contract\TextInterface|string

getContent ( )

Get the content of the item. In JSON this is the HTML content.

returntype

string

getLink ( )

Get a URI to the HTML website containing the same or similar information as this item (i.e. if the feed is from a blog, it should provide the blog article's URI where the HTML version of the entry can be read).

returntype

string

getAuthors ( )

Get the data for authors. For an RSS feed only one author can be assigned.

returntype

Brotkrueml\FeedGenerator\Collection\Collection

getDatePublished ( )

Get the date on which this item was published. If null, the date used will be the current date and time.

returntype

DateTimeInterface

getDateModified ( )

Get the date on which this item was last modified. If null, the date used will be the current date and time.

Used in Atom and JSON.

returntype

DateTimeInterface

getAttachments ( )

Get the attachments (enclosure). In accordance with the RSS Best Practices Profile of the RSS Advisory Board, no support is offered for multiple enclosures since such support forms no part of the RSS specification.

JSON feeds support multiple attachments.

returntype

Brotkrueml\FeedGenerator\Collection\Collection

getCategories ( )

Get the categories for the item.

returntype

Brotkrueml\FeedGenerator\Collection\Collection

getExtensionContents ( )

Get extension contents for the item.

returntype

Brotkrueml\FeedGenerator\Collection\Collection