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

180 lines
No EOL
5.5 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: UsersHelper
&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 (U)</a> &raquo;
<span class="title">UsersHelper</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: UsersHelper
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">app/helpers/users_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="#first_name_or_username-instance_method" title="#first_name_or_username (instance method)">- (Object) <strong>first_name_or_username</strong>(user) </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="first_name_or_username-instance_method">
- (<tt>Object</tt>) <strong>first_name_or_username</strong>(user)
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/helpers/users_helper.rb', line 6</span>
<span class='def def kw'>def</span> <span class='first_name_or_username identifier id'>first_name_or_username</span> <span class='lparen token'>(</span><span class='user identifier id'>user</span><span class='rparen token'>)</span>
<span class='set_name identifier id'>set_name</span> <span class='assign token'>=</span> <span class='user identifier id'>user</span><span class='dot token'>.</span><span class='person identifier id'>person</span><span class='dot token'>.</span><span class='profile identifier id'>profile</span><span class='dot token'>.</span><span class='first_name identifier id'>first_name</span>
<span class='lparen token'>(</span><span class='set_name identifier id'>set_name</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='orop op'>||</span> <span class='set_name identifier id'>set_name</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='user identifier id'>user</span><span class='dot token'>.</span><span class='username identifier id'>username</span> <span class='colon op'>:</span> <span class='user identifier id'>user</span><span class='dot token'>.</span><span class='person identifier id'>person</span><span class='dot token'>.</span><span class='profile identifier id'>profile</span><span class='dot token'>.</span><span class='first_name identifier id'>first_name</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:23 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>