adl-support/docs/adl-support.forms-support.html

<!DOCTYPE html PUBLIC ""
    "">
<html><head><meta charset="UTF-8" /><title>adl-support.forms-support documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Adl-support</span> <span class="project-version">0.1.6</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to adl-support</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>adl-support</span></div></div></li><li class="depth-2 branch"><a href="adl-support.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="adl-support.filters.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>filters</span></div></a></li><li class="depth-2 branch current"><a href="adl-support.forms-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>forms-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.print-usage.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>print-usage</span></div></a></li><li class="depth-2 branch"><a href="adl-support.rest-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rest-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.tags.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tags</span></div></a></li><li class="depth-2"><a href="adl-support.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="adl-support.forms-support.html#var-all-keys-present.3F"><div class="inner"><span>all-keys-present?</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-auxlist-data-name"><div class="inner"><span>auxlist-data-name</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-form-title"><div class="inner"><span>form-title</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-get-current-value"><div class="inner"><span>get-current-value</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-get-menu-options"><div class="inner"><span>get-menu-options</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-prepare-insertion-params"><div class="inner"><span>prepare-insertion-params</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-property-defaults"><div class="inner"><span>property-defaults</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-query-name"><div class="inner"><span>query-name</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">adl-support.forms-support</h1><div class="doc"><div class="markdown"><p>Application Description Language support - functions useful in generating forms.</p></div></div><div class="public anchor" id="var-all-keys-present.3F"><h3>all-keys-present?</h3><h4 class="type">macro</h4><div class="usage"><code>(all-keys-present? m keys)</code></div><div class="doc"><div class="markdown"><p>Return true if all the keys in <code>keys</code> are present in the map <code>m</code>.</p></div></div></div><div class="public anchor" id="var-auxlist-data-name"><h3>auxlist-data-name</h3><h4 class="type">macro</h4><div class="usage"><code>(auxlist-data-name auxlist)</code></div><div class="doc"><div class="markdown"><p>The name to which data for this <code>auxlist</code> will be bound in the Selmer params.</p></div></div></div><div class="public anchor" id="var-form-title"><h3>form-title</h3><div class="usage"><code>(form-title record form-name user-distinct-property-keys)</code></div><div class="doc"><div class="markdown"><p>Construct an appropriate title for a form having this <code>form-name</code>, for an entity having these <code>user-distinct-property-keys</code>, given this <code>record</code>.</p></div></div></div><div class="public anchor" id="var-get-current-value"><h3>get-current-value</h3><h4 class="type">macro</h4><div class="usage"><code>(get-current-value f params entity-name)</code></div><div class="doc"><div class="markdown"><p>Use the function <code>f</code> and these <code>params</code> to fetch an <code>entity</code> record from the database.</p></div></div></div><div class="public anchor" id="var-get-menu-options"><h3>get-menu-options</h3><h4 class="type">macro</h4><div class="usage"><code>(get-menu-options entity-name get-q list-q fk value)</code></div><div class="doc"><div class="markdown"><p>Fetch options for a menu of <code>entity-name</code> from the database, using this <code>get-q</code> query and this <code>list-q</code> query, using the key <code>fk</code>, where the current value is this <code>value</code>.</p></div></div></div><div class="public anchor" id="var-prepare-insertion-params"><h3>prepare-insertion-params</h3><h4 class="type">macro</h4><div class="usage"><code>(prepare-insertion-params params fields)</code></div><div class="doc"><div class="markdown"><p>Params for insertion into the database must have keys for all fields in the insert query, even if the value of some of those keys is nil. Massage these <code>params</code> to have a value for each field in these <code>fields</code>.</p></div></div></div><div class="public anchor" id="var-property-defaults"><h3>property-defaults</h3><div class="usage"><code>(property-defaults entity)</code></div><div class="doc"><div class="markdown"><p>Get a map of property names and default values for all properties of this <code>entity</code> which have explicit defaults.</p></div></div></div><div class="public anchor" id="var-query-name"><h3>query-name</h3><div class="usage"><code>(query-name entity-or-name q-type)</code></div><div class="doc"><div class="markdown"><p>Generate a query name for the query of type <code>q-type</code> (expected to be one of <code>:create</code>, <code>:delete</code>, <code>:get</code>, <code>:list</code>, <code>:search-strings</code>, <code>:update</code>) of the entity <code>entity-or-name</code> NOTE: if <code>entity-or-name</code> is passed as a string, it should be the full, unaltered name of the entity.</p></div></div></div></div></body></html>
	`<!DOCTYPE html PUBLIC ""`
	`"">`
	<html><head><meta charset="UTF-8" /><title>adl-support.forms-support documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Adl-support</span> <span class="project-version">0.1.6</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to adl-support</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>adl-support</span></div></div></li><li class="depth-2 branch"><a href="adl-support.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="adl-support.filters.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>filters</span></div></a></li><li class="depth-2 branch current"><a href="adl-support.forms-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>forms-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.print-usage.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>print-usage</span></div></a></li><li class="depth-2 branch"><a href="adl-support.rest-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rest-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.tags.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tags</span></div></a></li><li class="depth-2"><a href="adl-support.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="adl-support.forms-support.html#var-all-keys-present.3F"><div class="inner"><span>all-keys-present?</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-auxlist-data-name"><div class="inner"><span>auxlist-data-name</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-form-title"><div class="inner"><span>form-title</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-get-current-value"><div class="inner"><span>get-current-value</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-get-menu-options"><div class="inner"><span>get-menu-options</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-prepare-insertion-params"><div class="inner"><span>prepare-insertion-params</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-property-defaults"><div class="inner"><span>property-defaults</span></div></a></li><li class="depth-1"><a href="adl-support.forms-support.html#var-query-name"><div class="inner"><span>query-name</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">adl-support.forms-support</h1><div class="doc"><div class="markdown"><p>Application Description Language support - functions useful in generating forms.</p></div></div><div class="public anchor" id="var-all-keys-present.3F"><h3>all-keys-present?</h3><h4 class="type">macro</h4><div class="usage"><code>(all-keys-present? m keys)</code></div><div class="doc"><div class="markdown"><p>Return true if all the keys in <code>keys</code> are present in the map <code>m</code>.</p></div></div></div><div class="public anchor" id="var-auxlist-data-name"><h3>auxlist-data-name</h3><h4 class="type">macro</h4><div class="usage"><code>(auxlist-data-name auxlist)</code></div><div class="doc"><div class="markdown"><p>The name to which data for this <code>auxlist</code> will be bound in the Selmer params.</p></div></div></div><div class="public anchor" id="var-form-title"><h3>form-title</h3><div class="usage"><code>(form-title record form-name user-distinct-property-keys)</code></div><div class="doc"><div class="markdown"><p>Construct an appropriate title for a form having this <code>form-name</code>, for an entity having these <code>user-distinct-property-keys</code>, given this <code>record</code>.</p></div></div></div><div class="public anchor" id="var-get-current-value"><h3>get-current-value</h3><h4 class="type">macro</h4><div class="usage"><code>(get-current-value f params entity-name)</code></div><div class="doc"><div class="markdown"><p>Use the function <code>f</code> and these <code>params</code> to fetch an <code>entity</code> record from the database.</p></div></div></div><div class="public anchor" id="var-get-menu-options"><h3>get-menu-options</h3><h4 class="type">macro</h4><div class="usage"><code>(get-menu-options entity-name get-q list-q fk value)</code></div><div class="doc"><div class="markdown"><p>Fetch options for a menu of <code>entity-name</code> from the database, using this <code>get-q</code> query and this <code>list-q</code> query, using the key <code>fk</code>, where the current value is this <code>value</code>.</p></div></div></div><div class="public anchor" id="var-prepare-insertion-params"><h3>prepare-insertion-params</h3><h4 class="type">macro</h4><div class="usage"><code>(prepare-insertion-params params fields)</code></div><div class="doc"><div class="markdown"><p>Params for insertion into the database must have keys for all fields in the insert query, even if the value of some of those keys is nil. Massage these <code>params</code> to have a value for each field in these <code>fields</code>.</p></div></div></div><div class="public anchor" id="var-property-defaults"><h3>property-defaults</h3><div class="usage"><code>(property-defaults entity)</code></div><div class="doc"><div class="markdown"><p>Get a map of property names and default values for all properties of this <code>entity</code> which have explicit defaults.</p></div></div></div><div class="public anchor" id="var-query-name"><h3>query-name</h3><div class="usage"><code>(query-name entity-or-name q-type)</code></div><div class="doc"><div class="markdown"><p>Generate a query name for the query of type <code>q-type</code> (expected to be one of <code>:create</code>, <code>:delete</code>, <code>:get</code>, <code>:list</code>, <code>:search-strings</code>, <code>:update</code>) of the entity <code>entity-or-name</code> NOTE: if <code>entity-or-name</code> is passed as a string, it should be the full, unaltered name of the entity.</p></div></div></div></div></body></html>