Profiler v2

Author: cheprasov

README.md

@@ -11,10 +11,14 @@ It helps to add profiler to your php-project easy.
 - Has 'counter' and 'timer' tools.
 - Has grouping for compare elements.
 
-### How to add the profiler to you project
+### 1. How to add the profiler to you project
 
 All you need is open your 'autoload' function, and use the profiler's function for loading class.
 
+```php
+\SimpleProfiler\Profiler::loadFile(string $classPath, bool $inject_profiler = true) : void`
+```
+
 Example:
 ```php
 // Path to autoloader class for SimpleProfiler
@@ -40,19 +44,91 @@ spl_autoload_register(
 );
 ```
 
-### Examples
+### 2. How to get result
+
+The Profiler has 2 methods that returns semi-raw collected data, that you can use or modify as you want.
+
+`\SimpleProfiler\Profiler::getTimerStat() : array`
+
+`\SimpleProfiler\Profiler::getCounterStat() : array`
+
+You can use function `\SimpleProfiler\Profiler::getLog` for already getting formatted log data.
+
+Example of output:
+```
+# Group [ default ]
+
+1) ProcessTime
+   count: 1, avg_time: 0.003965 sec, full_time: 0.003965 sec
+   cost: [----------------------------------------------------------------------------------------------------] 100 %
+
+
+# Group [ Profiler ]
+
+1) CliArgs\CliArgs::__construct
+   count: 1, avg_time: 0.000027 sec, full_time: 0.000027 sec
+   cost: [--------------] 14 %
+
+2) CliArgs\CliArgs::setConfig
+   count: 1, avg_time: 0.000018 sec, full_time: 0.000018 sec
+   cost: [---------] 9.3 %
+
+3) CliArgs\CliArgs::getArg
+   count: 6, avg_time: 0.000014 sec, full_time: 0.000085 sec
+   cost: [--------------------------------------------] 44.2 %
+
+4) CliArgs\CliArgs::getArgFromConfig
+   count: 6, avg_time: 0.000001 sec, full_time: 0.000006 sec
+   cost: [---] 3 %
+
+5) CliArgs\CliArgs::getArguments
+   count: 18, avg_time: 0.000001 sec, full_time: 0.000022 sec
+   cost: [-----------] 11.3 %
 
-1. Implementation to you project
+6) CliArgs\CliArgs::parseArray
+   count: 1, avg_time: 0.000005 sec, full_time: 0.000005 sec
+   cost: [---] 2.6 %
+
+7) CliArgs\CliArgs::isFlagExists
+   count: 12, avg_time: 0.000003 sec, full_time: 0.000030 sec
+   cost: [----------------] 15.6 %
+
+
+# COUNTERS:
+ > Counter_of_some_event : 2
+ > Some_event : 3
+```
+
+### Usage
+
+1. Using timers tool
+```php
+\SimpleProfiler\Profiler::start('someName');
+
+// some code
+
+\SimpleProfiler\Profiler::stop('someName');
+```
+
+For grouping times use dot `.` as separator for group and name.
+Example of grouping calculation please see above.
 
-1. Using timer
 ```php
-Profiler::start('some name');
+\SimpleProfiler\Profiler::start('Group1.someName');
 
 // some code
 
-Profiler::stop();
+\SimpleProfiler\Profiler::stop('Group1.someName');
+```
+
+2. Using counter tool
+
+For collection count of some event just use next code
+```php
+\SimpleProfiler\Profiler::count('Counter_of_some_event');
 
-echo Profiler::getLog();
+// second paramenet is count of increment
+\SimpleProfiler\Profiler::count('Counter_of_some_event', 3);
 ```
 
 ### Composer