Changes to AgileBill

This commit is contained in:
Deon George
2009-08-03 14:10:16 +10:00
parent 0a22cfe22c
commit 27aee719b0
1051 changed files with 219109 additions and 117219 deletions

View File

@@ -1,174 +1,128 @@
<?php
/**
* AgileBill - Open Billing Software
*
* This body of work is free software; you can redistribute it and/or
* modify it under the terms of the Open AgileBill License
* License as published at http://www.agileco.com/agilebill/license1-4.txt
*
* For questions, help, comments, discussion, etc., please join the
* Agileco community forums at http://forum.agileco.com/
*
* Originally authored by Tony Landis, AgileBill LLC
*
* Recent modifications by Deon George
*
* @author Deon George <deonATleenooksDOTnet>
* @copyright 2009 Deon George
* @link http://osb.leenooks.net
*
* @link http://www.agileco.com/
* @copyright 2004-2008 Agileco, LLC.
* @license http://www.agileco.com/agilebill/license1-4.txt
* @author Tony Landis <tony@agileco.com>
* @author Tony Landis <tony@agileco.com>
* @package AgileBill
* @version 1.4.93
* @subpackage Modules:Tax
*/
class tax
{
/**
* Calculate all applicable taxes for a given product
* @return Array
*/
function calculate($taxable_amount, $country_id, $zone)
{
$arr=false;
$db = &DB();
$result = $db->Execute(sqlSelect($db,"tax","id,description,rate",
"(zone = '' OR zone IS NULL OR zone = ::*:: OR zone = ::$zone::) AND
(country_id = ::$country_id:: OR country_id = '' OR country_id IS NULL)","zone"));
if(!$result || $result->RecordCount() == 0) {
return false;
} else {
while(!$result->EOF) {
$arr[] = Array( 'rate' => round($result->fields["rate"] * $taxable_amount,2),
'name' => $result->fields["description"],
'id' => $result->fields["id"]);
/**
* The main AgileBill Tax Class
*
* @package AgileBill
* @subpackage Modules:Tax
*/
class tax extends OSB_module {
/**
* Calculate all applicable taxes for a given product
* @return Array
*/
public function calculate($taxable_amount,$country_id,$zone) {
$db = &DB();
$arr = array();
$result = $db->Execute(
sqlSelect($db,'tax','id,description,rate',
sprintf("(zone='' OR zone IS NULL OR zone=::*:: OR zone=::%s::) AND (country_id=::%s:: OR country_id='' OR country_id IS NULL)",$zone,$country_id),
'zone'));
if (! $result || ! $result->RecordCount())
return false;
else
while (! $result->EOF) {
array_push($arr,
array('rate'=>round($result->fields['rate']*$taxable_amount,2),
'name' => $result->fields['description'],
'id' => $result->fields['id']));
$result->MoveNext();
}
}
return $arr;
return count($arr) ? $arr : false;
}
/**
* Insert invoice_item_tax Records
*/
function invoice_item($invoice_id, $invoice_item_id, $account_id, $tax_arr) {
$db =& DB();
if(!is_array($tax_arr)) return false;
foreach($tax_arr as $tax) {
$sql="INSERT INTO ".AGILE_DB_PREFIX."invoice_item_tax SET id=".sqlGenID($db,"invoice_item_tax").", site_id=".DEFAULT_SITE.", date_orig=".time().", invoice_id={$invoice_id}, invoice_item_id={$invoice_item_id}, account_id={$account_id}, tax_id={$tax["id"]}, amount=".$db->qstr($tax["rate"]);
$db->Execute($sql);
}
}
/**
* Generate the HTML for tax id collection on account creation/update form
* Insert invoice_item_tax Records
*/
function get_tax_ids() {
$db=&DB();
$rs=$db->Execute($sql=sqlSelect($db,"tax","*","tax_id_collect=1 AND zone=::*::"));
if($rs && $rs->RecordCount()) {
while(!$rs->EOF) {
$arr[$rs->fields["tax_id_name"]] = $rs->fields;
public function invoice_item($invoice_id,$invoice_item_id,$account_id,$tax_arr) {
$db = &DB();
if (! is_array($tax_arr))
return false;
foreach ($tax_arr as $tax)
$db->Execute(sqlInsert($db,'invoice_item_tax',array('date_orig'=>time(),'invoice_id'=>$invoice_id,'invoice_item_id'=>$invoice_item_id,'account_id'=>$account_id,'tax_id'=>$tax['id'],'amount'=>$tax['rate'])));
}
/**
* Generate the HTML for tax id collection on account creation/update form
*/
public function get_tax_ids() {
$db = &DB();
$rs = $db->Execute(sqlSelect($db,'tax','*',array('tax_id_collect'=>1,'zone'=>'*')));
if ($rs && $rs->RecordCount()) {
while (! $rs->EOF) {
$arr[$rs->fields['tax_id_name']] = $rs->fields;
$rs->MoveNext();
}
} else {
return false;
}
foreach($arr as $val) $ret[] = $val;
$ret = array();
foreach ($arr as $val)
array_push($ret,$val);
global $smarty;
$smarty->assign('tax_ids', $ret);
$smarty->assign('tax_ids',$ret);
}
/**
* Validate inputted tax id on account addition/update
*/
function TaxIdsValidate($country_id, $tax_id, $exempt=false) {
$db=&DB();
$rs=$db->Execute(sqlSelect($db,"tax","*","country_id=$country_id AND zone=::*:: AND tax_id_collect=1 AND tax_id_req=1"));
if($rs && $rs->RecordCount()) {
function TaxIdsValidate($country_id, $tax_id, $exempt=false) {
$db = &DB();
$rs = $db->Execute(sqlSelect($db,'tax','*',array('country_id'=>$country_id,'zone'=>'*','tax_id_collect'=>1,'tax_id_req'=>1)));
if ($rs && $rs->RecordCount()) {
$this->errField = $rs->fields['tax_id_name'];
if(empty($tax_id))
if($rs->fields['tax_id_exempt'] && $exempt)
if (empty($tax_id))
if ($rs->fields['tax_id_exempt'] && $exempt)
return true;
else
return false;
if(!empty($rs->fields['tax_id_regex'])) {
$regex=$rs->fields['tax_id_regex'];
if(!ereg("$regex", trim($tax_id))) return false;
if (! empty($rs->fields['tax_id_regex'])) {
$regex = $rs->fields['tax_id_regex'];
if (! preg_match("/$regex/",trim($tax_id)))
return false;
}
}
return true;
}
function tax_construct() {
$this->module = "tax";
$this->xml_construct = PATH_MODULES . "" . $this->module . "/" . $this->module . "_construct.xml";
$C_xml = new CORE_xml;
$construct = $C_xml->xml_to_array($this->xml_construct);
$this->method = $construct["construct"]["method"];
$this->trigger = $construct["construct"]["trigger"];
$this->field = $construct["construct"]["field"];
$this->table = $construct["construct"]["table"];
$this->module = $construct["construct"]["module"];
$this->cache = $construct["construct"]["cache"];
$this->order_by = $construct["construct"]["order_by"];
$this->limit = $construct["construct"]["limit"];
}
function add($VAR) {
$this->tax_construct();
$type = "add";
$this->method["$type"] = explode(",", $this->method["$type"]);
$db = new CORE_database;
$db->add($VAR, $this, $type);
}
function view($VAR) {
$this->tax_construct();
$type = "view";
$this->method["$type"] = explode(",", $this->method["$type"]);
$db = new CORE_database;
$db->view($VAR, $this, $type);
}
function update($VAR) {
$this->tax_construct();
$type = "update";
$this->method["$type"] = explode(",", $this->method["$type"]);
$db = new CORE_database;
$db->update($VAR, $this, $type);
}
function delete($VAR) {
$this->tax_construct();
$db = new CORE_database;
$db->mass_delete($VAR, $this, "");
}
function search_form($VAR) {
$this->tax_construct();
$type = "search";
$this->method["$type"] = explode(",", $this->method["$type"]);
$db = new CORE_database;
$db->search_form($VAR, $this, $type);
}
function search($VAR) {
$this->tax_construct();
$type = "search";
$this->method["$type"] = explode(",", $this->method["$type"]);
$db = new CORE_database;
$db->search($VAR, $this, $type);
}
function search_show($VAR) {
$this->tax_construct();
$type = "search";
$this->method["$type"] = explode(",", $this->method["$type"]);
$db = new CORE_database;
$db->search_show($VAR, $this, $type);
}
}
?>
?>

View File

@@ -1,82 +1,138 @@
<?xml version="1.0" encoding="ISO-8859-1" ?>
<construct>
<!-- define the module name -->
<module>tax</module>
<!-- define the module table name -->
<table>tax</table>
<!-- define the module dependancy(s) -->
<dependancy>setup</dependancy>
<!-- define the DB cache in seconds -->
<cache>0</cache>
<!-- define the default order_by field for SQL queries -->
<order_by>zone</order_by>
<!-- define the methods -->
<limit>25</limit>
<!-- define database indexes -->
<index>
<country>country_id</country>
<zone>zone</zone>
</index>
<!-- define the fields -->
<field>
<id>
<type>I4</type>
<unique>1</unique>
<index>1</index>
</id>
<site_id>
<type>I4</type>
<index>1</index>
</site_id>
<country_id>
<type>I4</type>
<asso_table>country</asso_table>
<asso_field>name</asso_field>
<validate>any</validate>
</country_id>
<zone>
<type>C(128)</type>
<min_len>1</min_len>
<max_len>128</max_len>
</zone>
<description>
<type>C(255)</type>
<min_len>1</min_len>
<max_len>255</max_len>
<validate>any</validate>
</description>
<rate>
<type>F</type>
<min_len>2</min_len>
<max_len>6</max_len>
<validate>any</validate>
</rate>
<tax_id_collect>
<type>L</type>
</tax_id_collect>
<tax_id_name>
<type>C(32)</type>
</tax_id_name>
<tax_id_req>
<type>L</type>
</tax_id_req>
<tax_id_exempt>
<type>L</type>
</tax_id_exempt>
<tax_id_regex>
<type>C(255)</type>
</tax_id_regex>
</field>
<!-- define all the methods for this class, and the fields they have access to, if applicable. -->
<method>
<add>id,site_id,country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_exempt,tax_id_regex</add>
<update>id,site_id,country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_exempt,tax_id_regex</update>
<delete>id,site_id,country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_exempt,tax_id_regex</delete>
<view>id,site_id,country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_exempt,tax_id_regex</view>
<search>id,site_id,country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_exempt,tax_id_regex</search>
</method>
<!-- define the method triggers -->
<trigger>0</trigger>
<!-- Module name -->
<module>tax</module>
<!-- Module supporting database table -->
<table>tax</table>
<!-- Module dependancy(s) (module wont install if these modules are not yet installed) -->
<dependancy>setup</dependancy>
<!-- DB cache in seconds -->
<cache>15</cache>
<!-- Default order_by field for SQL queries -->
<order_by>zone</order_by>
<!-- Default SQL limit for SQL queries -->
<limit>25</limit>
<!-- Schema version (used to determine if the schema has change during upgrades) -->
<version>1</version>
<!-- Database indexes -->
<index>
<country>country_id</country>
<zone>zone</zone>
</index>
<!-- Database fields -->
<field>
<!-- Record ID -->
<id>
<index>1</index>
<type>I4</type>
<unique>1</unique>
</id>
<!-- Site ID -->
<site_id>
<index>1</index>
<type>I4</type>
</site_id>
<!-- Date record created -->
<date_orig>
<display>Date Created</display>
<type>I8</type>
</date_orig>
<!-- Date record updated -->
<date_last>
<convert>date-now</convert>
<display>Date Updated</display>
<type>I8</type>
</date_last>
<country_id>
<display>Country</display>
<type>I4</type>
<asso_table>country</asso_table>
<asso_field>name</asso_field>
<validate>any</validate>
</country_id>
<zone>
<display>Zone</display>
<type>C(128)</type>
<min_len>1</min_len>
<max_len>128</max_len>
</zone>
<description>
<display>Description</display>
<type>C(255)</type>
<min_len>1</min_len>
<max_len>255</max_len>
<validate>any</validate>
</description>
<rate>
<display>Tax Rate</display>
<type>F</type>
<min_len>2</min_len>
<max_len>6</max_len>
<validate>any</validate>
</rate>
<tax_id_collect>
<display>Collect Tax ID</display>
<type>L</type>
</tax_id_collect>
<tax_id_name>
<display>Tax ID Name</display>
<type>C(32)</type>
</tax_id_name>
<tax_id_req>
<display>Tax ID Required</display>
<type>L</type>
</tax_id_req>
<tax_id_exempt>
<display>Tax ID Exempt</display>
<type>L</type>
</tax_id_exempt>
<tax_id_regex>
<display>Tax ID Regexp</display>
<type>C(255)</type>
</tax_id_regex>
</field>
<!-- Methods for this class, and the fields they have access to, if applicable. -->
<method>
<add>country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_regex</add>
<update>id,site_id,country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_exempt,tax_id_regex</update>
<delete>id,site_id,country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_exempt,tax_id_regex</delete>
<view>id,site_id,country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_exempt,tax_id_regex</view>
<search>id,site_id,country_id,zone,description,rate,tax_id_collect,tax_id_name,tax_id_req,tax_id_exempt,tax_id_regex</search>
</method>
<!-- Method triggers -->
<trigger></trigger>
<!-- Template page display titles -->
<title>
<add>Add Tax Definition</add>
<search_form>Search</search_form>
<view>Tax</view>
</title>
<!-- Template helpers -->
<tpl>
<search_show>
<checkbox>
<field>id</field>
<type>checkbox</type>
<width>25px</width>
</checkbox>
<country_id>
<field>country_id</field>
</country_id>
<zone>
<field>zone</field>
</zone>
<description>
<field>description</field>
</description>
<rate>
<field>rate</field>
</rate>
</search_show>
</tpl>
</construct>

View File

@@ -1,40 +1,57 @@
<?xml version="1.0" encoding="ISO-8859-1" ?>
<install>
<!-- Tree Menu Module Properties -->
<module_properties>
<name>tax</name>
<parent>setup</parent>
<notes><![CDATA[Setup tax zones and rates for your taxable products.]]></notes>
<menu_display>1</menu_display>
<!-- MODULE Dependancy, this module wont be installed if the dependant modules dont exist -->
<dependancy>setup</dependancy>
<!-- Translated display to use on the tree -->
<display>Tax</display>
<!-- Display a module in the menu tree -->
<menu_display>1</menu_display>
<!-- MODULE Name -->
<name>tax</name>
<!-- MODULE Notes, these notes show up in the modules table, as a description of the module -->
<notes><![CDATA[Setup tax zones and rates for your taxable products.]]></notes>
<!-- MODULE Parent, the parent node in the tree -->
<parent>setup</parent>
<!-- MODULE Type (core|base), core modules cannot be deleted, unrecognised types are ignored. -->
<type></type>
</module_properties>
<sql_inserts>
<module_method>
<add>
<name>add</name>
<page><![CDATA[%%:add]]></page>
<menu_display>1</menu_display>
</add>
<update>
<name>update</name>
</update>
<delete>
<name>delete</name>
</delete>
<view>
<name>view</name>
<page><![CDATA[core:search&module=%%&_escape=1&_next_page_one=view]]></page>
<menu_display>1</menu_display>
</view>
<search>
<name>search</name>
</search>
<search_form>
<name>search_form</name>
<notes><![CDATA[Allow users to view the search form]]></notes>
</search_form>
<search_show>
<name>search_show</name>
<notes><![CDATA[Allow users to view the search results]]></notes>
</search_show>
</module_method>
</sql_inserts>
</install>
<!-- Tree Menu & Module Methods to load, they will be assigned the group permissions on install time, as selected by the user. -->
<module_method>
<add>
<display>Add</display>
<menu_display>1</menu_display>
<name>add</name>
<notes><![CDATA[Add records]]></notes>
</add>
<delete>
<name>delete</name>
<notes><![CDATA[Delete records]]></notes>
</delete>
<search>
<display>Search</display>
<menu_display>1</menu_display>
<name>search</name>
<notes><![CDATA[List records]]></notes>
<page><![CDATA[core:search&module=%%&_next_page_one=view]]></page>
</search>
<search_form>
<name>search_form</name>
<notes><![CDATA[Search for records]]></notes>
</search_form>
<search_show>
<name>search_show</name>
<notes><![CDATA[Show the results of a search]]></notes>
</search_show>
<update>
<name>update</name>
<notes><![CDATA[Update a record]]></notes>
</update>
<view>
<name>view</name>
<notes><![CDATA[View a record]]></notes>
</view>
</module_method>
</install>

View File

@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="ISO-8859-1" ?>
<install>
<tax>
<id>1</id>
<site_id>1</site_id>
<country_id>61</country_id>
<zone></zone>
<description>GST</description>
<rate>0.1</rate>
<tax_id_collect></tax_id_collect>
<tax_id_name></tax_id_name>
<tax_id_req></tax_id_req>
<tax_id_exempt></tax_id_exempt>
</tax>
<tax_id>
<id>2</id>
</tax_id>
</install>