### Create a New Hypervel Project

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/installation.md

Creates a new Hypervel project using Composer's create-project command. This command downloads the Hypervel skeleton and installs its dependencies, setting up a new application instance named 'example-app'.

```shell
composer create-project hypervel/hypervel example-app

```

--------------------------------

### Basic PHPUnit Test Example in Hypervel

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/testing.md

A fundamental example of a PHPUnit test case within a Hypervel application. This demonstrates a simple assertion to verify basic test execution.

```php
<?php

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function testBasicTest()
    {
        $this->assertTrue(true);
    }
}
```

--------------------------------

### Start Hypervel Development Server

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/installation.md

Starts Hypervel's local development server and enables hot reloading for development. The `serve` command launches the HTTP server, making the application accessible at http://localhost:9501. The `watch` command automatically restarts the server on file changes.

```shell
cd example-app

php artisan serve

```

```shell
php artisan watch

```

--------------------------------

### Run Hypervel Docker Container

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/installation.md

This command starts a Hypervel Docker container, mapping the host's local directory to the container's project directory and exposing the necessary port. It also includes options for privileged access and root user, which are recommended when SELinux is enabled on the host.

```shell
docker run --name hypervel \
-v /workspace/hypervel:/data/project \
-p 9501:9501 -it \
--privileged -u root \
--entrypoint /bin/sh \
hyperf/hyperf:8.3-alpine-v3.19-swoole-v6
```

--------------------------------

### Define Basic GET Route - PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/routing.md

Defines a simple GET route that returns a 'Hello World' string when accessed at the '/greeting' URI. This utilizes Hypervel's facade for route definition. No external dependencies are explicitly required for this basic example.

```php
use Hypervel\Support\Facades\Route;

Route::get('/greeting', function () {
    return 'Hello World';
});
```

--------------------------------

### PHP Configuration Access Example

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/packages.md

Demonstrates how to access a published configuration value in PHP after it has been made available by a service provider. The `config()` helper function is used to retrieve the value of 'option' from the 'courier' configuration file.

```php
// Assuming 'courier.php' has been published and contains an 'option' key.
$value = config('courier.option');

```

--------------------------------

### PHPDoc with Mixed Type Hinting

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/contributions.md

This code example shows the correct PHPDoc format for documenting a parameter that can accept mixed types or an array. It illustrates the required spacing and attribute usage for Hypervel's documentation standards.

```php
/**
 * E-mail the results of the scheduled operation if it fails.
 *
 * @param array|mixed $addresses
 */
public function emailOutputOnFailure(mixed $addresses): static
```

--------------------------------

### Invoke Setup and Tear Down in Coroutines - PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/testing.md

This example demonstrates how to explicitly invoke setup and tear down routines within coroutine tests using Hypervel.org. By overriding `invokeSetupInCoroutine` and `invokeTearDownInCoroutine`, developers can ensure that context is correctly managed and shared between their test functions and these setup/teardown methods.

```php
use PHPUnit\Framework\TestCase;
use Hypervel\Foundation\Testing\Concerns\RunTestsInCoroutine;

class UnitTest extends TestCase
{
    use RunTestsInCoroutine;

    protected function invokeSetupInCoroutine(): void
    {
        Context::set('auth_context.users.foo');
    }

    protected function invokeTearDownInCoroutine(): void
    {
        // ...
    }

    public function testCoroutines(): void
    {
        dump(Context::get('auth_context.users.foo'));
    }
}
```

--------------------------------

### Setting up Database Queue Driver - Hypervel

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/queues.md

Provides Artisan commands to generate the necessary migration for the database queue table and apply it to the database. Also shows how to configure the application to use the database driver.

```bash
php artisan queue:table

php artisan migrate
```

```dotenv
QUEUE_CONNECTION=database
```

--------------------------------

### FTP Driver Configuration Example

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/filesystem.md

Provides a sample configuration array for the FTP storage driver. This includes essential connection details like host, username, and password, along with optional settings for port, root directory, passive mode, SSL, and timeouts. This configuration should be placed in your `config/filesystems.php` file.

```php
'ftp' => [
    'driver' => 'ftp',
    'host' => env('FTP_HOST'),
    'username' => env('FTP_USERNAME'),
    'password' => env('FTP_PASSWORD'),

    // Optional FTP Settings...
    // 'port' => env('FTP_PORT', 21),
    // 'root' => env('FTP_ROOT'),
    // 'passive' => true,
    // 'ssl' => true,
    // 'timeout' => 30,
],
```

--------------------------------

### Manage Context with setUp and tearDown in Coroutine Tests - PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/testing.md

This example shows how to use PHPUnit's setUp and tearDown methods to manage context for coroutine tests. It highlights setting context before a test and destroying it afterwards, ensuring proper cleanup. Note that setUp and tearDown might not execute within coroutines by default, but Hypervel's testing traits can manage this.

```php
use PHPUnit\Framework\TestCase;
use Hypervel\Context\Context;
use Hypervel\Foundation\Testing\Concerns\RunTestsInCoroutine;

class UnitTest extends TestCase
{
    use RunTestsInCoroutine;

    public function setUp(): void
    {
        Context::set('auth_context.users.foo');
    }

    public function testCoroutines(): void
    {
        dump(Context::get('auth_context.users.foo'));
    }

    public function tearDown(): void
    {
        Context::destroy('auth_context.users.foo');
    }
}
```

--------------------------------

### Configure Package Discovery for Hypervel

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/packages.md

This JSON snippet demonstrates how to configure your package for automatic discovery by Hypervel. It specifies the service providers and facade aliases to be registered. This enhances the user experience by automating the setup process.

```json
{
    "extra": {
        "hypervel": {
            "providers": [
                "Barryvdh\\Debugbar\\ServiceProvider"
            ],
            "aliases": {
                "Debugbar": "Barryvdh\\Debugbar\\Facade"
            }
        }
    }
}
```

--------------------------------

### HTTP Client - Practical Example: GitHub API Integration

Source: https://context7.com/hypervel/hypervel.org/llms.txt

A real-world example demonstrating how to use the HTTP client to fetch repository data from the GitHub API.

```APIDOC
## HTTP Client - Practical Example: GitHub API Integration

### Description
This example illustrates a practical application of the Hypervel HTTP client within a service class to interact with an external API, specifically fetching user repositories from GitHub.

### Method
GET

### Endpoint
`https://api.github.com/users/{username}/repos`

### Parameters
#### Path Parameters
- **username** (string) - Required - The GitHub username whose repositories are to be fetched.

#### Request Body
None

### Request Example
```php
class GithubService
{
    public function getUserRepos(string $username): array
    {
        $response = Http::withHeaders([
            'Accept' => 'application/vnd.github.v3+json',
        ])->timeout(10)
          ->get("https://api.github.com/users/{$username}/repos");

        if ($response->successful()) {
            return $response->json();
        }

        throw new \Exception('Failed to fetch repositories');
    }
}
```

### Response
#### Success Response (200)
- **repositories** (array) - An array of repository objects for the specified user.

#### Response Example
```json
[
  {
    "id": 123456789,
    "name": "my-repo",
    "full_name": "username/my-repo",
    "description": "A sample repository."
  }
]
```

#### Error Response (e.g., 404)
- Throws an `Exception` if the request is not successful.
```

--------------------------------

### Eloquent Observer Example in PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

An example of an Eloquent observer class with methods corresponding to model events like 'created', 'updated', 'deleted', etc. Each method receives the affected model as an argument. Requires PHP and Eloquent model definitions.

```php
<?php

namespace App\Observers;

use App\Models\User;

class UserObserver
{
    /**
     * Handle the User "created" event.
     */
    public function created(User $user): void
    {
        // ...
    }

    /**
     * Handle the User "updated" event.
     */
    public function updated(User $user): void
    {
        // ...
    }

    /**
     * Handle the User "deleted" event.
     */
    public function deleted(User $user): void
    {
        // ...
    }

    /**
     * Handle the User "restored" event.
     */
    public function restored(User $user): void
    {
        // ...
    }

    /**
     * Handle the User "forceDeleted" event.
     */
    public function forceDeleted(User $user): void
    {
        // ...
    }
}
```

--------------------------------

### Build and Use On-Demand Disk

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/filesystem.md

Illustrates how to create a filesystem disk at runtime using the Storage facade's 'build' method with a configuration array. This allows using a disk without defining it in the `filesystems.php` configuration file.

```php
use Hypervel\Support\Facades\Storage;

$disk = Storage::build([
    'driver' => 'local',
    'root' => '/path/to/root',
]);

$disk->put('image.jpg', $content);
```

--------------------------------

### Register Eloquent Observer in AppServiceProvider

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Register an observer for a model by calling the `observe` method on the model within the `boot` method of `AppServiceProvider`. This links the observer class to the model's events. Requires PHP and Eloquent setup.

```php
use App\Models\User;
use App\Observers\UserObserver;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    User::observe(UserObserver::class);
}
```

--------------------------------

### PHP: Add Placeholder and Hint to Search Prompt

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/prompts.md

This code example shows how to enhance the 'search' prompt by adding placeholder text and an informational hint. The 'placeholder' argument provides example input, while the 'hint' argument offers additional context to the user. Dependencies include the 'search' function and potentially a User model.

```php
$id = search(
    label: 'Search for the user that should receive the mail',
    placeholder: 'E.g. Taylor Otwell',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    hint: 'The user will receive an email immediately.'
);
```

--------------------------------

### Hash Password Example

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/hashing.md

Demonstrates how to securely hash a user's password using the Hash facade's 'make' method. This is a fundamental operation for storing sensitive user credentials.

```php
<?php

namespace App\Http\Controllers;

use Psr\Http\Message\ResponseInterface;
use Hypervel\Http\Request;
use Hypervel\Support\Facades\Hash;

class PasswordController extends Controller
{
    /**
     * Update the password for the user.
     */
    public function update(Request $request): ResponseInterface
    {
        // Validate the new password length...

        $request->user()->fill([
            'password' => Hash::make($request->newPassword)
        ])->save();

        return redirect('/profile');
    }
}
```

--------------------------------

### Customize Timestamp Column Names in Eloquent Models

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

This example demonstrates how to change the names of the columns used for Eloquent timestamps. By defining the `CREATED_AT` and `UPDATED_AT` constants within the model, you can specify custom names like `creation_date` and `updated_date`.

```php
<?php

class Flight extends Model
{
    const CREATED_AT = 'creation_date';
    const UPDATED_AT = 'updated_date';
}
```

--------------------------------

### Apply Global Scope to Model (PHP)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Applies a global scope to a model by overriding its `booted` method and using `addGlobalScope`. This ensures that the defined scope's constraints are automatically applied to all queries for this model. The example shows how to apply the `AncientScope` to the `User` model.

```php
<?php

namespace App\Models;

use App\Models\Scopes\AncientScope;
use Hypervel\Database\Eloquent\Model;

class User extends Model
{
    /**
     * The "booted" method of the model.
     */
    public function booted(): void
    {
        static::addGlobalScope(new AncientScope);
    }
}

```

--------------------------------

### Bootstrap Application Services using the 'boot' Method

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/providers.md

This PHP code illustrates how to use the 'boot' method in a service provider to bootstrap application services after all other providers have been registered. It demonstrates extending 'Hypervel\Http\Request' with custom functionality using a 'RequestMacro'. This method is suitable for tasks requiring access to already registered services.

```php
<?php

namespace App\Providers;

use Hypervel\Http\Request;
use Hypervel\Foundation\Macros\RequestMacro;
use Hypervel\Support\ServiceProvider;

class RequestServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Request::mixin(new RequestMacro());
    }
}
```

--------------------------------

### Install Swoole PHP Extension

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/installation.md

Installs the Swoole PHP extension, a crucial dependency for Hypervel. This snippet shows the command for installation via PECL, which is the standard method. Mac users can use Homebrew for a simplified installation.

```shell
pecl install swoole

```

```shell
brew tap shivammathur/extensions
brew install shivammathur/extensions/swoole@8.3

```

--------------------------------

### Display Application Overview with `php artisan about`

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/configuration.md

The `about` Artisan command provides a summary of your application's configuration, drivers, and environment. You can filter the output to specific sections using the `--only` option.

```shell
php artisan about
```

```shell
php artisan about --only=environment
```

--------------------------------

### Global Scope Applied to Model Query (SQL)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Illustrates the SQL query generated when a global scope is applied to a model. The example shows that a `WHERE` clause corresponding to the global scope's constraints is automatically added to the `SELECT` statement, even for simple calls like `User::all()`.

```sql
select * from `users` where `created_at` < 0021-02-18 00:00:00

```

--------------------------------

### Defining an Option Shortcut

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/artisan.md

This example illustrates how to define a shortcut for an option. The syntax `{--Q|queue}` assigns 'Q' as a shortcut for the 'queue' option. Users can then invoke the command using either `-Q` or `--queue`, with shortcuts typically prefixed by a single hyphen.

```PHP
'mail:send {user} {--Q|queue}'

/**
 * Example of invoking the command using the option shortcut.
 *
 * php artisan mail:send 1 -Qdefault
 */
```

--------------------------------

### Equivalent Facade and Helper Function Calls in PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/facades.md

Demonstrates that facade calls and helper function calls can achieve the same result. This is useful for understanding how to abstract common tasks in Hypervel.

```php
return Hypervel\Support\Facades\View::render('profile');

return view('profile');
```

--------------------------------

### Extend Model Creating Hook with Parent Call

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

This snippet provides an example of how to properly extend the `creating` hook in a Hypervel Eloquent model. It's crucial to call `parent::creating()` within your custom `creating` method to ensure the parent class's logic is executed before your custom logic.

```php
public function creating(): void
{
    parent::creating();

    // your hook logic...
}
```

--------------------------------

### Use UUIDs as Primary Keys in Eloquent Models

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

This snippet demonstrates how to use the `HasUuids` trait to enable UUID primary keys for Eloquent models. It includes an example of creating a model with a UUID and accessing its generated ID. The trait generates ordered UUIDs by default for efficient database indexing.

```php
use Hypervel\Database\Eloquent\Concerns\HasUuids;
use Hypervel\Database\Eloquent\Model;

class Article extends Model
{
    use HasUuids;

    // ...
}

$article = Article::create(['title' => 'Traveling to Europe']);

$article->id; // "8f8e8478-9035-4d23-b9a7-62f4d2612ce5"
```

--------------------------------

### S3 Driver Pool Configuration Example

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/filesystem.md

Shows an example of configuring object pool settings for the 's3' driver. This allows control over connection pooling, including minimum and maximum objects, wait timeouts, and maximum object lifetime. Proper configuration is crucial for concurrent requests.

```php
's3' => [
    'driver' => 's3',
    // ...
    'pool' => [
        'min_objects' => 1,
        'max_objects' => 10,
        'wait_timeout' => 3.0,
        'max_lifetime' => 60.0,
    ],
],
```

--------------------------------

### Install Dropbox Flysystem Adapter (Shell)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/filesystem.md

Installs the Spatie Dropbox Flysystem adapter using Composer. This is a prerequisite for using Dropbox as a custom filesystem.

```shell
composer require spatie/flysystem-dropbox
```

--------------------------------

### Dispatch Batch of Jobs with Callbacks using Hypervel\Support\Facades\Bus

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/queues.md

This example shows how to dispatch a batch of jobs using the `Bus` facade. It includes defining various completion callbacks like `before`, `progress`, `then`, `catch`, and `finally`. These callbacks receive a `Batch` instance and allow for custom actions upon batch creation, job completion, failure, or finalization. The batch ID is returned for later inspection.

```php
use App\Jobs\ImportCsv;
use Hypervel\Bus\Batch;
use Hypervel\Support\Facades\Bus;
use Throwable;

$batch = Bus::batch([
    new ImportCsv(1, 100),
    new ImportCsv(101, 200),
    new ImportCsv(201, 300),
    new ImportCsv(301, 400),
    new ImportCsv(401, 500),
])->before(function (Batch $batch) {
    // The batch has been created but no jobs have been added...
})->progress(function (Batch $batch) {
    // A single job has completed successfully...
})->then(function (Batch $batch) {
    // All jobs completed successfully...
})->catch(function (Batch $batch, Throwable $e) {
    // First batch job failure detected...
})->finally(function (Batch $batch) {
    // The batch has finished executing...
})->dispatch();

return $batch->id;
```

--------------------------------

### Implement Custom Global Scope (PHP)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Defines a custom global scope by implementing the `Scope` interface and its `apply` method. The `apply` method receives the query builder and model instance, allowing you to add constraints like `where` clauses to all queries for that model. This example adds a constraint for records created more than 2000 years ago.

```php
<?php

namespace App\Models\Scopes;

use Hyperf\Database\Model\Builder;
use Hypervel\Database\Eloquent\Model;
use Hyperf\Database\Model\Scope;

class AncientScope implements Scope
{
    /**
     * Apply the scope to a given Eloquent query builder.
     */
    public function apply(Builder $builder, Model $model): void
    {
        $builder->where('created_at', '<', now()->subYears(2000));
    }
}

```

--------------------------------

### Eloquent Model Conventions: Primary Key

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

This example shows how Eloquent assumes a default primary key named 'id' and how to specify a different primary key column using the `$primaryKey` property. It also covers the assumption that the primary key is an auto-incrementing integer and how to disable this with `$incrementing` and specify a different key type with `$keyType`.

```php
<?php

namespace App\Models;

use Hypervel\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The primary key associated with the table.
     */
    protected string $primaryKey = 'flight_id';
}

<?php

class Flight extends Model
{
    /**
     * Indicates if the model's ID is auto-incrementing.
     */
    public bool $incrementing = false;
}

<?php

class Flight extends Model
{
    /**
     * The data type of the primary key ID.
     */
    protected string $keyType = 'string';
}
```

--------------------------------

### API Integration Example: GitHub Repositories (PHP)

Source: https://context7.com/hypervel/hypervel.org/llms.txt

A practical example showcasing how to integrate the Hypervel HTTP client into a service class to fetch data from an external API, specifically retrieving a user's repositories from GitHub. It includes setting custom headers and handling potential request failures.

```php
use Hypervel\Support\Facades\Http;

class GithubService
{
    public function getUserRepos(string $username): array
    {
        $response = Http::withHeaders([
            'Accept' => 'application/vnd.github.v3+json',
        ])->timeout(10)
          ->get("https://api.github.com/users/{$username}/repos");

        if ($response->successful()) {
            return $response->json();
        }

        throw new \Exception('Failed to fetch repositories');
    }
}
```

--------------------------------

### Apply Prefix Option to Routes and Groups

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/routing.md

This example shows how to apply a prefix to individual routes or entire route groups using the `prefix` option. This allows for flexible URI structuring.

```php
Route::get('users', function () {
    // Matches The "/api/users" URL
}, ['prefix' => 'api']);
```

```php
Route::group('/admin', function () {
    Route::get('/users', function () {
         // Matches The "/api/admin/users" URL
    });
}, ['prefix' => 'api']);
```

--------------------------------

### Build Custom Queries with Eloquent Model

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Eloquent models act as query builders. You can chain query builder methods like `where`, `orderBy`, and `take` before calling `get` to retrieve filtered and sorted results.

```php
$flights = Flight::where('active', 1)
    ->orderBy('name')
    ->take(10)
    ->get();
```

--------------------------------

### Configure Testbench with testbench.yaml

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/testbench.md

Example of a basic testbench.yaml configuration file. It specifies the package's service provider and lists packages to be excluded from discovery.

```yaml
providers:
  - Hypervel\Package\PackageServiceProvider

dont-discover:
  - hypervel/sanctum
```

--------------------------------

### PHP Configuration Example with Environment Variable

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/configuration.md

This PHP code snippet demonstrates an unsupported recursive configuration resolution. Referencing `config('bar.title')` within a config file that is loaded early will result in an error because the Config Instance is not yet ready.

```php
return [
    'foo' => config('bar.title'),
];
```

--------------------------------

### Check if Model is Soft Deleted

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Determines if a model instance has been soft-deleted by checking its `deleted_at` attribute using the `trashed` method.

```php
if ($flight->trashed()) {
    // ...
}
```

--------------------------------

### Retrieve Only Soft Deleted Models (PHP)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Uses the `onlyTrashed` method to fetch only soft-deleted model instances from the database. This is useful when you need to specifically access records that have been marked for deletion but not permanently removed. It accepts query builder methods like `where` and `get`.

```php
<?php

$flights = Flight::onlyTrashed()
    ->where('airline_id', 1)
    ->get();

```

--------------------------------

### PHP Service Provider Configuration Publishing

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/packages.md

Example of a PHP service provider's boot method that publishes a configuration file. The `publishes` method maps a source configuration file within the package to a destination path in the application's config directory. This allows users to override package defaults.

```php
<?php

namespace App\Providers;

use Hypervel\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any package services.
     */
    public function boot(): void
    {
        $this->publishes([
            __DIR__.'/../config/courier.php' => config_path('courier.php'),
        ]);
    }
}

```

--------------------------------

### Create and Delete Directories

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/filesystem.md

Provides methods for directory management. 'makeDirectory' creates a directory, including any necessary parent directories. 'deleteDirectory' removes a directory and all of its contents.

```php
use Hypervel\Support\Facades\Storage;

// Create a directory
Storage::makeDirectory($directory);

// Delete a directory and its contents
Storage::deleteDirectory($directory);
```

--------------------------------

### Restore Soft Deleted Model

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Restores a soft-deleted model by setting its `deleted_at` column to `null`. Can be used on single models or in mass operations.

```php
$flight->restore();
```

```php
Flight::withTrashed()
        ->where('airline_id', 1)
        ->restore();
```

```php
$flight->history()->restore();
```

--------------------------------

### Specify Connection and Queue for Batched Jobs

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/queues.md

This example demonstrates how to configure the Redis connection and queue for a batch of jobs using the `onConnection` and `onQueue` methods. All jobs within a single batch must run on the same connection and queue. This allows for granular control over job execution environments.

```php
$batch = Bus::batch([
    // ...
])->then(function (Batch $batch) {
    // All jobs completed successfully...
})->onConnection('redis')->onQueue('imports')->dispatch();
```

--------------------------------

### Deleting a Model Instance in PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Demonstrates how to delete a specific model record from the database by calling the `delete` method on a retrieved model instance.

```php
use App\Models\Flight;

$flight = Flight::find(1);

$flight->delete();
```

--------------------------------

### Install Ably PHP SDK

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/broadcasting.md

Installs the Ably PHP SDK using Composer. This is necessary for broadcasting events through Ably.

```shell
composer require ably/ably-php
```

--------------------------------

### Permanently Delete Soft Deleted Model

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Permanently removes a soft-deleted model from the database using the `forceDelete` method. This can also be used on relationship queries.

```php
$flight->forceDelete();
```

```php
$flight->history()->forceDelete();
```

--------------------------------

### Configure Read and Write Database Connections in PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/database.md

This PHP configuration example shows how to set up separate read and write database connections. This is beneficial for performance optimization, especially in high-traffic applications, by distributing read operations to replica databases. The 'sticky' option ensures that subsequent reads after a write operation use the write connection.

```php
'mysql' => [
    'read' => [
        'host' => [
            '192.168.1.1',
            '196.168.1.2',
        ],
    ],
    'write' => [
        'host' => [
            '196.168.1.3',
        ],
    ],
    'sticky' => true,

    'database' => env('DB_DATABASE', 'laravel'),
    'username' => env('DB_USERNAME', 'root'),
    'password' => env('DB_PASSWORD', ''),
    'unix_socket' => env('DB_SOCKET', ''),
    'charset' => env('DB_CHARSET', 'utf8mb4'),
    'collation' => env('DB_COLLATION', 'utf8mb4_unicode_ci'),
    'prefix' => '',
    'prefix_indexes' => true,
    'strict' => true,
    'engine' => null,
]
```

--------------------------------

### Configure SFTP Filesystem

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/filesystem.md

Provides a sample configuration for an SFTP filesystem in the `filesystems.php` configuration file. It supports both basic authentication and SSH key-based authentication, along with file/directory visibility settings.

```php
'sftp' => [
    'driver' => 'sftp',
    'host' => env('SFTP_HOST'),

    // Settings for basic authentication...
    'username' => env('SFTP_USERNAME'),
    'password' => env('SFTP_PASSWORD'),

    // Settings for SSH key based authentication with encryption password...
    'privateKey' => env('SFTP_PRIVATE_KEY'),
    'passphrase' => env('SFTP_PASSPHRASE'),

    // Settings for file / directory permissions...
    'visibility' => 'private', // `private` = 0600, `public` = 0644
    'directory_visibility' => 'private', // `private` = 0700, `public` = 0755

    // Optional SFTP Settings...
    // 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),
    // 'maxTries' => 4,
    // 'passphrase' => env('SFTP_PASSPHRASE'),
    // 'port' => env('SFTP_PORT', 22),
    // 'root' => env('SFTP_ROOT', ''),
    // 'timeout' => 30,
    // 'useAgent' => true,
],
```

--------------------------------

### Delete Models Using Queries

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Deletes models that match query criteria or all models in a table. Mass delete operations do not dispatch model events.

```php
$deleted = Flight::where('active', 0)->delete();
```

```php
$deleted = Flight::query()->delete();
```

--------------------------------

### Retrieve All Records with Eloquent Model

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Use the `all` method on an Eloquent model to retrieve all records from its associated database table. The results are returned as an instance of `Hypervel\Database\Eloquent\Collection`.

```php
use App\Models\Flight;

foreach (Flight::all() as $flight) {
    echo $flight->name;
}
```

--------------------------------

### Enable Workbench Discovery Options

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/testbench.md

Example of enabling specific discovery options for the Workbench in the testbench.yaml configuration. This controls the registration of routes and console commands.

```yaml
workbench:
  discovers:
    web: true
    api: false
    commands: false
```

--------------------------------

### Query Including Soft Deleted Models

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Includes soft-deleted models in query results by using the `withTrashed` method. This method can also be applied to relationship queries.

```php
use App\Models\Flight;

$flights = Flight::withTrashed()
    ->where('account_id', 1)
    ->get();
```

```php
$flight->history()->withTrashed()->get();
```

--------------------------------

### Defining an Option with a Value

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/artisan.md

This example demonstrates defining an option that expects a value, using `--queue=` syntax. The user must provide a value after the option, like `--queue=default`. If the option is not provided, its value will be `null`. This allows passing specific configurations or parameters to the command.

```PHP
/**
 * The name and signature of the console command.
 *
 * @var null|string
 */
protected ?string $signature = 'mail:send {user} {--queue=}';

/**
 * Example of invoking the command with a value for the --queue option.
 *
 * php artisan mail:send 1 --queue=default
 */
```

--------------------------------

### Using the Cache Facade in a Controller (PHP)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/facades.md

Illustrates how to use a facade within a controller to interact with Hypervel's cache system. This example shows retrieving data using the Cache facade.

```php
<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Psr\Http\Message\ResponseInterface;
use Hypervel\Support\Facades\Cache;

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     */
    public function showProfile(string $id): ResponseInterface
    {
        $user = Cache::get('user:' . $id);

        return view('profile', ['user' => $user]);
    }
}
```

--------------------------------

### Add and Remove Soft Delete Column

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Adds or removes the `deleted_at` column from a database table using the schema builder. This column is essential for soft deletion.

```php
use Hyperf\Database\Schema\Blueprint;
use Hypervel\Support\Facades\Schema;

Schema::table('flights', function (Blueprint $table) {
    $table->softDeletes();
});
```

```php
use Hyperf\Database\Schema\Blueprint;
use Hypervel\Support\Facades\Schema;

Schema::table('flights', function (Blueprint $table) {
    $table->dropSoftDeletes();
});
```

--------------------------------

### Test File Uploads with Fake Storage

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/filesystem.md

This example showcases how to use the Storage facade's `fake` method for testing file uploads. It involves creating fake uploaded files and asserting their presence or absence on a fake disk.

```php
<?php

namespace Tests\Feature;

use Hypervel\Http\UploadedFile;
use Hypervel\Support\Facades\Storage;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_albums_can_be_uploaded(): void
    {
        Storage::fake('photos');

        $response = $this->json('POST', '/photos', [
            UploadedFile::fake()->image('photo1.jpg'),
            UploadedFile::fake()->image('photo2.jpg')
        ]);

        // Assert one or more files were stored...
        Storage::disk('photos')->assertExists('photo1.jpg');
        Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);

        // Assert one or more files were not stored...
        Storage::disk('photos')->assertMissing('missing.jpg');
        Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);

        // Assert that a given directory is empty...
        Storage::disk('photos')->assertDirectoryEmpty('/wallpapers');
    }
}

```

--------------------------------

### Iterate Over Eloquent Collections

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Eloquent collections implement PHP's iterable interfaces, allowing you to loop over them like a standard array using a `foreach` loop.

```php
foreach ($flights as $flight) {
    echo $flight->name;
}
```

--------------------------------

### Build Log Stacks - PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/logging.md

This example demonstrates how to create a 'stack' log channel in Hypervel, which aggregates messages from multiple other channels like 'syslog' and 'slack'. This allows for flexible logging configurations.

```php
'channels' => [
    'stack' => [
        'driver' => 'stack',
        'channels' => ['syslog', 'slack'],
    ],

    'syslog' => [
        'driver' => 'syslog',
        'level' => 'debug',
    ],

    'slack' => [
        'driver' => 'slack',
        'url' => env('LOG_SLACK_WEBHOOK_URL'),
        'username' => 'Hypervel Log',
        'emoji' => ':boom:',
        'level' => 'critical',
    ],
]
```

--------------------------------

### Execute Code Before and After Task - PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/scheduling.md

These methods allow you to define closures that execute code just before a scheduled task starts (`before`) and just after it finishes (`after`). This is useful for setup and teardown operations.

```php
$schedule->command('emails:send')
    ->daily()
    ->before(function () {
        // The task is about to execute...
    })
    ->after(function () {
        // The task has executed...
    });
```

--------------------------------

### Enable Soft Deletes for a Model

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Enables soft deletion for a model by using the `SoftDeletes` trait. This trait automatically casts the `deleted_at` attribute to a `DateTime` or `Carbon` instance.

```php
<?php

namespace App\Models;

use Hypervel\Database\Eloquent\Model;
use Hyperf\Database\Model\SoftDeletes;

class Flight extends Model
{
    use SoftDeletes;
}
```

--------------------------------

### Select Prompt with Default and Hint (PHP)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/prompts.md

Illustrates customizing the `select` prompt by specifying a default choice and an informational hint to guide the user.

```php
$role = select(
    label: 'What role should the user have?',
    options: ['Member', 'Contributor', 'Owner'],
    default: 'Owner',
    hint: 'The role may be changed at any time.'
);
```

--------------------------------

### Delete Model by Primary Key

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Deletes a model by its primary key, optionally accepting multiple keys or a collection of keys. This method dispatches 'deleting' and 'deleted' events for each model.

```php
Flight::destroy(1);

Flight::destroy(1, 2, 3);

Flight::destroy([1, 2, 3]);

Flight::destroy(collect([1, 2, 3]));
```

--------------------------------

### Using Hypervel Facades for Cache and Route

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/facades.md

Demonstrates how to use Hypervel's Cache and Route facades to define a route that retrieves a value from the cache. Requires importing the respective facade classes.

```php
use Hypervel\Support\Facades\Cache;
use Hypervel\Support\Facades\Route;

Route::get('/cache', function () {
    return Cache::get('key');
});
```

--------------------------------

### Run Coroutine Tests with `Hypervel\Coroutine\run`

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/testing.md

Demonstrates how to execute test logic within a coroutine container using the `Hypervel\Coroutine\run` function. This is necessary when testing asynchronous code that relies on coroutines.

```php
use PHPUnit\Framework\TestCase;

use function Hypervel\Coroutine\run;

class UnitTest extends TestCase
{
    public function testCoroutines(): void
    {
        run(function () {
            dump(Coroutine::id());
        });
    }
}
```

--------------------------------

### Install Pusher Channels PHP SDK

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/broadcasting.md

Installs the Pusher Channels PHP SDK using Composer. This is the first step to enable broadcasting events via Pusher Channels.

```shell
composer require pusher/pusher-php-server
```

--------------------------------

### Select Prompt with Options (PHP)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/prompts.md

Demonstrates using the `select` function to allow users to choose from a list of predefined options. The selected option's value is returned.

```php
use function Hypervel\Prompts\select;

$role = select(
    label: 'What role should the user have?',
    options: ['Member', 'Contributor', 'Owner']
);
```

--------------------------------

### Retrieve or Execute Closure for Models (PHP)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

The `findOr` and `firstOr` methods provide a way to retrieve a single model or execute a closure if no matching records are found. The result of the closure is then returned.

```php
$flight = Flight::findOr(1, function () {
    // ...
});

$flight = Flight::where('legs', '>', 3)->firstOr(function () {
    // ...
});
```

--------------------------------

### Display Products in Grid using Chunk (HTML/PHP)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/collections.md

An example demonstrating how to use the `chunk` method within an HTML loop to display items in a grid layout, typically used with templating engines like Blade.

```html
@foreach ($products->chunk(3) as $chunk)
    <div class="row">
        @foreach ($chunk as $product)
            <div class="col-xs-4">{{ $product->name }}</div>
        @endforeach
    </div>
@endforeach
```

--------------------------------

### Disable Timestamps in Eloquent Models

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

This code demonstrates how to disable Eloquent's automatic management of `created_at` and `updated_at` timestamps by setting the `$timestamps` property to `false` within the model class.

```php
<?php

namespace App\Models;

use Hypervel\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * Indicates if the model should be timestamped.
     */
    public bool $timestamps = false;
}
```

--------------------------------

### Filling Model Instances with Attributes in PHP

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Illustrates how to populate an existing model instance with an array of attributes using the `fill` method. This is useful when you already have a model object and need to update its properties.

```php
$flight->fill(['name' => 'Amsterdam to Frankfurt']);
```

--------------------------------

### Access and Set Configuration Values (PHP)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/configuration.md

Demonstrates how to retrieve configuration values using the `Config` facade or the global `config` function with dot syntax. It also shows how to set configuration values at runtime and retrieve typed configuration values.

```php
use Hypervel\Support\Facades\Config;

// Retrieving configuration values
$value = Config::get('app.timezone');
$value = config('app.timezone');
$value = config('app.timezone', 'Asia/Seoul'); // With default value

// Setting configuration values
Config::set('app.timezone', 'America/Chicago');
config(['app.timezone' => 'America/Chicago']);

// Typed retrieval for static analysis
Config::string('config-key');
Config::integer('config-key');
Config::float('config-key');
Config::boolean('config-key');
Config::array('config-key');
```

--------------------------------

### Update an Existing Model

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

This snippet demonstrates how to update an existing model in the database. First, retrieve the model, then modify its attributes, and finally call the save method. The 'updated_at' timestamp is automatically handled.

```php
use App\Models\Flight;

$flight = Flight::find(1);

$flight->name = 'Paris to London';

$flight->save();
```

--------------------------------

### Configure Scoped Filesystem Disk

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/filesystem.md

Demonstrates how to create a scoped filesystem disk using the 'scoped' driver. This allows all file operations on the disk to be automatically prefixed with a specified path.

```php
's3-videos' => [
    'driver' => 'scoped',
    'disk' => 's3',
    'prefix' => 'path/to/videos',
],
```

--------------------------------

### Manipulate Eloquent Collections with Reject Method

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/eloquent.md

Eloquent query results are returned as `Hypervel\Database\Eloquent\Collection` instances. These collections extend `Hypervel\Support\Collection` and provide methods like `reject` to filter models based on a closure.

```php
$flights = Flight::where('destination', 'Paris')->get();

$flights = $flights->reject(function (Flight $flight) {
    return $flight->cancelled;
});
```

--------------------------------

### Interact with Redis using Hypervel Facade (COMMAND Method)

Source: https://github.com/hypervel/hypervel.org/blob/main/docs/docs/redis.md

This PHP example shows how to execute Redis commands using the `command` method on the `Redis` facade. This method is useful for passing command names as strings and their arguments as an array, offering flexibility for dynamic command execution.

```php
use Hypervel\Support\Facades\Redis;

$values = Redis::command('lrange', ['name', 5, 10]);

```