2023-10-11 15:41:12 +03:00
<!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.30.3" >
< meta name = "project" content = "Plausible v0.0.1" >
< title > Plausible.Billing.Feature — Plausible v0.0.1< / title >
< link rel = "stylesheet" href = "dist/html-elixir-P5GXSCHE.css" / >
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
< script src = "dist/handlebars.templates-NBND3S2D.js" > < / script >
2023-12-11 15:29:29 +03:00
< script src = "dist/sidebar_items-72CEEEE8.js" > < / script >
2023-10-11 15:41:12 +03:00
< script src = "docs_config.js" > < / script >
< script async src = "dist/html-CGDDOCMI.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 class = "sidebar-button sidebar-toggle" aria-label = "toggle sidebar" >
< i class = "ri-menu-line ri-lg" title = "Collapse/expand sidebar" > < / i >
< / button >
< section class = "sidebar" >
< form class = "sidebar-search" action = "search.html" >
< button type = "submit" class = "search-button" aria-label = "Submit Search" >
< i class = "ri-search-2-line" aria-hidden = "true" title = "Submit search" > < / i >
< / button >
< button type = "button" tabindex = "-1" class = "search-close-button" aria-label = "Cancel Search" >
< i class = "ri-close-line ri-lg" aria-hidden = "true" title = "Cancel search" > < / i >
< / button >
< label class = "search-label" >
< p class = "sr-only" > Search< / p >
< input name = "q" type = "text" class = "search-input" placeholder = "Search..." aria-label = "Input your search terms" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< / label >
< / form >
< div class = "autocomplete" >
< div class = "autocomplete-results" >
< / div >
< / div >
< div class = "sidebar-header" >
< a href = "readme.html" >
< img src = "assets/logo.png" alt = "Plausible" class = "sidebar-projectImage" >
< / a >
< div class = "sidebar-projectDetails" >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
Plausible
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
< / div >
< ul class = "sidebar-listNav" >
< li > < a id = "extras-list-link" href = "#full-list" > Pages< / a > < / li >
< li > < a id = "modules-list-link" href = "#full-list" > Modules< / a > < / li >
< li > < a id = "tasks-list-link" href = "#full-list" > < span translate = "no" > Mix< / span > Tasks< / a > < / li >
< / ul >
< / div >
< div class = "gradient" > < / div >
< ul id = "full-list" > < / ul >
< / section >
< section class = "content" >
< output role = "status" id = "toast" > < / output >
< div class = "content-outer" >
< div id = "content" class = "content-inner" >
< h1 >
< button class = "icon-action display-settings" >
< i class = "ri-settings-3-line" > < / i >
< span class = "sr-only" > Settings< / span >
< / button >
< 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
2023-10-18 11:30:10 +03:00
< 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 >
2023-10-11 15:41:12 +03:00
< / 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 >
Summary
< / a >
< / h1 >
< div class = "summary-callbacks summary" >
< h2 >
< a href = "#callbacks" > Callbacks< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-10-11 23:25:08 +03:00
< a href = "#c:check_availability/1" translate = "no" > check_availability(t)< / a >
2023-10-11 15:41:12 +03:00
< / 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 >
2023-11-17 20:43:12 +03:00
< 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 >
2023-10-18 11:30:10 +03:00
< 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 >
2023-10-11 15:41:12 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#c:toggle/2" translate = "no" > toggle(t, t)< / a >
< / div >
2023-10-18 11:30:10 +03:00
< div class = "summary-synopsis" > < p > Toggles the feature on and off for a site. Returns
2023-10-11 15:41:12 +03:00
< 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 >
< / 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 >
Callbacks
< / a >
< / 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 >
2023-10-11 23:25:08 +03:00
< h1 class = "signature" translate = "no" > check_availability(t)< / h1 >
2023-10-11 15:41:12 +03:00
2023-11-17 20:43:12 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L62" class = "icon-action" rel = "help" title = "View Source" >
2023-10-11 15:41:12 +03:00
< 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" >
2023-10-11 23:25:08 +03:00
< 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 >
2023-10-11 15:41:12 +03:00
< / 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 >
2023-10-18 11:30:10 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L34" class = "icon-action" rel = "help" title = "View Source" >
2023-10-11 15:41:12 +03:00
< 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 >
2023-11-17 20:43:12 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L57" class = "icon-action" rel = "help" title = "View Source" >
2023-10-11 15:41:12 +03:00
< 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 >
2023-11-17 20:43:12 +03:00
< 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 >
2023-10-18 11:30:10 +03:00
< 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 >
2023-10-11 15:41:12 +03:00
< 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 >
2023-11-17 20:43:12 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L51" class = "icon-action" rel = "help" title = "View Source" >
2023-10-11 15:41:12 +03:00
< 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 >
2023-10-18 11:30:10 +03:00
< p > Toggles the feature on and off for a site. Returns
2023-10-11 15:41:12 +03:00
< 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 >
2023-10-18 11:30:10 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L39" class = "icon-action" rel = "help" title = "View Source" >
2023-10-11 15:41:12 +03:00
< 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 >
Functions
< / a >
< / 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 >
2023-11-17 20:43:12 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/feature.ex#L76" class = "icon-action" rel = "help" title = "View Source" >
2023-10-11 15:41:12 +03:00
< 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 >
< / 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.30.3) for the
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
< / section >
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
