added DriverException for representing errors in the data layer

jaredk2g · Dec 29, 2015 · f103fb1 · f103fb1
1 parent d2fcb47
commit f103fb1
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/Driver/DriverInterface.php b/src/Driver/DriverInterface.php
@@ -22,6 +22,8 @@ interface DriverInterface
      * @param array         $parameters
      *
      * @return mixed result
+     *
+     * @throws \Pulsar\Exception\DriverException when an exception occurs within the driver
      */
     public function createModel(Model $model, array $parameters);
 
@@ -33,6 +35,8 @@ public function createModel(Model $model, array $parameters);
      * @param string        $propertyName
      *
      * @return mixed
+     *
+     * @throws \Pulsar\Exception\DriverException when an exception occurs within the driver
      */
     public function getCreatedID(Model $model, $propertyName);
 
@@ -42,6 +46,8 @@ public function getCreatedID(Model $model, $propertyName);
      * @param \Pulsar\Model $model
      *
      * @return array|false
+     *
+     * @throws \Pulsar\Exception\DriverException when an exception occurs within the driver
      */
     public function loadModel(Model $model);
 
@@ -52,6 +58,8 @@ public function loadModel(Model $model);
      * @param array         $parameters
      *
      * @return bool
+     *
+     * @throws \Pulsar\Exception\DriverException when an exception occurs within the driver
      */
     public function updateModel(Model $model, array $parameters);
 
@@ -61,6 +69,8 @@ public function updateModel(Model $model, array $parameters);
      * @param \Pulsar\Model $model
      *
      * @return bool
+     *
+     * @throws \Pulsar\Exception\DriverException when an exception occurs within the driver
      */
     public function deleteModel(Model $model);
 
@@ -70,6 +80,8 @@ public function deleteModel(Model $model);
      * @param \Pulsar\Query $query
      *
      * @return int total
+     *
+     * @throws \Pulsar\Exception\DriverException when an exception occurs within the driver
      */
     public function totalRecords(Query $query);
 
@@ -79,6 +91,8 @@ public function totalRecords(Query $query);
      * @param \Pulsar\Query $query
      *
      * @return array raw data from storage
+     *
+     * @throws \Pulsar\Exception\DriverException when an exception occurs within the driver
      */
     public function queryModels(Query $query);
 }