Skip to content

Commit 9baf83a

Browse files
weaverryanfabpot
authored andcommitted
Minor edits to the quick_tour/the_architecture section after proofreading through it.
1 parent dfd5978 commit 9baf83a

File tree

2 files changed

+31
-25
lines changed

2 files changed

+31
-25
lines changed

glossary.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,9 @@ Glossary
1818
A *Bundle* is a structured set of files (PHP files, stylesheets,
1919
JavaScripts, images, ...) that *implements* a single feature (a blog,
2020
a forum, ...) and which can be easily shared with other developers.
21+
22+
Front Controller
23+
A *Front Controller* is a short PHP that lives in the web directory
24+
of your project. Typically, *all* requests are handled by executing
25+
the same front controller, whose job is to bootstrap the Symfony
26+
application.

quick_tour/the_architecture.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ The Architecture
22
================
33

44
You are my hero! Who would have thought that you would still be here after the
5-
first three parts? Your efforts will be well rewarded soon. The first three
6-
parts don't have a deep look at the architecture of the framework. As it makes
5+
first three parts? Your efforts will be well-rewarded soon. The first three
6+
parts didn't look too deeply at the architecture of the framework. As it makes
77
Symfony2 stand apart from the framework crowd, let's dive into it now.
88

99
.. index::
@@ -13,7 +13,7 @@ The Directory Structure
1313
-----------------------
1414

1515
The directory structure of a Symfony2 :term:`application` is rather flexible
16-
but the directory structure of a sandbox reflects the typical and recommended
16+
but the directory structure of the sandbox reflects the typical and recommended
1717
structure of a Symfony2 application:
1818

1919
* ``app/``: This directory contains the application configuration;
@@ -26,8 +26,8 @@ The Web Directory
2626
~~~~~~~~~~~~~~~~~
2727

2828
The web root directory is the home of all public and static files like images,
29-
stylesheets, and JavaScript files. It is also where the front controllers
30-
live::
29+
stylesheets, and JavaScript files. It is also where each :term:`front controller`
30+
lives::
3131

3232
// web/app.php
3333
require_once __DIR__.'/../app/AppKernel.php';
@@ -117,15 +117,15 @@ server or locally in your projects.
117117
The Bundle System
118118
-----------------
119119

120-
This section starts to scratch the surface of one of the greatest and more
121-
powerful features of Symfony2, its :term:`bundle` system.
120+
This section starts to scratch the surface of one of the greatest and most
121+
powerful features of Symfony2, the :term:`bundle` system.
122122

123-
A bundle is kind of like a plugin in other software. But why is it called
124-
bundle and not plugin then? Because everything is a bundle in Symfony2, from
123+
A bundle is kind of like a plugin in other software. So why is it called
124+
bundle and not plugin? Because *everything* is a bundle in Symfony2, from
125125
the core framework features to the code you write for your application.
126126
Bundles are first-class citizens in Symfony2. This gives you the flexibility to
127127
use pre-built features packaged in third-party bundles or to distribute your
128-
own bundles. It makes it so easy to pick and choose which features to enable
128+
own bundles. It makes it easy to pick and choose which features to enable
129129
in your application and optimize them the way you want.
130130

131131
An application is made up of bundles as defined in the ``registerBundles()``
@@ -156,8 +156,8 @@ method of the ``AppKernel`` class::
156156
return $bundles;
157157
}
158158

159-
Along side the ``HelloBundle`` we have already talked about, notice that the
160-
kernel also enables ``FrameworkBundle``, ``DoctrineBundle``,
159+
In addition to the ``HelloBundle`` that we have already talked about, notice
160+
that the kernel also enables ``FrameworkBundle``, ``DoctrineBundle``,
161161
``SwiftmailerBundle``, and ``ZendBundle``. They are all part of the core
162162
framework.
163163

@@ -346,9 +346,9 @@ specific configuration file:
346346
),
347347
));
348348
349-
As we have seen in the previous part, an application is made of bundles as
350-
defined in the ``registerBundles()`` method but how does Symfony2 know where to
351-
look for bundles? Symfony2 is quite flexible in this regard. The
349+
As we have seen in the previous part, an application is made up of bundles
350+
defined in the ``registerBundles()`` method. But how does Symfony2 know where
351+
to look for bundles? Symfony2 is quite flexible in this regard. The
352352
``registerBundleDirs()`` method must return an associative array that maps
353353
namespaces to any valid directory (local or global ones)::
354354

@@ -373,10 +373,10 @@ applications, store them locally or globally, your choice.
373373
Using Vendors
374374
-------------
375375

376-
Odds are your application will depend on third-party libraries. Those should
377-
be stored in the ``src/vendor/`` directory. It already contains the Symfony2
378-
libraries, the SwiftMailer library, the Doctrine ORM, the Twig templating
379-
system, and a selection of the Zend Framework classes.
376+
Odds are that your application will depend on third-party libraries. Those
377+
should be stored in the ``src/vendor/`` directory. This directory already
378+
contains the Symfony2 libraries, the SwiftMailer library, the Doctrine ORM,
379+
the Twig templating system, and a selection of the Zend Framework classes.
380380

381381
.. index::
382382
single: Configuration Cache
@@ -391,12 +391,12 @@ each request? This is partly due to its cache system. The application
391391
configuration is only parsed for the very first request and then compiled down
392392
to plain PHP code stored in the ``cache/`` application directory. In the
393393
development environment, Symfony2 is smart enough to flush the cache when you
394-
change a file. But in the production one, it is your responsibility to clear
395-
the cache when you update your code or change its configuration.
394+
change a file. But in the production environment, it is your responsibility
395+
to clear the cache when you update your code or change its configuration.
396396

397397
When developing a web application, things can go wrong in many ways. The log
398398
files in the ``logs/`` application directory tell you everything about the
399-
requests and helps you fix the problem in no time.
399+
requests and help you fix the problem quickly.
400400

401401
.. index::
402402
single: CLI
@@ -425,13 +425,13 @@ Final Thoughts
425425
--------------
426426

427427
Call me crazy, but after reading this part, you should be comfortable with
428-
moving things around and making Symfony2 works for you. Everything is done in
429-
Symfony2 to stand out of your way. So, feel free to rename and move directories
428+
moving things around and making Symfony2 work for you. Everything is done in
429+
Symfony2 to get out of your way. So, feel free to rename and move directories
430430
around as you see fit.
431431

432432
And that's all for the quick tour. From testing to sending emails, you still
433433
need to learn a lot to become a Symfony2 master. Ready to dig into these topics
434-
now? Look no further, go to the official `guides`_ page and pick any topic you
434+
now? Look no further - go to the official `guides`_ page and pick any topic you
435435
want.
436436

437437
.. _standards: http://groups.google.com/group/php-standards/web/psr-0-final-proposal

0 commit comments

Comments
 (0)