garfield/wpscan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
7a7450f98e339a3a08d14d17b3a627cfda88c506
wpscan/doc_yard/WpItem.html
Christian Mehlmauer a38c709d74 Updated documentation
2013-04-30 23:06:37 +02:00

1429 lines
35 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: WpItem
&mdash; Documentation by YARD 0.8.6.1
</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 (W)</a> &raquo;
<span class="title">WpItem</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: WpItem
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">WpItem</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2">Extended by:</dt>
<dd class="r2"><span class='object_link'><a href="WpItem/Findable.html" title="WpItem::Findable (module)">Findable</a></span></dd>
<dt class="r1">Includes:</dt>
<dd class="r1"><span class='object_link'><a href="WpItem/Existable.html" title="WpItem::Existable (module)">Existable</a></span>, <span class='object_link'><a href="WpItem/Infos.html" title="WpItem::Infos (module)">Infos</a></span>, <span class='object_link'><a href="WpItem/Output.html" title="WpItem::Output (module)">Output</a></span>, <span class='object_link'><a href="WpItem/Versionable.html" title="WpItem::Versionable (module)">Versionable</a></span>, <span class='object_link'><a href="WpItem/Vulnerable.html" title="WpItem::Vulnerable (module)">Vulnerable</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/common/models/wp_item.rb<span class="defines">,<br />
lib/common/models/wp_item/infos.rb,<br /> lib/common/models/wp_item/output.rb,<br /> lib/common/models/wp_item/findable.rb,<br /> lib/common/models/wp_item/existable.rb,<br /> lib/common/models/wp_item/vulnerable.rb,<br /> lib/common/models/wp_item/versionable.rb</span>
</dd>
</dl>
<div class="clear"></div>
<div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="WpPlugin.html" title="WpPlugin (class)">WpPlugin</a></span>, <span class='object_link'><a href="WpTheme.html" title="WpTheme (class)">WpTheme</a></span>, <span class='object_link'><a href="WpTimthumb.html" title="WpTimthumb (class)">WpTimthumb</a></span>, <span class='object_link'><a href="WpUser.html" title="WpUser (class)">WpUser</a></span>, <span class='object_link'><a href="WpVersion.html" title="WpVersion (class)">WpVersion</a></span></p>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="WpItem/Existable.html" title="WpItem::Existable (module)">Existable</a></span>, <span class='object_link'><a href="WpItem/Findable.html" title="WpItem::Findable (module)">Findable</a></span>, <span class='object_link'><a href="WpItem/Infos.html" title="WpItem::Infos (module)">Infos</a></span>, <span class='object_link'><a href="WpItem/Output.html" title="WpItem::Output (module)">Output</a></span>, <span class='object_link'><a href="WpItem/Versionable.html" title="WpItem::Versionable (module)">Versionable</a></span>, <span class='object_link'><a href="WpItem/Vulnerable.html" title="WpItem::Vulnerable (module)">Vulnerable</a></span>
</p>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#found_from-instance_method" title="#found_from (instance method)">- (Object) <strong>found_from</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute found_from.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#path-instance_method" title="#path (instance method)">- (Object) <strong>path</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#version%3D-instance_method" title="#version= (instance method)">- (Object) <strong>version</strong> </a>
</span>
<span class="note title writeonly">writeonly</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the attribute version.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#wp_content_dir-instance_method" title="#wp_content_dir (instance method)">- (Object) <strong>wp_content_dir</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute wp_content_dir.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#wp_plugins_dir-instance_method" title="#wp_plugins_dir (instance method)">- (Object) <strong>wp_plugins_dir</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute wp_plugins_dir.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes included from <span class='object_link'><a href="WpItem/Vulnerable.html" title="WpItem::Vulnerable (module)">Vulnerable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="WpItem/Vulnerable.html#vulns_file-instance_method" title="WpItem::Vulnerable#vulns_file (method)">#vulns_file</a></span>, <span class='object_link'><a href="WpItem/Vulnerable.html#vulns_xpath-instance_method" title="WpItem::Vulnerable#vulns_xpath (method)">#vulns_xpath</a></span></p>
<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="#%3C%3D%3E-instance_method" title="#&lt;=&gt; (instance method)">- (Object) <strong>&lt;=&gt;</strong>(other) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#%3D%3D-instance_method" title="#== (instance method)">- (Object) <strong>==</strong>(other) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#%3D%3D%3D-instance_method" title="#=== (instance method)">- (Object) <strong>===</strong>(other) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#allowed_options-instance_method" title="#allowed_options (instance method)">- (Array) <strong>allowed_options</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Make it private ?.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#forge_uri-instance_method" title="#forge_uri (instance method)">- (void) <strong>forge_uri</strong>(target_base_uri) </a>
</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)">- (WpItem) <strong>initialize</strong>(target_base_uri, options = {}) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="private ">
<span class="summary_signature">
<a href="#set_options-instance_method" title="#set_options (instance method)">- (void) <strong>set_options</strong>(options) </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="#uri-instance_method" title="#uri (instance method)">- (URI) <strong>uri</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The uri to the WpItem, with the path if present.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#url-instance_method" title="#url (instance method)">- (String) <strong>url</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The url to the WpItem.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="WpItem/Output.html" title="WpItem::Output (module)">Output</a></span></h3>
<p class="inherited"><span class='object_link'><a href="WpItem/Output.html#output-instance_method" title="WpItem::Output#output (method)">#output</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="WpItem/Infos.html" title="WpItem::Infos (module)">Infos</a></span></h3>
<p class="inherited"><span class='object_link'><a href="WpItem/Infos.html#changelog_url-instance_method" title="WpItem::Infos#changelog_url (method)">#changelog_url</a></span>, <span class='object_link'><a href="WpItem/Infos.html#error_log_url-instance_method" title="WpItem::Infos#error_log_url (method)">#error_log_url</a></span>, <span class='object_link'><a href="WpItem/Infos.html#has_changelog%3F-instance_method" title="WpItem::Infos#has_changelog? (method)">#has_changelog?</a></span>, <span class='object_link'><a href="WpItem/Infos.html#has_directory_listing%3F-instance_method" title="WpItem::Infos#has_directory_listing? (method)">#has_directory_listing?</a></span>, <span class='object_link'><a href="WpItem/Infos.html#has_error_log%3F-instance_method" title="WpItem::Infos#has_error_log? (method)">#has_error_log?</a></span>, <span class='object_link'><a href="WpItem/Infos.html#has_readme%3F-instance_method" title="WpItem::Infos#has_readme? (method)">#has_readme?</a></span>, <span class='object_link'><a href="WpItem/Infos.html#readme_url-instance_method" title="WpItem::Infos#readme_url (method)">#readme_url</a></span>, <span class='object_link'><a href="WpItem/Infos.html#url_is_200%3F-instance_method" title="WpItem::Infos#url_is_200? (method)">#url_is_200?</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="WpItem/Existable.html" title="WpItem::Existable (module)">Existable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="WpItem/Existable.html#exists%3F-instance_method" title="WpItem::Existable#exists? (method)">#exists?</a></span>, <span class='object_link'><a href="WpItem/Existable.html#exists_from_response%3F-instance_method" title="WpItem::Existable#exists_from_response? (method)">#exists_from_response?</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="WpItem/Vulnerable.html" title="WpItem::Vulnerable (module)">Vulnerable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="WpItem/Vulnerable.html#vulnerabilities-instance_method" title="WpItem::Vulnerable#vulnerabilities (method)">#vulnerabilities</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="WpItem/Versionable.html" title="WpItem::Versionable (module)">Versionable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="WpItem/Versionable.html#to_s-instance_method" title="WpItem::Versionable#to_s (method)">#to_s</a></span>, <span class='object_link'><a href="WpItem/Versionable.html#version-instance_method" title="WpItem::Versionable#version (method)">#version</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="WpItem (class)">WpItem</a></span></tt>) <strong>initialize</strong>(target_base_uri, options = {})
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>target_base_uri</span>
<span class='type'>(<tt><span class='object_link'><a href="URI.html" title="URI (module)">URI</a></span></tt>)</span>
</li>
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
&mdash;
<div class='inline'>
<p>See allowed_option</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34
35
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_target_base_uri'>target_base_uri</span><span class='comma'>,</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='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:wp_content_dir</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>wp-content</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:wp_plugins_dir</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:wp_content_dir</span><span class='rbracket'>]</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/plugins</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_set_options'>set_options</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_forge_uri'>forge_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_target_base_uri'>target_base_uri</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="found_from=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="found_from-instance_method">
- (<tt>Object</tt>) <strong>found_from</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute found_from</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
4
5
6</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item/findable.rb', line 4</span>
<span class='kw'>def</span> <span class='id identifier rubyid_found_from'>found_from</span>
<span class='ivar'>@found_from</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="name=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
- (<tt>Object</tt>) <strong>name</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute name</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="path=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="path-instance_method">
- (<tt>Object</tt>) <strong>path</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute path</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span>
<span class='ivar'>@path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="version=-instance_method">
- (<tt>Object</tt>) <strong>version=</strong>(value) <span class="extras">(writeonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Sets the attribute version</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'></span>
&mdash;
<div class='inline'>
<p>the value to set the attribute version to.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
4
5
6</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item/versionable.rb', line 4</span>
<span class='kw'>def</span> <span class='id identifier rubyid_version='>version=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@version</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="wp_content_dir=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="wp_content_dir-instance_method">
- (<tt>Object</tt>) <strong>wp_content_dir</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute wp_content_dir</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_wp_content_dir'>wp_content_dir</span>
<span class='ivar'>@wp_content_dir</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="wp_plugins_dir=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="wp_plugins_dir-instance_method">
- (<tt>Object</tt>) <strong>wp_plugins_dir</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute wp_plugins_dir</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_wp_plugins_dir'>wp_plugins_dir</span>
<span class='ivar'>@wp_plugins_dir</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="<=>-instance_method">
- (<tt>Object</tt>) <strong>&lt;=&gt;</strong>(other)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>other</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="WpItem (class)">WpItem</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 89</span>
<span class='kw'>def</span> <span class='op'>&lt;=&gt;</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
<span class='id identifier rubyid_name'>name</span> <span class='op'>&lt;=&gt;</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="==-instance_method">
- (<tt>Object</tt>) <strong>==</strong>(other)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>other</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="WpItem (class)">WpItem</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
94
95
96</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 94</span>
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
<span class='id identifier rubyid_name'>name</span> <span class='op'>===</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="===-instance_method">
- (<tt>Object</tt>) <strong>===</strong>(other)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>other</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="WpItem (class)">WpItem</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 99</span>
<span class='kw'>def</span> <span class='op'>===</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
<span class='kw'>self</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_version'>version</span> <span class='op'>===</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="allowed_options-instance_method">
- (<tt><span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span></tt>) <strong>allowed_options</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Make it private ?</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_allowed_options'>allowed_options</span>
<span class='lbracket'>[</span><span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:wp_content_dir</span><span class='comma'>,</span> <span class='symbol'>:wp_plugins_dir</span><span class='comma'>,</span> <span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:version</span><span class='comma'>,</span> <span class='symbol'>:vulns_file</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="forge_uri-instance_method">
- (<tt>void</tt>) <strong>forge_uri</strong>(target_base_uri)
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>target_base_uri</span>
<span class='type'>(<tt><span class='object_link'><a href="URI.html" title="URI (module)">URI</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_forge_uri'>forge_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_target_base_uri'>target_base_uri</span><span class='rparen'>)</span>
<span class='ivar'>@uri</span> <span class='op'>=</span> <span class='id identifier rubyid_target_base_uri'>target_base_uri</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="set_options-instance_method">
- (<tt>void</tt>) <strong>set_options</strong>(options) <span class="extras">(private)</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46
47
48
49
50
51
52
53
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set_options'>set_options</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_allowed_options'>allowed_options</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_allowed_option'>allowed_option</span><span class='op'>|</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='id identifier rubyid_allowed_option'>allowed_option</span><span class='rparen'>)</span>
<span class='id identifier rubyid_method'>method</span> <span class='op'>=</span> <span class='symbol'>:#{</span><span class='id identifier rubyid_allowed_option'>allowed_option</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='id identifier rubyid_allowed_option'>allowed_option</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbrace'>}</span><span class='tstring_content'> does not respond to </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_method'>method</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="uri-instance_method">
- (<tt><span class='object_link'><a href="URI.html" title="URI (module)">URI</a></span></tt>) <strong>uri</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The uri to the WpItem, with the path if present</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="URI.html" title="URI (module)">URI</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The uri to the WpItem, with the path if present</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>?</span> <span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='ivar'>@uri</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="url-instance_method">
- (<tt>String</tt>) <strong>url</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The url to the WpItem</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The url to the WpItem</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/wp_item.rb', line 72</span>
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span><span class='semicolon'>;</span> <span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 30 23:05:06 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.6.1 (ruby-1.9.3).
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink