annotate vendor/symfony/translation/Extractor/ExtractorInterface.php @ 19:fa3358dc1485 tip

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