doc/Songkickr/EventResult.html in songkickr-0.2.2 vs doc/Songkickr/EventResult.html in songkickr-0.3.0
- old
+ new
@@ -1,332 +1,306 @@
-<?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">
+<!DOCTYPE html>
+
+<html>
<head>
- <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
- <title>Class: Songkickr::EventResult</title>
+<title>class Songkickr::EventResult - RDoc Documentation</title>
- <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
- <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>
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../";
+</script>
-</head>
+<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
+
+
<body id="top" class="class">
+<nav id="metadata">
+ <nav id="home-section" class="section">
+ <h3 class="section-header">
+ <a href="../index.html">Home</a>
+ <a href="../table_of_contents.html#classes">Classes</a>
+ <a href="../table_of_contents.html#methods">Methods</a>
+ </h3>
+</nav>
- <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="../lib/songkickr/event_result_rb.html?TB_iframe=true&height=550&width=785"
- class="thickbox" title="lib/songkickr/event_result.rb">lib/songkickr/event_result.rb</a></li>
-
- </ul>
- </div>
- </div>
+ <nav id="search-section" class="section project-section" class="initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <h3 class="section-header">
+ <input type="text" name="search" placeholder="Search" id="search-field"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </h3>
+ </form>
-
- </div>
+ <ul id="search-results" class="initially-hidden"></ul>
+</nav>
- <div id="class-metadata">
-
- <!-- Parent Class -->
- <div id="parent-class-section" class="section">
- <h3 class="section-header">Parent</h3>
-
- <p class="link">Object</p>
-
- </div>
-
-
+ <div id="file-metadata">
+ <nav id="file-list-section" class="section">
+ <h3 class="section-header">Defined In</h3>
+ <ul>
+ <li>lib/songkickr/event_result.rb
+ </ul>
+</nav>
-
+
+ </div>
-
- <!-- Method Quickref -->
- <div id="method-list-section" class="section">
- <h3 class="section-header">Methods</h3>
- <ul class="link-list">
-
- <li><a href="#method-c-new">::new</a></li>
-
- <li><a href="#method-i-parse_results">#parse_results</a></li>
-
- </ul>
- </div>
-
+ <div id="class-metadata">
+
+ <nav id="parent-class-section" class="section">
+ <h3 class="section-header">Parent</h3>
+
+ <p class="link">Object
+
+</nav>
-
- </div>
+
+ <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
- <div id="project-metadata">
-
-
- <div id="fileindex-section" class="section project-section">
- <h3 class="section-header">Files</h3>
- <ul>
-
- <li class="file"><a href="../LICENSE.html">LICENSE</a></li>
-
- <li class="file"><a href="../README_rdoc.html">README.rdoc</a></li>
-
- </ul>
- </div>
-
+ <ul class="link-list">
+
+ <li><a href="#method-c-new">::new</a>
+
+ <li><a href="#method-i-parse_results">#parse_results</a>
+
+ </ul>
+</nav>
- <div id="classindex-section" class="section project-section">
- <h3 class="section-header">Class/Module 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>
+ </div>
- <ul class="link-list">
-
- <li><a href="../Songkickr.html">Songkickr</a></li>
-
- <li><a href="../Songkickr/Artist.html">Songkickr::Artist</a></li>
-
- <li><a href="../Songkickr/ArtistResult.html">Songkickr::ArtistResult</a></li>
-
- <li><a href="../Songkickr/ConcertSetlistResult.html">Songkickr::ConcertSetlistResult</a></li>
-
- <li><a href="../Songkickr/Event.html">Songkickr::Event</a></li>
-
- <li><a href="../Songkickr/EventResult.html">Songkickr::EventResult</a></li>
-
- <li><a href="../Songkickr/Location.html">Songkickr::Location</a></li>
-
- <li><a href="../Songkickr/LocationResult.html">Songkickr::LocationResult</a></li>
-
- <li><a href="../Songkickr/Performance.html">Songkickr::Performance</a></li>
-
- <li><a href="../Songkickr/Remote.html">Songkickr::Remote</a></li>
-
- <li><a href="../Songkickr/Setlist.html">Songkickr::Setlist</a></li>
-
- <li><a href="../Songkickr/SetlistItem.html">Songkickr::SetlistItem</a></li>
-
- <li><a href="../Songkickr/Venue.html">Songkickr::Venue</a></li>
-
- <li><a href="../APIKeyNotSet.html">APIKeyNotSet</a></li>
-
- </ul>
- <div id="no-class-search-results" style="display: none;">No matching classes.</div>
- </div>
+ <div id="project-metadata">
+ <nav id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Pages</h3>
-
- </div>
+ <ul>
+
+ <li class="file"><a href="../LICENSE.html">LICENSE</a>
+
+ <li class="file"><a href="../README_rdoc.html">README</a>
+
+ </ul>
+</nav>
+
+ <nav id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class and Module Index</h3>
+
+ <ul class="link-list">
+
+ <li><a href="../Songkickr.html">Songkickr</a>
+
+ <li><a href="../Songkickr/Artist.html">Songkickr::Artist</a>
+
+ <li><a href="../Songkickr/ArtistResult.html">Songkickr::ArtistResult</a>
+
+ <li><a href="../Songkickr/ConcertSetlistResult.html">Songkickr::ConcertSetlistResult</a>
+
+ <li><a href="../Songkickr/Event.html">Songkickr::Event</a>
+
+ <li><a href="../Songkickr/EventResult.html">Songkickr::EventResult</a>
+
+ <li><a href="../Songkickr/Location.html">Songkickr::Location</a>
+
+ <li><a href="../Songkickr/LocationResult.html">Songkickr::LocationResult</a>
+
+ <li><a href="../Songkickr/Performance.html">Songkickr::Performance</a>
+
+ <li><a href="../Songkickr/Remote.html">Songkickr::Remote</a>
+
+ <li><a href="../Songkickr/Setlist.html">Songkickr::Setlist</a>
+
+ <li><a href="../Songkickr/SetlistItem.html">Songkickr::SetlistItem</a>
+
+ <li><a href="../Songkickr/Venue.html">Songkickr::Venue</a>
+
+ <li><a href="../APIError.html">APIError</a>
+
+ <li><a href="../APIKeyNotSet.html">APIKeyNotSet</a>
+
+ <li><a href="../ResourceNotFound.html">ResourceNotFound</a>
+
+ </ul>
+</nav>
+
</div>
+</nav>
- <div id="documentation">
- <h1 class="class">Songkickr::EventResult</h1>
+<div id="documentation">
+ <h1 class="class">class Songkickr::EventResult</h1>
- <div id="description" class="description">
-
+ <div id="description" class="description">
+
<p>A class to represent the result hash of an <a href="Event.html">Event</a>
search.</p>
- </div><!-- description -->
+ </div><!-- description -->
+
+
+
+ <section id="5Buntitled-5D" class="documentation-section">
- <div id="5Buntitled-5D" class="documentation-section">
-
-
+
-
+
+
+ <!-- Attributes -->
+ <section id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
- <!-- Attributes -->
- <div id="attribute-method-details" class="method-section section">
- <h3 class="section-header">Attributes</h3>
+ <div id="attribute-i-page" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">page</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+ <div class="method-description">
- <div id="page-attribute-method" class="method-detail">
- <a name="page"></a>
-
- <a name="page="></a>
-
- <div class="method-heading attribute-method-heading">
- <span class="method-name">page</span><span
- class="attribute-access-type">[RW]</span>
- </div>
-
- <div class="method-description">
-
-
-
- </div>
- </div>
- <div id="results-attribute-method" class="method-detail">
- <a name="results"></a>
-
- <a name="results="></a>
-
- <div class="method-heading attribute-method-heading">
- <span class="method-name">results</span><span
- class="attribute-access-type">[RW]</span>
- </div>
-
- <div class="method-description">
-
-
-
- </div>
- </div>
- <div id="total_entries-attribute-method" class="method-detail">
- <a name="total_entries"></a>
-
- <a name="total_entries="></a>
-
- <div class="method-heading attribute-method-heading">
- <span class="method-name">total_entries</span><span
- class="attribute-access-type">[RW]</span>
- </div>
-
- <div class="method-description">
-
-
-
- </div>
</div>
-
- </div><!-- attribute-method-details -->
+ </div>
+ <div id="attribute-i-results" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">results</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
- <!-- Methods -->
+ <div class="method-description">
+
+
+
+ </div>
+ </div>
- <div id="public-class-method-details" class="method-section section">
- <h3 class="section-header">Public Class Methods</h3>
+ <div id="attribute-i-total_entries" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">total_entries</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+ <div class="method-description">
+
+
+
+ </div>
+ </div>
- <div id="new-method" class="method-detail ">
- <a name="method-c-new"></a>
+ </section><!-- attribute-method-details -->
+
-
- <div class="method-heading">
- <span class="method-name">new</span><span
- class="method-args">(result_hash = {})</span>
- <span class="method-click-advice">click to toggle source</span>
- </div>
-
+ <!-- Methods -->
+
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
- <div class="method-description">
-
- <p>Takes the result hash directly and parses out the page and total entries
+
+ <div id="method-c-new" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">new</span><span
+ class="method-args">(result_hash = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Takes the result hash directly and parses out the page and total entries
and finally passes off to the <a
-href="EventResult.html#method-i-parse_results">parse_results</a> method to
+href="EventResult.html#method-i-parse_results">#parse_results</a> method to
get the results.</p>
-
+
-
- <div class="method-source-code" id="new-source">
-<pre>
-<span class="ruby-comment"># File lib/songkickr/event_result.rb, line 7</span>
+
+ <div class="method-source-code" id="new-source">
+ <pre><span class="ruby-comment"># File lib/songkickr/event_result.rb, line 7</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">result_hash</span> = {})
<span class="ruby-identifier">results_page</span> = <span class="ruby-identifier">result_hash</span>[<span class="ruby-string">"resultsPage"</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">results_page</span>
<span class="ruby-ivar">@page</span> = <span class="ruby-identifier">results_page</span>[<span class="ruby-string">"page"</span>]
<span class="ruby-ivar">@total_entries</span> = <span class="ruby-identifier">results_page</span>[<span class="ruby-string">"totalEntries"</span>]
<span class="ruby-ivar">@results</span> = <span class="ruby-identifier">parse_results</span> <span class="ruby-identifier">results_page</span>[<span class="ruby-string">"results"</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
- </div><!-- new-source -->
-
- </div>
-
+ </div><!-- new-source -->
+ </div>
-
- </div><!-- new-method -->
+
-
- </div><!-- public-class-method-details -->
+
+ </div><!-- new-method -->
+
- <div id="protected-instance-method-details" class="method-section section">
- <h3 class="section-header">Protected Instance Methods</h3>
+ </section><!-- public-class-method-details -->
+
+ <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section">
+ <h3 class="section-header">Protected Instance Methods</h3>
-
- <div id="parse_results-method" class="method-detail ">
- <a name="method-i-parse_results"></a>
+
+ <div id="method-i-parse_results" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">parse_results</span><span
+ class="method-args">(results = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
+
+ <div class="method-description">
- <div class="method-heading">
- <span class="method-name">parse_results</span><span
- class="method-args">(results = {})</span>
- <span class="method-click-advice">click to toggle source</span>
- </div>
+
- <div class="method-description">
-
-
-
-
-
- <div class="method-source-code" id="parse_results-source">
-<pre>
-<span class="ruby-comment"># File lib/songkickr/event_result.rb, line 20</span>
+
+ <div class="method-source-code" id="parse_results-source">
+ <pre><span class="ruby-comment"># File lib/songkickr/event_result.rb, line 20</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse_results</span>(<span class="ruby-identifier">results</span> = {})
<span class="ruby-identifier">events</span> = []
<span class="ruby-keyword">if</span> <span class="ruby-identifier">results</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"event"</span>)
<span class="ruby-identifier">results</span>[<span class="ruby-string">"event"</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">event</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">events</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">Event</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">event</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">events</span>
<span class="ruby-keyword">end</span></pre>
- </div><!-- parse_results-source -->
-
- </div>
-
+ </div><!-- parse_results-source -->
+ </div>
-
- </div><!-- parse_results-method -->
+
-
- </div><!-- protected-instance-method-details -->
+
+ </div><!-- parse_results-method -->
+
- </div><!-- 5Buntitled-5D -->
+ </section><!-- protected-instance-method-details -->
+ </section><!-- 5Buntitled-5D -->
- </div><!-- documentation -->
+</div><!-- documentation -->
- <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> 2</small>.</p>
- </div>
-</body>
-</html>
+<footer id="validator-badges">
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>