aboutsummaryrefslogtreecommitdiff
path: root/classes
diff options
context:
space:
mode:
Diffstat (limited to 'classes')
-rw-r--r--classes/BusinessAdmin.class.php42
-rw-r--r--classes/constants.class.php2
-rw-r--r--classes/discount.class.php285
-rw-r--r--classes/offer.class.php91
4 files changed, 412 insertions, 8 deletions
diff --git a/classes/BusinessAdmin.class.php b/classes/BusinessAdmin.class.php
index d90e341..23e9c74 100644
--- a/classes/BusinessAdmin.class.php
+++ b/classes/BusinessAdmin.class.php
@@ -193,6 +193,48 @@ class BusinessAdmin {
return $assignments;
}
+ /**
+ * Get all discount ids
+ *
+ * @see BusinessAdmin::getDiscounts() This funtion returns instances of the discount class instead of just the ids
+ *
+ * @param PDO $pdo The PDO class for database connection
+ * @param string[] $where An array of WHERE clauses that will be AND-ed
+ *
+ * @throws PDOException Is something went wrong with the database
+ *
+ * @return int[] The ids
+ */
+ public static function getDiscountIds($pdo, $where = array()) {
+ $ids = array();
+ $discounts = $pdo->query("SELECT `id` FROM `".constants::db_prefix."discount`" . ((count($where) > 0) ? (" WHERE (" . implode(') AND (', $where) . ")") : ""))->fetchAll(PDO::FETCH_ASSOC);
+ foreach ($discounts as $discount) {
+ $ids[] = $discount['id'];
+ }
+ return $ids;
+ }
+
+ /**
+ * Get all discounts
+ *
+ * @see BusinessAdmin::getDiscountIds() This function returns just the ids of the discounts, and not instances of the discount class
+ *
+ * @param PDO $pdo The PDO class for database connection
+ * @param string[] $where An array of WHERE clauses that will be AND-ed
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return discount[] An array indexed by id of instances of the discount class
+ */
+ public static function getDiscounts($pdo, $where = array()) {
+ $ids = self::getDiscountIds($pdo, $where);
+ $discounts = array();
+ foreach ($ids as $id) {
+ $discounts[$id] = new discount($pdo, $id);
+ }
+ return $discounts;
+ }
+
//------------------------------------------------------------------------------
// Other functions
//------------------------------------------------------------------------------
diff --git a/classes/constants.class.php b/classes/constants.class.php
index ad63521..09b9f98 100644
--- a/classes/constants.class.php
+++ b/classes/constants.class.php
@@ -70,5 +70,5 @@ class constants {
const fa_valuta = 'eur';
/** @const version Version of BusinessAdmin. Don't change this yourself! */
- const version = '0.2.2';
+ const version = '0.3';
}
diff --git a/classes/discount.class.php b/classes/discount.class.php
new file mode 100644
index 0000000..71aa370
--- /dev/null
+++ b/classes/discount.class.php
@@ -0,0 +1,285 @@
+<?php
+/**
+ * Provides the discount class, an interface to the discount table in the database
+ *
+ * @author Camil Staps
+ *
+ * BusinessAdmin: administrative software for small companies
+ * Copyright (C) 2015 Camil Staps (ViviSoft)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * An interface to the discount table in the database
+ */
+class discount {
+ /**
+ * @var pdo $pdo The PDO class for database communication
+ * @var int $id The id of the discount
+ * @var int $offerId The id of the offer this discount is linked to
+ * @var string $title The title of the discount
+ * @var string $description The description of the discount
+ * @var float $value The actual discount
+ * @var float $vat The percentage of VAT to calculate on this discount
+ */
+ protected $pdo, $offerId, $id, $title, $description, $value, $vat;
+
+ const SUBTOTAL = 1;
+ const VAT = 2;
+ const TOTAL = 3;
+
+ /**
+ * Create a new instance
+ *
+ * @param PDO $pdo The PDO class, to access the database
+ * @param int $id The id of the discount to fetch
+ *
+ * @throws PDOException If something went wrong with the database
+ * @throws Exception If the discount could not be found
+ */
+ public function __construct($pdo, $id) {
+ $this->pdo = $pdo;
+
+ $stmt = $this->pdo->prepare("SELECT * FROM `".constants::db_prefix."discount` WHERE `id`=?");
+ $stmt->execute(array($id));
+ if ($stmt->rowCount() == 0) {
+ throw new Exception("The discount with id '$id' could not be found.");
+ }
+ $discount = $stmt->fetch(PDO::FETCH_ASSOC);
+
+ $this->id = $discount['id'];
+ $this->offerId = $discount['offerId'];
+ $this->title = $discount['title'];
+ $this->description = $discount['description'];
+ $this->value = $discount['value'];
+ $this->vat = $discount['VAT_percentage'];
+ }
+
+ //------------------------------------------------------------------------------
+ // Getters and setters
+ //------------------------------------------------------------------------------
+
+ /**
+ * Get the ID of the discount
+ *
+ * @return int The ID
+ */
+ public function getId() {
+ return $this->id;
+ }
+
+ /**
+ * Get the ID of the offer that this discount is linked to
+ *
+ * @return int The ID
+ */
+ public function getOfferId() {
+ return $this->offerId;
+ }
+
+ /**
+ * Get the offer that this discount is linked to
+ *
+ * @return offer The offer
+ */
+ public function getOffer() {
+ return new offer($this->pdo, $this->offerId);
+ }
+
+ /**
+ * Get the title of the discount
+ *
+ * @return string The title
+ */
+ public function getTitle() {
+ return $this->title;
+ }
+
+ /**
+ * Set the title of the discount
+ *
+ * @param string $title The new title for the discount
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return bool True on succes, false on failure
+ */
+ public function setTitle($title) {
+ $stmt = $this->pdo->prepare("UPDATE `".constants::db_prefix."discount` SET `title`=? WHERE `id`=?");
+ $stmt->execute(array($title, $this->id));
+ if ($stmt->rowCount() == 1) {
+ $this->title = $title;
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Get the description of the discount
+ *
+ * @param bool $parseMarkdown Whether or not to parse markdown
+ *
+ * @return string The description
+ */
+ public function getDescription($parseMarkdown = true) {
+ if ($parseMarkdown) {
+ $pd = new Parsedown;
+ return $pd->text($this->description);
+ } else {
+ return $this->description;
+ }
+ }
+
+ /**
+ * Set the description of the discount
+ *
+ * @param string $description The new description for the discount
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return bool True on succes, false on failure
+ */
+ public function setDescription($description) {
+ $stmt = $this->pdo->prepare("UPDATE `".constants::db_prefix."discount` SET `description`=? WHERE `id`=?");
+ $stmt->execute(array($description, $this->id));
+ if ($stmt->rowCount() == 1) {
+ $this->description = $description;
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Get the value of the discount
+ *
+ * @return float The value
+ */
+ public function getValue() {
+ return $this->value;
+ }
+
+ /**
+ * Set the value of the discount
+ *
+ * @param float $value The new value for the discount
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return bool True on succes, false on failure
+ */
+ public function setValue($value) {
+ $stmt = $this->pdo->prepare("UPDATE `".constants::db_prefix."discount` SET `value`=? WHERE `id`=?");
+ $stmt->execute(array($value, $this->id));
+ if ($stmt->rowCount() == 1) {
+ $this->value = $value;
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Get the VAT percentage of the discount
+ *
+ * @return float The VAT percentage
+ */
+ public function getVAT() {
+ return $this->vat;
+ }
+
+ /**
+ * Set the VAT percentage of the discount
+ *
+ * @param float $vat The new VAT percentage for the discount
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return bool True on succes, false on failure
+ */
+ public function setVAT($vat) {
+ $stmt = $this->pdo->prepare("UPDATE `".constants::db_prefix."discount` SET `VAT_percentage`=? WHERE `id`=?");
+ $stmt->execute(array($vat, $this->id));
+ if ($stmt->rowCount() == 1) {
+ $this->vat = $vat;
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ //------------------------------------------------------------------------------
+ // Other functions
+ //------------------------------------------------------------------------------
+
+ /**
+ * Calculate useful numbers about the discount
+ *
+ * Subtotal: value
+ *
+ * VAT: subtotal \* VAT_percentage
+ *
+ * Total: subtotal + VAT
+ *
+ * @param int $what Any of discount::SUBTOTAL, discount::VAT, discount::TOTAL
+ * @param int $round How many decimals to round on
+ * @param bool $format Whether to format the number nicely (for output) or not (for calculations)
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return float|bool The calculated value rounded on $round decimals, or false when the input is incorrect
+ */
+ public function calculate($what = self::TOTAL, $round = 2, $format = true) {
+ $return = 0;
+ switch ($what) {
+ case self::SUBTOTAL:
+ $return = - $this->value;
+ break;
+ case self::VAT:
+ $return = $this->calculate(self::SUBTOTAL, $round + 1, false) * $this->getVAT() / 100;
+ break;
+ case self::TOTAL:
+ $return = $this->calculate(self::SUBTOTAL, $round + 1, false) + $this->calculate(self::VAT, $round + 1, false);
+ break;
+ default:
+ return false;
+ }
+ if ($format) {
+ return number_format($return, $round);
+ } else {
+ return round($return, $round);
+ }
+ }
+
+ /**
+ * Remove this discount from the database
+ *
+ * If this doesn't succeed (i.e. false is returned), that means the discount was removed manually or by another instance of this class
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return bool True on success, false on failure
+ */
+ public function delete() {
+ $stmt = $this->pdo->prepare("DELETE FROM `".constants::db_prefix."discount` WHERE `id`=?");
+ $stmt->execute(array($this->id));
+ if ($stmt->rowCount() != 1) {
+ return false;
+ } else {
+ return true;
+ }
+ }
+}
diff --git a/classes/offer.class.php b/classes/offer.class.php
index 1b80ce0..75cb4f6 100644
--- a/classes/offer.class.php
+++ b/classes/offer.class.php
@@ -145,6 +145,42 @@ class offer {
}
/**
+ * Get all discount ids for this offer
+ *
+ * @see offer::getDiscounts() This funtion returns instances of the discount class instead of just the ids
+ *
+ * @throws PDOException Is something went wrong with the database
+ *
+ * @return int[] The ids
+ */
+ public function getDiscountIds() {
+ $ids = array();
+ $discounts = $this->pdo->query("SELECT `id` FROM `".constants::db_prefix."discount` WHERE `offerId`={$this->id}")->fetchAll(PDO::FETCH_ASSOC);
+ foreach ($discounts as $discount) {
+ $ids[] = $discount['id'];
+ }
+ return $ids;
+ }
+
+ /**
+ * Get all discounts for this offer
+ *
+ * @see offer::getDiscountIds() This function returns just the ids of the discounts, and not instances of the discount class
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return discount[] An array indexed by id of instances of the discount class
+ */
+ public function getDiscounts() {
+ $ids = $this->getDiscountIds();
+ $discounts = array();
+ foreach ($ids as $id) {
+ $discounts[$id] = new discount($this->pdo, $id);
+ }
+ return $discounts;
+ }
+
+ /**
* Get the start date of the assignment
*
* @return int The start date as a UNIX timestamp
@@ -359,16 +395,21 @@ class offer {
$return = 0;
switch ($what) {
case self::SUBTOTAL:
- $assignments = $this->getAssignments();
- foreach ($assignments as $assignment) {
+ foreach ($this->getAssignments() as $assignment) {
$return += $assignment->calculate(assignment::SUBTOTAL, $round + 1, false);
}
+ foreach ($this->getDiscounts() as $discount) {
+ $return += $discount->calculate(discount::SUBTOTAL, $round + 1, false);
+ }
break;
case self::VAT:
$assignments = $this->getAssignments();
foreach ($assignments as $assignment) {
$return += $assignment->calculate(assignment::VAT, $round + 1, false);
}
+ foreach ($this->getDiscounts() as $discount) {
+ $return += $discount->calculate(discount::VAT, $round + 1, false);
+ }
break;
case self::TOTAL:
$return = $this->calculate(self::SUBTOTAL, $round + 1, false) + $this->calculate(self::VAT, $round + 1, false);
@@ -432,6 +473,36 @@ class offer {
$error = $stmt->errorInfo();
throw new Exception($error[2]);
}
+ }
+
+ /**
+ * Make a new discount linked to this order
+ *
+ * @param string $title The title for this discount
+ * @param string $description The description for this discount
+ * @param float $value The value for this discount
+ * @param float $vat The VAT percentage (so, 21 for 21%, not 0.21!)
+ *
+ * @throws PDOException If something went wrong with the database
+ * @throws Exception If there was a problem with the input
+ *
+ * @return discount A new instance of the discount class containing the new discount
+ */
+ public function createDiscount($title, $description, $value, $vat) {
+ $stmt = $this->pdo->prepare("INSERT INTO `".constants::db_prefix."discount` (`offerId`,`title`,`description`,`value`,`VAT_percentage`) VALUES (?,?,?,?,?)");
+ $stmt->execute(array(
+ $this->id,
+ $title,
+ $description,
+ $value,
+ $vat
+ ));
+ if ($stmt->rowCount() == 1) {
+ return new discount($this->pdo, $this->pdo->lastInsertId());
+ } else {
+ $error = $stmt->errorInfo();
+ throw new Exception($error[2]);
+ }
}
/**
@@ -459,15 +530,21 @@ class offer {
$invoice_nr = str_replace(array('invoice-','.pdf'), array('',''), $file->getFilename());
}
- $assignments = $this->getAssignments();
$list = array();
- foreach ($assignments as $assignment)
+ foreach ($this->getAssignments() as $assignment)
$list[] = array(
- $assignment->getTitle(),
- $assignment->getPricePerHour() * $assignment->getHours(),
- $assignment->getVAT() . "%",
+ $assignment->getTitle(),
+ $assignment->getPricePerHour() * $assignment->getHours(),
+ $assignment->getVAT() . "%",
$assignment->getPricePerHour() * $assignment->getHours() * (1 + $assignment->getVAT() / 100)
);
+ foreach ($this->getDiscounts() as $discount)
+ $list[] = array(
+ $discount->getTitle(),
+ $discount->calculate(discount::SUBTOTAL),
+ $discount->getVAT() . "%",
+ $discount->calculate(discount::TOTAL)
+ );
$pdf = new correspondence();
$pdf->SetContact($this->getContact());
generated by cgit v1.2.3 (git 2.39.1) at 2025-03-29 10:19:28 +0000