FriendsOfHyperf

https://github.com/friendsofhyperf/components
Admin
FriendsOfHyperf is a monorepo for 48 independently installable Composer packages providing various...
Tokens:85,908
Snippets:1,112
Trust Score:9.7
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Setup Database Notifications

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/notification.md

Install the database package, publish the migration, run migrations, and generate a new notification class for database notifications.

```shell
# Install the database package
composer require hyperf/database:~3.2.0

# Publish the migration file
php bin/hyperf.php notification:table

# Run the migration
php bin/hyperf.php migrate

# Create a notification
php bin/hyperf.php gen:notification TestNotification
```

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

### Install and Check Documentation

Source: https://github.com/friendsofhyperf/components/blob/main/AGENTS.md

Install project dependencies and run a documentation check to validate locale page parity, heading structures, component installation commands, and local links.

```bash
npm install
npm run docs:check
```

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

### Install Optional Facade Packages

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/facade.md

Install additional packages required by specific facades your application will use. For example, to use the `Config` and `Log` facades, install their respective packages.

```shell
composer require hyperf/config hyperf/logger
```

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

### Install Telescope Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/telescope.md

Install the Telescope component using Composer.

```shell
composer require friendsofhyperf/telescope
```

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

### Install Facade Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/facade.md

Install the base facade component using Composer. This command also installs required dependencies like `friendsofhyperf/support`, `hyperf/context`, and `hyperf/di`.

```shell
composer require friendsofhyperf/facade
```

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

### Install All Components

Source: https://github.com/friendsofhyperf/components/blob/main/README.md

Use this command to install the entire collection of FriendsOfHyperf components.

```bash
composer require friendsofhyperf/components
```

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

### Install Specific Components

Source: https://github.com/friendsofhyperf/components/blob/main/README.md

Install only the components your application requires by specifying their names.

```bash
composer require friendsofhyperf/telescope
composer require friendsofhyperf/http-client
composer require friendsofhyperf/model-factory --dev
```

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

### Install Dependencies

Source: https://github.com/friendsofhyperf/components/blob/main/README.md

Install all project dependencies from the repository root using Composer.

```bash
composer install
```

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

### Install Command Benchmark

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/command-benchmark.md

Install the command benchmark component using Composer.

```shell
composer require friendsofhyperf/command-benchmark
```

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

### Install Hyperf Helpers

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/helpers.md

Install the Hyperf Helpers component using Composer.

```shell
composer require friendsofhyperf/helpers
```

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

### Install Sentry Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/sentry.md

Install the Sentry component using Composer.

```shell
composer require friendsofhyperf/sentry
```

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

### Install Macros Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/macros.md

Install the macros component using Composer.

```shell
composer require friendsofhyperf/macros
```

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

### Publish Configuration and Example Files

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/model-factory.md

Publish the configuration and example factory files to your project using the Hyperf console command.

```shell
php bin/hyperf.php vendor:publish friendsofhyperf/model-factory
```

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

### Install IDE Helper Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/ide-helper.md

Install the IDE Helper component using Composer.

```shell
composer require friendsofhyperf/ide-helper
```

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

### Install OpenAI Client Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/openai-client.md

Install the OpenAI client component using Composer.

```shell
composer require friendsofhyperf/openai-client
```

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

### Install Documentation Dependencies

Source: https://github.com/friendsofhyperf/components/blob/main/README.md

Install Node.js dependencies required for documentation checks.

```bash
npm install
```

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

### Install Optional Closure Package

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/encryption.md

Install the 'opis/closure' package if encrypted closures need to be signed.

```shell
composer require opis/closure
```

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

### Install Support Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/support.md

Install the FriendsOfHyperf Support component using Composer. Optional integrations for AMQP, Kafka, and async queues require installing their respective Hyperf packages.

```shell
composer require friendsofhyperf/support
```

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

### IDE Helper Configuration Example

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/ide-helper.md

Example configuration file for the IDE Helper component, demonstrating settings for model and macro generation.

```php
<?php

return [
    'model' => [
        'ignores' => [
            App\Model\InternalModel::class,
        ],
        'camel_case_properties' => false,
        'type_overrides' => [
            'integer' => 'int',
        ],
        'custom_db_types' => [
            'mysql' => [
                'tinyint' => 'integer',
            ],
        ],
    ],
    'macro' => [
        'namespaces' => [
            'App\\',
        ],
        'rejects' => [
            App\Example\RejectedMacroable::class,
        ],
    ],
];

```

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

### Install Co-PHPUnit

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/co-phpunit.md

Install the package as a development dependency using Composer.

```bash
composer require friendsofhyperf/co-phpunit --dev
```

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

### Start Hyperf Application

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/web-tinker.md

Start the Hyperf application server. Ensure the application is running to access Web Tinker.

```shell
php bin/hyperf.php start
```

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

### Install OAuth2 Server Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/oauth2-server.md

Install the OAuth2 Server component and publish its configuration and migrations.

```shell
composer require friendsofhyperf/oauth2-server
php bin/hyperf.php vendor:publish friendsofhyperf/oauth2-server
php bin/hyperf.php migrate
```

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

### Install Hyperf Database Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/model-observer.md

If you are using Hyperf models, ensure the hyperf/database component is installed.

```shell
composer require hyperf/database
```

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

### Install OAuth2 Server Package

Source: https://github.com/friendsofhyperf/components/blob/main/src/oauth2-server/README.md

Install the FriendsOfHyperf OAuth2 Server package using Composer.

```bash
composer require friendsofhyperf/oauth2-server
```

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

### Install Amqp Job Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/amqp-job.md

Install the friendsofhyperf/amqp-job component using Composer.

```shell
composer require friendsofhyperf/amqp-job
```

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

### Install Notification Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/notification.md

Install the Hyperf Notification component using Composer.

```shell
composer require friendsofhyperf/notification
```

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

### Install TCP Sender Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/tcp-sender.md

Install the TCP sender component using Composer.

```shell
composer require friendsofhyperf/tcp-sender
```

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

### Install Optional Dependencies for Flexible Cache

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/cache.md

Install the necessary packages for the stale-while-revalidate caching feature.

```shell
composer require friendsofhyperf/lock hyperf/coroutine
```

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

### Install gRPC Validation Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/grpc-validation.md

Install the gRPC Validation component using Composer. This command also installs necessary Hyperf dependencies.

```shell
composer require friendsofhyperf/grpc-validation
```

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

### Install Hyperf Tinker

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/tinker.md

Install the Hyperf Tinker component using Composer.

```shell
composer require friendsofhyperf/tinker
```

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

### Install Elasticsearch Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/elasticsearch.md

Install the Elasticsearch component using Composer and publish its configuration file.

```shell
composer require friendsofhyperf/elasticsearch
php bin/hyperf.php vendor:publish friendsofhyperf/elasticsearch
```

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

### Install Confd Component and Drivers

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/confd.md

Install the Confd component using Composer. You also need to install the driver package for the configuration source you intend to use (e.g., hyperf/etcd or hyperf/nacos).

```shell
composer require friendsofhyperf/confd
composer require hyperf/etcd
# or
composer require hyperf/nacos
```

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

### Install Redis Subscriber

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/redis-subscriber.md

Install the Redis Subscriber component using Composer.

```shell
composer require friendsofhyperf/redis-subscriber
```

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

### Start Tinker REPL

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/tinker.md

Launch the Hyperf Tinker REPL tool from the command line.

```shell
php bin/hyperf.php tinker
```

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

### Install Telescope Elasticsearch Driver

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/telescope-elasticsearch.md

Install the Telescope Elasticsearch driver using Composer.

```shell
composer require friendsofhyperf/telescope-elasticsearch
```

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

### Install Web Tinker Component (Alternative)

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/web-tinker.md

An alternative command to install the Web Tinker component, which may also publish assets.

```shell
php bin/hyperf.php web-tinker:install
```

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

### Install Console Spinner Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/console-spinner.md

Install the console spinner component using Composer.

```shell
composer require friendsofhyperf/console-spinner
```

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

### Install Mail Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/mail.md

Install the mail component using Composer and publish its configuration and view files.

```shell
composer require friendsofhyperf/mail
php bin/hyperf.php vendor:publish friendsofhyperf/mail
```

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

### Install Encryption Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/encryption.md

Install the Hyperf Encryption component using Composer.

```shell
composer require friendsofhyperf/encryption
```

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

### Model Annotation Before Addon

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/mysql-grammar-addon.md

Example of a generated model annotation with garbled non-ASCII comments before installing the MySQL Grammar Addon.

```php
/**
 * @property int $user_id ??id
 * @property string $event_name ????
 */
```

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

### Install Validated DTO

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/validated-dto.md

Install the Validated DTO component using Composer.

```shell
composer require friendsofhyperf/validated-dto
```

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

### Install Config Consul Package

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/config-consul.md

Install the Hyperf Config Consul package using Composer. This command also installs its dependencies.

```shell
composer require friendsofhyperf/config-consul
```

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

### Install Model Morph Addon

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/model-morph-addon.md

Install the Model Morph Addon using Composer.

```shell
composer require friendsofhyperf/model-morph-addon
```

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

### Install Rate Limit Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/rate-limit.md

Install the Hyperf rate limit component using Composer.

```bash
composer require friendsofhyperf/rate-limit
```

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

### Install Notification Mail Channel

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/notification-mail.md

Install the notification mail component using Composer.

```shell
composer require friendsofhyperf/notification-mail
```

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

### Install Purifier Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/purifier.md

Install the Purifier component using Composer. The service provider is automatically discovered.

```shell
composer require friendsofhyperf/purifier
```

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

### Install Model Observer Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/model-observer.md

Install the Model Observer component using Composer. This is the first step to enable model event observation.

```shell
composer require friendsofhyperf/model-observer
```

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

### OAuth2 Server Configuration Example

Source: https://github.com/friendsofhyperf/components/blob/main/src/oauth2-server/README.md

Example configuration for the FriendsOfHyperf OAuth2 Server, detailing various grant types, token lifetimes, and security settings.

```php
<?php

declare(strict_types=1);
/**
 * This file is part of friendsofhyperf/components.
 *
 * @link     https://github.com/friendsofhyperf/components
 * @document https://github.com/friendsofhyperf/components/blob/main/README.md
 * @contact  huangdijia@gmail.com
 */
use FriendsOfHyperf\Oauth2\Server\Enums\EncryptionKeyType;
use League\OAuth2\Server\ResponseTypes\BearerTokenResponse;

use function Hyperf\Support\env;

return [
    'authorization_server' => [
        # Full path to the private key file.
        # How to generate a private key: https://oauth2.thephpleague.com/installation/#generating-public-and-private-keys
        'private_key' => env('OAUTH2_PRIVATE_KEY'),
        # Passphrase of the private key, if any
        'private_key_passphrase' => env('OAUTH2_PRIVATE_KEY_PASSPHRASE'),
        # The plain string or the ascii safe string used to create a Defuse\Crypto\Key to be used as an encryption key.
        # How to generate an encryption key: https://oauth2.thephpleague.com/installation/#string-password
        'encryption_key' => env('OAUTH2_ENCRYPTION_KEY'),
        # The encryption key type.
        'encryption_key_type' => EncryptionKeyType::from(env('OAUTH2_ENCRYPTION_KEY_TYPE', 'plain')),
        'response_type' => BearerTokenResponse::class,
        # Whether to revoke refresh tokens after they were used for all grant types (default to true)
        'revoke_refresh_tokens' => true,
        # How long the issued access token should be valid for.
        # The value should be a valid interval: http://ph
        'access_token_ttl' => new DateInterval('PT1H'),
        # How long the issued auth code should be valid for.
        # The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
        'auth_code_ttl' => new DateInterval('PT10M'),
        # How long the issued refresh token should be valid for.
        # The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
        'refresh_token_ttl' => new DateInterval('P1M'),
        # Whether to enable the client credentials grant
        'enable_client_credentials_grant' => true,
        # Whether to enable the password grant
        'enable_password_grant' => true,
        # Whether to enable the refresh token grant
        'enable_refresh_token_grant' => true,
        # Whether to enable the authorization code grant
        'enable_auth_code_grant' => true,
        'enable_implicit_grant' => false,
        # Whether to require code challenge for public clients for the auth code grant
        'require_code_challenge_for_public_clients' => true,
        # Whether to enable access token saving to persistence layer (default to true)
        'persist_access_token' => true,
    ],
    'resource_server' => [
        # Full path to the public key file
        # How to generate a public key: https://oauth2.thephpleague.com/installation/#generating-public-and-private-keys
        'public_key' => env('OAUTH2_PUBLIC_KEY'),
        # The leeway in seconds to allow for clock skew in JWT verification. Default PT0S (no leeway).
        'jwt_leeway' => null,
    ],

    'scopes' => [
        # Scopes that you wish to utilize in your application.
        # This should be a simple array of strings.
        'available' => [],
        # Scopes that will be assigned when no scope given.
        # This should be a simple array of strings.
        'default' => [],
    ],
];

```

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

### Install ReCaptcha Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/recaptcha.md

Use Composer to install the ReCaptcha component for your Hyperf project.

```shell
composer require friendsofhyperf/recaptcha
```

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

### Install Pretty Console Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/pretty-console.md

Install the Pretty Console component using Composer. This command adds the necessary package to your Hyperf project.

```shell
composer require friendsofhyperf/pretty-console
```

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

### Install Model Hashids Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/model-hashids.md

Install the Model Hashids component using Composer. This command fetches the package and its dependencies.

```shell
composer require friendsofhyperf/model-hashids
```

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

### Install Hyperf Mail Component

Source: https://github.com/friendsofhyperf/components/blob/main/src/mail/README.md

Install the mail component using Composer and publish its configuration files. Ensure Hyperf view configuration is also published if not already present.

```shell
composer require friendsofhyperf/mail
php bin/hyperf.php vendor:publish friendsofhyperf/mail
```

```shell
php bin/hyperf.php vendor:publish hyperf/view
```

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

### Example ConfigProvider Structure

Source: https://github.com/friendsofhyperf/components/blob/main/CLAUDE.md

Illustrates the structure of a ConfigProvider class used for Hyperf component auto-discovery. It defines dependencies, commands, listeners, aspects, annotations, and publishable assets.

```php
namespace FriendsOfHyperf\ComponentName;

class ConfigProvider
{
    public function __invoke(): array
    {
        return [
            'dependencies' => [],    // DI container bindings
            'commands' => [],        // Console commands
            'listeners' => [],       // Event listeners
            'aspects' => [],         // AOP aspects
            'annotations' => [
                'scan' => [
                    'paths' => [__DIR__],
                ],
            ],
            'publish' => [],         // Publishable assets
        ];
    }
}
```

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

### Install Fast Paginate

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/fast-paginate.md

Install the Fast Paginate component using Composer. It depends on Hyperf 3.2 packages and requires no additional configuration.

```shell
composer require friendsofhyperf/fast-paginate
```

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

### Redis Configuration Example

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/rate-limit.md

Configure multiple Redis connection pools in config/autoload/redis.php, including a dedicated pool for rate limiting with specific connection settings.

```php
return [
    'default' => [
        'host' => env('REDIS_HOST', 'localhost'),
        'port' => env('REDIS_PORT', 6379),
        'auth' => env('REDIS_AUTH', null),
        'db' => 0,
        'pool' => [
            'min_connections' => 1,
            'max_connections' => 30,
        ],
    ],
    'rate_limit' => [
        'host' => env('REDIS_HOST', 'localhost'),
        'port' => env('REDIS_PORT', 6379),
        'auth' => env('REDIS_AUTH', null),
        'db' => 1,
        'pool' => [
            'min_connections' => 5,
            'max_connections' => 50,
        ],
    ],
];

```

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

### Install Web Tinker Package

Source: https://github.com/friendsofhyperf/components/blob/main/src/web-tinker/README.md

Use Composer to install the Web Tinker package into your Hyperf project.

```shell
composer require friendsofhyperf/web-tinker
```

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

### Install IPC Broadcaster

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/ipc-broadcaster.md

Install the IPC Broadcaster component using Composer. The package automatically registers its configuration and listeners.

```shell
composer require friendsofhyperf/ipc-broadcaster
```

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

### Install Hyperf Cache Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/cache.md

Install the component using Composer. This component requires Hyperf 3.2.

```shell
composer require friendsofhyperf/cache
```

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

### Benchmark Summary Output

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/command-benchmark.md

Example of the colored summary output displayed after a benchmarked command completes.

```text
⚡ TIME: 2.5s  MEM: 15.23MB  SQL: 42
```

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

### Install Web Tinker Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/web-tinker.md

Install the Web Tinker component using Composer. This is a development dependency.

```shell
composer require friendsofhyperf/web-tinker --dev
```

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

### Model Annotation After Addon

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/mysql-grammar-addon.md

Example of a generated model annotation with preserved non-ASCII comments after installing the MySQL Grammar Addon.

```php
/**
 * @property int $user_id 用户id
 * @property string $event_name 事件名称
 */
```

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

### Install MySQL Grammar Addon

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/mysql-grammar-addon.md

Install the MySQL Grammar Addon using Composer. This package requires specific versions of hyperf/database and hyperf/di.

```shell
composer require friendsofhyperf/mysql-grammar-addon --dev
```

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

### Install Command Validation Package

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/command-validation.md

Install the package using Composer. This package requires Hyperf `~3.2.0` and `hyperf/validation`.

```shell
composer require friendsofhyperf/command-validation
```

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

### Access Named Cache Repository via Factory

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/cache.md

Inject the Contract\Factory interface to access named cache stores. The example shows how to get a 'redis' store.

```php
use FriendsOfHyperf\Cache\Contract\Factory;

$cache = $factory->store('redis');
```

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

### Install Trigger Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/trigger.md

Install the Trigger component using Composer. This command adds the necessary package to your project dependencies.

```shell
composer require friendsofhyperf/trigger
```

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

### Login Rate Limiting Example

Source: https://github.com/friendsofhyperf/components/blob/main/src/rate-limit/README.md

Implement rate limiting for login attempts to prevent brute-force attacks. This example limits to 5 attempts within 5 minutes.

```php
#[RateLimit(
    key: 'login:{email}',
    maxAttempts: 5,
    decay: 300, // 5 minutes
    response: 'Too many login attempts. Please try again after 5 minutes.',
    responseCode: 429
)]
public function login(string $email, string $password)
{
    // Login logic here
}
```

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

### Install HTTP Client and Guzzle

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/http-client.md

Install the Hyperf HTTP Client component and Guzzle using Composer. Guzzle is a required dependency for sending requests.

```shell
composer require friendsofhyperf/http-client guzzlehttp/guzzle:^7.6
```

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

### Setup Model with HasHashid and HashidRouting Traits

Source: https://github.com/friendsofhyperf/components/blob/main/src/model-hashids/README.md

To enable basic hashid features and route binding, use the HasHashid and HashidRouting traits in your model. This integrates hashid generation and resolution directly into your model.

```php
use Hyperf\Database\Model\Model;
use FriendsOfHyperf\ModelHashids\Concerns\HasHashid;
use FriendsOfHyperf\ModelHashids\Concerns\HashidRouting;

Class Item extends Model
{
    use HasHashid, HashidRouting;
}
```

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

### Install Symfony Mailer

Source: https://github.com/friendsofhyperf/components/blob/main/src/notification/README.md

Install the Symfony Mailer component using Composer. This is a prerequisite for email notifications.

```shell
composer require symfony/mailer
```

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

### Setup Model with HasHashid and HashidRouting

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/model-hashids.md

Add the HasHashid concern to your model to enable hashid encoding/decoding. Include HashidRouting if you want implicit route binding to use hashids.

```php
use FriendsOfHyperf\ModelHashids\Concerns\HasHashid;
use FriendsOfHyperf\ModelHashids\Concerns\HashidRouting;
use Hyperf\Database\Model\Model;

class Item extends Model
{
    use HasHashid;
    use HashidRouting;
}
```

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

### Install Exception Event Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/exception-event.md

Install the component using Composer. Ensure Hyperf's DI and event components are available for AOP and event dispatcher support.

```shell
composer require friendsofhyperf/exception-event
```

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

### Install Model Factory

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/model-factory.md

Install the Model Factory component using Composer. This package is intended for development environments.

```shell
composer require friendsofhyperf/model-factory --dev
```

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

### Install Command Signals Package

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/command-signals.md

Install the command signals package using Composer. This package is automatically discovered and does not publish configuration.

```shell
composer require friendsofhyperf/command-signals
```

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

### Login Rate Limiting Example

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/rate-limit.md

Implement rate limiting for login attempts to prevent brute-force attacks. This example limits attempts to 5 within 5 minutes and customizes the response message and code.

```php
<?php

use FriendsOfHyperf\RateLimit\Annotation\RateLimit;

#[RateLimit(
    key: 'login:{email}',
    maxAttempts: 5,
    decay: 300, // 5 minutes
    response: 'Too many login attempts. Please try again after 5 minutes.',
    responseCode: 429
)]
public function login(string $email, string $password)
{
    // Login logic
}

```

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

### Install Model Scope Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/model-scope.md

Install the Model Scope component using Composer. The package's ConfigProvider automatically registers the scope listener.

```shell
composer require friendsofhyperf/model-scope
```

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

### Install Doctrine DBAL for Model Property Inference

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/ide-helper.md

Install the 'doctrine/dbal' dependency to enable inference of model properties from database table columns.

```shell
composer require --dev doctrine/dbal
```

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

### Install Hyperf Lock Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/lock.md

Install the Hyperf Lock component using Composer. The default driver is Redis, but optional dependencies are required for other drivers.

```shell
composer require friendsofhyperf/lock
```

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

### Install Notification EasySms Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/notification-easysms.md

Install the component using Composer. It automatically handles dependencies like friendsofhyperf/notification and overtrue/easy-sms.

```shell
composer require friendsofhyperf/notification-easysms
```

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

### Multi-process TCP Server Implementation

Source: https://github.com/friendsofhyperf/components/blob/main/src/tcp-sender/README.md

Implement a multi-process TCP server using the `OnCloseInterface` and `OnReceiveInterface`. This example shows how to handle connections, disconnections, and received data.

```php
<?php

namespace App;

use Hyperf\Contract\OnCloseInterface;
use Hyperf\Contract\OnReceiveInterface;
use FriendsOfHyperf\TcpSender\Sender;
use Swoole\Server;

class TcpServer implements OnCloseInterface,OnReceiveInterface
{
    public function __construct(private Sender $sender)
    {
    }

    /**
     * @param Server $server
     */
    public function onConnect($server, $fd, $reactorId): void
    {
        $server->send($fd, sprintf('Client %s connected.'.PHP_EOL, $fd));
    }

    public function onClose($server, int $fd, int $reactorId): void
    {
        $server->send($fd, sprintf('Client %s closed.'.PHP_EOL, $fd));
    }

    public function onReceive($server, int $fd, int $reactorId, string $data): void
    {
        $server->send($fd, sprintf('Client %s send: %s'.PHP_EOL, $fd, $data));
        var_dump($data);
    }


}

```

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

### Install Compoships Component

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/compoships.md

Install the Compoships component using Composer. This command adds the necessary package to your project dependencies.

```shell
composer require friendsofhyperf/compoships
```

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

### Install Symfony Notifier

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/notification.md

Install the Symfony Notifier component using Composer to enable sending notifications via various Symfony Notifier channels.

```shell
composer require symfony/notifier
```

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

### Send Basic GET and POST Requests

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/http-client.md

Use the Http facade to send GET and POST requests. Request bodies are sent as JSON by default.

```php
use FriendsOfHyperf\Http\Client\Http;

$response = Http::get('https://example.com/users', [
    'page' => 1,
]);

$response = Http::post('https://example.com/users', [
    'name' => 'Taylor',
]);
```

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

### Access Cache via Facade

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/cache.md

Use the Cache facade for convenient access to cache operations. Examples show 'remember' and accessing a named store.

```php
use FriendsOfHyperf\Cache\Facade\Cache;

$users = Cache::remember('users', 60, function () {
    return [];
});

$users = Cache::store('redis')->get('users');
```

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

### Mailable Class Implementation

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/mail.md

Example of a Mailable class defining envelope, content, and attachments. Public properties are exposed to the view.

```php
namespace App\Mail;

use FriendsOfHyperf\Mail\Mailable;
use FriendsOfHyperf\Mail\Mailable\Attachment;
use FriendsOfHyperf\Mail\Mailable\Content;
use FriendsOfHyperf\Mail\Mailable\Envelope;

class TestMail extends Mailable
{
    public function __construct(public readonly string $name)
    {
    }

    public function envelope(): Envelope
    {
        return new Envelope(subject: 'Test Mail');
    }

    public function content(): Content
    {
        return new Content(
            markdown: 'mail.test',
            with: ['name' => $this->name],
        );
    }

    public function attachments(): array
    {
        return [
            Attachment::fromPath(BASE_PATH . '/storage/report.pdf')
                ->as('report.pdf')
                ->withMime('application/pdf'),
        ];
    }
}
```

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

### Default Purifier Configuration

Source: https://github.com/friendsofhyperf/components/blob/main/src/purifier/README.md

This is an example of the default purifier configuration file. It includes settings for encoding, caching, and allowed HTML elements and CSS properties.

```php
return [
    'encoding' => 'UTF-8',
    'finalize' => true,
    'ignore_non_strings' => false,
    'cache_path' => storage_path('app/purifier'),
    'cache_file_mode' => 0755,
    'settings' => [
        'default' => [
            'HTML.Doctype' => 'HTML 4.01 Transitional',
            'HTML.Allowed' => 'div,b,strong,i,em,u,a[href|title],ul,ol,li,p[style],br,span[style],img[width|height|alt|src]',
            'CSS.AllowedProperties' => 'font,font-size,font-weight,font-style,font-family,text-decoration,padding-left,color,background-color,text-align',
            'AutoFormat.AutoParagraph' => true,
            'AutoFormat.RemoveEmpty' => true,
        ],
        'test' => [
            'Attr.EnableID' => 'true',
        ],
        "youtube" => [
            "HTML.SafeIframe" => 'true',
            "URI.SafeIframeRegexp" => "%^(http://|https://|//)(www.youtube.com/embed/|player.vimeo.com/video/)%",
        ],
        'custom_definition' => [
            'id'  => 'html5-definitions',
            'rev' => 1,
            'debug' => false,
            'elements' => [
                // https://developers.whatwg.org/sections.html
                ['section', 'Block', 'Flow', 'Common'],
                ['nav',     'Block', 'Flow', 'Common'],
                ['article', 'Block', 'Flow', 'Common'],
                ['aside',   'Block', 'Flow', 'Common'],
                ['header',  'Block', 'Flow', 'Common'],
                ['footer',  'Block', 'Flow', 'Common'],
                // Content model actually excludes several tags, not modelled here
                ['address', 'Block', 'Flow', 'Common'],
                ['hgroup', 'Block', 'Required: h1 | h2 | h3 | h4 | h5 | h6', 'Common'],
                // https://developers.whatwg.org/grouping-content.html
                ['figure', 'Block', 'Optional: (figcaption, Flow) | (Flow, figcaption) | Flow', 'Common'],
                ['figcaption', 'Inline', 'Flow', 'Common'],
                // https://developers.whatwg.org/the-video-element.html#the-video-element
                ['video', 'Block', 'Optional: (source, Flow) | (Flow, source) | Flow', 'Common', [
                    'src' => 'URI',
                    'type' => 'Text',
                    'width' => 'Length',
                    'height' => 'Length',
                    'poster' => 'URI',
                    'preload' => 'Enum#auto,metadata,none',
                    'controls' => 'Bool',
                ]],
                ['source', 'Block', 'Flow', 'Common', [
                    'src' => 'URI',
                    'type' => 'Text',
                ]],
                // https://developers.whatwg.org/text-level-semantics.html
                ['s',    'Inline', 'Inline', 'Common'],
                ['var',  'Inline', 'Inline', 'Common'],
                ['sub',  'Inline', 'Inline', 'Common'],
                ['sup',  'Inline', 'Inline', 'Common'],
                ['mark', 'Inline', 'Inline', 'Common'],
                ['wbr',  'Inline', 'Empty', 'Core'],
                
                // https://developers.whatwg.org/edits.html
                ['ins', 'Block', 'Flow', 'Common', ['cite' => 'URI', 'datetime' => 'CDATA']],
                ['del', 'Block', 'Flow', 'Common', ['cite' => 'URI', 'datetime' => 'CDATA']],
            ],
            'attributes' => [
                ['iframe', 'allowfullscreen', 'Bool'],
                ['table', 'height', 'Text'],
                ['td', 'border', 'Text'],
                ['th', 'border', 'Text'],
                ['tr', 'width', 'Text'],
                ['tr', 'height', 'Text'],
                ['tr', 'border', 'Text'],
            ],
        ],
        'custom_attributes' => [
            ['a', 'target', 'Enum#_blank,_self,_target,_top'],
        ],
        'custom_elements' => [
            ['u', 'Inline', 'Inline', 'Common'],
        ],
    ],

];
```

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

### Example BelongsTo Relationship with Composite Keys

Source: https://github.com/friendsofhyperf/components/blob/main/src/compoships/README.md

Demonstrates the inverse relationship (belongsTo) for the previous example, allowing a Task to relate back to its responsible User using composite keys (team_id and category_id). The Task model must also use the Compoships trait.

```php
namespace App;

use Hyperf\Database\Model\Model;

class Task extends Model
{
    use \FriendsOfHyperf\Compoships\Compoships;
    
    public function user()
    {
        return $this->belongsTo(User::class, ['team_id', 'category_id'], ['team_id', 'category_id']);
    }
}
```

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

### Custom Tags and Filtering for Telescope Entries

Source: https://github.com/friendsofhyperf/components/blob/main/src/telescope/README.md

Implement a listener to attach custom tags and filter entries based on specific conditions. This example shows how to tag requests by status and URI, and filter out requests to 'xxxx'.

```php
use FriendsOfHyperf\Telescope\Telescope;
use Hyperf\Event\Contract\ListenerInterface;
use Hyperf\Framework\Event\BootApplication;
use FriendsOfHyperf\Telescope\IncomingEntry;

class TelescopeInitListener implements ListenerInterface
{
    public function listen(): array
    {
        return [
            BootApplication::class,
        ];
    }

    public function process(object $event): void
    {
        // attach your own custom tags
        Telescope::tag(function (IncomingEntry $entry) {
            if ($entry->type === 'request') {
                return [
                    'status:' . $entry->content['response_status'],
                    'uri:'. $entry->content['uri'],
                ];
            }
        });

        // filter entry
        Telescope::filter(function (IncomingEntry $entry): bool {
            if ($entry->type === 'request'){
                if ($entry->content['uri'] == 'xxxx') {
                    return false;
                }
            }
            return true;
        });

    }
}

```

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

### Publish Component Configuration

Source: https://github.com/friendsofhyperf/components/blob/main/README.md

Use this command to publish configuration or resources for a specific component. Consult the component's README for details.

```bash
php bin/hyperf.php vendor:publish friendsofhyperf/<component>
```

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

### Run Telescope Database Migrations

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/telescope.md

Execute database changes to create and store data required by Telescope.

```shell
php bin/hyperf.php migrate
```

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

### Using Spinner with Command

Source: https://github.com/friendsofhyperf/components/blob/main/src/console-spinner/README.md

Integrate the Spinnerable trait into a Hyperf Command to display a progress spinner during task execution. The spinner can be started, advanced, and finished manually.

```php
class FooCommand extends Command
{
    use Spinnerable;

    /**
     * Execute the console command.
     *
     * @return void
     */
    public function handle()
    {
        $spinner = $this->spinner($users->count());
        $spinner->setMessage('Loading...');
        $spinner->start();
        
        foreach ($users as $user) {
            // Do your stuff...
            
            $spinner->advance();
        }

        $spinner->finish();
    }
}
```

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

### Enable Benchmark Option

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/command-benchmark.md

Invoke a Hyperf command with the --enable-benchmark flag to activate performance metrics.

```shell
php bin/hyperf.php your:command --enable-benchmark
```

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

### Access Default Cache Repository via DI

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/cache.md

Inject the Contract\Repository interface to access the default cache store. The example demonstrates using the 'remember' method.

```php
namespace App\Controller;

use FriendsOfHyperf\Cache\Contract\Repository;

class IndexController
{
    public function __construct(private Repository $cache)
    {
    }

    public function index(): mixed
    {
        return $this->cache->remember('users', 60, function () {
            return [];
        });
    }
}
```

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

### Mail Template Example

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/notification-mail.md

Placeholder for a mail template file. This indicates where the content for the markdown email would typically be defined.

```blade
// storage/view/email.blade.php
xxx
```

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

### Implement URLCast for URLWrapper

Source: https://github.com/friendsofhyperf/components/blob/main/src/validated-dto/README.md

Example implementation of the `Castable` interface to cast a string value into a `URLWrapper` instance.

```php
class URLCast implements Castable
{
    /**
     * @param  string  $property
     * @param  mixed  $value
     * @return URLWrapper
     */
    public function cast(string $property, mixed $value): URLWrapper
    {
        return new URLWrapper($value);
    }
}
```

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

### User-Based Rate Limiting

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/rate-limit.md

Implement rate limiting based on a user identifier. This example limits actions to 10 per hour per user.

```php
#[RateLimit(
    key: ['user', '{userId}', 'action'],
    maxAttempts: 10,
    decay: 3600 // 1 hour
)]
public function performAction(int $userId)
{
    // Action logic
}
```

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

### String Deduplication Example

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/macros.md

Demonstrates how to use the `Str::deduplicate` method to remove duplicate characters from a string, specifying a custom character to deduplicate.

```php
use Hyperf\Collection\Arr;
use Hyperf\Context\Context;
use Hyperf\Stringable\Str;

$users = Arr::sortByMany($users, ['name', ['age', false]]);

Context::increment('processed');

$slug = Str::deduplicate('docs///macros', '/');
```

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

### Accessing Underlying Object and Configuration

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/facade.md

Demonstrates how to retrieve the underlying object of a facade using `getFacadeRoot()` and how to access configuration values through the facade.

```php
use FriendsOfHyperf\Facade\Config;

$config = Config::getFacadeRoot();
$name = Config::get('app_name', 'hyperf');
```

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

### Using the Cache Helper Function

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/helpers.md

Illustrates the different ways to use the cache helper function. It can be called without arguments to get the cache instance, with a key and default value to retrieve a cached item, or with an array of key-value pairs and a TTL to set cache items.

```php
use function FriendsOfHyperf\Helpers\cache;

$cache = cache();
$value = cache('key', 'default');
cache(['key' => 'value'], 60);
```

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

### Usage with Scout Builders

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/fast-paginate.md

When `hyperf/scout` is installed, `fastPaginate()` is also available on Scout builders. Note that this implementation delegates to Scout's normal `paginate()` method and does not use the two-query database optimization.

```php
User::search('Hyperf')->fastPaginate();
```

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

### Array Backoff Strategy Examples

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/support.md

Instantiate `ArrayBackoff` with a custom delay array, a predefined pattern ('short'), or a comma-separated string. The second constructor argument controls behavior after the array is exhausted.

```php
use FriendsOfHyperf\Support\Backoff\ArrayBackoff;

$custom = new ArrayBackoff([100, 500, 1000, 2000]);
$short = ArrayBackoff::fromPattern('short');
$fromString = ArrayBackoff::fromString('100, 500, 1000');
```

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

### Interact with Cache

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/helpers.md

The `cache` helper provides access to the cache service. Without arguments, it returns the service. With a string, it gets a value by key. With an array, it sets key-value pairs.

```php
cache(...$arguments)
```

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

### Supporting Laravel's Implicit Route Binding Features

Source: https://github.com/friendsofhyperf/components/blob/main/src/model-hashids/README.md

Demonstrates how HashidRouting is compatible with other Laravel features like soft deletes and scoped bindings. These examples show how to integrate hashid routing with existing Laravel conventions.

```php
Route::get('/items/{item}', function (Item $item) {
    return $item;
})->withTrashed();

Route::get('/user/{user}/items/{item}', function (User $user, Item $item) {
    return $item;
})->scopeBindings();
```

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

### Multi-Level Rate Limiting with AutoSort

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/rate-limit.md

Apply multiple rate limits to a single operation, with AutoSort ensuring stricter limits are checked first for performance. This example includes emergency, hourly, and daily limits.

```php
class ReportController
{
    /**
     * Expensive report generation with multi-level protection
     * AutoSort ensures stricter limits are checked first for better performance
     */
    #[AutoSort]
    #[RateLimit(maxAttempts: 5, decay: 60, response: 'Too many requests. Max 5 per minute')]       // Emergency brake
    #[RateLimit(maxAttempts: 30, decay: 3600, response: 'Hourly limit exceeded. Max 30 per hour')] // Sustained load
    #[RateLimit(maxAttempts: 100, decay: 86400, response: 'Daily limit exceeded. Max 100 per day')] // Daily cap
    public function generateReport($reportType)
    {
        // Expensive report generation logic
    }
}
```

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

### Basic Usage of Pretty Console

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/pretty-console.md

Demonstrates how to use the Pretty Console component within a Hyperf command. It utilizes the Prettyable trait to format console output.

```php
<?php
use FriendsOfHyperf\PrettyConsole\Traits\Prettyable;
use Hyperf\Command\Command as HyperfCommand;
use Hyperf\Command\Annotation\Command;

#[Command]
class FooCommand extends HyperfCommand
{
    use Prettyable;

    public function function handle()
    {
        $this->components->info('Your message here.');
    }
}
```

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

### Navigate to a Component Directory

Source: https://github.com/friendsofhyperf/components/blob/main/CLAUDE.md

Change the current directory to work on a specific component, such as 'telescope'.

```bash
cd src/telescope
```

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

### Process Steps with `withSpinner` (Iterable)

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/console-spinner.md

Use the `withSpinner` helper to automatically manage the spinner's start and finish states when processing an iterable. The callback receives the current item and the spinner, and the spinner advances after each item.

```php
$this->withSpinner(User::all(), function ($user, $spinner): void {
    // Do your stuff with $user...
}, 'Loading...');
```

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

### Publish Telescope Configuration

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/telescope-elasticsearch.md

Publish the Telescope configuration file to your project.

```shell
php bin/hyperf.php vendor:publish friendsofhyperf/telescope --id=config
```

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

### Create Elasticsearch Client with Options

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/elasticsearch.md

Uses ClientBuilderFactory to create an Elasticsearch client builder, passing Guzzle options and setting hosts before building the client.

```php
use FriendsOfHyperf\Elasticsearch\ClientBuilderFactory;

class Foo
{
    public function __construct(protected ClientBuilderFactory $clientBuilderFactory)
    {
    }

    public function handle()
    {
        $client = $this->clientBuilderFactory
            ->create(['timeout' => 5])
            ->setHosts(['http://127.0.0.1:9200'])
            ->build();

        return $client->info();
    }
}
```

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

### Importing and Using Helper Functions

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/helpers.md

Demonstrates how to import and use common helper functions like literal, object_get, blank, and transform. Ensure these functions are imported from the FriendsOfHyperf\Helpers namespace before use.

```php
use function FriendsOfHyperf\Helpers\blank;
use function FriendsOfHyperf\Helpers\literal;
use function FriendsOfHyperf\Helpers\object_get;
use function FriendsOfHyperf\Helpers\transform;

$profile = literal(name: 'Taylor', contact: (object) ['email' => 'taylor@example.com']);

object_get($profile, 'contact.email'); // taylor@example.com
blank('  '); // true
transform(5, fn (int $value) => $value * 2); // 10
```

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

### Viewing Documentation for a Function in Tinker

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/tinker.md

Attempts to display documentation for the `md5` function. Requires the PHP manual to be downloaded for full details.

```shell
>>> doc md5
function md5($str, $raw_output = unknown)

PHP manual not found
    To document core PHP functionality, download the PHP reference manual:
    https://github.com/bobthecow/psysh/wiki/PHP-manual
>>>
```

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

### Building AuthorizationServer via Factory

Source: https://github.com/friendsofhyperf/components/blob/main/src/oauth2-server/README.md

Use the AuthorizationServerFactory to build an instance of the AuthorizationServer. This is the recommended approach for obtaining the server instance in your code.

```php
<?php

use FriendsOfHyperf\Oauth2\Server\Factory\AuthorizationServerFactory;
use Hyperf\Di\Annotation\Inject;

class YourController
{
    #[Inject]
    private AuthorizationServerFactory $authorizationServerFactory;

    public function handleTokenRequest()
    {
        // Build the authorization server
        $authorizationServer = $this->authorizationServerFactory->build();
        
        // Use the authorization server for token validation, etc.
        // ...
    }
}
```

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

### Show Class Definition

Source: https://github.com/friendsofhyperf/components/blob/main/src/tinker/README.md

Displays the source code for the `App\Model\User` class.

```shell
>>> show App\Model\User
 7: /**
 8:  */
 9: class User extends Model
10: {
11:     /**
12:      * The table associated with the model.
13:      *
14:      * @var string
15:      */
```

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

### Create DTO Instance from Command Arguments and Options

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/validated-dto.md

Instantiate a DTO from a mix of command arguments and options using fromCommand().

```php
<?php

use App\\\DTO\\\UserDTO;
use Hyperf\\\Command\\\Command;

class CreateUserCommand extends Command
{
    protected ?string $signature = 'create:user {name}
                                        { --email= : The user email }
                                        { --password= : The user password }';

    protected string $description = 'Create a new User';

    /**
     * Execute the console command.
     *
     * @return int
     *
     * @throws ValidationException
     */
    public function handle()
    {
        $dto = UserDTO::fromCommand($this);
    }
}
```

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

### Get Base Path

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/helpers.md

Use the `base_path` helper to get the application's base directory path, optionally appending a specific path.

```php
base_path(string $path = ''): string
```

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

### Use the Factory Helper to Create Models

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/model-factory.md

Utilize the `factory()` helper function to create model instances. Import the helper function before use. You can specify the model, a count, or a named definition.

```php
use App\Model\User;

use function FriendsOfHyperf\ModelFactory\factory;

factory(User::class)->create();
factory(User::class)->create(['name' => 'Admin']);
factory(User::class, 20)->create();
factory(User::class, 'admin')->create();
factory(User::class, 'admin', 5)->create();
```

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

### Create Cookies

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/helpers.md

Use the `cookie` helper to create a cookie instance. Without a name, it returns the `CookieJarInterface` service. Lifetime is specified in minutes.

```php
cookie
```

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

### Use OpenAI Facade

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/openai-client.md

Utilize the static facade provided by the OpenAI client component for convenient API access.

```php
use FriendsOfHyperf\OpenAi\Facade\OpenAI;

$models = OpenAI::models()->list();
```

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

### Configure Telescope Database Connection

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/telescope.md

Manage the database connection configuration for Telescope in `config/autoload/telescope.php`. Defaults to the `default` connection.

```php
'connection' => env('TELESCOPE_DB_CONNECTION', 'default'),
```

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

### Configure Telescope gRPC Middleware

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/telescope.md

Add the Telescope middleware to the `config/autoload/middlewares.php` configuration file for gRPC functionality.

```php
<?php

return [
    'grpc' => [
        FriendsOfHyperf\Telescope\Middleware\TelescopeMiddleware::class,
    ],
];
```

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

### Publish View Configuration

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/mail.md

If your application lacks Hyperf view configuration, publish it separately.

```shell
php bin/hyperf.php vendor:publish hyperf/view
```

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

### Get Class Namespace

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/helpers.md

Retrieve the namespace of a given class using the `class_namespace` helper.

```php
class_namespace(object|string $class): string
```

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

### Context::increment

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/macros.md

Increments a context value by a specified step. If the value is missing, it starts at zero before incrementing.

```php
use Hyperf\Context\Context;

// Example usage:
Context::set('my_counter', 10);
Context::increment('my_counter', 2);
// Context::get('my_counter') will be 12

Context::increment('new_counter', 5);
// Context::get('new_counter') will be 5
```

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

### Running Basic Commands in Tinker

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/tinker.md

Demonstrates basic variable assignment and constant definition within the Psy Shell.

```shell
Psy Shell v0.10.4 (PHP 7.3.11 — cli)
>>> $a=1
=> 1
>>> $a
=> 1
>>> define('VERSION', 'v1.0.1')
=> true
>>> VERSION
=> "v1.0.1"
>>>
```

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

### Context::decrement

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/macros.md

Decrements a context value by a specified step. If the value is missing, it starts at zero before decrementing.

```php
use Hyperf\Context\Context;

// Example usage:
Context::set('my_counter', 10);
Context::decrement('my_counter', 2);
// Context::get('my_counter') will be 8

Context::decrement('new_counter', 5);
// Context::get('new_counter') will be -5
```

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

### Basic Usage with Model Builders and Relations

Source: https://github.com/friendsofhyperf/components/blob/main/docs/en/components/fast-paginate.md

Use `fastPaginate()` and `simpleFastPaginate()` macros on model builders and relations. These methods mirror Hyperf's standard pagination signatures.

```php
User::query()->fastPaginate();
User::query()->simpleFastPaginate();

User::first()->posts()->fastPaginate();
User::first()->posts()->simpleFastPaginate();
```

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

### Check Documentation

Source: https://github.com/friendsofhyperf/components/blob/main/README.md

Run checks on the documentation to ensure its integrity.

```bash
npm run docs:check
```
Tokens:
Raw