andela-celisha-wigwe / PotatoORM

exceptions/FaultyExecutionException.php

Doc Comments +3 added lines

@@ -6,6 +6,9 @@
 {
     public $message;
 
+    /**
+     * @param string $message
+     */
     public function __construct($message)
     {
         $this->message = $message;

src/PotatoConnector.php

Doc Comments +4 added lines, -12 removed lines

@@ -50,10 +50,6 @@ 
      * [connect Try setting up the connection wtith given connection parameters].
      *
      * @param [string] $adaptar  [The adapter to be used witht he connection to the database]
-     * @param [string] $host     [The host name for the connection]
-     * @param [string] $dbname   [The name of the database]
-     * @param [string] $username [The username to be used if it is required]
-     * @param [string] $password [The [assword to be used for the connectionif required.]]
      *
      * @return [type] [A PDO connection to the databsase]
      */
@@ -74,10 +70,6 @@ 
      * Throw an InvalidAdaptarException if the given driver is invalid, does not exist or is not compatible with PDO.
      *
      * @param [string] $adaptar  [The adaptar/driver name used to create PDO connection.]
-     * @param [string] $host     [The hostname to be used for the PDO connection if mysql is chosen.]
-     * @param [string] $dbname   [The name of the database of the PDO connection.]
-     * @param [string] $username [The username to be used for the PDO connection if mysql is chosen.]
-     * @param [string] $password [The password to be used for the PDO connection id mysql is chosen.]
      *
      * @return [type] [description]
      */
@@ -124,7 +116,7 @@ 
      * [sqliteConnect Create an SQLite connection if the selected PDO drver is sqlite.].
      *
      * @param [string] $adaptar The sqlite driver name
-     * @param [type]   $dbFile  [The database file. If this is null, then get the database file using the getSqliteFile method.]
+     * @param string   $dbFile  [The database file. If this is null, then get the database file using the getSqliteFile method.]
      *
      * @return [type] A PDO connection done with am sqlite driver.
      */
@@ -139,7 +131,6 @@ 
     /**
      * [getSqliteFile Get the file location of the slqlite file if it is preferred to use an sqlite pdo connection.].
      *
-     * @param [type] $path [The path to the sqlite database file.]
      *
      * @return [type] [The path to the sqlite file if provided or a default file path if the path in the provided argument is null.]
      */
@@ -153,7 +144,7 @@ 
     /**
      * [getConfigurations Get the configuration data from the file path].
      *
-     * @param [type] $filepath [The file path where the connection configuration information are located.]
+     * @param string $filepath [The file path where the connection configuration information are located.]
      *
      * @return [array] [An array of the configuration information after parsing the information.]
      */
@@ -167,6 +158,7 @@ 
     /**
      * [getConfigFilePath Get the file path of the file where the configuration lies.].
      *
+     * @param string $path
      * @return [string] [The file path of the location where the confuiguration information lie.]
      */
     public function getConfigFilePath($path = null)
@@ -227,7 +219,7 @@ 
     /**
      * [throwFaultyConnectionException Throw an exception if along the lime the connection is not setup correctly].
      *
-     * @param [string] $message [The message to be related in event of this exception.]
+     * @param string $message [The message to be related in event of this exception.]
      *
      * @return [type] [An inherited PDO exception with a customized message.]
      */

src/PotatoModel.php

Doc Comments +5 added lines, -5 removed lines

@@ -85,8 +85,8 @@ 
     /**
      * [find Find on record or row in the table given by an ID.
      *
-     * @param [type] $id    [the ID of the row record to be fetched.]
-     * @param [type] $query [The query to be used for the database communication.]
+     * @param integer $id    [the ID of the row record to be fetched.]
+     * @param \Mockery\MockInterface $query [The query to be used for the database communication.]
      *
      * @return [type] [The returned value of finding the record with the given ID.]
      */
@@ -145,8 +145,8 @@ 
     /**
      * Destroy a recored or row from a database table.
      *
-     * @param [type] $id    [The ID of the record to be deleted.]
-     * @param [type] $query [The query to handle to deleting operation]
+     * @param integer $id    [The ID of the record to be deleted.]
+     * @param \Mockery\MockInterface $query [The query to handle to deleting operation]
      *
      * @return [type] [An array of all the records in that table without the deleted recode.]
      */
@@ -162,7 +162,7 @@ 
     /**
      * [getClassTableName Get the name of the class from which this function is called, including classes that inherit from this class.].
      *
-     * @return [type] [description]
+     * @return string [description]
      */
     public static function getClassTableName()
     {

src/PotatoQuery.php

Doc Comments +7 added lines, -8 removed lines

@@ -93,7 +93,7 @@ 
     /**
      * Try executoing a query given the statment.
      *
-     * @param PDOStatemetn $statement The PDO statment to be executed.
+     * @param \PDOStatement $statement The PDO statment to be executed.
      *
      * @return bool The result of executing a query. True for success, false for failure
      */
@@ -136,7 +136,7 @@ 
     /**
      * Bind parameters to the placeholders in the SQL queries. This is to avoid sql injection.
      *
-     * @param [type]  $statement The PDOStatement to be used to the binding.
+     * @param \PDOStatement  $statement The PDOStatement to be used to the binding.
      * @param [array] $values    The result of binding parameters to an SQL query.
      */
     public function setBindForInsert($statement, $values)
@@ -150,8 +150,8 @@ 
     /**
      * Delete a record form a database table.
      *
-     * @param [string] $table The table to be deleted from
-     * @param [int]    $id    the ID of the record to be deleted
+     * @param string $table The table to be deleted from
+     * @param integer    $id    the ID of the record to be deleted
      *
      * @return [type] The result of the deletion execution.
      */
@@ -192,8 +192,7 @@ 
     /**
      * Bind parameters to the placeholders in the SQL queries. This is to avoid sql injection.
      *
-     * @param [type]  $statement The PDOStatement to be used to the binding.
-     * @param [array] $values    The result of binding parameters to an SQL query.
+     * @param \PDOStatement  $statement The PDOStatement to be used to the binding.
      */
     public function setBindForUpdate($statement, array $data)
     {
@@ -255,8 +254,8 @@ 
      * [throwNoRecordException Throw an Exception if there is no record found in the database table.]
      * This may mean that the table is empty ot that the record with the given ID is not foung.
      *
-     * @param [string] $table [The table that is empty or does not have the record with the given ID.]
-     * @param [int]    $id    [The ID of the record that does not exist in the databse table]
+     * @param string $table [The table that is empty or does not have the record with the given ID.]
+     * @param integer    $id    [The ID of the record that does not exist in the databse table]
      *
      * @return [type] [description]
      */