-
Notifications
You must be signed in to change notification settings - Fork 8
Extensions
- summary Extensions provides a basic method to develop and distribute integrated customisations for Simple Invoices.
|
Table of Contents <wiki:toc max_depth="2"></wiki:toc>
index.php is the main file in Simple Invoices that does all the work to say what files are to be loaded when and what to present on screen
* normally based on the url ie. index.php?module=invoices&view=manage
In the above example url index.php would load the relevant files to show the Manage Invoices page
* it would load all the normal stuff to run Simple Invoices * then the php code for this page from ./modules/invoices/manage.php would be loaded * then it would load the template for this page from ./templates/default/invoices/manage.tpl * and then present a combination of the above file to the browser
The extension system provide a way to override and/or extended what is loaded via index.php
In index.php there are checks at each main include section to see if an extension has been enabled and if it has either include the extensions version of the requested file instead of the normal file or include it inconjunction with the normal file
For an extension to be included correctly the same directory structure for the normal file must be repeated in the extensions directory (ie. ./extensions/gene/modules/invoices/itemised.php would replace the normal file ./modules/invoices/itemised.php if the Gene extension was enabled)
To explain how it works i'll use a quick example from the Gene extension
* What was required:
* A customisation of the New Itemised invoice page with additional fields to be available
* New fields meant that the function that inserts the products into the invoice items table will have to be altered
* The normal function for this is stored in ./includes/sql_queries.php
* index.php includes the extensions version of sql_queries.php, ./extensions/gene/include/sql_queries.php along with the normal ./includes/sql_queries.php
* only the new functions/classes were placed in ./extensions/gene/include/sql_queries.php all the normal functions stayed unedited in ./include/sql_queries.php
* The logic of the itemised screen has to be altered
* By including the file ./extensions/gene/module/invoices/itemised.php it overwrote the default itemised.php file (./modules/invoices/itemised.php)
* A custom view of the New Itemised invoice page was required
* By including the file ./extensions/gene/templates/default/invoices/itemised.tpl it overwrote the default itemised.tpl file (./modules/invoices/itemised.tpl)
With these new files loaded a custom version of the Itemised invoices page was displayed and developed in a way to complement Simple Invoices
In the current version 2010.x, Extensions can be enabled / disabled by Registering / Unregistering at: Settings → Extensions and clicking on the first green icon on the left of ech extension entry.
This extensions provides Simple Invoices with expense features
Note:
The main purpose of this extension is for reporting You can assign an expense to a biller, customer, invoice or product - but this is for reporting purposes only, you can't add an expense to an invoice and have that expense added to the total etc..
This extension is available in svn (as at 2009/08/08) and will be included in 2009.1 release. To enable this extension download the release with this extension then go to 'Settings' tab and select 'Settings'. In this page select 'Extensions' and then click the 'Register” link next to the Expenses extension and clic. Once registered just click the 'Enable' link next to Expenses in the list of extensions.
Once the extension has been enabled please run the below sql in your Simple Invoices database to create the required tables
To enable the extension - only run if you don't activate the extension via the GUI
This extension was developed by Justin Kelly of SixHQ for Carlos of Maximum Consult
This extension is released under the GNU GPL 3
This extension provides Purchase Order abilities in Simple Invoices to suit the requested workflow
Ability to adjust the the price and cost of a product during invoice creation/editing some funky ajax to load the cost/price into editable input box per line item based on drop down list product selection etc.. (Justin to write more stuff here)
This extension is currently work in progress
There are modifications required to the Simple Invoices database for this extension to work
They are detailed in ./extensions/gene/install/sql.php
You need to edit ./config/config.php and enable the gene extension, refer how_to_enable_an_extension for how to do this
Invoice preference with the ID of 5 (which by default is Quotes) to be edited to be the Purchase Order invoice preference
When you create a new Invoice it will default to Invoice Preference of ID = 1
When you create a new Purchase Order it will default to Invoice Preference of ID = 5
this is required so various pages display the correctly setting for POs and Invoices
Edit the products in your database to include a Unit Cost, if you don;t when you create a new PO and select a product nothing will auto populate in the unit cost box
Edit Custom Fields and set the custom field 1 for Invoices to be Shipping. This stores the shiping cost in the si_invoices table against the invoice and is used to calc the loaded unit cost (si_invoice_items.unit_load_cost)
Edit Custom Fields and set the custom field 1 for Invoices to be PO Received.
Edit Custom Fields and set the custom field 1 for Customers to be 'Customer or Vendor'.
This is only available in the nextrelease branch in svn as at 25th March 2008
This extension was developed by Justin Kelly of SixHQ for Gene from UDS
This extension is released under the GNU GPL v3
This extensions provides Simple Invoices with School Management features
This extension is currently work in progress
There will be modifications required to the Simple Invoices database for this extension to work
They are detailed in ./extensions/school/install/sql.php
You need to edit ./config/config.php and enable the school extension, refer how_to_enable_an_extension for how to do this
This extension is only available via SVN in the ./branches/nextrelease branch as at 25th March 2008
This extension was developed by Justin Kelly of SixHQ for Evgeny of Krasnodar School
This extension is released under the GNU GPL 3
This extension provides a product matrix for Simple Invoices. This means that in invoice creation you can selcet a product and then a list of attributes and values will be display that are relavent to that product for you to choose from
ie. - Product = T-Shirt - Product Attributes = Size, Colour - Product Values = Size (Small, Medium, Large), Colour (Red, White, Blue)
In the Manage Product Values screen you can add new values and assign then to certain attributes, and in edit/add products you can assign attributes to a certain product
This extension is currently work in progress
There are modifications required to the Simple Invoices database for this extension to work
They are detailed in ./extensions/product_matrix/install/matrix.sql
You can just import this .sql file into phpMyAdmin for the db changes to be applied
You need to edit ./config/config.php and enable the product matrix extension, refer how_to_enable_an_extension for how to do this
Product attributes are the group of values that a product can have ie for the product 'T-shirt' it may have product attributes of size and colour
Product values is the assigning of multiple values to a product attribute ie for the product 'T-shirt' with product attributes of size it may have product values of Small, Medium, and Large
This extension was developed by Justin Kelly of SixHQ
This extension is released under the GNU GPL v3
This extension makes it possible to use Simple Invoices on a small phone with internet browser - ie. HTC Touch - (ie. phones smaller tahn the iphone)
Stripped down UI of Simple Invoices to only include features that are absolutely necessary and also to fit on a small mobile phone screen Manage pages rewritten to work on small screen
This extension is currently work in progress
This extension has been designed to work with the product_matrix extension This extension is designed to be used with 2 installs (1 with this extension enabled and 1 without) this is so that all the setup and more specific config stuff can be done using the normal UI on a PC and the text_ui version just for the mobile version
You need to edit ./config/config.php and enable the text_ui extension, refer how_to_enable_an_extension for how to do this
This extension was developed by Justin Kelly of SixHQ
This extension is released under the GNU GPL v3
This extension provides adds a grouping into products. The main aims is to group line items in the invoice via these groupings
Note: tax rates per line item was developed for this extension - so thanks to Bernardo for funding this.
This extension is designed for Simple Invoices 2009.1
Edit ./extensions/invoice_grouped/include/init.php to list the groups you want Set Product.Custom_field1 to be grouping Copy the invoice template folder from within ./extras/invoice_group to ./templates/invoices/
You need to edit ./config/config.ini and enable the product matrix extension, refer how_to_enable_an_extension for how to do this
This extension was developed by Justin Kelly of SixHQ
This extension is released under the GNU GPL v3
This extension allows you to create new invoices, based on an existing one.
When this extension is enabled, the following happens:
In the Manage Customers, the last invoice of each customer is shown (in an extra column). In the Manage Customers page, the action 'Add invoice' is available.
When Add invoice is clicked, the new invoice (itemised style) is created as normal, but then prefilled with the contents of the template invoice. Recurring invoices are made easy, though still manual. The only items not from the template are the invoice date and the invoice number.
The invoice is added once the 'save' button is hit.
By default, the template invoice number is stored in custom userfield customer_cf4
Marcel van Dorp
Modifications are unintegrated customisations to Simple Invoices
Note: it is preferable if you create an extension rather then a modification, modification where how we used to do stuff prior to the new Simple Invoices extensions system existing
This is the place to detail any add-on or modification your made to your own version of Simple Invoices that the rest of the Simple Invoices community can benefit from
When I saw invoice numbering i have on mind, this isnt good for my. But I have solution for users with <10000 invoices maybe more. open: include/sql_queries.php and paste this code on the end:
Go to line: 1914 and comment the line, next add this:
This is all, you can format your invoice numbering. But type ID its in this case only 2, bug is reported!
I wanted to output my invoice numbers into this form: 000022, 000023, etc… I decided to do this with a Smarty plugin, so that I wouldn't have to change any of the core code, only my invoice templates.
Upload the PHP file function.invoice_number.php inside the plug-in folder: /simpleinvoices/include/smarty_plugins/ to enable the plugin for all Simple Invoices' template files (all templates inside /simpleinvoices/templates/default).
You're not ready yet. The invoice templates (/templates/invoices/) won't load the plug-in. So, you also need to upload the file function.invoice_number.php into this folder: /templates/invoices/{yourinvoicetemplate}/plugins/.
Now the plug-in is automatically loaded and usable.
You can download the zip file here. - or refer the below Code section
In most templates, the invoice number is printed with this code:
Change it to this form:
This will invoke the Smarty function that adds the 0's, so that the invoice number is exactly 0 characters long, eg: 000022.
If you want to specify the length of your invoice number (default is 6), you can easily change this. Just add the parameter length=8, or any other length, to the smarty code. For example:
This code is donated to the Simple Invoices community and is therefor part of the Simple Invoices project and freely usable (philosophy).
The original author is Gelderblom Webdesign, a Dutch webdesign company.
File: function.invoice_number.php
Add a new table, si_biller_index, that is similar in function to si_index, just with one index per operator:
Have si_biller_index updated in much the same way as for si_index (in sql_queries.php) when a new invoice is created and add a new column, invoice_number, to si_invoices where this per operator index is inserted.
Then make sure that the invoice_number is shown in the manage view of the invoices module and also that it is used in the default template for printing.
Patch for this functionality (here in combination with template_for_f60_invoice_form) can be found here.
Countrygirl - from the Simple Invoices forum developed a 'customer login app' for Simple Invoices
refer below link for the forum post
http://simpleinvoices.org/forum/discussion/1150/customer-login-area-available-for-testing
Download: client_area.zip
as listed in the setup.txt file
1. Run the following SQL commands in phpMyAdmin or insert the columns manually into the si_customers database if you want them to appear in a specific place
ALTER TABLE `si_customers` ADD `username` VARCHAR(10) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL
ALTER TABLE `si_customers` ADD `password` VARCHAR(10) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL
ALTER TABLE `si_customers` ADD `usertype` VARCHAR(5) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL
2. Add to simpleinvoices/lang/en-gb/lang.php (these values are all in alphabetical order so you may want to keep them that way)
$LANG['password'] = “Password”;1 $LANG['username'] = “Username”;1 $LANG['usertype'] = “User Type”;//1
3. Save lang.php and reupload to simpleinvoices/lang/en-gb/
4. Put values in all of the new username, password and usertype fields in the si_customers table usertype should be enterred as “user” without the quotes.
5. Open dbc.php folder and change the top two lines of code
$dbname = 'database_name'; $link = mysql_connect(“localhost”,”db_username”,”db_password”) or die(“Couldn't make connection.”);
change database_name to your database name change db_username to your database username change db_password to your database password
6. Open myaccount.php and change email@domain.com on line 138 to the email address that you accept paypal payments through, you can also change currency_code=USD to currency_code=CAD if you want your funds in Canadian funds
7. Upload the client_area to your web server, I do not have mine within the simple invoices folder, mine is separate. If you do yours the same way you should be able to get there by going to http://www.yourdomain.com/client_area
Note: In order to get the invoice view pdf symbol to work you need to go into the simpleinvoices application and export each invoice as a pdf. The pdf automatically wants to save in this format Invoice1.pdf, keep that format and save it, then upload the pdf to the invoices folder
Note: This is a very simple system and can be used temporarily until the simple invoices gang get's their customer login are up and running.
Note: My client area code is put into the template of my web site so it looks identical to the rest of my web site. You can wrap every one of these pages with your website code to make yours the same way, or you can just use it the way it is. If you do want to wrap it with your web site code I have marked in each page where to put the code with: