Download the PHP package ad7six/shadow-translate without Composer
On this page you can find all versions of the php package ad7six/shadow-translate. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ad7six/shadow-translate
More information about ad7six/shadow-translate
Files in ad7six/shadow-translate
Package shadow-translate
Short Description Manage translated content with shadow tables
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package shadow-translate
Note:
As of CakePHP 4.0 the ability to use shadow tables for storing translated content is available through core's Translate behavior itself. Check the CakePHP manual for more details.
Shadow translate #ARCHIVED
This plugin uses a shadow table for translated content, instead of the core's more flexible (but also potentially quite inefficient) EAV-style translate behavior. The shadow translate behavior is designed to have the same API as the core's translate behavior making it a drop-in replacement in terms of usage.
Quickstart
First install the plugin for your app using composer:
php composer.phar require ad7six/shadow-translate
Load the plugin by adding following statement to your app's config/bootstrap.php:
The shadow translate behavior expects each table to have its own translation table. Taking the blog tutorial as a start point, the following table would already exist:
To prepare for using the shadow translate behavior, the following table would be created:
Note that the id is the same type as the posts table - but the primary key is a compound key using both id and locale.
Usage is very similar to the core's behavior so e.g.:
You can specify the fields in the translation table - but if you don't they are derived from the translation table schema. From this point forward, see the documentation for the core translate behavior, the shadow translate behavior should act the same, and if it doesn't, well, see below.
Why use Shadow Translate
The standard translate behavior uses an EAV style translations table, and one join per field. By default all translations are stored in the same translation table. To give an example, the core translation behavior generates sql of the form:
There is very little setup for the core translate behavior, but the cost for no-setup is sql complexity, and it is more complex for each translated field. Depending on how much data there is being translated - it's quite possible for this data structure to cause slow queries; it also complicates finding records by translated field values.
Key points:
- Easy to setup
- All translated content stored in the same table
- One join per translated field when querying
- Less efficient queries - more joins and one index for all content
- Harder to find by translated content
By contrast, the shadow translate behavior does not use an EAV style translation table, the translations are stored in a copy of the main data table. This permits much less complex sql at the cost of having some setup steps per table. The shadow translate behavior generates sql of the form:
Key points:
- (Slightly) more work to setup
- Translated content is stored in a copy of the main data table
- One join per translated table
- More efficient queries - less joins and indexes per translated field are possible
- Easier to find by translated content
Roadmap
The initial release is only the behavior, it is planned for the future to add:
- A shell to create shadow tables (migration based)
- A shell to import from the core's i18n table
- A shell to export to the core's i18n table
Bugs
Most likely!
If you happen to stumble upon a bug, please feel free to create a pull request with a fix (optionally with a test), and a description of the bug and how it was resolved.
You can also create an issue with a description to raise awareness of the bug.
Support / Questions
If you have a problem, if no one else can help, and if you can find them, maybe you can find help on IRC in the #FriendsOfCake channel.
