Skip to content

Commit e495c57

Browse files
committed
Add a few more non-extendable interface
Signed-off-by: Carl Schwan <carl@carlschwan.eu>
1 parent 831aebf commit e495c57

File tree

3 files changed

+27
-1
lines changed

3 files changed

+27
-1
lines changed

lib/public/DB/IPreparedStatement.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@
3030
use PDO;
3131

3232
/**
33+
* This interface allows you to prepare a database query.
34+
*
35+
* This interface must not be implemented in your application but
36+
* instead obtained from IDBConnection::prepare.
37+
*
38+
* ```php
39+
* $prepare = $this->db->prepare($query->getSql());
40+
* ```
41+
*
3342
* @since 21.0.0
3443
*/
3544
interface IPreparedStatement {

lib/public/DB/IResult.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@
2929
use PDO;
3030

3131
/**
32+
* This interface represent the result of a database query.
33+
*
34+
* Usage:
35+
*
36+
* ```php
37+
* $qb = $this->db->getQueryBuilder();
38+
* $qb->select(...);
39+
* $result = $query->executeQuery();
40+
* ```
41+
*
42+
* This interface must not be implemented in your application.
43+
*
3244
* @since 21.0.0
3345
*/
3446
interface IResult {

lib/public/DB/ISchemaWrapper.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,12 @@
2626
use Doctrine\DBAL\Platforms\AbstractPlatform;
2727

2828
/**
29-
* Interface ISchemaWrapper
29+
* This interface allows to get information about the database schema.
30+
* This is particularly helpful for database migration scripts.
31+
*
32+
* This interface must not be implemented in your application but
33+
* instead can be obtained in your migration scripts with the
34+
* `$schemaClosure` Closure.
3035
*
3136
* @since 13.0.0
3237
*/

0 commit comments

Comments
 (0)