Files
wpscan/doc_yard/WpTimthumbs/Detectable.html
Christian Mehlmauer cd5b45f98b docs
2013-06-09 16:07:04 +02:00

740 lines
22 KiB
HTML

<!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: WpTimthumbs::Detectable
&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 (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../WpTimthumbs.html" title="WpTimthumbs (class)">WpTimthumbs</a></span></span>
&raquo;
<span class="title">Detectable</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: WpTimthumbs::Detectable
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="../WpTimthumbs.html" title="WpTimthumbs (class)">WpTimthumbs</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/common/collections/wp_timthumbs/detectable.rb</dd>
</dl>
<div class="clear"></div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="protected ">
<span class="summary_signature">
<a href="#create_item-instance_method" title="#create_item (instance method)">- (WpTimthumb) <strong>create_item</strong>(wp_target, path = nil) </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#passive_detection-instance_method" title="#passive_detection (instance method)">- (WpTimthumbs) <strong>passive_detection</strong>(wp_target, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>No passive detection.</p>
</div></span>
</li>
<li class="protected ">
<span class="summary_signature">
<a href="#targets_items-instance_method" title="#targets_items (instance method)">- (Array&lt;WpTimthumb&gt;) <strong>targets_items</strong>(wp_target, options = {}) </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="protected ">
<span class="summary_signature">
<a href="#targets_items_from_file-instance_method" title="#targets_items_from_file (instance method)">- (Array&lt;WpTimthumb&gt;) <strong>targets_items_from_file</strong>(file, wp_target) </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="protected ">
<span class="summary_signature">
<a href="#theme_timthumbs-instance_method" title="#theme_timthumbs (instance method)">- (Array&lt;WpTimthumb&gt;) <strong>theme_timthumbs</strong>(theme_name, wp_target) </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'></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="create_item-instance_method">
- (<tt><span class='object_link'><a href="../WpTimthumb.html" title="WpTimthumb (class)">WpTimthumb</a></span></tt>) <strong>create_item</strong>(wp_target, path = nil) <span class="extras">(protected)</span>
</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'>wp_target</span>
<span class='type'>(<tt><span class='object_link'><a href="../WpTarget.html" title="WpTarget (class)">WpTarget</a></span></tt>)</span>
</li>
<li>
<span class='name'>[</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../WpTimthumb.html" title="WpTimthumb (class)">WpTimthumb</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
72
73
74
75
76
77
78
79
80
81</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/collections/wp_timthumbs/detectable.rb', line 72</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_item'>create_item</span><span class='lparen'>(</span><span class='id identifier rubyid_wp_target'>wp_target</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>wp_content_dir:</span> <span class='id identifier rubyid_wp_target'>wp_target</span><span class='period'>.</span><span class='id identifier rubyid_wp_content_dir'>wp_content_dir</span><span class='comma'>,</span>
<span class='label'>wp_plugins_dir:</span> <span class='id identifier rubyid_wp_target'>wp_target</span><span class='period'>.</span><span class='id identifier rubyid_wp_plugins_dir'>wp_plugins_dir</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_path'>path</span>
<span class='const'>WpTimthumb</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_wp_target'>wp_target</span><span class='period'>.</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="passive_detection-instance_method">
- (<tt><span class='object_link'><a href="../WpTimthumbs.html" title="WpTimthumbs (class)">WpTimthumbs</a></span></tt>) <strong>passive_detection</strong>(wp_target, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>No passive detection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>wp_target</span>
<span class='type'>(<tt><span class='object_link'><a href="../WpTarget.html" title="WpTarget (class)">WpTarget</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>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../WpTimthumbs.html" title="WpTimthumbs (class)">WpTimthumbs</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/collections/wp_timthumbs/detectable.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_passive_detection'>passive_detection</span><span class='lparen'>(</span><span class='id identifier rubyid_wp_target'>wp_target</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_new'>new</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="targets_items-instance_method">
- (<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>&lt;<span class='object_link'><a href="../WpTimthumb.html" title="WpTimthumb (class)">WpTimthumb</a></span>&gt;</tt>) <strong>targets_items</strong>(wp_target, options = {}) <span class="extras">(protected)</span>
</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'>wp_target</span>
<span class='type'>(<tt><span class='object_link'><a href="../WpTarget.html" title="WpTarget (class)">WpTarget</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>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
<ul class="option">
<li>
<span class="name">:file</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
&mdash; <div class='inline'>
<p>The path to the file containing the targets</p>
</div>
</li>
<li>
<span class="name">:theme_name</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
</li>
</ul>
<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>&lt;<span class='object_link'><a href="../WpTimthumb.html" title="WpTimthumb (class)">WpTimthumb</a></span>&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26
27
28
29
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/collections/wp_timthumbs/detectable.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_targets_items'>targets_items</span><span class='lparen'>(</span><span class='id identifier rubyid_wp_target'>wp_target</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_targets'>targets</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:theme_name</span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_theme_timthumbs'>theme_timthumbs</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:theme_name</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_wp_target'>wp_target</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:file</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_targets'>targets</span> <span class='op'>+=</span> <span class='id identifier rubyid_targets_items_from_file'>targets_items_from_file</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:file</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_wp_target'>wp_target</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_targets'>targets</span><span class='period'>.</span><span class='id identifier rubyid_uniq'>uniq</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="targets_items_from_file-instance_method">
- (<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>&lt;<span class='object_link'><a href="../WpTimthumb.html" title="WpTimthumb (class)">WpTimthumb</a></span>&gt;</tt>) <strong>targets_items_from_file</strong>(file, wp_target) <span class="extras">(protected)</span>
</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'>file</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
<li>
<span class='name'>wp_target</span>
<span class='type'>(<tt><span class='object_link'><a href="../WpTarget.html" title="WpTarget (class)">WpTarget</a></span></tt>)</span>
</li>
</ul>
<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>&lt;<span class='object_link'><a href="../WpTimthumb.html" title="WpTimthumb (class)">WpTimthumb</a></span>&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58
59
60
61
62
63
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/collections/wp_timthumbs/detectable.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_targets_items_from_file'>targets_items_from_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_wp_target'>wp_target</span><span class='rparen'>)</span>
<span class='id identifier rubyid_targets'>targets</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>r</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span>
<span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_readlines'>readlines</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='op'>|</span>
<span class='id identifier rubyid_targets'>targets</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_create_item'>create_item</span><span class='lparen'>(</span><span class='id identifier rubyid_wp_target'>wp_target</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_targets'>targets</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="theme_timthumbs-instance_method">
- (<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>&lt;<span class='object_link'><a href="../WpTimthumb.html" title="WpTimthumb (class)">WpTimthumb</a></span>&gt;</tt>) <strong>theme_timthumbs</strong>(theme_name, wp_target) <span class="extras">(protected)</span>
</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'>theme_name</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
<li>
<span class='name'>wp_target</span>
<span class='type'>(<tt><span class='object_link'><a href="../WpTarget.html" title="WpTarget (class)">WpTarget</a></span></tt>)</span>
</li>
</ul>
<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>&lt;<span class='object_link'><a href="../WpTimthumb.html" title="WpTimthumb (class)">WpTimthumb</a></span>&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40
41
42
43
44
45
46
47
48
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/collections/wp_timthumbs/detectable.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_theme_timthumbs'>theme_timthumbs</span><span class='lparen'>(</span><span class='id identifier rubyid_theme_name'>theme_name</span><span class='comma'>,</span> <span class='id identifier rubyid_wp_target'>wp_target</span><span class='rparen'>)</span>
<span class='id identifier rubyid_targets'>targets</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_wp_timthumb'>wp_timthumb</span> <span class='op'>=</span> <span class='id identifier rubyid_create_item'>create_item</span><span class='lparen'>(</span><span class='id identifier rubyid_wp_target'>wp_target</span><span class='rparen'>)</span>
<span class='qwords_beg'>%w{
</span><span class='tstring_content'> timthumb.php</span><span class='words_sep'> </span><span class='tstring_content'>lib/timthumb.php</span><span class='words_sep'> </span><span class='tstring_content'>inc/timthumb.php</span><span class='words_sep'> </span><span class='tstring_content'>includes/timthumb.php</span><span class='words_sep'>
</span><span class='tstring_content'> scripts/timthumb.php</span><span class='words_sep'> </span><span class='tstring_content'>tools/timthumb.php</span><span class='words_sep'> </span><span class='tstring_content'>functions/timthumb.php</span><span class='words_sep'>
</span><span class='tstring_end'> }</span></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_path'>path</span><span class='op'>|</span>
<span class='id identifier rubyid_wp_timthumb'>wp_timthumb</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>$wp-content$/themes/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_theme_name'>theme_name</span><span class='rbrace'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_targets'>targets</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_wp_timthumb'>wp_timthumb</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_targets'>targets</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Jun 9 16:05:17 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>