Download the PHP package noahheck/e_pdostatement without Composer
On this page you can find all versions of the php package noahheck/e_pdostatement. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download noahheck/e_pdostatement
More information about noahheck/e_pdostatement
Files in noahheck/e_pdostatement
Package e_pdostatement
Short Description Drop in replacement for default PDOStatement class allowing devs to view an interpolated version of a parameterized query
License Apache-2.0
Homepage https://github.com/noahheck/E_PDOStatement
Informations about the package e_pdostatement
E_PDOStatement
Extension to the default PHP PDOStatement class providing the ability to generate a version of a parameterized query with the parameters injected into the query string.
The result is generally suitable for logging activities, debugging and performance analysis.
View the changelog
Usage
PHP's PDO are a much improved way for handling database communications, but not being able to view a complete version of the query to be executed on the server after statement parameters have been interpolated can be frustrating.
A common method for obtaining the interpolated query involves usage of outside functions or extending the native PDOStatement
object and adding a new method to accomplish this.
The E_PDOStatement (Enhanced PDOStatement) project was designed as a solution to this that doesn't require workflow modifications to generate the resultant query string. The generated query string is accessible on the new EPDOStatement
object as a new fullQuery
property :
The result of this will be (on a MySQL database):
When correctly configured, the interpolated values are escaped appropriately for the database driver, allowing the generated string to be suitable for e.g. log files, backups, etc.
E_PDOStatement supports pre-execution binding to both named and ? style parameter markers:
as well as un-named parameters provided as input arguments to the $stmt->execute()
method:
Named $key => $value pairs can also be provided as input arguments to the $stmt->execute()
method:
You can also generate the full query string without executing the query:
or
Installation
Preferred method: install using composer:
Alternatively, you can download the project, put it into a suitable location in your application directory and include into your project as needed.
Configuration
The EPDOStatement class extends the native \PDOStatement object, so the PDO object must be configured to use the extended definition:
That's all there is to it.
Debugging
EPDOStatement
's fullQuery
property and interpolateQuery
method are great tools for viewing a resultant query string, and is designed to be suitable for query logging. They don't provide any insight into the process used to track datapoints and generate the resultant query string.
To add debugging and development support, EPDOStatement
also now implements PSR-3 LoggerAwareInterface
. Provide an instance of a PSR-3 LoggerInterface
(such as Monolog), and you gain introspection into how your queries are being composed:
After executing, the log file content will include:
Logging levels utilized by EPDOStatement
include debug, warn, error, and info.
For more information, see the PHP-FIG PSR-3 Logger documentation. For information on working with Monolog, see the Monolog documentation.
Note: EPDOStatement
considers successful database query execution a PSR-3 Interesting Event and logs them at the info
level.
Get in Touch
There are a lot of forum posts related to or requesting this type of functionality, so hopefully someone somewhere will find it helpful. If it helps you, comments are of course appreciated.
Bugs, new feature requests and pull requests are of course welcome as well. This was created to help our pro team solve an issue, so it was designed around our specific work flow. If it doesn't work for you though, let me know and I'll be happy to explore if I can help you out.
E_mysqli
E_PDOStatement now has a sister project aimed at providing the same functionality for php devs using the mysqli
extension: