<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::ItemQuery
— Documentation by YARD 0.9.28
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Doing::ItemQuery";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (I)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">ItemQuery</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Doing::ItemQuery
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/item/query.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Tag and search filtering for a Doing entry</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="#highlight_search-instance_method" title="#highlight_search (instance method)">#<strong>highlight_search</strong>(search, distance: nil, negate: false, case_type: nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ignore_case-instance_method" title="#ignore_case (instance method)">#<strong>ignore_case</strong>(search, case_type) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Determine if case should be ignored for searches.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#keep_item%3F-instance_method" title="#keep_item? (instance method)">#<strong>keep_item?</strong>(opt) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Used by filter_items determine whether an item matches a set of criteria.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(search, distance: nil, negate: false, case_type: nil) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if item matches search string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tag_values%3F-instance_method" title="#tag_values? (instance method)">#<strong>tag_values?</strong>(queries, bool = :and, negate: false) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if item matches tag values.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tags%3F-instance_method" title="#tags? (instance method)">#<strong>tags?</strong>(tags, bool = :and, negate: false) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if item contains tag(s).</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="highlight_search-instance_method">
#<strong>highlight_search</strong>(search, distance: nil, negate: false, case_type: nil) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="ignore_case-instance_method">
#<strong>ignore_case</strong>(search, case_type) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Determine if case should be ignored for searches</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>search</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The search string</p>
</div>
</li>
<li>
<span class='name'>case_type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>The case type</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>case should be ignored</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="keep_item?-instance_method">
#<strong>keep_item?</strong>(opt) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Used by filter_items determine whether an item matches a set of criteria</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>filter parameters</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>whether the item matches all filter criteria</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="search-instance_method">
#<strong>search</strong>(search, distance: nil, negate: false, case_type: nil) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if item matches search string</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>search</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The search string</p>
</div>
</li>
<li>
<span class='name'>negate</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>negate results</p>
</div>
</li>
<li>
<span class='name'>case_type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The case-sensitivity
type (:sensitive,
:ignore, :smart)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>matches search criteria</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tag_values?-instance_method">
#<strong>tag_values?</strong>(queries, bool = :and, negate: false) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if item matches tag values</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>queries</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>The tag value queries to test</p>
</div>
</li>
<li>
<span class='name'>bool</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:and</tt>)</em>
—
<div class='inline'><p>The boolean to use for multiple tags (:and, :or, :not)</p>
</div>
</li>
<li>
<span class='name'>negate</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>negate the result?</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if tag/bool combination passes</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tags?-instance_method">
#<strong>tags?</strong>(tags, bool = :and, negate: false) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if item contains tag(s)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>tags</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span> or <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The tags to test. Can be an array or a comma-separated string.</p>
</div>
</li>
<li>
<span class='name'>bool</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:and</tt>)</em>
—
<div class='inline'><p>The boolean to use for multiple tags (:and, :or, :not)</p>
</div>
</li>
<li>
<span class='name'>negate</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>negate the result?</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if tag/bool combination passes</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Mar 11 05:55:28 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.0.1).
</div>
</div>
</body>
</html>