Skip to content

Commit 3eb016e

Browse files
glenscglensc
authored
Merge pull request #72 from glensc/config-class
Refactor: Add Config class implementing ArrayAccess
2 parents a01b3ee + f2beb9e commit 3eb016e

8 files changed

Lines changed: 121 additions & 48 deletions

File tree

‎autoload.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
require_once __DIR__ . '/src/Saver/SaverInterface.php';
99

1010
require_once __DIR__ . '/src/Exception/ProfilerException.php';
11+
require_once __DIR__ . '/src/Config.php';
1112
require_once __DIR__ . '/src/Profiler.php';
1213
require_once __DIR__ . '/src/ProfilerFactory.php';
1314
require_once __DIR__ . '/src/Profilers/AbstractProfiler.php';

‎src/Config.php‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
<?php
2+
3+
namespace Xhgui\Profiler;
4+
5+
use ArrayAccess;
6+
7+
class Config implements ArrayAccess
8+
{
9+
/** @var array */
10+
private $config;
11+
12+
public function __construct(array $config = array())
13+
{
14+
$this->config = $this->getDefaultConfig();
15+
if ($config) {
16+
$this->merge($config);
17+
}
18+
}
19+
20+
/**
21+
* @return array
22+
*/
23+
public function toArray()
24+
{
25+
return $this->config;
26+
}
27+
28+
private function merge(array $config)
29+
{
30+
$this->config = array_replace($this->config, $config);
31+
}
32+
33+
public function offsetExists($offset)
34+
{
35+
return isset($this->config[$offset]);
36+
}
37+
38+
public function offsetGet($offset)
39+
{
40+
return $this->config[$offset];
41+
}
42+
43+
public function offsetSet($offset, $value)
44+
{
45+
$this->config[$offset] = $value;
46+
}
47+
48+
public function offsetUnset($offset)
49+
{
50+
unset($this->config[$offset]);
51+
}
52+
53+
/**
54+
* @return array
55+
*/
56+
private function getDefaultConfig()
57+
{
58+
return array(
59+
'save.handler' => Profiler::SAVER_STACK,
60+
'save.handler.stack' => array(
61+
'savers' => array(
62+
Profiler::SAVER_UPLOAD,
63+
Profiler::SAVER_FILE,
64+
),
65+
'saveAll' => false,
66+
),
67+
'save.handler.file' => array(
68+
'filename' => sys_get_temp_dir() . '/xhgui.data.jsonl',
69+
),
70+
'profiler.enable' => function () {
71+
return true;
72+
},
73+
'profiler.flags' => array(
74+
ProfilingFlags::CPU,
75+
ProfilingFlags::MEMORY,
76+
ProfilingFlags::NO_BUILTINS,
77+
ProfilingFlags::NO_SPANS,
78+
),
79+
'profiler.options' => array(),
80+
'profiler.exclude-env' => array(),
81+
'profiler.simple_url' => function ($url) {
82+
return preg_replace('/=\d+/', '', $url);
83+
},
84+
'profiler.replace_url' => null,
85+
);
86+
}
87+
}

‎src/Profiler.php‎

Lines changed: 8 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ final class Profiler
2222
/**
2323
* Profiler configuration.
2424
*
25-
* @var array
25+
* @var Config
2626
*/
2727
private $config;
2828

@@ -54,11 +54,15 @@ final class Profiler
5454
/**
5555
* Profiler constructor.
5656
*
57-
* @param array $config
57+
* @param array|Config $config
5858
*/
59-
public function __construct(array $config)
59+
public function __construct($config)
6060
{
61-
$this->config = array_replace($this->getDefaultConfig(), $config);
61+
if ($config instanceof Config) {
62+
$this->config = $config;
63+
} else {
64+
$this->config = new Config($config);
65+
}
6266
}
6367

6468
/**
@@ -273,39 +277,4 @@ private function getSaver()
273277

274278
return $this->saveHandler ?: null;
275279
}
276-
277-
/**
278-
* @return array
279-
*/
280-
private function getDefaultConfig()
281-
{
282-
return array(
283-
'save.handler' => self::SAVER_STACK,
284-
'save.handler.stack' => array(
285-
'savers' => array(
286-
self::SAVER_UPLOAD,
287-
self::SAVER_FILE,
288-
),
289-
'saveAll' => false,
290-
),
291-
'save.handler.file' => array(
292-
'filename' => sys_get_temp_dir() . '/xhgui.data.jsonl',
293-
),
294-
'profiler.enable' => function () {
295-
return true;
296-
},
297-
'profiler.flags' => array(
298-
ProfilingFlags::CPU,
299-
ProfilingFlags::MEMORY,
300-
ProfilingFlags::NO_BUILTINS,
301-
ProfilingFlags::NO_SPANS,
302-
),
303-
'profiler.options' => array(),
304-
'profiler.exclude-env' => array(),
305-
'profiler.simple_url' => function ($url) {
306-
return preg_replace('/=\d+/', '', $url);
307-
},
308-
'profiler.replace_url' => null,
309-
);
310-
}
311280
}

‎src/ProfilerFactory.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ final class ProfilerFactory
2121
*
2222
* @return ProfilerInterface|null
2323
*/
24-
public static function create(array $config)
24+
public static function create(Config $config)
2525
{
2626
$adapters = array(
2727
Profiler::PROFILER_TIDEWAYS_XHPROF => function () {

‎src/ProfilingData.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ final class ProfilingData
1414
/** @var callable|null */
1515
private $replaceUrl;
1616

17-
public function __construct(array $config = array())
17+
public function __construct(Config $config)
1818
{
1919
$this->excludeEnv = isset($config['profiler.exclude-env']) ? (array)$config['profiler.exclude-env'] : array();
2020
$this->simpleUrl = isset($config['profiler.simple_url']) ? $config['profiler.simple_url'] : null;

‎src/SaverFactory.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ final class SaverFactory
1414
{
1515
/**
1616
* @param string $saveHandler
17-
* @param array $config
17+
* @param Config $config
1818
* @return SaverInterface|null
1919
*/
20-
public static function create($saveHandler, array $config = array())
20+
public static function create($saveHandler, Config $config)
2121
{
2222
switch ($saveHandler) {
2323
case Profiler::SAVER_FILE:
@@ -64,7 +64,7 @@ public static function create($saveHandler, array $config = array())
6464
throw new ProfilerException("For {$saveHandler} you need to install xhgui-collector package: composer require perftools/xhgui-collector");
6565
}
6666
$config = self::migrateConfig($config, $saveHandler);
67-
$legacySaver = Xhgui_Saver::factory($config);
67+
$legacySaver = Xhgui_Saver::factory($config->toArray());
6868
$saver = self::getAdapter($legacySaver);
6969
break;
7070
}
@@ -79,11 +79,11 @@ public static function create($saveHandler, array $config = array())
7979
/**
8080
* Prepare config for Xhgui_Saver specific to $saveHandler
8181
*
82-
* @param array $config
82+
* @param Config $config
8383
* @param string $saveHandler
84-
* @return array
84+
* @return Config
8585
*/
86-
private static function migrateConfig(array $config, $saveHandler)
86+
private static function migrateConfig(Config $config, $saveHandler)
8787
{
8888
switch ($saveHandler) {
8989
case Profiler::SAVER_MONGODB:

‎tests/ConfigTest.php‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
namespace Xhgui\Profiler\Test;
4+
5+
use Xhgui\Profiler\Config;
6+
use Xhgui\Profiler\Profiler;
7+
8+
class ConfigTest extends TestCase
9+
{
10+
public function testDefaults()
11+
{
12+
$config = new Config();
13+
$this->assertEquals(Profiler::SAVER_STACK, $config['save.handler']);
14+
}
15+
}

‎tests/TestCase.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace Xhgui\Profiler\Test;
44

5+
use Xhgui\Profiler\Config;
56
use Xhgui\Profiler\Profilers\ProfilerInterface;
67
use Xhgui\Profiler\Saver\SaverInterface;
78
use Xhgui\Profiler\SaverFactory;
@@ -30,7 +31,7 @@ protected function runProfiler($flags = array(), $options = array())
3031

3132
protected function createSaver($saveHandler, array $config = array())
3233
{
33-
$saver = SaverFactory::create($saveHandler, $config);
34+
$saver = SaverFactory::create($saveHandler, new Config($config));
3435
$this->assertNotNull($saver);
3536

3637
return $saver;

0 commit comments

Comments
 (0)