/doc/classes/ActsCrummy/BreadcrumbsHelper.html

http://acts-crummy.googlecode.com/ · HTML · 186 lines · 137 code · 46 blank · 3 comment · 0 complexity · 1d140b01819279a19825ae9bfc6a490e MD5 · raw file 

    

  1. <?xml version="1.0" encoding="iso-8859-1"?>

    2. 

  2. <!DOCTYPE html 

    3. 

  3.      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

    4. 

  4.      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

    5. 

  5. 

    6. 

  6. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

    7. 

  7. <head>

    8. 

  8.   <title>Module: ActsCrummy::BreadcrumbsHelper</title>

    9. 

  9.   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />

    10. 

  10.   <meta http-equiv="Content-Script-Type" content="text/javascript" />

    11. 

  11.   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />

    12. 

  12.   <script type="text/javascript">

    13. 

  13.   // <![CDATA[

    14. 

  14. 

    15. 

  15.   function popupCode( url ) {

    16. 

  16.     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")

    17. 

  17.   }

    18. 

  18. 

    19. 

  19.   function toggleCode( id ) {

    20. 

  20.     if ( document.getElementById )

    21. 

  21.       elem = document.getElementById( id );

    22. 

  22.     else if ( document.all )

    23. 

  23.       elem = eval( "document.all." + id );

    24. 

  24.     else

    25. 

  25.       return false;

    26. 

  26. 

    27. 

  27.     elemStyle = elem.style;

    28. 

  28.     

    29. 

  29.     if ( elemStyle.display != "block" ) {

    30. 

  30.       elemStyle.display = "block"

    31. 

  31.     } else {

    32. 

  32.       elemStyle.display = "none"

    33. 

  33.     }

    34. 

  34. 

    35. 

  35.     return true;

    36. 

  36.   }

    37. 

  37.   

    38. 

  38.   // Make codeblocks hidden by default

    39. 

  39.   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )

    40. 

  40.   

    41. 

  41.   // ]]>

    42. 

  42.   </script>

    43. 

  43. 

    44. 

  44. </head>

    45. 

  45. <body>

    46. 

  46. 

    47. 

  47. 

    48. 

  48. 

    49. 

  49.     <div id="classHeader">

    50. 

  50.         <table class="header-table">

    51. 

  51.         <tr class="top-aligned-row">

    52. 

  52.           <td><strong>Module</strong></td>

    53. 

  53.           <td class="class-name-in-header">ActsCrummy::BreadcrumbsHelper</td>

    54. 

  54.         </tr>

    55. 

  55.         <tr class="top-aligned-row">

    56. 

  56.             <td><strong>In:</strong></td>

    57. 

  57.             <td>

    58. 

  58.                 <a href="../../files/lib/breadcrumbs_helper_rb.html">

    59. 

  59.                 lib/breadcrumbs_helper.rb

    60. 

  60.                 </a>

    61. 

  61.         <br />

    62. 

  62.             </td>

    63. 

  63.         </tr>

    64. 

  64. 

    65. 

  65.         </table>

    66. 

  66.     </div>

    67. 

  67.   <!-- banner header -->

    68. 

  68. 

    69. 

  69.   <div id="bodyContent">

    70. 

  70. 

    71. 

  71. 

    72. 

  72. 

    73. 

  73.   <div id="contextContent">

    74. 

  74. 

    75. 

  75.     <div id="description">

    76. 

  76.       <p>

    77. 

  77. This module is mixed into ActionView::Base to provide the ability to render

    78. 

  78. breadcrumbs using the structure from the models.

    79. 

  79. </p>

    80. 

  80. 

    81. 

  81.     </div>

    82. 

  82. 

    83. 

  83. 

    84. 

  84.    </div>

    85. 

  85. 

    86. 

  86.     <div id="method-list">

    87. 

  87.       <h3 class="section-bar">Methods</h3>

    88. 

  88. 

    89. 

  89.       <div class="name-list">

    90. 

  90.       <a href="#M000001">render_breadcrumbs</a>&nbsp;&nbsp;

    91. 

  91.       </div>

    92. 

  92.     </div>

    93. 

  93. 

    94. 

  94.   </div>

    95. 

  95. 

    96. 

  96. 

    97. 

  97.     <!-- if includes -->

    98. 

  98. 

    99. 

  99.     <div id="section">

    100. 

  100. 

    101. 

  101. 

    102. 

  102.     <div id="constants-list">

    103. 

  103.       <h3 class="section-bar">Constants</h3>

    104. 

  104. 

    105. 

  105.       <div class="name-list">

    106. 

  106.         <table summary="Constants">

    107. 

  107.         <tr class="top-aligned-row context-row">

    108. 

  108.           <td class="context-item-name">DEFAULT_BREADCRUMB_SEPARATOR</td>

    109. 

  109.           <td>=</td>

    110. 

  110.           <td class="context-item-value">' &amp;gt; '</td>

    111. 

  111.         </tr>

    112. 

  112.         </table>

    113. 

  113.       </div>

    114. 

  114.     </div>

    115. 

  115. 

    116. 

  116. 

    117. 

  117. 

    118. 

  118.       

    119. 

  119. 

    120. 

  120. 

    121. 

  121.     <!-- if method_list -->

    122. 

  122.     <div id="methods">

    123. 

  123.       <h3 class="section-bar">Public Instance methods</h3>

    124. 

  124. 

    125. 

  125.       <div id="method-M000001" class="method-detail">

    126. 

  126.         <a name="M000001"></a>

    127. 

  127. 

    128. 

  128.         <div class="method-heading">

    129. 

  129.           <a href="#M000001" class="method-signature">

    130. 

  130.           <span class="method-name">render_breadcrumbs</span><span class="method-args">(child, options = {})</span>

    131. 

  131.           </a>

    132. 

  132.         </div>

    133. 

  133.       

    134. 

  134.         <div class="method-description">

    135. 

  135.           <p>

    136. 

  136. Renders breadcrumbs up the model hierarchy starting with <tt>child</tt>,

    137. 

  137. creating a link for each item, and returning the result as a string. It

    138. 

  138. works by selecting the return value of the method parent from each model

    139. 

  139. object. Each parent value is expected to be an instance of a model so that

    140. 

  140. a link can be rendered. As a convenience, the method

    141. 

  141. ActiveRecord::Base.is_child_to is provided so that the existing model does

    142. 

  142. not need to be altered to use breadcrumbs.

    143. 

  143. </p>

    144. 

  144. <p>

    145. 

  145. The only allowable currently is <tt>:level</tt>, which is an optional

    146. 

  146. integer to limit the number of parent links displayed to.

    147. 

  147. </p>

    148. 

  148.           <p><a class="source-toggle" href="#"

    149. 

  149.             onclick="toggleCode('M000001-source');return false;">[Source]</a></p>

    150. 

  150.           <div class="method-source-code" id="M000001-source">

    151. 

  151. <pre>

    152. 

  152.     <span class="ruby-comment cmt"># File lib/breadcrumbs_helper.rb, line 19</span>

    153. 

  153. 19:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">render_breadcrumbs</span> <span class="ruby-identifier">child</span>, <span class="ruby-identifier">options</span> = {}

    154. 

  154. 20:       <span class="ruby-identifier">i</span>, <span class="ruby-identifier">level</span> = <span class="ruby-value">0</span>, (<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:level</span>] <span class="ruby-operator">||</span> <span class="ruby-value">-1</span>)

    155. 

  155. 21:       <span class="ruby-identifier">urls</span> = [<span class="ruby-identifier">describe_model</span>(<span class="ruby-identifier">child</span>)]

    156. 

  156. 22:       <span class="ruby-identifier">parent</span> = <span class="ruby-identifier">child</span>

    157. 

  157. 23: 

    158. 

  158. 24:       <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:parent</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">level</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">parent</span> = <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">parent</span>)

    159. 

  159. 25:         <span class="ruby-identifier">i</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>

    160. 

  160. 26:         <span class="ruby-comment cmt"># if block_given?</span>

    161. 

  161. 27:         <span class="ruby-identifier">urls</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">parent_link</span>(<span class="ruby-identifier">parent</span>, <span class="ruby-identifier">options</span>))

    162. 

  162. 28:         <span class="ruby-comment cmt"># else</span>

    163. 

  163. 29:         <span class="ruby-comment cmt">#   urls.unshift(parent_link(parent))</span>

    164. 

  164. 30:         <span class="ruby-comment cmt"># end          </span>

    165. 

  165. 31:       <span class="ruby-keyword kw">end</span>

    166. 

  166. 32: 

    167. 

  167. 33:       <span class="ruby-identifier">urls</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:separator</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">DEFAULT_BREADCRUMB_SEPARATOR</span>)

    168. 

  168. 34:     <span class="ruby-keyword kw">end</span>

    169. 

  169. </pre>

    170. 

  170.           </div>

    171. 

  171.         </div>

    172. 

  172.       </div>

    173. 

  173. 

    174. 

  174. 

    175. 

  175.     </div>

    176. 

  176. 

    177. 

  177. 

    178. 

  178.   </div>

    179. 

  179. 

    180. 

  180. 

    181. 

  181. <div id="validator-badges">

    182. 

  182.   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>

    183. 

  183. </div>

    184. 

  184. 

    185. 

  185. </body>

    186. 

  186. </html>
    187.