Merge pull request #9 from phpsu/task/make-everything-internal

ChrisB9 · web-flow · commit 5834ca578cad · 2020-05-23T19:34:30.000+02:00
Marking the API internal, leaving only Expressions and ShellBuilder open
diff --git a/src/Collection/AbstractCollection.php b/src/Collection/AbstractCollection.php
@@ -7,6 +7,10 @@
 use PHPSu\ShellCommandBuilder\Exception\ShellBuilderException;
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 abstract class AbstractCollection implements ShellInterface
 {
     /** @var CollectionTuple|null */
diff --git a/src/Collection/CollectionTuple.php b/src/Collection/CollectionTuple.php
@@ -7,6 +7,10 @@
 use PHPSu\ShellCommandBuilder\Exception\ShellBuilderException;
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class CollectionTuple implements ShellInterface
 {
     /** @var string */
diff --git a/src/Collection/Pipeline.php b/src/Collection/Pipeline.php
@@ -9,6 +9,10 @@
 use PHPSu\ShellCommandBuilder\ShellCommand;
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class Pipeline extends AbstractCollection
 {
     /**
diff --git a/src/Collection/Redirection.php b/src/Collection/Redirection.php
@@ -8,6 +8,10 @@
 use PHPSu\ShellCommandBuilder\Exception\ShellBuilderException;
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class Redirection extends AbstractCollection
 {
     /**
diff --git a/src/Collection/ShellList.php b/src/Collection/ShellList.php
@@ -8,6 +8,10 @@
 use PHPSu\ShellCommandBuilder\Exception\ShellBuilderException;
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class ShellList extends AbstractCollection
 {
     /**
diff --git a/src/Conditional/BasicExpression.php b/src/Conditional/BasicExpression.php
@@ -7,6 +7,10 @@
 use PHPSu\ShellCommandBuilder\Definition\ConditionalOperator;
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 abstract class BasicExpression implements ShellInterface
 {
     /**
diff --git a/src/Literal/ShellArgument.php b/src/Literal/ShellArgument.php
@@ -7,6 +7,10 @@
 use PHPSu\ShellCommandBuilder\Exception\ShellBuilderException;
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class ShellArgument extends ShellWord
 {
     protected $isArgument = true;
diff --git a/src/Literal/ShellEnvironmentVariable.php b/src/Literal/ShellEnvironmentVariable.php
@@ -6,6 +6,10 @@
 
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class ShellEnvironmentVariable extends ShellWord
 {
     protected $isEnvironmentVariable = true;
diff --git a/src/Literal/ShellExecutable.php b/src/Literal/ShellExecutable.php
@@ -4,6 +4,10 @@
 
 namespace PHPSu\ShellCommandBuilder\Literal;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class ShellExecutable extends ShellWord
 {
     protected $isArgument = true;
diff --git a/src/Literal/ShellOption.php b/src/Literal/ShellOption.php
@@ -4,8 +4,13 @@
 
 namespace PHPSu\ShellCommandBuilder\Literal;
 
+use PHPSu\ShellCommandBuilder\Exception\ShellBuilderException;
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class ShellOption extends ShellWord
 {
     protected $isOption = true;
@@ -15,6 +20,7 @@ final class ShellOption extends ShellWord
      * ShellArgument constructor.
      * @param string $option
      * @param ShellInterface|string $value
+     * @throws ShellBuilderException
      */
     public function __construct(string $option, $value = '')
     {
diff --git a/src/Literal/ShellShortOption.php b/src/Literal/ShellShortOption.php
@@ -7,6 +7,10 @@
 use PHPSu\ShellCommandBuilder\Exception\ShellBuilderException;
 use PHPSu\ShellCommandBuilder\ShellInterface;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class ShellShortOption extends ShellWord
 {
     protected $isShortOption = true;
diff --git a/src/ShellCommand.php b/src/ShellCommand.php
@@ -12,6 +12,10 @@
 use PHPSu\ShellCommandBuilder\Literal\ShellShortOption;
 use PHPSu\ShellCommandBuilder\Literal\ShellWord;
 
+/**
+ * @internal
+ * @psalm-internal PHPSu\ShellCommandBuilder
+ */
 final class ShellCommand implements ShellInterface
 {
     /**

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,10 @@`
`6`	`6`
`7`	`7`	`use PHPSu\ShellCommandBuilder\ShellInterface;`
`8`	`8`
	`9`	`+/**`
	`10`	`+ * @internal`
	`11`	`+ * @psalm-internal PHPSu\ShellCommandBuilder`
	`12`	`+ */`
`9`	`13`	`final class ShellEnvironmentVariable extends ShellWord`
`10`	`14`	`{`
`11`	`15`	`protected $isEnvironmentVariable = true;`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,10 @@`
`4`	`4`
`5`	`5`	`namespace PHPSu\ShellCommandBuilder\Literal;`
`6`	`6`
	`7`	`+/**`
	`8`	`+ * @internal`
	`9`	`+ * @psalm-internal PHPSu\ShellCommandBuilder`
	`10`	`+ */`
`7`	`11`	`final class ShellExecutable extends ShellWord`
`8`	`12`	`{`
`9`	`13`	`protected $isArgument = true;`