/doc/modules/mod_tkvstore/m_tkvstore.html
https://code.google.com/p/zotonic/ · HTML · 72 lines · 60 code · 12 blank · 0 comment · 0 complexity · 9aa40cdff23642d55e57499a9ac71b85 MD5 · raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
- <html>
- <head>
- <title>Module m_tkvstore</title>
- <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
- </head>
- <body bgcolor="white">
- <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
- <hr>
- <h1>Module m_tkvstore</h1>
- <ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Simple store for key/value pairs.
- <p>Copyright 2010 Marc Worrell
- Date: 2010-10-07
- </p>
- <p><b>Behaviours:</b> <a href="gen_model.html"><tt>gen_model</tt></a>.</p>
- <p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p>
- <h2><a name="description">Description</a></h2>Simple store for key/value pairs
- <h2><a name="index">Function Index</a></h2>
- <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#delete-3">delete/3</a></td><td>Delete a value from the store.</td></tr>
- <tr><td valign="top"><a href="#get-3">get/3</a></td><td>Fetch a value from the store.</td></tr>
- <tr><td valign="top"><a href="#init-1">init/1</a></td><td>Ensure that the persistent table is present.</td></tr>
- <tr><td valign="top"><a href="#m_find_value-3">m_find_value/3</a></td><td>Fetch the value for the key from a model source.</td></tr>
- <tr><td valign="top"><a href="#m_to_list-2">m_to_list/2</a></td><td>Transform a value to a list, used for template loops.</td></tr>
- <tr><td valign="top"><a href="#m_value-2">m_value/2</a></td><td>Transform a model value so that it can be formatted or piped through filters.</td></tr>
- <tr><td valign="top"><a href="#put-4">put/4</a></td><td>Put a value into the store.</td></tr>
- </table>
- <h2><a name="functions">Function Details</a></h2>
- <h3 class="function"><a name="delete-3">delete/3</a></h3>
- <div class="spec">
- <p><tt>delete(Type, Key, Context) -> any()</tt></p>
- </div><p>Delete a value from the store</p>
- <h3 class="function"><a name="get-3">get/3</a></h3>
- <div class="spec">
- <p><tt>get(Type, Key, Context) -> any()</tt></p>
- </div><p>Fetch a value from the store</p>
- <h3 class="function"><a name="init-1">init/1</a></h3>
- <div class="spec">
- <p><tt>init(Context) -> any()</tt></p>
- </div><p>Ensure that the persistent table is present</p>
- <h3 class="function"><a name="m_find_value-3">m_find_value/3</a></h3>
- <div class="spec">
- <p><tt>m_find_value(Type::Key, M::Source, Context) -> term()</tt></p>
- </div><p>Fetch the value for the key from a model source</p>
- <h3 class="function"><a name="m_to_list-2">m_to_list/2</a></h3>
- <div class="spec">
- <p><tt>m_to_list(X1::Source, Context) -> list()</tt></p>
- </div><p>Transform a value to a list, used for template loops</p>
- <h3 class="function"><a name="m_value-2">m_value/2</a></h3>
- <div class="spec">
- <p><tt>m_value(M::Source, Context) -> term()</tt></p>
- </div><p>Transform a model value so that it can be formatted or piped through filters</p>
- <h3 class="function"><a name="put-4">put/4</a></h3>
- <div class="spec">
- <p><tt>put(Type, Key, Data, Context) -> any()</tt></p>
- </div><p>Put a value into the store</p>
- <hr>
- <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
- <p><i>Generated by EDoc, Aug 12 2011, 19:36:12.</i></p>
- </body>
- </html>