File: C:/Ruby27-x64/share/doc/ruby/html/RSS/Maker/Atom/Feed/Channel.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RSS::Maker::Atom::Feed::Channel - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../../";
var index_rel_prefix = "../../../../";
</script>
<script src="../../../../js/navigation.js" defer></script>
<script src="../../../../js/search.js" defer></script>
<script src="../../../../js/search_index.js" defer></script>
<script src="../../../../js/searcher.js" defer></script>
<script src="../../../../js/darkfish.js" defer></script>
<link href="../../../../css/fonts.css" rel="stylesheet">
<link href="../../../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../../../table_of_contents.html#pages">Pages</a>
<a href="../../../../table_of_contents.html#classes">Classes</a>
<a href="../../../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../../ChannelBase.html">RSS::Maker::ChannelBase</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../../SetupDefaultLanguage.html">RSS::Maker::SetupDefaultLanguage</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-i-_set_default_values">#_set_default_values</a>
<li class="calls-super" ><a href="#method-i-have_required_values-3F">#have_required_values?</a>
<li class="calls-super" ><a href="#method-i-not_set_required_variables">#not_set_required_variables</a>
<li ><a href="#method-i-required_variable_names">#required_variable_names</a>
<li ><a href="#method-i-to_feed">#to_feed</a>
<li class="calls-super" ><a href="#method-i-variable_is_set-3F">#variable_is_set?</a>
<li class="calls-super" ><a href="#method-i-variables">#variables</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RSS::Maker::Atom::Feed::Channel">
<h1 id="class-RSS::Maker::Atom::Feed::Channel" class="class">
class RSS::Maker::Atom::Feed::Channel
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-have_required_values-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">have_required_values?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../../Base.html#method-i-have_required_values-3F"><code>RSS::Maker::Base#have_required_values?</code></a>
</div>
<div class="method-source-code" id="have_required_values-3F-source">
<pre><span class="ruby-comment"># File lib/rss/maker/feed.rb, line 45</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">have_required_values?</span>
<span class="ruby-keyword">super</span> <span class="ruby-keyword">and</span>
(<span class="ruby-operator">!</span><span class="ruby-identifier">authors</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">or</span>
<span class="ruby-ivar">@maker</span>.<span class="ruby-identifier">items</span>.<span class="ruby-identifier">any?</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span><span class="ruby-identifier">item</span>.<span class="ruby-identifier">authors</span>.<span class="ruby-identifier">empty?</span>})
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_feed" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_feed</span><span
class="method-args">(feed)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="to_feed-source">
<pre><span class="ruby-comment"># File lib/rss/maker/feed.rb, line 28</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_feed</span>(<span class="ruby-identifier">feed</span>)
<span class="ruby-identifier">set_default_values</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">setup_values</span>(<span class="ruby-identifier">feed</span>)
<span class="ruby-identifier">feed</span>.<span class="ruby-identifier">dc_dates</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-identifier">setup_other_elements</span>(<span class="ruby-identifier">feed</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">image_favicon</span>.<span class="ruby-identifier">about</span>
<span class="ruby-identifier">icon</span> = <span class="ruby-identifier">feed</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">Icon</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">icon</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">image_favicon</span>.<span class="ruby-identifier">about</span>
<span class="ruby-identifier">feed</span>.<span class="ruby-identifier">icon</span> = <span class="ruby-identifier">icon</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">have_required_values?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotSetError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"maker.channel"</span>,
<span class="ruby-identifier">not_set_required_variables</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-_set_default_values" class="method-detail ">
<div class="method-heading">
<span class="method-name">_set_default_values</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
RSS::Maker::SetupDefaultLanguage#_set_default_values
</div>
<div class="method-source-code" id="_set_default_values-source">
<pre><span class="ruby-comment"># File lib/rss/maker/feed.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_set_default_values</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">keep</span> = {
<span class="ruby-value">:id</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">id</span>,
}
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">about</span>
<span class="ruby-keyword">super</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">ensure</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span> = <span class="ruby-identifier">keep</span>[<span class="ruby-value">:id</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-not_set_required_variables" class="method-detail ">
<div class="method-heading">
<span class="method-name">not_set_required_variables</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../../Base.html#method-i-not_set_required_variables"><code>RSS::Maker::Base#not_set_required_variables</code></a>
</div>
<div class="method-source-code" id="not_set_required_variables-source">
<pre><span class="ruby-comment"># File lib/rss/maker/feed.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">not_set_required_variables</span>
<span class="ruby-identifier">vars</span> = <span class="ruby-keyword">super</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">authors</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">and</span>
<span class="ruby-ivar">@maker</span>.<span class="ruby-identifier">items</span>.<span class="ruby-identifier">all?</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span> <span class="ruby-identifier">item</span>.<span class="ruby-identifier">author</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">empty?</span>}
<span class="ruby-identifier">vars</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"author"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">vars</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"title"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">title</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">have_required_values?</span>}
<span class="ruby-identifier">vars</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-required_variable_names" class="method-detail ">
<div class="method-heading">
<span class="method-name">required_variable_names</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="required_variable_names-source">
<pre><span class="ruby-comment"># File lib/rss/maker/feed.rb, line 52</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">required_variable_names</span>
<span class="ruby-node">%w(id updated)</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-variable_is_set-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">variable_is_set?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../../Base.html#method-i-variable_is_set-3F"><code>RSS::Maker::Base#variable_is_set?</code></a>
</div>
<div class="method-source-code" id="variable_is_set-3F-source">
<pre><span class="ruby-comment"># File lib/rss/maker/feed.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">variable_is_set?</span>
<span class="ruby-keyword">super</span> <span class="ruby-keyword">or</span> <span class="ruby-operator">!</span><span class="ruby-identifier">authors</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-variables" class="method-detail ">
<div class="method-heading">
<span class="method-name">variables</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../../Base.html#method-i-variables"><code>RSS::Maker::Base#variables</code></a>
</div>
<div class="method-source-code" id="variables-source">
<pre><span class="ruby-comment"># File lib/rss/maker/feed.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">variables</span>
<span class="ruby-keyword">super</span> <span class="ruby-operator">+</span> <span class="ruby-node">%w(id updated)</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>