Invoice

~softwareobjectsdescr~

Database Table: invoices
Extends: Result
Extends: AbstractDatabase

Invoice PHP Methods

add(array $fieldValues) _v5

Adds a new record.
PARAMETERS:
$fieldValues = Array of the values for each column when adding the record (Associative array with key = field name & value = field value).
RETURN VALUE:
int = id of the new record.
0 = if fails

addInvoice(string $title, string $details, float $totalprice, int $clientID, string $clientemail = "", $clientname = "", int $invoiceItems = 0, $iPOST = "") _v5

Create an invoice
PARAMETERS:
$title = string, invoice title
$details = string, invoice details
$totalprice = float, invoice total price
$clientID = int, invoice client ID (member id)
$clientemail = string, client email
$clientname = string, client name
$invoiceItems = int, number of items in the invoice
$iPOST = array, invoice items details
RETURN VALUE:
int = invoice ID

calculateTax() _v5

Calculate taxes for the loaded invoice
PARAMETERS:
NONE
RETURN VALUE:
float = tax amount

checkLoaded() _v5

Checks if record is loaded. throwing an error if the record failed to load successfully.
PARAMETERS:
NONE
RETURN VALUE:
VOID

convertHTML(string $htmlContent = "", string $prefix = "", bool $urlEncode = false) _v5

Converts ~~ variables in the $htmlContent that is provided and returns the converted content. The title of the ~~ variables are converted by the content from the column in the database with the matching title.
PARAMETERS:
$htmlContent = String, HTML content body to convert.
$prefix= String, tilde code prefix if any.
$urlEncode = Bool, true if you want to apply URL encode to the content, false otherwise
RETURN VALUE:
String = Converted HTML

delete(string $restoreQuery = "") _v5

Deletes the loaded record from the database.
PARAMETERS:
$restoreQuery = FOR INTERNAL USE. FOR TYPICAL USAGE LEAVE THIS BLANK. The restore query to pass along when deleting an object with dependencies.
RETURN VALUE:
VOID

duplicate(array $newValues = null) _v5

Creates a duplicate record in the database of the current object
PARAMETERS:
$newValues = array, associative array with field name as key and field value as array value containing the new values if any
RETURN VALUE:
int = the id of the new record.

function load(string $queryWhere) _v5

Loads values for the record matching the criteria specified by $queryWhere. If the there is more than one record returned from the query then only the first record is loaded.
PARAMETERS:
$queryWhere = String, SQL where query.
RETURN VALUE:
Bool = true, if success, false otherwise

getDatabaseName() _v5

Returns object's database table name
PARAMETERS:
NONE
RETURN VALUE:
String = Database name

getDefaultTRHTML() _v5

Returns the default html code for a tr row with all of the fields from the database in it as ~~ vars
PARAMETERS:
NONE
RETURN VALUE:
String = the default HTML code for a tr row with all of the fields from the database in it as ~~ vars

getDetailsBR() _v5

Get invoice details separated by new lines
PARAMETERS:
NONE
RETURN VALUE:
string = invoice details separated by new lines

getGoogleAnalytic() _v5

Get google analytics for the loaded invoice
PARAMETERS:
NONE
RETURN VALUE:
string = google analytics code

getID() _v5

Sets object ID
PARAMETERS:
NONE
RETURN VALUE:
int = ID

getJSON(bool $returnArr = false) _v5

Get JSON array for the loaded record.
PARAMETERS:
Bool = true if want to return JSON, false otherwise
RETURN VALUE:
Object Array or JSON encoded version of the array

getMD5() _v5

Get invoice hash
PARAMETERS:
NONE
RETURN VALUE:
string = invoice md5 hash

getProcessLink() _v5

Get invoice pay/process URL
PARAMETERS:
NONE
RETURN VALUE:
string = invoice processing URL

getShippingHTML() _v5

Gets shipping details for the loaded invoice
PARAMETERS:
NONE
RETURN VALUE:
string = shipping details for the loaded invoice

getStatus() _v5

Get the loaded invoice status (paid/unpaid etc)
PARAMETERS:
NONE
RETURN VALUE:
string = invoice status

getValue(string $fieldName = "value") _v5

Returns the value from a specific column for this record.
PARAMETERS:
$fieldName = String, field name.
RETURN VALUE:
Field value

hasField(string $fieldName) _v5

Checks if the field shown or hidden
PARAMETERS:
$fieldName= String, Field title.
RETURN VALUE:
Bool= True if the field show is true, false otherwise

hideAllFields() _v5

hides all fields(columns)
PARAMETERS:
NONE
RETURN VALUE:
VOID

hideField($fieldTitle) _v5

Hides specific field title by its column title
PARAMETERS:
$fieldTitle = String, Field title.
RETURN VALUE:
VOID

isLoaded() _v5

Checks if an object is loaded correctly (can be used to check if ID exists).
PARAMETERS:
NONE
RETURN VALUE:
Bool = True if the object loaded successfully, false otherwise

loadFirstID() _v5

Get object's first id
PARAMETERS:
NONE
RETURN VALUE:
int = First ID

loadID(int $id) _v5

Loads values for the record with the id specified.
PARAMETERS:
$id = int, record ID.
RETURN VALUE:
Bool = true, if success, false otherwise

loadInvoice(int $invoiceID) _v5

Loads an invoice using the invoice ID
PARAMETERS:
$invoiceID = int, invoice id
RETURN VALUE:
VOID

loadValuesAdd() _v5

Loads total number of invoice items under an invoice
PARAMETERS:
NONE
RETURN VALUE:
VOID

payInvoice(\WMT\Container $container, int $paymentID = 0) _v5

Mark the loaded invoice as paid
PARAMETERS:
$container = object
$paymentID = int, payment ID
RETURN VALUE:
VOID

save(array $fieldValues) _v5

Saves the record with the new values specified in the $fieldValuesarray.
PARAMETERS:
$fieldValues = Array of the values for each column when adding the record (Associative array with key = field name & value = field value).
RETURN VALUE:
Bool = True on success, False otherwise.

setMyMemberID(int $memberID) _v5

Sets member's ID
PARAMETERS:
$memberID = int, member id
RETURN VALUE:
VOID

setRestoreID(int $id) _v5

Sets restor point ID
PARAMETERS:
$id = int, restore ID
RETURN VALUE:
VOID

settingHTTPS(bool $useHTTPS = true) _v5

Sets site to use https or http
PARAMETERS:
$useHTTPS = True if https on, false otherwise (default true).
RETURN VALUE:
VOID

settingSiteURL(string $siteURL) _v5

Sets Site Domain
PARAMETERS:
$siteURL = String, site URL
RETURN VALUE:
VOID

showAllFields() _v5

Show all fields(columns)
PARAMETERS:
NONE
RETURN VALUE:
VOID

showField($fieldTitle) _v5

Shows specific field title by its column title
PARAMETERS:
$fieldTitle = String, Field title.
RETURN VALUE:
VOID

Invoice PHP Variables

🔎︎ %l4610%

Columns in the invoices Database Table:

id details title clientemail totalprice added clientname paid clientid tax shiptracking status shipping

Code Example

Use the code below to view a record in an html page:

<?php
// ###PUT YOUR CONTENT BELOW###
 $id = 1;  // The ID of the record being retrieved

// The HTML Code that we will convert the ~~ values inside of it
 $content = "<table>"; 
 $content .= "<tr><td>id<td>1653</tr>";
 $content .= "<tr><td>details<td>~details~</tr>";
 $content .= "<tr><td>title<td>~title~</tr>";
 $content .= "<tr><td>clientemail<td>~clientemail~</tr>";
 $content .= "<tr><td>totalprice<td>~totalprice~</tr>";
 $content .= "<tr><td>added<td>~added~</tr>";
 $content .= "<tr><td>clientname<td>~clientname~</tr>";
 $content .= "<tr><td>paid<td>~paid~</tr>";
 $content .= "<tr><td>clientid<td>~clientid~</tr>";
 $content .= "<tr><td>tax<td>~tax~</tr>";
 $content .= "<tr><td>shiptracking<td>~shiptracking~</tr>";
 $content .= "<tr><td>status<td>~status~</tr>";
 $content .= "<tr><td>shipping<td>~shipping~</tr>";
 $content .= "</table>";

// ###PUT YOUR CONTENT ABOVE###


 include("admin/load/nosession.php");

 $invoice = new Invoice();  //Create object
 $invoice->loadID($id);
 $converted = $invoice->convertHTML($content);  //Convert ~~ Codes

 echo $converted;  // Display results

Use the code below to add a record:

// ###PUT YOUR CONTENT BELOW###
 $id = 1;  // The ID of the record being retrieved

// The values to use for creating a new record
 $valueArray = array();
 $valueArray["id"] = "0";
 $valueArray["details"] = "TEXT NOT NULL";
 $valueArray["title"] = "VARCHAR(255) NOT NULL";
 $valueArray["clientemail"] = "VARCHAR(255) NOT NULL";
 $valueArray["totalprice"] = "DECIMAL(8,2) NOT NULL";
 $valueArray["added"] = "INT UNSIGNED NOT NULL";
 $valueArray["clientname"] = "VARCHAR(255) NOT NULL";
 $valueArray["paid"] = "BIT(1) NOT NULL DEFAULT 0";
 $valueArray["clientid"] = "INT UNSIGNED NOT NULL DEFAULT 0";
 $valueArray["tax"] = "DECIMAL(8,2) NOT NULL DEFAULT 0";
 $valueArray["shiptracking"] = "VARCHAR(100) NOT NULL";
 $valueArray["status"] = "TINYINT UNSIGNED NOT NULL DEFAULT 0";
 $valueArray["shipping"] = "DECIMAL(8,2) NOT NULL DEFAULT 0";

// ###PUT YOUR CONTENT ABOVE###


 include("admin/load/nosession.php");

 $invoice = new Invoice();  //Create object
 $invoice->add($valueArray);  // Add the record

 echo $invoice->getID();  // Echo the id of the newly created record

Use the code below to delete a record:

// ###PUT YOUR CONTENT BELOW###
 $id = 1;  // The ID of the record being deleted
// ###PUT YOUR CONTENT ABOVE###


 include("admin/load/nosession.php");

// Create object
 $invoice = new Invoice();
 $invoice->loadID($id);
 
// Delete and echo if success or failure
 if ($invoice->deletThis()) echo "Success";
 else echo "Failure";

Home | Partnership | Testimonials

Privacy/Terms | About Us | Contact Us

Invoice

Invoice PHP Methods

add(array $fieldValues) v5

addInvoice(string $title, string $details, float $totalprice, int $clientID, string $clientemail = "", $clientname = "", int $invoiceItems = 0, $iPOST = "") v5

calculateTax() v5

checkLoaded() v5

convertHTML(string $htmlContent = "", string $prefix = "", bool $urlEncode = false) v5

delete(string $restoreQuery = "") v5

duplicate(array $newValues = null) v5

function load(string $queryWhere) v5

getDatabaseName() v5

getDefaultTRHTML() v5

getDetailsBR() v5

getGoogleAnalytic() v5

getID() v5

getJSON(bool $returnArr = false) v5

getMD5() v5

getProcessLink() v5

getShippingHTML() v5

getStatus() v5

getValue(string $fieldName = "value") v5

hasField(string $fieldName) v5

hideAllFields() v5

hideField($fieldTitle) v5

isLoaded() v5

loadFirstID() v5

loadID(int $id) v5

loadInvoice(int $invoiceID) v5

loadValuesAdd() v5

payInvoice(\WMT\Container $container, int $paymentID = 0) v5

save(array $fieldValues) v5

setMyMemberID(int $memberID) v5

setRestoreID(int $id) v5

settingHTTPS(bool $useHTTPS = true) v5

settingSiteURL(string $siteURL) v5

showAllFields() v5

showField($fieldTitle) v5