Files
9minutes/doc/app/ApplicationHelper.html
T
Tobias Klika 2cbb942282 doc files;
2011-06-13 14:56:41 +02:00

363 lines
12 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<title>Module: ApplicationHelper</title>
<link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
<script src="./js/jquery.js" type="text/javascript"
charset="utf-8"></script>
<script src="./js/thickbox-compressed.js" type="text/javascript"
charset="utf-8"></script>
<script src="./js/quicksearch.js" type="text/javascript"
charset="utf-8"></script>
<script src="./js/darkfish.js" type="text/javascript"
charset="utf-8"></script>
</head>
<body class="module">
<div id="metadata">
<div id="home-metadata">
<div id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./index.html#classes">Classes</a>
<a href="./index.html#methods">Methods</a>
</h3>
</div>
</div>
<div id="file-metadata">
<div id="file-list-section" class="section">
<h3 class="section-header">In Files</h3>
<div class="section-body">
<ul>
<li><a href="./app/helpers/application_helper_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
class="thickbox" title="app/helpers/application_helper.rb">app/helpers/application_helper.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Parent Class -->
<!-- Namespace Contents -->
<!-- Method Quickref -->
<div id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#method-i-camelCaseString">#camelCaseString</a></li>
<li><a href="#method-i-get_album_info">#get_album_info</a></li>
<li><a href="#method-i-trimString">#trimString</a></li>
<li><a href="#method-i-validate_img_url">#validate_img_url</a></li>
</ul>
</div>
<!-- Included Modules -->
</div>
<div id="project-metadata">
<div id="fileindex-section" class="section project-section">
<h3 class="section-header">Files</h3>
<ul>
<li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a></li>
</ul>
</div>
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class Index
<span class="search-toggle"><img src="./images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="./LastFM.html">LastFM</a></li>
<li><a href="./LastFM/Album.html">LastFM::Album</a></li>
<li><a href="./LastFM/Artist.html">LastFM::Artist</a></li>
<li><a href="./LastFM/Chart.html">LastFM::Chart</a></li>
<li><a href="./LastFM/Request.html">LastFM::Request</a></li>
<li><a href="./LastFM/Track.html">LastFM::Track</a></li>
<li><a href="./LastFM/Validator.html">LastFM::Validator</a></li>
<li><a href="./DeviseAuth.html">DeviseAuth</a></li>
<li><a href="./DeviseAuth/RegistrationsController.html">DeviseAuth::RegistrationsController</a></li>
<li><a href="./DeviseAuth/SessionsController.html">DeviseAuth::SessionsController</a></li>
<li><a href="./Users.html">Users</a></li>
<li><a href="./Users/OmniauthCallbacksController.html">Users::OmniauthCallbacksController</a></li>
<li><a href="./ApplicationController.html">ApplicationController</a></li>
<li><a href="./ApplicationHelper.html">ApplicationHelper</a></li>
<li><a href="./Artist.html">Artist</a></li>
<li><a href="./ArtistsController.html">ArtistsController</a></li>
<li><a href="./ChartsController.html">ChartsController</a></li>
<li><a href="./HomeController.html">HomeController</a></li>
<li><a href="./Playlist.html">Playlist</a></li>
<li><a href="./PlaylistsTracks.html">PlaylistsTracks</a></li>
<li><a href="./RedisQueryable.html">RedisQueryable</a></li>
<li><a href="./SearchController.html">SearchController</a></li>
<li><a href="./Track.html">Track</a></li>
<li><a href="./TracksController.html">TracksController</a></li>
<li><a href="./User.html">User</a></li>
<li><a href="./UsersController.html">UsersController</a></li>
<li><a href="./UsersHelper.html">UsersHelper</a></li>
<li><a href="./YoutubeVideoRating.html">YoutubeVideoRating</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1 class="module">ApplicationHelper</h1>
<div id="description">
<p>
encoding: UTF-8
</p>
</div>
<!-- Constants -->
<!-- Attributes -->
<!-- Methods -->
<div id="public-instance-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="camel-ase-tring-method" class="method-detail ">
<a name="method-i-camelCaseString"></a>
<div class="method-heading">
<span class="method-name">camelCaseString</span><span
class="method-args">(phrase)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="camel-ase-tring-source">
<pre>
<span class="ruby-comment cmt"># File app/helpers/application_helper.rb, line 26</span>
26: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">camelCaseString</span> <span class="ruby-identifier">phrase</span>
27: <span class="ruby-identifier">phrase</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/^[a-z]|\s+[a-z]/</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">upcase</span> }
28: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">phrase</span>
29: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="get-album-info-method" class="method-detail ">
<a name="method-i-get_album_info"></a>
<div class="method-heading">
<span class="method-name">get_album_info</span><span
class="method-args">(album, artist)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="get-album-info-source">
<pre>
<span class="ruby-comment cmt"># File app/helpers/application_helper.rb, line 17</span>
17: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_album_info</span> <span class="ruby-identifier">album</span>, <span class="ruby-identifier">artist</span>
18: <span class="ruby-ivar">@result</span> = <span class="ruby-constant">LastFM</span><span class="ruby-operator">::</span><span class="ruby-constant">Album</span>.<span class="ruby-identifier">getInfo</span>(<span class="ruby-identifier">album</span>, <span class="ruby-identifier">artist</span>)
19: <span class="ruby-ivar">@result</span>.<span class="ruby-identifier">album</span>
20: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="trim-tring-method" class="method-detail ">
<a name="method-i-trimString"></a>
<div class="method-heading">
<span class="method-name">trimString</span><span
class="method-args">(str, length)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="trim-tring-source">
<pre>
<span class="ruby-comment cmt"># File app/helpers/application_helper.rb, line 22</span>
22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">trimString</span> <span class="ruby-identifier">str</span>, <span class="ruby-identifier">length</span>
23: <span class="ruby-identifier">truncate</span> <span class="ruby-identifier">str</span>, <span class="ruby-value">:length</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">length</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-value">:omission</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;&quot;</span>
24: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="validate-img-url-method" class="method-detail ">
<a name="method-i-validate_img_url"></a>
<div class="method-heading">
<span class="method-name">validate_img_url</span><span
class="method-args">(image, type, size)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="validate-img-url-source">
<pre>
<span class="ruby-comment cmt"># File app/helpers/application_helper.rb, line 4</span>
4: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_img_url</span> <span class="ruby-identifier">image</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">size</span>
5: <span class="ruby-ivar">@attr</span> = (<span class="ruby-identifier">type</span><span class="ruby-operator">==</span><span class="ruby-value str">&quot;gallery&quot;</span>) <span class="ruby-operator">?</span> <span class="ruby-value str">&quot;name&quot;</span> <span class="ruby-operator">:</span> <span class="ruby-value str">&quot;size&quot;</span>
6: <span class="ruby-identifier">image</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">img</span><span class="ruby-operator">|</span>
7: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">img</span>[<span class="ruby-ivar">@attr</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">size</span>.<span class="ruby-identifier">to_s</span>
8: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">img</span>[<span class="ruby-node">&quot;#text&quot;</span>].<span class="ruby-identifier">blank?</span>
9: <span class="ruby-keyword kw">return</span> <span class="ruby-node">&quot;/images/placeholder/#{type.to_s}.png&quot;</span>
10: <span class="ruby-keyword kw">end</span>
11: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">img</span>[<span class="ruby-node">&quot;#text&quot;</span>]
12: <span class="ruby-keyword kw">end</span>
13: <span class="ruby-keyword kw">end</span>
14:
15: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
</div>
<div id="rdoc-debugging-section-dump" class="debugging-section">
<p>Disabled; run with --debug to generate this.</p>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 1.1.6</small>.</p>
</div>
</body>
</html>