<!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: Ballast::Concerns::ErrorsHandling
— Documentation by YARD 0.8.7.3
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!" + escape(window.location.href);
</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>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (E)</a> »
<span class='title'><span class='object_link'><a href="../../Ballast.html" title="Ballast (module)">Ballast</a></span></span> » <span class='title'><span class='object_link'><a href="../Concerns.html" title="Ballast::Concerns (module)">Concerns</a></span></span>
»
<span class="title">ErrorsHandling</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 class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Ballast::Concerns::ErrorsHandling
</h1>
<dl class="box">
<dt class="r1">Extended by:</dt>
<dd class="r1">ActiveSupport::Concern</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/ballast/concerns/errors_handling.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A concern to handle errors. It requires the Ajax concern.</p>
</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="#handle_error-instance_method" title="#handle_error (instance method)">- (Object) <strong>handle_error</strong>(exception = nil, layout = "error", title = "Error - Application", format = nil) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Handles an error in the application.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="handle_error-instance_method">
- (<tt>Object</tt>) <strong>handle_error</strong>(exception = nil, layout = "error", title = "Error - Application", format = nil)
</h3><div class="docstring">
<div class="discussion">
<p>Handles an error in the application.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>exception</span>
<span class='type'>(<tt>Hash|Exception</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The exception to handle.</p>
</div>
</li>
<li>
<span class='name'>layout</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>"error"</tt>)</em>
—
<div class='inline'><p>The layout to use to render the error.</p>
</div>
</li>
<li>
<span class='name'>title</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>"Error - Application"</tt>)</em>
—
<div class='inline'><p>The title to set in case of custom errors.</p>
</div>
</li>
<li>
<span class='name'>format</span>
<span class='type'>(<tt>String|Symbol</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The format of the response.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/errors_handling.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_handle_error'>handle_error</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_layout'>layout</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>error</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_title'>title</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error - Application</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_format'>format</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@error</span> <span class='op'>||=</span> <span class='id identifier rubyid_exception'>exception</span>
<span class='kw'>if</span> <span class='ivar'>@error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Lazier</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>Debug</span><span class='rparen'>)</span> <span class='kw'>then</span>
<span class='ivar'>@error_title</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Debug</span><span class='tstring_end'>"</span></span>
<span class='ivar'>@error_code</span> <span class='op'>=</span> <span class='int'>503</span>
<span class='kw'>elsif</span> <span class='ivar'>@error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span> <span class='kw'>then</span>
<span class='ivar'>@error_title</span> <span class='op'>=</span> <span class='ivar'>@error</span><span class='lbracket'>[</span><span class='symbol'>:title</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_title'>title</span>
<span class='ivar'>@error_code</span> <span class='op'>=</span> <span class='ivar'>@error</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span>
<span class='ivar'>@error_message</span> <span class='op'>=</span> <span class='ivar'>@error</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span>
<span class='kw'>else</span>
<span class='ivar'>@error_title</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error - </span><span class='embexpr_beg'>#{</span><span class='ivar'>@error</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='ivar'>@error_code</span> <span class='op'>=</span> <span class='int'>500</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_send_or_render_error'>send_or_render_error</span><span class='lparen'>(</span><span class='id identifier rubyid_layout'>layout</span><span class='comma'>,</span> <span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Jan 25 13:47:00 2014 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.3 (ruby-2.1.0).
</div>
</body>
</html>