doc/Opinio.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: Opinio</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="./lib/generators/opinio/install/install_generator_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/generators/opinio/install/install_generator.rb">lib/generators/opinio/install/install_generator.rb</a></li>
<li><a href="./lib/generators/opinio/views/views_generator_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/generators/opinio/views/views_generator.rb">lib/generators/opinio/views/views_generator.rb</a></li>
<li><a href="./lib/opinio/controllers/extensions_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/controllers/extensions.rb">lib/opinio/controllers/extensions.rb</a></li>
<li><a href="./lib/opinio/controllers/helpers_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/controllers/helpers.rb">lib/opinio/controllers/helpers.rb</a></li>
<li><a href="./lib/opinio/controllers/internal_helpers_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/controllers/internal_helpers.rb">lib/opinio/controllers/internal_helpers.rb</a></li>
<li><a href="./lib/opinio/controllers/replies_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/controllers/replies.rb">lib/opinio/controllers/replies.rb</a></li>
<li><a href="./lib/opinio/opinio_model_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/opinio_model.rb">lib/opinio/opinio_model.rb</a></li>
<li><a href="./lib/opinio/opinio_subjectum_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/opinio_subjectum.rb">lib/opinio/opinio_subjectum.rb</a></li>
<li><a href="./lib/opinio/orm/active_record_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/orm/active_record.rb">lib/opinio/orm/active_record.rb</a></li>
<li><a href="./lib/opinio/rails_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/rails.rb">lib/opinio/rails.rb</a></li>
<li><a href="./lib/opinio/railtie_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/railtie.rb">lib/opinio/railtie.rb</a></li>
<li><a href="./lib/opinio/schema_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio/schema.rb">lib/opinio/schema.rb</a></li>
<li><a href="./lib/opinio_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/opinio.rb">lib/opinio.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Parent Class -->
<!-- Namespace Contents -->
<div id="namespace-list-section" class="section">
<h3 class="section-header">Namespace</h3>
<ul class="link-list">
<li><span class="type">MODULE</span> <a href="Opinio/Controllers.html">Opinio::Controllers</a></li>
<li><span class="type">MODULE</span> <a href="Opinio/Generators.html">Opinio::Generators</a></li>
<li><span class="type">MODULE</span> <a href="Opinio/OpinioModel.html">Opinio::OpinioModel</a></li>
<li><span class="type">MODULE</span> <a href="Opinio/OpinioSubjectum.html">Opinio::OpinioSubjectum</a></li>
<li><span class="type">MODULE</span> <a href="Opinio/Orm.html">Opinio::Orm</a></li>
<li><span class="type">MODULE</span> <a href="Opinio/Schema.html">Opinio::Schema</a></li>
<li><span class="type">CLASS</span> <a href="Opinio/CommentsController.html">Opinio::CommentsController</a></li>
<li><span class="type">CLASS</span> <a href="Opinio/Engine.html">Opinio::Engine</a></li>
<li><span class="type">CLASS</span> <a href="Opinio/Railtie.html">Opinio::Railtie</a></li>
</ul>
</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-check_custom_identifiers">::check_custom_identifiers</a></li>
<li><a href="#method-c-opinio_identifier">::opinio_identifier</a></li>
<li><a href="#method-c-set_destroy_conditions">::set_destroy_conditions</a></li>
<li><a href="#method-c-setup">::setup</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="./Gemfile.html">Gemfile</a></li>
<li class="file"><a href="./MIT-LICENSE.html">MIT-LICENSE</a></li>
<li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
<li class="file"><a href="./Rakefile.html">Rakefile</a></li>
<li class="file"><a href="./spec/dummy/Rakefile.html">Rakefile</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="./Opinio.html">Opinio</a></li>
<li><a href="./Opinio/CommentsController.html">Opinio::CommentsController</a></li>
<li><a href="./Opinio/Controllers.html">Opinio::Controllers</a></li>
<li><a href="./Opinio/Controllers/Extensions.html">Opinio::Controllers::Extensions</a></li>
<li><a href="./Opinio/Controllers/Extensions/ClassMethods.html">Opinio::Controllers::Extensions::ClassMethods</a></li>
<li><a href="./Opinio/Controllers/Extensions/InstanceMethods.html">Opinio::Controllers::Extensions::InstanceMethods</a></li>
<li><a href="./Opinio/Controllers/Helpers.html">Opinio::Controllers::Helpers</a></li>
<li><a href="./Opinio/Controllers/InternalHelpers.html">Opinio::Controllers::InternalHelpers</a></li>
<li><a href="./Opinio/Controllers/Replies.html">Opinio::Controllers::Replies</a></li>
<li><a href="./Opinio/Engine.html">Opinio::Engine</a></li>
<li><a href="./Opinio/Generators.html">Opinio::Generators</a></li>
<li><a href="./Opinio/Generators/InstallGenerator.html">Opinio::Generators::InstallGenerator</a></li>
<li><a href="./Opinio/Generators/ViewsGenerator.html">Opinio::Generators::ViewsGenerator</a></li>
<li><a href="./Opinio/OpinioModel.html">Opinio::OpinioModel</a></li>
<li><a href="./Opinio/OpinioModel/ClassMethods.html">Opinio::OpinioModel::ClassMethods</a></li>
<li><a href="./Opinio/OpinioModel/InstanceMethods.html">Opinio::OpinioModel::InstanceMethods</a></li>
<li><a href="./Opinio/OpinioSubjectum.html">Opinio::OpinioSubjectum</a></li>
<li><a href="./Opinio/OpinioSubjectum/ClassMethods.html">Opinio::OpinioSubjectum::ClassMethods</a></li>
<li><a href="./Opinio/OpinioSubjectum/InstanceMethods.html">Opinio::OpinioSubjectum::InstanceMethods</a></li>
<li><a href="./Opinio/Orm.html">Opinio::Orm</a></li>
<li><a href="./Opinio/Orm/ActiveRecord.html">Opinio::Orm::ActiveRecord</a></li>
<li><a href="./Opinio/Orm/ActiveRecord/Schema.html">Opinio::Orm::ActiveRecord::Schema</a></li>
<li><a href="./Opinio/Schema.html">Opinio::Schema</a></li>
<li><a href="./ActionDispatch.html">ActionDispatch</a></li>
<li><a href="./ActionDispatch/Routing.html">ActionDispatch::Routing</a></li>
<li><a href="./ActionDispatch/Routing/Mapper.html">ActionDispatch::Routing::Mapper</a></li>
<li><a href="./Dummy.html">Dummy</a></li>
<li><a href="./Dummy/Application.html">Dummy::Application</a></li>
<li><a href="./ApplicationController.html">ApplicationController</a></li>
<li><a href="./ApplicationHelper.html">ApplicationHelper</a></li>
<li><a href="./Comment.html">Comment</a></li>
<li><a href="./CreateComments.html">CreateComments</a></li>
<li><a href="./CreatePosts.html">CreatePosts</a></li>
<li><a href="./CreateUsers.html">CreateUsers</a></li>
<li><a href="./NavigationHelpers.html">NavigationHelpers</a></li>
<li><a href="./Post.html">Post</a></li>
<li><a href="./PostsController.html">PostsController</a></li>
<li><a href="./PostsHelper.html">PostsHelper</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="./WithinHelpers.html">WithinHelpers</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">Opinio</h1>
<div id="description">
</div>
<!-- Constants -->
<!-- Attributes -->
<!-- Methods -->
<div id="public-class-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="check-custom-identifiers-method" class="method-detail ">
<a name="method-c-check_custom_identifiers"></a>
<div class="method-heading">
<span class="method-name">check_custom_identifiers</span><span
class="method-args">(params)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="check-custom-identifiers-source">
<pre>
<span class="ruby-comment cmt"># File lib/opinio.rb, line 44</span>
44: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">check_custom_identifiers</span>(<span class="ruby-identifier">params</span>)
45: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">custom_identifiers</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">idf</span><span class="ruby-operator">|</span>
46: <span class="ruby-identifier">ret</span> = <span class="ruby-identifier">idf</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">params</span>)
47: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">ret</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ret</span>.<span class="ruby-identifier">nil?</span>
48: <span class="ruby-keyword kw">end</span>
49: <span class="ruby-keyword kw">nil</span>
50: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="opinio-identifier-method" class="method-detail ">
<a name="method-c-opinio_identifier"></a>
<div class="method-heading">
<span class="method-name">opinio_identifier</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-source-code"
id="opinio-identifier-source">
<pre>
<span class="ruby-comment cmt"># File lib/opinio.rb, line 36</span>
36: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">opinio_identifier</span>(<span class="ruby-identifier">block</span>)
37: <span class="ruby-identifier">@@custom_identifiers</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">block</span>
38: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="set-destroy-conditions-method" class="method-detail ">
<a name="method-c-set_destroy_conditions"></a>
<div class="method-heading">
<span class="method-name">set_destroy_conditions</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-source-code"
id="set-destroy-conditions-source">
<pre>
<span class="ruby-comment cmt"># File lib/opinio.rb, line 40</span>
40: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">set_destroy_conditions</span>(&<span class="ruby-identifier">block</span>)
41: <span class="ruby-identifier">@@destroy_conditions</span> = <span class="ruby-identifier">block</span>
42: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="setup-method" class="method-detail ">
<a name="method-c-setup"></a>
<div class="method-heading">
<span class="method-name">setup</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="setup-source">
<pre>
<span class="ruby-comment cmt"># File lib/opinio.rb, line 32</span>
32: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">setup</span>
33: <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">self</span>
34: <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>