mirror of
https://github.com/atlanticbiomedical/portal-legacy.git
synced 2025-07-02 01:47:28 -04:00
initial commit
This commit is contained in:
Chris Sewell
448
lib/symfony/generator/sfCrudGenerator.class.php
Executable file
448
lib/symfony/generator/sfCrudGenerator.class.php
Executable file
@ -0,0 +1,448 @@
|
||||
<?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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* CRUD generator.
|
||||
*
|
||||
* This class generates a basic CRUD module.
|
||||
*
|
||||
* @package symfony
|
||||
* @subpackage generator
|
||||
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
* @version SVN: $Id: sfCrudGenerator.class.php 5099 2007-09-15 06:44:50Z fabien $
|
||||
*/
|
||||
abstract class sfCrudGenerator extends sfGenerator
|
||||
{
|
||||
protected
|
||||
$singularName = '',
|
||||
$pluralName = '',
|
||||
$peerClassName = '',
|
||||
$map = null,
|
||||
$tableMap = null,
|
||||
$primaryKey = array(),
|
||||
$className = '',
|
||||
$params = array();
|
||||
|
||||
/**
|
||||
* Generates classes and templates in cache.
|
||||
*
|
||||
* @param array The parameters
|
||||
*
|
||||
* @return string The data to put in configuration cache
|
||||
*/
|
||||
public function generate($params = array())
|
||||
{
|
||||
$this->params = $params;
|
||||
|
||||
$required_parameters = array('model_class', 'moduleName');
|
||||
foreach ($required_parameters as $entry)
|
||||
{
|
||||
if (!isset($this->params[$entry]))
|
||||
{
|
||||
$error = 'You must specify a "%s"';
|
||||
$error = sprintf($error, $entry);
|
||||
|
||||
throw new sfParseException($error);
|
||||
}
|
||||
}
|
||||
|
||||
$modelClass = $this->params['model_class'];
|
||||
|
||||
if (!class_exists($modelClass))
|
||||
{
|
||||
$error = 'Unable to scaffold unexistant model "%s"';
|
||||
$error = sprintf($error, $modelClass);
|
||||
|
||||
throw new sfInitializationException($error);
|
||||
}
|
||||
|
||||
$this->setScaffoldingClassName($modelClass);
|
||||
|
||||
// generated module name
|
||||
$this->setGeneratedModuleName('auto'.ucfirst($this->params['moduleName']));
|
||||
$this->setModuleName($this->params['moduleName']);
|
||||
|
||||
// get some model metadata
|
||||
$this->loadMapBuilderClasses();
|
||||
|
||||
// load all primary keys
|
||||
$this->loadPrimaryKeys();
|
||||
|
||||
// theme exists?
|
||||
$theme = isset($this->params['theme']) ? $this->params['theme'] : 'default';
|
||||
$themeDir = sfLoader::getGeneratorTemplate($this->getGeneratorClass(), $theme, '');
|
||||
if (!is_dir($themeDir))
|
||||
{
|
||||
$error = 'The theme "%s" does not exist.';
|
||||
$error = sprintf($error, $theme);
|
||||
throw new sfConfigurationException($error);
|
||||
}
|
||||
|
||||
$this->setTheme($theme);
|
||||
$templateFiles = sfFinder::type('file')->name('*.php')->relative()->in($themeDir.'/templates');
|
||||
$configFiles = sfFinder::type('file')->name('*.yml')->relative()->in($themeDir.'/config');
|
||||
|
||||
$this->generatePhpFiles($this->generatedModuleName, $templateFiles, $configFiles);
|
||||
|
||||
// require generated action class
|
||||
$data = "require_once(sfConfig::get('sf_module_cache_dir').'/".$this->generatedModuleName."/actions/actions.class.php');\n";
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns PHP code for primary keys parameters.
|
||||
*
|
||||
* @param integer The indentation value
|
||||
*
|
||||
* @return string The PHP code
|
||||
*/
|
||||
public function getRetrieveByPkParamsForAction($indent)
|
||||
{
|
||||
$params = array();
|
||||
foreach ($this->getPrimaryKey() as $pk)
|
||||
{
|
||||
$params[] = "\$this->getRequestParameter('".sfInflector::underscore($pk->getPhpName())."')";
|
||||
}
|
||||
|
||||
return implode(",\n".str_repeat(' ', max(0, $indent - strlen($this->singularName.$this->className))), $params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns PHP code for getOrCreate() parameters.
|
||||
*
|
||||
* @return string The PHP code
|
||||
*/
|
||||
public function getMethodParamsForGetOrCreate()
|
||||
{
|
||||
$method_params = array();
|
||||
foreach ($this->getPrimaryKey() as $pk)
|
||||
{
|
||||
$fieldName = sfInflector::underscore($pk->getPhpName());
|
||||
$method_params[] = "\$$fieldName = '$fieldName'";
|
||||
}
|
||||
|
||||
return implode(', ', $method_params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns PHP code for getOrCreate() promary keys condition.
|
||||
*
|
||||
* @param boolean true if we pass the field name as an argument, false otherwise
|
||||
*
|
||||
* @return string The PHP code
|
||||
*/
|
||||
public function getTestPksForGetOrCreate($fieldNameAsArgument = true)
|
||||
{
|
||||
$test_pks = array();
|
||||
foreach ($this->getPrimaryKey() as $pk)
|
||||
{
|
||||
$fieldName = sfInflector::underscore($pk->getPhpName());
|
||||
$test_pks[] = sprintf("!\$this->getRequestParameter(%s)", $fieldNameAsArgument ? "\$$fieldName" : "'".$fieldName."'");
|
||||
}
|
||||
|
||||
return implode("\n || ", $test_pks);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns PHP code for primary keys parameters used in getOrCreate() method.
|
||||
*
|
||||
* @return string The PHP code
|
||||
*/
|
||||
public function getRetrieveByPkParamsForGetOrCreate()
|
||||
{
|
||||
$retrieve_params = array();
|
||||
foreach ($this->getPrimaryKey() as $pk)
|
||||
{
|
||||
$fieldName = sfInflector::underscore($pk->getPhpName());
|
||||
$retrieve_params[] = "\$this->getRequestParameter(\$$fieldName)";
|
||||
}
|
||||
|
||||
return implode(",\n".str_repeat(' ', max(0, 45 - strlen($this->singularName.$this->className))), $retrieve_params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the table map for the current model class.
|
||||
*
|
||||
* @return TableMap A TableMap instance
|
||||
*/
|
||||
public function getTableMap()
|
||||
{
|
||||
return $this->tableMap;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the class name to use for scaffolding
|
||||
*
|
||||
* @param string class name
|
||||
*/
|
||||
protected function setScaffoldingClassName($className)
|
||||
{
|
||||
$this->singularName = sfInflector::underscore($className);
|
||||
$this->pluralName = $this->singularName.'s';
|
||||
$this->className = $className;
|
||||
$this->peerClassName = $className.'Peer';
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the singular name for current scaffolding class.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getSingularName()
|
||||
{
|
||||
return $this->singularName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the plural name for current scaffolding class.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getPluralName()
|
||||
{
|
||||
return $this->pluralName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the class name for current scaffolding class.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getClassName()
|
||||
{
|
||||
return $this->className;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the Peer class name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getPeerClassName()
|
||||
{
|
||||
return $this->peerClassName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the primary key name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getPrimaryKey()
|
||||
{
|
||||
return $this->primaryKey;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the Map object.
|
||||
*
|
||||
* @return object
|
||||
*/
|
||||
public function getMap()
|
||||
{
|
||||
return $this->map;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns PHP code to add to a URL for primary keys.
|
||||
*
|
||||
* @param string The prefix value
|
||||
*
|
||||
* @return string PHP code
|
||||
*/
|
||||
public function getPrimaryKeyUrlParams($prefix = '')
|
||||
{
|
||||
$params = array();
|
||||
foreach ($this->getPrimaryKey() as $pk)
|
||||
{
|
||||
$phpName = $pk->getPhpName();
|
||||
$fieldName = sfInflector::underscore($phpName);
|
||||
$params[] = "$fieldName='.".$this->getColumnGetter($pk, true, $prefix);
|
||||
}
|
||||
|
||||
return implode(".'&", $params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets PHP code for primary key condition.
|
||||
*
|
||||
* @param string The prefix value
|
||||
*
|
||||
* @return string PHP code
|
||||
*/
|
||||
public function getPrimaryKeyIsSet($prefix = '')
|
||||
{
|
||||
$params = array();
|
||||
foreach ($this->getPrimaryKey() as $pk)
|
||||
{
|
||||
$params[] = $this->getColumnGetter($pk, true, $prefix);
|
||||
}
|
||||
|
||||
return implode(' && ', $params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets object tag parameters.
|
||||
*
|
||||
* @param array An array of parameters
|
||||
* @param array An array of default parameters
|
||||
*
|
||||
* @return string PHP code
|
||||
*/
|
||||
protected function getObjectTagParams($params, $default_params = array())
|
||||
{
|
||||
return var_export(array_merge($default_params, $params), true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns HTML code for a column in list mode.
|
||||
*
|
||||
* @param string The column name
|
||||
* @param array The parameters
|
||||
*
|
||||
* @return string HTML code
|
||||
*/
|
||||
public function getColumnListTag($column, $params = array())
|
||||
{
|
||||
$type = $column->getCreoleType();
|
||||
|
||||
$columnGetter = $this->getColumnGetter($column, true);
|
||||
|
||||
if ($type == CreoleTypes::TIMESTAMP)
|
||||
{
|
||||
return "format_date($columnGetter, 'f')";
|
||||
}
|
||||
elseif ($type == CreoleTypes::DATE)
|
||||
{
|
||||
return "format_date($columnGetter, 'D')";
|
||||
}
|
||||
else
|
||||
{
|
||||
return "$columnGetter";
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns HTML code for a column in edit mode.
|
||||
*
|
||||
* @param string The column name
|
||||
* @param array The parameters
|
||||
*
|
||||
* @return string HTML code
|
||||
*/
|
||||
public function getCrudColumnEditTag($column, $params = array())
|
||||
{
|
||||
$type = $column->getCreoleType();
|
||||
|
||||
if ($column->isForeignKey())
|
||||
{
|
||||
if (!$column->isNotNull() && !isset($params['include_blank']))
|
||||
{
|
||||
$params['include_blank'] = true;
|
||||
}
|
||||
|
||||
return $this->getPHPObjectHelper('select_tag', $column, $params, array('related_class' => $this->getRelatedClassName($column)));
|
||||
}
|
||||
else if ($type == CreoleTypes::DATE)
|
||||
{
|
||||
// rich=false not yet implemented
|
||||
return $this->getPHPObjectHelper('input_date_tag', $column, $params, array('rich' => true));
|
||||
}
|
||||
else if ($type == CreoleTypes::TIMESTAMP)
|
||||
{
|
||||
// rich=false not yet implemented
|
||||
return $this->getPHPObjectHelper('input_date_tag', $column, $params, array('rich' => true, 'withtime' => true));
|
||||
}
|
||||
else if ($type == CreoleTypes::BOOLEAN)
|
||||
{
|
||||
return $this->getPHPObjectHelper('checkbox_tag', $column, $params);
|
||||
}
|
||||
else if ($type == CreoleTypes::CHAR || $type == CreoleTypes::VARCHAR)
|
||||
{
|
||||
$size = ($column->getSize() > 20 ? ($column->getSize() < 80 ? $column->getSize() : 80) : 20);
|
||||
return $this->getPHPObjectHelper('input_tag', $column, $params, array('size' => $size));
|
||||
}
|
||||
else if ($type == CreoleTypes::INTEGER || $type == CreoleTypes::TINYINT || $type == CreoleTypes::SMALLINT || $type == CreoleTypes::BIGINT)
|
||||
{
|
||||
return $this->getPHPObjectHelper('input_tag', $column, $params, array('size' => 7));
|
||||
}
|
||||
else if ($type == CreoleTypes::FLOAT || $type == CreoleTypes::DOUBLE || $type == CreoleTypes::DECIMAL || $type == CreoleTypes::NUMERIC || $type == CreoleTypes::REAL)
|
||||
{
|
||||
return $this->getPHPObjectHelper('input_tag', $column, $params, array('size' => 7));
|
||||
}
|
||||
else if ($type == CreoleTypes::TEXT || $type == CreoleTypes::LONGVARCHAR)
|
||||
{
|
||||
return $this->getPHPObjectHelper('textarea_tag', $column, $params, array('size' => '30x3'));
|
||||
}
|
||||
else
|
||||
{
|
||||
return $this->getPHPObjectHelper('input_tag', $column, $params, array('disabled' => true));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads primary keys.
|
||||
*
|
||||
* This method is ORM dependant.
|
||||
*
|
||||
* @throws sfException
|
||||
*/
|
||||
abstract protected function loadPrimaryKeys();
|
||||
|
||||
/**
|
||||
* Loads map builder classes.
|
||||
*
|
||||
* This method is ORM dependant.
|
||||
*
|
||||
* @throws sfException
|
||||
*/
|
||||
abstract protected function loadMapBuilderClasses();
|
||||
|
||||
/**
|
||||
* Generates a PHP call to an object helper.
|
||||
*
|
||||
* This method is ORM dependant.
|
||||
*
|
||||
* @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
|
||||
*/
|
||||
abstract function getPHPObjectHelper($helperName, $column, $params, $localParams = array());
|
||||
|
||||
/**
|
||||
* Returns the getter either non-developped: 'getFoo' or developped: '$class->getFoo()'.
|
||||
*
|
||||
* This method is ORM dependant.
|
||||
*
|
||||
* @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
|
||||
*/
|
||||
abstract function getColumnGetter($column, $developed = false , $prefix = '');
|
||||
|
||||
/*
|
||||
* Gets the PHP name of the related class name.
|
||||
*
|
||||
* Used for foreign keys only; this method should be removed when we use sfAdminColumn instead.
|
||||
*
|
||||
* This method is ORM dependant.
|
||||
*
|
||||
* @param string The column name
|
||||
*
|
||||
* @return string The PHP name of the related class name
|
||||
*/
|
||||
abstract function getRelatedClassName($column);
|
||||
}
|
||||
Reference in New Issue
Block a user