www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/translation/Extractor/ExtractorInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\Translation\Extractor;
  13
  14 use Symfony\Component\Translation\MessageCatalogue;
  15
  16 /**
  17  * Extracts translation messages from a directory or files to the catalogue.
  18  * New found messages are injected to the catalogue using the prefix.
  19  *
  20  * @author Michel Salib <michelsalib@hotmail.com>
  21  */
  22 interface ExtractorInterface
  23 {
  24     /**
  25      * Extracts translation messages from files, a file or a directory to the catalogue.
  26      *
  27      * @param string|array     $resource  Files, a file or a directory
  28      * @param MessageCatalogue $catalogue The catalogue
  29      */
  30     public function extract($resource, MessageCatalogue $catalogue);
  31
  32     /**
  33      * Sets the prefix that should be used for new found messages.
  34      *
  35      * @param string $prefix The prefix
  36      */
  37     public function setPrefix($prefix);
  38 }