diaspora/doc/AspectsHelper.html
2011-06-13 16:12:32 -07:00

382 lines
No EOL
15 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: AspectsHelper
&mdash; Documentation by YARD 0.7.1
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="_index.html">Index (A)</a> &raquo;
<span class="title">AspectsHelper</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: AspectsHelper
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">app/helpers/aspects_helper.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>
Copyright &#169; 2010, Diaspora Inc. This file is
</p>
<pre class="code">
<span class='licensed identifier id'>licensed</span> <span class='under identifier id'>under</span> <span class='the identifier id'>the</span> <span class='Affero constant id'>Affero</span> <span class='General constant id'>General</span> <span class='Public constant id'>Public</span> <span class='License constant id'>License</span> <span class='version identifier id'>version</span> <span class='integer val'>3</span> <span class='or or kw'>or</span> <span class='later identifier id'>later</span><span class='dot token'>.</span> <span class='See constant id'>See</span>
<span class='the identifier id'>the</span> <span class='COPYRIGHT constant id'>COPYRIGHT</span> <span class='file identifier id'>file</span><span class='dot token'>.</span>
</pre>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#add_to_aspect_button-instance_method" title="#add_to_aspect_button (instance method)">- (Object) <strong>add_to_aspect_button</strong>(aspect_id, person_id) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#aspect_membership_button-instance_method" title="#aspect_membership_button (instance method)">- (Object) <strong>aspect_membership_button</strong>(aspect, contact, person) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remove_from_aspect_button-instance_method" title="#remove_from_aspect_button (instance method)">- (Object) <strong>remove_from_aspect_button</strong>(aspect_id, person_id) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remove_link-instance_method" title="#remove_link (instance method)">- (Object) <strong>remove_link</strong>(aspect) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<p class="signature first" id="add_to_aspect_button-instance_method">
- (<tt>Object</tt>) <strong>add_to_aspect_button</strong>(aspect_id, person_id)
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16
17
18
19
20
21
22
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/helpers/aspects_helper.rb', line 14</span>
<span class='def def kw'>def</span> <span class='add_to_aspect_button identifier id'>add_to_aspect_button</span><span class='lparen token'>(</span><span class='aspect_id identifier id'>aspect_id</span><span class='comma token'>,</span> <span class='person_id identifier id'>person_id</span><span class='rparen token'>)</span>
<span class='link_to identifier id'>link_to</span> <span class='image_tag identifier id'>image_tag</span><span class='lparen token'>(</span><span class='string val'>'icons/monotone_plus_add_round.png'</span><span class='rparen token'>)</span><span class='comma token'>,</span>
<span class='lbrace token'>{</span><span class='symbol val'>:controller</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'aspect_memberships'</span><span class='comma token'>,</span>
<span class='symbol val'>:action</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'create'</span><span class='comma token'>,</span>
<span class='symbol val'>:aspect_id</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='aspect_id identifier id'>aspect_id</span><span class='comma token'>,</span>
<span class='symbol val'>:person_id</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='person_id identifier id'>person_id</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
<span class='symbol val'>:remote</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='true true kw'>true</span><span class='comma token'>,</span>
<span class='symbol val'>:method</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'post'</span><span class='comma token'>,</span>
<span class='symbol val'>:class</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'add button'</span><span class='comma token'>,</span>
<span class='string val'>'data-aspect_id'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='aspect_id identifier id'>aspect_id</span><span class='comma token'>,</span>
<span class='string val'>'data-person_id'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='person_id identifier id'>person_id</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="aspect_membership_button-instance_method">
- (<tt>Object</tt>) <strong>aspect_membership_button</strong>(aspect, contact, person)
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/helpers/aspects_helper.rb', line 41</span>
<span class='def def kw'>def</span> <span class='aspect_membership_button identifier id'>aspect_membership_button</span><span class='lparen token'>(</span><span class='aspect identifier id'>aspect</span><span class='comma token'>,</span> <span class='contact identifier id'>contact</span><span class='comma token'>,</span> <span class='person identifier id'>person</span><span class='rparen token'>)</span>
<span class='if if kw'>if</span> <span class='contact identifier id'>contact</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='orop op'>||</span> <span class='notop op'>!</span><span class='contact identifier id'>contact</span><span class='dot token'>.</span><span class='aspect_memberships identifier id'>aspect_memberships</span><span class='dot token'>.</span><span class='detect identifier id'>detect</span><span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='am identifier id'>am</span><span class='bitor op'>|</span> <span class='am identifier id'>am</span><span class='dot token'>.</span><span class='aspect_id identifier id'>aspect_id</span> <span class='eq op'>==</span> <span class='aspect identifier id'>aspect</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='rbrace token'>}</span>
<span class='add_to_aspect_button identifier id'>add_to_aspect_button</span><span class='lparen token'>(</span><span class='aspect identifier id'>aspect</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='comma token'>,</span> <span class='person identifier id'>person</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='rparen token'>)</span>
<span class='else else kw'>else</span>
<span class='remove_from_aspect_button identifier id'>remove_from_aspect_button</span><span class='lparen token'>(</span><span class='aspect identifier id'>aspect</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='comma token'>,</span> <span class='person identifier id'>person</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="remove_from_aspect_button-instance_method">
- (<tt>Object</tt>) <strong>remove_from_aspect_button</strong>(aspect_id, person_id)
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30
31
32
33
34
35
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/helpers/aspects_helper.rb', line 27</span>
<span class='def def kw'>def</span> <span class='remove_from_aspect_button identifier id'>remove_from_aspect_button</span><span class='lparen token'>(</span><span class='aspect_id identifier id'>aspect_id</span><span class='comma token'>,</span> <span class='person_id identifier id'>person_id</span><span class='rparen token'>)</span>
<span class='link_to identifier id'>link_to</span> <span class='image_tag identifier id'>image_tag</span><span class='lparen token'>(</span><span class='string val'>'icons/monotone_check_yes.png'</span><span class='rparen token'>)</span><span class='comma token'>,</span>
<span class='lbrace token'>{</span><span class='symbol val'>:controller</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>&quot;aspect_memberships&quot;</span><span class='comma token'>,</span>
<span class='symbol val'>:action</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'destroy'</span><span class='comma token'>,</span>
<span class='symbol val'>:id</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>42</span><span class='comma token'>,</span>
<span class='symbol val'>:aspect_id</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='aspect_id identifier id'>aspect_id</span><span class='comma token'>,</span>
<span class='symbol val'>:person_id</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='person_id identifier id'>person_id</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
<span class='symbol val'>:remote</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='true true kw'>true</span><span class='comma token'>,</span>
<span class='symbol val'>:method</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'delete'</span><span class='comma token'>,</span>
<span class='symbol val'>:class</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'added button'</span><span class='comma token'>,</span>
<span class='string val'>'data-aspect_id'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='aspect_id identifier id'>aspect_id</span><span class='comma token'>,</span>
<span class='string val'>'data-person_id'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='person_id identifier id'>person_id</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="remove_link-instance_method">
- (<tt>Object</tt>) <strong>remove_link</strong>(aspect)
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8
9
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/helpers/aspects_helper.rb', line 6</span>
<span class='def def kw'>def</span> <span class='remove_link identifier id'>remove_link</span><span class='lparen token'>(</span><span class='aspect identifier id'>aspect</span><span class='rparen token'>)</span>
<span class='if if kw'>if</span> <span class='aspect identifier id'>aspect</span><span class='dot token'>.</span><span class='contacts identifier id'>contacts</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='eq op'>==</span> <span class='integer val'>0</span>
<span class='link_to identifier id'>link_to</span> <span class='I18n constant id'>I18n</span><span class='dot token'>.</span><span class='t identifier id'>t</span><span class='lparen token'>(</span><span class='string val'>'aspects.helper.remove'</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='aspect identifier id'>aspect</span><span class='comma token'>,</span> <span class='symbol val'>:method</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='symbol val'>:delete</span><span class='comma token'>,</span> <span class='symbol val'>:confirm</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='I18n constant id'>I18n</span><span class='dot token'>.</span><span class='t identifier id'>t</span><span class='lparen token'>(</span><span class='string val'>'aspects.helper.are_you_sure'</span><span class='rparen token'>)</span>
<span class='else else kw'>else</span>
<span class='dstring node'>&quot;&lt;span class='grey' title=#{I18n.t('aspects.helper.aspect_not_empty')}&gt;#{I18n.t('aspects.helper.remove')}&lt;/span&gt;&quot;</span>
<span class='end end kw'>end</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jun 13 15:59:20 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.1 (ruby-1.8.7).
</div>
</body>
</html>