PHPackages                             scafera/translate - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Localization & i18n](/categories/localization)
4. /
5. scafera/translate

ActiveSymfony-bundle[Localization & i18n](/categories/localization)

scafera/translate
=================

Translation for the Scafera framework

v1.0.2(1mo ago)07MITPHPPHP >=8.4

Since Apr 14Pushed 1mo agoCompare

[ Source](https://github.com/scafera/translate)[ Packagist](https://packagist.org/packages/scafera/translate)[ Docs](https://github.com/scafera/translate)[ RSS](/packages/scafera-translate/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (3)Dependencies (3)Versions (4)Used By (0)

scafera/translate
=================

[](#scaferatranslate)

Translation for the Scafera framework. UI string translation with locale management, RTL support, and Twig integration.

Internally adopts `symfony/translation`. Userland code never imports Symfony Translation types — boundary enforcement blocks it at compile time.

> **Provides:** UI string translation for Scafera — `Translator` for lookup, `LocaleManager` for locale switching (with RTL detection). Flat JSON translation files with `{name}` parameter syntax (not Symfony's `%name%`). When `scafera/frontend` is installed, a companion bundle registers `{{ t() }}` and `{{ locale_direction() }}` Twig functions automatically.
>
> **Depends on:** A Scafera host project whose architecture package defines a translations directory via `getTranslationsDir()` (e.g. `resources/translations/` in `scafera/layered`). Twig integration activates only when `scafera/frontend` is installed.
>
> **Extension points:** None of its own — `Translator` and `LocaleManager` are consumed as services. New locales are picked up by adding `{locale}.json` files to the translations directory. Locale behavior is tuned via two parameters in `config/config.yaml`: `scafera.translate.default_locale` and `scafera.translate.rtl_locales`.
>
> **Not responsible for:** Non-JSON translation formats (no YAML, no XLIFF — deliberate) · multi-level fallback chains (single fallback to default locale only) · choosing the translations directory (architecture package owns `getTranslationsDir()`) · direct use of `Symfony\Component\Translation` types in userland (blocked by `TranslateBoundaryPass` and `TranslateBoundaryValidator`).

This is a **capability package**. It adds optional translation to a Scafera project. It does not define folder structure or architectural rules — those belong to architecture packages.

What it provides
----------------

[](#what-it-provides)

- `Translator` — get translated strings with `{name}` parameter replacement
- `LocaleManager` — locale switching, available locales, RTL detection
- `JsonFileLoader` — loads flat JSON translation files (internal)
- Twig integration — `{{ t() }}` and `{{ locale_direction() }}` (when `scafera/frontend` is installed)
- Companion bundle auto-discovery via `extra.scafera-bundles` in composer.json

Design decisions
----------------

[](#design-decisions)

- **`{name}` parameter syntax, not `%name%`** — translation files use `{name}` for parameter placeholders. This is engine-independent (Symfony uses `%name%`) and human-readable. Replacement is done after Symfony's `trans()` call via simple `strtr()`.
- **Translations directory is architecture-owned** — defined by `getTranslationsDir()` on the architecture package, not hardcoded. For `scafera/layered`, this is `resources/translations/`.
- **JSON only** — no YAML, no XLIFF. Flat key-value format. Keeps translation files simple and parseable by any tooling.
- **Companion bundle for Twig** — the `{{ t() }}` function is registered via `extra.scafera-bundles` companion discovery (ADR-056), not by requiring `scafera/frontend` as a dependency. The translate package works without Twig.
- **Missing keys return the raw key** — `get('MISSING')` returns `'MISSING'`, not an error. Fallback to default locale is automatic for keys that exist in another locale.

Installation
------------

[](#installation)

```
composer require scafera/translate
```

Requirements
------------

[](#requirements)

- PHP >= 8.4
- scafera/kernel

Translation files
-----------------

[](#translation-files)

JSON files in the architecture-defined translations directory (e.g., `resources/translations/{locale}.json`):

```
{
    "WELCOME": "Welcome to the app!",
    "GREETING": "Hello, {name}!"
}
```

Flat key-value format. No nesting, no YAML, no XLIFF. Parameters use `{name}` syntax — not Symfony's `%name%` format. This keeps translation files engine-independent and human-readable.

Usage
-----

[](#usage)

```
use Scafera\Translate\Translator;

$translator->get('WELCOME');                        // 'Welcome to the app!'
$translator->get('GREETING', ['name' => 'Alice']);  // 'Hello, Alice!'
$translator->has('WELCOME');                        // true
$translator->getLocale();                           // 'en'
$translator->getDirection();                        // 'ltr'
```

Missing keys return the raw key string. Fallback to the default locale is automatic.

Locale management
-----------------

[](#locale-management)

```
use Scafera\Translate\LocaleManager;

$localeManager->setLocale('ar');
$localeManager->getLocale();              // 'ar'
$localeManager->getDirection();           // 'rtl'
$localeManager->getDirection('en');       // 'ltr'
$localeManager->getAvailableLocales();    // ['ar', 'en']
```

Available locales are discovered from `*.json` files in the translations directory.

Twig integration
----------------

[](#twig-integration)

When `scafera/frontend` is installed, a companion bundle registers automatically:

```

    {{ t('WELCOME') }}
    {{ t('GREETING', {name: user.name}) }}

```

Configuration
-------------

[](#configuration)

All configuration is optional. The package works out of the box with sensible defaults.

ParameterDefaultDescription`scafera.translate.default_locale``en`Default locale used when no locale is set. Also used as the fallback locale when a key is missing in the current locale.`scafera.translate.rtl_locales``[ar, fa, ur]`Locale codes that use right-to-left text direction. `LocaleManager::getDirection()` returns `'rtl'` for these.**Not configurable via parameters:**

- Translation files directory — defined by the architecture package via `getTranslationsDir()`. For `scafera/layered`, this is `resources/translations/`.
- File format — JSON only. No YAML, no XLIFF.
- Fallback chain — always falls back to the default locale. No multi-level fallback.

To override defaults, add to `config/config.yaml`:

```
# config/config.yaml
parameters:
    scafera.translate.default_locale: fr
    scafera.translate.rtl_locales: [ar, fa, ur]
```

If you are using `en` as your default locale and the standard RTL set, no configuration is needed.

Boundary enforcement
--------------------

[](#boundary-enforcement)

BlockedUse instead`Symfony\Component\Translation\*``Scafera\Translate\Translator`Enforced via compiler pass (build time) and validator (`scafera validate`). Detects `use`, `new`, and `extends` patterns.

License
-------

[](#license)

MIT

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance90

Actively maintained with recent releases

Popularity4

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~2 days

Total

3

Last Release

51d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e9233f415f42755f68dc3006e2853b76c34de54b04c9535202b70aa147790e6a?d=identicon)[samaphp](/maintainers/samaphp)

---

Top Contributors

[![samaphp](https://avatars.githubusercontent.com/u/531627?v=4)](https://github.com/samaphp "samaphp (4 commits)")

---

Tags

phptranslatelocalescafera

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/scafera-translate/health.svg)

```
[![Health](https://phpackages.com/badges/scafera-translate/health.svg)](https://phpackages.com/packages/scafera-translate)
```

###  Alternatives

[codezero/laravel-localized-routes

A convenient way to set up, manage and use localized routes in a Laravel app.

543656.8k4](/packages/codezero-laravel-localized-routes)[codezero/browser-locale

Get the most preferred locales from your visitor's browser.

161.9M16](/packages/codezero-browser-locale)[opgginc/codezero-laravel-localized-routes

A convenient way to set up, manage and use localized routes in a Laravel app.

30109.8k1](/packages/opgginc-codezero-laravel-localized-routes)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)