minor #1562 [docs] document new config values

This commit is contained in:
Jesse Rushlow
2024-08-29 12:21:21 -04:00
committed by GitHub
parent f0d1574458
commit a64783e9c2
11 changed files with 3082 additions and 11 deletions

80
.doctor-rst.yaml Normal file
View File

@@ -0,0 +1,80 @@
rules:
american_english: ~
avoid_repetetive_words: ~
blank_line_after_anchor: ~
blank_line_after_directive: ~
blank_line_before_directive: ~
composer_dev_option_not_at_the_end: ~
correct_code_block_directive_based_on_the_content: ~
deprecated_directive_should_have_version: ~
ensure_bash_prompt_before_composer_command: ~
ensure_correct_format_for_phpfunction: ~
ensure_exactly_one_space_before_directive_type: ~
ensure_exactly_one_space_between_link_definition_and_link: ~
ensure_explicit_nullable_types: ~
ensure_github_directive_start_with_prefix:
prefix: 'Symfony'
ensure_link_bottom: ~
ensure_link_definition_contains_valid_url: ~
ensure_order_of_code_blocks_in_configuration_block: ~
ensure_php_reference_syntax: ~
extend_abstract_controller: ~
# extension_xlf_instead_of_xliff: ~
forbidden_directives:
directives:
- '.. index::'
indention: ~
lowercase_as_in_use_statements: ~
max_blank_lines:
max: 2
max_colons: ~
no_app_console: ~
no_attribute_redundant_parenthesis: ~
no_blank_line_after_filepath_in_php_code_block: ~
no_blank_line_after_filepath_in_twig_code_block: ~
no_blank_line_after_filepath_in_xml_code_block: ~
no_blank_line_after_filepath_in_yaml_code_block: ~
no_brackets_in_method_directive: ~
no_composer_req: ~
no_directive_after_shorthand: ~
no_duplicate_use_statements: ~
no_footnotes: ~
no_inheritdoc: ~
no_merge_conflict: ~
no_namespace_after_use_statements: ~
no_php_open_tag_in_code_block_php_directive: ~
no_space_before_self_xml_closing_tag: ~
only_backslashes_in_namespace_in_php_code_block: ~
only_backslashes_in_use_statements_in_php_code_block: ~
ordered_use_statements: ~
php_prefix_before_bin_console: ~
remove_trailing_whitespace: ~
replace_code_block_types: ~
replacement: ~
short_array_syntax: ~
space_between_label_and_link_in_doc: ~
space_between_label_and_link_in_ref: ~
string_replacement: ~
title_underline_length_must_match_title_length: ~
typo: ~
unused_links: ~
use_deprecated_directive_instead_of_versionadded: ~
use_named_constructor_without_new_keyword_rule: ~
use_https_xsd_urls: ~
valid_inline_highlighted_namespaces: ~
valid_use_statements: ~
versionadded_directive_should_have_version: ~
yaml_instead_of_yml_suffix: ~
# master
versionadded_directive_major_version:
major_version: 1
versionadded_directive_min_version:
min_version: '1.0'
deprecated_directive_major_version:
major_version: 7
deprecated_directive_min_version:
min_version: '1.0'

1
.gitattributes vendored
View File

@@ -4,3 +4,4 @@
/tests export-ignore
/tools export-ignore
docker-compose.yml export-ignore
/_docs_build export-ignore

41
.github/workflows/ci-docs.yaml vendored Normal file
View File

@@ -0,0 +1,41 @@
name: "CI Docs Analysis"
on:
pull_request:
push:
branches:
- 'main'
schedule:
- cron: '0 0 * * *'
env:
PHPUNIT_FLAGS: "-v"
SYMFONY_PHPUNIT_DIR: "$HOME/symfony-bridge/.phpunit"
jobs:
doctor-rst:
name: Lint (DOCtor-RST)
runs-on: ubuntu-latest
steps:
- name: "Checkout"
uses: actions/checkout@v3
- name: "Create cache dir"
run: mkdir .cache
- name: "Extract base branch name"
run: echo "branch=$(echo ${GITHUB_BASE_REF:=${GITHUB_REF##*/}})" >> $GITHUB_OUTPUT
id: extract_base_branch
- name: "Cache DOCtor-RST"
uses: actions/cache@v3
with:
path: .cache
key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }}
- name: "Run DOCtor-RST"
uses: docker://oskarstark/doctor-rst:1.61.1
with:
args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache

2
.gitignore vendored
View File

@@ -7,3 +7,5 @@
/tools/*/composer.lock
/tools/*/vendor
/vendor/
/_docs_build/vendor
/_docs_build/output

View File

@@ -25,3 +25,27 @@ B) The generated code itself may change between minor releases. This
[1]: https://symfony.com/doc/current/bundles/SymfonyMakerBundle/index.html
[2]: https://symfony.com/doc/current/contributing/code/bc.html
---
Build Documentation Locally
---------------------------
This is not needed for contributing, but it's useful if you would like to debug some
issue in the docs or if you want to read MakerBundles Documentation offline.
```bash
$ cd _docs_build/
$ composer install
$ php build.php
```
After generating docs, serve them with the internal PHP server:
```bash
$ php -S localhost:8000 -t output/
```
Browse `http://localhost:8000` to read the docs.

65
_docs_build/build.php Executable file
View File

@@ -0,0 +1,65 @@
#!/usr/bin/env php
<?php
/*
* This file is part of the Symfony MakerBundle package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
require __DIR__.'/vendor/autoload.php';
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use SymfonyDocsBuilder\BuildConfig;
use SymfonyDocsBuilder\DocBuilder;
(new Application('Symfony Docs Builder', '1.0'))
->register('build-docs')
->addOption('generate-fjson-files', null, InputOption::VALUE_NONE, 'Use this option to generate docs both in HTML and JSON formats')
->setCode(function (InputInterface $input, OutputInterface $output) {
$io = new SymfonyStyle($input, $output);
$io->text('Building all Symfony Docs...');
$outputDir = __DIR__.'/output';
$buildConfig = (new BuildConfig())
->setSymfonyVersion('7.1')
->setContentDir(__DIR__.'/../src/Resources/doc')
->setOutputDir($outputDir)
->setImagesDir(__DIR__.'/output/_images')
->setImagesPublicPrefix('_images')
->setTheme('rtd')
->diableBuildCache()
;
$buildConfig->setExcludedPaths(['.github/', '_build/']);
if (!$generateJsonFiles = $input->getOption('generate-fjson-files')) {
$buildConfig->disableJsonFileGeneration();
}
$io->comment(sprintf('cache: disabled / output file type(s): %s', $generateJsonFiles ? 'HTML and JSON' : 'HTML'));
$result = (new DocBuilder())->build($buildConfig);
if ($result->isSuccessful()) {
$io->success(sprintf('The Symfony Docs were successfully built at %s', realpath($outputDir)));
return 0;
}
$io->error(sprintf("There were some errors while building the docs:\n\n%s\n", $result->getErrorTrace()));
$io->newLine();
$io->comment('Tip: you can add the -v, -vv or -vvv flags to this command to get debug information.');
return 1;
})
->getApplication()
->setDefaultCommand('build-docs', true)
->run();

22
_docs_build/composer.json Normal file
View File

@@ -0,0 +1,22 @@
{
"minimum-stability": "dev",
"prefer-stable": true,
"config": {
"platform": {
"php": "8.1.0"
},
"preferred-install": {
"*": "dist"
},
"sort-packages": true,
"allow-plugins": {
"symfony/flex": true
}
},
"require": {
"php": ">=8.1",
"symfony-tools/docs-builder": "^0.23",
"symfony/console": "^6.2",
"symfony/process": "^6.2"
}
}

1867
_docs_build/composer.lock generated Normal file

File diff suppressed because it is too large Load Diff

570
_docs_build/redirection_map Normal file
View File

@@ -0,0 +1,570 @@
/book/index /index
/cookbook/index /index
/book/stable_api /contributing/code/bc
/book/internals /reference/events
/configuration/apache_router /routing
/cookbook/console/sending_emails /cookbook/console/request_context
/cookbook/deployment-tools /cookbook/deployment/tools
/cookbook/doctrine/migrations /bundles/DoctrineFixturesBundle/index
/cookbook/doctrine/doctrine_fixtures /bundles/DoctrineFixturesBundle/index
/cookbook/doctrine/mongodb /bundles/DoctrineMongoDBBundle/index
/cookbook/form/dynamic_form_generation /cookbook/form/dynamic_form_modification
/cookbook/form/simple_signup_form_with_mongodb /bundles/DoctrineMongoDBBundle/form
/cookbook/email /email
/cookbook/gmail /cookbook/email/gmail
/cookbook/console /components/console
/cookbook/tools/autoloader https://github.com/symfony/class-loader
/cookbook/tools/finder /components/finder
/cookbook/service_container/parentservices /service_container/parent_services
/cookbook/service_container/factories /service_container/factories
/cookbook/service_container/tags /service_container/tags
/reference/configuration/mongodb /bundles/DoctrineMongoDBBundle/config
/reference/YAML /components/yaml
/cookbook/console/generating_urls /cookbook/console/sending_emails
/cmf/reference/configuration/block /cmf/bundles/block/configuration
/cmf/reference/configuration/content /cmf/bundles/content/configuration
/cmf/reference/configuration/core /cmf/bundles/core/configuration
/cmf/reference/configuration/create /cmf/bundles/create/configuration
/cmf/reference/configuration/media /cmf/bundles/media/configuration
/cmf/reference/configuration/menu /cmf/bundles/menu/configuration
/cmf/reference/configuration/phpcr_odm /cmf/bundles/phpcr_odm/configuration
/cmf/reference/configuration/routing /cmf/bundles/routing/configuration
/cmf/reference/configuration/search /cmf/bundles/search/configuration
/cmf/reference/configuration/seo /cmf/bundles/seo/configuration
/cmf/reference/configuration/simple_cms /cmf/bundles/simple_cms/configuration
/cmf/reference/configuration/tree_browser /cmf/bundles/tree_browser/configuration
/cmf/cookbook/exposing_content_via_rest /cmf/bundles/content/exposing_content_via_rest
/cmf/cookbook/creating_a_cms/auto-routing /cmf/tutorial/auto-routing
/cmf/cookbook/creating_a_cms/conclusion /cmf/tutorial/conclusion
/cmf/cookbook/creating_a_cms/content-to-controllers /cmf/tutorial/content-to-controllers
/cmf/cookbook/creating_a_cms/getting-started /cmf/tutorial/getting-started
/cmf/cookbook/creating_a_cms/index /cmf/tutorial/index
/cmf/cookbook/creating_a_cms/introduction /cmf/tutorial/introduction
/cmf/cookbook/creating_a_cms/make-homepage /cmf/tutorial/make-homepage
/cmf/cookbook/creating_a_cms/sonata-admin /cmf/tutorial/sonata-admin
/cmf/cookbook/creating_a_cms/the-frontend /cmf/tutorial/the-frontend
/cookbook/upgrading /cookbook/upgrade/index
/cookbook/security/voters_data_permission /cookbook/security/voters
/cookbook/configuration/pdo_session_storage /cookbook/doctrine/pdo_session_storage
/cookbook/configuration/mongodb_session_storage /cookbook/doctrine/mongodb_session_storage
/cookbook/service_container/event_listener /event_dispatcher
/create_framework/http-foundation /create_framework/http_foundation
/create_framework/front-controller /create_framework/front_controller
/create_framework/http-kernel-controller-resolver /create_framework/http_kernel_controller_resolver
/create_framework/separation-of-concerns /create_framework/separation_of_concerns
/create_framework/unit-testing /create_framework/unit_testing
/create_framework/event-dispatcher /create_framework/event_dispatcher
/create_framework/http-kernel-httpkernelinterface /create_framework/http_kernel_httpkernelinterface
/create_framework/http-kernel-httpkernel-class /create_framework/http_kernel_httpkernel_class
/create_framework/dependency-injection /create_framework/dependency_injection
/cookbook/doctrine/file_uploads /cookbook/controller/upload_file
/book/installation /setup
/book/page_creation /page_creation
/book/controller /controller
/book/routing /routing
/book/templating /templating
/book/bundles /bundles
/book/doctrine /doctrine
/book/testing /testing
/book/validation /validation
/book/forms /forms
/book/security /security
/book/http_cache /http_cache
/book/translation /translation
/book/service_container /service_container
/book/http_fundamentals /introduction/http_fundamentals
/book/from_flat_php_to_symfony2 /introduction/from_flat_php_to_symfony2
/book/configuration /configuration
/book/propel /propel/propel
/book/performance /performance
/bundles/installation /bundles
/cookbook/assetic/apply_to_option /frontend/assetic/apply_to_option
/cookbook/assetic/asset_management /frontend/assetic/asset_management
/cookbook/assetic/index /frontend/assetic/index
/cookbook/assetic/jpeg_optimize /frontend/assetic/jpeg_optimize
/cookbook/assetic/php /frontend/assetic/php
/cookbook/assetic/uglifyjs /frontend/assetic/uglifyjs
/cookbook/assetic/yuicompressor /frontend/assetic/yuicompressor
/assetic /frontend/assetic/index
/assetic/apply_to_option /frontend/assetic/apply_to_option
/assetic/asset_management /frontend/assetic/asset_management
/assetic/jpeg_optimize /frontend/assetic/jpeg_optimize
/assetic/php /frontend/assetic/php
/assetic/uglifyjs /frontend/assetic/uglifyjs
/assetic/yuicompressor /frontend/assetic/yuicompressor
/cookbook/bundles/best_practices /bundles/best_practices
/cookbook/bundles/configuration /bundles/configuration
/cookbook/bundles/extension /bundles/extension
/cookbook/bundles/index /bundles
/cookbook/bundles/inheritance /bundles/inheritance
/cookbook/bundles/installation /bundles
/cookbook/bundles/override /bundles/override
/cookbook/bundles/prepend_extension /bundles/prepend_extension
/cookbook/bundles/remove /bundles
/bundles/remove /bundles
/cookbook/cache/form_csrf_caching /http_cache/form_csrf_caching
/cookbook/cache/varnish /http_cache/varnish
/cookbook/composer /setup/composer
/cookbook/configuration/apache_router /routing
/cookbook/configuration/configuration_organization /configuration/configuration_organization
/cookbook/configuration/environments /configuration/environments
/cookbook/configuration/external_parameters /configuration/external_parameters
/cookbook/configuration/front_controllers_and_kernel /configuration/front_controllers_and_kernel
/cookbook/configuration/micro-kernel-trait /configuration/micro_kernel_trait
/cookbook/configuration/index /configuration
/cookbook/configuration/override_dir_structure /configuration/override_dir_structure
/cookbook/configuration/using_parameters_in_dic /configuration/using_parameters_in_dic
/cookbook/configuration/web_server_configuration /setup/web_server_configuration
/cookbook/console/command_in_controller /console/command_in_controller
/cookbook/console/commands_as_services /console/commands_as_services
/cookbook/console/console_command /console
/cookbook/console/index /console
/cookbook/console/logging /console
/cookbook/console/request_context /console/request_context
/cookbook/console/style /console/style
/cookbook/console/usage /console
/console/usage /console
/cookbook/controller/csrf_token_validation /security/csrf
/cookbook/controller/error_pages /controller/error_pages
/cookbook/controller/forwarding /controller/forwarding
/cookbook/controller/index /controller
/cookbook/controller/service /controller/service
/cookbook/controller/upload_file /controller/upload_file
/cookbook/debugging /
/debug/debugging /
/cookbook/deployment/tools /deployment/tools
/cookbook/doctrine/common_extensions /doctrine/common_extensions
/cookbook/doctrine/console /doctrine
/cookbook/doctrine/custom_dql_functions /doctrine/custom_dql_functions
/cookbook/doctrine/dbal /doctrine/dbal
/cookbook/doctrine/event_listeners_subscribers /doctrine/event_listeners_subscribers
/cookbook/doctrine/index /doctrine
/cookbook/doctrine/mapping_model_classes /doctrine
/doctrine/mapping_model_classes /doctrine
/cookbook/doctrine/mongodb_session_storage /doctrine/mongodb_session_storage
/cookbook/doctrine/multiple_entity_managers /doctrine/multiple_entity_managers
/cookbook/doctrine/pdo_session_storage /doctrine/pdo_session_storage
/cookbook/doctrine/registration_form /doctrine/registration_form
/cookbook/doctrine/resolve_target_entity /doctrine/resolve_target_entity
/cookbook/doctrine/reverse_engineering /doctrine/reverse_engineering
/doctrine/repository /doctrine
/doctrine/console /doctrine
/cookbook/email/cloud /email
/cookbook/email/dev_environment /email/dev_environment
/cookbook/email/email /email
/cookbook/email/gmail /email
/cookbook/email/index /email
/cookbook/email/spool /email/spool
/cookbook/email/testing /email/testing
/cookbook/event_dispatcher/before_after_filters /event_dispatcher#event-dispatcher-before-after-filters
/event_dispatcher/before_after_filters /event_dispatcher#event-dispatcher-before-after-filters
/cookbook/event_dispatcher/class_extension /event_dispatcher/class_extension
/cookbook/event_dispatcher/event_listener /event_dispatcher
/cookbook/event_dispatcher/index /event_dispatcher
/cookbook/event_dispatcher/method_behavior /event_dispatcher/method_behavior
/event_dispatcher/method_behavior /event_dispatcher#event-dispatcher-method-behavior
/cookbook/expressions /security/expressions
/expressions /security/expressions
/cookbook/form/create_custom_field_type /form/create_custom_field_type
/cookbook/form/create_form_type_extension /form/create_form_type_extension
/cookbook/form/data_transformers /form/data_transformers
/cookbook/form/direct_submit /form/direct_submit
/cookbook/form/dynamic_form_modification /form/dynamic_form_modification
/cookbook/form/form_collections /form/form_collections
/cookbook/form/form_customization /form/form_customization
/cookbook/form/index /forms
/cookbook/form/inherit_data_option /form/inherit_data_option
/cookbook/form/unit_testing /form/unit_testing
/cookbook/form/use_empty_data /form/use_empty_data
/cookbook/frontend/bower /frontend
/cookbook/frontend/index /frontend
/cookbook/install/unstable_versions /setup/unstable_versions
/cookbook/install/bundles /setup/bundles
/cookbook/install/index /setup
/cookbook/install/upgrade_major /setup/upgrade_major
/cookbook/install/upgrade_minor /setup/upgrade_minor
/cookbook/install/upgrade_patch /setup/upgrade_patch
/cookbook/logging/channels_handlers /logging/channels_handlers
/cookbook/logging/index /logging
/cookbook/logging/monolog /logging
/cookbook/logging/monolog_console /logging/monolog_console
/cookbook/logging/monolog_email /logging/monolog_email
/cookbook/logging/monolog_regex_based_excludes /logging/monolog_regex_based_excludes
/cookbook/profiler/data_collector /profiler#profiler-data-collector
/profiler/data_collector /profiler#profiler-data-collector
/cookbook/profiler/index /profiler
/cookbook/profiler/matchers /profiler/matchers
/cookbook/profiler/profiling_data /profiler/profiling_data
/cookbook/profiler/storage /profiler/storage
/cookbook/psr7 /components/psr7
/cookbook/request/index /request
/cookbook/request/load_balancer_reverse_proxy /deployment/proxies
/cookbook/request/mime_type /reference/configuration/framework
/cookbook/routing/conditions /routing/conditions
/cookbook/routing/custom_route_loader /routing/custom_route_loader
/cookbook/routing/debug /routing/debug
/cookbook/routing/external_resources /routing/external_resources
/cookbook/routing/extra_information /routing/extra_information
/cookbook/routing/index /routing
/cookbook/routing/method_parameters /routing/requirements
/cookbook/routing/optional_placeholders /routing/optional_placeholders
/cookbook/routing/redirect_in_config /routing/redirect_in_config
/cookbook/routing/redirect_trailing_slash /routing/redirect_trailing_slash
/cookbook/routing/requirements /routing/requirements
/cookbook/routing/routing_from_database /routing/routing_from_database
/cookbook/routing/scheme /routing/scheme
/cookbook/routing/service_container_parameters /routing/service_container_parameters
/cookbook/routing/slash_in_parameter /routing/slash_in_parameter
/cookbook/security/access_control /security/access_control
/cookbook/security/acl /security/acl
/cookbook/security/acl_advanced /security/acl_advanced
/cookbook/security/api_key_authentication /security/api_key_authentication
/cookbook/security/csrf_in_login_form /security/csrf
/cookbook/security/custom_authentication_provider /security/custom_authentication_provider
/cookbook/security/custom_password_authenticator /security/custom_password_authenticator
/cookbook/security/custom_provider /security/custom_provider
/cookbook/security/entity_provider /security/entity_provider
/cookbook/security/firewall_restriction /security/firewall_restriction
/cookbook/security/force_https /security/force_https
/cookbook/security/form_login /security/form_login
/cookbook/security/form_login_setup /security/form_login_setup
/cookbook/security/guard-authentication /security/guard_authentication
/cookbook/security/host_restriction /security/host_restriction
/cookbook/security/impersonating_user /security/impersonating_user
/cookbook/security/ldap /security/ldap
/cookbook/security/multiple_guard_authenticators /security/multiple_guard_authenticators
/cookbook/security/index /security
/cookbook/security/multiple_user_providers /security/multiple_user_providers
/cookbook/security/named_encoders /security/named_encoders
/cookbook/security/pre_authenticated /security/pre_authenticated
/cookbook/security/remember_me /security/remember_me
/cookbook/security/securing_services /security/securing_services
/cookbook/security/target_path /security/target_path
/cookbook/security/user_checkers /security/user_checkers
/cookbook/security/voters /security/voters
/cookbook/serializer /serializer
/cookbook/service_container/compiler_passes /service_container/compiler_passes
/cookbook/service_container/index /service_container
/cookbook/service_container/scopes /service_container/scopes
/cookbook/service_container/shared /service_container/shared
/cookbook/session/avoid_session_start /session/avoid_session_start
/cookbook/session/index /session
/cookbook/session/limit_metadata_writes /reference/configuration/framework
/session/limit_metadata_writes /reference/configuration/framework
/cookbook/session/locale_sticky_session /session#locale-sticky-session
/cookbook/locale_sticky_session /session#locale-sticky-session
/cookbook/session/php_bridge /session/php_bridge
/cookbook/session/proxy_examples /session/proxy_examples
/cookbook/session/sessions_directory /session/sessions_directory
/cookbook/symfony1 /introduction/symfony1
/cookbook/templating/global_variables /templating#templating-global-variables
/templating/global_variables /templating#templating-global-variables
/cookbook/templating/index /templating
/cookbook/templating/namespaced_paths /templating/namespaced_paths
/cookbook/templating/PHP /templating/PHP
/cookbook/templating/render_without_controller /templating/render_without_controller
/cookbook/templating/twig_extension /templating/twig_extension
/cookbook/testing/bootstrap /testing/bootstrap
/cookbook/testing/database /testing/database
/cookbook/testing/doctrine /testing/doctrine
/cookbook/testing/http_authentication /testing/http_authentication
/cookbook/testing/index /testing
/cookbook/testing/insulating_clients /testing/insulating_clients
/cookbook/testing/profiling /testing/profiling
/cookbook/testing/simulating_authentication /testing/simulating_authentication
/cookbook/upgrade/bundles /upgrade/patch_version
/cookbook/upgrade/index /setup/upgrade_major
/cookbook/upgrade/major_version /setup/upgrade_minor
/cookbook/upgrade/minor_version /setup/upgrade_major
/cookbook/upgrade/patch_version /upgrade/bundles
/cookbook/validation/custom_constraint /validation/custom_constraint
/cookbook/validation/group_service_resolver /form/validation_group_service_resolver
/cookbook/validation/index /validation
/cookbook/validation/severity /validation/severity
/cookbook/web_server/built_in /setup/built_in_web_server
/cookbook/web_server/index /setup/built_in_web_server
/cookbook/web_services/index /controller/soap_web_service
/cookbook/web_services/php_soap_extension /controller/soap_web_service
/cookbook/workflow/homestead /setup/homestead
/cookbook/workflow/index /setup
/cookbook/workflow/new_project_git /setup
/cookbook/workflow/new_project_svn /setup
/setup/new_project_git /setup
/setup/new_project_svn /setup
/components/asset/index /components/asset
/components/asset/introduction /components/asset
/components/browser_kit/index /components/browser_kit
/components/browser_kit/introduction /components/browser_kit
/components/class_loader/introduction https://github.com/symfony/class-loader
/components/class_loader/index https://github.com/symfony/class-loader
/components/class_loader/cache_class_loader https://github.com/symfony/class-loader
/components/class_loader/class_loader https://github.com/symfony/class-loader
/components/class_loader/class_map_generator https://github.com/symfony/class-loader
/components/class_loader/debug_class_loader https://github.com/symfony/class-loader
/components/class_loader/map_class_loader https://github.com/symfony/class-loader
/components/class_loader/map_class_loader https://github.com/symfony/class-loader
/components/class_loader/psr4_class_loader https://github.com/symfony/class-loader
/components/config/introduction /components/config
/components/config/index /components/config
/components/console/helpers/tablehelper /components/console/helpers/table
/components/console/helpers/progresshelper /components/console/helpers/progressbar
/components/console/helpers/dialoghelper /components/console/helpers/questionhelper
/components/console/introduction /components/console
/components/console/index /components/console
/components/debug/class_loader /components/debug
/components/debug/introduction /components/debug
/components/debug/index /components/debug
/components/dependency_injection/advanced /service_container/alias_private
/components/dependency_injection/autowiring /service_container/autowiring
/components/dependency_injection/definitions /service_container/definitions
/components/dependency_injection/introduction /components/dependency_injection
/components/dependency_injection/index /components/dependency_injection
/components/dependency_injection/factories /service_container/factories
/components/dependency_injection/lazy_services /service_container/lazy_services
/components/dependency_injection/parameters /service_container/parameters
/components/dependency_injection/parentservices /service_container/parent_services
/components/dependency_injection/parent_services /service_container/parent_services
/components/dependency_injection/synthetic_services /service_container/synthetic_services
/components/dependency_injection/tags /service_container/tags
/components/dependency_injection/types /service_container/injection_types
/components/event_dispatcher/index /components/event_dispatcher
/components/event_dispatcher/introduction /components/event_dispatcher
/components/expression_language/introduction /components/expression_language
/components/expression_language/index /components/expression_language
/components/filesystem/introduction /components/filesystem
/components/filesystem/index /components/filesystem
/components/form/form_events /form/events
/components/form/introduction /components/form
/components/form/index /components/form
/components/form/type_guesser /form/type_guesser
/components/http_foundation/index /components/http_foundation
/components/http_foundation/introduction /components/http_foundation
/request/load_balancer_reverse_proxy /deployment/proxies
/components/http_foundation/trusting_proxies /deployment/proxies
/components/http_kernel/introduction /components/http_kernel
/components/http_kernel/index /components/http_kernel
/components/property_access/introduction /components/property_access
/components/property_access/index /components/property_access
/components/routing/index https://github.com/symfony/routing
/components/routing/introduction https://github.com/symfony/routing
/components/routing/hostname_pattern /routing/hostname_pattern
/components/security/introduction /components/security
/components/security/index /components/security
/components/templating/introduction https://github.com/symfony/templating
/components/templating/index https://github.com/symfony/templating
/components/templating/helpers/assetshelper https://github.com/symfony/templating
/components/templating/helpers/slotshelper https://github.com/symfony/templating
/components/translation/introduction /components/translation
/components/translation/index /components/translation
/components/var_dumper/introduction /components/var_dumper
/components/var_dumper/index /components/var_dumper
/components/yaml/introduction /components/yaml
/components/yaml/index /components/yaml
/console/logging /console
/controller/csrf_token_validation /security/csrf
/deployment/tools /deployment
/form/csrf_protection /security/csrf
/install/bundles /setup/bundles
/email/gmail /email
/email/cloud /email
/event_dispatcher/class_extension /event_dispatcher
/form /forms
/form/use_virtual_forms /form/inherit_data_option
/frontend/assetic /frontend/assetic/index
/frontend/assetic/apply_to_option /frontend/assetic/index
/frontend/assetic/asset_management /frontend/assetic/index
/frontend/assetic/jpeg_optimize /frontend/assetic/index
/frontend/assetic/php /frontend/assetic/index
/frontend/assetic/uglifyjs /frontend/assetic/index
/frontend/assetic/yuicompressor /frontend/assetic/index
/reference/configuration/assetic /frontend/assetic/index
/security/target_path /security
/security/csrf_in_login_form /security/csrf
/service_container/service_locators /service_container/service_subscribers_locators
/service_container/third_party /service_container
/templating/templating_service /templates
/testing/simulating_authentication /testing/http_authentication
/validation/group_service_resolver /form/validation_group_service_resolver
/request/load_balancer_reverse_proxy /deployment/proxies
/quick_tour/the_controller /quick_tour/the_big_picture
/quick_tour/the_view /quick_tour/flex_recipes
/service_container/service_locators /service_container/service_subscribers_locators
/templating/overriding /bundles/override
/templating/twig_extension /templates#templates-twig-extension
/templating/hinclude /templates#templates-hinclude
/templating/PHP /templates
/security/custom_provider /security/user_provider
/security/multiple_user_providers /security/user_provider
/security/custom_password_authenticator /security/guard_authentication
/security/api_key_authentication /security/guard_authentication
/security/pre_authenticated /security/auth_providers
/security/host_restriction /security/firewall_restriction
/security/acl_advanced /security/acl
/security/password_encoding /security
/weblink /web_link
/components/weblink https://github.com/symfony/web-link
/frontend/encore/installation-no-flex /frontend/encore/installation
/http_cache/form_csrf_caching /security/csrf
/console/logging /console
/reference/forms/twig_reference /form/form_customization
/form/rendering /form/form_customization
/profiler/matchers /profiler
/profiler/profiling_data /profiler
/profiler/wdt_follow_ajax /profiler
/security/entity_provider /security/user_provider
/session/avoid_session_start /session
/session/sessions_directory /session
/session/configuring_ttl /session#session-configure-ttl
/frontend/encore/legacy-apps /frontend/encore/legacy-applications
/configuration/external_parameters /configuration/environment_variables
/contributing/code/patches /contributing/code/pull_requests
/workflow/state-machines /workflow/workflow-and-state-machine
/workflow/introduction /workflow/workflow-and-state-machine
/workflow/usage /workflow
/introduction/from_flat_php_to_symfony2 /introduction/from_flat_php_to_symfony
/configuration/environment_variables /configuration/env_var_processors
/configuration/configuration_organization /configuration
/configuration/environments /configuration
/configuration/configuration_organization /configuration
/email/dev_environment /mailer
/email/spool /mailer
/email/testing /mailer
/contributing/community/other /contributing/community
/profiler/storage /profiler
/setup/composer /setup
/security/security_checker /setup
/setup/built_in_web_server /setup/symfony_server
/service_container/parameters /configuration
/routing/generate_url_javascript /routing
/routing/slash_in_parameter /routing
/routing/scheme /routing
/routing/optional_placeholders /routing
/routing/conditions /routing
/routing/requirements /routing
/routing/redirect_trailing_slash /routing
/routing/debug /routing
/routing/service_container_parameters /routing
/routing/redirect_in_config /routing
/routing/external_resources /routing
/routing/hostname_pattern /routing
/routing/extra_information /routing
/console/request_context /routing
/form/action_method /forms
/reference/requirements /setup
/bundles/inheritance /bundles/override
/templating /templates
/templating/escaping /templates#output-escaping
/templating/syntax /templates#linting-twig-templates
/templating/debug /templates#the-dump-twig-utilities
/templating/render_without_controller /templates#rendering-a-template-directly-from-a-route
/templating/app_variable /templates#the-app-global-variable
/templating/formats /templates
/templating/namespaced_paths /templates#template-namespaces
/templating/embedding_controllers /templates#embedding-controllers
/templating/inheritance /templates#template-inheritance-and-layouts
/testing/doctrine /testing/database
/translation/templates /translation#translation-in-templates
/translation/debug /translation#translation-debug
/translation/lint /translation#translation-lint
/translation/locale /translation#translation-locale
/doctrine/lifecycle_callbacks /doctrine/events
/doctrine/event_listeners_subscribers /doctrine/events
/doctrine/common_extensions /doctrine
/best_practices/index /best_practices
/best_practices/introduction /best_practices
/best_practices/creating-the-project /best_practices
/best_practices/configuration /best_practices
/best_practices/business-logic /best_practices
/best_practices/controllers /best_practices
/best_practices/templates /best_practices
/best_practices/forms /best_practices
/best_practices/i18n /best_practices
/best_practices/security /best_practices
/best_practices/web-assets /best_practices
/best_practices/tests /best_practices
/components/debug https://github.com/symfony/debug
/components/translation https://github.com/symfony/translation
/components/translation/usage /translation
/components/translation/custom_formats https://github.com/symfony/translation
/components/translation/custom_message_formatter https://github.com/symfony/translation
/components/notifier https://github.com/symfony/notifier
/components/routing https://github.com/symfony/routing
/session/database /session#session-database
/doctrine/pdo_session_storage /session#session-database-pdo
/doctrine/mongodb_session_storage /session#session-database-mongodb
/components/dotenv https://github.com/symfony/dotenv
/components/mercure /mercure
/components/polyfill_apcu https://github.com/symfony/polyfill-apcu
/components/polyfill_ctype https://github.com/symfony/polyfill-ctype
/components/polyfill_iconv https://github.com/symfony/polyfill-iconv
/components/polyfill_intl_grapheme https://github.com/symfony/polyfill_intl-grapheme
/components/polyfill_intl_icu https://github.com/symfony/polyfill_intl-icu
/components/polyfill_intl_idn https://github.com/symfony/polyfill_intl-idn
/components/polyfill_intl_normalizer https://github.com/symfony/polyfill_intl-normalizer
/components/polyfill_mbstring https://github.com/symfony/polyfill-mbstring
/components/polyfill_php54 https://github.com/symfony/polyfill-php54
/components/polyfill_php55 https://github.com/symfony/polyfill-php55
/components/polyfill_php56 https://github.com/symfony/polyfill-php56
/components/polyfill_php70 https://github.com/symfony/polyfill-php70
/components/polyfill_php71 https://github.com/symfony/polyfill-php71
/components/polyfill_php72 https://github.com/symfony/polyfill-php72
/components/polyfill_php73 https://github.com/symfony/polyfill-php73
/components/polyfill_uuid https://github.com/symfony/polyfill-uuid
/components/web_link https://github.com/symfony/web-link
/components/templating https://github.com/symfony/templating
/components/error_handler https://github.com/symfony/error-handler
/components/class_loader https://github.com/symfony/class-loader
/frontend/encore/versus-assetic /frontend
/components/http_client /http_client
/components/mailer /mailer
/messenger/message-recorder /messenger/dispatch_after_current_bus
/components/stopwatch https://github.com/symfony/stopwatch
/service_container/3.3-di-changes https://symfony.com/doc/3.4/service_container/3.3-di-changes.html
/frontend/encore/shared-entry /frontend/encore/split-chunks
/frontend/encore/page-specific-assets /frontend/encore/simple-example#page-specific-javascript-or-css
/testing/functional_tests_assertions /testing#testing-application-assertions
/components https://symfony.com/components
/components/index https://symfony.com/components
/serializer/normalizers /components/serializer#normalizers
/components/serializer#component-serializer-attributes-groups-annotations /components/serializer#component-serializer-attributes-groups-attributes
/logging/monolog_regex_based_excludes /logging/monolog_exclude_http_codes
/security/named_encoders /security/named_hashers
/components/inflector /string#inflector
/security/experimental_authenticators /security
/security/user_provider /security/user_providers
/security/reset_password /security/passwords#reset-password
/security/auth_providers /security#security-authenticators
/security/form_login /security#form-login
/security/form_login_setup /security#form-login
/security/json_login_setup /security#json-login
/security/named_hashers /security/passwords#named-password-hashers
/security/password_migration /security/passwords#security-password-migration
/security/acl https://github.com/symfony/acl-bundle/blob/main/src/Resources/doc/index.rst
/security/securing_services /security#securing-other-services
/security/authenticator_manager /security
/security/multiple_guard_authenticators /security/entry_point
/security/guard_authentication /security/custom_authenticator
/components/security/authentication /security#authenticating-users
/components/security/authorization /security#access-control-authorization
/components/security/firewall /security#the-firewall
/components/security/secure_tools /security/passwords
/components/security /security
/components/var_dumper/advanced /components/var_dumper#advanced-usage
/components/yaml/yaml_format /reference/formats/yaml
/components/expression_language/syntax /reference/formats/expression_language
/components/expression_language/ast /components/expression_language#expression-language-ast
/components/expression_language/caching /components/expression_language#expression-language-caching
/components/expression_language/extending /components/expression_language#expression-language-extending
/notifier/chatters /notifier#sending-chat-messages
/notifier/texters /notifier#sending-sms
/notifier/events /notifier#notifier-events
/email /mailer
/frontend/assetic /frontend
/frontend/assetic/index /frontend
/controller/argument_value_resolver /controller/value_resolver
/frontend/ux https://symfony.com/bundles/StimulusBundle/current/index.html
/messenger/handler_results /messenger#messenger-getting-handler-results
/messenger/dispatch_after_current_bus /messenger#messenger-transactional-messages
/messenger/multiple_buses /messenger#messenger-multiple-buses
/frontend/encore/server-data /frontend/server-data
/components/string /string

View File

@@ -0,0 +1,344 @@
accessor
Akamai
analytics
Ansi
Ansible
async
authenticator
authenticators
autocompleted
autocompletion
autoconfiguration
autoconfigure
autoconfigured
autoconfigures
autoconfiguring
autoload
autoloaded
autoloader
autoloaders
autoloading
autoprefixing
autowire
autowireable
autowired
autowiring
backend
backends
balancer
balancers
bcrypt
benchmarking
Bitbucket
bitmask
bitmasks
bitwise
Blackfire
boolean
booleans
Brasseur
browserslist
buildpack
buildpacks
bundler
cacheable
Caddy
callables
camelCase
casted
changelog
changeset
charset
charsets
checkboxes
classmap
classname
clearers
cloner
cloners
codebase
config
configs
configurator
configurators
contrib
cron
cronjobs
cryptographic
cryptographically
Ctrl
ctype
cURL
customizable
customizations
Cygwin
dataset
datepicker
decrypt
denormalization
denormalize
denormalized
denormalizing
deprecations
deserialization
deserialize
deserialized
deserializing
destructor
dev
dn
DNS
docblock
Dotenv
downloader
Doxygen
DSN
Dunglas
easter
Eberlei
emilie
enctype
entrypoints
enum
env
escaper
escpaer
extensibility
extractable
eZPublish
Fabien
failover
filesystem
filesystems
formatter
formatters
frontend
getter
getters
GitHub
gmail
Gmail
Goutte
grapheme
hardcode
hardcoded
hardcodes
hardcoding
hasser
hassers
headshot
HInclude
hostname
https
iconv
igbinary
incrementing
ini
inlined
inlining
installable
instantiation
interoperable
intl
Intl
invokable
IPv
isser
issers
Jpegoptim
jQuery
js
Karlton
kb
kB
Kévin
Ki
KiB
kibibyte
Kubernetes
Kudu
labelled
latin
Ldap
libketama
licensor
lifecycle
liip
linter
localhost
Loggly
Logplex
lookups
loopback
lorenzo
Luhn
macOS
matcher
matchers
mbstring
mebibyte
memcache
memcached
MiB
michelle
minification
minified
minifier
minifies
minify
minifying
misconfiguration
misconfigured
misgendering
Monolog
mutator
nagle
namespace
namespaced
namespaces
namespacing
natively
nd
netmasks
nginx
normalizer
normalizers
npm
nyholm
OAuth
OPcache
overcomplicate
Packagist
parallelizes
parsers
PHP
PHPUnit
PID
plaintext
polyfill
polyfills
postcss
Potencier
pre
preconfigured
predefines
Predis
preload
preloaded
preloading
prepend
prepended
prepending
prepends
preprocessed
preprocessors
Procfile
profiler
programmatically
prototyped
rebase
reconfiguring
reconnection
redirections
refactorization
regexes
renderer
resolvers
responder
reStructuredText
reusability
runtime
sandboxing
schemas
screencast
semantical
serializable
serializer
sexualized
Silex
sluggable
socio
specificities
SQLite
stacktrace
stacktraces
storages
stringified
stylesheet
stylesheets
subclasses
subdirectories
subdirectory
sublcasses
sublicense
sublincense
subrequests
subtree
superclass
superglobal
superglobals
symfony
Symfony
symlink
symlinks
syntaxes
templating
testability
th
theming
throbber
timestampable
timezones
TLS
tmpfs
tobias
todo
Tomayko
Toolbelt
tooltip
Traversable
triaging
UI
uid
unary
unauthenticate
uncacheable
uncached
uncomment
uncommented
undelete
unhandled
unicode
Unix
unmapped
unminified
unported
unregister
unrendered
unserialize
unserialized
unserializing
unsubmitted
untracked
uploader
URI
validator
validators
variadic
VirtualBox
Vue
webpack
webpacked
webpackJsonp
webserver
whitespace
whitespaces
woh
Wordpress
Xdebug
xkcd
Xliff
XML
XPath
yaml
yay

View File

@@ -3,7 +3,7 @@ The Symfony MakerBundle
Symfony Maker helps you create empty commands, controllers, form classes,
tests and more so you can forget about writing boilerplate code. This bundle
assumes you're using a standard Symfony 5 directory structure, but many
assumes you're using a standard Symfony 6.4 directory structure, but many
commands can generate code into any application.
Installation
@@ -65,18 +65,74 @@ file by their respective environment variables:
Configuration
-------------
This bundle doesn't require any configuration. But, you *can* configure
the root namespace that is used to "guess" what classes you want to generate:
This bundle doesn't require any configuration. But, you *can* override the default
configuration:
.. code-block:: yaml
# config/packages/dev/maker.yaml
# create this file if you need to configure anything
maker:
# tell MakerBundle that all of your classes live in an
# Acme namespace, instead of the default App
# (e.g. Acme\Entity\Article, Acme\Command\MyCommand, etc)
root_namespace: 'Acme'
# config/packages/maker.yaml
when@dev:
maker:
root_namespace: 'App'
generate_final_classes: true
generate_final_entities: false
root_namespace
~~~~~~~~~~~~~~
**type**: ``string`` **default**: ``App``
The root namespace used when generating all of your classes
(e.g. ``App\Entity\Article``, ``App\Command\MyCommand``, etc). Changing
this to ``Acme`` would cause MakerBundle to create new classes like
(e.g. ``Acme\Entity\Article``, ``Acme\Command\MyCommand``, etc).
generate_final_classes
~~~~~~~~~~~~~~~~~~~~~~
**type**: ``boolean`` **default**: ``true``
By default, MakerBundle will generate all of your classes with the
``final`` PHP keyword except for doctrine entities. Set this to ``false``
to override this behavior for all maker commands.
See https://www.php.net/manual/en/language.oop5.final.php
.. code-block:: php
final class MyVoter
{
...
}
.. versionadded:: 1.61
``generate_final_classes`` was introduced in MakerBundle 1.61
generate_final_entities
~~~~~~~~~~~~~~~~~~~~~~~
**type**: ``boolean`` **default**: ``false``
By default, MakerBundle will not generate any of your doctrine entity
classes with the ``final`` PHP keyword. Set this to ``true``
to override this behavior for all maker commands that create
entities.
See https://www.php.net/manual/en/language.oop5.final.php
.. code-block:: php
#[ORM\Entity(repositoryClass: TaskRepository::class)]
final class Task extends AbstractEntity
{
...
}
.. versionadded:: 1.61
``generate_final_entities`` was introduced in MakerBundle 1.61.
Creating your Own Makers
------------------------
@@ -103,6 +159,5 @@ For that reason, in general, the generated code cannot be modified. In many case
adding your *own* maker command is so easy, that we recommend that. However, if there
is some extension point that you'd like, please open an issue so we can discuss!
.. _`SensioGeneratorBundle`: https://github.com/sensiolabs/SensioGeneratorBundle
.. _`AbstractMaker`: https://github.com/symfony/maker-bundle/blob/main/src/Maker/AbstractMaker.php
.. _`core maker commands`: https://github.com/symfony/maker-bundle/tree/main/src/Maker