Filestructure changes. Mark some classes as Internal

phpstreamserver · Sep 29, 2024 · fd42aea · fd42aea
1 parent 0fdc4dc
commit fd42aea
Show file tree

Hide file tree

Showing 81 changed files with 300 additions and 231 deletions.
diff --git a/src/Internal/ArrayContainer.php b/src/Internal/ArrayContainer.php
@@ -4,6 +4,9 @@
 
 namespace Luzrain\PHPStreamServer\Internal;
 
+/**
+ * @internal
+ */
 final class ArrayContainer implements Container
 {
     private array $container = [];

diff --git a/src/Console/App.php → src/Internal/Console/App.php b/src/Console/App.php → src/Internal/Console/App.php
@@ -2,11 +2,14 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\Console;
+namespace Luzrain\PHPStreamServer\Internal\Console;
 
 use Luzrain\PHPStreamServer\Internal\Functions;
 use Luzrain\PHPStreamServer\Server;
 
+/**
+ * @internal
+ */
 final class App
 {
     /**

diff --git a/src/Console/Colorizer.php → src/Internal/Console/Colorizer.php b/src/Console/Colorizer.php → src/Internal/Console/Colorizer.php
@@ -2,8 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\Console;
+namespace Luzrain\PHPStreamServer\Internal\Console;
 
+/**
+ * @internal
+ */
 final class Colorizer
 {
     /**

diff --git a/src/Console/Command.php → src/Internal/Console/Command.php b/src/Console/Command.php → src/Internal/Console/Command.php
@@ -2,10 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\Console;
+namespace Luzrain\PHPStreamServer\Internal\Console;
 
-use Luzrain\PHPStreamServer\Internal\MasterProcess;
+use Luzrain\PHPStreamServer\MasterProcess;
 
+/**
+ * @internal
+ */
 abstract class Command
 {
     protected const COMMAND = '';

diff --git a/src/Console/OptionDefinition.php → src/Internal/Console/OptionDefinition.php b/src/Console/OptionDefinition.php → src/Internal/Console/OptionDefinition.php
@@ -2,8 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\Console;
+namespace Luzrain\PHPStreamServer\Internal\Console;
 
+/**
+ * @internal
+ */
 final readonly class OptionDefinition
 {
     public function __construct(

diff --git a/src/Console/Options.php → src/Internal/Console/Options.php b/src/Console/Options.php → src/Internal/Console/Options.php
@@ -2,8 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\Console;
+namespace Luzrain\PHPStreamServer\Internal\Console;
 
+/**
+ * @internal
+ */
 final class Options
 {
     private array $parsedOptions;

diff --git a/src/Console/StdoutHandler.php → src/Internal/Console/StdoutHandler.php b/src/Console/StdoutHandler.php → src/Internal/Console/StdoutHandler.php
@@ -2,10 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\Console;
+namespace Luzrain\PHPStreamServer\Internal\Console;
 
 /**
  * Handler for redirect standard output to custom stream
+ * @internal
  */
 final class StdoutHandler
 {

diff --git a/src/Console/Table.php → src/Internal/Console/Table.php b/src/Console/Table.php → src/Internal/Console/Table.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\Console;
+namespace Luzrain\PHPStreamServer\Internal\Console;
 
 /**
  * @internal

diff --git a/src/Internal/Container.php b/src/Internal/Container.php
@@ -4,6 +4,9 @@
 
 namespace Luzrain\PHPStreamServer\Internal;
 
+/**
+ * @internal
+ */
 interface Container
 {
     public function set(string $id, mixed $value): void;

diff --git a/src/Internal/JsonSerializible.php b/src/Internal/JsonSerializible.php
diff --git a/src/Internal/Logger/Logger.php → src/Internal/Logger.php b/src/Internal/Logger/Logger.php → src/Internal/Logger.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\Internal\Logger;
+namespace Luzrain\PHPStreamServer\Internal;
 
 use Psr\Log\LoggerInterface;
 use Psr\Log\LoggerTrait;

diff --git a/src/Internal/MessageBus/Message.php b/src/Internal/MessageBus/Message.php
diff --git a/src/Internal/MessageBus/MessageBus.php b/src/Internal/MessageBus/MessageBus.php
@@ -5,7 +5,11 @@
 namespace Luzrain\PHPStreamServer\Internal\MessageBus;
 
 use Amp\Future;
+use Luzrain\PHPStreamServer\Message;
 
+/**
+ * @internal
+ */
 interface MessageBus
 {
     /**

diff --git a/src/Internal/MessageBus/MessageHandler.php b/src/Internal/MessageBus/MessageHandler.php
@@ -4,6 +4,11 @@
 
 namespace Luzrain\PHPStreamServer\Internal\MessageBus;
 
+use Luzrain\PHPStreamServer\Message;
+
+/**
+ * @internal
+ */
 interface MessageHandler
 {
     /**

diff --git a/src/Internal/MessageBus/SocketFileMessageBus.php b/src/Internal/MessageBus/SocketFileMessageBus.php
@@ -9,9 +9,13 @@
 use Amp\Socket\DnsSocketConnector;
 use Amp\Socket\SocketConnector;
 use Amp\Socket\StaticSocketConnector;
+use Luzrain\PHPStreamServer\Message;
 use function Amp\async;
 use function Amp\delay;
 
+/**
+ * @internal
+ */
 final class SocketFileMessageBus implements MessageBus
 {
     private SocketConnector $connector;

diff --git a/src/Internal/MessageBus/SocketFileMessageHandler.php b/src/Internal/MessageBus/SocketFileMessageHandler.php
@@ -8,9 +8,13 @@
 use Amp\Future;
 use Amp\Socket\ResourceServerSocket;
 use Amp\Socket\ResourceServerSocketFactory;
+use Luzrain\PHPStreamServer\Message;
 use Revolt\EventLoop;
 use function Amp\async;
 
+/**
+ * @internal
+ */
 final class SocketFileMessageHandler implements MessageHandler, MessageBus
 {
     private ResourceServerSocket $socket;

diff --git a/src/Internal/ProcessTrait.php b/src/Internal/ProcessTrait.php
@@ -6,14 +6,14 @@
 
 use Amp\Future;
 use Luzrain\PHPStreamServer\Exception\UserChangeException;
-use Luzrain\PHPStreamServer\Internal\MessageBus\Message;
+use Luzrain\PHPStreamServer\Message;
 use Luzrain\PHPStreamServer\ProcessInterface;
 use Psr\Log\LoggerInterface;
 use Revolt\EventLoop;
 
 /**
- * @internal
  * @psalm-require-implements ProcessInterface
+ * @internal
  */
 trait ProcessTrait
 {

diff --git a/...Strategy/ReloadStrategyAwareInterface.php → ...Strategy/ReloadStrategyAwareInterface.php b/...Strategy/ReloadStrategyAwareInterface.php → ...Strategy/ReloadStrategyAwareInterface.php
@@ -2,8 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\ReloadStrategy;
+namespace Luzrain\PHPStreamServer\Internal\ReloadStrategy;
 
+use Luzrain\PHPStreamServer\ReloadStrategy\ReloadStrategyInterface;
+
+/**
+ * @internal
+ */
 interface ReloadStrategyAwareInterface
 {
     /**

diff --git a/src/ReloadStrategy/ReloadStrategyTrigger.php → .../ReloadStrategy/ReloadStrategyTrigger.php b/src/ReloadStrategy/ReloadStrategyTrigger.php → .../ReloadStrategy/ReloadStrategyTrigger.php
@@ -2,10 +2,15 @@
 
 declare(strict_types=1);
 
-namespace Luzrain\PHPStreamServer\ReloadStrategy;
+namespace Luzrain\PHPStreamServer\Internal\ReloadStrategy;
 
+use Luzrain\PHPStreamServer\ReloadStrategy\ReloadStrategyInterface;
+use Luzrain\PHPStreamServer\ReloadStrategy\TimerReloadStrategyInterface;
 use Revolt\EventLoop;
 
+/**
+ * @internal
+ */
 final class ReloadStrategyTrigger
 {
     /** @var list<ReloadStrategyInterface> */
@@ -28,6 +33,9 @@ public function addReloadStrategy(ReloadStrategyInterface ...$reloadStrategies):
         }
     }
 
+    /**
+     * @param mixed $event any value that checked by reload strategies. Could be exception, request etc.
+     */
     public function emitEvent(mixed $event): void
     {
         foreach ($this->reloadStrategies as $reloadStrategy) {

diff --git a/src/Internal/SIGCHLDHandler.php b/src/Internal/SIGCHLDHandler.php
@@ -6,6 +6,9 @@
 
 use Revolt\EventLoop;
 
+/**
+ * @internal
+ */
 final class SIGCHLDHandler
 {
     private static bool $isRegistered = false;

diff --git a/src/Internal/Scheduler/Scheduler.php b/src/Internal/Scheduler/Scheduler.php
@@ -17,6 +17,9 @@
 use Revolt\EventLoop\Suspension;
 use function Amp\weakClosure;
 
+/**
+ * @internal
+ */
 final class Scheduler
 {
     private WorkerPool $pool;

diff --git a/src/Internal/Scheduler/Trigger/CronExpressionTrigger.php b/src/Internal/Scheduler/Trigger/CronExpressionTrigger.php
@@ -8,6 +8,7 @@
 
 /**
  * @psalm-suppress UndefinedClass
+ * @internal
  */
 final class CronExpressionTrigger implements TriggerInterface
 {
@@ -35,6 +36,10 @@ public function getNextRunDate(\DateTimeImmutable $now): \DateTimeImmutable|null
     {
         $next = $this->expression->getNextRunDate($now);
 
-        return $next instanceof \DateTime ? \DateTimeImmutable::createFromMutable($next) : $next;
+        if ($next instanceof \DateTime) {
+            $next = \DateTimeImmutable::createFromMutable($next);
+        }
+
+        return $next;
     }
 }
diff --git a/src/Internal/Scheduler/Trigger/DateTimeTrigger.php b/src/Internal/Scheduler/Trigger/DateTimeTrigger.php
@@ -4,6 +4,9 @@
 
 namespace Luzrain\PHPStreamServer\Internal\Scheduler\Trigger;
 
+/**
+ * @internal
+ */
 final class DateTimeTrigger implements TriggerInterface
 {
     private \DateTimeImmutable $date;

diff --git a/src/Internal/Scheduler/Trigger/JitterTrigger.php b/src/Internal/Scheduler/Trigger/JitterTrigger.php
@@ -4,6 +4,9 @@
 
 namespace Luzrain\PHPStreamServer\Internal\Scheduler\Trigger;
 
+/**
+ * @internal
+ */
 final class JitterTrigger implements TriggerInterface
 {
     public function __construct(private readonly TriggerInterface $trigger, private readonly int $jitter)

diff --git a/src/Internal/Scheduler/Trigger/PeriodicalTrigger.php b/src/Internal/Scheduler/Trigger/PeriodicalTrigger.php
@@ -4,6 +4,9 @@
 
 namespace Luzrain\PHPStreamServer\Internal\Scheduler\Trigger;
 
+/**
+ * @internal
+ */
 final class PeriodicalTrigger implements TriggerInterface
 {
     private \DateInterval $interval;

diff --git a/src/Internal/Scheduler/Trigger/TriggerFactory.php b/src/Internal/Scheduler/Trigger/TriggerFactory.php
@@ -4,6 +4,9 @@
 
 namespace Luzrain\PHPStreamServer\Internal\Scheduler\Trigger;
 
+/**
+ * @internal
+ */
 final class TriggerFactory
 {
     /**

diff --git a/src/Internal/Scheduler/Trigger/TriggerInterface.php b/src/Internal/Scheduler/Trigger/TriggerInterface.php
@@ -4,6 +4,9 @@
 
 namespace Luzrain\PHPStreamServer\Internal\Scheduler\Trigger;
 
+/**
+ * @internal
+ */
 interface TriggerInterface extends \Stringable
 {
     public function getNextRunDate(\DateTimeImmutable $now): \DateTimeImmutable|null;

diff --git a/src/Internal/Status.php b/src/Internal/Status.php
@@ -4,6 +4,9 @@
 
 namespace Luzrain\PHPStreamServer\Internal;
 
+/**
+ * @internal
+ */
 enum Status
 {
     case STARTING;

diff --git a/src/Internal/Supervisor/Supervisor.php b/src/Internal/Supervisor/Supervisor.php
@@ -7,13 +7,13 @@
 use Amp\DeferredFuture;
 use Amp\Future;
 use Luzrain\PHPStreamServer\Exception\PHPStreamServerException;
-use Luzrain\PHPStreamServer\Internal\MasterProcess;
-use Luzrain\PHPStreamServer\Internal\Message\ProcessBlockedEvent;
-use Luzrain\PHPStreamServer\Internal\Message\ProcessDetachedEvent;
-use Luzrain\PHPStreamServer\Internal\Message\ProcessHeartbeatEvent;
-use Luzrain\PHPStreamServer\Internal\Message\ProcessExitedEvent;
 use Luzrain\PHPStreamServer\Internal\SIGCHLDHandler;
 use Luzrain\PHPStreamServer\Internal\Status;
+use Luzrain\PHPStreamServer\MasterProcess;
+use Luzrain\PHPStreamServer\Message\ProcessBlockedEvent;
+use Luzrain\PHPStreamServer\Message\ProcessDetachedEvent;
+use Luzrain\PHPStreamServer\Message\ProcessExitedEvent;
+use Luzrain\PHPStreamServer\Message\ProcessHeartbeatEvent;
 use Luzrain\PHPStreamServer\WorkerProcessInterface;
 use Psr\Log\LoggerInterface;
 use Revolt\EventLoop;