Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Annotation;
Chris@0: 
Chris@0: use Drupal\Component\Annotation\AnnotationBase;
Chris@0: use Drupal\Core\StringTranslation\TranslatableMarkup;
Chris@0: 
Chris@0: /**
Chris@0:  * @defgroup plugin_translatable Annotation for translatable text
Chris@0:  * @{
Chris@0:  * Describes how to put translatable UI text into annotations.
Chris@0:  *
Chris@0:  * When providing plugin annotation, properties whose values are displayed in
Chris@0:  * the user interface should be made translatable. Much the same as how user
Chris@0:  * interface text elsewhere is wrapped in t() to make it translatable, in plugin
Chris@0:  * annotation, wrap translatable strings in the @ Translation() annotation.
Chris@0:  * For example:
Chris@0:  * @code
Chris@0:  *   title = @ Translation("Title of the plugin"),
Chris@0:  * @endcode
Chris@0:  * Remove spaces after @ in your actual plugin - these are put into this sample
Chris@0:  * code so that it is not recognized as annotation.
Chris@0:  *
Chris@0:  * To provide replacement values for placeholders, use the "arguments" array:
Chris@0:  * @code
Chris@0:  *   title = @ Translation("Bundle !title", arguments = {"!title" = "Foo"}),
Chris@0:  * @endcode
Chris@0:  *
Chris@0:  * It is also possible to provide a context with the text, similar to t():
Chris@0:  * @code
Chris@0:  *   title = @ Translation("Bundle", context = "Validation"),
Chris@0:  * @endcode
Chris@0:  * Other t() arguments like language code are not valid to pass in. Only
Chris@0:  * context is supported.
Chris@0:  *
Chris@0:  * @see i18n
Chris@0:  * @see annotation
Chris@0:  * @}
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a translatable annotation object.
Chris@0:  *
Chris@0:  * Some metadata within an annotation needs to be translatable. This class
Chris@0:  * supports that need by allowing both the translatable string and, if
Chris@0:  * specified, a context for that string. The string (with optional context)
Chris@0:  * is passed into t().
Chris@0:  *
Chris@0:  * @ingroup plugin_translatable
Chris@0:  *
Chris@0:  * @Annotation
Chris@0:  */
Chris@0: class Translation extends AnnotationBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * The string translation object.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\StringTranslation\TranslatableMarkup
Chris@0:    */
Chris@0:   protected $translation;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new class instance.
Chris@0:    *
Chris@0:    * Parses values passed into this class through the t() function in Drupal and
Chris@0:    * handles an optional context for the string.
Chris@0:    *
Chris@0:    * @param array $values
Chris@0:    *   Possible array keys:
Chris@0:    *   - value (required): the string that is to be translated.
Chris@0:    *   - arguments (optional): an array with placeholder replacements, keyed by
Chris@0:    *     placeholder.
Chris@0:    *   - context (optional): a string that describes the context of "value";
Chris@0:    */
Chris@0:   public function __construct(array $values) {
Chris@0:     $string = $values['value'];
Chris@0:     $arguments = isset($values['arguments']) ? $values['arguments'] : [];
Chris@0:     $options = [];
Chris@0:     if (!empty($values['context'])) {
Chris@0:       $options = [
Chris@0:         'context' => $values['context'],
Chris@0:       ];
Chris@0:     }
Chris@0:     $this->translation = new TranslatableMarkup($string, $arguments, $options);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function get() {
Chris@0:     return $this->translation;
Chris@0:   }
Chris@0: 
Chris@0: }