ContentBox Core API 1.6.0

contentbox.model.rss
Class RSSService

WEB-INF.cftags.component
        extended by contentbox.model.rss.RSSService

public class RSSService
extends WEB-INF.cftags.component

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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 & Description Default Serializable Required
 any CBHelper


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


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


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


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


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


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


Attributes:
  • 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
 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 WEB-INF.cftags.component
None
 

Constructor Detail

init

public init(any settingService, any cacheBox)
Constructor

Parameters:
settingService
cacheBox
Property Detail

CBHelper

any CBHelper

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

commentService

any commentService

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

contentService

any contentService

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

entryService

any entryService

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

feedGenerator

any feedGenerator

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

log

any log

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

pageService

any pageService

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

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

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]

ContentBox Core API 1.6.0