diff options
| author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2012-12-30 14:43:00 +0200 |
|---|---|---|
| committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2012-12-30 14:43:00 +0200 |
| commit | 96d49bf04ce77c975fe500f4d961e4a1ffed4c26 (patch) | |
| tree | 0e43958fb12f17b9dd7a3173ccf1123f4969e74e /doc/code/classes/SnippetsController.html | |
| parent | d075df56d3cfb15a5d11550d86229f5b8001fbe7 (diff) | |
| download | gitlab-ce-96d49bf04ce77c975fe500f4d961e4a1ffed4c26.tar.gz | |
Use sdoc to generate application code documentation
Diffstat (limited to 'doc/code/classes/SnippetsController.html')
| -rw-r--r-- | doc/code/classes/SnippetsController.html | 611 |
1 files changed, 611 insertions, 0 deletions
diff --git a/doc/code/classes/SnippetsController.html b/doc/code/classes/SnippetsController.html new file mode 100644 index 00000000000..fd7e0fe6d19 --- /dev/null +++ b/doc/code/classes/SnippetsController.html @@ -0,0 +1,611 @@ +<?xml version="1.0" encoding="utf-8"?> +<!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> + <title>SnippetsController</title> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" /> +<link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" /> +<link rel="stylesheet" href="../css/github.css" type="text/css" media="screen" /> +<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script> +<script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script> +<script src="../js/main.js" type="text/javascript" charset="utf-8"></script> +<script src="../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script> + +</head> + +<body> + <div class="banner"> + + <h1> + <span class="type">Class</span> + SnippetsController + + <span class="parent">< + + <a href="ProjectResourceController.html">ProjectResourceController</a> + + </span> + + </h1> + <ul class="files"> + + <li><a href="../files/app/controllers/snippets_controller_rb.html">app/controllers/snippets_controller.rb</a></li> + + </ul> + </div> + <div id="bodyContent"> + <div id="content"> + + + + + + + + + + + + + + + <!-- Method ref --> + <div class="sectiontitle">Methods</div> + <dl class="methods"> + + <dt>A</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-authorize_admin_snippet-21">authorize_admin_snippet!</a>, + </li> + + + <li> + <a href="#method-i-authorize_modify_snippet-21">authorize_modify_snippet!</a> + </li> + + </ul> + </dd> + + <dt>C</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-create">create</a> + </li> + + </ul> + </dd> + + <dt>D</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-destroy">destroy</a> + </li> + + </ul> + </dd> + + <dt>E</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-edit">edit</a> + </li> + + </ul> + </dd> + + <dt>I</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-index">index</a> + </li> + + </ul> + </dd> + + <dt>N</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-new">new</a> + </li> + + </ul> + </dd> + + <dt>R</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-raw">raw</a> + </li> + + </ul> + </dd> + + <dt>S</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-show">show</a>, + </li> + + + <li> + <a href="#method-i-snippet">snippet</a> + </li> + + </ul> + </dd> + + <dt>U</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-update">update</a> + </li> + + </ul> + </dd> + + </dl> + + + + + + + + + + + + + + + + + + + <!-- Methods --> + + <div class="sectiontitle">Instance Public methods</div> + + <div class="method"> + <div class="title method-title" id="method-i-create"> + + <b>create</b>() + + <a href="../classes/SnippetsController.html#method-i-create" name="method-i-create" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-create_source')" id="l_method-i-create_source">show</a> + + </p> + <div id="method-i-create_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 26</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">create</span> + <span class="ruby-ivar">@snippet</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">snippets</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:snippet</span>]) + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">author</span> = <span class="ruby-identifier">current_user</span> + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">save</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">valid?</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@snippet</span>] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@snippet</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="method"> + <div class="title method-title" id="method-i-destroy"> + + <b>destroy</b>() + + <a href="../classes/SnippetsController.html#method-i-destroy" name="method-i-destroy" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-destroy_source')" id="l_method-i-destroy_source">show</a> + + </p> + <div id="method-i-destroy_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 55</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">destroy</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">access_denied!</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_snippet</span>, <span class="ruby-ivar">@snippet</span>) + + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_snippets_path</span>(<span class="ruby-ivar">@project</span>) +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="method"> + <div class="title method-title" id="method-i-edit"> + + <b>edit</b>() + + <a href="../classes/SnippetsController.html#method-i-edit" name="method-i-edit" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-edit_source')" id="l_method-i-edit_source">show</a> + + </p> + <div id="method-i-edit_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 38</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">edit</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="method"> + <div class="title method-title" id="method-i-index"> + + <b>index</b>() + + <a href="../classes/SnippetsController.html#method-i-index" name="method-i-index" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-index_source')" id="l_method-i-index_source">show</a> + + </p> + <div id="method-i-index_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">index</span> + <span class="ruby-ivar">@snippets</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">snippets</span>.<span class="ruby-identifier">fresh</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="method"> + <div class="title method-title" id="method-i-new"> + + <b>new</b>() + + <a href="../classes/SnippetsController.html#method-i-new" name="method-i-new" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-new_source')" id="l_method-i-new_source">show</a> + + </p> + <div id="method-i-new_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 22</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">new</span> + <span class="ruby-ivar">@snippet</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">snippets</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="method"> + <div class="title method-title" id="method-i-raw"> + + <b>raw</b>() + + <a href="../classes/SnippetsController.html#method-i-raw" name="method-i-raw" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-raw_source')" id="l_method-i-raw_source">show</a> + + </p> + <div id="method-i-raw_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 63</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">raw</span> + <span class="ruby-identifier">send_data</span>( + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">content</span>, + <span class="ruby-identifier">type</span><span class="ruby-operator">:</span> <span class="ruby-string">"text/plain"</span>, + <span class="ruby-identifier">disposition</span><span class="ruby-operator">:</span> <span class="ruby-string">'inline'</span>, + <span class="ruby-identifier">filename</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">file_name</span> + ) +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="method"> + <div class="title method-title" id="method-i-show"> + + <b>show</b>() + + <a href="../classes/SnippetsController.html#method-i-show" name="method-i-show" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-show_source')" id="l_method-i-show_source">show</a> + + </p> + <div id="method-i-show_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 51</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">show</span> + <span class="ruby-ivar">@note</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">noteable</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@snippet</span>) +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="method"> + <div class="title method-title" id="method-i-update"> + + <b>update</b>() + + <a href="../classes/SnippetsController.html#method-i-update" name="method-i-update" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-update_source')" id="l_method-i-update_source">show</a> + + </p> + <div id="method-i-update_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 41</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">update</span> + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:snippet</span>]) + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">valid?</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@snippet</span>] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@snippet</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="sectiontitle">Instance Protected methods</div> + + <div class="method"> + <div class="title method-title" id="method-i-authorize_admin_snippet-21"> + + <b>authorize_admin_snippet!</b>() + + <a href="../classes/SnippetsController.html#method-i-authorize_admin_snippet-21" name="method-i-authorize_admin_snippet-21" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-authorize_admin_snippet-21_source')" id="l_method-i-authorize_admin_snippet-21_source">show</a> + + </p> + <div id="method-i-authorize_admin_snippet-21_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 82</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">authorize_admin_snippet!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_snippet</span>, <span class="ruby-ivar">@snippet</span>) +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="method"> + <div class="title method-title" id="method-i-authorize_modify_snippet-21"> + + <b>authorize_modify_snippet!</b>() + + <a href="../classes/SnippetsController.html#method-i-authorize_modify_snippet-21" name="method-i-authorize_modify_snippet-21" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-authorize_modify_snippet-21_source')" id="l_method-i-authorize_modify_snippet-21_source">show</a> + + </p> + <div id="method-i-authorize_modify_snippet-21_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 78</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">authorize_modify_snippet!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:modify_snippet</span>, <span class="ruby-ivar">@snippet</span>) +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + + <div class="method"> + <div class="title method-title" id="method-i-snippet"> + + <b>snippet</b>() + + <a href="../classes/SnippetsController.html#method-i-snippet" name="method-i-snippet" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-snippet_source')" id="l_method-i-snippet_source">show</a> + + </p> + <div id="method-i-snippet_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 74</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">snippet</span> + <span class="ruby-ivar">@snippet</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">snippets</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + </div> + + </div> + </body> +</html>
\ No newline at end of file |