1. AdvSearch
      1. AdvSearch.AdvSearch
        1. AdvSearch.AdvSearch.tpl
        2. AdvSearch.Advsearch.paging1Tpl
        3. AdvSearch.AdvSearch.paging0Tpl
        4. AdvSearch.AdvSearch.containerTpl
        5. Advsearch.AdvSearch.extractTpl
      2. AdvSearch.AdvSearchHelp
        1. AdvSearch.AdvSearchHelp.helplinkTpl
      3. AdvSearch.AdvSearchForm
        1. Advsearch.AdvSearchForm.tpl
    2. getYoutube
    3. aliasid
    4. AddHeaderfiles
    5. AjaxUpload
    6. amazonSES mailing list
    7. Analytics
    8. Archivist
      1. Archivist.Archivist
        1. Archivist.Archivist.tpl
      2. Archivist.ArchivistGrouper
      3. Archivist.getArchives
        1. Archivist.getArchives.tpl
    9. Articles
      1. Articles.Theming Articles
      2. Articles.Retrieving the next and previous article
      3. Articles.Roadmap
      4. Articles.Retrieving Articles Outside of Articles
      5. Articles.Creating a Blog
    10. Babel
      1. Babel.BabelLinks
      2. Babel.BabelTranslation
    11. BannerX
    12. BannerY
    13. Batcher
      1. Batcher.Roadmap
    14. bdListings
      1. bdListings.bdCategories
      2. bdListings.bdHookNewListing
      3. bdListings.bdListings
      4. bdListings.bdPriceGroups
      5. bdListings.bdRedirect
      6. bdListings.bdTargets
    15. boilerX
      1. bx-head-open
      2. bx-head-append
      3. bx-head-close
      4. bx-container-open
      5. bx-container-close
      6. bx-bottom-open
      7. bx-bottom-close
    16. BreadCrumb
      1. BreadCrumb.containerTpl
      2. BreadCrumb.currentCrumbTpl
      3. BreadCrumb.linkCrumbTpl
      4. BreadCrumb.maxCrumbTpl
    17. Breadcrumbs
    18. BxrExtra
    19. cachebuster
    20. CamperManagement
      1. CamperManagement.Customizing the Component
      2. CamperManagement.Developing the front-end
        1. CamperManagement.cmCamperDetails Snippet
        2. CamperManagement.cmCampers Snippet
        3. CamperManagement.Placeholders you can use
      3. CamperManagement.Managing your vehicle
      4. CamperManagement.Module home
    21. Church Events Calendar
      1. ChurchEvents.MODX Manager functions
      2. ChurchEventsCalendar Snippet
        1. ChurchEvents.Managing events
      3. ChurchEventsList Snippet
      4. ChurchEventsRss Snippet
    22. Cliche
    23. ClientConfig
    24. CMPGenerator
      1. CMPGenerator.5 minute example
      2. CMPGenerator.Foreign Databases
    25. ContextRouter
    26. CookieList
    27. CronManager
    28. cssSweet
      1. cssSweet.lighten
      2. cssSweet.modval
      3. cssSweet.prefix
    29. CustomUrls
    30. Databackup
    31. Discuss
      1. Discuss.ChunkMap
      2. Discuss.Contributing
      3. Discuss.Controllers
        1. Discuss.Controllers.board
          1. Discuss.Controllers.board.xml
        2. Discuss.Controllers.home
        3. Discuss.Controllers.login
        4. Discuss.Controllers.logout
        5. Discuss.Controllers.profile
        6. Discuss.Controllers.register
        7. Discuss.Controllers.search
        8. Discuss.Controllers.thread
      4. Discuss.Creating a Discuss Theme
      5. Discuss.Database Model
      6. Discuss.Features
      7. Discuss.Getting Started
      8. Discuss.Installation
        1. Discuss.Installation from Git
      9. Discuss.Roadmap
      10. Configuring Sphinx for Search
    32. DitsNews
    33. Eletters
      1. Eletters.API
      2. Eletters.FormIt
      3. Eletters.Import CSV
      4. Eletters.Templates
    34. EventManager
      1. EventManager.emListEvents
      2. EventManager.emNewReservationHook
    35. eventsCalendar2
      1. eventsCalendar2.eventsCalendar2
      2. eventsCalendar2.Generating events
      3. eventsCalendar2.tplCalendar2
      4. eventsCalendar2.tplCell2
      5. eventsCalendar2.tplEvent2
      6. eventsCalendar2.tplHead2
    36. EventsX
      1. EventsX.Examples
    37. ExerPlan
    38. fastField
    39. FileDownload R
      1. FileDownload R.FileDownload
      2. FileDownload R.FileDownloadLink
      3. FileDownload R.Plugins
    40. FileLister
      1. FileLister.FileLister
        1. FileLister.FileLister.directoryTpl
        2. FileLister.FileLister.fileLinkTpl
        3. FileLister.FileLister.fileTpl
        4. FileLister.FileLister.pathTpl
      2. FileLister.Roadmap
    41. FirstChildRedirect
    42. Flexibility
    43. ForcedPasswdChange
    44. FormIt
      1. FormIt.FormItCountryOptions
      2. FormIt.FormItRetriever
      3. FormIt.FormItStateOptions
      4. FormIt.Hooks
        1. FormIt.Hooks.email
        2. FormIt.Hooks.FormItAutoResponder
        3. FormIt.Hooks.math
        4. FormIt.Hooks.recaptcha
        5. FormIt.Hooks.redirect
        6. FormIt.Hooks.spam
      5. FormIt.Roadmap
      6. FormIt.Tutorials and Examples
        1. FormIt.Examples.Custom Hook
        2. FormIt.Examples.Simple Contact Page
        3. FormIt.Handling Selects, Checkboxes and Radios
        4. FormIt.Using a Blank NoSpam Field
      7. FormIt.Validators
    45. FormIt2db
    46. FormitFastPack
      1. FormitFastPack.Tutorial
      2. FormitFastPack.fieldSetDefaults
      3. FormitFastPack.field
      4. FormitFastPack.fiGenerateReport
    47. FormSave
    48. FoundationX
      1. FoundationX.How to Use FoundationX
    49. FX2themebase
      1. FX2.How to Use FX2
        1. FX2.For Theme Authors
      2. FX2.Included Extras
    50. Gallery
      1. Gallery.Example1
      2. Gallery.Gallery
        1. Gallery.Gallery.containerTpl
        2. Gallery.Gallery.thumbTpl
      3. Gallery.GalleryAlbums
        1. Gallery.GalleryAlbums.rowTpl
        2. Gallery.GalleryAlbums.containerTpl
      4. Gallery.GalleryItem
        1. Gallery.GalleryItem.albumTpl
        2. Gallery.GalleryItem.GalleryItemPagination
        3. Gallery.GalleryItem.tagTpl
        4. Gallery.GalleryItem.tpl
      5. Gallery.Plugins
        1. Gallery.Plugins.Galleriffic
        2. Gallery.Plugins.Slimbox
      6. Gallery.Roadmap
      7. Gallery.Setting Up the GalleryItem TV
      8. Gallery.Setting Up Your Gallery
    51. GatewayManager
    52. gCal
    53. getDate
    54. getFeed
      1. getFeed.Adding a Twitter Feed
    55. getPage
    56. getRelated
    57. getResourceField
    58. getResources
      1. getResources.Examples
        1. getResources.Building a RSS feed
        2. getResources.Category Index Page with Thumbnails
        3. getResources.Google XML Sitemap
    59. getUrlParam
    60. getRTImages
    61. getVimeo
    62. GoogleSiteMap
      1. GoogleSiteMap.GoogleSiteMap
        1. GoogleSiteMap.GoogleSiteMap.containerTpl
        2. GoogleSiteMap.GoogleSiteMap.itemTpl
      2. GoogleSiteMap.Roadmap
    63. GridClassKey
    64. HandyMan
      1. HandyMan.Frequently Asked Questions
      2. HandyMan.Installation
      3. HandyMan.Roadmap
    65. Hits
    66. HitsPage
    67. HybridAuth
      1. HybridAuth.Integrating Facebook
      2. HybridAuth.Integrating Google
      3. HybridAuth.Integrating Twitter
      4. HybridAuth.Integrating VK.com
    68. If
    69. Image+
    70. imageHERE
    71. ImageStyles
    72. ImportX
    73. LexRating
    74. Lingua
    75. Login
      1. Login.ChangePassword
      2. Login.ConfirmRegister
      3. Login.ForgotPassword
      4. Login.Login
      5. Login.Profile
      6. Login.Register
        1. Register.Example Form 1
      7. Login.ResetPassword
      8. Login.Roadmap
      9. Login.Tutorials
        1. Login.Basic Setup
        2. Login.Extended User Profiles
        3. Login.Request Membership
        4. Login.User Profiles
        5. Login.Using Custom Fields
        6. Login.Using Pre and Post Hooks
      10. Login.UpdateProfile
    76. Loginza
      1. Loginza.Loginza
      2. tpl.Loginza.login
      3. tpl.Loginza.logout
      4. tpl.Loginza.profile
    77. mChimpX
    78. MetaX
    79. mhPayPal
      1. mhPayPal.Snippet Usage
        1. mhPayPal.Snippet Usage.Hooks
        2. mhPayPal.Snippet Usage.Templating
    80. MIGX
      1. MIGX.Backend-Usage
      2. MIGX.Data-Entry
      3. MIGX.Frontend-Usage
      4. MIGX.Tutorials
        1. MIGX.Fancybox-images with seperate placeholders in Richtext-Content
        2. MIGX.Simple opening hours table
        3. Using resource-specific mediasource and multifile-uploader with MIGX
        4. MIGX.Varying layout-boxes
          1. MIGX.Varying layout-boxes.Configurator-Version
        5. Creating Selectable and Sortable lists for MIGX
        6. MIGX.sortable resourcelist
        7. Using resource-specific mediasource and multifile-uploader with MIGX
    81. MIGXdb
      1. MIGXdb.Configuration
      2. MIGXdb.Tutorials
        1. MIGXdb.Create a basic gallery-management from scratch with MIGXdb
        2. MIGXdb.Create doodles manager with help of MIGXdb
        3. MIGXdb.Manage Child-Resources in a grid-TV with help of MIGXdb
        4. MIGXdb.Manage Events-Resources in a CMP with help of MIGXdb
    82. MinifyX
    83. miniShop
      1. miniShop.Screenshots
    84. modActiveDirectory
    85. ModDef
    86. modExtra
    87. modMobile
    88. modSwiftMailer
    89. mxCalendar
      1. mxCalendar.Examples
      2. mxCalendar.Placeholders
    90. mxExtendedMenu
    91. mxFormBuilder
      1. mxFormBuilder.Create Form
      2. mxFormBuilder.Hooks
      3. mxFormBuilder.Field Types
      4. mxFormBuilder.Create Form List in TV
      5. mxFormBuilder.Fields
    92. mxHasTvs
    93. MoneyBird
      1. MoneyBird.Contacts
      2. MoneyBird.Invoices
      3. MoneyBird.NrFormat
    94. ObfuscateEmail-Revo
    95. PackMan
      1. PackMan.Roadmap
    96. PageBreaker
      1. PageBreaker.PageBreaker
      2. tpl.PageBreaker.ajax
      3. tpl.PageBreaker.navigation
    97. Peoples
      1. Peoples.PeopleGroup
        1. Peoples.PeopleGroup.userTpl
      2. Peoples.PeopleGroups
        1. Peoples.PeopleGroups.tpl
      3. Peoples.Peoples
        1. Peoples.Peoples.tpl
      4. Peoples.Roadmap
    98. PHP Tidy (plugin)
    99. phpThumbOf
    100. Polls
      1. Polls.Polls
      2. Polls.PollsLatest
      3. Polls.PollsPrevious
      4. Polls.PollsResult
    101. POI Manager
    102. QuickCrumbs
      1. QuickCrumbs.Example
    103. Quip
      1. Quip.Quip
        1. Quip.Quip.tplComment
        2. Quip.Quip.tplCommentOptions
        3. Quip.Quip.tplComments
        4. Quip.Quip.tplReport
      2. Quip.QuipCount
      3. Quip.QuipLatestComments
      4. Quip.QuipReply
        1. Quip.QuipReply.tplAddComment
        2. Quip.QuipReply.tplLoginToComment
        3. Quip.QuipReply.tplPreview
      5. Quip.QuipRss
      6. Quip.Roadmap
      7. Quip.Upgrading
        1. Quip.Upgrading to 1.0.1
    104. Rampart
      1. Rampart.hook.RampartFormIt
      2. Rampart.hook.RampartQuip
      3. Rampart.preHook.RampartRegister
    105. Redirector
    106. renderResources
    107. ResourceWatcher
    108. RezImgCrop
    109. Rowboat
      1. Rowboat.Rowboat
    110. sekFancyBox
      1. sekFancyBox & Gallery
    111. sekFormTools
      1. sekFormTools.input.autocomplete
      2. sekFormTools.input.combobox
      3. sekFormTools.input.datepicker
      4. sekFormTools.input.helper
      5. sekFormTools.input.textfield
      6. sekFormTools Advanced Examples
    112. sekSiteTools
      1. sekSiteTools.easytabs
      2. sekSiteTools.google.analytics
      3. sekSiteTools.printdiv
    113. sekUserGalleries
      1. sekUserGalleries.album.items.helper
      2. sekUserGalleries.album.items.manage
      3. sekUserGalleries.album.manage
      4. sekUserGalleries.album.view
      5. sekUserGalleries.browse.galleries
      6. sekUserGalleries.directory
      7. sekUserGalleries.image.information
      8. sekUserGalleries.search
      9. sekUserGalleries.users.gallery.manage
      10. sekUserGalleries.users.gallery.view
    114. selfLink
    115. Shopkeeper
    116. siblingNav
    117. SimpleSearch
      1. SimpleSearch.Roadmap
      2. SimpleSearch.SimpleSearch
        1. SimpleSearch.Faceted Search Through PostHooks
        2. SimpleSearch.SimpleSearch.containerTpl
        3. SimpleSearch.SimpleSearch.currentPageTpl
        4. SimpleSearch.SimpleSearch.pageTpl
        5. SimpleSearch.SimpleSearch.tpl
      3. SimpleSearch.SimpleSearchForm
        1. SimpleSearch.SimpleSearchForm.tpl
      4. SimpleSearch.Solr
    118. SiteEditor
    119. sitemapFriend
    120. Slideshow Manager
      1. jgSlideshow Snippet
      2. Slideshow Manager CMP
    121. sLink
    122. SmartOptimizer
    123. SmartTag
    124. StatCache
    125. SocialLogin
    126. SocialSuite
      1. SocialSuite.getFacebookPhotos
      2. SocialSuite.getFacebookProfile
      3. SocialSuite.getFacebookShares
      4. SocialSuite.getGooglePlusShares
      5. SocialSuite.getTwitterProfile
      6. SocialSuite.prettyNumbers
    127. spieFeed
    128. StaticSaver
    129. StoreLocator
    130. SubscribeMe
      1. SubscribeMe.Configuring API Credentials, IPN and going Live
      2. SubscribeMe.Setting up the Payment Flow
        1. SubscribeMe - Listing the Products
        2. SubscribeMe - Setting up the Payment Methods
        3. SubscribeMe - Subscription Confirmation Page
      3. SubscribeMe.User Account Management
    131. SyntaxChecker
    132. TaggingAtoZ
    133. tagLister
      1. tagLister.getResourcesTag
      2. tagLister.tagLister
        1. tagLister.tagLister.all
        2. tagLister.tagLister.tpl
      3. tagLister.tolinks
        1. tagLister.tolinks.tpl
    134. TinyMCE
      1. TinyMCE.Spellchecker
      2. TinyMCE.Table controls
      3. TinyMCE.Template
    135. Upload to Users CMP
    136. VersionX
      1. VersionX.Roadmap
    137. virtuNewsletter
    138. VisionCart
      1. VisionCart.Back-end
        1. VisionCart.Category management
        2. VisionCart.Module management
        3. VisionCart.Option management
        4. VisionCart.Order management
        5. VisionCart.Product management
        6. VisionCart.Shop management
      2. VisionCart.Front-end
        1. VisionCart.vcGetCategories
          1. VisionCart.vcGetCategories.tpl
        2. VisionCart.vcGetProducts
          1. VisionCart.vcGetProducts.tpl
        3. VisionCart.vcWayfinder
      3. VisionCart.General
        1. VisionCart.Templating
        2. VisionCart.UserManagement
      4. VisionCart.vcGetProductImages
      5. VisionCart.vcGetProductOptions
    139. Wayfinder
      1. Wayfinder Introductory Examples
    140. xFPC
    141. Tagger

spieFeed

This is a user-contributed Extra. If you find issues or would like more info or help, please contact the author.

Description

The RSS/Atom feeder based on SimplePie 1.2 which is already included in the package: http://github.com/rmccue/simplepie/downloads

Requirements

  • MODx Revolution 2.0.0-RC-2 or later
  • PHP5 or later

History

spieFeed integration was written by goldsky as the RSS/Atom feeder, and first released on Oct 18, 2010.

Download

It can be downloaded from within the MODx Revolution manager via [Package Management], or from the MODx Extras Repository, here: http://modxcms.com/extras/package/738 or here: http://modx.com/extras/package/spiefeed

Development and Bug Reporting

spieFeed is stored and developed in GitHub, and can be found here:https://github.com/goldsky/spiefeed

Bugs can be filed here: https://github.com/goldsky/spiefeed/issues

Usage

spieFeed is used by placing the Snippet call into your content and passing a 'url' parameter:

[[!spieFeed? &setFeedUrl=`http://path.com/to/my/rss.feed.rss`]]

For multiple sources can call this

http://feeds.feedburner.com/modx-announce | http://www.voanews.com/templates/Articles.rss?sectionPath=/russian/news

separated by pipe ( | ) symbol(s).

Available Properties

Name Description Options Default
setFeedUrl URL of the feed to retrieve. Any URL http://feeds.feedburner.com/modx-announce | http://www.voanews.com/templates/Articles.rss?sectionPath=/russian/news
enableCache This option allows you to disable caching all-together in SimplePie.
However, disabling the cache can lead to longer load times. info
0 | 1 1
enableOrderByDate Sometimes feeds don't have their items in chronological order.
By default, SimplePie will re-order them to be in such an order.
With this option, you can enable/disable the reordering of items into reverse chronological order if you don't want it. info
0 | 1
1
setCacheDuration Set the minimum time (in seconds) for which a feed will be cached. info
integers in seconds 3600
setCacheLocation Set the file system location (not WWW location) where the cache files should be written. The cache folder should be make or error will be returned. info
  core/components/spiefeed/cache
setFaviconHandler Set the handler to enable the display of cached favicons. info
[str image handler file], [query] false, "i"
setItemLimit Set the maximum number of items to return per feed with Multifeeds.
This is NOT for limiting the number of items to loop through in a single feed.
For that, you want to pass $start and $length parameters to get_items(). info
integer null
setJavascript Set the query string that triggers SimplePie to generate the JavaScript code for embedding media files. info javascript query string parameter js
stripAttributes Set which attributes get stripped from an entry's content.
The default set of attributes is stored in the property SimplePie?strip_attributes,  not to be confused with the method SimplePie?strip_attributes().
This way, you can modify the existing list without having to create a whole new one. info
attributes get stripped from an entry"s content array("bgsound", "class", "expr", "id", "style", "onclick", "onerror", "onfinish", "onmouseover", "onmouseout", "onfocus", "onblur", "lowsrc", "dynsrc")
stripComments Set whether to strip out HTML comments from an entry's content. info
0 | 1
0
stripHtmlTags Set which HTML tags get stripped from an entry's content.
The default set of tags is stored in the property SimplePie?strip_htmltags,  not to be confused with the method SimplePie?strip_htmltags().
This way, you can modify the existing list without having to create a whole new one. info
HTML tags get stripped from an entry"s content array("base", "blink", "body", "doctype", "embed", "font", "form", "frame", "frameset", "html", "iframe", "input", "marquee", "meta", "noscript", "object", "param", "script", "style")
dateFormat Date format supports anything that works with PHP's date() function. Only supports the English language. info
PHP"s date() "j F Y, g:i a"
localDateFormat Returns the date/timestamp of the posting in the localized language.  Date format supports anything that works with PHP's strftime() function.  To display in other languages, you need to change the locale with PHP's setlocale() function. The available localizations depend on which ones are installed on your web server. info
PHP"s strftime() of the posting in the localized language. setlocale() matters. "%c"
getItemStart Returns an array of SimplePie_Item references for each item in the feed, which can be looped through. info
integers 0
getItemLength Returns an array of SimplePie_Item references for each item in the feed, which can be looped through. info integers 0
forceFSockopen If cURL is available, SimplePie will use it instead of the built-in fsockopen functions for fetching remote feeds. This config option will force SimplePie to use fsockopen even if cURL is installed. info
0 | 1
1
setInputEncoding Allows you to override the character encoding of the feed.
This is only useful for times when the feed is reporting an incorrect character encoding (as per RFC 3023 and Determining the character encoding of a feed).
This setting is similar to set_output_encoding().
The number of supported character encodings depends on whether your web host supports mbstring, iconv, or both.  See Supported Character Encodings for more information. info
http://simplepie.org/wiki/faq/supported_character_encodings false
setOutputEncoding Allows you to override SimplePie's output to match that of your webpage.
This is useful for times when your webpages are not being served as UTF-8.
This setting will be obeyed by handle_content_type(), and is similar to set_input_encoding().
It should be noted, however, that not all character encodings can support all characters.
If your page is being served as ISO-8859-1 and you try to display a Japanese feed, you'll likely see garbled characters. Because of this, it is highly recommended to ensure that your webpages are served as UTF-8.
The number of supported character encodings depends on whether your web host supports mbstring, iconv, or both. See Supported Character Encodings for more information. info
http://simplepie.org/wiki/faq/supported_character_encodings "UTF-8"
sortBy Allow you to sort the result by one of the available placeholders
placeholders date
sortOrder The sorting order
ASC | DESC
DESC
tpl Template
chunk name defaultSpieFeedTpl
rowCls Class name for each row
class name spie-row
firstRowCls Class name for the first row
class name spie-first-row
lastRowCls Class name for the last row
class name spie-last-row
oddRowCls Class name for the odd row
class name spie-odd-row
&debug (1.5-pl)
Debug mode, to return Simple Pie's error
0 | 1
0
&toArray (1.5-pl)
Return the result as an array
0 | 1
0
&emptyMessage (1.5-pl)
Custom message on the empty return
anything
 

Available Placeholders

  • favicon
  • link
  • title
  • description
  • content
  • permalink
  • imageLink
  • imageTitle
  • imageUrl
  • imageWidth
  • imageHeight
  • date
  • localDate
  • copyright
  • latitude
  • longitude
  • language
  • encoding
  • authorName
  • authorLink
  • authorEmail
  • category
  • contributor
  • getType
  • itemImageThumbnailUrl
  • itemImageWidth
  • itemImageHeight