1. sfGenerator.class.php
  2. /**
 * sfGenerator is the abstract base class for all generators.
 *
 * @package    symfony
 * @subpackage generator
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfGenerator.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. abstract class sfGenerator
  4. {
  5.   protected
  6.     $generatorClass      = '',
  7.     $generatorManager    = null,
  8.     $generatedModuleName = '',
  9.     $theme               = 'default',
  10.     $moduleName          = '';
  12.   /**
  13.    * Class constructor.
  14.    *
  15.    * @see initialize()
  16.    */
  17.   public function __construct(sfGeneratorManager $generatorManager)
  18.   {
  19.     $this->initialize($generatorManager);
  20.   }
  22.   /**
  23.    * Initializes the current sfGenerator instance.
  24.    *
  25.    * @param sfGeneratorManager $generatorManager A sfGeneratorManager instance
  26.    */
  27.   public function initialize(sfGeneratorManager $generatorManager)
  28.   {
  29.     $this->generatorManager = $generatorManager;
  30.   }
  32.   /**
  33.    * Generates classes and templates.
  34.    *
  35.    * @param array $params An array of parameters
  36.    *
  37.    * @return string The cache for the configuration file
  38.    */
  39.   abstract public function generate($params = array());
  41.   /**
  42.    * Generates PHP files for a given module name.
  43.    *
  44.    * @param string $generatedModuleName The name of module name to generate
  45.    * @param array  $files               A list of template files to generate
  46.    */
  47.   protected function generatePhpFiles($generatedModuleName, $files = array())
  48.   {
  49.     foreach ($files as $file)
  50.     {
  51.       $this->getGeneratorManager()->save($generatedModuleName.'/'.$file, $this->evalTemplate($file));
  52.     }
  53.   }
  55.   /**
  56.    * Evaluates a template file.
  57.    *
  58.    * @param string $templateFile The template file path
  59.    *
  60.    * @return string The evaluated template
  61.    */
  62.   protected function evalTemplate($templateFile)
  63.   {
  64.     $templateFile = $this->generatorManager->getConfiguration()->getGeneratorTemplate($this->getGeneratorClass(), $this->getTheme(), $templateFile);
  66.     // eval template file
  67.     ob_start();
  68.     require($templateFile);
  69.     $content = ob_get_clean();
  71.     // replace [?php and ?]
  72.     return $this->replacePhpMarks($content);
  73.   }
  75.   /**
  76.    * Replaces PHP marks by <?php ?>.
  77.    *
  78.    * @param string $text The PHP code
  79.    *
  80.    * @return string The converted PHP code
  81.    */
  82.   protected function replacePhpMarks($text)
  83.   {
  84.     // replace [?php and ?]
  85.     return str_replace(array('[?php', '[?=', '?]'), array('<?php', '<?php echo', '?>'), $text);
  86.   }
  88.   /**
  89.    * Gets the generator class.
  90.    *
  91.    * @return string The generator class
  92.    */
  93.   public function getGeneratorClass()
  94.   {
  95.     return $this->generatorClass;
  96.   }
  98.   /**
  99.    * Sets the generator class.
  100.    *
  101.    * @param string $generatorClass The generator class
  102.    */
  103.   public function setGeneratorClass($generatorClass)
  104.   {
  105.     $this->generatorClass = $generatorClass;
  106.   }
  108.   /**
  109.    * Gets the sfGeneratorManager instance.
  110.    *
  111.    * @return string The sfGeneratorManager instance
  112.    */
  113.   protected function getGeneratorManager()
  114.   {
  115.     return $this->generatorManager;
  116.   }
  118.   /**
  119.    * Gets the module name of the generated module.
  120.    *
  121.    * @return string The module name
  122.    */
  123.   public function getGeneratedModuleName()
  124.   {
  125.     return $this->generatedModuleName;
  126.   }
  128.   /**
  129.    * Sets the module name of the generated module.
  130.    *
  131.    * @param string $moduleName The module name
  132.    */
  133.   public function setGeneratedModuleName($moduleName)
  134.   {
  135.     $this->generatedModuleName = $moduleName;
  136.   }
  138.   /**
  139.    * Gets the module name.
  140.    *
  141.    * @return string The module name
  142.    */
  143.   public function getModuleName()
  144.   {
  145.     return $this->moduleName;
  146.   }
  148.   /**
  149.    * Sets the module name.
  150.    *
  151.    * @param string $moduleName The module name
  152.    */
  153.   public function setModuleName($moduleName)
  154.   {
  155.     $this->moduleName = $moduleName;
  156.   }
  158.   /**
  159.    * Gets the theme name.
  160.    *
  161.    * @return string The theme name
  162.    */
  163.   public function getTheme()
  164.   {
  165.     return $this->theme;
  166.   }
  168.   /**
  169.    * Sets the theme name.
  170.    *
  171.    * @param string $theme The theme name
  172.    */
  173.   public function setTheme($theme)
  174.   {
  175.     $this->theme = $theme;
  176.   }
  177. }
Debug toolbar