plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-30 11:13:22 +03:00
Code Issues Packages Projects Releases Wiki Activity
84763bacf5
analytics/Plausible.Billing.Feature.html
macobo 84763bacf5 deploy: acbbaa9116
2024-04-08 06:29:49 +00:00

676 lines
22 KiB
HTML
Raw 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.Billing.Feature — 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-B54BD30E.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-L4O5OK2K.js"></script>
</head>
<body data-type="modules" class="page-behaviour">
<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/billing/feature.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.Billing.Feature</span> <small>behaviour</small>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="moduledoc">
<p>This module provides an interface for managing features, e.g. Revenue Goals,
Funnels and Custom Properties.</p><p>Feature modules have functions for toggling the feature on/off and checking
whether the feature is available for a site/user.</p><p>When defining new features, the following options are expected by the
<code class="inline">__using__</code> macro:</p><ul><li><p><code class="inline">:name</code> - an atom representing the feature name in the plan JSON
file (see also Plausible.Billing.Plan).</p></li><li><p><code class="inline">:display_name</code> - human-readable display name of the feature</p></li><li><p><code class="inline">:toggle_field</code> - the field in the %Plausible.Site{} schema that toggles
the feature. If <code class="inline">nil</code> or not set, toggle/2 silently returns <code class="inline">:ok</code></p></li><li><p><code class="inline">:free</code> - if set to <code class="inline">true</code>, makes the <code class="inline">check_availability/1</code> function
always return <code class="inline">:ok</code> (no matter the user's subscription status)</p></li></ul><p>Functions defined by <code class="inline">__using__</code> can be overridden if needed.</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-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:t/0" translate="no">t()</a>
</div>
</div>
</div>
<div class="summary-callbacks summary">
<h2>
<a href="#callbacks">Callbacks</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:check_availability/1" translate="no">check_availability(t)</a>
</div>
<div class="summary-synopsis"><p>Checks whether the site owner or the user plan includes the given feature.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:display_name/0" translate="no">display_name()</a>
</div>
<div class="summary-synopsis"><p>Returns the human-readable display name of the feature.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:enabled?/1" translate="no">enabled?(t)</a>
</div>
<div class="summary-synopsis"><p>Checks whether a feature is enabled or not. Returns false when the feature is
disabled or the user does not have access to it.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:free?/0" translate="no">free?()</a>
</div>
<div class="summary-synopsis"><p>Returns whether the feature is free to use or not.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:name/0" translate="no">name()</a>
</div>
<div class="summary-synopsis"><p>Returns the atom representing the feature name in the plan JSON file.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:opted_out?/1" translate="no">opted_out?(t)</a>
</div>
<div class="summary-synopsis"><p>Returns whether the site explicitly opted out of the feature. This function
is different from enabled/1, because enabled/1 returns false when the site
owner does not have access to the feature.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:toggle/2" translate="no">toggle(t, t)</a>
</div>
<div class="summary-synopsis"><p>Toggles the feature on and off for a site. Returns
<code class="inline">{:error, :upgrade_required}</code> when toggling a feature the site owner does not
have access to.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:toggle_field/0" translate="no">toggle_field()</a>
</div>
<div class="summary-synopsis"><p>Returns the %Plausible.Site{} field that toggles the feature on and off.</p></div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#list/0" translate="no">list()</a>
</div>
<div class="summary-synopsis"><p>Lists all available feature modules.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_short_names/0" translate="no">list_short_names()</a>
</div>
<div class="summary-synopsis"><p>Lists all the feature short names, e.g. RevenueGoals</p></div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Types</span>
</h1>
<div class="types-list">
<section class="detail" id="t:t/0">
<div class="detail-header">
<a href="#t:t/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">t()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L81" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> t() ::
Plausible.Billing.Feature.RevenueGoals
| Plausible.Billing.Feature.Funnels
| Plausible.Billing.Feature.Props
| Plausible.Billing.Feature.StatsAPI
| Plausible.Billing.Feature.Goals</pre>
</div>
</section>
</section>
</div>
</section>
<section id="callbacks" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#callbacks">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Callbacks</span>
</h1>
<div class="callbacks-list">
<section class="detail" id="c:check_availability/1">
<div class="detail-header">
<a href="#c:check_availability/1" class="detail-link" title="Link to this callback">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature" translate="no">check_availability(t)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L69" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@callback</span> check_availability(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>()) ::
:ok | {:error, :upgrade_required} | {:error, :not_implemented}</pre>
</div>
<p>Checks whether the site owner or the user plan includes the given feature.</p>
</section>
</section>
<section class="detail" id="c:display_name/0">
<div class="detail-header">
<a href="#c:display_name/0" class="detail-link" title="Link to this callback">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature" translate="no">display_name()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L34" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@callback</span> display_name() :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()</pre>
</div>
<p>Returns the human-readable display name of the feature.</p>
</section>
</section>
<section class="detail" id="c:enabled?/1">
<div class="detail-header">
<a href="#c:enabled?/1" class="detail-link" title="Link to this callback">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature" translate="no">enabled?(t)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L57" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@callback</span> enabled?(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
</div>
<p>Checks whether a feature is enabled or not. Returns false when the feature is
disabled or the user does not have access to it.</p>
</section>
</section>
<section class="detail" id="c:free?/0">
<div class="detail-header">
<a href="#c:free?/0" class="detail-link" title="Link to this callback">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature" translate="no">free?()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.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">
<div class="specs">
<pre translate="no"><span class="attribute">@callback</span> free?() :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
</div>
<p>Returns whether the feature is free to use or not.</p>
</section>
</section>
<section class="detail" id="c:name/0">
<div class="detail-header">
<a href="#c:name/0" class="detail-link" title="Link to this callback">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature" translate="no">name()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L29" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@callback</span> name() :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()</pre>
</div>
<p>Returns the atom representing the feature name in the plan JSON file.</p>
</section>
</section>
<section class="detail" id="c:opted_out?/1">
<div class="detail-header">
<a href="#c:opted_out?/1" class="detail-link" title="Link to this callback">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature" translate="no">opted_out?(t)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L64" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@callback</span> opted_out?(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
</div>
<p>Returns whether the site explicitly opted out of the feature. This function
is different from enabled/1, because enabled/1 returns false when the site
owner does not have access to the feature.</p>
</section>
</section>
<section class="detail" id="c:toggle/2">
<div class="detail-header">
<a href="#c:toggle/2" class="detail-link" title="Link to this callback">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature" translate="no">toggle(t, t)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L51" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@callback</span> toggle(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>(), <a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) :: :ok | {:error, :upgrade_required}</pre>
</div>
<p>Toggles the feature on and off for a site. Returns
<code class="inline">{:error, :upgrade_required}</code> when toggling a feature the site owner does not
have access to.</p>
</section>
</section>
<section class="detail" id="c:toggle_field/0">
<div class="detail-header">
<a href="#c:toggle_field/0" class="detail-link" title="Link to this callback">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature" translate="no">toggle_field()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L39" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@callback</span> toggle_field() :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()</pre>
</div>
<p>Returns the %Plausible.Site{} field that toggles the feature on and off.</p>
</section>
</section>
</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="list/0">
<div class="detail-header">
<a href="#list/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">list()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L86" 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>Lists all available feature modules.</p>
</section>
</section>
<section class="detail" id="list_short_names/0">
<div class="detail-header">
<a href="#list_short_names/0" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">list_short_names()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L93" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
<p>Lists all the feature short names, e.g. RevenueGoals</p>
</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