summaryrefslogtreecommitdiffstats
path: root/lib/plugins/acts_as_tree/README
diff options
context:
space:
mode:
authorJean-Philippe Lang <jp_lang@yahoo.fr>2012-04-26 17:23:24 +0000
committerJean-Philippe Lang <jp_lang@yahoo.fr>2012-04-26 17:23:24 +0000
commit8d73ddf73ffc2cefbe16ca06970377e13d4bead0 (patch)
treeecb8fbb4d8330fe936c43127f2b921ad24eec2e8 /lib/plugins/acts_as_tree/README
parent26868d8b140406cce8c2494efbac7f8f85f452d0 (diff)
downloadredmine-8d73ddf73ffc2cefbe16ca06970377e13d4bead0.tar.gz
redmine-8d73ddf73ffc2cefbe16ca06970377e13d4bead0.zip
Moved Rails plugins required by the core to lib/plugins.
git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@9533 e93f8b46-1217-0410-a6f0-8f06a7374b81
Diffstat (limited to 'lib/plugins/acts_as_tree/README')
-rw-r--r--lib/plugins/acts_as_tree/README26
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/plugins/acts_as_tree/README b/lib/plugins/acts_as_tree/README
new file mode 100644
index 000000000..a6cc6a904
--- /dev/null
+++ b/lib/plugins/acts_as_tree/README
@@ -0,0 +1,26 @@
+acts_as_tree
+============
+
+Specify this +acts_as+ extension if you want to model a tree structure by providing a parent association and a children
+association. This requires that you have a foreign key column, which by default is called +parent_id+.
+
+ class Category < ActiveRecord::Base
+ acts_as_tree :order => "name"
+ end
+
+ Example:
+ root
+ \_ child1
+ \_ subchild1
+ \_ subchild2
+
+ root = Category.create("name" => "root")
+ child1 = root.children.create("name" => "child1")
+ subchild1 = child1.children.create("name" => "subchild1")
+
+ root.parent # => nil
+ child1.parent # => root
+ root.children # => [child1]
+ root.children.first.children.first # => subchild1
+
+Copyright (c) 2007 David Heinemeier Hansson, released under the MIT license \ No newline at end of file