initial commit

lib/symfony/addon/propel/generator/sfPropelCrudGenerator.class.php

@@ -0,0 +1,144 @@
+<?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.
+ */
+
+/**
+ * Propel CRUD generator.
+ *
+ * This class generates a basic CRUD module with propel.
+ *
+ * @package    symfony
+ * @subpackage generator
+ * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
+ * @version    SVN: $Id: sfPropelCrudGenerator.class.php 3302 2007-01-18 13:42:46Z fabien $
+ */
+
+class sfPropelCrudGenerator extends sfAdminGenerator
+{
+  /**
+   * Initializes the current sfGenerator instance.
+   *
+   * @param sfGeneratorManager A sfGeneratorManager instance
+   */
+  public function initialize($generatorManager)
+  {
+    parent::initialize($generatorManager);
+
+    $this->setGeneratorClass('sfPropelCrud');
+  }
+
+  /**
+   * Loads primary keys.
+   *
+   * This method is ORM dependant.
+   *
+   * @throws sfException
+   */
+  protected function loadPrimaryKeys()
+  {
+    foreach ($this->tableMap->getColumns() as $column)
+    {
+      if ($column->isPrimaryKey())
+      {
+        $this->primaryKey[] = $column;
+      }
+    }
+
+    if (!count($this->primaryKey))
+    {
+      throw new sfException(sprintf('Cannot generate a module for a model without a primary key (%s)', $this->className));
+    }
+  }
+
+  /**
+   * Loads map builder classes.
+   *
+   * This method is ORM dependant.
+   *
+   * @throws sfException
+   */
+  protected function loadMapBuilderClasses()
+  {
+    // we must load all map builder classes to be able to deal with foreign keys (cf. editSuccess.php template)
+    $classes = sfFinder::type('file')->name('*MapBuilder.php')->in(sfLoader::getModelDirs());
+    foreach ($classes as $class)
+    {
+      $class_map_builder = basename($class, '.php');
+      $maps[$class_map_builder] = new $class_map_builder();
+      if (!$maps[$class_map_builder]->isBuilt())
+      {
+        $maps[$class_map_builder]->doBuild();
+      }
+
+      if ($this->className == str_replace('MapBuilder', '', $class_map_builder))
+      {
+        $this->map = $maps[$class_map_builder];
+      }
+    }
+    if (!$this->map)
+    {
+      throw new sfException('The model class "'.$this->className.'" does not exist.');
+    }
+
+    $this->tableMap = $this->map->getDatabaseMap()->getTable(constant($this->className.'Peer::TABLE_NAME'));
+  }
+
+  /**
+   * Generates a PHP call to an object helper.
+   *
+   * @param string The helper name
+   * @param string The column name
+   * @param array  An array of parameters
+   * @param array  An array of local parameters
+   *
+   * @return string PHP code
+   */
+  function getPHPObjectHelper($helperName, $column, $params, $localParams = array())
+  {
+    $params = $this->getObjectTagParams($params, $localParams);
+
+    return sprintf('object_%s($%s, \'%s\', %s)', $helperName, $this->getSingularName(), $this->getColumnGetter($column, false), $params);
+  }
+
+  /**
+   * Returns the getter either non-developped: 'getFoo' or developped: '$class->getFoo()'.
+   *
+   * @param string  The column name
+   * @param boolean true if you want developped method names, false otherwise
+   * @param string The prefix value
+   *
+   * @return string PHP code
+   */
+  function getColumnGetter($column, $developed = false, $prefix = '')
+  {
+    $getter = 'get'.$column->getPhpName();
+    if ($developed)
+    {
+      $getter = sprintf('$%s%s->%s()', $prefix, $this->getSingularName(), $getter);
+    }
+
+    return $getter;
+  }
+
+  /*
+   * Gets the PHP name of the related class name.
+   *
+   * Used for foreign keys only; this method should be removed when we use sfAdminColumn instead.
+   *
+   * @param string The column name
+   *
+   * @return string The PHP name of the related class name
+   */
+  function getRelatedClassName($column)
+  {
+    $relatedTable = $this->getMap()->getDatabaseMap()->getTable($column->getRelatedTableName());
+
+    return $relatedTable->getPhpName();
+  }
+}