Skip to content

Commit

Permalink
[+FEATURE] updated phpDox
Browse files Browse the repository at this point in the history
  • Loading branch information
@sprankhub
sprankhub committed Jan 27, 2014
1 parent 0661582 commit 2e74ff7
Show file tree
Hide file tree
Showing 105 changed files with 7,320 additions and 276 deletions.
204 changes: 204 additions & 0 deletions docs/api/html/classes.xhtml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Overview</title>
<link rel="stylesheet" type="text/css" href="css/style.css" media="screen"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="reports.xhtml">Reports</a>
</li>
</ul>
</nav>
<div id="mainstage">
<h1>Classes</h1>
<div class="container">
<h2 id="">\</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/FireGento_Pdf_Helper_Data.xhtml">FireGento_Pdf_Helper_Data</a>
</td>
<td>Dummy data helper for translation issues.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Creditmemo.xhtml">FireGento_Pdf_Model_Creditmemo</a>
</td>
<td>Creditmemo model rewrite.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Engine_Abstract.xhtml">FireGento_Pdf_Model_Engine_Abstract</a>
</td>
<td>Abstract pdf model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Engine_Creditmemo_Default.xhtml">FireGento_Pdf_Model_Engine_Creditmemo_Default</a>
</td>
<td>Creditmemo model rewrite.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Engine_Invoice_Default.xhtml">FireGento_Pdf_Model_Engine_Invoice_Default</a>
</td>
<td>Default invoice rendering engine.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Engine_Shipment_Default.xhtml">FireGento_Pdf_Model_Engine_Shipment_Default</a>
</td>
<td>Shipment model rewrite.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Invoice.xhtml">FireGento_Pdf_Model_Invoice</a>
</td>
<td>Invoice model rewrite.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Items_Bundle.xhtml">FireGento_Pdf_Model_Items_Bundle</a>
</td>
<td>Bundle item model rewrite.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Items_Default.xhtml">FireGento_Pdf_Model_Items_Default</a>
</td>
<td>Default item model rewrite.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Items_Grouped.xhtml">FireGento_Pdf_Model_Items_Grouped</a>
</td>
<td>Default item model rewrite.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Items_Shipment_Bundle.xhtml">FireGento_Pdf_Model_Items_Shipment_Bundle</a>
</td>
<td>Shipment bundle item model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Items_Shipment_Default.xhtml">FireGento_Pdf_Model_Items_Shipment_Default</a>
</td>
<td>Shipment default item model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Observer.xhtml">FireGento_Pdf_Model_Observer</a>
</td>
<td>FireGento Pdf observer.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Shipment.xhtml">FireGento_Pdf_Model_Shipment</a>
</td>
<td>Shipment model rewrite.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_System_Config_Source_Creditmemo_Engine.xhtml">FireGento_Pdf_Model_System_Config_Source_Creditmemo_Engine</a>
</td>
<td>Pdf creation engine source model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_System_Config_Source_Invoice_Engine.xhtml">FireGento_Pdf_Model_System_Config_Source_Invoice_Engine</a>
</td>
<td>Pdf creation engine source model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_System_Config_Source_Logo.xhtml">FireGento_Pdf_Model_System_Config_Source_Logo</a>
</td>
<td>Logo position source model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_System_Config_Source_Payment.xhtml">FireGento_Pdf_Model_System_Config_Source_Payment</a>
</td>
<td>Payment method position source model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_System_Config_Source_Shipment_Engine.xhtml">FireGento_Pdf_Model_System_Config_Source_Shipment_Engine</a>
</td>
<td>Pdf creation engine source model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_System_Config_Source_Shipping.xhtml">FireGento_Pdf_Model_System_Config_Source_Shipping</a>
</td>
<td>Shipping method position source model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Model_Tax_Sales_Pdf_Grandtotal.xhtml">FireGento_Pdf_Model_Tax_Sales_Pdf_Grandtotal</a>
</td>
<td>Shipment bundle item model.</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/FireGento_Pdf_Sales_OrderController.xhtml">FireGento_Pdf_Sales_OrderController</a>
</td>
<td>Sales orders controller</td>
<td>[Build-State]</td>
</tr>
<tr>
<td>
<a href="classes/Firegento_Pdf_Block_Adminhtml_ColumnOrder.xhtml">Firegento_Pdf_Block_Adminhtml_ColumnOrder</a>
</td>
<td>Firegento</td>
<td>[Build-State]</td>
</tr>
</tbody>
</table>
</div>
</div>
<footer>
<span/>
</footer>
</body>
</html>
1 change: 0 additions & 1 deletion docs/api/html/classes/FireGento_Pdf_Helper_Data.xhtml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@
<a title="FireGento_Pdf_Helper_Data" href="../classes/FireGento_Pdf_Helper_Data/showCustomerNumber.xhtml">showCustomerNumber()</a>
</li>
</ul>
<h3>Inherited from <a title="" href="../classes/.xhtml"/></h3>
</div>
</section>
</div>
Expand Down
92 changes: 92 additions & 0 deletions docs/api/html/classes/FireGento_Pdf_Helper_Data/getScaledImageSize.xhtml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Test Method</title>
<link rel="stylesheet" type="text/css" href="../../css/style.css" media="screen"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../../reports.xhtml">Reports</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../../classes.xhtml">Classes</a>
</li>
<li class="separator">
<a href="../../classes.xhtml#"/>
</li>
<li class="separator">
<a title="FireGento_Pdf_Helper_Data" href="../../classes/FireGento_Pdf_Helper_Data.xhtml">FireGento_Pdf_Helper_Data</a>
</li>
<li class="separator">getScaledImageSize</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
</ul>
</nav>
<section>
<h1><small>FireGento_Pdf_Helper_Data::</small>getScaledImageSize</h1>
<h4>Return scaled image sizes based on an path to an image file.</h4>
<p/>
<ul/>
<h2>Signature</h2>
<div class="styled synopsis">
<code>public function getScaledImageSize(string
$image,
int
$maxWidth,
int
$maxHeight )
</code>
</div>
<h2>Parameters</h2>
<dl class="styled">
<dt>
<code>$image</code>
</dt>
<dd>Url to image file.</dd>
<dt>
<code>$maxWidth</code>
</dt>
<dd>max width the image can have</dd>
<dt>
<code>$maxHeight</code>
</dt>
<dd>max height the image can have</dd>
</dl>
<h2>Returns</h2>
<dl class="styled">
<dt>array</dt>
<dd>with 2 elements - width and height.</dd>
</dl>
</section>
</div>
<footer>
<span/>
</footer>
</body>
</html>
81 changes: 81 additions & 0 deletions docs/api/html/classes/FireGento_Pdf_Helper_Data/isLogoFullWidth.xhtml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Test Method</title>
<link rel="stylesheet" type="text/css" href="../../css/style.css" media="screen"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../../reports.xhtml">Reports</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../../classes.xhtml">Classes</a>
</li>
<li class="separator">
<a href="../../classes.xhtml#"/>
</li>
<li class="separator">
<a title="FireGento_Pdf_Helper_Data" href="../../classes/FireGento_Pdf_Helper_Data.xhtml">FireGento_Pdf_Helper_Data</a>
</li>
<li class="separator">isLogoFullWidth</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
</ul>
</nav>
<section>
<h1><small>FireGento_Pdf_Helper_Data::</small>isLogoFullWidth</h1>
<h4/>
<p/>
<ul/>
<h2>Signature</h2>
<div class="styled synopsis">
<code>public function isLogoFullWidth(mixed
$store )
</code>
</div>
<h2>Parameters</h2>
<dl class="styled">
<dt>
<code>$store</code>
</dt>
<dd/>
</dl>
<h2>Returns</h2>
<dl class="styled">
<dt>bool</dt>
<dd><br/>
</dd>
</dl>
</section>
</div>
<footer>
<span/>
</footer>
</body>
</html>
Loading

0 comments on commit 2e74ff7

Please sign in to comment.