FeedBuilder
in package
implements
Stringable
Provides an RSS feed builder with Atom extensions.
Table of Contents
Interfaces
- Stringable
Methods
- __toString() : string
- createEntry() : void
- Creates a feed item using a builder.
- setContentUrl() : void
- Sets the URL to the content this feed represents.
- setDescription() : void
- Sets the description of the feed, may contain HTML.
- setFeedUrl() : void
- Sets the URL to this feed's XML file.
- setTitle() : void
- Sets the title of the feed.
- setUpdatedAt() : void
- Sets the last updated time for this feed.
- toXmlDocument() : DOMDocument
- Creates a DOMDocument from this builder.
- toXmlString() : string
- Converts the XML Document to a printable string.
Methods
__toString()
public
__toString() : string
Return values
stringcreateEntry()
Creates a feed item using a builder.
public
createEntry(callable(FeedItemBuilder): void $handler) : void
Parameters
- $handler : callable(FeedItemBuilder): void
-
Item builder closure.
setContentUrl()
Sets the URL to the content this feed represents.
public
setContentUrl(string $url) : void
Parameters
- $url : string
-
Content URL.
setDescription()
Sets the description of the feed, may contain HTML.
public
setDescription(string $description) : void
Parameters
- $description : string
-
Feed description.
setFeedUrl()
Sets the URL to this feed's XML file.
public
setFeedUrl(string $url) : void
Parameters
- $url : string
-
Feed XML URL.
setTitle()
Sets the title of the feed.
public
setTitle(string $title) : void
Parameters
- $title : string
-
Feed title.
setUpdatedAt()
Sets the last updated time for this feed.
public
setUpdatedAt(DateTimeInterface|int $updatedAt) : void
Parameters
- $updatedAt : DateTimeInterface|int
-
Timestamp at which the feed was last updated.
toXmlDocument()
Creates a DOMDocument from this builder.
public
toXmlDocument() : DOMDocument
Return values
DOMDocument —XML document representing this feed.
toXmlString()
Converts the XML Document to a printable string.
public
toXmlString() : string
Return values
string —Printable XML document.