Skip to content

Commit ae7420a

Browse files
committed
Package heading in README
2 parents ff71f8b + a652daf commit ae7420a

1 file changed

Lines changed: 67 additions & 3 deletions

File tree

README.md

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,71 @@
11
# simple-php-debuging
2-
Simple PHP debuging tools and utils
32

4-
# Install
5-
```bash
3+
> Simple PHP debuging tools and utils
4+
5+
Simple handy manual debuging utils
6+
7+
## Install
8+
9+
```
610
composer require trash07/simple-php-debuging
711
```
12+
13+
## Usage
14+
15+
* Dumping
16+
17+
```php
18+
$people = array('marc', 'john', 'liman');
19+
// what is the structure of $people ?
20+
_dump($people);
21+
```
22+
23+
* Debug
24+
25+
```php
26+
$info = array('marc', 'john', 1);
27+
// readable $info array echo
28+
_debug($people);
29+
```
30+
31+
* Stopping execution
32+
33+
```php
34+
// simple stop
35+
_stop();
36+
// stop with message
37+
_stop("Sorry we must stop");
38+
```
39+
40+
* Testing condition
41+
42+
```php
43+
$r = 10; $s = 11;
44+
// test the condition of the if statement
45+
_condition($r > $s && $r < $s);
46+
if ($r > $s && $r < $s) {
47+
// do something ...
48+
}
49+
```
50+
51+
```php
52+
$r = 10; $s = 11;
53+
// test the condition of the if statement with message
54+
_condition($r > $s && $r < $s, "The $r, $s equality testing if");
55+
if ($r > $s && $r < $s) {
56+
// do something ...
57+
}
58+
```
59+
60+
* Seing if a line was executed
61+
```php
62+
// simple test
63+
_line();
64+
// _line() with message
65+
_line("Are we realy here ?");
66+
```
67+
68+
69+
## License
70+
71+
GPL-3.0 © [trash07](https://it-consulting.890m.com)

0 commit comments

Comments
 (0)