Laravel Localizations

https://github.com/laravel-lang/lang
Admin
Laravel Localizations provides a comprehensive collection of 126 language files for Laravel...
Tokens:14,739
Snippets:288
Trust Score:7.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install package and publisher dependency

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/ServiceProvider.md

Command to install the package and its dependency in a Laravel application. After installation, Laravel automatically discovers and registers the service provider, making the Plugin class available in the container without additional application code.

```bash
composer require laravel-lang/lang laravel-lang/publisher

```

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

### Direct instantiation and manual registration

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/ServiceProvider.md

Direct instantiation of the service provider outside the Laravel container. This example shows how to manually create the provider with an Application instance and call register(). When the publisher dependency is absent, the call has no effect and raises no error.

```php
use LaravelLang\Lang\ServiceProvider;
use Illuminate\Container\Application;

$app    = new Application();
$plugin = new ServiceProvider($app);

$plugin->register();

// Effect of the call when the publisher dependency is not installed:
// class_exists('LaravelLang\\Publisher\\Plugins\\Provider') is false,
// so nothing is registered and no error is raised.

```

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

### Read plugin file map with files()

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/plugins.md

Use the public files() method on a plugin instance to iterate source-to-destination mappings. The example prints each mapping, e.g., framework/13.x/framework.json -> {locale}.json.

```php
use LaravelLang\Lang\Plugins\Laravel\V13;

$plugin = new V13();

foreach ($plugin->files() as $source => $destination) {
    echo "$source -> $destination"; // e.g. framework/13.x/framework.json -> {locale}.json
}
```

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

### Select plugin variant by framework version

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/plugins.md

Selects the appropriate plugin class based on the installed Laravel framework major version. Throws RuntimeException for unsupported versions.

```php
use LaravelLang\Lang\Plugins\Laravel\V11;
use LaravelLang\Lang\Plugins\Laravel\V12;
use LaravelLang\Lang\Plugins\Laravel\V13;

$picked = match (laravel_framework_major_version) {
    11 => new V11(),
    12 => new V12(),
    13 => new V13(),
    default => throw new RuntimeException('Unsupported framework major'),
};
```

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

### Register Plugin with Laravel Application Manually

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/Plugin.md

Use this snippet to manually register the Plugin provider when bypassing Laravel auto-discovery. It requires the publisher dependency to be installed, guarded by class_exists. The code retrieves the application instance and registers the plugin if the publisher provider class exists.

```php
use LaravelLang\Lang\Plugin;

$app = app(); // Illuminate\Container\Application or Laravel app instance

if (class_exists('LaravelLang\\Publisher\\Plugins\\Provider')) {
    $app->register(Plugin::class);
}
```

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

### Laravel auto-discovery configuration in composer.json

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/ServiceProvider.md

Composer metadata that enables Laravel's auto-discovery of the service provider. This entry in composer.json causes Laravel to automatically register LaravelLang\Lang\ServiceProvider when the package is installed.

```json
"extra": {
    "laravel": {
        "providers": [
            "LaravelLang\\Lang\\ServiceProvider"
        ]
    }
}

```

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

### Download CLI invocation in GitHub Actions

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/configuration.md

This command is used in the .github/workflows/download.yml file to download and process framework translation files. It utilizes specific flags for the publisher's lang binary.

```bash
vendor/bin/lang download \
    --url=https://github.com/laravel/framework/archive/refs/heads/${{ matrix.version }}.zip \
    --project=framework \
    --ver=${{ matrix.version }} \
    --copy=src/Illuminate/Translation/lang
```

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

### Subclass Plugin to Fork or Extend Provider

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/Plugin.md

Use this snippet to create a custom plugin by extending the base Plugin class. Override the protected properties package_name, base_path, and plugins to customize the package. Note that the merging semantics of the plugins array are defined by the publisher base class and are not verifiable from this repository.

```php
declare(strict_types=1);

namespace MyVendor\Lang;

use LaravelLang\Lang\Plugin;
use MyVendor\Lang\Plugins\Acme\V1;

final class MyPlugin extends Plugin
{
    protected ?string $package_name = 'my-vendor/lang';

    protected string $base_path = __DIR__ . '/../';

    protected array $plugins = [
        V1::class,

        Plugins\Breeze\Master::class, // re-declare stock plugins as needed
    ];
}
```

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

### files(): array Full Signature

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/plugins.md

The exact signature of the public files() method, identical in all 21 files.

```php
public function files(): array
```

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

### LaravelLang\Lang\Plugins\Nova\DuskSuite\Main plugin class

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/plugins.md

Full source of the Main plugin class for the Nova Dusk Suite. It declares only the vendor 'laravel/nova-dusk-suite' and a files() map; it has no version property. This is one of the three classes without a version property.

```php
declare(strict_types=1);

namespace LaravelLang\Lang\Plugins\Nova\DuskSuite;

use LaravelLang\Publisher\Plugins\Plugin;

class Main extends Plugin
{
    protected ?string $vendor = 'laravel/nova-dusk-suite';

    public function files(): array
    {
        return [
            'nova/dusk-suite/master/dusk-suite.json' => '{locale}.json',
            'nova/dusk-suite/master/en.json'         => '{locale}.json',
        ];
    }
}
```

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

### register() method signature

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/ServiceProvider.md

The method signature for the register() method. It takes no parameters and returns void. The method conditionally registers the Plugin class with the application container based on the existence of the Provider class.

```php
public function register(): void

```

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

### Common Plugin Class Template

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/plugins.md

All 21 plugin classes share this shape, differing only in namespace, vendor, version, and the files() map. The $version property is absent in three classes.

```php
declare(strict_types=1);

namespace LaravelLang\Lang\Plugins\<Product>\...;

use LaravelLang\Publisher\Plugins\Plugin;

class <Name> extends Plugin
{
    protected ?string $vendor = '<vendor/package>';

    protected string $version = '<composer-constraint>';

    public function files(): array
    {
        return [
            '<source/relative/path>' => '<destination-template>',
            // ...
        ];
    }
}
```

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

### LaravelLang\Lang\Plugin class declaration

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/Plugin.md

The root provider class of the laravel-lang/lang package. It extends LaravelLang\Publisher\Plugins\Provider and declares three protected properties: package_name, base_path, and plugins. The plugins array lists all product plugin classes that the provider aggregates.

```php
declare(strict_types=1);

namespace LaravelLang\Lang;

use LaravelLang\Publisher\Plugins\Provider;

class Plugin extends Provider
{
    protected ?string $package_name = 'laravel-lang/lang';

    protected string $base_path = __DIR__ . '/../';

    protected array $plugins = [
        Plugins\Breeze\Master::class,
        Plugins\Breeze\V2::class,

        Plugins\Cashier\Stripe\Master::class,
        Plugins\Cashier\Stripe\V15::class,

        Plugins\Fortify\Master::class,
        Plugins\Fortify\V1::class,

        Plugins\Jetstream\Master::class,
        Plugins\Jetstream\V5::class,

        Plugins\Laravel\Master::class,
        Plugins\Laravel\V11::class,
        Plugins\Laravel\V12::class,
        Plugins\Laravel\V13::class,

        Plugins\Nova\LogViewer\Main::class,
        Plugins\Nova\V4::class,
        Plugins\Nova\V5::class,

        Plugins\Nova\DuskSuite\Main::class,

        Plugins\Passkeys\Main::class,

        Plugins\Spark\Paddle::class,
        Plugins\Spark\Stripe::class,

        Plugins\UI\Master::class,
        Plugins\UI\V4::class,
    ];
}
```

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

### ServiceProvider class declaration

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/ServiceProvider.md

The full class declaration of LaravelLang\Lang\ServiceProvider. It extends Illuminate\Support\ServiceProvider and conditionally registers the Plugin class only when the LaravelLang\Publisher\Plugins\Provider class exists, making the registration a no-op if the publisher dependency is missing.

```php
declare(strict_types=1);

namespace LaravelLang\Lang;

use Illuminate\Support\ServiceProvider as BaseServiceProvider;
use LaravelLang\Publisher\Plugins\Provider;

class ServiceProvider extends BaseServiceProvider
{
    public function register(): void
    {
        if (class_exists(Provider::class)) {
            $this->app->register(Plugin::class);
        }
    }
}

```

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

### LaravelLang\Lang\Plugins\Laravel\V13 plugin class

Source: https://github.com/laravel-lang/lang/blob/main/_autodocs/api-reference/plugins.md

Full source of the V13 plugin class, which extends LaravelLang\Publisher\Plugins\Plugin. It declares the vendor 'laravel/framework', version '^13.0', and a files() map that publishes framework JSON and PHP language files to the locale directory. This is the richest files() map among the 21 plugin classes.

```php
declare(strict_types=1);

namespace LaravelLang\Lang\Plugins\Laravel;

use LaravelLang\Publisher\Plugins\Plugin;

class V13 extends Plugin
{
    protected ?string $vendor = 'laravel/framework';

    protected string $version = '^13.0';

    public function files(): array
    {
        return [
            'framework/13.x/framework.json' => '{locale}.json',

            'framework/extended.json' => '{locale}.json',

            'framework/13.x/auth.php'       => '{locale}/auth.php',
            'framework/13.x/pagination.php' => '{locale}/pagination.php',
            'framework/13.x/passwords.php'  => '{locale}/passwords.php',
            'framework/13.x/validation.php' => '{locale}/validation.php',
        ];
    }
}
```
Tokens:
Raw