From 1b911fd3e8118841f1ef9b0f175d998dbac0a344 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Mon, 25 Jun 2018 12:12:06 +0200 Subject: [PATCH 1/3] Removed the full config dumps from config reference articles --- reference/configuration/assetic.rst | 121 +-------- reference/configuration/debug.rst | 27 +- reference/configuration/doctrine.rst | 283 ++------------------ reference/configuration/framework.rst | 4 +- reference/configuration/monolog.rst | 126 ++------- reference/configuration/security.rst | 315 +---------------------- reference/configuration/swiftmailer.rst | 85 ++---- reference/configuration/twig.rst | 149 +---------- reference/configuration/web_profiler.rst | 59 ++--- 9 files changed, 123 insertions(+), 1046 deletions(-) diff --git a/reference/configuration/assetic.rst b/reference/configuration/assetic.rst index b0a9f40993a..d715635a10c 100644 --- a/reference/configuration/assetic.rst +++ b/reference/configuration/assetic.rst @@ -1,122 +1,17 @@ .. index:: pair: Assetic; Configuration reference -AsseticBundle Configuration ("assetic") -======================================= +Assetic Configuration Reference (AsseticBundle) +=============================================== .. include:: /assetic/_standard_edition_warning.rst.inc -Full Default Configuration --------------------------- +You can get the full Asstic configuration reference as follows: -.. configuration-block:: +.. code-block:: terminal - .. code-block:: yaml + # displays the default config values defined by Symfony + $ php bin/console config:dump assetic - # app/config/config.yml - assetic: - debug: '%kernel.debug%' - use_controller: - enabled: '%kernel.debug%' - profiler: false - read_from: '%assetic.read_from%' - write_to: '%kernel.root_dir%/../web' - java: /usr/bin/java - node: /usr/bin/node - ruby: /usr/bin/ruby - sass: /usr/bin/sass - # An key-value pair of any number of named elements - variables: - some_name: [] - bundles: - - # Defaults (all currently registered bundles): - - FrameworkBundle - - SecurityBundle - - TwigBundle - - MonologBundle - - SwiftmailerBundle - - DoctrineBundle - - AsseticBundle - - ... - assets: - # An array of named assets (e.g. some_asset, some_other_asset) - some_asset: - inputs: [] - filters: [] - options: - # A key-value array of options and values - some_option_name: [] - filters: - - # An array of named filters (e.g. some_filter, some_other_filter) - some_filter: [] - workers: - # see https://github.com/symfony/AsseticBundle/pull/119 - # Cache can also be busted via the framework.assets.version - # setting - see the "framework" configuration section - cache_busting: - enabled: false - twig: - functions: - # An array of named functions (e.g. some_function, some_other_function) - some_function: [] - - .. code-block:: xml - - - - - - - - - FrameworkBundle - SecurityBundle - TwigBundle - MonologBundle - SwiftmailerBundle - DoctrineBundle - AsseticBundle - ... - - - - - - - - - - - - - - - - - - - - - - - - - - - - + # displays the actual config values used by your application + $ php bin/console debug:config assetic diff --git a/reference/configuration/debug.rst b/reference/configuration/debug.rst index 9b71abea50c..6d0b173a93d 100644 --- a/reference/configuration/debug.rst +++ b/reference/configuration/debug.rst @@ -1,19 +1,26 @@ .. index:: single: Configuration reference; Framework -DebugBundle Configuration ("debug") -=================================== +Debug Configuration Reference (DebugBundle) +=========================================== -The DebugBundle allows greater integration of the -:doc:`VarDumper component ` in the -Symfony full-stack framework and can be configured under the ``debug`` key -in your application configuration. When using XML, you must use the -``http://symfony.com/schema/dic/debug`` namespace. +The DebugBundle integrates the :doc:`VarDumper component ` +in Symfony applications. All these options are configured under the ``debug`` +key in your application configuration. -.. tip:: +.. code-block:: terminal - The XSD schema is available at - ``http://symfony.com/schema/dic/debug/debug-1.0.xsd``. + # displays the default config values defined by Symfony + $ php app/console config:dump debug + + # displays the actual config values used by your application + $ php app/console debug:config debug + +.. note:: + + When using XML, you must use the ``http://symfony.com/schema/dic/debug`` + namespace and the related XSD schema is available at: + ``http://symfony.com/schema/dic/debug/debug-1.0.xsd`` Configuration ------------- diff --git a/reference/configuration/doctrine.rst b/reference/configuration/doctrine.rst index 32512723e6b..3ee73fed642 100644 --- a/reference/configuration/doctrine.rst +++ b/reference/configuration/doctrine.rst @@ -2,280 +2,27 @@ single: Doctrine; ORM configuration reference single: Configuration reference; Doctrine ORM -DoctrineBundle Configuration ("doctrine") -========================================= +Doctrine Configuration Reference (DoctrineBundle) +================================================= -Full Default Configuration --------------------------- - -.. configuration-block:: +The DoctrineBundle integrates both the :doc:`DBAL ` and +:doc:`ORM ` Doctrine projects into Symfony applications. All these +options are configured under the ``doctrine`` key in your application +configuration. - .. code-block:: yaml +.. code-block:: terminal - # app/config/config.yml - doctrine: - dbal: - default_connection: default - types: - # A collection of custom types - # Example - some_custom_type: - class: Acme\HelloBundle\MyCustomType - commented: true - - connections: - # A collection of different named connections (e.g. default, conn2, etc) - default: - dbname: ~ - host: localhost - port: ~ - user: root - password: ~ - # charset of the database - charset: ~ - # charset and collation of the tables. Not inherited from database - default_table_options: - charset: ~ - collate: ~ - path: ~ - memory: ~ - - # The unix socket to use for MySQL - unix_socket: ~ - - # True to use as persistent connection for the ibm_db2 driver - persistent: ~ - - # The protocol to use for the ibm_db2 driver (default to TCPIP if omitted) - protocol: ~ - - # True to use dbname as service name instead of SID for Oracle - service: ~ - - # The session mode to use for the oci8 driver - sessionMode: ~ - - # True to use a pooled server with the oci8 driver - pooled: ~ - - # Configuring MultipleActiveResultSets for the pdo_sqlsrv driver - MultipleActiveResultSets: ~ - driver: pdo_mysql - platform_service: ~ - - # the version of your database engine - server_version: ~ - - # when true, queries are logged to a 'doctrine' monolog channel - logging: '%kernel.debug%' - profiling: '%kernel.debug%' - driver_class: ~ - wrapper_class: ~ - # the DBAL keepSlave option - keep_slave: false - options: - # an array of options - key: [] - mapping_types: - # an array of mapping types - name: [] - - # If defined, only the tables whose names match this regular expression are managed - # by the schema tool (in this example, any table name not starting with `wp_`) - #schema_filter: '/^(?!wp_)/' - - slaves: - - # a collection of named slave connections (e.g. slave1, slave2) - slave1: - dbname: ~ - host: localhost - port: ~ - user: root - password: ~ - charset: ~ - path: ~ - memory: ~ - - # The unix socket to use for MySQL - unix_socket: ~ - - # True to use as persistent connection for the ibm_db2 driver - persistent: ~ - - # The protocol to use for the ibm_db2 driver (default to TCPIP if omitted) - protocol: ~ - - # True to use dbname as service name instead of SID for Oracle - service: ~ - - # The session mode to use for the oci8 driver - sessionMode: ~ - - # True to use a pooled server with the oci8 driver - pooled: ~ - - # Configuring MultipleActiveResultSets for the pdo_sqlsrv driver - MultipleActiveResultSets: ~ + # displays the default config values defined by Symfony + $ php app/console config:dump doctrine - orm: - default_entity_manager: ~ - auto_generate_proxy_classes: false - proxy_dir: '%kernel.cache_dir%/doctrine/orm/Proxies' - proxy_namespace: Proxies - # search for the "ResolveTargetEntityListener" class for an article about this - resolve_target_entities: [] - entity_managers: - # A collection of different named entity managers (e.g. some_em, another_em) - some_em: - query_cache_driver: - type: array # Required - host: ~ - port: ~ - instance_class: ~ - class: ~ - metadata_cache_driver: - type: array # Required - host: ~ - port: ~ - instance_class: ~ - class: ~ - result_cache_driver: - type: array # Required - host: ~ - port: ~ - instance_class: ~ - class: ~ - connection: ~ - class_metadata_factory_name: Doctrine\ORM\Mapping\ClassMetadataFactory - default_repository_class: Doctrine\ORM\EntityRepository - auto_mapping: false - hydrators: - - # An array of hydrator names - hydrator_name: [] - mappings: - # An array of mappings, which may be a bundle name or something else - mapping_name: - mapping: true - type: ~ - dir: ~ - alias: ~ - prefix: ~ - is_bundle: ~ - dql: - # a collection of string functions - string_functions: - # example - # test_string: Acme\HelloBundle\DQL\StringFunction - - # a collection of numeric functions - numeric_functions: - # example - # test_numeric: Acme\HelloBundle\DQL\NumericFunction - - # a collection of datetime functions - datetime_functions: - # example - # test_datetime: Acme\HelloBundle\DQL\DatetimeFunction - - # Register SQL Filters in the entity manager - filters: - # An array of filters - some_filter: - class: ~ # Required - enabled: false - - .. code-block:: xml - - - - + # displays the actual config values used by your application + $ php app/console debug:config doctrine - - - - bar - string - - - Acme\HelloBundle\MyCustomType - +.. note:: - - - - - - - - - Acme\HelloBundle\DQL\StringFunction - - - - Acme\HelloBundle\DQL\NumericFunction - - - - Acme\HelloBundle\DQL\DatetimeFunction - - - - - - - - - - + When using XML, you must use the ``http://symfony.com/schema/dic/doctrine`` + namespace and the related XSD schema is available at: + ``http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd`` Doctrine DBAL Configuration --------------------------- diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 68147f0cc14..105678d898f 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -1,8 +1,8 @@ .. index:: single: Configuration reference; Framework -FrameworkBundle Configuration ("framework") -=========================================== +Framework Configuration Reference (FrameworkBundle) +=================================================== The FrameworkBundle defines the main framework configuration, from sessions and translations to forms, validation, routing and more. All these options are diff --git a/reference/configuration/monolog.rst b/reference/configuration/monolog.rst index a067d95bc10..f5d39bafa52 100644 --- a/reference/configuration/monolog.rst +++ b/reference/configuration/monolog.rst @@ -1,123 +1,31 @@ .. index:: pair: Monolog; Configuration reference -MonologBundle Configuration ("monolog") -======================================= +Logging Configuration Reference (MonologBundle) +=============================================== -For a full list of handler types and related configuration -options, see `Monolog Configuration`_. +The MonologBundle integrates the Monolog :doc:`logging ` library in +Symfony applications. All these options are configured under the ``monolog`` key +in your application configuration. -Full Default Configuration --------------------------- +.. code-block:: terminal -.. configuration-block:: + # displays the default config values defined by Symfony + $ php app/console config:dump monolog - .. code-block:: yaml + # displays the actual config values used by your application + $ php app/console debug:config monolog - # app/config/config.yml - monolog: - handlers: - - # Examples: - syslog: - type: stream - path: /var/log/symfony.log - level: ERROR - bubble: false - formatter: my_formatter - main: - type: fingers_crossed - action_level: WARNING - # By default, buffer_size is unlimited (0), which could - # generate huge logs. - buffer_size: 0 - handler: custom - console: - type: console - verbosity_levels: - VERBOSITY_NORMAL: WARNING - VERBOSITY_VERBOSE: NOTICE - VERBOSITY_VERY_VERBOSE: INFO - VERBOSITY_DEBUG: DEBUG - custom: - type: service - id: my_handler - - # Default options and values for some "my_custom_handler" - # Note: many of these options are specific to the "type". - # For example, the 'service' type doesn't use any options - # except id and channels - my_custom_handler: - type: ~ # Required - id: ~ - priority: 0 - level: DEBUG - bubble: true - path: '%kernel.logs_dir%/%kernel.environment%.log' - ident: false - facility: user - max_files: 0 - action_level: WARNING - activation_strategy: ~ - stop_buffering: true - buffer_size: 0 - handler: ~ - members: [] - channels: - type: ~ - elements: ~ - from_email: ~ - to_email: ~ - subject: ~ - mailer: ~ - email_prototype: - id: ~ # Required (when the email_prototype is used) - method: ~ - formatter: ~ - - .. code-block:: xml - - - - - - +.. note:: - - + When using XML, you must use the ``http://symfony.com/schema/dic/monolog`` + namespace and the related XSD schema is available at: + ``http://symfony.com/schema/dic/monolog/monolog-1.0.xsd`` - +.. tip:: - - - + For a full list of handler types and related configuration options, see + `Monolog Configuration`_. .. note:: diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst index 00df4b96b4a..c69f18ecc53 100644 --- a/reference/configuration/security.rst +++ b/reference/configuration/security.rst @@ -1,313 +1,26 @@ .. index:: single: Security; Configuration reference -SecurityBundle Configuration ("security") -========================================= +Security Configuration Reference (SecurityBundle) +================================================= -The security system is one of the most powerful parts of Symfony and can -largely be controlled via its configuration. +The SecurityBundle integrates the :doc:`Security component ` +in Symfony applications. All these options are configured under the ``security`` +key in your application configuration. -Full Default Configuration --------------------------- - -The following is the full default configuration for the security system. -Each part will be explained in the next section. +.. code-block:: terminal -.. configuration-block:: + # displays the default config values defined by Symfony + $ php app/console config:dump security - .. code-block:: yaml + # displays the actual config values used by your application + $ php app/console debug:config security - # app/config/security.yml - security: - access_denied_url: ~ # Example: /foo/error403 - - # strategy can be: none, migrate, invalidate - session_fixation_strategy: migrate - hide_user_not_found: true - always_authenticate_before_granting: false - erase_credentials: true - access_decision_manager: - strategy: affirmative # One of affirmative, consensus, unanimous - allow_if_all_abstain: false - allow_if_equal_granted_denied: true - acl: - - # any name configured in doctrine.dbal section - connection: ~ - cache: - id: ~ - prefix: sf2_acl_ - provider: ~ - tables: - class: acl_classes - entry: acl_entries - object_identity: acl_object_identities - object_identity_ancestors: acl_object_identity_ancestors - security_identity: acl_security_identities - voter: - allow_if_object_identity_unavailable: true +.. note:: - encoders: - # Examples: - Acme\DemoBundle\Entity\User1: sha512 - Acme\DemoBundle\Entity\User2: - algorithm: sha512 - encode_as_base64: true - iterations: 5000 - - # PBKDF2 encoder - # see the note about PBKDF2 below for details on security and speed - Acme\Your\Class\Name: - algorithm: pbkdf2 - hash_algorithm: sha512 - encode_as_base64: true - iterations: 1000 - key_length: 40 - - # Example options/values for what a custom encoder might look like - Acme\DemoBundle\Entity\User3: - id: my.encoder.id - - # BCrypt encoder - # see the note about bcrypt below for details on specific dependencies - Acme\DemoBundle\Entity\User4: - algorithm: bcrypt - cost: 13 - - # Plaintext encoder - # it does not do any encoding - Acme\DemoBundle\Entity\User5: - algorithm: plaintext - ignore_case: false - - providers: # Required - # Examples: - my_in_memory_provider: - memory: - users: - foo: - password: foo - roles: ROLE_USER - bar: - password: bar - roles: [ROLE_USER, ROLE_ADMIN] - - my_entity_provider: - entity: - class: SecurityBundle:User - property: username - # name of a non-default entity manager - manager_name: ~ - - my_ldap_provider: - ldap: - service: ~ - base_dn: ~ - search_dn: ~ - search_password: ~ - default_roles: 'ROLE_USER' - uid_key: 'sAMAccountName' - filter: '({uid_key}={username})' - - # Example custom provider - my_some_custom_provider: - id: ~ - - # Chain some providers - my_chain_provider: - chain: - providers: [ my_in_memory_provider, my_entity_provider ] - - firewalls: # Required - # Examples: - somename: - pattern: .* - # restrict the firewall to a specific host - host: admin\.example\.com - # restrict the firewall to specific HTTP methods - methods: [GET, POST] - request_matcher: some.service.id - access_denied_url: /foo/error403 - access_denied_handler: some.service.id - entry_point: some.service.id - provider: some_key_from_above - # manages where each firewall stores session information - # See "Firewall Context" below for more details - context: context_key - stateless: false - x509: - provider: some_key_from_above - remote_user: - provider: some_key_from_above - http_basic: - provider: some_key_from_above - http_basic_ldap: - provider: some_key_from_above - service: ldap - dn_string: '{username}' - http_digest: - provider: some_key_from_above - guard: - # A key from the "providers" section of your security config, in case your user provider is different than the firewall - provider: ~ - - # A service id (of one of your authenticators) whose start() method should be called when an anonymous user hits a page that requires authentication - entry_point: null - - # An array of service ids for all of your "authenticators" - authenticators: [] - form_login: - # submit the login form here - check_path: /login_check - - # the user is redirected here when they need to log in - login_path: /login - - # if true, forward the user to the login form instead of redirecting - use_forward: false - - # login success redirecting options (read further below) - always_use_default_target_path: false - default_target_path: / - target_path_parameter: _target_path - use_referer: false - - # login failure redirecting options (read further below) - failure_path: /foo - failure_forward: false - failure_path_parameter: _failure_path - failure_handler: some.service.id - success_handler: some.service.id - - # field names for the username and password fields - username_parameter: _username - password_parameter: _password - - # csrf token options - csrf_parameter: _csrf_token - csrf_token_id: authenticate - csrf_token_generator: my.csrf_token_generator.id - - # by default, the login form *must* be a POST, not a GET - post_only: true - remember_me: false - - # by default, a session must exist before submitting an authentication request - # if false, then Request::hasPreviousSession is not called during authentication - # new in Symfony 2.3 - require_previous_session: true - - form_login_ldap: - # submit the login form here - check_path: /login_check - - # the user is redirected here when they need to log in - login_path: /login - - # if true, forward the user to the login form instead of redirecting - use_forward: false - - # login success redirecting options (read further below) - always_use_default_target_path: false - default_target_path: / - target_path_parameter: _target_path - use_referer: false - - # login failure redirecting options (read further below) - failure_path: /foo - failure_forward: false - failure_path_parameter: _failure_path - failure_handler: some.service.id - success_handler: some.service.id - - # field names for the username and password fields - username_parameter: _username - password_parameter: _password - - # csrf token options - csrf_parameter: _csrf_token - csrf_token_id: authenticate - csrf_token_generator: my.csrf_token_generator.id - - # by default, the login form *must* be a POST, not a GET - post_only: true - remember_me: false - - # by default, a session must exist before submitting an authentication request - # if false, then Request::hasPreviousSession is not called during authentication - # new in Symfony 2.3 - require_previous_session: true - - service: ~ - dn_string: '{username}' - - remember_me: - token_provider: name - secret: "%secret%" - name: NameOfTheCookie - lifetime: 3600 # in seconds - path: /foo - domain: somedomain.foo - secure: false - httponly: true - always_remember_me: false - remember_me_parameter: _remember_me - logout: - path: /logout - target: / - invalidate_session: false - delete_cookies: - a: { path: null, domain: null } - b: { path: null, domain: null } - handlers: [some.service.id, another.service.id] - success_handler: some.service.id - anonymous: ~ - - # Default values and options for any firewall - some_firewall_listener: - pattern: ~ - security: true - request_matcher: ~ - access_denied_url: ~ - access_denied_handler: ~ - entry_point: ~ - provider: ~ - stateless: false - context: ~ - logout: - csrf_parameter: _csrf_token - csrf_token_generator: ~ - csrf_token_id: logout - path: /logout - target: / - success_handler: ~ - invalidate_session: true - delete_cookies: - - # Prototype - name: - path: ~ - domain: ~ - handlers: [] - anonymous: - secret: "%secret%" - switch_user: - provider: ~ - parameter: _switch_user - role: ROLE_ALLOWED_TO_SWITCH - - access_control: - requires_channel: ~ - - # use the urldecoded format - path: ~ # Example: ^/path to resource/ - host: ~ - ips: [] - methods: [] - roles: [] - role_hierarchy: - ROLE_ADMIN: [ROLE_ORGANIZER, ROLE_USER] - ROLE_SUPERADMIN: [ROLE_ADMIN] + When using XML, you must use the ``http://symfony.com/schema/dic/security`` + namespace and the related XSD schema is available at: + `` http://symfony.com/schema/dic/services/services-1.0.xsd`` .. versionadded:: 2.8 The ``secret`` option of ``anonymous`` and ``remember_me`` was introduced diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index a18bf1290e4..4b7920bf450 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -1,19 +1,26 @@ .. index:: single: Configuration reference; Swift Mailer -SwiftmailerBundle Configuration ("swiftmailer") -=============================================== +Mailer Configuration Reference (SwiftmailerBundle) +================================================== -This reference document is a work in progress. It should be accurate, but -all options are not yet fully covered. For a full list of the default configuration -options, see `Full Default Configuration`_ +The SwiftmailerBundle integrates the Swiftmailer library in Symfony applications +to :doc:`send emails `. All these options are configured under the +``swiftmailer`` key in your application configuration. -The ``swiftmailer`` key configures Symfony's integration with Swift Mailer, -which is responsible for creating and delivering email messages. +.. code-block:: terminal -The following section lists all options that are available to configure -a mailer. It is also possible to configure several mailers (see -`Using Multiple Mailers`_). + # displays the default config values defined by Symfony + $ php app/console config:dump swiftmailer + + # displays the actual config values used by your application + $ php app/console debug:config swiftmailer + +.. note:: + + When using XML, you must use the ``http://symfony.com/schema/dic/swiftmailer`` + namespace and the related XSD schema is available at: + ``http://symfony.com/schema/dic/swiftmailer/swiftmailer-1.0.xsd`` Configuration ------------- @@ -243,64 +250,6 @@ the information will be available in the profiler. ``host``, ``port``, ``timeout``, ``source_ip``, ``local_domain``. For details, see the :doc:`/configuration/external_parameters` article. -Full Default Configuration --------------------------- - -.. configuration-block:: - - .. code-block:: yaml - - swiftmailer: - transport: smtp - username: ~ - password: ~ - host: localhost - port: false - encryption: ~ - auth_mode: ~ - spool: - type: file - path: '%kernel.cache_dir%/swiftmailer/spool' - sender_address: ~ - antiflood: - threshold: 99 - sleep: 0 - delivery_addresses: [] - disable_delivery: ~ - logging: '%kernel.debug%' - - .. code-block:: xml - - - - - - - - - - - Using Multiple Mailers ---------------------- diff --git a/reference/configuration/twig.rst b/reference/configuration/twig.rst index 18ab8284581..0b43cf3673f 100644 --- a/reference/configuration/twig.rst +++ b/reference/configuration/twig.rst @@ -1,147 +1,26 @@ .. index:: pair: Twig; Configuration reference -TwigBundle Configuration ("twig") -================================= +Twig Configuration Reference (TwigBundle) +========================================= -.. configuration-block:: - - .. code-block:: yaml +The TwigBundle integrates the Twig library in Symfony applications to +:doc:`render templates `. All these options are configured under +the ``twig`` key in your application configuration. - # app/config/config.yml - twig: - exception_controller: twig.controller.exception:showAction - - form_themes: - - # Default: - - form_div_layout.html.twig - - # Bootstrap: - - bootstrap_3_layout.html.twig - - bootstrap_3_horizontal_layout.html.twig - - # Foundation - - foundation_5_layout.html.twig - - # Example: - - form.html.twig - - globals: - - # Examples: - foo: '@bar' - pi: 3.14 - - # Example options, but the easiest use is as seen above - some_variable_name: - # a service id that should be the value - id: ~ - # set to service or leave blank - type: ~ - value: ~ - autoescape: ~ - - # The following were added in Symfony 2.3. - # See http://twig.sensiolabs.org/doc/recipes.html#using-the-template-name-to-set-the-default-escaping-strategy - autoescape_service: ~ # Example: 'my_service' - autoescape_service_method: ~ # use in combination with autoescape_service option - base_template_class: ~ # Example: Twig_Template - cache: '%kernel.cache_dir%/twig' - charset: '%kernel.charset%' - debug: '%kernel.debug%' - strict_variables: ~ - auto_reload: ~ - optimizations: ~ - paths: - '%kernel.root_dir%/../vendor/acme/foo-bar/templates': foo_bar - - # The following were added in Symfony 2.7. - date: - format: d.m.Y, H:i:s - interval_format: '%%d days' - timezone: Asia/Tokyo - number_format: - decimals: 2 - decimal_point: ',' - thousands_separator: '.' +.. code-block:: terminal - .. code-block:: xml + # displays the default config values defined by Symfony + $ php app/console config:dump twig - - - + # displays the actual config values used by your application + $ php app/console debug:config twig - - form_div_layout.html.twig - form.html.twig - - - 3.14 - - - - - AcmeFooBundle:Exception:showException - %kernel.root_dir%/../vendor/acme/foo-bar/templates - - - - .. code-block:: php - - // app/config/config.php - $container->loadFromExtension('twig', array( - 'form_themes' => array( - 'form_div_layout.html.twig', // Default - 'form.html.twig', - ), - 'globals' => array( - 'foo' => '@bar', - 'pi' => 3.14, - ), - 'auto_reload' => '%kernel.debug%', - 'autoescape' => 'name', - 'base_template_class' => 'Twig_Template', - 'cache' => '%kernel.cache_dir%/twig', - 'charset' => '%kernel.charset%', - 'debug' => '%kernel.debug%', - 'strict_variables' => false, - 'exception_controller' => 'AcmeFooBundle:Exception:showException', - 'optimizations' => true, - 'paths' => array( - '%kernel.root_dir%/../vendor/acme/foo-bar/templates' => 'foo_bar', - ), - 'date' => array( - 'format' => 'd.m.Y, H:i:s', - 'interval_format' => '%%d days', - 'timezone' => 'Asia/Tokyo', - ), - 'number_format' => array( - 'decimals' => 2, - 'decimal_point' => ',', - 'thousands_separator' => '.', - ), - )); - -.. caution:: +.. note:: - The ``twig.form`` (```` tag for xml) configuration key - has been deprecated and will be removed in 3.0. Instead, use the ``twig.form_themes`` - option. + When using XML, you must use the ``http://symfony.com/schema/dic/twig`` + namespace and the related XSD schema is available at: + ``http://symfony.com/schema/dic/twig/twig-1.0.xsd`` Configuration ------------- diff --git a/reference/configuration/web_profiler.rst b/reference/configuration/web_profiler.rst index 1c8284889d8..f7cc27a4247 100644 --- a/reference/configuration/web_profiler.rst +++ b/reference/configuration/web_profiler.rst @@ -1,11 +1,27 @@ .. index:: single: Configuration reference; WebProfiler -WebProfilerBundle Configuration ("web_profiler") -================================================ +Profiler Configuration Reference (WebProfilerBundle) +==================================================== The WebProfilerBundle provides detailed technical information about each request -execution and displays it in both the web debug toolbar and the profiler. +execution and displays it in both the web debug toolbar and the +:doc:`profiler `. All these options are configured under the +``web_profiler`` key in your application configuration. + +.. code-block:: terminal + + # displays the default config values defined by Symfony + $ php app/console config:dump web_profiler + + # displays the actual config values used by your application + $ php app/console debug:config web_profiler + +.. note:: + + When using XML, you must use the ``http://symfony.com/schema/dic/webprofiler`` + namespace and the related XSD schema is available at: + ``http://symfony.com/schema/dic/webprofiler/webprofiler-1.0.xsd`` .. caution:: @@ -68,40 +84,3 @@ verbose This option is **deprecated** and has no effect on the toolbar or the profiler, so you can safely remove it from your configuration. - -Full Default Configuration --------------------------- - -.. configuration-block:: - - .. code-block:: yaml - - # app/config/config.yml - web_profiler: - toolbar: false - position: bottom - intercept_redirects: false - excluded_ajax_paths: ^/(app(_[\\w]+)?\\.php/)?_wdt - - # DEPRECATED, it can be removed safely from your configuration - verbose: true - - .. code-block:: xml - - - - - - - From 7a4f75326bc4641ecd464e3bced5660e87050482 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Mon, 25 Jun 2018 15:39:39 +0200 Subject: [PATCH 2/3] Use the full command name --- reference/configuration/assetic.rst | 2 +- reference/configuration/debug.rst | 2 +- reference/configuration/doctrine.rst | 2 +- reference/configuration/framework.rst | 2 +- reference/configuration/monolog.rst | 2 +- reference/configuration/security.rst | 2 +- reference/configuration/swiftmailer.rst | 2 +- reference/configuration/twig.rst | 2 +- reference/configuration/web_profiler.rst | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/reference/configuration/assetic.rst b/reference/configuration/assetic.rst index d715635a10c..c86b93840e4 100644 --- a/reference/configuration/assetic.rst +++ b/reference/configuration/assetic.rst @@ -11,7 +11,7 @@ You can get the full Asstic configuration reference as follows: .. code-block:: terminal # displays the default config values defined by Symfony - $ php bin/console config:dump assetic + $ php bin/console config:dump-reference assetic # displays the actual config values used by your application $ php bin/console debug:config assetic diff --git a/reference/configuration/debug.rst b/reference/configuration/debug.rst index 6d0b173a93d..2aa9ceb97d7 100644 --- a/reference/configuration/debug.rst +++ b/reference/configuration/debug.rst @@ -11,7 +11,7 @@ key in your application configuration. .. code-block:: terminal # displays the default config values defined by Symfony - $ php app/console config:dump debug + $ php app/console config:dump-reference debug # displays the actual config values used by your application $ php app/console debug:config debug diff --git a/reference/configuration/doctrine.rst b/reference/configuration/doctrine.rst index 3ee73fed642..0193211f7c5 100644 --- a/reference/configuration/doctrine.rst +++ b/reference/configuration/doctrine.rst @@ -13,7 +13,7 @@ configuration. .. code-block:: terminal # displays the default config values defined by Symfony - $ php app/console config:dump doctrine + $ php app/console config:dump-reference doctrine # displays the actual config values used by your application $ php app/console debug:config doctrine diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 105678d898f..6f03c9d9e88 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -11,7 +11,7 @@ configured under the ``framework`` key in your application configuration. .. code-block:: terminal # displays the default config values defined by Symfony - $ php app/console config:dump framework + $ php app/console config:dump-reference framework # displays the actual config values used by your application $ php app/console debug:config framework diff --git a/reference/configuration/monolog.rst b/reference/configuration/monolog.rst index f5d39bafa52..50299288e62 100644 --- a/reference/configuration/monolog.rst +++ b/reference/configuration/monolog.rst @@ -11,7 +11,7 @@ in your application configuration. .. code-block:: terminal # displays the default config values defined by Symfony - $ php app/console config:dump monolog + $ php app/console config:dump-reference monolog # displays the actual config values used by your application $ php app/console debug:config monolog diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst index c69f18ecc53..44d3808b704 100644 --- a/reference/configuration/security.rst +++ b/reference/configuration/security.rst @@ -11,7 +11,7 @@ key in your application configuration. .. code-block:: terminal # displays the default config values defined by Symfony - $ php app/console config:dump security + $ php app/console config:dump-reference security # displays the actual config values used by your application $ php app/console debug:config security diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index 4b7920bf450..3a86894847e 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -11,7 +11,7 @@ to :doc:`send emails `. All these options are configured under the .. code-block:: terminal # displays the default config values defined by Symfony - $ php app/console config:dump swiftmailer + $ php app/console config:dump-reference swiftmailer # displays the actual config values used by your application $ php app/console debug:config swiftmailer diff --git a/reference/configuration/twig.rst b/reference/configuration/twig.rst index 0b43cf3673f..a510f44bfed 100644 --- a/reference/configuration/twig.rst +++ b/reference/configuration/twig.rst @@ -11,7 +11,7 @@ the ``twig`` key in your application configuration. .. code-block:: terminal # displays the default config values defined by Symfony - $ php app/console config:dump twig + $ php app/console config:dump-reference twig # displays the actual config values used by your application $ php app/console debug:config twig diff --git a/reference/configuration/web_profiler.rst b/reference/configuration/web_profiler.rst index f7cc27a4247..020f4bce2d4 100644 --- a/reference/configuration/web_profiler.rst +++ b/reference/configuration/web_profiler.rst @@ -12,7 +12,7 @@ execution and displays it in both the web debug toolbar and the .. code-block:: terminal # displays the default config values defined by Symfony - $ php app/console config:dump web_profiler + $ php app/console config:dump-reference web_profiler # displays the actual config values used by your application $ php app/console debug:config web_profiler From 96b9bfddd9bcd23fab9ad061aedaac156b9ff66d Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 26 Jun 2018 08:56:03 +0200 Subject: [PATCH 3/3] Minor grammar fix --- reference/configuration/doctrine.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/configuration/doctrine.rst b/reference/configuration/doctrine.rst index 0193211f7c5..2c9cd8f16e1 100644 --- a/reference/configuration/doctrine.rst +++ b/reference/configuration/doctrine.rst @@ -6,7 +6,7 @@ Doctrine Configuration Reference (DoctrineBundle) ================================================= The DoctrineBundle integrates both the :doc:`DBAL ` and -:doc:`ORM ` Doctrine projects into Symfony applications. All these +:doc:`ORM ` Doctrine projects in Symfony applications. All these options are configured under the ``doctrine`` key in your application configuration.