aboutsummaryrefslogtreecommitdiff
path: root/classes/client.php
diff options
context:
space:
mode:
Diffstat (limited to 'classes/client.php')
-rw-r--r--classes/client.php322
1 files changed, 161 insertions, 161 deletions
diff --git a/classes/client.php b/classes/client.php
index 1b45bae..f45f562 100644
--- a/classes/client.php
+++ b/classes/client.php
@@ -1,22 +1,22 @@
<?php
/**
* Provides the client class, an interface to the client 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/>.
*/
@@ -25,171 +25,171 @@
* An interface to the client table in the database
*/
class client {
- /**
- * @var pdo $pdo The PDO class for database communication
- * @var int $id The id of the client
- * @var string $name The name of the client
- */
- protected $pdo, $id, $name;
+ /**
+ * @var pdo $pdo The PDO class for database communication
+ * @var int $id The id of the client
+ * @var string $name The name of the client
+ */
+ protected $pdo, $id, $name;
- /**
- * Create a new instance
- *
- * @param PDO $pdo The PDO class, to access the database
- * @param int $id The id of the client to fetch
- *
- * @throws PDOException If something went wrong with the database
- * @throws Exception If the client could not be found
- */
- public function __construct($pdo, $id) {
- $this->pdo = $pdo;
+ /**
+ * Create a new instance
+ *
+ * @param PDO $pdo The PDO class, to access the database
+ * @param int $id The id of the client to fetch
+ *
+ * @throws PDOException If something went wrong with the database
+ * @throws Exception If the client could not be found
+ */
+ public function __construct($pdo, $id) {
+ $this->pdo = $pdo;
- $stmt = $this->pdo->prepare("SELECT * FROM `".constants::db_prefix."client` WHERE `id`=?");
- $stmt->execute(array($id));
- if ($stmt->rowCount() == 0) {
- throw new Exception("The client with id '$id' could not be found.");
- }
- $client = $stmt->fetch(PDO::FETCH_ASSOC);
+ $stmt = $this->pdo->prepare("SELECT * FROM `".constants::db_prefix."client` WHERE `id`=?");
+ $stmt->execute(array($id));
+ if ($stmt->rowCount() == 0) {
+ throw new Exception("The client with id '$id' could not be found.");
+ }
+ $client = $stmt->fetch(PDO::FETCH_ASSOC);
- $this->id = $client['id'];
- $this->name = $client['name'];
- }
+ $this->id = $client['id'];
+ $this->name = $client['name'];
+ }
- //------------------------------------------------------------------------------
- // Getters and setters
- //------------------------------------------------------------------------------
+ //------------------------------------------------------------------------------
+ // Getters and setters
+ //------------------------------------------------------------------------------
- /**
- * Get the ID of the client
- *
- * @return int The ID
- */
- public function getId() {
- return $this->id;
- }
+ /**
+ * Get the ID of the client
+ *
+ * @return int The ID
+ */
+ public function getId() {
+ return $this->id;
+ }
- /**
- * Get the name of the client
- *
- * @return string The name
- */
- public function getName() {
- return $this->name;
- }
+ /**
+ * Get the name of the client
+ *
+ * @return string The name
+ */
+ public function getName() {
+ return $this->name;
+ }
- /**
- * Set the name of the client
- *
- * @param string $name The new name for the client
- *
- * @throws PDOException If something went wrong with the database
- *
- * @return bool True on succes, false on failure
- */
- public function setName($name) {
- $stmt = $this->pdo->prepare("UPDATE `".constants::db_prefix."client` SET `name`=? WHERE `id`=?");
- $stmt->execute(array($name, $this->id));
- if ($stmt->rowCount() == 1) {
- $this->name = $name;
- return true;
- } else {
- return false;
- }
- }
+ /**
+ * Set the name of the client
+ *
+ * @param string $name The new name for the client
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return bool True on succes, false on failure
+ */
+ public function setName($name) {
+ $stmt = $this->pdo->prepare("UPDATE `".constants::db_prefix."client` SET `name`=? WHERE `id`=?");
+ $stmt->execute(array($name, $this->id));
+ if ($stmt->rowCount() == 1) {
+ $this->name = $name;
+ return true;
+ } else {
+ return false;
+ }
+ }
- /**
- * Get all contact ids for this client
- *
- * @see client::getContacts() This funtion returns instances of the contact class instead of just the ids
- *
- * @throws PDOException Is something went wrong with the database
- *
- * @return int[] The ids
- */
- public function getContactIds() {
- $ids = array();
- $contacts = $this->pdo->query("SELECT `id` FROM `".constants::db_prefix."contact` WHERE `clientId`={$this->id}")->fetchAll(PDO::FETCH_ASSOC);
- foreach ($contacts as $contact) {
- $ids[] = $contact['id'];
- }
- return $ids;
- }
+ /**
+ * Get all contact ids for this client
+ *
+ * @see client::getContacts() This funtion returns instances of the contact class instead of just the ids
+ *
+ * @throws PDOException Is something went wrong with the database
+ *
+ * @return int[] The ids
+ */
+ public function getContactIds() {
+ $ids = array();
+ $contacts = $this->pdo->query("SELECT `id` FROM `".constants::db_prefix."contact` WHERE `clientId`={$this->id}")->fetchAll(PDO::FETCH_ASSOC);
+ foreach ($contacts as $contact) {
+ $ids[] = $contact['id'];
+ }
+ return $ids;
+ }
- /**
- * Get all contacts for this client
- *
- * @see client::getContactIds() This function returns just the ids of the contacts, and not instances of the contact class
- *
- * @throws PDOException If something went wrong with the database
- *
- * @return contact[] An array indexed by id of instances of the contact class
- */
- public function getContacts() {
- $ids = $this->getContactIds();
- $contacts = array();
- foreach ($ids as $id) {
- $contacts[$id] = new contact($this->pdo, $id);
- }
- return $contacts;
- }
+ /**
+ * Get all contacts for this client
+ *
+ * @see client::getContactIds() This function returns just the ids of the contacts, and not instances of the contact class
+ *
+ * @throws PDOException If something went wrong with the database
+ *
+ * @return contact[] An array indexed by id of instances of the contact class
+ */
+ public function getContacts() {
+ $ids = $this->getContactIds();
+ $contacts = array();
+ foreach ($ids as $id) {
+ $contacts[$id] = new contact($this->pdo, $id);
+ }
+ return $contacts;
+ }
- //------------------------------------------------------------------------------
- // Other functions
- //------------------------------------------------------------------------------
+ //------------------------------------------------------------------------------
+ // Other functions
+ //------------------------------------------------------------------------------
- /**
- * 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
- *
- * @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."client` WHERE `id`=?");
- $stmt->execute(array($this->id));
- if ($stmt->rowCount() != 1) {
- return false;
- } else {
- return true;
- }
- }
+ /**
+ * 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
+ *
+ * @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."client` WHERE `id`=?");
+ $stmt->execute(array($this->id));
+ if ($stmt->rowCount() != 1) {
+ return false;
+ } else {
+ return true;
+ }
+ }
- /**
- * Make a new contact for this client
- *
- * @param string $name The name for this contact
- * @param string $email The email for this contact
- * @param string $address The first address line of this contact (normally street and house number)
- * @param string $address_2 The second address line of this contact
- * @param string $postal_code The postal code for this contact
- * @param string $city The city for this contact
- * @param string $state The state for this contact
- * @param string $country The country for this contact
- *
- * @throws PDOException If something went wrong with the database
- * @throws Exception If there was a problem with the input
- *
- * @return contact A new instance of the contact class containing the new contact
- */
- public function createContact($name, $email, $address, $address_2, $postal_code, $city, $country) {
- $stmt = $this->pdo->prepare("INSERT INTO `".constants::db_prefix."contact` (`clientId`,`name`,`email`,`address`,`address_2`,`postal_code`,`city`,`country`) VALUES (?,?,?,?,?,?,?,?)");
- $stmt->execute(array(
- $this->id,
- $name,
- $email,
- $address,
- $address_2,
- $postal_code,
- $city,
- $country
- ));
- if ($stmt->rowCount() == 1) {
- return new contact($this->pdo, $this->pdo->lastInsertId());
- } else {
- $error = $stmt->errorInfo();
- throw new Exception($error[2]);
- }
- }
-} \ No newline at end of file
+ /**
+ * Make a new contact for this client
+ *
+ * @param string $name The name for this contact
+ * @param string $email The email for this contact
+ * @param string $address The first address line of this contact (normally street and house number)
+ * @param string $address_2 The second address line of this contact
+ * @param string $postal_code The postal code for this contact
+ * @param string $city The city for this contact
+ * @param string $state The state for this contact
+ * @param string $country The country for this contact
+ *
+ * @throws PDOException If something went wrong with the database
+ * @throws Exception If there was a problem with the input
+ *
+ * @return contact A new instance of the contact class containing the new contact
+ */
+ public function createContact($name, $email, $address, $address_2, $postal_code, $city, $country) {
+ $stmt = $this->pdo->prepare("INSERT INTO `".constants::db_prefix."contact` (`clientId`,`name`,`email`,`address`,`address_2`,`postal_code`,`city`,`country`) VALUES (?,?,?,?,?,?,?,?)");
+ $stmt->execute(array(
+ $this->id,
+ $name,
+ $email,
+ $address,
+ $address_2,
+ $postal_code,
+ $city,
+ $country
+ ));
+ if ($stmt->rowCount() == 1) {
+ return new contact($this->pdo, $this->pdo->lastInsertId());
+ } else {
+ $error = $stmt->errorInfo();
+ throw new Exception($error[2]);
+ }
+ }
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-03-13 15:59:43 +0000