Provides basic functions like adding elements to the database
- - - -getClients(\PDO $pdo) : array<mixed,\client>
- Get all clients
- - -| \PDO | -$pdo | -The PDO class for database connection |
-
If something went wrong with the database
An array indexed by id of instances of the client class
- -getContactIds(\PDO $pdo) : array<mixed,integer>
- Get all contact ids
- - -| \PDO | -$pdo | -The PDO class for database connection |
-
Is something went wrong with the database
The ids
- -getContacts(\PDO $pdo) : array<mixed,\contact>
- Get all contacts
- - -| \PDO | -$pdo | -The PDO class for database connection |
-
If something went wrong with the database
An array indexed by id of instances of the contact class
- -getOfferIds(\PDO $pdo, array<mixed,string> $where = array()) : array<mixed,integer>-
Get all offer ids
- - -| \PDO | -$pdo | -The PDO class for database connection |
-
| array<mixed,string> | -$where | -An array of WHERE clauses that will be AND-ed |
-
Is something went wrong with the database
The ids
- -getOffers(\PDO $pdo, array<mixed,string> $where = array()) : array<mixed,\offer>-
Get all offers
- - -| \PDO | -$pdo | -The PDO class for database connection |
-
| array<mixed,string> | -$where | -An array of WHERE clauses that will be AND-ed |
-
If something went wrong with the database
An array indexed by id of instances of the offer class
- -getAssignmentIds(\PDO $pdo) : array<mixed,integer>
- Get all assignment ids
- - -| \PDO | -$pdo | -The PDO class for database connection |
-
Is something went wrong with the database
The ids
- -getAssignments(\PDO $pdo) : array<mixed,\assignment>
- Get all assignments
- - -| \PDO | -$pdo | -The PDO class for database connection |
-
If something went wrong with the database
An array indexed by id of instances of the assignment class
- -createClient(\PDO $pdo, string $name) : \client|boolean-
Create a new client
- - -| \PDO | -$pdo | -The database connection |
-
| string | -$name | -The name for the new client |
-
If something went wrong with the database
A new instance of the client object, or false on failure
- -createFile(\PDO $pdo, string $filename) : \file-
Create a new file
- - -| \PDO | -$pdo | -The database connection |
-
| string | -$filename | -The desired filename |
-
If something went wrong with the database
If the file could not be created (due to permissions, file existed already, etc.), or the database record couldn't be added
A new instance of the file object
- -formatDate(integer $timestamp, boolean $with_time = true, boolean $full_date = false, boolean $relatively = false) : string-
Format a date nicely
- - -| integer | -$timestamp | -The UNIX timestamp to format |
-
| boolean | -$with_time | -If false, only the date is returned; if false, also the time |
-
| boolean | -$full_date | -If true, a year will be outputted even if the date is in the current year |
-
| boolean | -$relatively | -Whether or not to show the date relatively (e.g. '1 day ago') (NOT IMPLEMENTED YET) |
-
The formatted date
- -An interface to the assignment table in the database
- - - -__construct(\PDO $pdo, integer $id)-
Create a new instance
- - -| \PDO | -$pdo | -The PDO class, to access the database |
-
| integer | -$id | -The id of the assignment to fetch |
-
If something went wrong with the database
If the assignment could not be found
getOffer() : \offer-
Get the offer that this assignment is linked to
- - - - -The offer
- -setTitle(string $title) : boolean
- Set the title of the assignment
- - -| string | -$title | -The new title for the assignment |
-
If something went wrong with the database
True on succes, false on failure
- -setDescription(string $description) : boolean
- Set the description of the assignment
- - -| string | -$description | -The new description for the assignment |
-
If something went wrong with the database
True on succes, false on failure
- -setHours(integer $hours) : boolean
- Set the amount of hours of the assignment
- - -| integer | -$hours | -The new amount hours for the assignment |
-
If something went wrong with the database
True on succes, false on failure
- -setPricePerHour(float $price_per_hour) : boolean
- Set the price per hour of the assignment
- - -| float | -$price_per_hour | -The new price per hour for the assignment |
-
If something went wrong with the database
True on succes, false on failure
- -setVAT(float $vat) : boolean
- Set the VAT percentage of the assignment
- - -| float | -$vat | -The new VAT percentage for the assignment |
-
If something went wrong with the database
True on succes, false on failure
- -calculate(integer $what = self::TOTAL, integer $round = 2, boolean $format = true) : float|boolean-
Calculate useful numbers about the assignment
-Subtotal: price_per_hour * hours
-VAT: subtotal * VAT_percentage
-Total: subtotal + VAT
- -| integer | -$what | -Any of assignment::SUBTOTAL, assignment::VAT, assignment::TOTAL |
-
| integer | -$round | -How many decimals to round on |
-
| boolean | -$format | -Whether to format the number nicely (for output) or not (for calculations) |
-
If something went wrong with the database
The calculated value rounded on $round decimals, or false when the input is incorrect
- -delete() : boolean-
Remove this assignment from the database
-If this doesn't succeed (i.e. false is returned), that means the assignment was removed manually or by another instance of this class
- - -If something went wrong with the database
True on success, false on failure
- -An interface to the client table in the database
- - - -__construct(\PDO $pdo, integer $id)-
Create a new instance
- - -| \PDO | -$pdo | -The PDO class, to access the database |
-
| integer | -$id | -The id of the client to fetch |
-
If something went wrong with the database
If the client could not be found
getContacts() : array<mixed,\contact>-
Get all contacts for this client
- - - -If something went wrong with the database
An array indexed by id of instances of the contact class
- -delete() : boolean-
Remove this client from the database
-If this doesn't succeed (i.e. false is returned), that means the client was removed manually or by another instance of this class
- - -If something went wrong with the database
True on success, false on failure
- -createContact(string $name, string $email, string $address, string $address_2, string $postal_code, string $city, string $country) : \contact-
Make a new contact for this client
- - -| string | -$name | -The name for this contact |
-
| string | -The email for this contact |
- |
| string | -$address | -The first address line of this contact (normally street and house number) |
-
| string | -$address_2 | -The second address line of this contact |
-
| string | -$postal_code | -The postal code for this contact |
-
| string | -$city | -The city for this contact |
-
| string | -$country | -The country for this contact |
-
If something went wrong with the database
If there was a problem with the input
A new instance of the contact class containing the new contact
- -A class for some constants
- - - -An interface to the contact table in the database
- - - -__construct(\PDO $pdo, integer $id)-
Create a new instance
- - -| \PDO | -$pdo | -The PDO class, to access the database |
-
| integer | -$id | -The id of the contact to fetch |
-
If something went wrong with the database
If the contact could not be found
getClient() : \client-
Get the client that this contact is linked to
- - - - -The client
- -setEmail(string $email) : boolean
- Set the email of the contact
- - -| string | -The new email for the contact |
-
If something went wrong with the database
True on succes, false on failure
- -setAddress(string $address) : boolean
- Set the first address line of the contact
- - -| string | -$address | -The new address for the contact |
-
If something went wrong with the database
True on succes, false on failure
- -setAddress_2(string $address_2) : boolean
- Set the second address line of the contact
- - -| string | -$address_2 | -The new address for the contact |
-
If something went wrong with the database
True on succes, false on failure
- -setPostalCode( $postal_code) : boolean
- Set the postal code of the contact
- - -| - | $postal_code | -string The new postal code for the contact |
-
If something went wrong with the database
True on succes, false on failure
- -setCountry(string $country) : boolean
- Set the country of the contact
- - -| string | -$country | -The new country for the contact |
-
If something went wrong with the database
True on succes, false on failure
- -setLanguage(string $language) : boolean
- Set the language of the contact
- - -| string | -$language | -The new language for the contact |
-
If something went wrong with the database
True on succes, false on failure
- -delete() : boolean-
Remove this contact from the database
-If this doesn't succeed (i.e. false is returned), that means the contact was removed manually or by another instance of this class
- - -If something went wrong with the database
True on success, false on failure
- -createOffer() : \offer-
Make a new offer for this contact
- - - -If something went wrong with the database
If there was a problem with the input
A new instance of the offer class containing the new offer
- -An extension of FPDF to generate personalized correspondence PDFs
- - - -__construct(string $orientation = 'P', string $unit = 'mm', string $size = 'A4')-
Create a new PDF
- - -| string | -$orientation | -See the FPDF class specs |
-
| string | -$unit | -See the FPDF class specs |
-
| string | -$size | -See the FPDF class specs |
-
SetContact(\contact $contact)
- Set the contact to whom this correspondence will be sent (used for the address)
- - -| \contact | -$contact | -The contact |
-
An interface to the file table in the database
- - - -__construct(\PDO $pdo, integer $id)-
Create a new instance
- - -| \PDO | -$pdo | -The PDO class, to access the database |
-
| integer | -$id | -The id of the file to fetch |
-
If something went wrong with the database
If the file could not be found
delete() : boolean-
Move this file to the trash and delete all records for it
-Physically, this moves the file to a trash folder -Then, the file will be removed from the file table in the database -Any appendices linking to this file with fileId will have fileId NULL -Any offers linking to this file with invoice_fileId will have invoice_fileId NULL
- - -If there's something wrong with the database
True on success, false on failure
- -An interface to the offer table in the database
- - - -__construct(\PDO $pdo, integer $id)-
Create a new instance
-Blah
- -| \PDO | -$pdo | -The PDO class, to access the database |
-
| integer | -$id | -The id of the offer to fetch |
-
If something went wrong with the database
If the offer could not be found
getContact() : \contact-
Get the contact that this offer is linked to
- - - - -The contact
- -getAssignments() : array<mixed,\assignment>-
Get all assignments for this offer
- - - -If something went wrong with the database
An array indexed by id of instances of the assignment class
- -setStartDate(integer $start_date) : boolean
- Set the start date of the assignment
- - -| integer | -$start_date | -The new start date for the assignment as a UNIX timestamp |
-
If something went wrong with the database
True on succes, false on failure
- -setEndDate(integer $end_date) : boolean
- Set the end date of the assignment
- - -| integer | -$end_date | -The new end date for the assignment as a UNIX timestamp |
-
If something went wrong with the database
True on succes, false on failure
- -setInvoiceDate(integer $invoice_date) : boolean
- Set the invoice date of the assignment
- - -| integer | -$invoice_date | -The new invoice date for the assignment as a UNIX timestamp |
-
If something went wrong with the database
True on succes, false on failure
- -setPaymentReceived(integer $payment_received) : boolean
- Set the payment received date of the assignment
- - -| integer | -$payment_received | -The new date the payment has been received as a UNIX timestamp |
-
If something went wrong with the database
True on succes, false on failure
- -getInvoiceFile() : \file|null-
Get the file that the invoice this offer is linked to
- - - - -The file, or null if it doesn't exist
- -setInvoiceFileId(integer $invoice_fileId) : boolean
- Set the invoice file id of the assignment
- - -| integer | -$invoice_fileId | -The new invoice file id for the assignment |
-
If something went wrong with the database
True on succes, false on failure
- -calculate(integer $what = self::TOTAL, integer $round = 2, boolean $format = true) : float|boolean-
Calculate a handy number about the invoice
-Subtotal: the sum of the prices of the assignments excl. VAT
-VAT: the sum of all the VAT from all the assignments
-Total: the sum of subtotal and total
- -| integer | -$what | -Any of offer::SUBTOTAL, offer::VAT and offer::TOTAL |
-
| integer | -$round | -How many decimals to round the result on |
-
| boolean | -$format | -Whether to format the number nicely (for output) or not (for calculations) |
-
If something went wrong with the database
The calculated value rounded to $round decimals, or false on incorrect input
- -delete() : boolean-
Remove this offer from the database
-If this doesn't succeed (i.e. false is returned), that means the offer was removed manually or by another instance of this class
- - -If something went wrong with the database
True on success, false on failure
- -createAssignment(string $title, string $description, integer $hours, float $price_per_hour, float $vat) : \assignment-
Make a new assignment linked to this order
- - -| string | -$title | -The title for this assignment |
-
| string | -$description | -The description for this assignment |
-
| integer | -$hours | -The amount of hours to work on this assignment |
-
| float | -$price_per_hour | -The price per hour on this assignment |
-
| float | -$vat | -The VAT percentage (so, 21 for 21%, not 0.21!) |
-
If something went wrong with the database
If there was a problem with the input
A new instance of the assignment class containing the new assignment
- -generateInvoice() : \file-
Generate a PDF invoice
- - - -If something went wrong with the database
If the file could not be written or an other error occured
An instance of the file class with information on the invoice file generated
- -Provides a standard to base all responses to be called with AJAX on
- - - -http_response_code(integer $code = null) : integer|boolean
- Get or set the HTTP response code
-If a parameter is provided, it is used as the new HTTP response code, and a bool is returned for success or failure. Otherwise, the current one is returned.
- -| integer | -$code | -The new code |
-
True on successful change, false on unsuccesful change, int when the current code is returned
- -