diff --git a/src/Magnetar/Application.php b/src/Magnetar/Application.php index 50638c6..2cc11f5 100644 --- a/src/Magnetar/Application.php +++ b/src/Magnetar/Application.php @@ -506,7 +506,7 @@ protected function registerBaseServiceProviders(): void { * Register the container's core list of aliases * @return void * - * @see Magnetar\Helpers\Facades\Facade::defaultAliases() + * @see \Magnetar\Helpers\Facades\Facade::defaultAliases() */ public function registerCoreContainerAliases(): void { foreach([ diff --git a/src/Magnetar/Auth/AuthManager.php b/src/Magnetar/Auth/AuthManager.php index 446ffcc..9ccdb42 100644 --- a/src/Magnetar/Auth/AuthManager.php +++ b/src/Magnetar/Auth/AuthManager.php @@ -11,7 +11,7 @@ /** * Authentication manager * - * @see AuthenticationAdapter + * @see \Magnetar\Auth\AuthenticationAdapter */ class AuthManager { /** @@ -128,7 +128,7 @@ public function adapter(string $connection_name): AuthenticationAdapter { * @param array $args * @return mixed * - * @see AuthenticationAdapter + * @see \Magnetar\Auth\AuthenticationAdapter */ public function __call(string $method, array $args): mixed { return $this->connection()->$method(...$args); diff --git a/src/Magnetar/Cache/StoreManager.php b/src/Magnetar/Cache/StoreManager.php index 2e2824e..c12810a 100644 --- a/src/Magnetar/Cache/StoreManager.php +++ b/src/Magnetar/Cache/StoreManager.php @@ -20,9 +20,12 @@ class StoreManager { /** * Constructor - * @param Application $app The application instance */ public function __construct( + /** + * The application instance + * @var Application + */ protected Application $app ) { @@ -75,6 +78,8 @@ protected function makeConnection(string $driver_name): void { * @param string $method * @param array $args * @return mixed + * + * @see \Magnetar\Cache\AbstractCacheStore */ public function __call(string $method, array $args): mixed { return $this->connection()->$method(...$args); diff --git a/src/Magnetar/Database/ConnectionManager.php b/src/Magnetar/Database/ConnectionManager.php index c66e00c..8a7c921 100644 --- a/src/Magnetar/Database/ConnectionManager.php +++ b/src/Magnetar/Database/ConnectionManager.php @@ -127,7 +127,7 @@ public function adapter(string $connection_name): DatabaseAdapter { * @param array $args * @return mixed * - * @see DatabaseAdapter + * @see \Magnetar\Database\DatabaseAdapter */ public function __call(string $method, array $args): mixed { return $this->connection()->$method(...$args); diff --git a/src/Magnetar/Database/QueryBuilder.php b/src/Magnetar/Database/QueryBuilder.php index 9489b6b..ced633e 100644 --- a/src/Magnetar/Database/QueryBuilder.php +++ b/src/Magnetar/Database/QueryBuilder.php @@ -558,7 +558,7 @@ public function insert( * @example $db->insertIgnore( ['column' => 'value'] ); * @example $db->insertIgnore( [ ['column' => 'value'], ['column' => 'value2'] ] ); * - * @see insert() + * @see \Magnetar\Database\QueryBuilder */ public function insertIgnore(array $data): int { return $this->insert($data, true); diff --git a/src/Magnetar/Filesystem/Adapter/Adapter.php b/src/Magnetar/Filesystem/Adapter/Adapter.php deleted file mode 100644 index 6bdfcda..0000000 --- a/src/Magnetar/Filesystem/Adapter/Adapter.php +++ /dev/null @@ -1,42 +0,0 @@ -rootDir = $rootDir; - } - - /** - * Get the root directory - * @return string - */ - public function rootDir(): string { - return $this->rootDir; - } - - /** - * Convert a path relative to the root directory to a full path - * @param string $path Path relative to root directory - * @return string Full path - */ - public function path(string $path): string { - return $this->rootDir . ltrim($path, DIRECTORY_SEPARATOR); - } - } \ No newline at end of file diff --git a/src/Magnetar/Filesystem/Adapter/DiskAdapter.php b/src/Magnetar/Filesystem/Adapter/DiskAdapter.php deleted file mode 100644 index 55fada4..0000000 --- a/src/Magnetar/Filesystem/Adapter/DiskAdapter.php +++ /dev/null @@ -1,13 +0,0 @@ -connection()->$method(...$args); diff --git a/src/Magnetar/Helpers/Facades/App.php b/src/Magnetar/Helpers/Facades/App.php index da3f054..9e96bb9 100644 --- a/src/Magnetar/Helpers/Facades/App.php +++ b/src/Magnetar/Helpers/Facades/App.php @@ -90,7 +90,7 @@ * @method offsetSet(mixed $key, mixed $value): void * @method offsetUnset(mixed $key): void * - * @see Magnetar\Application + * @see \Magnetar\Application */ class App extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/Auth.php b/src/Magnetar/Helpers/Facades/Auth.php index 965d73a..1525557 100644 --- a/src/Magnetar/Helpers/Facades/Auth.php +++ b/src/Magnetar/Helpers/Facades/Auth.php @@ -10,8 +10,11 @@ * @method getDefaultConnectionName(): ?string * @method getConnected(): array * @method adapter(string $connection_name): Magnetar\Auth\AuthenticationAdapter + * @method getAdapterName(): string + * @method setModelClass(string $model_class): void * - * @see Magnetar\Auth\AuthManager + * @see \Magnetar\Auth\AuthManager + * @see \Magnetar\Auth\AuthenticationAdapter */ class Auth extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/Cache.php b/src/Magnetar/Helpers/Facades/Cache.php index 5cf6005..2d8a354 100644 --- a/src/Magnetar/Helpers/Facades/Cache.php +++ b/src/Magnetar/Helpers/Facades/Cache.php @@ -7,8 +7,19 @@ /** * @method connection(?string $driver_name=null): Magnetar\Cache\AbstractCacheStore + * @method clear(): void + * @method delete(string $key): bool + * @method get(string $key, mixed $callback=null, int $ttl=3600): mixed + * @method getMany(array $keys): array + * @method increment(string $key, int $step=1): int|false + * @method decrement(string $key, int $step=1): int|false + * @method has(string $key): bool + * @method hasMany(array $keys): array + * @method set(string $key, mixed $value, int|false $ttl=3600): mixed + * @method setMany(array $values, int|false $ttl=3600): void * - * @see Magnetar\Cache\StoreManager + * @see \Magnetar\Cache\StoreManager + * @see \Magnetar\Cache\AbstractCacheStore */ class Cache extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/Config.php b/src/Magnetar/Helpers/Facades/Config.php index 75404bd..a5d5c58 100644 --- a/src/Magnetar/Helpers/Facades/Config.php +++ b/src/Magnetar/Helpers/Facades/Config.php @@ -19,7 +19,7 @@ * @method offsetSet(mixed $key, mixed $value): void * @method offsetUnset(mixed $key): void * - * @see Magnetar\Config\Config + * @see \Magnetar\Config\Config */ class Config extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/DB.php b/src/Magnetar/Helpers/Facades/DB.php index 7da26a2..3c0ce33 100644 --- a/src/Magnetar/Helpers/Facades/DB.php +++ b/src/Magnetar/Helpers/Facades/DB.php @@ -10,8 +10,17 @@ * @method getDefaultConnectionName(): ?string * @method getConnected(): array * @method adapter(string $connection_name): Magnetar\Database\DatabaseAdapter + * @method getAdapterName(): string + * @method query(string $sql_query, array $params=[]): int|false + * @method get_rows(string $sql_query, array $params=[], string|false $column_key=false): array|false + * @method get_row(string $sql_query, array $params=[]): array|false + * @method get_col(string $sql_query, array $params=[], string|int $column_key=0): array|false + * @method get_col_assoc(string $sql_query, array $params=[], string|int $assoc_key=0, string|int $column_key=1): array|false + * @method get_var(string $sql_query, array $params=[], string|int|false $column_key=false): string|int|false + * @method table(string $table_name): Magnetar\Database\QueryBuilder * - * @see Magnetar\Database\ConnectionManager + * @see \Magnetar\Database\ConnectionManager + * @see \Magnetar\Database\DatabaseAdapter */ class DB extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/File.php b/src/Magnetar/Helpers/Facades/File.php index c8ed3e3..94df5f3 100644 --- a/src/Magnetar/Helpers/Facades/File.php +++ b/src/Magnetar/Helpers/Facades/File.php @@ -11,8 +11,32 @@ * @method getConnected(): array * @method adapter(string $name): Magnetar\Filesystem\DiskAdapter * @method drive(string $name): Magnetar\Filesystem\DiskAdapter + * @method path(string $rel_path=''): string + * @method write(string $path, string $contents, bool $overwrite=false): bool + * @method copy(string $source, string $destination, bool $overwrite=false): bool + * @method read(string $path): string|false + * @method exists(string $path): bool + * @method isFile(string $path): bool + * @method name(string $path): string + * @method basename(string $path): string + * @method extension(string $path): string + * @method size(string $path): int + * @method mimetype(string $path): string|false + * @method lastModified(string $path): string|false + * @method append(string $path, string $contents): bool + * @method prepend(string $path, string $contents): bool + * @method move(string $source, string $destination, bool $overwrite=false): bool + * @method delete(array|string $paths): bool + * @method directoryExists(string $path): bool + * @method isDirectory(string $path): bool + * @method makeDirectory(string $path, int $mode=511, bool $recursive=false): bool + * @method copyDirectory(string $source, string $destination, bool $overwrite=false): bool + * @method emptyDirectory(string $path): bool + * @method deleteDirectory(string $path): bool + * @method url(string $path): string * - * @see Magnetar\Filesystem\ConnectionManager + * @see \Magnetar\Filesystem\ConnectionManager + * @see \Magnetar\Filesystem\Disk\DiskAdapter */ class File extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/Log.php b/src/Magnetar/Helpers/Facades/Log.php index 43945ff..ed61957 100644 --- a/src/Magnetar/Helpers/Facades/Log.php +++ b/src/Magnetar/Helpers/Facades/Log.php @@ -10,7 +10,7 @@ * @method getLogs(int $minLevel=0): array * @method dump(int $minLevel=0, bool $return=false): mixed * - * @see Magnetar\Log\Logger + * @see \Magnetar\Log\Logger */ class Log extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/Queue.php b/src/Magnetar/Helpers/Facades/Queue.php index 7a4ec54..e24071f 100644 --- a/src/Magnetar/Helpers/Facades/Queue.php +++ b/src/Magnetar/Helpers/Facades/Queue.php @@ -10,8 +10,17 @@ * @method getDefaultConnectionName(): ?string * @method getConnected(): array * @method adapter(string $connection_name): Magnetar\Queue\QueueAdapter + * @method getApp(): Magnetar\Application + * @method getAdapterName(): string + * @method getConnectionName(): string + * @method getConnectionConfig(): array + * @method getConnection(): Magnetar\Queue\Connection + * @method makeMessage(mixed $body): Magnetar\Queue\Message + * @method channel(string $channelName): Magnetar\Queue\Channel + * @method publish(string $channel, mixed $message, string $exchange=''): bool * - * @see Magnetar\Queue\QueueManager + * @see \Magnetar\Queue\QueueManager + * @see \Magnetar\Queue\QueueAdapter */ class Queue extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/Request.php b/src/Magnetar/Helpers/Facades/Request.php index 601f639..26159c5 100644 --- a/src/Magnetar/Helpers/Facades/Request.php +++ b/src/Magnetar/Helpers/Facades/Request.php @@ -21,7 +21,7 @@ * @method file(string $input_name): Magnetar\Http\UploadedFile|array|null * @method files(): array * - * @see Magnetar\Http\Request + * @see \Magnetar\Http\Request */ class Request extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/Response.php b/src/Magnetar/Helpers/Facades/Response.php index e94e983..baff89a 100644 --- a/src/Magnetar/Helpers/Facades/Response.php +++ b/src/Magnetar/Helpers/Facades/Response.php @@ -24,7 +24,7 @@ * @method redirect(string $path, int $response_code=302): self * @method json(mixed $body): self * - * @see Magnetar\Http\Response + * @see \Magnetar\Http\Response */ class Response extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/Router.php b/src/Magnetar/Helpers/Facades/Router.php index c692084..39f1444 100644 --- a/src/Magnetar/Helpers/Facades/Router.php +++ b/src/Magnetar/Helpers/Facades/Router.php @@ -21,7 +21,7 @@ * @method redirect(string $pattern, string $redirect_path, int $response_code=302): Magnetar\Router\Route * @method permanentRedirect(string $pattern, string $redirect_path): Magnetar\Router\Route * - * @see Magnetar\Router\Router + * @see \Magnetar\Router\Router */ class Router extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/Theme.php b/src/Magnetar/Helpers/Facades/Theme.php index e57d3a0..f088fb1 100644 --- a/src/Magnetar/Helpers/Facades/Theme.php +++ b/src/Magnetar/Helpers/Facades/Theme.php @@ -8,8 +8,14 @@ /** * @method theme(?string $theme_name=null): Magnetar\Template\Template * @method tpl(string $tpl_name, array $view_data=[]): string + * @method getViewPath(string $tpl_name): string + * @method render(string $tpl_name, array $view_data=[]): string + * @method display(string $tpl_name): void + * @method renderResponse(string $tpl_name, array $view_data=[]): Magnetar\Http\Response + * @method getData(): array * - * @see Magnetar\Template\ThemeManager + * @see \Magnetar\Template\ThemeManager + * @see \Magnetar\Template\Template */ class Theme extends Facade { /** diff --git a/src/Magnetar/Helpers/Facades/URL.php b/src/Magnetar/Helpers/Facades/URL.php index f5f5b51..03c491f 100644 --- a/src/Magnetar/Helpers/Facades/URL.php +++ b/src/Magnetar/Helpers/Facades/URL.php @@ -9,7 +9,7 @@ * @method to(string $path, array $params=[]): string * @method from(string $url): Magnetar\Router\URLBuilder * - * @see Magnetar\Router\URLGenerator + * @see \Magnetar\Router\URLGenerator */ class URL extends Facade { /** diff --git a/src/Magnetar/Helpers/TypedEnumHelper.php b/src/Magnetar/Helpers/TypedEnumHelper.php index 541ea74..552ef0f 100644 --- a/src/Magnetar/Helpers/TypedEnumHelper.php +++ b/src/Magnetar/Helpers/TypedEnumHelper.php @@ -49,7 +49,7 @@ public static function getType(mixed $value, TypedEnum|null $default=null): Type * * @throws Exception If the type is unknown and no default value is provided * - * @see Magnetar\Helpers\Enums\TypedEnum + * @see \Magnetar\Helpers\Enums\TypedEnum */ public static function typeByName(string $named_type, mixed $default=null): TypedEnum { return match($named_type) { diff --git a/src/Magnetar/Please/Actions/Facades/UpdateFacadePHPDocs.php b/src/Magnetar/Please/Actions/Facades/UpdateFacadePHPDocs.php index 368f1b3..740bd0d 100644 --- a/src/Magnetar/Please/Actions/Facades/UpdateFacadePHPDocs.php +++ b/src/Magnetar/Please/Actions/Facades/UpdateFacadePHPDocs.php @@ -14,6 +14,8 @@ use Magnetar\Helpers\Facades\Log; + // @NOTE this is outdated, only here temporarily for reference + class UpdateFacadePHPDocs extends Actionable { /** * {@inheritDoc} diff --git a/src/Magnetar/Queue/QueueManager.php b/src/Magnetar/Queue/QueueManager.php index dd1f2a6..de1a1da 100644 --- a/src/Magnetar/Queue/QueueManager.php +++ b/src/Magnetar/Queue/QueueManager.php @@ -124,6 +124,8 @@ public function adapter(string $connection_name): QueueAdapter { * @param string $method * @param array $args * @return mixed + * + * @see \Magnetar\Queue\QueueAdapter */ public function __call(string $method, array $args): mixed { return $this->connection()->$method(...$args); diff --git a/src/Magnetar/Router/Helpers/HTTPMethodEnumResolver.php b/src/Magnetar/Router/Helpers/HTTPMethodEnumResolver.php index 6bb8992..dfc4328 100644 --- a/src/Magnetar/Router/Helpers/HTTPMethodEnumResolver.php +++ b/src/Magnetar/Router/Helpers/HTTPMethodEnumResolver.php @@ -18,7 +18,7 @@ class HTTPMethodEnumResolver { * * @throws Exception If the method is unknown and no default value is provided * - * @see Magnetar\Router\Enums\HTTPMethodEnum + * @see \Magnetar\Router\Enums\HTTPMethodEnum */ public static function resolve(string $method, mixed $default=null): HTTPMethodEnum { return match($method) { diff --git a/src/Magnetar/Template/ThemeManager.php b/src/Magnetar/Template/ThemeManager.php index 4d57390..c72b3ae 100644 --- a/src/Magnetar/Template/ThemeManager.php +++ b/src/Magnetar/Template/ThemeManager.php @@ -71,6 +71,8 @@ public function tpl(string $tpl_name, array $view_data=[]): string { * @param string $method The method name to call * @param array $args The arguments to pass to the method * @return mixed + * + * @see \Magnetar\Template\Template */ public function __call(string $method, array $args): mixed { return $this->theme()->$method(...$args);