Skip to content

Commit 9d2bc8d

Browse files
barryvdhbarryvdh
committed
Merge pull request php-debugbar#251 from Pachonk/master
PHPDoc Fixes
2 parents 4c0b624 + 488cca2 commit 9d2bc8d

24 files changed

+303
-10
lines changed

‎src/DebugBar/Bridge/CacheCacheCollector.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ class CacheCacheCollector extends MonologCollector
3131
{
3232
protected $logger;
3333

34+
/**
35+
* CacheCacheCollector constructor.
36+
* @param Cache|null $cache
37+
* @param Logger|null $logger
38+
* @param bool $level
39+
* @param bool $bubble
40+
*/
3441
public function __construct(Cache $cache = null, Logger $logger = null, $level = Logger::DEBUG, $bubble = true)
3542
{
3643
parent::__construct(null, $level, $bubble);
@@ -45,6 +52,9 @@ public function __construct(Cache $cache = null, Logger $logger = null, $level =
4552
}
4653
}
4754

55+
/**
56+
* @param Cache $cache
57+
*/
4858
public function addCache(Cache $cache)
4959
{
5060
$backend = $cache->getBackend();
@@ -55,6 +65,9 @@ public function addCache(Cache $cache)
5565
$this->addLogger($backend->getLogger());
5666
}
5767

68+
/**
69+
* @return string
70+
*/
5871
public function getName()
5972
{
6073
return 'cache';

‎src/DebugBar/Bridge/DoctrineCollector.php

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ class DoctrineCollector extends DataCollector implements Renderable, AssetProvid
3434
{
3535
protected $debugStack;
3636

37+
/**
38+
* DoctrineCollector constructor.
39+
* @param $debugStackOrEntityManager
40+
* @throws DebugBarException
41+
*/
3742
public function __construct($debugStackOrEntityManager)
3843
{
3944
if ($debugStackOrEntityManager instanceof EntityManager) {
@@ -45,6 +50,9 @@ public function __construct($debugStackOrEntityManager)
4550
$this->debugStack = $debugStackOrEntityManager;
4651
}
4752

53+
/**
54+
* @return array
55+
*/
4856
public function collect()
4957
{
5058
$queries = array();
@@ -67,11 +75,17 @@ public function collect()
6775
);
6876
}
6977

78+
/**
79+
* @return string
80+
*/
7081
public function getName()
7182
{
7283
return 'doctrine';
7384
}
7485

86+
/**
87+
* @return array
88+
*/
7589
public function getWidgets()
7690
{
7791
return array(
@@ -88,6 +102,9 @@ public function getWidgets()
88102
);
89103
}
90104

105+
/**
106+
* @return array
107+
*/
91108
public function getAssets()
92109
{
93110
return array(

‎src/DebugBar/Bridge/MonologCollector.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ public function addLogger(Logger $logger)
5656
$logger->pushHandler($this);
5757
}
5858

59+
/**
60+
* @param array $record
61+
*/
5962
protected function write(array $record)
6063
{
6164
$this->records[] = array(
@@ -66,11 +69,17 @@ protected function write(array $record)
6669
);
6770
}
6871

72+
/**
73+
* @return array
74+
*/
6975
public function getMessages()
7076
{
7177
return $this->records;
7278
}
7379

80+
/**
81+
* @return array
82+
*/
7483
public function collect()
7584
{
7685
return array(
@@ -79,11 +88,17 @@ public function collect()
7988
);
8089
}
8190

91+
/**
92+
* @return string
93+
*/
8294
public function getName()
8395
{
8496
return $this->name;
8597
}
8698

99+
/**
100+
* @return array
101+
*/
87102
public function getWidgets()
88103
{
89104
$name = $this->getName();

‎src/DebugBar/DataCollector/AggregatedCollector.php

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,9 @@ public function getSort()
100100
return $this->sort;
101101
}
102102

103+
/**
104+
* @return array
105+
*/
103106
public function collect()
104107
{
105108
$aggregate = array();
@@ -136,6 +139,9 @@ protected function sort($data)
136139
return $data;
137140
}
138141

142+
/**
143+
* @return string
144+
*/
139145
public function getName()
140146
{
141147
return $this->name;
@@ -144,21 +150,38 @@ public function getName()
144150
// --------------------------------------------
145151
// ArrayAccess implementation
146152

153+
/**
154+
* @param mixed $key
155+
* @param mixed $value
156+
* @throws DebugBarException
157+
*/
147158
public function offsetSet($key, $value)
148159
{
149160
throw new DebugBarException("AggregatedCollector[] is read-only");
150161
}
151162

163+
/**
164+
* @param mixed $key
165+
* @return mixed
166+
*/
152167
public function offsetGet($key)
153168
{
154169
return $this->collectors[$key];
155170
}
156171

172+
/**
173+
* @param mixed $key
174+
* @return bool
175+
*/
157176
public function offsetExists($key)
158177
{
159178
return isset($this->collectors[$key]);
160179
}
161180

181+
/**
182+
* @param mixed $key
183+
* @throws DebugBarException
184+
*/
162185
public function offsetUnset($key)
163186
{
164187
throw new DebugBarException("AggregatedCollector[] is read-only");

‎src/DebugBar/DataCollector/ConfigCollector.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ public function setData(array $data)
3939
$this->data = $data;
4040
}
4141

42+
/**
43+
* @return array
44+
*/
4245
public function collect()
4346
{
4447
$data = array();
@@ -51,11 +54,17 @@ public function collect()
5154
return $data;
5255
}
5356

57+
/**
58+
* @return string
59+
*/
5460
public function getName()
5561
{
5662
return $this->name;
5763
}
5864

65+
/**
66+
* @return array
67+
*/
5968
public function getWidgets()
6069
{
6170
$name = $this->getName();

‎src/DebugBar/DataCollector/DataCollector.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,17 @@ public static function getDefaultDataFormatter()
4949
* Sets the data formater instance used by this collector
5050
*
5151
* @param DataFormatterInterface $formater
52+
* @return $this
5253
*/
5354
public function setDataFormatter(DataFormatterInterface $formater)
5455
{
5556
$this->dataFormater = $formater;
5657
return $this;
5758
}
5859

60+
/**
61+
* @return DataFormatterInterface
62+
*/
5963
public function getDataFormatter()
6064
{
6165
if ($this->dataFormater === null) {

‎src/DebugBar/DataCollector/ExceptionsCollector.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,17 @@ public function formatExceptionData(Exception $e)
8888
);
8989
}
9090

91+
/**
92+
* @return string
93+
*/
9194
public function getName()
9295
{
9396
return 'exceptions';
9497
}
9598

99+
/**
100+
* @return array
101+
*/
96102
public function getWidgets()
97103
{
98104
return array(

‎src/DebugBar/DataCollector/LocalizationCollector.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ public function getDomain()
3535
return textdomain();
3636
}
3737

38+
/**
39+
* @return array
40+
*/
3841
public function collect()
3942
{
4043
return array(
@@ -43,11 +46,17 @@ public function collect()
4346
);
4447
}
4548

49+
/**
50+
* @return string
51+
*/
4652
public function getName()
4753
{
4854
return 'localization';
4955
}
5056

57+
/**
58+
* @return array
59+
*/
5160
public function getWidgets()
5261
{
5362
return array(

‎src/DebugBar/DataCollector/MemoryCollector.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ public function updatePeakUsage()
3535
$this->peakUsage = memory_get_peak_usage(true);
3636
}
3737

38+
/**
39+
* @return array
40+
*/
3841
public function collect()
3942
{
4043
$this->updatePeakUsage();
@@ -44,11 +47,17 @@ public function collect()
4447
);
4548
}
4649

50+
/**
51+
* @return string
52+
*/
4753
public function getName()
4854
{
4955
return 'memory';
5056
}
5157

58+
/**
59+
* @return array
60+
*/
5261
public function getWidgets()
5362
{
5463
return array(

‎src/DebugBar/DataCollector/MessagesCollector.php

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,17 @@ public function __construct($name = 'messages')
3838
* Sets the data formater instance used by this collector
3939
*
4040
* @param DataFormatterInterface $formater
41+
* @return $this
4142
*/
4243
public function setDataFormatter(DataFormatterInterface $formater)
4344
{
4445
$this->dataFormater = $formater;
4546
return $this;
4647
}
4748

49+
/**
50+
* @return DataFormatterInterface
51+
*/
4852
public function getDataFormatter()
4953
{
5054
if ($this->dataFormater === null) {
@@ -85,6 +89,9 @@ public function aggregate(MessagesAggregateInterface $messages)
8589
$this->aggregates[] = $messages;
8690
}
8791

92+
/**
93+
* @return array
94+
*/
8895
public function getMessages()
8996
{
9097
$messages = $this->messages;
@@ -107,6 +114,11 @@ public function getMessages()
107114
return $messages;
108115
}
109116

117+
/**
118+
* @param $level
119+
* @param $message
120+
* @param array $context
121+
*/
110122
public function log($level, $message, array $context = array())
111123
{
112124
$this->addMessage($message, $level);
@@ -120,6 +132,9 @@ public function clear()
120132
$this->messages = array();
121133
}
122134

135+
/**
136+
* @return array
137+
*/
123138
public function collect()
124139
{
125140
$messages = $this->getMessages();
@@ -129,11 +144,17 @@ public function collect()
129144
);
130145
}
131146

147+
/**
148+
* @return string
149+
*/
132150
public function getName()
133151
{
134152
return $this->name;
135153
}
136154

155+
/**
156+
* @return array
157+
*/
137158
public function getWidgets()
138159
{
139160
$name = $this->getName();

0 commit comments

Comments
 (0)