mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-25 00:07:20 +00:00
1053 lines
32 KiB
PHP
1053 lines
32 KiB
PHP
<?php
|
|
/**
|
|
* The ModelTask handles creating and updating models files.
|
|
*
|
|
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
|
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
*
|
|
* Licensed under The MIT License
|
|
* For full copyright and license information, please see the LICENSE.txt
|
|
* Redistributions of files must retain the above copyright notice.
|
|
*
|
|
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
|
* @since CakePHP(tm) v 1.2
|
|
* @license http://www.opensource.org/licenses/mit-license.php MIT License
|
|
*/
|
|
|
|
App::uses('AppShell', 'Console/Command');
|
|
App::uses('BakeTask', 'Console/Command/Task');
|
|
App::uses('ConnectionManager', 'Model');
|
|
App::uses('Model', 'Model');
|
|
App::uses('Validation', 'Utility');
|
|
|
|
/**
|
|
* Task class for creating and updating model files.
|
|
*
|
|
* @package Cake.Console.Command.Task
|
|
*/
|
|
class ModelTask extends BakeTask {
|
|
|
|
/**
|
|
* path to Model directory
|
|
*
|
|
* @var string
|
|
*/
|
|
public $path = null;
|
|
|
|
/**
|
|
* tasks
|
|
*
|
|
* @var array
|
|
*/
|
|
public $tasks = array('DbConfig', 'Fixture', 'Test', 'Template');
|
|
|
|
/**
|
|
* Tables to skip when running all()
|
|
*
|
|
* @var array
|
|
*/
|
|
public $skipTables = array('i18n');
|
|
|
|
/**
|
|
* Holds tables found on connection.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_tables = array();
|
|
|
|
/**
|
|
* Holds the model names
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_modelNames = array();
|
|
|
|
/**
|
|
* Holds validation method map.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_validations = array();
|
|
|
|
/**
|
|
* Override initialize
|
|
*
|
|
* @return void
|
|
*/
|
|
public function initialize() {
|
|
$this->path = current(App::path('Model'));
|
|
}
|
|
|
|
/**
|
|
* Execution method always used for tasks
|
|
*
|
|
* @return void
|
|
*/
|
|
public function execute() {
|
|
parent::execute();
|
|
|
|
if (empty($this->args)) {
|
|
$this->_interactive();
|
|
}
|
|
|
|
if (!empty($this->args[0])) {
|
|
$this->interactive = false;
|
|
if (!isset($this->connection)) {
|
|
$this->connection = 'default';
|
|
}
|
|
if (strtolower($this->args[0]) === 'all') {
|
|
return $this->all();
|
|
}
|
|
$model = $this->_modelName($this->args[0]);
|
|
$this->listAll($this->connection);
|
|
$useTable = $this->getTable($model);
|
|
$object = $this->_getModelObject($model, $useTable);
|
|
if ($this->bake($object, false)) {
|
|
if ($this->_checkUnitTest()) {
|
|
$this->bakeFixture($model, $useTable);
|
|
$this->bakeTest($model);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Bake all models at once.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function all() {
|
|
$this->listAll($this->connection, false);
|
|
$unitTestExists = $this->_checkUnitTest();
|
|
foreach ($this->_tables as $table) {
|
|
if (in_array($table, $this->skipTables)) {
|
|
continue;
|
|
}
|
|
$modelClass = Inflector::classify($table);
|
|
$this->out(__d('cake_console', 'Baking %s', $modelClass));
|
|
$object = $this->_getModelObject($modelClass, $table);
|
|
if ($this->bake($object, false) && $unitTestExists) {
|
|
$this->bakeFixture($modelClass, $table);
|
|
$this->bakeTest($modelClass);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get a model object for a class name.
|
|
*
|
|
* @param string $className Name of class you want model to be.
|
|
* @param string $table Table name
|
|
* @return Model Model instance
|
|
*/
|
|
protected function _getModelObject($className, $table = null) {
|
|
if (!$table) {
|
|
$table = Inflector::tableize($className);
|
|
}
|
|
$object = new Model(array('name' => $className, 'table' => $table, 'ds' => $this->connection));
|
|
$fields = $object->schema(true);
|
|
foreach ($fields as $name => $field) {
|
|
if (isset($field['key']) && $field['key'] === 'primary') {
|
|
$object->primaryKey = $name;
|
|
break;
|
|
}
|
|
}
|
|
return $object;
|
|
}
|
|
|
|
/**
|
|
* Generate a key value list of options and a prompt.
|
|
*
|
|
* @param array $options Array of options to use for the selections. indexes must start at 0
|
|
* @param string $prompt Prompt to use for options list.
|
|
* @param int $default The default option for the given prompt.
|
|
* @return int Result of user choice.
|
|
*/
|
|
public function inOptions($options, $prompt = null, $default = null) {
|
|
$valid = false;
|
|
$max = count($options);
|
|
while (!$valid) {
|
|
$len = strlen(count($options) + 1);
|
|
foreach ($options as $i => $option) {
|
|
$this->out(sprintf("%${len}d. %s", $i + 1, $option));
|
|
}
|
|
if (empty($prompt)) {
|
|
$prompt = __d('cake_console', 'Make a selection from the choices above');
|
|
}
|
|
$choice = $this->in($prompt, null, $default);
|
|
if ((int)$choice > 0 && (int)$choice <= $max) {
|
|
$valid = true;
|
|
}
|
|
}
|
|
return $choice - 1;
|
|
}
|
|
|
|
/**
|
|
* Handles interactive baking
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function _interactive() {
|
|
$this->hr();
|
|
$this->out(__d('cake_console', "Bake Model\nPath: %s", $this->getPath()));
|
|
$this->hr();
|
|
$this->interactive = true;
|
|
|
|
$primaryKey = 'id';
|
|
$validate = $associations = array();
|
|
|
|
if (empty($this->connection)) {
|
|
$this->connection = $this->DbConfig->getConfig();
|
|
}
|
|
$currentModelName = $this->getName();
|
|
$useTable = $this->getTable($currentModelName);
|
|
$db = ConnectionManager::getDataSource($this->connection);
|
|
$fullTableName = $db->fullTableName($useTable);
|
|
if (!in_array($useTable, $this->_tables)) {
|
|
$prompt = __d('cake_console', "The table %s doesn't exist or could not be automatically detected\ncontinue anyway?", $useTable);
|
|
$continue = $this->in($prompt, array('y', 'n'));
|
|
if (strtolower($continue) === 'n') {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$tempModel = new Model(array('name' => $currentModelName, 'table' => $useTable, 'ds' => $this->connection));
|
|
|
|
$knownToExist = false;
|
|
try {
|
|
$fields = $tempModel->schema(true);
|
|
$knownToExist = true;
|
|
} catch (Exception $e) {
|
|
$fields = array($tempModel->primaryKey);
|
|
}
|
|
if (!array_key_exists('id', $fields)) {
|
|
$primaryKey = $this->findPrimaryKey($fields);
|
|
}
|
|
|
|
if ($knownToExist) {
|
|
$displayField = $tempModel->hasField(array('name', 'title'));
|
|
if (!$displayField) {
|
|
$displayField = $this->findDisplayField($tempModel->schema());
|
|
}
|
|
|
|
$prompt = __d('cake_console', "Would you like to supply validation criteria \nfor the fields in your model?");
|
|
$wannaDoValidation = $this->in($prompt, array('y', 'n'), 'y');
|
|
if (array_search($useTable, $this->_tables) !== false && strtolower($wannaDoValidation) === 'y') {
|
|
$validate = $this->doValidation($tempModel);
|
|
}
|
|
|
|
$prompt = __d('cake_console', "Would you like to define model associations\n(hasMany, hasOne, belongsTo, etc.)?");
|
|
$wannaDoAssoc = $this->in($prompt, array('y', 'n'), 'y');
|
|
if (strtolower($wannaDoAssoc) === 'y') {
|
|
$associations = $this->doAssociations($tempModel);
|
|
}
|
|
}
|
|
|
|
$this->out();
|
|
$this->hr();
|
|
$this->out(__d('cake_console', 'The following Model will be created:'));
|
|
$this->hr();
|
|
$this->out(__d('cake_console', "Name: %s", $currentModelName));
|
|
|
|
if ($this->connection !== 'default') {
|
|
$this->out(__d('cake_console', "DB Config: %s", $this->connection));
|
|
}
|
|
if ($fullTableName !== Inflector::tableize($currentModelName)) {
|
|
$this->out(__d('cake_console', 'DB Table: %s', $fullTableName));
|
|
}
|
|
if ($primaryKey !== 'id') {
|
|
$this->out(__d('cake_console', 'Primary Key: %s', $primaryKey));
|
|
}
|
|
if (!empty($validate)) {
|
|
$this->out(__d('cake_console', 'Validation: %s', print_r($validate, true)));
|
|
}
|
|
if (!empty($associations)) {
|
|
$this->out(__d('cake_console', 'Associations:'));
|
|
$assocKeys = array('belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany');
|
|
foreach ($assocKeys as $assocKey) {
|
|
$this->_printAssociation($currentModelName, $assocKey, $associations);
|
|
}
|
|
}
|
|
|
|
$this->hr();
|
|
$looksGood = $this->in(__d('cake_console', 'Look okay?'), array('y', 'n'), 'y');
|
|
|
|
if (strtolower($looksGood) === 'y') {
|
|
$vars = compact('associations', 'validate', 'primaryKey', 'useTable', 'displayField');
|
|
$vars['useDbConfig'] = $this->connection;
|
|
if ($this->bake($currentModelName, $vars)) {
|
|
if ($this->_checkUnitTest()) {
|
|
$this->bakeFixture($currentModelName, $useTable);
|
|
$this->bakeTest($currentModelName, $useTable, $associations);
|
|
}
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Print out all the associations of a particular type
|
|
*
|
|
* @param string $modelName Name of the model relations belong to.
|
|
* @param string $type Name of association you want to see. i.e. 'belongsTo'
|
|
* @param string $associations Collection of associations.
|
|
* @return void
|
|
*/
|
|
protected function _printAssociation($modelName, $type, $associations) {
|
|
if (!empty($associations[$type])) {
|
|
for ($i = 0, $len = count($associations[$type]); $i < $len; $i++) {
|
|
$out = "\t" . $modelName . ' ' . $type . ' ' . $associations[$type][$i]['alias'];
|
|
$this->out($out);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Finds a primary Key in a list of fields.
|
|
*
|
|
* @param array $fields Array of fields that might have a primary key.
|
|
* @return string Name of field that is a primary key.
|
|
*/
|
|
public function findPrimaryKey($fields) {
|
|
$name = 'id';
|
|
foreach ($fields as $name => $field) {
|
|
if (isset($field['key']) && $field['key'] === 'primary') {
|
|
break;
|
|
}
|
|
}
|
|
return $this->in(__d('cake_console', 'What is the primaryKey?'), null, $name);
|
|
}
|
|
|
|
/**
|
|
* interact with the user to find the displayField value for a model.
|
|
*
|
|
* @param array $fields Array of fields to look for and choose as a displayField
|
|
* @return mixed Name of field to use for displayField or false if the user declines to choose
|
|
*/
|
|
public function findDisplayField($fields) {
|
|
$fieldNames = array_keys($fields);
|
|
$prompt = __d('cake_console', "A displayField could not be automatically detected\nwould you like to choose one?");
|
|
$continue = $this->in($prompt, array('y', 'n'));
|
|
if (strtolower($continue) === 'n') {
|
|
return false;
|
|
}
|
|
$prompt = __d('cake_console', 'Choose a field from the options above:');
|
|
$choice = $this->inOptions($fieldNames, $prompt);
|
|
return $fieldNames[$choice];
|
|
}
|
|
|
|
/**
|
|
* Handles Generation and user interaction for creating validation.
|
|
*
|
|
* @param Model $model Model to have validations generated for.
|
|
* @return array validate Array of user selected validations.
|
|
*/
|
|
public function doValidation($model) {
|
|
if (!$model instanceof Model) {
|
|
return false;
|
|
}
|
|
|
|
$fields = $model->schema();
|
|
if (empty($fields)) {
|
|
return false;
|
|
}
|
|
|
|
$skipFields = false;
|
|
$validate = array();
|
|
$this->initValidations();
|
|
foreach ($fields as $fieldName => $field) {
|
|
$validation = $this->fieldValidation($fieldName, $field, $model->primaryKey);
|
|
if (isset($validation['_skipFields'])) {
|
|
unset($validation['_skipFields']);
|
|
$skipFields = true;
|
|
}
|
|
if (!empty($validation)) {
|
|
$validate[$fieldName] = $validation;
|
|
}
|
|
if ($skipFields) {
|
|
return $validate;
|
|
}
|
|
}
|
|
return $validate;
|
|
}
|
|
|
|
/**
|
|
* Populate the _validations array
|
|
*
|
|
* @return void
|
|
*/
|
|
public function initValidations() {
|
|
$options = $choices = array();
|
|
if (class_exists('Validation')) {
|
|
$options = get_class_methods('Validation');
|
|
}
|
|
$deprecatedOptions = array('notEmpty', 'between', 'ssn');
|
|
$options = array_diff($options, $deprecatedOptions);
|
|
sort($options);
|
|
$default = 1;
|
|
foreach ($options as $option) {
|
|
if ($option{0} !== '_') {
|
|
$choices[$default] = $option;
|
|
$default++;
|
|
}
|
|
}
|
|
$choices[$default] = 'none'; // Needed since index starts at 1
|
|
$this->_validations = $choices;
|
|
return $choices;
|
|
}
|
|
|
|
/**
|
|
* Does individual field validation handling.
|
|
*
|
|
* @param string $fieldName Name of field to be validated.
|
|
* @param array $metaData metadata for field
|
|
* @param string $primaryKey The primary key field.
|
|
* @return array Array of validation for the field.
|
|
*/
|
|
public function fieldValidation($fieldName, $metaData, $primaryKey = 'id') {
|
|
$defaultChoice = count($this->_validations);
|
|
$validate = $alreadyChosen = array();
|
|
|
|
$prompt = __d('cake_console',
|
|
"or enter in a valid regex validation string.\nAlternatively [s] skip the rest of the fields.\n"
|
|
);
|
|
$methods = array_flip($this->_validations);
|
|
|
|
$anotherValidator = 'y';
|
|
while ($anotherValidator === 'y') {
|
|
if ($this->interactive) {
|
|
$this->out();
|
|
$this->out(__d('cake_console', 'Field: <info>%s</info>', $fieldName));
|
|
$this->out(__d('cake_console', 'Type: <info>%s</info>', $metaData['type']));
|
|
$this->hr();
|
|
$this->out(__d('cake_console', 'Please select one of the following validation options:'));
|
|
$this->hr();
|
|
|
|
$optionText = '';
|
|
for ($i = 1, $m = $defaultChoice / 2; $i <= $m; $i++) {
|
|
$line = sprintf("%2d. %s", $i, $this->_validations[$i]);
|
|
$optionText .= $line . str_repeat(" ", 31 - strlen($line));
|
|
if ($m + $i !== $defaultChoice) {
|
|
$optionText .= sprintf("%2d. %s\n", $m + $i, $this->_validations[$m + $i]);
|
|
}
|
|
}
|
|
$this->out($optionText);
|
|
$this->out(__d('cake_console', "%s - Do not do any validation on this field.", $defaultChoice));
|
|
$this->hr();
|
|
}
|
|
|
|
$guess = $defaultChoice;
|
|
if ($metaData['null'] != 1 && !in_array($fieldName, array($primaryKey, 'created', 'modified', 'updated'))) {
|
|
if ($fieldName === 'email') {
|
|
$guess = $methods['email'];
|
|
} elseif ($metaData['type'] === 'string' && $metaData['length'] == 36) {
|
|
$guess = $methods['uuid'];
|
|
} elseif ($metaData['type'] === 'string') {
|
|
$guess = $methods['notBlank'];
|
|
} elseif ($metaData['type'] === 'text') {
|
|
$guess = $methods['notBlank'];
|
|
} elseif ($metaData['type'] === 'integer') {
|
|
$guess = $methods['numeric'];
|
|
} elseif ($metaData['type'] === 'float') {
|
|
$guess = $methods['numeric'];
|
|
} elseif ($metaData['type'] === 'boolean') {
|
|
$guess = $methods['boolean'];
|
|
} elseif ($metaData['type'] === 'date') {
|
|
$guess = $methods['date'];
|
|
} elseif ($metaData['type'] === 'time') {
|
|
$guess = $methods['time'];
|
|
} elseif ($metaData['type'] === 'datetime') {
|
|
$guess = $methods['datetime'];
|
|
} elseif ($metaData['type'] === 'inet') {
|
|
$guess = $methods['ip'];
|
|
} elseif ($metaData['type'] === 'decimal') {
|
|
$guess = $methods['decimal'];
|
|
}
|
|
}
|
|
|
|
if ($this->interactive === true) {
|
|
$choice = $this->in($prompt, null, $guess);
|
|
if ($choice === 's') {
|
|
$validate['_skipFields'] = true;
|
|
return $validate;
|
|
}
|
|
if (in_array($choice, $alreadyChosen)) {
|
|
$this->out(__d('cake_console', "You have already chosen that validation rule,\nplease choose again"));
|
|
continue;
|
|
}
|
|
if (!isset($this->_validations[$choice]) && is_numeric($choice)) {
|
|
$this->out(__d('cake_console', 'Please make a valid selection.'));
|
|
continue;
|
|
}
|
|
$alreadyChosen[] = $choice;
|
|
} else {
|
|
$choice = $guess;
|
|
}
|
|
|
|
if (isset($this->_validations[$choice])) {
|
|
$validatorName = $this->_validations[$choice];
|
|
} else {
|
|
$validatorName = Inflector::slug($choice);
|
|
}
|
|
|
|
if ($choice != $defaultChoice) {
|
|
$validate[$validatorName] = $choice;
|
|
if (is_numeric($choice) && isset($this->_validations[$choice])) {
|
|
$validate[$validatorName] = $this->_validations[$choice];
|
|
}
|
|
}
|
|
$anotherValidator = 'n';
|
|
if ($this->interactive && $choice != $defaultChoice) {
|
|
$anotherValidator = $this->in(__d('cake_console', "Would you like to add another validation rule\n" .
|
|
"or skip the rest of the fields?"), array('y', 'n', 's'), 'n');
|
|
if ($anotherValidator === 's') {
|
|
$validate['_skipFields'] = true;
|
|
return $validate;
|
|
}
|
|
}
|
|
}
|
|
return $validate;
|
|
}
|
|
|
|
/**
|
|
* Handles associations
|
|
*
|
|
* @param Model $model The model object
|
|
* @return array Associations
|
|
*/
|
|
public function doAssociations($model) {
|
|
if (!$model instanceof Model) {
|
|
return false;
|
|
}
|
|
if ($this->interactive === true) {
|
|
$this->out(__d('cake_console', 'One moment while the associations are detected.'));
|
|
}
|
|
|
|
$fields = $model->schema(true);
|
|
if (empty($fields)) {
|
|
return array();
|
|
}
|
|
|
|
if (empty($this->_tables)) {
|
|
$this->_tables = (array)$this->getAllTables();
|
|
}
|
|
|
|
$associations = array(
|
|
'belongsTo' => array(),
|
|
'hasMany' => array(),
|
|
'hasOne' => array(),
|
|
'hasAndBelongsToMany' => array()
|
|
);
|
|
|
|
$associations = $this->findBelongsTo($model, $associations);
|
|
$associations = $this->findHasOneAndMany($model, $associations);
|
|
$associations = $this->findHasAndBelongsToMany($model, $associations);
|
|
|
|
if ($this->interactive !== true) {
|
|
unset($associations['hasOne']);
|
|
}
|
|
|
|
if ($this->interactive === true) {
|
|
$this->hr();
|
|
if (empty($associations)) {
|
|
$this->out(__d('cake_console', 'None found.'));
|
|
} else {
|
|
$this->out(__d('cake_console', 'Please confirm the following associations:'));
|
|
$this->hr();
|
|
$associations = $this->confirmAssociations($model, $associations);
|
|
}
|
|
$associations = $this->doMoreAssociations($model, $associations);
|
|
}
|
|
return $associations;
|
|
}
|
|
|
|
/**
|
|
* Handles behaviors
|
|
*
|
|
* @param Model $model The model object.
|
|
* @return array Behaviors
|
|
*/
|
|
public function doActsAs($model) {
|
|
if (!$model instanceof Model) {
|
|
return false;
|
|
}
|
|
$behaviors = array();
|
|
$fields = $model->schema(true);
|
|
if (empty($fields)) {
|
|
return array();
|
|
}
|
|
|
|
if (isset($fields['lft']) && $fields['lft']['type'] === 'integer' &&
|
|
isset($fields['rght']) && $fields['rght']['type'] === 'integer' &&
|
|
isset($fields['parent_id'])) {
|
|
$behaviors[] = 'Tree';
|
|
}
|
|
return $behaviors;
|
|
}
|
|
|
|
/**
|
|
* Find belongsTo relations and add them to the associations list.
|
|
*
|
|
* @param Model $model Model instance of model being generated.
|
|
* @param array $associations Array of in progress associations
|
|
* @return array Associations with belongsTo added in.
|
|
*/
|
|
public function findBelongsTo(Model $model, $associations) {
|
|
$fieldNames = array_keys($model->schema(true));
|
|
foreach ($fieldNames as $fieldName) {
|
|
$offset = substr($fieldName, -3) === '_id';
|
|
if ($fieldName != $model->primaryKey && $fieldName !== 'parent_id' && $offset !== false) {
|
|
$tmpModelName = $this->_modelNameFromKey($fieldName);
|
|
$associations['belongsTo'][] = array(
|
|
'alias' => $tmpModelName,
|
|
'className' => $tmpModelName,
|
|
'foreignKey' => $fieldName,
|
|
);
|
|
} elseif ($fieldName === 'parent_id') {
|
|
$associations['belongsTo'][] = array(
|
|
'alias' => 'Parent' . $model->name,
|
|
'className' => $model->name,
|
|
'foreignKey' => $fieldName,
|
|
);
|
|
}
|
|
}
|
|
return $associations;
|
|
}
|
|
|
|
/**
|
|
* Find the hasOne and hasMany relations and add them to associations list
|
|
*
|
|
* @param Model $model Model instance being generated
|
|
* @param array $associations Array of in progress associations
|
|
* @return array Associations with hasOne and hasMany added in.
|
|
*/
|
|
public function findHasOneAndMany(Model $model, $associations) {
|
|
$foreignKey = $this->_modelKey($model->name);
|
|
foreach ($this->_tables as $otherTable) {
|
|
$tempOtherModel = $this->_getModelObject($this->_modelName($otherTable), $otherTable);
|
|
$tempFieldNames = array_keys($tempOtherModel->schema(true));
|
|
|
|
$pattern = '/_' . preg_quote($model->table, '/') . '|' . preg_quote($model->table, '/') . '_/';
|
|
$possibleJoinTable = preg_match($pattern, $otherTable);
|
|
if ($possibleJoinTable) {
|
|
continue;
|
|
}
|
|
foreach ($tempFieldNames as $fieldName) {
|
|
$assoc = false;
|
|
if ($fieldName !== $model->primaryKey && $fieldName === $foreignKey) {
|
|
$assoc = array(
|
|
'alias' => $tempOtherModel->name,
|
|
'className' => $tempOtherModel->name,
|
|
'foreignKey' => $fieldName
|
|
);
|
|
} elseif ($otherTable === $model->table && $fieldName === 'parent_id') {
|
|
$assoc = array(
|
|
'alias' => 'Child' . $model->name,
|
|
'className' => $model->name,
|
|
'foreignKey' => $fieldName
|
|
);
|
|
}
|
|
if ($assoc) {
|
|
$associations['hasOne'][] = $assoc;
|
|
$associations['hasMany'][] = $assoc;
|
|
}
|
|
|
|
}
|
|
}
|
|
return $associations;
|
|
}
|
|
|
|
/**
|
|
* Find the hasAndBelongsToMany relations and add them to associations list
|
|
*
|
|
* @param Model $model Model instance being generated
|
|
* @param array $associations Array of in-progress associations
|
|
* @return array Associations with hasAndBelongsToMany added in.
|
|
*/
|
|
public function findHasAndBelongsToMany(Model $model, $associations) {
|
|
$foreignKey = $this->_modelKey($model->name);
|
|
foreach ($this->_tables as $otherTable) {
|
|
$tableName = null;
|
|
$offset = strpos($otherTable, $model->table . '_');
|
|
$otherOffset = strpos($otherTable, '_' . $model->table);
|
|
|
|
if ($offset !== false) {
|
|
$tableName = substr($otherTable, strlen($model->table . '_'));
|
|
} elseif ($otherOffset !== false) {
|
|
$tableName = substr($otherTable, 0, $otherOffset);
|
|
}
|
|
if ($tableName && in_array($tableName, $this->_tables)) {
|
|
$habtmName = $this->_modelName($tableName);
|
|
$associations['hasAndBelongsToMany'][] = array(
|
|
'alias' => $habtmName,
|
|
'className' => $habtmName,
|
|
'foreignKey' => $foreignKey,
|
|
'associationForeignKey' => $this->_modelKey($habtmName),
|
|
'joinTable' => $otherTable
|
|
);
|
|
}
|
|
}
|
|
return $associations;
|
|
}
|
|
|
|
/**
|
|
* Interact with the user and confirm associations.
|
|
*
|
|
* @param array $model Temporary Model instance.
|
|
* @param array $associations Array of associations to be confirmed.
|
|
* @return array Array of confirmed associations
|
|
*/
|
|
public function confirmAssociations(Model $model, $associations) {
|
|
foreach ($associations as $type => $settings) {
|
|
if (!empty($associations[$type])) {
|
|
foreach ($associations[$type] as $i => $assoc) {
|
|
$prompt = "{$model->name} {$type} {$assoc['alias']}?";
|
|
$response = $this->in($prompt, array('y', 'n'), 'y');
|
|
|
|
if (strtolower($response) === 'n') {
|
|
unset($associations[$type][$i]);
|
|
} elseif ($type === 'hasMany') {
|
|
unset($associations['hasOne'][$i]);
|
|
}
|
|
}
|
|
$associations[$type] = array_merge($associations[$type]);
|
|
}
|
|
}
|
|
return $associations;
|
|
}
|
|
|
|
/**
|
|
* Interact with the user and generate additional non-conventional associations
|
|
*
|
|
* @param Model $model Temporary model instance
|
|
* @param array $associations Array of associations.
|
|
* @return array Array of associations.
|
|
*/
|
|
public function doMoreAssociations(Model $model, $associations) {
|
|
$prompt = __d('cake_console', 'Would you like to define some additional model associations?');
|
|
$wannaDoMoreAssoc = $this->in($prompt, array('y', 'n'), 'n');
|
|
$possibleKeys = $this->_generatePossibleKeys();
|
|
while (strtolower($wannaDoMoreAssoc) === 'y') {
|
|
$assocs = array('belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany');
|
|
$this->out(__d('cake_console', 'What is the association type?'));
|
|
$assocType = (int)$this->inOptions($assocs, __d('cake_console', 'Enter a number'));
|
|
|
|
$this->out(__d('cake_console', "For the following options be very careful to match your setup exactly.\n" .
|
|
"Any spelling mistakes will cause errors."));
|
|
$this->hr();
|
|
|
|
$alias = $this->in(__d('cake_console', 'What is the alias for this association?'));
|
|
$className = $this->in(__d('cake_console', 'What className will %s use?', $alias), null, $alias);
|
|
|
|
if ($assocType === 0) {
|
|
if (!empty($possibleKeys[$model->table])) {
|
|
$showKeys = $possibleKeys[$model->table];
|
|
} else {
|
|
$showKeys = null;
|
|
}
|
|
$suggestedForeignKey = $this->_modelKey($alias);
|
|
} else {
|
|
$otherTable = Inflector::tableize($className);
|
|
if (in_array($otherTable, $this->_tables)) {
|
|
if ($assocType < 3) {
|
|
if (!empty($possibleKeys[$otherTable])) {
|
|
$showKeys = $possibleKeys[$otherTable];
|
|
} else {
|
|
$showKeys = null;
|
|
}
|
|
} else {
|
|
$showKeys = null;
|
|
}
|
|
} else {
|
|
$otherTable = $this->in(__d('cake_console', 'What is the table for this model?'));
|
|
$showKeys = $possibleKeys[$otherTable];
|
|
}
|
|
$suggestedForeignKey = $this->_modelKey($model->name);
|
|
}
|
|
if (!empty($showKeys)) {
|
|
$this->out(__d('cake_console', 'A helpful List of possible keys'));
|
|
$foreignKey = $this->inOptions($showKeys, __d('cake_console', 'What is the foreignKey?'));
|
|
$foreignKey = $showKeys[(int)$foreignKey];
|
|
}
|
|
if (!isset($foreignKey)) {
|
|
$foreignKey = $this->in(__d('cake_console', 'What is the foreignKey? Specify your own.'), null, $suggestedForeignKey);
|
|
}
|
|
if ($assocType === 3) {
|
|
$associationForeignKey = $this->in(__d('cake_console', 'What is the associationForeignKey?'), null, $this->_modelKey($model->name));
|
|
$joinTable = $this->in(__d('cake_console', 'What is the joinTable?'));
|
|
}
|
|
$associations[$assocs[$assocType]] = array_values((array)$associations[$assocs[$assocType]]);
|
|
$count = count($associations[$assocs[$assocType]]);
|
|
$i = ($count > 0) ? $count : 0;
|
|
$associations[$assocs[$assocType]][$i]['alias'] = $alias;
|
|
$associations[$assocs[$assocType]][$i]['className'] = $className;
|
|
$associations[$assocs[$assocType]][$i]['foreignKey'] = $foreignKey;
|
|
if ($assocType === 3) {
|
|
$associations[$assocs[$assocType]][$i]['associationForeignKey'] = $associationForeignKey;
|
|
$associations[$assocs[$assocType]][$i]['joinTable'] = $joinTable;
|
|
}
|
|
$wannaDoMoreAssoc = $this->in(__d('cake_console', 'Define another association?'), array('y', 'n'), 'y');
|
|
}
|
|
return $associations;
|
|
}
|
|
|
|
/**
|
|
* Finds all possible keys to use on custom associations.
|
|
*
|
|
* @return array Array of tables and possible keys
|
|
*/
|
|
protected function _generatePossibleKeys() {
|
|
$possible = array();
|
|
foreach ($this->_tables as $otherTable) {
|
|
$tempOtherModel = new Model(array('table' => $otherTable, 'ds' => $this->connection));
|
|
$modelFieldsTemp = $tempOtherModel->schema(true);
|
|
foreach ($modelFieldsTemp as $fieldName => $field) {
|
|
if ($field['type'] === 'integer' || $field['type'] === 'string') {
|
|
$possible[$otherTable][] = $fieldName;
|
|
}
|
|
}
|
|
}
|
|
return $possible;
|
|
}
|
|
|
|
/**
|
|
* Assembles and writes a Model file.
|
|
*
|
|
* @param string|object $name Model name or object
|
|
* @param array|bool $data if array and $name is not an object assume bake data, otherwise boolean.
|
|
* @return string
|
|
*/
|
|
public function bake($name, $data = array()) {
|
|
if ($name instanceof Model) {
|
|
if (!$data) {
|
|
$data = array();
|
|
$data['associations'] = $this->doAssociations($name);
|
|
$data['validate'] = $this->doValidation($name);
|
|
$data['actsAs'] = $this->doActsAs($name);
|
|
}
|
|
$data['primaryKey'] = $name->primaryKey;
|
|
$data['useTable'] = $name->table;
|
|
$data['useDbConfig'] = $name->useDbConfig;
|
|
$data['name'] = $name = $name->name;
|
|
} else {
|
|
$data['name'] = $name;
|
|
}
|
|
|
|
$defaults = array(
|
|
'associations' => array(),
|
|
'actsAs' => array(),
|
|
'validate' => array(),
|
|
'primaryKey' => 'id',
|
|
'useTable' => null,
|
|
'useDbConfig' => 'default',
|
|
'displayField' => null
|
|
);
|
|
$data = array_merge($defaults, $data);
|
|
|
|
$pluginPath = '';
|
|
if ($this->plugin) {
|
|
$pluginPath = $this->plugin . '.';
|
|
}
|
|
|
|
$this->Template->set($data);
|
|
$this->Template->set(array(
|
|
'plugin' => $this->plugin,
|
|
'pluginPath' => $pluginPath
|
|
));
|
|
$out = $this->Template->generate('classes', 'model');
|
|
|
|
$path = $this->getPath();
|
|
$filename = $path . $name . '.php';
|
|
$this->out("\n" . __d('cake_console', 'Baking model class for %s...', $name), 1, Shell::QUIET);
|
|
$this->createFile($filename, $out);
|
|
ClassRegistry::flush();
|
|
return $out;
|
|
}
|
|
|
|
/**
|
|
* Assembles and writes a unit test file
|
|
*
|
|
* @param string $className Model class name
|
|
* @return string
|
|
*/
|
|
public function bakeTest($className) {
|
|
$this->Test->interactive = $this->interactive;
|
|
$this->Test->plugin = $this->plugin;
|
|
$this->Test->connection = $this->connection;
|
|
return $this->Test->bake('Model', $className);
|
|
}
|
|
|
|
/**
|
|
* outputs the a list of possible models or controllers from database
|
|
*
|
|
* @param string $useDbConfig Database configuration name
|
|
* @return array
|
|
*/
|
|
public function listAll($useDbConfig = null) {
|
|
$this->_tables = $this->getAllTables($useDbConfig);
|
|
|
|
$this->_modelNames = array();
|
|
$count = count($this->_tables);
|
|
for ($i = 0; $i < $count; $i++) {
|
|
$this->_modelNames[] = $this->_modelName($this->_tables[$i]);
|
|
}
|
|
if ($this->interactive === true) {
|
|
$this->out(__d('cake_console', 'Possible Models based on your current database:'));
|
|
$len = strlen($count + 1);
|
|
for ($i = 0; $i < $count; $i++) {
|
|
$this->out(sprintf("%${len}d. %s", $i + 1, $this->_modelNames[$i]));
|
|
}
|
|
}
|
|
return $this->_tables;
|
|
}
|
|
|
|
/**
|
|
* Interact with the user to determine the table name of a particular model
|
|
*
|
|
* @param string $modelName Name of the model you want a table for.
|
|
* @param string $useDbConfig Name of the database config you want to get tables from.
|
|
* @return string Table name
|
|
*/
|
|
public function getTable($modelName, $useDbConfig = null) {
|
|
$useTable = Inflector::tableize($modelName);
|
|
if (in_array($modelName, $this->_modelNames)) {
|
|
$modelNames = array_flip($this->_modelNames);
|
|
$useTable = $this->_tables[$modelNames[$modelName]];
|
|
}
|
|
|
|
if ($this->interactive === true) {
|
|
if (!isset($useDbConfig)) {
|
|
$useDbConfig = $this->connection;
|
|
}
|
|
$db = ConnectionManager::getDataSource($useDbConfig);
|
|
$fullTableName = $db->fullTableName($useTable, false);
|
|
$tableIsGood = false;
|
|
if (array_search($useTable, $this->_tables) === false) {
|
|
$this->out();
|
|
$this->out(__d('cake_console', "Given your model named '%s',\nCake would expect a database table named '%s'", $modelName, $fullTableName));
|
|
$tableIsGood = $this->in(__d('cake_console', 'Do you want to use this table?'), array('y', 'n'), 'y');
|
|
}
|
|
if (strtolower($tableIsGood) === 'n') {
|
|
$useTable = $this->in(__d('cake_console', 'What is the name of the table (without prefix)?'));
|
|
}
|
|
}
|
|
return $useTable;
|
|
}
|
|
|
|
/**
|
|
* Get an Array of all the tables in the supplied connection
|
|
* will halt the script if no tables are found.
|
|
*
|
|
* @param string $useDbConfig Connection name to scan.
|
|
* @return array Array of tables in the database.
|
|
*/
|
|
public function getAllTables($useDbConfig = null) {
|
|
if (!isset($useDbConfig)) {
|
|
$useDbConfig = $this->connection;
|
|
}
|
|
|
|
$tables = array();
|
|
$db = ConnectionManager::getDataSource($useDbConfig);
|
|
$db->cacheSources = false;
|
|
$usePrefix = empty($db->config['prefix']) ? '' : $db->config['prefix'];
|
|
if ($usePrefix) {
|
|
foreach ($db->listSources() as $table) {
|
|
if (!strncmp($table, $usePrefix, strlen($usePrefix))) {
|
|
$tables[] = substr($table, strlen($usePrefix));
|
|
}
|
|
}
|
|
} else {
|
|
$tables = $db->listSources();
|
|
}
|
|
if (empty($tables)) {
|
|
$this->err(__d('cake_console', 'Your database does not have any tables.'));
|
|
return $this->_stop();
|
|
}
|
|
sort($tables);
|
|
return $tables;
|
|
}
|
|
|
|
/**
|
|
* Forces the user to specify the model he wants to bake, and returns the selected model name.
|
|
*
|
|
* @param string $useDbConfig Database config name
|
|
* @return string The model name
|
|
*/
|
|
public function getName($useDbConfig = null) {
|
|
$this->listAll($useDbConfig);
|
|
|
|
$enteredModel = '';
|
|
|
|
while (!$enteredModel) {
|
|
$enteredModel = $this->in(__d('cake_console', "Enter a number from the list above,\n" .
|
|
"type in the name of another model, or 'q' to exit"), null, 'q');
|
|
|
|
if ($enteredModel === 'q') {
|
|
$this->out(__d('cake_console', 'Exit'));
|
|
return $this->_stop();
|
|
}
|
|
|
|
if (!$enteredModel || (int)$enteredModel > count($this->_modelNames)) {
|
|
$this->err(__d('cake_console', "The model name you supplied was empty,\n" .
|
|
"or the number you selected was not an option. Please try again."));
|
|
$enteredModel = '';
|
|
}
|
|
}
|
|
if ((int)$enteredModel > 0 && (int)$enteredModel <= count($this->_modelNames)) {
|
|
return $this->_modelNames[(int)$enteredModel - 1];
|
|
}
|
|
|
|
return $enteredModel;
|
|
}
|
|
|
|
/**
|
|
* Gets the option parser instance and configures it.
|
|
*
|
|
* @return ConsoleOptionParser
|
|
*/
|
|
public function getOptionParser() {
|
|
$parser = parent::getOptionParser();
|
|
|
|
$parser->description(
|
|
__d('cake_console', 'Bake models.')
|
|
)->addArgument('name', array(
|
|
'help' => __d('cake_console', 'Name of the model to bake. Can use Plugin.name to bake plugin models.')
|
|
))->addSubcommand('all', array(
|
|
'help' => __d('cake_console', 'Bake all model files with associations and validation.')
|
|
))->addOption('plugin', array(
|
|
'short' => 'p',
|
|
'help' => __d('cake_console', 'Plugin to bake the model into.')
|
|
))->addOption('theme', array(
|
|
'short' => 't',
|
|
'help' => __d('cake_console', 'Theme to use when baking code.')
|
|
))->addOption('connection', array(
|
|
'short' => 'c',
|
|
'help' => __d('cake_console', 'The connection the model table is on.')
|
|
))->addOption('force', array(
|
|
'short' => 'f',
|
|
'help' => __d('cake_console', 'Force overwriting existing files without prompting.')
|
|
))->epilog(
|
|
__d('cake_console', 'Omitting all arguments and options will enter into an interactive mode.')
|
|
);
|
|
|
|
return $parser;
|
|
}
|
|
|
|
/**
|
|
* Interact with FixtureTask to automatically bake fixtures when baking models.
|
|
*
|
|
* @param string $className Name of class to bake fixture for
|
|
* @param string $useTable Optional table name for fixture to use.
|
|
* @return void
|
|
* @see FixtureTask::bake
|
|
*/
|
|
public function bakeFixture($className, $useTable = null) {
|
|
$this->Fixture->interactive = $this->interactive;
|
|
$this->Fixture->connection = $this->connection;
|
|
$this->Fixture->plugin = $this->plugin;
|
|
$this->Fixture->bake($className, $useTable);
|
|
}
|
|
|
|
}
|