Regen ApiGen documentation

This commit is contained in:
FrancescoUK
2017-07-06 22:13:18 +01:00
parent e524593a15
commit 863988d2ab
293 changed files with 14676 additions and 13169 deletions

View File

@@ -136,6 +136,7 @@
<h3>Functions</h3>
<ul>
<li><a href="function-cash_decimals.html">cash_decimals</a></li>
<li><a href="function-currency_side.html">currency_side</a></li>
<li><a href="function-current_language.html">current_language</a></li>
<li><a href="function-current_language_code.html">current_language_code</a></li>
@@ -171,6 +172,7 @@
<li><a href="function-tax_decimals.html">tax_decimals</a></li>
<li><a href="function-to_currency.html">to_currency</a></li>
<li><a href="function-to_currency_no_money.html">to_currency_no_money</a></li>
<li><a href="function-to_currency_tax.html">to_currency_tax</a></li>
<li><a href="function-to_decimals.html">to_decimals</a></li>
<li><a href="function-to_quantity_decimals.html">to_quantity_decimals</a></li>
<li><a href="function-to_tax_decimals.html">to_tax_decimals</a></li>
@@ -208,85 +210,81 @@
</ul>
</div>
<pre class="numbers"><code><span class="l"><a href="#1"> 1: </a></span><span class="l"><a href="#2"> 2: </a></span><span class="l"><a href="#3"> 3: </a></span></span><span class="l"><a href="#4"> 4: </a></span></span><span class="l"><a href="#5"> 5: </a></span></span><span class="l"><a href="#6"> 6: </a></span></span><span class="l"><a href="#7"> 7: </a></span></span><span class="l"><a href="#8"> 8: </a></span></span><span class="l"><a href="#9"> 9: </a></span><span class="l"><a href="#10">10: </a></span><span class="l"><a href="#11">11: </a></span><span class="l"><a href="#12">12: </a></span><span class="l"><a href="#13">13: </a></span><span class="l"><a href="#14">14: </a></span><span class="l"><a href="#15">15: </a></span><span class="l"><a href="#16">16: </a></span><span class="l"><a href="#17">17: </a></span><span class="l"><a href="#18">18: </a></span><span class="l"><a href="#19">19: </a></span><span class="l"><a href="#20">20: </a></span><span class="l"><a href="#21">21: </a></span><span class="l"><a href="#22">22: </a></span><span class="l"><a href="#23">23: </a></span><span class="l"><a href="#24">24: </a></span><span class="l"><a href="#25">25: </a></span><span class="l"><a href="#26">26: </a></span><span class="l"><a href="#27">27: </a></span><span class="l"><a href="#28">28: </a></span><span class="l"><a href="#29">29: </a></span><span class="l"><a href="#30">30: </a></span><span class="l"><a href="#31">31: </a></span><span class="l"><a href="#32">32: </a></span><span class="l"><a href="#33">33: </a></span><span class="l"><a href="#34">34: </a></span><span class="l"><a href="#35">35: </a></span><span class="l"><a href="#36">36: </a></span><span class="l"><a href="#37">37: </a></span><span class="l"><a href="#38">38: </a></span><span class="l"><a href="#39">39: </a></span><span class="l"><a href="#40">40: </a></span><span class="l"><a href="#41">41: </a></span><span class="l"><a href="#42">42: </a></span><span class="l"><a href="#43">43: </a></span><span class="l"><a href="#44">44: </a></span><span class="l"><a href="#45">45: </a></span><span class="l"><a href="#46">46: </a></span><span class="l"><a href="#47">47: </a></span><span class="l"><a href="#48">48: </a></span><span class="l"><a href="#49">49: </a></span><span class="l"><a href="#50">50: </a></span><span class="l"><a href="#51">51: </a></span><span class="l"><a href="#52">52: </a></span><span class="l"><a href="#53">53: </a></span><span class="l"><a href="#54">54: </a></span><span class="l"><a href="#55">55: </a></span><span class="l"><a href="#56">56: </a></span><span class="l"><a href="#57">57: </a></span><span class="l"><a href="#58">58: </a></span><span class="l"><a href="#59">59: </a></span><span class="l"><a href="#60">60: </a></span><span class="l"><a href="#61">61: </a></span><span class="l"><a href="#62">62: </a></span><span class="l"><a href="#63">63: </a></span><span class="l"><a href="#64">64: </a></span><span class="l"><a href="#65">65: </a></span><span class="l"><a href="#66">66: </a></span><span class="l"><a href="#67">67: </a></span><span class="l"><a href="#68">68: </a></span><span class="l"><a href="#69">69: </a></span><span class="l"><a href="#70">70: </a></span><span class="l"><a href="#71">71: </a></span><span class="l"><a href="#72">72: </a></span><span class="l"><a href="#73">73: </a></span><span class="l"><a href="#74">74: </a></span><span class="l"><a href="#75">75: </a></span><span class="l"><a href="#76">76: </a></span><span class="l"><a href="#77">77: </a></span><span class="l"><a href="#78">78: </a></span></code></pre>
<pre class="numbers"><code><span class="l"><a href="#1"> 1: </a></span><span class="l"><a href="#2"> 2: </a></span><span class="l"><a href="#3"> 3: </a></span></span><span class="l"><a href="#4"> 4: </a></span></span><span class="l"><a href="#5"> 5: </a></span><span class="l"><a href="#6"> 6: </a></span><span class="l"><a href="#7"> 7: </a></span><span class="l"><a href="#8"> 8: </a></span><span class="l"><a href="#9"> 9: </a></span><span class="l"><a href="#10">10: </a></span><span class="l"><a href="#11">11: </a></span><span class="l"><a href="#12">12: </a></span><span class="l"><a href="#13">13: </a></span><span class="l"><a href="#14">14: </a></span><span class="l"><a href="#15">15: </a></span><span class="l"><a href="#16">16: </a></span><span class="l"><a href="#17">17: </a></span><span class="l"><a href="#18">18: </a></span><span class="l"><a href="#19">19: </a></span><span class="l"><a href="#20">20: </a></span><span class="l"><a href="#21">21: </a></span><span class="l"><a href="#22">22: </a></span><span class="l"><a href="#23">23: </a></span><span class="l"><a href="#24">24: </a></span><span class="l"><a href="#25">25: </a></span><span class="l"><a href="#26">26: </a></span><span class="l"><a href="#27">27: </a></span><span class="l"><a href="#28">28: </a></span><span class="l"><a href="#29">29: </a></span><span class="l"><a href="#30">30: </a></span><span class="l"><a href="#31">31: </a></span><span class="l"><a href="#32">32: </a></span><span class="l"><a href="#33">33: </a></span><span class="l"><a href="#34">34: </a></span><span class="l"><a href="#35">35: </a></span><span class="l"><a href="#36">36: </a></span><span class="l"><a href="#37">37: </a></span><span class="l"><a href="#38">38: </a></span><span class="l"><a href="#39">39: </a></span><span class="l"><a href="#40">40: </a></span><span class="l"><a href="#41">41: </a></span><span class="l"><a href="#42">42: </a></span><span class="l"><a href="#43">43: </a></span><span class="l"><a href="#44">44: </a></span><span class="l"><a href="#45">45: </a></span><span class="l"><a href="#46">46: </a></span><span class="l"><a href="#47">47: </a></span><span class="l"><a href="#48">48: </a></span><span class="l"><a href="#49">49: </a></span><span class="l"><a href="#50">50: </a></span><span class="l"><a href="#51">51: </a></span><span class="l"><a href="#52">52: </a></span><span class="l"><a href="#53">53: </a></span><span class="l"><a href="#54">54: </a></span><span class="l"><a href="#55">55: </a></span><span class="l"><a href="#56">56: </a></span><span class="l"><a href="#57">57: </a></span><span class="l"><a href="#58">58: </a></span><span class="l"><a href="#59">59: </a></span><span class="l"><a href="#60">60: </a></span><span class="l"><a href="#61">61: </a></span><span class="l"><a href="#62">62: </a></span><span class="l"><a href="#63">63: </a></span><span class="l"><a href="#64">64: </a></span><span class="l"><a href="#65">65: </a></span><span class="l"><a href="#66">66: </a></span><span class="l"><a href="#67">67: </a></span><span class="l"><a href="#68">68: </a></span><span class="l"><a href="#69">69: </a></span><span class="l"><a href="#70">70: </a></span><span class="l"><a href="#71">71: </a></span><span class="l"><a href="#72">72: </a></span><span class="l"><a href="#73">73: </a></span><span class="l"><a href="#74">74: </a></span></code></pre>
<pre class="code"><code><span id="1" class="l"><span class="xlang">&lt;?php</span> <span class="php-keyword1">if</span> (!<span class="php-keyword2">defined</span>(<span class="php-quote">'BASEPATH'</span>)) <span class="php-keyword1">exit</span>(<span class="php-quote">'No direct script access allowed'</span>);
</span><span id="2" class="l">
</span><span id="3" class="l"><span class="php-comment">/**
</span></span><span id="4" class="l"><span class="php-comment"> * Module class
</span></span><span id="5" class="l"><span class="php-comment"> *
</span></span><span id="6" class="l"><span class="php-comment"> * @link github.com/jekkos/opensourcepos
</span></span><span id="7" class="l"><span class="php-comment"> * @since 1.0
</span></span><span id="8" class="l"><span class="php-comment"> * @author N/A
</span></span><span id="9" class="l"><span class="php-comment"> */</span>
</span><span id="10" class="l">
</span><span id="11" class="l"><span class="php-keyword1">class</span> Module <span class="php-keyword1">extends</span> CI_Model
</span><span id="12" class="l">{
</span><span id="13" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_module_name(<span class="php-var">$module_id</span>)
</span><span id="14" class="l"> {
</span><span id="15" class="l"> <span class="php-var">$query</span> = <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'modules'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'module_id'</span> =&gt; <span class="php-var">$module_id</span>), <span class="php-num">1</span>);
</span></span><span id="5" class="l"><span class="php-comment"> */</span>
</span><span id="6" class="l">
</span><span id="7" class="l"><span class="php-keyword1">class</span> Module <span class="php-keyword1">extends</span> CI_Model
</span><span id="8" class="l">{
</span><span id="9" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_module_name(<span class="php-var">$module_id</span>)
</span><span id="10" class="l"> {
</span><span id="11" class="l"> <span class="php-var">$query</span> = <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'modules'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'module_id'</span> =&gt; <span class="php-var">$module_id</span>), <span class="php-num">1</span>);
</span><span id="12" class="l">
</span><span id="13" class="l"> <span class="php-keyword1">if</span>(<span class="php-var">$query</span>-&gt;num_rows() == <span class="php-num">1</span>)
</span><span id="14" class="l"> {
</span><span id="15" class="l"> <span class="php-var">$row</span> = <span class="php-var">$query</span>-&gt;row();
</span><span id="16" class="l">
</span><span id="17" class="l"> <span class="php-keyword1">if</span>(<span class="php-var">$query</span>-&gt;num_rows() == <span class="php-num">1</span>)
</span><span id="18" class="l"> {
</span><span id="19" class="l"> <span class="php-var">$row</span> = <span class="php-var">$query</span>-&gt;row();
</span><span id="20" class="l">
</span><span id="21" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;lang-&gt;line(<span class="php-var">$row</span>-&gt;name_lang_key);
</span><span id="22" class="l"> }
</span><span id="23" class="l">
</span><span id="24" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;lang-&gt;line(<span class="php-quote">'error_unknown'</span>);
</span><span id="25" class="l"> }
</span><span id="17" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;lang-&gt;line(<span class="php-var">$row</span>-&gt;name_lang_key);
</span><span id="18" class="l"> }
</span><span id="19" class="l">
</span><span id="20" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;lang-&gt;line(<span class="php-quote">'error_unknown'</span>);
</span><span id="21" class="l"> }
</span><span id="22" class="l">
</span><span id="23" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_module_desc(<span class="php-var">$module_id</span>)
</span><span id="24" class="l"> {
</span><span id="25" class="l"> <span class="php-var">$query</span> = <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'modules'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'module_id'</span> =&gt; <span class="php-var">$module_id</span>), <span class="php-num">1</span>);
</span><span id="26" class="l">
</span><span id="27" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_module_desc(<span class="php-var">$module_id</span>)
</span><span id="28" class="l"> {
</span><span id="29" class="l"> <span class="php-var">$query</span> = <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'modules'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'module_id'</span> =&gt; <span class="php-var">$module_id</span>), <span class="php-num">1</span>);
</span><span id="27" class="l"> <span class="php-keyword1">if</span>(<span class="php-var">$query</span>-&gt;num_rows() == <span class="php-num">1</span>)
</span><span id="28" class="l"> {
</span><span id="29" class="l"> <span class="php-var">$row</span> = <span class="php-var">$query</span>-&gt;row();
</span><span id="30" class="l">
</span><span id="31" class="l"> <span class="php-keyword1">if</span>(<span class="php-var">$query</span>-&gt;num_rows() == <span class="php-num">1</span>)
</span><span id="32" class="l"> {
</span><span id="33" class="l"> <span class="php-var">$row</span> = <span class="php-var">$query</span>-&gt;row();
</span><span id="34" class="l">
</span><span id="35" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;lang-&gt;line(<span class="php-var">$row</span>-&gt;desc_lang_key);
</span><span id="36" class="l"> }
</span><span id="37" class="l">
</span><span id="38" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;lang-&gt;line(<span class="php-quote">'error_unknown'</span>);
</span><span id="39" class="l"> }
</span><span id="31" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;lang-&gt;line(<span class="php-var">$row</span>-&gt;desc_lang_key);
</span><span id="32" class="l"> }
</span><span id="33" class="l">
</span><span id="34" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;lang-&gt;line(<span class="php-quote">'error_unknown'</span>);
</span><span id="35" class="l"> }
</span><span id="36" class="l">
</span><span id="37" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_all_permissions()
</span><span id="38" class="l"> {
</span><span id="39" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;from(<span class="php-quote">'permissions'</span>);
</span><span id="40" class="l">
</span><span id="41" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_all_permissions()
</span><span id="42" class="l"> {
</span><span id="43" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;from(<span class="php-quote">'permissions'</span>);
</span><span id="44" class="l">
</span><span id="45" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get();
</span><span id="46" class="l"> }
</span><span id="47" class="l">
</span><span id="48" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_all_subpermissions()
</span><span id="49" class="l"> {
</span><span id="50" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;from(<span class="php-quote">'permissions'</span>);
</span><span id="51" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;<span class="php-keyword2">join</span>(<span class="php-quote">'modules'</span>, <span class="php-quote">'modules.module_id = permissions.module_id'</span>);
</span><span id="52" class="l"> <span class="php-comment">// can't quote the parameters correctly when using different operators..</span>
</span><span id="53" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;where(<span class="php-var">$this</span>-&gt;db-&gt;dbprefix(<span class="php-quote">'modules'</span>) . <span class="php-quote">'.module_id!='</span>, <span class="php-quote">'permission_id'</span>, <span class="php-keyword1">FALSE</span>);
</span><span id="54" class="l">
</span><span id="55" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get();
</span><span id="56" class="l"> }
</span><span id="57" class="l">
</span><span id="58" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_all_modules()
</span><span id="59" class="l"> {
</span><span id="60" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;from(<span class="php-quote">'modules'</span>);
</span><span id="61" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;order_by(<span class="php-quote">'sort'</span>, <span class="php-quote">'asc'</span>);
</span><span id="62" class="l">
</span><span id="63" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get();
</span><span id="64" class="l"> }
</span><span id="65" class="l">
</span><span id="66" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_allowed_modules(<span class="php-var">$person_id</span>)
</span><span id="67" class="l"> {
</span><span id="68" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;from(<span class="php-quote">'modules'</span>);
</span><span id="69" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;<span class="php-keyword2">join</span>(<span class="php-quote">'permissions'</span>, <span class="php-quote">'permissions.permission_id = modules.module_id'</span>);
</span><span id="70" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;<span class="php-keyword2">join</span>(<span class="php-quote">'grants'</span>, <span class="php-quote">'permissions.permission_id = grants.permission_id'</span>);
</span><span id="71" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;where(<span class="php-quote">'person_id'</span>, <span class="php-var">$person_id</span>);
</span><span id="72" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;order_by(<span class="php-quote">'sort'</span>, <span class="php-quote">'asc'</span>);
</span><span id="73" class="l">
</span><span id="74" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get();
</span><span id="75" class="l"> }
</span><span id="76" class="l">}
</span><span id="77" class="l"><span class="xlang">?&gt;</span>
</span><span id="78" class="l"></span></code></pre>
</span><span id="41" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get();
</span><span id="42" class="l"> }
</span><span id="43" class="l">
</span><span id="44" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_all_subpermissions()
</span><span id="45" class="l"> {
</span><span id="46" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;from(<span class="php-quote">'permissions'</span>);
</span><span id="47" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;<span class="php-keyword2">join</span>(<span class="php-quote">'modules'</span>, <span class="php-quote">'modules.module_id = permissions.module_id'</span>);
</span><span id="48" class="l"> <span class="php-comment">// can't quote the parameters correctly when using different operators..</span>
</span><span id="49" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;where(<span class="php-var">$this</span>-&gt;db-&gt;dbprefix(<span class="php-quote">'modules'</span>) . <span class="php-quote">'.module_id!='</span>, <span class="php-quote">'permission_id'</span>, <span class="php-keyword1">FALSE</span>);
</span><span id="50" class="l">
</span><span id="51" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get();
</span><span id="52" class="l"> }
</span><span id="53" class="l">
</span><span id="54" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_all_modules()
</span><span id="55" class="l"> {
</span><span id="56" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;from(<span class="php-quote">'modules'</span>);
</span><span id="57" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;order_by(<span class="php-quote">'sort'</span>, <span class="php-quote">'asc'</span>);
</span><span id="58" class="l">
</span><span id="59" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get();
</span><span id="60" class="l"> }
</span><span id="61" class="l">
</span><span id="62" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_allowed_modules(<span class="php-var">$person_id</span>)
</span><span id="63" class="l"> {
</span><span id="64" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;from(<span class="php-quote">'modules'</span>);
</span><span id="65" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;<span class="php-keyword2">join</span>(<span class="php-quote">'permissions'</span>, <span class="php-quote">'permissions.permission_id = modules.module_id'</span>);
</span><span id="66" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;<span class="php-keyword2">join</span>(<span class="php-quote">'grants'</span>, <span class="php-quote">'permissions.permission_id = grants.permission_id'</span>);
</span><span id="67" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;where(<span class="php-quote">'person_id'</span>, <span class="php-var">$person_id</span>);
</span><span id="68" class="l"> <span class="php-var">$this</span>-&gt;db-&gt;order_by(<span class="php-quote">'sort'</span>, <span class="php-quote">'asc'</span>);
</span><span id="69" class="l">
</span><span id="70" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get();
</span><span id="71" class="l"> }
</span><span id="72" class="l">}
</span><span id="73" class="l"><span class="xlang">?&gt;</span>
</span><span id="74" class="l"></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen</a>
@@ -294,6 +292,6 @@
</div>
</div>
<script src="resources/combined.js?ab7ddfe54adb05998edf888264c90e8da7a06c89"></script>
<script src="elementlist.js?393598f38775c491011b04d46c7a40f307e10d0d"></script>
<script src="elementlist.js?107bba78f0ace2667eb8cd2ee2df0b1a23c2c7af"></script>
</body>
</html>