mirrors/bonfire-app
1
0
Fork 0
mirror of https://github.com/bonfire-networks/bonfire-app.git synced 2024-05-17 08:32:41 +00:00
Code Issues Projects Releases Wiki Activity
bonfire-app/Bonfire.Files.html
mayel 8c4192f0be deploy: f0e6222a43
2024-04-16 21:21:08 +00:00

557 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.2">
<meta name="project" content="bonfire_umbrella v0.9.10-cooperation-beta.62">
<title>Bonfire.Files — bonfire_umbrella v0.9.10-cooperation-beta.62</title>
<link rel="stylesheet" href="dist/html-elixir-JKHCEBPC.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-A7S2WMC7.js"></script>
<script src="dist/sidebar_items-0AD831F9.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-JRPQ5PR6.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="https://bonfirenetworks.org" class="sidebar-projectImage">
<img src="assets/logo.png" alt="bonfire_umbrella" />
</a>
<div>
<a href="https://bonfirenetworks.org" class="sidebar-projectName" translate="no">
bonfire_umbrella
</a>
<div class="sidebar-projectVersion" translate="no">
v0.9.10-cooperation-beta.62
</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>
</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>
</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 bonfire_umbrella</span>
<input name="q" type="text" class="search-input" placeholder="Press / to search" 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/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L2" 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">Bonfire.Files</span>
<small class="app-vsn" translate="no">(bonfire_umbrella v0.9.10-cooperation-beta.62)</small>
</h1>
<section id="moduledoc">
<p>This module contains general functions for handling files, and also an Ecto schema which is a multimixin for storing one or more media attached to a Pointable object.</p><p>An uploader definition must be provided for each new upload, or will be automatically chosen based on the file type.</p><p>A few definitions exist as defaults inside of this namespace, but you can also define
your own - a <a href="https://hexdocs.pm/bonfire_files/0.1.0/Bonfire.Files.Definition.html"><code class="inline">Bonfire.Files.Definition</code></a> is an extension of <a href="https://hexdocs.pm/waffle/1.1.8/Waffle.Definition.html"><code class="inline">Waffle.Definition</code></a>,
however the <code class="inline">allowed_media_types/0</code> and <code class="inline">max_file_size/0</code> callback are added,
with which you need to define what media types are accepted for these types of uploads.
(You can also return <code class="inline">:all</code> to accept all media types).</p><p>To use the uploader:</p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="p" data-group-id="5072798227-1">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">media</span><span class="p" data-group-id="5072798227-1">}</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Bonfire.Files</span><span class="o">.</span><span class="n">upload</span><span class="p" data-group-id="5072798227-2">(</span><span class="nc">MyUploader</span><span class="p">,</span><span class="w"> </span><span class="n">creator_or_context</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5072798227-3">%{</span><span class="ss">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;./150.png&quot;</span><span class="p" data-group-id="5072798227-3">}</span><span class="p" data-group-id="5072798227-2">)</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">media</span><span class="o">.</span><span class="n">media_type</span><span class="w">
</span><span class="s">&quot;image/png&quot;</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="nc">Bonfire.Files</span><span class="o">.</span><span class="n">remote_url</span><span class="p" data-group-id="5072798227-4">(</span><span class="nc">MyUploader</span><span class="p">,</span><span class="w"> </span><span class="n">media</span><span class="p" data-group-id="5072798227-4">)</span><span class="w">
</span><span class="s">&quot;/uploads/my/01F3AY6JV30G06BY4DR9BTW5EH&quot;</span></code></pre>
</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="#ap_publish_activity/1" translate="no">ap_publish_activity(medias)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#ap_receive_attachments/2" translate="no">ap_receive_attachments(creator, attachments)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#data_url/2" translate="no">data_url(content, mime_type)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#extract_metadata/1" translate="no">extract_metadata(path)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#file_extension/1" translate="no">file_extension(path)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#file_extension_only/1" translate="no">file_extension_only(path)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#full_url/2" translate="no">full_url(module, media)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#normalise_size/2" translate="no">normalise_size(size, default \\ 8)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#remote_url/3" translate="no">remote_url(module \\ nil, media, version \\ :default)</a>
</div>
<div class="summary-synopsis"><p>Return the URL that a local file has.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#upload/5" translate="no">upload(module, creator_or_context, file, attrs \\ %{}, opts \\ [])</a>
</div>
<div class="summary-synopsis"><p>Attempt to store a file, returning an upload, for any parent item that
participates in the meta abstraction, providing the user/context of
the upload.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#validate/3" translate="no">validate(other, allowed_media_types, max_file_size)</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="ap_publish_activity/1">
<div class="detail-header">
<a href="#ap_publish_activity/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">ap_publish_activity(medias)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L387" 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="ap_receive_attachments/2">
<div class="detail-header">
<a href="#ap_receive_attachments/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">ap_receive_attachments(creator, attachments)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L441" 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="data_url/2">
<div class="detail-header">
<a href="#data_url/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">data_url(content, mime_type)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L375" 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="extract_metadata/1">
<div class="detail-header">
<a href="#extract_metadata/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">extract_metadata(path)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L358" 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="file_extension/1">
<div class="detail-header">
<a href="#file_extension/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">file_extension(path)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L181" 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="file_extension_only/1">
<div class="detail-header">
<a href="#file_extension_only/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">file_extension_only(path)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L185" 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="full_url/2">
<div class="detail-header">
<a href="#full_url/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">full_url(module, media)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L380" 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="normalise_size/2">
<span id="normalise_size/1"></span>
<div class="detail-header">
<a href="#normalise_size/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">normalise_size(size, default \\ 8)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L536" 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="remote_url/3">
<span id="remote_url/1"></span>
<span id="remote_url/2"></span>
<div class="detail-header">
<a href="#remote_url/3" 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">remote_url(module \\ nil, media, version \\ :default)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L264" 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>Return the URL that a local file has.</p>
</section>
</section>
<section class="detail" id="upload/5">
<span id="upload/3"></span>
<span id="upload/4"></span>
<div class="detail-header">
<a href="#upload/5" 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">upload(module, creator_or_context, file, attrs \\ %{}, opts \\ [])</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L58" 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>Attempt to store a file, returning an upload, for any parent item that
participates in the meta abstraction, providing the user/context of
the upload.</p>
</section>
</section>
<section class="detail" id="validate/3">
<div class="detail-header">
<a href="#validate/3" 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">validate(other, allowed_media_types, max_file_size)</h1>
<a href="https://github.com/bonfire-networks/bonfire_files/blob/main/lib/files.ex#L136" 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="bonfire_umbrella.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.2) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink