Skip to content

Commit 149a696

Browse files
smegheadsmeghead
committed
feat: add --hide-private option. #67
add `--hide-private`, `--hide-private-properties`, `--hide-private-methods` options.
1 parent eace33a commit 149a696

File tree

8 files changed

+263
-2
lines changed

8 files changed

+263
-2
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# CHANGELOG
22

3+
### Features
4+
5+
* add `--hide-private`, `--hide-private-properties`, `--hide-private-methods` option. #67
6+
37
### Bug fix
48

59
* Improve Main class #68 by @Chemaclass

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ OPTIONS
7373
--disable-class-methods not describe methods in class diagram.
7474
--enable-class-name-summary describe classname with Class summary of document comment. (default)
7575
--disable-class-name-summary describe classname without Class summary of document comment.
76+
--hide-private hide private properties and methods.
77+
--hide-private-properties hide private properties.
78+
--hide-private-methods hide private methods.
7679
--svg-topurl specifies the top URL when displaying the class as a link when outputting in SVG format.
7780
--php5 parse php source file as php5.
7881
--php7 parse php source file as php7.

‎bin/php-class-diagram‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ $options = getopt('hv', [
3030
'disable-class-methods',
3131
'enable-class-name-summary',
3232
'disable-class-name-summary',
33+
'hide-private',
34+
'hide-private-properties',
35+
'hide-private-methods',
3336
'svg-topurl::',
3437
'php7',
3538
'php8',
@@ -57,6 +60,9 @@ OPTIONS
5760
--disable-class-methods not describe methods in class diagram.
5861
--enable-class-name-summary describe classname with Class summary of document comment. (default)
5962
--disable-class-name-summary describe classname without Class summary of document comment.
63+
--hide-private hide private properties and methods.
64+
--hide-private-properties hide private properties.
65+
--hide-private-methods hide private methods.
6066
--svg-topurl Specifies the top URL when displaying the class as a link when outputting in SVG format.
6167
--php5 parse php source file as php5.
6268
--php7 parse php source file as php7.

‎src/Config/Options.php‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,4 +163,26 @@ public function svgTopurl(): string
163163
}
164164
return $this->opt['svg-topurl'];
165165
}
166+
167+
public function hidePrivateProperties(): bool
168+
{
169+
if (isset($this->opt['hide-private-properties'])) {
170+
return true;
171+
}
172+
if (isset($this->opt['hide-private'])) {
173+
return true;
174+
}
175+
return false;
176+
}
177+
178+
public function hidePrivateMethods(): bool
179+
{
180+
if (isset($this->opt['hide-private-methods'])) {
181+
return true;
182+
}
183+
if (isset($this->opt['hide-private'])) {
184+
return true;
185+
}
186+
return false;
187+
}
166188
}

‎src/DiagramElement/Entry.php‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,17 @@ public function dump(int $level = 0): array
6363
$lines[] = sprintf('%s%s {', $indent, $classIdentifier);
6464
if ($this->options->classProperties()) {
6565
foreach ($this->class->getProperties() as $p) {
66+
if ($this->options->hidePrivateProperties() && $p->getAccessModifier()->isPublic() === false) {
67+
continue;
68+
}
6669
$lines[] = sprintf(' %s%s%s : %s', $indent, $this->modifier($p->getAccessModifier()), $p->getName(), $p->getType()->getName());
6770
}
6871
}
6972
if ($this->options->classMethods()) {
7073
foreach ($this->class->getMethods() as $m) {
74+
if ($this->options->hidePrivateMethods() && $m->getAccessModifier()->isPublic() === false) {
75+
continue;
76+
}
7177
$params = array_map(function (PhpMethodParameter $x) {
7278
return $x->getName();
7379
}, $m->getParams());
@@ -189,6 +195,7 @@ private function getLinkExpression(string $meta): string
189195
' [[%s %s %s]]',
190196
$path,
191197
$this->class->getClassType()->getName(),
192-
ucfirst($meta));
198+
ucfirst($meta)
199+
);
193200
}
194201
}

‎test/HidePrivateTest.php‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use PHPUnit\Framework\TestCase;
6+
7+
use Smeghead\PhpClassDiagram\Config\Options;
8+
use Smeghead\PhpClassDiagram\DiagramElement\{
9+
Relation,
10+
Entry,
11+
};
12+
use Smeghead\PhpClassDiagram\Php\PhpReader;
13+
14+
final class HidePrivateTest extends TestCase
15+
{
16+
private string $fixtureDir;
17+
18+
public function setUp(): void
19+
{
20+
$this->fixtureDir = sprintf('%s/fixtures', __DIR__);
21+
}
22+
23+
public function testDefault(): void
24+
{
25+
$directory = sprintf('%s/hide-private', $this->fixtureDir);
26+
$options = new Options([
27+
]);
28+
$files = [
29+
'product/Product.php',
30+
];
31+
$entries = [];
32+
foreach ($files as $f) {
33+
$filename = sprintf('%s/hide-private/%s', $this->fixtureDir, $f);
34+
$classes = PhpReader::parseFile($directory, $filename, $options);
35+
$entries[] = array_map(fn($c) => new Entry(dirname($f), $c->getInfo(), $options), $classes);
36+
}
37+
$rel = new Relation(array_merge(...$entries), $options);
38+
39+
$expected = <<<EOS
40+
@startuml class-diagram
41+
package product as product {
42+
class "Product" as product_Product {
43+
+name : string
44+
-memo : string
45+
+publicFunction(param1)
46+
-privateFunction(param1)
47+
}
48+
}
49+
@enduml
50+
EOS;
51+
$this->assertSame($expected, implode(PHP_EOL, $rel->dump()), 'output PlantUML script.');
52+
}
53+
54+
public function testHidePrivate(): void
55+
{
56+
$directory = sprintf('%s/hide-private', $this->fixtureDir);
57+
$options = new Options([
58+
'hide-private' => true,
59+
]);
60+
$files = [
61+
'product/Product.php',
62+
];
63+
$entries = [];
64+
foreach ($files as $f) {
65+
$filename = sprintf('%s/hide-private/%s', $this->fixtureDir, $f);
66+
$classes = PhpReader::parseFile($directory, $filename, $options);
67+
$entries[] = array_map(fn($c) => new Entry(dirname($f), $c->getInfo(), $options), $classes);
68+
}
69+
$rel = new Relation(array_merge(...$entries), $options);
70+
71+
$expected = <<<EOS
72+
@startuml class-diagram
73+
package product as product {
74+
class "Product" as product_Product {
75+
+name : string
76+
+publicFunction(param1)
77+
}
78+
}
79+
@enduml
80+
EOS;
81+
$this->assertSame($expected, implode(PHP_EOL, $rel->dump()), 'output PlantUML script.');
82+
}
83+
84+
public function testHidePrivateProperties(): void
85+
{
86+
$directory = sprintf('%s/hide-private', $this->fixtureDir);
87+
$options = new Options([
88+
'hide-private-properties' => true,
89+
]);
90+
$files = [
91+
'product/Product.php',
92+
];
93+
$entries = [];
94+
foreach ($files as $f) {
95+
$filename = sprintf('%s/hide-private/%s', $this->fixtureDir, $f);
96+
$classes = PhpReader::parseFile($directory, $filename, $options);
97+
$entries[] = array_map(fn($c) => new Entry(dirname($f), $c->getInfo(), $options), $classes);
98+
}
99+
$rel = new Relation(array_merge(...$entries), $options);
100+
101+
$expected = <<<EOS
102+
@startuml class-diagram
103+
package product as product {
104+
class "Product" as product_Product {
105+
+name : string
106+
+publicFunction(param1)
107+
-privateFunction(param1)
108+
}
109+
}
110+
@enduml
111+
EOS;
112+
$this->assertSame($expected, implode(PHP_EOL, $rel->dump()), 'output PlantUML script.');
113+
}
114+
115+
public function testHidePrivateMethods(): void
116+
{
117+
$directory = sprintf('%s/hide-private', $this->fixtureDir);
118+
$options = new Options([
119+
'hide-private-methods' => true,
120+
]);
121+
$files = [
122+
'product/Product.php',
123+
];
124+
$entries = [];
125+
foreach ($files as $f) {
126+
$filename = sprintf('%s/hide-private/%s', $this->fixtureDir, $f);
127+
$classes = PhpReader::parseFile($directory, $filename, $options);
128+
$entries[] = array_map(fn($c) => new Entry(dirname($f), $c->getInfo(), $options), $classes);
129+
}
130+
$rel = new Relation(array_merge(...$entries), $options);
131+
132+
$expected = <<<EOS
133+
@startuml class-diagram
134+
package product as product {
135+
class "Product" as product_Product {
136+
+name : string
137+
-memo : string
138+
+publicFunction(param1)
139+
}
140+
}
141+
@enduml
142+
EOS;
143+
$this->assertSame($expected, implode(PHP_EOL, $rel->dump()), 'output PlantUML script.');
144+
}
145+
}

0 commit comments

Comments
 (0)