Database_Connection Interface Reference
Public Member Functions | |
| connect () | |
| selectDatabase ($database) | |
| exec ($sql) | |
| query ($sql) | |
| pager ($sql) | |
| affectedRows () | |
| insertId () | |
| escape ($str) | |
| quote ($str) | |
Detailed Description
Database_Connection generic interface
Definition at line 49 of file database.lib.php.
Member Function Documentation
| affectedRows | ( | ) |
Returns the number of rows affected by the last query
- Returns:
- int
- Exceptions:
-
Database_Connection_Exception
Implemented in Mysql_Database_Connection, and Claroline_Database_Connection.
| connect | ( | ) |
Connect to the database
- Exceptions:
-
Database_Connection_Exception
Implemented in Mysql_Database_Connection, and Claroline_Database_Connection.
| escape | ( | $ | str | ) |
Escape dangerous characters in the given string
- Parameters:
-
string $str
- Returns:
- string
Implemented in Mysql_Database_Connection, and Claroline_Database_Connection.
| exec | ( | $ | sql | ) |
Execute a query and returns the number of affected rows
- Returns:
- int
- Exceptions:
-
Database_Connection_Exception
Implemented in Mysql_Database_Connection, and Claroline_Database_Connection.
| insertId | ( | ) |
Get the ID generated from the previous INSERT operation
- Returns:
- int
- Exceptions:
-
Database_Connection_Exception
Implemented in Mysql_Database_Connection, and Claroline_Database_Connection.
| pager | ( | $ | sql | ) |
Get a pager for the query
- Returns:
- Database_Pager
- Exceptions:
-
Database_Connection_Exception
- Deprecated:
- since Claroline 1.9.5, will be removed in 1.9.6 and 1.10
Implemented in Mysql_Database_Connection, and Claroline_Database_Connection.
| query | ( | $ | sql | ) |
Execute a query and returns the result set
- Returns:
- Database_ResultSet
- Exceptions:
-
Database_Connection_Exception
Implemented in Mysql_Database_Connection, and Claroline_Database_Connection.
| quote | ( | $ | str | ) |
Escape dangerous characters and enquote the given string
- Parameters:
-
string $str
- Returns:
- string
Implemented in Mysql_Database_Connection, and Claroline_Database_Connection.
| selectDatabase | ( | $ | database | ) |
Select a database
- Parameters:
-
string $database database name
- Exceptions:
-
Database_Connection_Exception on failure
Implemented in Mysql_Database_Connection, and Claroline_Database_Connection.
The documentation for this interface was generated from the following file:
- claroline/claroline/inc/lib/database/database.lib.php
