Какая новая структура каталогов Symfony 3?

Я только что создал новый проект Symfony 2.5 с обычной композиционной командой:

php composer.phar create-project symfony/framework-standard-edition path/ 2.5.0

Терминал спрашивает меня:

Вы хотите использовать структуру каталогов Symfony 3?

Что это за структура каталогов Symfony 3? Я никогда не видел его раньше... Это новый с 2.5?

Каковы преимущества его использования?

Есть ли способ реплицировать эту структуру каталогов?

Ответ 1

Я хочу использовать новую структуру каталогов Symfony 3, но я не вижу вопроса?

Вопрос Would you like to use Symfony 3 directory structure? был удален при создании нового проекта из-за возникшей путаницы. Вы можете принудительно использовать структуру каталогов, используя следующее:

Если вы предпочитаете новую структуру, вы можете добавить переменную окружения SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE к вашим .bashrc или .bash_profile следующим образом:

Сделать все будущие проекты запрошенными для новой структуры

# .bash_profile
# ALL new composer installs will ask `Would you like to use the new Symfony3 strucure?`
export SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE=true

Сделать ТОЛЬКО ЭТОТ проект, хотим ли мы использовать новую структуру.

Если вы хотите его только для определенного проекта (один раз), вы можете использовать:

SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE=true composer create-project symfony/framework-standard-edition path/ "2.5.*"

Если переменная окружения SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE установлена ​​и установлена ​​в true, composer спросит, хотите ли вы использовать новую структуру каталогов.

Продолжите чтение ниже для всех изменений между структурой каталогов Symfony2 и Symfony3.


Что представляет собой новая структура каталогов Symfony 3?

(и как это влияет на меня и мой рабочий процесс)

Я рассмотрел это, создав 2 проекта, один с структурой каталогов symfony-2.5.0, один с symfony-3 (изменение структуры каталогов).

Сделайте один из каждого проекта:

# say `N` to `Would you like to use Symfony 3 directory structure?`
$ composer create-project symfony/framework-standard-edition symfony-2.5.0/ 2.5.0

# say `Y` to `Would you like to use Symfony 3 directory structure?`
$ composer create-project symfony/framework-standard-edition symfony-3/ 2.5.0

Итак, теперь у нас есть 2 разных каталога, которые мы хотим сравнить.


Найдите diff erence

Вы можете diff между двумя каталогами:

$ diff -rq symfony-2.5.0/ symfony-3/
/** (Returned from the diff)
Files symfony-2.5.0/.gitignore and symfony-3/.gitignore differ
Files symfony-2.5.0/.travis.yml and symfony-3/.travis.yml differ
Only in symfony-2.5.0/app: bootstrap.php.cache
Only in symfony-2.5.0/app: cache
Only in symfony-2.5.0/app: console
Only in symfony-2.5.0/app: logs
Only in symfony-2.5.0/app: phpunit.xml.dist
Only in symfony-3/bin: console
Only in symfony-3/bin: symfony_requirements
Files symfony-2.5.0/composer.json and symfony-3/composer.json differ
Only in symfony-3/: phpunit.xml.dist
Only in symfony-3/: var
Files symfony-2.5.0/vendor/autoload.php and symfony-3/vendor/autoload.php differ
Files symfony-2.5.0/vendor/composer/autoload_real.php and symfony-3/vendor/composer/autoload_real.php differ
Files symfony-2.5.0/web/app.php and symfony-3/web/app.php differ
Files symfony-2.5.0/web/app_dev.php and symfony-3/web/app_dev.php differ
*/

Здесь отображаются файлы, которые отличаются в двух версиях.


Разбивка diff

Здесь разбивается все, что находится в diff.

# These files still exist in both versions (with different content)
.gitignore
.travis.yml
composer.json
vendor/autoload.php
vendor/composer/autoload_real.php
web/app.php
web/app_dev.php

# The following files have been removed from 2.5.0
# {RemovedFile2.5}      |  {ReplacedWith3.0}
app/cache               |  var/cache
app/logs                |  var/log
app/bootstrap.php.cache |  var/bootstrap.php.cache
app/console             |  bin/console
app/phpunit.xml.dist    |  phpunit.xml.dist

# The following files are new in 3.0
bin/symfony_requirements # run via CLI

Преимущества структуры каталогов Symfony 3

Новая структура каталогов имеет ряд преимуществ, все из которых незначительны и могут потребовать минимальных изменений в вашем рабочем процессе.

PHPUnit

phpunit может быть запущен из корня проекта без необходимости явно указывать путь к файлу конфигурации.

# Symfony2
phpunit -c app/phpunit.xml

# Symfony3 (no need to specify the configuration file location)
phpunit

Бинарные исполняемые файлы

Теперь все двоичные исполняемые файлы находятся в одном месте - в каталоге bin (аналогично unix-like os).

# you can update your `PATH` to include the `bin` directory
PATH="./bin:$PATH"

# From your project root you can now run executables like so:
console
symfony_requirements
doctrine

# else with no `PATH` update
bin/console
bin/symfony_requirements
bin/doctrine

Новый /var каталог

Новый каталог /var содержит файлы, к которым система записывает данные в ходе своей работы (похожие на unix-подобные os).

Это также упрощает добавление разрешений, весь каталог /var должен быть доступен для записи вашим веб-сервером. Вы можете выполнить руководство Symfony2 для установки разрешений (подставляя app/cache & app/logs с помощью var), любые другие файлы, которые вы хотите написать локально, также можно найти здесь.

# default symfony3 `var` directory
var/bootstrap.php.cache
var/cache
var/logs

Проверка требований Symfony

Запуск symfony_requirements выведет обязательные и необязательные конфигурации окружения.
например:

********************************
* 'Symfony requirements check' *
********************************

* Configuration file used by PHP: /usr/local/php5/lib/php.ini

/** ATTENTION **
*  The PHP CLI can use a different php.ini file
*  than the one used with your web server.
*  To be on the safe side, please also launch the requirements check
*  from your web server using the web/config.PHP скрипт.
*/

** Mandatory requirements **
'
 OK       PHP version must be at least 5.3.3 (5.5.11 installed)
 OK       PHP version must not be 5.3.16 as Symfony wont work properly with it
 OK       Vendor libraries must be installed
 OK       var/cache/ directory must be writable
 OK       var/logs/ directory must be writable
 OK       date.timezone setting must be set
 OK       Configured default timezone "Europe/London" must be supported by your installation of PHP
 OK       json_encode() must be available
 OK       session_start() must be available
 OK       ctype_alpha() must be available
 OK       token_get_all() must be available
 OK       simplexml_import_dom() must be available
 OK       APC version must be at least 3.1.13 when using PHP 5.4
 OK       detect_unicode must be disabled in php.ini
 OK       xdebug.show_exception_trace must be disabled in php.ini
 OK       xdebug.scream must be disabled in php.ini
 OK       PCRE extension must be available
'
** Optional recommendations **
'
 OK       xdebug.max_nesting_level should be above 100 in php.ini
 OK       Requirements file should be up-to-date
 OK       You should use at least PHP 5.3.4 due to PHP bug #52083 in earlier versions
 OK       When using annotations you should have at least PHP 5.3.8 due to PHP bug #55156
 OK       You should not use PHP 5.4.0 due to the PHP bug #61453
 OK       When using the logout handler from the Symfony Security Component, you should have at least PHP 5.4.11 due to PHP bug #63379 (as a workaround, you can also set invalidate_session to false in the security logout handler configuration)
 OK       You should use PHP 5.3.18+ or PHP 5.4.8+ to always get nice error messages for fatal errors in the development environment due to PHP bug #61767/#60909
 OK       PCRE extension should be at least version 8.0 (8.34 installed)
 OK       PHP-XML module should be installed
 OK       mb_strlen() should be available
 OK       iconv() should be available
 OK       utf8_decode() should be available
 OK       posix_isatty() should be available
 OK       intl extension should be available
 OK       intl extension should be correctly configured
 OK       intl ICU version should be at least 4+
 OK       a PHP accelerator should be installed
 OK       short_open_tag should be disabled in php.ini
 OK       magic_quotes_gpc should be disabled in php.ini
 OK       register_globals should be disabled in php.ini
 OK       session.auto_start should be disabled in php.ini
 OK       PDO should be installed
 OK       PDO should have some drivers installed (currently available: mysql, sqlite, dblib, pgsql)
'

Заключение

Похоже на то, что Sensio Labs хорошо убирает все перечисленные выше изменения, они должны быть легко реализованы при обновлении с 2.5 до 3.x, это, вероятно, будет наименьшим из ваших проблем!

Прочитайте документы

Symfony 2.x = > 3.0 Обновить документы здесь
Symfony 3.0 Архитектура

Дата выпуска для Symfony 3

Он смотрит далеко за пределы процесса выпуска (стоит прочитать):

http://symfony.com/doc/current/contributing/community/releases.html

Updated Symfony release Process

Ответ 2

Ниже приведен список изменений между старой и новой структурой каталогов:

  • Вводится новая папка var
  • app/console перемещается в bin/console
  • app/check.php перемещается/переименовывается в bin/symfony_requirements
  • app/phpunit.xml.dist перемещается в корневую папку
  • app/SymfonyRequirements.php перемещается в var/SymfonyRequirements.php
  • папки app/cache и app/logs были перенесены в var/cache и var/logs, соответственно

(В настоящее время не все старые файлы, похоже, удалены, поэтому вы можете сделать это вручную перед тем, как перенести все файлы в управление версиями. См. this вопрос)

Итак, какая польза?

Есть несколько преимуществ с этими изменениями. Прежде всего, все файлы и папки, которые должны быть доступны для записи для Symfony, теперь находятся в папке var. Это должно упростить настройку разрешений: просто запишите доступ к записи в папку var, и все готово. Это предлагается в этом сообщении в блоге - Я еще не пробовал это сам.

Во-вторых, все исполняемые файлы, включая console, теперь находятся в папке bin. Это позволяет Bash пользователям, например, добавить это в свой файл .profile:

# set PATH so it includes current bin folder
PATH="./bin:$PATH"

Теперь вам даже не нужно набирать bin/console, просто console будет достаточно (обратите внимание, что мне пришлось перезагружаться, чтобы это работало).

Есть и другие улучшения. app/check.php теперь является исполняемым, поэтому вы можете вызвать его, используя bin/symfony_requirements вместо php app/check.php. (Используя трюк .profile, который я описал ранее, достаточно просто symfony_requirements)

И последнее, но не менее важное: вам больше не нужно указывать расположение файла конфигурации при запуске PHPUnit. Поэтому вместо phpunit -c app вы можете просто выполнить phpunit.

Могу ли я обновить существующие проекты в этой новой структуре?

По умолчанию для создания нового проекта (используя composer create-project symfony/framework-standard-edition path/ "2.5.*") вы получите сообщение "Вы хотите использовать новую структуру каталогов".

Однако можно обновить существующее приложение Symfony, но это несколько хакерское решение. Мне удалось сделать это с помощью ряда приложений сейчас, и вы можете прочитать шаги в этом смысле. Однако, поскольку он не был предназначен для этого, я не могу гарантировать, что он будет работать.

Update

Оказывается, Symfony больше не спрашивает вас, хотите ли вы использовать новую структуру каталогов при создании нового приложения Symfony через Composer. Тем не менее, по-прежнему можно создавать проекты Symfony с новой структурой каталогов, используя переменную среды. Для получения дополнительной информации см. Как создать новый проект Symfony с новой структурой каталогов?