root/branches/1.3/lib/generator/sfGeneratorManager.class.php

<?php

/*
 * This file is part of the symfony package.
 * (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * sfGeneratorManager helps generate classes, views and templates for scaffolding, admin interface, ...
 *
 * @package    symfony
 * @subpackage generator
 * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
 * @version    SVN: $Id$
 */
class sfGeneratorManager
{
  protected
    $configuration = null,
    $basePath      = null;

  /**
   * Class constructor.
   *
   * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance
   * @param string                 $basePath      The base path for file generation
   *
   * @see initialize()
   */
  public function __construct(sfProjectConfiguration $configuration, $basePath = null)
  {
    $this->configuration = $configuration;
    $this->basePath = $basePath;
  }

  /**
   * Initializes the sfGeneratorManager instance.
   *
   * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance
   * @deprecated
   */
  public function initialize(sfProjectConfiguration $configuration)
  {
    // DEPRECATED
  }

  /**
   * Returns the current configuration instance.
   *
   * @return sfProjectConfiguration A sfProjectConfiguration instance
   */
  public function getConfiguration()
  {
    return $this->configuration;
  }

  /**
   * Gets the base path to use when generating files.
   *
   * @return string The base path
   */
  public function getBasePath()
  {
    if (null === $this->basePath)
    {
      // for BC
      $this->basePath = sfConfig::get('sf_module_cache_dir');
    }

    return $this->basePath;
  }

  /**
   * Sets the base path to use when generating files.
   *
   * @param string $basePath The base path
   */
  public function setBasePath($basePath)
  {
    $this->basePath = $basePath;
  }

  /**
   * Saves some content.
   *
   * @param string $path    The relative path
   * @param string $content The content
   */
  public function save($path, $content)
  {
    $path = $this->getBasePath().DIRECTORY_SEPARATOR.$path;

    if (!is_dir(dirname($path)))
    {
      $current_umask = umask(0000);
      if (false === @mkdir(dirname($path), 0777, true))
      {
        throw new sfCacheException(sprintf('Failed to make cache directory "%s".', dirname($path)));
      }
      umask($current_umask);
    }

    if (false === $ret = @file_put_contents($path, $content))
    {
      throw new sfCacheException(sprintf('Failed to write cache file "%s".', $path));
    }

    return $ret;
  }

  /**
   * Generates classes and templates for a given generator class.
   *
   * @param string $generatorClass The generator class name
   * @param array  $param          An array of parameters
   *
   * @return string The cache for the configuration file
   */
  public function generate($generatorClass, $param)
  {
    $generator = new $generatorClass($this);

    return $generator->generate($param);
  }
}