wickedone/phrase-tag-bundle

helpers to deal with your phrase translations

2.2.0 2024-08-16 20:11 UTC

Requires

• php: ~8.2.0 || ~8.3.0
• symfony/config: ^6.4 || ^7.0
• symfony/console: ^6.4 || ^7.0
• symfony/framework-bundle: ^6.4 || ^7.0
• symfony/http-client: ^6.4 || ^7.0
• symfony/monolog-bundle: ^3.10.0
• symfony/translation: ^6.4 || ^7.0

Requires (Dev)

• infection/infection: ^0.29
• matthiasnoback/symfony-dependency-injection-test: ^6.0.0
• phpstan/phpstan: ^1.11.10
• phpstan/phpstan-deprecation-rules: ^1.2.0
• phpstan/phpstan-php-parser: ^1.1
• phpstan/phpstan-phpunit: ^1.4.0
• phpunit/phpunit: ^10.5.11 || ^11.0
• roave/security-advisories: dev-latest
• vimeo/psalm: dev-master

MIT

• wickedOne

README

providing some commands & services to help you manage your translation keys at phrase. this might be especially usefull when you switched to using the phrase translation provider.

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require wickedone/phrase-tag-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require wickedone/phrase-tag-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    WickedOne\PhraseTagBundle\WickedOnePhraseTagBundle::class => ['all' => true],
];

step 3: configuration

in your config/packages directory create a wickedone.yaml file with the following content:

wicked_one_phrase_tag:
  dsn: '%env(PHRASE_DSN)%'

and in your .env file define the phrase dsn like so

PHRASE_DSN=phrase://PROJECT_ID:API_TOKEN@default?userAgent=myProject

dsn elements

• PROJECT_ID: can be retrieved in phrase from project settings > API > Project ID
• API_TOKEN: can be created in your phrase profile settings
• default: endpoint, defaults to api.phrase.com

dsn query parameters

• userAgent: please read this for some examples.

Commands

After installation two new commands will be available to your application:

phrase:keys:tag command

this command helps you to batch tag keys in phrase by querying for existing tags and / or key name. you can search for multiple tags at once and a broad search on key name using the * wildcard. keep in mind the query is an AND query, meaning the keys have to match all criteria.

example:

php bin/console phrase:keys:tag -k error.* -t ticket-15 -t ticket-13 --tag epic-5

this will search for all keys matching the name error.* and with tags ticket-15 AND ticket-13 and will add the tag epic-5 to them.

when you add the --dry-run option to the command, it will list the first 100 matches to your query.

phrase:keys:untag command

this command helps you to batch remove tags from keys in phrase by querying for existing tags and / or key name. you can search for multiple tags at once and a broad search on key name using the * wildcard. keep in mind the query is an AND query, meaning the keys have to match all criteria.

example:

php bin/console phrase:keys:untag -k error.* -t ticket-15 -t ticket-13 --tag epic-5

this will search for all keys matching the name error.* and with tags ticket-15 AND ticket-13 and will remove the tag epic-5 from them.

when you add the --dry-run option to the command, it will list the first 100 matches to your query.