Merge pull request #39 from hypervel/feature/facade-documents

facade documents

Author: albertcht

bin/generate-facade-docs.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+cp composer.json composer.json.bak
+cp composer.lock composer.lock.bak
+
+composer config repositories.facade-documenter vcs [email protected]:hypervel/facade-documenter.git
+composer require --dev hypervel/facade-documenter:dev-main
+find src/support/src/Facades -type f -name '*.php' -printf '%f\n' | sort | grep -v Facade | sed -E 's/(.+)\.php/Hypervel\\\\Support\\\\Facades\\\\\1/' | xargs php -f vendor/bin/facade.php
+
+mv composer.json.bak composer.json
+mv composer.lock.bak composer.lock
+composer install

src/console/src/Scheduling/Schedule.php

@@ -27,7 +27,7 @@
 use RuntimeException;
 
 /**
- * @mixin PendingEventAttributes
+ * @mixin \Hypervel\Console\Scheduling\PendingEventAttributes
  */
 class Schedule
 {

src/support/src/Facades/App.php

@@ -15,6 +15,7 @@
  * @method static string basePath(string $path = '')
  * @method static string resourcePath(string $path = '')
  * @method static string viewPath(string $path = '')
+ * @method static string storagePath(string $path = '')
  * @method static string joinPaths(string $basePath, string $path = '')
  * @method static string|bool environment(array|string ...$environments)
  * @method static bool isLocal()
@@ -28,6 +29,8 @@
  * @method static \Hypervel\Support\ServiceProvider resolveProvider(string $provider)
  * @method static bool isBooted()
  * @method static void boot()
+ * @method static void booting(callable $callback)
+ * @method static void booted(callable $callback)
  * @method static void abort(int $code, string $message = '', array $headers = [])
  * @method static array getLoadedProviders()
  * @method static bool providerIsLoaded(string $provider)

src/support/src/Facades/Auth.php

@@ -16,6 +16,7 @@
  * @method static string getDefaultDriver()
  * @method static void shouldUse(string|null $name)
  * @method static void setDefaultDriver(string $name)
+ * @method static \Hypervel\Auth\AuthManager viaRequest(string $driver, callable $callback)
  * @method static \Closure userResolver()
  * @method static \Hypervel\Auth\AuthManager resolveUsersUsing(\Closure $userResolver)
  * @method static array getGuards()

src/support/src/Facades/File.php

@@ -7,6 +7,7 @@
 use Hypervel\Filesystem\Filesystem;
 
 /**
+ * @method static void ensureDirectoryExists(string $path, int $mode = 0755, bool $recursive = true)
  * @method static bool exists(string $path)
  * @method static string get(string $path, bool $lock = false)
  * @method static string sharedGet(string $path)

src/support/src/Facades/Http.php

@@ -34,7 +34,6 @@
  * @method static \Hypervel\HttpClient\Factory registerConnection(string $name, array $config = [])
  * @method static \GuzzleHttp\ClientInterface getClient(string|null $connection, \GuzzleHttp\HandlerStack $handlerStack, array|null $config = null)
  * @method static \GuzzleHttp\ClientInterface createClient(\GuzzleHttp\HandlerStack $handlerStack)
- * @method static array getConfig(string $name)
  * @method static array getConnectionConfigs()
  * @method static array getConnectionConfig(string $name)
  * @method static \Hypervel\HttpClient\Factory setConnectionConfig(string $name, array $config)

src/support/src/Facades/Process.php

@@ -16,16 +16,15 @@
  * @method static \Hypervel\Process\PendingProcess idleTimeout(int $timeout)
  * @method static \Hypervel\Process\PendingProcess forever()
  * @method static \Hypervel\Process\PendingProcess env(array $environment)
- * @method static \Hypervel\Process\PendingProcess input(\Traversable|resource|string|int|float|bool|null $input)
+ * @method static \Hypervel\Process\PendingProcess input(null|bool|float|int|resource|string|\Traversable $input)
  * @method static \Hypervel\Process\PendingProcess quietly()
  * @method static \Hypervel\Process\PendingProcess tty(bool $tty = true)
  * @method static \Hypervel\Process\PendingProcess options(array $options)
  * @method static \Hypervel\Process\Contracts\ProcessResult run(array|string|null $command = null, callable|null $output = null)
- * @method static \Hypervel\Process\InvokedProcess start(array|string|null $command = null, callable|null $output = null)
- * @method static bool supportsTty()
+ * @method static \Hypervel\Process\Contracts\InvokedProcess start(array|string|null $command = null, callable|null $output = null)
  * @method static \Hypervel\Process\PendingProcess withFakeHandlers(array $fakeHandlers)
- * @method static \Hypervel\Process\PendingProcess|mixed when(\Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)
- * @method static \Hypervel\Process\PendingProcess|mixed unless(\Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)
+ * @method static \Hypervel\Process\PendingProcess|mixed when(null|\Closure|mixed $value = null, null|callable $callback = null, null|callable $default = null, null|\Closure|mixed $value = null)
+ * @method static \Hypervel\Process\PendingProcess|mixed unless(null|\Closure|mixed $value = null, null|callable $callback = null, null|callable $default = null, null|\Closure|mixed $value = null)
  * @method static \Hypervel\Process\FakeProcessResult result(array|string $output = '', array|string $errorOutput = '', int $exitCode = 0)
  * @method static \Hypervel\Process\FakeProcessDescription describe()
  * @method static \Hypervel\Process\FakeProcessSequence sequence(array $processes = [])
@@ -43,11 +42,10 @@
  * @method static \Hypervel\Process\Contracts\ProcessResult pipe(callable|array $callback, callable|null $output = null)
  * @method static \Hypervel\Process\ProcessPoolResults concurrently(callable $callback, callable|null $output = null)
  * @method static \Hypervel\Process\PendingProcess newPendingProcess()
- * @method static void macro(string $name, object|callable $macro)
+ * @method static mixed macroCall(string $method, array $parameters)
+ * @method static void macro(string $name, callable|object $macro)
  * @method static void mixin(object $mixin, bool $replace = true)
  * @method static bool hasMacro(string $name)
- * @method static void flushMacros()
- * @method static mixed macroCall(string $method, array $parameters)
  *
  * @see \Hypervel\Process\PendingProcess
  * @see \Hypervel\Process\Factory

src/support/src/Facades/Queue.php

@@ -48,7 +48,7 @@
  * @method static mixed getJobExpiration(mixed $job)
  * @method static void createPayloadUsing(callable|null $callback)
  * @method static \Psr\Container\ContainerInterface getContainer()
- * @method static void setContainer(\Psr\Container\ContainerInterface $container)
+ * @method static \Hypervel\Queue\Queue setContainer(\Psr\Container\ContainerInterface $container)
  * @method static \Hypervel\Support\Testing\Fakes\QueueFake except(array|string $jobsToBeQueued)
  * @method static void assertPushed(\Closure|string $job, callable|int|null $callback = null)
  * @method static void assertPushedOn(string|null $queue, \Closure|string $job, callable|null $callback = null)