garfield/wpscan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
7c1241c6f6cbfacb55681b3749cb7b539801fca7
wpscan/doc_yard/ListGeneratorPlugin.html
Christian Mehlmauer 8896f8bf79 docs
2013-08-11 08:58:28 +02:00

444 lines
18 KiB
HTML
Raw Blame History

<!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>
Class: ListGeneratorPlugin
&mdash; Documentation by YARD 0.8.5.2
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" 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 (L)</a> &raquo;
<span class="title">ListGeneratorPlugin</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>Class: ListGeneratorPlugin
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="Plugin.html" title="Plugin (class)">Plugin</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Plugin.html" title="Plugin (class)">Plugin</a></span></li>
<li class="next">ListGeneratorPlugin</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/wpstools/plugins/list_generator/list_generator_plugin.rb</dd>
</dl>
<div class="clear"></div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Plugin.html" title="Plugin (class)">Plugin</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Plugin.html#author-instance_method" title="Plugin#author (method)">#author</a></span>, <span class='object_link'><a href="Plugin.html#registered_options-instance_method" title="Plugin#registered_options (method)">#registered_options</a></span></p>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="private ">
<span class="summary_signature">
<a href="#full-instance_method" title="#full (instance method)">- (Object) <strong>full</strong>(type) </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (ListGeneratorPlugin) <strong>initialize</strong> </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of ListGeneratorPlugin.</p>
</div></span>
</li>
<li class="private ">
<span class="summary_signature">
<a href="#most_popular-instance_method" title="#most_popular (instance method)">- (Object) <strong>most_popular</strong>(type, number_of_pages) </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#run-instance_method" title="#run (instance method)">- (Object) <strong>run</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Plugin.html" title="Plugin (class)">Plugin</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Plugin.html#register_options-instance_method" title="Plugin#register_options (method)">#register_options</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="ListGeneratorPlugin (class)">ListGeneratorPlugin</a></span></tt>) <strong>initialize</strong>
</h3><div class="docstring">
<div class="discussion">
<p>A new instance of ListGeneratorPlugin</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7
8
9
10
11
12
13
14
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/list_generator_plugin.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='label'>author:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>WPScanTeam - @FireFart</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_register_options'>register_options</span><span class='lparen'>(</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--generate-plugin-list [NUMBER_OF_PAGES]</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--gpl</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Generate a new data/plugins.txt file. (supply number of *pages* to parse, default : 150)</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--generate-full-plugin-list</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--gfpl</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Generate a new full data/plugins.txt file</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--generate-theme-list [NUMBER_OF_PAGES]</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--gtl</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Generate a new data/themes.txt file. (supply number of *pages* to parse, default : 150)</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--generate-full-theme-list</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--gftl</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Generate a new full data/themes.txt file</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--generate-all</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--ga</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Generate a new full plugins, full themes, popular plugins and popular themes list</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="full-instance_method">
- (<tt>Object</tt>) <strong>full</strong>(type) <span class="extras">(private)</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
48
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/list_generator_plugin.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_full'>full</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[+] Generating new full </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='rbrace'>}</span><span class='tstring_content'> list</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span>
<span class='const'>GenerateList</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>s</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='ivar'>@verbose</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_generate_full_list'>generate_full_list</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="most_popular-instance_method">
- (<tt>Object</tt>) <strong>most_popular</strong>(type, number_of_pages) <span class="extras">(private)</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/list_generator_plugin.rb', line 42</span>
<span class='kw'>def</span> <span class='id identifier rubyid_most_popular'>most_popular</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_number_of_pages'>number_of_pages</span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[+] Generating new most popular </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='rbrace'>}</span><span class='tstring_content'> list</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span>
<span class='const'>GenerateList</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>s</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='ivar'>@verbose</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_generate_popular_list'>generate_popular_list</span><span class='lparen'>(</span><span class='id identifier rubyid_number_of_pages'>number_of_pages</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="run-instance_method">
- (<tt>Object</tt>) <strong>run</strong>(options = {})
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/list_generator_plugin.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='ivar'>@verbose</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:verbose</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='kw'>false</span>
<span class='id identifier rubyid_generate_all'>generate_all</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:generate_all</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='kw'>false</span>
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:generate_plugin_list</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_generate_all'>generate_all</span>
<span class='id identifier rubyid_most_popular'>most_popular</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>plugin</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:generate_plugin_list</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>150</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:generate_full_plugin_list</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_generate_all'>generate_all</span>
<span class='id identifier rubyid_full'>full</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>plugin</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:generate_theme_list</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_generate_all'>generate_all</span>
<span class='id identifier rubyid_most_popular'>most_popular</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>theme</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:generate_theme_list</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>150</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:generate_full_theme_list</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_generate_all'>generate_all</span>
<span class='id identifier rubyid_full'>full</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>theme</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Aug 11 08:57:59 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.5.2 (ruby-1.9.3).
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink