vendor/symfony/intl/Symfony/Component/Intl/ResourceBundle/Transformer/Rule/TransformationRuleInterface.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\Intl\ResourceBundle\Transformer\Rule;
  13
  14 use Symfony\Component\Intl\ResourceBundle\Transformer\CompilationContextInterface;
  15 use Symfony\Component\Intl\ResourceBundle\Transformer\StubbingContextInterface;
  16
  17 /**
  18  * Contains instruction for compiling a resource bundle.
  19  *
  20  * @author Bernhard Schussek <bschussek@gmail.com>
  21  */
  22 interface TransformationRuleInterface
  23 {
  24     /**
  25      * Returns the name of the compiled resource bundle.
  26      *
  27      * @return string The name of the bundle.
  28      */
  29     public function getBundleName();
  30
  31     /**
  32      * Runs instructions to be executed before compiling the sources of the
  33      * resource bundle.
  34      *
  35      * @param CompilationContextInterface $context The contextual information of
  36      *                                             the compilation.
  37      *
  38      * @return string[] The source directories/files of the bundle.
  39      */
  40     public function beforeCompile(CompilationContextInterface $context);
  41
  42     /**
  43      * Runs instructions to be executed after compiling the sources of the
  44      * resource bundle.
  45      *
  46      * @param CompilationContextInterface $context The contextual information of
  47      *                                             the compilation.
  48      */
  49     public function afterCompile(CompilationContextInterface $context);
  50
  51     /**
  52      * Runs instructions to be executed before creating the stub version of the
  53      * resource bundle.
  54      *
  55      * @param StubbingContextInterface $context The contextual information of
  56      *                                          the compilation.
  57      *
  58      * @return mixed The data to include in the stub version.
  59      */
  60     public function beforeCreateStub(StubbingContextInterface $context);
  61
  62     /**
  63      * Runs instructions to be executed after creating the stub version of the
  64      * resource bundle.
  65      *
  66      * @param StubbingContextInterface $context The contextual information of
  67      *                                          the compilation.
  68      */
  69     public function afterCreateStub(StubbingContextInterface $context);
  70 }