From c521227633826dbbf9cb4122591c2f60b2c88ed9 Mon Sep 17 00:00:00 2001 From: Ross Cousens Date: Fri, 24 Jul 2015 20:29:52 +1000 Subject: [PATCH 1/3] Add third column to specific emplacements table describing relationship The standard Symfony2 framework has mandatory requirements about specific emplacements, and then others that are considered best practice by convention. This commit makes the documentation clearer in order to provide a developer with reasonable expectations about the consequences of altering the default directory structure. Additionally, newer developers may be less intimidated and concerned by whether they are compromising any auto-wiring functionality by deviating from the information provided. --- cookbook/bundles/best_practices.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/cookbook/bundles/best_practices.rst b/cookbook/bundles/best_practices.rst index 61b6fdfe6e1..bf4ef849b6c 100644 --- a/cookbook/bundles/best_practices.rst +++ b/cookbook/bundles/best_practices.rst @@ -117,20 +117,20 @@ files are going to be part of the repository. The following classes and files have specific emplacements: -=============================== ============================= -Type Directory -=============================== ============================= -Commands ``Command/`` -Controllers ``Controller/`` -Service Container Extensions ``DependencyInjection/`` -Event Listeners ``EventListener/`` -Model classes [1] ``Model/`` -Configuration ``Resources/config/`` -Web Resources (CSS, JS, images) ``Resources/public/`` -Translation files ``Resources/translations/`` -Templates ``Resources/views/`` -Unit and Functional Tests ``Tests/`` -=============================== ============================= +=============================== ============================= ================ +Type Directory Relationship +=============================== ============================= ================ +Commands ``Command/`` Mandatory +Controllers ``Controller/`` Mandatory +Service Container Extensions ``DependencyInjection/`` Mandatory +Event Listeners ``EventListener/`` Convention +Model classes [1] ``Model/`` Convention +Configuration ``Resources/config/`` Mandatory +Web Resources (CSS, JS, images) ``Resources/public/`` Mandatory +Translation files ``Resources/translations/`` Mandatory +Templates ``Resources/views/`` Mandatory +Unit and Functional Tests ``Tests/`` Convention +=============================== ============================= ================ [1] See :doc:`/cookbook/doctrine/mapping_model_classes` for how to handle the mapping with a compiler pass. From fe86c35ada2de382b431c5662f4a97b133d81101 Mon Sep 17 00:00:00 2001 From: Ross Cousens Date: Fri, 31 Jul 2015 20:46:44 +1000 Subject: [PATCH 2/3] Fix as per comments Renamed Relationship column to Location and updated value for Tests to Mandatory due to default phpunit config. --- cookbook/bundles/best_practices.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cookbook/bundles/best_practices.rst b/cookbook/bundles/best_practices.rst index bf4ef849b6c..cda24386163 100644 --- a/cookbook/bundles/best_practices.rst +++ b/cookbook/bundles/best_practices.rst @@ -118,7 +118,7 @@ files are going to be part of the repository. The following classes and files have specific emplacements: =============================== ============================= ================ -Type Directory Relationship +Type Directory Location =============================== ============================= ================ Commands ``Command/`` Mandatory Controllers ``Controller/`` Mandatory @@ -129,7 +129,7 @@ Configuration ``Resources/config/`` Mandatory Web Resources (CSS, JS, images) ``Resources/public/`` Mandatory Translation files ``Resources/translations/`` Mandatory Templates ``Resources/views/`` Mandatory -Unit and Functional Tests ``Tests/`` Convention +Unit and Functional Tests ``Tests/`` Mandatory =============================== ============================= ================ [1] See :doc:`/cookbook/doctrine/mapping_model_classes` for how to handle the From e7d72ed3d7020589878f9955364b7ea94a2735c9 Mon Sep 17 00:00:00 2001 From: Ross Cousens Date: Fri, 31 Jul 2015 21:12:06 +1000 Subject: [PATCH 3/3] Fix spacing on third column --- cookbook/bundles/best_practices.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/cookbook/bundles/best_practices.rst b/cookbook/bundles/best_practices.rst index cda24386163..c9a230e91e2 100644 --- a/cookbook/bundles/best_practices.rst +++ b/cookbook/bundles/best_practices.rst @@ -117,20 +117,20 @@ files are going to be part of the repository. The following classes and files have specific emplacements: -=============================== ============================= ================ -Type Directory Location -=============================== ============================= ================ -Commands ``Command/`` Mandatory -Controllers ``Controller/`` Mandatory -Service Container Extensions ``DependencyInjection/`` Mandatory -Event Listeners ``EventListener/`` Convention -Model classes [1] ``Model/`` Convention -Configuration ``Resources/config/`` Mandatory -Web Resources (CSS, JS, images) ``Resources/public/`` Mandatory -Translation files ``Resources/translations/`` Mandatory -Templates ``Resources/views/`` Mandatory -Unit and Functional Tests ``Tests/`` Mandatory -=============================== ============================= ================ +=============================== ============================= ================ +Type Directory Location +=============================== ============================= ================ +Commands ``Command/`` Mandatory +Controllers ``Controller/`` Mandatory +Service Container Extensions ``DependencyInjection/`` Mandatory +Event Listeners ``EventListener/`` Convention +Model classes [1] ``Model/`` Convention +Configuration ``Resources/config/`` Mandatory +Web Resources (CSS, JS, images) ``Resources/public/`` Mandatory +Translation files ``Resources/translations/`` Mandatory +Templates ``Resources/views/`` Mandatory +Unit and Functional Tests ``Tests/`` Mandatory +=============================== ============================= ================ [1] See :doc:`/cookbook/doctrine/mapping_model_classes` for how to handle the mapping with a compiler pass.