From 1902c4bf975a5c1decd199a5190b04d08a2e4760 Mon Sep 17 00:00:00 2001
From: hukl <hukl@eight.intern.artcom.de>
Date: Tue, 3 Feb 2009 16:47:43 +0100
Subject: added lots of comments to describe what the methods are doing. this
 will get everyone a better start. I hope

---
 app/helpers/content_helper.rb | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'app/helpers')

diff --git a/app/helpers/content_helper.rb b/app/helpers/content_helper.rb
index 385bca0..9800471 100644
--- a/app/helpers/content_helper.rb
+++ b/app/helpers/content_helper.rb
@@ -1,9 +1,25 @@
 module ContentHelper
   
+  # Returns the published_at attribute of a page if it is not nil, otherwise
+  # it returns the auto-filled value of the created_at attribute
   def date_for_page page
     page.published_at.to_s(:db) rescue page.created_at.to_s(:db)
   end
   
+  # This method is an output filter for templates. It accepts any kind of text
+  # and checks for an <aggregate /> tag within it. If such a tag is found, its 
+  # attributes are parsed and converted into parameters for the 
+  # render_collection method. The <aggregate /> tag will then be replaced 
+  # entirely with the output of the render_collection method.
+  #
+  # Syntax of the <aggregate /> tag:
+  #
+  # <aggregate 
+  #   flags="update, pressemitteilung"
+  #   limit="20"
+  #   order_by="published_at"
+  #   order_direction="DESC"
+  # />
   def aggregate? content
     options = {}
     
@@ -27,6 +43,8 @@ module ContentHelper
     end
   end
   
+  # Takes the parameters from the aggregate? method and renders the collection
+  # from Page.aggregate(options) with a given partial
   def render_collection options
     render(
       :partial => 'content/article', 
-- 
cgit v1.3