Skip to content

updated configuration reference #1303

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

Merged
merged 2 commits into from
Jun 1, 2012
Merged

updated configuration reference #1303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91ff414
updated configuration reference
kbond Apr 23, 2012
505a694
added missing examples
kbond May 28, 2012
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
14 changes: 10 additions & 4 deletions reference/configuration/assetic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,20 @@ Full Default Configuration
.. code-block:: yaml

assetic:
debug: true
use_controller: true
debug: %kernel.debug%
use_controller:
enabled: %kernel.debug%
profiler: false
read_from: %kernel.root_dir%/../web
write_to: %assetic.read_from%
java: /usr/bin/java
node: /usr/bin/node
ruby: /usr/bin/ruby
sass: /usr/bin/sass
variables:

# Prototype
name: []
bundles:

# Defaults (all currently registered bundles):
Expand All @@ -30,7 +37,6 @@ Full Default Configuration
- DoctrineBundle
- AsseticBundle
- ...

assets:

# Prototype
Expand All @@ -49,4 +55,4 @@ Full Default Configuration
functions:

# Prototype
name: []
name: []
183 changes: 141 additions & 42 deletions reference/configuration/doctrine.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,62 +12,161 @@ Configuration Reference
doctrine:
dbal:
default_connection: default
types:
# Prototype
name:
class: ~ # Required
commented: true

connections:
default:
dbname: database

# Prototype
Copy link
Member

Choose a reason for hiding this comment

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

Same thing here with the prototypes, I'm not sure this is the best way to show this (though it is the most technically correct). I think it'd make more sense to show an example usage with a note. What do you think?

name:
dbname: ~
host: localhost
port: 1234
user: user
password: secret
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 ommited)
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
driver_class: MyNamespace\MyDriverImpl
platform_service: ~
logging: true
profiling: true
driver_class: ~
wrapper_class: ~
options:
foo: bar
path: %kernel.data_dir%/data.sqlite
memory: true
unix_socket: /tmp/mysql.sock
wrapper_class: MyDoctrineDbalConnectionWrapper
charset: UTF8
logging: %kernel.debug%
platform_service: MyOwnDatabasePlatformService

# Prototype
key: []
mapping_types:
enum: string
conn1:
# ...
types:
custom: Acme\HelloBundle\MyCustomType

# Prototype
name: []
slaves:

# Prototype
name:
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 ommited)
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: ~

orm:
auto_generate_proxy_classes: false
proxy_namespace: Proxies
proxy_dir: %kernel.cache_dir%/doctrine/orm/Proxies
default_entity_manager: default # The first defined is used if not set
default_entity_manager: ~
auto_generate_proxy_classes: false
proxy_dir: %kernel.cache_dir%/doctrine/orm/Proxies
proxy_namespace: Proxies
entity_managers:
default:
# The name of a DBAL connection (the one marked as default is used if not set)
connection: conn1
mappings: # Required
AcmeHelloBundle: ~
class_metadata_factory_name: Doctrine\ORM\Mapping\ClassMetadataFactory
# All cache drivers have to be array, apc, xcache or memcache
metadata_cache_driver: array
query_cache_driver: array

# Prototype
name:
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: memcache
host: localhost
port: 11211
instance_class: Memcache
class: Doctrine\Common\Cache\MemcacheCache
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:

# Prototype
name: []
mappings:

# Prototype
name:
mapping: true
type: ~
dir: ~
alias: ~
prefix: ~
is_bundle: ~
dql:
string_functions:
test_string: Acme\HelloBundle\DQL\StringFunction

# Prototype
name: []
numeric_functions:
test_numeric: Acme\HelloBundle\DQL\NumericFunction

# Prototype
name: []
datetime_functions:
test_datetime: Acme\HelloBundle\DQL\DatetimeFunction
hydrators:
custom: Acme\HelloBundle\Hydrators\CustomHydrator
em2:
# ...

# Prototype
name: []

# Register SQL Filters in the entity manager
filters:

# Prototype
name:
class: ~ # Required
enabled: false

.. code-block:: xml

Expand Down
44 changes: 35 additions & 9 deletions reference/configuration/framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,11 +246,11 @@ Full Default Configuration

# general configuration
charset: ~
trust_proxy_headers: false
secret: ~ # Required
ide: ~
test: ~
default_locale: en
trust_proxy_headers: false

# form configuration
form:
Expand All @@ -267,13 +267,15 @@ Full Default Configuration
profiler:
only_exceptions: false
only_master_requests: false
dsn: sqlite:%kernel.cache_dir%/profiler.db
dsn: file:%kernel.cache_dir%/profiler
username:
password:
lifetime: 86400
matcher:
ip: ~
path: ~

# use the urldecoded format
path: ~ # Example: ^/path to resource/
service: ~

# router configuration
Expand All @@ -285,26 +287,50 @@ Full Default Configuration

# session configuration
session:
auto_start: ~
auto_start: false
storage_id: session.storage.native
handler_id: session.handler.native_file
name: ~
lifetime: 0
cookie_lifetime: ~
cookie_path: ~
cookie_domain: ~
cookie_secure: ~
cookie_httponly: ~
gc_divisor: ~
gc_probability: ~
gc_maxlifetime: ~
save_path: %kernel.cache_dir%/sessions

# DEPRECATED! Please use: cookie_lifetime
lifetime: ~

# DEPRECATED! Please use: cookie_path
path: ~

# DEPRECATED! Please use: cookie_domain
domain: ~

# DEPRECATED! Please use: cookie_secure
secure: ~

# DEPRECATED! Please use: cookie_httponly
httponly: ~

# templating configuration
templating:
assets_version: ~
assets_version_format: "%%s?%%s"
assets_version_format: %%s?%%s
hinclude_default_template: ~
form:
resources:

# Default:
- FrameworkBundle:Form
assets_base_urls:
http: []
ssl: []
cache: ~
engines: # Required
form:
resources: [FrameworkBundle:Form]

# Example:
- twig
Expand All @@ -314,7 +340,7 @@ Full Default Configuration
# Prototype
name:
version: ~
version_format: ~
version_format: %%s?%%s
base_urls:
http: []
ssl: []
Expand Down
10 changes: 8 additions & 2 deletions reference/configuration/monolog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Configuration Reference
level: ERROR
bubble: false
formatter: my_formatter
processors:
- some_callable
main:
type: fingers_crossed
action_level: WARNING
Expand All @@ -39,6 +41,7 @@ Configuration Reference
facility: user
max_files: 0
action_level: WARNING
activation_strategy: ~
stop_buffering: true
buffer_size: 0
handler: ~
Expand All @@ -47,8 +50,11 @@ Configuration Reference
to_email: ~
subject: ~
email_prototype:
id: ~ # Required (when the email_prototype is used)
method: ~
id: ~ # Required (when the email_prototype is used)
factory-method: ~
channels:
type: ~
elements: []
formatter: ~

.. code-block:: xml
Expand Down
Loading