Skip to content

Commit 191e6ca

Browse files
committed
Add more missing docblocks.
1 parent 4c9abd2 commit 191e6ca

File tree

108 files changed

+883
-116
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+883
-116
lines changed

config/phpcs.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,12 @@
2020
<rule ref="SlevomatCodingStandard.ControlStructures.DisallowYodaComparison">
2121
<severity>0</severity>
2222
</rule>
23+
<rule ref="SlevomatCodingStandard.Classes.UnusedPrivateElements">
24+
<severity>0</severity>
25+
</rule>
26+
27+
<rule ref="Spryker.Commenting.DocBlockReturnSelf">
28+
<severity>0</severity>
29+
</rule>
2330

2431
</ruleset>

src/Propel/Common/Config/ConfigurationManager.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ public function getConfigProperty($name)
116116
*/
117117
public function getConnectionParametersArray($section = 'runtime')
118118
{
119-
if (!in_array($section, ['runtime', 'generator'])) {
119+
if (!in_array($section, ['runtime', 'generator'], true)) {
120120
return null;
121121
}
122122

src/Propel/Common/Config/Loader/IniFileLoader.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,8 @@ private function parseKey($key, $value, array &$config)
154154

155155
if (!strlen($pieces[0]) || !strlen($pieces[1])) {
156156
throw new IniParseException(sprintf('Invalid key "%s"', $key));
157-
} elseif (!isset($config[$pieces[0]])) {
157+
}
158+
if (!isset($config[$pieces[0]])) {
158159
if ($pieces[0] === '0' && !empty($config)) {
159160
$config = [$pieces[0] => $config];
160161
} else {
@@ -168,7 +169,7 @@ private function parseKey($key, $value, array &$config)
168169
}
169170

170171
$this->parseKey($pieces[1], $value, $config[$pieces[0]]);
171-
} elseif (is_string($value) && in_array(strtolower($value), ['true', 'false'])) {
172+
} elseif (is_string($value) && in_array(strtolower($value), ['true', 'false'], true)) {
172173
$config[$key] = (strtolower($value) === 'true');
173174
} elseif ($value === (string)(int)$value) {
174175
$config[$key] = (int)$value;

src/Propel/Generator/Behavior/AggregateColumn/AggregateColumnBehavior.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@
2121
*/
2222
class AggregateColumnBehavior extends Behavior
2323
{
24-
// default parameters value
24+
/**
25+
* Default parameters value
26+
*
27+
* @var array
28+
*/
2529
protected $parameters = [
2630
'name' => null,
2731
'expression' => null,

src/Propel/Generator/Behavior/AggregateColumn/AggregateColumnRelationBehavior.php

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,20 @@
1919
*/
2020
class AggregateColumnRelationBehavior extends Behavior
2121
{
22-
// default parameters value
22+
/**
23+
* Default parameters value
24+
*
25+
* @var string[]
26+
*/
2327
protected $parameters = [
2428
'foreign_table' => '',
2529
'update_method' => '',
2630
'aggregate_name' => '',
2731
];
2832

33+
/**
34+
* @return bool
35+
*/
2936
public function allowMultiple()
3037
{
3138
return true;

src/Propel/Generator/Behavior/Archivable/ArchivableBehavior.php

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@
2121
*/
2222
class ArchivableBehavior extends Behavior
2323
{
24-
// default parameters value
24+
/**
25+
* Default parameters value
26+
*
27+
* @var array
28+
*/
2529
protected $parameters = [
2630
'archive_table' => '',
2731
'archive_phpname' => null,
@@ -38,8 +42,14 @@ class ArchivableBehavior extends Behavior
3842
*/
3943
protected $archiveTable;
4044

45+
/**
46+
* @var \Propel\Generator\Behavior\Archivable\ArchivableBehaviorObjectBuilderModifier|null
47+
*/
4148
protected $objectBuilderModifier;
4249

50+
/**
51+
* @var \Propel\Generator\Behavior\Archivable\ArchivableBehaviorQueryBuilderModifier|null
52+
*/
4353
protected $queryBuilderModifier;
4454

4555
/**

src/Propel/Generator/Behavior/AutoAddPk/AutoAddPkBehavior.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@
1919
*/
2020
class AutoAddPkBehavior extends Behavior
2121
{
22-
// default parameters value
22+
/**
23+
* Default parameters value
24+
*
25+
* @var string[]
26+
*/
2327
protected $parameters = [
2428
'name' => 'id',
2529
'autoIncrement' => 'true',

src/Propel/Generator/Behavior/ConcreteInheritance/ConcreteInheritanceBehavior.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@ class ConcreteInheritanceBehavior extends Behavior
3030
*/
3131
protected $builder;
3232

33-
// default parameters value
33+
/**
34+
* Default parameters value
35+
*
36+
* @var string[]
37+
*/
3438
protected $parameters = [
3539
'extends' => '',
3640
'descendant_column' => 'descendant_class',

src/Propel/Generator/Behavior/ConcreteInheritance/ConcreteInheritanceParentBehavior.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,11 @@ class ConcreteInheritanceParentBehavior extends Behavior
2626
*/
2727
protected $builder;
2828

29-
// default parameters value
29+
/**
30+
* Default parameters value
31+
*
32+
* @var string[]
33+
*/
3034
protected $parameters = [
3135
'descendant_column' => 'descendant_class',
3236
];

src/Propel/Generator/Behavior/Delegate/DelegateBehavior.php

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,18 @@ class DelegateBehavior extends Behavior
2828
public const ONE_TO_ONE = 1;
2929
public const MANY_TO_ONE = 2;
3030

31-
// default parameters value
31+
/**
32+
* Default parameters value
33+
*
34+
* @var string[]
35+
*/
3236
protected $parameters = [
3337
'to' => '',
3438
];
3539

40+
/**
41+
* @var int[]
42+
*/
3643
protected $delegates = [];
3744

3845
/**

0 commit comments

Comments
 (0)