Skip to content

Commit

Permalink
update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
morris committed May 9, 2020
1 parent 85cc517 commit 8069be7
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
26 changes: 24 additions & 2 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,11 +285,19 @@ class Connection
//

/**
* Called before executing a statement.
* Execution callback.
*
* The default implementation does nothing.
* Override to log or measure statement execution.
* Must call $callback.
*
* @param Fragment $statement
* @param function $callback
*/
public function execCallback($statement, $callback);

/**
* @deprecated Override execCallback instead.
* @param Fragment $statement
*/
public function beforeExec($statement);

Expand Down Expand Up @@ -554,6 +562,20 @@ class Result implements \Iterator
*/
public function affected();

/**
* Get this result's connection.
*
* @return Connection
*/
public function conn();

/**
* Get this result's statement.
*
* @return Fragment
*/
public function statement();

/**
* @return \PDOStatement
*/
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "morris/dop",
"description": "An immutable API on top of PDO to compose and execute SQL statements",
"keywords": [ "sql", "pdo", "database", "dop" ],
"keywords": ["sql", "pdo", "database", "dop"],
"license": "MIT",
"homepage": "https://github.com/morris/dop",
"authors": [
Expand Down

0 comments on commit 8069be7

Please sign in to comment.