contentbox.model.rss

Class RSSService

railo-context.Component
        extended by contentbox.model.rss.RSSService
Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  

    ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. RSS Services for this application

    Property Summary
    type property default serializable required
    any CBHelper


    • inject = id:CBHelper@cb
    true false
    any commentService


    • inject = id:commentService@cb
    true false
    any contentService


    • inject = id:contentService@cb
    true false
    any entryService


    • inject = id:entryService@cb
    true false
    any feedGenerator


    • inject = coldbox:plugin:FeedGenerator
    true false
    any log


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


    • inject = id:pageService@cb
    true false
    Constructor Summary
    init(any settingService, any cacheBox)
          Constructor.
    Method Summary
    private any buildCommentFeed([string slug=''], [string contentType=''])
         Build comment feeds according to filtering elements.
    private any buildContentFeed([any category=''])
         Build content feeds.
    private any buildEntryFeed([any category=''])
         Build entries feeds.
    private any buildPageFeed([any category=''])
         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=''])
         Build RSS feeds for contentbox content objects.
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init(any settingService, any cacheBox)

    Constructor

    Parameters:
    settingService
    cacheBox

    Property Detail

    CBHelper

    property any CBHelper

    Attributes:
    required - false
    inject - id:CBHelper@cb
    serializable - true

    commentService

    property any commentService

    Attributes:
    required - false
    inject - id:commentService@cb
    serializable - true

    contentService

    property any contentService

    Attributes:
    required - false
    inject - id:contentService@cb
    serializable - true

    entryService

    property any entryService

    Attributes:
    required - false
    inject - id:entryService@cb
    serializable - true

    feedGenerator

    property any feedGenerator

    Attributes:
    required - false
    inject - coldbox:plugin:FeedGenerator
    serializable - true

    log

    property any log

    Attributes:
    required - false
    inject - logbox:logger:{this}
    serializable - true

    pageService

    property any pageService

    Attributes:
    required - false
    inject - id:pageService@cb
    serializable - true

    Method Detail

    buildCommentFeed

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

    Build comment feeds according to filtering elements

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

    buildContentFeed

    private any buildContentFeed([any category=''])

    Build content feeds

    Parameters:
    category - The category to filter on if needed

    buildEntryFeed

    private any buildEntryFeed([any category=''])

    Build entries feeds

    Parameters:
    category - The category to filter on if needed

    buildPageFeed

    private any buildPageFeed([any category=''])

    Build pages feeds

    Parameters:
    category - The category to filter on if needed

    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=''])

    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]