LaraGram

https://laraxgram.github.io/
Admin
LaraGram is an advanced framework for Telegram Bot development, featuring a powerful listening...
Tokens:334,937
Snippets:4,550
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Setup and Run Client

Source: https://laraxgram.github.io/simula.html

Install Node.js dependencies and start the development server for the client. Navigate to the client directory first.

```bash
cd client
npm install
npm run dev
```

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

### Complete Sequence Example with Listeners

Source: https://laraxgram.github.io/v3/step.html

A full example demonstrating how to start a sequence, handle steps using `Bot::onStep`, and end the sequence. This pattern keeps stages in their own handlers while the sequence manages user position.

```php
use LaraGram\Support\Facades\Bot;
use LaraGram\Support\Facades\Step;
use LaraGram\Request\Request;

Bot::onText('register', function (Request $request) {
    Step::startSequence([
        'awaiting_name',
        'awaiting_email',
        'awaiting_confirmation',
    ]);

    $request->sendMessage(chat()->id, 'What is your name?');
});

Bot::onStep('awaiting_name', function (Request $request, string $name) {
    // Store the name, then advance the sequence...
    Step::next();

    $request->sendMessage(chat()->id, 'What is your email?');
});

Bot::onStep('awaiting_email', function (Request $request, string $email) {
    // Store the email, then advance the sequence...
    Step::next();

    $request->sendMessage(chat()->id, 'Please confirm by sending "yes".');
});

Bot::onStep('awaiting_confirmation', function (Request $request, string $answer) {
    Step::endSequence();

    $request->sendMessage(chat()->id, 'Registration complete!');
});
```

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

### Setup and Run Scraper

Source: https://laraxgram.github.io/simula.html

Install dependencies and run the scraper and generator scripts for the scraper component. Navigate to the scraper directory first.

```bash
cd scraper
pip install -r requirements.txt
python src/scraper.py
python src/generator.py
```

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

### Install Surge Configuration

Source: https://laraxgram.github.io/v3/surge.html

Execute the `surge:install` command to publish Surge's configuration file.

```shell
php laragram surge:install
```

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

### Start Release Docker Profile

Source: https://laraxgram.github.io/simula.html

Use the release Docker profile to start production-like services.

```bash
./scripts/release-up.sh
```

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

### Start API Server

Source: https://laraxgram.github.io/v3/installation.html

Execute this command to start your own API server by setting api_id and api_hash in the configuration.

```shell
php laragram start:apiserver
```

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

### Install PHP, Composer, and LaraGram Installer on Windows

Source: https://laraxgram.github.io/v3/installation.html

Execute this PowerShell command as administrator to install required software on Windows. Ensure to set the execution policy.

```powershell
# Run as administrator...
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://php.new/install/windows/8.4'))
```

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

### Start Dev Docker Profile

Source: https://laraxgram.github.io/simula.html

Start the development Docker profile with hot-reloading enabled.

```bash
docker compose --profile dev up --build
```

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

### Start LaraGram Development Server

Source: https://laraxgram.github.io/v3/installation.html

Navigate to your application directory and use this command to start the local development server for testing.

```shell
cd example-app
php laragram serve
```

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

### Install PHP, Composer, and LaraGram Installer on Linux

Source: https://laraxgram.github.io/v3/installation.html

This command installs the necessary tools on Linux systems. A terminal restart is recommended.

```shell
/bin/bash -c "$(curl -fsSL https://php.new/install/linux/8.4)"
```

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

### Install Chokidar File Watching Library

Source: https://laraxgram.github.io/v3/surge.html

Install the Chokidar library as a development dependency to enable file watching for the Surge server.

```shell
npm install --save-dev chokidar
```

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

### Ensure String Starts with Value with start

Source: https://laraxgram.github.io/v3/strings.html

The `start` method prepends a given value to a string if it doesn't already start with it.

```php
use LaraGram\Support\Str;

$adjusted = Str::of('this/string')->start('/');

// /this/string

$adjusted = Str::of('/this/string')->start('/');

// /this/string
```

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

### Get a Redis Key

Source: https://laraxgram.github.io/v3/redis.html

Retrieve a value from Redis using the GET command via the Redis facade. This example shows fetching user profile data.

```php
<?php

namespace App\Controllers;

use LaraGram\Support\Facades\Redis;
use LaraGram\View\View;

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     */
    public function show(string $id): View
    {
        return view('user.profile',
            ['user' => Redis::get('user:profile:'.$id)]
        );
    }
}
```

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

### Start Surge Server with File Watching

Source: https://laraxgram.github.io/v3/surge.html

Use the `--watch` flag to automatically restart the Surge server when application files change. Ensure Node.js and the Chokidar library are installed.

```shell
php laragram surge:start --watch
```

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

### Basic Controller Example

Source: https://laraxgram.github.io/v3/controllers.html

A basic controller class with a public method to handle incoming Bot requests. This example shows a `show` method for displaying user profiles.

```php
<?php

namespace App\Controllers;

use App\Models\User;

class UserController extends Controller
{
    /**
     * Show the profile for a given user.
     */
    public function show(string $id)
    {
        template('user.profile', [
            'user' => User::findOrFail($id)
        ]);
    }
}
```

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

### Install PHP, Composer, and LaraGram Installer on macOS

Source: https://laraxgram.github.io/v3/installation.html

Use this command to install necessary tools on macOS. Restart your terminal after execution.

```shell
/bin/bash -c "$(curl -fsSL https://php.new/install/mac/8.4)"
```

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

### Take Items from Array Start

Source: https://laraxgram.github.io/v3/helpers.html

Use `Arr::take` to get a specified number of items from the beginning of an array.

```php
use LaraGram\Support\Arr;

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, 3);

// [0, 1, 2]
```

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

### Start an Asynchronous Process

Source: https://laraxgram.github.io/v3/processes.html

Execute a process in the background using the `start` method, allowing your application to continue other tasks. Use `running` to check status and `wait` to retrieve the result.

```php
$process = Process::timeout(120)->start('bash import.sh');

while ($process->running()) {
    // ...
}

$result = $process->wait();
```

```php
$process = Process::timeout(120)->start('bash import.sh');

// ...

$result = $process->wait();
```

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

### Install Watchdog Package

Source: https://laraxgram.github.io/v3/watchdog.html

Install the Watchdog package using Composer. This is typically done alongside the main Laragram installation.

```shell
composer require laraxgram/watchdog
```

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

### Example Custom Commander Command Structure

Source: https://laraxgram.github.io/v3/commander.html

This example shows the structure of a custom Commander command, including the signature, description, and the handle method for command logic. Dependencies can be injected into the handle method.

```php
<?php

namespace App\Console\Commands;

use App\Models\User;
use App\Support\DripEmailer;
use LaraGram\Console\Command;

class SendEmails extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'mail:send {user}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Send a marketing email to a user';

    /**
     * Execute the console command.
     */
    public function handle(DripEmailer $drip): void
    {
        $drip->send(User::find($this->argument('user')));
    }
}
```

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

### Configure Swoole Tables in Surge Configuration

Source: https://laraxgram.github.io/v3/surge.html

Define Swoole tables within the `tables` configuration array in your application's `surge` configuration file. This example defines a table named 'example' with a maximum of 1000 rows and specifies string column size.

```php
'tables' => [
    'example:1000' => [
        'name' => 'string:1000',
        'votes' => 'int',
    ],
],
```

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

### Run Web Services (macOS/Linux)

Source: https://laraxgram.github.io/simula.html

Start the Simula web services on macOS or Linux using the provided script.

```bash
run-web.sh
```

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

### Str::start()

Source: https://laraxgram.github.io/v3/strings.html

Adds a single instance of the given value to a string if it does not already start with that value.

```APIDOC
## Str::start()

### Description
Adds a single instance of the given value to a string if it does not already start with that value.

### Method
```php
Str::start(string $value, string $start)
```

### Parameters
#### Arguments
- **value** (string) - The string to ensure starts with the specified value.
- **start** (string) - The value to prepend if necessary.

### Request Example
```php
use LaraGram\Support\Str;

$adjusted = Str::start('this/string', '/');

// /this/string

$adjusted = Str::start('/this/string', '/');

// /this/string
```
```

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

### Install LaraGram Installer via Composer

Source: https://laraxgram.github.io/v3/installation.html

If PHP and Composer are already installed, use this command to install the LaraGram installer globally.

```shell
composer global require laraxgram/installer
```

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

### Publishing with Facade

Source: https://laraxgram.github.io/v3/facades.html

Example of using a facade to publish an event. The facade resolves the underlying implementation from the service container.

```php
$publisher->publish($this);
Publisher::publish($this);
```

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

### Install LaraGram Surge

Source: https://laraxgram.github.io/v3/surge.html

Install the LaraGram Surge package using Composer.

```shell
composer require laraxgram/surge
```

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

### Retrieve All Options

Source: https://laraxgram.github.io/v3/commander.html

Get all options passed to the command as an array.

```php
// Retrieve all options as an array...
$options = $this->options();
```

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

### Run Web Services (Windows)

Source: https://laraxgram.github.io/simula.html

Start the Simula web services on Windows using the provided batch file.

```batch
run-web.bat
```

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

### Access and Interact with Swoole Tables

Source: https://laraxgram.github.io/v3/surge.html

Use the `Surge::table` method to access and manipulate Swoole tables. This example sets a value for the 'uuid' key in the 'example' table and then retrieves it.

```php
use LaraGram\Surge\Facades\Surge;

Surge::table('example')->set('uuid', [
    'name' => 'Nuno Maduro',
    'votes' => 1000,
]);

return Surge::table('example')->get('uuid');
```

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

### Install Swoole PHP Extension

Source: https://laraxgram.github.io/v3/surge.html

Install the Swoole PHP extension using PECL, a prerequisite for using the Swoole application server.

```shell
pecl install swoole
```

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

### Installing Supervisor

Source: https://laraxgram.github.io/v3/queues.html

Install Supervisor, a process monitor for Linux, to automatically restart `queue:work` processes if they fail. This command is for Ubuntu systems.

```shell
sudo apt-get install supervisor
```

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

### Manually Start Release Docker Services

Source: https://laraxgram.github.io/simula.html

Manually start the API server and client in detached mode with the release Docker profile.

```bash
docker compose --profile release run --rm scraper
docker compose --profile release up -d --build api-server client
```

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

### Podcast Model With Real-Time Facades

Source: https://laraxgram.github.io/v3/facades.html

Demonstrates using real-time facades in a Podcast model, allowing the Publisher to be accessed via a facade without explicit injection.

```php
<?php

namespace App	Models;

use App	Contracts	Publisher; 
use Facades	App	Contracts	Publisher; 
use LaraGram	Database	Eloquent	Model;

class Podcast extends Model
{
    /**
     * Publish the podcast.
     */
    public function publish(Publisher $publisher): void
    public function publish(): void
    {
        $this->update(['publishing' => now()]);


```

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

### Get string between two values

Source: https://laraxgram.github.io/v3/strings.html

Returns the portion of the string that falls between the first occurrence of the start value and the first occurrence of the end value.

```php
use LaraGram\Support\Str;

$converted = Str::of('This is my name')->between('This', 'name');

// ' is my '
```

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

### Get Database Table Overview

Source: https://laraxgram.github.io/v3/database.html

Use the `db:table` command to get a general overview of a database table, including its columns, types, attributes, keys, and indexes. This command requires the table name as an argument.

```shell
php laragram db:table users
```

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

### Listing All Defined Listeners

Source: https://laraxgram.github.io/v3/listening.html

Use the `listen:list` Commander command to get an overview of all listeners defined in your application.

```shell
php laragram listen:list
```

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

### Zero Configuration Resolution Example

Source: https://laraxgram.github.io/v3/container.html

Demonstrates how the container can automatically resolve and inject a concrete class ('Service') into a listener's handler without explicit configuration.

```php
<?php

class Service
{
    // ...
}

Bot::onText('hello', function (Service $service) {
    dd($service::class);
});
```

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

### Retrieve All Users

Source: https://laraxgram.github.io/v3/queries.html

Use the `DB::table` method to start a query and `get` to retrieve all rows from the 'users' table. Results are returned as a collection of stdClass objects.

```php
<?php

namespace App\Controllers;

use LaraGram\Support\Facades\DB;
use LaraGram\View\View;

class UserController extends Controller
{
    /**
     * Show a list of all of the application's users.
     */
    public function index(): View
    {
        $users = DB::table('users')->get();

        return view('user.index', ['users' => $users]);
    }
}
```

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

### Get smallest string portion between two values

Source: https://laraxgram.github.io/v3/strings.html

Returns the smallest possible portion of the string between the first occurrence of the start value and the first occurrence of the end value.

```php
use LaraGram\Support\Str;

$converted = Str::of('[a] bc [d]')->betweenFirst('[', ']');

// 'a'
```

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

### Display Application Overview

Source: https://laraxgram.github.io/v3/configuration.html

Use the `about` command to see an overview of your application's configuration, drivers, and environment. You can filter the output using the `--only` option.

```shell
php laragram about
```

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

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

### Take Characters from String Start

Source: https://laraxgram.github.io/v3/strings.html

Returns a specified number of characters from the beginning of a string.

```php
use LaraGram\Support\Str;

$taken = Str::take('Build something amazing!', 5);

// Build
```

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

### Get and Set File Visibility

Source: https://laraxgram.github.io/v3/filesystem.html

Retrieve a file's visibility with `getVisibility` and update it with `setVisibility`.

```php
$visibility = Storage::getVisibility('file.jpg');

Storage::setVisibility('file.jpg', 'public');
```

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

### Show Database Overview

Source: https://laraxgram.github.io/v3/database.html

Inspect your database's general information, including size, type, and a summary of its tables, using the 'db:show' Commander command. Use the --database option to specify a connection.

```shell
php laragram db:show
```

```shell
php laragram db:show --database=pgsql
```

```shell
php laragram db:show --counts --views
```

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

### Get a slice of a collection by index

Source: https://laraxgram.github.io/v3/collections.html

Returns a slice of the collection starting at the given index. Optionally limit the size of the returned slice by providing a second argument. Preserves keys by default.

```php
$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);

$slice = $collection->slice(4);

$slice->all();

// [5, 6, 7, 8, 9, 10]
```

```php
$slice = $collection->slice(4, 2);

$slice->all();

// [5, 6]
```

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

### Nginx Configuration for Surge Application

Source: https://laraxgram.github.io/v3/surge.html

Example Nginx configuration to serve static assets and proxy requests to a LaraGram Surge application running on port 9000. This setup is recommended for production environments.

```nginx
map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      close;
}

server {
    listen 80;
    listen [::]:80;
    server_name domain.com;
    server_tokens off;
    root /home/forge/domain.com/public;

    index index.php;

    charset utf-8;

    location /index.php {
        try_files /not_exists @surge;
    }

    location / {
        try_files $uri $uri/ @surge;
    }

    location = /favicon.ico { access_log off; log_not_found off; }
    location = /robots.txt  { access_log off; log_not_found off; }

    access_log off;
    error_log  /var/log/nginx/domain.com-error.log error;

    error_page 404 /index.php;

    location @surge {
        set $suffix "";

        if ($uri = /index.php) {
            set $suffix ?$query_string;
        }

        proxy_http_version 1.1;
        proxy_set_header Host $http_host;
        proxy_set_header Scheme $scheme;
        proxy_set_header SERVER_PORT $server_port;
        proxy_set_header REMOTE_ADDR $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;

        proxy_pass http://127.0.0.1:9000$suffix;
    }
}
```

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

### Database Connection URL Example

Source: https://laraxgram.github.io/v3/database.html

Configure database connections using a single URL string, which includes driver, credentials, host, port, database name, and options.

```html
mysql://root:password@127.0.0.1/forge?charset=UTF-8
```

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

### SQLite Configuration Example

Source: https://laraxgram.github.io/v3/database.html

Configure your application to use an SQLite database by setting the connection type and the database file path.

```ini
DB_CONNECTION=sqlite
DB_DATABASE=/absolute/path/to/database.sqlite
```

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

### Install LaraGram MongoDB Package

Source: https://laraxgram.github.io/v3/mongodb.html

Install the LaraGram MongoDB package using Composer. Ensure the mongodb PHP extension is installed.

```shell
composer require laraxgram/mongodb
```

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

### Custom Cache Status Driver Configuration

Source: https://laraxgram.github.io/v3/authorization.html

Example of configuring a custom cache status driver with specific settings.

```php
'default' => 'fast',

'drivers' => [
    'fast' => [
        'driver' => 'cache',
        'store' => 'redis',
        'prefix' => 'chat_status',
        'ttl' => 1800,
    ],
],
```

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

### Start LaraGram Surge Server

Source: https://laraxgram.github.io/v3/surge.html

Start the Surge server using the `surge:start` Commander command. By default, it runs on port 9000.

```shell
php laragram surge:start
```

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

### Capture Query Information in Stack

Source: https://laraxgram.github.io/v3/context.html

Example of using `Context::push` within a database listener to record query details (duration and SQL) for historical tracking.

```php
use LaraGram\Support\Facades\Context;
use LaraGram\Support\Facades\DB;

// In AppServiceProvider.php...
DB::listen(function ($event) {
    Context::push('queries', [$event->time, $event->sql]);
});
```

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

### Defining Translation Strings with Short Keys

Source: https://laraxgram.github.io/v3/localization.html

Example of a language file returning an array of keyed strings for translations.

```php
<?php

// lang/en/messages.php

return [
    'welcome' => 'Welcome to our application!',
];
```

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

### Access Package Translation Line

Source: https://laraxgram.github.io/v3/packages.html

Example of how to retrieve a translation line from a package using the 'package::file.line' syntax.

```php
echo trans('surge::messages.welcome');
```

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

### Registering an Immediate Tick Operation

Source: https://laraxgram.github.io/v3/surge.html

This snippet demonstrates how to configure a tick operation to execute immediately upon server boot and then at the specified interval thereafter, using the `immediate` method.

```php
Surge::tick('simple-ticker', fn () => ray('Ticking...'))
    ->seconds(10)
    ->immediate();
```

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

### Schedule Task Weekly on Mondays at 1 PM

Source: https://laraxgram.github.io/v3/scheduling.html

Example of combining weekly scheduling with specific day and time constraints.

```php
use LaraGram\Support\Facades\Schedule;

// Run once per week on Monday at 1 PM...
Schedule::call(function () {
    // 
})->weekly()->mondays()->at('13:00');
```

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

### Show Specific Configuration File

Source: https://laraxgram.github.io/v3/configuration.html

Use the `config:show` command to view the values of a specific configuration file in detail.

```shell
php laragram config:show database
```

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

### Get Storage Path

Source: https://laraxgram.github.io/v3/helpers.html

Use `storage_path()` to get the full path to the storage directory or a specific file within it.

```php
$path = storage_path();

$path = storage_path('app/file.txt');
```

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

### Create and Use On-Demand Disk

Source: https://laraxgram.github.io/v3/filesystem.html

Create a temporary disk at runtime with custom configuration using the `build` method. This disk can then be used for file operations without modifying the main configuration.

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

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

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

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

### Get Template Path

Source: https://laraxgram.github.io/v3/helpers.html

Use `template_path()` to get the full path to the templates directory or a specific template file.

```php
$path = template_path();

$path = template_path('panel/admin.t8.php');
```

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

### Get Public Path

Source: https://laraxgram.github.io/v3/helpers.html

Use `public_path()` to get the full path to the public directory or a specific file within it.

```php
$path = public_path();

$path = public_path('css/app.css');
```

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

### Podcast Model Without Real-Time Facades

Source: https://laraxgram.github.io/v3/facades.html

Illustrates a Podcast model with a publish method that requires explicit injection of a Publisher instance.

```php
<?php

namespace App	Models;

use App	Contracts	Publisher;
use LaraGram	Database	Eloquent	Model;

class Podcast extends Model
{
    /**
     * Publish the podcast.
     */
    public function publish(Publisher $publisher): void
    {
        $this->update(['publishing' => now()]);

        $publisher->publish($this);
    }
}
```

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

### Get Database Path

Source: https://laraxgram.github.io/v3/helpers.html

Use `database_path()` to get the full path to the database directory or a specific file within it.

```php
$path = database_path();

$path = database_path('factories/UserFactory.php');
```

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

### Registering a Simple Binding in a Service Provider

Source: https://laraxgram.github.io/v3/container.html

This example demonstrates how to register a concrete class binding ('Transistor') within a service provider using the 'bind' method and a closure. It shows how to resolve dependencies for the bound class.

```php
use App\Services\Transistor;
use App\Services\PodcastParser;
use LaraGram\Contracts\Foundation\Application;

$this->app->bind(Transistor::class, function (Application $app) {
    return new Transistor($app->make(PodcastParser::class));
});
```

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

### Get Configuration Path

Source: https://laraxgram.github.io/v3/helpers.html

Use `config_path()` to get the full path to the configuration directory or a specific configuration file.

```php
$path = config_path();

$path = config_path('app.php');
```

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

### Basic Controller Structure

Source: https://laraxgram.github.io/v3/validation.html

A simple controller with methods for creating and storing blog posts. The `store` method is initially left empty.

```php
<?php

namespace App\Controllers;

use LaraGram\Request\RedirectResponse;
use LaraGram\Request\Request;
use LaraGram\Tempalte\Tempalte;

class PostController extends Controller
{
    /**
     * Show the form to create a new blog post.
     */
    public function create(): Tempalte
    {
        return template('post.create');
    }

    /**
     * Store a new blog post.
     */
    public function store(Request $request): RedirectResponse
    {
        // Validate and store the blog post...

        $post = /** ... */;

        return to_listen('post.show', ['post' => $post->id]);
    }
}
```

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

### Get Application Path

Source: https://laraxgram.github.io/v3/helpers.html

Use `app_path()` to get the full path to the application directory or a specific file within it.

```php
$path = app_path();

$path = app_path('Http/Controllers/Controller.php');
```

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

### Get Files Within a Directory

Source: https://laraxgram.github.io/v3/filesystem.html

Use `files` to get files in a directory and `allFiles` to include files in subdirectories.

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

$files = Storage::files($directory);

$files = Storage::allFiles($directory);
```

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

### List all listens

Source: https://laraxgram.github.io/v3/listening.html

Use this command to display all configured bot listens.

```shell
php laragram listen:list -vv
```

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

### Remove multiple prefixes from the start of a string

Source: https://laraxgram.github.io/v3/strings.html

Removes the first occurrence of any value from an array of prefixes if the string starts with that value.

```php
use LaraGram\Support\Str;

$url = Str::of('http://laragram.com')->chopStart(['https://', 'http://']);

// 'laragram.com'
```

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

### Configure default listens in app.php

Source: https://laraxgram.github.io/v3/listening.html

The default configuration for bot and console listens is set in the bootstrap/app.php file.

```php
<?php

use LaraGram\Foundation\Application;

return Application::configure(basePath: dirname(__DIR__))
    ->withListening(
        bot: __DIR__."/../listens/bot.php",
        commands: __DIR__."/../listens/console.php",
    )->create();

```

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

### Create a Directory

Source: https://laraxgram.github.io/v3/filesystem.html

The `makeDirectory` method creates a directory, including any necessary parent directories.

```php
Storage::makeDirectory($directory);
```

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

### Install MongoDB PHP Extension

Source: https://laraxgram.github.io/v3/mongodb.html

Install the required mongodb PHP extension using PECL. This is necessary for connecting to a MongoDB database.

```shell
pecl install mongodb
```

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

### Run API Server

Source: https://laraxgram.github.io/simula.html

Compile and run the API server using Cargo. Navigate to the api-server directory first.

```bash
cd api-server
cargo run
```

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

### Using LaraGram Facades

Source: https://laraxgram.github.io/v3/facades.html

Demonstrates how to use LaraGram facades like `Bot` and `Cache` to interact with application features. Ensure necessary classes are imported.

```php
use LaraGram\Support\Facades\Cache;
use LaraGram\Support\Facades\Bot;
use LaraGram\Request\Request;

Bot::onText('get', function (Request $request) {
    $cache = Cache::get('key');
    
    $request->sendMessage(chat()->id, $cache);
});
```

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

### Create a Component in a Subdirectory

Source: https://laraxgram.github.io/v3/temple8.html

Organize components by placing them in subdirectories within the `app/Template/Components` and `app/templates/components` directories. The command structure reflects the directory nesting.

```shell
php laragram make:component Forms/Input
```

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

### Get Base Path

Source: https://laraxgram.github.io/v3/helpers.html

Use `base_path()` to get the full path to the project's root directory or a specific file within it.

```php
$path = base_path();

$path = base_path('vendor/bin');
```

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

### Template Facade vs. Helper Function

Source: https://laraxgram.github.io/v3/facades.html

Shows the equivalent usage of the Template facade and the `template` helper function for creating views. Both achieve the same result of making a 'profile' template.

```php
$profile = LaraGram\Support\Facades\Template::make('profile');

$profile = template('profile');
```

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

### Valid PHPDoc Block Example

Source: https://laraxgram.github.io/v3/contributions.html

An example of a correctly formatted PHPDoc block for registering a binding with the container. Note the spacing and attribute usage.

```php
/**
 * Register a binding with the container.
 *
 * @param  string|array  $abstract
 * @param  \Closure|string|null  $concrete
 * @param  bool  $shared
 * @return void
 *
 * @throws \Exception
 */
public function bind($abstract, $concrete = null, $shared = false)
{
    // ...
}
```

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

### Define Firewall Class with Variadic Filters

Source: https://laraxgram.github.io/v3/container.html

Example class demonstrating a constructor that accepts a Logger and a variadic array of Filter objects.

```php
<?php

use App\Models\Filter;
use App\Services\Logger;

class Firewall
{
    /**
     * The filter instances.
     *
     * @var array
     */
    protected $filters;

    /**
     * Create a new class instance.
     */
    public function __construct(
        protected Logger $logger,
        Filter ...$filters,
    )
    {
        $this->filters = $filters;
    }
}
```

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

### Apply Middleware with Multiple Parameters

Source: https://laraxgram.github.io/v3/middleware.html

Apply middleware to a listener and pass multiple parameters by delimiting them with commas.

```php
Bot::onText('edit {id}', function (string $id) {
    // ...
})->middleware(EnsureUserHasRole::class.':editor,publisher');
```

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

### Install Predis Package

Source: https://laraxgram.github.io/v3/redis.html

Install the Predis package via Composer if the PhpRedis extension is not available. This provides a Redis client written entirely in PHP.

```shell
composer require predis/predis

```

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

### Start Surge Server with Specific Worker Count

Source: https://laraxgram.github.io/v3/surge.html

Manually specify the number of application request workers to start using the `--workers` option.

```shell
php laragram surge:start --workers=4
```

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

### Create Collection Instance using make()

Source: https://laraxgram.github.io/v3/collections.html

Creates a new collection instance using the static `make` method. This is an alternative way to instantiate collections.

```php
use LaraGram\Support\Collection;

$collection = Collection::make([1, 2, 3]);
```

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

### Install Open Swoole PHP Extension

Source: https://laraxgram.github.io/v3/surge.html

Install the Open Swoole PHP extension using PECL, an alternative to Swoole for serving LaraGram Surge applications.

```shell
pecl install openswoole
```

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

### Configure Multiple Bot Connections

Source: https://laraxgram.github.io/v3/requests.html

Example configuration for multiple bot connections, including setting the default to 'auto' and defining unique 'secret_token' for each.

```php
'default' => 'auto',

'connections' => [
    'first' => [
        'token' => '',
        'secret_token' => "AAA",
    ],
    'second' => [
        'token' => '',
        'secret_token' => "BBB",
    ],
],
```

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

### Check if String Does Not Start With a Value

Source: https://laraxgram.github.io/v3/strings.html

Use `Str::doesntStartWith` to verify if a string does not begin with a given substring. It can also check if the string starts with any value from an array.

```php
use LaraGram\Support\Str;

$result = Str::doesntStartWith('This is my name', 'That');

// true
```

```php
$result = Str::doesntStartWith('This is my name', ['What', 'That', 'There']);

// true
```

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

### Create Job Batches Table and Migrate

Source: https://laraxgram.github.io/v3/queues.html

Generate the database migration for job batches and apply it.

```shell
php laragram make:queue-batches-table

php laragram migrate
```

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

### Get Language Path

Source: https://laraxgram.github.io/v3/helpers.html

Use `lang_path()` to get the full path to the language directory or a specific language file. Note: The `lang` directory may not be present by default.

```php
$path = lang_path();

$path = lang_path('en/messages.php');
```

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

### Multi-select Prompt with Defaults and Hint

Source: https://laraxgram.github.io/v3/prompts.html

Configure a multi-select prompt with predefined default selections and an informational hint. This pre-populates choices and guides the user.

```php
use function LaraGram\Console\Prompts\multiselect;

$permissions = multiselect(
    label: 'What permissions should be assigned?',
    options: ['Read', 'Create', 'Update', 'Delete'],
    default: ['Read', 'Create'],
    hint: 'Permissions may be updated at any time.'
);
```

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

### Injecting Dependencies into a Controller

Source: https://laraxgram.github.io/v3/container.html

This example shows how to inject a service dependency (AppleMusic) into a controller's constructor. This allows for easier mocking during testing.

```php
<?php

namespace App\Controllers;

use App\Services\AppleMusic;

class PodcastController extends Controller
{
    /**
     * Create a new controller instance.
     */
    public function __construct(
        protected AppleMusic $apple,
    ) {}

    /**
     * Show information about the given podcast.
     */
    public function show(string $id)
    {
        template('podcasts.show', [
            'podcast' => $this->apple->findPodcast($id)
        ]);
    }
}
```

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

### Build Queries with Constraints and `get`

Source: https://laraxgram.github.io/v3/eloquent.html

Chain query builder methods like `where`, `orderBy`, and `limit` to define specific criteria, then use `get` to retrieve the matching records. This allows for flexible data filtering and sorting.

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

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

### Create Redirect to Listen

Source: https://laraxgram.github.io/v3/redirects.html

Use the global `redirect` helper to create a redirect response to a specific listen. This is useful for handling commands that should navigate the user.

```php
Bot:onCommand('dashboard', function () {
    return redirect()->listen('home');
});
```

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

### Suggest with Placeholder, Default, and Hint

Source: https://laraxgram.github.io/v3/prompts.html

Enhance the suggest prompt with placeholder text, a default value, and an informational hint to guide the user.

```php
$name = suggest(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle'],
    placeholder: 'E.g. Taylor',
    default: $user?->name,
    hint: 'This will be displayed on your profile.'
);
```

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

### Get First Item or Throw Exception

Source: https://laraxgram.github.io/v3/collections.html

Use `firstOrFail` to retrieve the first item matching a condition or throw an exception if none is found. It can also be used without arguments to get the first item, throwing an exception if the collection is empty.

```php
collect([1, 2, 3, 4])->firstOrFail(function (int $value, int $key) {
    return $value > 5;
});

// Throws ItemNotFoundException...

```

```php
collect([])->firstOrFail();

// Throws ItemNotFoundException...

```

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

### Start a Conversation Sequence

Source: https://laraxgram.github.io/v3/step.html

Initiate a multi-step conversation by passing an ordered array of step names to `Step::startSequence`. The first step is automatically activated.

```php
use LaraGram\Support\Facades\Step;

Step::startSequence([
    'awaiting_name',
    'awaiting_email',
    'awaiting_confirmation',
]);

// The current step is now "awaiting_name"...
```

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

### Start Queue Worker

Source: https://laraxgram.github.io/v3/queues.html

Start a queue worker process using the `queue:work` command. This command will continuously process new jobs until manually stopped or the terminal is closed. For permanent background operation, use a process manager like Supervisor.

```shell
php laragram queue:work
```

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

### Using Named Slots with x-slot

Source: https://laraxgram.github.io/v3/temple8.html

This XML example shows how to pass content to a named 'title' slot and the default slot using x-slot.

```xml
<x-alert>
    <x-slot:title>
        Server Error
    </x-slot>

    <b>Whoops!</b> Something went wrong!
</x-alert>
```

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

### Define Hourly Rate Limiter for Backups

Source: https://laraxgram.github.io/v3/queues.html

Configure a custom rate limiter named 'backups' in the `boot` method of `AppServiceProvider`. This example allows one backup per hour per user, with no limit for VIP customers.

```php
use LaraGram\Cache\RateLimiting\Limit;
use LaraGram\Support\Facades\RateLimiter;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    RateLimiter::for('backups', function (object $job) {
        return $job->user->vipCustomer()
            ? Limit::none()
            : Limit::perHour(1)->by($job->user->id);
    });
}
```

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

### Create and Process a Collection

Source: https://laraxgram.github.io/v3/collections.html

Demonstrates creating a collection, applying a transformation (uppercase), and filtering out empty elements.

```php
$collection = collect(['Taylor', 'Abigail', null])->map(function (?string $name) {
    return strtoupper($name);
})->reject(function (string $name) {
    return empty($name);
});
```

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

### Retrieve All Arguments

Source: https://laraxgram.github.io/v3/commander.html

Get all arguments passed to the command as an array.

```php
$arguments = $this->arguments();
```

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

### Get all items as an array

Source: https://laraxgram.github.io/v3/collections.html

Returns the underlying array representation of the collection.

```php
collect([1, 2, 3])->all();

// [1, 2, 3]
```

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

### Str::substr()

Source: https://laraxgram.github.io/v3/strings.html

Returns the portion of string specified by the start and length parameters.

```APIDOC
## Str::substr()

### Description
Returns the portion of string specified by the start and length parameters.

### Method
```php
Str::substr(string $string, int $start, ?int $length = null)
```

### Parameters
#### Arguments
- **string** (string) - The input string.
- **start** (int) - The starting position.
- **length** (int|null, optional) - The length of the substring. If null, returns from start to the end of the string.

### Request Example
```php
use LaraGram\Support\Str;

$converted = Str::substr('The LaraGram Framework', 4, 7);

// LaraGram
```
```

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

### Registering a Service with Configuration

Source: https://laraxgram.github.io/v3/surge.html

This snippet shows how to register a service that depends on the configuration repository. Avoid injecting the configuration repository directly into singleton constructors if configuration values might change.

```php
use App\Service;
use LaraGram\Contracts\Foundation\Application;

/**
 * Register any application services.
 */
public function register(): void
{
    $this->app->singleton(Service::class, function (Application $app) {
        return new Service($app->make('config'));
    });
}
```

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

### Get Validated Data

Source: https://laraxgram.github.io/v3/validation.html

Retrieve an array of validated data from a validator instance.

```php
$validated = $validator->validated();
```

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

### Prepend and Append to Files

Source: https://laraxgram.github.io/v3/filesystem.html

Use `prepend` to add content to the beginning of a file and `append` to add content to the end.

```php
Storage::prepend('file.log', 'Prepended Text');

Storage::append('file.log', 'Appended Text');
```

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

### Get Default Locale

Source: https://laraxgram.github.io/v3/helpers.html

Retrieves the default locale setting for the Number class.

```php
use LaraGram\Support\Number;

$locale = Number::defaultLocale();

// en
```

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

### Start Queue Listener (Less Efficient)

Source: https://laraxgram.github.io/v3/queues.html

Use the `queue:listen` command as an alternative to `queue:work`. This command automatically reloads updated code and resets application state between jobs but is less efficient. It is not recommended for production environments.

```shell
php laragram queue:listen
```

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

### Defining Translation Strings with Placeholders

Source: https://laraxgram.github.io/v3/localization.html

Example of a translation string with a ':name' placeholder.

```php
'welcome' => 'Welcome, :name',
```

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

### Create Queue Table

Source: https://laraxgram.github.io/v3/queues.html

Use this command to create the database table required for the database queue driver if it's not already present.

```shell
php laragram make:queue-table

php laragram migrate
```

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

### Replace if String Starts With

Source: https://laraxgram.github.io/v3/strings.html

The `replaceStart` method replaces a substring only if it appears at the beginning of the string.

```php
use LaraGram\Support\Str;

$replaced = Str::of('Hello World')->replaceStart('Hello', 'LaraGram');

// LaraGram World

$replaced = Str::of('Hello World')->replaceStart('World', 'LaraGram');

// Hello World
```

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

### Connect to Database CLI

Source: https://laraxgram.github.io/v3/database.html

Use the 'db' Commander command to connect to your database's command-line interface. Specify a connection name to target a non-default database.

```shell
php laragram db
```

```shell
php laragram db mysql
```

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

### Get Default Currency

Source: https://laraxgram.github.io/v3/helpers.html

Retrieves the default currency symbol configured for the Number class.

```php
use LaraGram\Support\Number;

$currency = Number::defaultCurrency();

// USD
```

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

### Using Cache Facade vs. Cache Helper Function

Source: https://laraxgram.github.io/v3/facades.html

Compares using the `Cache` facade with the global `cache()` helper function to retrieve data. Helper functions are globally available and do not require imports.

```php
use LaraGram\Support\Facades\Cache;

Bot::onText('users', function () {
    $data = Cache::get('users');
    // ...
});
```

```php
Bot::onText('users', function () {
    $data = cache()->get('users');
    // ...
});
```

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

### Publish Configuration Files

Source: https://laraxgram.github.io/v3/configuration.html

The `config:publish` command is used to publish configuration files that are not published by default. Use the `--all` flag to publish all configuration files.

```shell
php laragram config:publish
```

```shell
php laragram config:publish --all
```

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

### SQL Equivalent for Grouped OrWhere

Source: https://laraxgram.github.io/v3/queries.html

The SQL generated for the grouped 'orWhere' clause example.

```sql
select * from users where votes > 100 or (name = 'Abigail' and votes > 50)
```

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

### Create New Model Instance with `create` Method

Source: https://laraxgram.github.io/v3/eloquent.html

Use the `create` method for a concise way to insert a new model. Ensure `fillable` or `guarded` properties are set on the model to prevent mass assignment vulnerabilities.

```php
use App\Models\Flight;

$flight = Flight::create([
    'name' => 'London to Paris',
]);
```

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

### Step Facade Methods

Source: https://laraxgram.github.io/v3/step.html

Reference for the methods available on the Step facade for managing user steps and sequences.

```APIDOC
## Step Facade Methods

### Description
The following methods are available on the `Step` facade for managing user steps and sequences.

### Method Reference

| Method | Description |
|---|---|
| `set(string $key, int $ttl = null)` | Clear any existing step and store a new one, optionally with a TTL in seconds. |
| `get()` | Get the current step, or `null` if none is set. |
| `pull()` | Get the current step and immediately remove it. |
| `forget()` | Remove the current step. |
| `hasStep()` | Determine if the user has any active step. |
| `hasNotStep()` | Determine if the user has no active step. |
| `is(string $key)` | Determine if the current step strictly equals the given value. |
| `isNot(string $key)` | Determine if the current step does not equal the given value. |
| `startSequence(array $sequence)` | Start a new sequence and activate its first step. |
| `endSequence()` | Clear the sequence and the active step. |
| `next()` | Advance to the next step in the sequence. |
| `previous()` | Move back to the previous step in the sequence. |
| `current()` | Get the current step name in the sequence, or `null`. |
| `isFirst()` | Determine if the current step is the first in the sequence. |
| `isLast()` | Determine if the current step is the last in the sequence. |
| `getSequence()` | Get the raw sequence array, or `null` if none exists. |
```

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

### Str::replaceStart()

Source: https://laraxgram.github.io/v3/strings.html

Replaces the first occurrence of the given value only if the value appears at the start of the string.

```APIDOC
## Str::replaceStart()

### Description
Replaces the first occurrence of the given value only if the value appears at the start of the string.

### Method
```php
Str::replaceStart(string $search, string $replace, string $subject)
```

### Parameters
#### Arguments
- **search** (string) - The value to search for at the beginning of the string.
- **replace** (string) - The value to replace with.
- **subject** (string) - The string to perform the replacement on.

### Request Example
```php
use LaraGram\Support\Str;

$replaced = Str::replaceStart('Hello', 'LaraGram', 'Hello World');

// LaraGram World

$replaced = Str::replaceStart('World', 'LaraGram', 'Hello World');

// Hello World
```
```

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

### Get All Error Messages for All Fields

Source: https://laraxgram.github.io/v3/validation.html

Retrieve an array containing all error messages for all validated fields.

```php
foreach ($errors->all() as $message) {
    // ...
}
```

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

### Defining Global Parameter Constraints

Source: https://laraxgram.github.io/v3/listening.html

Use the `pattern` method in the `AppServiceProvider`'s `boot` method to define global regular expression constraints for specific parameter names, applying them to all listens using that parameter.

```php
use LaraGram\Support\Facades\Bot;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Bot::pattern('id', '[0-9]+');
}
```

```php
Bot::onText('user {id}', function (string $id) {
    // Only executed if {id} is numeric...
});
```

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

### Basic Suggestion Prompt

Source: https://laraxgram.github.io/v3/prompts.html

Use the `suggest` function to provide a list of predefined options for user input. The selected option's value will be returned.

```php
$name = suggest('What is your name?', ['Taylor', 'Dayle']);
```
Tokens:
Raw