https://github.com/jspeedz/debug-pooper-symfony
Some more debugging methods to be used in a symfony framework (or standalone)
https://github.com/jspeedz/debug-pooper-symfony
debugging-tools symfony
Last synced: 8 days ago
JSON representation
Some more debugging methods to be used in a symfony framework (or standalone)
- Host: GitHub
- URL: https://github.com/jspeedz/debug-pooper-symfony
- Owner: jspeedz
- License: mit
- Created: 2018-10-05T14:34:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-18T15:21:48.000Z (about 6 years ago)
- Last Synced: 2025-09-21T02:57:16.208Z (7 months ago)
- Topics: debugging-tools, symfony
- Language: PHP
- Homepage:
- Size: 68.4 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# debug-pooper-symfony
Tired of using symfony's dump(); method? Use 💩(); instead!
## More useful features
### Dumping prepared statements
Dumping prepared statements into a readable, and usually executable SQL strings can be useful.
#### Example 1:
```php
dumpQuery(
'SELECT 1 FROM x WHERE y = ?',
[
1234
],
[
\Doctrine\DBAL\ParameterType::INTEGER
]
);
```
Result:
`SELECT 1 FROM x WHERE y = 1234`
#### Example 2:
```php
dumpQuery(
'SELECT 1 FROM x WHERE y = :some_named_value',
[
'some_named_value' => 1234
],
[
\Doctrine\DBAL\ParameterType::INTEGER
]
);
```
Result:
`SELECT 1 FROM x WHERE y = 1234`
### Dumping request information
```php
dumpRequest();
```
Result:
`To be determined..`
### Dumping simple XML element objects
Converting and dumping SimpleXmlObjects into a readable string.
#### Example 1:
```php
dumpSimpleXmlElement(
simplexml_load_string('someValue')
);
```
Result:
```SimpleXML object (1 item)
[
Element {
Name: 'root'
String Content: ''
Content in Default Namespace
Children: 1 - 1 'someElement'
Attributes: 0
}
]
```
### Dumping simple XML element object trees
Converting and dumping SimpleXmlObjects into a readable tree string.
#### Example 1:
```php
dumpSimpleXmlElementTree(
simplexml_load_string('someValue')
);
```
Result:
```SimpleXML object (1 item)
[0] //
->someElement[0]
(string) 'someValue' (9 chars)
```
## Utilities
### Timing a block of code
```php
$timer = debugTimer();
sleep(1);
$timeInMs = $timer();
```
## Code templates
### PhpStorm Live templates
```php
if($this->container->getParameter('kernel.environment') === 'dev') {
💩($END$);
die(__FILE__ . ':' . __LINE__);
}
```
```php
if($this->container->getParameter('kernel.environment') === 'dev') {
dumpQuery($END$);
die(__FILE__ . ':' . __LINE__);
}
```
```php
if($this->container->getParameter('kernel.environment') === 'dev') {
dumpRequest();
die(__FILE__ . ':' . __LINE__);
}
```
```php
if($this->container->getParameter('kernel.environment') === 'dev') {
$timer = debugTimer();
// Do some work
💩($END$);
$taskTookMs = $timer();
echo 'Completed task in ' . $taskTookMs . 'ms!' . PHP_EOL;
die(__FILE__ . ':' . __LINE__);
}
```
```php
if($this->container->getParameter('kernel.environment') === 'dev') {
dumpSimpleXmlElement($END$);
die(__FILE__ . ':' . __LINE__);
}
```
```php
if($this->container->getParameter('kernel.environment') === 'dev') {
dumpSimpleXmlElementTree($END$);
die(__FILE__ . ':' . __LINE__);
}
```
## Install
Please only install this package for development:
`composer require --dev jspeedz/debug-pooper-symfony`
## Requirements
- Symfony 3.3+
- PHP 8.1+
- Doctrine DBAL 4+