Merge pull request #11 from jr-cologne/jr_add-connected-method

Add functionality to check whether connection to database is established

Author: jr-cologne

README.md

@@ -76,6 +76,20 @@ if ($db->connect('mysql:host=localhost;dbname=db-class-example;charset=utf8', 'r
 }
 ```
 
+### Checking Connection to Database
+
+You can also check the connection to the database by the method `DB::connected()` after connecting.
+
+Example:
+
+```php
+if ($db->connected()) {
+  echo 'Successfully connected to database';
+} else {
+  echo 'Connection failed';
+}
+```
+
 ### Retrieving Data from Database
 
 In order to retrieve data from a database, you need to walk through the following three steps:

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "jr-cologne/db-class",
   "type": "library",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "A simple database class with PHP, PDO and a query builder.",
   "keywords": [
     "database",
@@ -19,7 +19,7 @@
     }
   },
   "homepage": "https://github.com/jr-cologne/db-class",
-  "time": "2017-10-21",
+  "time": "2017-11-10",
   "license": "MIT",
   "authors": [
     {
@@ -31,7 +31,7 @@
   ],
   "support": {
     "issues": "https://github.com/jr-cologne/db-class/issues",
-    "source": "https://github.com/jr-cologne/db-class/tree/v2.0.1",
+    "source": "https://github.com/jr-cologne/db-class/tree/v2.1.0",
     "docs": "https://github.com/jr-cologne/db-class/blob/README.md"
   }
 }

src/API.md

@@ -47,6 +47,17 @@ JRCologne\Utils\Database
 ```
 
 
+#### `$connected`
+
+**Description:** Defines whether a connection to a database is established.
+
+**Visibility:** `protected`
+
+**Data Type:** `boolean`
+
+**Default Value:** `false`
+
+
 #### `$results`
 
 **Description:** The results of the query from the method `DB::select()`.
@@ -126,6 +137,23 @@ Creates a connection to a specified database by PDO.
 **Return Values:** `boolean` true on success, false on failure
 
 
+#### `DB::connected()`
+
+**Description:**
+
+```php
+DB::connected()
+```
+
+Checks whether a connection to a database is established.
+
+**Visibility:** `public`
+
+**Parameters:** -
+
+**Return Values:** `boolean`
+
+
 #### `DB::table()`
 
 **Description:**

src/DB.php

@@ -13,7 +13,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2017 JR Cologne
  * @license https://github.com/jr-cologne/db-class/blob/master/LICENSE MIT
- * @version v2.0.1
+ * @version v2.1.0
  * @link https://github.com/jr-cologne/db-class GitHub Repository
  * @link https://packagist.org/packages/jr-cologne/db-class Packagist site
  *
@@ -53,6 +53,17 @@ class DB extends PDO {
     PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
   ];
 
+  /**
+   * Defines whether a connection to a database is established.
+   *
+   * Value:
+   * true if a connection to a database is established,
+   * false if a connection to a database isn't established (default)
+   *
+   * @var boolean
+   */
+  protected $connected = false;
+
   /**
    * The results of the query from the method DB::select().
    *
@@ -108,12 +119,23 @@ public function connect(string $dsn, string $username = null, string $password =
       }
     } catch (PDOException $e) {
       $this->pdo_exception = $e;
+      $this->connected = false;
       return false;
     }
 
+    $this->connected = true;
     return true;
   }
 
+  /**
+   * Checks whether a connection to a database is established.
+   * 
+   * @return boolean
+   */
+  public function connected() {
+    return $this->connected;
+  }
+
   /**
    * Sets the table to use for the following query.
    * 

src/Exceptions/UnsupportedKeywordException.php

@@ -13,7 +13,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2017 JR Cologne
  * @license https://github.com/jr-cologne/db-class/blob/master/LICENSE MIT
- * @version v2.0.1
+ * @version v2.1.0
  * @link https://github.com/jr-cologne/db-class GitHub Repository
  * @link https://packagist.org/packages/jr-cologne/db-class Packagist site
  *

src/QueryBuilder.php

@@ -13,7 +13,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2017 JR Cologne
  * @license https://github.com/jr-cologne/db-class/blob/master/LICENSE MIT
- * @version v2.0.1
+ * @version v2.1.0
  * @link https://github.com/jr-cologne/db-class GitHub Repository
  * @link https://packagist.org/packages/jr-cologne/db-class Packagist site
  *