Skip to content

Add option --forms-only to generate-admin command #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add option --forms-only to generate-admin command #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
246e2b2
Add option --forms-only to generate-admin command
sescandell Feb 6, 2016
e83a61a
Update generated generator file.
sescandell Feb 6, 2016
c399324
Do not update routing if forms-only
sescandell Feb 6, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Builder/Generator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,22 @@ public function getFromBundleConfig($configPath, $default = null)
);
}

/**
* @return array
*/
public function getBuildersFromYaml()
{
return $this->getFromYaml('builders', array());
}

/**
* @return boolean
*/
public function isFormsOnly()
{
return $this->getFromYaml('params.forms_only', false);
}

/**
* @param array $array The array to traverse.
* @param string $path Path string with point for levels.
Expand Down
17 changes: 10 additions & 7 deletions Command/GenerateAdminCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ protected function configure()
new InputOption('dir', '', InputOption::VALUE_REQUIRED, 'The directory where the bundle is', 'src/'),
new InputOption('bundle-name', '', InputOption::VALUE_REQUIRED, 'The bundle name'),
new InputOption('generator', '', InputOption::VALUE_REQUIRED, 'The generator service (propel, doctrine, doctrine_odm)', 'doctrine'),
new InputOption('model-name', '', InputOption::VALUE_REQUIRED, 'Base model name for admin module, without namespace.', 'YourModel'),
new InputOption('model-name', '', InputOption::VALUE_REQUIRED, 'Base model name for admin module, without namespace.'),
new InputOption('prefix', '', InputOption::VALUE_REQUIRED, 'The generator prefix ([prefix]-generator.yml)'),

new InputOption('forms-only', null, InputOption::VALUE_NONE, 'If set, only forms will be auto-generated.')
))
->setHelp(<<<EOT
The <info>admin:generate-admin</info> command helps you generates new admin pages for a given model.
Expand Down Expand Up @@ -216,7 +216,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
$generator->setPrefix($input->getOption('prefix'));
$generator->generate(
$bundle,
$input->getOption('model-name')
$input->getOption('model-name'),
$input->hasOption('forms-only')
);

$output->writeln('Generating the bundle code: <info>OK</info>');
Expand All @@ -231,7 +232,9 @@ protected function execute(InputInterface $input, OutputInterface $output)
$runner($this->updateKernel($output, $this->getContainer()->get('kernel'), $bundle));

// routing
$runner($this->updateRouting($output, $bundle, $input->getOption('prefix')));
if (!$input->hasOption('forms-only')) {
$runner($this->updateRouting($output, $bundle, $input->getOption('prefix')));
}

$questionHelper->writeGeneratorSummary($output, $errors);
}
Expand Down Expand Up @@ -309,13 +312,13 @@ protected function updateRouting(OutputInterface $output, Bundle $bundle, $prefi
try {
$ret = $routing->addResource($bundle->getName(), 'admingenerator');
if (!$ret) {
$help = sprintf(" <comment>resource: \"@%s/Controller/%s/\"</comment>\n <comment>type: admingenerator</comment>\n", $bundle->getName(), ucfirst($prefix));
$help .= " <comment>prefix: /</comment>\n";
$help = sprintf("\t\t<comment>resource: \"@%s/Controller/%s/\"</comment>\n\t<comment>type:\tadmingenerator</comment>\n", $bundle->getName(), ucfirst($prefix));
$help .= "\t\t<comment>prefix:\t/</comment>\n";

return array(
'- Import the bundle\'s routing resource in the app main routing file:',
'',
sprintf(' <comment>%s:</comment>', $bundle->getName()),
sprintf('\t<comment>%s:</comment>', $bundle->getName()),
$help,
'',
);
Expand Down
53 changes: 29 additions & 24 deletions Generator/BundleGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public function setPrefix($prefix)
* @param Bundle $bundle
* @param string $modelName
*/
public function generate(Bundle $bundle, $modelName)
public function generate(Bundle $bundle, $modelName, $formsOnly)
{
$dir = $bundle->getTargetDirectory();

Expand Down Expand Up @@ -127,35 +127,13 @@ public function generate(Bundle $bundle, $modelName)
'model_folder' => $modelFolder,
'model_name' => $modelName,
'prefix' => ucfirst($this->prefix),
'forms_only' => $formsOnly
);

if (!file_exists($dir.'/'.$bundle->getName().'.php')) {
$this->renderGeneratedFile('Bundle.php.twig', $dir.'/'.$bundle->getName().'.php', $parameters);
}

foreach ($this->actions as $action => $actionProperties) {
$parameters['action'] = $action;

$controllerFile = $dir.'/Controller/'
.($this->prefix ? ucfirst($this->prefix).'/' : '').$action.'Controller.php';
$this->copyPreviousFile($controllerFile);
$this->renderGeneratedFile(
'DefaultController.php.twig',
$controllerFile,
$parameters
);

foreach ($actionProperties['views'] as $templateName) {
$templateFile = $dir.'/Resources/views/'.ucfirst($this->prefix).$action.'/'.$templateName.'.html.twig';
$this->copyPreviousFile($templateFile);
$this->renderGeneratedFile(
'default_view.html.twig',
$templateFile,
$parameters + array('view' => $templateName)
);
}
}

foreach ($this->forms as $form) {
$parameters['form'] = $form;

Expand Down Expand Up @@ -183,6 +161,33 @@ public function generate(Bundle $bundle, $modelName)
$generatorFile,
$parameters
);

if ($formsOnly) {
return;
}

foreach ($this->actions as $action => $actionProperties) {
$parameters['action'] = $action;

$controllerFile = $dir.'/Controller/'
.($this->prefix ? ucfirst($this->prefix).'/' : '').$action.'Controller.php';
$this->copyPreviousFile($controllerFile);
$this->renderGeneratedFile(
'DefaultController.php.twig',
$controllerFile,
$parameters
);

foreach ($actionProperties['views'] as $templateName) {
$templateFile = $dir.'/Resources/views/'.ucfirst($this->prefix).$action.'/'.$templateName.'.html.twig';
$this->copyPreviousFile($templateFile);
$this->renderGeneratedFile(
'default_view.html.twig',
$templateFile,
$parameters + array('view' => $templateName)
);
}
}
}

/**
Expand Down
29 changes: 18 additions & 11 deletions Generator/DoctrineGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,41 +49,48 @@ protected function doBuild()
);
$generator->setBaseGeneratorName($this->getBaseGeneratorName());

$builders = $generator->getFromYaml('builders', array());
$builders = $generator->getBuildersFromYaml();
$formsOnly = $generator->isFormsOnly();

if (array_key_exists('list', $builders)) {
$generator->addBuilder(new ListBuilderAction());
$generator->addBuilder(new ListBuilderTemplate());
if (!$formsOnly) {
$generator->addBuilder(new ListBuilderAction());
$generator->addBuilder(new ListBuilderTemplate());
}
$generator->addBuilder(new FiltersBuilderType());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sescandell why generate filter forms?

}

if (array_key_exists('nested_list', $builders)) {
if (array_key_exists('nested_list', $builders) && !$formsOnly) {
$generator->addBuilder(new NestedListBuilderAction());
$generator->addBuilder(new NestedListBuilderTemplate());
}

if (array_key_exists('edit', $builders)) {
$generator->addBuilder(new EditBuilderAction());
$generator->addBuilder(new EditBuilderTemplate());
if (!$formsOnly) {
$generator->addBuilder(new EditBuilderAction());
$generator->addBuilder(new EditBuilderTemplate());
}
$generator->addBuilder(new EditBuilderType());
}

if (array_key_exists('new', $builders)) {
$generator->addBuilder(new NewBuilderAction());
$generator->addBuilder(new NewBuilderTemplate());
if (!$formsOnly) {
$generator->addBuilder(new NewBuilderAction());
$generator->addBuilder(new NewBuilderTemplate());
}
$generator->addBuilder(new NewBuilderType());
}

if (array_key_exists('show', $builders)) {
if (array_key_exists('show', $builders) && !$formsOnly) {
$generator->addBuilder(new ShowBuilderAction());
$generator->addBuilder(new ShowBuilderTemplate());
}

if (array_key_exists('excel', $builders)) {
if (array_key_exists('excel', $builders) && !$formsOnly) {
$generator->addBuilder(new ExcelBuilderAction());
}

if (array_key_exists('actions', $builders)) {
if (array_key_exists('actions', $builders) && !$formsOnly) {
$generator->addBuilder(new ActionsBuilderAction());
$generator->addBuilder(new ActionsBuilderTemplate());
}
Expand Down
27 changes: 17 additions & 10 deletions Generator/DoctrineODMGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,36 +47,43 @@ protected function doBuild()
);
$generator->setBaseGeneratorName($this->getBaseGeneratorName());

$builders = $generator->getFromYaml('builders', array());
$builders = $generator->getBuildersFromYaml();
$formsOnly = $generator->isFormsOnly();

if (array_key_exists('list', $builders)) {
$generator->addBuilder(new ListBuilderAction());
$generator->addBuilder(new ListBuilderTemplate());
if (!$formsOnly) {
$generator->addBuilder(new ListBuilderAction());
$generator->addBuilder(new ListBuilderTemplate());
}
$generator->addBuilder(new FiltersBuilderType());
}

if (array_key_exists('edit', $builders)) {
$generator->addBuilder(new EditBuilderAction());
$generator->addBuilder(new EditBuilderTemplate());
if (!$formsOnly) {
$generator->addBuilder(new EditBuilderAction());
$generator->addBuilder(new EditBuilderTemplate());
}
$generator->addBuilder(new EditBuilderType());
}

if (array_key_exists('new', $builders)) {
$generator->addBuilder(new NewBuilderAction());
$generator->addBuilder(new NewBuilderTemplate());
if (!$formsOnly) {
$generator->addBuilder(new NewBuilderAction());
$generator->addBuilder(new NewBuilderTemplate());
}
$generator->addBuilder(new NewBuilderType());
}

if (array_key_exists('show', $builders)) {
if (array_key_exists('show', $builders) && !$formsOnly) {
$generator->addBuilder(new ShowBuilderAction());
$generator->addBuilder(new ShowBuilderTemplate());
}

if (array_key_exists('excel', $builders)) {
if (array_key_exists('excel', $builders) && !$formsOnly) {
$generator->addBuilder(new ExcelBuilderAction());
}

if (array_key_exists('actions', $builders)) {
if (array_key_exists('actions', $builders) && !$formsOnly) {
$generator->addBuilder(new ActionsBuilderAction());
$generator->addBuilder(new ActionsBuilderTemplate());
}
Expand Down
29 changes: 18 additions & 11 deletions Generator/PropelGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,41 +49,48 @@ protected function doBuild()
$generator->setColumnClass('Admingenerator\GeneratorBundle\Generator\PropelColumn');
$generator->setBaseGeneratorName($this->getBaseGeneratorName());

$builders = $generator->getFromYaml('builders', array());
$builders = $generator->getBuildersFromYaml();
$formsOnly = $generator->isFormsOnly();

if (array_key_exists('list', $builders)) {
$generator->addBuilder(new ListBuilderAction());
$generator->addBuilder(new ListBuilderTemplate());
if (!$formsOnly) {
$generator->addBuilder(new ListBuilderAction());
$generator->addBuilder(new ListBuilderTemplate());
}
$generator->addBuilder(new FiltersBuilderType());
}

if (array_key_exists('nested_list', $builders)) {
if (array_key_exists('nested_list', $builders) && !$formsOnly) {
$generator->addBuilder(new NestedListBuilderAction());
$generator->addBuilder(new NestedListBuilderTemplate());
}

if (array_key_exists('edit', $builders)) {
$generator->addBuilder(new EditBuilderAction());
$generator->addBuilder(new EditBuilderTemplate());
if (!$formsOnly) {
$generator->addBuilder(new EditBuilderAction());
$generator->addBuilder(new EditBuilderTemplate());
}
$generator->addBuilder(new EditBuilderType());
}

if (array_key_exists('new', $builders)) {
$generator->addBuilder(new NewBuilderAction());
$generator->addBuilder(new NewBuilderTemplate());
if (!$formsOnly) {
$generator->addBuilder(new NewBuilderAction());
$generator->addBuilder(new NewBuilderTemplate());
}
$generator->addBuilder(new NewBuilderType());
}

if (array_key_exists('show', $builders)) {
if (array_key_exists('show', $builders) && !$formsOnly) {
$generator->addBuilder(new ShowBuilderAction());
$generator->addBuilder(new ShowBuilderTemplate());
}

if (array_key_exists('excel', $builders)) {
if (array_key_exists('excel', $builders) && $formsOnly) {
$generator->addBuilder(new ExcelBuilderAction());
}

if (array_key_exists('actions', $builders)) {
if (array_key_exists('actions', $builders) && !$formsOnly) {
$generator->addBuilder(new ActionsBuilderAction());
$generator->addBuilder(new ActionsBuilderTemplate());
}
Expand Down
11 changes: 11 additions & 0 deletions Resources/skeleton/bundle/generator.yml.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ params:
namespace_prefix: {{ namespace_prefix }}
concurrency_lock: ~
bundle_name: {{ bundle_name }}
forms_only: {{ forms_only ? 1 : 0 }}
pk_requirement: ~
fields: ~
object_actions:
Expand All @@ -13,31 +14,40 @@ params:
builders:
list:
params:
{% if not forms_only -%}
title: List for {{ bundle_name }}
display: ~
actions:
new: ~
object_actions:
edit: ~
delete: ~
{% endif %}
{% if not forms_only %}
excel:
params: ~
filename: ~
filetype: ~
{% endif %}
new:
params:
{% if not forms_only -%}
title: New object for {{ bundle_name }}
display: ~
actions:
save: ~
list: ~
{% endif %}
edit:
params:
{% if not forms_only -%}
title: "You're editing the object \"%object%\"|{ %object%: {{ model_name }}.title }|"
display: ~
actions:
save: ~
list: ~
{% endif %}
{% if not forms_only -%}
show:
params:
title: "You're viewing the object \"%object%\"|{ %object%: {{ model_name }}.title }|"
Expand All @@ -51,3 +61,4 @@ builders:
delete: ~
batch_actions:
delete: ~
{% endif %}