Files
opensourcepos/docs/class-emberlabs.Barcode.BarcodeBase.html
FrancescoUK f9fb9e44b3 Added apigen to generate OSPOS code documentation (see docs)
Added grunt-composer and grunt-apigen and scripted all the steps in Grunt
2017-04-29 23:43:15 +01:00

663 lines
12 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class emberlabs\Barcode\BarcodeBase</title>
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active">
<a href="namespace-emberlabs.html">
emberlabs<span></span>
</a>
<ul>
<li class="active">
<a href="namespace-emberlabs.Barcode.html">
Barcode </a>
</li>
</ul></li>
<li>
<a href="namespace-None.html">
None </a>
</li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-emberlabs.Barcode.BarcodeBase.html">BarcodeBase</a></li>
<li><a href="class-emberlabs.Barcode.Code128.html">Code128</a></li>
<li><a href="class-emberlabs.Barcode.Code39.html">Code39</a></li>
<li><a href="class-emberlabs.Barcode.Ean13.html">Ean13</a></li>
<li><a href="class-emberlabs.Barcode.Ean8.html">Ean8</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-emberlabs.Barcode.html" title="Summary of emberlabs\Barcode"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class BarcodeBase</h1>
<div class="description">
<p>emberlabs Barcode Creator - Barcode Base Abstract Base</p>
</div>
<div>
<h4>Direct known subclasses</h4>
<a href="class-emberlabs.Barcode.Code128.html">emberlabs\Barcode\Code128</a>,
<a href="class-emberlabs.Barcode.Code39.html">emberlabs\Barcode\Code39</a>,
<a href="class-emberlabs.Barcode.Ean13.html">emberlabs\Barcode\Ean13</a>,
<a href="class-emberlabs.Barcode.Ean8.html">emberlabs\Barcode\Ean8</a>
</div>
<div class="info">
<b>Abstract</b><br>
<b>Namespace:</b> <a href="namespace-emberlabs.html">emberlabs</a>\<a href="namespace-emberlabs.Barcode.html">Barcode</a><br>
<b>License:</b>
<a href="http://opensource.org/licenses/mit-license.php">The MIT License</a><br>
<b>Link:</b>
<a href="https://github.com/samt/barcode">https://github.com/samt/barcode</a><br>
<b>Located at</b> <a href="source-class-emberlabs.Barcode.BarcodeBase.html#14-216" title="Go to source code">views/barcodes/BarcodeBase.php</a>
<br>
</div>
<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="setData" id="_setData">
<td class="attributes"><code>
abstract public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setData">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#64" title="Go to source code">setData</a>( <span> <var>$data</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getData" id="_getData">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getData">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#73-76" title="Go to source code">getData</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="validate" id="_validate">
<td class="attributes"><code>
public
boolean
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_validate">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#78-86" title="Go to source code">validate</a>( <span> <var>$barcode</var></span> )</code>
<div class="description short">
<p>Validate the given barcode.</p>
</div>
<div class="description detailed hidden">
<p>Validate the given barcode.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$barcode</var></dt>
<dd>barcode to validate</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
boolean<br>true if it complies with the barcode formatting
</div>
</div>
</div></td>
</tr>
<tr data-order="generate" id="_generate">
<td class="attributes"><code>
public
mixed
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_generate">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#88-97" title="Go to source code">generate</a>( <span> <var>$number</var></span> )</code>
<div class="description short">
<p>Generate a barcode for this implementation using the given seed.
Default implementation returns just the seed</p>
</div>
<div class="description detailed hidden">
<p>Generate a barcode for this implementation using the given seed.
Default implementation returns just the seed</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$number</var></dt>
<dd>seed to generate a barcode for</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
mixed<br>The generated barcode
</div>
</div>
</div></td>
</tr>
<tr data-order="draw" id="_draw">
<td class="attributes"><code>
abstract public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_draw">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#104" title="Go to source code">draw</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="setDimensions" id="_setDimensions">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setDimensions">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#113-119" title="Go to source code">setDimensions</a>( <span> <var>$x</var></span>, <span> <var>$y</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="setQuality" id="_setQuality">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setQuality">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#126-131" title="Go to source code">setQuality</a>( <span> <var>$q</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="enableHumanText" id="_enableHumanText">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_enableHumanText">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#138-143" title="Go to source code">enableHumanText</a>( <span> <var>$enable</var> = <span class="php-keyword1">true</span></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="output" id="_output">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_output">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#150-168" title="Go to source code">output</a>( <span> <var>$type</var> = <span class="php-quote">'png'</span></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save" id="_save">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#179-202" title="Go to source code">save</a>( <span> <var>$filename</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="base64" id="_base64">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_base64">#</a>
<code><a href="source-class-emberlabs.Barcode.BarcodeBase.html#209-215" title="Go to source code">base64</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
<table class="summary properties" id="properties">
<caption>Properties summary</caption>
<tr data-order="img" id="$img">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-emberlabs.Barcode.BarcodeBase.html#28" title="Go to source code"><var>$img</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$img" class="anchor">#</a>
<code><span class="php-keyword1">null</span></code>
</div>
</td>
</tr>
<tr data-order="data" id="$data">
<td class="attributes"><code>
protected
string
</code></td>
<td class="name">
<a href="source-class-emberlabs.Barcode.BarcodeBase.html#33" title="Go to source code"><var>$data</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$data" class="anchor">#</a>
<code><span class="php-quote">''</span></code>
</div>
</td>
</tr>
<tr data-order="x" id="$x">
<td class="attributes"><code>
protected
integer
</code></td>
<td class="name">
<a href="source-class-emberlabs.Barcode.BarcodeBase.html#38" title="Go to source code"><var>$x</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$x" class="anchor">#</a>
<code><span class="php-num">0</span></code>
</div>
</td>
</tr>
<tr data-order="y" id="$y">
<td class="attributes"><code>
protected
integer
</code></td>
<td class="name">
<a href="source-class-emberlabs.Barcode.BarcodeBase.html#43" title="Go to source code"><var>$y</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$y" class="anchor">#</a>
<code><span class="php-num">0</span></code>
</div>
</td>
</tr>
<tr data-order="humanText" id="$humanText">
<td class="attributes"><code>
protected
boolean
</code></td>
<td class="name">
<a href="source-class-emberlabs.Barcode.BarcodeBase.html#49" title="Go to source code"><var>$humanText</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$humanText" class="anchor">#</a>
<code><span class="php-keyword1">true</span></code>
</div>
</td>
</tr>
<tr data-order="jpgQuality" id="$jpgQuality">
<td class="attributes"><code>
protected
integer
</code></td>
<td class="name">
<a href="source-class-emberlabs.Barcode.BarcodeBase.html#55" title="Go to source code"><var>$jpgQuality</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$jpgQuality" class="anchor">#</a>
<code><span class="php-num">85</span></code>
</div>
</td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>