contentbox.models.rss

Class RSSService

lucee.Component
    extended by contentbox.models.rss.RSSService

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- RSS Services for this application

Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any CBHelper


    • access = public
    • returntype = any
    • inject = CBHelper@contentbox
    true false
    any commentService


    • access = public
    • returntype = any
    • inject = commentService@contentbox
    true false
    any contentService


    • access = public
    • returntype = any
    • inject = contentService@contentbox
    true false
    any entryService


    • access = public
    • returntype = any
    • inject = entryService@contentbox
    true false
    any feedGenerator


    • access = public
    • returntype = any
    • inject = feedGenerator@cbfeeds
    true false
    any log


    • access = public
    • returntype = any
    • inject = logbox:logger:{this}
    true false
    any pageService


    • access = public
    • returntype = any
    • inject = pageService@contentbox
    true false
    Constructor Summary
    init(any settingService, any cacheBox)
          Constructor.
    Method Summary
    private any buildCommentFeed([string slug=''], [string contentType=''], [string siteID=''])
         Build comment feeds according to filtering elements.
    private any buildContentFeed([string category=''], [string siteID=''])
         Build content feeds.
    private any buildEntryFeed([string category=''], [string siteID=''])
         Build entries feeds.
    private any buildPageFeed([string category=''], [string siteID=''])
         Build pages feeds.
    private any cleanupContent(any content)
         Cleanup HTML to normal strings to avoid parsing issues.
    RSSService clearAllCaches([boolean async='false'])
         Clean All RSS caches NOW BABY, NOW!.
    RSSService clearCaches([boolean comments='false'], [string slug=''])
         Clean RSS caches asynchronously.
    any getRSS([string slug=''], [boolean comments='false'], [any category=''], [any contentType=''], [string siteID=''])
         Build RSS feeds for contentbox content objects.
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init(any settingService, any cacheBox)

    Constructor

    Parameters:
    settingService
    cacheBox

    Property Detail

    CBHelper

    property any CBHelper

    Attributes:
    access - public
    required - false
    returntype - any
    inject - CBHelper@contentbox
    serializable - true

    commentService

    property any commentService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - commentService@contentbox
    serializable - true

    contentService

    property any contentService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - contentService@contentbox
    serializable - true

    entryService

    property any entryService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - entryService@contentbox
    serializable - true

    feedGenerator

    property any feedGenerator

    Attributes:
    access - public
    required - false
    returntype - any
    inject - feedGenerator@cbfeeds
    serializable - true

    log

    property any log

    Attributes:
    access - public
    required - false
    returntype - any
    inject - logbox:logger:{this}
    serializable - true

    pageService

    property any pageService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - pageService@contentbox
    serializable - true

    Method Detail

    buildCommentFeed

    private any buildCommentFeed([string slug=''], [string contentType=''], [string siteID=''])

    Build comment feeds according to filtering elements

    Parameters:
    slug - The content slug to filter on
    contentType - The content type discriminator to filter on
    siteID - The site to filter on

    buildContentFeed

    private any buildContentFeed([string category=''], [string siteID=''])

    Build content feeds

    Parameters:
    category - The category to filter on
    siteID - The site to filter on

    buildEntryFeed

    private any buildEntryFeed([string category=''], [string siteID=''])

    Build entries feeds

    Parameters:
    category - The category to filter on
    siteID - The site to filter on

    buildPageFeed

    private any buildPageFeed([string category=''], [string siteID=''])

    Build pages feeds

    Parameters:
    category - The category to filter on
    siteID - The site to filter on

    cleanupContent

    private any cleanupContent(any content)

    Cleanup HTML to normal strings to avoid parsing issues

    Parameters:
    content

    clearAllCaches

    public RSSService clearAllCaches([boolean async='false'])

    Clean All RSS caches NOW BABY, NOW!

    Parameters:
    async

    clearCaches

    public RSSService clearCaches([boolean comments='false'], [string slug=''])

    Clean RSS caches asynchronously

    Parameters:
    comments - Clear comment caches or not, defaults to false
    slug - The content slug to clear on

    getRSS

    public any getRSS([string slug=''], [boolean comments='false'], [any category=''], [any contentType=''], [string siteID=''])

    Build RSS feeds for contentbox content objects

    Parameters:
    slug - The page or entry slug to filter on.
    comments - Retrieve the comments RSS feed or content feed, defaults to false
    category - Filter the content feed with categories
    contentType - The contentType to build an RSS feed on. Empty is for the site. Available content types are [page,entry]
    siteID - The site Id to filter on