plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-22 10:43:38 +03:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
analytics/Plausible.Stats.Filters.html
github-merge-queue[bot] b37fe84486 deploy: 2a7d02b6f0
2024-11-21 14:36:40 +00:00

536 lines
19 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.31.1">
<meta name="project" content="Plausible v0.0.1">
<title>Plausible.Stats.Filters — Plausible v0.0.1</title>
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
<script src="dist/sidebar_items-DD84C8DF.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-L4O5OK2K.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<div class="background-layer"></div>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<a href="readme.html" class="sidebar-projectImage">
<img src="assets/logo.png" alt="Plausible" />
</a>
<div>
<a href="readme.html" class="sidebar-projectName" translate="no">
Plausible
</a>
<div class="sidebar-projectVersion" translate="no">
v0.0.1
</div>
</div>
</div>
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
<li>
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
Pages
</button>
</li>
<li>
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
Modules
</button>
</li>
<li>
<button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1">
<span translate="no">Mix</span> Tasks
</button>
</li>
</ul>
</div>
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
<ul id="extras-full-list" class="full-list"></ul>
</div>
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
<ul id="modules-full-list" class="full-list"></ul>
</div>
<div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden>
<ul id="tasks-full-list" class="full-list"></ul>
</div>
</nav>
<main class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of Plausible</span>
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<div class="autocomplete">
</div>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">Plausible.Stats.Filters</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="moduledoc">
<p>A module for parsing filters used in stat queries.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Summary</span>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#dimensions_used_in_filters/2" translate="no">dimensions_used_in_filters(filters, opts \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#event_props/0" translate="no">event_props()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#event_table_visit_props/0" translate="no">event_table_visit_props()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#filtering_on_dimension?/2" translate="no">filtering_on_dimension?(query, dimension)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_toplevel_filter/2" translate="no">get_toplevel_filter(query, prefix)</a>
</div>
<div class="summary-synopsis"><p>Gets the first top level filter with matching dimension (or nil).</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#parse/1" translate="no">parse(filters)</a>
</div>
<div class="summary-synopsis"><p>Parses different filter formats.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#rename_dimensions_used_in_filter/2" translate="no">rename_dimensions_used_in_filter(filters, renames)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#transform_filters/2" translate="no">transform_filters(filters, transformer)</a>
</div>
<div class="summary-synopsis"><p>Updates filters via <code class="inline">transformer</code>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#visit_props/0" translate="no">visit_props()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#without_prefix/1" translate="no">without_prefix(dimension)</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="dimensions_used_in_filters/2">
<span id="dimensions_used_in_filters/1"></span>
<div class="detail-header">
<a href="#dimensions_used_in_filters/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">dimensions_used_in_filters(filters, opts \\ [])</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L97" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="event_props/0">
<div class="detail-header">
<a href="#event_props/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">event_props()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L48" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="event_table_visit_props/0">
<div class="detail-header">
<a href="#event_table_visit_props/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">event_table_visit_props()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L44" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="filtering_on_dimension?/2">
<div class="detail-header">
<a href="#filtering_on_dimension?/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">filtering_on_dimension?(query, dimension)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L106" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="get_toplevel_filter/2">
<div class="detail-header">
<a href="#get_toplevel_filter/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_toplevel_filter(query, prefix)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L116" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Gets the first top level filter with matching dimension (or nil).</p><p>Only use in cases where it's known that filters are only set on the top level as it
does not handle AND/OR/NOT!</p>
</section>
</section>
<section class="detail" id="parse/1">
<div class="detail-header">
<a href="#parse/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">parse(filters)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L72" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Parses different filter formats.</p><p>Depending on the format and type of the <code class="inline">filters</code> argument, returns:</p><ul><li>a decoded list, when <code class="inline">filters</code> is encoded JSON</li><li>a parsed filter list, when <code class="inline">filters</code> is a filter expression string</li><li>the same list, when <code class="inline">filters</code> is a map</li></ul><p>Returns an empty list when argument type is unexpected (e.g. <code class="inline">nil</code>).</p><h3 id="parse/1-examples" class="section-heading">
<a href="#parse/1-examples" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Examples:</span>
</h3>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="nc">Filters</span><span class="o">.</span><span class="n">parse</span><span class="p" data-group-id="5318041628-1">(</span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">page</span><span class="se">\&quot;</span><span class="s">:</span><span class="se">\&quot;</span><span class="s">/blog/**</span><span class="se">\&quot;</span><span class="s">}&quot;</span><span class="p" data-group-id="5318041628-1">)</span><span class="w">
</span><span class="p" data-group-id="5318041628-2">[</span><span class="p" data-group-id="5318041628-3">[</span><span class="ss">:matches_wildcard</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;event:page&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5318041628-4">[</span><span class="s">&quot;/blog/**&quot;</span><span class="p" data-group-id="5318041628-4">]</span><span class="p" data-group-id="5318041628-3">]</span><span class="p" data-group-id="5318041628-2">]</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="nc">Filters</span><span class="o">.</span><span class="n">parse</span><span class="p" data-group-id="5318041628-5">(</span><span class="s">&quot;visit:browser!=Chrome&quot;</span><span class="p" data-group-id="5318041628-5">)</span><span class="w">
</span><span class="p" data-group-id="5318041628-6">[</span><span class="p" data-group-id="5318041628-7">[</span><span class="ss">:is_not</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;visit:browser&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5318041628-8">[</span><span class="s">&quot;Chrome&quot;</span><span class="p" data-group-id="5318041628-8">]</span><span class="p" data-group-id="5318041628-7">]</span><span class="p" data-group-id="5318041628-6">]</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="nc">Filters</span><span class="o">.</span><span class="n">parse</span><span class="p" data-group-id="5318041628-9">(</span><span class="no">nil</span><span class="p" data-group-id="5318041628-9">)</span><span class="w">
</span><span class="p" data-group-id="5318041628-10">[</span><span class="p" data-group-id="5318041628-10">]</span></code></pre>
</section>
</section>
<section class="detail" id="rename_dimensions_used_in_filter/2">
<div class="detail-header">
<a href="#rename_dimensions_used_in_filter/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">rename_dimensions_used_in_filter(filters, renames)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L122" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="transform_filters/2">
<div class="detail-header">
<a href="#transform_filters/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">transform_filters(filters, transformer)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L139" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Updates filters via <code class="inline">transformer</code>.</p><p>Transformer will receive each node (filter, and/or/not subtree) of
query and must return a list of nodes to replace it with or nil
to ignore and look deeper.</p>
</section>
</section>
<section class="detail" id="visit_props/0">
<div class="detail-header">
<a href="#visit_props/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">visit_props()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L35" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="without_prefix/1">
<div class="detail-header">
<a href="#without_prefix/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">without_prefix(dimension)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/filters.ex#L90" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Plausible.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.1) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad: true})</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink