65 lines
27 KiB
HTML
65 lines
27 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>adl-support.utils 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.4-SNAPSHOT</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"><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 current"><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.utils.html#var-*locale*"><div class="inner"><span>*locale*</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-*output-path*"><div class="inner"><span>*output-path*</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-*verbosity*"><div class="inner"><span>*verbosity*</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-all-properties"><div class="inner"><span>all-properties</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-attributes"><div class="inner"><span>attributes</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-base-type"><div class="inner"><span>base-type</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-capitalise"><div class="inner"><span>capitalise</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-child"><div class="inner"><span>child</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-child-with-tag"><div class="inner"><span>child-with-tag</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-children"><div class="inner"><span>children</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-children-with-tag"><div class="inner"><span>children-with-tag</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-column-name"><div class="inner"><span>column-name</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-descendant-with-tag"><div class="inner"><span>descendant-with-tag</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-descendants-with-tag"><div class="inner"><span>descendants-with-tag</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-distinct-properties"><div class="inner"><span>distinct-properties</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-editor-name"><div class="inner"><span>editor-name</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-element.3F"><div class="inner"><span>element?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-emit-header"><div class="inner"><span>emit-header</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-entity-for-property"><div class="inner"><span>entity-for-property</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-entity.3F"><div class="inner"><span>entity?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-find-permissions"><div class="inner"><span>find-permissions</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-formal-primary-key.3F"><div class="inner"><span>formal-primary-key?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-has-non-key-properties.3F"><div class="inner"><span>has-non-key-properties?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-has-primary-key.3F"><div class="inner"><span>has-primary-key?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-insertable-key-properties"><div class="inner"><span>insertable-key-properties</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-insertable-properties"><div class="inner"><span>insertable-properties</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-insertable.3F"><div class="inner"><span>insertable?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-is-quotable-type.3F"><div class="inner"><span>is-quotable-type?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-key-names"><div class="inner"><span>key-names</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-key-properties"><div class="inner"><span>key-properties</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-link-related-query-name"><div class="inner"><span>link-related-query-name</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-link-table-name"><div class="inner"><span>link-table-name</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-link-table.3F"><div class="inner"><span>link-table?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-list-related-query-name"><div class="inner"><span>list-related-query-name</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-path-part"><div class="inner"><span>path-part</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-permission-groups"><div class="inner"><span>permission-groups</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-pretty-name"><div class="inner"><span>pretty-name</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-prompt"><div class="inner"><span>prompt</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-properties"><div class="inner"><span>properties</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-property-for-field"><div class="inner"><span>property-for-field</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-property.3F"><div class="inner"><span>property?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-required-properties"><div class="inner"><span>required-properties</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-safe-name"><div class="inner"><span>safe-name</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-singularise"><div class="inner"><span>singularise</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-sort-by-name"><div class="inner"><span>sort-by-name</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-system-generated.3F"><div class="inner"><span>system-generated?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-type-for-defined"><div class="inner"><span>type-for-defined</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-typedef"><div class="inner"><span>typedef</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-unique-link.3F"><div class="inner"><span>unique-link?</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-user-distinct-properties"><div class="inner"><span>user-distinct-properties</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-user-distinct-property-names"><div class="inner"><span>user-distinct-property-names</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-visible-to"><div class="inner"><span>visible-to</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-volatility"><div class="inner"><span>volatility</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-wrap-lines"><div class="inner"><span>wrap-lines</span></div></a></li><li class="depth-1"><a href="adl-support.utils.html#var-writeable-by"><div class="inner"><span>writeable-by</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">adl-support.utils</h1><div class="doc"><pre class="plaintext">Application Description Language support - utility functions.
|
|
</pre></div><div class="public anchor" id="var-*locale*"><h3>*locale*</h3><h4 class="dynamic">dynamic</h4><div class="usage"></div><div class="doc"><pre class="plaintext">The locale for which files will be generated.
|
|
</pre></div></div><div class="public anchor" id="var-*output-path*"><h3>*output-path*</h3><h4 class="dynamic">dynamic</h4><div class="usage"></div><div class="doc"><pre class="plaintext">The path to which generated files will be written.
|
|
</pre></div></div><div class="public anchor" id="var-*verbosity*"><h3>*verbosity*</h3><h4 class="dynamic">dynamic</h4><div class="usage"></div><div class="doc"><pre class="plaintext">The verbosity of output from the generator.
|
|
</pre></div></div><div class="public anchor" id="var-all-properties"><h3>all-properties</h3><h4 class="type">macro</h4><div class="usage"><code>(all-properties entity)</code></div><div class="doc"><pre class="plaintext">Return all properties of this `entity` (including key properties).
|
|
</pre></div></div><div class="public anchor" id="var-attributes"><h3>attributes</h3><div class="usage"><code>(attributes element)</code><code>(attributes element predicate)</code></div><div class="doc"><pre class="plaintext">Return the attributes of this `element`; if `predicate` is passed, return only those
|
|
attributes satisfying the predicate.</pre></div></div><div class="public anchor" id="var-base-type"><h3>base-type</h3><div class="usage"><code>(base-type property application)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-capitalise"><h3>capitalise</h3><div class="usage"><code>(capitalise s)</code></div><div class="doc"><pre class="plaintext">Return a string like `s` but with each token capitalised.
|
|
</pre></div></div><div class="public anchor" id="var-child"><h3>child</h3><div class="usage"><code>(child element predicate)</code></div><div class="doc"><pre class="plaintext">Return the first child of this `element` satisfying this `predicate`.
|
|
</pre></div></div><div class="public anchor" id="var-child-with-tag"><h3>child-with-tag</h3><div class="usage"><code>(child-with-tag element tag)</code><code>(child-with-tag element tag predicate)</code></div><div class="doc"><pre class="plaintext">Return the first child of this `element` which has this `tag`;
|
|
if `element` is `nil`, return `nil`. If `predicate` is supplied,
|
|
return only the first child with the specified `tag` which satisfies
|
|
the `predicate`.</pre></div></div><div class="public anchor" id="var-children"><h3>children</h3><div class="usage"><code>(children element)</code><code>(children element predicate)</code></div><div class="doc"><pre class="plaintext">Return the children of this `element`; if `predicate` is passed, return only those
|
|
children satisfying the predicate.</pre></div></div><div class="public anchor" id="var-children-with-tag"><h3>children-with-tag</h3><div class="usage"><code>(children-with-tag element tag)</code><code>(children-with-tag element tag predicate)</code></div><div class="doc"><pre class="plaintext">Return all children of this `element` which have this `tag`;
|
|
if `element` is `nil`, return `nil`. If `predicate` is supplied,
|
|
return only those children with the specified `tag` which satisfy
|
|
the `predicate`.</pre></div></div><div class="public anchor" id="var-column-name"><h3>column-name</h3><div class="usage"><code>(column-name property)</code></div><div class="doc"><pre class="plaintext">Return, as a string, the name for the column which represents this `property`.
|
|
</pre></div></div><div class="public anchor" id="var-descendant-with-tag"><h3>descendant-with-tag</h3><div class="usage"><code>(descendant-with-tag element tag)</code><code>(descendant-with-tag element tag predicate)</code></div><div class="doc"><pre class="plaintext">Return the first descendant of this `element`, recursively, which has this `tag`.
|
|
If `predicate` is specified, return the first also satisfying this `predicate`.</pre></div></div><div class="public anchor" id="var-descendants-with-tag"><h3>descendants-with-tag</h3><div class="usage"><code>(descendants-with-tag element tag)</code><code>(descendants-with-tag element tag predicate)</code></div><div class="doc"><pre class="plaintext">Return all descendants of this `element`, recursively, which have this `tag`.
|
|
If `predicate` is specified, return only those also satisfying this `predicate`.</pre></div></div><div class="public anchor" id="var-distinct-properties"><h3>distinct-properties</h3><div class="usage"><code>(distinct-properties entity)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-editor-name"><h3>editor-name</h3><div class="usage"><code>(editor-name entity application)</code></div><div class="doc"><pre class="plaintext">Return the path-part of the editor form for this `entity`. Note:
|
|
assumes the editor form is the first form listed for the entity.</pre></div></div><div class="public anchor" id="var-element.3F"><h3>element?</h3><div class="usage"><code>(element? o)</code></div><div class="doc"><pre class="plaintext">True if `o` is a Clojure representation of an XML element.
|
|
</pre></div></div><div class="public anchor" id="var-emit-header"><h3>emit-header</h3><div class="usage"><code>(emit-header prefix & content)</code></div><div class="doc"><pre class="plaintext">Emit this `content` as a sequence of wrapped lines each prefixed with
|
|
`prefix`, and the whole delimited by rules.</pre></div></div><div class="public anchor" id="var-entity-for-property"><h3>entity-for-property</h3><div class="usage"><code>(entity-for-property property application)</code></div><div class="doc"><pre class="plaintext">If this `property` references an entity, return that entity from this `application`
|
|
</pre></div></div><div class="public anchor" id="var-entity.3F"><h3>entity?</h3><div class="usage"><code>(entity? x)</code></div><div class="doc"><pre class="plaintext">Return true if `x` is an ADL entity.
|
|
</pre></div></div><div class="public anchor" id="var-find-permissions"><h3>find-permissions</h3><div class="usage"><code>(find-permissions & elements)</code></div><div class="doc"><pre class="plaintext">Return appropriate the permissions of the first of these `elements` which
|
|
has permissions.</pre></div></div><div class="public anchor" id="var-formal-primary-key.3F"><h3>formal-primary-key?</h3><div class="usage"><code>(formal-primary-key? prop-or-name entity)</code></div><div class="doc"><pre class="plaintext">Does this `prop-or-name` appear to be a property (or the name of a property)
|
|
which is a formal primary key of this entity?</pre></div></div><div class="public anchor" id="var-has-non-key-properties.3F"><h3>has-non-key-properties?</h3><div class="usage"><code>(has-non-key-properties? entity)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-has-primary-key.3F"><h3>has-primary-key?</h3><div class="usage"><code>(has-primary-key? entity)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-insertable-key-properties"><h3>insertable-key-properties</h3><h4 class="type">macro</h4><div class="usage"><code>(insertable-key-properties entity)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-insertable-properties"><h3>insertable-properties</h3><h4 class="type">macro</h4><div class="usage"><code>(insertable-properties entity)</code></div><div class="doc"><pre class="plaintext">Return all the properties of this `entity` (including key properties) into
|
|
which user-supplied data can be inserted</pre></div></div><div class="public anchor" id="var-insertable.3F"><h3>insertable?</h3><div class="usage"><code>(insertable? property)</code></div><div class="doc"><pre class="plaintext">Return `true` it the value of this `property` may be set from user-supplied data.
|
|
</pre></div></div><div class="public anchor" id="var-is-quotable-type.3F"><h3>is-quotable-type?</h3><div class="usage"><code>(is-quotable-type? property application)</code></div><div class="doc"><pre class="plaintext">True if the value for this field should be quoted.
|
|
</pre></div></div><div class="public anchor" id="var-key-names"><h3>key-names</h3><div class="usage"><code>(key-names entity)</code><code>(key-names entity as-keywords?)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-key-properties"><h3>key-properties</h3><h4 class="type">macro</h4><div class="usage"><code>(key-properties entity)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-link-related-query-name"><h3>link-related-query-name</h3><div class="usage"><code>(link-related-query-name property nearside farside)</code></div><div class="doc"><pre class="plaintext">link is tricky. If there's exactly than one link between the two
|
|
entities, we need to generate the same name from both
|
|
ends of the link</pre></div></div><div class="public anchor" id="var-link-table-name"><h3>link-table-name</h3><div class="usage"><code>(link-table-name e1 e2)</code><code>(link-table-name property e1 e2)</code></div><div class="doc"><pre class="plaintext">Canonical name of a link table between entity `e1` and entity `e2`. However, there
|
|
may be different links between the same two tables with different semantics; if
|
|
`property` is specified, and if more than one property in `e1` links to `e2`, generate
|
|
a more specific link name.</pre></div></div><div class="public anchor" id="var-link-table.3F"><h3>link-table?</h3><div class="usage"><code>(link-table? entity)</code></div><div class="doc"><pre class="plaintext">Return true if this `entity` represents a link table.
|
|
</pre></div></div><div class="public anchor" id="var-list-related-query-name"><h3>list-related-query-name</h3><div class="usage"><code>(list-related-query-name property nearside farside)</code></div><div class="doc"><pre class="plaintext">Return the canonical name of the HugSQL query to return all records on
|
|
`farside` which match a given record on `nearside`, where `nearide` and
|
|
`farside` are both entities.</pre></div></div><div class="public anchor" id="var-path-part"><h3>path-part</h3><div class="usage"><code>(path-part form entity application)</code></div><div class="doc"><pre class="plaintext">Return the URL path part for this `form` of this `entity` within this `application`.
|
|
Note that `form` may be a Clojure XML representation of a `form`, `list` or `page`
|
|
ADL element, or may be one of the keywords `:form`, `:list`, `:page` in which case the
|
|
first child of the `entity` of the specified type will be used.</pre></div></div><div class="public anchor" id="var-permission-groups"><h3>permission-groups</h3><div class="usage"><code>(permission-groups permissions predicate)</code></div><div class="doc"><pre class="plaintext">Return a list of names of groups to which this `predicate` is true of
|
|
some permission taken from these `permissions`, else nil.</pre></div></div><div class="public anchor" id="var-pretty-name"><h3>pretty-name</h3><div class="usage"><code>(pretty-name element)</code></div><div class="doc"><pre class="plaintext">Return a version of the name of this `element` (entity, field,
|
|
form, list, page, property) suitable for use in text visible to the user.</pre></div></div><div class="public anchor" id="var-prompt"><h3>prompt</h3><div class="usage"><code>(prompt field-or-property form entity application)</code></div><div class="doc"><pre class="plaintext">Return an appropriate prompt for the given `field-or-property` taken from this
|
|
`form` of this `entity` of this `application`, in the context of the current
|
|
binding of `*locale*`. TODO: something more sophisticated about i18n</pre></div></div><div class="public anchor" id="var-properties"><h3>properties</h3><h4 class="type">macro</h4><div class="usage"><code>(properties entity)</code></div><div class="doc"><pre class="plaintext">Return all the properties of this `entity`.
|
|
</pre></div></div><div class="public anchor" id="var-property-for-field"><h3>property-for-field</h3><div class="usage"><code>(property-for-field field entity)</code></div><div class="doc"><pre class="plaintext">Return the property within this `entity` which matches this `field`.
|
|
</pre></div></div><div class="public anchor" id="var-property.3F"><h3>property?</h3><div class="usage"><code>(property? o)</code></div><div class="doc"><pre class="plaintext">True if `o` is a property.
|
|
</pre></div></div><div class="public anchor" id="var-required-properties"><h3>required-properties</h3><div class="usage"><code>(required-properties entity)</code></div><div class="doc"><pre class="plaintext">Return the properties of this `entity` which are required and are not
|
|
system generated.</pre></div></div><div class="public anchor" id="var-safe-name"><h3>safe-name</h3><div class="usage"><code>(safe-name o)</code><code>(safe-name o convention)</code></div><div class="doc"><pre class="plaintext">Return a safe name for the object `o`, given the specified `convention`.
|
|
`o` is expected to be either a string or an element. Recognised values for
|
|
`convention` are: #{:c :c-sharp :java :sql}</pre></div></div><div class="public anchor" id="var-singularise"><h3>singularise</h3><div class="usage"><code>(singularise string)</code></div><div class="doc"><pre class="plaintext">Attempt to construct an idiomatic English-language singular of this string.
|
|
</pre></div></div><div class="public anchor" id="var-sort-by-name"><h3>sort-by-name</h3><div class="usage"><code>(sort-by-name elements)</code></div><div class="doc"><pre class="plaintext">Sort these `elements` by their `:name` attribute.
|
|
</pre></div></div><div class="public anchor" id="var-system-generated.3F"><h3>system-generated?</h3><div class="usage"><code>(system-generated? property)</code></div><div class="doc"><pre class="plaintext">True if the value of the `property` is system generated, and
|
|
should not be set by the user.</pre></div></div><div class="public anchor" id="var-type-for-defined"><h3>type-for-defined</h3><div class="usage"><code>(type-for-defined property application)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-typedef"><h3>typedef</h3><div class="usage"><code>(typedef property application)</code></div><div class="doc"><pre class="plaintext">If this `property` is of type `defined`, return its type definition from
|
|
this `application`, else nil.</pre></div></div><div class="public anchor" id="var-unique-link.3F"><h3>unique-link?</h3><div class="usage"><code>(unique-link? e1 e2)</code></div><div class="doc"><pre class="plaintext">True if there is exactly one link between entities `e1` and `e2`.
|
|
</pre></div></div><div class="public anchor" id="var-user-distinct-properties"><h3>user-distinct-properties</h3><div class="usage"><code>(user-distinct-properties entity)</code></div><div class="doc"><pre class="plaintext">Return the properties of this `entity` which are user distinct
|
|
</pre></div></div><div class="public anchor" id="var-user-distinct-property-names"><h3>user-distinct-property-names</h3><div class="usage"><code>(user-distinct-property-names entity)</code></div><div class="doc"><pre class="plaintext">Return, as a set, the names of properties which are user distinct
|
|
</pre></div></div><div class="public anchor" id="var-visible-to"><h3>visible-to</h3><div class="usage"><code>(visible-to permissions)</code></div><div class="doc"><pre class="plaintext">Return a list of names of groups to which are granted read access,
|
|
given these `permissions`, else nil.</pre></div></div><div class="public anchor" id="var-volatility"><h3>volatility</h3><div class="usage"><code>(volatility entity)</code></div><div class="doc"><pre class="plaintext">Return the cache ttl in seconds for records of this `entity`.
|
|
</pre></div></div><div class="public anchor" id="var-wrap-lines"><h3>wrap-lines</h3><div class="usage"><code>(wrap-lines width text)</code><code>(wrap-lines text)</code></div><div class="doc"><pre class="plaintext">Wrap lines in this `text` to this `width`; return a list of lines.
|
|
</pre></div></div><div class="public anchor" id="var-writeable-by"><h3>writeable-by</h3><div class="usage"><code>(writeable-by permissions)</code><code>(writeable-by permissions has-value?)</code></div><div class="doc"><pre class="plaintext">Return a list of names of groups to which are granted write access,
|
|
given these `permissions`, else nil.
|
|
TODO: TOTHINKABOUT: properties are also writeable by `insert` and `noedit`, but only if the
|
|
current value is nil.</pre></div></div></div></body></html> |