TWiki/TWikiQueryHoistREsDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::Query::_HoistREs"></a> Package =TWiki::Query::HoistREs
   2
   3 Static functions to extract regular expressions from queries. The REs can be used in caching stores that use the TWiki standard inline meta-data representation to pre-filter topic lists for more efficient query matching.
   4
   5 See `Store/RcsFile.pm` for an example of usage.
   6
   7 <div>
   8   <ul>
   9     <li><a href="#Package =TWiki::Query::_HoistREs"> Package TWiki::Query::HoistREs</a><ul>
  10         <li><a href="#ObjectMethod <strong>hoist</strong> ($query) ->"> ObjectMethod hoist <tt>($query) -&gt; @res</tt></a></li>
  11       </ul>
  12     </li>
  13   </ul>
  14 </div>
  15
  16 ## <a name="ObjectMethod &lt;strong&gt;hoist&lt;/strong&gt; ($query) -"></a><a name="ObjectMethod &lt;strong&gt;hoist&lt;/strong&gt; ($query) - "></a> [[ObjectMethod]] **hoist** `($query) -> @res`
  17
  18 Extract useful filter REs from the given query. The list returned is a list of filter expressions that can be used with a cache search to refine the list of topics. The full query should still be applied to topics that remain after the filter match has been applied; this is purely an optimisation.