feature #20266 [Console] rename Command::private to Command::hidden (xabbuh)

fabpot · fabpot · commit 923aaad7dbc8 · 2016-10-21T14:28:04.000-07:00
This PR was merged into the 3.2-dev branch. Discussion ---------- [Console] rename Command::private to Command::hidden | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20029 | License | MIT | Doc PR | Commits ------- f900ef0 rename Command::private to Command::hidden
diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -34,7 +34,7 @@ class Command
     private $processTitle;
     private $aliases = array();
     private $definition;
-    private $public = true;
+    private $hidden = false;
     private $help;
     private $description;
     private $ignoreValidationErrors = false;
@@ -448,23 +448,23 @@ public function getName()
     }
 
     /**
-     * @param bool $public Whether the command should be publicly shown or not.
+     * @param bool $hidden Whether or not the command should be hidden from the list of commands
      * 
      * @return Command The current instance
      */
-    public function setPublic($public)
+    public function setHidden($hidden)
     {
-        $this->public = (bool) $public;
+        $this->hidden = (bool) $hidden;
 
         return $this;
     }
 
     /**
      * @return bool Whether the command should be publicly shown or not.
      */
-    public function isPublic()
+    public function isHidden()
     {
-        return $this->public;
+        return $this->hidden;
     }
 
     /**
diff --git a/src/Symfony/Component/Console/Descriptor/ApplicationDescription.php b/src/Symfony/Component/Console/Descriptor/ApplicationDescription.php
@@ -112,7 +112,7 @@ private function inspectApplication()
 
             /** @var Command $command */
             foreach ($commands as $name => $command) {
-                if (!$command->getName() || !$command->isPublic()) {
+                if (!$command->getName() || $command->isHidden()) {
                     continue;
                 }
 
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/DescriptorCommand3.php b/src/Symfony/Component/Console/Tests/Fixtures/DescriptorCommand3.php
@@ -21,7 +21,7 @@ protected function configure()
             ->setName('descriptor:command3')
             ->setDescription('command 3 description')
             ->setHelp('command 3 help')
-            ->setPublic(false)
+            ->setHidden(true)
         ;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ class Command`
`34`	`34`	`private $processTitle;`
`35`	`35`	`private $aliases = array();`
`36`	`36`	`private $definition;`
`37`		`- private $public = true;`
	`37`	`+ private $hidden = false;`
`38`	`38`	`private $help;`
`39`	`39`	`private $description;`
`40`	`40`	`private $ignoreValidationErrors = false;`
`@@ -448,23 +448,23 @@ public function getName()`
`448`	`448`	`}`
`449`	`449`
`450`	`450`	`/**`
`451`		`- * @param bool $public Whether the command should be publicly shown or not.`
	`451`	`+ * @param bool $hidden Whether or not the command should be hidden from the list of commands`
`452`	`452`	`*`
`453`	`453`	`* @return Command The current instance`
`454`	`454`	`*/`
`455`		`- public function setPublic($public)`
	`455`	`+ public function setHidden($hidden)`
`456`	`456`	`{`
`457`		`- $this->public = (bool) $public;`
	`457`	`+ $this->hidden = (bool) $hidden;`
`458`	`458`
`459`	`459`	`return $this;`
`460`	`460`	`}`
`461`	`461`
`462`	`462`	`/**`
`463`	`463`	`* @return bool Whether the command should be publicly shown or not.`
`464`	`464`	`*/`
`465`		`- public function isPublic()`
	`465`	`+ public function isHidden()`
`466`	`466`	`{`
`467`		`- return $this->public;`
	`467`	`+ return $this->hidden;`
`468`	`468`	`}`
`469`	`469`
`470`	`470`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ private function inspectApplication()`
`112`	`112`
`113`	`113`	`/** @var Command $command */`
`114`	`114`	`foreach ($commands as $name => $command) {`
`115`		`- if (!$command->getName() \|\| !$command->isPublic()) {`
	`115`	`+ if (!$command->getName() \|\| $command->isHidden()) {`
`116`	`116`	`continue;`
`117`	`117`	`}`
`118`	`118`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ protected function configure()`
`21`	`21`	`->setName('descriptor:command3')`
`22`	`22`	`->setDescription('command 3 description')`
`23`	`23`	`->setHelp('command 3 help')`
`24`		`- ->setPublic(false)`
	`24`	`+ ->setHidden(true)`
`25`	`25`	`;`
`26`	`26`	`}`
`27`	`27`	`}`